fastlane 2.135.2 → 2.140.0

data/pilot/lib/pilot/options.rb

@@ -132,7 +132,9 @@ module Pilot
         FastlaneCore::ConfigItem.new(key: :skip_waiting_for_build_processing,
                                      short_option: "-z",
                                      env_name: "PILOT_SKIP_WAITING_FOR_BUILD_PROCESSING",
-                                     description: "Don't wait for the build to process. If set to true, the changelog won't be set, `distribute_external` option won't work and no build will be distributed to testers. (You might want to use this option if you are using this action on CI and have to pay for 'minutes used' on your CI plan)",
+                                     description: "If set to true, the `distribute_external` option won't work and no build will be distributed to testers. " \
+                                      "(You might want to use this option if you are using this action on CI and have to pay for 'minutes used' on your CI plan). " \
+                                      "If set to `true` and a changelog is provided, it will partially wait for the build to appear on AppStore Connect so the changelog can be set, and skip the remaining processing steps",
                                      is_string: false,
                                      default_value: false),
         FastlaneCore::ConfigItem.new(key: :update_build_info_on_upload,

data/scan/lib/scan/detect_values.rb

@@ -108,7 +108,7 @@ module Scan
     def self.detect_simulator(devices, requested_os_type, deployment_target_key, default_device_name, simulator_type_descriptor)
       require 'set'
 
-      deployment_target_version = Scan.project.build_settings(key: deployment_target_key) || '0'
+      deployment_target_version = get_deployment_target_version(deployment_target_key)
 
       simulators = filter_simulators(
         FastlaneCore::DeviceManager.simulators(requested_os_type).tap do |array|
@@ -215,5 +215,10 @@ module Scan
         Scan.config[:destination] = min_xcode8? ? ["platform=macOS"] : ["platform=OS X"]
       end
     end
+
+    # get deployment target version
+    def self.get_deployment_target_version(deployment_target_key)
+      Scan.config[:deployment_target_version] || Scan.project.build_settings(key: deployment_target_key) || '0'
+    end
   end
 end

data/scan/lib/scan/manager.rb

@@ -4,8 +4,13 @@ require_relative 'runner'
 
 module Scan
   class Manager
+    attr_accessor :plist_files_before
+
     def work(options)
-      Scan.config = options
+      Scan.config = options # we set this here to auto-detect missing values, which we need later on
+      unless options[:derived_data_path].to_s.empty?
+        self.plist_files_before = test_summary_filenames(Scan.config[:derived_data_path])
+      end
 
       # Also print out the path to the used Xcode installation
       # We go 2 folders up, to not show "Contents/Developer/"
@@ -17,5 +22,17 @@ module Scan
 
       return Runner.new.run
     end
+
+    def test_summary_filenames(derived_data_path)
+      files = []
+
+      # Xcode < 10
+      files += Dir["#{derived_data_path}/**/Logs/Test/*TestSummaries.plist"]
+
+      # Xcode 10
+      files += Dir["#{derived_data_path}/**/Logs/Test/*.xcresult/TestSummaries.plist"]
+
+      return files
+    end
   end
 end

data/scan/lib/scan/options.rb

@@ -81,6 +81,11 @@ module Scan
                                      description: "Enabling this option will automatically erase the simulator before running the application",
                                      default_value: false,
                                      type: Boolean),
+        FastlaneCore::ConfigItem.new(key: :disable_slide_to_type,
+                                     env_name: 'SCAN_DISABLE_SLIDE_TO_TYPE',
+                                     description: "Enabling this option will disable the simulator from showing the 'Slide to type' prompt",
+                                     default_value: true,
+                                     type: Boolean),
         FastlaneCore::ConfigItem.new(key: :prelaunch_simulator,
                                      env_name: 'SCAN_PRELAUNCH_SIMULATOR',
                                      description: "Enabling this option will launch the first simulator prior to calling any xcodebuild command",
@@ -311,6 +316,18 @@ module Scan
                                        UI.user_error!("File not found at path '#{File.expand_path(value)}'") unless File.exist?(value)
                                      end),
 
+        # build settings
+        FastlaneCore::ConfigItem.new(key: :app_name,
+                                    env_name: "SCAN_APP_NAME",
+                                    optional: true,
+                                    description: "App name to use in slack message and logfile name",
+                                    is_string: true),
+        FastlaneCore::ConfigItem.new(key: :deployment_target_version,
+                                    env_name: "SCAN_DEPLOYMENT_TARGET_VERSION",
+                                    optional: true,
+                                    description: "Target version of the app being build or tested. Used to filter out simulator version",
+                                    is_string: true),
+
         # slack
         FastlaneCore::ConfigItem.new(key: :slack_url,
                                      short_option: "-i",

data/scan/lib/scan/runner.rb

@@ -31,6 +31,12 @@ module Scan
         end
       end
 
+      if Scan.config[:disable_slide_to_type]
+        Scan.devices.each do |device|
+          FastlaneCore::Simulator.disable_slide_to_type(udid: device.udid)
+        end
+      end
+
       # We call this method, to be sure that all other simulators are killed
       # And a correct one is freshly launched. Switching between multiple simulator
       # in case the user specified multiple targets works with no issues

data/scan/lib/scan/slack_poster.rb

@@ -44,7 +44,7 @@ module Scan
       end
 
       Fastlane::Actions::SlackAction.run({
-        message: "#{Scan.project.app_name} Tests:\n#{Scan.config[:slack_message]}",
+        message: "#{Scan.config[:app_name] || Scan.project.app_name} Tests:\n#{Scan.config[:slack_message]}",
         channel: channel,
         slack_url: Scan.config[:slack_url].to_s,
         success: results[:build_errors].to_i == 0 && results[:failures].to_i == 0,

data/scan/lib/scan/test_command_generator.rb

@@ -120,7 +120,7 @@ module Scan
 
     # Store the raw file
     def xcodebuild_log_path
-      file_name = "#{Scan.project.app_name}-#{Scan.config[:scheme]}.log"
+      file_name = "#{Scan.config[:app_name] || Scan.project.app_name}-#{Scan.config[:scheme]}.log"
       containing = File.expand_path(Scan.config[:buildlog_path])
       FileUtils.mkdir_p(containing)
 

data/screengrab/lib/screengrab/module.rb

@@ -1,4 +1,5 @@
 require 'fastlane_core/helper'
+require 'fastlane/boolean'
 require_relative 'detect_values'
 
 module Screengrab
@@ -19,6 +20,7 @@ module Screengrab
 
   Helper = FastlaneCore::Helper # you gotta love Ruby: Helper.* should use the Helper class contained in FastlaneCore
   UI = FastlaneCore::UI
+  Boolean = Fastlane::Boolean
   ROOT = Pathname.new(File.expand_path('../../..', __FILE__))
   DESCRIPTION = "Automated localized screenshots of your Android app on every device".freeze
 end

data/screengrab/lib/screengrab/options.rb

@@ -32,7 +32,7 @@ module Screengrab
                                      env_name: 'SCREENGRAB_CLEAR_PREVIOUS_SCREENSHOTS',
                                      description: "Enabling this option will automatically clear previously generated screenshots before running screengrab",
                                      default_value: false,
-                                     is_string: false),
+                                     type: Boolean),
         FastlaneCore::ConfigItem.new(key: :output_directory,
                                      short_option: "-o",
                                      env_name: "SCREENGRAB_OUTPUT_DIRECTORY",
@@ -43,7 +43,7 @@ module Screengrab
                                      description: "Don't open the summary after running _screengrab_",
                                      default_value: DEFAULT_SKIP_OPEN_SUMMARY,
                                      default_value_dynamic: true,
-                                     is_string: false),
+                                     type: Boolean),
         FastlaneCore::ConfigItem.new(key: :app_package_name,
                                      env_name: 'SCREENGRAB_APP_PACKAGE_NAME',
                                      short_option: "-a",
@@ -68,22 +68,26 @@ module Screengrab
                                      type: Array,
                                      description: "Only run tests in these Java classes"),
         FastlaneCore::ConfigItem.new(key: :launch_arguments,
-                                      env_name: 'SCREENGRAB_LAUNCH_ARGUMENTS',
-                                      optional: true,
-                                      short_option: "-e",
-                                      type: Array,
-                                      description: "Additional launch arguments"),
+                                     env_name: 'SCREENGRAB_LAUNCH_ARGUMENTS',
+                                     optional: true,
+                                     short_option: "-e",
+                                     type: Array,
+                                     description: "Additional launch arguments"),
         FastlaneCore::ConfigItem.new(key: :test_instrumentation_runner,
                                      env_name: 'SCREENGRAB_TEST_INSTRUMENTATION_RUNNER',
                                      optional: true,
-                                     default_value: 'android.support.test.runner.AndroidJUnitRunner',
+                                     default_value: 'androidx.test.runner.AndroidJUnitRunner',
                                      description: "The fully qualified class name of your test instrumentation runner"),
         FastlaneCore::ConfigItem.new(key: :ending_locale,
                                      env_name: 'SCREENGRAB_ENDING_LOCALE',
                                      optional: true,
-                                     is_string: true,
                                      default_value: 'en-US',
                                      description: "Return the device to this locale after running tests"),
+        FastlaneCore::ConfigItem.new(key: :use_adb_root,
+                                     env_name: 'SCREENGRAB_USE_ADB_ROOT',
+                                     description: "Restarts the adb daemon using `adb root` to allow access to screenshots directories on device. Use if getting 'Permission denied' errors",
+                                     default_value: false,
+                                     type: Boolean),
         FastlaneCore::ConfigItem.new(key: :app_apk_path,
                                      env_name: 'SCREENGRAB_APP_APK_PATH',
                                      optional: true,
@@ -123,12 +127,21 @@ module Screengrab
                                      env_name: 'EXIT_ON_TEST_FAILURE',
                                      description: "Whether or not to exit Screengrab on test failure. Exiting on failure will not copy sceenshots to local machine nor open sceenshots summary",
                                      default_value: true,
-                                     is_string: false),
+                                     type: Boolean),
         FastlaneCore::ConfigItem.new(key: :reinstall_app,
                                      env_name: 'SCREENGRAB_REINSTALL_APP',
                                      description: "Enabling this option will automatically uninstall the application before running it",
                                      default_value: false,
-                                     is_string: false)
+                                     type: Boolean),
+        FastlaneCore::ConfigItem.new(key: :use_timestamp_suffix,
+                                     env_name: 'SCREENGRAB_USE_TIMESTAMP_SUFFIX',
+                                     description: "Add timestamp suffix to screenshot filename",
+                                     default_value: true,
+                                     type: Boolean),
+        FastlaneCore::ConfigItem.new(key: :adb_host,
+                                     env_name: 'SCREENGRAB_ADB_HOST',
+                                     description: "Configure the host used by adb to connect, allows running on remote devices farm",
+                                     optional: true)
       ]
     end
   end

data/screengrab/lib/screengrab/runner.rb

@@ -1,5 +1,6 @@
 require 'fastlane_core/print_table'
 require 'fastlane_core/command_executor'
+require 'fastlane/helper/adb_helper'
 require_relative 'reports_generator'
 require_relative 'module'
 
@@ -57,8 +58,13 @@ module Screengrab
 
       device_screenshots_paths = [
         determine_external_screenshots_path(device_serial),
-        determine_internal_screenshots_path
-      ]
+        determine_internal_screenshots_paths(@config[:app_package_name], @config[:locales])
+      ].flatten
+
+      # Root is needed to access device paths at /data
+      if @config[:use_adb_root]
+        run_adb_command("root", print_all: false, print_command: true)
+      end
 
       clear_device_previous_screenshots(device_serial, device_screenshots_paths)
 
@@ -67,6 +73,8 @@ module Screengrab
 
       validate_apk(app_apk_path)
 
+      enable_clean_status_bar(device_serial, app_apk_path)
+
       run_tests(device_serial, app_apk_path, tests_apk_path, test_classes_to_use, test_packages_to_use, @config[:launch_arguments])
 
       number_of_screenshots = pull_screenshots_from_device(device_serial, device_screenshots_paths, device_type_dir_name)
@@ -77,35 +85,26 @@ module Screengrab
     end
 
     def select_device
-      devices = run_adb_command("adb devices -l", print_all: true, print_command: true).split("\n")
-      # the first output by adb devices is "List of devices attached" so remove that and any adb startup output
-      devices.reject! do |device|
-        [
-          'server is out of date',    # The adb server is out of date and must be restarted
-          'unauthorized',             # The device has not yet accepted ADB control
-          'offline',                  # The device is offline, skip it
-          '* daemon',                 # Messages printed when the daemon is starting up
-          'List of devices attached', # Header of table for data we want
-          "doesn't match this client" # Message printed when there is an ADB client/server version mismatch
-        ].any? { |status| device.include?(status) }
-      end
+      adb = Fastlane::Helper::AdbHelper.new(adb_host: @config[:adb_host])
+      devices = adb.load_all_devices
 
       UI.user_error!('There are no connected and authorized devices or emulators') if devices.empty?
 
-      devices.select! { |d| d.include?(@config[:specific_device]) } if @config[:specific_device]
+      specific_device = @config[:specific_device]
+      if specific_device
+        devices.select! do |d|
+          d.serial.include?(specific_device)
+        end
+      end
 
-      UI.user_error!("No connected devices matched your criteria: #{@config[:specific_device]}") if devices.empty?
+      UI.user_error!("No connected devices matched your criteria: #{specific_device}") if devices.empty?
 
       if devices.length > 1
         UI.important("Multiple connected devices, selecting the first one")
         UI.important("To specify which connected device to use, use the -s (specific_device) config option")
       end
 
-      # grab the serial number. the lines of output can look like these:
-      # 00c22d4d84aec525       device usb:2148663295X product:bullhead model:Nexus_5X device:bullhead
-      # 192.168.1.100:5555       device usb:2148663295X product:bullhead model:Nexus_5X device:genymotion
-      # emulator-5554       device usb:2148663295X product:bullhead model:Nexus_5X device:emulator
-      devices[0].match(/^\S+/)[0]
+      devices.first.serial
     end
 
     def select_app_apk(discovered_apk_paths)
@@ -139,15 +138,19 @@ module Screengrab
       # 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"
-      device_ext_storage = run_adb_command("adb -s #{device_serial} #{command}",
+      device_ext_storage = run_adb_command("-s #{device_serial} #{command}",
                                            print_all: true,
                                            print_command: true)
       device_ext_storage = device_ext_storage.strip
       File.join(device_ext_storage, @config[:app_package_name], 'screengrab')
     end
 
-    def determine_internal_screenshots_path
-      "/data/data/#{@config[:app_package_name]}/app_screengrab"
+    def determine_internal_screenshots_paths(app_package_name, locales)
+      locale_paths = locales.map do |locale|
+        "/data/user/0/#{app_package_name}/files/#{app_package_name}/screengrab/#{locale}/images/screenshots"
+      end
+
+      return ["/data/data/#{app_package_name}/app_screengrab"] + locale_paths
     end
 
     def clear_device_previous_screenshots(device_serial, device_screenshots_paths)
@@ -155,7 +158,7 @@ module Screengrab
 
       device_screenshots_paths.each do |device_path|
         if_device_path_exists(device_serial, device_path) do |path|
-          run_adb_command("adb -s #{device_serial} shell rm -rf #{path}",
+          run_adb_command("-s #{device_serial} shell rm -rf #{path}",
                           print_all: true,
                           print_command: true)
         end
@@ -182,13 +185,13 @@ module Screengrab
 
     def install_apks(device_serial, app_apk_path, tests_apk_path)
       UI.message('Installing app APK')
-      apk_install_output = run_adb_command("adb -s #{device_serial} install -t -r #{app_apk_path.shellescape}",
+      apk_install_output = run_adb_command("-s #{device_serial} install -t -r #{app_apk_path.shellescape}",
                                            print_all: true,
                                            print_command: true)
       UI.user_error!("App APK could not be installed") if apk_install_output.include?("Failure [")
 
       UI.message('Installing tests APK')
-      apk_install_output = run_adb_command("adb -s #{device_serial} install -t -r #{tests_apk_path.shellescape}",
+      apk_install_output = run_adb_command("-s #{device_serial} install -t -r #{tests_apk_path.shellescape}",
                                            print_all: true,
                                            print_command: true)
       UI.user_error!("Tests APK could not be installed") if apk_install_output.include?("Failure [")
@@ -199,14 +202,14 @@ module Screengrab
 
       if packages.include?(app_package_name.to_s)
         UI.message('Uninstalling app APK')
-        run_adb_command("adb -s #{device_serial} uninstall #{app_package_name}",
+        run_adb_command("-s #{device_serial} uninstall #{app_package_name}",
                         print_all: true,
                         print_command: true)
       end
 
       if packages.include?(tests_package_name.to_s)
         UI.message('Uninstalling tests APK')
-        run_adb_command("adb -s #{device_serial} uninstall #{tests_package_name}",
+        run_adb_command("-s #{device_serial} uninstall #{tests_package_name}",
                         print_all: true,
                         print_command: true)
       end
@@ -214,20 +217,16 @@ module Screengrab
 
     def grant_permissions(device_serial)
       UI.message('Granting the permission necessary to change locales on the device')
-      run_adb_command("adb -s #{device_serial} shell pm grant #{@config[:app_package_name]} android.permission.CHANGE_CONFIGURATION",
+      run_adb_command("-s #{device_serial} shell pm grant #{@config[:app_package_name]} android.permission.CHANGE_CONFIGURATION",
                       print_all: true,
                       print_command: true)
 
-      device_api_version = run_adb_command("adb -s #{device_serial} shell getprop ro.build.version.sdk",
-                                           print_all: true,
-                                           print_command: true).to_i
-
-      if device_api_version >= 23
+      if device_api_version(device_serial) >= 23
         UI.message('Granting the permissions necessary to access device external storage')
-        run_adb_command("adb -s #{device_serial} shell pm grant #{@config[:app_package_name]} android.permission.WRITE_EXTERNAL_STORAGE",
+        run_adb_command("-s #{device_serial} shell pm grant #{@config[:app_package_name]} android.permission.WRITE_EXTERNAL_STORAGE",
                         print_all: true,
                         print_command: true)
-        run_adb_command("adb -s #{device_serial} shell pm grant #{@config[:app_package_name]} android.permission.READ_EXTERNAL_STORAGE",
+        run_adb_command("-s #{device_serial} shell pm grant #{@config[:app_package_name]} android.permission.READ_EXTERNAL_STORAGE",
                         print_all: true,
                         print_command: true)
       end
@@ -252,9 +251,10 @@ module Screengrab
     def run_tests_for_locale(locale, device_serial, test_classes_to_use, test_packages_to_use, launch_arguments)
       UI.message("Running tests for locale: #{locale}")
 
-      instrument_command = ["adb -s #{device_serial} shell am instrument --no-window-animation -w",
+      instrument_command = ["-s #{device_serial} shell am instrument --no-window-animation -w",
                             "-e testLocale #{locale.tr('-', '_')}",
                             "-e endingLocale #{@config[:ending_locale].tr('-', '_')}"]
+      instrument_command << "-e appendTimestamp #{@config[:use_timestamp_suffix]}"
       instrument_command << "-e class #{test_classes_to_use.join(',')}" if test_classes_to_use
       instrument_command << "-e package #{test_packages_to_use.join(',')}" if test_packages_to_use
       instrument_command << launch_arguments.map { |item| '-e ' + item }.join(' ') if launch_arguments
@@ -281,10 +281,11 @@ module Screengrab
 
       # Make a temp directory into which to pull the screenshots before they are moved to their final location.
       # This makes directory cleanup easier, as the temp directory will be removed when the block completes.
+
       Dir.mktmpdir do |tempdir|
         device_screenshots_paths.each do |device_path|
           if_device_path_exists(device_serial, device_path) do |path|
-            run_adb_command("adb -s #{device_serial} pull #{path} #{tempdir}",
+            run_adb_command("-s #{device_serial} pull #{path} #{tempdir}",
                             print_all: false,
                             print_command: true)
           end
@@ -347,7 +348,7 @@ module Screengrab
     # Some device commands fail if executed against a device path that does not exist, so this helper method
     # provides a way to conditionally execute a block only if the provided path exists on the device.
     def if_device_path_exists(device_serial, device_path)
-      return if run_adb_command("adb -s #{device_serial} shell ls #{device_path}",
+      return if run_adb_command("-s #{device_serial} shell ls #{device_path}",
                                 print_all: false,
                                 print_command: false).include?('No such file')
 
@@ -359,7 +360,7 @@ module Screengrab
 
     # Return an array of packages that are installed on the device
     def installed_packages(device_serial)
-      packages = run_adb_command("adb -s #{device_serial} shell pm list packages",
+      packages = run_adb_command("-s #{device_serial} shell pm list packages",
                                  print_all: true,
                                  print_command: true)
       packages.split("\n").map { |package| package.gsub("package:", "") }
@@ -367,7 +368,9 @@ module Screengrab
 
     def run_adb_command(command, print_all: false, print_command: false)
       adb_path = @android_env.adb_path.chomp("adb")
-      output = @executor.execute(command: adb_path + command,
+      adb_host = @config[:adb_host]
+      host = adb_host.nil? ? '' : "-H #{adb_host} "
+      output = @executor.execute(command: adb_path + "adb " + host + command,
                                  print_all: print_all,
                                  print_command: print_command) || ''
       output.lines.reject do |line|
@@ -375,5 +378,39 @@ module Screengrab
         line.start_with?('adb: ')
       end.join('') # Lines retain their newline chars
     end
+
+    def device_api_version(device_serial)
+      run_adb_command("-s #{device_serial} shell getprop ro.build.version.sdk",
+                      print_all: true, print_command: true).to_i
+    end
+
+    def enable_clean_status_bar(device_serial, app_apk_path)
+      return unless device_api_version(device_serial) >= 23
+
+      unless @android_env.aapt_path
+        UI.error("The `aapt` command could not be found, so status bar could not be cleaned. Make sure android_home is configured for screengrab or ANDROID_HOME is set in the environment")
+        return
+      end
+
+      # Check if the app wants to use the clean status bar feature
+      badging_dump = @executor.execute(command: "#{@android_env.aapt_path} dump badging #{app_apk_path}",
+                                       print_all: true, print_command: true)
+      return unless badging_dump.include?('uses-feature: name=\'tools.fastlane.screengrab.cleanstatusbar\'')
+
+      UI.message('Enabling clean status bar')
+
+      # Make sure the app requests the DUMP permission
+      unless badging_dump.include?('uses-permission: name=\'android.permission.DUMP\'')
+        UI.user_error!("The clean status bar feature requires the android.permission.DUMP permission but it could not be found in your app APK")
+      end
+
+      # Grant the DUMP permission
+      run_adb_command("-s #{device_serial} shell pm grant #{@config[:app_package_name]} android.permission.DUMP",
+                      print_all: true, print_command: true)
+
+      # Enable the SystemUI demo mode
+      run_adb_command("-s #{device_serial} shell settings put global sysui_demo_allowed 1",
+                      print_all: true, print_command: true)
+    end
   end
 end