semaphore_test_boosters 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 818fb423cc0dca748176dcc676e1827e76215f86
-  data.tar.gz: 5829ff0d66e9613f0f9705617604dd7a447670eb
+  metadata.gz: 6115ef24f4518bfaaf70e3556e1cbab67c1d8820
+  data.tar.gz: 39f69a9a81d2dbd9df0d01c82d3d6daeefd79a28
 SHA512:
-  metadata.gz: 104ea0a5bb98c8479fdc8a8d6a1d73b0b5c4f71d851582b33db7176e855bd1f800c508adf3a37438ac0d3b1ad614c182de4bb0e77267fa85d399f9c2ac911637
-  data.tar.gz: 9029ac6ab8388faa94cb18af5487611e60f9d8c2fd4d4af9b6763e3cd45c4cb2cba704f3596995ce3c0f7702e52cd5b6398b4ea7cddf3f6fe61271cc013e35eb
+  metadata.gz: 5f7ac16b098e9f3cd360b8451c35ed460f6b3aa970f3d72d58c23dc62bd9c4828eea35735ce56905e417165aecc562c0181cc14016d9adaee3e6badcc117ac7d
+  data.tar.gz: c6d21b3e1db2231740b74c7f2876a3b14c921187340b2e7fc975ea0f885ffc255dda0ef6d4109b4c59a61cded45635f2b9c8a583c642c3253040bd77c488204c

data/README.md

@@ -7,49 +7,41 @@ Auto Parallelization — runs test files in multiple jobs
 
 - [Installation](#installation)
 
-- RSpec Booster
-  - [Running RSpec jobs](#rspec-booster)
-  - [RSpec Split Configuration](#rspec-split-configuration)
-  - [Leftover RSpec specs](#leftover-rspec-specs)
-  - [Passing custom options to RSpec](#custom-rspec-options)
-
-- Cucumber Booster
-  - [Running Cucumber jobs](#cucumber-booster)
-  - [Cucumber Split Configuration](#cucumber-split-configuration)
-  - [Leftover Cucumber specs](#leftover-rspec-specs)
-  - [Passing custom options to Cucumber](#custom-cucumber-options)
+Test Booster basics:
 
-## Installation
+  - [What are Test Boosters](#what-are-test-boosters)
+  - [Split Configuration](#split-configuration)
+  - [Leftover Files](#split-configuration)
 
-``` bash
-gem install semaphore_test_boosters
-````
+Test Boosters:
 
-## RSpec Booster
+  - [RSpec Booster](#rspec-booster)
+  - [Cucumber Booster](#cucumber-booster)
+  - [Minitest Booster](#minitest-booster)
+  - [ExUnit Booster](#ex-unit-booster)
+  - [GoTest Booster](#go-test-booster)
 
-The RSpec Booster splits your RSpec test suite to multiple jobs.
 
-For example, if you want to split your RSpec test suite into 21 jobs, and run
-then executed the 3rd job, use the following command:
+## Installation
 
 ``` bash
-rspec_booster --thread 3/21
-```
+gem install semaphore_test_boosters
+````
 
-By default, RSpec Booster will distribute your spec files based on their size
-into multiple jobs. This is OK for your first run, but the distribution is
-usually suboptimal.
+## What are Test Boosters
 
-If you want to achieve better build times, and split your test files more
-evenly, you need to provide a split configuration file for RSpec Booster.
+Test Boosters take your test suite and split the test files into multiple jobs.
+This allows you to quickly parallelize your test suite across multiple build
+machines.
 
-On Semaphore, this file is generated before every build based on the duration's
-of your previous builds.
+As an example, let's take a look at the `rspec_booster --job 1/10` command. It
+lists all the files that match the `spec/**/*_spec.rb` glob in your project,
+distributes them into 10 jobs, and execute the first job.
 
-### RSpec Split Configuration
+### Split Configuration
 
-The `rspec_split_configuration.json` should be placed in your home directory and
-should contain the list of files for each RSpec Booster job.
+Every test booster can load a split configuration file that helps the test
+booster to make a better distribution.
 
 For example, if you have 3 RSpec Booster jobs, and you want to run:
 
@@ -67,9 +59,12 @@ you should put the following in your split configuration file:
 ]
 ```
 
-### Leftover RSpec specs
+Semaphore uses Split configurations to split your test files based their
+durations in the previous builds.
 
-Files that are part of your RSpec test suite, but are not in the split
+### Leftover Files
+
+Files that are part of your test suite, but are not in the split
 configuration file, are called "leftover files". These files will be distributed
 based on their file size in a round robin fashion across your jobs.
 
@@ -102,108 +97,108 @@ rspec_booster --job 1/3
 # => runs: bundle exec rspec spec/a_spec.rb spec/d_spec.rb
 ```
 
-### Custom RSpec options
+## RSpec Booster
 
-By default, `rspec_booster` passes the following options to RSpec:
+The `rspec_booster` loads all the files that match the `spec/**/*_spec.rb`
+pattern and uses the `~/rspec_split_configuration.json` file to parallelize your
+test suite.
+
+Example of running job 4 out of 32 jobs:
 
 ``` bash
---format documentation --format json --out ~/rspec_report.json
+rspec_booster --job 4/32
 ```
 
-If you want to pass additional parameters to RSpec, you can do that by setting
-the `TB_RSPEC_OPTIONS` environment variable.
+Under the hood, the RSpec Booster uses the following command:
 
-For example, if you want to pass a `--fail-fast` option to RSpec, you can do it
-like this:
+``` bash
+bundle exec rspec --format documentation --format json --out /home/<user>/rspec_report.json <file_list>
+```
+
+Optionally, you can pass additional RSpec flags with the `TB_RSPEC_OPTIONS`
+environment variable:
 
 ``` bash
-export TB_RSPEC_OPTIONS = '--fail-fast'
+TB_RSPEC_OPTIONS='--fail-fast=3' rspec_booster --job 4/32
+```
 
-rspec_booster --job 2/3
+The above command will execute:
 
-# => runs: bundle exec rspec --fail-fast --format documentation --format json --out ~/rspec_report.json <file_list>
+``` bash
+bundle exec rspec --fail-fast=3 --format documentation --format json --out /home/<user>/rspec_report.json <file_list>
 ```
 
 ## Cucumber Booster
 
-The Cucumber Booster splits your Cucumber test suite to multiple jobs.
+The `cucumber_booster` loads all the files that match the `features/**/*.feature`
+pattern and uses the `~/cucumber_split_configuration.json` file to parallelize
+your test suite.
 
-For example, if you want to split your Cucumber test suite into 21 jobs, and run
-then executed the 3rd job, use the following command:
+Example of running job 4 out of 32 jobs:
 
 ``` bash
-cucumber_booster --thread 3/21
+cucumber_booster --job 4/32
 ```
 
-By default, Cucumber Booster will distribute your spec files based on their size
-into multiple jobs. This is OK for your first run, but the distribution is
-usually suboptimal.
-
-If you want to achieve better build times, and split your test files more
-evenly, you need to provide a split configuration file for Cucumber Booster.
+Under the hood, the Cucumber Booster uses the following command:
 
-On Semaphore, this file is generated before every build based on the duration's
-of your previous builds.
+``` bash
+bundle exec cucumber <file_list>
+```
 
-### Cucumber Split Configuration
+## Minitest Booster
 
-The `cucumber_split_configuration.json` should be placed in your home directory
-and should contain the list of files for each Cucumber Booster job.
+The `minitest_booster` loads all the files that match the `test/**/*_test.rb`
+pattern and uses the `~/minitest_split_configuration.json` file to parallelize
+your test suite.
 
-For example, if you have 3 Cucumber Booster jobs, and you want to run:
+Example of running job 4 out of 32 jobs:
 
-- `features/a.feature` and `spec/b.feature` in the first job
-- `features/c.feature` and `spec/d.feature` in the second job
-- `features/e.feature` in the third job
+``` bash
+minitest_booster --job 4/32
+```
 
-you should put the following in your split configuration file:
+Under the hood, the Minitest Booster uses the following command:
 
-``` json
-[
-  { "files": ["features/a.feature", "features/b.feature"] },
-  { "files": ["features/c.feature", "features/d.feature"] },
-  { "files": ["features/e.feature"] }
-]
+``` bash
+ruby -e 'ARGV.each { |f| require ".#{f}" }' <file_list>
 ```
 
-### Leftover files
+## ExUnit Booster
 
-Files that are part of your Cucumber test suite, but are not in the split
-configuration file, are called "leftover files". These files will be distributed
-based on their file size in a round robin fashion across your jobs.
+The `ex_unit_booster` loads all the files that match the `test/**/*_test.exs`
+pattern and uses the `~/ex_unit_split_configuration.json` file to parallelize
+your test suite.
 
-For example, if you have the following in your split configuration:
+Example of running job 4 out of 32 jobs:
 
-``` json
-[
-  { "files": ["features/a.feature"] }
-  { "files": ["features/b.feature"] }
-  { "files": ["features/c.feature"] }
-]
+``` bash
+ex_unit_booster --job 4/32
 ```
 
-and the following files in your spec directory:
+Under the hood, the ExUnit Booster uses the following command:
 
 ``` bash
-features/a.feature
-features/b.feature
-features/c.feature
-features/d.feature
-features/e.feature
+mix test <file_list>
 ```
 
-When you run the `cucumber_booster --job 1/3` command, the files from the
-configuration's first job and some leftover files will be executed.
+## Go Test Booster
 
-``` bash
-cucumber_booster --job 1/3
+The `go_test_booster` loads all the files that match the `**/*_test.go`
+pattern and uses the `~/go_test_split_configuration.json` file to parallelize
+your test suite.
+
+Example of running job 4 out of 32 jobs:
 
-# => runs: bundle exec cucumber features/a.feature features/d.feature
+``` bash
+go_test_booster --job 4/32
 ```
 
-### Custom Cucumber options
+Under the hood, the Go Test Booster uses the following command:
 
-Currently, you can't pass custom options to Cucumber.
+``` bash
+go test <file_list>
+```
 
 ## Contributing
 

data/lib/test_boosters/shell.rb

@@ -8,7 +8,7 @@ module TestBoosters
 
       puts command unless options[:silent] == true
 
-      Bundler.with_clean_env do
+      with_clean_env do
         system(command)
       end
 
@@ -19,6 +19,10 @@ module TestBoosters
       exit_status
     end
 
+    def with_clean_env
+      defined?(Bundler) ? Bundler.with_clean_env { yield } : yield
+    end
+
     def display_title(title)
       puts
       puts "=== #{title} ===="

data/lib/test_boosters/version.rb

@@ -1,3 +1,3 @@
 module TestBoosters
-  VERSION = "2.0.0".freeze
+  VERSION = "2.0.1".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: semaphore_test_boosters
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Developers at Rendered Text