fastlane-plugin-test_center 3.7.0 → 3.8.0.parallelizing.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd7fbaf52ee79115ad9ea8f260bdd35e90868c14
-  data.tar.gz: 03ab87b0d261fde47d37edfa7d997e33a6f3faa7
+  metadata.gz: e0d83a81d13511c8798b43c1b458e6619d94c786
+  data.tar.gz: '048f7bc9d0465b5fba70b682271b6d5952e88963'
 SHA512:
-  metadata.gz: 9cd9189973cddeab19e82f2bee16577eca64b0eea355d0229cf17fa555b6231f536d558ac44a086ddbfb22ae6877cf857f45db20a9fedbe80a392cc0594db7b6
-  data.tar.gz: 3d3747b5497960d65c97b44b20291eea6133c68752449f29d442b6f2e144b4dfc853a7b44eb09523f383749b11d143abbdab028ff73ee314e2bef1e056725ef7
+  metadata.gz: 2e7c925081b38580cb7efe949c689963f44368db7f92a73ad5c1eec497aed23c17ec3416afd5e57578277359899989c2cd700a26a79f6c1a14ae455ab4ac2f31
+  data.tar.gz: 4434d5b5502c17a6fe3b3c70fcba0a39a03212479c331b10a0deb6780a243ec1b5fa9c147d5b8d70a7f0bb55c17d1737a34e5d1fcec28d7c89673169b7d9ee69

data/README.md

@@ -184,16 +184,41 @@ multi_scan(
 
 ```ruby
 
+UI.important(
+  'example: ' \
+  'multi_scan also works with invocation based tests.'
+)
+Dir.chdir('../AtomicBoy') do
+  bundle_install
+  cocoapods(podfile: File.absolute_path('Podfile'))
+  multi_scan(
+    workspace: File.absolute_path('AtomicBoy.xcworkspace'),
+    scheme: 'KiwiBoy',
+    try_count: 3,
+    clean: true,
+    invocation_based_tests: true,
+    fail_build: false
+  )
+end
+
+```
+
+```ruby
+
 UI.important(
   'example: ' \
   'use the :workspace parameter instead of the :project parameter to find, ' \
   'build, and test the iOS app.'
 )
- multi_scan(
-  workspace: File.absolute_path('../AtomicBoy/AtomicBoy.xcworkspace'),
-  scheme: 'AtomicBoy',
-  try_count: 3
-)
+begin
+  multi_scan(
+    workspace: File.absolute_path('../AtomicBoy/AtomicBoy.xcworkspace'),
+    scheme: 'AtomicBoy',
+    try_count: 3
+  )
+rescue # anything
+  UI.error('Found real failing tests!')
+end
 
 ```
 
@@ -226,7 +251,7 @@ multi_scan(
   project: File.absolute_path('../AtomicBoy/AtomicBoy.xcodeproj'),
   scheme: 'Professor',
   try_count: 3,
-  custom_report_file_name: 'atomic_report.xml',
+  output_files: 'atomic_report.xml',
   output_types: 'junit',
   fail_build: false
 )
@@ -244,6 +269,7 @@ multi_scan(
   workspace: File.absolute_path('../AtomicBoy/AtomicBoy.xcworkspace'),
   scheme: 'AtomicBoy',
   try_count: 3,
+  code_coverage: true,
   only_testing: ['AtomicBoyTests'],
   fail_build: false
 )
@@ -265,6 +291,45 @@ multi_scan(
   fail_build: false
 )
 
+```
+
+```ruby
+
+UI.important(
+  'example: ' \
+  'multi_scan parallelizes its test runs.'
+)
+multi_scan(
+  workspace: File.absolute_path('../AtomicBoy/AtomicBoy.xcworkspace'),
+  scheme: 'AtomicBoy',
+  try_count: 3,
+  parallel_testrun_count: 4,
+  fail_build: false
+)
+
+```
+
+```ruby
+
+UI.important(
+  'example: ' \
+  'use the :xctestrun parameter instead of the :project parameter to find, ' \
+  'build, and test the iOS app.'
+)
+Dir.mktmpdir do |derived_data_path|
+  project_path = File.absolute_path('../AtomicBoy/AtomicBoy.xcodeproj')
+  command = "bundle exec fastlane scan --build_for_testing true --project '#{project_path}' --derived_data_path #{derived_data_path} --scheme AtomicBoy"
+  `#{command}`
+  xctestrun_file = Dir.glob("#{derived_data_path}/Build/Products/AtomicBoy*.xctestrun").first
+  multi_scan(
+    scheme: 'AtomicBoy',
+    try_count: 3,
+    fail_build: false,
+    xctestrun: xctestrun_file,
+    test_without_building: true
+  )
+end
+
 ```
 <!-- multi_scan examples: end -->
 </details>

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

@@ -159,6 +159,7 @@ module Fastlane
       # @!group Documentation
       #####################################################
 
+      # :nocov:
       def self.description
         "Combines and combines tests from multiple html report files"
       end
@@ -227,6 +228,7 @@ module Fastlane
       def self.category
         :testing
       end
+      # :nocov:
     end
   end
 end

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

@@ -98,6 +98,7 @@ module Fastlane
       # @!group Documentation
       #####################################################
 
+      # :nocov:
       def self.description
         "Combines and combines tests from multiple json report files"
       end
@@ -167,6 +168,7 @@ module Fastlane
       def self.category
         :testing
       end
+      # :nocov:
     end
   end
 end

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

@@ -147,7 +147,7 @@ module Fastlane
       #####################################################
       # @!group Documentation
       #####################################################
-
+      # :nocov:
       def self.description
         "Combines and combines tests from multiple junit report files"
       end
@@ -217,6 +217,7 @@ module Fastlane
       def self.is_supported?(platform)
         %i[ios mac].include?(platform)
       end
+      # :nocov:
     end
   end
 end

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

@@ -111,6 +111,7 @@ module Fastlane
       # @!group Documentation
       #####################################################
 
+      # :nocov:
       def self.description
         "Combines and combines tests from multiple test_result bundles"
       end
@@ -179,6 +180,7 @@ module Fastlane
       def self.is_supported?(platform)
         %i[ios mac].include?(platform)
       end
+      # :nocov:
     end
   end
 end

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

@@ -5,29 +5,43 @@ module Fastlane
     require 'shellwords'
     require 'xctest_list'
     require 'plist'
+    require_relative '../helper/multi_scan_manager/runner'
 
     class MultiScanAction < Action
       def self.run(params)
+        # :nocov:
         unless Helper.test?
+          scan_keys = Fastlane::Actions::ScanAction.available_options.map(&:key)
           FastlaneCore::PrintTable.print_values(
-            config: params._values.select { |k, _| %i[try_count batch_count invocation_based_tests fail_build quit_simulators].include?(k) },
+            config: params._values.reject { |k, _| scan_keys.include?(k) },
             title: "Summary for multi_scan (test_center v#{Fastlane::TestCenter::VERSION})"
           )
         end
-        unless params[:test_without_building] || params[:skip_build]
-          build_for_testing(
-            params._values
-          )
+        # :nocov:
+        force_quit_simulator_processes if params[:force_quit_simulator]
+
+        prepare_for_testing(params.values)
+        
+        platform = :mac
+        platform = :ios if Scan.config[:destination].any? { |d| d.include?('platform=iOS Simulator') }
+
+        runner_options = params.values.merge(platform: platform)
+        runner = ::TestCenter::Helper::MultiScanManager::Runner.new(runner_options)
+        tests_passed = runner.run
+        if params[:fail_build] && !tests_passed
+          raise UI.test_failure!('Tests have failed')
         end
-        smart_scanner = ::TestCenter::Helper::CorrectingScanHelper.new(params.values)
-        tests_passed = smart_scanner.scan
-        summary = run_summary(params, tests_passed, smart_scanner.retry_total_count)
+
+        summary = run_summary(params, tests_passed, runner.retry_total_count)
+        # :nocov:
         unless Helper.test?
           FastlaneCore::PrintTable.print_values(
             config: summary,
             title: "multi_scan results"
           )
         end
+        # :nocov:
+
         if params[:fail_build] && !tests_passed
           raise UI.test_failure!('Tests have failed')
         end
@@ -80,33 +94,69 @@ module Fastlane
         }
       end
 
-      def self.build_for_testing(scan_options)
-        options_to_remove = %i[
-          try_count
-          batch_count
-          quit_simulators
-          testrun_completed_block
-          test_without_building
-          invocation_based_tests
-          output_types
-          output_files
-        ]
-        config = FastlaneCore::Configuration.create(
+      def self.prepare_for_testing(scan_options)
+        if scan_options[:test_without_building] || scan_options[:skip_build]
+          prepare_scan_config(scan_options)
+        else
+          build_for_testing(scan_options)
+        end
+      end
+
+      def self.prepare_scan_config(scan_options)
+        Scan.config ||= FastlaneCore::Configuration.create(
           Fastlane::Actions::ScanAction.available_options,
-          scan_options.merge(build_for_testing: true).reject { |k, _| options_to_remove.include?(k) }
+          scan_options.select { |k,v| %i[project workspace scheme device devices].include?(k) }
         )
-        Fastlane::Actions::ScanAction.run(config)
+      end
 
-        scan_options.merge!(
-          test_without_building: true,
-          derived_data_path: Scan.config[:derived_data_path]
-        ).delete(:build_for_testing)
+      def self.build_for_testing(scan_options)
+          valid_scan_keys = Fastlane::Actions::ScanAction.available_options.map(&:key)
+          scan_options = scan_options.select { |k,v| %i[project workspace scheme device devices].include?(k) }
+
+          Scan.config = FastlaneCore::Configuration.create(
+            Fastlane::Actions::ScanAction.available_options,
+            scan_options.merge(build_for_testing: true)
+          )
+          values = Scan.config.values(ask: false)
+          values[:xcode_path] = File.expand_path("../..", FastlaneCore::Helper.xcode_path)
+          
+          # :nocov:
+          unless Helper.test?
+            FastlaneCore::PrintTable.print_values(
+              config: values,
+              hide_keys: [:destination, :slack_url],
+              title: "Summary for scan #{Fastlane::VERSION}"
+            )
+          end
+          # :nocov:
+
+          Scan::Runner.new.run
+          remove_build_report_files
+
+          Scan.config._values.delete(:build_for_testing)
+          scan_options[:derived_data_path] = Scan.config[:derived_data_path]
+      end
+
+      def self.remove_build_report_files
+        report_options = Scan::XCPrettyReporterOptionsGenerator.generate_from_scan_config
+        output_files = report_options.instance_variable_get(:@output_files)
+        output_directory = report_options.instance_variable_get(:@output_directory)
+
+        output_files.each do |output_file|
+          FileUtils.rm_f(File.join(output_directory, output_file))
+        end
+      end
+
+      def self.force_quit_simulator_processes
+        # Silently execute and kill, verbose flags will show this command occurring
+        Fastlane::Actions.sh("killall Simulator &> /dev/null || true", log: false)
       end
 
       #####################################################
       # @!group Documentation
       #####################################################
 
+      # :nocov:
       def self.description
         "Uses scan to run Xcode tests a given number of times, with the option " \
         "of batching them, only re-testing failing tests."
@@ -174,7 +224,7 @@ module Fastlane
           FastlaneCore::ConfigItem.new(
             key: :quit_simulators,
             env_name: "FL_MULTI_SCAN_QUIT_SIMULATORS",
-            description: "If the simulators need to be killed before run the tests",
+            description: "If the simulators need to be killed before running the tests",
             type: Boolean,
             is_string: false,
             default_value: true,
@@ -187,6 +237,13 @@ module Fastlane
             description: "Comma separated list of the output types (e.g. html, junit, json, json-compilation-database)",
             default_value: "html,junit"
           ),
+          FastlaneCore::ConfigItem.new(
+            key: :parallel_testrun_count,
+            description: 'Run  simulators each batch of tests and/or each test target in parallel on its own Simulator',
+            optional: true,
+            is_string: false,
+            default_value: 1
+          ),
           FastlaneCore::ConfigItem.new(
             key: :testrun_completed_block,
             description: 'A block invoked each time a test run completes',
@@ -259,6 +316,24 @@ module Fastlane
           )
           ",
           "
+          UI.important(
+            'example: ' \\
+            'multi_scan also works with invocation based tests.'
+          )
+          Dir.chdir('../AtomicBoy') do
+            bundle_install
+            cocoapods(podfile: File.absolute_path('Podfile'))
+            multi_scan(
+              workspace: File.absolute_path('AtomicBoy.xcworkspace'),
+              scheme: 'KiwiBoy',
+              try_count: 3,
+              clean: true,
+              invocation_based_tests: true,
+              fail_build: false
+            )
+          end
+          ",
+          "
           UI.important(
             'example: ' \\
             'use the :workspace parameter instead of the :project parameter to find, ' \\
@@ -336,16 +411,35 @@ module Fastlane
           "
           UI.important(
             'example: ' \\
-            'multi_scan also works with invocation based tests.'
+            'multi_scan parallelizes its test runs.'
           )
-          cocoapods
           multi_scan(
-            workspace: File.absolute_path('../KiwiDemo/KiwiDemo.xcworkspace'),
-            scheme: 'KiwiDemoTests',
+            workspace: File.absolute_path('../AtomicBoy/AtomicBoy.xcworkspace'),
+            scheme: 'AtomicBoy',
             try_count: 3,
-            invocation_based_tests: true,
+            parallel_testrun_count: 4,
             fail_build: false
           )
+          ",
+          "
+          UI.important(
+            'example: ' \\
+            'use the :xctestrun parameter instead of the :project parameter to find, ' \\
+            'build, and test the iOS app.'
+          )
+          Dir.mktmpdir do |derived_data_path|
+            project_path = File.absolute_path('../AtomicBoy/AtomicBoy.xcodeproj')
+            command = \"bundle exec fastlane scan --build_for_testing true --project '\#{project_path}' --derived_data_path \#{derived_data_path} --scheme AtomicBoy\"
+            `\#{command}`
+            xctestrun_file = Dir.glob(\"\#{derived_data_path}/Build/Products/AtomicBoy*.xctestrun\").first
+            multi_scan(
+              scheme: 'AtomicBoy',
+              try_count: 3,
+              fail_build: false,
+              xctestrun: xctestrun_file,
+              test_without_building: true
+            )
+          end
           "
         ]
       end
@@ -361,6 +455,7 @@ module Fastlane
       def self.is_supported?(platform)
         %i[ios mac].include?(platform)
       end
+      # :nocov:
     end
   end
 end

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

@@ -0,0 +1,40 @@
+module Fastlane
+  module Actions
+    class QuitCoreSimulatorServiceAction < Action
+      def self.run(params)
+        launchctl_list_count = 0
+        commands = []
+        while Actions.sh('launchctl list | grep com.apple.CoreSimulator.CoreSimulatorService || true', log: false) != ''
+          UI.crash!('Unable to quit com.apple.CoreSimulator.CoreSimulatorService after 10 tries') if (launchctl_list_count += 1) > 10
+          commands << Actions.sh('launchctl remove com.apple.CoreSimulator.CoreSimulatorService &> /dev/null || true', log: false)
+          UI.verbose('Waiting for com.apple.CoreSimulator.CoreSimulatorService to quit')
+          sleep(0.5)
+        end
+        commands
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      # :nocov:
+      def self.description
+        "Force-quits the com.apple.CoreSimulator.CoreSimulatorService."
+      end
+
+      def self.details
+        "Sometimes the com.apple.CoreSimulator.CoreSimulatorService can hang. " \
+        "Use this action to force-quit it."
+      end
+
+      def self.authors
+        ["lyndsey-ferguson/@lyndseydf"]
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+      # :nocov:
+    end
+  end
+end

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

@@ -59,6 +59,7 @@ module Fastlane
       # @!group Documentation
       #####################################################
 
+      # :nocov:
       def self.description
         "Suppresses specific tests in a specific or all Xcode Schemes in a given project"
       end
@@ -171,6 +172,7 @@ module Fastlane
       def self.is_supported?(platform)
         %i[ios mac].include?(platform)
       end
+      # :nocov:
     end
   end
 end

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

@@ -45,7 +45,8 @@ module Fastlane
       #####################################################
       # @!group Documentation
       #####################################################
-
+      
+      # :nocov:
       def self.description
         "Uses a junit xml report file to suppress either passing or failing tests in an Xcode Scheme"
       end
@@ -135,6 +136,7 @@ module Fastlane
       def self.is_supported?(platform)
         %i[ios mac].include?(platform)
       end
+      # :nocov:
     end
   end
 end

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

@@ -52,6 +52,7 @@ module Fastlane
       # @!group Documentation
       #####################################################
 
+      # :nocov:
       def self.description
         "Retrieves a list of tests that are suppressed in a specific or all Xcode Schemes in a project"
       end
@@ -139,6 +140,7 @@ module Fastlane
       def self.is_supported?(platform)
         %i[ios mac].include?(platform)
       end
+      # :nocov:
     end
   end
 end

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

@@ -32,6 +32,7 @@ module Fastlane
       # @!group Documentation
       #####################################################
 
+      # :nocov:
       def self.description
         "Retrieves the failing and passing tests as reported in a junit xml file"
       end
@@ -82,6 +83,7 @@ module Fastlane
       def self.is_supported?(platform)
         %i[ios mac].include?(platform)
       end
+      # :nocov:
     end
   end
 end

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

@@ -47,6 +47,7 @@ module Fastlane
       # @!group Documentation
       #####################################################
 
+      # :nocov:
       def self.description
         "Retrieves all of the tests from xctest bundles referenced by the xctestrun file"
       end
@@ -115,6 +116,7 @@ module Fastlane
       def self.is_supported?(platform)
         %i[ios mac].include?(platform)
       end
+      # :nocov:
     end
   end
 end

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

@@ -0,0 +1,30 @@
+module FastlaneCore
+  class DeviceManager
+    class Device
+      def clone
+        raise 'Can only clone iOS Simulators' unless self.is_simulator
+        Device.new(
+          name: self.name,
+          udid: `xcrun simctl clone #{self.udid} '#{self.name}'`.chomp,
+          os_type: self.os_type,
+          os_version: self.os_version,
+          state: self.state,
+          is_simulator: self.is_simulator
+        )
+      end
+
+      def rename(newname)
+        `xcrun simctl rename #{self.udid} '#{newname}'`
+        self.name = newname
+      end
+
+      def boot
+        `xcrun simctl boot #{self.udid}`
+      end
+
+      def shutdown
+        `xcrun simctl shutdown #{self.udid}` unless self.state == "Shutdown"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+module TestCenter
+  module Helper
+    module MultiScanManager
+      class ParallelTestBatchWorker < TestBatchWorker
+
+        attr_reader :pid
+
+        def initialize(options)
+          super(options)
+          @pipe_endpoint = nil
+        end
+
+        def state=(new_state)
+          super(new_state)
+        end
+
+        def process_results
+          @pid = nil
+          File.foreach(@log_filepath) do |line|
+            puts "[worker #{@options[:batch_index]}] #{line}"
+          end
+          state = :ready_to_work
+          @options[:test_batch_results] << (@reader.gets == 'true')
+        end
+
+        def run(run_options)
+          self.state = :working
+
+          open_interprocess_communication
+          @pid = Process.fork do
+            tests_passed = false
+            begin
+              reroute_stdout_to_logfile
+              tests_passed = super(run_options)
+            ensure
+              handle_child_process_results(tests_passed)
+              exit!
+            end
+          end
+          close_parent_process_writer
+        end
+
+        def open_interprocess_communication
+          @reader, @writer = IO.pipe
+          @log_filepath = File.join(
+            Dir.mktmpdir,
+            "parallel-test-batch-#{@options[:batch_index]}.txt"
+          )
+        end
+
+        def reroute_stdout_to_logfile
+          @reader.close # we are now in the subprocess
+          @logfile = File.open(@log_filepath, 'w')
+          @logfile.sync = true
+          $stdout.reopen(@logfile)
+          $stderr.reopen(@logfile)
+        end
+
+        def handle_child_process_results(tests_passed)
+          @logfile.close
+          @writer.puts tests_passed.to_s
+          @writer.close
+        end
+
+        def close_parent_process_writer
+          @writer.close
+        end
+      end
+    end
+  end
+end
+
+