rspec-conductor 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17242ccb102c17f1a469bf4e105d62f2469372059d9416bcf4ab87df4f698143
-  data.tar.gz: ab29ad25bded7e52af8b762c532f2d30d9c5451a954abfcd3330430840dda107
+  metadata.gz: e35dd999b2161d2767b67b1c798dba7e89595ba8a5e6376780498c57c9bd1405
+  data.tar.gz: 2b93eb4f86463e46ab97cf00c8fa619b4dc386e4f31febb006542ff9d3c02a49
 SHA512:
-  metadata.gz: 7d7aa04766f0b086c747c2c7046e6dc3050c6376389c05b68db1a83a99570c65e5d0e993df8bcd4b2379acb68d6047f4ec15dfba01423714eda39f8a1cb4da89
-  data.tar.gz: c801bac92877545bef4083eb0875efb291e58ad1af80961f7ece72fee86e2abbf3f3916c43d823eaeaefb81f605254d22e96a1ae8eddda046e6fd846fe1237de
+  metadata.gz: ef4fc413c0198396cba25765275c27dfd57968d8abc2286989817edfdc94b1b8e63370c8b12cd5dd747b8684e386042f61ecc8e9770a9bb780ac9ef8043e875c
+  data.tar.gz: 00e4eb9136dd92fa375dd441f056d759e847c48fb0d422f39acb458cfa60d1569caf662af94e95e059dca2b3cfd6b23fc660df66ee3d72241b4457da8c65bf35

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [1.0.1] - 2025-12-21
+
+- Fix spec_helper/rails_helper path finding [Thanks @diego-aslz]
+- Add --prefork-require and --no-prefork-require CLI options for non-rails apps or rails setups where loading config/application.rb is not entirely safe
+- Add --postfork-require and --no-postfork-require CLI options for flexibility
+
 ## [1.0.0] - 2025-12-21
 
 - Initial release

data/README.md

@@ -12,27 +12,36 @@ User experience was designed to serve as a simple, almost drop-in, replacement f
 
 ![rspec-conductor demo](https://github.com/user-attachments/assets/2b598635-3192-4aa0-bb39-2af01b93bb4a)
 
-## Usage
-
-Set up the databases:
+## Installation
 
-```
-rails 'parallel:drop[10]' 'parallel:setup[10]'
+Add to your Gemfile:
 
-# if you like the first-is-1 mode, keeping your parallel test envs separate from your regular env:
-PARALLEL_TEST_FIRST_IS_1=true rails 'parallel:drop[16]' 'parallel:setup[16]'
+```ruby
+gem 'rspec-conductor'
 ```
 
-Then launch the CLI app (see also `bin/rspec-conductor --help`):
+## Usage
 
-```
+```bash
 rspec-conductor <OPTIONS> -- <RSPEC_OPTIONS> <SPEC_PATHS>
-rspec-conductor --workers 10 -- --tag '~@flaky' spec_ether/system/
-rspec-conductor --workers 10 spec_ether/system/ # shorthand when there are no spec options is also supported
+rspec-conductor --workers 10 -- --tag '~@flaky' spec
+# shorthand for setting the paths when there are no rspec options is also supported
+rspec-conductor --workers 10 spec
 ```
 
 `--verbose` flag is especially useful for troubleshooting.
 
+To set up the databases (if you are using this with rails) you can use a rake task from the parallel_tests gem
+
+```bash
+rails 'parallel:drop[10]' 'parallel:setup[10]'
+
+# if you like the first-is-1 mode, keeping your parallel test envs separate from your regular env:
+PARALLEL_TEST_FIRST_IS_1=true rails 'parallel:drop[10]' 'parallel:setup[10]'
+```
+
+I might consider porting that rake task in the near future.
+
 ## Mechanics
 
 Server process preloads the `rails_helper`, prepares a list of files to work, then spawns the workers, each with `ENV['TEST_ENV_NUMBER'] = <worker_number>` (same as parallel-tests). The two communicate over a standard unix socket. Message format is basically a tuple of `(size, json_payload)`. It should also be possible to run this process over the network, but I haven't found a solid usecase for this.
@@ -41,6 +50,13 @@ Server process preloads the `rails_helper`, prepares a list of files to work, th
 
 * In order to make the CLI executable load and run fast, do not add any dependencies. That includes `active_support`.
 
+## Troubleshooting
+
+* `+[__NSCFConstantString initialize] may have been in progress in another thread when fork() was called.` on M-based Mac machines
+    * This is a common issue with ruby code, compiled libraries and forking. Set `OBJC_DISABLE_INITIALIZE_FORK_SAFETY=YES` environment variable to work around this
+* Something gets loaded that shouldn't get loaded, or in a different order
+    * There are two simple ways to hook into preloads, exposed as CLI flags, `--prefork-require` (defaults to `config/application.rb`) and `--postfork-require` (defaults to either `rails_helper.rb` or `spec_helper.rb`, whichever is present on your machine). You can set any of those to whatever you need and control the load order
+
 ## FAQ
 
 * Why not preload the whole rails environment before spawning the workers instead of just `rails_helper`?

data/lib/rspec/conductor/cli.rb

@@ -13,6 +13,8 @@ module RSpec
         fail_fast_after: nil,
         verbose: false,
         display_retry_backtraces: false,
+        prefork_require: 'config/application.rb',
+        postfork_require: :spec_helper,
       }.freeze
 
       def self.run(argv)
@@ -60,6 +62,22 @@ module RSpec
             @conductor_options[:offset] = n
           end
 
+          opts.on("--prefork-require FILENAME", String, "Require this file before forking (default: config/application.rb)") do |f|
+            @conductor_options[:prefork_require] = f
+          end
+
+          opts.on("--no-prefork-require", "Do not preload config/application.rb") do
+            @conductor_options[:prefork_require] = nil
+          end
+
+          opts.on("--postfork-require FILENAME", String, "Require this file after forking (default: either rails_helper.rb or spec_helper.rb, whichever is present)") do |f|
+            @conductor_options[:postfork_require] = f
+          end
+
+          opts.on("--no-postfork-require", "Do not load anything post-fork") do
+            @conductor_options[:postfork_require] = nil
+          end
+
           opts.on("--first-is-1", 'ENV["TEST_ENV_NUMBER"] for the worker 1 is "1" rather than ""') do
             @conductor_options[:first_is_1] = true
           end
@@ -97,11 +115,10 @@ module RSpec
       end
 
       def start_server
-        require_relative "server"
-
         Server.new(
           worker_count: @conductor_options[:workers],
           worker_number_offset: @conductor_options[:offset],
+          prefork_require: @conductor_options[:prefork_require],
           first_is_1: @conductor_options[:first_is_1],
           seed: @conductor_options[:seed],
           fail_fast_after: @conductor_options[:fail_fast_after],

data/lib/rspec/conductor/server.rb

@@ -11,6 +11,8 @@ module RSpec
       # @option worker_count [Integer] How many workers to spin
       # @option rspec_args [Array<String>] A list of rspec options
       # @option worker_number_offset [Integer] Start worker numbering with an offset
+      # @option prefork_require [String] File required prior to forking
+      # @option postfork_require [String, Symbol] File required after forking
       # @option first_is_1 [Boolean] TEST_ENV_NUMBER for the first worker is "1" instead of ""
       # @option seed [Integer] Set a predefined starting seed
       # @option fail_fast_after [Integer, NilClass] Shut down the workers after a certain number of failures
@@ -20,6 +22,8 @@ module RSpec
       def initialize(worker_count:, rspec_args:, **opts)
         @worker_count = worker_count
         @worker_number_offset = opts.fetch(:worker_number_offset, 0)
+        @prefork_require = opts.fetch(:prefork_require, nil)
+        @postfork_require = opts.fetch(:postfork_require, nil)
         @first_is_one = opts.fetch(:first_is_1, false)
         @seed = opts[:seed] || (Random.new_seed % 65_536)
         @fail_fast_after = opts[:fail_fast_after]
@@ -39,7 +43,7 @@ module RSpec
                      when "plain"
                        Formatters::Plain.new
                      else
-                       Formatters::Fancy.recommended? ? Formatters::Fancy.new : Formatters::Plain.new
+                       (!@verbose && Formatters::Fancy.recommended?) ? Formatters::Fancy.new : Formatters::Plain.new
                      end
         @results = { passed: 0, failed: 0, pending: 0, errors: [], worker_crashes: 0, started_at: @started_at, spec_files_total: 0, spec_files_processed: 0 }
       end
@@ -63,11 +67,18 @@ module RSpec
       private
 
       def preload_application
-        application = File.expand_path("config/application", Conductor.root)
+        if !@prefork_require
+          debug "Prefork require not set, skipping..."
+          return
+        end
+
+        preload = File.expand_path(@prefork_require, Conductor.root)
 
-        if File.exist?(application)
-          debug "Preloading config/application.rb..."
-          require File.expand_path("config/application", Conductor.root)
+        if File.exist?(preload)
+          debug "Preloading #{@prefork_require}..."
+          require preload
+        else
+          debug "#{@prefork_require} not found, skipping..."
         end
 
         debug "Application preloaded, autoload paths configured"
@@ -133,7 +144,8 @@ module RSpec
             worker_number: worker_number,
             socket: Protocol::Socket.new(child_socket),
             rspec_args: @rspec_args,
-            verbose: @verbose
+            verbose: @verbose,
+            postfork_require: @postfork_require,
           ).run
         end
 

data/lib/rspec/conductor/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module Conductor
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

data/lib/rspec/conductor/worker.rb

@@ -17,11 +17,13 @@ end
 module RSpec
   module Conductor
     class Worker
-      def initialize(worker_number:, socket:, rspec_args: [], verbose: false)
+      def initialize(worker_number:, socket:, rspec_args: [], verbose: false, postfork_require: :spec_helper)
         @worker_number = worker_number
         @socket = socket
         @rspec_args = rspec_args
         @verbose = verbose
+        @postfork_require = postfork_require
+
         @message_queue = []
       end
 
@@ -29,7 +31,7 @@ module RSpec
         suppress_output unless @verbose
         debug "Worker #{@worker_number} starting"
         setup_load_path
-        initialize_rspec
+        require_postfork_preloads
 
         loop do
           debug "Waiting for message"
@@ -69,18 +71,14 @@ module RSpec
 
       def setup_load_path
         parsed_options.configure(RSpec.configuration)
-        default_path = RSpec.configuration.default_path || "spec"
-
-        spec_path = File.expand_path("spec", Conductor.root)
-        default_full_path = File.expand_path(default_path, Conductor.root)
-
-        $LOAD_PATH.unshift(spec_path) if Dir.exist?(spec_path) && !$LOAD_PATH.include?(spec_path)
+        @default_path = RSpec.configuration.default_path || "spec"
+        @default_full_path = File.expand_path(@default_path, Conductor.root)
 
-        if default_full_path != spec_path && Dir.exist?(default_full_path)
-          $LOAD_PATH.unshift(default_full_path)
+        if Dir.exist?(@default_full_path) && !$LOAD_PATH.include?(@default_full_path)
+          $LOAD_PATH.unshift(@default_full_path)
         end
 
-        debug "Load path (spec dirs): #{$LOAD_PATH.grep(/spec/)}"
+        debug "Load path (spec dirs): #{$LOAD_PATH.inspect}"
       end
 
       def suppress_output
@@ -89,17 +87,29 @@ module RSpec
         $stdin.reopen(null_io_in)
       end
 
-      def initialize_rspec
-        rails_helper = File.expand_path("rails_helper.rb", Conductor.root)
-        spec_helper = File.expand_path("spec_helper.rb", Conductor.root)
-        if File.exist?(rails_helper)
-          debug "Requiring rails_helper to boot Rails..."
-          require rails_helper
-        elsif File.exist?(spec_helper)
-          debug "Requiring spec_helper..."
-          require spec_helper
+      def require_postfork_preloads
+        if @postfork_require == :spec_helper
+          rails_helper = File.expand_path("rails_helper.rb", @default_full_path)
+          spec_helper = File.expand_path("spec_helper.rb", @default_full_path)
+          if File.exist?(rails_helper)
+            debug "Requiring rails_helper to boot Rails..."
+            require rails_helper
+          elsif File.exist?(spec_helper)
+            debug "Requiring spec_helper..."
+            require spec_helper
+          else
+            debug "Neither rails_helper, nor spec_helper found, skipping..."
+          end
+        elsif @postfork_require
+          required_file = File.expand_path(@postfork_require, @default_full_path)
+          if File.exist?(required_file)
+            debug "Requiring #{required_file}..."
+            require required_file
+          else
+            debug "#{required_file} not found, skipping..."
+          end
         else
-          debug "Could detect neither rails_helper nor spec_helper"
+          debug "Skipping postfork require..."
         end
 
         debug "RSpec initialized, running before(:suite) hooks"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-conductor
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Mark Abramov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-12-21 00:00:00.000000000 Z
+date: 2025-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core