flakey_spec_catcher 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c2c74dc190189f31023ee816f41a7856aceee56ccca2de3f385b3559932cfde
-  data.tar.gz: 15b1cf40884ea015014a2d0b4b96ea223f46f9381751282d370e21641a0456da
+  metadata.gz: 16de08551fe8e8417b75b81548de5a56cc64b0a90e3b4458c0e515938b52a954
+  data.tar.gz: 5e98f8c50760a963463b713e04eaf74240b382a99b9e577187bdef61789e28ca
 SHA512:
-  metadata.gz: f3eea41fa5d50fd29d292810a5b1fbf0c25452e57c85c81999fb257063a02f823657e15bd2cb9e23c63fe90923367d89b9098e5aef56142dcf51f9638412d86e
-  data.tar.gz: 7fbc79e679dfc5c4f38c995c377ab119eae0d4e890d1d5b7b97ee9516215f60e094439f246dfd7e97c2b4fa3f5c2dd5293979d230d26da7fc19174d1192ce327
+  metadata.gz: fb1e1e3dbbeba8c3441f1b7f56d9b79e3438d36261a679afef5855f59cdd27d34d6eb195f2705b76f399513ca9ecb5d0d2d17cbb893851d1bf7f4a10b82b2ce1
+  data.tar.gz: 050eed36f9fcb9c50b3a1bc0ce22ead64572d5b9ebcc2efe0474882e5f61315528104c79151fc8571303e09106c440ebf02f7f42d5f7e87c697bf97c42e6736a

data/bin/flakey_spec_catcher

@@ -4,6 +4,9 @@
 require 'flakey_spec_catcher'
 
 app = FlakeySpecCatcher::Runner.new
-app.show_settings
-app.rerun_preview
-exit app.run_specs
+
+if app.user_config.enable_runs
+  app.show_settings
+  app.rerun_preview
+  exit app.run_specs
+end

data/lib/flakey_spec_catcher/capsule_manager.rb

@@ -27,7 +27,6 @@ module FlakeySpecCatcher
       @change_capsules.map(&:file_name).uniq
     end
 
-    # rubocop:disable Metrics/AbcSize
     def condense_reruns
       # Don't re-run if the parent context of a change will be run
       reruns = []
@@ -35,21 +34,11 @@ module FlakeySpecCatcher
                                      .sort_by { |c| c.line_number.to_i }
 
       all_contexts.each do |context|
-        next if reruns.include?(context.file_name)
-
-        found_parent_match = false
-        all_contexts.each do |other|
-          next if context == other
-
-          found_parent_match = true if context.parent_matches_context(other)
-        end
-
-        next if found_parent_match
+        next if reruns.include?(context.file_name) || context.ancestor_present_in_reruns(reruns)
 
         reruns.push(context.rerun_info) unless reruns.include?(context.rerun_info)
       end
       reruns
     end
-    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/flakey_spec_catcher/change_capsule.rb

@@ -5,7 +5,7 @@ module FlakeySpecCatcher
   #
   # Summarizes a git change for a single file.
   #
-  # A ChangeCapsule object will represent the changes made to a single file. It
+  # 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
@@ -28,9 +28,11 @@ module FlakeySpecCatcher
       ignore_scope_closure = 0
       lines_in_file = File.read(@file_name).split("\n")
       lines_in_file.each_with_index do |line, index|
+        # Check if line matches an rspec example or examplegroup format
         if line =~ spec_scope
           handle_change_context(line, index, change_context_stack)
-        elsif line =~ /\s*do(\s+|$)/
+        # Else, ignore other blocks that might pollute context stack
+        elsif line_matches_method_or_block(line)
           ignore_scope_closure += 1
         end
 
@@ -59,8 +61,6 @@ module FlakeySpecCatcher
       if context.nil?
         change_context = FlakeySpecCatcher::ChangeContext.new(description: nil,
                                                               line_number: nil,
-                                                              parent_description: nil,
-                                                              parent_line_number: nil,
                                                               file_name: @file_name)
         @change_contexts.push(change_context)
       else
@@ -75,6 +75,12 @@ module FlakeySpecCatcher
       /\s*(#{SCOPE_SPECIFIERS.join("|")}).*\s+do\s*$/
     end
 
+    def line_matches_method_or_block(line)
+      return true if line =~ /\s*do(\s+|$)/ || line =~ /^\s*def\s+/
+
+      false
+    end
+
     def pop_scope
       /\s+end(\s+|$)/
     end
@@ -99,16 +105,9 @@ module FlakeySpecCatcher
     end
 
     def handle_change_context(line, line_number, change_context_stack)
-      if !change_context_stack.empty?
-        parent_desc = change_context_stack[-1].description
-        parent_line = change_context_stack[-1].line_number
-      else
-        parent_desc = nil
-        parent_line = nil
-      end
       change_context = FlakeySpecCatcher::ChangeContext.new(
-        description: line, line_number: (line_number + 1), parent_description: parent_desc,
-        parent_line_number: parent_line, file_name: @file_name
+        description: line, line_number: (line_number + 1),
+        file_name: @file_name, ancestor_contexts: change_context_stack.dup
       )
 
       change_context_stack.push(change_context) unless

data/lib/flakey_spec_catcher/change_context.rb

@@ -15,35 +15,29 @@ module FlakeySpecCatcher
   # the 'describe' block only.
   class ChangeContext
     attr_reader :description, :line_number
-    attr_reader :parent_description, :parent_line_number
-    attr_reader :file_name
+    attr_reader :ancestor_contexts, :file_name
 
-    def initialize(description:, line_number:, parent_description:,
-      parent_line_number:, file_name:)
+    def initialize(description:, line_number:, file_name:, ancestor_contexts: [])
       @description = description
       @line_number = line_number
-      @parent_description = parent_description
-      @parent_line_number = parent_line_number
+
       @file_name = file_name
+      @ancestor_contexts = ancestor_contexts
       update_descriptions
     end
 
     def update_descriptions
-      if @description.nil? || @description.empty?
-        @description = @file_name
-        @line_number = nil
-        @parent_description = nil
-        @parent_line_number = nil
-      elsif @parent_description.nil? || @parent_description.empty?
-        @parent_description = @file_name
-        @parent_line_number = nil
-      end
+      return unless @description.nil? || @description.empty?
+
+      @description = @file_name
+      @line_number = nil
     end
 
     def ==(other)
       @description == other.description &&
         @line_number == other.line_number &&
-        @file_name == other.file_name
+        @file_name == other.file_name &&
+        @ancestor_contexts == other.ancestor_contexts
     end
 
     def rerun_info
@@ -54,10 +48,11 @@ module FlakeySpecCatcher
       end
     end
 
-    def parent_matches_context(other)
-      @parent_description == other.description &&
-        @parent_line_number == other.line_number &&
-        @file_name == other.file_name
+    def ancestor_present_in_reruns(reruns)
+      reruns.each do |rerun|
+        return true if @ancestor_contexts.map(&:rerun_info).include? rerun
+      end
+      false
     end
   end
 end

data/lib/flakey_spec_catcher/cli_override.rb

@@ -7,9 +7,10 @@ module FlakeySpecCatcher
   #
   # Captures command line arguments for manual re-runs
   class CliOverride
-    attr_reader :rerun_pattern, :rerun_usage, :repeat_factor
+    attr_reader :rerun_pattern, :rerun_usage, :repeat_factor, :enable_runs
 
     def initialize
+      @enable_runs = true
       parse_command_line_args
     end
 
@@ -41,10 +42,12 @@ module FlakeySpecCatcher
 
         opts.on('-v', '--version', 'Prints current flakey_spec_catcher_version') do
           puts "flakey_spec_catcher Version: #{FlakeySpecCatcher::VERSION}"
+          @enable_runs = false
         end
 
         opts.on('-h', '--help', 'Displays available flakey_spec_catcher cli overrides') do
           puts opts
+          @enable_runs = false
         end
       end.parse!
     end

data/lib/flakey_spec_catcher/git_controller.rb

@@ -20,7 +20,7 @@ module FlakeySpecCatcher
     attr_reader :capsule_manager
 
     def initialize(test_mode: false, capsule_manager: FlakeySpecCatcher::CapsuleManager.new)
-      @branch = `git branch | grep '*'`.delete('*').gsub(/\s+/, '')
+      @branch = find_remote_branch
       @remote = `git remote`.gsub(/\s+/, '')
       @capsule_manager = capsule_manager
       initialize_git_comparison(test_mode)
@@ -34,6 +34,49 @@ module FlakeySpecCatcher
 
     private
 
+    def find_remote_branch
+      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 origin`.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
+
+      remote_branch = if match.nil?
+        'master'
+      else
+        # match is formatted as [working_branch, remote]
+        match[1]
+      end
+      remote_branch
+    end
+
     def initialize_git_comparison(test_mode)
       if !test_mode
         @working_commit_sha = `git rev-parse @`.gsub(/\s+/, '')

data/lib/flakey_spec_catcher/user_config.rb

@@ -9,6 +9,8 @@ module FlakeySpecCatcher
     attr_reader :repeat_factor, :ignore_files, :ignore_branches, :silent_mode
     attr_reader :rerun_file_only, :rspec_usage_patterns
     attr_reader :manual_rerun_pattern, :manual_rerun_usage
+    attr_reader :enable_runs
+
     USER_CONFIG_ENV_VARS = %w[FSC_REPEAT_FACTOR FSC_IGNORE_FILES FSC_IGNORE_BRANCHES
                               FSC_SILENT_MODE FSC_RERUN_FILE_ONLY FSC_USAGE_PATTERNS].freeze
 
@@ -36,6 +38,7 @@ module FlakeySpecCatcher
       @manual_rerun_pattern = @cli_override.rerun_pattern
       @manual_rerun_usage = @cli_override.rerun_usage
       @repeat_factor = @cli_override.repeat_factor if @cli_override.repeat_factor.to_i.positive?
+      @enable_runs = @cli_override.enable_runs
     end
 
     def remove_formatter_quotes(env_var)

data/lib/flakey_spec_catcher/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flakey_spec_catcher
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Brian Watson
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-11 00:00:00.000000000 Z
+date: 2019-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -123,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Run new or changed specs many times to prevent unreliable specs