parallel_tests 5.2.0 → 5.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e72834dd1a8a2c46d1b09d8b6039c8b2189fba5b59d0e72fd738d349650f940
-  data.tar.gz: 1ba16b8a33eb3139b73d2c01476cfd89564cfa1de7b4c4b6a9b104afe7e229b9
+  metadata.gz: 976016bff736bf3c0a3318b375b57575596a97185e25e5991c1e4bf3853a359f
+  data.tar.gz: 970d5aa2f19a5166ce304d686681583ba20990439893e82c59926453f7d32277
 SHA512:
-  metadata.gz: 6189557d6e628b1fefe65103033027e4bd78d3eb1d9bc828427fbdc3780b23fb81b827b31626b05f196e26e9d8b721813e38a494bc4813ae38809939b60bae9b
-  data.tar.gz: 0b5135be07485245f7533139a6f559421156bffeba26d9ddd8c483e995988132610c13369f52c2d0b0fdc0f0962b09afa15c2ab167818e2f253fb73642f99bf4
+  metadata.gz: 0cc814265ca73b3ced92dad469fe94b42d9068aa29cc1ff218a74c920ef3d7c286eef27d6864b555852de6257cd2d041d801373a30c81936181bd5a7e612e672
+  data.tar.gz: feb60ffbb3b67da7990e406471bd4a8f6b4144453bc307bf33fdeca62111ed3744ca3a1a4e0fad2a80064e6db441aa68b18fb076d86586d8768d98a4f68ddbd3

data/Readme.md

@@ -101,17 +101,23 @@ require "parallel_tests"
 
 # preparation:
 # affected by race-condition: first process may boot slower than the second
-# either sleep a bit or use a lock for example File.lock
-ParallelTests.first_process? ? do_something : sleep(1)
+# the Process.ppid will be the pod of the process that started the parallel tests
+# when not using TEST_ENV_NUMBER we use a unique file per process because ppid would be the users shell
+done = "/tmp/parallel-setup-done-#{ENV['TEST_ENV_NUMBER'] ? Process.ppid : Process.pid}"
+if ParallelTests.first_process?
+  do_something
+  File.write done, "true"
+else
+  sleep 0.1 until File.exist?(done)
+end
 
 # cleanup:
-# last_process? does NOT mean last finished process, just last started
-ParallelTests.last_process? ? do_something : sleep(1)
-
+# could also use last_process? but that is just the last process to start, not the last to finish
 at_exit do
   if ParallelTests.first_process?
-    ParallelTests.wait_for_other_processes_to_finish
-    undo_something
+     File.unlink done
+     ParallelTests.wait_for_other_processes_to_finish
+     undo_something
   end
 end
 ```
@@ -239,7 +245,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
@@ -258,7 +264,7 @@ 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. If SPECS is a `-` the value for this
+                                     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'
@@ -268,7 +274,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):
@@ -288,7 +297,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
@@ -296,21 +307,31 @@ Options are:
         --quiet                      Print only tests output
     -v, --version                    Show Version
     -h, --help                       Show this.
+<!-- rake readme -->
 
-You can run any kind of code in parallel with -e / --exec
+You can run any command in parallel with `-e` / `--exec`
 
-    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"
+```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"
+```
 
-<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>
+and pass arguments to a command with `--exec-args`
+
+```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
 ====
@@ -452,6 +473,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

@@ -15,7 +15,7 @@ module ParallelTests
       ENV['DISABLE_SPRING'] ||= '1'
 
       num_processes = ParallelTests.determine_number_of_processes(options[:count])
-      num_processes = (num_processes * ParallelTests.determine_multiple(options[:multiply])).round
+      num_processes = (num_processes * ParallelTests.determine_multiple(options[:multiply_processes])).round
 
       options[:first_is_1] ||= first_is_1?
 
@@ -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,7 +255,7 @@ 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. If SPECS is a '-' the value for this
@@ -267,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 }
@@ -302,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 }
@@ -452,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/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.2.0'
+  VERSION = '5.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parallel_tests
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.3.1
 platform: ruby
 authors:
 - Michael Grosser
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-09 00:00:00.000000000 Z
+date: 2025-07-24 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.2.0/CHANGELOG.md
-  documentation_uri: https://github.com/grosser/parallel_tests/blob/v5.2.0/Readme.md
-  source_code_uri: https://github.com/grosser/parallel_tests/tree/v5.2.0
+  changelog_uri: https://github.com/grosser/parallel_tests/blob/v5.3.1/CHANGELOG.md
+  documentation_uri: https://github.com/grosser/parallel_tests/blob/v5.3.1/Readme.md
+  source_code_uri: https://github.com/grosser/parallel_tests/tree/v5.3.1
   wiki_uri: https://github.com/grosser/parallel_tests/wiki
   rubygems_mfa_required: 'true'
 post_install_message: