fastlane 2.146.0 → 2.149.0

data/scan/lib/scan/runner.rb

@@ -148,6 +148,8 @@ module Scan
     end
 
     def test_results
+      return if Scan.config[:disable_xcpretty]
+
       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

@@ -37,8 +37,8 @@ module Scan
       options << "-toolchain '#{config[:toolchain]}'" if config[:toolchain]
       options << "-derivedDataPath '#{config[:derived_data_path]}'" if config[:derived_data_path]
       options << "-resultBundlePath '#{result_bundle_path}'" if config[:result_bundle]
-      options << "-parallel-testing-worker-count #{config[:concurrent_workers]}" if config[:concurrent_workers]
       if FastlaneCore::Helper.xcode_at_least?(10)
+        options << "-parallel-testing-worker-count #{config[:concurrent_workers]}" if config[:concurrent_workers]
         options << "-maximum-concurrent-test-simulator-destinations #{config[:max_concurrent_simulators]}" if config[:max_concurrent_simulators]
         options << "-disable-concurrent-testing" if config[:disable_concurrent_testing]
       end
@@ -47,6 +47,11 @@ module Scan
       options << "-enableThreadSanitizer #{config[:thread_sanitizer] ? 'YES' : 'NO'}" unless config[:thread_sanitizer].nil?
       if FastlaneCore::Helper.xcode_at_least?(11)
         options << "-testPlan '#{config[:testplan]}'" if config[:testplan]
+
+        # detect_values will ensure that these values are present as Arrays if
+        # they are present at all
+        options += config[:only_test_configurations].map { |name| "-only-test-configuration '#{name}'" } if config[:only_test_configurations]
+        options += config[:skip_test_configurations].map { |name| "-skip-test-configuration '#{name}'" } if config[:skip_test_configurations]
       end
       options << "-xctestrun '#{config[:xctestrun]}'" if config[:xctestrun]
       options << config[:xcargs] if config[:xcargs]
@@ -85,7 +90,7 @@ module Scan
     def pipe
       pipe = ["| tee '#{xcodebuild_log_path}'"]
 
-      if Scan.config[:output_style] == 'raw'
+      if Scan.config[:disable_xcpretty] || Scan.config[:output_style] == 'raw'
         return pipe
       end
 

data/scan/lib/scan/test_result_parser.rb

@@ -3,6 +3,13 @@ require_relative 'module'
 module Scan
   class TestResultParser
     def parse_result(output)
+      unless output
+        return {
+            tests: 0,
+            failures: 0
+        }
+      end
+
       # e.g. ...<testsuites tests='2' failures='1'>...
       matched = output.scan(/<testsuites\b(?=[^<>]*\s+tests='(\d+)')(?=[^<>]*\s+failures='(\d+)')[^<>]+>/)
 
@@ -10,13 +17,13 @@ module Scan
         tests = matched[0][0].to_i
         failures = matched[0][1].to_i
 
-        return {
+        {
           tests: tests,
           failures: failures
         }
       else
         UI.error("Couldn't parse the number of tests from the output")
-        return {
+        {
           tests: 0,
           failures: 0
         }

data/screengrab/lib/screengrab/runner.rb

@@ -57,7 +57,7 @@ module Screengrab
       device_serial = select_device
 
       device_screenshots_paths = [
-        determine_external_screenshots_path(device_serial),
+        determine_external_screenshots_path(device_serial, @config[:locales]),
         determine_internal_screenshots_paths(@config[:app_package_name], @config[:locales])
       ].flatten
 
@@ -130,7 +130,7 @@ module Screengrab
       Dir.glob(File.join(output_directory, '**', device_type, '*.png'), File::FNM_CASEFOLD)
     end
 
-    def determine_external_screenshots_path(device_serial)
+    def determine_external_screenshots_path(device_serial, locales)
       # macOS evaluates $foo in `echo $foo` before executing the command,
       # Windows doesn't - hence the double backslash vs. single backslash
       command = Helper.windows? ? "shell echo \$EXTERNAL_STORAGE " : "shell echo \\$EXTERNAL_STORAGE"
@@ -138,22 +138,23 @@ module Screengrab
                                            print_all: true,
                                            print_command: true)
       device_ext_storage = device_ext_storage.strip
-      File.join(device_ext_storage, @config[:app_package_name], 'screengrab')
+      return locales.map do |locale|
+        File.join(device_ext_storage, @config[:app_package_name], 'screengrab', locale, "images", "screenshots")
+      end.flatten
     end
 
     def determine_internal_screenshots_paths(app_package_name, locales)
-      locale_paths = locales.map do |locale|
+      return locales.map do |locale|
         [
           "/data/user/0/#{app_package_name}/files/#{app_package_name}/screengrab/#{locale}/images/screenshots",
 
           # https://github.com/fastlane/fastlane/issues/15653#issuecomment-578541663
-          "/data/data/#{app_package_name}/files/#{app_package_name}/screengrab/#{locale}/images/screenshots"
+          "/data/data/#{app_package_name}/files/#{app_package_name}/screengrab/#{locale}/images/screenshots",
+
+          "/data/data/#{app_package_name}/app_screengrab/#{locale}/images/screenshots",
+          "/data/data/#{app_package_name}/screengrab/#{locale}/images/screenshots"
         ]
       end.flatten
-
-      return ["/data/data/#{app_package_name}/app_screengrab"] +
-             ["/data/data/#{app_package_name}/screengrab"] +
-             locale_paths
     end
 
     def clear_device_previous_screenshots(device_serial, device_screenshots_paths)

data/sigh/lib/sigh/commands_generator.rb

@@ -26,6 +26,7 @@ module Sigh
       program :help_formatter, :compact
 
       global_option('--verbose') { FastlaneCore::Globals.verbose = true }
+      global_option('--env STRING[,STRING2]', String, 'Add environment(s) to use with `dotenv`')
 
       command :renew do |c|
         c.syntax = 'fastlane sigh renew'

data/sigh/lib/sigh/options.rb

@@ -153,7 +153,13 @@ module Sigh
                                      env_name: "SIGH_PROVISIONING_PROFILE_TEMPLATE_NAME",
                                      description: "The name of provisioning profile template. If the developer account has provisioning profile templates (aka: custom entitlements), the template name can be found by inspecting the Entitlements drop-down while creating/editing a provisioning profile (e.g. \"Apple Pay Pass Suppression Development\")",
                                      optional: true,
-                                     default_value: nil)
+                                     default_value: nil),
+        FastlaneCore::ConfigItem.new(key: :fail_on_name_taken,
+                                     env_name: "SIGH_FAIL_ON_NAME_TAKEN",
+                                     description: "Should the command fail if it was about to create a duplicate of an existing provisioning profile. It can happen due to issues on Apple Developer Portal, when profile to be recreated was not properly deleted first",
+                                     optional: true,
+                                     is_string: false,
+                                     default_value: false)
       ]
     end
   end

data/sigh/lib/sigh/runner.rb

@@ -125,7 +125,8 @@ module Sigh
       name = Sigh.config[:provisioning_name] || [bundle_id, profile_type.pretty_type].join(' ')
 
       unless Sigh.config[:skip_fetch_profiles]
-        if Spaceship.provisioning_profile.all.find { |p| p.name == name }
+        if Spaceship.provisioning_profile.all(mac: Sigh.config[:platform].to_s == 'macos').find { |p| p.name == name }
+          UI.user_error!("The name '#{name}' is already taken, and fail_on_name_taken is true") if Sigh.config[:fail_on_name_taken]
           UI.error("The name '#{name}' is already taken, using another one.")
           name += " #{Time.now.to_i}"
         end

data/snapshot/lib/assets/SnapfileTemplate

@@ -27,6 +27,9 @@
 # remove the '#' to clear all previously generated screenshots before creating new ones
 # clear_previous_screenshots(true)
 
+# Remove the '#' to set the status bar to 9:41 AM, and show full battery and reception.
+# override_status_bar(true)
+
 # Arguments to pass to the app on launch. See https://docs.fastlane.tools/actions/snapshot/#launch-arguments
 # launch_arguments(["-favColor red"])
 

data/snapshot/lib/assets/SnapshotHelper.swift

@@ -38,22 +38,13 @@ func snapshot(_ name: String, timeWaitingForIdle timeout: TimeInterval = 20) {
 }
 
 enum SnapshotError: Error, CustomDebugStringConvertible {
-    case cannotDetectUser
-    case cannotFindHomeDirectory
     case cannotFindSimulatorHomeDirectory
-    case cannotAccessSimulatorHomeDirectory(String)
     case cannotRunOnPhysicalDevice
 
     var debugDescription: String {
         switch self {
-        case .cannotDetectUser:
-            return "Couldn't find Snapshot configuration files - can't detect current user "
-        case .cannotFindHomeDirectory:
-            return "Couldn't find Snapshot configuration files - can't detect `Users` dir"
         case .cannotFindSimulatorHomeDirectory:
             return "Couldn't find simulator home location. Please, check SIMULATOR_HOST_HOME env variable."
-        case .cannotAccessSimulatorHomeDirectory(let simulatorHostHome):
-            return "Can't prepare environment. Simulator home location is inaccessible. Does \(simulatorHostHome) exist?"
         case .cannotRunOnPhysicalDevice:
             return "Can't use Snapshot on a physical device."
         }
@@ -75,7 +66,7 @@ open class Snapshot: NSObject {
         Snapshot.waitForAnimations = waitForAnimations
 
         do {
-            let cacheDir = try pathPrefix()
+            let cacheDir = try getCacheDirectory()
             Snapshot.cacheDirectory = cacheDir
             setLanguage(app)
             setLocale(app)
@@ -206,34 +197,22 @@ open class Snapshot: NSObject {
         _ = XCTWaiter.wait(for: [networkLoadingIndicatorDisappeared], timeout: timeout)
     }
 
-    class func pathPrefix() throws -> URL? {
-        let homeDir: URL
+    class func getCacheDirectory() throws -> URL {
+        let cachePath = "Library/Caches/tools.fastlane"
         // on OSX config is stored in /Users/<username>/Library
         // and on iOS/tvOS/WatchOS it's in simulator's home dir
         #if os(OSX)
-            guard let user = ProcessInfo().environment["USER"] else {
-                throw SnapshotError.cannotDetectUser
+            let homeDir = URL(fileURLWithPath: NSHomeDirectory())
+            return homeDir.appendingPathComponent(cachePath)
+        #elseif arch(i386) || arch(x86_64)
+            guard let simulatorHostHome = ProcessInfo().environment["SIMULATOR_HOST_HOME"] else {
+                throw SnapshotError.cannotFindSimulatorHomeDirectory
             }
-
-            guard let usersDir = FileManager.default.urls(for: .userDirectory, in: .localDomainMask).first else {
-                throw SnapshotError.cannotFindHomeDirectory
-            }
-
-            homeDir = usersDir.appendingPathComponent(user)
+            let homeDir = URL(fileURLWithPath: simulatorHostHome)
+            return homeDir.appendingPathComponent(cachePath)
         #else
-            #if arch(i386) || arch(x86_64)
-                guard let simulatorHostHome = ProcessInfo().environment["SIMULATOR_HOST_HOME"] else {
-                    throw SnapshotError.cannotFindSimulatorHomeDirectory
-                }
-                guard let homeDirUrl = URL(string: simulatorHostHome) else {
-                    throw SnapshotError.cannotAccessSimulatorHomeDirectory(simulatorHostHome)
-                }
-                homeDir = URL(fileURLWithPath: homeDirUrl.path)
-            #else
-                throw SnapshotError.cannotRunOnPhysicalDevice
-            #endif
+            throw SnapshotError.cannotRunOnPhysicalDevice
         #endif
-        return homeDir.appendingPathComponent("Library/Caches/tools.fastlane")
     }
 }
 
@@ -300,4 +279,4 @@ private extension CGFloat {
 
 // Please don't remove the lines below
 // They are used to detect outdated configuration files
-// SnapshotHelperVersion [1.21]
+// SnapshotHelperVersion [1.22]

data/snapshot/lib/snapshot/detect_values.rb

@@ -30,6 +30,9 @@ module Snapshot
 
       Snapshot.project.select_scheme(preferred_to_include: "UITests")
 
+      coerce_to_array_of_strings(:only_testing)
+      coerce_to_array_of_strings(:skip_testing)
+
       # Devices
       if config[:devices].nil? && !Snapshot.project.mac?
         config[:devices] = []
@@ -67,5 +70,17 @@ module Snapshot
         config[:devices] = ["Mac"]
       end
     end
+
+    def self.coerce_to_array_of_strings(config_key)
+      config_value = Snapshot.config[config_key]
+
+      return if config_value.nil?
+
+      # splitting on comma allows us to support comma-separated lists of values
+      # from the command line, even though the ConfigItem is not defined as an
+      # Array type
+      config_value = config_value.split(',') unless config_value.kind_of?(Array)
+      Snapshot.config[config_key] = config_value.map(&:to_s)
+    end
   end
 end

data/snapshot/lib/snapshot/options.rb

@@ -5,6 +5,11 @@ require_relative 'module'
 
 module Snapshot
   class Options
+    def self.verify_type(item_name, acceptable_types, value)
+      type_ok = [Array, String].any? { |type| value.kind_of?(type) }
+      UI.user_error!("'#{item_name}' should be of type #{acceptable_types.join(' or ')} but found: #{value.class.name}") unless type_ok
+    end
+
     def self.available_options
       output_directory = (File.directory?("fastlane") ? "fastlane/screenshots" : "screenshots")
 
@@ -111,6 +116,11 @@ module Snapshot
                                      description: "Enabling this option will automatically erase the simulator before running the application",
                                      default_value: false,
                                      is_string: false),
+        FastlaneCore::ConfigItem.new(key: :override_status_bar,
+                                     env_name: 'SNAPSHOT_OVERRIDE_STATUS_BAR',
+                                     description: "Enabling this option wil automatically override the status bar to show 9:41 AM, full battery, and full reception",
+                                     default_value: false,
+                                     is_string: false),
         FastlaneCore::ConfigItem.new(key: :localize_simulator,
                                      env_name: 'SNAPSHOT_LOCALIZE_SIMULATOR',
                                      description: "Enabling this option will configure the Simulator's system language",
@@ -142,6 +152,12 @@ module Snapshot
                                      description: "A list of videos that should be added to the simulator before running the application",
                                      type: Array,
                                      optional: true),
+        FastlaneCore::ConfigItem.new(key: :html_template,
+                                     env_name: 'SNAPSHOT_HTML_TEMPLATE',
+                                     short_option: "-e",
+                                     description: "A path to screenshots.html template",
+                                     default_value: File.join(Snapshot::ROOT, "lib", "snapshot/page.html.erb"),
+                                     optional: true),
 
         # Everything around building
         FastlaneCore::ConfigItem.new(key: :buildlog_path,
@@ -232,6 +248,32 @@ module Snapshot
                                      env_name: "SNAPSHOT_CLONED_SOURCE_PACKAGES_PATH",
                                      description: "Sets a custom path for Swift Package Manager dependencies",
                                      type: String,
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :testplan,
+                                     env_name: "SNAPSHOT_TESTPLAN",
+                                     description: "The testplan associated with the scheme that should be used for testing",
+                                     is_string: true,
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :only_testing,
+                                     env_name: "SNAPSHOT_ONLY_TESTING",
+                                     description: "Array of strings matching Test Bundle/Test Suite/Test Cases to run",
+                                     optional: true,
+                                     is_string: false,
+                                     verify_block: proc do |value|
+                                       verify_type('only_testing', [Array, String], value)
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :skip_testing,
+                                     env_name: "SNAPSHOT_SKIP_TESTING",
+                                     description: "Array of strings matching Test Bundle/Test Suite/Test Cases to skip",
+                                     optional: true,
+                                     is_string: false,
+                                     verify_block: proc do |value|
+                                       verify_type('skip_testing', [Array, String], value)
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :disable_xcpretty,
+                                     env_name: "SNAPSHOT_DISABLE_XCPRETTY",
+                                     description: "Disable xcpretty formatting of build",
+                                     type: Boolean,
                                      optional: true)
       ]
     end

data/snapshot/lib/snapshot/reports_generator.rb

@@ -36,7 +36,7 @@ module Snapshot
         end
       end
 
-      html_path = File.join(Snapshot::ROOT, "lib", "snapshot/page.html.erb")
+      html_path = Snapshot.config[:html_template]
       html = ERB.new(File.read(html_path)).result(binding) # https://web.archive.org/web/20160430190141/www.rrn.dk/rubys-erb-templating-system
 
       export_path = "#{screens_path}/screenshots.html"

data/snapshot/lib/snapshot/simulator_launchers/launcher_configuration.rb

@@ -12,6 +12,7 @@ module Snapshot
     attr_accessor :reinstall_app
     attr_accessor :app_identifier
     attr_accessor :disable_slide_to_type
+    attr_accessor :override_status_bar
 
     # xcode 8
     attr_accessor :number_of_retries
@@ -43,6 +44,7 @@ module Snapshot
       @output_directory = snapshot_config[:output_directory]
       @concurrent_simulators = snapshot_config[:concurrent_simulators]
       @disable_slide_to_type = snapshot_config[:disable_slide_to_type]
+      @override_status_bar = snapshot_config[:override_status_bar]
 
       launch_arguments = Array(snapshot_config[:launch_arguments])
       # if more than 1 set of arguments, use a tuple with an index

data/snapshot/lib/snapshot/simulator_launchers/simulator_launcher.rb

@@ -89,10 +89,14 @@ module Snapshot
         log_path: xcodebuild_log_path(language: language, locale: locale)
       )
 
+      devices.each { |device_type| override_status_bar(device_type) } if launcher_config.override_status_bar
+
       UI.important("Running snapshot on: #{devices.join(', ')}")
 
       execute(command: command, language: language, locale: locale, launch_args: launch_arguments, devices: devices)
 
+      devices.each { |device_type| clear_status_bar(device_type) } if launcher_config.override_status_bar
+
       return copy_screenshots(language: language, locale: locale, launch_args: launch_arguments)
     end
 

data/snapshot/lib/snapshot/simulator_launchers/simulator_launcher_base.rb

@@ -1,4 +1,5 @@
 require 'plist'
+require 'time'
 
 require_relative '../module'
 require_relative '../test_command_generator'
@@ -58,7 +59,9 @@ module Snapshot
 
       device_types.each do |type|
         if launcher_config.erase_simulator || launcher_config.localize_simulator || !launcher_config.dark_mode.nil?
-          erase_simulator(type)
+          if launcher_config.erase_simulator
+            erase_simulator(type)
+          end
           if launcher_config.localize_simulator
             localize_simulator(type, language, locale)
           end
@@ -102,6 +105,26 @@ module Snapshot
       end
     end
 
+    def override_status_bar(device_type)
+      device_udid = TestCommandGenerator.device_udid(device_type)
+
+      UI.message("Launch Simulator #{device_type}")
+      Helper.backticks("xcrun instruments -w #{device_udid} &> /dev/null")
+
+      UI.message("Overriding Status Bar")
+
+      # The time needs to be passed as ISO8601 so the simulator formats it correctly
+      time = Time.new(2007, 1, 9, 9, 41, 0)
+      Helper.backticks("xcrun simctl status_bar #{device_udid} override --time #{time.iso8601} --dataNetwork wifi --wifiMode active --wifiBars 3 --cellularMode active --cellularBars 4 --batteryState charged --batteryLevel 100 &> /dev/null")
+    end
+
+    def clear_status_bar(device_type)
+      device_udid = TestCommandGenerator.device_udid(device_type)
+
+      UI.message("Clearing Status Bar Override")
+      Helper.backticks("xcrun simctl status_bar #{device_udid} clear &> /dev/null")
+    end
+
     def uninstall_app(device_type)
       launcher_config.app_identifier ||= UI.input("App Identifier: ")
       device_udid = TestCommandGenerator.device_udid(device_type)

data/snapshot/lib/snapshot/test_command_generator.rb

@@ -16,20 +16,25 @@ module Snapshot
         parts += build_settings
         parts += actions
         parts += suffix
-        parts += pipe(language: language, locale: locale, log_path: log_path)
+        parts += pipe(log_path: log_path)
 
         return parts
       end
 
-      def pipe(language: nil, locale: nil, log_path: nil)
+      def pipe(log_path: nil)
         tee_command = ['tee']
         tee_command << '-a' if log_path && File.exist?(log_path)
         tee_command << log_path.shellescape if log_path
 
+        pipe = ["| #{tee_command.join(' ')}"]
+        if Snapshot.config[:disable_xcpretty]
+          return pipe
+        end
+
         xcpretty = "xcpretty #{Snapshot.config[:xcpretty_args]}"
         xcpretty << "--no-color" if Helper.colors_disabled?
 
-        return ["| #{tee_command.join(' ')} | #{xcpretty}"]
+        return pipe << "| #{xcpretty}"
       end
 
       def destination(devices)