knapsack_pro 5.1.0 → 5.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4e0c8f7bd4c8bf4c50885cdbcbecf34222a3d1ab46d3be52d937d940a0ba5c0
-  data.tar.gz: b8a68e22c872686d20fc6fac50ec3d02bad449768da522eb36ed86db5d331dfc
+  metadata.gz: fdfe0b2398cdf5c6f7721d4984569bc0adce8438406e97b005868c9f32478b24
+  data.tar.gz: '09411e2a2b2cddb9d5dd1e6cdb544c1b7b2898058155d135850836c7409b8551'
 SHA512:
-  metadata.gz: 34d669379edb42f5a3e3eaf9075320bd1e2457ec48dfae86d94e2fa21eb4562d1fcc2db66ed49749ef78a641741d934e6d978bc9cc557d5985e49eb9bbed133d
-  data.tar.gz: bde90595bb3123c0c10b53d58de5b78637a2c30679f3ab5e37283735ce3a4f6bcbc19a39be7fcf691f6878f5be0018d16e3eb0bc8adc9f2d6f23827de72f0bb2
+  metadata.gz: 822b2c1ef56ebaf68fbe24800511cdcd3cab21ef0aa8a74fb38a9cf85f682587cf41d59b7c347fa8609458ed35886215f535587016022c2952a5867441fe8f90
+  data.tar.gz: c2a94c2a81befbc09f0b7d77b656335275c028bc1ea40c1c06ad07f60e1623a3b0a4079eba83525234f6f7e460d3f8b067cd274fa4e0adfd1835d903df8f25d2

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+### 5.1.2
+
+* Fix broken RSpec split by test examples feature when `SPEC_OPTS` is set in Queue Mode. Ignore `SPEC_OPTS` when generating test examples report for slow test files.
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/191
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v5.1.1...v5.1.2
+
+### 5.1.1
+
+* Use `KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true` as default value in Queue Mode for GitLab CI
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/206
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v5.1.0...v5.1.1
+
 ### 5.1.0
 
 * Mask user seats data instead of hashing it
@@ -19,6 +35,10 @@ https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v5.0.0...v5.1.0
 
     https://github.com/KnapsackPro/knapsack_pro-ruby/pull/201
 
+    __(breaking change)__ for Buildkite. You need to pass the `BUILDKITE` environment variable to Docker Compose.
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/issues/204
+
 * Set `RAILS_ENV=test` / `RACK_ENV=test` in Queue Mode
 
     https://github.com/KnapsackPro/knapsack_pro-ruby/pull/199

data/lib/knapsack_pro/config/ci/gitlab_ci.rb

@@ -43,7 +43,7 @@ module KnapsackPro
         end
 
         def fixed_queue_split
-          false
+          true
         end
       end
     end

data/lib/knapsack_pro/runners/queue/rspec_runner.rb

@@ -87,6 +87,7 @@ module KnapsackPro
             all_test_file_paths += test_file_paths
             cli_args = args + test_file_paths
 
+            ensure_spec_opts_have_rspec_queue_summary_formatter
             options = ::RSpec::Core::ConfigurationOptions.new(cli_args)
             rspec_runner = ::RSpec::Core::Runner.new(options)
 
@@ -113,6 +114,15 @@ module KnapsackPro
           end
         end
 
+        def self.ensure_spec_opts_have_rspec_queue_summary_formatter
+          spec_opts = ENV['SPEC_OPTS']
+
+          return unless spec_opts
+          return if spec_opts.include?(KnapsackPro::Formatters::RSpecQueueSummaryFormatter.to_s)
+
+          ENV['SPEC_OPTS'] = "#{spec_opts} --format #{KnapsackPro::Formatters::RSpecQueueSummaryFormatter.to_s}"
+        end
+
         private
 
         def self.adapter_class

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '5.1.0'
+  VERSION = '5.1.2'
 end

data/lib/tasks/rspec.rake

@@ -7,6 +7,9 @@ namespace :knapsack_pro do
 
   desc "Generate JSON report for test suite based on default test pattern or based on defined pattern with ENV vars"
   task :rspec_test_example_detector do
+    # ignore the `SPEC_OPTS` options to not affect RSpec execution within this rake task
+    ENV.delete('SPEC_OPTS')
+
     detector = KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector.new
     detector.generate_json_report
   end

data/spec/knapsack_pro/config/env_spec.rb

@@ -728,7 +728,7 @@ describe KnapsackPro::Config::Env do
         ['Codefresh', { 'CF_BUILD_ID' => '123' }, false],
         ['Codeship', { 'CI_NAME' => 'codeship' }, true],
         ['GitHub Actions', { 'GITHUB_ACTIONS' => 'true' }, true],
-        ['GitLab CI', { 'GITLAB_CI' => 'true' }, false],
+        ['GitLab CI', { 'GITLAB_CI' => 'true' }, true],
         ['Heroku CI', { 'HEROKU_TEST_RUN_ID' => '123' }, false],
         ['Semaphore CI 1.0', { 'SEMAPHORE_BUILD_NUMBER' => '123' }, false],
         ['Semaphore CI 2.0', { 'SEMAPHORE' => 'true', 'SEMAPHORE_WORKFLOW_ID' => '123' }, false],

data/spec/knapsack_pro/runners/queue/rspec_runner_spec.rb

@@ -212,6 +212,7 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
         expect(tracker).to receive(:reset!)
         expect(tracker).to receive(:set_prerun_tests).with(test_file_paths)
 
+        expect(described_class).to receive(:ensure_spec_opts_have_rspec_queue_summary_formatter)
         options = double
         expect(RSpec::Core::ConfigurationOptions).to receive(:new).with([
           '--no-color',
@@ -339,4 +340,39 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
       end
     end
   end
+
+  describe '.ensure_spec_opts_have_rspec_queue_summary_formatter' do
+    subject { described_class.ensure_spec_opts_have_rspec_queue_summary_formatter }
+
+    context 'when `SPEC_OPTS` is set' do
+      context 'when `SPEC_OPTS` has RSpec Queue Summary Formatter' do
+        before do
+          stub_const('ENV', { 'SPEC_OPTS' => '--format json --format KnapsackPro::Formatters::RSpecQueueSummaryFormatter' })
+        end
+
+        it 'does nothing' do
+          subject
+          expect(ENV['SPEC_OPTS']).to eq '--format json --format KnapsackPro::Formatters::RSpecQueueSummaryFormatter'
+        end
+      end
+
+      context 'when `SPEC_OPTS` has no RSpec Queue Summary Formatter' do
+        before do
+          stub_const('ENV', { 'SPEC_OPTS' => '--format json' })
+        end
+
+        it 'adds RSpec Queue Summary Formatter to `SPEC_OPTS`' do
+          subject
+          expect(ENV['SPEC_OPTS']).to eq '--format json --format KnapsackPro::Formatters::RSpecQueueSummaryFormatter'
+        end
+      end
+    end
+
+    context 'when `SPEC_OPTS` is not set' do
+      it 'does nothing' do
+        subject
+        expect(ENV['SPEC_OPTS']).to be_nil
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.1.2
 platform: ruby
 authors:
 - ArturT
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-08 00:00:00.000000000 Z
+date: 2023-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -389,7 +389,7 @@ metadata:
   documentation_uri: https://docs.knapsackpro.com/integration/
   homepage_uri: https://knapsackpro.com
   source_code_uri: https://github.com/KnapsackPro/knapsack_pro-ruby
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -404,8 +404,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Knapsack Pro splits tests across parallel CI nodes and ensures each parallel
   job finish work at a similar time.