umbrellio / ci_helper

100%

push

github

Add timing-aware spec splitting to RunSpecs (#29)

* Add timing-aware spec splitting to RunSpecs

* Record spec timings via an added formatter instead of --format

Registering the recorder with a command-line --format made RSpec drop the
formatters the consuming suite configures via .rspec (in RSpec 3, any CLI
--format replaces the configured list), silently removing documentation,
custom, or JUnit formatters and their CI artifacts. Post-processing the
report in the command also ran only on success, so a run with any failing
example left timings_out as RSpec's nested report rather than the flat map.

Ship an RSpecTimingsFormatter and register it via --require, so it is added
on top of the suite's own formatters, and write the flat map from its
dump_summary hook, which RSpec reaches even when examples fail.

* Record spec timings from an after(:suite) hook, not a formatter

An added formatter still occupies rspec's formatter list, and
Formatters::Loader only installs the default progress formatter when that
list is empty. So for the common suite with no explicit --format in
.rspec, enabling --timings-out suppressed the normal progress and failure
output entirely.

Collect timings from an after(:suite) hook (via RSpec.world.all_examples)
instead. It records after every example has finished, so it still captures
timings when examples fail, and it never touches the formatter list, so
rspec keeps both the suite's configured formatters and its default output.

* Record timings only for examples executed on this node

A node runs a subset of example ids, but rspec loads the whole file, so
RSpec.world.all_examples also returns examples filtered out on this node.
Those never ran and have a nil run_time, which to_f turned into 0.0, so
each node's map gained zero entries for other nodes' examples — and merging
the per-node maps could overwrite a real timing with 0.0.

Skip examples whose run_time is nil, keeping only those actually executed.

30 of 30 branches covered (100.0%)

Branch coverage included in aggregate %.

188 of 188 relevant lines covered (100.0%)

9.27 hits per line