rspec-tracer 0.3.0 → 0.6.1

data/lib/rspec_tracer/rspec_runner.rb

@@ -2,24 +2,29 @@
 
 module RSpecTracer
   module RSpecRunner
+    # rubocop:disable Metrics/AbcSize
     def run_specs(_example_groups)
       actual_count = RSpec.world.example_count
+      starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
       filtered_examples, example_groups = RSpecTracer.filter_examples
 
       RSpec.world.instance_variable_set(:@filtered_examples, filtered_examples)
       RSpec.world.instance_variable_set(:@example_groups, example_groups)
 
       current_count = RSpec.world.example_count
+      ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      elpased = 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})
+        skipped: #{actual_count - current_count}) (took #{elpased})
       EXAMPLES
 
       RSpecTracer.running = true
 
       super(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',
+      flaky_example: 'Flaky example',
       failed_example: 'Failed previously',
       pending_example: 'Pending previously',
       files_changed: 'Files changed'
@@ -20,6 +21,8 @@ module RSpecTracer
       @reporter = RSpecTracer::Reporter.new
       @filtered_examples = {}
 
+      return if @cache.run_id.nil?
+
       @cache.load_cache_for_run
       filter_examples_to_run
     end
@@ -127,15 +130,19 @@ module RSpecTracer
 
     def generate_report
       @reporter.generate_last_run_report
+      generate_examples_status_report
 
-      generate_failed_examples_report
-      generate_pending_examples_report
+      %i[all_files all_examples dependency examples_coverage reverse_dependency].each do |report_type|
+        starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
 
-      %i[all_files all_examples dependency examples_coverage].each do |report_type|
         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.generate_reverse_dependency_report
       @reporter.write_reports
     end
 
@@ -146,54 +153,74 @@ module RSpecTracer
     end
 
     def filter_examples_to_run
-      add_previously_failed_examples
-      add_previously_pending_examples
+      starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      @changed_files = fetch_changed_files
+
+      filter_by_example_status
       filter_by_files_changed
-    end
 
-    def add_previously_failed_examples
-      @cache.failed_examples.each do |example_id|
-        @filtered_examples[example_id] = EXAMPLE_RUN_REASON[:failed_example]
-      end
+      ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      elpased = RSpecTracer::TimeFormatter.format_time(ending - starting)
+
+      puts "RSpec tracer processed cache (took #{elpased})" if RSpecTracer.verbose?
     end
 
-    def add_previously_pending_examples
-      @cache.pending_examples.each do |example_id|
-        @filtered_examples[example_id] = EXAMPLE_RUN_REASON[:pending_example]
-      end
+    def filter_by_example_status
+      add_previously_flaky_examples
+      add_previously_failed_examples
+      add_previously_pending_examples
     end
 
     def filter_by_files_changed
       @cache.dependency.each_pair do |example_id, files|
         next if @filtered_examples.key?(example_id)
+        next if (@changed_files & files).empty?
 
-        files.each do |file_name|
-          break if filtered_by_file_changed?(example_id, file_name)
-        end
+        @filtered_examples[example_id] = EXAMPLE_RUN_REASON[:files_changed]
       end
     end
 
-    def filtered_by_file_changed?(example_id, file_name)
-      if @reporter.file_changed?(file_name)
-        @filtered_examples[example_id] = EXAMPLE_RUN_REASON[:files_changed]
+    def add_previously_flaky_examples
+      @cache.flaky_examples.each do |example_id|
+        @filtered_examples[example_id] = EXAMPLE_RUN_REASON[:flaky_example]
 
-        return true
+        next unless (@changed_files & @cache.dependency[example_id]).empty?
+
+        @reporter.register_possibly_flaky_example(example_id)
       end
+    end
 
-      source_file = registered_source_file(file_name)
+    def add_previously_failed_examples
+      @cache.failed_examples.each do |example_id|
+        next if @filtered_examples.key?(example_id)
+
+        @filtered_examples[example_id] = EXAMPLE_RUN_REASON[:failed_example]
 
-      return false if source_file &&
-        @cache.all_files[file_name][:digest] == source_file[:digest]
+        next unless (@changed_files & @cache.dependency[example_id]).empty?
+
+        @reporter.register_possibly_flaky_example(example_id)
+      end
+    end
+
+    def add_previously_pending_examples
+      @cache.pending_examples.each do |example_id|
+        @filtered_examples[example_id] = EXAMPLE_RUN_REASON[:pending_example]
+      end
+    end
 
-      @filtered_examples[example_id] = EXAMPLE_RUN_REASON[:files_changed]
+    def fetch_changed_files
+      @cache.all_files.each_value do |cached_file|
+        file_name = cached_file[:file_name]
+        source_file = RSpecTracer::SourceFile.from_name(file_name)
 
-      if source_file.nil?
-        @reporter.on_file_deleted(file_name)
-      else
-        @reporter.on_file_modified(file_name)
+        if source_file.nil?
+          @reporter.on_file_deleted(file_name)
+        elsif cached_file[:digest] != source_file[:digest]
+          @reporter.on_file_modified(file_name)
+        end
       end
 
-      true
+      @reporter.modified_files | @reporter.deleted_files
     end
 
     def generate_untraced_files(trace_point_files)
@@ -227,14 +254,23 @@ module RSpecTracer
     end
 
     def register_example_file_dependency(example_id, file_name)
-      source_file = registered_source_file(file_name)
+      source_file = RSpecTracer::SourceFile.from_name(file_name)
 
       @reporter.register_source_file(source_file)
       @reporter.register_dependency(example_id, file_name)
     end
 
-    def registered_source_file(file_name)
-      @reporter.all_files[file_name] || RSpecTracer::SourceFile.from_name(file_name)
+    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
@@ -255,6 +291,16 @@ module RSpecTracer
       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) ||
@@ -296,5 +342,9 @@ module RSpecTracer
         end
       end
     end
+
+    def generate_reverse_dependency_report
+      @reporter.generate_reverse_dependency_report
+    end
   end
 end

data/lib/rspec_tracer/time_formatter.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module RSpecTracer
+  module TimeFormatter
+    DEFAULT_PRECISION = 2
+    SECONDS_PRECISION = 5
+
+    UNITS = {
+      second: 60,
+      minute: 60,
+      hour: 24,
+      day: Float::INFINITY
+    }.freeze
+
+    module_function
+
+    def format_time(seconds)
+      return pluralize(format_duration(seconds), 'second') if seconds < 60
+
+      formatted_duration = UNITS.each_pair.with_object([]) do |(unit, count), duration|
+        next unless seconds.positive?
+
+        seconds, remainder = seconds.divmod(count)
+
+        next if remainder.zero?
+
+        duration << pluralize(format_duration(remainder), unit)
+      end
+
+      formatted_duration.reverse.join(' ')
+    end
+
+    def format_duration(duration)
+      return 0 if duration.negative?
+
+      precision = duration < 1 ? SECONDS_PRECISION : DEFAULT_PRECISION
+
+      strip_trailing_zeroes(format("%<duration>0.#{precision}f", duration: duration))
+    end
+
+    def strip_trailing_zeroes(formatted_duration)
+      formatted_duration.sub(/(?:(\..*[^0])0+|\.0+)$/, '\1')
+    end
+
+    def pluralize(duration, unit)
+      if (duration.to_f - 1).abs < Float::EPSILON
+        "#{duration} #{unit}"
+      else
+        "#{duration} #{unit}s"
+      end
+    end
+
+    private_class_method :format_duration, :strip_trailing_zeroes, :pluralize
+  end
+end

data/lib/rspec_tracer/version.rb

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

data/lib/rspec_tracer.rb

@@ -17,11 +17,13 @@ require_relative 'rspec_tracer/coverage_reporter'
 require_relative 'rspec_tracer/defaults'
 require_relative 'rspec_tracer/example'
 require_relative 'rspec_tracer/html_reporter/reporter'
+require_relative 'rspec_tracer/remote_cache/cache'
 require_relative 'rspec_tracer/rspec_reporter'
 require_relative 'rspec_tracer/rspec_runner'
 require_relative 'rspec_tracer/ruby_coverage'
 require_relative 'rspec_tracer/runner'
 require_relative 'rspec_tracer/source_file'
+require_relative 'rspec_tracer/time_formatter'
 require_relative 'rspec_tracer/version'
 
 module RSpecTracer
@@ -183,22 +185,36 @@ module RSpecTracer
     def generate_reports
       puts 'RSpec tracer is generating reports'
 
-      generate_tracer_reports
-      generate_coverage_reports
+      process_dependency
+      process_coverage
       runner.generate_report
       RSpecTracer::HTMLReporter::Reporter.new.generate_report
     end
 
-    def generate_tracer_reports
+    def process_dependency
+      starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
       runner.register_deleted_examples
       runner.register_dependency(coverage_reporter.examples_coverage)
       runner.register_untraced_dependency(@traced_files)
+
+      ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      elpased = RSpecTracer::TimeFormatter.format_time(ending - starting)
+
+      puts "RSpec tracer processed dependency (took #{elpased})" if RSpecTracer.verbose?
     end
 
-    def generate_coverage_reports
+    def process_coverage
+      starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
       coverage_reporter.generate_final_examples_coverage
       coverage_reporter.merge_coverage(runner.generate_missed_coverage)
       runner.register_examples_coverage(coverage_reporter.examples_coverage)
+
+      ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      elpased = RSpecTracer::TimeFormatter.format_time(ending - starting)
+
+      puts "RSpec tracer processed coverage (took #{elpased})" if RSpecTracer.verbose?
     end
 
     def run_simplecov_exit_task
@@ -212,12 +228,18 @@ module RSpecTracer
     end
 
     def run_coverage_exit_task
+      starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
       coverage_reporter.generate_final_coverage
 
       file_name = File.join(RSpecTracer.coverage_path, 'coverage.json')
 
       write_coverage_report(file_name)
-      print_coverage_stats(file_name)
+
+      ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      elpased = RSpecTracer::TimeFormatter.format_time(ending - starting)
+
+      print_coverage_stats(file_name, elpased)
     end
 
     def write_coverage_report(file_name)
@@ -228,15 +250,16 @@ module RSpecTracer
         }
       }
 
-      File.write(file_name, JSON.pretty_generate(report))
+      File.write(file_name, JSON.generate(report))
     end
 
-    def print_coverage_stats(file_name)
+    def print_coverage_stats(file_name, elpased)
       stat = coverage_reporter.coverage_stat
 
       puts <<-REPORT.strip.gsub(/\s+/, ' ')
         Coverage report generated for RSpecTracer to #{file_name}. #{stat[:covered_lines]}
         / #{stat[:total_lines]} LOC (#{stat[:covered_percent]}%) covered
+        (took #{elpased})
       REPORT
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-tracer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Abhimanyu Singh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-30 00:00:00.000000000 Z
+date: 2021-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docile
@@ -90,20 +90,24 @@ files:
 - 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
+- lib/rspec_tracer/html_reporter/views/flaky_examples.erb
 - lib/rspec_tracer/html_reporter/views/layout.erb
+- lib/rspec_tracer/remote_cache/cache.rb
+- lib/rspec_tracer/remote_cache/git.rb
 - lib/rspec_tracer/reporter.rb
 - lib/rspec_tracer/rspec_reporter.rb
 - lib/rspec_tracer/rspec_runner.rb
 - lib/rspec_tracer/ruby_coverage.rb
 - lib/rspec_tracer/runner.rb
 - lib/rspec_tracer/source_file.rb
+- lib/rspec_tracer/time_formatter.rb
 - lib/rspec_tracer/version.rb
 homepage: https://github.com/avmnu-sng/rspec-tracer
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/avmnu-sng/rspec-tracer
-  source_code_uri: https://github.com/avmnu-sng/rspec-tracer/tree/v0.3.0
+  source_code_uri: https://github.com/avmnu-sng/rspec-tracer/tree/v0.6.1
   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: