parallel_tests 2.21.3 → 4.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf77da70ec28df90a21b90572420fadab460301e3ec1478a0cffd3e60921e075
-  data.tar.gz: 47bd7a45257b1bda6b5d6aab216d97962619876f9fd3c8600ba4ef06d2e1a32a
+  metadata.gz: a9044c95c595a48f89a621563c609a4c9fa89d851792ca694a30fcaf947a2119
+  data.tar.gz: 248e38e467b9070c1666819e2c1dc9149b791644b42e8a90cd53df82ebb80eed
 SHA512:
-  metadata.gz: 93c5b2c81652075847d8ec76e3e618a207adc20df5cafcc5328c0e7920f9bf5a0f1e6ddc0b2256dec6c282c06227992958179096c952033d6874933f7aa384d7
-  data.tar.gz: 4b7bd0ec398dd38a681eb0ef7c2849740b54dc00cf52dad144dccfaec5b7faeaa2edabb1d2704cdb3071193b9200d5515bd8ef492bc73cd81860e08f09010cf8
+  metadata.gz: 363e8d317a43d03043a270c19d05f60071bd05a9b435a0545454e81b96d875b694dd4fadc74669ba136990d57d863883132a19ff7fd1c9c4169e2c16a8e2db38
+  data.tar.gz: ef251fa00adf1310c5281ee4985119ce6b4810d121d87a3a4a7f6b6a03aa968ed9be7847eec127e74a118983e4454b181635d1538b1a17b5f242fbb11839caa9

data/Readme.md

@@ -1,8 +1,7 @@
 # parallel_tests
 
 [![Gem Version](https://badge.fury.io/rb/parallel_tests.svg)](https://rubygems.org/gems/parallel_tests)
-[![Build Status](https://travis-ci.org/grosser/parallel_tests.svg)](https://travis-ci.org/grosser/parallel_tests/builds)
-[![Build status](https://ci.appveyor.com/api/projects/status/708b1up4pqc34x3y?svg=true)](https://ci.appveyor.com/project/grosser/parallel-tests)
+[![Build status](https://github.com/grosser/parallel_tests/workflows/test/badge.svg)](https://github.com/grosser/parallel_tests/actions?query=workflow%3Atest)
 
 Speedup Test::Unit + RSpec + Cucumber + Spinach by running parallel on multiple CPU cores.<br/>
 ParallelTests splits tests into even groups (by number of lines or runtime) and runs each group in a single process with its own database.
@@ -37,9 +36,15 @@ test:
 ### Copy development schema (repeat after migrations)
     rake parallel:prepare
 
+### Run migrations in additional database(s) (repeat after migrations)
+    rake parallel:migrate
+
 ### Setup environment from scratch (create db and loads schema, useful for CI)
     rake parallel:setup
 
+### Drop all test databases
+    rake parallel:drop
+
 ### Run!
     rake parallel:test          # Test::Unit
     rake parallel:spec          # RSpec
@@ -82,6 +87,8 @@ Running things once
 ===================
 
 ```Ruby
+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
@@ -97,7 +104,6 @@ at_exit do
     undo_something
   end
 end
-
 ```
 
 Even test group run-times
@@ -113,9 +119,9 @@ Rspec: Add to your `.rspec_parallel` (or `.rspec`) :
     --format progress
     --format ParallelTests::RSpec::RuntimeLogger --out tmp/parallel_runtime_rspec.log
 
-To use a custom logfile location (default: `tmp/parallel_runtime_spec.log`), use the CLI: `parallel_test spec -t rspec --runtime-log my.log`
+To use a custom logfile location (default: `tmp/parallel_runtime_rspec.log`), use the CLI: `parallel_test spec -t rspec --runtime-log my.log`
 
-### Test::Unit & Minitest 4/5
+### Minitest
 
 Add to your `test_helper.rb`:
 ```ruby
@@ -141,17 +147,19 @@ Add the following to your `.rspec_parallel` (or `.rspec`) :
 RSpec: FailuresLogger
 -----------------------
 
-Produce pasteable command-line snippets for each failed example.
+Produce pastable command-line snippets for each failed example. For example:
 
-E.g.
-
-    rspec /path/to/my_spec.rb:123 # should do something
+```bash
+rspec /path/to/my_spec.rb:123 # should do something
+```
 
-Add the following to your `.rspec_parallel` (or `.rspec`) :
+Add to `.rspec_parallel` or use as CLI flag:
 
     --format progress
     --format ParallelTests::RSpec::FailuresLogger --out tmp/failing_specs.log
 
+(Not needed to retry failures, for that pass [--only-failures](https://relishapp.com/rspec/rspec-core/docs/command-line/only-failures) to rspec)
+
 Cucumber: FailuresLogger
 -----------------------
 
@@ -176,42 +184,57 @@ Setup for non-rails
 
     gem install parallel_tests
     # go to your project dir
-    parallel_test test/
-    parallel_rspec spec/
-    parallel_cucumber features/
-    parallel_spinach features/
+    parallel_test
+    parallel_rspec
+    parallel_cucumber
+    parallel_spinach
+
+ - use `ENV['TEST_ENV_NUMBER']` inside your tests to select separate db/memcache/etc. (docker compose: expose it)
 
- - use `ENV['TEST_ENV_NUMBER']` inside your tests to select separate db/memcache/etc.
- - Only run selected files & folders:
+ - Only run a subset of files / folders:
 
     `parallel_test test/bar test/baz/foo_text.rb`
 
  - Pass test-options and files via `--`:
 
-    `parallel_test -- -t acceptance -f progress -- spec/foo_spec.rb spec/acceptance`
+    `parallel_rspec -- -t acceptance -f progress -- spec/foo_spec.rb spec/acceptance`
+
+ - Pass in test options, by using the -o flag (wrap everything in quotes):
+
+    `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 -->
-
     -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
+                                     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
     -i, --isolate                    Do not run any other tests in the group used by --single(-s)
-        --only-group INT[, INT]
+        --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)
+        --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.
+                                     $ 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
+                                       Process 2 will contain 3_spec.rb
+                                       Process 3 will contain all other specs
+        --only-group INT[,INT]
     -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
+                                     '_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
         --prefix-output-with-test-env-number
                                      Prefixes test env number to the output when not using --serialize-stdout
@@ -221,9 +244,13 @@ Options are:
         --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            Allowed percentage of missing runtimes (default = 50)
+        --allowed-missing [INT]      Allowed percentage of missing runtimes (default = 50)
         --unknown-runtime [FLOAT]    Use given number as unknown runtime (otherwise use average time)
-        --verbose                    Print more output
+        --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
+        --verbose                    Print debug output
+        --verbose-command            Displays the command that will be executed by each process and when there are failures displays the command executed by each process that failed
+        --quiet                      Print only tests output
     -v, --version                    Show Version
     -h, --help                       Show this.
 
@@ -252,6 +279,7 @@ TIPS
  - Instantly see failures (instead of just a red F) with [rspec-instafail](https://github.com/grosser/rspec-instafail)
  - Use [rspec-retry](https://github.com/NoRedInk/rspec-retry) (not rspec-rerun) to rerun failed tests.
  - [JUnit formatter configuration](https://github.com/grosser/parallel_tests/wiki#with-rspec_junit_formatter----by-jgarber)
+ - Use [parallel_split_test](https://github.com/grosser/parallel_split_test) to run multiple scenarios in a single spec file, concurrently. (`parallel_tests` [works at the file-level and intends to stay that way](https://github.com/grosser/parallel_tests/issues/747#issuecomment-580216980))
 
 ### Cucumber
 
@@ -262,30 +290,23 @@ TIPS
    - Builds a HTML report from JSON with support for debug msgs & embedded Base64 images.
 
 ### General
- - [SQL schema format] use :ruby schema format to get faster parallel:prepare`
  - [ZSH] use quotes to use rake arguments `rake "parallel:prepare[3]"`
  - [Memcached] use different namespaces<br/>
    e.g. `config.cache_store = ..., namespace: "test_#{ENV['TEST_ENV_NUMBER']}"`
  - Debug errors that only happen with multiple files using `--verbose` and [cleanser](https://github.com/grosser/cleanser)
  - `export PARALLEL_TEST_PROCESSORS=13` to override default processor count
  - Shell alias: `alias prspec='parallel_rspec -m 2 --'`
- - [Spring] to use spring you have to [patch it](https://github.com/grosser/parallel_tests/wiki/Spring)
+ - [Spring] Add the [spring-commands-parallel-tests](https://github.com/DocSpring/spring-commands-parallel-tests) gem to your `Gemfile` to get `parallel_tests` working with Spring.
  - `--first-is-1` will make the first environment be `1`, so you can test while running your full suite.<br/>
    `export PARALLEL_TEST_FIRST_IS_1=true` will provide the same result
  - [email_spec and/or action_mailer_cache_delivery](https://github.com/grosser/parallel_tests/wiki)
  - [zeus-parallel_tests](https://github.com/sevos/zeus-parallel_tests)
- - [Distributed parallel test (e.g. Travis Support)](https://github.com/grosser/parallel_tests/wiki/Distributed-Parallel-Tests-and-Travis-Support)
+ - [Distributed Parallel Tests on CI systems)](https://github.com/grosser/parallel_tests/wiki/Distributed-Parallel-Tests-on-CI-systems) learn how `parallel_tests` can run on distributed servers such as Travis and GitLab-CI. Also shows you how to use parallel_tests without adding `TEST_ENV_NUMBER`-backends
  - [Capybara setup](https://github.com/grosser/parallel_tests/wiki)
  - [Sphinx setup](https://github.com/grosser/parallel_tests/wiki)
  - [Capistrano setup](https://github.com/grosser/parallel_tests/wiki/Remotely-with-capistrano) let your tests run on a big box instead of your laptop
 
-Contribute your own gotaches to the [Wiki](https://github.com/grosser/parallel_tests/wiki) or even better open a PR :)
-
-TODO
-====
- - fix tests vs cucumber >= 1.2 `unknown option --format`
- - add unit tests for cucumber runtime formatter
- - fix windows bugs / get windows CI green
+Contribute your own gotchas to the [Wiki](https://github.com/grosser/parallel_tests/wiki) or even better open a PR :)
 
 Authors
 ====
@@ -369,6 +390,19 @@ inspired by [pivotal labs](https://blog.pivotal.io/labs/labs/parallelize-your-rs
  - [Aleksei Gusev](https://github.com/hron)
  - [Scott Olsen](https://github.com/scottolsen)
  - [Andrei Botalov](https://github.com/abotalov)
+ - [Zachary Attas](https://github.com/snackattas)
+ - [David Rodríguez](https://github.com/deivid-rodriguez)
+ - [Justin Doody](https://github.com/justindoody)
+ - [Sandeep Singh](https://github.com/sandeepnagra)
+ - [Calaway](https://github.com/calaway)
+ - [alboyadjian](https://github.com/alboyadjian)
+ - [Nathan Broadbent](https://github.com/ndbroadbent)
+ - [Vikram B Kumar](https://github.com/v-kumar)
+ - [Joshua Pinter](https://github.com/joshuapinter)
+ - [Zach Dennis](https://github.com/zdennis)
+ - [Jon Dufresne](https://github.com/jdufresne)
+ - [Eric Kessler](https://github.com/enkessler)
+ - [Adis Osmonov](https://github.com/adis-io)
 
 [Michael Grosser](http://grosser.it)<br/>
 michael@grosser.it<br/>

data/bin/parallel_cucumber

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # enable local usage from cloned repo
-root = File.expand_path("../..", __FILE__)
+root = File.expand_path('..', __dir__)
 $LOAD_PATH << "#{root}/lib" if File.exist?("#{root}/Gemfile")
 
 require "parallel_tests"

data/bin/parallel_rspec

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # enable local usage from cloned repo
-root = File.expand_path("../..", __FILE__)
+root = File.expand_path('..', __dir__)
 $LOAD_PATH << "#{root}/lib" if File.exist?("#{root}/Gemfile")
 
 require "parallel_tests"

data/bin/parallel_spinach

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # enable local usage from cloned repo
-root = File.expand_path("../..", __FILE__)
+root = File.expand_path('..', __dir__)
 $LOAD_PATH << "#{root}/lib" if File.exist?("#{root}/Gemfile")
 
 require "parallel_tests"

data/bin/parallel_test

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # enable local usage from cloned repo
-root = File.expand_path("../..", __FILE__)
+root = File.expand_path('..', __dir__)
 $LOAD_PATH << "#{root}/lib" if File.exist?("#{root}/Gemfile")
 
 require "parallel_tests"