rspec-tracer 0.9.0 → 1.0.0

data/lib/rspec_tracer/reporter.rb

@@ -2,9 +2,12 @@
 
 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,
+                :skipped_examples, :failed_examples, :all_files, :modified_files,
+                :deleted_files, :dependency, :examples_coverage
+
+    attr_accessor :reverse_dependency, :last_run
 
     def initialize
       initialize_examples
@@ -18,27 +21,54 @@ 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
 
+    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]
@@ -63,6 +93,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
@@ -107,17 +145,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
@@ -126,62 +153,12 @@ module RSpecTracer
       @examples_coverage = examples_coverage
     end
 
-    def generate_reverse_dependency_report
-      @dependency.each_pair do |example_id, files|
-        example_file = @all_examples[example_id][:rerun_file_name]
-
-        files.each do |file_name|
-          @reverse_dependency[file_name][:example_count] += 1
-          @reverse_dependency[file_name][:examples][example_file] += 1
-        end
-      end
-
-      format_reverse_dependency_report
-    end
-
-    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,
-        failed_examples: @failed_examples.count,
-        skipped_examples: @skipped_examples.count,
-        pending_examples: @pending_examples.count
-      }
-    end
-
-    def write_reports
-      starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-
-      @run_id = Digest::MD5.hexdigest(@all_examples.keys.sort.to_json)
-      @cache_dir = File.join(RSpecTracer.cache_path, @run_id)
-
-      FileUtils.mkdir_p(@cache_dir)
-
-      %i[
-        all_examples
-        flaky_examples
-        failed_examples
-        pending_examples
-        all_files
-        dependency
-        reverse_dependency
-        examples_coverage
-        last_run
-      ].each { |report_type| send("write_#{report_type}_report") }
-
-      ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-      elpased = RSpecTracer::TimeFormatter.format_time(ending - starting)
-
-      puts "RSpec tracer reports written to #{@cache_dir} (took #{elpased})"
-    end
-
     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
@@ -223,114 +200,5 @@ module RSpecTracer
         status: result.status.to_s
       }
     end
-
-    def format_reverse_dependency_report
-      @reverse_dependency.transform_values! do |data|
-        {
-          example_count: data[:example_count],
-          examples: data[:examples].sort_by { |file_name, count| [-count, file_name] }.to_h
-        }
-      end
-
-      report = @reverse_dependency.sort_by do |file_name, data|
-        [-data[:example_count], file_name]
-      end
-
-      @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')
-
-      File.write(file_name, JSON.pretty_generate(@all_examples))
-    end
-
-    def write_flaky_examples_report
-      file_name = File.join(@cache_dir, 'flaky_examples.json')
-
-      File.write(file_name, JSON.pretty_generate(@flaky_examples.to_a))
-    end
-
-    def write_failed_examples_report
-      file_name = File.join(@cache_dir, 'failed_examples.json')
-
-      File.write(file_name, JSON.pretty_generate(@failed_examples.to_a))
-    end
-
-    def write_pending_examples_report
-      file_name = File.join(@cache_dir, 'pending_examples.json')
-
-      File.write(file_name, JSON.pretty_generate(@pending_examples.to_a))
-    end
-
-    def write_all_files_report
-      file_name = File.join(@cache_dir, 'all_files.json')
-
-      File.write(file_name, JSON.pretty_generate(@all_files))
-    end
-
-    def write_dependency_report
-      file_name = File.join(@cache_dir, 'dependency.json')
-
-      File.write(file_name, JSON.pretty_generate(@dependency))
-    end
-
-    def write_reverse_dependency_report
-      file_name = File.join(@cache_dir, 'reverse_dependency.json')
-
-      File.write(file_name, JSON.pretty_generate(@reverse_dependency))
-    end
-
-    def write_examples_coverage_report
-      file_name = File.join(@cache_dir, 'examples_coverage.json')
-
-      File.write(file_name, JSON.pretty_generate(@examples_coverage))
-    end
-
-    def write_last_run_report
-      file_name = File.join(RSpecTracer.cache_path, 'last_run.json')
-      last_run_data = @last_run.merge(run_id: @run_id, timestamp: Time.now.utc)
-
-      File.write(file_name, JSON.pretty_generate(last_run_data))
-    end
   end
 end

data/lib/rspec_tracer/rspec_runner.rb

@@ -2,7 +2,6 @@
 
 module RSpecTracer
   module RSpecRunner
-    # rubocop:disable Metrics/AbcSize
     def run_specs(example_groups)
       actual_count = RSpec.world.example_count
       RSpecTracer.no_examples = actual_count.zero?
@@ -23,18 +22,17 @@ module RSpecTracer
 
       current_count = RSpec.world.example_count
       ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-      elpased = RSpecTracer::TimeFormatter.format_time(ending - starting)
+      elapsed = RSpecTracer::TimeFormatter.format_time(ending - starting)
 
       puts
       puts <<-EXAMPLES.strip.gsub(/\s+/, ' ')
         RSpec tracer is running #{current_count} examples (actual: #{actual_count},
-        skipped: #{actual_count - current_count}) (took #{elpased})
+        skipped: #{actual_count - current_count}) (took #{elapsed})
       EXAMPLES
 
       RSpecTracer.running = true
 
       super(filtered_example_groups)
     end
-    # rubocop:enable Metrics/AbcSize
   end
 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',
@@ -21,8 +22,6 @@ module RSpecTracer
       @reporter = RSpecTracer::Reporter.new
       @filtered_examples = {}
 
-      return if @cache.run_id.nil?
-
       @cache.load_cache_for_run
       filter_examples_to_run
     end
@@ -43,6 +42,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,15 +62,14 @@ module RSpecTracer
       @reporter.on_example_pending(example_id, execution_result)
     end
 
-    def register_deleted_examples
-      @reporter.register_deleted_examples(@cache.all_examples)
+    def register_interrupted_examples
+      @reporter.register_interrupted_examples
     end
 
-    def incorrect_analysis?
-      @reporter.incorrect_analysis?
+    def register_deleted_examples
+      @reporter.register_deleted_examples(@cache.all_examples)
     end
 
-    # rubocop:disable Metrics/AbcSize
     def generate_missed_coverage
       missed_coverage = Hash.new do |files_coverage, file_path|
         files_coverage[file_path] = Hash.new do |strength, line_number|
@@ -77,6 +79,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)
@@ -91,12 +96,14 @@ module RSpecTracer
 
       missed_coverage
     end
-    # rubocop:enable Metrics/AbcSize
 
     def register_dependency(examples_coverage)
       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|
@@ -122,6 +129,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
@@ -131,22 +141,9 @@ module RSpecTracer
       @reporter.register_examples_coverage(examples_coverage)
     end
 
-    def generate_report
-      @reporter.generate_last_run_report
-      generate_examples_status_report
-
-      %i[all_files all_examples dependency examples_coverage reverse_dependency].each do |report_type|
-        starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-
-        send("generate_#{report_type}_report")
-
-        ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-        elpased = RSpecTracer::TimeFormatter.format_time(ending - starting)
-
-        puts "RSpec tracer generated #{report_type.to_s.tr('_', ' ')} report (took #{elpased})" if RSpecTracer.verbose?
-      end
-
-      @reporter.write_reports
+    def non_zero_exit_code?
+      !@reporter.duplicate_examples.empty? &&
+        ENV.fetch('RSPEC_TRACER_FAIL_ON_DUPLICATES', 'true') == 'true'
     end
 
     private
@@ -163,12 +160,13 @@ module RSpecTracer
       filter_by_files_changed
 
       ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-      elpased = RSpecTracer::TimeFormatter.format_time(ending - starting)
+      elapsed = RSpecTracer::TimeFormatter.format_time(ending - starting)
 
-      puts "RSpec tracer processed cache (took #{elpased})" if RSpecTracer.verbose?
+      puts "RSpec tracer processed cache (took #{elapsed})" if RSpecTracer.verbose?
     end
 
     def filter_by_example_status
+      add_previously_interrupted_examples
       add_previously_flaky_examples
       add_previously_failed_examples
       add_previously_pending_examples
@@ -183,10 +181,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)
@@ -199,6 +204,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)
@@ -247,6 +253,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])
@@ -257,6 +266,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)
@@ -264,6 +276,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) }
@@ -273,92 +288,5 @@ module RSpecTracer
 
       true
     end
-
-    def generate_examples_status_report
-      starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-
-      generate_flaky_examples_report
-      generate_failed_examples_report
-      generate_pending_examples_report
-
-      ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-      elpased = RSpecTracer::TimeFormatter.format_time(ending - starting)
-
-      puts "RSpec tracer generated flaky, failed, and pending examples report (took #{elpased})" if RSpecTracer.verbose?
-    end
-
-    def generate_all_files_report
-      @cache.all_files.each_pair do |file_name, data|
-        next if @reporter.all_files.key?(file_name) ||
-          @reporter.file_deleted?(file_name)
-
-        @reporter.all_files[file_name] = data
-      end
-    end
-
-    def generate_all_examples_report
-      @cache.all_examples.each_pair do |example_id, data|
-        next if @reporter.all_examples.key?(example_id) ||
-          @reporter.example_deleted?(example_id)
-
-        @reporter.all_examples[example_id] = data
-      end
-    end
-
-    def generate_flaky_examples_report
-      @reporter.possibly_flaky_examples.each do |example_id|
-        next if @reporter.example_deleted?(example_id)
-        next unless @cache.flaky_examples.include?(example_id) ||
-          @reporter.example_passed?(example_id)
-
-        @reporter.register_flaky_example(example_id)
-      end
-    end
-
-    def generate_failed_examples_report
-      @cache.failed_examples.each do |example_id|
-        next if @reporter.example_deleted?(example_id) ||
-          @reporter.all_examples.key?(example_id)
-
-        @reporter.register_failed_example(example_id)
-      end
-    end
-
-    def generate_pending_examples_report
-      @cache.pending_examples.each do |example_id|
-        next if @reporter.example_deleted?(example_id) ||
-          @reporter.all_examples.key?(example_id)
-
-        @reporter.register_pending_example(example_id)
-      end
-    end
-
-    def generate_dependency_report
-      @cache.dependency.each_pair do |example_id, data|
-        next if @reporter.dependency.key?(example_id) ||
-          @reporter.example_deleted?(example_id)
-
-        @reporter.dependency[example_id] = data.reject do |file_name|
-          @reporter.file_deleted?(file_name)
-        end
-      end
-
-      @reporter.dependency.transform_values!(&:to_a)
-    end
-
-    def generate_examples_coverage_report
-      @cache.cached_examples_coverage.each_pair do |example_id, data|
-        next if @reporter.examples_coverage.key?(example_id) ||
-          @reporter.example_deleted?(example_id)
-
-        @reporter.examples_coverage[example_id] = data.reject do |file_name|
-          @reporter.file_deleted?(file_name)
-        end
-      end
-    end
-
-    def generate_reverse_dependency_report
-      @reporter.generate_reverse_dependency_report
-    end
   end
 end

data/lib/rspec_tracer/version.rb

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