fastlane-plugin-test_center 3.1.3 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0486d5117e1539891943e8ea57c81984fbf67b3
-  data.tar.gz: 255a3287ae7045eb149d5009e38bb68dd4c6767c
+  metadata.gz: 1d20795b34c16cec61b3f6356cda1307dd6dc849
+  data.tar.gz: 0171b56560823d9da202a0caa98cfec51d897e3e
 SHA512:
-  metadata.gz: a44d876d906e83f449dd63f09c335b1bad8db33e3006b02b18cdbef9bc122a5b9dbe1ee35020414c1f3143644aa5e29125285baa041c6d564082eaa66b98c896
-  data.tar.gz: 6963a55aaac02d7ce83fdf5d98a7d2ffb998f3b26f276318308c4f2e8c84211c6e518e7ab5ebe75ce5c4b855c079e6391fc1d5565cf96702d02fb0730faba7ac
+  metadata.gz: 531270afbe621592914946811f17f69bc5798198dfa53466ba9c312551f33c7412a1b9be1c2f4ceebc74f399ed0eca83a30b2a10d39db98889437a829c5f1413
+  data.tar.gz: 2168773f546018afa810fc5c66984081448b22886ed7f846c091625519ff558827562b51d1732cfd6ed4eb5968c74719b73eee8699c7510c74dd2b9850b80805

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

@@ -0,0 +1,169 @@
+module Fastlane
+  module Actions
+    class CollateHtmlReportsAction < Action
+      def self.run(params)
+        report_filepaths = params[:reports]
+        if report_filepaths.size == 1
+          FileUtils.cp(report_filepaths[0], params[:collated_report])
+        else
+          reports = report_filepaths.map { |report_filepath| REXML::Document.new(File.new(report_filepath)) }
+
+          # copy any missing testsuites
+          target_report = reports.shift
+          reports.each do |report|
+            report.elements.each("//section[contains(@class, 'test-suite')]") do |testsuite|
+              collate_testsuite(testsuite_from_report(target_report, testsuite), testsuite)
+            end
+          end
+          update_testsuites_status(target_report)
+          update_test_counts(target_report)
+
+          FileUtils.mkdir_p(File.dirname(params[:collated_report]))
+
+          File.open(params[:collated_report], 'w') do |f|
+            target_report.write(f, 2)
+          end
+        end
+      end
+
+      def self.testsuite_from_report(report, testsuite)
+        testsuite_name = testsuite.attributes['id']
+        REXML::XPath.first(report, "//section[contains(@class, 'test-suite') and @id='#{testsuite_name}']")
+      end
+
+      def self.testcases_from_testsuite(testsuite)
+        REXML::XPath.match(testsuite, ".//*[contains(@class, 'tests')]//*[contains(@class, 'test')]//*[contains(@class, 'title')]")
+      end
+
+      def self.testcase_from_testsuite(testsuite, testcase_name)
+        REXML::XPath.first(testsuite, "*[contains(@class, 'test')]//*[text()='#{testcase_name}']/../..")
+      end
+
+      def self.collate_testsuite(target_testsuite, testsuite)
+        if target_testsuite
+          testcases = testcases_from_testsuite(testsuite)
+          testcases.each do |testcase|
+            testresult = testcase.parent.parent
+            target_testresult = testcase_from_testsuite(target_testsuite, testcase.text)
+            collate_testresults(target_testresult, testresult)
+          end
+        else
+          testable = REXML::XPath.first(target_report, "//section[@id='test-suites']")
+          testable << testsuite
+        end
+      end
+
+      def self.collate_testresults(target_testresult, testresult)
+        if target_testresult
+          collate_testresult_details(target_testresult, testresult)
+          target_testresult.parent.replace_child(target_testresult, testresult)
+        else
+          target_testresult << testresult
+        end
+      end
+
+      def self.collate_testresult_details(target_testresult, testresult)
+        target_testdetails = details_for_testresult(target_testresult)
+        testdetails = details_for_testresult(testresult)
+
+        if target_testdetails
+          if testdetails
+            target_testresult.parent.replace_child(target_testdetails, testdetails)
+          else
+            target_testresult.parent.delete_element(target_testdetails)
+          end
+        end
+      end
+
+      def self.update_testsuites_status(report)
+        report.elements.each("//section[contains(@class, 'test-suite')]") do |testsuite|
+          failing_tests_xpath = "./*[contains(@class, 'tests')]//*[" \
+                "contains(@class, 'failing')]"
+
+          class_attributes = testsuite.attributes['class']
+          test_failures = REXML::XPath.match(testsuite, failing_tests_xpath)
+          test_status = test_failures.size.zero? ? 'passing' : 'failing'
+
+          testsuite.attributes['class'] = class_attributes.sub('failing', test_status)
+        end
+      end
+
+      def self.update_test_counts(report)
+        tests_xpath = "//*[contains(@class, 'tests')]//*[contains(@class, 'test')]//*[contains(@class, 'title')]"
+        tests = REXML::XPath.match(report, tests_xpath)
+
+        failing_tests_xpath = "//*[contains(@class, 'tests')]//*[" \
+                "contains(@class, 'details') and " \
+                "contains(@class, 'failing')]"
+
+        test_failures = REXML::XPath.match(report, failing_tests_xpath)
+        REXML::XPath.first(report, ".//*[@id='test-count']/span").text = tests.size
+        REXML::XPath.first(report, ".//*[@id='fail-count']/span").text = test_failures.size
+      end
+
+      def self.details_for_testresult(testresult)
+        testcase = REXML::XPath.first(testresult, ".//*[contains(@class, 'title')]")
+
+        xpath = "../*[" \
+                "contains(@class, 'details') and " \
+                "contains(@class, 'failing') and " \
+                "contains(@class, '#{testcase.text}')]"
+
+        REXML::XPath.first(testresult, xpath)
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Combines and combines tests from multiple html report files"
+      end
+
+      def self.details
+        "The first HTML report is used as the base report. Testcases " \
+        "from other reports are added if they do not already exist, or " \
+        "if the testcases already exist, they are replaced." \
+        "" \
+        "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 HTML reports will have more passed tests." \
+        ""
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :reports,
+            env_name: 'COLLATE_HTML_REPORTS_REPORTS',
+            description: 'An array of HTML reports to collate. The first report is used as the base into which other reports are merged in',
+            optional: false,
+            type: Array,
+            verify_block: proc do |reports|
+              UI.user_error!('No HTML report files found') if reports.empty?
+              reports.each do |report|
+                UI.user_error!("Error: HTML report not found: '#{report}'") unless File.exist?(report)
+              end
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :collated_report,
+            env_name: 'COLLATE_HTML_REPORTS_COLLATED_REPORT',
+            description: 'The final HTML report file where all testcases will be merged into',
+            optional: true,
+            default_value: 'result.html',
+            type: String
+          )
+        ]
+      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

@@ -52,6 +52,12 @@ module Fastlane
           passing_testcount += junit_results[:passing].size
           failure_details.merge!(junit_results[:failure_details])
         end
+
+        if reportnamer.includes_html?
+          report_files += Dir.glob("#{scan_options[:output_directory]}/**/*#{reportnamer.html_filextension}").map do |relative_filepath|
+            File.absolute_path(relative_filepath)
+          end
+        end
         {
           result: tests_passed,
           total_tests: passing_testcount + failed_tests.size,

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

@@ -107,6 +107,24 @@ module TestCenter
         end
         retried_junit_reportfiles = Dir.glob("#{output_directory}/**/*-[1-9]*#{reportnamer.junit_filextension}")
         FileUtils.rm_f(retried_junit_reportfiles)
+
+        if reportnamer.includes_html?
+          report_files = Dir.glob("#{output_directory}/*#{reportnamer.html_filextension}").map do |relative_filepath|
+            File.absolute_path(relative_filepath)
+          end
+          if report_files.size > 1
+            config = FastlaneCore::Configuration.create(
+              Fastlane::Actions::CollateHtmlReportsAction.available_options,
+              {
+                reports: report_files.sort { |f1, f2| File.mtime(f1) <=> File.mtime(f2) },
+                collated_report: File.absolute_path(File.join(output_directory, reportnamer.html_reportname))
+              }
+            )
+            Fastlane::Actions::CollateHtmlReportsAction.run(config)
+          end
+          retried_html_reportfiles = Dir.glob("#{output_directory}/**/*-[1-9]*#{reportnamer.html_filextension}")
+          FileUtils.rm_f(retried_html_reportfiles)
+        end
       end
 
       def correcting_scan(scan_run_options, batch, reportnamer)

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

@@ -64,6 +64,26 @@ module TestCenter
         File.extname(junit_reportname)
       end
 
+      # --- HTML ---
+      # TODO: what to do when there are no html output types?
+      def includes_html?
+        @output_types.split(',').find_index('html') != nil
+      end
+
+      def html_last_reportname
+        html_index = @output_types.split(',').find_index('html')
+        numbered_filename(@output_files.to_s.split(',')[html_index])
+      end
+
+      def html_reportname
+        html_index = @output_types.split(',').find_index('html')
+        @output_files.to_s.split(',')[html_index]
+      end
+
+      def html_filextension
+        File.extname(html_reportname)
+      end
+
       def increment
         @report_count += 1
       end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module TestCenter
-    VERSION = "3.1.3"
+    VERSION = "3.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-test_center
 version: !ruby/object:Gem::Version
-  version: 3.1.3
+  version: 3.2.0
 platform: ruby
 authors:
 - Lyndsey Ferguson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-27 00:00:00.000000000 Z
+date: 2018-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plist
@@ -195,6 +195,7 @@ files:
 - LICENSE
 - README.md
 - lib/fastlane/plugin/test_center.rb
+- lib/fastlane/plugin/test_center/actions/collate_html_reports.rb
 - lib/fastlane/plugin/test_center/actions/collate_junit_reports.rb
 - lib/fastlane/plugin/test_center/actions/multi_scan.rb
 - lib/fastlane/plugin/test_center/actions/suppress_tests.rb