split-test-rb 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffaee1d0d9211e912e20044c5fbf90b4d6c2ad643321d3c5dc94f2cbf5a8921f
-  data.tar.gz: bae21fcdfab3ff5d94e96a1bfa8d00e391ff5387b20e51570ee1bfe3f169ae83
+  metadata.gz: f765610ad0a575e0bb582ea31ae9ed544382fed7d4ef63d2f9f396460a19c821
+  data.tar.gz: 65061f28e3bf6f0f9882b4d6f4e110c23eadd7146cb5bc0e3dfec608c2a49022
 SHA512:
-  metadata.gz: 56d1f3f3ddaa7e24be47904d499e01d4aac169f4fdfde9678a7c72644d2a5ac065d1bb990e44a1e579c6ff402f469fd9f2867eedbf92f68289b9b88c9deccd50
-  data.tar.gz: 365fbe88adab8a447848389ec8039521d7488a974079fb2ed91086f35d111ce8a74bd465a5b4835a631edd64650396800dcd8828250e0a4c6970b2d3257bd0d7
+  metadata.gz: '034288dce122aa532fb53ede46a67af4d05bad5d84163e54fee77e4eee067828f7aed2dd21fd88f870c99170ab19836895ebfc10669ae32a33fcdd4f0698a3f2'
+  data.tar.gz: 9808a967a1c9e7f96ff87fedbe9ddef03808a4455987ac0750709a840c8d42e6003dfad2cd5ab28fdf6318236b2c43dcbae2237feb2fc4ecb247ce3b6f20cb1c

data/README.md

@@ -87,12 +87,16 @@ The test directory and pattern options are useful for:
 When you have test files that take significantly longer than others, you can use `--split-by-example-threshold` to automatically split them into individual RSpec examples. This enables finer-grained load balancing across CI nodes.
 
 ```bash
+bundle exec rspec --dry-run --format json --out tmp/dry-run.json
 split-test-rb --json-path tmp/test-results \
   --node-index $CI_NODE_INDEX \
   --node-total $CI_NODE_TOTAL \
-  --split-by-example-threshold 10.0
+  --split-by-example-threshold 10.0 \
+  --dry-run-json tmp/dry-run.json
 ```
 
+`--dry-run-json` is recommended together with this option. Without it, examples missing from the cached JSON are not run (see [Keeping heavy files up to date with `--dry-run-json`](#keeping-heavy-files-up-to-date-with---dry-run-json)).
+
 With this option:
 - Files with execution time **below** the threshold are distributed as whole files (e.g., `spec/fast_spec.rb`)
 - Files with execution time **at or above** the threshold are split into individual examples (e.g., `spec/slow_spec.rb[1:1]`, `spec/slow_spec.rb[1:2]`)
@@ -106,21 +110,14 @@ This is useful when:
 
 #### Keeping heavy files up to date with `--dry-run-json`
 
-By default, heavy files are assigned only by the example IDs found in the cached JSON reports. Examples that are not in the cache are not assigned to any node:
+Without `--dry-run-json`, heavy files are assigned only by the example IDs found in the cached JSON reports, and a warning is printed. Examples that are not in the cache are not assigned to any node:
 
 - Examples newly added to a heavy file
 - Examples whose IDs shifted because other examples were inserted or moved (RSpec example IDs are position based, e.g. `[1:2:1]`)
 
-Pass the output of `rspec --dry-run --format json` to use the examples that currently exist:
+Pass the output of `rspec --dry-run --format json` to use the examples that currently exist (see the example above).
 
-```bash
-bundle exec rspec --dry-run --format json --out tmp/dry-run.json
-split-test-rb --json-path tmp/test-results \
-  --node-index $CI_NODE_INDEX \
-  --node-total $CI_NODE_TOTAL \
-  --split-by-example-threshold 10.0 \
-  --dry-run-json tmp/dry-run.json
-```
+Every node must use a dry-run JSON with the same examples, or the nodes compute different splits and some tests are run on no node. Generating it once (e.g. in a setup job) and sharing it with all nodes as a CI artifact guarantees this, and boots the app only once instead of on every node.
 
 With this option, for each heavy file:
 - Examples in the dry-run JSON are assigned, using cached timings when available and the default timing (1.0s) otherwise

data/lib/split_test_rb/version.rb

@@ -1,3 +1,3 @@
 module SplitTestRb
-  VERSION = '1.0.4'.freeze
+  VERSION = '1.0.5'.freeze
 end

data/lib/split_test_rb.rb

@@ -241,6 +241,7 @@ module SplitTestRb
       threshold = options[:split_by_example_threshold]
       timings = if threshold
                   current_example_ids = load_current_example_ids(options[:dry_run_json])
+                  warn_cached_examples_only(file_timings, threshold) unless current_example_ids
                   apply_example_splitting(file_timings, json_files, threshold,
                                           current_example_ids: current_example_ids, default_files: default_files)
                 else
@@ -256,6 +257,15 @@ module SplitTestRb
                      .split(file_timings, threshold)
     end
 
+    # Warns that heavy files are assigned only by the cached example IDs when --dry-run-json is not given,
+    # because examples missing from the cache (new or shifted IDs) are then not run on any node
+    def self.warn_cached_examples_only(file_timings, threshold)
+      return unless file_timings.any? { |_file, time| time >= threshold }
+
+      warn 'Warning: --dry-run-json is not given, so examples of heavy files that are not in the cached JSON ' \
+           'will not be run. Pass the output of `rspec --dry-run --format json` with --dry-run-json'
+    end
+
     # Loads example IDs from an RSpec dry-run JSON report, or returns nil when no path is given
     def self.load_current_example_ids(dry_run_json)
       return nil unless dry_run_json

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: split-test-rb
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Naofumi Fujii