rspec-tracer 1.2.2 → 2.0.0.pre.1

data/lib/rspec_tracer/remote_cache/cache.rb

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'aws'
-require_relative 'repo'
-require_relative 'validator'
-
-module RSpecTracer
-  module RemoteCache
-    class Cache
-      class CacheError < StandardError; end
-
-      def initialize
-        @aws = RSpecTracer::RemoteCache::Aws.new
-        @repo = RSpecTracer::RemoteCache::Repo.new(@aws)
-      end
-
-      def download
-        return unless cache_ref?
-
-        @aws.download_file(@cache_sha, 'last_run.json')
-        @aws.download_dir(@cache_sha, last_run_id)
-      end
-
-      def upload
-        @aws.upload_file(@repo.branch_ref, 'last_run.json')
-        @aws.upload_dir(@repo.branch_ref, last_run_id)
-
-        file_name = File.join(RSpecTracer.cache_path, 'branch_refs.json')
-
-        write_branch_refs(file_name)
-        @aws.upload_branch_refs(@repo.branch_name, file_name)
-      end
-
-      private
-
-      def cache_ref?
-        cache_validator = RSpecTracer::RemoteCache::Validator.new
-
-        @cache_sha = @repo.cache_refs.each_key.detect do |ref|
-          RSpecTracer.logger.debug "Validating ref #{ref}"
-
-          cache_validator.valid?(ref, @aws.cache_files_list(ref))
-        end
-
-        if @cache_sha.nil?
-          RSpecTracer.logger.warn 'Could not find a suitable cache sha to download'
-
-          return false
-        end
-
-        true
-      end
-
-      def write_branch_refs(file_name)
-        branch_ref_time = `git show --no-patch --format="%ct" #{@repo.branch_ref}`.chomp
-
-        unless $CHILD_STATUS.success?
-          RSpecTracer.logger.warn "Failed to find object #{@repo.branch_ref} commit timestamp"
-        end
-
-        ref_list = @repo.branch_refs.merge(@repo.branch_ref => branch_ref_time.to_i)
-
-        File.write(file_name, JSON.pretty_generate(ref_list), encoding: 'UTF-8')
-      end
-
-      def last_run_id
-        file_name = File.join(RSpecTracer.cache_path, 'last_run.json')
-
-        raise CacheError, 'Could not find any local cache to upload' unless File.file?(file_name)
-
-        JSON.parse(File.read(file_name, encoding: 'UTF-8'))['run_id']
-      end
-    end
-  end
-end

data/lib/rspec_tracer/remote_cache/repo.rb

@@ -1,210 +0,0 @@
-# frozen_string_literal: true
-
-module RSpecTracer
-  module RemoteCache
-    class Repo
-      class RepoError < StandardError; end
-
-      attr_reader :default_branch_name, :branch_name, :branch_ref, :branch_refs, :ancestry_refs, :cache_refs
-
-      def initialize(aws)
-        raise RepoError, 'GIT_DEFAULT_BRANCH environment variable is not set' if ENV['GIT_DEFAULT_BRANCH'].nil?
-        raise RepoError, 'GIT_BRANCH environment variable is not set' if ENV['GIT_BRANCH'].nil?
-
-        @aws = aws
-        @default_branch_name = ENV['GIT_DEFAULT_BRANCH'].chomp
-        @branch_name = ENV['GIT_BRANCH'].chomp
-
-        merge_base_branch
-        fetch_head_ref
-        fetch_branch_ref
-        fetch_ancestry_refs
-        fetch_branch_refs
-        generate_cache_refs
-      end
-
-      private
-
-      def merge_base_branch
-        return if @default_branch_name == @branch_name
-
-        pull_remote_branch if current_branch != @branch_name
-
-        merge_default_branch
-      end
-
-      def current_branch
-        branch = `git rev-parse --abbrev-ref HEAD`.chomp
-
-        return branch if $CHILD_STATUS.success?
-
-        raise RepoError, 'Could not determine current branch'
-      end
-
-      def pull_remote_branch
-        return if system(
-          'git',
-          'fetch',
-          'origin',
-          "#{@branch_name}:#{@branch_name}",
-          out: File::NULL,
-          err: File::NULL
-        ) && system(
-          'git',
-          'checkout',
-          @branch_name,
-          out: File::NULL,
-          err: File::NULL
-        )
-
-        raise RepoError, "Could not pull remote branch #{@branch_name}"
-      end
-
-      def merge_default_branch
-        return if system(
-          'git',
-          'merge',
-          "origin/#{@default_branch_name}",
-          '--no-edit',
-          '--no-ff',
-          out: File::NULL,
-          err: File::NULL
-        )
-
-        raise RepoError, "Could not merge #{@default_branch_name} into #{@branch_name}"
-      end
-
-      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
-        if merged?
-          fetch_merged_parents
-
-          @branch_ref = @merged_parents.first
-          @ignored_refs = [@head_ref]
-        else
-          @branch_ref = @head_ref
-          @ignored_refs = []
-        end
-      end
-
-      def merged?
-        system('git', 'rev-parse', 'HEAD^2', out: File::NULL, err: File::NULL)
-      end
-
-      def fetch_merged_parents
-        @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 merge commit parents' if @merged_parents.length != 2
-      end
-
-      def fetch_ancestry_refs
-        ref_list = Set.new
-        ref_list |= `git rev-list --max-count=25 #{@branch_ref}..origin/HEAD`.chomp.split if merged?
-        ref_list |= `git rev-list --max-count=25 #{@branch_ref}`.chomp.split
-
-        raise RepoError, 'Could not find ancestry refs' unless $CHILD_STATUS.success?
-
-        @ancestry_refs = refs_committer_timestamp(ref_list - @ignored_refs)
-
-        return if @ancestry_refs.empty?
-
-        print_refs(@ancestry_refs, 'ancestry')
-      end
-
-      def fetch_branch_refs
-        unless @aws.branch_refs?(@branch_name)
-          RSpecTracer.logger.warn "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 refs_committer_timestamp(ref_list)
-        return {} if ref_list.empty?
-
-        command = <<-COMMAND.strip.gsub(/\s+/, ' ')
-          git show
-            --no-patch
-            --format="%H %ct"
-            #{ref_list.to_a.join(' ')}
-        COMMAND
-
-        ref_timestamp = `#{command}`.chomp
-
-        raise RepoError, 'Could not find ancestry refs' unless $CHILD_STATUS.success?
-
-        ref_timestamp.split("\n").to_h(&:split).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, encoding: 'UTF-8')).transform_values(&:to_i)
-
-          return if @branch_refs.empty?
-
-          filter_branch_refs
-          print_refs(@branch_refs, 'branch')
-        else
-          @branch_refs = {}
-
-          FileUtils.rm_f(file_name)
-
-          RSpecTracer.logger.error "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)
-        refs_list = refs.map { |ref, timestamp| "  * #{ref} (commit timestamp: #{timestamp})" }.join("\n")
-
-        RSpecTracer.logger.debug "Fetched the following #{type} refs for #{@branch_name} branch:\n#{refs_list}"
-      end
-    end
-  end
-end

data/lib/rspec_tracer/report_generator.rb

@@ -1,158 +0,0 @@
-# frozen_string_literal: true
-
-module RSpecTracer
-  class ReportGenerator
-    def initialize(reporter, cache)
-      @reporter = reporter
-      @cache = cache
-    end
-
-    def reverse_dependency_report
-      reverse_dependency = Hash.new do |examples, file_name|
-        examples[file_name] = {
-          example_count: 0,
-          examples: Hash.new(0)
-        }
-      end
-
-      @reporter.dependency.each_pair do |example_id, files|
-        next if @reporter.interrupted_examples.include?(example_id)
-
-        example_file = @reporter.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
-
-      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
-
-      reverse_dependency.sort_by { |file_name, data| [-data[:example_count], file_name] }.to_h
-    end
-
-    def generate_report
-      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)
-        elapsed = RSpecTracer::TimeFormatter.format_time(ending - starting)
-
-        RSpecTracer.logger.debug "RSpec tracer generated #{report_type.to_s.tr('_', ' ')} report (took #{elapsed})"
-      end
-    end
-
-    private
-
-    def generate_last_run_report
-      @reporter.last_run = {
-        pid: RSpecTracer.pid,
-        actual_count: RSpec.world.example_count + @reporter.skipped_examples.count,
-        example_count: RSpec.world.example_count,
-        duplicate_examples: @reporter.duplicate_examples.sum { |_, examples| examples.count },
-        interrupted_examples: @reporter.interrupted_examples.count,
-        failed_examples: @reporter.failed_examples.count,
-        skipped_examples: @reporter.skipped_examples.count,
-        pending_examples: @reporter.pending_examples.count,
-        flaky_examples: @reporter.flaky_examples.count
-      }
-    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)
-      elapsed = RSpecTracer::TimeFormatter.format_time(ending - starting)
-
-      RSpecTracer.logger.debug "RSpec tracer generated flaky, failed, and pending examples report (took #{elapsed})"
-    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_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_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.reverse_dependency = reverse_dependency_report
-    end
-  end
-end

data/lib/rspec_tracer/report_merger.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-module RSpecTracer
-  class ReportMerger
-    attr_reader :all_examples, :duplicate_examples, :interrupted_examples,
-                :flaky_examples, :failed_examples, :pending_examples, :skipped_examples,
-                :all_files, :dependency, :reverse_dependency, :examples_coverage, :last_run
-
-    def initialize
-      @last_run = {}
-      @all_examples = {}
-      @duplicate_examples = {}
-      @interrupted_examples = Set.new
-      @flaky_examples = Set.new
-      @failed_examples = Set.new
-      @pending_examples = Set.new
-      @skipped_examples = Set.new
-      @all_files = {}
-      @dependency = Hash.new { |hash, key| hash[key] = Set.new }
-      @reverse_dependency = {}
-      @examples_coverage = {}
-    end
-
-    def merge(reports_dir)
-      reports_dir.each do |report_dir|
-        next unless File.directory?(report_dir)
-
-        merge_cache(load_cache(report_dir))
-        merge_last_run_report(File.dirname(report_dir))
-      end
-
-      @dependency.transform_values!(&:to_a)
-
-      @reverse_dependency = RSpecTracer::ReportGenerator.new(self, nil).reverse_dependency_report
-    end
-
-    private
-
-    def load_cache(cache_dir)
-      RSpecTracer::Cache.new.populate_from_disk(cache_dir, discard_run_reason: false)
-    end
-
-    def merge_cache(cache)
-      @all_examples.merge!(cache.all_examples) { |_, v1, v2| v1[:run_reason] ? v1 : v2 }
-      @duplicate_examples.merge!(cache.duplicate_examples) { |_, v1, v2| v1 + v2 }
-      @interrupted_examples.merge(cache.interrupted_examples)
-      @flaky_examples.merge(cache.flaky_examples)
-      @failed_examples.merge(cache.failed_examples)
-      @pending_examples.merge(cache.pending_examples)
-      @skipped_examples.merge(cache.skipped_examples)
-      @all_files.merge!(cache.all_files)
-      @dependency.merge!(cache.dependency) { |_, v1, v2| v1.merge(v2) }
-      @examples_coverage.merge!(cache.examples_coverage) do |_, v1, v2|
-        v1.merge(v2) { |_, v3, v4| v3.merge(v4) { |_, v5, v6| v5 + v6 } }
-      end
-    end
-
-    def merge_last_run_report(cache_dir)
-      file_name = File.join(cache_dir, 'last_run.json')
-      cached_last_run = JSON.parse(File.read(file_name, encoding: 'UTF-8'), symbolize_names: true)
-      cached_last_run[:pid] = [cached_last_run[:pid]]
-
-      cached_last_run.delete_if { |key, _| %i[run_id timestamp].include?(key) }
-
-      @last_run.merge!(cached_last_run) { |_, v1, v2| v1 + v2 }
-    end
-  end
-end

data/lib/rspec_tracer/report_writer.rb

@@ -1,141 +0,0 @@
-# frozen_string_literal: true
-
-module RSpecTracer
-  class ReportWriter
-    def initialize(report_dir, reporter)
-      @report_dir = report_dir
-      @reporter = reporter
-    end
-
-    def write_report
-      starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-
-      @run_id = Digest::MD5.hexdigest(@reporter.all_examples.keys.sort.to_json)
-      @cache_dir = File.join(@report_dir, @run_id)
-
-      FileUtils.mkdir_p(@cache_dir)
-
-      write_all_examples_report
-      write_duplicate_examples_report
-      write_interrupted_examples_report
-      write_flaky_examples_report
-      write_failed_examples_report
-      write_pending_examples_report
-      write_skipped_examples_report
-      write_all_files_report
-      write_dependency_report
-      write_reverse_dependency_report
-      write_examples_coverage_report
-      write_last_run_report
-
-      ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-      elapsed = RSpecTracer::TimeFormatter.format_time(ending - starting)
-
-      RSpecTracer.logger.debug "RSpec tracer reports written to #{@cache_dir} (took #{elapsed})"
-    end
-
-    def print_duplicate_examples
-      return if @reporter.duplicate_examples.empty?
-
-      total = @reporter.duplicate_examples.sum { |_, examples| examples.count }
-
-      RSpecTracer.logger.error [
-        '=' * 80,
-        '   IMPORTANT NOTICE -- RSPEC TRACER COULD NOT IDENTIFY SOME EXAMPLES UNIQUELY',
-        '=' * 80,
-        "RSpec tracer could not uniquely identify the following #{total} examples:"
-      ].join("\n")
-
-      justify = ' ' * 2
-      nested_justify = justify * 3
-
-      @reporter.duplicate_examples.each_pair do |example_id, examples|
-        RSpecTracer.logger.error "#{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}"
-
-          RSpecTracer.logger.error "#{nested_justify}* #{description} (#{location})"
-        end
-      end
-    end
-
-    private
-
-    def write_all_examples_report
-      file_name = File.join(@cache_dir, 'all_examples.json')
-
-      File.write(file_name, JSON.pretty_generate(@reporter.all_examples), encoding: 'UTF-8')
-    end
-
-    def write_duplicate_examples_report
-      file_name = File.join(@cache_dir, 'duplicate_examples.json')
-
-      File.write(file_name, JSON.pretty_generate(@reporter.duplicate_examples), encoding: 'UTF-8')
-    end
-
-    def write_interrupted_examples_report
-      file_name = File.join(@cache_dir, 'interrupted_examples.json')
-
-      File.write(file_name, JSON.pretty_generate(@reporter.interrupted_examples.sort.to_a), encoding: 'UTF-8')
-    end
-
-    def write_flaky_examples_report
-      file_name = File.join(@cache_dir, 'flaky_examples.json')
-
-      File.write(file_name, JSON.pretty_generate(@reporter.flaky_examples.sort.to_a), encoding: 'UTF-8')
-    end
-
-    def write_failed_examples_report
-      file_name = File.join(@cache_dir, 'failed_examples.json')
-
-      File.write(file_name, JSON.pretty_generate(@reporter.failed_examples.sort.to_a), encoding: 'UTF-8')
-    end
-
-    def write_pending_examples_report
-      file_name = File.join(@cache_dir, 'pending_examples.json')
-
-      File.write(file_name, JSON.pretty_generate(@reporter.pending_examples.sort.to_a), encoding: 'UTF-8')
-    end
-
-    def write_skipped_examples_report
-      file_name = File.join(@cache_dir, 'skipped_examples.json')
-
-      File.write(file_name, JSON.pretty_generate(@reporter.skipped_examples.sort.to_a), encoding: 'UTF-8')
-    end
-
-    def write_all_files_report
-      file_name = File.join(@cache_dir, 'all_files.json')
-
-      File.write(file_name, JSON.pretty_generate(@reporter.all_files), encoding: 'UTF-8')
-    end
-
-    def write_dependency_report
-      file_name = File.join(@cache_dir, 'dependency.json')
-
-      File.write(file_name, JSON.pretty_generate(@reporter.dependency), encoding: 'UTF-8')
-    end
-
-    def write_reverse_dependency_report
-      file_name = File.join(@cache_dir, 'reverse_dependency.json')
-
-      File.write(file_name, JSON.pretty_generate(@reporter.reverse_dependency), encoding: 'UTF-8')
-    end
-
-    def write_examples_coverage_report
-      file_name = File.join(@cache_dir, 'examples_coverage.json')
-
-      File.write(file_name, JSON.pretty_generate(@reporter.examples_coverage), encoding: 'UTF-8')
-    end
-
-    def write_last_run_report
-      file_name = File.join(@report_dir, 'last_run.json')
-      last_run_data = @reporter.last_run.merge(run_id: @run_id, timestamp: Time.now.utc)
-
-      File.write(file_name, JSON.pretty_generate(last_run_data), encoding: 'UTF-8')
-    end
-  end
-end