fastlane-plugin-try_scan 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3bf2f28d3558be4e3d2cd068beb9a4968f1957532a554aa902134c0db1e5e05
-  data.tar.gz: b4f5d09eede219e2425efce5487481947bee2a30075aac8448ba9f014ddbb48e
+  metadata.gz: f1cf8ffd4f2e1a0558797b6bdd7094d7b36f42306d28d10bea3172be11c42688
+  data.tar.gz: c286e3609e7900a837322e36dc86ed3ead3a17fe0a32a3239a87de8feb8a742a
 SHA512:
-  metadata.gz: 575e434210450543a657cdcae55e88573183e552a2e12125d83ac4fc5cbdaa0ef715699268a6b1059a12f23ffb4a6fea47a3093683d95fc61146a6dc359d1b76
-  data.tar.gz: 4670941d32adf903ff77ebf024555c40295ad64b7e267cb027b40def51d45183f4df0e1521778ac623857bb30a180e42990ac04b3aa30343083b3f9910992080
+  metadata.gz: 27fea4e492a529eee6953d601914075b0042549345bfb4fc91e28bf0562fc514c943bbebdb929777c5973d863ec8b09795b9445e46c76cd3da142a14c42d08fa
+  data.tar.gz: 12bab09a883ab80263e01a65b07ec9670df952a2800d1296a87688af7bf8736de240ebf35f05cf6f54df822d405cc3cf3c50f40b2c6ca3f908b0db69e1288d32

data/README.md

@@ -4,7 +4,7 @@
 
 ## 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:
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `try_scan`, add it to your project by running:
 
 ```bash
 fastlane add_plugin try_scan
@@ -12,27 +12,16 @@ fastlane add_plugin try_scan
 
 ## About try_scan
 
-Simple way to retry your scan action
+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.
+## Usage
 
-## 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
+```ruby
+try_scan(
+  workspace: "Example.xcworkspace",
+  devices: ["iPhone 6s", "iPad Air"],
+  try_count: 3
+)
 ```
 
 ## Issues and Feedback
@@ -43,10 +32,6 @@ For any other issues and feedback about this plugin, please submit it to this re
 
 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/actions/try_scan_action.rb

@@ -1,6 +1,7 @@
 module Fastlane
   module Actions
 
+    require 'json'
     require 'fastlane/actions/scan'
     require_relative '../helper/scan_helper'
     require_relative '../helper/try_scan_runner'
@@ -9,61 +10,31 @@ module Fastlane
 
     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)
+        if Helper.xcode_at_least?('11.0.0')
+          prepare_scan_config(params.values)
+          prepare_destination(params)
+          success = TryScanManager::Runner.new(params.values).run
+
+          raise FastlaneCore::UI.test_failure!('Tests have failed') if params[:fail_build] && !success
+        else
+          raise FastlaneCore::UI.user_error!("Minimum supported Xcode: `v11.0.0` (used: `v#{Helper.xcode_version}`)")
+        end
       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
+      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
 
-      def self.coerce_destination_to_array(params)
+      def self.prepare_destination(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                   #
       #####################################################
@@ -76,13 +47,8 @@ module Fastlane
         ["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 + [
+        ScanAction.available_options + [
           FastlaneCore::ConfigItem.new(
             key: :try_count,
             env_name: "FL_TRY_SCAN_TRY_COUNT",

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

@@ -19,31 +19,9 @@ module TryScanManager
       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]
 
@@ -88,18 +66,6 @@ module TryScanManager
           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
+end

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

@@ -5,30 +5,37 @@ module TryScanManager
 
     def initialize(options = {})
       @options = options
-      warn_of_try_scan_option
+      @options[:try_count] = 1 if @options[:try_count] < 1
     end
 
     def run
-      update_scan_config
       print_summary
-      attempt = 1
+      @attempt = 1
       begin
-        warn_of_performing_attempts(attempt)
+        essential_scan_config_updates
+        warn_of_performing_attempts
         clear_preexisting_data
         Scan::Runner.new.run
+        print_try_scan_result
         return true
-      rescue FastlaneCore::Interface::FastlaneBuildFailure, FastlaneCore::Interface::FastlaneTestFailure => _
-        merge_junit_reports if attempt != 1
-        return false if attempt > @options[:try_count]
+      rescue FastlaneCore::Interface::FastlaneTestFailure => _
+        failed_tests = failed_tests_from_xcresult_report
+        print_try_scan_result(failed_tests_count: failed_tests.size)
+        return false if finish?
 
-        attempt += 1
-        update_scan_options
+        @attempt += 1
+        update_scan_options(failed_tests)
+        retry
+      rescue FastlaneCore::Interface::FastlaneBuildFailure => _
+        return false if finish?
+
+        @attempt += 1
         retry
       end
     end
 
-    def update_scan_config
-      Scan.config[:output_types] << 'junit' unless Scan.config[:output_types].include?('junit')
+    def finish?
+      @attempt >= @options[:try_count]
     end
 
     def print_summary
@@ -47,15 +54,8 @@ module TryScanManager
       )
     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
+    def warn_of_performing_attempts
+      FastlaneCore::UI.important("TryScan: Getting started #{ordinalized_attempt} shot\n")
     end
 
     def clear_preexisting_data
@@ -65,81 +65,77 @@ module TryScanManager
       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
+    def print_try_scan_result(failed_tests_count: 0)
+      FastlaneCore::UI.important("TryScan: result after #{ordinalized_attempt} shot 👇")
+      FastlaneCore::PrintTable.print_values(
+        config: {"Number of tests" => tests_count_from_xcresult_report, "Number of failures" => failed_tests_count},
+        title: "Test Results"
+      )
+    end
+
+    def ordinalized_attempt
+      case @attempt
+      when 1
+        "#{@attempt}st"
+      when 2
+        "#{@attempt}nd"
+      when 3
+        "#{@attempt}rd"
+      else
+        "#{@attempt}th"
+      end
+    end
+
+    def update_scan_options(failed_tests)
+      scan_options = FastlaneScanHelper.scan_options_from_try_scan_options(@options)
+      scan_options[:only_testing] = 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?
+        Scan.config.set(key, val)
         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 " })
+    def essential_scan_config_updates
+      Scan.config[:result_bundle] = true
+      Scan.config[:build_for_testing] = nil if Scan.config[:build_for_testing]
+      Scan.config[:xcargs].slice!('build-for-testing') if Scan.config[:xcargs]&.include?('build-for-testing')
     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?
+    def parse_xcresult_report
+      report_options = FastlaneScanHelper.report_options
+      output_directory = report_options.instance_variable_get(:@output_directory)
+      xcresult_report_files = Dir["#{output_directory}/*.xcresult"]
+      raise FastlaneCore::UI.test_failure!('There are no xcresult reports to parse') if xcresult_report_files.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
+      FastlaneCore::UI.verbose("Parsing xcresult report by path: '#{xcresult_report_files.first}'")
+      JSON.parse(`xcrun xcresulttool get --format json --path #{xcresult_report_files.first}`)
     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']
+    def failed_tests_from_xcresult_report
+      only_testing = []
+      parse_xcresult_report['issues']['testFailureSummaries']['_values'].each do |failed_test|
+        suite_name = failed_test['producingTarget']['_value']
+        test_path = failed_test['testCaseName']['_value']
+        begin
+          test_class = test_path.split('.').first
+          test_name = test_path.split('.')[1].split('(').first
+        rescue NoMethodError => _
+          test_class = test_path.split('[')[1].split(' ').first
+          test_name = test_path.split(' ')[1].split(']').first
         end
+        only_testing << "#{suite_name}/#{test_class}/#{test_name}"
       end
+      only_testing
+    end
 
-      File.open(@junit_report_path, "w+") { |f| f.write(old_junit_report.to_xml) }
+    def tests_count_from_xcresult_report
+      parse_xcresult_report['metrics']['testsCount']['_value']
     end
   end
 end

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

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-try_scan
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Alexey Alter-Pesotskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2020-06-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  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: pry
   requirement: !ruby/object:Gem::Requirement
@@ -122,20 +136,6 @@ dependencies:
     - - ">="
       - !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