test-map 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cff4303356d351f21830fabfa15aa8c83074739a7df7b8eb3c05765b6c2a9a18
-  data.tar.gz: 86c24f5558da531e9aa4cfec819ca21b9a9a7328113b5925509a72b128ffcc3e
+  metadata.gz: 1ce3e91a8ab0098bedae3516d60ec4591513a5bd31507b143373627e3bd96ad3
+  data.tar.gz: 736396db3f44850d11fdeb3a0a0bca2bed9ecdb5f551439eed75aad59613b79c
 SHA512:
-  metadata.gz: 0ae009024978af278f98b2fc51c9abcb4907e0d14e575f179fd0edc2247356bcc07f3349b80dae599b8f8932d4e1b9534fab17e51e555d7d1d3e19fa6a00219e
-  data.tar.gz: 06ffd99ddcc28a9025d6a998a19766c9aa378489a6cb39e92a2f0b401da794fc05a4a9d17c2eb60b5456936088a87e12ce65bceeb4db1353230a62d0a00bbdb3
+  metadata.gz: d80393696fdf9dfad334535bd560ddf4e93731d99ba77993a31c3243d8902f7cf30001cf56c2fe37b4ffa6ba5ad450329dd466ef2aa4119316e3344c0ce0c834
+  data.tar.gz: b0a20a539dec75bf6c27e47dc50c47dabd70cf68096fa83730950ede937c1445ddd8ed763814bf02b4040c2bcd47e32431379c9c78cde4e7ebc03ce2b7c912dc

data/CHANGELOG.md

@@ -6,6 +6,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 0.3.0 - 2026-03-01
+
+Introduce test cache and remove changes runner. Removed `test:changes` Rake
+task as it is no longer needed.
+
 ## 0.2.0 - 2024-10-25
 
 Provide explicit Test Task via Rake for Minitest, Rspec, and Rails. Extend

data/README.md

@@ -4,12 +4,10 @@
 Track associated files of executed tests to optimize test execution on file
 changes.
 
-Test-Map results in a file that maps test files to the files they depend on.
-You can use this file to run only the tests that are affected by a file change.
-This is useful when you have a large test suite and want to optimize the time
-spent running tests. Submit a change request and only run tests that depend on
-what you changed. Optimizing in such way, the time spent waiting for CI to
-verify can be reduced to seconds.
+Test-Map records which source files each test touches and caches their
+checksums. On subsequent runs, tests whose dependencies haven't changed are
+automatically skipped. This is useful when you have a large test suite and want
+to optimize the time spent running tests locally or in CI.
 
 ## Usage
 
@@ -21,57 +19,38 @@ $ bundle add test-map
 
 ### Minitest
 
-Include test-map in your test helper. Typically you want to include it
-conditionally so it only generates the test map when needed.
+Include test-map in your test helper.
 
 ```ruby
 # filename: test/test_helper.rb
 
 # Include test-map after minitest has been required
-require 'test_map' if ENV['TEST_MAP']
+require 'test_map'
 ```
 
-Run your tests with the `TEST_MAP` environment variable set.
+Run your tests. On the first run test-map records file dependencies into
+`.test-map.yml` and checksums into `.test-cache.yml`. On subsequent runs,
+tests whose source files haven't changed are automatically skipped.
 
 ```sh
-$ TEST_MAP=1 bundle exec ruby -Itest test/models/user_test.rb
+$ bundle exec ruby -Itest test/models/user_test.rb
 # or
-$ TEST_MAP=1 bundle exec rake test
-```
-
-Using the a dedicated rake task you can connect a file watcher and trigger
-tests on file changes.
-
-```ruby
-# filename: Rakefile
-require 'test_map/test_task'
-
-TestMap::TestTask.create
-```
-
-Using [entr](https://eradman.com/entrproject/) as example file watcher.
-
-```sh
-# find all ruby files | watch them, postpone first execution, clear screen
-#   with every run and on file change run test suite for the changed file
-#   (placeholder /_).
-$ find . -name "*.rb" | entr -cp bundle exec rake test:changes /_
+$ bundle exec rake test
 ```
 
 ### Rspec
 
-Include test-map in your test helper. Typically you want to include it
-conditionally so it only generates the test map when needed.
+Include test-map in your spec helper.
 
 ```ruby
 # filename: spec/spec_helper.rb
-require 'test_map' if ENV['TEST_MAP']
+require 'test_map'
 ```
 
-Run your tests with the `TEST_MAP` environment variable set.
+Run your tests. Caching works the same as with Minitest.
 
 ```sh
-$ TEST_MAP=1 bundle exec rspec
+$ bundle exec rspec
 ```
 
 ## Configuration
@@ -79,27 +58,21 @@ $ TEST_MAP=1 bundle exec rspec
 On demand you can adapt the configuration to your needs.
 
 ```ruby
-TestMap::Configure.configure do |config|
-  config.logger = Logger.new($stdout) # default logs to dev/null
-  config.out_file = 'my-test-map.yml' # default is .test-map.yml
+TestMap::Config.configure do |config|
+  config[:logger] = Logger.new($stdout) # default logs to dev/null
+  config[:merge] = false # merge results (e.g. with multiple testsuites)
+  config[:out_file] = 'my-test-map.yml' # default is .test-map.yml
+  config[:cache_file] = 'my-test-cache.yml' # default is .test-cache.yml
   # defaults to [%r{^(vendor)/}] }
-  config.exclude_patterns = [%r{^(vendor|other_libraries)/}]
+  config[:exclude_patterns] = [%r{^(vendor|other_libraries)/}]
   # register a custom rule to match new files; must implement `call(file)`;
   # defaults to nil
-  config.natural_mapping = ->(file) { file.sub(%r{^library/}, 'test/') }
+  config[:natural_mapping] = ->(file) { file.sub(%r{^library/}, 'test/') }
 end
 ```
 
 ## Development
 
-Open list of features:
-
-- [ ] Configure file exclude list (e.g. test files are not needed).
-- [ ] Auto-handle packs, packs with subdirectories.
-- [ ] Demonstrate usage with file watchers.
-- [ ] Demonstrate CI pipelines with GitHub actions and GitLab CI.
-- [ ] Merge results.
-
 ```sh
 $ bundle install # install dependencies
 $ bundle exec rake # run testsuite

data/lib/test_map/cache.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'digest'
+require 'yaml'
+
+module TestMap
+  # Cache tracks file checksums to skip unchanged tests.
+  class Cache
+    GLOBAL_FILES = %w[Gemfile.lock .ruby-version].freeze
+
+    def initialize(cache_file, map_file, root: Dir.pwd)
+      @cache_file = cache_file
+      @map_file = map_file
+      @root = root
+    end
+
+    def fresh?(test_file)
+      return false unless cached_checksums
+      return false if global_files_changed?
+
+      files_to_check = [test_file] + source_files_for(test_file)
+      files_to_check.all? { |f| file_exist?(f) && current_checksum(f) == cached_checksums[f] }
+    end
+
+    def write(results)
+      all_files = collect_tracked_files(results)
+      checksums = all_files.each_with_object({}) do |file, hash|
+        hash[file] = current_checksum(file) if file_exist?(file)
+      end
+      File.write(@cache_file, checksums.sort.to_h.to_yaml)
+    end
+
+    private
+
+    def cached_checksums
+      @cached_checksums ||= File.exist?(@cache_file) && YAML.safe_load_file(@cache_file)
+    end
+
+    def global_files_changed?
+      GLOBAL_FILES.any? do |f|
+        file_exist?(f) && current_checksum(f) != cached_checksums[f]
+      end
+    end
+
+    def inverted_map = @inverted_map ||= build_inverted_map
+
+    def build_inverted_map
+      return {} unless File.exist?(@map_file)
+
+      map = YAML.safe_load_file(@map_file)
+      inverted = Hash.new { |h, k| h[k] = [] }
+      map.each do |source, tests|
+        tests.each { |t| inverted[t] << source }
+      end
+      inverted
+    end
+
+    def source_files_for(test_file)
+      inverted_map[test_file] || []
+    end
+
+    def current_checksum(file)
+      Digest::SHA256.file(File.join(@root, file)).hexdigest
+    end
+
+    def file_exist?(file) = File.exist?(File.join(@root, file))
+
+    def collect_tracked_files(results)
+      sources = results.keys
+      tests = results.values.flatten.uniq
+      all = (sources + tests + GLOBAL_FILES).uniq
+      all.select { |f| file_exist?(f) }
+    end
+  end
+end

data/lib/test_map/config.rb

@@ -11,6 +11,7 @@ module TestMap
 
     def self.default_config
       { logger: Logger.new('/dev/null'), out_file: '.test-map.yml',
+        cache_file: '.test-cache.yml',
         exclude_patterns: [%r{^(vendor)/}], natural_mapping: nil,
         skip_files: [%r{^(test/)}], merge: false }
     end

data/lib/test_map/plugins/minitest.rb

@@ -6,14 +6,40 @@ module TestMap
     module Minitest
       def self.included(_base)
         TestMap.logger.info 'Registering hooks for Minitest'
-        ::Minitest.after_run do
-          result = TestMap.reporter.to_yaml
-          File.write "#{Dir.pwd}/#{Config.config[:out_file]}", result
+        TestMap.suite_passed = true
+
+        ::Minitest.after_run { write_results }
+      end
+
+      def self.write_results
+        out_file = "#{Dir.pwd}/#{Config.config[:out_file]}"
+        reporter_results = TestMap.reporter.results
+
+        # All tests were cache-skipped, existing files are still valid
+        return if reporter_results.empty?
+
+        full_results = merge_results(out_file, reporter_results)
+        File.write(out_file, full_results.to_yaml)
+        TestMap.cache.write(full_results) if TestMap.suite_passed
+      end
+
+      # Merge with existing map to preserve mappings for cache-skipped tests
+      def self.merge_results(out_file, reporter_results)
+        if File.exist?(out_file)
+          TestMap.reporter.merge(reporter_results, YAML.safe_load_file(out_file))
+        else
+          reporter_results
         end
       end
 
       def after_setup
-        @recorder = FileRecorder.new.tap(&:trace)
+        test_file = resolve_test_file
+        if test_file && TestMap.cache.fresh?(test_file)
+          @_test_map_skipped = true
+          skip 'test-map: cached'
+        else
+          @recorder = FileRecorder.new.tap(&:trace)
+        end
 
         super
       end
@@ -21,8 +47,21 @@ module TestMap
       def before_teardown
         super
 
+        return if @_test_map_skipped || !@recorder
+
         @recorder.stop
         TestMap.reporter.add @recorder.results
+
+        TestMap.suite_passed = false if !passed? && !skipped?
+      end
+
+      private
+
+      def resolve_test_file
+        file = method(name).source_location&.first
+        return unless file
+
+        file.sub("#{Dir.pwd}/", '')
       end
     end
   end

data/lib/test_map/plugins/rspec.rb

@@ -1,17 +1,38 @@
 # frozen_string_literal: true
 
 TestMap.logger.info 'Loading RSpec plugin'
+TestMap.suite_passed = true
 
 RSpec.configure do |config|
   config.around(:example) do |example|
-    # path = example.metadata[:example_group][:file_path]
-    recorder = TestMap::FileRecorder.new
-    recorder.trace { example.run }
-    TestMap.reporter.add recorder.results
+    test_file = example.metadata[:file_path].sub("#{Dir.pwd}/", '').sub(%r{^\./}, '')
+
+    if TestMap.cache.fresh?(test_file)
+      skip 'test-map: cached'
+    else
+      recorder = TestMap::FileRecorder.new
+      recorder.trace { example.run }
+      TestMap.reporter.add recorder.results
+
+      TestMap.suite_passed = false if example.exception && !example.skipped?
+    end
   end
 
   config.after(:suite) do
-    result = TestMap.reporter.to_yaml
-    File.write "#{Dir.pwd}/#{TestMap::Config.config[:out_file]}", result
+    out_file = "#{Dir.pwd}/#{TestMap::Config.config[:out_file]}"
+    reporter_results = TestMap.reporter.results
+
+    # All tests were cache-skipped, existing files are still valid
+    next if reporter_results.empty?
+
+    # Merge with existing map to preserve mappings for cache-skipped tests
+    full_results = if File.exist?(out_file)
+                     TestMap.reporter.merge(reporter_results, YAML.safe_load_file(out_file))
+                   else
+                     reporter_results
+                   end
+
+    File.write(out_file, full_results.to_yaml)
+    TestMap.cache.write(full_results) if TestMap.suite_passed
   end
 end

data/lib/test_map/report.rb

@@ -16,12 +16,21 @@ module TestMap
     end
 
     def write(file)
-      result = to_yaml
-      result = YAML.safe_load_file(file).deep_merge(result) if Config.config[:merge]
-      File.write file, result
+      content = if File.exist?(file) && Config.config[:merge]
+                  merge(results, YAML.safe_load_file(file)).to_yaml
+                else
+                  to_yaml
+                end
+      File.write file, content
     end
 
-    def results = @results.transform_values { _1.to_a.sort }.sort.to_h
+    def results = @results.transform_values { _1.to_a.uniq.sort }.sort.to_h
     def to_yaml = results.to_yaml
+
+    def merge(result, current)
+      current.merge(result) do |_key, oldval, newval|
+        (oldval + newval).uniq.sort
+      end
+    end
   end
 end

data/lib/test_map/version.rb

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

data/lib/test_map.rb

@@ -8,11 +8,23 @@ require_relative 'test_map/report'
 require_relative 'test_map/file_recorder'
 require_relative 'test_map/natural_mapping'
 require_relative 'test_map/mapping'
+require_relative 'test_map/cache'
 
 # TestMap records associated files to test execution.
 module TestMap
   def self.reporter = @reporter ||= Report.new
   def self.logger = Config.config[:logger]
+
+  def self.cache
+    @cache ||= Cache.new(
+      "#{Dir.pwd}/#{Config[:cache_file]}",
+      "#{Dir.pwd}/#{Config[:out_file]}"
+    )
+  end
+
+  class << self
+    attr_accessor :suite_passed
+  end
 end
 
 # Load plugins for supported test frameworks.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-map
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Christoph Lipautz
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-26 00:00:00.000000000 Z
+date: 2026-03-01 00:00:00.000000000 Z
 dependencies: []
 description: |
   Track files that are covered by test files to execute only the necessary
@@ -18,13 +18,14 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- LICENSE
+- LICENSE.txt
 - README.md
 files:
 - CHANGELOG.md
-- LICENSE
+- LICENSE.txt
 - README.md
 - lib/test_map.rb
+- lib/test_map/cache.rb
 - lib/test_map/config.rb
 - lib/test_map/errors.rb
 - lib/test_map/file_recorder.rb
@@ -34,7 +35,6 @@ files:
 - lib/test_map/plugins/minitest.rb
 - lib/test_map/plugins/rspec.rb
 - lib/test_map/report.rb
-- lib/test_map/test_task.rb
 - lib/test_map/version.rb
 homepage: https://github.com/unused/test-map
 licenses: []
@@ -43,7 +43,7 @@ metadata:
   source_code_uri: https://github.com/unused/test-map
   changelog_uri: https://github.com/unused/test-map/main/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -51,15 +51,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Track associated files of tests.
 test_files: []

data/lib/test_map/test_task.rb

@@ -1,73 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'mapping'
-require 'rake/testtask'
-require 'minitest'
-require 'minitest/unit'
-
-module TestMap
-  # TestTask is a rake helper class.
-  class TestTask < Rake::TaskLib
-    # Error for unknown test task adapter.
-    class UnknownAdapterError < StandardError; end
-
-    def initialize(name) # rubocop:disable Lint/MissingSuper
-      @name = name
-    end
-
-    # Adapter for rspec test task
-    class RailsTestTask
-      attr_accessor :files
-
-      def call = Rails::TestUnit::Runner.run_from_rake('test', files)
-    end
-
-    # Adapter for minitest test task.
-    class MinitestTask < Minitest::TestTask
-      def call = ruby(make_test_cmd, verbose: false)
-
-      def files=(test_files)
-        self.test_globs = test_files
-      end
-    end
-
-    # Adapter for rspec test task
-    class RSpecTask
-      attr_accessor :files
-
-      def call = `rspec #{files.join(' ')}`
-    end
-
-    def self.create(name = :test) = new(name).define
-
-    def define
-      namespace @name do
-        desc 'Run tests for changed files'
-        task :changes do
-          out_file = "#{Dir.pwd}/.test-map.yml"
-          args = defined?(Rails) ? ENV['TEST']&.split : ARGV[1..]
-          test_files = Mapping.new(out_file).lookup(*args)
-
-          # puts "Running tests #{test_files.join(' ')}"
-          test_task.files = test_files
-          test_task.call
-        end
-      end
-    end
-
-    def test_task = @test_task ||= build_test_task
-
-    def build_test_task
-      if defined?(Rails)
-        return RailsTestTask.new
-      elsif defined?(Minitest)
-        require 'minitest/test_task'
-        return MinitestTask.new
-      elsif defined?(RSpec)
-        return RSpecTask.new
-      end
-
-      raise UnknownAdapterError, 'No test task adapter found'
-    end
-  end
-end