fastlane-plugin-test_center 3.8.16 → 3.9.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b53bbbb4a17b23c0a0d1a3d6df0fcd24363427ae699d65b290742d8e7ad336f
-  data.tar.gz: 1fd7e8b3f2faab7b441f1ce926693e4f34d4531ad43595ba0cf9cd3a7e4b89f9
+  metadata.gz: 19b265ec81e64e97efa222fe6ebc0e0f712ba161f2f0765972fef18d24a0a59e
+  data.tar.gz: ce5a8cd92d09416c3fa0b224abc16084512a51f4511e57a4edd4000a6d690da4
 SHA512:
-  metadata.gz: d5127e1ed4d506b5cf86a67520fa4049c6e003b8426a597c5201aa9d2f1d7a7e7614353a87a6bf8039fbdf6a3f53d3ada52ca1fa2efb24a30a1c6c0b33f3fd2e
-  data.tar.gz: c8311011c5e8cb872be4976f89f9756d95b8ffc59bc453405bfdad96e523ade239c7d5ba09db61ab0a0e6b0df2d9a2f4df4331bf40006887042756e7978e8f8c
+  metadata.gz: 1fd0f2e468e3e907e5b5cfdfbdcbfd547f8a2ab50ac30a0c46645e3b98f1d7a36f32c05ecff7cabd8555ff27b1489d219b627d26c3bf891866f40c24fa574cc9
+  data.tar.gz: 942b2b420fac25341a85a4a4245d8fbd62cb8ff39047ab70836e172e2cbd66ff7c9dd7a9694fe959383a9cc92512000b70b07cd38ded20443c04ddf96e1bc0c2

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 everthing 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.
 
@@ -41,6 +41,7 @@ _read the documentation on each action by clicking on the action name_
 | [`collate_html_reports`](docs/feature_details/collate_html_reports.md) | combines multiple HTML test reports into one report | ios, mac |
 | [`collate_json_reports`](docs/feature_details/collate_json_reports.md) | combines multiple json test reports into one report | ios, mac |
 | [`collate_test_result_bundles`](docs/feature_details/collate_test_result_bundles.md) | combines multiple test_result bundles into one test_result bundle | ios, mac |
+| [`collate_xcresults`](docs/feature_details/collate_xcresults.md) | combines multiple xcresult bundles into one xcresult bundle | ios, mac |
 
 
 ## Installation

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

@@ -184,8 +184,7 @@ module Fastlane
         "in the collated test_result bundle. " \
         "This is done because it is assumed that fragile tests, when " \
         "re-run will often succeed due to less interference from other " \
-        "tests and the subsequent test_result bundles will have fewer failing tests." \
-        ""
+        "tests and the subsequent test_result bundles will have fewer failing tests."
       end
 
       def self.available_options

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

@@ -0,0 +1,111 @@
+module Fastlane
+  module Actions
+    class CollateXcresultsAction < Action
+      require 'tempfile'
+
+      def self.run(params)
+        unless FastlaneCore::Helper.xcode_at_least?(11)
+          FastlaneCore::UI.error("Error: Xcode 11 is required to run this action")
+          return
+        end
+        commands_run = ''
+  
+        xcresult_bundlepaths = params[:xcresults]
+        base_xcresult_path = xcresult_bundlepaths[0]
+        
+        tmp_collated_xcresult_bundle = Tempfile.new(['collated_result_', '.xcresult'])
+        tmp_collated_xcresult_bundlepath = tmp_collated_xcresult_bundle.path
+        tmp_collated_xcresult_bundle.unlink
+
+        if xcresult_bundlepaths.size > 1
+          command = [
+            'xcrun',
+            'xcresulttool',
+            'merge',
+            xcresult_bundlepaths.map(&:shellescape),
+            '--output-path',
+            tmp_collated_xcresult_bundlepath
+          ].flatten
+          commands_run = sh(*command)
+
+          FileUtils.rm_rf(params[:collated_xcresult])
+          FileUtils.cp_r(tmp_collated_xcresult_bundlepath, params[:collated_xcresult])
+        elsif File.realdirpath(xcresult_bundlepaths.first) != File.realdirpath(params[:collated_xcresult])
+          FileUtils.rm_rf(params[:collated_xcresult])
+          FileUtils.cp_r(base_xcresult_path, params[:collated_xcresult])
+        end
+
+        UI.message("Finished collating xcresults to '#{params[:collated_xcresult]}'")
+        commands_run
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "🔸 Combines multiple xcresult bundles into one xcresult bundle"
+      end
+
+      def self.details
+        "The first xcresult bundle is used as the base bundle. " \
+        "Testcases that failed in previous bundles that no longer appear in " \
+        "later bundles are assumed to have passed in a re-run, thus not appearing " \
+        "in the collated xcresult bundle. " \
+        "This is done because it is assumed that fragile tests, when " \
+        "re-run will often succeed due to less interference from other " \
+        "tests and the subsequent xcresult bundles will have fewer failing tests."        
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :xcresults,
+            env_name: 'COLLATE_XCRESULTS',
+            description: 'An array of xcresult bundles to collate',
+            optional: false,
+            type: Array,
+            verify_block: proc do |xcresult_bundles|
+              UI.user_error!('No xcresult bundles found') if xcresult_bundles.empty?
+              xcresult_bundles.each do |xcresult_bundle|
+                UI.user_error!("Error: xcresult bundle not found: '#{xcresult_bundle}'") unless Dir.exist?(xcresult_bundle)
+              end
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :collated_xcresult,
+            env_name: 'COLLATE_XCRESULTS',
+            description: 'The merged xcresult bundle',
+            optional: true,
+            default_value: 'result.xcresult',
+            type: String
+          )
+        ]
+      end
+
+      def self.example_code
+        [
+          "
+          UI.important(
+            'example: ' \\
+            'collate the xcresult bundles to a temporary xcresult bundle \"result.xcresult\"'
+          )
+          xcresults = Dir['../spec/fixtures/*.xcresult'].map { |relpath| File.absolute_path(relpath) }
+          collate_xcresults(
+            xcresults: xcresults,
+            collated_xcresult: File.join('test_output', 'result.xcresult')
+          )
+          "
+        ]
+      end
+
+      def self.authors
+        ["lyndsey-ferguson/@lyndseydf"]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+    end
+  end
+end

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

@@ -21,6 +21,13 @@ module Fastlane
           params[:output_files] = params[:output_files].split(',').map(&:strip).join(',')
         end
 
+        if FastlaneCore::Helper.xcode_at_least?('11.0.0')
+          if params[:result_bundle]
+            UI.important('As of Xcode 11, test_result bundles created in the output directory are actually symbolic links to an xcresult bundle')
+          end
+        elsif params[:output_types]&.include?('xcresult')
+          UI.important("The 'xcresult' :output_type is only supported for Xcode 11 and greater. You are using #{FastlaneCore::Helper.xcode_version}.")
+        end
         print_multi_scan_parameters(params)
         force_quit_simulator_processes if params[:quit_simulators]
 
@@ -73,6 +80,16 @@ module Fastlane
       end
 
       def self.run_summary(scan_options, tests_passed)
+        scan_options = scan_options.clone
+
+        if scan_options[:result_bundle]
+          updated_output_types, updated_output_files = ::TestCenter::Helper::ReportNameHelper.ensure_output_includes_xcresult(
+            scan_options[:output_types],
+            scan_options[:output_files]
+          )
+          scan_options[:output_types] = updated_output_types
+          scan_options[:output_files] = updated_output_files
+        end
         reportnamer = ::TestCenter::Helper::ReportNameHelper.new(
           scan_options[:output_types],
           scan_options[:output_files],
@@ -110,6 +127,11 @@ module Fastlane
             File.absolute_path(relative_test_result_bundle_filepath)
           end
         end
+        if reportnamer.includes_xcresult?
+          report_files += Dir.glob("#{scan_options[:output_directory]}/**/#{reportnamer.xcresult_fileglob}").map do |relative_bundlepath|
+            File.absolute_path(relative_bundlepath)
+          end
+        end
         {
           result: tests_passed,
           total_tests: passing_testcount + failed_tests.size,
@@ -188,6 +210,7 @@ module Fastlane
         )
         values = Scan.config.values(ask: false)
         values[:xcode_path] = File.expand_path("../..", FastlaneCore::Helper.xcode_path)
+        Scan.config._values.delete(:result_bundle)
         values
       end
 
@@ -307,7 +330,7 @@ module Fastlane
             key: :output_types,
             short_option: "-f",
             env_name: "SCAN_OUTPUT_TYPES",
-            description: "Comma separated list of the output types (e.g. html, junit, json, json-compilation-database)",
+            description: "Comma separated list of the output types (e.g. html, junit, json, json-compilation-database, xcresult)",
             default_value: "html,junit"
           ),
           FastlaneCore::ConfigItem.new(

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

@@ -5,12 +5,14 @@ module TestCenter
       require_relative '../../actions/collate_html_reports'
       require_relative '../../actions/collate_json_reports'
       require_relative '../../actions/collate_test_result_bundles'
+      require_relative '../../actions/collate_xcresults'
 
       class ReportCollator
         CollateJunitReportsAction = Fastlane::Actions::CollateJunitReportsAction
         CollateHtmlReportsAction = Fastlane::Actions::CollateHtmlReportsAction
         CollateJsonReportsAction = Fastlane::Actions::CollateJsonReportsAction
         CollateTestResultBundlesAction = Fastlane::Actions::CollateTestResultBundlesAction
+        CollateXcresultsAction = Fastlane::Actions::CollateXcresultsAction
 
         def initialize(params)
           @source_reports_directory_glob = params[:source_reports_directory_glob]
@@ -27,6 +29,7 @@ module TestCenter
           collate_html_reports
           collate_json_reports
           collate_test_result_bundles
+          collate_xcresult_bundles
         end
 
         def sort_globbed_files(glob)
@@ -139,6 +142,31 @@ module TestCenter
             FileUtils.mv(test_result_bundlepaths.first, collated_test_result_bundlepath)
           end
         end
+
+        def collate_xcresult_bundles 
+          return unless @reportnamer.includes_xcresult?
+
+          test_xcresult_bundlepaths = sort_globbed_files("#{@source_reports_directory_glob}/#{@reportnamer.xcresult_fileglob}")
+          xcresult_bundlename_suffix = ''
+          xcresult_bundlename_suffix = "-#{@reportnamer.report_count}" if @reportnamer.report_count > 0
+          collated_xcresult_bundlepath = File.absolute_path("#{File.join(@output_directory, @reportnamer.xcresult_bundlename(@suffix))}")
+          if test_xcresult_bundlepaths.size > 1
+            FastlaneCore::UI.verbose("Collating xcresult bundles #{test_xcresult_bundlepaths}")
+            config = create_config(
+              CollateXcresultsAction,
+              {
+                xcresults: test_xcresult_bundlepaths,
+                collated_xcresult: collated_xcresult_bundlepath
+              }
+            )
+            CollateXcresultsAction.run(config)
+            FileUtils.rm_rf(test_xcresult_bundlepaths - [collated_xcresult_bundlepath])
+          elsif test_xcresult_bundlepaths.size == 1 && File.realdirpath(test_xcresult_bundlepaths.first) != File.realdirpath(collated_xcresult_bundlepath)
+            FastlaneCore::UI.verbose("Copying xcresult bundle from #{test_xcresult_bundlepaths.first} to #{collated_xcresult_bundlepath}")
+            FileUtils.mkdir_p(File.dirname(collated_xcresult_bundlepath))
+            FileUtils.mv(test_xcresult_bundlepaths.first, collated_xcresult_bundlepath)
+          end
+        end
       end
     end
   end

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

@@ -21,6 +21,7 @@ module TestCenter
           # this allows multi_scan's `destination` option to be picked up by `scan`
           scan_config._values.delete(:device)
           scan_config._values.delete(:devices)
+          scan_config._values.delete(:result_bundle) if ReportNameHelper.includes_xcresult?(@options[:output_types])
           scan_cache.clear
         end
 

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

@@ -38,6 +38,8 @@ module TestCenter
         end
 
         def delete_xcresults
+          return if @reportnamer.includes_xcresult?
+
           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')
@@ -91,9 +93,13 @@ module TestCenter
           retrying_scan_options = @reportnamer.scan_options.merge(
             {
               output_directory: output_directory,
-              xcargs: "#{xcargs} -parallel-testing-enabled NO"
+              xcargs: "#{xcargs} -parallel-testing-enabled NO "
             }
           )
+          if @reportnamer.includes_xcresult?
+            retrying_scan_options[:xcargs] += "-resultBundlePath '#{File.join(output_directory, @reportnamer.xcresult_last_bundlename)}' "
+          end
+
           @options.select { |k,v| valid_scan_keys.include?(k) }
             .merge(retrying_scan_options)
         end
@@ -292,7 +298,7 @@ module TestCenter
 
         def move_test_result_bundle_for_next_run
           return unless @options[:result_bundle]
-
+          
           glob_pattern = "#{output_directory}/*.test_result"
           preexisting_test_result_bundles = Dir.glob(glob_pattern)
           unnumbered_test_result_bundles = preexisting_test_result_bundles.reject do |test_result|

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

@@ -16,10 +16,26 @@ module TestCenter
             clean: false,
             disable_concurrent_testing: true
           )
+          @result_bundle_desired = !!@options[:result_bundle]
+          if @options[:result_bundle] && FastlaneCore::Helper.xcode_at_least?('11.0.0')
+            update_options_to_use_xcresult_output
+          end
           @batch_count = 1 # default count. Will be updated by setup_testcollector
           setup_testcollector
         end
 
+        def update_options_to_use_xcresult_output
+          return @options unless @options[:result_bundle]
+
+          updated_output_types, updated_output_files = ReportNameHelper.ensure_output_includes_xcresult(
+            @options[:output_types],
+            @options[:output_files]
+          )
+          @options[:output_types] = updated_output_types
+          @options[:output_files] = updated_output_files
+          @options.reject! { |k,_| k == :result_bundle }
+        end
+
         def setup_testcollector
           return if @options[:invocation_based_tests] && @options[:only_testing].nil?
           return if @test_collector
@@ -42,6 +58,7 @@ module TestCenter
         def run
           ScanHelper.remove_preexisting_simulator_logs(@options)
           remove_preexisting_test_result_bundles
+          remote_preexisting_xcresult_bundles
 
           tests_passed = false
           if should_run_tests_through_single_try?
@@ -63,7 +80,7 @@ module TestCenter
 
 
         def remove_preexisting_test_result_bundles
-          return unless @options[:result_bundle]
+          return unless @options[:result_bundle] || @options[:output_types]&.include?('xcresult')
 
           glob_pattern = "#{output_directory}/**/*.test_result"
           preexisting_test_result_bundles = Dir.glob(glob_pattern)
@@ -76,6 +93,20 @@ module TestCenter
           end
         end
 
+        def remote_preexisting_xcresult_bundles
+          return unless @options.fetch(:output_types, '').include?('xcresult')
+
+          glob_pattern = "#{output_directory}/**/*.xcresult"
+          preexisting_xcresult_bundles = Dir.glob(glob_pattern)
+          if preexisting_xcresult_bundles.size > 0
+            FastlaneCore::UI.verbose("Removing pre-existing xcresult bundles: ")
+            preexisting_xcresult_bundles.each do |test_result_bundle|
+              FastlaneCore::UI.verbose("  #{test_result_bundle}")
+            end
+            FileUtils.rm_rf(preexisting_xcresult_bundles)
+          end
+        end
+
         def run_tests_through_single_try
           FastlaneCore::UI.verbose("Running invocation tests")
           if @options[:invocation_based_tests]
@@ -108,6 +139,8 @@ module TestCenter
           @options[:only_testing] = retrieve_failed_single_try_tests
           @options[:only_testing] = @options[:only_testing].map(&:strip_testcase).uniq
           
+          symlink_result_bundle_to_xcresult(output_directory, reportnamer)
+
           tests_passed
         end
         
@@ -178,6 +211,17 @@ module TestCenter
           FileUtils.rm_rf(report_files_dir)
         end
 
+        def symlink_result_bundle_to_xcresult(output_dir, reportname_helper)
+          return unless @result_bundle_desired && reportname_helper.includes_xcresult?
+
+          xcresult_bundlename = reportname_helper.xcresult_bundlename
+          xcresult_bundlename_path = File.join(output_dir, xcresult_bundlename)
+          test_result_bundlename = File.basename(xcresult_bundlename, '.*') + '.test_result'
+          test_result_bundlename_path = File.join(output_dir, test_result_bundlename)
+          FileUtils.rm_rf(test_result_bundlename_path)
+          File.symlink(xcresult_bundlename_path, test_result_bundlename_path)
+        end
+
         def collate_batched_reports_for_testable(testable)
           FastlaneCore::UI.verbose("Collating results for all batches")
 
@@ -191,18 +235,21 @@ module TestCenter
           given_output_types = @options[:output_types]
           given_output_files = @options[:output_files]
 
+          report_name_helper = ReportNameHelper.new(
+            given_output_types,
+            given_output_files,
+            given_custom_report_file_name
+          )
+
           TestCenter::Helper::MultiScanManager::ReportCollator.new(
             source_reports_directory_glob: source_reports_directory_glob,
             output_directory: absolute_output_directory,
-            reportnamer: ReportNameHelper.new(
-              given_output_types,
-              given_output_files,
-              given_custom_report_file_name
-            ),
+            reportnamer: report_name_helper,
             scheme: @options[:scheme],
             result_bundle: @options[:result_bundle]
           ).collate
           FileUtils.rm_rf(Dir.glob(source_reports_directory_glob))
+          symlink_result_bundle_to_xcresult(absolute_output_directory, report_name_helper)
           true
         end
       end

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

@@ -48,6 +48,10 @@ module TestCenter
           files.delete_at(json_index)
           types.delete_at(json_index)
         end
+        if (xcresult_index = types.find_index('xcresult'))
+          files.delete_at(xcresult_index)
+          types.delete_at(xcresult_index)
+        end
         files.map! do |filename|
           filename.chomp
           numbered_filename(filename)
@@ -141,6 +145,51 @@ module TestCenter
       def json_numbered_fileglob
         "#{File.basename(json_reportname, '.*')}-[1-9]*#{json_filextension}"
       end
+      
+      def self.ensure_output_includes_xcresult(output_types, output_files)
+        return [output_types, output_files] if includes_xcresult?(output_types) || output_types.nil?
+
+        output_types = output_types.split(',').push('xcresult').join(',')
+        if output_files
+          output_files = output_files.split(',').push('report.xcresult').join(',')
+        end
+
+        [output_types, output_files]
+      end
+
+      def self.includes_xcresult?(output_types)
+       return false unless ::FastlaneCore::Helper.xcode_at_least?('11.0.0')
+       output_types && output_types.split(',').find_index('xcresult') != nil
+      end
+
+      def includes_xcresult?
+        self.class.includes_xcresult?(@output_types)
+      end
+
+      def xcresult_last_bundlename
+        xcresult_index = @output_types.split(',').find_index('xcresult')
+        numbered_filename(@output_files.to_s.split(',')[xcresult_index])
+      end
+
+      def xcresult_bundlename(suffix = '')
+        xcresult_index = @output_types.split(',').find_index('xcresult')
+        report_name = @output_files.to_s.split(',')[xcresult_index]
+        return report_name if suffix.empty?
+
+        "#{File.basename(report_name, '.*')}-#{suffix}#{xcresult_filextension}"
+      end
+
+      def xcresult_filextension
+        File.extname(xcresult_bundlename)
+      end
+
+      def xcresult_fileglob
+        "#{File.basename(xcresult_bundlename, '.*')}*#{xcresult_filextension}"
+      end
+
+      def xcresult_numbered_fileglob
+        "#{File.basename(xcresult_bundlename, '.*')}-[1-9]*#{xcresult_filextension}"
+      end
 
       def increment
         @report_count += 1

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

@@ -1,5 +1,5 @@
 module Fastlane
   module TestCenter
-    VERSION = "3.8.16"
+    VERSION = "3.9.0.beta.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-test_center
 version: !ruby/object:Gem::Version
-  version: 3.8.16
+  version: 3.9.0.beta.1
 platform: ruby
 authors:
 - Lyndsey Ferguson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-26 00:00:00.000000000 Z
+date: 2020-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -261,6 +261,7 @@ files:
 - lib/fastlane/plugin/test_center/actions/collate_json_reports.rb
 - lib/fastlane/plugin/test_center/actions/collate_junit_reports.rb
 - lib/fastlane/plugin/test_center/actions/collate_test_result_bundles.rb
+- lib/fastlane/plugin/test_center/actions/collate_xcresults.rb
 - lib/fastlane/plugin/test_center/actions/multi_scan.rb
 - lib/fastlane/plugin/test_center/actions/quit_core_simulator_service.rb
 - lib/fastlane/plugin/test_center/actions/suppress_tests.rb
@@ -301,9 +302,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.6
 signing_key: