parallel_tests 5.1.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6c3298881c1895193a9ecea54a6d41578ea239a2f247f88bfd796cb59d6240b
-  data.tar.gz: d4d5fc5bc795baa568a8ba3874f4d8a0e695cf72a35f10965215dbf961ac1f2f
+  metadata.gz: a7a2c5d683029ce50e608bd13d0d3d7490f3c3bcd29180a311383c9c4ae8c698
+  data.tar.gz: 6c779e00cf55b4bb34f740fb791b857b3ddeaaf42a5d595d207326184ddc0b91
 SHA512:
-  metadata.gz: 1bdfe399bd6e3e3380853522202245562ccb6e1939ea42f25276475426ac61de386a24a1365d60467114badcac87cf5c56883028e55b5d6b39ccb531ffa9d3f7
-  data.tar.gz: 93e6ddc6c20e98a86de94b5e6bd80dd0b1433a69cae9cfbcb8bf93f19aaa43e343b014c648435ca7a05f6ec81eb17c31ae332272fa45660445b068c3d9a2df78
+  metadata.gz: f363d5971f4a53180b4db97ec016b63a35e59dbf4d0416f71737e4b2e5e7c8c8aece067b45a80249123acf3c57761f6cf4daf12958ba00281e909122617e3eaf
+  data.tar.gz: 4524b05659ca8b2468023adbb1c28f41be9738230295ec630a8d8b85f74e804143a3ad3c42dddaa9a95cd0111a3530374ef0f101714ee849f402bbecdb2614cf

data/Readme.md

@@ -129,7 +129,7 @@ Test groups will often run for different times, making the full test run as slow
 
 ### RSpec
 
-Rspec: Add to your `.rspec_parallel` (or `.rspec`) :
+Rspec: Add to your `.rspec_parallel` (or `.rspec`), but can also be used via `--test-options='--format x'`:
 
     --format progress
     --format ParallelTests::RSpec::RuntimeLogger --out tmp/parallel_runtime_rspec.log
@@ -154,7 +154,7 @@ RSpec: SummaryLogger
 
 Log the test output without the different processes overwriting each other.
 
-Add the following to your `.rspec_parallel` (or `.rspec`) :
+Add the following to your `.rspec_parallel` (or `.rspec`), but can also be used via `--test-options='--format x'`:
 
     --format progress
     --format ParallelTests::RSpec::SummaryLogger --out tmp/spec_summary.log
@@ -168,7 +168,7 @@ Produce pasteable command-line snippets for each failed example. For example:
 rspec /path/to/my_spec.rb:123 # should do something
 ```
 
-Add to `.rspec_parallel` or use as CLI flag:
+Add the following to your `.rspec_parallel` (or `.rspec`), but can also be used via `--test-options='--format x'`:
 
     --format progress
     --format ParallelTests::RSpec::FailuresLogger --out tmp/failing_specs.log
@@ -188,7 +188,7 @@ Prints a single line for starting and finishing each example, to see what is cur
 [14402] [1] [PASSED] Bar bar
 ```
 
-Add to `.rspec_parallel` or use as CLI flag:
+Add the following to your `.rspec_parallel` (or `.rspec`), but can also be used via `--test-options='--format x'`:
 
       --format ParallelTests::RSpec::VerboseLogger
 
@@ -206,6 +206,8 @@ Or add the formatter to the `parallel:` profile of your `cucumber.yml`:
 
     parallel: --format progress --format ParallelTests::Cucumber::FailuresLogger --out tmp/cucumber_failures.log
 
+but can also be used via `--test-options='--format x'`:
+
 Note if your `cucumber.yml` default profile uses `<%= std_opts %>` you may need to insert this as follows `parallel: <%= std_opts %> --format progress...`
 
 To rerun failures:
@@ -237,7 +239,7 @@ Setup for non-rails
     `parallel_cucumber -n 2 -o '-p foo_profile --tags @only_this_tag or @only_that_tag --format summary'`
 
 Options are:
-<!-- copy output from bundle exec ./bin/parallel_test -h -->
+<!-- rake readme -->
     -n PROCESSES                     How many processes to use, default: available CPUs
     -p, --pattern PATTERN            run tests matching this regex pattern
         --exclude-pattern PATTERN    exclude tests matching this regex pattern
@@ -256,7 +258,8 @@ Options are:
         --failure-exit-code INT      Specify the exit code to use when tests fail
         --specify-groups SPECS       Use 'specify-groups' if you want to specify multiple specs running in multiple
                                      processes in a specific formation. Commas indicate specs in the same process,
-                                     pipes indicate specs in a new process. Cannot use with --single, --isolate, or
+                                     pipes indicate specs in a new process. If SPECS is a '-' the value for this
+                                     option is read from STDIN instead. Cannot use with --single, --isolate, or
                                      --isolate-n.  Ex.
                                      $ parallel_tests -n 3 . --specify-groups '1_spec.rb,2_spec.rb|3_spec.rb'
                                        Process 1 will contain 1_spec.rb and 2_spec.rb
@@ -265,7 +268,10 @@ Options are:
         --only-group GROUP_INDEX[,GROUP_INDEX]
                                      Only run the given group numbers.
                                      Changes `--group-by` default to 'filesize'.
-    -e, --exec COMMAND               execute this code parallel and with ENV['TEST_ENV_NUMBER']
+    -e, --exec COMMAND               execute COMMAND in parallel and with ENV['TEST_ENV_NUMBER']
+        --exec-args COMMAND          execute COMMAND in parallel with test files as arguments, for example:
+                                     $ parallel_tests --exec-args echo
+                                     > echo spec/a_spec.rb spec/b_spec.rb
     -o, --test-options 'OPTIONS'     execute test commands with those options
     -t, --type TYPE                  test(default) / rspec / cucumber / spinach
         --suffix PATTERN             override built in test file pattern (should match suffix):
@@ -285,7 +291,9 @@ Options are:
         --unknown-runtime SECONDS    Use given number as unknown runtime (otherwise use average time)
         --first-is-1                 Use "1" as TEST_ENV_NUMBER to not reuse the default test environment
         --fail-fast                  Stop all groups when one group fails (best used with --test-options '--fail-fast' if supported
-        --test-file-limit LIMIT      Limit to this number of files per test run by batching (for windows set to ~100 to stay below 8192 max command limit, might have bugs from reusing test-env-number and summarizing partial results)
+        --test-file-limit LIMIT      Limit to this number of files per test run by batching
+                                     (for windows set to ~100 to stay below 8192 max command limit, might have bugs from reusing test-env-number
+                                     and summarizing partial results)
         --verbose                    Print debug output
         --verbose-command            Combines options --verbose-process-command and --verbose-rerun-command
         --verbose-process-command    Print the command that will be executed by each process before it begins
@@ -293,21 +301,31 @@ Options are:
         --quiet                      Print only tests output
     -v, --version                    Show Version
     -h, --help                       Show this.
+<!-- rake readme -->
+
+You can run any command in parallel with `-e` / `--exec`
 
-You can run any kind of code in parallel with -e / --exec
+```bash
+parallel_test -n 3 -e 'ruby -e "puts %[hello from process #{ENV[:TEST_ENV_NUMBER.to_s].inspect}]"'
+hello from process "2"
+hello from process ""
+hello from process "3"
+```
 
-    parallel_test -n 5 -e 'ruby -e "puts %[hello from process #{ENV[:TEST_ENV_NUMBER.to_s].inspect}]"'
-    hello from process "2"
-    hello from process ""
-    hello from process "3"
-    hello from process "5"
-    hello from process "4"
+and pass arguments to a command with `--exec-args`
 
-<table>
-<tr><td></td><td>1 Process</td><td>2 Processes</td><td>4 Processes</td></tr>
-<tr><td>RSpec spec-suite</td><td>18s</td><td>14s</td><td>10s</td></tr>
-<tr><td>Rails-ActionPack</td><td>88s</td><td>53s</td><td>44s</td></tr>
-</table>
+```bash
+parallel_test -n 3 --exec-args echo
+spec/a_spec.rb spec/b_spec.rb 
+spec/c_spec.rb spec/d_spec.rb
+spec/e_spec.rb
+```
+
+and run multiple commands by using `sh` and `--exec-args`
+
+```bash
+parallel_test -n 3 --exec-args "sh -c \"echo 'hello world' && rspec \$@\" --"
+```
 
 TIPS
 ====
@@ -449,6 +467,7 @@ inspired by [pivotal labs](https://blog.pivotal.io/labs/labs/parallelize-your-rs
  - [Jay Dorsey](https://github.com/jaydorsey)
  - [hatsu](https://github.com/hatsu38)
  - [Mark Huk](https://github.com/vimutter)
+ - [Johannes Vetter](https://github.com/johvet)
 
 [Michael Grosser](http://grosser.it)<br/>
 michael@grosser.it<br/>

data/lib/parallel_tests/cli.rb

@@ -191,8 +191,9 @@ module ParallelTests
     end
 
     def parse_options!(argv)
-      newline_padding = " " * 37
+      newline_padding = 37 # poor man's way of getting a decent table like layout for -h output on 120 char width terminal
       options = {}
+
       OptionParser.new do |opts|
         opts.banner = <<~BANNER
           Run all tests in parallel, giving each process ENV['TEST_ENV_NUMBER'] ('', '2', '3', ...)
@@ -205,12 +206,14 @@ module ParallelTests
 
           Options are:
         BANNER
+
         opts.on("-n PROCESSES", Integer, "How many processes to use, default: available CPUs") { |n| options[:count] = n }
         opts.on("-p", "--pattern PATTERN", "run tests matching this regex pattern") { |pattern| options[:pattern] = /#{pattern}/ }
         opts.on("--exclude-pattern", "--exclude-pattern PATTERN", "exclude tests matching this regex pattern") { |pattern| options[:exclude_pattern] = /#{pattern}/ }
+
         opts.on(
           "--group-by TYPE",
-          <<~TEXT.rstrip.split("\n").join("\n#{newline_padding}")
+          heredoc(<<~TEXT, newline_padding)
             group tests by:
             found - order of finding files
             steps - number of cucumber/spinach steps
@@ -220,6 +223,7 @@ module ParallelTests
             default - runtime when runtime log is filled otherwise filesize
           TEXT
         ) { |type| options[:group_by] = type.to_sym }
+
         opts.on("-m COUNT", "--multiply-processes COUNT", Float, "use given number as a multiplier of processes to run") do |m|
           options[:multiply_processes] = m
         end
@@ -251,10 +255,11 @@ module ParallelTests
 
         opts.on(
           "--specify-groups SPECS",
-          <<~TEXT.rstrip.split("\n").join("\n#{newline_padding}")
+          heredoc(<<~TEXT, newline_padding)
             Use 'specify-groups' if you want to specify multiple specs running in multiple
             processes in a specific formation. Commas indicate specs in the same process,
-            pipes indicate specs in a new process. Cannot use with --single, --isolate, or
+            pipes indicate specs in a new process. If SPECS is a '-' the value for this
+            option is read from STDIN instead. Cannot use with --single, --isolate, or
             --isolate-n.  Ex.
             $ parallel_tests -n 3 . --specify-groups '1_spec.rb,2_spec.rb|3_spec.rb'
               Process 1 will contain 1_spec.rb and 2_spec.rb
@@ -266,28 +271,40 @@ module ParallelTests
         opts.on(
           "--only-group GROUP_INDEX[,GROUP_INDEX]",
           Array,
-          <<~TEXT.rstrip.split("\n").join("\n#{newline_padding}")
+          heredoc(<<~TEXT, newline_padding)
             Only run the given group numbers.
             Changes `--group-by` default to 'filesize'.
           TEXT
         ) { |groups| options[:only_group] = groups.map(&:to_i) }
 
-        opts.on("-e", "--exec COMMAND", "execute this code parallel and with ENV['TEST_ENV_NUMBER']") { |arg| options[:execute] = Shellwords.shellsplit(arg) }
+        opts.on("-e", "--exec COMMAND", "execute COMMAND in parallel and with ENV['TEST_ENV_NUMBER']") { |arg| options[:execute] = Shellwords.shellsplit(arg) }
+        opts.on(
+          "--exec-args COMMAND",
+          heredoc(<<~TEXT, newline_padding)
+            execute COMMAND in parallel with test files as arguments, for example:
+            $ parallel_tests --exec-args echo
+            > echo spec/a_spec.rb spec/b_spec.rb
+          TEXT
+        ) { |arg| options[:execute_args] = Shellwords.shellsplit(arg) }
+
         opts.on("-o", "--test-options 'OPTIONS'", "execute test commands with those options") { |arg| options[:test_options] = Shellwords.shellsplit(arg) }
+
         opts.on("-t", "--type TYPE", "test(default) / rspec / cucumber / spinach") do |type|
           @runner = load_runner(type)
         rescue NameError, LoadError => e
           puts "Runner for `#{type}` type has not been found! (#{e})"
           abort
         end
+
         opts.on(
           "--suffix PATTERN",
-          <<~TEXT.rstrip.split("\n").join("\n#{newline_padding}")
+          heredoc(<<~TEXT, newline_padding)
             override built in test file pattern (should match suffix):
             '_spec.rb$' - matches rspec files
             '_(test|spec).rb$' - matches test or spec files
           TEXT
         ) { |pattern| options[:suffix] = /#{pattern}/ }
+
         opts.on("--serialize-stdout", "Serialize stdout output, nothing will be written until everything is done") { options[:serialize_stdout] = true }
         opts.on("--prefix-output-with-test-env-number", "Prefixes test env number to the output when not using --serialize-stdout") { options[:prefix_output_with_test_env_number] = true }
         opts.on("--combine-stderr", "Combine stderr into stdout, useful in conjunction with --serialize-stdout") { options[:combine_stderr] = true }
@@ -301,7 +318,17 @@ module ParallelTests
         opts.on("--unknown-runtime SECONDS", Float, "Use given number as unknown runtime (otherwise use average time)") { |time| options[:unknown_runtime] = time }
         opts.on("--first-is-1", "Use \"1\" as TEST_ENV_NUMBER to not reuse the default test environment") { options[:first_is_1] = true }
         opts.on("--fail-fast", "Stop all groups when one group fails (best used with --test-options '--fail-fast' if supported") { options[:fail_fast] = true }
-        opts.on("--test-file-limit LIMIT", Integer, "Limit to this number of files per test run by batching (for windows set to ~100 to stay below 8192 max command limit, might have bugs from reusing test-env-number and summarizing partial results)") { |limit| options[:test_file_limit] = limit }
+
+        opts.on(
+          "--test-file-limit LIMIT",
+          Integer,
+          heredoc(<<~TEXT, newline_padding)
+            Limit to this number of files per test run by batching
+            (for windows set to ~100 to stay below 8192 max command limit, might have bugs from reusing test-env-number
+            and summarizing partial results)
+          TEXT
+        ) { |limit| options[:test_file_limit] = limit }
+
         opts.on("--verbose", "Print debug output") { options[:verbose] = true }
         opts.on("--verbose-command", "Combines options --verbose-process-command and --verbose-rerun-command") { options.merge! verbose_process_command: true, verbose_rerun_command: true }
         opts.on("--verbose-process-command", "Print the command that will be executed by each process before it begins") { options[:verbose_process_command] = true }
@@ -451,5 +478,9 @@ module ParallelTests
         yield
       end
     end
+
+    def heredoc(text, newline_padding)
+      text.rstrip.gsub("\n", "\n#{' ' * newline_padding}")
+    end
   end
 end

data/lib/parallel_tests/gherkin/runner.rb

@@ -18,11 +18,7 @@ module ParallelTests
           options[:env] ||= {}
           options[:env] = options[:env].merge({ 'AUTOTEST' => '1' }) if $stdout.tty?
 
-          cmd = executable
-          cmd += runtime_logging if File.directory?(File.dirname(runtime_log))
-          cmd += combined_scenarios
-          cmd += cucumber_opts(options[:test_options])
-          execute_command(cmd, process_number, num_processes, options)
+          execute_command(build_command(combined_scenarios, options), process_number, num_processes, options)
         end
 
         def test_file_name
@@ -41,6 +37,15 @@ module ParallelTests
           line =~ /^\d+ (steps?|scenarios?)/
         end
 
+        def build_test_command(file_list, options)
+          [
+            *executable,
+            *(runtime_logging if File.directory?(File.dirname(runtime_log))),
+            *file_list,
+            *cucumber_opts(options[:test_options])
+          ]
+        end
+
         # cucumber has 2 result lines per test run, that cannot be added
         # 1 scenario (1 failed)
         # 1 step (1 failed)

data/lib/parallel_tests/grouper.rb

@@ -48,8 +48,15 @@ module ParallelTests
 
       private
 
+      def specified_groups(options)
+        groups = options[:specify_groups]
+        return groups if groups != '-'
+
+        $stdin.read.chomp
+      end
+
       def specify_groups(items, num_groups, options, groups)
-        specify_test_process_groups = options[:specify_groups].split('|')
+        specify_test_process_groups = specified_groups(options).split('|')
         if specify_test_process_groups.count > num_groups
           raise 'Number of processes separated by pipe must be less than or equal to the total number of processes'
         end

data/lib/parallel_tests/rspec/runner.rb

@@ -6,8 +6,7 @@ module ParallelTests
     class Runner < ParallelTests::Test::Runner
       class << self
         def run_tests(test_files, process_number, num_processes, options)
-          cmd = [*executable, *options[:test_options], *color, *spec_opts, *test_files]
-          execute_command(cmd, process_number, num_processes, options)
+          execute_command(build_command(test_files, options), process_number, num_processes, options)
         end
 
         def determine_executable
@@ -42,6 +41,10 @@ module ParallelTests
           line =~ /\d+ examples?, \d+ failures?/
         end
 
+        def build_test_command(file_list, options)
+          [*executable, *options[:test_options], *color, *spec_opts, *file_list]
+        end
+
         # remove old seed and add new seed
         # --seed 1234
         # --order rand

data/lib/parallel_tests/test/runner.rb

@@ -28,15 +28,7 @@ module ParallelTests
 
         def run_tests(test_files, process_number, num_processes, options)
           require_list = test_files.map { |file| file.gsub(" ", "\\ ") }.join(" ")
-          cmd = [
-            *executable,
-            '-Itest',
-            '-e',
-            "%w[#{require_list}].each { |f| require %{./\#{f}} }",
-            '--',
-            *options[:test_options]
-          ]
-          execute_command(cmd, process_number, num_processes, options)
+          execute_command(build_command(require_list, options), process_number, num_processes, options)
         end
 
         # ignores other commands runner noise
@@ -168,6 +160,26 @@ module ParallelTests
           ["ruby"]
         end
 
+        def build_command(file_list, options)
+          if options[:execute_args]
+            options[:execute_args] + file_list
+          else
+            build_test_command(file_list, options)
+          end
+        end
+
+        # load all test files, to be overwritten by other runners
+        def build_test_command(file_list, options)
+          [
+            *executable,
+            '-Itest', # adding ./test directory to the load path for compatibility to common setups
+            '-e',
+            "%w[#{file_list}].each { |f| require %{./\#{f}} }", # using %w to keep things readable
+            '--',
+            *options[:test_options]
+          ]
+        end
+
         def sum_up_results(results)
           results = results.join(' ').gsub(/s\b/, '') # combine and singularize results
           counts = results.scan(/(\d+) (\w+)/)

data/lib/parallel_tests/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ParallelTests
-  VERSION = '5.1.0'
+  VERSION = '5.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parallel_tests
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-09 00:00:00.000000000 Z
+date: 2025-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel
@@ -69,9 +69,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/grosser/parallel_tests/issues
-  changelog_uri: https://github.com/grosser/parallel_tests/blob/v5.1.0/CHANGELOG.md
-  documentation_uri: https://github.com/grosser/parallel_tests/blob/v5.1.0/Readme.md
-  source_code_uri: https://github.com/grosser/parallel_tests/tree/v5.1.0
+  changelog_uri: https://github.com/grosser/parallel_tests/blob/v5.3.0/CHANGELOG.md
+  documentation_uri: https://github.com/grosser/parallel_tests/blob/v5.3.0/Readme.md
+  source_code_uri: https://github.com/grosser/parallel_tests/tree/v5.3.0
   wiki_uri: https://github.com/grosser/parallel_tests/wiki
   rubygems_mfa_required: 'true'
 post_install_message: