knapsack_pro 6.0.4 → 7.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e14f8999c37f913f26b9d52a4c5968f25d9c3f7d3a6f91442e140619d5eb986
-  data.tar.gz: 58350583c0545e48f7deb7b2bf78f951124f87b35f734627400794479c3a53b2
+  metadata.gz: cd0d61c51dbf5b1db810f1249e058149831a3e502af11158bcb112ca02f83bf8
+  data.tar.gz: 8c281aa9ed386c01f857f60212f469fdb1364ff3ffc3111e60cdcb0a1557dc35
 SHA512:
-  metadata.gz: 3ee99fbf40d75acbaf3af791947a87a2e7d547638e99dd04666133e3f4c7addc33f8e91f610fb055b3fd8d47bfadb8e9257dfa0ef65ec16042b0ac7dfb51b727
-  data.tar.gz: 3adfda6f4cfb3761b497da0d2aeb688fe70efc65334da29b70fb0af3ff0a480dcf83714d11c3b126bcdc1218fa46c1b3f88264090bf204f310dc332512b077b8
+  metadata.gz: b3f306e986304db8084259385b375681b4bf7bad16351fbe15bf3c5d624ab31648a42e2efafb8cc3bdd3eef7ce2ea49df91d9fa87b1a812830aaf6d3e489cb89
+  data.tar.gz: 867302738082653b366f08265224463186ea19069e147d281020ef1a76c6c480398922913fdf92d3ad1971fe792be69e204b4087e589eeac66b705fabc6a7879

data/.circleci/config.yml

@@ -37,7 +37,8 @@ commands:
             fi
       - restore_cache:
           keys:
-          - v1-bundler-rails-{{ checksum "Gemfile.lock" }}-<< parameters.ruby >>
+          - v1-bundler-rails-{{ checksum "Gemfile.lock" }}-ruby-<< parameters.ruby >>-rspec-<< parameters.rspec >>
+          - v1-bundler-rails-{{ checksum "Gemfile.lock" }}-ruby-<< parameters.ruby >>-
           - v1-bundler-rails-{{ checksum "Gemfile.lock" }}-
           - v1-bundler-rails-
       - run:
@@ -48,14 +49,15 @@ commands:
       - save_cache:
           paths:
             - << parameters.path >>/vendor/bundle
-          key: v1-bundler-rails-{{ checksum "Gemfile.lock" }}-<< parameters.ruby >>
+          key: v1-bundler-rails-{{ checksum "Gemfile.lock" }}-ruby-<< parameters.ruby >>-rspec-<< parameters.rspec >>
 
 jobs:
   unit:
     parallelism: 1
     working_directory: ~/knapsack_pro-ruby
+    resource_class: small
     docker:
-      - image: cimg/ruby:3.2
+      - image: cimg/ruby:3.3
     steps:
       - setup_knapsack_pro_ruby
       - run: gem install rubocop
@@ -63,9 +65,51 @@ jobs:
       - run: bundle exec rspec spec
       - run: bundle exec ruby spec/knapsack_pro/formatters/time_tracker_specs.rb
 
-  integration-regular-rspec:
+  integration-rspec:
+    parallelism: 1
+    working_directory: ~/knapsack_pro-ruby
+    resource_class: small
+    parameters:
+      ruby:
+        type: string
+      rspec:
+        type: string
+    docker:
+      - image: cimg/ruby:<< parameters.ruby >>
+    steps:
+      - checkout
+      - run:
+          command: |
+            if [[ "<< parameters.rspec >>" != "" ]]; then
+              sed -i 's/.*gem.*rspec-core.*/gem "rspec-core", "<< parameters.rspec >>"/g' ./Gemfile
+              echo "Updated RSpec version in Gemfile"
+            fi
+      - restore_cache:
+          keys:
+          - v1-bundler-gem-{{ checksum "knapsack_pro.gemspec" }}-ruby-<< parameters.ruby >>-rspec-<< parameters.rspec >>
+          - v1-bundler-gem-{{ checksum "knapsack_pro.gemspec" }}-ruby-<< parameters.ruby >>-
+          - v1-bundler-gem-{{ checksum "knapsack_pro.gemspec" }}-
+          - v1-bundler-gem-
+      - run:
+          command: |
+            bundle config set --local path './vendor/bundle'
+            bundle install --jobs=4 --retry=3
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-bundler-gem-{{ checksum "knapsack_pro.gemspec" }}-ruby-<< parameters.ruby >>-rspec-<< parameters.rspec >>
+      - run:
+          command: |
+            ruby --version
+            bundle exec rspec --version
+            RSPEC=$(bundle exec rspec --version | grep rspec-core | head -n1 | cut -d " " -f5)
+            [ $RSPEC != << parameters.rspec >> ] && exit 1 || echo "Correct version of RSpec installed: $RSPEC"
+      - run: bundle exec rspec spec/integration/runners/queue/rspec_runner_spec.rb
+
+  e2e-regular-rspec:
     parallelism: 2
     working_directory: ~/knapsack_pro-ruby
+    resource_class: small
     parameters:
       ruby:
         type: string
@@ -122,8 +166,16 @@ jobs:
             export KNAPSACK_PRO_BRANCH="$CIRCLE_BRANCH--$CIRCLE_BUILD_NUM--regular--split"
             export KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES=true
             bundle exec rake knapsack_pro:rspec
+      - run:
+          working_directory: ~/rails-app-with-knapsack_pro
+          command: |
+            # split custom files by test examples ||
+            export KNAPSACK_PRO_BRANCH="$CIRCLE_BRANCH--$CIRCLE_BUILD_NUM--regular--split-custom-files"
+            export KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES=true
+            export KNAPSACK_PRO_SLOW_TEST_FILE_PATTERN="spec/features/calculator_spec.rb"
+            bundle exec rake knapsack_pro:rspec
 
-  integration-queue-rspec:
+  e2e-queue-rspec:
     parameters:
       ruby:
         type: string
@@ -131,6 +183,7 @@ jobs:
         type: string
     parallelism: 2
     working_directory: ~/knapsack_pro-ruby
+    resource_class: small
     docker:
       - image: cimg/ruby:<< parameters.ruby >>-browsers
         environment:
@@ -216,9 +269,10 @@ jobs:
             export KNAPSACK_PRO_TEST_FILE_PATTERN="turnip/**/*.feature"
             bundle exec rake "knapsack_pro:queue:rspec[-r turnip/rspec]"
 
-  integration-regular-minitest:
+  e2e-regular-minitest:
     parallelism: 2
     working_directory: ~/knapsack_pro-ruby
+    resource_class: small
     parameters:
       ruby:
         type: string
@@ -255,12 +309,13 @@ jobs:
             export KNAPSACK_PRO_BRANCH="$CIRCLE_BRANCH--$CIRCLE_BUILD_NUM--regular"
             bundle exec rake knapsack_pro:minitest[--verbose]
 
-  integration-queue-minitest:
+  e2e-queue-minitest:
     parameters:
       ruby:
         type: string
     parallelism: 2
     working_directory: ~/knapsack_pro-ruby
+    resource_class: small
     docker:
       - image: cimg/ruby:<< parameters.ruby >>-browsers
         environment:
@@ -307,25 +362,31 @@ workflows:
   tests:
     jobs:
       - unit
-      - integration-regular-rspec:
-          name: integration-regular__ruby-<< matrix.ruby >>__rspec-<< matrix.rspec >>
+      - integration-rspec:
+          name: integration__ruby-<< matrix.ruby >>__rspec-<< matrix.rspec >>
+          matrix:
+            parameters:
+              ruby: ["3.0", "3.1", "3.2", "3.3"]
+              rspec: ["3.10.2", "3.11.0", "3.12.2"]
+      - e2e-regular-rspec:
+          name: e2e-regular__ruby-<< matrix.ruby >>__rspec-<< matrix.rspec >>
           matrix:
             parameters:
-              ruby: ["3.0", "3.1", "3.2"]
+              ruby: ["3.0", "3.1", "3.2", "3.3"]
               rspec: ["3.10.2", "3.11.0", "3.12.2"]
-      - integration-queue-rspec:
-          name: integration-queue__ruby-<< matrix.ruby >>__rspec-<< matrix.rspec >>
+      - e2e-queue-rspec:
+          name: e2e-queue__ruby-<< matrix.ruby >>__rspec-<< matrix.rspec >>
           matrix:
             parameters:
-              ruby: ["3.0", "3.1", "3.2"]
+              ruby: ["3.0", "3.1", "3.2", "3.3"]
               rspec: ["3.10.2", "3.11.0", "3.12.2"]
-      - integration-regular-minitest:
-          name: integration-regular__ruby-<< matrix.ruby >>__minitest
+      - e2e-regular-minitest:
+          name: e2e-regular__ruby-<< matrix.ruby >>__minitest
           matrix:
             parameters:
-              ruby: ["3.0", "3.1", "3.2"]
-      - integration-queue-minitest:
-          name: integration-queue__ruby-<< matrix.ruby >>__minitest
+              ruby: ["3.0", "3.1", "3.2", "3.3"]
+      - e2e-queue-minitest:
+          name: e2e-queue__ruby-<< matrix.ruby >>__minitest
           matrix:
             parameters:
-              ruby: ["3.0", "3.1", "3.2"]
+              ruby: ["3.0", "3.1", "3.2", "3.3"]

data/.github/pull_request_template.md

@@ -0,0 +1,22 @@
+# Story
+
+TODO: link to the internal story
+
+## Related
+
+TODO: links to related PRs or issues
+
+# Description
+
+TODO
+
+# Changes
+
+TODO: changes introduced by this PR
+
+# Checklist reminder
+
+- [ ] You follow the architecture outlined below for RSpec in Queue Mode, which is a work in progress (feel free to propose changes):
+  - Pure: `lib/knapsack_pro/pure/queue/rspec_pure.rb` contains pure functions that are unit tested.
+  - Extension: `lib/knapsack_pro/extensions/rspec_extension.rb` encapsulates calls to RSpec internals and is integration and e2e tested.
+  - Runner: `lib/knapsack_pro/runners/queue/rspec_runner.rb` invokes the pure code and the extension to produce side effects, which are integration and e2e tested.

data/.gitignore

@@ -34,3 +34,7 @@ Gemfile.lock
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+
+# dynamically generated specs
+spec/knapsack_pro/formatters/tmp_time_tracker*_spec.rb
+spec_integration/

data/CHANGELOG.md

@@ -1,5 +1,100 @@
 # Changelog
 
+### 7.0.1
+
+* fix(RSpec): conditionally adds `--require rails_helper` to cli arguments of `KnapsackPro::Runners::Queue::RSpecRunner`. Version 7.0.0 introduced some fundamental changes, namely fetching, loading and running batches of specs **after** executing suite hooks, so that such hooks are only ran once, not before every batch. As a result, if `rails_helper` is only required in spec files, which is the RSpec default, instead of e.g. in `.rspec`, then some `before(:suite)` hooks, e.g. defined by gems, are registered after suite hooks had already been executed by the test suite. By comparison, RSpec loads all the spec files **before** executing `before(:suite)` hooks.
+
+PR with the above changes: https://github.com/KnapsackPro/knapsack_pro-ruby/pull/243
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v7.0.0...v7.0.1
+
+### 7.0.0
+
+* __(breaking change)__ RSpec in Queue Mode:
+  * The default for `KNAPSACK_PRO_LOG_LEVEL` is `info` instead of `debug`.
+  * The RSpec `before(:suite)` and `after(:suite)` hooks changed:
+
+    __Before:__<br>
+    The `before(:suite)` and `after(:suite)` hooks were executed multiple times. Each time for a batch of tests fetched from Knapsack Pro Queue API.
+
+    __After:__<br>
+    The `before(:suite)` and `after(:suite)` hooks are executed only once: `before(:suite)` is executed before starting tests, `after(:suite)` is executed after all tests are completed. (It is what you would expect from RSpec).
+
+  * The `KnapsackPro::Hooks::Queue.after_queue` hook change:
+
+    __Before:__<br>
+    The `KnapsackPro::Hooks::Queue.after_queue` hook is executed outside of the `after(:suite)` hook.
+
+    __After:__<br>
+    The `KnapsackPro::Hooks::Queue.after_queue` hook is executed __inside__ of the `after(:suite)` hook.
+
+* Recommended RSpec changes in your project:
+  * Remove the following code if you use Queue Mode and the `rspec_junit_formatter` gem to generate JUnit XML or JSON reports:
+
+    ```ruby
+    # REMOVE THE FOLLOWING CODE
+
+    # spec_helper.rb or rails_helper.rb
+    TMP_REPORT = "tmp/rspec_#{ENV['KNAPSACK_PRO_CI_NODE_INDEX']}.xml"
+    FINAL_REPORT = "tmp/final_rspec_#{ENV['KNAPSACK_PRO_CI_NODE_INDEX']}.xml"
+
+    KnapsackPro::Hooks::Queue.after_subset_queue do |queue_id, subset_queue_id|
+      if File.exist?(TMP_REPORT)
+        FileUtils.mv(TMP_REPORT, FINAL_REPORT)
+      end
+    end
+    ```
+
+    Learn more about [using Knapsack Pro with RSpec formatters](https://docs.knapsackpro.com/ruby/rspec/#formatters-rspec_junit_formatter-json) and [using Knapsack Pro with CircleCI](https://docs.knapsackpro.com/ruby/circleci/) in the docs.
+
+  * Replace the following code if you are using Queue Mode and the `percy-capybara` gem on a version older than 4:
+
+    Before:
+
+    ```ruby
+    KnapsackPro::Hooks::Queue.before_queue { |queue_id| Percy::Capybara.initialize_build }
+    KnapsackPro::Hooks::Queue.after_queue { |queue_id| Percy::Capybara.finalize_build }
+    ```
+
+    After:
+
+    ```ruby
+    # recommended
+    before(:suite) { Percy::Capybara.initialize_build }
+    after(:suite) { Percy::Capybara.finalize_build }
+    ```
+
+    Learn more about [using Knapsack Pro with Percy](https://docs.knapsackpro.com/ruby/hooks/#percy-capybara) in the docs.
+
+  * We are no longer modifying the default RSpec formatters in Queue Mode. You can remove the [`KNAPSACK_PRO_MODIFY_DEFAULT_RSPEC_FORMATTERS`](https://docs.knapsackpro.com/ruby/reference/#knapsack_pro_modify_default_rspec_formatters-removed-rspec) environment variable from your CI config if you are using it.
+
+* RSpec improvements in Queue Mode:
+  * Termination signals (`HUP`, `INT`, `TERM`, `ABRT`, `QUIT`, `USR1`, and `USR2`) are handled earlier: the process will terminate before the next top-level example group (`describe` or `context`) instead of waiting for the next Knapsack Pro batch of tests.
+
+  * Respect the `--error-exit-code` option. It sets a custom exit code (instead of `1`) when RSpec fails outside an example (e.g. lack of memory, termination signal).
+
+    ```bash
+    bundle exec rake "knapsack_pro:queue:rspec[--error-exit-code 3]"
+    ```
+
+  * Respect the `--failure-exit-code` option. It sets a custom exit code for when any examples fail.
+
+    ```bash
+    bundle exec rake "knapsack_pro:queue:rspec[--failure-exit-code 2]"
+    ```
+
+  * Respect the `--fail-fast` option and show a warning in the Knapsack Pro log.
+
+  * Ignore the `fail_if_no_examples` option in Queue Mode:
+    * A late CI node, started after all tests were executed by other nodes, is expected to receive an empty batch.
+    * A batch could contain tests with no examples (e.g. commented out)
+
+  * Raise an exception if the [deprecated `run_all_when_everything_filtered`](https://docs.knapsackpro.com/ruby/rspec/#some-of-my-test-files-are-not-executed) option is detected.
+
+PR with the above changes: https://github.com/KnapsackPro/knapsack_pro-ruby/pull/237
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v6.0.4...v7.0.0
+
 ### 6.0.4
 
 * fix(minitest): avoid installing `at_exit` (that would result in an empty run of Minitest after Knapsack Pro is finished in Queue Mode)

data/Gemfile

@@ -2,3 +2,12 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in knapsack.gemspec
 gemspec
+
+group :test do
+  gem 'rspec_junit_formatter', require: false
+  gem 'nokogiri', require: false
+  gem 'simplecov', require: false
+
+  # This line is going to be replaced on CI to test different RSpec versions.
+  # gem 'rspec-core', 'x.x.x'
+end

data/README.md

@@ -42,10 +42,6 @@ The `knapsack_pro` gem supports all CIs and the following test runners:
 - Spinach
 - Turnip
 
-## Requirements
-
-`>= Ruby 2.1.0`
-
 ## Installation
 
 The [Installation Guide](https://docs.knapsackpro.com/knapsack_pro-ruby/guide/?utm_source=github&utm_medium=readme&utm_campaign=knapsack_pro-ruby_gem&utm_content=installation_guide) will ask you a few questions and generate instruction steps for your project:
@@ -78,30 +74,32 @@ Scripted tests can be found in the [Rails App With Knapsack Pro repository](http
 
 ### Publishing
 
-Update the version in `lib/knapsack_pro/version.rb` and `CHANGELOG.md`:
+1. Update the `CHANGELOG.md` as part of your PR.
+
+2. After your PR has been merged, update the gem version in `lib/knapsack_pro/version.rb` directly on the `master` branch:
 
 ```bash
 git commit -m "Bump version X.X.X"
 git push origin master
 ```
 
-Create a git tag for the release:
+3. Create a git tag for the release:
 
 ```bash
 git tag -a vX.X.X -m "Release vX.X.X"
 git push --tags
 ```
 
-Build the gem and publish it to RubyGems:
+4. Build the gem and publish it to RubyGems:
 
 ```bash
 gem build knapsack_pro.gemspec
 gem push knapsack_pro-X.X.X.gem
 ```
 
-Update the latest available gem version in `TestSuiteClientVersionChecker` for the Knapsack Pro API repository.
+5. Update the latest available gem version in `TestSuiteClientVersionChecker` for the Knapsack Pro API repository.
 
-Update the `knapsack_pro` gem version in:
+6. Update the `knapsack_pro` gem version in:
 
 - [Rails App With Knapsack Pro repository](https://github.com/KnapsackPro/rails-app-with-knapsack_pro)
 - Knapsack Pro API internal repository

data/knapsack_pro.gemspec

@@ -6,10 +6,11 @@ require 'knapsack_pro/version'
 Gem::Specification.new do |spec|
   spec.name          = 'knapsack_pro'
   spec.version       = KnapsackPro::VERSION
+  spec.required_ruby_version = '>= 2.7.0'
   spec.authors       = ['ArturT']
   spec.email         = ['support@knapsackpro.com']
   spec.summary       = %q{Knapsack Pro splits tests across parallel CI nodes and ensures each parallel job finish work at a similar time.}
-  spec.description   = %q{Run tests in parallel across CI server nodes based on tests execution time. Split tests in a dynamic way to ensure parallel jobs are done at a similar time. Thanks to that your CI build time is as fast as possible. It works with many CI providers.}
+  spec.description   = %q{Knapsack Pro wraps your current test runner(s) and works with your existing CI infrastructure to parallelize tests optimally. It dynamically splits your tests based on up-to-date test execution data. It's designed from the ground up for CI and supports all of them.}
   spec.homepage      = 'https://knapsackpro.com'
   spec.license       = 'MIT'
   spec.metadata    = {

data/lib/knapsack_pro/adapters/base_adapter.rb

@@ -60,13 +60,13 @@ module KnapsackPro
         File.write(self.class.adapter_bind_method_called_file, nil)
 
         if KnapsackPro::Config::Env.recording_enabled?
-          KnapsackPro.logger.debug('Test suite time execution recording enabled.')
+          KnapsackPro.logger.debug('Regular Mode enabled.')
           bind_time_tracker
           bind_save_report
         end
 
         if KnapsackPro::Config::Env.queue_recording_enabled?
-          KnapsackPro.logger.debug('Test suite time execution queue recording enabled.')
+          KnapsackPro.logger.debug('Queue Mode enabled.')
           bind_queue_mode
         end
       end
@@ -83,8 +83,13 @@ module KnapsackPro
         raise NotImplementedError
       end
 
+      def bind_after_queue_hook
+        raise NotImplementedError
+      end
+
       def bind_queue_mode
         bind_before_queue_hook
+        bind_after_queue_hook
         bind_time_tracker
       end
     end

data/lib/knapsack_pro/adapters/cucumber_adapter.rb

@@ -65,9 +65,7 @@ module KnapsackPro
         end
       end
 
-      def bind_queue_mode
-        super
-
+      def bind_after_queue_hook
         ::Kernel.at_exit do
           KnapsackPro::Hooks::Queue.call_after_subset_queue
           KnapsackPro::Report.save_subset_queue_to_file

data/lib/knapsack_pro/adapters/rspec_adapter.rb

@@ -52,6 +52,10 @@ module KnapsackPro
         !!parsed_options(cli_args)&.[](:formatters)
       end
 
+      def self.has_require_rails_helper_option?(cli_args)
+        (parsed_options(cli_args)&.[](:requires) || []).include?("rails_helper")
+      end
+
       def self.order_option(cli_args)
         parsed_options(cli_args)&.[](:order)
       end
@@ -76,6 +80,10 @@ module KnapsackPro
         id.match(/\A(.*?)(?:\[([\d\s:,]+)\])?\z/).captures.first
       end
 
+      def self.rails_helper_exists?(test_dir)
+        File.exist?("#{test_dir}/rails_helper.rb")
+      end
+
       # private
       def self.top_level_group(example)
         group = example.metadata[:example_group]
@@ -87,7 +95,7 @@ module KnapsackPro
 
       def bind_time_tracker
         ensure_no_focus!
-        log_batch_duration
+        log_tests_duration
       end
 
       def ensure_no_focus!
@@ -105,12 +113,14 @@ module KnapsackPro
         end
       end
 
-      def log_batch_duration
+      def log_tests_duration
         ::RSpec.configure do |config|
-          config.after(:suite) do
+          config.append_after(:suite) do
             time_tracker = KnapsackPro::Formatters::TimeTrackerFetcher.call
-            formatted = KnapsackPro::Presenter.global_time(time_tracker.batch_duration)
-            KnapsackPro.logger.debug(formatted)
+            if time_tracker
+              formatted = KnapsackPro::Presenter.global_time(time_tracker.duration)
+              KnapsackPro.logger.debug(formatted)
+            end
           end
         end
       end
@@ -127,10 +137,15 @@ module KnapsackPro
       def bind_before_queue_hook
         ::RSpec.configure do |config|
           config.before(:suite) do
-            unless ENV['KNAPSACK_PRO_BEFORE_QUEUE_HOOK_CALLED']
-              ENV['KNAPSACK_PRO_BEFORE_QUEUE_HOOK_CALLED'] = 'true'
-              KnapsackPro::Hooks::Queue.call_before_queue
-            end
+            KnapsackPro::Hooks::Queue.call_before_queue
+          end
+        end
+      end
+
+      def bind_after_queue_hook
+        ::RSpec.configure do |config|
+          config.after(:suite) do
+            KnapsackPro::Hooks::Queue.call_after_queue
           end
         end
       end

data/lib/knapsack_pro/config/env.rb

@@ -144,14 +144,6 @@ module KnapsackPro
           test_files_encrypted == 'true'
         end
 
-        def modify_default_rspec_formatters
-          ENV.fetch('KNAPSACK_PRO_MODIFY_DEFAULT_RSPEC_FORMATTERS', true)
-        end
-
-        def modify_default_rspec_formatters?
-          modify_default_rspec_formatters.to_s == 'true'
-        end
-
         def branch_encrypted
           ENV['KNAPSACK_PRO_BRANCH_ENCRYPTED']
         end
@@ -276,7 +268,7 @@ module KnapsackPro
         end
 
         def log_level
-          LOG_LEVELS[ENV['KNAPSACK_PRO_LOG_LEVEL'].to_s.downcase] || ::Logger::DEBUG
+          LOG_LEVELS[ENV['KNAPSACK_PRO_LOG_LEVEL'].to_s.downcase] || ::Logger::INFO
         end
 
         def log_dir

data/lib/knapsack_pro/extensions/rspec_extension.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module KnapsackPro
+  module Extensions
+    # Facade to abstract calls to internal RSpec methods.
+    # To allow comparing the monkey patch with the original RSpec code, keep a similar method structure and permalink to the source.
+    module RSpecExtension
+      Seed = Struct.new(:value, :used?)
+
+      def self.setup!
+        RSpec::Core::World.prepend(World)
+        RSpec::Core::Runner.prepend(Runner)
+        RSpec::Core::Configuration.prepend(Configuration)
+      end
+
+      module World
+        # Based on:
+        # https://github.com/rspec/rspec-core/blob/f8c8880dabd8f0544a6f91d8d4c857c1bd8df903/lib/rspec/core/world.rb#L171
+        #
+        # Filters are not announced because we do not load tests during setup. It would print `No examples found.` and we don't want that.
+        def knapsack__announce_filters
+          fail_if_config_and_cli_options_invalid
+        end
+      end
+
+      module Runner
+        # Based on:
+        # https://github.com/rspec/rspec-core/blob/f8c8880dabd8f0544a6f91d8d4c857c1bd8df903/lib/rspec/core/runner.rb#L98
+        #
+        # `@configuration.load_spec_files` is not called because we load tests in batches with `knapsack__load_spec_files_batch` later on.
+        def knapsack__setup(stream_error = $stderr, stream_out = $stdout)
+          configure(stream_error, stream_out)
+        ensure
+          world.knapsack__announce_filters
+        end
+
+        def knapsack__wants_to_quit?
+          world.wants_to_quit
+        end
+
+        def knapsack__rspec_is_quitting?
+          world.respond_to?(:rspec_is_quitting) && world.rspec_is_quitting
+        end
+
+        def knapsack__exit_early
+          _exit_status = configuration.reporter.exit_early(exit_code)
+        end
+
+        # Based on:
+        # https://github.com/rspec/rspec-core/blob/f8c8880dabd8f0544a6f91d8d4c857c1bd8df903/lib/rspec/core/configuration.rb#L546
+        def knapsack__error_exit_code
+          configuration.error_exit_code # nil unless `--error-exit-code` is specified
+        end
+
+        # must be called after `Runner#knapsack__setup` that loads the `spec_helper.rb` configuration
+        def knapsack__deprecated_run_all_when_everything_filtered_enabled?
+          configuration.respond_to?(:run_all_when_everything_filtered) && !!configuration.run_all_when_everything_filtered
+        end
+
+        def knapsack__seed
+          Seed.new(configuration.seed.to_s, configuration.seed_used?)
+        end
+
+        # @param test_file_paths Array[String]
+        #   Example: ['a_spec.rb', 'b_spec.rb[1:1]']
+        def knapsack__load_spec_files_batch(test_file_paths)
+          world.reset
+
+          # Reset filters, but do not reset `configuration.static_config_filter_manager` to preserve the --tag option
+          filter_manager = RSpec::Core::FilterManager.new
+          options.configure_filter_manager(filter_manager)
+          configuration.filter_manager = filter_manager
+
+          configuration.knapsack__load_spec_files(test_file_paths)
+        end
+
+        # Based on:
+        # https://github.com/rspec/rspec-core/blob/f8c8880dabd8f0544a6f91d8d4c857c1bd8df903/lib/rspec/core/runner.rb#L113
+        #
+        # Ignore `configuration.fail_if_no_examples` in Queue Mode:
+        #   * a late CI node, started after all tests were executed by other nodes, is expected to receive an empty batch
+        #   * a batch could contain tests with no examples (e.g. commented out)
+        #
+        # @return [Fixnum] exit status code.
+        def knapsack__run_specs(queue_runner)
+          # Based on:
+          # https://github.com/rspec/rspec-core/blob/f8c8880dabd8f0544a6f91d8d4c857c1bd8df903/lib/rspec/core/world.rb#L53
+          ordering_strategy = configuration.ordering_registry.fetch(:global)
+          node_examples_passed = true
+
+          configuration.reporter.report(_expected_example_count = 0) do |reporter|
+            configuration.with_suite_hooks do
+              queue_runner.with_batch do |test_file_paths|
+                knapsack__load_spec_files_batch(test_file_paths)
+
+                examples_passed = ordering_strategy.order(world.example_groups).map do |example_group|
+                  queue_runner.handle_signal!
+                  example_group.run(reporter)
+                end.all?
+
+                node_examples_passed = false unless examples_passed
+
+                knapsack__persist_example_statuses
+
+                if reporter.fail_fast_limit_met?
+                  queue_runner.log_fail_fast_limit_met
+                  break
+                end
+              end
+            end
+
+            exit_code(node_examples_passed)
+          end
+        end
+
+        # Based on:
+        # https://github.com/rspec/rspec-core/blob/f8c8880dabd8f0544a6f91d8d4c857c1bd8df903/lib/rspec/core/runner.rb#L90
+        def knapsack__persist_example_statuses
+          persist_example_statuses
+        end
+      end
+
+      module Configuration
+        # Based on:
+        # https://github.com/rspec/rspec-core/blob/f8c8880dabd8f0544a6f91d8d4c857c1bd8df903/lib/rspec/core/configuration.rb#L1619
+        def knapsack__load_spec_files(test_file_paths)
+          batch_of_files_to_run = get_files_to_run(test_file_paths)
+          batch_of_files_to_run.each do |f|
+            file = File.expand_path(f)
+            load_file_handling_errors(:load, file)
+            loaded_spec_files << file
+          end
+        end
+      end
+    end
+  end
+end