fastlane-plugin-wpmreleasetoolkit 6.0.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c16be217cbd668e4fbd9da107edcdba4b5be149f0d64d4dadb6a0d5697cde006
-  data.tar.gz: e736842ca7df0e1ff50fc0a7114e39555570c03c8e58b41fa265999f267f0ec2
+  metadata.gz: a5ccc5cff47b793af8f4ab760dae506824b97736743751874e6ffe05da49c6d6
+  data.tar.gz: b505f57985fa018c5845437e38b9d62a82db73252fca4990d30bf2e5b8b6455e
 SHA512:
-  metadata.gz: 739938930d2cfd9238590f6b58b7031923f5f6b325c53246058f77dc47c7e302180f2d088b8c764106d50e45f7bca265d915a3d671bbf09c6a45e9309fcb1e3e
-  data.tar.gz: 0741aeff083cab3060b8b4f46259ad091217eef34fd013370fca26289b5c2279c325632dd7935699772e293e81e87ffcbd71bc7b8905da5fffbb4e04543f61e5
+  metadata.gz: ef7e10048e6a7bd1795667f06e59ff4af01638ea2a3f47bb2742f3ea50bd1d52ae1c8b747e4fc8d2422599f216e9dc03ba334ace07f9a90dfa785630f937c9d7
+  data.tar.gz: 559bee78785335bcc564e04cafc52af9d5514f2d979598ce05c5837ba97b6378c70f0d919809fc6f4db5ca4e5f64db47ac90e430b058d5cd6d777ebf81cc54dc

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_firebase_test.rb

@@ -3,8 +3,9 @@ require 'securerandom'
 module Fastlane
   module Actions
     module SharedValues
-      FIREBASE_TEST_RESULT = :FIREBASE_TEST_LOG_FILE
+      FIREBASE_TEST_RESULT = :FIREBASE_TEST_LOG_FILE # FirebaseTestLabResult object, for internal consumption
       FIREBASE_TEST_LOG_FILE_PATH = :FIREBASE_TEST_LOG_FILE_PATH
+      FIREBASE_TEST_MORE_DETAILS_URL = :FIREBASE_TEST_MORE_DETAILS_URL
     end
 
     class AndroidFirebaseTestAction < Action
@@ -45,13 +46,20 @@ module Fastlane
           key_file_path: params[:key_file]
         )
 
-        FastlaneCore::UI.test_failure! "Firebase Tests failed – more information can be found at #{result.more_details_url}" unless result.success?
+        Fastlane::Actions.lane_context[SharedValues::FIREBASE_TEST_MORE_DETAILS_URL] = result.more_details_url
 
-        UI.success 'Firebase Tests Complete'
+        if result.success?
+          UI.success 'Firebase Tests Complete'
+          return true
+        else
+          ui_method = params[:crash_on_test_failure] ? :test_failure! : :error
+          FastlaneCore::UI.send(ui_method, "Firebase Tests failed – more information can be found at #{result.more_details_url}")
+          return false
+        end
       end
 
       # Fastlane doesn't eagerly validate options for us, so we'll do it first to have control over
-      # when they're evalutated.
+      # when they're evaluated.
       def self.validate_options(params)
         available_options
           .reject { |opt| opt.optional || !opt.default_value.nil? }
@@ -180,9 +188,28 @@ module Fastlane
             optional: true,
             type: String
           ),
+          FastlaneCore::ConfigItem.new(
+            key: :crash_on_test_failure,
+            description: 'If set to `true` (the default), will stop fastlane with `test_failure!`. ' \
+              + 'If `false`, the action will return the test status, without interrupting the rest of your Fastlane run on failure, letting the caller handle the failure on their side',
+            optional: true,
+            type: Boolean,
+            default_value: true
+          ),
         ]
       end
 
+      def self.output
+        [
+          ['FIREBASE_TEST_LOG_FILE_PATH', 'Path to the `output.log` file containing the logs or invoking the tests'],
+          ['FIREBASE_TEST_MORE_DETAILS_URL', 'URL to the Firebase Console dashboard showing the details of the test run (and failures, if any)'],
+        ]
+      end
+
+      def self.return_value
+        'True if the test succeeded, false if they failed'
+      end
+
       def self.authors
         ['Automattic']
       end

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/promo_screenshots_action.rb

@@ -11,7 +11,9 @@ module Fastlane
         UI.message "#{self.check_path(params[:orig_folder])} Original Screenshot Source: #{params[:orig_folder]}"
         UI.message "#{self.check_path(params[:metadata_folder])} Translation source: #{params[:metadata_folder]}"
 
-        config = helper.read_json(params[:config_file])
+        config = helper.read_config(params[:config_file])
+
+        helper.check_fonts_installed!(config: config) unless params[:skip_font_check]
 
         translationDirectories = subdirectories_for_path(params[:metadata_folder])
         imageDirectories = subdirectories_for_path(params[:orig_folder])
@@ -141,31 +143,34 @@ module Fastlane
                                        env_name: 'PROMOSS_ORIG',
                                        description: 'The directory containing the original screenshots',
                                        optional: false,
-                                       is_string: true),
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :output_folder,
                                        env_name: 'PROMOSS_OUTPUT',
                                        description: 'The path of the folder to save the promo screenshots',
                                        optional: false,
-                                       is_string: true),
-
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :metadata_folder,
                                        env_name: 'PROMOSS_METADATA_FOLDER',
                                        description: 'The directory containing the translation data',
                                        optional: false,
-                                       is_string: true),
-
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :config_file,
                                        env_name: 'PROMOSS_CONFIG_FILE',
                                        description: 'The path to the file containing the promo screenshot configuration',
                                        optional: true,
-                                       is_string: true,
+                                       type: String,
                                        default_value: 'screenshots.json'),
-
           FastlaneCore::ConfigItem.new(key: :force,
                                        env_name: 'PROMOSS_FORCE_CREATION',
                                        description: 'Overwrite existing promo screenshots without asking first?',
                                        optional: true,
-                                       is_string: false,
+                                       type: Boolean,
+                                       default_value: false),
+          FastlaneCore::ConfigItem.new(key: :skip_font_check,
+                                       env_name: 'PROMOSS_SKIP_FONT_CHECK',
+                                       description: 'Skip the check verifying that needed fonts are installed and active',
+                                       optional: true,
+                                       type: Boolean,
                                        default_value: false),
         ]
       end

data/lib/fastlane/plugin/wpmreleasetoolkit/helper/promo_screenshots_helper.rb

@@ -7,11 +7,11 @@ rescue LoadError
 end
 require 'json'
 require 'tempfile'
+require 'open3'
 require 'optparse'
 require 'pathname'
 require 'progress_bar'
 require 'parallel'
-require 'jsonlint'
 require 'chroma'
 require 'securerandom'
 
@@ -32,17 +32,65 @@ module Fastlane
         UI.user_error!('`drawText` not found – install it using `brew install automattic/build-tools/drawText`.') unless system('command -v drawText')
       end
 
-      def read_json(configFilePath)
+      def read_config(configFilePath)
         configFilePath = resolve_path(configFilePath)
 
         begin
-          return JSON.parse(open(configFilePath).read)
-        rescue
-          linter = JsonLint::Linter.new
-          linter.check(configFilePath)
-          linter.display_errors
+          # NOTE: While JSON is a subset of YAML and thus YAML.load_file would technically cover both cases at once, in practice
+          # `JSON.parse` is more lenient with JSON files than `YAML.load_file` is — especially, it accepts `// comments` in the
+          # JSON file, despite this not being allowed in the spec — hence why we still try with `JSON.parse` for `.json` files.
+          return File.extname(configFilePath) == '.json' ? JSON.parse(File.read(configFilePath)) : YAML.load_file(configFilePath)
+        rescue StandardError => e
+          UI.error(e)
+          UI.user_error!('Invalid JSON/YAML configuration. Please lint your config file to check for syntax errors.')
+        end
+      end
 
-          UI.user_error!('Invalid JSON configuration. See errors in log.')
+      # Checks that all required fonts are installed
+      #  - Visits the JSON config to find all the stylesheets referenced in it
+      #  - For each stylesheet, extract the first font of each `font-family` attribute found
+      #  - Finally, for each of those fonts, check that they exist and are activated.
+      #
+      # @param [Hash] config The promo screenshots configuration, as returned by #read_config
+      # @raise [UserError] Raises if at least one font is missing.
+      #
+      def check_fonts_installed!(config:)
+        # Find all stylesheets in the config
+        all_stylesheets = ([config['stylesheet']] + config['entries'].flat_map do |entry|
+          entry['attachments']&.map { |att| att['stylesheet'] }
+        end).compact.uniq
+
+        # Parse the first font in each `font-family` attribute found in all found CSS files.
+        # Only the first in each `font-family` font list matters, as others are fallbacks we don't want to use anyway.
+        font_families = all_stylesheets.flat_map do |s|
+          File.readlines(s).flat_map do |line|
+            attr = line.match(/font-family: (.*);/)&.captures&.first
+            attr.split(',').first.strip.gsub(/'(.*)'/, '\1').gsub(/"(.*)"/, '\1') unless attr.nil?
+          end
+        end.compact.uniq
+
+        # Verify that all fonts exists and are active—using a small swift script as there's no nice CLI for that
+        swift_script = <<~SWIFT
+          import AppKit
+
+          var exitCode: Int32 = 0
+          for fontName in CommandLine.arguments.dropFirst() {
+              if NSFont(name: fontName, size: NSFont.systemFontSize) != nil {
+                  print(" ✅ Font \\"\\(fontName)\\" found and active")
+              } else {
+                  print(" ❌ Font \\"\\(fontName)\\" not found, it is either not installed or disabled. Please install it using FontBook first.")
+                  exitCode = 1
+              }
+          }
+          exit(exitCode)
+        SWIFT
+
+        Tempfile.create(['fonts-check-', '.swift']) do |f|
+          f.write(swift_script)
+          f.close
+          oe, s = Open3.capture2e('/usr/bin/env', 'xcrun', 'swift', f.path, *font_families)
+          UI.command_output(oe)
+          UI.user_error!('Some fonts required by your stylesheets are missing. Please install them and try again.') unless s.success?
         end
       end
 
@@ -343,8 +391,8 @@ module Fastlane
       def open_image(path)
         path = resolve_path(path)
 
-        Magick::Image.read(path)  do
-          self.background_color = 'transparent'
+        Magick::Image.read(path) do |image|
+          image.background_color = 'transparent'
         end.first
       end
 

data/lib/fastlane/plugin/wpmreleasetoolkit/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module Wpmreleasetoolkit
-    VERSION = '6.0.0'
+    VERSION = '6.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-wpmreleasetoolkit
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 6.1.0
 platform: ruby
 authors:
 - Automattic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-17 00:00:00.000000000 Z
+date: 2022-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: jsonlint
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement