knapsack_pro 8.1.0 → 8.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9392d6bfe6377c70af5278f4b527314194c5516f5693badc4255d46c989de2c6
-  data.tar.gz: 559425cde606e2dc159912dd3facf07467c5fa1ac507fced6734c0b655f246bf
+  metadata.gz: 0cb3592a7a5f0e3f69138e53d5659954e0e84190ad84380d823e776268d4e900
+  data.tar.gz: b40c96cebfb9c4446998291b01c435f6e29cd937a51848593510ed633e56b14b
 SHA512:
-  metadata.gz: 35a9edadc691088d01e48fdde8f496d9ed1bebb49d9dff50ffe9887c0238a5bf4b5c4289fcfcc024afd9921b53a8c5a28500ae2a00d0ca860f6ad2bfdae81de4
-  data.tar.gz: edeea08e31dfe17e0d614922665f93e76e0adbbf8564e56ef0d1f751bb38355e9e3b6f2bbd98d4f2d0ffb6a3ad417318497a150087723cf193b2f4e01f215e9f
+  metadata.gz: 8308e34071c72b055335ded1422bb49762c600fffbc86f83a54911dde1cc23db59e472233bd53c1ec558fbf612c11b537587e241774dd8824d14e6665fd914e8
+  data.tar.gz: 35829c1ba92de81be2d7b3f5bd428b9fb2a66a8ad3da940f21e196b02b7962ce13f0c453f27c85c3acfce681223b3a83145baf2b26ef12b10a66dcf67f0d9fa3

data/.circleci/config.yml

@@ -445,27 +445,27 @@ workflows:
           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"]
+              ruby: ["3.2", "3.3", "3.4"]
+              rspec: ["3.12.3", "3.13.3"]
       - e2e-regular-rspec:
           name: e2e-regular__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"]
+              ruby: ["3.2", "3.3", "3.4"]
+              rspec: ["3.12.3", "3.13.3"]
       - e2e-queue-rspec:
           name: e2e-queue__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"]
+              ruby: ["3.2", "3.3", "3.4"]
+              rspec: ["3.12.3", "3.13.3"]
       - e2e-regular-minitest:
           name: e2e-regular__ruby-<< matrix.ruby >>__minitest
           matrix:
             parameters:
-              ruby: ["3.0", "3.1", "3.2", "3.3"]
+              ruby: ["3.2", "3.3", "3.4"]
       - e2e-queue-minitest:
           name: e2e-queue__ruby-<< matrix.ruby >>__minitest
           matrix:
             parameters:
-              ruby: ["3.0", "3.1", "3.2", "3.3"]
+              ruby: ["3.2", "3.3", "3.4"]

data/CHANGELOG.md

@@ -1,5 +1,59 @@
 # Changelog
 
+### 8.1.2
+
+* Allow running RSpec with `--force-color` (and the default Split by Test Examples)
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/298
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v8.1.1...v8.1.2
+
+### 8.1.1
+
+* Do not load Rake tasks on behalf of the user for RSpec and Minitest in Queue Mode
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/297
+
+    Workarounds like [this one](https://docs.knapsackpro.com/ruby/troubleshooting/#rake-tasks-under-tests-are-run-more-than-once-in-queue-mode) are no more needed to test Rake tasks, you can now remove them and test Rake tasks like you would normally do:
+
+    RSpec:
+
+    ```ruby
+    before do
+      MY_APPLICATION_NAME::Application.load_tasks if Rake::Task.tasks.empty?
+    end
+
+    after do
+      Rake::Task[MY_TASK_NAME].reenable
+    end
+
+    it "tests the rake task" do
+      Rake::Task[MY_TASK_NAME].invoke
+      # ...
+    end
+    ```
+
+    Minitest:
+
+    ```ruby
+    setup do
+      MY_APPLICATION_NAME::Application.load_tasks if Rake::Task.tasks.empty?
+    end
+
+    teardown do
+      Rake::Task[MY_TASK_NAME].reenable
+    end
+
+    test "tests the rake task" do
+      Rake::Task[MY_TASK_NAME].invoke
+      # ...
+    end
+    ```
+
+    It's also ok to use `Rake.application.rake_require("tasks/MY_TASK")` instead of `MY_APPLICATION_NAME::Application.load_tasks if Rake::Task.tasks.empty?`.
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v8.1.0...v8.1.1
+
 ### 8.1.0
 
 * Improve the performance of the [RSpec split by test examples](https://docs.knapsackpro.com/ruby/split-by-test-examples/).

data/lib/knapsack_pro/test_case_detectors/rspec_test_example_detector.rb

@@ -33,32 +33,22 @@ module KnapsackPro
         # Apply a --format option which overrides formatters from the RSpec custom option files like `.rspec`.
         cli_args = cli_args_without_formatters + cli_format + [
           '--dry-run',
-          '--no-color',
           '--out', report_path,
-          '--default-path', test_dir,
+          '--default-path', test_dir
         ] + KnapsackPro::TestFilePresenter.paths(test_file_entities)
-        options = ::RSpec::Core::ConfigurationOptions.new(cli_args)
-        exit_code = ::RSpec::Core::Runner.new(options).run($stderr, $stdout)
-        if exit_code != 0
-          debug_cmd = ([
-            'bundle exec rspec',
-          ] + cli_args).join(' ')
-
-          KnapsackPro.logger.error('-'*10 + ' START of actionable error message ' + '-'*50)
-          KnapsackPro.logger.error('RSpec (with a dry-run option) had a problem generating the report with test examples for the slow test files. Here is what you can do:')
-
-          KnapsackPro.logger.error("a) Please look for an error message from RSpec in the output above or below. If you don't see anything, that is fine. Sometimes RSpec does not produce any errors in the output.")
-
-          KnapsackPro.logger.error("b) Check if RSpec generated the report file #{report_path}. If the report exists, it may contain an error message. Here is a preview of the report file:")
-          KnapsackPro.logger.error(report_content || 'N/A')
-
-          KnapsackPro.logger.error('c) To reproduce the error manually, please run the following RSpec command. This way, you can find out what is causing the error. Please ensure you run the command in the same environment where the error occurred. For instance, if the error happens on the CI server, you should run the command in the CI environment:')
-          KnapsackPro.logger.error(debug_cmd)
+        exit_code = begin
+          options = ::RSpec::Core::ConfigurationOptions.new(cli_args)
+          ::RSpec::Core::Runner.new(options).run($stderr, $stdout)
+        rescue SystemExit => e
+          e.status
+        end
 
-          KnapsackPro.logger.error('-'*10 + ' END of actionable error message ' + '-'*50)
+        return if exit_code.zero?
 
-          raise 'There was a problem while generating test examples for the slow test files. Please read the actionable error message above.'
-        end
+        report.fetch('messages', []).each { |message| puts message }
+        command = (['bundle exec rspec'] + cli_args).join(' ')
+        KnapsackPro.logger.error("Failed to generate the slow test files report: #{command}")
+        exit exit_code
       end
 
       def test_file_example_paths
@@ -92,8 +82,9 @@ module KnapsackPro
         "#{report_dir}/rspec_dry_run_json_report_node_#{KnapsackPro::Config::Env.ci_node_index}.json"
       end
 
-      def report_content
-        File.read(report_path) if File.exist?(report_path)
+      def report
+        return {} unless File.exist?(report_path)
+        JSON.parse(File.read(report_path))
       end
 
       def adapter_class

data/lib/knapsack_pro/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KnapsackPro
-  VERSION = '8.1.0'
+  VERSION = '8.1.2'
 end

data/lib/tasks/queue/minitest.rake

@@ -9,6 +9,7 @@ namespace :knapsack_pro do
     end
 
     task :minitest_go, [:minitest_args] do |_, args|
+      Rake::Task.clear
       KnapsackPro::Runners::Queue::MinitestRunner.run(args[:minitest_args])
     end
   end

data/lib/tasks/queue/rspec.rake

@@ -9,6 +9,7 @@ namespace :knapsack_pro do
     end
 
     task :rspec_go, [:rspec_args] do |_, args|
+      Rake::Task.clear
       KnapsackPro::Runners::Queue::RSpecRunner.run(args[:rspec_args])
     end
   end

data/spec/knapsack_pro/test_case_detectors/rspec_test_example_detector_spec.rb

@@ -48,7 +48,6 @@ describe KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector do
           expect(RSpec::Core::ConfigurationOptions).to receive(:new).with(expected_args + [
             '--format', expected_format,
             '--dry-run',
-            '--no-color',
             '--out', report_path,
             '--default-path', test_dir,
             'spec/a_spec.rb', 'spec/b_spec.rb',
@@ -78,7 +77,7 @@ describe KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector do
           end
 
           it do
-            expect { subject }.to raise_error(RuntimeError, 'There was a problem while generating test examples for the slow test files. Please read the actionable error message above.')
+            expect { subject }.to raise_error(SystemExit) { |error| expect(error.status).to eq exit_code }
           end
         end
       end
@@ -123,6 +122,36 @@ describe KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector do
         expect { subject }.to raise_error("The internal KNAPSACK_PRO_RSPEC_OPTIONS environment variable is unset. Ensure it is not overridden accidentally. Otherwise, please report this as a bug: https://knapsackpro.com/perma/ruby/support")
       end
     end
+
+    context 'with --force-color' do
+      let(:rspec_args) { '--force-color' }
+      let(:expected_args) { ['--force-color'] }
+      let(:expected_format) { 'json' }
+
+      it_behaves_like 'generate_json_report runs RSpec::Core::Runner'
+    end
+
+    context 'with --no-color and --force-color' do
+      let(:rspec_args) { '--no-color --force-color' }
+
+      after { KnapsackPro.reset_logger! }
+
+      it do
+        subject_class = Class.new(KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector) do
+          define_method(:slow_test_files) do
+            [{ 'path' => 'spec/a_spec.rb' }]
+          end
+        end
+
+        expect do
+          KnapsackPro.logger = ::Logger.new($stdout)
+          subject_class.new.generate_json_report(rspec_args)
+        end
+          .to output(/Please only use one of `--force-color` and `--no-color`/).to_stderr
+          .and output(%r{ERROR -- : \[knapsack_pro\] Failed to generate the slow test files report: bundle exec rspec --no-color --force-color --format json --dry-run --out .knapsack_pro/test_case_detectors/rspec/rspec_dry_run_json_report_node_0.json --default-path spec spec/a_spec.rb}).to_stdout
+          .and raise_error(SystemExit) { |error| expect(error.status).to eq 1 }
+      end
+    end
   end
 
   describe '#test_file_example_paths' do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 8.1.0
+  version: 8.1.2
 platform: ruby
 authors:
 - ArturT
 bindir: bin
 cert_chain: []
-date: 2025-03-25 00:00:00.000000000 Z
+date: 2025-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake