fastlane-plugin-test_center 3.11.0 → 3.11.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fe7c4581f1be17faf807466f1b9b82cf6ee917fef0695c861ef718417dc4c0d
-  data.tar.gz: e0b966985549a444bfcafafa4926eb4f4927f6f43b12b39aa0b025c935e6b185
+  metadata.gz: cf0d31d514743d1748cdbf8667ddf5975c330a628063b8309666fe04968eddc4
+  data.tar.gz: dd66c49e0e92dd9582e78717f29910969ccdc2ae32c96f96f2872dba64c386cc
 SHA512:
-  metadata.gz: f412ba3da2f63443923a94dec51b9f8bd7ed792ab98b4e0c1076fad2520e2a22eed74d3214cab40b36266c2fe35ca136194f4fdcd0e6d42c9730c80237fa0dff
-  data.tar.gz: fc7cb57702c648d99079d092b03abf44726a7fe6ac229da7202d73fe745de3e7d33be40675d0b8f0ce2827fbb7cc314d335a2019163b6a675b4cd5177e5e711b
+  metadata.gz: 23a5978a4d537a3d72314e6e04a121c9a6638536038ad7c0c5f406755c2f01b9e66b2e9463df8d2350202d88ca1b4390d34890e0fc4827dbb62ee1f2aaa8b0d7
+  data.tar.gz: '08957a8d60fb41ef49276ab0fa5fec1a01c74160d09bac10a3b7a683af47d73aceebbeaeb250bdf3f561513c22abb0b7eca413e0ecadaf8153a53bf589b8fa9c'

data/README.md

@@ -7,6 +7,8 @@
 
 Have you ever spent too much time trying to fix fragile tests only to give up with nothing real to show? Use the `fastlane` actions from `test_center` to remove the pain around your tests, so that you can focus on what makes 💰: features that customers love 😍.
 
+> For those of you new to fastlane, I recommend that you read my article [Rescue Your Mobile Builds from Madness Using Fastlane](https://medium.com/appian-engineering/rescue-your-mobile-builds-from-madness-using-fastlane-cf123622f2d3).
+
 <p align="center">
   <a href="#features">Features</a> |
   <a href="#installation">Installation</a> |
@@ -21,7 +23,7 @@ Have you ever spent too much time trying to fix fragile tests only to give up wi
 
 ## Features
 
-This plugin makes testing your iOS app easier by providing you actions that give you greater control over everything related to testing your app. 
+This plugin makes testing your iOS app easier by providing you actions that give you greater control over everything related to testing your app.
 
 `multi_scan` began when I created an action to only re-run the failed tests in order to determine if they were truly failing, or if they were failing randomly due to a fragile infrastructure. This action morphed into an entire plugin with many actions in the testing category.
 
@@ -35,6 +37,8 @@ _read the documentation on each action by clicking on the action name_
 | [`suppress_tests_from_junit`](docs/feature_details/suppress_tests_from_junit.md) | suppress tests in an Xcode Scheme using those in a Junit test report | ios, mac |
 | [`suppress_tests`](docs/feature_details/suppress_tests.md) | suppress tests in an Xcode Scheme | ios, mac |
 | [`suppressed_tests`](docs/feature_details/suppressed_tests.md) | returns a list of the suppressed tests in your Xcode Project or Scheme | ios, mac |
+| [`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_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 |
@@ -62,7 +66,7 @@ The most popular action in the `test_center` plugin is `multi_scan`, and if you
 multi_scan(
   project: File.absolute_path('../AtomicBoy/AtomicBoy.xcodeproj'),
   scheme: 'AtomicBoy',
-  try_count: 3, # retry _failing_ tests up to three times^1. 
+  try_count: 3, # retry _failing_ tests up to three times^1.
   fail_build: false,
   parallel_testrun_count: 4 # run subsets of your tests on parallel simulators^2
 )

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

@@ -232,7 +232,7 @@ module Fastlane
       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?(k) }
+        build_options = scan_options.merge(build_for_testing: true).reject { |k| %i[test_without_building testplan include_simulator_logs].include?(k) }
         Scan.config = FastlaneCore::Configuration.create(
           Fastlane::Actions::ScanAction.available_options,
           ScanHelper.scan_options_from_multi_scan_options(build_options)
@@ -246,7 +246,7 @@ module Fastlane
       def self.update_xctestrun_after_build(scan_options)
         glob_pattern = "#{Scan.config[:derived_data_path]}/Build/Products/*.xctestrun"
         if scan_options[:testplan]
-          glob_pattern = "#{Scan.config[:derived_data_path]}/Build/Products/*#{scan_options[:testplan]}*.xctestrun"
+          glob_pattern = "#{Scan.config[:derived_data_path]}/Build/Products/*_#{scan_options[:testplan]}_*.xctestrun"
         end
         xctestrun_files = Dir.glob(glob_pattern)
         UI.verbose("After building, found xctestrun files #{xctestrun_files} (choosing 1st)")

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

@@ -14,6 +14,7 @@ module Fastlane
           if test_target.key?('selectedTests')
             UI.verbose("  Found selectedTests")
             test_identifiers = test_target['selectedTests'].each do |selected_test|
+              selected_test.delete!('()')
               UI.verbose("    Found test: '#{selected_test}'")
               only_testing << "#{testable}/#{selected_test.sub('\/', '/')}"
             end

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

@@ -2,25 +2,15 @@ module Fastlane
   module Actions
     class TestplansFromSchemeAction < Action
       def self.run(params)
-        scheme = params[:scheme]
-        scheme_filepaths = schemes_from_project(params[:xcodeproj], scheme) || schemes_from_workspace(params[:workspace], scheme)
-        if scheme_filepaths.length.zero?
-          UI.user_error!("Error: cannot find any schemes in the Xcode project") if params[:xcodeproj]
-          UI.user_error!("Error: cannot find any schemes in the Xcode workspace") if params[:workspace]
-        end
+        scheme_filepaths = schemes(params)
         testplan_paths = []
         scheme_filepaths.each do |scheme_filepath|
           UI.verbose("Looking in Scheme '#{scheme_filepath}' for any testplans")
           xcscheme = Xcodeproj::XCScheme.new(scheme_filepath)
-          next if xcscheme.test_action.nil?
-          next if xcscheme.test_action.testables.to_a.empty?
-          next if xcscheme.test_action.testables[0].buildable_references.to_a.empty?
-          next if xcscheme.test_action.test_plans.to_a.empty?
-
-          xcodeproj = xcscheme.test_action.testables[0].buildable_references[0].target_referenced_container.sub('container:', '')
-          container_dir = scheme_filepath.sub(/#{xcodeproj}.*/, '')
+          next unless scheme_has_testplans?(xcscheme)
+          scheme_container_dir = File.absolute_path(scheme_filepath).sub(%r{/[^/]*\.(xcworkspace|xcodeproj)/.*}, '')
           xcscheme.test_action.test_plans.each do |testplan|
-            testplan_path = File.absolute_path(File.join(container_dir, testplan.target_referenced_container.sub('container:', '')))
+            testplan_path = File.absolute_path(File.join(scheme_container_dir, testplan.target_referenced_container.sub('container:', '')))
             UI.verbose("  found testplan '#{testplan_path}'")
             testplan_paths << testplan_path
           end
@@ -28,6 +18,29 @@ module Fastlane
         testplan_paths
       end
 
+      def self.scheme_has_testplans?(xcscheme)
+          return !(
+            xcscheme.test_action.nil? ||
+            xcscheme.test_action.testables.to_a.empty? ||
+            xcscheme.test_action.testables[0].buildable_references.to_a.empty? ||
+            xcscheme.test_action.test_plans.to_a.empty?
+          )
+      end
+
+      def self.schemes(params)
+        scheme = params[:scheme]
+        scheme_filepaths = schemes_from_project(params[:xcodeproj], scheme) || schemes_from_workspace(params[:workspace], scheme)
+        if scheme_filepaths.length.zero?
+          scheme_detail_message = ''
+          if scheme
+            scheme_detail_message = "named '#{scheme}' "
+          end
+          UI.user_error!("Error: cannot find any schemes #{scheme_detail_message}in the Xcode project") if params[:xcodeproj]
+          UI.user_error!("Error: cannot find any schemes #{scheme_detail_message}in the Xcode workspace") if params[:workspace]
+        end
+        scheme_filepaths
+      end
+
       def self.schemes_from_project(project_path, scheme)
         return nil unless project_path
 
@@ -37,9 +50,16 @@ module Fastlane
       def self.schemes_from_workspace(workspace_path, scheme)
         return nil unless workspace_path
 
-        xcworkspace = Xcodeproj::Workspace.new_from_xcworkspace(workspace_path)
         scheme_filepaths = []
-        xcworkspace.file_references.each do |file_reference|
+        scheme_filepaths.concat(schemes_from_project(workspace_path, scheme))
+        return scheme_filepaths unless scheme_filepaths.empty?
+
+        xcworkspace = Xcodeproj::Workspace.new_from_xcworkspace(workspace_path)
+        xcodeprojects = xcworkspace.file_references.select do |file_reference|
+          file_reference.path.end_with?('xcodeproj')
+        end
+
+        xcodeprojects.each do |file_reference|
           next if file_reference.path.include?('Pods/Pods.xcodeproj')
 
           project_path = file_reference.absolute_path(File.dirname(workspace_path))

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

@@ -47,6 +47,11 @@ module TestCenter
             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}")
+            Scan.devices.replace(@options[:scan_devices_override])
+          end
         end
 
         # :nocov:

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

@@ -45,7 +45,7 @@ module TestCenter
 
           derived_data_path = File.expand_path(@options[:derived_data_path] || Scan.config[:derived_data_path])
           xcresults = Dir.glob("#{derived_data_path}/Logs/Test/*.xcresult")
-          if FastlaneCore::Helper.xcode_at_least?('11.0.0')
+          if FastlaneCore::Helper.xcode_at_least?('11')
             xcresults += Dir.glob("#{output_directory}/*.xcresult")
           end
           FastlaneCore::UI.verbose("Deleting xcresults:")
@@ -292,7 +292,7 @@ module TestCenter
         end
 
         def retrieve_test_operation_failure(test_session_last_messages)
-          if FastlaneCore::Helper.xcode_at_least?(11)
+          if FastlaneCore::Helper.xcode_at_least?('11')
             retrieve_test_operation_failure_post_xcode11(test_session_last_messages)
           else
             retrieve_test_operation_failure_pre_xcode11(test_session_last_messages)
@@ -306,6 +306,8 @@ module TestCenter
             test_operation_failure = 'Test device locked'
           elsif /Test runner exited before starting test execution/ =~ test_session_last_messages
             test_operation_failure = 'Test runner exited before starting test execution'
+          else
+            test_operation_failure = 'Unknown test operation failure'
           end
           test_operation_failure
         end
@@ -335,8 +337,12 @@ module TestCenter
 
           glob_pattern = "#{output_directory}/system_logs-*.{log,logarchive}"
           logs = Dir.glob(glob_pattern)
+          batch_prefix = ''
+          if @options[:batch]
+            batch_prefix = "batch-#{@options[:batch]}-"
+          end
           logs.each do |log_filepath|
-            new_logname = "try-#{testrun_count}-#{File.basename(log_filepath)}"
+            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)
@@ -346,15 +352,17 @@ module TestCenter
         def move_test_result_bundle_for_next_run
           return unless @options[:result_bundle]
 
-          glob_pattern = "#{output_directory}/*.test_result"
+          result_extension = FastlaneCore::Helper.xcode_at_least?('11') ? '.xcresult' : '.test_result'
+          
+          glob_pattern = "#{output_directory}/*#{result_extension}"
           preexisting_test_result_bundles = Dir.glob(glob_pattern)
           unnumbered_test_result_bundles = preexisting_test_result_bundles.reject do |test_result|
-            test_result =~ /.*-\d+\.test_result/
+            test_result =~ /.*-\d+\#{result_extension}/
           end
           src_test_bundle = unnumbered_test_result_bundles.first
           dst_test_bundle_parent_dir = File.dirname(src_test_bundle)
-          dst_test_bundle_basename = File.basename(src_test_bundle, '.test_result')
-          dst_test_bundle = "#{dst_test_bundle_parent_dir}/#{dst_test_bundle_basename}-#{@testrun_count}.test_result"
+          dst_test_bundle_basename = File.basename(src_test_bundle, result_extension)
+          dst_test_bundle = "#{dst_test_bundle_parent_dir}/#{dst_test_bundle_basename}-#{@testrun_count}#{result_extension}"
           FastlaneCore::UI.verbose("Moving test_result '#{src_test_bundle}' to '#{dst_test_bundle}'")
           File.rename(src_test_bundle, dst_test_bundle)
         end

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

@@ -224,8 +224,10 @@ module TestCenter
           src_xcresult_bundlepath = File.join(testable_output_dir, xcresult_bundlename)
           dst_xcresult_bundlepath = File.join(final_output_dir, xcresult_bundlename)
 
-          # We do not need to merge if one of these do not exist
-          return unless File.exist?(src_xcresult_bundlepath) || File.exist?(dst_xcresult_bundlepath)
+          # if there is no destination bundle to merge to, skip it as any source bundle will be copied when complete.
+          return if !File.exist?(dst_xcresult_bundlepath)
+          # if there is no source bundle to merge, skip it as there is nothing to merge.
+          return if !File.exist?(src_xcresult_bundlepath)
 
           config = FastlaneCore::Configuration.create(
             Fastlane::Actions::CollateXcresultsAction.available_options,
@@ -282,6 +284,9 @@ module TestCenter
             scheme: @options[:scheme],
             result_bundle: @options[:result_bundle]
           ).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.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/multi_scan_manager/simulator_helper.rb

@@ -12,34 +12,43 @@ module TestCenter
           end
         end
 
+        def simulator_matches_destination(simulator, destination)
+          match = destination.match(/id=(?<udid>[^,]+)/)
+          if match
+            found_match = (match[:udid] == simulator.udid)
+          else
+            match = destination.match(/name=(?<name>[^,]+)/)
+            name = match[:name] || ''
+            match = destination.match(/OS=(?<os_version>[^,]+)/)
+            os_version = match[:os_version] || ''
+
+            found_match = (name == simulator.name && os_version == simulator.os_version)
+          end
+          found_match
+        end
+
         def clone_destination_simulators
           cloned_simulators = []
 
           run_count = @options[:parallel_testrun_count] || 0
+          destinations = Scan.config[:destination].clone
           original_simulators = FastlaneCore::DeviceManager.simulators('iOS').find_all do |simulator|
-            found_match = false
-            Scan.config[:destination].each do |destination|
-              match = destination.match(/id=(?<udid>[^,]+)/)
-              if match
-                found_match = (match[:udid] == simulator.udid)
-              else
-                match = destination.match(/name=(?<name>[^,]+)/)
-                name = match[:name] || ''
-                match = destination.match(/OS=(?<os_version>[^,]+)/)
-                os_version = match[:os_version] || ''
-
-                found_match = (name == simulator.name && os_version == simulator.os_version)
-              end
+            found_simulator = destinations.find do |destination|
+              simulator_matches_destination(simulator, destination)
+            end
+            if found_simulator
+              destinations.delete(found_simulator)
             end
-            found_match
+
+            !found_simulator.nil?
           end
           original_simulators.each(&:shutdown)
           (0...run_count).each do |batch_index|
             cloned_simulators << []
             original_simulators.each do |simulator|
-              FastlaneCore::UI.verbose("Cloning simulator")
               cloned_simulator = simulator.clone
               new_first_name = simulator.name.sub(/( ?\(.*| ?$)/, " Clone #{batch_index + 1}")
+              FastlaneCore::UI.verbose("Cloned simulator #{simulator.name} to (name=#{new_first_name}, udid=#{cloned_simulator.udid}, OS=#{cloned_simulator.ios_version})")
               new_last_name = "#{self.class.name}<#{self.object_id}>"
               cloned_simulator.rename("#{new_first_name} #{new_last_name}")
 

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

@@ -46,6 +46,11 @@ module TestCenter
           end
         end
 
+        def simulator_devices_for_worker(worker_index)
+          return nil unless @options[:platform] == :ios_simulator
+          @clones[worker_index]
+        end
+
         def setup_parallel_workers
           setup_cloned_simulators
           desired_worker_count = @options[:parallel_testrun_count]
@@ -58,6 +63,7 @@ module TestCenter
         def parallel_scan_options(worker_index)
           options = @options.reject { |key| %i[device devices].include?(key) }
           options[:destination] = destination_for_worker(worker_index)
+          options[:scan_devices_override] = simulator_devices_for_worker(worker_index)
           options[:buildlog_path] = buildlog_path_for_worker(worker_index) if @options[:buildlog_path]
           options[:derived_data_path] = derived_data_path_for_worker(worker_index)
           options[:batch_index] = worker_index

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-test_center
 version: !ruby/object:Gem::Version
-  version: 3.11.0
+  version: 3.11.5
 platform: ruby
 authors:
 - Lyndsey Ferguson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2020-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -270,7 +270,6 @@ files:
 - lib/fastlane/plugin/test_center/actions/test_options_from_testplan.rb
 - 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_xcresult.rb
 - lib/fastlane/plugin/test_center/actions/tests_from_xctestrun.rb
 - lib/fastlane/plugin/test_center/helper/html_test_report.rb
 - lib/fastlane/plugin/test_center/helper/junit_helper.rb

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

@@ -1,82 +0,0 @@
-module Fastlane
-  module Actions
-    module SharedValues
-      TESTS_FROM_XCRESULT_CUSTOM_VALUE = :TESTS_FROM_XCRESULT_CUSTOM_VALUE
-    end
-
-    class TestsFromXcresultAction < Action
-      def self.run(params)
-        # fastlane will take care of reading in the parameter and fetching the environment variable:
-        UI.message "Parameter API Token: #{params[:api_token]}"
-
-        # sh "shellcommand ./path"
-
-        # Actions.lane_context[SharedValues::TESTS_FROM_XCRESULT_CUSTOM_VALUE] = "my_val"
-      end
-
-      #####################################################
-      # @!group Documentation
-      #####################################################
-
-      def self.description
-        "A short description with <= 80 characters of what this action does"
-      end
-
-      def self.details
-        # Optional:
-        # this is your chance to provide a more detailed description of this action
-        "You can use this action to do cool things..."
-      end
-
-      def self.available_options
-        # Define all options your action supports. 
-        
-        # Below a few examples
-        [
-          FastlaneCore::ConfigItem.new(key: :api_token,
-                                       env_name: "FL_TESTS_FROM_XCRESULT_API_TOKEN", # The name of the environment variable
-                                       description: "API Token for TestsFromXcresultAction", # a short description of this parameter
-                                       verify_block: proc do |value|
-                                          UI.user_error!("No API token for TestsFromXcresultAction given, pass using `api_token: 'token'`") unless (value and not value.empty?)
-                                          # UI.user_error!("Couldn't find file at path '#{value}'") unless File.exist?(value)
-                                       end),
-          FastlaneCore::ConfigItem.new(key: :development,
-                                       env_name: "FL_TESTS_FROM_XCRESULT_DEVELOPMENT",
-                                       description: "Create a development certificate instead of a distribution one",
-                                       is_string: false, # true: verifies the input is a string, false: every kind of value
-                                       default_value: false) # the default value if the user didn't provide one
-        ]
-      end
-
-      def self.output
-        # Define the shared values you are going to provide
-        # Example
-        [
-          ['TESTS_FROM_XCRESULT_CUSTOM_VALUE', 'A description of what this value contains']
-        ]
-      end
-
-      def self.return_value
-        # If your method provides a return value, you can describe here what it does
-      end
-
-      def self.authors
-        # So no one will ever forget your contribution to fastlane :) You are awesome btw!
-        ["Your GitHub/Twitter Name"]
-      end
-
-      def self.is_supported?(platform)
-        # you can do things like
-        # 
-        #  true
-        # 
-        #  platform == :ios
-        # 
-        #  [:ios, :mac].include?(platform)
-        # 
-
-        platform == :ios
-      end
-    end
-  end
-end