fastlane-plugin-try_scan 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d3bf2f28d3558be4e3d2cd068beb9a4968f1957532a554aa902134c0db1e5e05
+  data.tar.gz: b4f5d09eede219e2425efce5487481947bee2a30075aac8448ba9f014ddbb48e
+SHA512:
+  metadata.gz: 575e434210450543a657cdcae55e88573183e552a2e12125d83ac4fc5cbdaa0ef715699268a6b1059a12f23ffb4a6fea47a3093683d95fc61146a6dc359d1b76
+  data.tar.gz: 4670941d32adf903ff77ebf024555c40295ad64b7e267cb027b40def51d45183f4df0e1521778ac623857bb30a180e42990ac04b3aa30343083b3f9910992080

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Alexey Alter-Pesotskiy <aalterpesotskiy@zendesk.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,52 @@
+# try_scan plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-try_scan)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-try_scan`, add it to your project by running:
+
+```bash
+fastlane add_plugin try_scan
+```
+
+## About try_scan
+
+Simple way to retry your scan action
+
+**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+
+**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## 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/try_scan.rb

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

data/lib/fastlane/plugin/try_scan/actions/try_scan_action.rb

@@ -0,0 +1,106 @@
+module Fastlane
+  module Actions
+
+    require 'fastlane/actions/scan'
+    require_relative '../helper/scan_helper'
+    require_relative '../helper/try_scan_runner'
+
+    FastlaneScanHelper = TryScanManager::Helper::FastlaneScanHelper
+
+    class TryScanAction < Action
+      def self.run(params)
+        prepare_for_testing(params)
+        success = TryScanManager::Runner.new(params.values).run
+
+        raise FastlaneCore::UI.test_failure!('Tests have failed') if params[:fail_build] && !success
+      end
+
+      def self.prepare_for_testing(params)
+        warn_of_xcode11_result_bundle_incompatability(params)
+        use_scanfile_to_override_settings(params.values)
+        turn_off_concurrent_workers(params.values)
+        prepare_scan_config(params.values)
+        coerce_destination_to_array(params)
+      end
+
+      def self.warn_of_xcode11_result_bundle_incompatability(params)
+        if FastlaneCore::Helper.xcode_at_least?('11.0.0')
+          if params[:result_bundle]
+            FastlaneCore::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')
+          FastlaneCore::UI.important("The 'xcresult' :output_type is only supported for Xcode 11 and greater. You are using #{FastlaneCore::Helper.xcode_version}.")
+        end
+      end
+
+      def self.coerce_destination_to_array(params)
+        destination = params[:destination] || Scan.config[:destination] || []
+        unless destination.kind_of?(Array)
+          params[:destination] = Scan.config[:destination] = [destination]
+        end
+      end
+
+      def self.turn_off_concurrent_workers(scan_options)
+        if Gem::Version.new(Fastlane::VERSION) >= Gem::Version.new('2.142.0')
+          scan_options.delete(:concurrent_workers) if scan_options[:concurrent_workers].to_i > 0
+        end
+      end
+
+      def self.use_scanfile_to_override_settings(scan_options)
+        overridden_options = FastlaneScanHelper.options_from_configuration_file(
+          FastlaneScanHelper.scan_options_from_try_scan_options(scan_options)
+        )
+
+        unless overridden_options.empty?
+          FastlaneCore::UI.important("Scanfile found: overriding try_scan options with it's values.")
+          overridden_options.each { |key, val| scan_options[key] = val }
+        end
+      end
+
+      def self.prepare_scan_config(scan_options)
+        Scan.config ||= FastlaneCore::Configuration.create(
+          Fastlane::Actions::ScanAction.available_options,
+          FastlaneScanHelper.scan_options_from_try_scan_options(scan_options)
+        )
+      end
+
+      #####################################################
+      #                   Documentation                   #
+      #####################################################
+
+      def self.description
+        "Simple way to retry your scan action"
+      end
+
+      def self.authors
+        ["Alexey Alter-Pesotskiy"]
+      end
+
+      def self.scan_options
+        ScanAction.available_options.reject { |config| %i[output_types].include?(config.key) }
+      end
+
+      def self.available_options
+        scan_options = ScanAction.available_options.reject { |config| %i[output_types].include?(config.key) }
+        scan_options + [
+          FastlaneCore::ConfigItem.new(
+            key: :try_count,
+            env_name: "FL_TRY_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.category
+        :testing
+      end
+
+      def self.is_supported?(platform)
+        [:ios].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/try_scan/helper/scan_helper.rb

@@ -0,0 +1,105 @@
+module TryScanManager
+  module Helper
+    module FastlaneScanHelper
+      def self.report_options
+        Scan::XCPrettyReporterOptionsGenerator.generate_from_scan_config
+      end
+
+      def self.valid_scan_keys
+        Fastlane::Actions::ScanAction.available_options.map(&:key)
+      end
+
+      def self.print_scan_parameters(params)
+        return if FastlaneCore::Helper.test?
+
+        FastlaneCore::PrintTable.print_values(
+          config: params,
+          title: "Summary for scan #{Fastlane::VERSION}"
+        )
+      end
+
+      def self.scan_options_from_try_scan_options(params)
+        valid_scan_keys = Fastlane::Actions::ScanAction.available_options.map(&:key)
+        params.select { |key, _| valid_scan_keys.include?(key) }
+      end
+
+      def self.options_from_configuration_file(params)
+        config = FastlaneCore::Configuration.create(
+          Fastlane::Actions::ScanAction.available_options,
+          params
+        )
+        config_file = config.load_configuration_file(Scan.scanfile_name, nil, true)
+        overridden_options = config_file ? config_file.options : {}
+
+        FastlaneCore::Project.detect_projects(config)
+        project = FastlaneCore::Project.new(config)
+
+        imported_path = File.expand_path(Scan.scanfile_name)
+        Dir.chdir(File.expand_path("..", project.path)) do
+          if File.expand_path(Scan.scanfile_name) != imported_path
+            config_file = config.load_configuration_file(Scan.scanfile_name, nil, true)
+          end
+          overridden_options.merge!(config_file.options) if config_file
+        end
+        overridden_options
+      end
+
+      def self.remove_preexisting_simulator_logs(params)
+        return unless params[:include_simulator_logs]
+
+        output_directory = report_options.instance_variable_get(:@output_directory)
+        glob_pattern = "#{output_directory}/**/system_logs-*.{log,logarchive}"
+        logs = Dir.glob(glob_pattern)
+        FileUtils.rm_rf(logs)
+      end
+
+      def self.remove_preexisting_test_result_bundles(params)
+        output_directory = report_options.instance_variable_get(:@output_directory)
+        glob_pattern = "#{output_directory}/**/*.test_result"
+        preexisting_test_result_bundles = Dir.glob(glob_pattern)
+        if preexisting_test_result_bundles.size > 0
+          FastlaneCore::UI.verbose("Removing pre-existing test_result bundles: ")
+          preexisting_test_result_bundles.each { |bundle| FastlaneCore::UI.verbose("  #{bundle}") }
+          FileUtils.rm_rf(preexisting_test_result_bundles)
+        end
+      end
+
+      def self.remove_preexisting_xcresult_bundles(params)
+        output_directory = report_options.instance_variable_get(:@output_directory)
+        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 { |bundle| FastlaneCore::UI.verbose("  #{bundle}") }
+          FileUtils.rm_rf(preexisting_xcresult_bundles)
+        end
+      end
+
+      def self.remove_report_files
+        output_files = report_options.instance_variable_get(:@output_files)
+        output_directory = report_options.instance_variable_get(:@output_directory)
+
+        unless output_files.empty?
+          FastlaneCore::UI.verbose("Removing report files")
+          output_files.each do |output_file|
+            report_file = File.join(output_directory, output_file)
+            FastlaneCore::UI.verbose("  #{report_file}")
+            FileUtils.rm_f(report_file)
+          end
+        end
+      end
+
+      def self.update_xctestrun_after_build(scan_options)
+        xctestrun_files = Dir.glob("#{Scan.config[:derived_data_path]}/Build/Products/*.xctestrun")
+        FastlaneCore::UI.verbose("After building, found xctestrun files #{xctestrun_files} (choosing 1st)")
+        scan_options[:xctestrun] = xctestrun_files.first
+      end
+
+      def self.remove_preexisting_xctestrun_files
+        xctestrun_files = Dir.glob("#{Scan.config[:derived_data_path]}/Build/Products/*.xctestrun")
+        FastlaneCore::UI.verbose("Before building, removing pre-existing xctestrun files: #{xctestrun_files}")
+        FileUtils.rm_rf(xctestrun_files)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/try_scan/helper/try_scan_runner.rb

@@ -0,0 +1,145 @@
+module TryScanManager
+  class Runner
+
+    FastlaneScanHelper = TryScanManager::Helper::FastlaneScanHelper
+
+    def initialize(options = {})
+      @options = options
+      warn_of_try_scan_option
+    end
+
+    def run
+      update_scan_config
+      print_summary
+      attempt = 1
+      begin
+        warn_of_performing_attempts(attempt)
+        clear_preexisting_data
+        Scan::Runner.new.run
+        return true
+      rescue FastlaneCore::Interface::FastlaneBuildFailure, FastlaneCore::Interface::FastlaneTestFailure => _
+        merge_junit_reports if attempt != 1
+        return false if attempt > @options[:try_count]
+
+        attempt += 1
+        update_scan_options
+        retry
+      end
+    end
+
+    def update_scan_config
+      Scan.config[:output_types] << 'junit' unless Scan.config[:output_types].include?('junit')
+    end
+
+    def print_summary
+      return if FastlaneCore::Helper.test?
+
+      scan_actual_params = Scan.config.values(ask: false)
+      scan_available_keys = Scan.config.available_options.map(&:key)
+      try_scan_params = @options.reject { |try_scan_key, _| scan_available_keys.include?(try_scan_key) }
+      FastlaneCore::PrintTable.print_values(
+        config: try_scan_params,
+        title: "Summary for try_scan #{Fastlane::TryScan::VERSION}"
+      )
+      FastlaneCore::PrintTable.print_values(
+        config: scan_actual_params,
+        title: "Summary for scan #{Fastlane::VERSION}"
+      )
+    end
+
+    def warn_of_performing_attempts(attempt)
+      FastlaneCore::UI.important("TryScan shot №#{attempt}\n")
+    end
+
+    def warn_of_try_scan_option
+      if @options[:try_count] <= 0
+        FastlaneCore::UI.important(":try_count can't be less than or equal to zero. Setting a default value equal to `1`")
+        @options[:try_count] = 1
+      end
+    end
+
+    def clear_preexisting_data
+      FastlaneScanHelper.remove_preexisting_simulator_logs(@options)
+      FastlaneScanHelper.remove_preexisting_test_result_bundles(@options)
+      FastlaneScanHelper.remove_preexisting_xcresult_bundles(@options)
+      FastlaneScanHelper.remove_report_files
+    end
+
+    def update_scan_options
+      scan_options = @options.select { |key,  _| FastlaneScanHelper.valid_scan_keys.include?(key) }.merge(plugin_scan_options)
+      scan_options[:only_testing] = extract_failed_tests
+      scan_options[:skip_build] = true
+      scan_options[:test_without_building] = true
+      scan_options[:build_for_testing] = false
+      scan_options.delete(:skip_testing)
+      Scan.cache.clear
+      scan_options.each do |key, val|
+        next if val.nil?
+
+        Scan.config.set(key, val) unless val.nil?
+        FastlaneCore::UI.verbose("\tSetting #{key.to_s} to #{val}")
+      end
+    end
+
+    def plugin_scan_options
+      xcargs = @options[:xcargs] || ''
+      if xcargs&.include?('build-for-testing')
+        FastlaneCore::UI.important(":xcargs, #{xcargs}, contained 'build-for-testing', removing it")
+        xcargs.slice!('build-for-testing')
+      end
+      if xcargs.include?('-quiet')
+        FastlaneCore::UI.important('Disabling -quiet as failing tests cannot be found with it enabled.')
+        xcargs.gsub!('-quiet', '')
+      end
+      xcargs.gsub!(/-parallel-testing-enabled(=|\s+)(YES|NO)/, '')
+      @options.select { |k,v| FastlaneScanHelper.valid_scan_keys.include?(k) }.merge({ xcargs: "#{xcargs} -parallel-testing-enabled NO " })
+    end
+
+    def extract_failed_tests
+      report = junit_report
+      suite_name = report.xpath('testsuites/@name').to_s.split('.')[0]
+      test_cases = report.xpath('//testcase')
+      only_testing = []
+      test_cases.each do |test_case|
+        next if test_case.xpath('failure').empty?
+
+        test_class = test_case.xpath('@classname').to_s.split('.')[1]
+        test_name = test_case.xpath('@name')
+        only_testing << "#{suite_name}/#{test_class}/#{test_name}"
+      end
+      only_testing
+    end
+
+    def junit_report(cached: false)
+      unless cached
+        report_options = FastlaneScanHelper.report_options
+        output_files = report_options.instance_variable_get(:@output_files)
+        output_directory = report_options.instance_variable_get(:@output_directory)
+        file_name = output_files.select { |name| name.include?('.xml') }.first
+        @junit_report_path = "#{output_directory}/#{file_name}"
+        @cached_junit_report = File.open(@junit_report_path) { |f| Nokogiri::XML(f) }
+      end
+      @cached_junit_report
+    end
+
+    def merge_junit_reports
+      old_junit_report = junit_report(cached: true)
+      new_junit_report = junit_report(cached: false)
+
+      new_junit_report.css("testsuites").zip(old_junit_report.css("testsuites")).each do |new_suites, old_suites|
+        old_suites.attributes["failures"].value = new_suites.attributes["failures"].value
+        new_suites.css("testsuite").zip(old_suites.css("testsuite")).each do |new_suite, old_suite|
+          old_suite.attributes["failures"].value = new_suite.attributes["failures"].value
+        end
+      end
+
+      new_junit_report.css('testcase').each do |node1|
+        old_junit_report.css('testcase').each do |node2|
+          node2.children = node1.children if node1['name'] == node2['name']
+        end
+      end
+
+      File.open(@junit_report_path, "w+") { |f| f.write(old_junit_report.to_xml) }
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module TryScan
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-try_scan
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexey Alter-Pesotskiy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-09 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: nokogiri
+  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.144.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.144.0
+description: 
+email: 33gri@bk.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/try_scan.rb
+- lib/fastlane/plugin/try_scan/actions/try_scan_action.rb
+- lib/fastlane/plugin/try_scan/helper/scan_helper.rb
+- lib/fastlane/plugin/try_scan/helper/try_scan_runner.rb
+- lib/fastlane/plugin/try_scan/version.rb
+homepage: https://github.com/alteral/fastlane-plugin-try_scan
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Simple way to retry your scan action
+test_files: []