test_launcher 1.5.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26993369cd4119c8bfba37182fbd4f95d9b4607d
-  data.tar.gz: e2cc315b236f0ced3a052e3fc609b382b5ade67d
+  metadata.gz: ccdfde0aec34dd6c9644f3985b2fec6c8b80d65a
+  data.tar.gz: a580b9f1354854325582f98d02a42626065cca23
 SHA512:
-  metadata.gz: dfddbd2cafefd68989321ab4f4b469cbccc35f5e6ab1f8a9105a282ea81720cd495ac4cb778a51e4f347fd7c43d1aee743aa0dc5d9a150b3bb250485ae304108
-  data.tar.gz: ba0ad8e49131fdbe06862a163f02f453c5dacfe8f4c9d45645eb1b3f0dd99fae5dae5566cf6dbf277fe616cc02123fad97f4713c05c67f37eb0498a53b1e6183
+  metadata.gz: 264cb91173593078f956c8a76e527494cd033a3d647d31d1527528eef1afb84d0273707004c55d0057bfdc7f15411384be3da46af1197d942fb05a8ee55b1be7
+  data.tar.gz: 509301a76e17513abaeb8952230a43844392f09ca0d7ae520b8909faedde428a485bf02c44ba40b17c5a9ee371f0890eae053bfd56ea1996d1fc7984aed02241

data/README.md

@@ -1,8 +1,25 @@
-#Test Launcher -->
+# Test Launcher -->
 
-Test Launcher takes some input and tries to figure out what test you want to run. It makes running tests on the command line much easier.  Test Launcher always outputs the command that it has decided to run so that you can verify that it is running the test you want it to run.
+Test Launcher takes a search query and tries to figure out what test you want to run. It makes running tests on the command line easy! Super bonus!
 
-Test Launcher works with Minitest.  RSpec support is in its infancy.  You should try it and let me know!
+You might use Test Launcher for two reasons:
+
+1. You run tests from the command line a lot.
+2. You work in a ruby app that contains inline gems/engines with their own test suites.
+
+It was built for Minitest, but it also has basic support for RSpec and ExUnit.
+
+See the __Usages__ section below for some examples.
+
+# Installation
+
+To install:
+
+```
+gem install test_launcher
+```
+
+Under the hood, it uses git to determine your project root. If you're on an app that's not using git, let me know and I can remove that dependency.
 
 ### Usage
 
@@ -19,6 +36,7 @@ But with Test Launcher, you can just type this:
 ```
 test_launcher test_blog_name_thing
 
+#=> Found 1 example in 1 file
 #=> ruby -I test test/models/blog_post_test.rb --name=test_blog_name_thing
 ```
 
@@ -30,6 +48,22 @@ test_launcher blog_post_test
 #=> ruby -I test test/models/blog_post_test.rb
 ```
 
+Maybe you'd like to run a whole folder?
+
+```
+test_launcher test/models --all
+
+#=> ruby -I test -e 'ARGV.each {|f| require(f)}' test/models/blog_post_test.rb test/models/comment_test.rb
+```
+
+You can run specific test methods by line:
+```
+test_launcher blog_post_test.rb:13
+
+#=> Found 1 example in 1 file
+#=> ruby -I test test/models/blog_post_test.rb --name=test_blog_name_thing
+```
+
 What if you just have the class name for the test?
 
 ```
@@ -55,16 +89,27 @@ test_launcher /Users/username/code/my_repo/test/models/blog_post_test.rb
 #=> ruby -I test test/models/blog_post_test.rb
 ```
 
-But can it run two files for you?
+Suppose you have multiple files you'd like to run:
 ```
 test_launcher blog_post_test.rb comment_test.rb
 
 #=> ruby -I test -e 'ARGV.each {|f| require(f)}' test/models/blog_post_test.rb test/models/comment_test.rb
 ```
 
+Or maybe you'd like to run all test methods that match a regular expression:
+
+```
+test_launcher 'hello_\w*|goodbye_\w+'
+
+#=> Found 2 methods in 2 files.
+#=> bundle exec ruby -I test -e "ARGV.push('--name=/hello_\w*|goodbye_\w+/')" -r /src/test/file_1_test.rb -r /src/test/file_2_test.rb
+```
+
 ### Inline Gems
 
-Test Launcher will automatically move to the correct subdirectory in order to run the tests.  For example, if `thing_test.rb` is within your inline_gem, you can run:
+If you work in an application that has inlined gems/engines, you've probably already experienced pain around running tests. IDEs and editor plugins have a hard time understanding how to run tests for inlined gems when you have opened the project from a parent folder. By looking for Gemfiles and gemspecs, Test Launcher can run your tests in the correct context. If you are using RubyMine in a project with inline gems, see the __RubyMine__ section below.
+
+For example, if `thing_test.rb` is within your inline_gem, you can run:
 
 ```
 test_launcher thing_test
@@ -72,7 +117,7 @@ test_launcher thing_test
 #=> cd /path/to/inline_gem && ruby -I test test/thing_test.rb
 ```
 
-You don't have to run Test Launcher from the root of your project either.  It will figure things out.
+You don't have to run Test Launcher from the root of your project either.  It will figure things out, even when using the `--all` flag!
 
 ### Spring preloader
 
@@ -86,6 +131,29 @@ test_launcher springified_test
 
 Test Launcher will not use spring if the `DISABLE_SPRING=1` environment variable is set.
 
+### Priorities
+
+Test Launcher searches for tests based on your input.
+
+Suppose you type `test_launcher thing`.  It will run tests using this priority preference:
+
+1. A single test file
+  - matches on `thing_test.rb`
+
+1. A single, specific test method name or partial name
+  - `def test_the_thing`
+
+1. Multiple test method names in the same file
+  - `def test_the_thing` and `def test_the_other_thing`
+
+1. Any test file based on a generic search
+  - runs `stuff_test.rb` because it found the word `thing` inside of it
+
+If your looks like it's specifying a line number (e.g. `file_test.rb:17`), that search will be preferred.
+
+Any time it matches multiple files, it will default to running the most recently edited file.  You can append `--all` if you want to run all matching tests, even if they are in different engines/gems!
+
+
 ### Running all tests you've changed:
 
 This will find all uncommitted `*_test.rb` files  and pass them to test_launcher to be run.  Use this before you commit so you don't accidentally commit a test you've broken.
@@ -119,18 +187,7 @@ tdiff origin/master
 
 Super fun!
 
-#Installation
-
-To install:
-
-```
-gem install test_launcher
-```
-
-Under the hood it uses git to search for files and to grep, so it will only work in git repositories.
-
-
-#Setup
+### Setup
 
 This gem installs one executable called `test_launcher`.
 
@@ -149,25 +206,6 @@ alias t='NOEXEC_DISABLE=1 test_launcher'
 
 Now you can just type `t` instead of `test_launcher`.  Much nicer!
 
-#Usage
-
-Test Launcher searches for tests based on your input.
-
-Suppose you type `test_launcher thing`.  It will run tests using this priority preference:
-
-1. A single, specific test method name or partial name
-  - `def test_the_thing`
-
-1. Multiple test method names in the same file
-  - `def test_the_thing` and `def test_the_other_thing`
-
-1. A single test file
-  - matches on `thing_test.rb`
-
-1. Any test file based on a generic search
-  - runs `stuff_test.rb` because it found the word `thing` inside of it
-
-Any time it matches multiple files, it will default to running the most recently edited file.  You can append `--all` if you want to run all matching tests, even if they are in different engines/gems!
 
 # RubyMine Support
 
@@ -230,3 +268,9 @@ I suggest that if you are using RVM, you may as well make this your alias:
 ```
 alias t='NOEXEC_DISABLE=1 test_launcher'
 ```
+
+# What's going on in there?
+
+Test Launcher began life as a bash script patching together `ag`, `awk`, `grep`, and all sorts of insanity. After looking up how to do an if/else in bash for the millionth time, I decided to rewrite it in Ruby.
+
+Test Launcher was developed using "BDD" (Bug Driven Development). Because I use it so heavily, I'd pop over and hack something precisely at the moment I needed it (often breaking all sorts of other things). I've since added some tests, but I reserve the right to break anything at anytime if only for old times' sake.

data/lib/test_launcher/cli.rb

@@ -22,9 +22,7 @@ module TestLauncher
       end
     end
 
-    def self.launch(argv, env, shell: Shell::Runner.new(log_path: "/tmp/test_launcher.log"))
-      searcher = Search.searcher(shell)
-
+    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

data/lib/test_launcher/cli/input_parser.rb

@@ -4,7 +4,7 @@ require "test_launcher/version"
 
 require "test_launcher/frameworks/rspec"
 require "test_launcher/frameworks/minitest"
-require "test_launcher/frameworks/elixir"
+require "test_launcher/frameworks/ex_unit"
 require "test_launcher/cli/request"
 
 module TestLauncher
@@ -46,10 +46,10 @@ VERSION: #{TestLauncher::VERSION}
             [Frameworks::RSpec]
           elsif @options[:framework] == "minitest"
             [Frameworks::Minitest]
-          elsif @options[:framework] == "elixir"
-            [Frameworks::Elixir]
+          elsif @options[:framework] == "ex_unit"
+            [Frameworks::ExUnit]
           else
-            [Frameworks::Minitest, Frameworks::RSpec, Frameworks::Elixir]
+            [Frameworks::Minitest, Frameworks::RSpec, Frameworks::ExUnit]
           end
 
         frameworks.map {|framework|
@@ -89,13 +89,17 @@ VERSION: #{TestLauncher::VERSION}
             exit
           end
 
-          opts.on("-f", "--framework framework", "The testing framework being used. Valid options: ['minitest', 'rspec', 'elixir', 'guess']. Defaults to 'guess'") do |framework|
+          opts.on("-f", "--framework framework", "The testing framework being used. Valid options: ['minitest', 'rspec', 'ex_unit', 'guess']. Defaults to 'guess'") do |framework|
             options[:framework] = framework
           end
 
-          opts.on("-n", "--name name", "Minitest name of testcase to run") do |name|
+          opts.on("-n", "--name name", "Name of testcase/example to run. This will pass through to the selected framework without verifying that the example actually exists. This option really only exists to work with tooling that will automatically run your tests. You shouldn't have much need for this.") do |name|
             options[:name] = name
           end
+
+          opts.on("--example example", "alias of name") do |example|
+            options[:name] = example
+          end
         end
       end
     end

data/lib/test_launcher/frameworks/base.rb

@@ -38,6 +38,10 @@ module TestLauncher
       end
 
       class Runner
+        def by_line_number(test_case)
+          raise NotImplementedError
+        end
+
         def single_example(test_case)
           raise NotImplementedError
         end
@@ -54,6 +58,13 @@ module TestLauncher
           one_or_more_files([test_case])
         end
 
+        def multiple_examples(collection)
+          collection
+            .group_by(&:app_root)
+            .map { |_root, test_cases| multiple_examples_same_root(test_cases) }
+            .join("; cd -;\n\n")
+        end
+
         def multiple_files(collection)
           collection
             .group_by(&:app_root)

data/lib/test_launcher/frameworks/{elixir.rb → ex_unit.rb}

@@ -3,7 +3,7 @@ require "test_launcher/base_error"
 
 module TestLauncher
   module Frameworks
-    module Elixir
+    module ExUnit
       def self.active?
         # Do not do this outside of the shell.
         ! Dir.glob("**/test/**/*.exs").empty?
@@ -25,13 +25,11 @@ module TestLauncher
         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
+          test_files(file_pattern).map {|file|
+            {
+              file: file,
+              line_number: line_number
+            }
           }
         end
 
@@ -48,25 +46,23 @@ module TestLauncher
         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)
+        def by_line_number(test_case)
           %{cd #{test_case.app_root} && mix test #{test_case.file}:#{test_case.line_number}}
         end
 
+        def single_example(test_case)
+          by_line_number(test_case)
+        end
+
         def multiple_examples_same_file(test_cases)
-          one_or_more_files(test_cases.first)
+          one_or_more_files(test_cases.uniq {|tc| tc.file})
+        end
+
+        def multiple_examples_same_root(test_cases)
+          one_or_more_files(test_cases.uniq {|tc| tc.file})
         end
 
         def one_or_more_files(test_cases)

data/lib/test_launcher/frameworks/minitest.rb

@@ -27,7 +27,7 @@ module TestLauncher
 
         def by_line(file_pattern, line_number)
           files = test_files(file_pattern)
-          return unless files.any?
+          return [] unless files.any?
           raise multiple_files_error if files.size > 1
           #
           file = files.first
@@ -39,16 +39,16 @@ module TestLauncher
               .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
 
@@ -72,26 +72,36 @@ module TestLauncher
 
         def multiple_files_error
           MultipleByLineMatches.new(<<-MSG)
-  It looks like you are running a line number in a test file.
+It looks like you are running a line number in a test file.
 
-  Multiple files have been found that match your query.
+Multiple files have been found that match your query.
 
-  This case is not supported.
+This case is not supported for Minitest.
+
+Open an issue on https://github.com/petekinnecom/test_launcher if this is something you have run into at least 3 times. :)
           MSG
         end
 
       end
 
       class Runner < Base::Runner
+        def by_line_number(test_case)
+          if test_case.example
+            single_example(test_case)
+          else
+            single_file(test_case)
+          end
+        end
+
         def single_example(test_case, name: test_case.example, exact_match: false)
-          regex_string =
+          name_arg =
             if exact_match
-              name
+              Shellwords.escape(name)
             else
               "/#{Shellwords.escape(name)}/"
             end
 
-          %{cd #{test_case.app_root} && #{test_case.runner} #{test_case.file} --name=#{regex_string}}
+          %{cd #{test_case.app_root} && #{test_case.example_runner} #{test_case.file} --name=#{name_arg}}
         end
 
         def multiple_examples_same_file(test_cases)
@@ -99,23 +109,25 @@ module TestLauncher
           single_example(test_cases.first)
         end
 
+        def multiple_examples_same_root(test_cases)
+          %{cd #{test_cases.first.app_root} && bundle exec ruby -I test -e "ARGV.push('--name=/#{test_cases.first.example}/')" #{test_cases.map {|tc| "-r #{tc.file}"}.uniq.join(" ")}}
+        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(" ")}}
+          %{cd #{test_cases.first.app_root} && #{test_cases.first.file_runner} #{test_cases.map(&:file).uniq.join(" ")}}
         end
       end
 
       class TestCase < Base::TestCase
-        def runner
+        def example_runner
           if spring_enabled?
             "bundle exec spring testunit"
-          elsif is_example?
-            "bundle exec ruby -I test"
           else
-            "bundle exec ruby -I test -e 'ARGV.each {|f| require(f)}'"
+            "bundle exec ruby -I test"
           end
         end
 
-        def multiple_files_runner
+        def file_runner
           if spring_enabled?
             "bundle exec spring testunit"
           else

data/lib/test_launcher/frameworks/rspec.rb

@@ -25,12 +25,12 @@ module TestLauncher
 
         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
+          files.map {|file|
+            {
+              file: file,
+              line_number: line_number
+            }
           }
         end
 
@@ -50,8 +50,12 @@ module TestLauncher
       end
 
       class Runner < Base::Runner
+        def by_line_number(test_case)
+          %{cd #{test_case.app_root} && bundle exec rspec #{test_case.file}:#{test_case.line_number}}
+        end
+
         def single_example(test_case, **_)
-          %{cd #{test_case.app_root} && rspec #{test_case.file} --example #{Shellwords.escape(test_case.example)}}
+          %{cd #{test_case.app_root} && bundle exec rspec #{test_case.file} --example #{Shellwords.escape(test_case.example)}}
         end
 
         def multiple_examples_same_file(test_cases)
@@ -59,9 +63,12 @@ module TestLauncher
           single_example(test_case)
         end
 
+        def multiple_examples_same_root(test_cases)
+          one_or_more_files(test_cases.uniq {|tc| tc.file})
+        end
 
         def one_or_more_files(test_cases)
-          %{cd #{test_cases.first.app_root} && rspec #{test_cases.map(&:file).join(" ")}}
+          %{cd #{test_cases.first.app_root} && bundle exec rspec #{test_cases.map(&:file).join(" ")}}
         end
       end