rspec-tracer 0.8.0 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 675be2bd6603501deb282508ea234808f0bbdf60c2b626611919f84c32bb4ba9
-  data.tar.gz: 591be21b4e97c50f33385111ac758665a97e83ca82e154cd3b86d32133f7ef52
+  metadata.gz: 91a840ac79a148f2203602abe8f3c0d3b2019565532edd3ac04990b7ca7f1035
+  data.tar.gz: 0cd0bd13178616e79730c9f062098f8425964507fddd704f8c8725d2cad33050
 SHA512:
-  metadata.gz: 1ab8ca453da65dd7185fa4869633d9b9ab85fb5c73cfb45929928a492d58d0e16d24e3bcef2466ceae4408c7e1ad2e5ab3f10137061ab684b1decf885809607d
-  data.tar.gz: 8dc1d3078f2c16c8ee5142c03d05222dd0bd458c979bca0a35ee1b1e44fead38ed2c1a6d84795a93f2a4d7a15c58da40562f4dae360f22e65f1518fc0ddecf75
+  metadata.gz: a98b3e279e71fcab7ceef12ec25998ece1bef3710c00dfed75a760cca7541ec2dad8b599dfdfa154f22b0f9eb9d32be74984b0696535956c831ea2cba6289a05
+  data.tar.gz: 907c29eb6e4ca0b013cf73ad3221a1137ec6ed7a44f493ec005b867a7d6808eaf99ec23c2ec1c35e7cb7c6e045be75eb49ca578162debc2fde8c3c8f786594a6

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## [0.9.2] - 2021-09-30
+
+### Fixed
+
+Caches getting corrupted on interrupts (#39)
+
+## [0.9.1] - 2021-09-23
+
+### Fixed
+
+Flaky and failed examples dependency check (#38)
+
+## [0.9.0] - 2021-09-15
+
+### Added
+
+- Handling all examples filtered by RSpec (#34)
+- Warn on incorrect analysis to stop using RSpec Tracer (#35)
+- Run `SimpleCov.at_exit` hook (#36)
+
 ## [0.8.0] - 2021-09-13
 
 ### Fixed

data/README.md

@@ -28,9 +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
 
@@ -40,6 +38,7 @@ describing the **intention** and implementation details of **managing dependency
 * [Advanced Configuration](#advanced-configuration)
 * [Filters](#filters)
 * [Environment Variables](#environment-variables)
+* [Duplicate Examples](#duplicate-examples)
 
 ## Demo
 
@@ -63,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
@@ -93,7 +98,7 @@ These reports provide information on the total number of tests that will run aft
 
 1. Add this line to your `Gemfile` and `bundle install`:
     ```ruby
-    gem 'rspec-tracer', '~> 0.7', group: :test, require: false
+    gem 'rspec-tracer', '~> 0.9', group: :test, require: false
     ```
 
     And, add the followings to your `.gitignore`:
@@ -124,10 +129,8 @@ any of the application code.**
     RSpecTracer.start
     ```
 
-    Currently using RSpec Tracer with SimpleCov has the following two limitations:
-
-    - SimpleCov **won't be able to provide branch coverage report** even when enabled.
-    - RSpec Tracer **nullifies the `SimpleCov.at_exit`** callback.
+    If you use RSpec Tracer with SimpleCov, then **SimpleCov would not report branch
+    coverage results even when enabled**.
 
 3. After running your tests, open `rspec_tracer_report/index.html` in the browser
 of your choice.
@@ -257,52 +260,48 @@ end
 ### Defining Custom Filteres
 
 You can currently define a filter using either a String or Regexp (that will then
-be Regexp-matched against each source file's path), a block or by passing in your
-own Filter class.
-
-#### String Filter
-
-```ruby
-RSpecTracer.start do
-  add_filter '/helpers/'
-end
-```
-
-This simple string filter will remove all files that match "/helpers/" in their path.
-
-#### Regex Filter
-
-```ruby
-RSpecTracer.start do
-  add_filter %r{^/helpers/}
-end
-```
+be Regexp-matched against each source file's name relative to the project root),
+a block or by passing in your own Filter class.
 
-This simple regex filter will remove all files that start with /helper/ in their path.
-
-#### Block Filter
+- **String Filter**: The string filter matches files that have the given string
+in their name. For example, the following string filter will remove all files that
+have `"/helpers/"` in their name.
+  ```ruby
+  RSpecTracer.start do
+    add_filter '/helpers/'
+  end
+  ```
 
-```ruby
-RSpecTracer.start do
-  add_filter do |source_file|
-    source_file[:file_path].include?('/helpers/')
+- **Regex Filter**: The regex filter removes all files that have a successful name
+match against the given regex expression. This simple regex filter will remove
+all files that start with `%r{^/helper/}` in their name:
+  ```ruby
+  RSpecTracer.start do
+    add_filter %r{^/helpers/}
   end
-end
-```
+  ```
 
-Block filters receive a `Hash` object and expect your block to return either true
-(if the file is to be removed from the result) or false (if the result should be kept).
-In the above example, the filter will remove all files that match "/helpers/" in their path.
+- **Block Filter**: Block filters receive a `Hash` object and expect your block
+to return either **true** (if the file is to be removed from the result) or **false**
+(if the result should be kept). In the below example, the filter will remove all
+files that match `"/helpers/"` in their path.
+  ```ruby
+  RSpecTracer.start do
+    add_filter do |source_file|
+      source_file[:file_path].include?('/helpers/')
+    end
+  end
+  ```
 
-#### Array Filter
+  You can also use `source_file[:name]` to define the return value of the block
+  filter for the given source file.
 
-```ruby
-RSpecTracer.start do
-  add_filter ['/helpers/', %r{^/utils/}]
-end
-```
-
-You can pass in an array containing any of the other filter types.
+- **Array Filter**: You can pass in an array containing any of the other filter types:
+  ```ruby
+  RSpecTracer.start do
+    add_filter ['/helpers/', %r{^/utils/}]
+  end
+  ```
 
 ## Environment Variables
 
@@ -314,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.
@@ -340,6 +342,117 @@ specific test suites and not merge them.
   TEST_SUITE_ID=2 bundle exec rspec spec/helpers
   ```
 
+## 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
+how we have written the specs. The following attributes determine the uniqueness:
+
+- The example group
+- The example full description
+- The spec file location, i.e., file name and line number
+- All the shared examples and contexts
+
+Consider the following `Calculator` module:
+```ruby
+module Calculator
+  module_function
+
+  def add(a, b) a + b; end
+  def sub(a, b) a - b; end
+  def mul(a, b) a * b; end
+end
+```
+
+And the corresponding spec file `spec/calculator_spec.rb`:
+```ruby
+RSpec.describe Calculator do
+  describe '#add' do
+    [
+      [1, 2, 3],
+      [0, 0, 0],
+      [5, 32, 37],
+      [-1, -8, -9],
+      [10, -10, 0]
+    ].each { |a, b, r| it { expect(described_class.add(a, b)).to eq(r) } }
+  end
+
+  describe '#sub' do
+    [
+      [1, 2, -1],
+      [10, 0, 10],
+      [37, 5, 32],
+      [-1, -8, 7],
+      [10, 10, 0]
+    ].each do |a, b, r|
+      it 'performs subtraction' do
+        expect(described_class.sub(a, b)).to eq(r)
+      end
+    end
+  end
+
+  describe '#mul' do
+    [
+      [1, 2, -2],
+      [10, 0, 0],
+      [5, 7, 35],
+      [-1, -8, 8],
+      [10, 10, 100]
+    ].each do |a, b, r|
+      it "multiplies #{a} and #{b} to #{r}" do
+        expect(described_class.mul(a, b)).to eq(r)
+      end
+    end
+  end
+end
+```
+
+Running the spec with `bundle exec rspec spec/calculator_spec.rb` generates the
+following output:
+```
+Calculator
+  #mul
+    multiplies 5 and 7 to 35
+    multiplies 10 and 10 to 100
+    multiplies 10 and 0 to 0
+    multiplies 1 and 2 to -2 (FAILED - 1)
+    multiplies -1 and -8 to 8
+  #add
+    example at ./spec/calculator_spec.rb:13
+    example at ./spec/calculator_spec.rb:13
+    example at ./spec/calculator_spec.rb:13
+    example at ./spec/calculator_spec.rb:13
+    example at ./spec/calculator_spec.rb:13
+  #sub
+    performs subtraction
+    performs subtraction
+    performs subtraction
+    performs subtraction
+    performs subtraction
+```
+
+In this scenario, RSpec Tracer cannot determine the `Calculator#add` and
+`Calculator#sub` group examples.
+
+```
+================================================================================
+   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)
+      * Calculator#add (spec/calculator_spec.rb:13)
+      * Calculator#add (spec/calculator_spec.rb:13)
+      * Calculator#add (spec/calculator_spec.rb:13)
+      * Calculator#add (spec/calculator_spec.rb:13)
+  - Example ID: 72171b502c5a42b9aa133f165cf09ec2 (5 examples)
+      * Calculator#sub performs subtraction (spec/calculator_spec.rb:24)
+      * Calculator#sub performs subtraction (spec/calculator_spec.rb:24)
+      * Calculator#sub performs subtraction (spec/calculator_spec.rb:24)
+      * Calculator#sub performs subtraction (spec/calculator_spec.rb:24)
+      * Calculator#sub performs subtraction (spec/calculator_spec.rb:24)
+```
+
 ## Contributing
 
 Read the [contribution guide](https://github.com/avmnu-sng/rspec-tracer/blob/main/.github/CONTRIBUTING.md).

data/lib/rspec_tracer/cache.rb

@@ -2,8 +2,8 @@
 
 module RSpecTracer
   class Cache
-    attr_reader :all_examples, :flaky_examples, :failed_examples, :pending_examples,
-                :all_files, :dependency, :run_id
+    attr_reader :all_examples, :interrupted_examples, :flaky_examples, :failed_examples,
+                :pending_examples, :all_files, :dependency, :run_id
 
     def initialize
       @run_id = last_run_id
@@ -12,6 +12,7 @@ module RSpecTracer
       @cached = false
 
       @all_examples = {}
+      @interrupted_examples = Set.new
       @flaky_examples = Set.new
       @failed_examples = Set.new
       @pending_examples = Set.new
@@ -74,7 +75,11 @@ module RSpecTracer
       end
 
       @all_examples.each_value do |example|
-        example[:execution_result].transform_keys!(&:to_sym)
+        if example.key?(:execution_result)
+          example[:execution_result].transform_keys!(&:to_sym)
+        else
+          @interrupted_examples << example[:example_id]
+        end
 
         example[:run_reason] = nil
       end

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
@@ -60,13 +65,39 @@ module RSpecTracer
             id: example_id,
             description: example[:full_description],
             location: example_location(example[:rerun_file_name], example[:rerun_line_number]),
-            status: example[:run_reason] || 'Skipped',
+            status: example[:run_reason] || 'Skipped'
+          }.merge(example_result(example_id, example))
+        end
+      end
+
+      def example_result(example_id, example)
+        if example[:execution_result].nil?
+          {
+            result: @reporter.example_interrupted?(example_id) ? 'Interrupted' : '_',
+            last_run: '_'
+          }
+        else
+          {
             result: example[:execution_result][:status].capitalize,
             last_run: example_run_local_time(example[:execution_result][:finished_at])
           }
         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
@@ -142,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
@@ -176,7 +215,7 @@ module RSpecTracer
 
       def example_status_css_class(example_status)
         case example_status.split.first
-        when 'Failed', 'Flaky'
+        when 'Failed', 'Flaky', 'Interrupted'
           'red'
         when 'Pending'
           'yellow'
@@ -189,7 +228,7 @@ module RSpecTracer
         case example_result
         when 'Passed'
           'green'
-        when 'Failed'
+        when 'Failed', 'Interrupted'
           'red'
         when 'Pending'
           'yellow'

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,9 +2,10 @@
 
 module RSpecTracer
   class Reporter
-    attr_reader :all_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
@@ -15,6 +16,15 @@ module RSpecTracer
 
     def register_example(example)
       @all_examples[example[:example_id]] = example
+      @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)
@@ -22,22 +32,41 @@ module RSpecTracer
     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
 
+    def register_interrupted_examples
+      @all_examples.each_pair do |example_id, example|
+        next if example.key?(:execution_result)
+
+        @interrupted_examples << example_id
+      end
+
+      return if @interrupted_examples.empty?
+
+      puts "RSpec tracer is not processing #{@interrupted_examples.count} interrupted examples"
+    end
+
     def register_deleted_examples(seen_examples)
       @deleted_examples = seen_examples.keys.to_set - (@skipped_examples | @all_examples.keys)
+      @deleted_examples -= @interrupted_examples
 
       @deleted_examples.select! do |example_id|
         example = seen_examples[example_id]
@@ -62,6 +91,14 @@ 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
+
     def example_passed?(example_id)
       @passed_examples.include?(example_id)
     end
@@ -116,6 +153,8 @@ module RSpecTracer
 
     def generate_reverse_dependency_report
       @dependency.each_pair do |example_id, files|
+        next if @interrupted_examples.include?(example_id)
+
         example_file = @all_examples[example_id][:rerun_file_name]
 
         files.each do |file_name|
@@ -129,13 +168,15 @@ 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,
-        pending_examples: @pending_examples.count
+        pending_examples: @pending_examples.count,
+        flaky_examples: @flaky_examples.count
       }
     end
 
@@ -165,10 +206,43 @@ 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
       @all_examples = {}
+      @duplicate_examples = Hash.new { |examples, example_id| examples[example_id] = [] }
+      @interrupted_examples = Set.new
       @passed_examples = Set.new
       @possibly_flaky_examples = Set.new
       @flaky_examples = Set.new

data/lib/rspec_tracer/rspec_runner.rb

@@ -3,13 +3,23 @@
 module RSpecTracer
   module RSpecRunner
     # rubocop:disable Metrics/AbcSize
-    def run_specs(_example_groups)
+    def run_specs(example_groups)
       actual_count = RSpec.world.example_count
+      RSpecTracer.no_examples = actual_count.zero?
+
+      if RSpecTracer.no_examples
+        RSpecTracer.running = true
+
+        super(example_groups)
+
+        return
+      end
+
       starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-      filtered_examples, example_groups = RSpecTracer.filter_examples
+      filtered_examples, filtered_example_groups = RSpecTracer.filter_examples
 
       RSpec.world.instance_variable_set(:@filtered_examples, filtered_examples)
-      RSpec.world.instance_variable_set(:@example_groups, example_groups)
+      RSpec.world.instance_variable_set(:@example_groups, filtered_example_groups)
 
       current_count = RSpec.world.example_count
       ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
@@ -23,7 +33,7 @@ module RSpecTracer
 
       RSpecTracer.running = true
 
-      super(example_groups)
+      super(filtered_example_groups)
     end
     # rubocop:enable Metrics/AbcSize
   end

data/lib/rspec_tracer/runner.rb

@@ -8,6 +8,7 @@ module RSpecTracer
     EXAMPLE_RUN_REASON = {
       explicit_run: 'Explicit run',
       no_cache: 'No cache',
+      interrupted: 'Interrupted previously',
       flaky_example: 'Flaky example',
       failed_example: 'Failed previously',
       pending_example: 'Pending previously',
@@ -43,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
@@ -59,6 +64,10 @@ module RSpecTracer
       @reporter.on_example_pending(example_id, execution_result)
     end
 
+    def register_interrupted_examples
+      @reporter.register_interrupted_examples
+    end
+
     def register_deleted_examples
       @reporter.register_deleted_examples(@cache.all_examples)
     end
@@ -73,6 +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) ||
+            @reporter.duplicate_example?(example_id)
+
           next unless @reporter.example_skipped?(example_id)
 
           file_name = RSpecTracer::SourceFile.file_name(file_path)
@@ -93,6 +105,9 @@ module RSpecTracer
       filtered_files = Set.new
 
       examples_coverage.each_pair do |example_id, example_coverage|
+        next if @reporter.example_interrupted?(example_id) ||
+          @reporter.duplicate_example?(example_id)
+
         register_example_files_dependency(example_id)
 
         example_coverage.each_key do |file_path|
@@ -118,6 +133,9 @@ module RSpecTracer
         @reporter.register_source_file(source_file)
 
         @reporter.all_examples.each_key do |example_id|
+          next if @reporter.example_interrupted?(example_id) ||
+            @reporter.duplicate_example?(example_id)
+
           @reporter.register_dependency(example_id, source_file[:file_name])
         end
       end
@@ -143,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
@@ -165,6 +189,7 @@ module RSpecTracer
     end
 
     def filter_by_example_status
+      add_previously_interrupted_examples
       add_previously_flaky_examples
       add_previously_failed_examples
       add_previously_pending_examples
@@ -179,10 +204,17 @@ module RSpecTracer
       end
     end
 
+    def add_previously_interrupted_examples
+      @cache.interrupted_examples.each do |example_id|
+        @filtered_examples[example_id] = EXAMPLE_RUN_REASON[:interrupted]
+      end
+    end
+
     def add_previously_flaky_examples
       @cache.flaky_examples.each do |example_id|
         @filtered_examples[example_id] = EXAMPLE_RUN_REASON[:flaky_example]
 
+        next unless @cache.dependency.key?(example_id)
         next unless (@changed_files & @cache.dependency[example_id]).empty?
 
         @reporter.register_possibly_flaky_example(example_id)
@@ -195,6 +227,7 @@ module RSpecTracer
 
         @filtered_examples[example_id] = EXAMPLE_RUN_REASON[:failed_example]
 
+        next unless @cache.dependency.key?(example_id)
         next unless (@changed_files & @cache.dependency[example_id]).empty?
 
         @reporter.register_possibly_flaky_example(example_id)
@@ -243,6 +276,9 @@ module RSpecTracer
     end
 
     def register_example_files_dependency(example_id)
+      return if @reporter.example_interrupted?(example_id) ||
+        @reporter.duplicate_example?(example_id)
+
       example = @reporter.all_examples[example_id]
 
       register_example_file_dependency(example_id, example[:file_name])
@@ -253,6 +289,9 @@ module RSpecTracer
     end
 
     def register_example_file_dependency(example_id, file_name)
+      return if @reporter.example_interrupted?(example_id) ||
+        @reporter.duplicate_example?(example_id)
+
       source_file = RSpecTracer::SourceFile.from_name(file_name)
 
       @reporter.register_source_file(source_file)
@@ -260,6 +299,9 @@ module RSpecTracer
     end
 
     def register_file_dependency(example_id, file_path)
+      return if @reporter.example_interrupted?(example_id) ||
+        @reporter.duplicate_example?(example_id)
+
       source_file = RSpecTracer::SourceFile.from_path(file_path)
 
       return false if RSpecTracer.filters.any? { |filter| filter.match?(source_file) }

data/lib/rspec_tracer/version.rb

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

data/lib/rspec_tracer.rb

@@ -28,7 +28,7 @@ require_relative 'rspec_tracer/version'
 
 module RSpecTracer
   class << self
-    attr_accessor :running, :pid
+    attr_accessor :running, :pid, :no_examples
 
     def start(&block)
       RSpecTracer.running = false
@@ -67,6 +67,8 @@ module RSpecTracer
         end
       end
 
+      runner.deregister_duplicate_examples
+
       [to_run, groups.to_a]
     end
     # rubocop:enable Metrics/AbcSize
@@ -75,6 +77,10 @@ module RSpecTracer
       return unless RSpecTracer.pid == Process.pid && RSpecTracer.running
 
       run_exit_tasks
+
+      ::Kernel.exit(1) if runner.non_zero_exit_code?
+    ensure
+      RSpecTracer.running = false
     end
 
     def start_example_trace
@@ -154,15 +160,11 @@ module RSpecTracer
     def setup_coverage
       @simplecov = defined?(SimpleCov) && SimpleCov.running
 
-      if simplecov?
-        # rubocop:disable Lint/EmptyBlock
-        SimpleCov.at_exit {}
-        # rubocop:enable Lint/EmptyBlock
-      else
-        require 'coverage'
+      return if simplecov?
 
-        ::Coverage.start
-      end
+      require 'coverage'
+
+      ::Coverage.start
     end
 
     def setup_trace_point
@@ -175,11 +177,13 @@ module RSpecTracer
     end
 
     def run_exit_tasks
-      generate_reports
+      if RSpecTracer.no_examples
+        puts 'Skipped reports generation since all examples were filtered out'
+      else
+        generate_reports
+      end
 
       simplecov? ? run_simplecov_exit_task : run_coverage_exit_task
-    ensure
-      RSpecTracer.running = false
     end
 
     def generate_reports
@@ -194,6 +198,7 @@ module RSpecTracer
     def process_dependency
       starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
 
+      runner.register_interrupted_examples
       runner.register_deleted_examples
       runner.register_dependency(coverage_reporter.examples_coverage)
       runner.register_untraced_dependency(@traced_files)
@@ -224,12 +229,13 @@ module RSpecTracer
 
       puts 'SimpleCov will now generate coverage report (<3 RSpec tracer)'
 
-      SimpleCov.result.format!
+      coverage_reporter.record_coverage if RSpecTracer.no_examples
     end
 
     def run_coverage_exit_task
       starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
 
+      coverage_reporter.record_coverage if RSpecTracer.no_examples
       coverage_reporter.generate_final_coverage
 
       file_name = File.join(RSpecTracer.coverage_path, 'coverage.json')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-tracer
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.3
 platform: ruby
 authors:
 - Abhimanyu Singh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-13 00:00:00.000000000 Z
+date: 2021-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docile
@@ -50,9 +50,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.6.0
-description: RSpec Tracer is a specs dependency analysis tool and a test skipper for
-  RSpec. It maintains a list of files for each test, enabling itself to skip tests
-  in the subsequent runs if none of the dependent files are changed.
+description: RSpec Tracer is a specs dependency analyzer, flaky tests detector, tests
+  accelerator, and coverage reporter tool for RSpec. It maintains a list of files
+  for each test, enabling itself to skip tests in the subsequent runs if none of the
+  dependent files are changed. It uses Ruby's built-in coverage library to keep track
+  of the coverage for each test.
 email:
 - abhisinghabhimanyu@gmail.com
 executables: []
@@ -88,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
@@ -111,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.8.0
+  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:
@@ -132,5 +135,6 @@ requirements: []
 rubygems_version: 3.2.26
 signing_key:
 specification_version: 4
-summary: RSpec Tracer is a specs dependency analysis tool and a test skipper for RSpec
+summary: RSpec Tracer is a specs dependency analyzer, flaky tests detector, tests
+  accelerator, and coverage reporter tool.
 test_files: []