parallel_tests 4.7.1 → 4.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b091de564b1cd9f2c57b94dd973bceea01f7722e4c6bafbe71e6b75c7a265421
-  data.tar.gz: bf14a02a03bef8046e2973a904701f03b10bdae1ef8a84654511c18631efe179
+  metadata.gz: 40c390881f78ed6c146e2f11deee7e19fc5df5fa99494779a15743ce6a8463a0
+  data.tar.gz: 89cc457abaea5d29160f745ccc6cd57e2ba365f53f64b82248eb3033533da804
 SHA512:
-  metadata.gz: d4d7df8aed6d01ba8a9b98064a4c88ad7b88270884d9b5f24c34c2094772974c81fef357c9534e97265e57603b780c9b61af4b1a70a32ae6891ba87256633dfd
-  data.tar.gz: a0f0e19e7d02d3046f41ebe8c51a72056bd840d25b54947564b5b015df8946f0e4b0c86920b3cabca7ff1a82f29dcbb44e53daeaf92ae3721de29b6388c92fe0
+  metadata.gz: d1cc1c8645f580ea2eb43ee650e24a1c314c1af93937a5d11a8591e405bbc429b23fcfc79ed92bc50f9d15ec3a1aa35abe1db2a718927dbab50b1077a4fa91c6
+  data.tar.gz: b50b820699c76f128d1bce2495d5f2363cac1a53e978713c6e3a51b5e298f841292153a898514ded1153d7c99c230e67c95f3f23c6a4416a78dc26991c875b11

data/Readme.md

@@ -1,7 +1,7 @@
 # parallel_tests
 
 [![Gem Version](https://badge.fury.io/rb/parallel_tests.svg)](https://rubygems.org/gems/parallel_tests)
-[![Build status](https://github.com/grosser/parallel_tests/workflows/test/badge.svg)](https://github.com/grosser/parallel_tests/actions?query=workflow%3Atest)
+[![Build status](https://github.com/grosser/parallel_tests/workflows/test/badge.svg)](https://github.com/grosser/parallel_tests/actions?query=workflow%3Atest&branch=master)
 
 Speedup Minitest + RSpec + Turnip + Cucumber + Spinach by running parallel on multiple CPU cores.<br/>
 ParallelTests splits tests into balanced groups (by number of lines or runtime) and runs each group in a process with its own database.
@@ -93,7 +93,7 @@ rake "parallel:rake[my:custom:task,2]"
 ```
 
 
-Running things once
+Running setup or teardown once
 ===================
 
 ```Ruby
@@ -121,8 +121,11 @@ Even test group runtimes
 
 Test groups will often run for different times, making the full test run as slow as the slowest group.
 
-Step 1: Use these loggers (see below) to record test runtime
-Step 2: Your next run will use the recorded test runtimes (use `--runtime-log <file>` if you picked a location different from below)
+**Step 1**: Use these loggers (see below) to record test runtime
+
+**Step 2**: The next test run will use the recorded test runtimes (use `--runtime-log <file>` if you picked a location different from below)
+
+**Step 3**: Automate upload/download of test runtime from your CI system [example](https://github.com/grosser/parallel_rails_example/blob/master/.github/workflows/test.yml) (chunks need to be combined, an alternative is [amend](https://github.com/grosser/amend))
 
 ### RSpec
 
@@ -143,8 +146,6 @@ require 'parallel_tests/test/runtime_logger' if ENV['RECORD_RUNTIME']
 results will be logged to `tmp/parallel_runtime_test.log` when `RECORD_RUNTIME` is set,
 so it is not always required or overwritten.
 
-### TODO: add instructions for other frameworks
-
 Loggers
 =======
 
@@ -237,23 +238,23 @@ Setup for non-rails
 
 Options are:
 <!-- copy output from bundle exec ./bin/parallel_test -h -->
-    -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
-        --group-by [TYPE]            group tests by:
+    -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
+        --group-by TYPE              group tests by:
                                      found - order of finding files
                                      steps - number of cucumber/spinach steps
                                      scenarios - individual cucumber scenarios
                                      filesize - by size of the file
                                      runtime - info from runtime log
                                      default - runtime when runtime log is filled otherwise filesize
-    -m, --multiply-processes [FLOAT] use given number as a multiplier of processes to run
-    -s, --single [PATTERN]           Run all matching files in the same process
+    -m, --multiply-processes COUNT   use given number as a multiplier of processes to run
+    -s, --single PATTERN             Run all matching files in the same process
     -i, --isolate                    Do not run any other tests in the group used by --single(-s)
-        --isolate-n [PROCESSES]      Use 'isolate'  singles with number of processes, default: 1
+        --isolate-n PROCESSES        Use 'isolate'  singles with number of processes, default: 1
         --highest-exit-status        Exit with the highest exit status provided by test run(s)
-        --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
+        --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
                                      --isolate-n.  Ex.
@@ -261,12 +262,13 @@ Options are:
                                        Process 1 will contain 1_spec.rb and 2_spec.rb
                                        Process 2 will contain 3_spec.rb
                                        Process 3 will contain all other specs
-        --only-group INT[,INT]       Only run the given group numbers.
+        --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']
-    -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):
+    -e, --exec COMMAND               execute this code parallel and with ENV['TEST_ENV_NUMBER']
+    -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):
                                      '_spec.rb$' - matches rspec files
                                      '_(test|spec).rb$' - matches test or spec files
         --serialize-stdout           Serialize stdout output, nothing will be written until everything is done
@@ -275,14 +277,15 @@ Options are:
         --combine-stderr             Combine stderr into stdout, useful in conjunction with --serialize-stdout
         --non-parallel               execute same commands but do not in parallel, needs --exec
         --no-symlinks                Do not traverse symbolic links to find test files
-        --ignore-tags [PATTERN]      When counting steps ignore scenarios with tags that match this pattern
+        --ignore-tags PATTERN        When counting steps ignore scenarios with tags that match this pattern
         --nice                       execute test commands with low priority.
-        --runtime-log [PATH]         Location of previously recorded test runtimes
-        --allowed-missing [INT]      Allowed percentage of missing runtimes (default = 50)
+        --runtime-log PATH           Location of previously recorded test runtimes
+        --allowed-missing COUNT      Allowed percentage of missing runtimes (default = 50)
         --allow-duplicates           When detecting files to run, allow duplicates
-        --unknown-runtime [FLOAT]    Use given number as unknown runtime (otherwise use average time)
+        --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)
         --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

data/lib/parallel_tests/cli.rb

@@ -109,8 +109,19 @@ module ParallelTests
     end
 
     def run_tests(group, process_number, num_processes, options)
-      if group.empty?
-        { stdout: '', exit_status: 0, command: nil, seed: nil }
+      if (limit = options[:test_file_limit])
+        # TODO: will have some bugs with summarizing results and last process
+        results = group.each_slice(limit).map do |slice|
+          @runner.run_tests(slice, process_number, num_processes, options)
+        end
+        result = results[0]
+        results[1..].each do |res|
+          result[:stdout] = result[:stdout].to_s + res[:stdout].to_s
+          result[:exit_status] = [res[:exit_status], result[:exit_status]].max
+          # adding all files back in, not using original cmd to show what was actually run
+          result[:command] |= res[:command]
+        end
+        result
       else
         @runner.run_tests(group, process_number, num_processes, options)
       end
@@ -194,11 +205,11 @@ 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("-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]",
+          "--group-by TYPE",
           <<~TEXT.rstrip.split("\n").join("\n#{newline_padding}")
             group tests by:
             found - order of finding files
@@ -209,11 +220,11 @@ module ParallelTests
             default - runtime when runtime log is filled otherwise filesize
           TEXT
         ) { |type| options[:group_by] = type.to_sym }
-        opts.on("-m [FLOAT]", "--multiply-processes [FLOAT]", Float, "use given number as a multiplier of processes to run") do |multiply|
+        opts.on("-m COUNT", "--multiply-processes COUNT", Float, "use given number as a multiplier of processes to run") do |multiply|
           options[:multiply] = multiply
         end
 
-        opts.on("-s [PATTERN]", "--single [PATTERN]", "Run all matching files in the same process") do |pattern|
+        opts.on("-s PATTERN", "--single PATTERN", "Run all matching files in the same process") do |pattern|
           (options[:single_process] ||= []) << /#{pattern}/
         end
 
@@ -222,7 +233,7 @@ module ParallelTests
         end
 
         opts.on(
-          "--isolate-n [PROCESSES]",
+          "--isolate-n PROCESSES",
           Integer,
           "Use 'isolate'  singles with number of processes, default: 1"
         ) { |n| options[:isolate_count] = n }
@@ -233,13 +244,13 @@ module ParallelTests
         ) { options[:highest_exit_status] = true }
 
         opts.on(
-          "--failure-exit-code [INT]",
+          "--failure-exit-code INT",
           Integer,
           "Specify the exit code to use when tests fail"
         ) { |code| options[:failure_exit_code] = code }
 
         opts.on(
-          "--specify-groups [SPECS]",
+          "--specify-groups SPECS",
           <<~TEXT.rstrip.split("\n").join("\n#{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,
@@ -253,7 +264,7 @@ module ParallelTests
         ) { |groups| options[:specify_groups] = groups }
 
         opts.on(
-          "--only-group INT[,INT]",
+          "--only-group GROUP_INDEX[,GROUP_INDEX]",
           Array,
           <<~TEXT.rstrip.split("\n").join("\n#{newline_padding}")
             Only run the given group numbers.
@@ -261,16 +272,16 @@ module ParallelTests
           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("-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|
+        opts.on("-e", "--exec COMMAND", "execute this code parallel and with ENV['TEST_ENV_NUMBER']") { |arg| options[:execute] = 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]",
+          "--suffix PATTERN",
           <<~TEXT.rstrip.split("\n").join("\n#{newline_padding}")
             override built in test file pattern (should match suffix):
             '_spec.rb$' - matches rspec files
@@ -282,14 +293,15 @@ module ParallelTests
         opts.on("--combine-stderr", "Combine stderr into stdout, useful in conjunction with --serialize-stdout") { options[:combine_stderr] = true }
         opts.on("--non-parallel", "execute same commands but do not in parallel, needs --exec") { options[:non_parallel] = true }
         opts.on("--no-symlinks", "Do not traverse symbolic links to find test files") { options[:symlinks] = false }
-        opts.on('--ignore-tags [PATTERN]', 'When counting steps ignore scenarios with tags that match this pattern') { |arg| options[:ignore_tag_pattern] = arg }
+        opts.on('--ignore-tags PATTERN', 'When counting steps ignore scenarios with tags that match this pattern') { |arg| options[:ignore_tag_pattern] = arg }
         opts.on("--nice", "execute test commands with low priority.") { options[:nice] = true }
-        opts.on("--runtime-log [PATH]", "Location of previously recorded test runtimes") { |path| options[:runtime_log] = path }
-        opts.on("--allowed-missing [INT]", Integer, "Allowed percentage of missing runtimes (default = 50)") { |percent| options[:allowed_missing_percent] = percent }
+        opts.on("--runtime-log PATH", "Location of previously recorded test runtimes") { |path| options[:runtime_log] = path }
+        opts.on("--allowed-missing COUNT", Integer, "Allowed percentage of missing runtimes (default = 50)") { |percent| options[:allowed_missing_percent] = percent }
         opts.on('--allow-duplicates', 'When detecting files to run, allow duplicates') { options[:allow_duplicates] = true }
-        opts.on("--unknown-runtime [FLOAT]", Float, "Use given number as unknown runtime (otherwise use average time)") { |time| options[:unknown_runtime] = time }
+        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("--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 }

data/lib/parallel_tests/cucumber/runner.rb

@@ -4,8 +4,8 @@ require "parallel_tests/gherkin/runner"
 module ParallelTests
   module Cucumber
     class Runner < ParallelTests::Gherkin::Runner
-      SCENARIOS_RESULTS_BOUNDARY_REGEX = /^(Failing|Flaky) Scenarios:$/.freeze
-      SCENARIO_REGEX = %r{^cucumber features/.+:\d+}.freeze
+      SCENARIOS_RESULTS_BOUNDARY_REGEX = /^(Failing|Flaky) Scenarios:$/
+      SCENARIO_REGEX = %r{^cucumber features/.+:\d+}
 
       class << self
         def name

data/lib/parallel_tests/rspec/runtime_logger.rb

@@ -25,6 +25,8 @@ class ParallelTests::RSpec::RuntimeLogger < ParallelTests::RSpec::LoggerBase
     super if defined?(super)
   end
 
+  def seed(*); end
+
   def dump_summary(*); end
 
   def dump_failures(*); end

data/lib/parallel_tests/test/runner.rb

@@ -158,7 +158,7 @@ module ParallelTests
 
         def executable
           if (executable = ENV['PARALLEL_TESTS_EXECUTABLE'])
-            [executable]
+            Shellwords.shellsplit(executable)
           else
             determine_executable
           end

data/lib/parallel_tests/version.rb

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

data/lib/parallel_tests.rb

@@ -44,7 +44,7 @@ module ParallelTests
 
     def stop_all_processes
       pids.all.each { |pid| Process.kill(:INT, pid) }
-    rescue Errno::ESRCH
+    rescue Errno::ESRCH, Errno::EPERM
       # Process already terminated, do nothing
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parallel_tests
 version: !ruby/object:Gem::Version
-  version: 4.7.1
+  version: 4.8.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-25 00:00:00.000000000 Z
+date: 2025-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel
@@ -69,9 +69,11 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/grosser/parallel_tests/issues
-  documentation_uri: https://github.com/grosser/parallel_tests/blob/v4.7.1/Readme.md
-  source_code_uri: https://github.com/grosser/parallel_tests/tree/v4.7.1
+  changelog_uri: https://github.com/grosser/parallel_tests/blob/v4.8.0/CHANGELOG.md
+  documentation_uri: https://github.com/grosser/parallel_tests/blob/v4.8.0/Readme.md
+  source_code_uri: https://github.com/grosser/parallel_tests/tree/v4.8.0
   wiki_uri: https://github.com/grosser/parallel_tests/wiki
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -80,7 +82,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="