README.md in test-queue-0.5.0 vs README.md in test-queue-0.6.0
- old
+ new
@@ -1,35 +1,35 @@
-## test-queue
+# test-queue
[](https://rubygems.org/gems/test-queue)
-[](https://travis-ci.org/tmm1/test-queue)
+[](https://github.com/tmm1/test-queue/actions/workflows/test.yml)
Yet another parallel test runner, built using a centralized queue to ensure
optimal distribution of tests between workers.
Specifically optimized for CI environments: build statistics from each run
are stored locally and used to sort the queue at the beginning of the
next run.
-### design
+## Design
test-queue uses a simple master + pre-fork worker model. The master
exposes a unix domain socket server which workers use to grab tests off
the queue.
-```
+```console
─┬─ 21232 minitest-queue master
├─── 21571 minitest-queue worker [3] - AuthenticationTest
├─── 21568 minitest-queue worker [2] - ApiTest
├─── 21565 minitest-queue worker [1] - UsersControllerTest
└─── 21562 minitest-queue worker [0] - UserTest
```
test-queue also has a distributed mode, where additional masters can share
the workload and relay results back to a central master.
-### environment variables
+## Environment variables
- `TEST_QUEUE_WORKERS`: number of workers to use per master (default: all available cores)
- `TEST_QUEUE_VERBOSE`: show results as they are available (default: `0`)
- `TEST_QUEUE_SOCKET`: unix socket `path` (or tcp `address:port` pair) used for communication (default: `/tmp/test_queue_XXXXX.sock`)
- `TEST_QUEUE_RELAY`: relay results back to a central master, specified as tcp `address:port`
@@ -38,24 +38,24 @@
- `TEST_QUEUE_RELAY_TIMEOUT`: when using distributed builds, the amount of time a remote master will try to reconnect to start work
- `TEST_QUEUE_RELAY_TOKEN`: when using distributed builds, this must be the same on remote masters and the central master for remote masters to be able to connect.
- `TEST_QUEUE_REMOTE_MASTER_MESSAGE`: when using distributed builds, set this on a remote master and it will appear in that master's connection message on the central master.
- `TEST_QUEUE_SPLIT_GROUPS`: split tests up by example rather than example group. Faster for tests with short setup time such as selenium. RSpec only. Add the :no_split tag to ExampleGroups you don't want split.
-### usage
+## Usage
test-queue bundles `testunit-queue`, `minitest-queue` and `rspec-queue` binaries which can be used directly:
-```
+```console
$ minitest-queue $(find test/ -name \*_test.rb)
$ rspec-queue --format progress spec
```
But the underlying `TestQueue::Runner::TestUnit`, `TestQueue::Runner::MiniTest` and `TestQueue::Runner::RSpec` are
built to be subclassed by your application. I recommend checking a new
executable into your project using one of these superclasses.
-```
+```console
$ vim script/test-queue
$ chmod +x script/test-queue
$ git add script/test-queue
```
@@ -67,11 +67,11 @@
#!/usr/bin/env ruby
class MyAppTestRunner < TestQueue::Runner::MiniTest
def after_fork(num)
# use separate mysql database (we assume it exists and has the right schema already)
- ActiveRecord::Base.configurations['test']['database'] << num.to_s
+ ActiveRecord::Base.configurations.configs_for(env_name: 'test', name: 'primary').database << num.to_s
ActiveRecord::Base.establish_connection(:test)
# use separate redis database
$redis.client.db = num
$redis.client.reconnect
@@ -95,24 +95,24 @@
end
MyAppTestRunner.new.execute
```
-### distributed mode
+## Distributed mode
To use distributed mode, the central master must listen on a tcp port. Additional masters can be booted
-in relay mode to connect to the central master. Remote masters must provide a TEST_QUEUE_RELAY_TOKEN
+in relay mode to connect to the central master. Remote masters must provide a `TEST_QUEUE_RELAY_TOKEN`
to match the central master's.
-```
+```console
$ TEST_QUEUE_RELAY_TOKEN=123 TEST_QUEUE_SOCKET=0.0.0.0:12345 bundle exec minitest-queue ./test/sample_test.rb
$ TEST_QUEUE_RELAY_TOKEN=123 TEST_QUEUE_RELAY=0.0.0.0:12345 bundle exec minitest-queue ./test/sample_test.rb
$ TEST_QUEUE_RELAY_TOKEN=123 ./test-multi.sh
```
See the [Parameterized Trigger Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Parameterized+Trigger+Plugin)
for a simple way to do this with jenkins.
-### see also
+## See also
* https://github.com/Shopify/rails_parallel
* https://github.com/grosser/parallel_tests