fastlane-plugin-retry_failed_tests 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 20fd4cac4f47a56fd5f417bbad92baab1eb987b3
+  data.tar.gz: f26377521254943b98724be7fb045d94e65b0047
+SHA512:
+  metadata.gz: 986d917d1a0991f2e4fb5819153dc28c3a10989dcdc13587711fa9c8bdcd1111db22d94171783716e34b307ef8943fdb277b2bc413a71970227b91b8d02a64c5
+  data.tar.gz: 16b51dad340b3517bba29d10134272da4dd29fad6b814be3a05820bf4c0636825cb0195847652ad7d2e4364c1b3b8c376107b64118b19d3ff9e7782f020696df

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Lyndsey Ferguson <lyndsey.ferguson@appian.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,2 @@
+# fastlane-plugin-retry
+A fastlane plugin for retrying iOS automation tests. Based on the "fastlane-plugin-test_center" plugin repository by Github user lyndsey-ferguson. 

data/lib/fastlane/plugin/retry_tests/actions/collate_junit_reports.rb

@@ -0,0 +1,163 @@
+require 'pry-byebug'
+require 'nokogiri'
+require 'nokogiri-plist'
+require 'FileUtils'
+
+module Fastlane
+  module Actions
+    class CollateJunitReportsAction < Action
+
+      def self.run(params)
+        report_filepaths = params[:reports].reverse
+        if report_filepaths.size == 1
+          FileUtils.cp(report_filepaths[0], params[:collated_report])
+        else
+          target_report = File.open(report_filepaths.shift) {|f| Nokogiri::XML(f)}
+          reports = report_filepaths.map { |report_filepath| Nokogiri::XML(Nokogiri::PList(open(report_filepath)).to_plist) }
+          reports.each do |retry_report|
+            retry_report = clean_report(retry_report.to_s)
+            mergeLists(target_report, retry_report, params)
+          end
+        end
+        merge_assets(params[:assets], params[:collated_report] + "/Attachments")
+        merge_logs(params[:logs], params[:collated_report] + "/")
+      end
+
+      # Merges .plist reports
+      def self.mergeLists(target_report, retry_report, params)
+        UI.verbose("Merging retried results...")
+        Dir.mkdir(params[:collated_report]) unless File.exists?(params[:collated_report])
+        file_name = params[:collated_report] + "/action_TestSummaries.plist"
+        retried_tests = retry_report.xpath("//key[contains(.,'TestSummaryGUID')]/..")
+        current_node = retried_tests.shift
+        while (current_node != nil)
+          testName = get_test_name(current_node)
+          matching_node = target_report.at_xpath("//string[contains(.,'#{testName}')]/..")
+          if (!matching_node.nil?)
+            matching_node.previous.next.replace(current_node)
+            write_report_to_file(target_report, file_name)
+          end
+          current_node = retried_tests.shift
+        end
+      end
+
+      # Merges screenshots from all retries
+      def self.merge_assets(asset_files, assets_folder)
+        UI.verbose ("Merging screenshot folders...")
+        Dir.mkdir(assets_folder) unless File.exists?(assets_folder)
+        asset_files.each do |folder|
+          FileUtils.cp_r(Dir[folder + '/*'], assets_folder)
+        end
+      end
+
+      # Cleans formatting of report
+      def self.clean_report(report)
+        report = report.gsub("<XCAccessibilityElement:/>0x", " XCAccessibilityElement ")
+        report = report.gsub("<XCAccessibilityElement:></XCAccessibilityElement:>", " XCAccessibilityElement ")
+        report = Nokogiri::XML(report)
+        report
+      end
+
+      # Merges console log of reports
+      def self.merge_logs(log_files, logs_folder)
+        UI.verbose("Merging console logs...")
+        target_log = log_files.shift
+        log_files.each do |log|
+          to_append = File.read(log)
+          File.open(target_log, "a") do |handle|
+            handle.puts to_append
+          end
+          FileUtils.cp_r(target_log, logs_folder)
+        end
+      end
+
+      # Outputs report to a new file
+      def self.write_report_to_file(report, file_name)
+        UI.verbose("Writing merged results to file...")
+        File.new(file_name, 'w')
+        File.open(file_name, 'w') do |f|
+          f.write(report.to_xml)
+        end
+      end
+
+      # Returns the test name of the retried test
+      def self.get_test_name(test_data)
+        test_name = test_data.xpath("(//key[contains(.,'TestSummaryGUID')])/../key[contains(.,'TestName')]/following-sibling::string").to_a[0].to_s
+        test_name = test_name[8..-10]
+        test_name
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Combines test results from multiple plist files."
+      end
+
+      def self.details
+        "Based on the fastlane-plugins-test_center plugin by lyndsey-ferguson/@lyndseydf"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :reports,
+            env_name: 'COLLATE_PLIST_REPORTS_REPORTS',
+            description: 'An array of plist 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 plist report files found') if reports.empty?
+              reports.each do |report|
+                UI.user_error!("Error: plist report not found: '#{report}'") unless File.exist?(report)
+              end
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :collated_report,
+            env_name: 'COLLATE_PLIST_REPORTS_COLLATED_REPORT',
+            description: 'The final plist report file where all testcases will be merged into',
+            optional: true,
+            default_value: 'result.xml',
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :assets,
+            env_name: 'COLLATE_PLIST_REPORTS_ASSETS',
+            description: 'An array of plist 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 |assets|
+              UI.user_error!('No plist report files found') if assets.empty?
+              assets.each do |asset|
+                UI.user_error!("Error: plist report not found: '#{asset}'") unless File.exist?(asset)
+              end
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :logs,
+            env_name: 'COLLATE_PLIST_REPORTS_LOGS',
+            description: 'An array of plist 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 |logs|
+              UI.user_error!('No plist report files found') if logs.empty?
+              logs.each do |log|
+                UI.user_error!("Error: plist report not found: '#{log}'") unless File.exist?(log)
+              end
+            end
+          )
+        ]
+      end
+
+      def self.authors
+        ["Gloria Chow/@gmgchow"]
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+    end
+  end
+end

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

@@ -0,0 +1,118 @@
+module Fastlane
+  module Actions
+    require 'fastlane/actions/scan'
+    require 'shellwords'
+    require 'nokogiri'
+    require 'nokogiri-plist'
+    require 'pry'
+
+    class MultiScanAction < Action
+      def self.run(params)
+        try_count = 0
+        scan_options = params.values.reject { |k| k == :try_count }
+        final_report_path = scan_options[:result_bundle]
+        unless Helper.test?
+          FastlaneCore::PrintTable.print_values(
+            config: params._values.reject { |k, v| scan_options.key?(k) },
+            title: "Summary for multi_scan"
+          )
+        end
+
+        scan_options = config_with_junit_report(scan_options)
+        begin
+          try_count += 1
+          scan_options = config_with_retry(scan_options, try_count)
+          config = FastlaneCore::Configuration.create(Fastlane::Actions::ScanAction.available_options, scan_options)
+          Fastlane::Actions::ScanAction.run(config)
+        rescue FastlaneCore::Interface::FastlaneTestFailure => e
+          UI.verbose("Scan failed with #{e}")
+          if try_count < params[:try_count]
+            report_filepath = junit_report_filepath(scan_options)
+            failed_tests = parse_failures(report_filepath)
+            scan_options[:only_testing] = failed_tests
+            retry
+          end
+        end
+        merge_reports(scan_options, final_report_path)
+      end
+
+      # Parse the names of the failed test cases
+      def self.parse_failures(plist)
+        failures = Array.new
+        target_report = File.open(plist) {|f| Nokogiri::XML(f)}
+        failed = target_report.xpath("//key[contains(.,'Failure')]/../key[contains(.,'TestIdentifier')]/following-sibling::string[contains(.,'()') and contains (., '/')]")
+        failed.each do |test_name|
+          failures << ("MercariUITests/" + test_name.to_s.split('(')[0].split('>')[1])
+        end
+        failures
+      end
+
+      # Merge results from all retries
+      def self.merge_reports(scan_options, final_report_path)
+        folder = get_folder_root(scan_options[:output_directory])
+        report_files = Dir.glob("#{folder}*/MercariUITests.test_result/1_Test/action_TestSummaries.plist")
+        asset_files = Dir.glob("#{folder}*/MercariUITests.test_result/1_Test/Attachments")
+        log_files = Dir.glob("#{folder}*/MercariUITests.test_result/1_Test/action.xcactivitylog")
+        if report_files.size > 1
+          other_action.collate_junit_reports(
+            reports: report_files,
+            collated_report: final_report_path,
+            assets: asset_files,
+            logs: log_files,
+          )
+        end
+      end
+
+      # Create scan config
+      def self.config_with_retry(config, count)
+        folder = get_folder_root(config[:result_bundle])
+        config[:result_bundle] = (folder + count.to_s)
+        config[:output_directory] = (folder + count.to_s)
+        config
+      end
+
+      # Get folder location
+      def self.get_folder_root(folder)
+        folder = folder.gsub(/ *\d+$/, '')
+        folder
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Uses scan to run Xcode tests a given number of times: only re-testing failing tests."
+      end
+
+      def self.details
+        "Use this action to run your tests if you have fragile tests that fail sporadically."
+      end
+
+      def self.scan_options
+        ScanAction.available_options
+      end
+
+      def self.available_options
+        scan_options + [
+          FastlaneCore::ConfigItem.new(
+            key: :try_count,
+            env_name: "FL_MULTI_SCAN_TRY_COUNT",
+            description: "The number of times to retry running tests via scan",
+            type: Integer,
+            is_string: false,
+            default_value: 1
+          )
+        ]
+      end
+
+      def self.authors
+        ["Gloria Chow/@gmgchow"]
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module TestCenter
+    VERSION = "3.0.6"
+  end
+end

data/lib/fastlane/plugin/retry_tests.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/retry_tests/version'
+
+module Fastlane
+  module RetryTests
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::RetryTests.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-retry_failed_tests
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Gloria Chow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xcodeproj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.56.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.56.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "    Retries failed iOS tests\n"
+email: gchow@mercari.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/retry_tests.rb
+- lib/fastlane/plugin/retry_tests/actions/collate_junit_reports.rb
+- lib/fastlane/plugin/retry_tests/actions/multi_scan.rb
+- lib/fastlane/plugin/retry_tests/version.rb
+homepage: ''
+licenses:
+- ''
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Retries failed iOS tests
+test_files: []