flakey_spec_catcher 0.9.4 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 741a4b99da98b4eed541bd4dc36476c66a3df1efd21e6a79ea00547202b9e30e
-  data.tar.gz: 48cb6f40ee8cf9f7019639622a8f3d9dc366b3b6691fde3418a1197dd0d0672e
+  metadata.gz: 9894969be42fdb7dfafa961942ce16b1313ca3cffdc746d9613ebe1398d39069
+  data.tar.gz: 75238a79f25ddb8cec6fd60064e9f06d5f5651b8bb3c27e423f317f653f65774
 SHA512:
-  metadata.gz: e135869d651917524f5abd7015f651a636a3d4c584a99a2d6860e094f3754779e2d0798d81f5b51df3bb9da323743a720c7a8f15ad160cbc7cf228794995f1a7
-  data.tar.gz: a665e8efe5d67ec47706fde62a3cfc7a087303950e32778819154bacac2da4f7efd5a7135ca2236ab2ab6851e338e519924b06a76d5d73be10a4a7348afd4409
+  metadata.gz: d3698a10fd2c5d4ae75f3fe0250d7578a82906eb6ad478c759756911501b8f53125a63f1ced325e51c6115a9f76c7ac2264ae28a42c8b65273376186e8e7aa34
+  data.tar.gz: 440e5ef180775556f3292548330cf9572db13d82394921fbbca6053b37ed4c088aa5c37b9dcb06ab2fb4049879c7fe2a093a60cf05da649abb950bf01d0af6cf

data/.gitignore

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

data/README.md

@@ -160,8 +160,10 @@ FSC_USAGE_PATTERNS = '{ spec/ui => bundle exec rspec }, { spec/api => parallel_r
   --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
+  --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

@@ -76,7 +76,7 @@ module FlakeySpecCatcher
     end
 
     def line_matches_method_or_block(line)
-      return true if line =~ /\s*do(\s+|$)/ || line =~ /^\s*def\s+/
+      return true if line =~ /\s*do(\s+|$)/ || line =~ /^\s*def\s+/ || line =~ /^\s*if\s+/
 
       false
     end

data/lib/flakey_spec_catcher/cli_override.rb

@@ -8,13 +8,15 @@ 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
+    attr_reader :output_file, :split_nodes, :split_index, :verbose, :test_options, :break_on_first_failure
 
     def initialize
       @dry_run = false
       @enable_runs = true
       @excluded_tags = []
       @use_parent = false
+      @verbose = false
+      @test_options = []
       parse_command_line_args
       validate_arguments
     end
@@ -54,6 +56,10 @@ 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('-e', '--excluded-tags=EXCLUDED_TAGS',
                 'Specify tags to exclude in a comma separated list') do |tags|
           @excluded_tags = parse_tags(tags)
@@ -78,10 +84,18 @@ module FlakeySpecCatcher
           @dry_run = true
         end
 
+        opts.on('--verbose', 'Send all output from running tests to stdout') do
+          @verbose = true
+        end
+
         opts.on('-h', '--help', 'Displays available flakey_spec_catcher cli overrides') do
           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/runner.rb

@@ -24,6 +24,7 @@ module FlakeySpecCatcher
       @rerun_manager = rerun_manager
       @rspec_result_manager = result_manager
       @test_run_count = 0
+      @temp_output_file = @user_config.output_file + 'temp' unless @user_config.output_file == File::NULL
     end
 
     # Debug Methods
@@ -35,10 +36,11 @@ 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}"
-      return if @user_config.output_file == '/dev/null'
+      return if @user_config.output_file == File::NULL
 
       puts "  Verbose Output Path: #{@user_config.output_file}"
     end
@@ -74,10 +76,12 @@ 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
 
       display_results(status)
+      copy_to_user_output unless @user_config.output_file == File::NULL
 
       # Always return 0 if silent_mode is enabled
       @user_config.silent_mode ? 0 : status
@@ -93,16 +97,23 @@ module FlakeySpecCatcher
     def invoke_rspec_runner(test)
       configure_listener
       # Pass in CLI options to suppress normal output, and only run the specified test
-      rspec_args = ['--out', @user_config.output_file, test]
-      return_status = RSpec::Core::Runner.run(rspec_args)
+      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(@user_config.test_options.concat(rspec_args))
       RSpec.clear_examples
+      copy_output_to_temp_file unless @user_config.output_file == File::NULL
       return_status
     end
 
     def invoke_custom_rspec_runner(usage, testcase)
-      custom_usage_output = `#{usage} #{testcase.join(' ')}`
+      if @user_config.verbose
+        $stdout << custom_usage_output = `#{usage} #{testcase.join(' ')}`
+      else
+        custom_usage_output = `#{usage} #{testcase.join(' ')}`
+      end
 
-      File.open(@user_config.output_file, 'a') { |f| f.puts custom_usage_output } if @user_config.output_file != '/dev/null'
+      File.open(@user_config.output_file, 'a') { |f| f.puts custom_usage_output } if @user_config.output_file != File::NULL
 
       $?.exitstatus # rubocop:disable Style/SpecialGlobalVars
     end
@@ -134,5 +145,18 @@ module FlakeySpecCatcher
                                      :example_failed, :example_passed
       end
     end
+
+    def copy_output_to_temp_file
+      # copy contents of output file, it will get overwritten in RSpec::Core::Runner
+      File.open(@temp_output_file, 'a') do |f|
+        f.puts IO.readlines(@user_config.output_file)
+      end
+    end
+
+    def copy_to_user_output
+      # copy all appended output to original output file, delete the temp output file
+      IO.copy_stream(@temp_output_file, @user_config.output_file) if File.exist?(@temp_output_file)
+      File.delete(@temp_output_file) if File.exist?(@temp_output_file)
+    end
   end
 end

data/lib/flakey_spec_catcher/user_config.rb

@@ -11,7 +11,8 @@ 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
+    attr_reader :split_nodes, :split_index, :verbose, :test_options
+    attr_reader :break_on_first_failure
 
     USER_CONFIG_ENV_VARS = %w[FSC_REPEAT_FACTOR FSC_IGNORE_FILES FSC_IGNORE_BRANCHES
                               FSC_SILENT_MODE FSC_RERUN_FILE_ONLY FSC_USAGE_PATTERNS
@@ -44,6 +45,7 @@ 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
       @enable_runs = @cli_override.enable_runs
       @dry_run = @cli_override.dry_run
       @split_nodes = @cli_override.split_nodes unless @cli_override.split_nodes.nil?
@@ -54,6 +56,8 @@ module FlakeySpecCatcher
         @cli_override.excluded_tags
       end
       @output_file = set_output_file
+      @verbose = @cli_override.verbose
+      @test_options = @cli_override.test_options
     end
     # rubocop:enable Metrics/AbcSize
 
@@ -68,7 +72,7 @@ module FlakeySpecCatcher
       if !@cli_override.output_file.nil?
         @cli_override.output_file
       elsif @output_file.nil? || @output_file.strip.empty?
-        '/dev/null'
+        File::NULL
       else
         @output_file
       end

data/lib/flakey_spec_catcher/version.rb

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

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: flakey_spec_catcher
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.10.0
 platform: ruby
 authors:
 - Brian Watson
 - Mikey Hargiss
 - Ben Nelson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-25 00:00:00.000000000 Z
+date: 2021-07-28 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.0.4
-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: []