fastlane-plugin-test_center 3.14.8 → 3.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 290ab3e6fb5932555e74d834784e80cb441dc4b7e4feb49eda479382a603a1e5
-  data.tar.gz: f46250359e1d156d283dd033e6e8db8c851297ea7a6385d78da4e72a014d0ebd
+  metadata.gz: '09ff419b88b430de488e1e2b4053a89b474f355f903c4cc3cfc4df69286da6f8'
+  data.tar.gz: 80114cde688e0efa5f1f5d6b6ee1f0167bd7cc8119598452fb53acd62945c60b
 SHA512:
-  metadata.gz: aaf987944f48d6511755077c7e4e1c564f722ad8c7f69f8c4e0f24b7c5db62590edc9fc69372e98d19e0cc8b7466f8b3fd2ef2a1ddba472b37bc45c3ee0b12a5
-  data.tar.gz: e1eb52e0b8b396019fe9727af6895948ad675c574b80293c866dfd627752d0e2dc3c8dd11b3e8f7508a40f1f64732a4b2987b1f92938aa6cf21b98d9c0d731d7
+  metadata.gz: b97fe2075ff7a24dead50f00d3a25028566ead76bb1f01ad95d3dd702ebdf33bff942fad7eff475a82c21a4b3caf892af197300ae8d3f4c8a768bb137f9eba35
+  data.tar.gz: 84fc593aee44b48ca43709ae6401e85546867b3b2502cf8000db752738a40fb24410645fb0243f85797e51f8190e46e9c1e9a69b72610342d4d618fb2f597ff2

data/lib/fastlane/plugin/test_center/actions/multi_scan.rb

@@ -13,12 +13,7 @@ module Fastlane
 
     class MultiScanAction < Action
       def self.run(params)
-        params[:quit_simulators] = params._values[:force_quit_simulator] if params._values[:force_quit_simulator]
-        if params[:try_count] < 1
-          UI.important('multi_scan will not test any if :try_count < 0, setting to 1')
-          params[:try_count] = 1
-        end
-
+        update_interdependent_params(params)
         strip_leading_and_trailing_whitespace_from_output_types(params)
 
         warn_of_xcode11_result_bundle_incompatability(params)
@@ -53,6 +48,14 @@ module Fastlane
         summary
       end
 
+      def self.update_interdependent_params(params)
+        params[:quit_simulators] = params._values[:force_quit_simulator] if params._values[:force_quit_simulator]
+        if params[:try_count] < 1
+          UI.important('multi_scan will not test any if :try_count < 0, setting to 1')
+          params[:try_count] = 1
+        end
+      end
+
       def self.warn_of_parallelism_with_circle_ci(params)
         if params[:parallel_testrun_count] > 1 && Helper.is_circle_ci?
           UI.important("Warning: problems have occurreed when running parallel simulators on Circle CI.")
@@ -456,6 +459,22 @@ module Fastlane
             is_string: false,
             default_value: true
           ),
+          FastlaneCore::ConfigItem.new(
+            key: :override_scan_options_block,
+            description: 'A block invoked with a Hash of the scan options that will be used when test run is about to start. This allows your code to modify the arguments that will be sent to scan',
+            optional: true,
+            is_string: false,
+            default_value: nil,
+            type: Proc
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :reuse_simulators_for_parallel_testruns,
+            description: 'Find simulators (or clone new ones) that match the requested device for the parallel test runs. This option sets :pre_delete_cloned_simulators to false',
+            optional: true,
+            is_string: false,
+            type: Boolean,
+            default_value: false
+          ),
           FastlaneCore::ConfigItem.new(
             key: :testrun_completed_block,
             description: 'A block invoked each time a test run completes. When combined with :parallel_testrun_count, will be called separately in each child process. Return a Hash with :continue set to false to stop retrying tests, or :only_testing to change which tests will be run in the next try',
@@ -463,6 +482,14 @@ module Fastlane
             is_string: false,
             default_value: nil,
             type: Proc
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :simulator_started_callback,
+            description: 'A block invoked after the iOS simulators have started',
+            optional: true,
+            is_string: false,
+            default_value: nil,
+            type: Proc
           )
         ]
       end
@@ -492,6 +519,10 @@ module Fastlane
             }
           end
 
+          sim_callback = lambda do |simulator_device_udid|
+            puts \"Start streaming system log for device \#{simulator_device_udid}\"
+          end
+
           multi_scan(
             project: File.absolute_path('../AtomicBoy/AtomicBoy.xcodeproj'),
             scheme: 'AtomicBoy',
@@ -499,7 +530,8 @@ module Fastlane
             batch_count: 4,
             fail_build: false,
             parallel_testrun_count: 4,
-            testrun_completed_block: test_run_block
+            testrun_completed_block: test_run_block,
+            simulator_started_callback: sim_callback
           )
           ",
           "

data/lib/fastlane/plugin/test_center/actions/tests_from_xctestrun.rb

@@ -139,25 +139,32 @@ module Fastlane
           "
           require 'fastlane/actions/scan'
 
-          UI.important(
-            'example: ' \\
-            'get list of tests that are referenced from an xctestrun file'
-          )
-          # build the tests so that we have a xctestrun file to parse
-          scan(
-            build_for_testing: true,
-            workspace: File.absolute_path('../AtomicBoy/AtomicBoy.xcworkspace'),
-            scheme: 'AtomicBoy'
-          )
-
-          # find the xctestrun file
-          derived_data_path = Scan.config[:derived_data_path]
-          xctestrun_file = Dir.glob(\"\#{derived_data_path}/Build/Products/*.xctestrun\").first
+          lane :split_tests do
+            scan(
+              build_for_testing: true,
+              workspace: File.absolute_path('../AtomicBoy/AtomicBoy.xcworkspace'),
+              scheme: 'AtomicBoy'
+            )
+            derived_data_path = Scan.config[:derived_data_path]
+            xctestrun_file = Dir.glob(\"\#{derived_data_path}/Build/Products/*.xctestrun\").first
+            tests = tests_from_xctestrun(xctestrun: xctestrun_file).values.flatten.shuffle
+            slice_size = (tests.size/4.0).ceil
+            tests.each_slice(slice_size).each_with_index do |inner_array, index|
+              File.write(\"test_output/batch\#{index}.txt\", inner_array.join(','))
+            end
+          end
 
-          # get the tests from the xctestrun file
-          tests = tests_from_xctestrun(xctestrun: xctestrun_file)
-          UI.header('xctestrun file contains the following tests')
-          tests.values.flatten.each { |test_identifier| puts test_identifier }
+          lane :run_split_tests do |options|
+            batch_file = File.join('test_output', \"batch\#{options[:batch_index]}.txt\")
+            only_testing = File.read(batch_file).split(',')
+            multi_scan(
+              workspace: File.absolute_path('../AtomicBoy/AtomicBoy.xcworkspace'),
+              scheme: 'AtomicBoy',
+              try_count: 3,
+              fail_build: false,
+              only_testing: only_testing
+            )
+          end
           "
         ]
       end

data/lib/fastlane/plugin/test_center/helper/html_test_report.rb

@@ -8,6 +8,12 @@ module TestCenter
         FastlaneCore::UI.verbose(message)
       end
 
+      def self.error(message)
+        return if ENV.fetch('COLLATE_HTML_REPORTS_VERBOSITY', 1).to_i.zero?
+
+        FastlaneCore::UI.error(message)
+      end
+
       class Report
         require 'rexml/formatters/transitive'
 

data/lib/fastlane/plugin/test_center/helper/multi_scan_manager/device_manager.rb

@@ -18,6 +18,17 @@ module FastlaneCore
         self.name = newname
       end
 
+      def disable_hardware_keyboard
+        UI.verbose("Disabling hardware keyboard for #{self.udid}")
+        plist_filepath = File.expand_path("~/Library/Preferences/com.apple.iphonesimulator.plist")
+        keyboard_pref_key = ":DevicePreferences:#{self.udid}:ConnectHardwareKeyboard"
+
+        command = "/usr/libexec/PlistBuddy -c \"Set #{keyboard_pref_key} false\" #{plist_filepath} 2>/dev/null || "
+        command << "/usr/libexec/PlistBuddy -c \"Add #{keyboard_pref_key} bool false\" #{plist_filepath}"
+
+        `#{command}`
+      end
+
       def boot
         return unless is_simulator
         return unless os_type == "iOS"

data/lib/fastlane/plugin/test_center/helper/multi_scan_manager/retrying_scan.rb

@@ -7,57 +7,6 @@ module TestCenter
           @retrying_scan_helper = RetryingScanHelper.new(@options)
         end
 
-        # :nocov:
-        def scan_config
-          Scan.config
-        end
-
-        def scan_cache
-          Scan.cache
-        end
-        # :nocov:
-
-        def prepare_scan_config
-          # this allows multi_scan's `destination` option to be picked up by `scan`
-          scan_config._values.delete(:device)
-          ENV.delete('SCAN_DEVICE')
-          scan_config._values.delete(:devices)
-          ENV.delete('SCAN_DEVICES')
-          # this prevents double -resultBundlePath args to xcodebuild
-          if ReportNameHelper.includes_xcresult?(@options[:output_types])
-            scan_config._values.delete(:result_bundle)
-            ENV.delete('SCAN_RESULT_BUNDLE')
-          end
-          scan_config._values.delete(:skip_testing)
-          scan_cache.clear
-        end
-
-        def update_scan_options
-          valid_scan_keys = Fastlane::Actions::ScanAction.available_options.map(&:key)
-          scan_options = @options.select { |k,v| valid_scan_keys.include?(k) }
-                                  .merge(@retrying_scan_helper.scan_options)
-
-          prepare_scan_config
-          scan_options[:build_for_testing] = false
-          scan_options.delete(:skip_testing)
-          FastlaneCore::UI.verbose("retrying_scan #update_scan_options")
-          scan_options.each do |k,v|
-            next if v.nil?
-
-            scan_config.set(k,v) unless v.nil?
-            FastlaneCore::UI.verbose("\tSetting #{k.to_s} to #{v}")
-          end
-          if @options[:scan_devices_override]
-            scan_device_names = @options[:scan_devices_override].map { |device| device.name }
-            FastlaneCore::UI.verbose("\tSetting Scan.devices to #{scan_device_names}")
-            if Scan.devices
-              Scan.devices.replace(@options[:scan_devices_override])
-            else
-              Scan.devices = @options[:scan_devices_override]
-            end
-          end
-        end
-
         # :nocov:
         def self.run(options)
           RetryingScan.new(options).run
@@ -68,12 +17,6 @@ module TestCenter
           try_count = @options[:try_count] || 1
           begin
             @retrying_scan_helper.before_testrun
-            update_scan_options
-
-            values = scan_config.values(ask: false)
-            values[:xcode_path] = File.expand_path("../..", FastlaneCore::Helper.xcode_path)
-            ScanHelper.print_scan_parameters(values)
-
             Scan::Runner.new.run
             @retrying_scan_helper.after_testrun
             true

data/lib/fastlane/plugin/test_center/helper/multi_scan_manager/retrying_scan_helper.rb

@@ -23,9 +23,78 @@ module TestCenter
           delete_xcresults # has to be performed _after_ moving a *.test_result
           quit_simulator
           set_json_env
+          set_scan_config
           print_starting_scan_message
         end
 
+        def set_scan_config
+          valid_scan_keys = Fastlane::Actions::ScanAction.available_options.map(&:key)
+          new_scan_options = @options.select { |k,v| valid_scan_keys.include?(k) }
+                                 .merge(scan_options)
+
+          prepare_scan_config
+          new_scan_options[:build_for_testing] = false
+          new_scan_options.delete(:skip_testing)
+
+          new_scan_options = send_callback_override_scan_options_block(new_scan_options)
+
+          FastlaneCore::UI.verbose("retrying_scan #update_scan_options")
+          new_scan_options.each do |k,v|
+            next if v.nil?
+
+            scan_config.set(k,v) unless v.nil?
+            FastlaneCore::UI.verbose("\tSetting #{k.to_s} to #{v}")
+          end
+          if @options[:scan_devices_override]
+            scan_device_names = @options[:scan_devices_override].map { |device| device.name }
+            FastlaneCore::UI.verbose("\tSetting Scan.devices to #{scan_device_names}")
+            if Scan.devices
+              Scan.devices.replace(@options[:scan_devices_override])
+            else
+              Scan.devices = @options[:scan_devices_override]
+            end
+          end
+ 
+          values = scan_config.values(ask: false)
+          values[:xcode_path] = File.expand_path("../..", FastlaneCore::Helper.xcode_path)
+          ScanHelper.print_scan_parameters(values)
+        end
+
+        # :nocov:
+        def scan_config
+          Scan.config
+        end
+
+        def scan_cache
+          Scan.cache
+        end
+        # :nocov:
+
+        def prepare_scan_config
+          # this allows multi_scan's `destination` option to be picked up by `scan`
+          scan_config._values.delete(:device)
+          ENV.delete('SCAN_DEVICE')
+          scan_config._values.delete(:devices)
+          ENV.delete('SCAN_DEVICES')
+          # this prevents double -resultBundlePath args to xcodebuild
+          if ReportNameHelper.includes_xcresult?(@options[:output_types])
+            scan_config._values.delete(:result_bundle)
+            ENV.delete('SCAN_RESULT_BUNDLE')
+          end
+          scan_config._values.delete(:skip_testing)
+          scan_cache.clear
+        end
+
+        def send_callback_override_scan_options_block(new_scan_options)
+          return new_scan_options unless @options[:override_scan_options_block]
+
+          callback_result = @options[:override_scan_options_block].call(new_scan_options)
+          if callback_result.kind_of?(Hash)
+            return callback_result
+          end
+          new_scan_options
+        end
+
         def quit_simulator
           return unless @options[:quit_simulators]
 

data/lib/fastlane/plugin/test_center/helper/multi_scan_manager/runner.rb

@@ -21,6 +21,8 @@ module TestCenter
             update_options_to_use_xcresult_output
           end
           @batch_count = 1 # default count. Will be updated by setup_testcollector
+          @options[:parallel_testrun_count] ||= 1
+          @initial_parallel_testrun_count = @options[:parallel_testrun_count]
           setup_testcollector
           setup_logcollection
           FastlaneCore::UI.verbose("< done in TestCenter::Helper::MultiScanManager.initialize")
@@ -67,6 +69,7 @@ module TestCenter
           @test_collector = TestCollector.new(@options)
           @options.reject! { |key| %i[testplan].include?(key) }
           @batch_count = @test_collector.batches.size
+          @options[:parallel_testrun_count] = @initial_parallel_testrun_count
           tests = @test_collector.batches.flatten
           if tests.size < @options[:parallel_testrun_count].to_i
             FastlaneCore::UI.important(":parallel_testrun_count greater than the number of tests (#{tests.size}). Reducing to that number.")
@@ -184,6 +187,8 @@ module TestCenter
           options = @options.reject { |key| %i[device devices force_quit_simulator].include?(key) }
           options[:try_count] = 1
 
+          SimulatorHelper.call_simulator_started_callback(@options, Scan.devices)
+
           tests_passed = RetryingScan.run(options)
           @options[:try_count] -= 1
 
@@ -229,6 +234,11 @@ module TestCenter
           pool_options[:test_batch_results] = test_batch_results
           pool_options[:xctestrun] = @test_collector.xctestrun_path
 
+          serial_test_batches = (@options.fetch(:parallel_testrun_count, 1) == 1)
+          if serial_test_batches && !@options[:invocation_based_tests]
+            SimulatorHelper.call_simulator_started_callback(@options, Scan.devices)
+          end
+
           pool = TestBatchWorkerPool.new(pool_options)
           pool.setup_workers
 

data/lib/fastlane/plugin/test_center/helper/multi_scan_manager/simulator_helper.rb

@@ -4,6 +4,8 @@ module TestCenter
       class SimulatorHelper
         def initialize(options)
           @options = options
+          # TODO: add byebug to make sure we're mocking this
+          @all_simulators = FastlaneCore::DeviceManager.simulators('iOS') 
         end
 
         def setup
@@ -12,6 +14,38 @@ module TestCenter
           end
         end
 
+        def parallel_destination_simulators
+          remaining_desired_simulators = @options[:parallel_testrun_count] || 0
+
+          simulators = []
+          if @options[:reuse_simulators_for_parallel_testruns]
+            matching_simulators = find_matching_destination_simulators(remaining_desired_simulators)
+            remaining_desired_simulators -= matching_simulators.size
+            (0...matching_simulators.size).each do |s|
+              simulators << [matching_simulators[s]]
+            end
+          end
+
+          if remaining_desired_simulators > 0
+            simulators.concat(clone_destination_simulators(remaining_desired_simulators))
+          end
+          simulators
+        end
+
+        def find_matching_destination_simulators(remaining_desired_simulators)
+          destination = Scan.config[:destination].clone.first
+
+          desired_device = @all_simulators.find do |simulator|
+            match = destination.match(/id=(?<udid>[^,]+)/) 
+            match && match[:udid] == simulator.udid
+          end
+
+          matching_simulators = @all_simulators.find_all do |simulator|
+            desired_device.os_version == simulator.os_version && simulator.name =~ /#{Regexp.escape(desired_device.name)} Clone \d #{self.class.name}<[^>]+>/ 
+          end
+          matching_simulators.first(remaining_desired_simulators)
+        end
+
         def simulator_matches_destination(simulator, destination)
           match = destination.match(/id=(?<udid>[^,]+)/)
           if match
@@ -27,12 +61,12 @@ module TestCenter
           found_match
         end
 
-        def clone_destination_simulators
+        def clone_destination_simulators(remaining_desired_simulators)
           cloned_simulators = []
 
-          run_count = @options[:parallel_testrun_count] || 0
+          run_count = remaining_desired_simulators
           destinations = Scan.config[:destination].clone
-          original_simulators = FastlaneCore::DeviceManager.simulators('iOS').find_all do |simulator|
+          original_simulators = @all_simulators.find_all do |simulator|
             found_simulator = destinations.find do |destination|
               simulator_matches_destination(simulator, destination)
             end
@@ -63,6 +97,15 @@ module TestCenter
             simulator.delete if /#{self.class.name}<\d+>/ =~ simulator.name
           end
         end
+
+        def self.call_simulator_started_callback(options, devices)
+          return unless options[:simulator_started_callback]
+          return unless options[:platform] == :ios_simulator
+
+          devices.each do |device|
+            options[:simulator_started_callback].call(device.udid)
+          end
+        end
       end
     end
   end

data/lib/fastlane/plugin/test_center/helper/multi_scan_manager/test_batch_worker_pool.rb

@@ -23,17 +23,23 @@ module TestCenter
 
           @simhelper = SimulatorHelper.new(
             parallel_testrun_count: @options[:parallel_testrun_count],
-            pre_delete_cloned_simulators: @options.fetch(:pre_delete_cloned_simulators, true)
+            pre_delete_cloned_simulators: @options.fetch(:pre_delete_cloned_simulators, true),
+            reuse_simulators_for_parallel_testruns: @options[:reuse_simulators_for_parallel_testruns] || false
           )
           @simhelper.setup
-          @clones = @simhelper.clone_destination_simulators
+          @clones = @simhelper.parallel_destination_simulators
           main_pid = Process.pid
-          at_exit do
-            clean_up_cloned_simulators(@clones) if Process.pid == main_pid
+          unless @options[:reuse_simulators_for_parallel_testruns]
+            at_exit do
+              clean_up_cloned_simulators(@clones) if Process.pid == main_pid
+            end
           end
           # boot all the simulators _before_ calling `xcodebuilt test` to avoid
           # testmanagerd connection failures.
+          @clones.flatten.each(&:shutdown)
+          @clones.flatten.each(&:disable_hardware_keyboard)
           @clones.flatten.each(&:boot)
+          SimulatorHelper.call_simulator_started_callback(@options, @clones.flatten)
           @clones
         end
 

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

@@ -1,5 +1,5 @@
 module Fastlane
   module TestCenter
-    VERSION = "3.14.8"
+    VERSION = "3.15.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-test_center
 version: !ruby/object:Gem::Version
-  version: 3.14.8
+  version: 3.15.0
 platform: ruby
 authors:
 - Lyndsey Ferguson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-13 00:00:00.000000000 Z
+date: 2020-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json