fastlane-plugin-test_center 3.10.2 → 3.11.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c6d2198915a9633a3ab0d6f284a76f9cf03682524747b73e546786852bf2a86
-  data.tar.gz: 494391029f0689f83a34b7babba3772294b7ee112e1505e69ce09db300743d3b
+  metadata.gz: d8ca5a9222720b8b5159174407b28d8675636e19c3cd9ee1e4950f37069acb50
+  data.tar.gz: 290ebef85ce82943353cbf4ca7593b431a2ab903c8dc552932705c61c3b11771
 SHA512:
-  metadata.gz: 77f8e4cbaa0235a71f34e849b95c0eb0321f0e666709fce63cd517af43c2d027cb5f0e8a32f3c10de692a97c5e496b83352e8aec294bb828098d85ff0bf4328c
-  data.tar.gz: 1cea423213b5ea48f5274a9efa1aa2765ad776ebfe414b699c5fa7411dbbdaf37ae00876f2175f81c2c95dd0d82892e5ab51599e692d2020d48b5ec945309b7a
+  metadata.gz: 162eab51a51e48d16a0dc84c72de87c310fbecfd75e61ddb6a531dc3d3ee8047f17950a826e60f6cfc25d81f2b586132716d5d470c31f8308a72d4efaae3c145
+  data.tar.gz: 5070579e0c6b38115908238c3a5b6335edf3791c7cc44e62587138304199b439c875ebf2a3fb97cb798e81eb3cfaffd3a990215d8cf2b48d3fbfdb5c55bafc37

data/README.md

@@ -21,7 +21,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 +35,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 +64,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
 )
@@ -91,6 +93,11 @@ For more information about how the `fastlane` plugin system works, check out the
 
 _fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).
 
+## Supporters
+
+![Владислав Давыдов](https://avatars1.githubusercontent.com/u/47553334?s=44&u=4691860dba898943b947180b3d28bb85851b0d7c&v=4)
+[vdavydovHH](https://github.com/vdavydovHH)
+
 ## License
 
 MIT

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

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

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

@@ -0,0 +1,90 @@
+require 'json'
+
+module Fastlane
+  module Actions
+    class TestOptionsFromTestplanAction < Action
+      def self.run(params)
+        testplan_path = params[:testplan]
+
+        testplan = JSON.load(File.open(testplan_path))
+        only_testing = []
+        UI.verbose("Examining testplan JSON: #{testplan}")
+        testplan['testTargets'].each do |test_target|
+          testable = test_target.dig('target', 'name')
+          if test_target.key?('selectedTests')
+            UI.verbose("  Found selectedTests")
+            test_identifiers = test_target['selectedTests'].each do |selected_test|
+              UI.verbose("    Found test: '#{selected_test}'")
+              only_testing << "#{testable}/#{selected_test.sub('\/', '/')}"
+            end
+          else
+            UI.verbose("  No selected tests, using testable '#{testable}'")
+            only_testing << testable
+          end
+        end
+        {
+          code_coverage: testplan.dig('defaultOptions', 'codeCoverage'),
+          only_testing: only_testing
+        }
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "☑️ Gets test info from a given test plan"
+      end
+
+      def self.details
+        "Gets tests info consisting of tests to run and whether or not code coverage is enabled"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :testplan,
+            optional: true,
+            env_name: "FL_TEST_OPTIONS_FROM_TESTPLAN_TESTPLAN",
+            description: "The Xcode testplan to read the test info from",
+            verify_block: proc do |test_plan|
+              UI.user_error!("Error: Xcode Test Plan '#{test_plan}' is not valid!") if test_plan and test_plan.empty?
+              UI.user_error!("Error: Test Plan does not exist at path '#{test_plan}'") unless File.exist?(test_plan)
+            end
+          )
+        ]
+      end
+
+      def self.return_value
+        "Returns a Hash with keys :code_coverage and :only_testing for the given testplan"
+      end
+
+      def self.example_code
+        [
+          "
+          UI.important(
+            'example: ' \\
+            'get the tests and the test coverage configuration from a given testplan'
+          )
+          test_options = test_options_from_testplan(
+            testplan: 'AtomicBoy/AtomicBoy_2.xctestplan'
+          )
+          UI.message(\"The AtomicBoy_2 testplan has the following tests: \#{test_options[:only_testing]}\")
+          "
+        ]
+      end
+
+      def self.authors
+        ["lyndsey-ferguson/lyndseydf"]
+      end
+
+      def self.category
+        :testing
+      end
+
+      def self.is_supported?(platform)
+        %i[ios mac].include?(platform)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,120 @@
+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
+        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}.*/, '')
+          xcscheme.test_action.test_plans.each do |testplan|
+            testplan_path = File.absolute_path(File.join(container_dir, testplan.target_referenced_container.sub('container:', '')))
+            UI.verbose("  found testplan '#{testplan_path}'")
+            testplan_paths << testplan_path
+          end
+        end
+        testplan_paths
+      end
+
+      def self.schemes_from_project(project_path, scheme)
+        return nil unless project_path
+
+        Dir.glob("#{project_path}/{xcshareddata,xcuserdata}/**/xcschemes/#{scheme || '*'}.xcscheme")
+      end
+
+      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|
+          next if file_reference.path.include?('Pods/Pods.xcodeproj')
+
+          project_path = file_reference.absolute_path(File.dirname(workspace_path))
+          scheme_filepaths.concat(schemes_from_project(project_path, scheme))
+        end
+        scheme_filepaths
+      end
+
+      def self.description
+        "☑️Gets all the testplans that a Scheme references"
+      end
+
+      def self.authors
+        ["lyndsey-ferguson/lyndseydf"]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :xcodeproj,
+            env_name: "FL_TESTPLANS_FROM_SCHEME_XCODE_PROJECT",
+            optional: true,
+            description: "The file path to the Xcode project file that references the Scheme",
+            verify_block: proc do |path|
+              path = File.expand_path(path.to_s)
+              UI.user_error!("Error: Xcode project file path not given!") unless path and !path.empty?
+              UI.user_error!("Error: Xcode project '#{path}' not found!") unless Dir.exist?(path)
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :workspace,
+            env_name: "FL_TESTPLANS_FROM_SCHEME_XCODE_WORKSPACE",
+            optional: true,
+            description: "The file path to the Xcode workspace file that references the Scheme",
+            verify_block: proc do |value|
+              v = File.expand_path(value.to_s)
+              UI.user_error!("Error: Workspace file not found at path '#{v}'") unless Dir.exist?(v)
+              UI.user_error!("Error: Workspace file is not a workspace, must end with .xcworkspace") unless v.include?(".xcworkspace")
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :scheme,
+            optional: true,
+            env_name: "FL_TESTPLANS_FROM_SCHEME_XCODE_SCHEME",
+            description: "The Xcode scheme referencing the testplan",
+            verify_block: proc do |scheme_name|
+              UI.user_error!("Error: Xcode Scheme '#{scheme_name}' is not valid!") if scheme_name and scheme_name.empty?
+            end
+          )
+        ]
+      end
+
+      def self.example_code
+        [
+          "
+          UI.important(
+            'example: ' \\
+            'get all the testplans that an Xcode Scheme references'
+          )
+          testplans = testplans_from_scheme(
+            xcodeproj: 'AtomicBoy/AtomicBoy.xcodeproj',
+            scheme: 'AtomicBoy'
+          )
+          UI.message(\"The AtomicBoy uses the following testplans: \#{testplans}\")
+          "
+        ]
+      end
+
+      def self.category
+        :testing
+      end
+
+      def self.is_supported?(platform)
+        %i[ios mac].include?(platform)
+      end
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+require_relative 'reportname_helper'
+require_relative 'test_collector'
 require_relative 'multi_scan_manager/device_manager'
 require_relative 'multi_scan_manager/report_collator'
 require_relative 'multi_scan_manager/retrying_scan_helper'

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:")
@@ -93,6 +93,10 @@ module TestCenter
             FastlaneCore::UI.important(":xcargs, #{xcargs}, contained 'build-for-testing', removing it")
             xcargs.slice!('build-for-testing')
           end
+          if xcargs.include?('-quiet')
+            FastlaneCore::UI.important('Disabling -quiet as failing tests cannot be found with it enabled.')
+            xcargs.gsub!('-quiet', '')
+          end
           xcargs.gsub!(/-parallel-testing-enabled(=|\s+)(YES|NO)/, '')
           retrying_scan_options = @reportnamer.scan_options.merge(
             {
@@ -245,7 +249,7 @@ module TestCenter
               junit: File.absolute_path(report_filepath)
             }
           )
-          @options[:only_testing] = @options[:only_testing] - Fastlane::Actions::TestsFromJunitAction.run(config).fetch(:passing, Hash.new).map(&:shellsafe_testidentifier)
+          @options[:only_testing] = (@options[:only_testing] || []) - Fastlane::Actions::TestsFromJunitAction.run(config).fetch(:passing, Hash.new).map(&:shellsafe_testidentifier)
           if @options[:invocation_based_tests]
             @options[:only_testing] = @options[:only_testing].map(&:strip_testcase).uniq
           end
@@ -288,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)
@@ -302,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
@@ -342,15 +348,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

@@ -1,4 +1,3 @@
-
 module TestCenter
   module Helper
     module MultiScanManager
@@ -40,7 +39,8 @@ module TestCenter
           return if @options[:invocation_based_tests] && @options[:only_testing].nil?
           return if @test_collector
 
-          @test_collector = TestCenter::Helper::TestCollector.new(@options)
+          @test_collector = TestCollector.new(@options)
+          @options.reject! { |key| %i[testplan].include?(key) }
           @batch_count = @test_collector.test_batches.size
         end
 
@@ -207,10 +207,46 @@ module TestCenter
             File.absolute_path(output_directory),
             @test_collector.testables.first
           )
+          merge_single_testable_xcresult_with_final_xcresult(report_files_dir, File.absolute_path(output_directory))
           FileUtils.cp_r("#{report_files_dir}/.", File.absolute_path(output_directory))
           FileUtils.rm_rf(report_files_dir)
         end
 
+        def merge_single_testable_xcresult_with_final_xcresult(testable_output_dir, final_output_dir)
+          reportnamer = ReportNameHelper.new(
+            @options[:output_types],
+            @options[:output_files],
+            @options[:custom_report_file_name]
+          )
+          return unless reportnamer.includes_xcresult?
+
+          xcresult_bundlename = reportnamer.xcresult_bundlename
+          src_xcresult_bundlepath = File.join(testable_output_dir, xcresult_bundlename)
+          dst_xcresult_bundlepath = File.join(final_output_dir, xcresult_bundlename)
+
+          # 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,
+            {
+              xcresults: [src_xcresult_bundlepath, dst_xcresult_bundlepath],
+              collated_xcresult: dst_xcresult_bundlepath
+            }
+          )
+          FastlaneCore::UI.verbose("Merging xcresult '#{src_xcresult_bundlepath}' to '#{dst_xcresult_bundlepath}'")
+          Fastlane::Actions::CollateXcresultsAction.run(config)
+          FileUtils.rm_rf(src_xcresult_bundlepath)
+          if @result_bundle_desired
+            xcresult_bundlename = reportnamer.xcresult_bundlename
+            test_result_bundlename = File.basename(xcresult_bundlename, '.*') + '.test_result'
+            test_result_bundlename_path = File.join(testable_output_dir, test_result_bundlename)
+            FileUtils.rm_rf(test_result_bundlename_path)
+          end
+        end
+
         def symlink_result_bundle_to_xcresult(output_dir, reportname_helper)
           return unless @result_bundle_desired && reportname_helper.includes_xcresult?
 

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

@@ -15,7 +15,7 @@ module TestCenter
         unless @xctestrun_path && File.exist?(@xctestrun_path)
           FastlaneCore::UI.user_error!("Error: cannot find xctestrun file '#{@xctestrun_path}'")
         end
-        @only_testing = options[:only_testing]
+        @only_testing = options[:only_testing] || only_testing_from_testplan(options)
         if @only_testing.kind_of?(String)
           @only_testing = @only_testing.split(',')
         end
@@ -27,6 +27,36 @@ module TestCenter
         end
       end
 
+      def only_testing_from_testplan(options)
+        return unless options[:testplan] && options[:scheme]
+
+        config = FastlaneCore::Configuration.create(
+          Fastlane::Actions::TestplansFromSchemeAction.available_options,
+          {
+            workspace: options[:workspace],
+            xcodeproj: options[:project],
+            scheme: options[:scheme]
+          }
+        )
+        testplans = Fastlane::Actions::TestplansFromSchemeAction.run(config)
+        FastlaneCore::UI.verbose("TestCollector found testplans: #{testplans}")
+        testplan = testplans.find do |testplan_path|
+          %r{(.*/?#{ options[:testplan] })\.xctestplan}.match?(testplan_path)
+        end
+        FastlaneCore::UI.verbose("  using :testplan option, #{options[:testplan]}, using found one: #{testplan}")
+
+        return if testplan.nil?
+
+        config = FastlaneCore::Configuration.create(
+          Fastlane::Actions::TestOptionsFromTestplanAction.available_options,
+          {
+            testplan: testplan
+          }
+        )
+        test_options = Fastlane::Actions::TestOptionsFromTestplanAction.run(config)
+        return test_options[:only_testing]
+      end
+
       def default_derived_data_path(options)
         project_derived_data_path = Scan.project.build_settings(key: "BUILT_PRODUCTS_DIR")
         File.expand_path("../../..", project_derived_data_path)

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

@@ -1,5 +1,5 @@
 module Fastlane
   module TestCenter
-    VERSION = "3.10.2"
+    VERSION = "3.11.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-test_center
 version: !ruby/object:Gem::Version
-  version: 3.10.2
+  version: 3.11.3
 platform: ruby
 authors:
 - Lyndsey Ferguson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-10 00:00:00.000000000 Z
+date: 2020-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -267,6 +267,8 @@ files:
 - lib/fastlane/plugin/test_center/actions/suppress_tests.rb
 - lib/fastlane/plugin/test_center/actions/suppress_tests_from_junit.rb
 - lib/fastlane/plugin/test_center/actions/suppressed_tests.rb
+- 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_xctestrun.rb
 - lib/fastlane/plugin/test_center/helper/html_test_report.rb