rspec-tracer 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f76c84eee2926bd06511fc4e92112653dd9515a7a486c5c90102e94d1001ba7
-  data.tar.gz: 8b64c63ba96ade735ec0cd1c2982075ece274fc88e4f76eb0bff2a6bd1c4f545
+  metadata.gz: 91a840ac79a148f2203602abe8f3c0d3b2019565532edd3ac04990b7ca7f1035
+  data.tar.gz: 0cd0bd13178616e79730c9f062098f8425964507fddd704f8c8725d2cad33050
 SHA512:
-  metadata.gz: b296c0812b1b223186eb3e3a789cf2eefb9a035216ef83b7b0ebd98828f64f9c358ca435cd68461f2baf96c710d2fe02547e1eb1f25a4219cc92da4bd59ab7c8
-  data.tar.gz: eb899ae2a04ceb7bd0b6a99af710750a98c03282b431d86e2c038376a76120d1ad794ee917e866638732099a8966a039cbebc5e17514062a262e6ab733700137
+  metadata.gz: a98b3e279e71fcab7ceef12ec25998ece1bef3710c00dfed75a760cca7541ec2dad8b599dfdfa154f22b0f9eb9d32be74984b0696535956c831ea2cba6289a05
+  data.tar.gz: 907c29eb6e4ca0b013cf73ad3221a1137ec6ed7a44f493ec005b867a7d6808eaf99ec23c2ec1c35e7cb7c6e045be75eb49ca578162debc2fde8c3c8f786594a6

data/README.md

@@ -28,7 +28,7 @@ recommended to use **simplecov >= 0.12.0**. To use RSpec Tracer **cache on CI**,
 need to have an **S3 bucket** and **[AWS CLI](https://aws.amazon.com/cli/)**
 installed.
 
-### You should take some time and go through the **[document](./RSPEC_TRACER.md)** describing the **intention** and implementation details of **managing dependency**, **managing flaky tests**, **skipping tests**, and **caching on CI**.
+> You should take some time and go through the **[document](./RSPEC_TRACER.md)** describing the **intention** and implementation details of **managing dependency**, **managing flaky tests**, **skipping tests**, and **caching on CI**.
 
 ## Table of Contents
 
@@ -38,7 +38,7 @@ installed.
 * [Advanced Configuration](#advanced-configuration)
 * [Filters](#filters)
 * [Environment Variables](#environment-variables)
-* [When Should You Not Use RSpec Tracer](#when-should-you-not-use-rspec-tracer)
+* [Duplicate Examples](#duplicate-examples)
 
 ## Demo
 
@@ -62,6 +62,12 @@ These reports provide basic test information:
 
 ![](./readme_files/examples_report_next_run.png)
 
+### Duplicate Examples Report
+
+These reports provide duplicate tests information.
+
+![](./readme_files/duplicate_examples_report.png)
+
 ### Flaky Examples Report
 
 These reports provide flaky tests information. Assuming **the following two tests
@@ -307,6 +313,9 @@ development environment. You can install [localstack](https://github.com/localst
 and [awscli-local](https://github.com/localstack/awscli-local) and then invoke the
 rake tasks with `LOCAL_AWS=true`.
 
+- **`RSPEC_TRACER_FAIL_ON_DUPLICATES (default: true)`:** By default, RSpec Tracer
+exits with one if there are [duplicate examples](#duplicate-examples).
+
 - **`RSPEC_TRACER_NO_SKIP (default: false)`:** Use this environment variables to
 not skip any tests. Note that it will continue to maintain cache files and generate
 reports.
@@ -333,7 +342,7 @@ specific test suites and not merge them.
   TEST_SUITE_ID=2 bundle exec rspec spec/helpers
   ```
 
-## When Should You Not Use RSpec Tracer
+## Duplicate Examples
 
 To uniquely identify the examples is one of the requirements for the correctness
 of the RSpec Tracer. Sometimes, it would not be possible to do so depending upon
@@ -423,17 +432,12 @@ Calculator
 ```
 
 In this scenario, RSpec Tracer cannot determine the `Calculator#add` and
-`Calculator#sub` group examples. Also, it will ask you not to use the gem unless
-you have made some changes to your spec files.
+`Calculator#sub` group examples.
 
 ```
 ================================================================================
-                IMPORTANT NOTICE -- DO NOT USE RSPEC TRACER
-================================================================================
-    It would be best to make changes so that the RSpec tracer can uniquely
-    identify all the examples, and then you can enable the RSpec tracer back.
+   IMPORTANT NOTICE -- RSPEC TRACER COULD NOT IDENTIFY SOME EXAMPLES UNIQUELY
 ================================================================================
-
 RSpec tracer could not uniquely identify the following 10 examples:
   - Example ID: eabd51a899db4f64d5839afe96004f03 (5 examples)
       * Calculator#add (spec/calculator_spec.rb:13)

data/lib/rspec_tracer/html_reporter/reporter.rb

@@ -10,18 +10,12 @@ module RSpecTracer
 
       def initialize
         @reporter = RSpecTracer.runner.reporter
-
-        format_last_run
-        format_examples
-        format_flaky_examples
-        format_examples_dependency
-        format_files_dependency
       end
 
       def generate_report
         starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
 
-        copy_assets
+        prepare
 
         file_name = File.join(RSpecTracer.report_path, 'index.html')
 
@@ -37,6 +31,16 @@ module RSpecTracer
 
       private
 
+      def prepare
+        format_last_run
+        format_examples
+        format_duplicate_examples
+        format_flaky_examples
+        format_examples_dependency
+        format_files_dependency
+        copy_assets
+      end
+
       def copy_assets
         Dir[File.join(File.dirname(__FILE__), 'public/*')].each do |path|
           FileUtils.cp_r(path, asset_output_path)
@@ -46,6 +50,7 @@ module RSpecTracer
       def format_last_run
         @last_run = @reporter.last_run.slice(
           :actual_count,
+          :duplicate_examples,
           :failed_examples,
           :pending_examples,
           :skipped_examples
@@ -79,6 +84,20 @@ module RSpecTracer
         end
       end
 
+      def format_duplicate_examples
+        @duplicate_examples = []
+
+        @reporter.duplicate_examples.each_pair do |example_id, examples|
+          examples.each do |example|
+            @duplicate_examples << {
+              id: example_id,
+              description: example[:full_description],
+              location: example_location(example[:rerun_file_name], example[:rerun_line_number])
+            }
+          end
+        end
+      end
+
       def format_flaky_examples
         @flaky_examples = @examples.slice(*@reporter.flaky_examples).values
       end
@@ -154,6 +173,14 @@ module RSpecTracer
         template(title_id).result(current_binding)
       end
 
+      def formatted_duplicate_examples(title, duplicate_examples)
+        title_id = report_container_id(title)
+        current_binding = binding
+
+        current_binding.local_variable_set(:title_id, title_id)
+        template(title_id).result(current_binding)
+      end
+
       def formatted_flaky_examples(title, flaky_examples)
         title_id = report_container_id(title)
         current_binding = binding

data/lib/rspec_tracer/html_reporter/views/duplicate_examples.erb

@@ -0,0 +1,34 @@
+<div class="report_container" id="<%= title_id %>">
+  <h2>
+    <span class="group_name"><%= title %></span>
+    (
+      <span class="blue">
+        <strong><%= duplicate_examples.count %></strong>
+      </span> examples
+    )
+  </h2>
+
+  <a name="<%= title_id %>"></a>
+
+  <div class="report-table--responsive">
+    <table class="report-table">
+      <thead>
+        <tr>
+          <th>ID</th>
+          <th>Description</th>
+          <th>Location</th>
+        </tr>
+      </thead>
+
+      <tbody>
+        <% duplicate_examples.each do |example| %>
+          <tr>
+            <td><%= example[:id] %></td>
+            <td><%= example[:description] %></td>
+            <td><%= example[:location] %></td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+</div>

data/lib/rspec_tracer/html_reporter/views/examples.erb

@@ -5,6 +5,11 @@
       <span class="blue">
         <strong><%= last_run[:actual_count] %></strong>
       </span> examples,
+      <% if last_run[:duplicate_examples].positive? %>
+        <span class="blue">
+          <strong><%= last_run[:duplicate_examples] %></strong>
+        </span> duplicates,
+      <% end %>
       <% if last_run[:failed_examples].positive? %>
         <span class="red">
           <strong><%= last_run[:failed_examples] %></strong>

data/lib/rspec_tracer/html_reporter/views/layout.erb

@@ -18,12 +18,15 @@
       <ul class="group_tabs"></ul>
 
       <div id="content">
-        <%= formatted_examples('Examples', examples.values) %>
-        <% unless flaky_examples.empty? %>
-          <%= formatted_flaky_examples('Flaky Examples', flaky_examples) %>
+        <%= formatted_examples('Examples', @examples.values) %>
+        <% unless @duplicate_examples.empty? %>
+          <%= formatted_duplicate_examples('Duplicate Examples', @duplicate_examples) %>
         <% end %>
-        <%= formatted_examples_dependency('Examples Dependency', examples_dependency) %>
-        <%= formatted_files_dependency("Files Dependency", files_dependency) %>
+        <% unless @flaky_examples.empty? %>
+          <%= formatted_flaky_examples('Flaky Examples', @flaky_examples) %>
+        <% end %>
+        <%= formatted_examples_dependency('Examples Dependency', @examples_dependency) %>
+        <%= formatted_files_dependency("Files Dependency", @files_dependency) %>
       </div>
 
       <div id="footer">

data/lib/rspec_tracer/reporter.rb

@@ -2,10 +2,10 @@
 
 module RSpecTracer
   class Reporter
-    attr_reader :all_examples, :interrupted_examples, :possibly_flaky_examples,
-                :flaky_examples, :pending_examples, :all_files, :modified_files,
-                :deleted_files, :dependency, :reverse_dependency, :examples_coverage,
-                :last_run
+    attr_reader :all_examples, :interrupted_examples, :duplicate_examples,
+                :possibly_flaky_examples, :flaky_examples, :pending_examples,
+                :all_files, :modified_files, :deleted_files, :dependency,
+                :reverse_dependency, :examples_coverage, :last_run
 
     def initialize
       initialize_examples
@@ -19,21 +19,35 @@ module RSpecTracer
       @duplicate_examples[example[:example_id]] << example
     end
 
+    def deregister_duplicate_examples
+      @duplicate_examples.select! { |_, examples| examples.count > 1 }
+
+      return if @duplicate_examples.empty?
+
+      @all_examples.reject! { |example_id, _| @duplicate_examples.key?(example_id) }
+    end
+
     def on_example_skipped(example_id)
       @skipped_examples << example_id
     end
 
     def on_example_passed(example_id, result)
+      return if @duplicate_examples.key?(example_id)
+
       @passed_examples << example_id
       @all_examples[example_id][:execution_result] = formatted_execution_result(result)
     end
 
     def on_example_failed(example_id, result)
+      return if @duplicate_examples.key?(example_id)
+
       @failed_examples << example_id
       @all_examples[example_id][:execution_result] = formatted_execution_result(result)
     end
 
     def on_example_pending(example_id, result)
+      return if @duplicate_examples.key?(example_id)
+
       @pending_examples << example_id
       @all_examples[example_id][:execution_result] = formatted_execution_result(result)
     end
@@ -77,6 +91,10 @@ module RSpecTracer
       @pending_examples << example_id
     end
 
+    def duplicate_example?(example_id)
+      @duplicate_examples.key?(example_id)
+    end
+
     def example_interrupted?(example_id)
       @interrupted_examples.include?(example_id)
     end
@@ -125,17 +143,6 @@ module RSpecTracer
       file_deleted?(file_name) || file_modified?(file_name)
     end
 
-    def incorrect_analysis?
-      @duplicate_examples.select! { |_, examples| examples.count > 1 }
-
-      return false if @duplicate_examples.empty?
-
-      print_not_use_notice
-      print_duplicate_examples
-
-      true
-    end
-
     def register_dependency(example_id, file_name)
       @dependency[example_id] << file_name
     end
@@ -161,10 +168,10 @@ module RSpecTracer
 
     def generate_last_run_report
       @last_run = {
-        run_id: @run_id,
         pid: RSpecTracer.pid,
         actual_count: RSpec.world.example_count + @skipped_examples.count,
         example_count: RSpec.world.example_count,
+        duplicate_examples: @duplicate_examples.sum { |_, examples| examples.count },
         interrupted_examples: @interrupted_examples.count,
         failed_examples: @failed_examples.count,
         skipped_examples: @skipped_examples.count,
@@ -199,6 +206,37 @@ module RSpecTracer
       puts "RSpec tracer reports written to #{@cache_dir} (took #{elpased})"
     end
 
+    # rubocop:disable Metrics/AbcSize
+    def print_duplicate_examples
+      return if @duplicate_examples.empty?
+
+      total = @duplicate_examples.sum { |_, examples| examples.count }
+
+      puts '=' * 80
+      puts '   IMPORTANT NOTICE -- RSPEC TRACER COULD NOT IDENTIFY SOME EXAMPLES UNIQUELY'
+      puts '=' * 80
+      puts "RSpec tracer could not uniquely identify the following #{total} examples:"
+
+      justify = ' ' * 2
+      nested_justify = justify * 3
+
+      @duplicate_examples.each_pair do |example_id, examples|
+        puts "#{justify}- Example ID: #{example_id} (#{examples.count} examples)"
+
+        examples.each do |example|
+          description = example[:full_description].strip
+          file_name = example[:rerun_file_name].sub(%r{^/}, '')
+          line_number = example[:rerun_line_number]
+          location = "#{file_name}:#{line_number}"
+
+          puts "#{nested_justify}* #{description} (#{location})"
+        end
+      end
+
+      puts
+    end
+    # rubocop:enable Metrics/AbcSize
+
     private
 
     def initialize_examples
@@ -262,45 +300,6 @@ module RSpecTracer
       @reverse_dependency = report.to_h
     end
 
-    def print_not_use_notice
-      justify = ' ' * 4
-      four_justify = justify * 4
-
-      puts '=' * 80
-      puts "#{four_justify}IMPORTANT NOTICE -- DO NOT USE RSPEC TRACER"
-      puts '=' * 80
-      puts "#{justify}It would be best to make changes so that the RSpec tracer can uniquely"
-      puts "#{justify}identify all the examples, and then you can enable the RSpec tracer back."
-      puts '=' * 80
-      puts
-    end
-
-    # rubocop:disable Metrics/AbcSize
-    def print_duplicate_examples
-      total = @duplicate_examples.sum { |_, examples| examples.length }
-
-      puts "RSpec tracer could not uniquely identify the following #{total} examples:"
-
-      justify = ' ' * 2
-      nested_justify = justify * 3
-
-      @duplicate_examples.each_pair do |example_id, examples|
-        puts "#{justify}- Example ID: #{example_id} (#{examples.count} examples)"
-
-        examples.each do |example|
-          description = example[:full_description].strip
-          file_name = example[:rerun_file_name].sub(%r{^/}, '')
-          line_number = example[:rerun_line_number]
-          location = "#{file_name}:#{line_number}"
-
-          puts "#{nested_justify}* #{description} (#{location})"
-        end
-      end
-
-      puts
-    end
-    # rubocop:enable Metrics/AbcSize
-
     def write_all_examples_report
       file_name = File.join(@cache_dir, 'all_examples.json')
 

data/lib/rspec_tracer/runner.rb

@@ -44,6 +44,10 @@ module RSpecTracer
       @reporter.register_example(example)
     end
 
+    def deregister_duplicate_examples
+      @reporter.deregister_duplicate_examples
+    end
+
     def on_example_skipped(example_id)
       @reporter.on_example_skipped(example_id)
     end
@@ -68,10 +72,6 @@ module RSpecTracer
       @reporter.register_deleted_examples(@cache.all_examples)
     end
 
-    def incorrect_analysis?
-      @reporter.incorrect_analysis?
-    end
-
     # rubocop:disable Metrics/AbcSize
     def generate_missed_coverage
       missed_coverage = Hash.new do |files_coverage, file_path|
@@ -82,7 +82,9 @@ module RSpecTracer
 
       @cache.cached_examples_coverage.each_pair do |example_id, example_coverage|
         example_coverage.each_pair do |file_path, line_coverage|
-          next if @reporter.example_interrupted?(example_id)
+          next if @reporter.example_interrupted?(example_id) ||
+            @reporter.duplicate_example?(example_id)
+
           next unless @reporter.example_skipped?(example_id)
 
           file_name = RSpecTracer::SourceFile.file_name(file_path)
@@ -103,7 +105,8 @@ module RSpecTracer
       filtered_files = Set.new
 
       examples_coverage.each_pair do |example_id, example_coverage|
-        next if @reporter.example_interrupted?(example_id)
+        next if @reporter.example_interrupted?(example_id) ||
+          @reporter.duplicate_example?(example_id)
 
         register_example_files_dependency(example_id)
 
@@ -130,7 +133,8 @@ module RSpecTracer
         @reporter.register_source_file(source_file)
 
         @reporter.all_examples.each_key do |example_id|
-          next if @reporter.example_interrupted?(example_id)
+          next if @reporter.example_interrupted?(example_id) ||
+            @reporter.duplicate_example?(example_id)
 
           @reporter.register_dependency(example_id, source_file[:file_name])
         end
@@ -157,6 +161,12 @@ module RSpecTracer
       end
 
       @reporter.write_reports
+      @reporter.print_duplicate_examples
+    end
+
+    def non_zero_exit_code?
+      !@reporter.duplicate_examples.empty? &&
+        ENV.fetch('RSPEC_TRACER_FAIL_ON_DUPLICATES', 'true') == 'true'
     end
 
     private
@@ -266,7 +276,8 @@ module RSpecTracer
     end
 
     def register_example_files_dependency(example_id)
-      return if @reporter.example_interrupted?(example_id)
+      return if @reporter.example_interrupted?(example_id) ||
+        @reporter.duplicate_example?(example_id)
 
       example = @reporter.all_examples[example_id]
 
@@ -278,7 +289,8 @@ module RSpecTracer
     end
 
     def register_example_file_dependency(example_id, file_name)
-      return if @reporter.example_interrupted?(example_id)
+      return if @reporter.example_interrupted?(example_id) ||
+        @reporter.duplicate_example?(example_id)
 
       source_file = RSpecTracer::SourceFile.from_name(file_name)
 
@@ -287,7 +299,8 @@ module RSpecTracer
     end
 
     def register_file_dependency(example_id, file_path)
-      return if @reporter.example_interrupted?(example_id)
+      return if @reporter.example_interrupted?(example_id) ||
+        @reporter.duplicate_example?(example_id)
 
       source_file = RSpecTracer::SourceFile.from_path(file_path)
 

data/lib/rspec_tracer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RSpecTracer
-  VERSION = '0.9.2'
+  VERSION = '0.9.3'
 end

data/lib/rspec_tracer.rb

@@ -67,6 +67,8 @@ module RSpecTracer
         end
       end
 
+      runner.deregister_duplicate_examples
+
       [to_run, groups.to_a]
     end
     # rubocop:enable Metrics/AbcSize
@@ -74,9 +76,9 @@ module RSpecTracer
     def at_exit_behavior
       return unless RSpecTracer.pid == Process.pid && RSpecTracer.running
 
-      ::Kernel.exit(1) if runner.incorrect_analysis?
-
       run_exit_tasks
+
+      ::Kernel.exit(1) if runner.non_zero_exit_code?
     ensure
       RSpecTracer.running = false
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-tracer
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - Abhimanyu Singh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-30 00:00:00.000000000 Z
+date: 2021-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docile
@@ -90,6 +90,7 @@ files:
 - lib/rspec_tracer/html_reporter/public/favicon.png
 - lib/rspec_tracer/html_reporter/public/loading.gif
 - lib/rspec_tracer/html_reporter/reporter.rb
+- lib/rspec_tracer/html_reporter/views/duplicate_examples.erb
 - lib/rspec_tracer/html_reporter/views/examples.erb
 - lib/rspec_tracer/html_reporter/views/examples_dependency.erb
 - lib/rspec_tracer/html_reporter/views/files_dependency.erb
@@ -113,7 +114,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/avmnu-sng/rspec-tracer
-  source_code_uri: https://github.com/avmnu-sng/rspec-tracer/tree/v0.9.2
+  source_code_uri: https://github.com/avmnu-sng/rspec-tracer/tree/v0.9.3
   changelog_uri: https://github.com/avmnu-sng/rspec-tracer/blob/main/CHANGELOG.md
   bug_tracker_uri: https://github.com/avmnu-sng/rspec-tracer/issues
 post_install_message: