rspec-tracer 0.7.0 → 0.8.0

data/lib/rspec_tracer/configuration.rb

@@ -14,21 +14,18 @@ module RSpecTracer
       return @root if defined?(@root) && root.nil?
 
       @cache_path = nil
+      @report_path = nil
+      @coverage_path = nil
+
       @root = File.expand_path(root || Dir.getwd)
     end
 
-    def project_name(proj_name = nil)
-      return @project_name if defined?(@project_name) && proj_name.nil?
-
-      @project_name = proj_name if proj_name.is_a?(String)
+    def project_name
       @project_name ||= File.basename(root).capitalize
     end
 
-    def cache_dir(dir = nil)
-      return @cache_dir if defined?(@cache_dir) && dir.nil?
-
-      @cache_path = nil
-      @cache_dir = dir || DEFAULT_CACHE_DIR
+    def cache_dir
+      @cache_dir ||= (ENV['RSPEC_TRACER_CACHE_DIR'] || DEFAULT_CACHE_DIR)
     end
 
     def cache_path
@@ -42,15 +39,12 @@ module RSpecTracer
       end
     end
 
-    def report_dir(dir = nil)
-      return @report_dir if defined?(@report_dir) && dir.nil?
-
-      @report_path = nil
-      @report_dir = dir || DEFAULT_REPORT_DIR
+    def report_dir
+      @report_dir ||= (ENV['RSPEC_TRACER_REPORT_DIR'] || DEFAULT_REPORT_DIR)
     end
 
     def report_path
-      @report_path || begin
+      @report_path ||= begin
         report_path = File.expand_path(report_dir, root)
         report_path = File.join(report_path, ENV['TEST_SUITE_ID'].to_s)
 
@@ -60,11 +54,8 @@ module RSpecTracer
       end
     end
 
-    def coverage_dir(dir = nil)
-      return @coverage_dir if defined?(@coverage_dir) && dir.nil?
-
-      @coverage_path = nil
-      @coverage_dir = dir || DEFAULT_COVERAGE_DIR
+    def coverage_dir
+      @coverage_dir ||= (ENV['RSPEC_TRACER_COVERAGE_DIR'] || DEFAULT_COVERAGE_DIR)
     end
 
     def coverage_path
@@ -103,9 +94,7 @@ module RSpecTracer
     end
 
     def verbose?
-      return @verbose if defined?(@verbose)
-
-      @verbose = ENV.fetch('RSPEC_TRACER_VERBOSE', 'false') == 'true'
+      @verbose ||= (ENV.fetch('RSPEC_TRACER_VERBOSE', 'false') == 'true')
     end
 
     def configure(&block)

data/lib/rspec_tracer/remote_cache/aws.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+module RSpecTracer
+  module RemoteCache
+    class Aws
+      class AwsError < StandardError; end
+
+      def initialize
+        @s3_bucket, @s3_path = setup_s3
+        @aws_cli = setup_aws_cli
+      end
+
+      def branch_refs?(branch_name)
+        key = "#{@s3_path}/branch-refs/#{branch_name}/branch_refs.json"
+
+        system(
+          @aws_cli,
+          's3api',
+          'head-object',
+          '--bucket',
+          @s3_bucket,
+          '--key',
+          key,
+          out: File::NULL,
+          err: File::NULL
+        )
+      end
+
+      def download_branch_refs(branch_name, file_name)
+        key = "#{@s3_path}/branch-refs/#{branch_name}/branch_refs.json"
+
+        system(
+          @aws_cli,
+          's3api',
+          'get-object',
+          '--bucket',
+          @s3_bucket,
+          '--key',
+          key,
+          file_name,
+          out: File::NULL,
+          err: File::NULL
+        )
+      end
+
+      def upload_branch_refs(branch_name, file_name)
+        remote_path = "s3://#{@s3_bucket}/#{@s3_path}/branch-refs/#{branch_name}/branch_refs.json"
+
+        raise AwsError, "Failed to upload branch refs for #{branch_name} branch" unless system(
+          @aws_cli,
+          's3',
+          'cp',
+          file_name,
+          remote_path,
+          out: File::NULL,
+          err: File::NULL
+        )
+
+        puts "Uploaded branch refs for #{branch_name} branch to #{remote_path}"
+      end
+
+      def cache_files_list(ref)
+        prefix = "s3://#{@s3_bucket}/#{@s3_path}/#{ref}/"
+
+        `#{@aws_cli} s3 ls #{prefix} --recursive`.chomp.split("\n")
+      end
+
+      def download_file(ref, file_name)
+        remote_path = File.join(s3_dir(ref), file_name)
+        local_path = File.join(RSpecTracer.cache_path, file_name)
+
+        raise AwsError, "Failed to download file #{remote_path}" unless system(
+          @aws_cli,
+          's3',
+          'cp',
+          remote_path,
+          local_path,
+          out: File::NULL,
+          err: File::NULL
+        )
+
+        puts "Downloaded file #{remote_path} to #{local_path}"
+      end
+
+      def download_dir(ref, run_id)
+        remote_dir = s3_dir(ref, run_id)
+        local_dir = File.join(RSpecTracer.cache_path, run_id)
+
+        raise AwsError, "Failed to download files from #{remote_dir}" unless system(
+          @aws_cli,
+          's3',
+          'cp',
+          remote_dir,
+          local_dir,
+          '--recursive',
+          out: File::NULL,
+          err: File::NULL
+        )
+
+        puts "Downloaded cache files from #{remote_dir} to #{local_dir}"
+      rescue AwsError => e
+        FileUtils.rm_rf(local_dir)
+
+        raise e
+      end
+
+      def upload_file(ref, file_name)
+        remote_path = File.join(s3_dir(ref), file_name)
+        local_path = File.join(RSpecTracer.cache_path, file_name)
+
+        raise AwsError, "Failed to upload file #{local_path}" unless system(
+          @aws_cli,
+          's3',
+          'cp',
+          local_path,
+          remote_path,
+          out: File::NULL,
+          err: File::NULL
+        )
+
+        puts "Uploaded file #{local_path} to #{remote_path}"
+      end
+
+      def upload_dir(ref, run_id)
+        remote_dir = s3_dir(ref, run_id)
+        local_dir = File.join(RSpecTracer.cache_path, run_id)
+
+        raise AwsError, "Failed to download files from #{local_dir}" unless system(
+          @aws_cli,
+          's3',
+          'cp',
+          local_dir,
+          remote_dir,
+          '--recursive',
+          out: File::NULL,
+          err: File::NULL
+        )
+
+        puts "Uploaded files from #{local_dir} to #{remote_dir}"
+      end
+
+      private
+
+      def setup_s3
+        s3_uri = ENV['RSPEC_TRACER_S3_URI']
+
+        raise AwsError, 'RSPEC_TRACER_S3_URI environment variable is not set' if s3_uri.nil?
+
+        uri_parts = s3_uri[4..-1].split('/')
+
+        raise AwsError, "Invalid S3 URI #{s3_uri}" unless uri_parts.length >= 3 && uri_parts.first.empty?
+
+        [
+          uri_parts[1],
+          uri_parts[2..-1].join('/')
+        ]
+      end
+
+      def setup_aws_cli
+        if ENV.fetch('LOCAL_AWS', 'false') == 'true'
+          'awslocal'
+        else
+          'aws'
+        end
+      end
+
+      def s3_dir(ref, run_id = nil)
+        test_suite_id = ENV['TEST_SUITE_ID']
+
+        if test_suite_id.nil?
+          "s3://#{@s3_bucket}/#{@s3_path}/#{ref}/#{run_id}/".sub(%r{/+$}, '/')
+        else
+          "s3://#{@s3_bucket}/#{@s3_path}/#{ref}/#{test_suite_id}/#{run_id}/".sub(%r{/+$}, '/')
+        end
+      end
+    end
+  end
+end

data/lib/rspec_tracer/remote_cache/cache.rb

@@ -1,186 +1,78 @@
 # frozen_string_literal: true
 
-require_relative 'git'
+require_relative 'aws'
+require_relative 'repo'
+require_relative 'validator'
 
 module RSpecTracer
   module RemoteCache
     class Cache
-      class CacheDownloadError < StandardError; end
-
-      class CacheUploadError < StandardError; end
-
-      class LocalCacheNotFoundError < StandardError; end
-
-      CACHE_FILES_PER_TEST_SUITE = 8
+      class CacheError < StandardError; end
 
       def initialize
-        @s3_uri = ENV['RSPEC_TRACER_S3_URI']
-        @aws_s3 = if ENV.fetch('LOCAL_AWS', 'false') == 'true'
-                    'awslocal'
-                  else
-                    'aws'
-                  end
+        @aws = RSpecTracer::RemoteCache::Aws.new
+        @repo = RSpecTracer::RemoteCache::Repo.new(@aws)
       end
 
       def download
-        if @s3_uri.nil?
-          puts 'S3 URI is not configured'
-
-          return
-        end
+        return unless cache_ref?
 
-        prepare_for_download
-
-        if @cache_sha.nil?
-          puts 'Could not find a suitable cache sha to download'
-
-          return
-        end
-
-        download_files
-
-        puts "Downloaded cache from #{@download_prefix} to #{@download_path}"
+        @aws.download_file(@cache_sha, 'last_run.json')
+        @aws.download_dir(@cache_sha, last_run_id)
       rescue StandardError => e
-        puts "Errored: #{e.message}"
+        puts "Error: #{e.message}"
+        puts e.backtrace.first(5).join("\n")
       end
 
       def upload
-        if @s3_uri.nil?
-          puts 'S3 URI is not configured'
+        @aws.upload_file(@repo.branch_ref, 'last_run.json')
+        @aws.upload_dir(@repo.branch_ref, last_run_id)
 
-          return
-        end
+        file_name = File.join(RSpecTracer.cache_path, 'branch_refs.json')
 
-        prepare_for_upload
-        upload_files
-
-        puts "Uploaded cache from #{@upload_path} to #{@upload_prefix}"
-      rescue CacheUploadError => e
-        puts "Errored: #{e.message}"
+        write_branch_refs(file_name)
+        @aws.upload_branch_refs(@repo.branch_name, file_name)
+      rescue StandardError => e
+        puts "Error: #{e.message}"
+        puts e.backtrace.first(5).join("\n")
       end
 
       private
 
-      def prepare_for_download
-        @test_suite_id = ENV['TEST_SUITE_ID']
-        @test_suites = ENV['TEST_SUITES']
+      def cache_ref?
+        cache_validator = RSpecTracer::RemoteCache::Validator.new
 
-        if @test_suite_id.nil? ^ @test_suites.nil?
-          raise(
-            CacheDownloadError,
-            'Both the enviornment variables TEST_SUITE_ID and TEST_SUITES are not set'
-          )
-        end
-
-        @git = RSpecTracer::RemoteCache::Git.new
-        @git.prepare_for_download
+        @cache_sha = @repo.cache_refs.each_key.detect do |ref|
+          puts "Validating ref #{ref}"
 
-        generate_cached_files_count_and_regex
-
-        @cache_sha = nearest_cache_sha
-      end
-
-      def generate_cached_files_count_and_regex
-        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.to_i
-          @cached_files_regex = "/%<ref>s/(#{@test_suites_regex})/[0-9a-f]{32}/.+.json$"
+          cache_validator.valid?(ref, @aws.cache_files_list(ref))
         end
-      end
-
-      def nearest_cache_sha
-        @git.ref_list.detect do |ref|
-          prefix = "#{@s3_uri}/#{ref}/"
-
-          puts "Testing prefix #{prefix}"
-
-          objects = `#{@aws_s3} s3 ls #{prefix} --recursive`.chomp.split("\n")
 
-          last_run_regex = Regexp.new(format(@last_run_files_regex, ref: ref))
-
-          next if objects.count { |object| object.match?(last_run_regex) } != @last_run_files_count
-
-          cache_regex = Regexp.new(format(@cached_files_regex, ref: ref))
+        if @cache_sha.nil?
+          puts 'Could not find a suitable cache sha to download'
 
-          objects.count { |object| object.match?(cache_regex) } == @cached_files_count
+          return false
         end
-      end
-
-      def download_files
-        @download_prefix = "#{@s3_uri}/#{@cache_sha}/#{@test_suite_id}/".sub(%r{/+$}, '/')
-        @download_path = RSpecTracer.cache_path
-
-        raise CacheDownloadError, 'Failed to download cache files' unless system(
-          @aws_s3, 's3', 'cp',
-          File.join(@download_prefix, 'last_run.json'),
-          @download_path,
-          out: File::NULL, err: File::NULL
-        )
 
-        @run_id = last_run_id
+        true
+      end
 
-        return if system(
-          @aws_s3, 's3', 'cp',
-          File.join(@download_prefix, @run_id),
-          File.join(@download_path, @run_id),
-          '--recursive',
-          out: File::NULL, err: File::NULL
-        )
+      def write_branch_refs(file_name)
+        branch_ref_time = `git show --no-patch --format="%ct" #{@repo.branch_ref}`.chomp
 
-        FileUtils.rm_rf(@download_path)
+        puts "Failed to find object #{@repo.branch_ref} commit timestamp" unless $CHILD_STATUS.success?
 
-        raise CacheDownloadError, 'Failed to download cache files'
-      end
+        ref_list = @repo.branch_refs.merge(@repo.branch_ref => branch_ref_time.to_i)
 
-      def prepare_for_upload
-        @git = RSpecTracer::RemoteCache::Git.new
-        @test_suite_id = ENV['TEST_SUITE_ID']
-        @upload_prefix = if @test_suite_id.nil?
-                           "#{@s3_uri}/#{@git.branch_ref}/"
-                         else
-                           "#{@s3_uri}/#{@git.branch_ref}/#{@test_suite_id}/"
-                         end
-
-        @upload_path = RSpecTracer.cache_path
-        @run_id = last_run_id
-      end
-
-      def upload_files
-        return if system(
-          @aws_s3, 's3', 'cp',
-          File.join(@upload_path, 'last_run.json'),
-          @upload_prefix,
-          out: File::NULL, err: File::NULL
-        ) && system(
-          @aws_s3, 's3', 'cp',
-          File.join(@upload_path, @run_id),
-          File.join(@upload_prefix, @run_id),
-          '--recursive',
-          out: File::NULL, err: File::NULL
-        )
-
-        raise CacheUploadError, 'Failed to upload cache files'
+        File.write(file_name, JSON.pretty_generate(ref_list))
       end
 
       def last_run_id
         file_name = File.join(RSpecTracer.cache_path, 'last_run.json')
 
-        return unless File.file?(file_name)
-
-        run_id = JSON.parse(File.read(file_name))['run_id']
-
-        raise LocalCacheNotFoundError, 'Could not find any local cache to upload' if run_id.nil?
+        raise CacheError, 'Could not find any local cache to upload' unless File.file?(file_name)
 
-        run_id
+        JSON.parse(File.read(file_name))['run_id']
       end
     end
   end