flakey_spec_catcher 0.9.7 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fdaeca36cc9fd914875fff621500b2b220efd71f78a83528ca55df6eda40e2b
-  data.tar.gz: 11cc4f997cb8be146904f04960ec140274752f0aafcdfa876fe0c977081f121c
+  metadata.gz: 6a88793e18d2fc8a483639620b2876b4955f3fc8a5425f41a25cc2e3509cd6e0
+  data.tar.gz: f4c0a38a03eb0fabcde7111f3bf8bfc3698a7c5c576a106fb7c7b4337ed782b8
 SHA512:
-  metadata.gz: 216233d326b8bda265c44ff8218345fdd3897148b0637a27025a6ca02b82c0322050f90bd12645f4ac5a3ea0094e9107b0212b1c7cfd2a25c4024ed6dd7660e2
-  data.tar.gz: fb2ce576288f4cef8a2c17a10a848763ac81bc68d0b65e5adb1e5aba3e2714da9bb377dfb3be048bd77e5393ec57f566a1600469f8591ac977252f21385e3899
+  metadata.gz: 8c033294dc195ab6784dc22919ff986f7e646657b85a7efe6a5780333b666b4a7c7bba5f10ab41839ee9574cd9f4307a6f9b6c276f5da4f9144b5828dd1f2e06
+  data.tar.gz: 00a950c3296e05a81c8294c2005d6c84b454296de2f697b7ef2152ec6f29ef02c6305b3749d3a2d1449436fa1b6fb6ac0ccc2d9e3f5ae9db7ebef04043db2b96

data/.gitignore

@@ -1,3 +1,4 @@
+/.byebug_history
 /coverage
 /Gemfile.lock
 /flakey_spec_catcher-*.gem

data/README.md

@@ -163,6 +163,7 @@ FSC_USAGE_PATTERNS = '{ spec/ui => bundle exec rspec }, { spec/api => parallel_r
   --verbose                        Send all output from running tests to stdout
   -v, --version                    Prints current flakey_spec_catcher_version
   -h, --help                       Displays available flakey_spec_catcher cli overrides
+  --rspec-options '[OPTIONS]'      Execute default usage with rspec options
 ```
 
 Examples:

data/flakey_spec_catcher.gemspec

@@ -28,11 +28,13 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.metadata['allowed_push_host'] = 'https://rubygems.org'
-  gem.required_ruby_version         = '>= 2.3'
+  gem.required_ruby_version         = '>= 2.6'
 
-  gem.add_dependency 'rspec', '~> 3.8'
+  gem.add_dependency 'rspec', '~> 3.10'
+  gem.add_development_dependency 'byebug', '~> 11.1'
   gem.add_development_dependency 'climate_control', '~> 0.2'
-  gem.add_development_dependency 'rake', '~> 12.3'
-  gem.add_development_dependency 'simplecov', '~> 0.17'
+  gem.add_development_dependency 'rake', '~> 13.0'
+  gem.add_development_dependency 'rubocop', '~> 0.93.1'
+  gem.add_development_dependency 'simplecov', '~> 0.19'
 end
 # rubocop:enable Layout/ExtraSpacing, Layout/SpaceAroundOperators

data/lib/flakey_spec_catcher/change_capsule.rb

@@ -8,7 +8,7 @@ module FlakeySpecCatcher
   # A ChangeCapsule object will represent the changes made to a block of code. It
   # accomplishes this using ChangeContext and ChangeSummary objects.
   class ChangeCapsule
-    attr_reader :file_name, :change_summary, :change_contexts
+    attr_reader :file_name, :change_summary, :change_contexts, :spec_tree
     SCOPE_SPECIFIERS = %w[it context describe scenario].freeze
     SHARED_EXAMPLES = %w[include_examples it_behaves_like it_should_behave_like matching].freeze
 
@@ -16,6 +16,7 @@ module FlakeySpecCatcher
       @file_name = file_name
       @change_summary = change_summary
       @change_contexts = []
+      @spec_tree = {}
       handle_initial_change_contexts(change_contexts)
     end
 
@@ -23,23 +24,30 @@ module FlakeySpecCatcher
       @change_contexts.map(&:rerun_info)
     end
 
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
     def fill_contexts
       change_context_stack = []
       ignore_scope_closure = 0
       lines_in_file = File.read(@file_name).split("\n")
       lines_in_file.each_with_index do |line, index|
+        shared_example_identified = false
+
         # Check if line matches an rspec example or examplegroup format
         if line =~ spec_scope
           handle_change_context(line, index, change_context_stack)
         # Else, ignore other blocks that might pollute context stack
+        elsif line =~ shared_example_scope
+          handle_change_context(line, index, change_context_stack)
+          shared_example_identified = true
         elsif line_matches_method_or_block(line)
           ignore_scope_closure += 1
         end
 
         fill_context(line, index, change_context_stack)
 
-        # Note - some things use do-like loops and we need to be able to ignore those
-        if line =~ pop_scope
+        if shared_example_identified
+          change_context_stack.pop
+        elsif line =~ pop_scope
           if ignore_scope_closure.positive?
             ignore_scope_closure -= 1
           else
@@ -48,6 +56,7 @@ module FlakeySpecCatcher
         end
       end
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
 
     private
 
@@ -69,14 +78,15 @@ module FlakeySpecCatcher
     end
 
     def spec_scope
-      # Not sure if we need to check for description in quotes
-      # spec_scope = /^\s*(#{SCOPE_SPECIFIERS.join("|")})\s*('.*'|".*").*do\s*$/
-
       /\s*(#{SCOPE_SPECIFIERS.join("|")}).*\s+do.*$/
     end
 
+    def shared_example_scope
+      /\s*(#{SHARED_EXAMPLES.join("|")}).*\s+.*$/
+    end
+
     def line_matches_method_or_block(line)
-      return true if line =~ /\s*do(\s+|$)/ || line =~ /^\s*def\s+/ || line =~ /^\s*if\s+/
+      return true if line =~ /\s*do(\s+|$)/ || line =~ /^\s*def\s+/ || line =~ /^\s*if\s+/ || line =~ /^\s*class\s+/
 
       false
     end
@@ -112,6 +122,20 @@ module FlakeySpecCatcher
 
       change_context_stack.push(change_context) unless
         change_context_stack.any? { |c| c == change_context }
+
+      build_spec_tree(change_context_stack)
+    end
+
+    def build_spec_tree(change_contexts)
+      return unless change_contexts.count > 1
+
+      current_scope = change_contexts[-1].rerun_info
+      parent_scope = change_contexts[-2].rerun_info
+      @spec_tree[parent_scope] = if @spec_tree[parent_scope]
+        @spec_tree[parent_scope] << current_scope
+      else
+        [current_scope]
+      end
     end
   end
 end

data/lib/flakey_spec_catcher/cli_override.rb

@@ -8,7 +8,8 @@ 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, :dry_run
-    attr_reader :output_file, :split_nodes, :split_index, :verbose
+    attr_reader :output_file, :split_nodes, :split_index, :verbose, :test_options, :break_on_first_failure
+    attr_reader :list_child_specs
 
     def initialize
       @dry_run = false
@@ -16,6 +17,7 @@ module FlakeySpecCatcher
       @excluded_tags = []
       @use_parent = false
       @verbose = false
+      @test_options = []
       parse_command_line_args
       validate_arguments
     end
@@ -55,6 +57,14 @@ module FlakeySpecCatcher
           @repeat_factor = remove_formatter_quotes(repeat).to_i
         end
 
+        opts.on('--break-on-first-failure', 'Break on first failure') do |break_on_first_failure|
+          @break_on_first_failure = break_on_first_failure
+        end
+
+        opts.on('--list-child-specs', 'List Child Specs (Verbose Spec Listing') do |list_child_specs|
+          @list_child_specs = list_child_specs
+        end
+
         opts.on('-e', '--excluded-tags=EXCLUDED_TAGS',
                 'Specify tags to exclude in a comma separated list') do |tags|
           @excluded_tags = parse_tags(tags)
@@ -87,6 +97,10 @@ module FlakeySpecCatcher
           puts opts
           @enable_runs = false
         end
+
+        opts.on("--rspec-options '[OPTIONS]'", 'execute default usage with rspec options') do |arg|
+          @test_options = arg.split(/[ ](?=(?:[^"]*"[^"]*")*[^"]*$)(?=(?:[^']*'[^']*')*[^']*$)/)
+        end
       end.parse!
     end
 

data/lib/flakey_spec_catcher/git_controller.rb

@@ -56,45 +56,12 @@ module FlakeySpecCatcher
       return nil if @remote.nil?
 
       working_branch = `git branch | grep '*'`.delete('*').gsub(/\s+/, '')
-      # `git remote show origin` will show us if our branch is configured to push
-      #  to a non-master branch. Note that our push destination is what we're interested in
-      #  Assume master if no matches
-
-      # Example output
-      # * remote origin
-      # Fetch URL: gerrit:repo
-      # Push  URL: gerrit:repo
-      # HEAD branch: master
-      # Remote branches:
-      #   dev/reports           tracked
-      #   edge                  tracked
-      #   master                tracked
-      # Local branch configured for 'git pull':
-      #   master merges with remote master
-      # Local refs configured for 'git push':
-      #   dev/reports pushes to dev/reports                 (up to date)
-      #   master              pushes to master              (up to date)
-
-      remote_branches = `git remote show #{@remote}`.split("\n")
-
-      # Separate 'dev/reports pushes to dev/reports                 (up to date)' into
-      #  ['dev/reports', 'dev/reports'] or [<LOCAL BRANCH>, <REMOTE BRANCH>]
-      remote_pairs = remote_branches.map { |r| r.scan(/(\S*)\s+pushes to\s+(\S*)\s+/).flatten }
-
-      # check if the working branch (currently checked out branch) corresponds to a remote_pair
-      #  if so, use that remote pair for comparison, else use master
-      match = remote_pairs.find do |pair|
-        # working branch (pair[0]) pushes to remote (pair[1])
-        pair[0] == working_branch
-      end
+      branch_remote = `git config branch.#{working_branch}.remote`.strip
+      return 'master' unless @remote == branch_remote
 
-      remote_branch = if match.nil?
-        'master'
-      else
-        # match is formatted as [working_branch, remote]
-        match[1]
-      end
-      remote_branch
+      remote_branch = `git config branch.#{branch}.merge`.strip.sub(%r{^refs/heads/}, '')
+      remote_branch = nil if remote_branch.empty?
+      remote_branch || 'master'
     end
 
     def initialize_git_comparison(test_mode)
@@ -108,7 +75,7 @@ module FlakeySpecCatcher
       @git_comparison = "#{@base_commit_sha}..#{@working_commit_sha}"
     end
 
-    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/CyclomaticComplexity
     def parse_changes
       # For each file, get the change block
       diff_files.each do |filename|
@@ -128,7 +95,7 @@ module FlakeySpecCatcher
         end
       end
     end
-    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/CyclomaticComplexity
 
     def identify_change_contexts
       @capsule_manager.change_capsules.each(&:fill_contexts)

data/lib/flakey_spec_catcher/rerun_manager.rb

@@ -39,6 +39,7 @@ module FlakeySpecCatcher
       else
         all_non_example_groups - identify_tag_excluded_reruns
       end
+      tests = transform_parent_specs(tests).flatten if @user_config.list_child_specs
       filter_reruns_by_ignore_files(tests)
     end
 
@@ -171,5 +172,23 @@ module FlakeySpecCatcher
         @rerun_capsules.push(FlakeySpecCatcher::RerunCapsule.new(testcase: testcase, usage: usage))
       end
     end
+
+    def transform_parent_specs(tests)
+      transformed_tests = []
+      tests.each do |test|
+        capsule = @git_controller.capsule_manager.change_capsules.find { |c| c.file_name == test.split(':')[0] }
+        spec_tree = capsule.spec_tree
+        # If test is a key in the spec_tree, it's an example group, so we queue up its descendant examples
+        if spec_tree[test]
+          spec_tree[test].each do |child|
+            transformed_tests << transform_parent_specs([child]).flatten
+          end
+        # Else test is just an example
+        else
+          transformed_tests << test
+        end
+      end
+      transformed_tests
+    end
   end
 end

data/lib/flakey_spec_catcher/runner.rb

@@ -36,6 +36,7 @@ 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 "  Break on first failure: #{@user_config.break_on_first_failure}" if @user_config.break_on_first_failure
       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}"
@@ -75,6 +76,7 @@ module FlakeySpecCatcher
         @user_config.repeat_factor.times do
           iteration_status = handle_capsule_rerun(capsule)
           status = [status, iteration_status].max
+          break if @user_config.break_on_first_failure && !status.zero?
         end
       end
 
@@ -98,7 +100,7 @@ module FlakeySpecCatcher
       rspec_args = ['--format', 'documentation', '--out', @user_config.output_file, test]
       # Rspec output sent to stdout if verbose option is true
       rspec_args << '-fd' if @user_config.verbose
-      return_status = RSpec::Core::Runner.run(rspec_args)
+      return_status = RSpec::Core::Runner.run(@user_config.test_options.concat(rspec_args))
       RSpec.clear_examples
       copy_output_to_temp_file unless @user_config.output_file == File::NULL
       return_status

data/lib/flakey_spec_catcher/user_config.rb

@@ -11,11 +11,12 @@ module FlakeySpecCatcher
     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, :dry_run
-    attr_reader :split_nodes, :split_index, :verbose
+    attr_reader :split_nodes, :split_index, :verbose, :test_options
+    attr_reader :break_on_first_failure, :list_child_specs
 
     USER_CONFIG_ENV_VARS = %w[FSC_REPEAT_FACTOR FSC_IGNORE_FILES FSC_IGNORE_BRANCHES
                               FSC_SILENT_MODE FSC_RERUN_FILE_ONLY FSC_USAGE_PATTERNS
-                              FSC_EXCLUDED_TAGS FSC_OUTPUT_FILE].freeze
+                              FSC_EXCLUDED_TAGS FSC_OUTPUT_FILE FSC_LIST_CHILD_SPECS].freeze
 
     def initialize(cli_override: CliOverride.new)
       apply_env_var_settings
@@ -32,6 +33,7 @@ module FlakeySpecCatcher
       @ignore_branches = env_var_string_to_array(ENV['FSC_IGNORE_BRANCHES'])
       @silent_mode = env_var_string_to_bool(ENV['FSC_SILENT_MODE'])
       @rerun_file_only = env_var_string_to_bool(ENV['FSC_RERUN_FILE_ONLY'])
+      @list_child_specs = env_var_string_to_bool(ENV['FSC_LIST_CHILD_SPECS'])
       @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']
@@ -44,6 +46,8 @@ module FlakeySpecCatcher
       @manual_rerun_usage = @cli_override.rerun_usage
       @use_parent = @cli_override.use_parent
       @repeat_factor = @cli_override.repeat_factor if @cli_override.repeat_factor.to_i.positive?
+      @break_on_first_failure = @cli_override.break_on_first_failure
+      @list_child_specs = @cli_override.list_child_specs unless @cli_override.list_child_specs.nil?
       @enable_runs = @cli_override.enable_runs
       @dry_run = @cli_override.dry_run
       @split_nodes = @cli_override.split_nodes unless @cli_override.split_nodes.nil?
@@ -55,6 +59,7 @@ module FlakeySpecCatcher
       end
       @output_file = set_output_file
       @verbose = @cli_override.verbose
+      @test_options = @cli_override.test_options
     end
     # rubocop:enable Metrics/AbcSize
 
@@ -167,7 +172,7 @@ module FlakeySpecCatcher
       end
     end
 
-    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
     def override_user_config(env_var, env_value)
       case env_var
       when 'FSC_REPEAT_FACTOR'
@@ -180,6 +185,8 @@ module FlakeySpecCatcher
         @silent_mode = env_var_string_to_bool(env_value)
       when 'FSC_RERUN_FILE_ONLY'
         @rerun_file_only = env_var_string_to_bool(env_value)
+      when 'FSC_LIST_CHILD_SPECS'
+        @list_child_specs = env_var_string_to_bool(env_value)
       when 'FSC_USAGE_PATTERNS'
         @rspec_usage_patterns = env_var_string_to_pairs(env_value)
       when 'FSC_EXCLUDED_TAGS'
@@ -188,6 +195,6 @@ module FlakeySpecCatcher
         @output_file = env_value
       end
     end
-    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/MethodLength
   end
 end

data/lib/flakey_spec_catcher/version.rb

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

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: flakey_spec_catcher
 version: !ruby/object:Gem::Version
-  version: 0.9.7
+  version: 0.11.1
 platform: ruby
 authors:
 - Brian Watson
 - Mikey Hargiss
 - Ben Nelson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-18 00:00:00.000000000 Z
+date: 2021-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -18,14 +18,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
 - !ruby/object:Gem::Dependency
   name: climate_control
   requirement: !ruby/object:Gem::Requirement
@@ -46,29 +60,43 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.93.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: 0.93.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.19'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
-description: 
+        version: '0.19'
+description:
 email:
 - bwatson@instructure.com
 - mhargiss@instructure.com
@@ -102,12 +130,12 @@ files:
 - lib/flakey_spec_catcher/version.rb
 - lib/helpers/colorize.rb
 - lib/helpers/indent_string.rb
-homepage: 
+homepage:
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -115,15 +143,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
-signing_key: 
+rubygems_version: 3.0.1
+signing_key:
 specification_version: 4
 summary: Run new or changed specs many times to prevent unreliable specs
 test_files: []