flakey_spec_catcher 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfd29938b0542b31562ef717b6a5bc89f96dc78afa35daac74e408f93486309f
-  data.tar.gz: 930d3b0b85d2bb214363c70dd3ea2f8959e16cba83650d3d804721113e824a5d
+  metadata.gz: 993c31c2baefd8e58b525db89b1ff79ea1d6220c2d515151fda4ce2c2bcd6df7
+  data.tar.gz: 4760b425917fc1284e46eaaa73e8cf48f4f1f6224fc423beb18f749df6756d0f
 SHA512:
-  metadata.gz: 4d8133daadc9181017af45abfdda0200825cef3605459a1d4ca5a21a524b5b7d7ef9dfd8643b4545c2d2761aba103a71bbf4fbba1ee3adb1b10d60e5b6a51353
-  data.tar.gz: 0d1d43b5ed4f93b1e21b871c03cf38e524c05c99a8f29a46998f78e867bc10d431143df64083a0b041c927e657120aac6007248b2a10955bcd581b0c583a0f4c
+  metadata.gz: 59be5545a0be53ffc435a299458d665893c35b7df44d9d3c8a8522792cd3ad68069b777d0ac9bd4bc8f10850ad38f679bcaac5fa198023836fe472b633daf401
+  data.tar.gz: aff2fe42b718049783361bf81d554182928963cc0e9bb0a4a27d9d0ceef7cc72dfbc155e24ad6a1a0c5effb5621ac35b3ae2c69f7c3ed8b16d87107eafecacc4

data/lib/flakey_spec_catcher/capsule_manager.rb

@@ -27,12 +27,14 @@ module FlakeySpecCatcher
       @change_capsules.map(&:file_name).uniq
     end
 
+    def sorted_change_contexts
+      @change_capsules.map(&:change_contexts).flatten.sort_by { |c| c.line_number.to_i }
+    end
+
     def condense_reruns
       # Don't re-run if the parent context of a change will be run
       reruns = []
-      all_contexts = @change_capsules.map(&:change_contexts).flatten
-                                     .sort_by { |c| c.line_number.to_i }
-
+      all_contexts = sorted_change_contexts
       all_contexts.each do |context|
         next if reruns.include?(context.file_name) || context.ancestor_present_in_reruns(reruns)
 
@@ -40,5 +42,26 @@ module FlakeySpecCatcher
       end
       reruns
     end
+
+    def tag_values_equal?(user_excluded_tag_value, rspec_tag_value)
+      return true if user_excluded_tag_value.nil? && rspec_tag_value.nil?
+
+      return false if user_excluded_tag_value.nil? || rspec_tag_value.nil?
+
+      (user_excluded_tag_value.tr('\'\"', '') == rspec_tag_value.tr('\'\" ', ''))
+    end
+
+    def find_reruns_by_tags(user_excluded_tags)
+      dropped_tests = []
+      sorted_change_contexts.each do |context|
+        context.tags.keys.each do |tag|
+          next unless user_excluded_tags.key?(tag) &&
+                      tag_values_equal?(user_excluded_tags[tag], context.tags[tag])
+
+          dropped_tests << context.rerun_info
+        end
+      end
+      dropped_tests
+    end
   end
 end

data/lib/flakey_spec_catcher/change_context.rb

@@ -15,15 +15,16 @@ module FlakeySpecCatcher
   # the 'describe' block only.
   class ChangeContext
     attr_reader :description, :line_number
-    attr_reader :ancestor_contexts, :file_name
+    attr_reader :ancestor_contexts, :file_name, :tags
 
-    def initialize(description:, line_number:, file_name:, ancestor_contexts: [])
+    def initialize(description:, line_number:, file_name:, ancestor_contexts: [], tags: {})
       @description = description
       @line_number = line_number
-
       @file_name = file_name
       @ancestor_contexts = ancestor_contexts
+      @tags = tags
       update_descriptions
+      identify_tags_and_values
     end
 
     def update_descriptions
@@ -33,6 +34,36 @@ module FlakeySpecCatcher
       @line_number = nil
     end
 
+    def example_group?
+      # If the description starts with 'it' or 'scenario' then the test
+      #  can provide assertions/expectations and is not an example group
+      if @description =~ /^\s*(it|scenario)\s+/
+        false
+      else
+        true
+      end
+    end
+
+    # Get tag strings which optionally may continue tags with their values
+    #  and return a hash
+    def identify_tags_and_values
+      tags_with_values = {}
+      tag_strings = identify_tag_strings
+      return if tag_strings.nil? || tag_strings.empty?
+
+      # Since tags can have a value represented as strings or symbols
+      #  we'll only remove the hash rockets and not colons
+      #  Example: ":tag => 'special'" => tags_with_values[:tag] = 'special'
+      #  Example: ":tag => :special" => tags_with_values[:tag] = :special
+
+      tag_strings.each do |str|
+        tag_and_value = str.sub(/=>/, ' ').split(' ')
+        tags_with_values[tag_and_value[0]] = tag_and_value[1]
+      end
+
+      @tags = tags_with_values
+    end
+
     def ==(other)
       @description == other.description &&
         @line_number == other.line_number &&
@@ -54,5 +85,30 @@ module FlakeySpecCatcher
       end
       false
     end
+
+    private
+
+    # Since RSpec doesn't allow for tags to be excluded for runs when explicitly
+    #  specifying an example group via `rspec test:line_number`, we have to
+    #  do the filtering ourselves which requires us to also identify tags
+    # Assume here that tags are comma delimited following the initial description
+    def identify_tag_strings
+      return if @description.empty?
+
+      tags = @description.split(',')
+      return if tags.count == 1
+
+      # Remove the description
+      tags.shift
+      # Remove the trailing ' do' from the last tag
+      tags.last.sub!(/ do$/, '')
+
+      # Remove trailing and leading whitespace
+      tags.map!(&:strip)
+
+      # Grab tags which are represented as symbols
+      tags.select! { |tag| tag.start_with? ':' }
+      tags
+    end
   end
 end

data/lib/flakey_spec_catcher/cli_override.rb

@@ -7,10 +7,11 @@ module FlakeySpecCatcher
   #
   # Captures command line arguments for manual re-runs
   class CliOverride
-    attr_reader :rerun_pattern, :rerun_usage, :repeat_factor, :enable_runs
+    attr_reader :rerun_pattern, :rerun_usage, :repeat_factor, :enable_runs, :excluded_tags
 
     def initialize
       @enable_runs = true
+      @excluded_tags = []
       parse_command_line_args
     end
 
@@ -40,6 +41,11 @@ module FlakeySpecCatcher
           @repeat_factor = parsed_repeat_factor if parsed_repeat_factor.positive?
         end
 
+        opts.on('-e', '--excluded-tags=EXCLUDED_TAGS',
+                'Specify tags to exclude in a comma separated list') do |tags|
+          @excluded_tags = parse_tags(tags)
+        end
+
         opts.on('-v', '--version', 'Prints current flakey_spec_catcher_version') do
           puts "flakey_spec_catcher Version: #{FlakeySpecCatcher::VERSION}"
           @enable_runs = false
@@ -56,5 +62,28 @@ module FlakeySpecCatcher
     def remove_formatter_quotes(env_var)
       env_var.tr('\'\"', '')
     end
+
+    def parse_tags(tag_string)
+      tags = tag_string.tr('\'\" ', '').split(',').uniq
+      tags.map do |tag|
+        if tag[0] == ':'
+          tag
+        else
+          tag.prepend(':') unless tag[0] == ':'
+        end
+      end
+
+      # Since tags can have a value represented as strings or symbols
+      #  we'll only remove the hash rockets and not colons
+      #  Example: ":tag => 'special'" => tags_with_values[:tag] = 'special'
+      #  Example: ":tag => :special" => tags_with_values[:tag] = :special
+      tags_with_values = {}
+      tags.each do |str|
+        tag_and_value = str.sub(/=>/, ' ').split(' ')
+        tags_with_values[tag_and_value[0]] = tag_and_value[1]
+      end
+
+      tags_with_values
+    end
   end
 end

data/lib/flakey_spec_catcher/rerun_manager.rb

@@ -32,12 +32,30 @@ module FlakeySpecCatcher
     def tests_for_rerun
       tests = if @user_config.rerun_file_only
         @git_controller.capsule_manager.changed_files
+        # If no tags are specified, condense re-runs else expand them
+      elsif @user_config.excluded_tags.empty?
+        condense_reruns - identify_tag_excluded_reruns
       else
-        @git_controller.capsule_manager.condense_reruns
+        all_non_example_groups - identify_tag_excluded_reruns
       end
       filter_reruns_by_ignore_files(tests)
     end
 
+    def condense_reruns
+      @git_controller.capsule_manager.condense_reruns
+    end
+
+    # Get all change contexts that can invoke expectations/assertions
+    def all_non_example_groups
+      @git_controller.capsule_manager.sorted_change_contexts.reject(&:example_group?)
+                     .map(&:rerun_info)
+    end
+
+    # Identifies all contexts that have a tag present
+    def identify_tag_excluded_reruns
+      @git_controller.capsule_manager.find_reruns_by_tags(@user_config.excluded_tags)
+    end
+
     def pair_reruns_with_usages
       reruns = tests_for_rerun
       configured_usage_patterns = @user_config.rspec_usage_patterns

data/lib/flakey_spec_catcher/runner.rb

@@ -73,7 +73,8 @@ module FlakeySpecCatcher
     def invoke_rspec_runner(test)
       configure_listener
       # Pass in CLI options to suppress normal output, and only run the specified test
-      return_status = RSpec::Core::Runner.run(['--out', '/dev/null', test])
+      rspec_args = ['--out', '/dev/null', test]
+      return_status = RSpec::Core::Runner.run(rspec_args)
       RSpec.clear_examples
       return_status
     end

data/lib/flakey_spec_catcher/user_config.rb

@@ -5,9 +5,11 @@ module FlakeySpecCatcher
   # UserConfig class
   #
   # 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
+    attr_reader :rerun_file_only, :rspec_usage_patterns, :excluded_tags
     attr_reader :manual_rerun_pattern, :manual_rerun_usage
     attr_reader :enable_runs
 
@@ -15,17 +17,24 @@ module FlakeySpecCatcher
                               FSC_SILENT_MODE FSC_RERUN_FILE_ONLY FSC_USAGE_PATTERNS].freeze
 
     def initialize(cli_override: CliOverride.new)
+      apply_env_var_settings
+      @cli_override = cli_override
+      override_settings
+    end
+
+    private
+
+    # rubocop:disable Metrics/AbcSize
+    def apply_env_var_settings
       @repeat_factor = initialize_repeat_factor(ENV['FSC_REPEAT_FACTOR'])
       @ignore_files = env_var_string_to_array(ENV['FSC_IGNORE_FILES'])
       @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'])
       @rspec_usage_patterns = env_var_string_to_pairs(ENV['FSC_USAGE_PATTERNS'])
-      @cli_override = cli_override
-      override_settings
+      @excluded_tags = env_var_string_to_tags(ENV['FSC_EXCLUDED_TAGS'])
     end
-
-    private
+    # rubocop:enable Metrics/AbcSize
 
     def override_settings
       apply_cli_override
@@ -39,6 +48,11 @@ module FlakeySpecCatcher
       @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
+      @excluded_tags = if @cli_override.excluded_tags.empty?
+        @excluded_tags
+      else
+        @cli_override.excluded_tags
+      end
     end
 
     def remove_formatter_quotes(env_var)
@@ -75,6 +89,28 @@ module FlakeySpecCatcher
       end
     end
 
+    def env_var_string_to_tags(tag_string)
+      if tag_string.nil? || tag_string.empty?
+        {}
+      else
+        tag_strings = tag_string.tr('\'\" ', '').split(',').uniq
+        tags_with_values = {}
+        return if tag_strings.nil? || tag_strings.empty?
+
+        # Since tags can have a value represented as strings or symbols
+        #  we'll only remove the hash rockets and not colons
+        #  Example: ":tag => 'special'" => tags_with_values[:tag] = 'special'
+        #  Example: ":tag => :special" => tags_with_values[:tag] = :special
+
+        tag_strings.each do |str|
+          tag_and_value = str.sub(/=>/, ' ').split(' ')
+          tags_with_values[tag_and_value[0]] = tag_and_value[1]
+        end
+
+        tags_with_values
+      end
+    end
+
     def format_regex_scan_results(matches)
       # Scanning the commit message will result in an array of matches
       #  based on the specified regex. If the pattern uses groups like ours does
@@ -118,4 +154,5 @@ 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.6.1'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flakey_spec_catcher
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Brian Watson
@@ -122,7 +122,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Run new or changed specs many times to prevent unreliable specs