flakey_spec_catcher 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15d0a03b7d5147dc7d4ef97bd1868c53a9a279ae767cdc652adbfdfec076ba89
-  data.tar.gz: a58a1f258d13ab6050275c20e702cd1283598fe8254cf79517a01edd50323fbc
+  metadata.gz: 7f845e77fb2900e6e7fca4c3de62b8104dd1c1844fba4b0881d9d9c77d3b65c0
+  data.tar.gz: 3611db64df625c5cc1506e400a5cd5d664da15bf254431835f245d6539b9fdaa
 SHA512:
-  metadata.gz: ba2cb9723f0f04756c506eaf91608b9fec132f0ba5285d8594e0ec1c67ab1503bb5a87bdcc3e68aa64ab74479791cbcbb2b88d051c9b5faad8a35062448de3d7
-  data.tar.gz: bc0207b9163c7a07a7398b8694125d503fbd7bda397d84bef7f34c37906a2efdca814ae31d10775ba4893473c7751e6e79c7e20676618a2ec52e31157b4023b8
+  metadata.gz: b314f343b5630fab71d1d95eeb0b08f371d7bf314b2b5045e33fbc7eaa6d088c17d86244ee0826cb338f0e74b515f66f2fa1e0b76874fe128cbb0cfac534aedb
+  data.tar.gz: 9efea9ff0b95595f1535fdff9ada0bd86822b716c01c7faec2edc48d6600c82a2b6dea07e0fba1a225f63a936720f75e8d74577b8102b3833bc693564e3bcf93

data/README.md

@@ -11,7 +11,7 @@ There are two primary usecases for flakey_spec_catcher (FSC):
    commit many times.
 
 2. Manual Re-runs - Specify a test to re-run many times regardless of whether it has
-   corresponding changes in yuor commit.
+   corresponding changes in your commit.
 
 FSC detects changes by running the equivalent of a git diff
 between the current branch's commit and the HEAD of Source Control Management (SCM)
@@ -70,7 +70,7 @@ you'll also need to ensure that FSC has access to any needed gems.
 It's best to do this by adding flakey_speec_catcher to your Gemfile via bundler
 and then running it with `bundle exec flakey_spec_catcher`
 
-### In what cases if FSC not suitable?
+### In what cases is FSC not suitable?
 
 Since FSC by default re-runs tests at the smallest possible level of
 change (a single test case or example), it is not suitable to allow it to run

data/lib/flakey_spec_catcher/change_capsule.rb

@@ -72,7 +72,7 @@ module FlakeySpecCatcher
       # 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\s*$/
+      /\s*(#{SCOPE_SPECIFIERS.join("|")}).*\s+do.*$/
     end
 
     def line_matches_method_or_block(line)

data/lib/flakey_spec_catcher/cli_override.rb

@@ -37,8 +37,6 @@ module FlakeySpecCatcher
 
         opts.on('-r', '--repeat=REPEAT_FACTOR',
                 'Specify a repeat factor for the manual re-run(s)') do |repeat|
-          raise ArgumentError if @rerun_patterns.nil?
-
           parsed_repeat_factor = remove_formatter_quotes(repeat).to_i
           @repeat_factor = parsed_repeat_factor if parsed_repeat_factor.positive?
         end

data/lib/flakey_spec_catcher/git_controller.rb

@@ -20,8 +20,8 @@ module FlakeySpecCatcher
     attr_reader :capsule_manager
 
     def initialize(test_mode: false, capsule_manager: FlakeySpecCatcher::CapsuleManager.new)
+      @remote = find_git_remote
       @branch = find_remote_branch
-      @remote = `git remote`.gsub(/\s+/, '')
       @capsule_manager = capsule_manager
       initialize_git_comparison(test_mode)
       parse_changes
@@ -34,7 +34,19 @@ module FlakeySpecCatcher
 
     private
 
+    # Use 'origin' unless otherwise specified
+    def find_git_remote
+      if ENV['FSC_GIT_REMOTE'].nil? || ENV['FSC_GIT_REMOTE'].strip.empty?
+        remotes = `git remote show`.split
+        remotes.empty? ? nil : remotes[0]
+      else
+        ENV['FSC_GIT_REMOTE']
+      end
+    end
+
     def find_remote_branch
+      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
@@ -55,7 +67,7 @@ module FlakeySpecCatcher
       #   dev/reports pushes to dev/reports                 (up to date)
       #   master              pushes to master              (up to date)
 
-      remote_branches = `git remote show origin`.split("\n")
+      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>]
@@ -78,7 +90,7 @@ module FlakeySpecCatcher
     end
 
     def initialize_git_comparison(test_mode)
-      if !test_mode
+      if !test_mode && !@remote.nil?
         @working_commit_sha = `git rev-parse @`.gsub(/\s+/, '')
         @base_commit_sha = `git rev-parse #{@remote}/#{@branch}`.gsub(/\s+/, '')
       else

data/lib/flakey_spec_catcher/rerun_capsule.rb

@@ -9,7 +9,7 @@ module FlakeySpecCatcher
     include Comparable
     attr_reader :usage, :testcase
 
-    def initialize(usage: nil, testcase: '')
+    def initialize(usage: nil, testcase: [])
       @usage = initialize_usage(usage)
       @testcase = initialize_testcase(testcase)
     end
@@ -30,6 +30,10 @@ module FlakeySpecCatcher
       @testcase <=> other.testcase
     end
 
+    def ==(other)
+      usage == other.usage && testcase == other.testcase
+    end
+
     private
 
     def initialize_usage(usage)
@@ -42,9 +46,11 @@ module FlakeySpecCatcher
 
     def initialize_testcase(testcase)
       if testcase.nil? || testcase.empty?
-        ''
-      else
+        []
+      elsif testcase.is_a?(Array)
         testcase
+      else
+        raise "Error: expected array for testcase not #{testcase.class}"
       end
     end
   end

data/lib/flakey_spec_catcher/rerun_manager.rb

@@ -23,7 +23,7 @@ module FlakeySpecCatcher
       if @user_config.manual_rerun_patterns.nil?
         pair_reruns_with_usages
       else
-        @rerun_capsules.clear
+        @rerun_capsules = []
         inject_manual_reruns(@user_config.manual_rerun_patterns,
                              @user_config.manual_rerun_usage)
       end
@@ -59,57 +59,52 @@ module FlakeySpecCatcher
     def pair_reruns_with_usages
       reruns = tests_for_rerun
       configured_usage_patterns = @user_config.rspec_usage_patterns
-
       if configured_usage_patterns.count.zero?
         add_capsules_with_default_usage(reruns)
         return
       end
 
-      reruns.each do |rerun|
-        match_found = false
-        configured_usage_patterns.each do |usage_pattern_pair|
-          next if match_found
-
-          pattern, usage = usage_pattern_pair
-          if rerun =~ /#{pattern}/
-            add_rerun_capsule(testcase: rerun, usage: usage)
-            match_found = true
-          end
+      configured_usage_patterns.each do |usage_pattern_pair|
+        tests = []
+        pattern, usage = usage_pattern_pair
+        reruns.each do |rerun|
+          tests.push rerun if rerun =~ /#{pattern}/
         end
-        add_rerun_capsule(testcase: rerun) unless match_found
+        reruns -= tests
+        add_rerun_capsule(testcase: tests, usage: usage)
       end
+      add_rerun_capsule(testcase: reruns) if reruns.any?
     end
 
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     def inject_manual_reruns(patterns, usage)
+      tests = []
       patterns.tr(' ', '').split(',').each do |pattern|
         # Check if file exists first and handle if user supplies testcase:line_number
         file_name = pattern.split(':')[0]
         line_number_present = pattern.split(':').count > 1
         matching_files = Dir.glob(file_name)
-
         # If no file matches are run, don't queue up re-runs
         if matching_files.count.zero?
           puts "Specified pattern #{pattern} did not match an existing file"
           raise ArgumentError
         end
-
         # It won't make sense to have multiple files to run with one specific line number
         if line_number_present
           if matching_files.count > 1
             puts "Specified pattern #{pattern} matched multiple files but a line number was given"
             raise ArgumentError
           else
-            add_rerun_capsule(testcase: pattern, usage: usage)
+            tests.push pattern
           end
-
         # No line numbers, queue up all matching files
         else
           matching_files.each do |file|
-            add_rerun_capsule(testcase: file, usage: usage)
+            tests.push file
           end
         end
       end
+      add_rerun_capsule(testcase: tests, usage: usage)
     end
     # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
@@ -131,13 +126,18 @@ module FlakeySpecCatcher
     end
 
     def add_capsules_with_default_usage(reruns)
-      reruns.each do |rerun|
-        @rerun_capsules.push(FlakeySpecCatcher::RerunCapsule.new(testcase: rerun))
-      end
+      @rerun_capsules.push(FlakeySpecCatcher::RerunCapsule.new(testcase: reruns)) unless reruns.empty?
     end
 
-    def add_rerun_capsule(testcase: '', usage: nil)
-      @rerun_capsules.push(FlakeySpecCatcher::RerunCapsule.new(testcase: testcase, usage: usage))
+    def add_rerun_capsule(testcase: [], usage: nil)
+      return if testcase.empty?
+
+      capsule = @rerun_capsules.find { |cap| cap.usage == usage }
+      if capsule
+        capsule.testcase.push(testcase)
+      else
+        @rerun_capsules.push(FlakeySpecCatcher::RerunCapsule.new(testcase: testcase, usage: usage))
+      end
     end
   end
 end

data/lib/flakey_spec_catcher/runner.rb

@@ -44,10 +44,12 @@ module FlakeySpecCatcher
     def rerun_preview
       puts "\n********************************************"
       puts "Re-run Preview\n"
-      @rerun_manager.rerun_capsules.sort.each do |capsule|
-        rerun_msg = "  Running #{capsule.testcase} #{@user_config.repeat_factor} times "
-        rerun_msg += "using `#{capsule.usage}`" unless capsule.default_usage?
-        puts rerun_msg
+      @rerun_manager.rerun_capsules.each do |capsule|
+        capsule.testcase.each do |test|
+          rerun_msg = "  Running #{test} #{@user_config.repeat_factor} times "
+          rerun_msg += "using `#{capsule.usage}`" unless capsule.default_usage?
+          puts rerun_msg
+        end
       end
       puts "\n********************************************"
     end
@@ -55,8 +57,8 @@ module FlakeySpecCatcher
 
     def run_specs
       status = 0
-      @user_config.repeat_factor.times do
-        @rerun_manager.rerun_capsules.sort.each do |capsule|
+      @rerun_manager.rerun_capsules.sort.each do |capsule|
+        @user_config.repeat_factor.times do
           iteration_status = handle_capsule_rerun(capsule)
           status = [status, iteration_status].max
         end
@@ -85,11 +87,9 @@ module FlakeySpecCatcher
     end
 
     def invoke_custom_rspec_runner(usage, testcase)
-      custom_usage_output = `#{usage} #{testcase}`
+      custom_usage_output = `#{usage} #{testcase.join(' ')}`
 
-      if @user_config.output_file != '/dev/null'
-        File.open(@user_config.output_file, 'a') { |f| f.puts custom_usage_output }
-      end
+      File.open(@user_config.output_file, 'a') { |f| f.puts custom_usage_output } if @user_config.output_file != '/dev/null'
 
       $?.exitstatus # rubocop:disable Style/SpecialGlobalVars
     end

data/lib/flakey_spec_catcher/user_config.rb

@@ -6,7 +6,6 @@ module FlakeySpecCatcher
   #
   # Captures user-defined settings to configure RSpec re-run settings.
 
-  # rubocop:disable Metrics/ClassLength
   class UserConfig
     attr_reader :repeat_factor, :ignore_files, :ignore_branches, :silent_mode
     attr_reader :rerun_file_only, :rspec_usage_patterns, :excluded_tags
@@ -171,5 +170,4 @@ module FlakeySpecCatcher
     end
     # rubocop:enable Metrics/CyclomaticComplexity
   end
-  # rubocop:enable Metrics/ClassLength
 end

data/lib/flakey_spec_catcher/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flakey_spec_catcher
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Brian Watson
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-17 00:00:00.000000000 Z
+date: 2020-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -122,8 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Run new or changed specs many times to prevent unreliable specs