spectracer 1.0.0

data/lib/spectracer/io/git_adapter.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "git"
+
+module Spectracer
+  module IO
+    class GitAdapter
+      def initialize(working_dir: Dir.pwd, logger: nil)
+        @working_dir = working_dir
+        @logger = logger
+        @git = nil
+      end
+
+      def repository_root
+        git.dir.path
+      end
+
+      def current_branch
+        git.current_branch
+      end
+
+      def commit_sha(ref)
+        git.object(ref).sha
+      end
+
+      def changed_files_in_commit(sha)
+        commit = git.object(sha)
+        return [] unless commit.respond_to?(:diff_parent)
+
+        commit.diff_parent.stats[:files].keys
+      rescue Git::Error => e
+        @logger&.warn("Failed to get changed files for commit #{sha}: #{e.message}")
+        []
+      end
+
+      def changed_files_against(target_branch, cached: false)
+        target_ref = "origin/#{target_branch}"
+
+        diff = if cached
+          git.diff(target_ref, "HEAD")
+        else
+          git.diff(target_ref)
+        end
+
+        diff.stats[:files].keys
+      rescue Git::Error => e
+        @logger&.warn("Failed to diff against #{target_branch}: #{e.message}")
+        []
+      end
+
+      private
+
+      def git
+        @git ||= Git.open(@working_dir, log: nil)
+      end
+    end
+  end
+end

data/lib/spectracer/logger.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Spectracer
+  class Logger
+    LEVELS = {debug: 0, info: 1, warn: 2, error: 3}.freeze
+
+    def initialize(output: $stderr, level: :info, enabled: false)
+      @output = output
+      @level = LEVELS.fetch(level, 1)
+      @enabled = enabled
+    end
+
+    def debug(message)
+      log(:debug, message)
+    end
+
+    def info(message)
+      log(:info, message)
+    end
+
+    def warn(message)
+      log(:warn, message)
+    end
+
+    def error(message)
+      log(:error, message)
+    end
+
+    private
+
+    def log(level, message)
+      return unless @enabled
+      return if LEVELS[level] < @level
+
+      @output.puts "[Spectracer] #{level.upcase}: #{message}"
+    end
+  end
+end

data/lib/spectracer/orchestrators/dependency_collector.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Spectracer
+  module Orchestrators
+    class DependencyCollector
+      def initialize(
+        paths: Spectracer::Core::Paths.new,
+        store: Spectracer::IO::DependencyStore.new,
+        logger: nil
+      )
+        @paths = paths
+        @store = store
+        @logger = logger
+      end
+
+      def self.collect!(...)
+        new(...).collect!
+      end
+
+      def collect!
+        inverse_deps = build_inverse_dependencies
+
+        inverse_deps.each_value(&:sort!)
+
+        @store.write(inverse_deps, @paths.collected_dependencies_file)
+
+        nil
+      end
+
+      private
+
+      def build_inverse_dependencies
+        inverse = Hash.new { |h, k| h[k] = [] }
+
+        artifact_files.each do |file|
+          @logger&.debug("Processing artifact: #{file}")
+          data = @store.read(file)
+
+          data.each do |spec_file, dependencies|
+            dependencies.each do |dep|
+              inverse[dep] << spec_file unless inverse[dep].include?(spec_file)
+            end
+          end
+        end
+
+        inverse
+      end
+
+      def artifact_files
+        @store.glob(@paths.spec_artifacts_download_glob)
+      end
+    end
+  end
+end

data/lib/spectracer/orchestrators/dependency_tracer.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Spectracer
+  module Orchestrators
+    class DependencyTracer
+      def initialize(
+        paths: Spectracer::Core::Paths.new,
+        store: Spectracer::IO::DependencyStore.new,
+        repository: Spectracer::Providers::Repository.new,
+        logger: nil
+      )
+        @paths = paths
+        @store = store
+        @repository = repository
+        @logger = logger
+        @current_spec_file = nil
+        @spec_file_dependencies = Hash.new { |h, k| h[k] = Set.new }
+      end
+
+      attr_writer :current_spec_file
+
+      def with_tracing(&block)
+        tracepoint.enable
+        block.call
+      ensure
+        tracepoint.disable
+      end
+
+      def write_output!
+        output = build_output
+
+        if output.empty?
+          @logger&.debug("No dependencies found.")
+          return
+        end
+
+        @store.write(output, @paths.spec_artifact_output_file)
+      end
+
+      private
+
+      def tracepoint
+        @tracepoint ||= TracePoint.new(:call) do |tp|
+          path = tp.path
+          next unless path.start_with?(repository_root)
+          next if @current_spec_file.nil?
+
+          file_path = normalize_path(path)
+          next if @current_spec_file == file_path
+
+          @spec_file_dependencies[@current_spec_file].add(file_path)
+        end
+      end
+
+      def repository_root
+        @repository_root ||= @repository.root
+      end
+
+      def normalize_path(path)
+        @paths.normalize(path, repo_root: repository_root)
+      end
+
+      def build_output
+        @spec_file_dependencies.each_with_object({}) do |(spec_file, files), acc|
+          next if files.empty?
+          acc[spec_file] = files.to_a.sort
+        end
+      end
+    end
+  end
+end

data/lib/spectracer/orchestrators/spec_run_determiner.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Spectracer
+  module Orchestrators
+    class SpecRunDeterminer
+      def initialize(
+        paths: Spectracer::Core::Paths.new,
+        store: Spectracer::IO::DependencyStore.new,
+        config_loader: Spectracer::IO::ConfigLoader.new,
+        changed_files_provider: Spectracer::Providers::GitChangedFiles.new,
+        selector: Spectracer::Core::SpecSelector.new,
+        logger: nil
+      )
+        @paths = paths
+        @store = store
+        @config_loader = config_loader
+        @changed_files_provider = changed_files_provider
+        @selector = selector
+        @logger = logger
+      end
+
+      def self.determine!(...)
+        new(...).determine!
+      end
+
+      def determine!
+        dependencies = load_dependencies
+        config = @config_loader.load
+        changed_files = @changed_files_provider.call
+
+        log_debug_info(config, changed_files)
+
+        @selector.call(
+          changed_files: changed_files,
+          inverse_deps: dependencies,
+          globs: config[:globs],
+          on_empty: config[:on_empty_spec_set]
+        )
+      rescue => e
+        @logger&.error("Error determining specs: #{e.message}")
+        @logger&.error(e.backtrace&.join("\n"))
+        nil
+      end
+
+      private
+
+      def load_dependencies
+        deps_file = @paths.collected_dependencies_file
+
+        unless File.exist?(deps_file)
+          @logger&.debug("No dependencies file found at #{deps_file.inspect}")
+          return {}
+        end
+
+        @store.read(deps_file)
+      end
+
+      def log_debug_info(config, changed_files)
+        @logger&.debug("Configuration: #{config.inspect}")
+        @logger&.debug("Changed files: #{changed_files.inspect}")
+      end
+    end
+  end
+end

data/lib/spectracer/providers/git_changed_files.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Spectracer
+  module Providers
+    class GitChangedFiles
+      def initialize(git_adapter: Spectracer::IO::GitAdapter.new, env: ENV, logger: nil)
+        @git_adapter = git_adapter
+        @env = env
+        @logger = logger
+      end
+
+      def call
+        default_branch = @env.fetch("BUILDKITE_PIPELINE_DEFAULT_BRANCH", "main")
+        current_branch = @env.fetch("BUILDKITE_BRANCH") { @git_adapter.current_branch }
+
+        files = if current_branch == default_branch
+          changed_files_for_latest_commit(current_branch)
+        else
+          changed_files_against_default_branch(default_branch)
+        end
+
+        @logger&.debug("Changed files: #{files.inspect}")
+        files
+      end
+
+      private
+
+      def changed_files_for_latest_commit(branch)
+        sha = @git_adapter.commit_sha(branch)
+        @logger&.debug("Latest commit SHA: #{sha}")
+
+        @git_adapter.changed_files_in_commit(sha)
+      end
+
+      def changed_files_against_default_branch(default_branch)
+        @git_adapter.changed_files_against(default_branch, cached: true)
+      end
+    end
+  end
+end

data/lib/spectracer/providers/repository.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Spectracer
+  module Providers
+    class Repository
+      def initialize(git_adapter: Spectracer::IO::GitAdapter.new)
+        @git_adapter = git_adapter
+      end
+
+      def root
+        @root ||= @git_adapter.repository_root
+      end
+    end
+  end
+end

data/lib/spectracer/tasks/spectacle.rake

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+namespace :spectracer do
+  desc "Install Spectracer configuration file"
+  task :install do
+    config_path = Spectracer::IO::ConfigLoader::FILE_PATH
+
+    if File.exist?(config_path)
+      warn "Spectracer is already installed."
+      exit 0
+    end
+
+    warn "Creating '#{config_path}' file."
+
+    default_content = File.read(Spectracer::IO::ConfigLoader::DEFAULT_FILE_PATH)
+    File.write(config_path, default_content)
+  end
+
+  desc "Collect spec dependencies from tracing artifacts"
+  task :collect_dependencies do
+    logger = Spectracer::Logger.new(
+      enabled: ENV["WITH_SPECTACLE_DEBUG"] == "true",
+      level: :debug
+    )
+    Spectracer::Orchestrators::DependencyCollector.collect!(logger: logger)
+  end
+
+  desc "Print the list of specs to run based on changed files"
+  task :spec_determiner do
+    logger = Spectracer::Logger.new(
+      enabled: ENV["WITH_SPECTACLE_DEBUG"] == "true",
+      level: :debug
+    )
+    result = Spectracer::Orchestrators::SpecRunDeterminer.determine!(logger: logger)
+    $stdout.puts "'#{result}'"
+  end
+end

data/lib/spectracer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Spectracer
+  VERSION = "1.0.0"
+end

data/lib/spectracer.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "spectracer/version"
+require_relative "spectracer/logger"
+
+require_relative "spectracer/core/paths"
+require_relative "spectracer/core/spec_selector"
+
+require_relative "spectracer/io/command_runner"
+require_relative "spectracer/io/dependency_store"
+require_relative "spectracer/io/config_loader"
+require_relative "spectracer/io/git_adapter"
+
+require_relative "spectracer/providers/repository"
+require_relative "spectracer/providers/git_changed_files"
+
+require_relative "spectracer/orchestrators/dependency_tracer"
+require_relative "spectracer/orchestrators/dependency_collector"
+require_relative "spectracer/orchestrators/spec_run_determiner"
+
+require_relative "spectracer/integrations/rspec"
+require_relative "spectracer/integrations/minitest"
+require_relative "spectracer/integrations/railtie" if defined?(Rails)
+
+module Spectracer
+  class Error < StandardError; end
+
+  class << self
+    def logger
+      @logger ||= Logger.new(
+        enabled: ENV["WITH_SPECTRACER_DEBUG"] == "true",
+        level: :debug
+      )
+    end
+
+    def paths
+      @paths ||= Core::Paths.new
+    end
+  end
+end
+
+Spectracer::Integrations::RSpec.install!
+Spectracer::Integrations::Minitest.install!

data/sig/spectracer.rbs

@@ -0,0 +1,195 @@
+module Spectracer
+  VERSION: String
+
+  class Error < StandardError
+  end
+
+  def self.logger: () -> Logger
+  def self.paths: () -> Core::Paths
+
+  class Logger
+    LEVELS: Hash[Symbol, Integer]
+
+    def initialize: (?output: IO, ?level: Symbol, ?enabled: bool) -> void
+    def debug: (String message) -> void
+    def info: (String message) -> void
+    def warn: (String message) -> void
+    def error: (String message) -> void
+
+    private
+
+    def log: (Symbol level, String message) -> void
+  end
+
+  module Core
+    class Paths
+      DEFAULT_OUTPUT_DIR: String
+
+      def initialize: (?env: Hash[String, String?]) -> void
+      def build_id: () -> String
+      def job_id: () -> String
+      def output_directory: () -> String
+      def spec_artifact_output_file: () -> String
+      def spec_artifacts_download_glob: () -> String
+      def collected_dependencies_file: () -> String
+      def normalize: (String file_path, repo_root: String) -> String
+      def strip_dot_prefix: (String path) -> String
+    end
+
+    class SpecSelector
+      def call: (
+        changed_files: Array[String],
+        inverse_deps: Hash[String, Array[String]],
+        globs: Hash[String, String],
+        on_empty: String
+      ) -> String
+    end
+  end
+
+  module IO
+    class CommandRunner
+      def initialize: (?logger: Logger?) -> void
+      def run: (String command) -> String
+    end
+
+    class DependencyStore
+      def initialize: (?logger: Logger?) -> void
+      def read: (String file_path) -> Hash[String, untyped]
+      def write: (Hash[String, untyped] data, String file_path) -> void
+      def glob: (String pattern) -> Array[String]
+
+      private
+
+      def read_gzipped_json: (String file_path) -> Hash[String, untyped]
+      def read_json: (String file_path) -> Hash[String, untyped]
+    end
+
+    class ConfigLoader
+      FILE_PATH: String
+      DEFAULT_FILE_PATH: String
+
+      def initialize: (?logger: Logger?) -> void
+      def load: () -> Hash[Symbol, untyped]
+
+      private
+
+      def load_raw_config: () -> Hash[String, untyped]?
+      def parse_config: (Hash[String, untyped] raw) -> Hash[Symbol, untyped]
+      def resolve_templates: (String template, Hash[String, String] defaults) -> String
+      def default_config: () -> Hash[Symbol, untyped]
+    end
+
+    class GitAdapter
+      def initialize: (?working_dir: String, ?logger: Logger?) -> void
+      def repository_root: () -> String
+      def current_branch: () -> String
+      def commit_sha: (String ref) -> String
+      def changed_files_in_commit: (String sha) -> Array[String]
+      def changed_files_against: (String target_branch, ?cached: bool) -> Array[String]
+
+      private
+
+      def git: () -> untyped
+    end
+  end
+
+  module Providers
+    class Repository
+      def initialize: (?git_adapter: IO::GitAdapter) -> void
+      def root: () -> String
+    end
+
+    class GitChangedFiles
+      def initialize: (
+        ?git_adapter: IO::GitAdapter,
+        ?env: Hash[String, String?],
+        ?logger: Logger?
+      ) -> void
+      def call: () -> Array[String]
+
+      private
+
+      def changed_files_for_latest_commit: (String branch) -> Array[String]
+      def changed_files_against_default_branch: (String default_branch) -> Array[String]
+    end
+  end
+
+  module Orchestrators
+    class DependencyTracer
+      attr_writer current_spec_file: String?
+
+      def initialize: (
+        ?paths: Core::Paths,
+        ?store: IO::DependencyStore,
+        ?repository: Providers::Repository,
+        ?logger: Logger?
+      ) -> void
+      def with_tracing: () { () -> void } -> void
+      def write_output!: () -> void
+
+      private
+
+      def tracepoint: () -> TracePoint
+      def repository_root: () -> String
+      def normalize_path: (String path) -> String
+      def build_output: () -> Hash[String, Array[String]]
+    end
+
+    class DependencyCollector
+      def initialize: (
+        ?paths: Core::Paths,
+        ?store: IO::DependencyStore,
+        ?logger: Logger?
+      ) -> void
+      def self.collect!: (**untyped) -> nil
+      def collect!: () -> nil
+
+      private
+
+      def build_inverse_dependencies: () -> Hash[String, Array[String]]
+      def artifact_files: () -> Array[String]
+    end
+
+    class SpecRunDeterminer
+      def initialize: (
+        ?paths: Core::Paths,
+        ?store: IO::DependencyStore,
+        ?config_loader: IO::ConfigLoader,
+        ?changed_files_provider: Providers::GitChangedFiles,
+        ?selector: Core::SpecSelector,
+        ?logger: Logger?
+      ) -> void
+      def self.determine!: (**untyped) -> String?
+      def determine!: () -> String?
+
+      private
+
+      def load_dependencies: () -> Hash[String, Array[String]]
+      def log_debug_info: (Hash[Symbol, untyped] config, Array[String] changed_files) -> void
+    end
+  end
+
+  module Integrations
+    module RSpec
+      def self.install!: () -> void
+    end
+
+    module Minitest
+      attr_accessor self.tracer: Orchestrators::DependencyTracer?
+
+      def self.install!: () -> void
+
+      module RunPatch
+        def run: (?Array[String] args) -> untyped
+      end
+
+      module TestCasePlugin
+        def before_setup: () -> void
+        def run: () -> untyped
+      end
+    end
+
+    class Railtie < Rails::Railtie
+    end
+  end
+end