flakey_spec_catcher 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 924bcd5b7fe71399bc43663478b9b238731e9920e4fcc8c54ba8977a345ee065
-  data.tar.gz: '080682849736c9d46acd6eeeb8ccc8e98115fb9558004e821f4beed33dfd455e'
+  metadata.gz: 6afbdca4bb65ca89de114e1dcfbdbffb93e5dbfbe7f39cc4c4511e018f422bf3
+  data.tar.gz: 3e6b37e7f310e74b2711139e6d45b94028d22a3624e7bcd08494e8bef49bc26a
 SHA512:
-  metadata.gz: 68cf5c4b41ae6b158a501bab2a6134a40dd1d0ca3d7ce26452948b986ddf713d443458643d2a27a8ff565b9856c647867630015c78dc2f9e7784bf31b0d772e4
-  data.tar.gz: cee42fcbf243eaa03e56745491515ae7580e2e7974d751faef5f2387c40f07cb20b9f225d188e04009950b7cfd339720e406b789f4e7fa2ec537c2c109b81c18
+  metadata.gz: d37a8bfaffe6c700ce2f748b96cac49838db1bbb45f4f96d50b87029f13b01e57507e08e939f9316e7ec3a523ed6d2b34ab0f1d090e461e5405442cad588f565
+  data.tar.gz: b84ce73838ec8ff524c444a207627eadefd15f91dd9b7358493280e562c0eadd1a85a72aca6c2a8072d95e9f26e2b3965983389aeb7ac384876a40ec5a737079

data/README.md

@@ -152,9 +152,14 @@ FSC_USAGE_PATTERNS = '{ spec/ui => bundle exec rspec }, { spec/api => parallel_r
 ```
   -t, --test=TEST_NAME             Specify one or more specs in comma separated list
   -u, --usage=USAGE                Specify a re-run usage for the manual re-run
+  --use-parent                     Use the parent of commit for git diff instead of the Head of SCM
   -r, --repeat=REPEAT_FACTOR       Specify a repeat factor for the manual re-run(s)
   -e, --excluded-tags=EXCLUDED     Specify tags to exclude in a comma separated list
   -o, --output=PATH_TO_OUTPUT      Direct all re-run output to a specific file
+  --node-total                     Specify now many nodes the run is being split into
+  --node-index                     Specify the index this node represents in a split run
+  -d, --dry-run                    Performs all setup but doesn't run any tests
+  --dry-run-quiet                  Prints list of tests to be run
   -v, --version                    Prints current flakey_spec_catcher_version
   -h, --help                       Displays available flakey_spec_catcher cli overrides
 ```
@@ -195,6 +200,36 @@ flakey_spec_catcher --test='api/spec/*_spec.rb' --usage='bundle exec parallel_rs
 flakey_spec_catcher --test='api/spec/admin_spec.rb' --repeat='10' --usage='rspec'
 ```
 
+### Running on multiple nodes:
+
+If there are a lot of tests required to be checked, then you may want to run the
+tests on multiple nodes. this can be done with the combination of the `--node-total`
+and `--node-index` arguments.
+
+Usage Examples:
+```sh
+# if you have 30 tests to run
+
+# this will be tests 0-9
+bundle exec flakey_spec_catcher --node-total=3 --node-index=0
+# this will be tests 10-19
+bundle exec flakey_spec_catcher --node-total=3 --node-index=1
+# this will be tests 20-29
+bundle exec flakey_spec_catcher --node-total=3 --node-index=2
+```
+
+Note that the last node may have a different number of tests that it runs:
+```sh
+# if you have 20 tests to run
+
+# this will be tests 0-6 (7 tests)
+bundle exec flakey_spec_catcher --node-total=3 --node-index=0
+# this will be tests 7-13 (7 tests)
+bundle exec flakey_spec_catcher --node-total=3 --node-index=1
+# this will be tests 14-19 (6 tests)
+bundle exec flakey_spec_catcher --node-total=3 --node-index=2
+```
+
 ### Additional Git Detection Examples
 
 ```sh

data/bin/flakey_spec_catcher

@@ -9,4 +9,6 @@ if app.user_config.enable_runs
   app.show_settings
   app.rerun_preview
   exit app.run_specs
+elsif app.user_config.dry_run
+  app.show_test_list
 end

data/lib/flakey_spec_catcher/cli_override.rb

@@ -7,14 +7,16 @@ module FlakeySpecCatcher
   #
   # Captures command line arguments for manual re-runs
   class CliOverride
-    attr_reader :rerun_patterns, :rerun_usage, :repeat_factor, :enable_runs, :excluded_tags, :use_parent
-    attr_reader :output_file
+    attr_reader :rerun_patterns, :rerun_usage, :repeat_factor, :enable_runs, :excluded_tags, :use_parent, :dry_run
+    attr_reader :output_file, :split_nodes, :split_index
 
     def initialize
+      @dry_run = false
       @enable_runs = true
       @excluded_tags = []
       @use_parent = false
       parse_command_line_args
+      validate_arguments
     end
 
     private
@@ -36,15 +38,20 @@ module FlakeySpecCatcher
         end
 
         opts.on('-u', '--usage=USAGE', 'Specify a re-run usage for the manual re-run') do |usage|
-          raise ArgumentError if @rerun_patterns.nil?
-
           @rerun_usage = remove_formatter_quotes(usage)
         end
 
+        opts.on('--node-total=SPLIT_NODES', 'Specify now many nodes the run is being split into') do |nodes|
+          @split_nodes = remove_formatter_quotes(nodes).to_i
+        end
+
+        opts.on('--node-index=SPLIT_INDEX', 'Specify the index this node represents in a split run') do |index|
+          @split_index = remove_formatter_quotes(index).to_i
+        end
+
         opts.on('-r', '--repeat=REPEAT_FACTOR',
                 'Specify a repeat factor for the manual re-run(s)') do |repeat|
-          parsed_repeat_factor = remove_formatter_quotes(repeat).to_i
-          @repeat_factor = parsed_repeat_factor if parsed_repeat_factor.positive?
+          @repeat_factor = remove_formatter_quotes(repeat).to_i
         end
 
         opts.on('-e', '--excluded-tags=EXCLUDED_TAGS',
@@ -62,12 +69,36 @@ module FlakeySpecCatcher
           @enable_runs = false
         end
 
+        opts.on('-d', '--dry-run', "Performs all setup but doesn't run any tests") do
+          @dry_run = true
+        end
+
+        opts.on('--dry-run-quiet', 'Prints list of tests to be run') do
+          @enable_runs = false
+          @dry_run = true
+        end
+
         opts.on('-h', '--help', 'Displays available flakey_spec_catcher cli overrides') do
           puts opts
           @enable_runs = false
         end
       end.parse!
     end
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    def validate_arguments
+      if !@rerun_usage.nil? && @rerun_patterns.nil?
+        raise ArgumentError, 'rerun usage can only be specified with rerun patterns'
+      end
+      raise ArgumentError, 'repeat factor must be positive' if !@repeat_factor.nil? && @repeat_factor.negative?
+      raise ArgumentError, 'split index and split nodes must be specified together' if @split_nodes.nil? != @split_index.nil?
+
+      splitting = !@split_nodes.nil? && !@split_index.nil?
+      raise ArgumentError, 'split total must be positive' if splitting && @split_nodes.negative?
+      raise ArgumentError, 'split index must be positive' if splitting && @split_index.negative?
+      raise ArgumentError, 'split index must be less than split nodes' if splitting && @split_index >= @split_nodes
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/BlockLength
 
     def remove_formatter_quotes(env_var)

data/lib/flakey_spec_catcher/git_controller.rb

@@ -26,6 +26,9 @@ module FlakeySpecCatcher
       @remote = find_git_remote
       @branch = find_remote_branch
       @capsule_manager = capsule_manager
+      # we don't need to do any git comparisons if we have manually specified tests to run.
+      return unless @user_config.manual_rerun_patterns.nil? || @user_config.manual_rerun_patterns.empty?
+
       initialize_git_comparison(test_mode)
       parse_changes
       identify_change_contexts

data/lib/flakey_spec_catcher/rerun_manager.rb

@@ -17,6 +17,7 @@ module FlakeySpecCatcher
       @user_config = user_config
       @rerun_capsules = []
       determine_rerun_usage
+      split!
     end
 
     def determine_rerun_usage
@@ -110,6 +111,37 @@ module FlakeySpecCatcher
 
     private
 
+    # rubocop:disable Metrics/AbcSize
+    def split!
+      return unless !@user_config.split_nodes.nil? && !@user_config.split_index.nil?
+
+      # we create this restriction for simplicity. if we have multiple capsules then
+      # we have to split while being aware of splitting across capsules.
+      # if we absolutely need to split with different usage types, then we can implement that later..
+      raise ArgumentError('can only split on one usage type') if @rerun_capsules.size != 1
+
+      # ensure everything is sorted consistently before splitting
+      capsule = @rerun_capsules[0]
+      capsule.testcase.sort!
+
+      # compute the total tests that are changing
+      test_count = capsule.testcase.size
+
+      # the last node is going to be different from the previous nodes.
+      # for instance, if there are 13 test to run and you want 3 nodes:
+      # node1 -> 5
+      # node2 -> 5
+      # node3 -> 3
+      # it may be more efficient to split differently, but for now this will work.
+      node_test_count = (test_count / @user_config.split_nodes.to_f).ceil
+
+      skipping = @user_config.split_index * node_test_count
+      skipping_until = (@user_config.split_index + 1) * node_test_count
+      split_tests = capsule.testcase[skipping...skipping_until]
+      @rerun_capsules = [FlakeySpecCatcher::RerunCapsule.new(usage: capsule.usage, testcase: split_tests)]
+    end
+    # rubocop:enable Metrics/AbcSize
+
     def filter_reruns_by_ignore_files(reruns)
       return reruns if @user_config.ignore_files.count.zero?
 

data/lib/flakey_spec_catcher/runner.rb

@@ -10,7 +10,7 @@ require_relative './event_listener.rb'
 
 module FlakeySpecCatcher
   class Runner
-    attr_reader :user_config, :rerun_manager, :git_controller
+    attr_reader :user_config, :rerun_manager, :git_controller, :test_run_count
 
     def initialize(test_mode: false,
       user_config: FlakeySpecCatcher::UserConfig.new,
@@ -23,6 +23,7 @@ module FlakeySpecCatcher
       @user_config = user_config
       @rerun_manager = rerun_manager
       @rspec_result_manager = result_manager
+      @test_run_count = 0
     end
 
     # Debug Methods
@@ -34,6 +35,8 @@ module FlakeySpecCatcher
       puts "  Current Sha: #{@git_controller.working_commit_sha}"
       puts "  Base Sha: #{@git_controller.base_commit_sha}"
       puts "  Repeat factor: #{@user_config.repeat_factor}"
+      puts "  Node Total: #{@user_config.split_nodes}" if @user_config.split_nodes
+      puts "  Node Index: #{@user_config.split_index}" if @user_config.split_index
       puts "  Changed Specs Detected: #{@git_controller.changed_examples}"
       return if @user_config.output_file == '/dev/null'
 
@@ -55,7 +58,17 @@ module FlakeySpecCatcher
     end
     # end Debug methods
 
+    def show_test_list
+      @rerun_manager.rerun_capsules.each do |capsule|
+        capsule.testcase.each do |test|
+          puts test
+        end
+      end
+    end
+
     def run_specs
+      return 0 if @user_config.dry_run
+
       status = 0
       @rerun_manager.rerun_capsules.sort.each do |capsule|
         @user_config.repeat_factor.times do
@@ -95,6 +108,7 @@ module FlakeySpecCatcher
     end
 
     def handle_capsule_rerun(capsule)
+      @test_run_count += 1
       if capsule.default_usage?
         invoke_rspec_runner(capsule.testcase)
       else

data/lib/flakey_spec_catcher/user_config.rb

@@ -10,7 +10,8 @@ module FlakeySpecCatcher
     attr_reader :repeat_factor, :ignore_files, :ignore_branches, :silent_mode
     attr_reader :rerun_file_only, :rspec_usage_patterns, :excluded_tags
     attr_reader :manual_rerun_patterns, :manual_rerun_usage
-    attr_reader :enable_runs, :output_file, :use_parent
+    attr_reader :enable_runs, :output_file, :use_parent, :dry_run
+    attr_reader :split_nodes, :split_index
 
     USER_CONFIG_ENV_VARS = %w[FSC_REPEAT_FACTOR FSC_IGNORE_FILES FSC_IGNORE_BRANCHES
                               FSC_SILENT_MODE FSC_RERUN_FILE_ONLY FSC_USAGE_PATTERNS
@@ -34,14 +35,8 @@ module FlakeySpecCatcher
       @rspec_usage_patterns = env_var_string_to_pairs(ENV['FSC_USAGE_PATTERNS'])
       @excluded_tags = env_var_string_to_tags(ENV['FSC_EXCLUDED_TAGS'])
       @output_file = ENV['FSC_OUTPUT_FILE']
-    end
-    # rubocop:enable Metrics/AbcSize
-
-    def override_settings
-      apply_cli_override
-      return unless @manual_rerun_patterns.nil?
-
-      parse_commit_message
+      @split_nodes = env_var_string_to_int_or_nil('FSC_NODE_TOTAL')
+      @split_index = env_var_string_to_int_or_nil('FSC_NODE_INDEX')
     end
 
     def apply_cli_override
@@ -50,6 +45,9 @@ module FlakeySpecCatcher
       @use_parent = @cli_override.use_parent
       @repeat_factor = @cli_override.repeat_factor if @cli_override.repeat_factor.to_i.positive?
       @enable_runs = @cli_override.enable_runs
+      @dry_run = @cli_override.dry_run
+      @split_nodes = @cli_override.split_nodes unless @cli_override.split_nodes.nil?
+      @split_index = @cli_override.split_index unless @cli_override.split_index.nil?
       @excluded_tags = if @cli_override.excluded_tags.empty?
         @excluded_tags
       else
@@ -57,6 +55,14 @@ module FlakeySpecCatcher
       end
       @output_file = set_output_file
     end
+    # rubocop:enable Metrics/AbcSize
+
+    def override_settings
+      apply_cli_override
+      return unless @manual_rerun_patterns.nil?
+
+      parse_commit_message
+    end
 
     def set_output_file
       if !@cli_override.output_file.nil?
@@ -76,6 +82,18 @@ module FlakeySpecCatcher
       env_var.to_i.positive? ? env_var.to_i : 20
     end
 
+    def env_var_string_to_int_or_nil(env_var_name)
+      env_var = ENV[env_var_name]
+      if env_var.nil? || env_var.empty?
+        nil
+      else
+        check = env_var.to_i
+        raise ArgumentError, "#{env_var_name} must be positive" if check.negative?
+
+        check
+      end
+    end
+
     def env_var_string_to_array(env_var)
       if env_var.nil? || env_var.empty?
         []

data/lib/flakey_spec_catcher/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FlakeySpecCatcher
-  VERSION = '0.9.2'
+  VERSION = '0.9.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flakey_spec_catcher
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - Brian Watson
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-18 00:00:00.000000000 Z
+date: 2020-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec