semaphore_test_boosters 1.4.5 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a22f7e91007f32b4d63ba1d6f3f85dbd1b991296
-  data.tar.gz: eea15b805b691bab72c235ffb3c62673c605385f
+  metadata.gz: 727d7c5926285ec72949d51f143c2088b761b7d1
+  data.tar.gz: 44d8f18eb76dd4048b47a24389f137f63e18826b
 SHA512:
-  metadata.gz: 3c8468abaff49802acf8b9fa2fec687e64f12e3921f99aadb301b36fffb8e22c9e0a545397fea3c211103f472b07691254bbc4b7a3ea5c85fc7c11888b6e74a3
-  data.tar.gz: aa45864746f4a6cf7568e3186d51e99f962ebe69e4de8d0c8e1d691d00dc4fcb0e63dfceb96dde54e0c82a110cf279aaf9d3063b28afaf4427fdd3f717b7381e
+  metadata.gz: e0627ba6468d637e49ea736d1f177097effa556d8a0ed57b77101eda851c7df13b50395f039d40a89107c7dc1677bf5520c281db68ac31d870283103fbb7c709
+  data.tar.gz: b1c33fffe27780b1678f029d8ddff3fde04f9b324e85a6170cea38cc51496f989cec38682f9214c4b799d7554fbb2a5e795de7859a6c3d5890621fa2de1b5f87

data/README.md

@@ -12,7 +12,94 @@ gem install test_boosters
 
 ## Usage
 
-TODO: Write usage instructions here
+### RSpec Booster
+
+The RSpec booster command allows you to run one out of several parallel rspec
+threads.
+
+``` bash
+rspec_booster --thread 3
+```
+
+#### RSpec Split Configuration
+
+The `rspec_split_configuration.json` located in your home directory is used to
+pass test files to the booster. On Semaphore, this file contains a list of
+specs files distributed across threads based on their estimated durations.
+
+For example, if you have a `rspec_split_configuration.json` located in your home
+directory with the following content:
+
+``` json
+[
+  { :files => ["spec/a_spec.rb", "spec/b_spec.rb"] },
+  { :files => ["spec/c_spec.rb", "spec/d_spec.rb"] },
+  { :files => ["spec/e_spec.rb"] }
+]
+```
+
+The `rspec_booster` command will deduce that you have 3 threads in total and
+that you want to run `spec/a_spec.rb` and `spec/b_spec.rb` on the first thread,
+`spec/c_spec.rb` and `spec/d_spec.rb` on the second thread, and `spec/e_spec.rb`
+on the third thread.
+
+#### Leftover files
+
+The RSpec Split Configuration contains only those spec files that have an
+estimated duration recorded on Semaphore. New files, whose estimated duration
+is not yet stored on Semaphore will be distributed across threads in based on
+their file size in a round robin fashion.
+
+For example, if you have the following split configuration:
+
+``` json
+[
+  { :files => ["spec/a_spec.rb"] }
+  { :files => ["spec/b_spec.rb"] }
+  { :files => ["spec/c_spec.rb"] }
+]
+```
+
+and the following files in your spec directory:
+
+``` bash
+spec/a_spec.rb
+spec/b_spec.rb
+spec/c_spec.rb
+spec/d_spec.rb
+spec/e_spec.rb
+```
+
+When you run the `rspec_booster --thread 1` command, the files from the
+configuration's first thread and some leftover files will be executed.
+
+``` bash
+rspec_booster --thread 1
+
+# => runs: bundle exec rspec spec/a_spec.rb spec/d_spec.rb
+```
+
+#### Custom RSpec options
+
+By default, `rspec_booster` passes the following options to RSpec:
+
+``` bash
+--format documentation --format json --out ~/rspec_report.json
+```
+
+If you want to pass additional parameters to RSpec, you can do that by setting
+the `TB_RSPEC_OPTIONS` environment variable.
+
+For example, if you want to pass a `--fail-fast` option to RSpec, you can do it
+like this:
+
+``` bash
+export TB_RSPEC_OPTIONS = '--fail-fast'
+
+rspec_booster --thread 2
+
+# => runs: bundle exec rspec --fail-fast --format documentation --format json --out ~/rspec_report.json <file_list>
+```
 
 ## Contributing
 

data/lib/test_boosters/rspec/thread.rb

@@ -53,7 +53,7 @@ module TestBoosters
       end
 
       def rspec_options
-        "--format documentation --format json --out #{report_path}"
+        "#{ENV["TB_RSPEC_OPTIONS"]} --format documentation --format json --out #{report_path}"
       end
 
       def rspec_command

data/lib/test_boosters/version.rb

@@ -1,3 +1,3 @@
 module TestBoosters
-  VERSION = "1.4.5".freeze
+  VERSION = "1.5.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: semaphore_test_boosters
 version: !ruby/object:Gem::Version
-  version: 1.4.5
+  version: 1.5.0
 platform: ruby
 authors:
 - Developers at Rendered Text
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-19 00:00:00.000000000 Z
+date: 2017-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: semaphore_cucumber_booster_config