test_file_finder 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b01e368369d161afd0766f1ea95a296b16dc8cb5e3f20d5c8e7abf7910e8da0b
-  data.tar.gz: 442c058ea7d0ad184d5fe31d697cb9f0f3058b1fe09e03717cf8d12bbadaa5cc
+  metadata.gz: 6a5db49df6fa89ead1681625678682bc15b2f430c80c029fc12c3b1edd3e302b
+  data.tar.gz: 7bf00383d07d235ec18bb745cd9847cbd23ef1af258f0ee38549369e8dba486c
 SHA512:
-  metadata.gz: 70f2284e0d24b68b4a426acd9d42c02a4886c64e258282339459ae4df8ae5da73484916f78b3ca774b8619d88666dc40041f6820f306def6fc5f10d70a143033
-  data.tar.gz: ccfc5613ed9250411a4e2623ddcf650d2a982e7631d0d3bdb12b820278bfa07c7c0f3595424f925bfc78324c54ba1106dd2180e9bf802756c2dc0037172672dc
+  metadata.gz: c18f06159878ea39337c9364a1eff56a94f22ff747d9da569a6fa5816fc7a51bc15e0990c00eb7844da9baf29d5f00154ea6b2ce9b5223ba1d96057496ca6f50
+  data.tar.gz: 7431cb14b42c17e8d82a96c9a7fd47cf7ad88b26047c9ea5620bbe38b2c5db2c1d9458f2f655ef91f8ae41e64fee69e74ff4e84ba9903785142d9f0351972f7f

data/README.md

@@ -42,6 +42,41 @@ You can use it in a script, for example:
 $ rspec $(tff $(git diff --name-only master..head))
 ```
 
+#### Options
+
+`TestFileFinder` can be used with an optional mapping file to specify the mapping from a source file to a test file.
+
+The mapping file is a yaml file containing to entries to match file patterns to its test files. The patterns may include capturing groups to be used to identify the test file. To refer to a captured value in the test file, use the `%s` placeholder. For example:
+
+```yaml
+mapping:
+  # maps `app/file.rb` to `spec/file_spec.rb`
+  - source: app/(.+)\.rb
+    test: spec/%s_spec.rb
+  # maps `db/schema.rb` to `spec/db/schema_spec.rb`
+  - source: db/schema.rb
+    test: spec/db/schema_spec.rb
+  # maps `ee/app/models/ee/user.rb` to `ee/spec/models/user_spec.rb`
+  - source: ee/app/(.*/)ee/(.+)\.rb
+    test: ee/spec/%s%s_spec.rb
+```
+
+Command line example:
+
+```bash
+$ file_paths="app/models/widget.rb"
+$ tff -f mapping.yml $file_paths
+spec/models/widget_spec.rb
+```
+
+Ruby example:
+
+```ruby
+TestFileFinder::FileFinder.new(paths: file_paths, mapping_file: 'mapping.yml').test_files
+```
+
+An example mapping file is available in `spec/fixtures/mapping.yml`.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/exe/tff

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
 require 'test_file_finder'
 
-puts TestFileFinder::FileFinder.new(paths: ARGV).test_files
+options = TestFileFinder::OptionParser.parse!(ARGV)
+mapping = TestFileFinder::Mapping.load(options.mapping_file)
+puts TestFileFinder::FileFinder.new(paths: ARGV, mapping: mapping).test_files

data/lib/test_file_finder.rb

@@ -1,6 +1,10 @@
-require 'test_file_finder/version'
 require 'test_file_finder/file_finder'
+require 'test_file_finder/mapping'
+require 'test_file_finder/option_parser'
+require 'test_file_finder/version'
 
 module TestFileFinder
   class Error < StandardError; end
+
+  InvalidMappingFileError = Class.new(Error)
 end

data/lib/test_file_finder/file_finder.rb

@@ -1,47 +1,30 @@
-class TestFileFinder::FileFinder
-
-  def initialize(paths: [])
-    @paths = [paths].flatten
-  end
-
-  def test_files
-    search
-  end
-
-  private
-
-  attr_reader :paths
+module TestFileFinder
+  class FileFinder
+    def initialize(paths: [], mapping: nil)
+      @paths = [paths].flatten
+      @mapping = mapping
+    end
 
-  def search
-    file_path_guesses.select { |path| File.exist?(path) }
-  end
+    def test_files
+      search
+    end
 
-  def file_path_guesses
-    paths.map do |path|
-      guess_test_files_for(path)
-    end.compact.uniq
-  end
+    private
 
-  def context
-    {
-      app:      %r{^app/(.+)\.rb$},
-      lib:      %r{^lib/(.+)\.rb$},
-      spec:     %r{^spec/(.+)_spec.rb$},
-      spec_dir: 'spec',
-    }
-  end
+    attr_reader :paths
 
-  def guess_test_files_for(path)
-    if (match = context[:app]&.match(path))
-      return "#{context[:spec_dir]}/#{match[1]}_spec.rb"
+    def search
+      file_path_guesses.select { |path| File.exist?(path) }
     end
 
-    if (match = context[:lib]&.match(path))
-      return "#{context[:spec_dir]}/lib/#{match[1]}_spec.rb"
+    def file_path_guesses
+      paths.flat_map do |path|
+        guess_test_files_for(path)
+      end.compact.uniq
     end
 
-    if context[:spec]&.match(path)
-      return path
+    def guess_test_files_for(path)
+      @mapping.match(path)
     end
   end
 end

data/lib/test_file_finder/mapping.rb

@@ -0,0 +1,63 @@
+require 'set'
+require 'yaml'
+
+module TestFileFinder
+  class Mapping
+    attr_reader :pattern_matchers
+
+    def self.load(mapping_file = nil)
+      return default_rails_mapping unless mapping_file
+
+      content = File.read(mapping_file)
+      maps = YAML.load(content)['mapping']
+
+      validate(maps)
+
+      new do |mapping|
+        maps.each do |map|
+          source = map['source']
+          test = map['test']
+          mapping.relate(source, test)
+        end
+      end
+    end
+
+    def self.validate(maps)
+      raise InvalidMappingFileError, 'missing `mapping` in test mapping file' if maps.nil?
+      raise InvalidMappingFileError, 'missing `source` or `test` in test mapping file' if maps.any? { |map| incomplete?(map) }
+    end
+
+    def self.incomplete?(map)
+      map['source'].nil? || map['test'].nil?
+    end
+
+    def self.default_rails_mapping
+      new do |mapping|
+        mapping.relate(%r{^app/(.+)\.rb$}, 'spec/%s_spec.rb')
+        mapping.relate(%r{^lib/(.+)\.rb$}, 'spec/lib/%s_spec.rb')
+        mapping.relate(%r{^spec/(.+)_spec.rb$}, 'spec/%s_spec.rb')
+      end
+    end
+
+    def initialize
+      @pattern_matchers = Hash.new { |h, k| h[k] = [] }
+
+      yield self if block_given?
+    end
+
+    def relate(source, test)
+      @pattern_matchers[source] << test
+    end
+
+    def match(file)
+      @pattern_matchers.each_with_object(Set.new) do |(source, tests), result|
+        regexp = %r{^#{source}$}
+
+        if (match = regexp.match(file))
+          test_files = tests.flat_map { |test| test % match.captures }
+          result.merge(Array(test_files))
+        end
+      end.to_a
+    end
+  end
+end

data/lib/test_file_finder/option_parser.rb

@@ -0,0 +1,19 @@
+require 'optparse'
+
+module TestFileFinder
+  Options = Struct.new(:mapping_file)
+
+  class OptionParser
+    def self.parse!(argv)
+      Options.new.tap do |options|
+        ::OptionParser.new do |opts|
+          opts.banner = "Usage: tff [options] [...file_paths]"
+
+          opts.on('-f', '--mapping-file FILE', String, 'Use a custom test mapping file') do |mapping_file|
+            options.mapping_file = mapping_file
+          end
+        end.parse!(argv)
+      end
+    end
+  end
+end

data/lib/test_file_finder/version.rb

@@ -1,3 +1,3 @@
 module TestFileFinder
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/test_file_finder.gemspec

@@ -1,4 +1,3 @@
-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'test_file_finder/version'
@@ -6,12 +5,12 @@ require 'test_file_finder/version'
 Gem::Specification.new do |spec|
   spec.name          = 'test_file_finder'
   spec.version       = TestFileFinder::VERSION
-  spec.authors       = ['drew cimino']
-  spec.email         = ['dscimino@gmail.com']
+  spec.authors       = ['GitLab']
+  spec.email         = ['gitlab_rubygems@gitlab.com']
 
   spec.summary       = %q{Guesses spec file paths given input file paths.}
   spec.description   = %q{A command-line tool for guessing which spec files are relavant to a passed-in set of file paths.}
-  spec.homepage      = 'https://gitlab.com/gitlab-org/ci-cd/test-file-finder'
+  spec.homepage      = 'https://gitlab.com/gitlab-org/ci-cd/test_file_finder'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -19,8 +18,8 @@ Gem::Specification.new do |spec|
     spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
     spec.metadata['homepage_uri'] = spec.homepage
-    spec.metadata['source_code_uri'] = 'https://gitlab.com/gitlab-org/ci-cd/test-file-finder/-/tree/master'
-    spec.metadata['changelog_uri'] = 'https://gitlab.com/gitlab-org/ci-cd/test-file-finder/-/blob/master/CHANGELOG.md'
+    spec.metadata['source_code_uri'] = 'https://gitlab.com/gitlab-org/ci-cd/test_file_finder'
+    spec.metadata['changelog_uri'] = 'https://gitlab.com/gitlab-org/ci-cd/test_file_finder/-/blob/master/CHANGELOG.md'
   else
     raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
   end

data/tests.yml

@@ -0,0 +1,5 @@
+mapping:
+  - source: lib/(.+).rb
+    test: spec/lib/%s_spec.rb
+  - source: spec/spec_helper.rb
+    test: spec

data/tff_test.sh

@@ -9,8 +9,22 @@ rm $expected
 if [[ -n $actual && $expected = $actual ]]
 then
 	echo "Executable verified"
-	exit 0
 else
 	echo "Could not verify executable"
 	exit 1
 fi
+
+expected="spec/db/schema_spec.rb"
+mkdir -p "spec/db"
+echo "existing schema specs" >> $expected
+
+actual=$( ruby -Ilib exe/tff -f spec/fixtures/mapping.yml db/schema.rb)
+rm $expected
+
+if [[ -n $actual && $expected = $actual ]]
+then
+	echo "Executable using mapping verified"
+else
+	echo "Could not verify executable using mapping"
+	exit 1
+fi

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test_file_finder
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
-- drew cimino
+- GitLab
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-11 00:00:00.000000000 Z
+date: 2020-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,7 +69,7 @@ dependencies:
 description: A command-line tool for guessing which spec files are relavant to a passed-in
   set of file paths.
 email:
-- dscimino@gmail.com
+- gitlab_rubygems@gitlab.com
 executables:
 - tff
 extensions: []
@@ -87,16 +87,19 @@ files:
 - exe/tff
 - lib/test_file_finder.rb
 - lib/test_file_finder/file_finder.rb
+- lib/test_file_finder/mapping.rb
+- lib/test_file_finder/option_parser.rb
 - lib/test_file_finder/version.rb
 - test_file_finder.gemspec
+- tests.yml
 - tff_test.sh
-homepage: https://gitlab.com/gitlab-org/ci-cd/test-file-finder
+homepage: https://gitlab.com/gitlab-org/ci-cd/test_file_finder
 licenses: []
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://gitlab.com/gitlab-org/ci-cd/test-file-finder
-  source_code_uri: https://gitlab.com/gitlab-org/ci-cd/test-file-finder/-/tree/master
-  changelog_uri: https://gitlab.com/gitlab-org/ci-cd/test-file-finder/-/blob/master/CHANGELOG.md
+  homepage_uri: https://gitlab.com/gitlab-org/ci-cd/test_file_finder
+  source_code_uri: https://gitlab.com/gitlab-org/ci-cd/test_file_finder
+  changelog_uri: https://gitlab.com/gitlab-org/ci-cd/test_file_finder/-/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: