fastlane 2.175.0 → 2.180.0

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

@@ -26,12 +26,16 @@ module Precheck
         # There is also a check in Deliver::Runner for this.
         # Please remove check in Deliver when the API support IAPs.
         if Precheck.config[:include_in_app_purchases]
-          UI.user_error!("Precheck cannot check In-app purchases with the App Store Connect API Key (yet). Exclude In-app purchases from precheck or use Apple ID login")
+          UI.user_error!("Precheck cannot check In-app purchases with the App Store Connect API Key (yet). Exclude In-app purchases from precheck, disable the precheck step in your build step, or use Apple ID login")
         end
 
         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/detect_values.rb

@@ -162,7 +162,10 @@ module Scan
               filter_simulators(simulators, :equal, version).tap(&potential_emptiness_error).select(&selector)
             end
           ).tap do |array|
-            UI.error("Ignoring '#{device_string}', couldn’t find matching simulator") if array.empty?
+            if array.empty?
+              UI.test_failure!("No device found with name '#{device_string}'") if Scan.config[:ensure_devices_found]
+              UI.error("Ignoring '#{device_string}', couldn’t find matching simulator")
+            end
           end
         end
 

data/scan/lib/scan/options.rb

@@ -69,6 +69,11 @@ module Scan
                                      default_value: false,
                                      type: Boolean,
                                      optional: true),
+        FastlaneCore::ConfigItem.new(key: :ensure_devices_found,
+                                     description: "Should fail if devices not found",
+                                     default_value: false,
+                                     type: Boolean,
+                                     optional: true),
 
         # simulator management
         FastlaneCore::ConfigItem.new(key: :force_quit_simulator,
@@ -269,6 +274,11 @@ module Scan
                                      optional: true,
                                      is_string: false,
                                      default_value: false),
+        FastlaneCore::ConfigItem.new(key: :output_xctestrun,
+                                     type: Boolean,
+                                     env_name: "SCAN_OUTPUT_XCTESTRUN",
+                                     description: "Should provide additional copy of .xctestrun file (settings.xctestrun) and place in output path?",
+                                     default_value: false),
         FastlaneCore::ConfigItem.new(key: :result_bundle,
                                      short_option: "-z",
                                      env_name: "SCAN_RESULT_BUNDLE",
@@ -462,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,12 @@ module Scan
         end
       end
 
+      execute(retries: Scan.config[:number_of_retries])
+    end
+
+    def execute(retries: 0)
       command = @test_command_generator.generate
+
       prefix_hash = [
         {
           prefix: "Running Tests: ",
@@ -71,7 +76,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 +89,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
@@ -110,6 +161,7 @@ module Scan
 
       copy_simulator_logs
       zip_build_products
+      copy_xctestrun
 
       if result[:failures] > 0
         open_report
@@ -150,6 +202,32 @@ module Scan
       UI.message("Successfully zipped build products: #{output_path}")
     end
 
+    def copy_xctestrun
+      return unless Scan.config[:output_xctestrun]
+
+      # Gets :derived_data_path/Build/Products directory for coping .xctestrun file
+      derived_data_path = Scan.config[:derived_data_path]
+      path = File.join(derived_data_path, "Build", "Products")
+
+      # Gets absolute path of output directory
+      output_directory = File.absolute_path(Scan.config[:output_directory])
+      output_path = File.join(output_directory, "settings.xctestrun")
+
+      # Caching path for action to put into lane_context
+      Scan.cache[:output_xctestrun] = output_path
+
+      # Copy .xctestrun file and moves it to output directory
+      UI.message("Copying .xctestrun file")
+      xctestrun_file = Dir.glob("#{path}/*.xctestrun").first
+
+      if xctestrun_file
+        FileUtils.cp(xctestrun_file, output_path)
+        UI.message("Successfully copied xctestrun file: #{output_path}")
+      else
+        UI.user_error!("Could not find .xctextrun file to copy")
+      end
+    end
+
     def test_results
       temp_junit_report = Scan.cache[:temp_junit_report]
       return File.read(temp_junit_report) if temp_junit_report && File.file?(temp_junit_report)

data/scan/lib/scan/test_command_generator.rb

@@ -162,16 +162,16 @@ 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
+      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
-      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
@@ -392,13 +392,12 @@ module Screengrab
     end
 
     def run_adb_command(command, print_all: false, print_command: false, raise_errors: true)
-      adb_path = @android_env.adb_path.chomp("adb")
       adb_host = @config[:adb_host]
       host = adb_host.nil? ? '' : "-H #{adb_host} "
       output = ''
       begin
         errout = nil
-        cmdout = @executor.execute(command: adb_path + "adb " + host + command,
+        cmdout = @executor.execute(command: @android_env.adb_path + " " + host + command,
                                   print_all: print_all,
                                   print_command: print_command,
                                   error: raise_errors ? nil : proc { |out, status| errout = out }) || ''

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/simulator_launchers/simulator_launcher_base.rb

@@ -69,7 +69,8 @@ module Snapshot
           unless launcher_config.dark_mode.nil?
             interface_style(type, launcher_config.dark_mode)
           end
-        elsif launcher_config.reinstall_app
+        end
+        if launcher_config.reinstall_app && !launcher_config.erase_simulator
           # no need to reinstall if device has been erased
           uninstall_app(type)
         end

data/spaceship/lib/spaceship/client.rb

@@ -134,7 +134,7 @@ module Spaceship
       if teams.count > 1
         puts("The current user is in #{teams.count} teams. Pass a team ID or call `select_team` to choose a team. Using the first one for now.")
       end
-      @current_team_id ||= teams[0]['contentProvider']['contentProviderId']
+      @current_team_id ||= user_details_data['sessionToken']['contentProviderId']
     end
 
     # Set a new team ID which will be used from now on
@@ -171,6 +171,9 @@ module Spaceship
 
       handle_itc_response(response.body)
 
+      # clear user_details_data cache, as session switch will have changed sessionToken attribute
+      @_cached_user_details = nil
+
       @current_team_id = team_id
     end
 
@@ -880,10 +883,7 @@ module Spaceship
         response = @client.send(method, url_or_path, params, headers, &block)
         log_response(method, url_or_path, response, headers, &block)
 
-        resp_hash = response.to_hash
-        if resp_hash[:status] == 401
-          handle_401(response)
-        end
+        handle_error(response)
 
         if response.body.to_s.include?("<title>302 Found</title>")
           raise AppleTimeoutError.new, "Apple 302 detected - this might be temporary server error, check https://developer.apple.com/system-status/ to see if there is a known downtime"
@@ -893,22 +893,23 @@ module Spaceship
           raise BadGatewayError.new, "Apple 502 detected - this might be temporary server error, try again later"
         end
 
-        if resp_hash[:status] == 403
-          msg = "Access forbidden"
-          logger.warn(msg)
-          raise AccessForbiddenError.new, msg
-        elsif resp_hash[:status] == 429
-          raise TooManyRequestsError, resp_hash
-        end
-
         return response
       end
     end
 
-    def handle_401(response)
-      msg = "Auth lost"
-      logger.warn(msg)
-      raise UnauthorizedAccessError.new, "Unauthorized Access"
+    def handle_error(response)
+      case response.status
+      when 401
+        msg = "Auth lost"
+        logger.warn(msg)
+        raise UnauthorizedAccessError.new, "Unauthorized Access"
+      when 403
+        msg = "Access forbidden"
+        logger.warn(msg)
+        raise AccessForbiddenError.new, msg
+      when 429
+        raise TooManyRequestsError, response.to_hash
+      end
     end
 
     def send_request_auto_paginate(method, url_or_path, params, headers, &block)

data/spaceship/lib/spaceship/connect_api/api_client.rb

@@ -150,6 +150,12 @@ module Spaceship
 
       protected
 
+      class TimeoutRetryError < StandardError
+        def initialize(msg)
+          super
+        end
+      end
+
       def with_asc_retry(tries = 5, &_block)
         tries = 1 if Object.const_defined?("SpecHelper")
 
@@ -159,7 +165,7 @@ module Spaceship
 
         if [500, 504].include?(status)
           msg = "Timeout received! Retrying after 3 seconds (remaining: #{tries})..."
-          raise msg
+          raise TimeoutRetryError, msg
         end
 
         return response
@@ -167,7 +173,7 @@ module Spaceship
         # Catch unathorized access and re-raising
         # There is no need to try again
         raise error
-      rescue => error
+      rescue TimeoutRetryError => error
         tries -= 1
         puts(error) if Spaceship::Globals.verbose?
         if tries.zero?
@@ -190,7 +196,7 @@ module Spaceship
 
         raise UnexpectedResponse, response.body['error'] if response.body['error']
 
-        raise UnexpectedResponse, handle_errors(response) if response.body['errors']
+        raise UnexpectedResponse, format_errors(response) if response.body['errors']
 
         raise UnexpectedResponse, "Temporary App Store Connect error: #{response.body}" if response.body['statusCode'] == 'ERROR'
 
@@ -199,11 +205,23 @@ module Spaceship
         return Spaceship::ConnectAPI::Response.new(body: response.body, status: response.status, headers: response.headers, client: self)
       end
 
-      def handle_401(response)
-        raise UnauthorizedAccessError, handle_errors(response) if response && (response.body || {})['errors']
+      # Overridden from Spaceship::Client
+      def handle_error(response)
+        case response.status.to_i
+        when 401
+          raise UnauthorizedAccessError, format_errors(response) if response && (response.body || {})['errors']
+        when 403
+          error = (response.body['errors'] || []).first || {}
+          error_code = error['code']
+          if error_code == "FORBIDDEN.REQUIRED_AGREEMENTS_MISSING_OR_EXPIRED"
+            raise ProgramLicenseAgreementUpdated, format_errors(response) if response && (response.body || {})['errors']
+          else
+            raise AccessForbiddenError, format_errors(response) if response && (response.body || {})['errors']
+          end
+        end
       end
 
-      def handle_errors(response)
+      def format_errors(response)
         # Example error format
         # {
         # "errors":[