rspec-tracer 0.6.0 → 0.8.0

data/lib/rspec_tracer/remote_cache/repo.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+module RSpecTracer
+  module RemoteCache
+    class Repo
+      class RepoError < StandardError; end
+
+      attr_reader :branch_name, :branch_ref, :branch_refs, :ancestry_refs, :cache_refs
+
+      def initialize(aws)
+        @aws = aws
+        @branch_name = ENV['GIT_BRANCH'].chomp
+
+        raise RepoError, 'GIT_BRANCH environment variable is not set' if @branch_name.nil?
+
+        fetch_head_ref
+        fetch_branch_ref
+        fetch_ancestry_refs
+        fetch_branch_refs
+        generate_cache_refs
+      end
+
+      private
+
+      def fetch_head_ref
+        @head_ref = `git rev-parse HEAD`.chomp
+
+        raise RepoError, 'Could not find HEAD commit sha' unless $CHILD_STATUS.success?
+      end
+
+      def fetch_branch_ref
+        @merged_parents = []
+        @ignored_refs = []
+
+        unless merged?
+          @branch_ref = @head_ref
+
+          return
+        end
+
+        @ignored_refs << @head_ref
+
+        fetch_merged_parents
+        fetch_merged_branch_ref
+      end
+
+      def fetch_ancestry_refs
+        ref_list = `git rev-list --max-count=25 #{@branch_ref}`.chomp.split
+
+        raise RepoError, 'Could not find ancestry refs' unless $CHILD_STATUS.success?
+
+        ref_list = ref_list.to_set - @ignored_refs
+        @ancestry_refs = refs_committer_timestamp(ref_list.to_a)
+
+        return if @ancestry_refs.empty?
+
+        print_refs(@ancestry_refs, 'ancestry')
+      end
+
+      def fetch_branch_refs
+        unless @aws.branch_refs?(@branch_name)
+          puts "No branch refs for #{@branch_name} branch found in S3"
+
+          @branch_refs = {}
+
+          return
+        end
+
+        download_branch_refs
+      end
+
+      def generate_cache_refs
+        ref_list = @ancestry_refs.merge(@branch_refs)
+
+        if ref_list.empty?
+          @cache_refs = {}
+
+          return
+        end
+
+        @cache_refs = ref_list.sort_by { |_, timestamp| -timestamp }.to_h
+
+        print_refs(@cache_refs, 'cache')
+      end
+
+      def merged?
+        system('git', 'rev-parse', 'HEAD^2', out: File::NULL, err: File::NULL)
+      end
+
+      def fetch_merged_parents
+        first_parent = `git rev-parse HEAD^1`.chomp
+        @merged_parents << first_parent if $CHILD_STATUS.success?
+
+        second_parent = `git rev-parse HEAD^2`.chomp
+        @merged_parents << second_parent if $CHILD_STATUS.success?
+
+        raise RepoError, 'Could not find merged commit parents' if @merged_parents.length != 2
+      end
+
+      def fetch_merged_branch_ref
+        @origin_head_ref = `git rev-parse origin/HEAD`.chomp
+        @branch_ref = nil
+
+        if @merged_parents.first != @origin_head_ref
+          @branch_ref = @head_ref
+          @ignored_refs = []
+
+          return
+        end
+
+        @branch_ref = @merged_parents.last
+        @ignored_refs = @ignored_refs.to_set | `git rev-list #{@branch_ref}..origin/HEAD`.chomp.split
+
+        raise RepoError, 'Could not find ignored refs' unless $CHILD_STATUS.success?
+      end
+
+      def refs_committer_timestamp(ref_list)
+        return {} if ref_list.empty?
+
+        command = <<-COMMAND.strip.gsub(/\s+/, ' ')
+          git show
+            --no-patch
+            --format="%H %ct"
+            #{ref_list.join(' ')}
+        COMMAND
+
+        ref_list = `#{command}`.chomp
+
+        raise RepoError, 'Could not find ancestry refs' unless $CHILD_STATUS.success?
+
+        ref_list.split("\n").map(&:split).to_h.transform_values(&:to_i)
+      end
+
+      def download_branch_refs
+        file_name = File.join(RSpecTracer.cache_path, 'branch_refs.json')
+
+        if @aws.download_branch_refs(branch_name, file_name)
+          @branch_refs = JSON.parse(File.read(file_name)).transform_values(&:to_i)
+
+          return if @branch_refs.empty?
+
+          filter_branch_refs
+          print_refs(@branch_refs, 'branch')
+        else
+          @branch_refs = {}
+
+          File.rm_f(file_name)
+
+          puts "Failed to fetch branch refs for #{@branch_name} branch"
+        end
+      end
+
+      def filter_branch_refs
+        if @ancestry_refs.empty?
+          @branch_refs = @branch_refs.sort_by { |_, timestamp| -timestamp }.first(25).to_h
+
+          return
+        end
+
+        oldest_ancestry_time = @ancestry_refs.values.min
+
+        @branch_refs = @branch_refs
+          .select { |_, timestamp| timestamp >= oldest_ancestry_time }
+          .sort_by { |_, timestamp| -timestamp }
+          .first(25)
+          .to_h
+      end
+
+      def print_refs(refs, type)
+        puts "Fetched the following #{type} refs for #{@branch_name} branch:"
+        puts refs.map { |ref, timestamp| "  * #{ref} (commit timestamp: #{timestamp})" }.join("\n")
+      end
+    end
+  end
+end

data/lib/rspec_tracer/remote_cache/validator.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module RSpecTracer
+  module RemoteCache
+    class Validator
+      CACHE_FILES_PER_TEST_SUITE = 8
+
+      def initialize
+        @test_suite_id = ENV['TEST_SUITE_ID']
+        @test_suites = ENV['TEST_SUITES']
+
+        if @test_suite_id.nil? ^ @test_suites.nil?
+          raise(
+            ValidationError,
+            'Both the enviornment variables TEST_SUITE_ID and TEST_SUITES are not set'
+          )
+        end
+
+        setup
+      end
+
+      def valid?(ref, cache_files)
+        last_run_regex = Regexp.new(format(@last_run_files_regex, ref: ref))
+
+        return false if cache_files.count { |file| file.match?(last_run_regex) } != @last_run_files_count
+
+        cache_regex = Regexp.new(format(@cached_files_regex, ref: ref))
+
+        cache_files.count { |file| file.match?(cache_regex) } == @cached_files_count
+      end
+
+      private
+
+      def setup
+        if @test_suites.nil?
+          @last_run_files_count = 1
+          @last_run_files_regex = '/%<ref>s/last_run.json$'
+          @cached_files_count = CACHE_FILES_PER_TEST_SUITE
+          @cached_files_regex = '/%<ref>s/[0-9a-f]{32}/.+.json'
+        else
+          @test_suites = @test_suites.to_i
+          @test_suites_regex = (1..@test_suites).to_a.join('|')
+
+          @last_run_files_count = @test_suites
+          @last_run_files_regex = "/%<ref>s/(#{@test_suites_regex})/last_run.json$"
+          @cached_files_count = CACHE_FILES_PER_TEST_SUITE * @test_suites
+          @cached_files_regex = "/%<ref>s/(#{@test_suites_regex})/[0-9a-f]{32}/.+.json$"
+        end
+      end
+    end
+  end
+end

data/lib/rspec_tracer/reporter.rb

@@ -229,56 +229,56 @@ module RSpecTracer
     def write_all_examples_report
       file_name = File.join(@cache_dir, 'all_examples.json')
 
-      File.write(file_name, JSON.generate(@all_examples))
+      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.generate(@flaky_examples.to_a))
+      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.generate(@failed_examples.to_a))
+      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.generate(@pending_examples.to_a))
+      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.generate(@all_files))
+      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.generate(@dependency))
+      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.generate(@reverse_dependency))
+      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.generate(@examples_coverage))
+      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.generate(last_run_data))
+      File.write(file_name, JSON.pretty_generate(last_run_data))
     end
   end
 end

data/lib/rspec_tracer/runner.rb

@@ -90,16 +90,15 @@ module RSpecTracer
     # rubocop:enable Metrics/AbcSize
 
     def register_dependency(examples_coverage)
+      filtered_files = Set.new
+
       examples_coverage.each_pair do |example_id, example_coverage|
         register_example_files_dependency(example_id)
 
         example_coverage.each_key do |file_path|
-          source_file = RSpecTracer::SourceFile.from_path(file_path)
-
-          next if RSpecTracer.filters.any? { |filter| filter.match?(source_file) }
+          next if filtered_files.include?(file_path)
 
-          @reporter.register_source_file(source_file)
-          @reporter.register_dependency(example_id, source_file[:file_name])
+          filtered_files << file_path unless register_file_dependency(example_id, file_path)
         end
       end
 
@@ -140,7 +139,7 @@ module RSpecTracer
         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})"
+        puts "RSpec tracer generated #{report_type.to_s.tr('_', ' ')} report (took #{elpased})" if RSpecTracer.verbose?
       end
 
       @reporter.write_reports
@@ -162,7 +161,7 @@ module RSpecTracer
       ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
       elpased = RSpecTracer::TimeFormatter.format_time(ending - starting)
 
-      puts "RSpec tracer processed cache (took #{elpased})"
+      puts "RSpec tracer processed cache (took #{elpased})" if RSpecTracer.verbose?
     end
 
     def filter_by_example_status
@@ -260,6 +259,17 @@ module RSpecTracer
       @reporter.register_dependency(example_id, file_name)
     end
 
+    def register_file_dependency(example_id, file_path)
+      source_file = RSpecTracer::SourceFile.from_path(file_path)
+
+      return false if RSpecTracer.filters.any? { |filter| filter.match?(source_file) }
+
+      @reporter.register_source_file(source_file)
+      @reporter.register_dependency(example_id, source_file[:file_name])
+
+      true
+    end
+
     def generate_examples_status_report
       starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
 
@@ -270,7 +280,7 @@ module RSpecTracer
       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})"
+      puts "RSpec tracer generated flaky, failed, and pending examples report (took #{elpased})" if RSpecTracer.verbose?
     end
 
     def generate_all_files_report

data/lib/rspec_tracer/time_formatter.rb

@@ -21,11 +21,10 @@ module RSpecTracer
         next unless seconds.positive?
 
         seconds, remainder = seconds.divmod(count)
-        remainder = format_duration(remainder)
 
         next if remainder.zero?
 
-        duration << pluralize(remainder, unit)
+        duration << pluralize(format_duration(remainder), unit)
       end
 
       formatted_duration.reverse.join(' ')
@@ -36,17 +35,21 @@ module RSpecTracer
 
       precision = duration < 1 ? SECONDS_PRECISION : DEFAULT_PRECISION
 
-      format("%<duration>0.#{precision}f", duration: duration)
+      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 == 1
+      if (duration.to_f - 1).abs < Float::EPSILON
         "#{duration} #{unit}"
       else
         "#{duration} #{unit}s"
       end
     end
 
-    private_class_method :format_duration, :pluralize
+    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.6.0'
+  VERSION = '0.8.0'
 end

data/lib/rspec_tracer.rb

@@ -201,7 +201,7 @@ module RSpecTracer
       ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
       elpased = RSpecTracer::TimeFormatter.format_time(ending - starting)
 
-      puts "RSpec tracer processed dependency (took #{elpased})"
+      puts "RSpec tracer processed dependency (took #{elpased})" if RSpecTracer.verbose?
     end
 
     def process_coverage
@@ -214,7 +214,7 @@ module RSpecTracer
       ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
       elpased = RSpecTracer::TimeFormatter.format_time(ending - starting)
 
-      puts "RSpec tracer processed coverage (took #{elpased})"
+      puts "RSpec tracer processed coverage (took #{elpased})" if RSpecTracer.verbose?
     end
 
     def run_simplecov_exit_task
@@ -250,7 +250,7 @@ module RSpecTracer
         }
       }
 
-      File.write(file_name, JSON.generate(report))
+      File.write(file_name, JSON.pretty_generate(report))
     end
 
     def print_coverage_stats(file_name, elpased)

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: rspec-tracer
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Abhimanyu Singh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-05 00:00:00.000000000 Z
+date: 2021-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docile
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.6.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.6.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
+    - - ">="
+      - !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.
@@ -69,6 +69,7 @@ files:
 - lib/rspec_tracer/defaults.rb
 - lib/rspec_tracer/example.rb
 - lib/rspec_tracer/filter.rb
+- lib/rspec_tracer/html_reporter/Rakefile
 - lib/rspec_tracer/html_reporter/assets/javascripts/application.js
 - lib/rspec_tracer/html_reporter/assets/javascripts/libraries/jquery.js
 - lib/rspec_tracer/html_reporter/assets/javascripts/plugins/datatables.js
@@ -92,8 +93,11 @@ files:
 - 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/Rakefile
+- lib/rspec_tracer/remote_cache/aws.rb
 - lib/rspec_tracer/remote_cache/cache.rb
-- lib/rspec_tracer/remote_cache/git.rb
+- lib/rspec_tracer/remote_cache/repo.rb
+- lib/rspec_tracer/remote_cache/validator.rb
 - lib/rspec_tracer/reporter.rb
 - lib/rspec_tracer/rspec_reporter.rb
 - lib/rspec_tracer/rspec_runner.rb
@@ -107,7 +111,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.6.0
+  source_code_uri: https://github.com/avmnu-sng/rspec-tracer/tree/v0.8.0
   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:
@@ -125,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+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