rspec-core-parallel 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e45d853c91a7618f7d3e2610761a0a7271ade685db327199de1b3a045ed9609
-  data.tar.gz: f652d5b00ce96ef27afbab7d064caaf8ed9cc5541c5fa739708bdd24cf08c5ef
+  metadata.gz: 959cdd2e6744a83648486825d673ea9164f39f2aa0fbafafd2f4b49eda5163ae
+  data.tar.gz: 8657334668c6e6aaeb8ceca2fabf5c413d1860f19379e34d463a26b01bcdb837
 SHA512:
-  metadata.gz: ce28c54e6b455f78bed2682ce55ddc7c79b53ee3913a9ea3c5e91ed13f2b0507baa56130a494feb1bd913a3c05ea30819eb29608ee2aa82b9b314ab5335b6a1b
-  data.tar.gz: 2db7c74933f5f617e44027b3687b473395d2c4d93e8277ac13b172e558b6c3304a572ef5f5c81c77acbf26c85e4802b3d1aa3ea9b811b2c67b1c6b20c7cadd4e
+  metadata.gz: d12df7ed1e4abe97795bc1643779d16dd9c348458121952733e974340ae5024abe3e7b18840c308294b8955b5294cb77353506276e0428dc5dfd6775f9080430
+  data.tar.gz: '02925aa2a3aff6acbe74d6c499802d247942cbc83336cba8dce061cba2d41fe73a62d230cac84f26e1b2e70ed73f94414a5c264cd509735fa1226644c6816b2e'

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.4.0
+
+* In Rails apps every worker writes to its own log file (`log/test-1.log`,
+  `log/test-2.log`...) instead of `log/test.log`.
+
 ## 0.3.0
 
 * `before(:run)` and `after(:run)` hooks, which run once per run: in the main

data/README.md

@@ -68,6 +68,9 @@ loaded from the schema when needed, like `rails test` does in parallel. Set
 (`maintain_test_schema!` runs before the workers are forked), so on CI create it as usual, e.g. with
 `bin/rails db:create db:schema:load`, rather than with `parallel:create`.
 
+**Logs.** In Rails apps every worker writes to its own log file (`log/test-1.log`, `log/test-2.log`, ...), so that the
+lines of the workers don't mix in `log/test.log`, which keeps the lines of the main process.
+
 **Other resources.** Each worker gets a `TEST_ENV_NUMBER` environment variable (`""`, `"2"`, `"3"`, ...) as with
 parallel_tests, and runs the `parallel_worker_setup` hooks. Workers are forked after the suite is loaded, so anything
 set up while loading, like a constant with a directory or a Redis client, is the same in all of them. This also applies

data/lib/rspec/core/parallel/rails_integration.rb

@@ -11,6 +11,8 @@ module RSpec
       #   `ActiveSupport.parallelize_test_databases` to `false` to opt out.
       #   Workers are numbered from 0 for these hooks, as in Rails. Rails
       #   versions before 8.1 have no hooks to run before forking.
+      # * gives every worker its own log file (`log/test-1.log`, `log/test-2.log`...),
+      #   rather than mixing the lines of all the workers in `log/test.log`.
       # * loads the translations before forking, as Rails does when eager
       #   loading, rather than in every worker.
       #
@@ -22,9 +24,39 @@ module RSpec
         end
 
         def self.after_fork(worker_number)
+          split_log(worker_number)
           hooks(:after_fork_hooks).each { |hook| hook.call(worker_number - 1) }
         end
 
+        # Rails opens the log file itself and hands the open file to its
+        # logger, so the path comes from the file the logger writes to.
+        # Loggers writing elsewhere, like to STDOUT, are left as they are.
+        def self.split_log(worker_number)
+          return unless defined?(::Rails.logger) && ::Rails.logger
+
+          loggers = ::Rails.logger.respond_to?(:broadcasts) ? ::Rails.logger.broadcasts : [::Rails.logger]
+          loggers.each do |logger|
+            device = logger.instance_variable_get(:@logdev)&.dev
+            next unless device.is_a?(::File)
+
+            logger.reopen(open_log_file(worker_log_path(device.path, worker_number)))
+          end
+        end
+
+        def self.worker_log_path(path, worker_number)
+          extension = ::File.extname(path)
+          "#{path.delete_suffix(extension)}-#{worker_number}#{extension}"
+        end
+
+        # As Rails opens its own log file: in binary mode, so that lines in
+        # any encoding can be written, and without buffering.
+        def self.open_log_file(path)
+          file = ::File.open(path, 'a')
+          file.binmode
+          file.sync = true
+          file
+        end
+
         def self.run_cleanup(worker_number)
           hooks(:run_cleanup_hooks).each { |hook| hook.call(worker_number - 1) }
         end

data/lib/rspec/core/parallel/version.rb

@@ -1,7 +1,7 @@
 module RSpec
   module Core
     module Parallel
-      VERSION = '0.3.0'
+      VERSION = '0.4.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-core-parallel
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Alessandro Rodi