fastlane-plugin-test_center 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '083be0187ece34a8f7019e4992c1fa2330b4732d'
-  data.tar.gz: 364b206944566949934477d518853537f27cdabb
+  metadata.gz: 2c6a17f7ee4ae4381b5cff509b6ea0d2a7e860b8
+  data.tar.gz: 79aac0aa87a128f9ab42841a1c5b8b87db1165b8
 SHA512:
-  metadata.gz: 64532eb3e5dfe6afdf6b49fe27555e58d052fc60cf3d57363becf437704e0519a696889032f0106fabafabaf5ab808f0f713b059af75a38f0e9aecc44e8f2cde
-  data.tar.gz: 301e3e7946ab86b32aa310fd73b01cb2b222c00b99d1a255575964c1bed55ca864bf66b55ff2d50690776ff399d3c57335ac3d6737de2262c50a720a565af0e5
+  metadata.gz: 602af20f6d4659244c748df0907077e87b432756d1f3c8cf55873f29b8c47432d5f62a4ad6e07227a54313a959e97b2662a3cb6308c35ecc1f38f0764d7eea62
+  data.tar.gz: '096cb269e5fad71c010807212a466dc6067fa6dc86f63c9ba1484c6200d71d8af5a2bdf3965f6dd95c6155119b6d069bbd5294d6f067d781faa65e4bc5c170c9'

data/README.md

@@ -70,6 +70,7 @@ This fastlane plugin includes the following actions:
 - [`collate_junit_reports`](#collate_junit_reports): combines multiple junit test reports into one report.
 - [`collate_html_reports`](#collate_html_reports): combines multiple html test reports into one report.
 - [`collate_json_reports`](#collate_json_reports): combines multiple json test reports into one report.
+- [`collate_test_result_bundles`](#collate_test_result_bundles): combines multiple test_result bundles into one test_result bundle.
 
 ### multi_scan 🎉
 
@@ -107,27 +108,6 @@ UI.success("multi_scan passed? #{summary[:result]}")
 
 ```ruby
 
-UI.important(
-  'example: ' \
-  'run tests for a scheme that has two test targets, re-trying up to 2 times if ' \
-  'tests fail. Make sure that the default behavior of failing the build works.'
-)
-begin
-  multi_scan(
-    project: File.absolute_path('../AtomicBoy/AtomicBoy.xcodeproj'),
-    scheme: 'AtomicBoy',
-    try_count: 2
-  )
-rescue FastlaneCore::Interface::FastlaneTestFailure => e
-  UI.success("failed successfully with #{e.message}")
-else
-  raise 'This should have failed'
-end
-
-```
-
-```ruby
-
 UI.important(
   'example: ' \
   'split the tests into 2 batches and run each batch of tests up to 3 ' \
@@ -158,9 +138,7 @@ test_run_block = lambda do |testrun_info|
   try_attempt = testrun_info[:try_count]
   batch = testrun_info[:batch]
 
-  if passed_test_count > 0 && failed_test_count > passed_test_count / 2
-    UI.abort_with_message!("Too many tests are failing")
-  end
+  # UI.abort_with_message!('You could conditionally abort')
   UI.message("\ὠA everything is fine, let's continue try #{try_attempt + 1} for batch #{batch}")
 end
 
@@ -220,7 +198,7 @@ multi_scan(
   scheme: 'Professor',
   try_count: 3,
   custom_report_file_name: 'atomic_report.xml',
-  output_types: 'junit,html',
+  output_types: 'junit',
   fail_build: false
 )
 
@@ -549,6 +527,30 @@ collate_json_reports(
 <!-- collate_json_reports examples: end -->
 </details>
 
+### collate_test_result_bundles
+
+Do you have multiple test_result bundles coming in from different sources and need it combined? Use this action to collate all the tests performed for a given test target into one test_result bundle.
+
+<details>
+    <summary>Example Code:</summary>
+<!-- collate_test_result_bundles examples: begin -->
+
+```ruby
+
+UI.important(
+  'example: ' \
+  'collate the test_result bundles to a temporary bundle "result.test_result"'
+)
+bundles = Dir['../spec/fixtures/*.test_result'].map { |relpath| File.absolute_path(relpath) }
+collate_test_result_bundles(
+  bundles: bundles,
+  collated_bundle: File.join(Dir.mktmpdir, 'result.test_result')
+)
+
+```
+<!-- collate_test_result_bundles examples: end -->
+</details>
+
 ## Run tests for this plugin
 
 To run both the tests, and code style validation, run

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

@@ -0,0 +1,180 @@
+module Fastlane
+  module Actions
+    class CollateTestResultBundlesAction < Action
+      require 'plist'
+
+      def self.run(params)
+        test_result_bundlepaths = params[:bundles]
+        base_bundle_path = test_result_bundlepaths[0]
+        if test_result_bundlepaths.size > 1
+          base_bundle_path = Dir.mktmpdir(['base', '.test_result'])
+          FileUtils.cp_r(File.join(test_result_bundlepaths[0], '.'), base_bundle_path)
+          test_result_bundlepaths.shift
+          test_result_bundlepaths.each do |other_bundlepath|
+            collate_bundles(base_bundle_path, other_bundlepath)
+          end
+        end
+        FileUtils.rm_rf(params[:collated_bundle])
+        FileUtils.cp_r(base_bundle_path, params[:collated_bundle])
+        UI.message("Finished collating test_result bundle to '#{params[:collated_bundle]}'")
+      end
+
+      def self.collate_bundles(base_bundle_path, other_bundle_path)
+        Dir.foreach(other_bundle_path) do |child_item|
+          if child_item == 'Info.plist'
+            collate_infoplist(
+              File.join(base_bundle_path, child_item),
+              File.join(other_bundle_path, child_item)
+            )
+          elsif /\d_Test/ =~ child_item
+            test_target_path = File.join(base_bundle_path, child_item)
+            other_target_path = File.join(other_bundle_path, child_item)
+            Dir.foreach(other_target_path) do |grandchild_item|
+              collate_bundle(test_target_path, other_target_path, grandchild_item)
+            end
+          else
+            collate_bundle(base_bundle_path, other_bundle_path, child_item)
+          end
+        end
+      end
+
+      def self.collate_bundle(base_bundle_path, other_bundle_path, child_item_name)
+        if %w{Attachments Diagnostics}.include?(child_item_name)
+          FileUtils.cp_r(
+            File.join(other_bundle_path, child_item_name, '.'),
+            File.join(base_bundle_path, child_item_name)
+          )
+        elsif child_item_name.end_with?('.xcactivitylog')
+          concatenate_zipped_activitylogs(
+            File.join(base_bundle_path, child_item_name),
+            File.join(other_bundle_path, child_item_name)
+          )
+        elsif child_item_name.end_with?('TestSummaries.plist')
+          collate_testsummaries_plist(
+            File.join(base_bundle_path, child_item_name),
+            File.join(other_bundle_path, child_item_name)
+          )
+        end
+      end
+
+      def self.concatenate_zipped_activitylogs(base_activity_log_path, other_activity_log_path)
+        gunzipped_base_filepath = File.join(
+          File.dirname(base_activity_log_path),
+          File.basename(base_activity_log_path, '.*')
+        )
+        gunzipped_other_filepath = File.join(
+          File.dirname(other_activity_log_path),
+          File.basename(other_activity_log_path, '.*')
+        )
+        sh("gunzip -k -S .xcactivitylog #{other_activity_log_path}", print_command: false, print_command_output: false)
+        sh("gunzip -S .xcactivitylog #{base_activity_log_path}", print_command: false, print_command_output: false)
+        sh("cat #{gunzipped_other_filepath} > #{gunzipped_base_filepath}", print_command: false, print_command_output: false)
+        FileUtils.rm(gunzipped_other_filepath)
+        sh("gzip -S .xcactivitylog #{gunzipped_base_filepath}", print_command: false, print_command_output: false)
+      end
+
+      def self.collate_testsummaries_plist(base_testsummaries_plist_filepath, other_testsummaries_plist_filepath)
+        if File.exist?(base_testsummaries_plist_filepath)
+          base_testsummaries_plist = Plist.parse_xml(base_testsummaries_plist_filepath)
+          other_testsummaries_plist = Plist.parse_xml(other_testsummaries_plist_filepath)
+          base_testsummaries_plist['TestableSummaries'].zip(other_testsummaries_plist['TestableSummaries']).each do |base_testable_summary, other_testable_summary|
+            unless base_testable_summary.key?('PreviousTests')
+              base_testable_summary['PreviousTests'] = []
+            end
+            base_testable_summary['PreviousTests'].concat(base_testable_summary['Tests'] || [])
+            base_testable_summary['Tests'] = other_testable_summary['Tests']
+          end
+          Plist::Emit.save_plist(base_testsummaries_plist, base_testsummaries_plist_filepath)
+        else
+          FileUtils.cp(other_testsummaries_plist, base_testsummaries_plist)
+        end
+      end
+
+      def self.collate_infoplist(base_infoplist_filepath, other_infoplist_filepath)
+        if File.exist?(base_infoplist_filepath)
+          base_infoplist = Plist.parse_xml(base_infoplist_filepath)
+          other_infoplist = Plist.parse_xml(other_infoplist_filepath)
+          other_infoplist['Actions'].zip(base_infoplist['Actions']).each do |other_action, base_action|
+            if other_action['Title'] != base_action['Title']
+              raise 'Info.plist Actions do not align: cannot collate'
+            end
+            base_action['EndedTime'] = other_action['EndedTime']
+            base_action['ActionResult']['TestsFailedCount'] = other_action['ActionResult']['TestsFailedCount']
+          end
+          Plist::Emit.save_plist(base_infoplist, base_infoplist_filepath)
+        else
+          FileUtils.cp(other_infoplist_filepath, base_infoplist_filepath)
+        end
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Combines and combines tests from multiple test_result bundles"
+      end
+
+      def self.details
+        "The first test_result 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 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." \
+        ""
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :bundles,
+            env_name: 'COLLATE_TEST_RESULT_BUNDLES_BUNDLES',
+            description: 'An array of test_result bundles to collate. The first bundle is used as the base into which other bundles are merged in',
+            optional: false,
+            type: Array,
+            verify_block: proc do |bundles|
+              UI.user_error!('No test_result bundles found') if bundles.empty?
+              bundles.each do |bundle|
+                UI.user_error!("Error: test_result bundle not found: '#{bundle}'") unless Dir.exist?(bundle)
+              end
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :collated_bundle,
+            env_name: 'COLLATE_TEST_RESULT_BUNDLES_COLLATED_BUNDLE',
+            description: 'The final test_result bundle where all testcases will be merged into',
+            optional: true,
+            default_value: 'result.test_result',
+            type: String
+          )
+        ]
+      end
+
+      def self.example_code
+        [
+          "
+          UI.important(
+            'example: ' \\
+            'collate the test_result bundles to a temporary bundle \"result.test_result\"'
+          )
+          bundles = Dir['../spec/fixtures/*.test_result'].map { |relpath| File.absolute_path(relpath) }
+          collate_test_result_bundles(
+            bundles: bundles,
+            collated_bundle: File.join(Dir.mktmpdir, 'result.test_result')
+          )
+          "
+        ]
+      end
+
+      def self.authors
+        ["lyndsey-ferguson/@lyndseydf"]
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+    end
+  end
+end

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

@@ -63,6 +63,11 @@ module Fastlane
             File.absolute_path(relative_filepath)
           end
         end
+        if scan_options[:result_bundle]
+          report_files += Dir.glob("#{scan_options[:output_directory]}/**/*.test_result").map do |relative_test_result_bundle_filepath|
+            File.absolute_path(relative_test_result_bundle_filepath)
+          end
+        end
         {
           result: tests_passed,
           total_tests: passing_testcount + failed_tests.size,
@@ -188,24 +193,6 @@ module Fastlane
           UI.success(\"multi_scan passed? \#{summary[:result]}\")
           ",
           "
-          UI.important(
-            'example: ' \\
-            'run tests for a scheme that has two test targets, re-trying up to 2 times if ' \\
-            'tests fail. Make sure that the default behavior of failing the build works.'
-          )
-          begin
-            multi_scan(
-              project: File.absolute_path('../AtomicBoy/AtomicBoy.xcodeproj'),
-              scheme: 'AtomicBoy',
-              try_count: 2
-            )
-          rescue FastlaneCore::Interface::FastlaneTestFailure => e
-            UI.success(\"failed successfully with \#{e.message}\")
-          else
-            raise 'This should have failed'
-          end
-          ",
-          "
           UI.important(
             'example: ' \\
             'split the tests into 2 batches and run each batch of tests up to 3 ' \\
@@ -233,9 +220,7 @@ module Fastlane
             try_attempt = testrun_info[:try_count]
             batch = testrun_info[:batch]
 
-            if passed_test_count > 0 && failed_test_count > passed_test_count / 2
-              UI.abort_with_message!(\"Too many tests are failing\")
-            end
+            # UI.abort_with_message!('You could conditionally abort')
             UI.message(\"\\\u1F60A everything is fine, let's continue try \#{try_attempt + 1} for batch \#{batch}\")
           end
 
@@ -286,7 +271,7 @@ module Fastlane
             scheme: 'Professor',
             try_count: 3,
             custom_report_file_name: 'atomic_report.xml',
-            output_types: 'junit,html',
+            output_types: 'junit',
             fail_build: false
           )
           ",

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

@@ -103,6 +103,10 @@ module TestCenter
         if reportnamer.includes_json?
           collate_json_reports(output_directory, reportnamer)
         end
+
+        if @scan_options[:result_bundle]
+          collate_test_result_bundles(output_directory, reportnamer)
+        end
       end
 
       def passed_test_count_from_summary(summary)
@@ -110,6 +114,24 @@ module TestCenter
         test_count.to_i - test_failures.to_i
       end
 
+      def collate_test_result_bundles(output_directory, reportnamer)
+        test_result_bundlepaths = Dir.glob("#{output_directory}/#{@scan_options[:scheme]}*.test_result").map do |relative_test_result_bundle_filepath|
+          File.absolute_path(relative_test_result_bundle_filepath)
+        end
+        if test_result_bundlepaths.size > 1
+          config = FastlaneCore::Configuration.create(
+            Fastlane::Actions::CollateTestResultBundlesAction.available_options,
+            {
+              bundles: test_result_bundlepaths.sort { |f1, f2| File.mtime(f1) <=> File.mtime(f2) },
+              collated_bundle: File.join(output_directory, @scan_options[:scheme]) + '.test_result'
+            }
+          )
+          Fastlane::Actions::CollateTestResultBundlesAction.run(config)
+        end
+        retried_test_result_bundlepaths = Dir.glob("#{output_directory}/#{@scan_options[:scheme]}_*.test_result")
+        FileUtils.rm_rf(retried_test_result_bundlepaths)
+      end
+
       def collate_json_reports(output_directory, reportnamer)
         report_filepaths = Dir.glob("#{output_directory}/#{reportnamer.json_fileglob}").map do |relative_filepath|
           File.absolute_path(relative_filepath)
@@ -198,13 +220,13 @@ module TestCenter
 
             scan_options[:only_testing] = info[:failed].map(&:shellescape)
             FastlaneCore::UI.message('Re-running scan on only failed tests')
+            reportnamer.increment
             if @scan_options[:result_bundle]
               built_test_result, moved_test_result = test_result_bundlepaths(
                 scan_options[:output_directory], reportnamer
               )
               FileUtils.mv(built_test_result, moved_test_result)
             end
-            reportnamer.increment
             retry
           end
           tests_passed = false
@@ -239,6 +261,12 @@ module TestCenter
           json_report_filepath = File.join(output_directory, reportnamer.json_last_reportname)
           info[:json_report_filepath] = json_report_filepath
         end
+        if @scan_options[:result_bundle]
+          test_result_suffix = '.test_result'
+          test_result_suffix.prepend("_#{reportnamer.report_count}") unless reportnamer.report_count.zero?
+          test_result_bundlepath = File.join(output_directory, @scan_options[:scheme]) + test_result_suffix
+          info[:test_result_bundlepath] = test_result_bundlepath
+        end
         info
       end
 

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

@@ -1,5 +1,5 @@
 module Fastlane
   module TestCenter
-    VERSION = "3.4.0"
+    VERSION = "3.5.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-test_center
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Lyndsey Ferguson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-24 00:00:00.000000000 Z
+date: 2018-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -206,15 +206,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |2
-      This fastlane plugin includes the following actions:
-      1) multi_scan: uses scan to run Xcode tests, optionally in batches, a given number of times: only re-testing failing tests.
-      2) suppress_tests_from_junit: uses a junit xml report file to suppress either passing or failing tests in an Xcode Scheme.
-      3) suppress_tests: suppresses specific tests in a specific or all Xcode Schemes in a given project.
-      4) suppressed_tests: retrieves a list of tests that are suppressed in a specific or all Xcode Schemes in a project.
-      5) tests_from_junit: retrieves the failing and passing tests as reported in a junit xml file.
-      6) tests_from_xctestrun: retrieves all of the tests from xctest bundles referenced by the xctestrun file
-      7) collate_junit_reports: collects and correctly organizes junit reports from multiple test passes.
+description: "    This fastlane plugin includes the following many actions to better
+  manage how you test, what you test, and the information you get from your tests\n"
 email: ldf.public+github@outlook.com
 executables: []
 extensions: []
@@ -226,6 +219,7 @@ files:
 - lib/fastlane/plugin/test_center/actions/collate_html_reports.rb
 - 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/multi_scan.rb
 - lib/fastlane/plugin/test_center/actions/suppress_tests.rb
 - lib/fastlane/plugin/test_center/actions/suppress_tests_from_junit.rb