test_file_finder 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a5db49df6fa89ead1681625678682bc15b2f430c80c029fc12c3b1edd3e302b
-  data.tar.gz: 7bf00383d07d235ec18bb745cd9847cbd23ef1af258f0ee38549369e8dba486c
+  metadata.gz: f430ea47bf579ef3674aaf0e0dc9cd41dcb667496e095fe5186a3fdf4763e3d0
+  data.tar.gz: f22662e4c8e9e20af318eeca9d6a6de2f24ef494a962406e202781c464cd38c9
 SHA512:
-  metadata.gz: c18f06159878ea39337c9364a1eff56a94f22ff747d9da569a6fa5816fc7a51bc15e0990c00eb7844da9baf29d5f00154ea6b2ce9b5223ba1d96057496ca6f50
-  data.tar.gz: 7431cb14b42c17e8d82a96c9a7fd47cf7ad88b26047c9ea5620bbe38b2c5db2c1d9458f2f655ef91f8ae41e64fee69e74ff4e84ba9903785142d9f0351972f7f
+  metadata.gz: 01da410e1a12bd34d58d0d3d0212d793ba99bdaef7d7b97d3fb03fb68a9b059af700a4da5a695be1976a61ef0dec7385f19e89660630b219acaf88be4b4e7601
+  data.tar.gz: 3e3cf7a6f6a74a7d7fcef43b462ad0b78e971cc1f1116ddf37607aa2837dce44e1b42635b7d0e275929f3d74146ba74151d3c32f717c6bdb151c49ec4afc73bb

data/.gitlab-ci.yml

@@ -4,6 +4,6 @@ rspec:
     - if: $CI
 
 check-executable:
-  script: bash tff_test.sh
+  script: bundle; bundle exec rspec feature
   rules:
     - if: $CI

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    test_file_finder (0.1.0)
+    test_file_finder (0.1.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -44,7 +44,9 @@ $ 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.
+##### `-f mapping`
+
+`TestFileFinder` can be used with an optional YAML 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:
 
@@ -72,10 +74,50 @@ spec/models/widget_spec.rb
 Ruby example:
 
 ```ruby
-TestFileFinder::FileFinder.new(paths: file_paths, mapping_file: 'mapping.yml').test_files
+tff = TestFileFinder::FileFinder.new(paths: file_paths)
+tff.use TestFileFinder::MappingStrategies::PatternMatching.load('mapping.yml')
+tff.test_files
+```
+
+An example mapping file is available in `fixtures/mapping.yml`.
+
+##### `--json mapping`
+
+`TestFileFinder` can be used with an optional JSON mapping file to specify the mapping from a source file to test files.
+
+The mapping file is a JSON file containing a JSON object. The keys in the JSON are the source files, and the values are
+arrays containing the test files. For example:
+
+```json
+{
+  "app/models/project.rb": [
+    "spec/models/project_spec.rb",
+    "spec/controllers/projects_controller_spec.rb"
+  ],
+  "app/controllers/projects_controller.rb": [
+    "spec/controllers/projects_controller_spec.rb"
+  ]
+}
+```
+
+Command line example:
+
+```bash
+$ file_paths="app/models/project.rb"
+$ tff --json mapping.json $file_paths
+spec/models/project_spec.rb
+spec/controllers/projects_controller_spec.rb
+```
+
+Ruby example:
+
+```ruby
+tff = TestFileFinder::FileFinder.new(paths: file_paths)
+tff.use TestFileFinder::MappingStrategies::DirectMatching.load('mapping.json')
+tff.test_files
 ```
 
-An example mapping file is available in `spec/fixtures/mapping.yml`.
+An example mapping file is available in `fixtures/mapping.json`.
 
 ## Development
 

data/exe/tff

@@ -2,5 +2,18 @@
 require 'test_file_finder'
 
 options = TestFileFinder::OptionParser.parse!(ARGV)
-mapping = TestFileFinder::Mapping.load(options.mapping_file)
-puts TestFileFinder::FileFinder.new(paths: ARGV, mapping: mapping).test_files
+
+TestFileFinder::FileFinder.new(paths: ARGV).tap do |file_finder|
+  if options.json
+    file_finder.use TestFileFinder::MappingStrategies::DirectMatching.load_json(options.json)
+  end
+  if options.mapping_file
+    file_finder.use TestFileFinder::MappingStrategies::PatternMatching.load(options.mapping_file)
+  end
+
+  if file_finder.strategies.empty?
+    file_finder.use TestFileFinder::MappingStrategies::PatternMatching.default_rails_mapping
+  end
+
+  puts file_finder.test_files
+end

data/feature/tff_exe_spec.rb

@@ -0,0 +1,49 @@
+RSpec.describe 'tff exe' do
+  subject { `ruby -Ilib ../exe/tff #{options} #{files}` }
+
+  around do |example|
+    Dir.chdir(File.join(__dir__, '../fixtures')) do
+      example.run
+    end
+  end
+
+  context 'without any mapping' do
+    let(:options) {}
+    let(:files) { 'app/models/test_file_finder_gem_executable_widget.rb' }
+
+    it 'prints matching test files using default rails mapping' do
+      expect(subject).to eq("spec/models/test_file_finder_gem_executable_widget_spec.rb\n")
+    end
+  end
+
+  context 'with a yaml mapping' do
+    let(:options) { '-f mapping.yml' }
+    let(:files) { 'db/schema.rb' }
+
+    it 'prints matching test files using given yaml mapping' do
+      expect(subject).to eq("spec/db/schema_spec.rb\n")
+    end
+  end
+
+  context 'with a yaml mapping and json mapping' do
+    let(:options) { '-f mapping.yml --json mapping.json' }
+    let(:files) { 'db/schema.rb app/models/project.rb ' }
+
+    it 'prints matching test files using both yaml and json mappings' do
+      expect(subject.split("\n")).to match_array(%w[spec/db/schema_spec.rb spec/models/project_spec.rb spec/controllers/projects_controller_spec.rb])
+    end
+  end
+
+  context 'with only json mapping' do
+    let(:options) { '--json mapping.json' }
+    let(:files) { 'app/models/test_file_finder_gem_executable_widget.rb app/models/project.rb' }
+
+    it 'prints matching test files using json mapping' do
+      expect(subject.split("\n")).to match_array(%w[spec/models/project_spec.rb spec/controllers/projects_controller_spec.rb])
+    end
+
+    it 'does not match test file using rails mapping' do
+      expect(subject.split("\n")).not_to include('spec/models/test_file_finder_gem_executable_widget_spec.rb')
+    end
+  end
+end

data/fixtures/mapping.json

@@ -0,0 +1,9 @@
+{
+  "app/models/project.rb": [
+    "spec/models/project_spec.rb",
+    "spec/controllers/projects_controller_spec.rb"
+  ],
+  "app/controllers/projects_controller.rb": [
+    "spec/controllers/projects_controller_spec.rb"
+  ]
+}

data/fixtures/mapping.yml

@@ -0,0 +1,9 @@
+mapping:
+  - source: app/(.+)\.rb
+    test: spec/%s_spec.rb
+  - source: lib/(.+)\.rb
+    test: spec/lib/%s_spec.rb
+  - source: db/schema.rb
+    test: spec/db/schema_spec.rb
+  - source: spec/(.+)_spec.rb
+    test: spec/%s_spec.rb

data/fixtures/spec/controllers/projects_controller_spec.rb

@@ -0,0 +1 @@
+test projects controller spec

data/fixtures/spec/db/schema_spec.rb

@@ -0,0 +1 @@
+test schema spec

data/fixtures/spec/models/project_spec.rb

@@ -0,0 +1 @@
+test project spec

data/fixtures/spec/models/test_file_finder_gem_executable_widget_spec.rb

@@ -0,0 +1 @@
+existing specs

data/lib/test_file_finder.rb

@@ -1,5 +1,6 @@
 require 'test_file_finder/file_finder'
 require 'test_file_finder/mapping'
+require 'test_file_finder/mapping_strategies'
 require 'test_file_finder/option_parser'
 require 'test_file_finder/version'
 

data/lib/test_file_finder/file_finder.rb

@@ -1,8 +1,16 @@
+require 'set'
+
 module TestFileFinder
   class FileFinder
-    def initialize(paths: [], mapping: nil)
+    attr_reader :strategies
+
+    def initialize(paths: [])
       @paths = [paths].flatten
-      @mapping = mapping
+      @strategies = []
+    end
+
+    def use(strategy)
+      @strategies << strategy
     end
 
     def test_files
@@ -18,13 +26,10 @@ module TestFileFinder
     end
 
     def file_path_guesses
-      paths.flat_map do |path|
-        guess_test_files_for(path)
-      end.compact.uniq
-    end
-
-    def guess_test_files_for(path)
-      @mapping.match(path)
+      strategies.each_with_object(Set.new) do |strategy, result|
+        matches = strategy.match(paths)
+        result.merge(matches)
+      end
     end
   end
 end

data/lib/test_file_finder/mapping.rb

@@ -1,63 +1,7 @@
 require 'set'
 require 'yaml'
+require 'test_file_finder/mapping_strategies'
 
 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
+  Mapping = MappingStrategies::PatternMatching
 end

data/lib/test_file_finder/mapping_strategies.rb

@@ -0,0 +1,8 @@
+require 'test_file_finder/mapping_strategies/direct_matching'
+require 'test_file_finder/mapping_strategies/pattern_matching'
+
+module TestFileFinder
+  module MappingStrategies
+
+  end
+end

data/lib/test_file_finder/mapping_strategies/direct_matching.rb

@@ -0,0 +1,34 @@
+require 'json'
+
+module TestFileFinder
+  module MappingStrategies
+    class DirectMatching
+      JSON_ERROR_MESSAGE = 'json file should contain a json object, with array of test files as the values'.freeze
+
+      def self.load_json(json_file)
+        map = JSON.parse(File.read(json_file))
+
+        validate(map)
+
+        new.tap do |strategy|
+          strategy.map = map
+        end
+      end
+
+      def self.validate(map)
+        return if map.is_a?(Hash) && map.values.all? { |value| value.is_a?(Array) }
+
+        raise InvalidMappingFileError, JSON_ERROR_MESSAGE
+      end
+
+      attr_accessor :map
+
+      def match(files)
+        Array(files).inject(Set.new) do |result, file|
+          test_files = @map.fetch(file, [])
+          result.merge(test_files)
+        end.to_a
+      end
+    end
+  end
+end

data/lib/test_file_finder/mapping_strategies/pattern_matching.rb

@@ -0,0 +1,70 @@
+module TestFileFinder
+  module MappingStrategies
+    class PatternMatching
+      attr_reader :pattern_matchers
+
+      def self.load(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 = []
+
+        yield self if block_given?
+      end
+
+      def relate(source, test)
+        @pattern_matchers << pattern_matcher_for(source, test)
+      end
+
+      def match(files)
+        @pattern_matchers.inject(Set.new) do |result, pattern_matcher|
+          test_files = pattern_matcher.call(files)
+          result.merge(test_files)
+        end.to_a
+      end
+
+      private
+
+      def pattern_matcher_for(source, test)
+        regexp = %r{^#{source}$}
+
+        proc do |files|
+          Array(files).flat_map do |file|
+            if (match = regexp.match(file))
+              test % match.captures
+            end
+          end.compact
+        end
+      end
+    end
+  end
+end

data/lib/test_file_finder/option_parser.rb

@@ -1,7 +1,7 @@
 require 'optparse'
 
 module TestFileFinder
-  Options = Struct.new(:mapping_file)
+  Options = Struct.new(:mapping_file, :json)
 
   class OptionParser
     def self.parse!(argv)
@@ -12,6 +12,14 @@ module TestFileFinder
           opts.on('-f', '--mapping-file FILE', String, 'Use a custom test mapping file') do |mapping_file|
             options.mapping_file = mapping_file
           end
+
+          opts.on('--yaml FILE', String, 'Use a YAML test mapping file') do |mapping_file|
+            options.mapping_file = mapping_file
+          end
+
+          opts.on('--json FILE', String, 'Use a JSON mapping file') do |json|
+            options.json = json
+          end
         end.parse!(argv)
       end
     end

data/lib/test_file_finder/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test_file_finder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - GitLab
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-25 00:00:00.000000000 Z
+date: 2020-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,14 +85,23 @@ files:
 - bin/console
 - bin/setup
 - exe/tff
+- feature/tff_exe_spec.rb
+- fixtures/mapping.json
+- fixtures/mapping.yml
+- fixtures/spec/controllers/projects_controller_spec.rb
+- fixtures/spec/db/schema_spec.rb
+- fixtures/spec/models/project_spec.rb
+- fixtures/spec/models/test_file_finder_gem_executable_widget_spec.rb
 - lib/test_file_finder.rb
 - lib/test_file_finder/file_finder.rb
 - lib/test_file_finder/mapping.rb
+- lib/test_file_finder/mapping_strategies.rb
+- lib/test_file_finder/mapping_strategies/direct_matching.rb
+- lib/test_file_finder/mapping_strategies/pattern_matching.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
 licenses: []
 metadata:

data/tff_test.sh

@@ -1,30 +0,0 @@
-
-expected="spec/models/test_file_finder_gem_executable_widget_spec.rb"
-mkdir -p "spec/models"
-echo "existing specs" >> $expected
-
-actual=$( ruby -Ilib exe/tff app/models/test_file_finder_gem_executable_widget.rb)
-rm $expected
-
-if [[ -n $actual && $expected = $actual ]]
-then
-	echo "Executable verified"
-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