test_launcher 1.5.2 → 2.0.0

data/lib/test_launcher/queries.rb

@@ -110,30 +110,28 @@ module TestLauncher
 
     class SpecifiedNameQuery < BaseQuery
       def command
-        return unless file
-
-        shell.notify("Found matching test.")
-        runner.single_example(test_case)
-      end
-
-      def test_case
-        request.test_case(
-          file: file,
-          example: request.example_name,
-          request: request,
-        )
-      end
-
-      def file
-        if potential_files.size == 0
-          shell.warn("Could not locate file: #{request.search_string}")
-        elsif potential_files.size > 1
-          shell.warn("Too many files matched: #{request.search_string}")
+        if test_cases.empty?
+          shell.warn("Could not identify file: #{request.search_string}")
+        elsif test_cases.size == 1
+          shell.notify("Found 1 example in 1 file.")
+          runner.single_example(test_cases.first)
         else
-          potential_files.first
+          shell.notify "Found #{pluralize(test_cases.size, "example")} in #{pluralize(file_count, "file")}."
+          shell.notify "Running most recently edited. Run with '--all' to run all the tests."
+          runner.single_example(most_recently_edited_test_case)
         end
       end
 
+      def test_cases
+        @test_cases ||= potential_files.map {|file|
+          request.test_case(
+            file: file,
+            example: request.example_name,
+            request: request,
+          )
+        }
+      end
+
       def potential_files
         @potential_files ||= searcher.test_files(request.search_string)
       end
@@ -218,7 +216,7 @@ module TestLauncher
           runner.multiple_examples_same_file(test_cases) # it will regex with the query
         elsif request.run_all?
           shell.notify "Found #{pluralize(test_cases.size, "example")} in #{pluralize(file_count, "file")}."
-          runner.multiple_files(test_cases)
+          runner.multiple_examples(test_cases)
         else
           shell.notify "Found #{pluralize(test_cases.size, "example")} in #{pluralize(file_count, "file")}."
           shell.notify "Running most recently edited. Run with '--all' to run all the tests."
@@ -285,20 +283,38 @@ module TestLauncher
       LINE_SPLIT_REGEX = /\A(?<file>.*):(?<line_number>\d+)\Z/
 
       def command
-        match = request.search_string.match(LINE_SPLIT_REGEX)
-        return unless match
+        return unless search_results.any?
 
-        search_result = searcher.by_line(match[:file], match[:line_number].to_i)
-        return unless search_result
-
-        if search_result[:line_number]
-          shell.notify("Found 1 example on line #{search_result[:line_number]}.")
-          runner.single_example(request.test_case(file: search_result[:file], line_number: search_result[:line_number], example: search_result[:example_name], request: request))
+        if one_file?
+          shell.notify "Found #{pluralize(file_count, "file")}."
+          runner.by_line_number(test_cases.first)
         else
-          shell.notify("Found file, but line is not inside an example.")
-          runner.single_file(request.test_case(file: search_result[:file], request: request))
+          shell.notify "Found #{pluralize(file_count, "file")}."
+          shell.notify "Cannot run all tests with --all because test frameworks don't accept multiple file/lines combos."
+          runner.by_line_number(most_recently_edited_test_case)
         end
+      end
 
+      def test_cases
+        @test_cases ||= search_results.map {|sr|
+          request.test_case(
+            file: sr[:file],
+            line_number: sr[:line_number],
+            example: sr[:example_name],
+            request: request
+          )
+        }
+      end
+
+      def search_results
+        @search_results ||= begin
+          match = request.search_string.match(LINE_SPLIT_REGEX)
+          if match
+            searcher.by_line(match[:file], match[:line_number].to_i)
+          else
+            []
+          end
+        end
       end
     end
 

data/lib/test_launcher/shell/runner.rb

@@ -1,5 +1,6 @@
 require "test_launcher/shell/color"
 require "bundler"
+require "shellwords"
 
 module TestLauncher
   module Shell
@@ -52,7 +53,7 @@ module TestLauncher
       private
 
       def log(msg)
-        %x{echo "#{msg}" >> #{log_path}}
+        %x{echo #{Shellwords.escape(msg)} >> #{log_path}}
       end
 
       def shell_out(command)

data/lib/test_launcher/version.rb

@@ -1,3 +1,3 @@
 module TestLauncher
-  VERSION = "1.5.2"
+  VERSION = "2.0.0"
 end

data/test/test_helpers/integration_helper.rb

@@ -8,30 +8,23 @@ module TestLauncher
   module IntegrationHelper
     include DefaultMocks
 
-    class IntegrationShell < Shell::Runner
+    class IntegrationShell < MockShell
       def exec(string)
-        raise "Cannot exec twice!" if defined?(@exec)
+        raise "Cannot exec twice!" if @exec
         @exec = string
       end
 
       def recall_exec
         @exec
       end
+
+      def reset
+        @exec = nil
+      end
     end
 
     private
 
-    def system_path(relative_dir)
-      File.join(Dir.pwd, relative_dir)
-    end
-
-    def launch(search_string, run_all: false, framework:, name: nil)
-      argv = [search_string, "--framework", framework]
-      argv << "--all" if run_all
-      argv.concat(["--name", name]) if name
-      env = {}
-      CLI.launch(argv, env, shell: shell_mock)
-    end
 
     def shell_mock
       @shell_mock ||= IntegrationShell.new

data/test/test_helpers/mocks.rb

@@ -40,6 +40,7 @@ module TestLauncher
     impl(:single_file) { "single_file_return" }
     impl(:multiple_files) { "multiple_files_return" }
     impl(:single_example) { "single_example_return" }
+    impl(:by_line_number) { "by_line_number_return" }
   end
 
   require "test_launcher/frameworks/base"

data/test/test_helpers/mocks/searcher_mock.rb

@@ -17,7 +17,7 @@ module TestLauncher
       end
 
       def to_file_mock
-        FileMock.new(@path, @lines, @time)
+        FileMock.new(@path, @lines, @mtime)
       end
     end
 
@@ -27,6 +27,8 @@ module TestLauncher
         @path = path
         @lines = lines
         File.stubs(:mtime).with(path).returns(mtime)
+        File.stubs(:exist?).returns(false)
+        File.stubs(:exist?).with(path).returns(true)
       end
 
       def grep(regex)

data/test/test_launcher/ex_unit_integration_test.rb

@@ -0,0 +1,392 @@
+require "test_helper"
+require "test_helpers/integration_helper"
+
+module TestLauncher
+  class ExUnitIntegrationTest < TestCase
+    include IntegrationHelper
+
+    def launch(query, env: {}, searcher:)
+      query += " --framework ex_unit "
+      shell_mock.reset
+      CLI.launch(query.split(" "), env, shell: shell_mock, searcher: searcher)
+    end
+
+    def test__by_example__single_method
+      searcher = MemorySearcher.new do |searcher|
+        searcher.mock_file do |f|
+          f.path "/src/test/file_1_test.exs"
+          f.contents <<-RB
+            defmodule MyApp.File1Test do
+              test "test_name" do
+              end
+            end
+          RB
+        end
+      end
+
+      launch("test_name", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_1_test.exs:2", shell_mock.recall_exec
+
+      launch("n", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_1_test.exs:2", shell_mock.recall_exec
+    end
+
+    def test__by_example__multiple_methods__same_file
+      searcher = MemorySearcher.new do |searcher|
+        searcher.mock_file do |f|
+          f.path "/src/test/file_1_test.exs"
+          f.contents <<-RB
+            defmodule File1Test do
+              test "test_name_1" do
+              end
+
+              test "test_name_2" do
+              end
+            end
+          RB
+        end
+      end
+
+      launch("name_", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_1_test.exs", shell_mock.recall_exec
+    end
+
+    def test__by_example__multiple_methods__different_files
+      searcher = MemorySearcher.new do |searcher|
+        searcher.mock_file do |f|
+          f.path "/src/test/file_1_test.exs"
+          f.mtime Time.new(2014, 01, 01, 00, 00, 00)
+          f.contents <<-RB
+            test "test_name_1" do
+            test "test_name_2" do
+          RB
+        end
+
+        searcher.mock_file do |f|
+          f.path "/src/test/file_2_test.exs"
+          f.mtime Time.new(2015, 01, 01, 00, 00, 00)
+          f.contents <<-RB
+            test "test_name_1" do
+            test "test_name_2" do
+          RB
+        end
+
+        searcher.mock_file do |f|
+          f.path "/src/test/file_3_test.exs"
+          f.mtime Time.new(2013, 01, 01, 00, 00, 00)
+          f.contents <<-RB
+            test "test_name_2" do
+          RB
+        end
+      end
+
+      launch("name_1", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_2_test.exs:1", shell_mock.recall_exec
+
+      launch("name_2", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_2_test.exs:2", shell_mock.recall_exec
+
+      launch("name_1 --all", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_1_test.exs /src/test/file_2_test.exs", shell_mock.recall_exec
+
+      launch("name_2 --all", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_1_test.exs /src/test/file_2_test.exs /src/test/file_3_test.exs", shell_mock.recall_exec
+    end
+
+    def test__by_filename
+      searcher = MemorySearcher.new do |searcher|
+        searcher.mock_file do |f|
+          f.path "/src/test/file_1_test.exs"
+          f.contents ""
+        end
+      end
+
+      launch("file_1", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_1_test.exs", shell_mock.recall_exec
+
+      launch("file_1_test.exs", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_1_test.exs", shell_mock.recall_exec
+
+      launch("/file_1", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_1_test.exs", shell_mock.recall_exec
+
+      launch(".exs", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_1_test.exs", shell_mock.recall_exec
+
+      launch("/src/test/file_1", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_1_test.exs", shell_mock.recall_exec
+
+      launch("src/test/file_1", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_1_test.exs", shell_mock.recall_exec
+
+      launch("st/file_1", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_1_test.exs", shell_mock.recall_exec
+    end
+
+    def test__by_filename__multiple_files_found
+      searcher = MemorySearcher.new do |searcher|
+        searcher.mock_file do |f|
+          f.path "/src/test/file_1_test.exs"
+          f.mtime Time.new(2013, 01, 01, 00, 00, 00)
+        end
+
+        searcher.mock_file do |f|
+          f.path "/src/test/file_2_test.exs"
+          f.mtime Time.new(2015, 01, 01, 00, 00, 00)
+        end
+
+        searcher.mock_file do |f|
+          f.path "/src/test/file_3_test.exs"
+          f.mtime Time.new(2014, 01, 01, 00, 00, 00)
+        end
+
+        searcher.mock_file do |f|
+          f.path "/src/test/other_test.exs"
+        end
+      end
+
+      launch("file_1", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_1_test.exs", shell_mock.recall_exec
+
+      launch("file", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_2_test.exs", shell_mock.recall_exec
+
+      launch("file --all", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_1_test.exs /src/test/file_2_test.exs /src/test/file_3_test.exs", shell_mock.recall_exec
+    end
+
+    def test__by_filename__preferred_over_regex_and_test_name_matches
+      searcher = MemorySearcher.new do |searcher|
+        searcher.mock_file do |f|
+          f.path "/src/test/file_1_test.exs"
+          f.contents <<-RB
+            test "test_name" do
+          RB
+        end
+
+        searcher.mock_file do |f|
+          f.path "/src/test/name_test.exs"
+        end
+
+        searcher.mock_file do |f|
+          f.path "/src/test/other_test.exs"
+          f.contents <<-RB
+            regex will match name_test
+          RB
+        end
+      end
+
+      launch("name_test", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/name_test.exs", shell_mock.recall_exec
+    end
+
+    def test__by_multiple_filenames__multiple_files_found
+      searcher = MemorySearcher.new do |searcher|
+        searcher.mock_file do |f|
+          f.path "/src/test/file_1_test.exs"
+          f.mtime Time.new(2013, 01, 01, 00, 00, 00)
+          f.contents ""
+        end
+
+        searcher.mock_file do |f|
+          f.path "/src/test/file_2_test.exs"
+          f.mtime Time.new(2015, 01, 01, 00, 00, 00)
+          f.contents ""
+        end
+
+        searcher.mock_file do |f|
+          f.path "/src/test/file_3_test.exs"
+          f.mtime Time.new(2014, 01, 01, 00, 00, 00)
+          f.contents ""
+        end
+
+        searcher.mock_file do |f|
+          f.path "/src/test/other_test.exs"
+          f.contents ""
+        end
+      end
+
+      launch("file_1 file_2", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_1_test.exs /src/test/file_2_test.exs", shell_mock.recall_exec
+
+      launch("file_1 file", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_1_test.exs /src/test/file_2_test.exs /src/test/file_3_test.exs", shell_mock.recall_exec
+
+      # If multiple queries are submitted but not all of them match,
+      # then what should we do? For now, we assume that it's only
+      # considered a match if each query term matches at least one
+      # or more files.
+      launch("file_1 gibberish", searcher: searcher)
+      assert_equal nil, shell_mock.recall_exec
+    end
+
+    def test__by_regex__one_match
+      searcher = MemorySearcher.new do |searcher|
+        searcher.mock_file do |f|
+          f.path "/src/test/file_1_test.exs"
+          f.mtime Time.new(2013, 01, 01, 00, 00, 00)
+          f.contents <<-RB
+            regex match 1
+            regex match 2
+            regex match 3
+          RB
+        end
+
+        searcher.mock_file do |f|
+          f.path "/src/test/file_2_test.exs"
+          f.mtime Time.new(2015, 01, 01, 00, 00, 00)
+          f.contents <<-RB
+            regex match 1
+            regex match 2
+          RB
+        end
+
+        searcher.mock_file do |f|
+          f.path "/src/test/file_3_test.exs"
+          f.mtime Time.new(2014, 01, 01, 00, 00, 00)
+          f.contents <<-RB
+            regex match 1
+            regex match 3
+          RB
+        end
+      end
+
+      launch("regex match 1", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_2_test.exs", shell_mock.recall_exec
+
+      launch("regex match 3", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_3_test.exs", shell_mock.recall_exec
+
+      launch("regex match", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_2_test.exs", shell_mock.recall_exec
+
+      launch("regex match --all", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_1_test.exs /src/test/file_2_test.exs /src/test/file_3_test.exs", shell_mock.recall_exec
+    end
+
+    def test__by_example__handles_regex_for_example_name
+      searcher = MemorySearcher.new do |searcher|
+        searcher.mock_file do |f|
+          f.path "/src/test/file_1_test.exs"
+          f.mtime Time.new(2013, 01, 01, 00, 00, 00)
+          f.contents <<-RB
+            test "test_name_1" do
+          RB
+        end
+
+        searcher.mock_file do |f|
+          f.path "/src/test/file_2_test.exs"
+          f.mtime Time.new(2015, 01, 01, 00, 00, 00)
+          f.contents <<-RB
+            test "test_name_2" do
+          RB
+        end
+      end
+
+      launch("test_name_1x?", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_1_test.exs:1", shell_mock.recall_exec
+
+      launch("test_name_2|test_name_1", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_2_test.exs:1", shell_mock.recall_exec
+
+      launch('test_name_\d', searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_2_test.exs:1", shell_mock.recall_exec
+
+      launch('test_name_\d --all', searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_1_test.exs /src/test/file_2_test.exs", shell_mock.recall_exec
+    end
+
+    def test__not_found
+      searcher = MemorySearcher.new do |searcher|
+        searcher.mock_file do |f|
+          f.path "/src/test/file_1_test.exs"
+          f.mtime Time.new(2013, 01, 01, 00, 00, 00)
+          f.contents <<-RB
+            some stuff
+          RB
+        end
+      end
+
+      launch("gibberish", searcher: searcher)
+      assert_equal nil, shell_mock.recall_exec
+    end
+
+    def test__different_roots
+      searcher = MemorySearcher.new do |searcher|
+        searcher.mock_file do |f|
+          f.path "/src/test/file_1_test.exs"
+          f.mtime Time.new(2013, 01, 01, 00, 00, 00)
+          f.contents <<-RB
+            test "test_name_1" do
+          RB
+        end
+
+        searcher.mock_file do |f|
+          f.path "/src/test/file_2_test.exs"
+          f.mtime Time.new(2015, 01, 01, 00, 00, 00)
+          f.contents <<-RB
+            test "test_name_2" do
+          RB
+        end
+
+        searcher.mock_file do |f|
+          f.path "/src/inline/project/test/file_1_test.exs"
+          f.mtime Time.new(2014, 01, 01, 00, 00, 00)
+          f.contents <<-RB
+            test "test_name_1" do
+          RB
+        end
+      end
+
+      launch("test_name_1", searcher: searcher)
+      assert_equal "cd /src/inline/project && mix test /src/inline/project/test/file_1_test.exs:1", shell_mock.recall_exec
+
+      launch("test_name_1 --all", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_1_test.exs; cd -;\n\ncd /src/inline/project && mix test /src/inline/project/test/file_1_test.exs", shell_mock.recall_exec
+
+      launch("file --all", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_1_test.exs /src/test/file_2_test.exs; cd -;\n\ncd /src/inline/project && mix test /src/inline/project/test/file_1_test.exs", shell_mock.recall_exec
+
+      launch("file_1", searcher: searcher)
+      assert_equal "cd /src/inline/project && mix test /src/inline/project/test/file_1_test.exs", shell_mock.recall_exec
+
+      launch("file_1 --all", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_1_test.exs; cd -;\n\ncd /src/inline/project && mix test /src/inline/project/test/file_1_test.exs", shell_mock.recall_exec
+    end
+
+    def test__by_line_number__just_passes_through_to_ex_unit
+      searcher = MemorySearcher.new do |searcher|
+        searcher.mock_file do |f|
+          f.path "/src/test/file_1_test.exs"
+          f.mtime Time.new(2013, 01, 01, 00, 00, 00)
+          f.contents ""
+        end
+      end
+
+      launch("file_1_test.exs:1", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_1_test.exs:1", shell_mock.recall_exec
+
+      launch("file_1_test.exs:273", searcher: searcher)
+      assert_equal "cd /src && mix test /src/test/file_1_test.exs:273", shell_mock.recall_exec
+    end
+
+    def test__by_line_number__multiple_files
+      searcher = MemorySearcher.new do |searcher|
+        searcher.mock_file do |f|
+          f.path "/src/test/file_1_test.exs"
+          f.mtime Time.new(2013, 01, 01, 00, 00, 00)
+          f.contents ""
+        end
+
+        searcher.mock_file do |f|
+          f.path "/src/inline/project/test/file_1_test.exs"
+          f.mtime Time.new(2014, 01, 01, 00, 00, 00)
+          f.contents ""
+        end
+      end
+
+      launch("file_1_test.exs:1", searcher: searcher)
+      assert_equal "cd /src/inline/project && mix test /src/inline/project/test/file_1_test.exs:1", shell_mock.recall_exec
+    end
+  end
+end