fastlane 2.177.0 → 2.181.0

data/pilot/lib/pilot/options.rb

@@ -31,6 +31,7 @@ module Pilot
                                      short_option: "-u",
                                      env_name: "PILOT_USERNAME",
                                      description: "Your Apple ID Username",
+                                     optional: true,
                                      default_value: user,
                                      default_value_dynamic: true),
         FastlaneCore::ConfigItem.new(key: :app_identifier,
@@ -182,8 +183,8 @@ module Pilot
         FastlaneCore::ConfigItem.new(key: :notify_external_testers,
                                     is_string: false,
                                     env_name: "PILOT_NOTIFY_EXTERNAL_TESTERS",
-                                    description: "Should notify external testers?",
-                                    default_value: true),
+                                    description: "Should notify external testers? (Not setting a value will use App Store Connect's default which is to notify)",
+                                    optional: true),
         FastlaneCore::ConfigItem.new(key: :app_version,
                                      env_name: "PILOT_APP_VERSION",
                                      description: "The version number of the application build to distribute. If the version number is not specified, then the most recent build uploaded to TestFlight will be distributed. If specified, the most recent build for the version number will be distributed",

data/precheck/lib/precheck/options.rb

@@ -52,6 +52,7 @@ module Precheck
                                      short_option: "-u",
                                      env_name: "PRECHECK_USERNAME",
                                      description: "Your Apple ID Username",
+                                     optional: true,
                                      default_value: user,
                                      default_value_dynamic: true),
         FastlaneCore::ConfigItem.new(key: :team_id,

data/precheck/lib/precheck/runner.rb

@@ -32,6 +32,10 @@ module Precheck
         UI.message("Creating authorization token for App Store Connect API")
         Spaceship::ConnectAPI.token = api_token
       elsif Spaceship::Tunes.client.nil?
+        # Username is now optional since addition of App Store Connect API Key
+        # Force asking for username to prompt user if not already set
+        Precheck.config.fetch(:username, force_ask: true)
+
         # Team selection passed though FASTLANE_ITC_TEAM_ID and FASTLANE_ITC_TEAM_NAME environment variables
         # Prompts select team if multiple teams and none specified
         UI.message("Starting login with user '#{Precheck.config[:username]}'")
@@ -72,7 +76,7 @@ module Precheck
     end
 
     def api_token
-      @api_token ||= Spaceship::ConnectAPI::Token.create(Precheck.config[:api_key]) if Precheck.config[:api_key]
+      @api_token ||= Spaceship::ConnectAPI::Token.create(**Precheck.config[:api_key]) if Precheck.config[:api_key]
       @api_token ||= Spaceship::ConnectAPI::Token.from_json_file(Precheck.config[:api_key_path]) if Precheck.config[:api_key_path]
       return @api_token
     end

data/scan/lib/scan/options.rb

@@ -472,11 +472,16 @@ module Scan
                                      type: Boolean,
                                      default_value: false),
         FastlaneCore::ConfigItem.new(key: :use_system_scm,
-                                     env_name: "SCAN_USE_SYSTEM_SCM",
-                                     description: "Lets xcodebuild use system's scm configuration",
-                                     optional: true,
-                                     type: Boolean,
-                                     default_value: false)
+                                    env_name: "SCAN_USE_SYSTEM_SCM",
+                                    description: "Lets xcodebuild use system's scm configuration",
+                                    optional: true,
+                                    type: Boolean,
+                                    default_value: false),
+        FastlaneCore::ConfigItem.new(key: :number_of_retries,
+                                    env_name: 'SCAN_NUMBER_OF_RETRIES',
+                                    description: "The number of times a test can fail before scan should stop retrying",
+                                    type: Integer,
+                                    default_value: 0)
 
       ]
     end

data/scan/lib/scan/runner.rb

@@ -51,7 +51,14 @@ module Scan
         end
       end
 
+      execute(retries: Scan.config[:number_of_retries])
+    end
+
+    def execute(retries: 0)
+      Scan.cache[:retry_attempt] = Scan.config[:number_of_retries] - retries
+
       command = @test_command_generator.generate
+
       prefix_hash = [
         {
           prefix: "Running Tests: ",
@@ -71,7 +78,12 @@ module Scan
                                               error: proc do |error_output|
                                                 begin
                                                   exit_status = $?.exitstatus
-                                                  ErrorHandler.handle_build_error(error_output, @test_command_generator.xcodebuild_log_path)
+                                                  if retries > 0
+                                                    # If there are retries remaining, run the tests again
+                                                    return retry_execute(retries: retries, error_output: error_output)
+                                                  else
+                                                    ErrorHandler.handle_build_error(error_output, @test_command_generator.xcodebuild_log_path)
+                                                  end
                                                 rescue => ex
                                                   SlackPoster.new.run({
                                                     build_errors: 1
@@ -79,9 +91,50 @@ module Scan
                                                   raise ex
                                                 end
                                               end)
+
       exit_status
     end
 
+    def retry_execute(retries:, error_output: "")
+      tests = retryable_tests(error_output)
+
+      if tests.empty?
+        UI.crash!("Failed to find failed tests to retry (could not parse error output)")
+      end
+
+      Scan.config[:only_testing] = tests
+      UI.important("Retrying tests: #{Scan.config[:only_testing].join(', ')}")
+
+      retries -= 1
+      UI.important("Number of retries remaining: #{retries}")
+
+      return execute(retries: retries)
+    end
+
+    def retryable_tests(input)
+      input = Helper.strip_ansi_colors(input)
+
+      retryable_tests = []
+
+      failing_tests = input.split("Failing tests:\n").fetch(1, [])
+                           .split("\n\n").first
+
+      suites = failing_tests.split(/(?=\n\s+[\w\s]+:\n)/)
+
+      suites.each do |suite|
+        suite_name = suite.match(/\s*([\w\s]+):/).captures.first
+
+        test_cases = suite.split(":\n").fetch(1, []).split("\n").each
+                          .select { |line| line.match?(/^\s+/) }
+                          .map { |line| line.strip.gsub(".", "/").gsub("()", "") }
+                          .map { |line| suite_name + "/" + line }
+
+        retryable_tests += test_cases
+      end
+
+      return retryable_tests.uniq
+    end
+
     def handle_results(tests_exit_status)
       if Scan.config[:disable_xcpretty]
         unless tests_exit_status == 0

data/scan/lib/scan/test_command_generator.rb

@@ -162,16 +162,18 @@ module Scan
       Scan.cache[:build_path]
     end
 
+    # The path to the result bundle
     def result_bundle_path
-      unless Scan.cache[:result_bundle_path]
-        ext = FastlaneCore::Helper.xcode_version.to_i >= 11 ? '.xcresult' : '.test_result'
-        path = File.join(Scan.config[:output_directory], Scan.config[:scheme]) + ext
-        if File.directory?(path)
-          FileUtils.remove_dir(path)
-        end
-        Scan.cache[:result_bundle_path] = path
+      retry_count = Scan.cache[:retry_attempt] || 0
+      attempt = retry_count > 0 ? "-#{retry_count}" : ""
+      ext = FastlaneCore::Helper.xcode_version.to_i >= 11 ? '.xcresult' : '.test_result'
+      path = File.join(Scan.config[:output_directory], Scan.config[:scheme]) + attempt + ext
+      if File.directory?(path)
+        FileUtils.remove_dir(path)
       end
-      return Scan.cache[:result_bundle_path]
+      Scan.cache[:result_bundle_path] = path
+
+      return path
     end
   end
 end

data/screengrab/lib/screengrab/android_environment.rb

@@ -34,22 +34,22 @@ module Screengrab
     def find_platform_tools(android_home)
       return nil unless android_home
 
-      platform_tools_path = File.join(android_home, 'platform-tools')
+      platform_tools_path = Helper.localize_file_path(File.join(android_home, 'platform-tools'))
       File.directory?(platform_tools_path) ? platform_tools_path : nil
     end
 
     def find_build_tools(android_home, build_tools_version)
       return nil unless android_home
 
-      build_tools_dir = File.join(android_home, 'build-tools')
+      build_tools_dir = Helper.localize_file_path(File.join(android_home, 'build-tools'))
 
       return nil unless build_tools_dir && File.directory?(build_tools_dir)
 
-      return File.join(build_tools_dir, build_tools_version) if build_tools_version
+      return Helper.localize_file_path(File.join(build_tools_dir, build_tools_version)) if build_tools_version
 
       version = select_build_tools_version(build_tools_dir)
 
-      return version ? File.join(build_tools_dir, version) : nil
+      return version ? Helper.localize_file_path(File.join(build_tools_dir, version)) : nil
     end
 
     def select_build_tools_version(build_tools_dir)
@@ -74,6 +74,7 @@ module Screengrab
       return FastlaneCore::CommandExecutor.which('adb') unless platform_tools_path
 
       adb_path = Helper.get_executable_path(File.join(platform_tools_path, 'adb'))
+      adb_path = Helper.localize_file_path(adb_path)
       return executable_command?(adb_path) ? adb_path : nil
     end
 
@@ -81,6 +82,7 @@ module Screengrab
       return FastlaneCore::CommandExecutor.which('aapt') unless build_tools_path
 
       aapt_path = Helper.get_executable_path(File.join(build_tools_path, 'aapt'))
+      aapt_path = Helper.localize_file_path(aapt_path)
       return executable_command?(aapt_path) ? aapt_path : nil
     end
 

data/screengrab/lib/screengrab/runner.rb

@@ -308,7 +308,7 @@ module Screengrab
             if out =~ /Permission denied/
               dir = File.dirname(path)
               base = File.basename(path)
-              run_adb_command("-s #{device_serial} shell run-as #{@config[:app_package_name]} 'tar -cC #{dir} #{base}' | tar -xvC #{tempdir}",
+              run_adb_command("-s #{device_serial} shell run-as #{@config[:app_package_name]} \"tar -cC #{dir} #{base}\" | tar -xv -f- -C #{tempdir}",
                               print_all: false,
                               print_command: true)
             end

data/sigh/lib/sigh/download_all.rb

@@ -60,7 +60,7 @@ module Sigh
     end
 
     def api_token
-      api_token ||= Spaceship::ConnectAPI::Token.create(Sigh.config[:api_key]) if Sigh.config[:api_key]
+      api_token ||= Spaceship::ConnectAPI::Token.create(**Sigh.config[:api_key]) if Sigh.config[:api_key]
       api_token ||= Spaceship::ConnectAPI::Token.from_json_file(Sigh.config[:api_key_path]) if Sigh.config[:api_key_path]
       return api_token
     end

data/sigh/lib/sigh/options.rb

@@ -77,6 +77,7 @@ module Sigh
                                      short_option: "-u",
                                      env_name: "SIGH_USERNAME",
                                      description: "Your Apple ID Username",
+                                     optional: true,
                                      default_value: user,
                                      default_value_dynamic: true),
         FastlaneCore::ConfigItem.new(key: :team_id,

data/sigh/lib/sigh/runner.rb

@@ -21,6 +21,10 @@ module Sigh
         UI.message("Creating authorization token for App Store Connect API")
         Spaceship::ConnectAPI.token = api_token
       else
+        # Username is now optional since addition of App Store Connect API Key
+        # Force asking for username to prompt user if not already set
+        Sigh.config.fetch(:username, force_ask: true)
+
         # Team selection passed though FASTLANE_ITC_TEAM_ID and FASTLANE_ITC_TEAM_NAME environment variables
         # Prompts select team if multiple teams and none specified
         UI.message("Starting login with user '#{Sigh.config[:username]}'")
@@ -60,7 +64,7 @@ module Sigh
     end
 
     def api_token
-      @api_token ||= Spaceship::ConnectAPI::Token.create(Sigh.config[:api_key]) if Sigh.config[:api_key]
+      @api_token ||= Spaceship::ConnectAPI::Token.create(**Sigh.config[:api_key]) if Sigh.config[:api_key]
       @api_token ||= Spaceship::ConnectAPI::Token.from_json_file(Sigh.config[:api_key_path]) if Sigh.config[:api_key_path]
       return @api_token
     end

data/snapshot/lib/assets/SnapshotHelper.swift

@@ -302,4 +302,4 @@ private extension CGFloat {
 
 // Please don't remove the lines below
 // They are used to detect outdated configuration files
-// SnapshotHelperVersion [1.24]
+// SnapshotHelperVersion [1.25]

data/snapshot/lib/snapshot/reports_generator.rb

@@ -84,6 +84,10 @@ module Snapshot
       {
         # snapshot in Xcode 9 saves screenshots with the SIMULATOR_DEVICE_NAME
         # which includes spaces
+        'iPhone 12 Pro Max' => "iPhone 12 Pro Max",
+        'iPhone 12 Pro' => "iPhone 12 Pro",
+        'iPhone 12 mini' => "iPhone 12 mini",
+        'iPhone 12' => "iPhone 12",
         'iPhone 11 Pro Max' => "iPhone 11 Pro Max",
         'iPhone 11 Pro' => "iPhone 11 Pro",
         'iPhone 11' => "iPhone 11",

data/spaceship/README.md

@@ -111,21 +111,11 @@ When your Apple account has 2 factor verification enabled, you'll automatically
 
 #### Web sessions
 
-To generate a web session for your CI machine, use
-
-```sh
-fastlane spaceauth -u user@example.org
-```
-
-This will authenticate you and provide a string that can be transferred to your CI system. Copy everything from `---\n` to your CI server and provide it as environment variable named `FASTLANE_SESSION`. For example:
-
-```
-export FASTLANE_SESSION='---\n- !ruby/object:HTTP::Cookie\n  name: DES5c148586dfd451e55afbaaa5f62418f91\n  value: HSARMTKNSRVTWFla1+yO4gVPowH17VaaaxPFnUdMUegQZxqy1Ie1c2v6bM1vSOzIbuOmrl/FNenlScsd/NbF7/Lw4cpnL15jsyg0TOJwP32tC/NguPiyOaaaU+jrj4tf4uKdIywVaaaFSRVT\n  domain: idmsa.apple.com\n  for_domain: true\n  path: "/"\n  secure: true\n  httponly: true\n  expires: 2016-04-27 23:55:56.000000000 Z\n  max_age: \n  created_at: 2016-03-28 16:55:57.032086000 -07:00\n  accessed_at: 2016-03-28 19:11:17.828141000 -07:00\n'
-```
+See [Continuous Integration > Authenticating with Apple services > Method 2: Two-step or two-factor authentication > Storing a manually verified session using spaceauth](https://docs.fastlane.tools/best-practices/continuous-integration/#storing-a-manually-verified-session-using-spaceauth)
 
 #### Transporter
 
-See [Continuous Integration > Authentication with Apple services > Application specific passwords](https://docs.fastlane.tools/best-practices/continuous-integration/#application-specific-passwords)
+See [Getting Started > iOS > Authentication > Method 3: Application-specific passwords](https://docs.fastlane.tools/getting-started/ios/authentication/#method-3-application-specific-passwords)
 
 ## _spaceship_ in use
 

data/spaceship/lib/spaceship/commands_generator.rb

@@ -39,9 +39,10 @@ module Spaceship
       command :spaceauth do |c|
         c.syntax = 'fastlane spaceship spaceauth'
         c.description = 'Authentication helper for spaceship/fastlane to work with Apple 2-Step/2FA'
+        c.option('--copy_to_clipboard', 'Whether the session string should be copied to clipboard. For more info see https://docs.fastlane.tools/best-practices/continuous-integration/#storing-a-manually-verified-session-using-spaceauth`')
 
         c.action do |args, options|
-          Spaceship::SpaceauthRunner.new(username: options.user).run
+          Spaceship::SpaceauthRunner.new(username: options.user, copy_to_clipboard: options.copy_to_clipboard).run
         end
       end
 

data/spaceship/lib/spaceship/connect_api/models/app_screenshot.rb

@@ -112,7 +112,7 @@ module Spaceship
           timeout_minutes = (ENV["SPACESHIP_SCREENSHOT_UPLOAD_TIMEOUT"] || 20).to_i
 
           loop do
-            # This error handling needs to be revised since any error occured can reach here.
+            # This error handling needs to be revised since any error occurred can reach here.
             # It should handle errors based on what status code is.
             puts("Waiting for screenshots to appear before uploading. This is unlikely to be recovered unless it's 503 error. error=\"#{error}\"")
             sleep(30)

data/spaceship/lib/spaceship/connect_api/models/beta_group.rb

@@ -38,6 +38,11 @@ module Spaceship
         return client.post_bulk_beta_tester_assignments(beta_group_id: id, beta_testers: beta_testers)
       end
 
+      def add_beta_testers(client: nil, beta_tester_ids:)
+        client ||= Spaceship::ConnectAPI
+        return client.add_beta_tester_to_group(beta_group_id: id, beta_tester_ids: beta_tester_ids)
+      end
+
       def update(client: nil, attributes: nil)
         return if attributes.empty?
 

data/spaceship/lib/spaceship/connect_api/testflight/testflight.rb

@@ -275,6 +275,19 @@ module Spaceship
           test_flight_request_client.post("bulkBetaTesterAssignments", body)
         end
 
+        def add_beta_tester_to_group(beta_group_id: nil, beta_tester_ids: nil)
+          beta_tester_ids || []
+          body = {
+            data: beta_tester_ids.map do |id|
+              {
+                type: "betaTesters",
+                id: id
+              }
+            end
+          }
+          test_flight_request_client.post("betaGroups/#{beta_group_id}/relationships/betaTesters", body)
+        end
+
         def delete_beta_tester_from_apps(beta_tester_id: nil, app_ids: [])
           body = {
             data: app_ids.map do |id|

data/spaceship/lib/spaceship/connect_api/token.rb

@@ -37,7 +37,7 @@ module Spaceship
           raise "App Store Connect API key JSON is missing field(s): #{missing_keys.join(', ')}"
         end
 
-        self.create(json)
+        self.create(**json)
       end
 
       def self.create(key_id: nil, issuer_id: nil, filepath: nil, key: nil, is_key_content_base64: false, duration: nil, in_house: nil, **)
@@ -60,14 +60,16 @@ module Spaceship
           key_id: key_id,
           issuer_id: issuer_id,
           key: OpenSSL::PKey::EC.new(key),
+          key_raw: key,
           duration: duration,
           in_house: in_house
         )
       end
 
-      def initialize(key_id: nil, issuer_id: nil, key: nil, duration: nil, in_house: nil)
+      def initialize(key_id: nil, issuer_id: nil, key: nil, key_raw: nil, duration: nil, in_house: nil)
         @key_id = key_id
         @key = key
+        @key_raw = key_raw
         @issuer_id = issuer_id
         @duration = duration
         @in_house = in_house
@@ -97,6 +99,10 @@ module Spaceship
       def expired?
         @expiration < Time.now
       end
+
+      def write_key_to_file(path)
+        File.open(path, 'w') { |f| f.write(@key_raw) }
+      end
     end
   end
 end

data/spaceship/lib/spaceship/spaceauth_runner.rb

@@ -1,15 +1,17 @@
 require 'colored'
 require 'credentials_manager/appfile_config'
 require 'yaml'
+require 'fastlane_core'
 
 require_relative 'tunes/tunes_client'
 
 module Spaceship
   class SpaceauthRunner
-    def initialize(username: nil)
+    def initialize(username: nil, copy_to_clipboard: nil)
       @username = username
       @username ||= CredentialsManager::AppfileConfig.try_fetch_value(:apple_id)
       @username ||= ask("Username: ")
+      @copy_to_clipboard = copy_to_clipboard
     end
 
     def run
@@ -22,7 +24,7 @@ module Spaceship
         puts("Could not login to App Store Connect".red)
         puts("Please check your credentials and try again.".yellow)
         puts("This could be an issue with App Store Connect,".yellow)
-        puts("Please try unsetting the FASTLANE_SESSION environment variable".yellow)
+        puts("Please try unsetting the FASTLANE_SESSION environment variable by calling 'unset FASTLANE_SESSION'".yellow)
         puts("(if it is set) and re-run `fastlane spaceauth`".yellow)
         puts("")
         puts("Exception type: #{ex.class}")
@@ -49,22 +51,30 @@ module Spaceship
         cookie.name.start_with?("myacinfo") || cookie.name == "dqsid" || cookie.name.start_with?("DES")
       end
 
-      yaml = cookies.to_yaml.gsub("\n", "\\n")
+      @yaml = cookies.to_yaml.gsub("\n", "\\n")
 
       puts("---")
       puts("")
       puts("Pass the following via the FASTLANE_SESSION environment variable:")
-      puts(yaml.cyan.underline)
+      puts(@yaml.cyan.underline)
       puts("")
       puts("")
       puts("Example:")
-      puts("export FASTLANE_SESSION='#{yaml}'".cyan.underline)
+      puts("export FASTLANE_SESSION='#{@yaml}'".cyan.underline)
 
-      if mac? && Spaceship::Client::UserInterface.interactive? && agree("🙄 Should fastlane copy the cookie into your clipboard, so you can easily paste it? (y/n)", true)
-        require 'open3'
-        Open3.popen3('pbcopy') { |input, _, _| input << yaml }
-        puts("Successfully copied text into your clipboard 🎨".green)
+      if @copy_to_clipboard == false
+        puts("Skipped asking to copy the session string into your clipboard ⏭️".green)
+      elsif @copy_to_clipboard || (mac? && Spaceship::Client::UserInterface.interactive? && agree("🙄 Should fastlane copy the cookie into your clipboard, so you can easily paste it? (y/n)", true))
+        FastlaneCore::Clipboard.copy(content: @yaml)
+        puts("Successfully copied the session string into your clipboard 🎨".green)
       end
+
+      return self
+    end
+
+    def session_string
+      FastlaneCore::UI.user_error!("`#{__method__}` method called before calling `run` in `SpaceauthRunner`") unless @yaml
+      @yaml
     end
 
     def mac?