parallel_tests 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 598069c4031e361060ee4c4beaf7becc3454365b7825b7e9cb8d7909d2f0bb00
-  data.tar.gz: 3b0684f907eb1de6b9bb0556289ff3556052fc1fb75c138608801dbb91891b63
+  metadata.gz: cf9a4f09819ff1193b0f02d9148f72d7b12e4c2efc2ca4e5e7981eb6959ebfef
+  data.tar.gz: f86bdeb95cb93b8d8d79a81727e719014a481c18520da973480ff44d6828ffdb
 SHA512:
-  metadata.gz: 5056b01a89580b61ce8b49f034959fe7f5b08f7dee2bd83cd44c115016483ff1be41f1ca34b3cc8471ef9e4ce898b9d3cb3b5123cf88905a9d9c21e6a08439b5
-  data.tar.gz: 91a0afb5012fc117de3f602b769d590be185e322dab9555c1f9eae220d90db7131d7516e8fd338ec25cbd8c70428209e5b85b644380f00722eaafd5d41ac9f36
+  metadata.gz: 549401be10742522594fbd9f9ba1eb657c7689c13be3f9034bb7ee78225a7b86cf127b83d1f16cac932b639cfec92ecac9644e8aff9aa488b39e3980eb23ff6c
+  data.tar.gz: ad909f442e744a869bc4db59b9bf2bc9b3559e888f2d017cee58fa51b4d8563f5dc9123d6ce48317fe65f56e7d6f4f4d89c56274960d14ec1befbe5e3cabcc2d

data/Readme.md

@@ -106,11 +106,13 @@ at_exit do
 end
 ```
 
-Even test group run-times
-=========================
+Even test group runtimes
+========================
 
-Test groups are often not balanced and will run for different times, making everything wait for the slowest group.
-Use these loggers to record test runtime and then use the recorded runtime to balance test groups more evenly.
+Test groups will often run for different times, making the full test run as slow as the slowest group.
+
+Step 1: Use these loggers (see below) to record test runtime
+Step 2: Your next run will use the recorded test runtimes (use `--runtime-log <file>` if you picked a location different from below)
 
 ### RSpec
 
@@ -128,9 +130,11 @@ Add to your `test_helper.rb`:
 require 'parallel_tests/test/runtime_logger' if ENV['RECORD_RUNTIME']
 ```
 
-results will be logged to tmp/parallel_runtime_test.log when `RECORD_RUNTIME` is set,
+results will be logged to `tmp/parallel_runtime_test.log` when `RECORD_RUNTIME` is set,
 so it is not always required or overwritten.
 
+### TODO: add instructions for other frameworks
+
 Loggers
 =======
 
@@ -147,7 +151,7 @@ Add the following to your `.rspec_parallel` (or `.rspec`) :
 RSpec: FailuresLogger
 -----------------------
 
-Produce pastable command-line snippets for each failed example. For example:
+Produce pasteable command-line snippets for each failed example. For example:
 
 ```bash
 rspec /path/to/my_spec.rb:123 # should do something
@@ -160,6 +164,24 @@ Add to `.rspec_parallel` or use as CLI flag:
 
 (Not needed to retry failures, for that pass [--only-failures](https://relishapp.com/rspec/rspec-core/docs/command-line/only-failures) to rspec)
 
+
+RSpec: VerboseLogger
+-----------------------
+
+Prints a single line for starting and finishing each example, to see what is currently running in each process.
+
+```
+# PID, parallel process number, spec status, example description
+[14403] [2] [STARTED] Foo foo
+[14402] [1] [STARTED] Bar bar
+[14402] [1] [PASSED] Bar bar
+```
+
+Add to `.rspec_parallel` or use as CLI flag:
+
+      --format ParallelTests::RSpec::VerboseLogger
+
+
 Cucumber: FailuresLogger
 -----------------------
 

data/lib/parallel_tests/rspec/runtime_logger.rb

@@ -36,6 +36,8 @@ class ParallelTests::RSpec::RuntimeLogger < ParallelTests::RSpec::LoggerBase
   def start_dump(*)
     return unless ENV['TEST_ENV_NUMBER'] # only record when running in parallel
     lock_output do
+      # Order the output from slowest to fastest
+      @example_times = @example_times.sort_by(&:last).reverse
       @example_times.each do |file, time|
         relative_path = file.sub(%r{^#{Regexp.escape Dir.pwd}/}, '').sub(%r{^\./}, "")
         @output.puts "#{relative_path}:#{[time, 0].max}"

data/lib/parallel_tests/rspec/verbose_logger.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'rspec/core/formatters/base_text_formatter'
+require 'parallel_tests/rspec/runner'
+
+class ParallelTests::RSpec::VerboseLogger < RSpec::Core::Formatters::BaseTextFormatter
+  RSpec::Core::Formatters.register(
+    self,
+    :example_group_started,
+    :example_group_finished,
+    :example_started,
+    :example_passed,
+    :example_pending,
+    :example_failed
+  )
+
+  def initialize(output)
+    super
+    @line = []
+  end
+
+  def example_group_started(notification)
+    @line.push(notification.group.description)
+  end
+
+  def example_group_finished(_notification)
+    @line.pop
+  end
+
+  def example_started(notification)
+    @line.push(notification.example.description)
+    output_formatted_line('STARTED', :yellow)
+  end
+
+  def example_passed(_passed)
+    output_formatted_line('PASSED', :success)
+    @line.pop
+  end
+
+  def example_pending(_pending)
+    output_formatted_line('PENDING', :pending)
+    @line.pop
+  end
+
+  def example_failed(_failure)
+    output_formatted_line('FAILED', :failure)
+    @line.pop
+  end
+
+  private
+
+  def output_formatted_line(status, console_code)
+    prefix = ["[#{Process.pid}]"]
+    if ENV.include?('TEST_ENV_NUMBER')
+      test_env_number = ENV['TEST_ENV_NUMBER'] == '' ? 1 : Integer(ENV['TEST_ENV_NUMBER'])
+      prefix << "[#{test_env_number}]"
+    end
+    prefix << RSpec::Core::Formatters::ConsoleCodes.wrap("[#{status}]", console_code)
+
+    output.puts [*prefix, *@line].join(' ')
+  end
+end

data/lib/parallel_tests/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ParallelTests
-  VERSION = '4.3.0'
+  VERSION = '4.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parallel_tests
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-09 00:00:00.000000000 Z
+date: 2023-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel
@@ -58,6 +58,7 @@ files:
 - lib/parallel_tests/rspec/runner.rb
 - lib/parallel_tests/rspec/runtime_logger.rb
 - lib/parallel_tests/rspec/summary_logger.rb
+- lib/parallel_tests/rspec/verbose_logger.rb
 - lib/parallel_tests/spinach/runner.rb
 - lib/parallel_tests/tasks.rb
 - lib/parallel_tests/test/runner.rb
@@ -68,8 +69,8 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/grosser/parallel_tests/issues
-  documentation_uri: https://github.com/grosser/parallel_tests/blob/v4.3.0/Readme.md
-  source_code_uri: https://github.com/grosser/parallel_tests/tree/v4.3.0
+  documentation_uri: https://github.com/grosser/parallel_tests/blob/v4.4.0/Readme.md
+  source_code_uri: https://github.com/grosser/parallel_tests/tree/v4.4.0
   wiki_uri: https://github.com/grosser/parallel_tests/wiki
 post_install_message:
 rdoc_options: []