test_launcher 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9fcdbdd5ed1a8eb6fc871ec897647a78fdfb3b1
-  data.tar.gz: 2d87fa49f026322a2786e31a34ab5a73aac6e9e6
+  metadata.gz: e18c5338873c55199563af9ddc95cf56e55efe76
+  data.tar.gz: 6c0f7ff4e88fe6cfbcc6feecae0aed593783b6c0
 SHA512:
-  metadata.gz: a01f5d870505778646f8b267a61874b67be0c37edd6d567fff1a9ba542f3ef71ab4249c24fc8c93768df2b27fb25a0bfcc90150051b880c2967e364a86392163
-  data.tar.gz: 221391e05a08f49b8b15f05466c2cfae573cbbfa552471e8f8b3ff7acfa5326356f6f1ad9dae0757765997c461d7365a7cd9c4f965f01d4e426e309895ec787c
+  metadata.gz: acb65869157cd0f35d51e713df0e0ac917773320a412b305644f0e19539221ecc92cb4e25ec32d3b853b203c5a4931efda457a0c0882988f4502c1d4ab3c06c6
+  data.tar.gz: 1b42332fa3e556a0ca035da62641a452fed3b607d4cc0026c6309c4dc7e2ffa096193db1b8385a7ae345386320b014ff37a48519c328f7b1c4ab58192fc8d23d

data/README.md

@@ -101,6 +101,24 @@ git diff --name-only --diff-filter=ACMTUXB origin/master | grep _test.rb | xargs
 ```
 (see https://git-scm.com/docs/git-diff)
 
+
+```
+function tdiff()
+{
+  git diff --name-only --diff-filter=ACMTUXB $@ | grep _test.rb | xargs test_launcher
+}
+
+# Now you can:
+
+tdiff
+
+# or
+
+tdiff origin/master
+```
+
+Super fun!
+
 #Installation
 
 To install:

data/bin/test_launcher

@@ -1,8 +1,5 @@
 #!/usr/bin/env ruby
 
-require "test_launcher/cli/input_parser"
-require "test_launcher"
+require "test_launcher/cli"
 
-cli = TestLauncher::CLI::InputParser.new(ARGV)
-
-TestLauncher.launch(cli.request)
+TestLauncher::CLI.launch(ARGV, ENV)

data/lib/test_launcher/cli/input_parser.rb

@@ -1,7 +1,11 @@
 require "optparse"
 
 require "test_launcher/version"
-require "test_launcher/request"
+
+require "test_launcher/frameworks/rspec"
+require "test_launcher/frameworks/minitest"
+require "test_launcher/frameworks/elixir"
+require "test_launcher/cli/request"
 
 module TestLauncher
   module CLI
@@ -19,8 +23,9 @@ VERSION: #{TestLauncher::VERSION}
 
       DESC
 
-      def initialize(args)
-        @query = args
+      def initialize(args, env)
+        @search_string = args
+        @env = env
         @options = {}
         option_parser.parse!(args)
       rescue OptionParser::ParseError
@@ -30,18 +35,34 @@ VERSION: #{TestLauncher::VERSION}
         exit
       end
 
-      def request
-        if @query.size == 0
+      def requests(shell:, searcher:)
+        if @search_string.size == 0
           puts option_parser
           exit
         end
 
-        Request.new(
-          query: @query.join(" "),
-          run_all: @options[:run_all],
-          disable_spring: ENV["DISABLE_SPRING"],
-          framework: @options[:framework]
-        )
+        frameworks =
+          if @options[:framework] == "rspec"
+            [Frameworks::RSpec]
+          elsif @options[:framework] == "minitest"
+            [Frameworks::Minitest]
+          elsif @options[:framework] == "elixir"
+            [Frameworks::Elixir]
+          else
+            [Frameworks::Minitest, Frameworks::RSpec, Frameworks::Elixir]
+          end
+
+        frameworks.map {|framework|
+          Request.new(
+            search_string: @search_string.join(" "),
+            run_all: !!@options[:run_all],
+            disable_spring: !!@env["DISABLE_SPRING"],
+            example_name: @options[:name],
+            framework: framework,
+            shell: shell,
+            searcher: searcher
+          )
+        }
       end
 
       def options
@@ -68,9 +89,13 @@ VERSION: #{TestLauncher::VERSION}
             exit
           end
 
-          opts.on("-f", "--framework framework", "The testing framework being used. Valid options: ['minitest', 'rspec', 'guess']. Defaults to 'guess'") do |framework|
+          opts.on("-f", "--framework framework", "The testing framework being used. Valid options: ['minitest', 'rspec', 'elixir', 'guess']. Defaults to 'guess'") do |framework|
             options[:framework] = framework
           end
+
+          opts.on("-n", "--name name", "Minitest name of testcase to run") do |name|
+            options[:name] = name
+          end
         end
       end
     end

data/lib/test_launcher/cli/query.rb

@@ -0,0 +1,30 @@
+require "test_launcher/base_error"
+require "test_launcher/queries"
+require "test_launcher/cli/request"
+
+module TestLauncher
+  module CLI
+    class Query < BaseQuery
+      attr_reader :shell, :searcher
+
+      def command
+      def queries
+        requests.map {|request| Queries::GenericQuery.new(request: request)}
+      end
+
+      def requests
+        @frameworks.map {|framework|
+          Request.new(
+            framework: framework,
+            search_string: @search_string,
+            run_all: @run_all,
+            disable_spring: @disable_spring,
+            example_name: @example_name,
+            shell: shell,
+            searcher: searcher
+          )
+        }
+      end
+    end
+  end
+end

data/lib/test_launcher/cli/request.rb

@@ -0,0 +1,61 @@
+module TestLauncher
+  module CLI
+    class Request
+      def initialize(
+        search_string:,
+        framework:,
+        run_all: false,
+        disable_spring: false,
+        example_name: nil,
+        shell:,
+        searcher:
+      )
+        @search_string = search_string
+        @framework = framework
+        @run_all = run_all
+        @disable_spring = disable_spring
+        @example_name = example_name
+        @shell = shell
+        @searcher = searcher
+      end
+
+      def search_string
+        @search_string
+      end
+
+      def run_all?
+        @run_all
+      end
+
+      def disable_spring?
+        @disable_spring
+      end
+
+      def example_name
+        @example_name
+      end
+
+      def searcher
+        framework.searcher(@searcher)
+      end
+
+      def runner(*a)
+        framework.runner(*a)
+      end
+
+      def test_case(*a)
+        framework.test_case(*a)
+      end
+
+      def shell
+        @shell
+      end
+
+      private
+
+      def framework
+        @framework
+      end
+    end
+  end
+end

data/lib/test_launcher/cli.rb

@@ -0,0 +1,44 @@
+require "test_launcher/shell/runner"
+require "test_launcher/search"
+require "test_launcher/cli/input_parser"
+require "test_launcher/queries"
+
+module TestLauncher
+  module CLI
+
+    class MultiRequestQuery < Struct.new(:requests)
+
+      def command
+        command = nil
+        command_finders.each do |command_finder|
+          command = command_finder.generic_search
+          break if command
+        end
+        command
+      end
+
+      def command_finders
+        requests.map {|request| Queries::CommandFinder.new(request)}
+      end
+    end
+
+    def self.launch(argv, env, shell: Shell::Runner.new(log_path: "/tmp/test_launcher.log"))
+      searcher = Search.searcher(shell)
+
+      requests = CLI::InputParser.new(
+        argv,
+        env
+      ).requests(shell: shell, searcher: searcher)
+
+      command = MultiRequestQuery.new(requests).command
+
+      if command
+        shell.exec command
+      else
+        shell.warn "No tests found."
+      end
+    rescue BaseError => e
+      shell.warn(e)
+    end
+  end
+end

data/lib/test_launcher/frameworks/base.rb

@@ -1,23 +1,38 @@
-require "test_launcher/frameworks/implementation/locator"
 require "test_launcher/frameworks/implementation/test_case"
-require "test_launcher/frameworks/implementation/consolidator"
 
 module TestLauncher
   module Frameworks
     module Base
-      class Locator < Implementation::Locator
+      class Searcher < Struct.new(:raw_searcher)
+        def test_files(query)
+          raw_searcher
+            .find_files(query)
+            .select {|f| f.match(file_name_regex)}
+        end
+
+        def examples(query)
+          grep(example_name_regex(query))
+        end
+
+        def grep(regex)
+          raw_searcher.grep(regex, file_pattern: file_name_pattern)
+        end
+
+        def by_line(file_pattern, line_number)
+          raise NotImplementedError
+        end
+
+        private
+
         def file_name_regex
-          # for ruby to match on file names
           raise NotImplementedError
         end
 
         def file_name_pattern
-          # for bash to match on file names
           raise NotImplementedError
         end
 
-        def regex_pattern
-          # to match on examples
+        def example_name_regex(query)
           raise NotImplementedError
         end
       end
@@ -27,6 +42,10 @@ module TestLauncher
           raise NotImplementedError
         end
 
+        def multiple_examples_same_file(test_cases)
+          raise NotImplementedError
+        end
+
         def one_or_more_files(test_cases)
           raise NotImplementedError
         end

data/lib/test_launcher/frameworks/elixir.rb

@@ -0,0 +1,84 @@
+require "test_launcher/frameworks/base"
+require "test_launcher/base_error"
+
+module TestLauncher
+  module Frameworks
+    module Elixir
+      def self.active?
+        # Do not do this outside of the shell.
+        ! Dir.glob("**/test/**/*.exs").empty?
+      end
+
+      def self.test_case(*a)
+        TestCase.new(*a)
+      end
+
+      def self.searcher(*a)
+        Searcher.new(*a)
+      end
+
+      def self.runner(*a)
+        Runner.new(*a)
+      end
+
+      class Searcher < Base::Searcher
+        MultipleByLineMatches = Class.new(BaseError)
+
+        def by_line(file_pattern, line_number)
+          files = test_files(file_pattern)
+          return unless files.any?
+          raise multiple_files_error if files.size > 1
+
+          {
+            file: files.first,
+            line_number: line_number
+          }
+        end
+
+        private
+
+        def file_name_regex
+          /.*_test\.exs$/
+        end
+
+        def file_name_pattern
+          "*_test.exs"
+        end
+
+        def example_name_regex(query="")
+          "^\s*test\s+\".*#{query}.*\"\s+do"
+        end
+
+        def multiple_files_error
+          MultipleByLineMatches.new(<<-MSG)
+It looks like you are running a line number in a test file.
+
+Multiple files have been found that match your query.
+
+This case is not supported.
+          MSG
+        end
+      end
+
+      class Runner < Base::Runner
+        def single_example(test_case)
+          %{cd #{test_case.app_root} && mix test #{test_case.file}:#{test_case.line_number}}
+        end
+
+        def multiple_examples_same_file(test_cases)
+          one_or_more_files(test_cases.first)
+        end
+
+        def one_or_more_files(test_cases)
+          %{cd #{test_cases.first.app_root} && mix test #{test_cases.map(&:file).join(" ")}}
+        end
+      end
+
+      class TestCase < Base::TestCase
+        def test_root_dir_name
+          "test"
+        end
+      end
+    end
+  end
+end

data/lib/test_launcher/frameworks/implementation/test_case.rb

@@ -4,15 +4,16 @@ module TestLauncher
   module Frameworks
     module Implementation
       class TestCase
-        attr_reader :file, :example, :request
+        attr_reader :file, :example, :request, :line_number
 
         def self.from_search(file:, query:, request:)
           new(file: file, example: query, request: request)
         end
 
-        def initialize(file:, example: nil, request:)
+        def initialize(file:, example: nil, request:, line_number: nil)
           @file = file
           @example = example
+          @line_number = line_number
           @request = request
         end
 
@@ -31,7 +32,7 @@ module TestLauncher
             while !candidates.empty?
               if candidates.last == test_root_dir_name
                 root_path = File.join("/", candidates[0..-2])
-                return root_path if Dir.entries(root_path).any? {|e| e.match /Gemfile|gemspec/}
+                return root_path if Dir.entries(root_path).any? {|e| e.match /Gemfile|gemspec|mix.exs/} # TODO: extract this
               end
 
               candidates.pop
@@ -46,10 +47,6 @@ module TestLauncher
           File.join(app_root, test_root_dir_name)
         end
 
-        def runner
-          raise NotImplementedError
-        end
-
         def test_root_dir_name
           raise NotImplementedError
         end

data/lib/test_launcher/frameworks/minitest.rb

@@ -1,53 +1,104 @@
+require 'shellwords'
 require "test_launcher/frameworks/base"
+require "test_launcher/base_error"
 
 module TestLauncher
   module Frameworks
     module Minitest
-
       def self.active?
+        # Do not do this outside of the shell.
         ! Dir.glob("**/test/**/*_test.rb").empty?
       end
 
-      class Runner < Base::Runner
-        def single_example(test_case, exact_match: false)
+      def self.test_case(*a)
+        TestCase.new(*a)
+      end
 
-          name =
-            if exact_match
-              "--name=#{test_case.example}"
-            else
-              "--name=/#{test_case.example}/"
-            end
+      def self.searcher(*a)
+        Searcher.new(*a)
+      end
 
-          %{cd #{test_case.app_root} && #{test_case.runner} #{test_case.file} #{name}}
-        end
+      def self.runner(*a)
+        Runner.new(*a)
+      end
 
-        def one_or_more_files(test_cases)
-          %{cd #{test_cases.first.app_root} && #{test_cases.first.runner} #{test_cases.map(&:file).join(" ")}}
+      class Searcher < Base::Searcher
+        MultipleByLineMatches = Class.new(BaseError)
+
+        def by_line(file_pattern, line_number)
+          files = test_files(file_pattern)
+          return unless files.any?
+          raise multiple_files_error if files.size > 1
+          #
+          file = files.first
+          grep_results = raw_searcher.grep(example_name_regex, file_pattern: file)
+          # return unless grep_results.any?
+          best_result =
+            grep_results
+              .select {|r| line_number >= r[:line_number]}
+              .min_by {|r| line_number - r[:line_number]}
+
+          if best_result
+            {
+              file: best_result[:file],
+              example_name: best_result[:line].match(/(test_\w+)/)[1],
+              line_number: best_result[:line_number]
+            }
+          else
+            # line number outside of example. Run whole file
+            {
+              file: grep_results.first[:file]
+            }
+          end
         end
-      end
 
-      class Locator < Base::Locator
         private
 
         def file_name_regex
-          /.*_test\.rb/
+          /.*_test\.rb$/
         end
 
         def file_name_pattern
           "*_test.rb"
         end
 
-        def regex_pattern
-          "^\s*def test_.*#{request.query.sub(/^test_/, "")}.*"
+        def example_name_regex(query="")
+          if query.match(/^test_/)
+            "^\s*def\s+#{query}.*"
+          else
+            "^\s*def\s+test_.*#{query}.*"
+          end
         end
 
-        def test_case_class
-          TestCase
+        def multiple_files_error
+          MultipleByLineMatches.new(<<-MSG)
+  It looks like you are running a line number in a test file.
+
+  Multiple files have been found that match your query.
+
+  This case is not supported.
+          MSG
         end
+
       end
 
-      class TestCase < Base::TestCase
+      class Runner < Base::Runner
+        def single_example(test_case, name: test_case.example)
 
+          %{cd #{test_case.app_root} && #{test_case.runner} #{test_case.file} --name=/#{Shellwords.escape(name)}/}
+        end
+
+        def multiple_examples_same_file(test_cases)
+          test_case = test_cases.first
+          single_example(test_cases.first)
+        end
+
+        def one_or_more_files(test_cases)
+          %{cd #{test_cases.first.app_root} && #{test_cases.first.multiple_files_runner} #{test_cases.map(&:file).join(" ")}}
+        end
+      end
+
+      class TestCase < Base::TestCase
         def runner
           if spring_enabled?
             "bundle exec spring testunit"
@@ -58,12 +109,19 @@ module TestLauncher
           end
         end
 
+        def multiple_files_runner
+          if spring_enabled?
+            "bundle exec spring testunit"
+          else
+            "bundle exec ruby -I test -e 'ARGV.each {|f| require(f)}'"
+          end
+        end
+
         def test_root_dir_name
           "test"
         end
 
         def spring_enabled?
-          # TODO: move ENV reference to options hash
           return false if request.disable_spring?
 
           [
@@ -73,7 +131,6 @@ module TestLauncher
             File.exist?(File.join(app_root, f))
           }
         end
-
       end
     end
   end

data/lib/test_launcher/frameworks/rspec.rb

@@ -1,5 +1,4 @@
 require "shellwords"
-
 require "test_launcher/frameworks/base"
 
 module TestLauncher
@@ -10,17 +9,31 @@ module TestLauncher
         ! Dir.glob("**/*_spec.rb").empty?
       end
 
-      class Runner < Base::Runner
-        def single_example(test_case)
-          %{cd #{test_case.app_root} && rspec #{test_case.file} --example #{Shellwords.escape(test_case.example)}}
-        end
+      def self.test_case(*a)
+        TestCase.new(*a)
+      end
 
-        def one_or_more_files(test_cases)
-          %{cd #{test_cases.first.app_root} && rspec #{test_cases.map(&:file).join(" ")}}
-        end
+      def self.searcher(*a)
+        Searcher.new(*a)
+      end
+
+      def self.runner(*a)
+        Runner.new(*a)
       end
 
-      class Locator < Base::Locator
+      class Searcher < Base::Searcher
+
+        def by_line(file_pattern, line_number)
+          files = test_files(file_pattern)
+          return unless files.any?
+          raise multiple_files_error if files.size > 1
+
+          {
+            file: files.first,
+            line_number: line_number
+          }
+        end
+
         private
 
         def file_name_regex
@@ -31,12 +44,24 @@ module TestLauncher
           '*_spec.rb'
         end
 
-        def regex_pattern
-          "^\s*(it|context|(RSpec.)?describe) .*#{request.query}.* do.*"
+        def example_name_regex(query)
+          "^\s*(it|context|(RSpec.)?describe) .*#{query}.* do.*"
+        end
+      end
+
+      class Runner < Base::Runner
+        def single_example(test_case, **_)
+          %{cd #{test_case.app_root} && rspec #{test_case.file} --example #{Shellwords.escape(test_case.example)}}
+        end
+
+        def multiple_examples_same_file(test_cases)
+          test_case = test_cases.first
+          single_example(test_case)
         end
 
-        def test_case_class
-          TestCase
+
+        def one_or_more_files(test_cases)
+          %{cd #{test_cases.first.app_root} && rspec #{test_cases.map(&:file).join(" ")}}
         end
       end