fastlane-plugin-test_center 3.11.5 → 3.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf0d31d514743d1748cdbf8667ddf5975c330a628063b8309666fe04968eddc4
-  data.tar.gz: dd66c49e0e92dd9582e78717f29910969ccdc2ae32c96f96f2872dba64c386cc
+  metadata.gz: 391e38d9af23a2337bcb32634971de2b7fc3813de2c2e8cddf1e20059ca588df
+  data.tar.gz: e438f5cef4c5c2864da937ea488b19e254277d0bcffe05721d2292271124c892
 SHA512:
-  metadata.gz: 23a5978a4d537a3d72314e6e04a121c9a6638536038ad7c0c5f406755c2f01b9e66b2e9463df8d2350202d88ca1b4390d34890e0fc4827dbb62ee1f2aaa8b0d7
-  data.tar.gz: '08957a8d60fb41ef49276ab0fa5fec1a01c74160d09bac10a3b7a683af47d73aceebbeaeb250bdf3f561513c22abb0b7eca413e0ecadaf8153a53bf589b8fa9c'
+  metadata.gz: 44fc75715573240e6acb1146146075d5ba5f58f18e19b7fd568933d7749ed24fc513cff9f0806a46a2013c8575cc537592906901708efb7df13d79b86cdc1ce5
+  data.tar.gz: 568537fbb709f14c3f91fc0880cda63c88ce22470696f8f1cf17281176f635b4a31af4707e081251dfab06ed5ee6631fe78b63b96ebfe68e71d3538a875a1ca8

data/README.md

@@ -40,6 +40,7 @@ _read the documentation on each action by clicking on the action name_
 | [`test_options_from_testplan`](docs/feature_details/test_options_from_testplan.md) | returns the tests and test code coverage configuration for a given testplan | ios, mac |
 | [`testplans_from_scheme`](docs/feature_details/testplans_from_scheme.md) | returns the testplans that an Xcode Scheme references | ios, mac |
 | [`tests_from_junit`](docs/feature_details/tests_from_junit.md) | returns the passing and failing tests in a Junit test report | ios, mac |
+| [`tests_from_xcresult`](docs/feature_details/tests_from_xcresult.md) | returns the passing and failing tests in a xcresult bundle | ios, mac |
 | [`tests_from_xctestrun`](docs/feature_details/tests_from_xctestrun.md) | returns a list of tests for each test target in a `xctestrun` file  | ios, mac |
 | [`collate_junit_reports`](docs/feature_details/collate_junit_reports.md) | combines multiple Junit test reports into one report | ios, mac |
 | [`collate_html_reports`](docs/feature_details/collate_html_reports.md) | combines multiple HTML test reports into one report | ios, mac |

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

@@ -170,8 +170,10 @@ module Fastlane
         reset_scan_config_to_defaults
         use_scanfile_to_override_settings(scan_options)
         turn_off_concurrent_workers(scan_options)
+        UI.important("Turning off :skip_build as it doesn't do anything with multi_scan") if scan_options[:skip_build]
+        scan_options.reject! { |k,v| k == :skip_build }
         ScanHelper.remove_preexisting_simulator_logs(scan_options)
-        if scan_options[:test_without_building] || scan_options[:skip_build]
+        if scan_options[:test_without_building]
           UI.verbose("Preparing Scan config options for multi_scan testing")
           prepare_scan_config(scan_options)
         else
@@ -231,11 +233,31 @@ module Fastlane
         scan_options[:derived_data_path] = Scan.config[:derived_data_path]
       end
 
+      def self.remove_xcresult_from_build_options(build_options)
+        # convert the :output_types comma separated string of types into an array with no whitespace
+        output_types = build_options[:output_types].to_s.split(',').map(&:strip)
+        xcresult_index = output_types.index('xcresult')
+
+        unless xcresult_index.nil?
+          output_types.delete_at(xcresult_index)
+          # set :output_types value to comma separated string of remaining output types
+          build_options[:output_types] = output_types.join(',')
+
+          if build_options[:output_files] # not always set
+            output_files = build_options[:output_files].split(',').map(&:strip)
+            output_files.delete_at(xcresult_index)
+
+            build_options[:output_files] = output_files.join(',')
+          end
+        end
+      end
+
       def self.prepare_scan_options_for_build_for_testing(scan_options)
         build_options = scan_options.merge(build_for_testing: true).reject { |k| %i[test_without_building testplan include_simulator_logs].include?(k) }
+        remove_xcresult_from_build_options(build_options)
         Scan.config = FastlaneCore::Configuration.create(
           Fastlane::Actions::ScanAction.available_options,
-          ScanHelper.scan_options_from_multi_scan_options(build_options)
+          ScanHelper.scan_options_from_multi_scan_options(build_options).merge(include_simulator_logs: false)
         )
         values = Scan.config.values(ask: false)
         values[:xcode_path] = File.expand_path("../..", FastlaneCore::Helper.xcode_path)
@@ -357,6 +379,15 @@ module Fastlane
                 "because the number of tests is unknown")
             end
           ),
+          FastlaneCore::ConfigItem.new(
+            key: :swift_test_prefix,
+            description: "The prefix used to find test methods. In standard XCTests, this is `test`. If you are using Quick with Swift, set this to `spec`",
+            default_value: "test",
+            optional: true,
+            verify_block: proc do |swift_test_prefix|
+              UI.user_error!("Error: swift_test_prefix must be non-nil and non-empty") if swift_test_prefix.nil? || swift_test_prefix.empty?
+            end
+          ),
           FastlaneCore::ConfigItem.new(
             key: :quit_simulators,
             env_name: "FL_MULTI_SCAN_QUIT_SIMULATORS",

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

@@ -5,10 +5,10 @@ module Fastlane
     class TestsFromXctestrunAction < Action
       def self.run(params)
         UI.verbose("Getting tests from xctestrun file at '#{params[:xctestrun]}'")
-        return xctestrun_tests(params[:xctestrun], params[:invocation_based_tests])
+        return xctestrun_tests(params[:xctestrun], params[:invocation_based_tests], swift_test_prefix: params[:swift_test_prefix])
       end
 
-      def self.xctestrun_tests(xctestrun_path, invocation_based_tests)
+      def self.xctestrun_tests(xctestrun_path, invocation_based_tests, swift_test_prefix: "test")
         xctestrun = Plist.parse_xml(xctestrun_path)
         xctestrun_rootpath = File.dirname(xctestrun_path)
         xctestrun_version = xctestrun.fetch('__xctestrun_metadata__', Hash.new).fetch('FormatVersion', 1)
@@ -17,12 +17,14 @@ module Fastlane
         if xctestrun_version == 1
           xctestrun.each do |testable_name, test_target_config|
             next if ignoredTestables.include? testable_name
+            test_target_config['TestableName'] = testable_name
             test_targets << test_target_config
           end
         else
           test_configurations = xctestrun['TestConfigurations']
           test_configurations.each do |configuration|
             configuration['TestTargets'].each do |test_target|
+              test_target['TestableName'] = test_target['BlueprintName']
               test_targets << test_target
             end
           end
@@ -30,14 +32,14 @@ module Fastlane
 
         tests = Hash.new([])
         test_targets.each do |xctestrun_config|
-          testable_name = xctestrun_config['ProductModuleName']
+          testable_name = xctestrun_config['TestableName']
           xctest_path = xctest_bundle_path(xctestrun_rootpath, xctestrun_config)
           test_identifiers = []
           if xctestrun_config.key?('OnlyTestIdentifiers')
             test_identifiers = xctestrun_config['OnlyTestIdentifiers']
             UI.verbose("Identifiers after adding onlytest tests: #{test_identifiers.join("\n\t")}")
           else
-            test_identifiers = XCTestList.tests(xctest_path)
+            test_identifiers = XCTestList.tests(xctest_path, swift_test_prefix: swift_test_prefix)
             UI.verbose("Found the following tests: #{test_identifiers.join("\n\t")}")
           end
           if xctestrun_config.key?('SkipTestIdentifiers')
@@ -50,6 +52,7 @@ module Fastlane
           if test_identifiers.empty? && !invocation_based_tests
             UI.error("No tests found in '#{xctest_path}'!")
             UI.important("Is the Build Setting, `ENABLE_TESTABILITY` enabled for the test target #{testable_name}?")
+            UI.message("If your Swift test method names use a prefix other than `test`, consider setting `:swift_test_prefix`.")
           end
           tests[testable_name] = test_identifiers.map do |test_identifier|
             "#{testable_name}/#{test_identifier}"
@@ -114,6 +117,15 @@ module Fastlane
             is_string: false,
             default_value: false,
             optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :swift_test_prefix,
+            description: "The prefix used to find test methods. In standard XCTests, this is `test`. If you are using Quick with Swift, set this to `spec`",
+            default_value: "test",
+            optional: true,
+            verify_block: proc do |swift_test_prefix|
+              UI.user_error!("Error: swift_test_prefix must be non-nil and non-empty") if swift_test_prefix.nil? || swift_test_prefix.empty?
+            end
           )
         ]
       end

data/lib/fastlane/plugin/test_center/helper/fastlane_core/device_manager/simulator_extensions.rb

@@ -0,0 +1,16 @@
+
+module FixedCopyLogarchiveFastlaneSimulator
+  def self.included(base)
+    base.instance_eval do
+      def copy_logarchive(device, log_identity, logs_destination_dir)
+        require 'shellwords'
+        FastlaneCore::UI.verbose("> FixedCopyLogarchiveFastlaneSimulator.copy_logarchive")
+        logarchive_dst = File.join(logs_destination_dir, "system_logs-#{log_identity}.logarchive")
+        FileUtils.rm_rf(logarchive_dst)
+        FileUtils.mkdir_p(File.expand_path("..", logarchive_dst))
+        command = "xcrun simctl spawn #{device.udid} log collect --output #{logarchive_dst.shellescape} 2>/dev/null"
+        FastlaneCore::CommandExecutor.execute(command: command, print_all: false, print_command: true)
+      end
+    end
+  end
+end

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

@@ -181,11 +181,26 @@ module TestCenter
         end
 
         def remove_duplicate_testcases
-          nonuniq_testcases = testcases
+          # Get a list of all the testcases in the report's testsuite
+          # and reverse the order so that we'll get the tests that
+          # passed _after_ they failed first. That way, when
+          # uniq is called, it will grab the first non-repeated test
+          # it finds; for duplicated tests (tests that were re-run), it will
+          # actually grab the last test that was run of that set.
+          #
+          # For example, if `testcases` is
+          # `['a(passing)', 'b(passing)', 'c(passing)', 'dup1(failing)', 'dup2(failing)', 'dup1(passing)', 'dup2(passing)' ]`
+          # then, testcases.reverse will be
+          # `['dup2(passing)', 'dup1(passing)', 'dup2(failing)', 'dup1(failing)', 'c(passing)', 'b(passing)', 'a(passing)']`
+          # then `uniq_testcases` will be
+          # `['dup2(passing)', 'dup1(passing)', 'c(passing)', 'b(passing)', 'a(passing)']`
+          nonuniq_testcases = testcases.reverse
           uniq_testcases = nonuniq_testcases.uniq { |tc| tc.title }
           (nonuniq_testcases - uniq_testcases).each do |tc|
+            # here, we would be deleting ['dup2(failing)', 'dup1(failing)']
             failure_details = tc.failure_details
-            tc.root.parent.delete_element(failure_details)
+            # failure_details can be nil if this is a passing testcase
+            tc.root.parent.delete_element(failure_details) unless failure_details.nil?
             tc.root.parent.delete_element(tc.root)
           end
         end

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

@@ -19,11 +19,24 @@ module FastlaneCore
       end
 
       def boot
-        `xcrun simctl boot #{self.udid}`
+        return unless is_simulator
+        return unless os_type == "iOS"
+        return if self.state == 'Booted'
+
+        UI.message("Booting #{self}")
+
+        `xcrun simctl boot #{self.udid} 2>/dev/null`
+        self.state = 'Booted'
       end
 
       def shutdown
-        `xcrun simctl shutdown #{self.udid}` unless self.state == "Shutdown"
+        return unless is_simulator
+        return unless os_type == "iOS"
+        return if self.state == 'Shutdown'
+
+        UI.message("Shutting down #{self.udid}")
+        `xcrun simctl shutdown #{self.udid} 2>/dev/null`
+        self.state = 'Shutdown'
       end
     end
   end

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

@@ -29,7 +29,7 @@ module TestCenter
           return unless @options[:quit_simulators]
 
           @options.fetch(:destination).each do |destination|
-            if /id=(?<udid>\w+),?/ =~ destination
+            if /id=(?<udid>[^,$]+)/ =~ destination
               FastlaneCore::UI.verbose("Restarting Simulator #{udid}")
               `xcrun simctl shutdown #{udid} 2>/dev/null`
               `xcrun simctl boot #{udid} 2>/dev/null`
@@ -345,7 +345,7 @@ module TestCenter
             new_logname = "#{batch_prefix}try-#{testrun_count}-#{File.basename(log_filepath)}"
             new_log_filepath = "#{File.dirname(log_filepath)}/#{new_logname}"
             FastlaneCore::UI.verbose("Moving simulator log '#{log_filepath}' to '#{new_log_filepath}'")
-            File.rename(log_filepath, new_log_filepath)
+            FileUtils.mv(log_filepath, new_log_filepath, force: true)
           end
         end
 

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

@@ -6,6 +6,7 @@ module TestCenter
       require 'json'
       require 'shellwords'
       require 'snapshot/reset_simulators'
+      require_relative '../fastlane_core/device_manager/simulator_extensions'
 
       class Runner
         attr_reader :retry_total_count
@@ -21,6 +22,8 @@ module TestCenter
           end
           @batch_count = 1 # default count. Will be updated by setup_testcollector
           setup_testcollector
+          setup_logcollection
+          FastlaneCore::UI.verbose("< done in TestCenter::Helper::MultiScanManager.initialize")
         end
 
         def update_options_to_use_xcresult_output
@@ -35,6 +38,27 @@ module TestCenter
           @options.reject! { |k,_| k == :result_bundle }
         end
 
+        def setup_logcollection
+          FastlaneCore::UI.verbose("> setup_logcollection")
+          return unless @options[:include_simulator_logs]
+          return if Scan::Runner.method_defined?(:prelaunch_simulators)
+
+          # We need to prelaunch the simulators so xcodebuild
+          # doesn't shut it down before we have a chance to get
+          # the logs.
+          FastlaneCore::UI.verbose("\t collecting devices to boot for log collection")
+          devices_to_shutdown = []
+          Scan.devices.each do |device|
+            devices_to_shutdown << device if device.state == "Shutdown"
+            device.boot
+          end
+          at_exit do
+            devices_to_shutdown.each(&:shutdown)
+          end
+          FastlaneCore::UI.verbose("\t fixing FastlaneCore::Simulator.copy_logarchive")
+          FastlaneCore::Simulator.send(:include, FixedCopyLogarchiveFastlaneSimulator)
+        end
+
         def setup_testcollector
           return if @options[:invocation_based_tests] && @options[:only_testing].nil?
           return if @test_collector
@@ -42,6 +66,11 @@ module TestCenter
           @test_collector = TestCollector.new(@options)
           @options.reject! { |key| %i[testplan].include?(key) }
           @batch_count = @test_collector.test_batches.size
+          tests = @test_collector.test_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.")
+            @options[:parallel_testrun_count] = tests.size
+          end
         end
 
         def output_directory(batch_index = 0, test_batch = [])
@@ -73,9 +102,7 @@ module TestCenter
         end
 
         def should_run_tests_through_single_try?
-          should_run_for_invocation_tests = @options[:invocation_based_tests] && @options[:only_testing].nil?
-          should_run_for_skip_build = @options[:skip_build]
-          (should_run_for_invocation_tests || should_run_for_skip_build)
+          @options[:invocation_based_tests] && @options[:only_testing].nil?
         end
 
 
@@ -182,11 +209,21 @@ module TestCenter
         end
 
         def scan_options_for_worker(test_batch, batch_index)
+          if @test_collector.test_batches.size > 1
+            # If there are more than 1 batch, then we want each batch result
+            # sent to a "batch index" output folder to be collated later
+            # into the requested output_folder.
+            # Otherwise, send the results from the one and only one batch
+            # to the requested output_folder
+            batch_index += 1
+            batch = batch_index
+          end
+
           {
             only_testing: test_batch.map(&:shellsafe_testidentifier),
-            output_directory: output_directory(batch_index + 1, test_batch),
+            output_directory: output_directory(batch_index, test_batch),
             try_count: @options[:try_count],
-            batch: batch_index + 1
+            batch: batch
           }
         end
 
@@ -286,7 +323,7 @@ module TestCenter
           ).collate
           logs_glog_pattern = "#{source_reports_directory_glob}/*system_logs-*.{log,logarchive}"
           logs = Dir.glob(logs_glog_pattern)
-          FileUtils.mv(logs, absolute_output_directory)
+          FileUtils.mv(logs, absolute_output_directory, force: true)
           FileUtils.rm_rf(Dir.glob(source_reports_directory_glob))
           symlink_result_bundle_to_xcresult(absolute_output_directory, report_name_helper)
           true

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

@@ -13,7 +13,7 @@ module TestCenter
         )
         # :nocov:
       end
-    
+
       def self.remove_preexisting_simulator_logs(params)
         return unless params[:include_simulator_logs]
     

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

@@ -6,6 +6,7 @@ module TestCenter
 
     class TestCollector
       attr_reader :xctestrun_path
+      attr_reader :only_testing
 
       def initialize(options)
         unless options[:xctestrun] || options[:derived_data_path]
@@ -25,6 +26,8 @@ module TestCenter
         if @batch_count == 1 && options[:parallel_testrun_count] > 1
           @batch_count = options[:parallel_testrun_count]
         end
+
+        @swift_test_prefix = options[:swift_test_prefix]
       end
 
       def only_testing_from_testplan(options)
@@ -88,30 +91,77 @@ module TestCenter
       end
 
       def xctestrun_known_tests
-        config = FastlaneCore::Configuration.create(
-          ::Fastlane::Actions::TestsFromXctestrunAction.available_options,
-          {
-            xctestrun: @xctestrun_path,
-            invocation_based_tests: @invocation_based_tests
-          }
-        )
-        ::Fastlane::Actions::TestsFromXctestrunAction.run(config)
+        unless @known_tests
+          config = FastlaneCore::Configuration.create(
+            ::Fastlane::Actions::TestsFromXctestrunAction.available_options,
+            {
+              xctestrun: @xctestrun_path,
+              invocation_based_tests: @invocation_based_tests,
+              swift_test_prefix: @swift_test_prefix
+            }
+          )
+          @known_tests = ::Fastlane::Actions::TestsFromXctestrunAction.run(config)
+        end
+        @known_tests
       end
 
-      def expand_testsuites_to_tests
+      def expand_short_testidentifiers_to_tests(testables_tests)
+        # Remember, testable_tests is of the format:
+        # {
+        #   'testable1' => [
+        #     'testsuite1/testcase1',
+        #     'testsuite1/testcase2',
+        #     'testsuite2/testcase1',
+        #     'testsuite2/testcase2',
+        #     ...
+        #     'testsuiteN/testcase1', ... 'testsuiteN/testcaseM'
+        #   ],
+        #   ...
+        #   'testableO' => [
+        #     'testsuite1/testcase1',
+        #     'testsuite1/testcase2',
+        #     'testsuite2/testcase1',
+        #     'testsuite2/testcase2',
+        #     ...
+        #     'testsuiteN/testcase1', ... 'testsuiteN/testcaseM'
+        #   ]
+        # }
         return if @invocation_based_tests
 
+        # iterate among all the test identifers for each testable
+        # A test identifier is seperated into components by '/'
+        # if a test identifier has only 2 separators, it probably is
+        # 'testable/testsuite' (but it could be 'testsuite/testcase' )
+        all_known_tests = nil
         known_tests = []
-        @testables_tests.each do |testable, tests|
+        testables_tests.each do |testable, tests|
           tests.each_with_index do |test, index|
-            if test.count('/') < 2
-              known_tests += xctestrun_known_tests[testable]
-              test_components = test.split('/')
-              testsuite = test_components.size == 1 ? test_components[0] : test_components[1]
-              @testables_tests[testable][index] = known_tests.select { |known_test| known_test.include?(testsuite) }
+            test_components = test.split('/')
+            is_full_test_identifier = (test_components.size == 3)
+            next if is_full_test_identifier
+
+            all_known_tests ||= xctestrun_known_tests.clone
+
+            testsuite = ''
+            if test_components.size == 1
+              if test_components[0] == testable
+                # The following || [] is just in case the user provided multiple
+                # test targets or there are no actual tests found.
+                testables_tests[testable][index] = all_known_tests[testable] || []
+                all_known_tests.delete(testable)
+                next
+              end
+
+              testsuite = test_components[0]
+            else
+              testsuite = test_components[1]
+            end
+
+            testables_tests[testable][index], all_known_tests[testable] = all_known_tests[testable].partition do |known_test|
+              known_test.split('/')[1] == testsuite
             end
           end
-          @testables_tests[testable].flatten!
+          testables_tests[testable].flatten!
         end
       end
 
@@ -119,7 +169,7 @@ module TestCenter
         unless @testables_tests
           if @only_testing
             @testables_tests = only_testing_to_testables_tests
-            expand_testsuites_to_tests
+            expand_short_testidentifiers_to_tests(@testables_tests)
           else
             @testables_tests = xctestrun_known_tests
             if @skip_testing

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

@@ -1,5 +1,5 @@
 module Fastlane
   module TestCenter
-    VERSION = "3.11.5"
+    VERSION = "3.14.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-test_center
 version: !ruby/object:Gem::Version
-  version: 3.11.5
+  version: 3.14.1
 platform: ruby
 authors:
 - Lyndsey Ferguson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-30 00:00:00.000000000 Z
+date: 2020-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.8
+        version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.8
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -271,6 +271,7 @@ files:
 - lib/fastlane/plugin/test_center/actions/testplans_from_scheme.rb
 - lib/fastlane/plugin/test_center/actions/tests_from_junit.rb
 - lib/fastlane/plugin/test_center/actions/tests_from_xctestrun.rb
+- lib/fastlane/plugin/test_center/helper/fastlane_core/device_manager/simulator_extensions.rb
 - lib/fastlane/plugin/test_center/helper/html_test_report.rb
 - lib/fastlane/plugin/test_center/helper/junit_helper.rb
 - lib/fastlane/plugin/test_center/helper/multi_scan_manager.rb
@@ -309,7 +310,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Makes testing your iOS app easier