knapsack_pro 7.11.0 → 7.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1ef8aab90f4a3bec0602ae96afb11f6c74d7b8b045bfb7bb649be8a6a5df61c
-  data.tar.gz: f86cbe57dab02bab4b7f93096b94e73d7948f740a017beee8d44b7cf1b274a88
+  metadata.gz: 204e1595877682d96997ee193c8b0aa0230d6f5e1c22d37ca515e1e94a40d404
+  data.tar.gz: 4a373acd12bdd3451bda93d7186a69a217aeeea593c3ad1d8cb425d1f215d0cc
 SHA512:
-  metadata.gz: 4b56ad88170012a6d956a097bfef88ccfe63a24db56e06432babbbac530ef24f0a20f43e30ddf62a604f05e80eafed1ba718b6a06733c3208d5c36dda16670c7
-  data.tar.gz: 2ce859941cd08128e364f4cab359dd5bc17d5d7b480bd709c38ef44762becc569cc126aac0d86258e86cb9c3172d623cd8341df7167004df5948469f9670c8cc
+  metadata.gz: 9f2310862a878b55c4001beaf3beda4c2249946a7fc04fe40f3b4e5911c17aff1ffc1df2437df392aa597681396cc1dc1e7a0deac67936d6e5cbf399bda830c5
+  data.tar.gz: a3d8b7bf464a71a5a0600333f017a981562ecab163c52f1b67747c5aaad444aab834ab7d0a93ef00cad012e2d4f66163ec1cfa9b9204e4bb13477b1fdce263de

data/.circleci/config.yml

@@ -268,6 +268,25 @@ jobs:
             export KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true
             export KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES=true
             bundle exec rake knapsack_pro:queue:rspec
+      - run:
+          working_directory: ~/rails-app-with-knapsack_pro
+          command: |
+            # split by test examples above the slow test file threshold ||
+            export KNAPSACK_PRO_BRANCH="$CIRCLE_BRANCH--$CIRCLE_BUILD_NUM--queue--split-above-slow-test-file-threshold"
+            export KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true
+            export KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES=true
+            export KNAPSACK_PRO_SLOW_TEST_FILE_THRESHOLD=1
+            bundle exec rake knapsack_pro:queue:rspec
+      - run:
+          working_directory: ~/rails-app-with-knapsack_pro
+          command: |
+            # split by test examples AND a single CI node ||
+            export KNAPSACK_PRO_BRANCH="$CIRCLE_BRANCH--$CIRCLE_BUILD_NUM--queue--split--single-node"
+            export KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true
+            export KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES=true
+            export KNAPSACK_PRO_CI_NODE_TOTAL=1
+            export KNAPSACK_PRO_CI_NODE_INDEX=0
+            bundle exec rake knapsack_pro:queue:rspec
       - run:
           working_directory: ~/rails-app-with-knapsack_pro
           command: |

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+### 7.12.1
+
+* fix(RSpec split by examples): properly disable split by test examples on a single node to speed up tests
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/283
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v7.12.0...v7.12.1
+
+### 7.12.0
+
+* Add `KNAPSACK_PRO_SLOW_TEST_FILE_THRESHOLD` to improve the RSpec split by examples feature with many skipped tests
+* Do not split test files by test cases if you run tests on a single CI node to run Knapsack Pro faster.
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/282
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v7.11.0...v7.12.0
+
 ### 7.11.0
 
 * fix(RSpec split by examples): Properly determine slow test files when test example execution times and full test file execution time are both known

data/lib/knapsack_pro/config/env.rb

@@ -188,18 +188,31 @@ module KnapsackPro
           ENV.fetch('KNAPSACK_PRO_CUCUMBER_QUEUE_PREFIX', 'bundle exec')
         end
 
-        def rspec_split_by_test_examples
-          ENV.fetch('KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES', false)
-        end
-
         def rspec_split_by_test_examples?
-          rspec_split_by_test_examples.to_s == 'true'
+          return @rspec_split_by_test_examples if defined?(@rspec_split_by_test_examples)
+
+          split = ENV.fetch('KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES', false).to_s == 'true'
+
+          if split && ci_node_total < 2
+            KnapsackPro.logger.debug('Skipping split of test files by test examples because you are running tests on a single CI node (no parallelism)')
+            @rspec_split_by_test_examples = false
+          else
+            @rspec_split_by_test_examples = split
+          end
         end
 
         def rspec_test_example_detector_prefix
           ENV.fetch('KNAPSACK_PRO_RSPEC_TEST_EXAMPLE_DETECTOR_PREFIX', 'bundle exec')
         end
 
+        def slow_test_file_threshold
+          ENV.fetch('KNAPSACK_PRO_SLOW_TEST_FILE_THRESHOLD', nil)&.to_f
+        end
+
+        def slow_test_file_threshold?
+          !!slow_test_file_threshold
+        end
+
         def test_suite_token
           env_name = 'KNAPSACK_PRO_TEST_SUITE_TOKEN'
           ENV[env_name] || raise("Missing environment variable #{env_name}. You should set environment variable like #{env_name}_RSPEC (note there is suffix _RSPEC at the end). knapsack_pro gem will set #{env_name} based on #{env_name}_RSPEC value. If you use other test runner than RSpec then use proper suffix.")

data/lib/knapsack_pro/slow_test_file_determiner.rb

@@ -10,8 +10,12 @@ module KnapsackPro
       time_threshold = (total_execution_time / KnapsackPro::Config::Env.ci_node_total) * TIME_THRESHOLD_PER_CI_NODE
 
       test_files.select do |test_file|
-        time_execution = test_file.fetch('time_execution')
-        time_execution >= time_threshold && time_execution > 0
+        execution_time = test_file.fetch('time_execution')
+        next false if execution_time.zero?
+        next true if execution_time >= time_threshold
+        next false unless KnapsackPro::Config::Env.slow_test_file_threshold?
+
+        execution_time >= KnapsackPro::Config::Env.slow_test_file_threshold
       end
     end
 

data/lib/knapsack_pro/version.rb

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

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

@@ -1964,10 +1964,13 @@ describe "#{KnapsackPro::Runners::Queue::RSpecRunner} - Integration tests", :cle
       # remember to stub Queue API batches to include test examples (example: a_spec.rb[1:1])
       # for the following slow test files
       ENV['KNAPSACK_PRO_SLOW_TEST_FILE_PATTERN'] = "#{SPEC_DIRECTORY}/a_spec.rb"
+
+      ENV['KNAPSACK_PRO_CI_NODE_TOTAL'] = '2'
     end
     after do
       ENV.delete('KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES')
       ENV.delete('KNAPSACK_PRO_SLOW_TEST_FILE_PATTERN')
+      ENV.delete('KNAPSACK_PRO_CI_NODE_TOTAL')
     end
 
     it 'splits slow test files by examples AND ensures the test examples are executed only once' do
@@ -2060,10 +2063,13 @@ describe "#{KnapsackPro::Runners::Queue::RSpecRunner} - Integration tests", :cle
       # remember to stub Queue API batches to include test examples (example: a_spec.rb[1:1])
       # for the following slow test files
       ENV['KNAPSACK_PRO_SLOW_TEST_FILE_PATTERN'] = "#{SPEC_DIRECTORY}/a_spec.rb"
+
+      ENV['KNAPSACK_PRO_CI_NODE_TOTAL'] = '2'
     end
     after do
       ENV.delete('KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES')
       ENV.delete('KNAPSACK_PRO_SLOW_TEST_FILE_PATTERN')
+      ENV.delete('KNAPSACK_PRO_CI_NODE_TOTAL')
     end
 
     it 'sets 1 as exit code AND raises an error (a test example path as a_spec.rb[1:1] would always be executed even when it does not have the tag that is set via the --tag option. We cannot run tests because it could lead to running unintentional tests)' do
@@ -2138,10 +2144,13 @@ describe "#{KnapsackPro::Runners::Queue::RSpecRunner} - Integration tests", :cle
       # remember to stub Queue API batches to include test examples (example: a_spec.rb[1:1])
       # for the following slow test files
       ENV['KNAPSACK_PRO_SLOW_TEST_FILE_PATTERN'] = "#{SPEC_DIRECTORY}/a_spec.rb"
+
+      ENV['KNAPSACK_PRO_CI_NODE_TOTAL'] = '2'
     end
     after do
       ENV.delete('KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES')
       ENV.delete('KNAPSACK_PRO_SLOW_TEST_FILE_PATTERN')
+      ENV.delete('KNAPSACK_PRO_CI_NODE_TOTAL')
     end
 
     it 'produces a JSON report' do
@@ -2237,10 +2246,13 @@ describe "#{KnapsackPro::Runners::Queue::RSpecRunner} - Integration tests", :cle
       # remember to stub Queue API batches to include test examples (example: a_spec.rb[1:1])
       # for the following slow test files
       ENV['KNAPSACK_PRO_SLOW_TEST_FILE_PATTERN'] = "#{SPEC_DIRECTORY}/a_spec.rb"
+
+      ENV['KNAPSACK_PRO_CI_NODE_TOTAL'] = '2'
     end
     after do
       ENV.delete('KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES')
       ENV.delete('KNAPSACK_PRO_SLOW_TEST_FILE_PATTERN')
+      ENV.delete('KNAPSACK_PRO_CI_NODE_TOTAL')
     end
 
     it 'produces a JUnit XML report' do
@@ -2334,10 +2346,13 @@ describe "#{KnapsackPro::Runners::Queue::RSpecRunner} - Integration tests", :cle
       # remember to stub Queue API batches to include test examples (example: a_spec.rb[1:1])
       # for the following slow test files
       ENV['KNAPSACK_PRO_SLOW_TEST_FILE_PATTERN'] = "#{SPEC_DIRECTORY}/a_spec.rb"
+
+      ENV['KNAPSACK_PRO_CI_NODE_TOTAL'] = '2'
     end
     after do
       ENV.delete('KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES')
       ENV.delete('KNAPSACK_PRO_SLOW_TEST_FILE_PATTERN')
+      ENV.delete('KNAPSACK_PRO_CI_NODE_TOTAL')
     end
 
     it 'produces a code coverage report' do

data/spec/knapsack_pro/config/env_spec.rb

@@ -1013,37 +1013,54 @@ describe KnapsackPro::Config::Env do
     end
   end
 
-  describe '.rspec_split_by_test_examples' do
-    subject { described_class.rspec_split_by_test_examples }
+  describe '.rspec_split_by_test_examples?' do
+    subject { described_class.rspec_split_by_test_examples? }
 
-    context 'when ENV exists' do
-      before { stub_const("ENV", { 'KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES' => true }) }
-      it { should eq true }
+    before do
+      described_class.remove_instance_variable(:@rspec_split_by_test_examples)
+    rescue NameError
     end
 
-    context "when ENV doesn't exist" do
-      before { stub_const("ENV", {}) }
+    context 'when KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES=true AND KNAPSACK_PRO_CI_NODE_TOTAL >= 2' do
+      before do
+        stub_const("ENV", { 'KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES' => 'true', 'KNAPSACK_PRO_CI_NODE_TOTAL' => '2' })
+        expect(KnapsackPro).not_to receive(:logger)
+      end
+
+      it { should be true }
+    end
+
+    context 'when KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES=false AND KNAPSACK_PRO_CI_NODE_TOTAL >= 2' do
+      before do
+        stub_const("ENV", { 'KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES' => 'false', 'KNAPSACK_PRO_CI_NODE_TOTAL' => '2' })
+        expect(KnapsackPro).not_to receive(:logger)
+      end
+
       it { should be false }
     end
-  end
 
-  describe '.rspec_split_by_test_examples?' do
-    subject { described_class.rspec_split_by_test_examples? }
+    context 'when KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES=true AND KNAPSACK_PRO_CI_NODE_TOTAL < 2' do
+      before { stub_const("ENV", { 'KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES' => 'true', 'KNAPSACK_PRO_CI_NODE_TOTAL' => '1' }) }
 
-    context 'when ENV exists' do
-      context 'when KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES=true' do
-        before { stub_const("ENV", { 'KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES' => 'true' }) }
-        it { should be true }
-      end
+      it { should be false }
 
-      context 'when KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES=false' do
-        before { stub_const("ENV", { 'KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES' => 'false' }) }
-        it { should be false }
+      context 'when called twice' do
+        it 'logs a debug message only once' do
+          logger = instance_double(Logger)
+          expect(KnapsackPro).to receive(:logger).and_return(logger)
+          expect(logger).to receive(:debug).with('Skipping split of test files by test examples because you are running tests on a single CI node (no parallelism)')
+
+          2.times { described_class.rspec_split_by_test_examples? }
+        end
       end
     end
 
     context "when ENV doesn't exist" do
-      before { stub_const("ENV", {}) }
+      before do
+        stub_const("ENV", {})
+        expect(KnapsackPro).not_to receive(:logger)
+      end
+
       it { should be false }
     end
   end
@@ -1062,6 +1079,37 @@ describe KnapsackPro::Config::Env do
     end
   end
 
+  describe '.slow_test_file_threshold' do
+    subject { described_class.slow_test_file_threshold }
+
+    context 'when ENV exists' do
+      before { stub_const("ENV", { 'KNAPSACK_PRO_SLOW_TEST_FILE_THRESHOLD' => '2' }) }
+      it 'returns seconds' do
+        expect(subject).to eq 2.0
+        expect(subject).to be_a Float
+      end
+    end
+
+    context "when ENV doesn't exist" do
+      before { stub_const("ENV", {}) }
+      it { should be_nil }
+    end
+  end
+
+  describe '.slow_test_file_threshold?' do
+    subject { described_class.slow_test_file_threshold? }
+
+    context 'when ENV exists' do
+      before { stub_const("ENV", { 'KNAPSACK_PRO_SLOW_TEST_FILE_THRESHOLD' => '2' }) }
+      it { should be true }
+    end
+
+    context "when ENV doesn't exist" do
+      before { stub_const("ENV", {}) }
+      it { should be false }
+    end
+  end
+
   describe '.test_suite_token' do
     subject { described_class.test_suite_token }
 

data/spec/knapsack_pro/slow_test_file_determiner_spec.rb

@@ -8,8 +8,7 @@ describe KnapsackPro::SlowTestFileDeterminer do
 
     subject { described_class.call(test_files) }
 
-    context 'when test files have recorded time execution' do
-      let(:time_execution) { 20.0 }
+    context 'when test files have recorded execution time' do
       let(:test_files) do
         [
           { 'path' => 'a_spec.rb', 'time_execution' => 1.0 },
@@ -27,7 +26,30 @@ describe KnapsackPro::SlowTestFileDeterminer do
       end
     end
 
-    context 'when test files have no recorded time execution' do
+    context 'when test files have recorded execution time AND slow test files threshold is set' do
+      let(:test_files) do
+        [
+          { 'path' => 'a_spec.rb', 'time_execution' => 1.0 },
+          { 'path' => 'b_spec.rb', 'time_execution' => 3.4 },
+          { 'path' => 'c_spec.rb', 'time_execution' => 3.5 },
+          { 'path' => 'd_spec.rb', 'time_execution' => 12.1 },
+        ]
+      end
+
+      before do
+        stub_const("ENV", { 'KNAPSACK_PRO_SLOW_TEST_FILE_THRESHOLD' => '2' })
+      end
+
+      it 'detects slow tests above 2.0s threshold' do
+        expect(subject).to eq([
+          { 'path' => 'b_spec.rb', 'time_execution' => 3.4 },
+          { 'path' => 'c_spec.rb', 'time_execution' => 3.5 },
+          { 'path' => 'd_spec.rb', 'time_execution' => 12.1 },
+        ])
+      end
+    end
+
+    context 'when test files have no recorded execution time' do
       let(:test_files) do
         [
           { 'path' => 'a_spec.rb', 'time_execution' => 0.0 },

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 7.11.0
+  version: 7.12.1
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-30 00:00:00.000000000 Z
+date: 2024-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake