[Fix #39] Handle Interrupts (#40)

RSpec tracer does not corrupt cache on interrupts.

Author: avmnu-sng

lib/rspec_tracer.rb

@@ -196,6 +196,7 @@ def generate_reports
     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)

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 @@ def initialize
       @cached = false
 
       @all_examples = {}
+      @interrupted_examples = Set.new
       @flaky_examples = Set.new
       @failed_examples = Set.new
       @pending_examples = Set.new
@@ -74,7 +75,11 @@ def load_all_examples_cache
       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

lib/rspec_tracer/html_reporter/reporter.rb

@@ -60,7 +60,19 @@ def format_examples
             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])
           }
@@ -176,7 +188,7 @@ def template(name)
 
       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 +201,7 @@ def example_result_css_class(example_result)
         case example_result
         when 'Passed'
           'green'
-        when 'Failed'
+        when 'Failed', 'Interrupted'
           'red'
         when 'Pending'
           'yellow'

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, :possibly_flaky_examples,
+                :flaky_examples, :pending_examples, :all_files, :modified_files,
+                :deleted_files, :dependency, :reverse_dependency, :examples_coverage,
+                :last_run
 
     def initialize
       initialize_examples
@@ -37,8 +38,21 @@ def on_example_pending(example_id, result)
       @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 +77,10 @@ def register_pending_example(example_id)
       @pending_examples << 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
@@ -128,6 +146,8 @@ def register_examples_coverage(examples_coverage)
 
     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|
@@ -145,9 +165,11 @@ def generate_last_run_report
         pid: RSpecTracer.pid,
         actual_count: RSpec.world.example_count + @skipped_examples.count,
         example_count: RSpec.world.example_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
 
@@ -182,6 +204,7 @@ def write_reports
     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

lib/rspec_tracer/runner.rb

@@ -8,6 +8,7 @@ class Runner
     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',
@@ -59,6 +60,10 @@ def on_example_pending(example_id, execution_result)
       @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
@@ -77,6 +82,7 @@ def generate_missed_coverage
 
       @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 unless @reporter.example_skipped?(example_id)
 
           file_name = RSpecTracer::SourceFile.file_name(file_path)
@@ -97,6 +103,8 @@ 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)
+
         register_example_files_dependency(example_id)
 
         example_coverage.each_key do |file_path|
@@ -122,6 +130,8 @@ def register_untraced_dependency(trace_point_files)
         @reporter.register_source_file(source_file)
 
         @reporter.all_examples.each_key do |example_id|
+          next if @reporter.example_interrupted?(example_id)
+
           @reporter.register_dependency(example_id, source_file[:file_name])
         end
       end
@@ -169,6 +179,7 @@ def filter_examples_to_run
     end
 
     def filter_by_example_status
+      add_previously_interrupted_examples
       add_previously_flaky_examples
       add_previously_failed_examples
       add_previously_pending_examples
@@ -183,6 +194,12 @@ def filter_by_files_changed
       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]
@@ -249,6 +266,8 @@ def fetch_rspec_required_files
     end
 
     def register_example_files_dependency(example_id)
+      return if @reporter.example_interrupted?(example_id)
+
       example = @reporter.all_examples[example_id]
 
       register_example_file_dependency(example_id, example[:file_name])
@@ -259,13 +278,17 @@ def register_example_files_dependency(example_id)
     end
 
     def register_example_file_dependency(example_id, file_name)
+      return if @reporter.example_interrupted?(example_id)
+
       source_file = RSpecTracer::SourceFile.from_name(file_name)
 
       @reporter.register_source_file(source_file)
       @reporter.register_dependency(example_id, file_name)
     end
 
     def register_file_dependency(example_id, file_path)
+      return if @reporter.example_interrupted?(example_id)
+
       source_file = RSpecTracer::SourceFile.from_path(file_path)
 
       return false if RSpecTracer.filters.any? { |filter| filter.match?(source_file) }