knapsack_pro 8.1.1 → 8.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ad155a65c67bffcb3dad75d114396d2e53cc8896f21a84de7325a56f9a582ba
-  data.tar.gz: 6a6e0958d5596b150cdc6ee46453d5ff9991255e98113990015e34a8fef8aa1d
+  metadata.gz: f23120ba50c0ecf87cb9812a1238debd7d723c59e87fd006b93e1bbed2077cc1
+  data.tar.gz: 65758d5c380cb93332756af1ce05c1ad917d59340d5ca0e3c5fb563783b56059
 SHA512:
-  metadata.gz: ee9feec10df81e17331b3664af0a30f8d75c4d436bb9c897829588518bb3468e5c00a3729d0e5c9f731ce535ab2b02dc5747a52a743e400bd49ffd046bb7ef51
-  data.tar.gz: d982189a7880df48104810628f1ff6e416c420325ace9fc2827c988c0289bfe27d2e78ff4bdffd94fe20891e37333805f2d530ab40aa822632847daed5b9596d
+  metadata.gz: e54574fe5e0656917394d6246ab61f0b4840262907c35fff7c824f2a8ed854b9b072a30968d82230b4e6454d7683fdb095bba31a21bf4458361ea399e0a93653
+  data.tar.gz: 8a5030dd9184aa6d85330f884d849efdc3037e43614736386c718c041170553fdf1aadfe00331f748f2111fec299bd9b8332aa5e14719c241f1761c02c3b8bf4

data/.circleci/config.yml

@@ -6,8 +6,8 @@ commands:
       - checkout
       - restore_cache:
           keys:
-          - v1-bundler-ruby-{{ checksum "knapsack_pro.gemspec" }}
-          - v1-bundler-ruby-
+            - v1-bundler-ruby-{{ checksum "knapsack_pro.gemspec" }}
+            - v1-bundler-ruby-
       - run:
           command: |
             bundle config set --local path './vendor/bundle'
@@ -37,10 +37,10 @@ commands:
             fi
       - restore_cache:
           keys:
-          - 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-
+            - 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:
           working_directory: << parameters.path >>
           command: |
@@ -57,7 +57,7 @@ jobs:
     working_directory: ~/knapsack_pro-ruby
     resource_class: small
     docker:
-      - image: cimg/ruby:3.3
+      - image: cimg/ruby:3.4
     steps:
       - setup_knapsack_pro_ruby
       - run: gem install rubocop
@@ -88,10 +88,10 @@ jobs:
             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-
+            - 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'

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+### UNRELEASED
+
+### 8.1.3
+
+* Update `changelog_uri` in gemspec
+
+### 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
@@ -784,7 +798,7 @@ https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v3.3.0...v3.3.1
 
 ### 3.3.0
 
-* Show a JSON report file content when RSpec fails during a dry run 
+* Show a JSON report file content when RSpec fails during a dry run
 
     https://github.com/KnapsackPro/knapsack_pro-ruby/pull/172
 
@@ -865,7 +879,7 @@ https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v2.18.0...v2.18.1
 
 ### 2.18.0
 
-* Do not allow to use the RSpec tag option together with the RSpec split by test examples feature in knapsack_pro gem in Regular Mode 
+* Do not allow to use the RSpec tag option together with the RSpec split by test examples feature in knapsack_pro gem in Regular Mode
 
     https://github.com/KnapsackPro/knapsack_pro-ruby/pull/148
 

data/knapsack_pro.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
   spec.metadata    = {
     'bug_tracker_uri' => 'https://github.com/KnapsackPro/knapsack_pro-ruby/issues',
-    'changelog_uri' => 'https://github.com/KnapsackPro/knapsack_pro-ruby/blob/master/CHANGELOG.md',
+    'changelog_uri' => 'https://github.com/KnapsackPro/knapsack_pro-ruby/blob/main/CHANGELOG.md',
     'documentation_uri' => 'https://docs.knapsackpro.com/knapsack_pro-ruby/guide/',
     'homepage_uri' => 'https://knapsackpro.com',
     'source_code_uri' => 'https://github.com/KnapsackPro/knapsack_pro-ruby'

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.1'
+  VERSION = '8.1.3'
 end

data/spec/fixtures/vcr_cassettes/api/v1/build_distributions/subset/invalid_test_suite_token.yml

@@ -5,7 +5,7 @@ http_interactions:
     uri: http://api.knapsackpro.test:3000/v1/build_distributions/subset
     body:
       encoding: UTF-8
-      string: '{"fixed_test_suite_split":true,"cache_read_attempt":true,"commit_hash":"abcdefg","branch":"master","node_total":"2","node_index":"1","ci_build_id":"missing-build-id"}'
+      string: '{"fixed_test_suite_split":true,"cache_read_attempt":true,"commit_hash":"abcdefg","branch":"main","node_total":"2","node_index":"1","ci_build_id":"missing-build-id"}'
     headers:
       Content-Type:
       - application/json

data/spec/fixtures/vcr_cassettes/api/v1/build_distributions/subset/success.yml

@@ -5,7 +5,7 @@ http_interactions:
     uri: http://api.knapsackpro.test:3000/v1/build_distributions/subset
     body:
       encoding: UTF-8
-      string: '{"fixed_test_suite_split":true,"cache_read_attempt":true,"commit_hash":"abcdefg","branch":"master","node_total":"2","node_index":"1","ci_build_id":"missing-build-id"}'
+      string: '{"fixed_test_suite_split":true,"cache_read_attempt":true,"commit_hash":"abcdefg","branch":"main","node_total":"2","node_index":"1","ci_build_id":"missing-build-id"}'
     headers:
       Content-Type:
       - application/json

data/spec/fixtures/vcr_cassettes/api/v1/build_subsets/create/invalid_test_suite_token.yml

@@ -5,7 +5,7 @@ http_interactions:
     uri: http://api.knapsackpro.test:3000/v1/build_subsets
     body:
       encoding: UTF-8
-      string: '{"commit_hash":"abcdefg","branch":"master","node_total":"2","node_index":"1","test_files":[{"path":"a_spec.rb","time_execution":1.2},{"path":"b_spec.rb","time_execution":0.3}],"test_suite_token":"fake"}'
+      string: '{"commit_hash":"abcdefg","branch":"main","node_total":"2","node_index":"1","test_files":[{"path":"a_spec.rb","time_execution":1.2},{"path":"b_spec.rb","time_execution":0.3}]}'
     headers:
       Content-Type:
       - application/json

data/spec/fixtures/vcr_cassettes/api/v1/build_subsets/create/success.yml

@@ -5,7 +5,7 @@ http_interactions:
     uri: http://api.knapsackpro.test:3000/v1/build_subsets
     body:
       encoding: UTF-8
-      string: '{"commit_hash":"abcdefg","branch":"master","node_total":"2","node_index":"1","test_files":[{"path":"a_spec.rb","time_execution":1.2},{"path":"b_spec.rb","time_execution":0.3}],"test_suite_token":"3fa64859337f6e56409d49f865d13fd7"}'
+      string: '{"commit_hash":"abcdefg","branch":"main","node_total":"2","node_index":"1","test_files":[{"path":"a_spec.rb","time_execution":1.2},{"path":"b_spec.rb","time_execution":0.3}]}'
     headers:
       Content-Type:
       - application/json

data/spec/integration/api/build_distributions_subset_spec.rb

@@ -8,7 +8,7 @@ describe 'Request API /v1/build_distributions/subset' do
     KnapsackPro::Client::API::V1::BuildDistributions.subset(
       cache_read_attempt: true,
       commit_hash: 'abcdefg',
-      branch: 'master',
+      branch: 'main',
       node_total: '2',
       node_index: '1',
       test_files: [

data/spec/integration/api/build_subsets_create_spec.rb

@@ -7,7 +7,7 @@ describe 'Request API /v1/build_subsets' do
   let(:action) do
     KnapsackPro::Client::API::V1::BuildSubsets.create(
       commit_hash: 'abcdefg',
-      branch: 'master',
+      branch: 'main',
       node_total: '2',
       node_index: '1',
       test_files: [

data/spec/knapsack_pro/config/ci/app_veyor_spec.rb

@@ -49,8 +49,8 @@ describe KnapsackPro::Config::CI::AppVeyor do
     subject { described_class.new.branch }
 
     context 'when the environment exists' do
-      let(:env) { { 'APPVEYOR_REPO_BRANCH' => 'master' } }
-      it { should eql 'master' }
+      let(:env) { { 'APPVEYOR_REPO_BRANCH' => 'main' } }
+      it { should eql 'main' }
     end
 
     context "when the environment doesn't exist" do

data/spec/knapsack_pro/config/ci/cirrus_ci_spec.rb

@@ -63,8 +63,8 @@ describe KnapsackPro::Config::CI::CirrusCI do
     subject { described_class.new.branch }
 
     context 'when the environment exists' do
-      let(:env) { { 'CIRRUS_BRANCH' => 'master' } }
-      it { should eql 'master' }
+      let(:env) { { 'CIRRUS_BRANCH' => 'main' } }
+      it { should eql 'main' }
     end
 
     context "when the environment doesn't exist" do

data/spec/knapsack_pro/config/ci/codeship_spec.rb

@@ -49,8 +49,8 @@ describe KnapsackPro::Config::CI::Codeship do
     subject { described_class.new.branch }
 
     context 'when the environment exists' do
-      let(:env) { { 'CI_BRANCH' => 'master' } }
-      it { should eql 'master' }
+      let(:env) { { 'CI_BRANCH' => 'main' } }
+      it { should eql 'main' }
     end
 
     context "when the environment doesn't exist" do

data/spec/knapsack_pro/config/ci/heroku_spec.rb

@@ -63,8 +63,8 @@ describe KnapsackPro::Config::CI::Heroku do
     subject { described_class.new.branch }
 
     context 'when the environment exists' do
-      let(:env) { { 'HEROKU_TEST_RUN_BRANCH' => 'master' } }
-      it { should eql 'master' }
+      let(:env) { { 'HEROKU_TEST_RUN_BRANCH' => 'main' } }
+      it { should eql 'main' }
     end
 
     context "when the environment doesn't exist" do

data/spec/knapsack_pro/config/ci/semaphore2_spec.rb

@@ -68,13 +68,13 @@ describe KnapsackPro::Config::CI::Semaphore2 do
     end
 
     context 'when both SEMAPHORE_GIT_WORKING_BRANCH and SEMAPHORE_GIT_BRANCH are set' do
-      let(:env) { { 'SEMAPHORE_GIT_WORKING_BRANCH' => 'feature', 'SEMAPHORE_GIT_BRANCH' => 'master' } }
+      let(:env) { { 'SEMAPHORE_GIT_WORKING_BRANCH' => 'feature', 'SEMAPHORE_GIT_BRANCH' => 'main' } }
       it { should eql 'feature' }
     end
 
     context 'when SEMAPHORE_GIT_BRANCH is set' do
-      let(:env) { { 'SEMAPHORE_GIT_BRANCH' => 'master' } }
-      it { should eql 'master' }
+      let(:env) { { 'SEMAPHORE_GIT_BRANCH' => 'main' } }
+      it { should eql 'main' }
     end
 
     context "when no ENVs are set" do

data/spec/knapsack_pro/config/ci/semaphore_spec.rb

@@ -63,8 +63,8 @@ describe KnapsackPro::Config::CI::Semaphore do
     subject { described_class.new.branch }
 
     context 'when the environment exists' do
-      let(:env) { { 'BRANCH_NAME' => 'master' } }
-      it { should eql 'master' }
+      let(:env) { { 'BRANCH_NAME' => 'main' } }
+      it { should eql 'main' }
     end
 
     context "when the environment doesn't exist" do

data/spec/knapsack_pro/config/ci/travis_spec.rb

@@ -49,8 +49,8 @@ describe KnapsackPro::Config::CI::Travis do
     subject { described_class.new.branch }
 
     context 'when the environment exists' do
-      let(:env) { { 'TRAVIS_BRANCH' => 'master' } }
-      it { should eql 'master' }
+      let(:env) { { 'TRAVIS_BRANCH' => 'main' } }
+      it { should eql 'main' }
     end
 
     context "when the environment doesn't exist" do

data/spec/knapsack_pro/config/env_spec.rb

@@ -313,8 +313,8 @@ describe KnapsackPro::Config::Env do
 
     context 'when ENV exists' do
       context 'when KNAPSACK_PRO_BRANCH has value' do
-        before { stub_const("ENV", { 'KNAPSACK_PRO_BRANCH' => 'master' }) }
-        it { should eq 'master' }
+        before { stub_const("ENV", { 'KNAPSACK_PRO_BRANCH' => 'main' }) }
+        it { should eq 'main' }
       end
 
       context 'when CI environment has value' do
@@ -335,22 +335,22 @@ describe KnapsackPro::Config::Env do
         end
 
         context 'when values are different' do
-          let(:env_value) { 'master' }
+          let(:env_value) { 'main' }
           let(:ci_value) { 'feature-branch' }
 
-          it { should eq 'master' }
+          it { should eq 'main' }
 
           it 'logs a warning' do
             expect(logger).to receive(:info).with(
-              'You have set the environment variable KNAPSACK_PRO_BRANCH to master which could be automatically determined from the CI environment as feature-branch.'
+              'You have set the environment variable KNAPSACK_PRO_BRANCH to main which could be automatically determined from the CI environment as feature-branch.'
             )
             subject
           end
         end
 
         context 'when values are the same' do
-          let(:env_value) { 'master' }
-          let(:ci_value) { 'master' }
+          let(:env_value) { 'main' }
+          let(:ci_value) { 'main' }
 
           it 'does not log a warning' do
             expect(logger).not_to receive(:info)

data/spec/knapsack_pro/repository_adapters/git_adapter_spec.rb

@@ -28,7 +28,7 @@ describe KnapsackPro::RepositoryAdapters::GitAdapter do
   describe '#branches' do
     subject { described_class.new.branches }
 
-    it { expect(subject.include?('master')).to be true }
+    it { expect(subject.include?('main')).to be true }
     it { expect(subject.include?(circle_branch)).to be true } if ENV['CIRCLECI']
   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.1
+  version: 8.1.3
 platform: ruby
 authors:
 - ArturT
 bindir: bin
 cert_chain: []
-date: 2025-04-10 00:00:00.000000000 Z
+date: 2025-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -410,7 +410,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/KnapsackPro/knapsack_pro-ruby/issues
-  changelog_uri: https://github.com/KnapsackPro/knapsack_pro-ruby/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/KnapsackPro/knapsack_pro-ruby/blob/main/CHANGELOG.md
   documentation_uri: https://docs.knapsackpro.com/knapsack_pro-ruby/guide/
   homepage_uri: https://knapsackpro.com
   source_code_uri: https://github.com/KnapsackPro/knapsack_pro-ruby