fastlane-plugin-retry 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6f8e3ca7cd39efec921792b15c54547aa6ca852aa22042878426240292c7d2fb
+  data.tar.gz: 13207f94594b1e2b56ed7cb281a9138f8ab7a3ceb5151ded1c44ae03118e9eb5
+SHA512:
+  metadata.gz: ba9ca0bff84f6678ba1e62eb085d9f71ae1189f80c3c5ccd1b8b7ceba0f34b2c1be4572d57ca9d57a10bd20629117cfa9da62e4f532e7d9deab5da4ddecb7e80
+  data.tar.gz: 1be1c820c5104db4ad1cced8576887945414c466c4c6bb43d92faa14d19ea6f1cccccc570ae8efb1b64706d1abe80e72516bf7463cfe88ed05b988b948654ee5

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 gmgchow <gchow@mercari.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,59 @@
+# retry plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-retry)
+
+A fastlane plugin that automatically retries failed XCUITest test cases. This plugin is loosely based off [lyndsey-ferguson's fastlane-plugin-test_center](https://github.com/lyndsey-ferguson/fastlane-plugin-test_center) plugin, which uses JUnit reports instead of PList to generate a simple HTML report.
+
+This plugin works with the following logic:
+1) Run the whole test suite once
+2) Parse the generated .plist results to obtain a list of the failed tests
+3) Retry the failed tests an 'x' number of times (see below for how to specify the number of retries) and generate a .plist report for each retry run
+4) Merge all .plist reports together to generate one final .plist report
+
+Tip: You can then use the final .plist report with the [XCHtmlReport plugin](https://github.com/TitouanVanBelle/XCTestHTMLReport) to generate a very beautiful HTML report including screenshots and console logs! See the sample fastfile for usage.
+
+This plugin is available in the [Ruby Gems directory](https://rubygems.org/gems/fastlane-plugin-retry).
+
+## Installation
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-retry`, add it to your project by running:
+
+```
+fastlane add_plugin retry
+```
+Check that the command above generated a Pluginfile in your project's fastlane folder. The Pluginfile should contain the following text:
+```
+gem 'fastlane-plugin-retry', '~> 1.0', '>= 1.0.5'
+```
+Add the following line to your project's Gemfile:
+```
+plugins_path = File.join(File.dirname(__FILE__), 'fastlane', 'Pluginfile')
+eval_gemfile(plugins_path) if File.exist?(plugins_path)
+```
+Finally, run the following command to install the plugin files to your project's Bundler folder.
+```
+bundle install
+```
+
+## Usage
+
+See the sample fastfile for how to configure your project's fastfile. Once you have configured your fastfile, use the following command to run your tests with retry (you can change the number of tries and the device).
+```
+bundle exec fastlane run_tests_with_retry tries:3 devices:"platform=iOS Simulator,name=iPhone 8,OS=11.4"
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_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).

data/lib/fastlane/plugin/retry.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/retry/version'
+
+module Fastlane
+  module Retry
+    # 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::Retry.all_classes.each do |current|
+  require current
+end

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

@@ -0,0 +1,167 @@
+require 'nokogiri'
+require 'nokogiri-plist'
+require 'FileUtils'
+
+module Fastlane
+  module Actions
+    class CollateJunitReportsAction < Action
+
+      def self.run(params)
+        report_filepaths = params[:reports].reverse
+        # If no retries are required return the results
+        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) }
+          # Clean each retry report and merge it into the first report
+          reports.each do |retry_report|
+            retry_report = clean_report(retry_report.to_s)
+            mergeLists(target_report, retry_report, params)
+          end
+        end
+        # Merge screenshots and console logs from all retry runs
+        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)
+          # For each retried test, get the corresponding node of data from the retried report and merge it into the base report
+          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)
+        # Removes unescaped <> characters which cause the final .plist to become unreadable
+        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/actions/multi_scan.rb

@@ -0,0 +1,122 @@
+module Fastlane
+  module Actions
+    require 'fastlane/actions/scan'
+    require 'shellwords'
+    require 'nokogiri'
+    require 'nokogiri-plist'
+
+    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
+
+        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 = plist_report_filepath(scan_options)
+            failed_tests = parse_failures(report_filepath, params[:scheme])
+            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, scheme_name)
+        failures = Array.new
+        target_report = File.open(plist) {|f| Nokogiri::XML(f)}
+        # Get the names of all the failed tests from the specified report
+        failed = target_report.xpath("//key[contains(.,'Failure')]/../key[contains(.,'TestIdentifier')]/following-sibling::string[contains(.,'()') and contains (., '/')]")
+        failed.each do |test_name|
+          # Reformat the test name to be usable by the xcodebuild 'only_testing' flag
+          failures << ("#{scheme_name}/" + 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}*/*/*/action_TestSummaries.plist")
+        asset_files = Dir.glob("#{folder}*/*/*/Attachments")
+        log_files = Dir.glob("#{folder}*/*/*/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
+
+      def self.plist_report_filepath(config)
+        File.absolute_path(File.join(config[:output_directory], "/#{config[:scheme]}.test_result/TestSummaries.plist"))
+      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/actions/retry_action.rb

@@ -0,0 +1,47 @@
+require 'fastlane/action'
+require_relative '../helper/retry_helper'
+
+module Fastlane
+  module Actions
+    class RetryAction < Action
+      def self.run(params)
+        UI.message("The retry plugin is working!")
+      end
+
+      def self.description
+        "Retries failed XCUITest test cases"
+      end
+
+      def self.authors
+        ["gmgchow"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        ""
+      end
+
+      def self.available_options
+        [
+          # FastlaneCore::ConfigItem.new(key: :your_option,
+          #                         env_name: "RETRY_YOUR_OPTION",
+          #                      description: "A description of your option",
+          #                         optional: false,
+          #                             type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        # [:ios, :mac, :android].include?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/retry/helper/retry_helper.rb

@@ -0,0 +1,16 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class RetryHelper
+      # class methods that you define here become available in your action
+      # as `Helper::RetryHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the retry plugin helper!")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module Retry
+    VERSION = "1.1.0"
+  end
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-retry
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- gmgchow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-07 00:00:00.000000000 Z
+dependencies:
+- !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: 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: 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: rspec_junit_formatter
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  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'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.97.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.97.0
+description: 
+email: gchow@mercari.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/retry.rb
+- lib/fastlane/plugin/retry/actions/collate_junit_reports.rb
+- lib/fastlane/plugin/retry/actions/multi_scan.rb
+- lib/fastlane/plugin/retry/actions/retry_action.rb
+- lib/fastlane/plugin/retry/helper/retry_helper.rb
+- lib/fastlane/plugin/retry/version.rb
+homepage: 
+licenses:
+- MIT
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Retries failed XCUITest test cases
+test_files: []