knapsack_pro 7.11.0 → 7.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1ef8aab90f4a3bec0602ae96afb11f6c74d7b8b045bfb7bb649be8a6a5df61c
-  data.tar.gz: f86cbe57dab02bab4b7f93096b94e73d7948f740a017beee8d44b7cf1b274a88
+  metadata.gz: b6e9369d803759d8590a88b3e34bc3e195ca6520ee6f97e41c312735a768a8bb
+  data.tar.gz: 45dd6b4b8871cd370ec44384b706a0445cce6276b0463bc307d36f79dea16deb
 SHA512:
-  metadata.gz: 4b56ad88170012a6d956a097bfef88ccfe63a24db56e06432babbbac530ef24f0a20f43e30ddf62a604f05e80eafed1ba718b6a06733c3208d5c36dda16670c7
-  data.tar.gz: 2ce859941cd08128e364f4cab359dd5bc17d5d7b480bd709c38ef44762becc569cc126aac0d86258e86cb9c3172d623cd8341df7167004df5948469f9670c8cc
+  metadata.gz: 4a0a3f3301f24a840845b0a59d40f06aa94d1ce94d1156846f740f237606c54a05b32da7d44ee815a65674c35ca94ac63185b0d93262570c3379e60a3686872f
+  data.tar.gz: 12f877a2c3e060580c3b2f20fc1de7fb934c47c82f1dfa95a1b240ab82838cf6580c9325fbba494849e14515634084cc12b294224412e2e63d5aa36810572d98

data/.circleci/config.yml

@@ -268,6 +268,15 @@ 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: |

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+### 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/base_allocator_builder.rb

@@ -36,6 +36,11 @@ module KnapsackPro
       test_files_to_run = all_test_files_to_run
 
       if adapter_class.split_by_test_cases_enabled?
+        if KnapsackPro::Config::Env.ci_node_total < 2
+          KnapsackPro.logger.warn('Skipping split of test files by test cases because you are running tests on a single CI node (no parallelism)')
+          return test_files_to_run
+        end
+
         slow_test_files = get_slow_test_files
         return test_files_to_run if slow_test_files.empty?
 

data/lib/knapsack_pro/config/env.rb

@@ -200,6 +200,14 @@ module KnapsackPro
           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.0'
 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/base_allocator_builder_spec.rb

@@ -134,39 +134,57 @@ describe KnapsackPro::BaseAllocatorBuilder do
 
       before  do
         expect(adapter_class).to receive(:split_by_test_cases_enabled?).and_return(true)
+        expect(KnapsackPro::Config::Env).to receive(:ci_node_total).and_return(node_total)
 
         test_file_pattern = double
         expect(KnapsackPro::TestFilePattern).to receive(:call).with(adapter_class).and_return(test_file_pattern)
 
         expect(KnapsackPro::TestFileFinder).to receive(:call).with(test_file_pattern).and_return(test_files_to_run)
+      end
+
+      context 'when less than 2 CI nodes' do
+        let(:node_total) { 1 }
 
-        expect(allocator_builder).to receive(:get_slow_test_files).and_return(slow_test_files)
+        it 'returns test files without test cases' do
+          logger = instance_double(Logger)
+          expect(KnapsackPro).to receive(:logger).and_return(logger)
+          expect(logger).to receive(:warn).with('Skipping split of test files by test cases because you are running tests on a single CI node (no parallelism)')
+          expect(subject).to eq test_files_to_run
+        end
       end
 
-      context 'when slow test files are detected' do
-        let(:slow_test_files) do
-          [
-            '1_spec.rb',
-            '2_spec.rb',
-          ]
+      context 'when at least 2 CI nodes' do
+        let(:node_total) { 2 }
+
+        before do
+          expect(allocator_builder).to receive(:get_slow_test_files).and_return(slow_test_files)
         end
 
-        it 'returns test files with test cases' do
-          test_file_cases = double
-          expect(adapter_class).to receive(:test_file_cases_for).with(slow_test_files).and_return(test_file_cases)
+        context 'when slow test files are detected' do
+          let(:slow_test_files) do
+            [
+              '1_spec.rb',
+              '2_spec.rb',
+            ]
+          end
+
+          it 'returns test files with test cases' do
+            test_file_cases = double
+            expect(adapter_class).to receive(:test_file_cases_for).with(slow_test_files).and_return(test_file_cases)
 
-          test_files_with_test_cases = double
-          expect(KnapsackPro::TestFilesWithTestCasesComposer).to receive(:call).with(test_files_to_run, slow_test_files, test_file_cases).and_return(test_files_with_test_cases)
+            test_files_with_test_cases = double
+            expect(KnapsackPro::TestFilesWithTestCasesComposer).to receive(:call).with(test_files_to_run, slow_test_files, test_file_cases).and_return(test_files_with_test_cases)
 
-          expect(subject).to eq test_files_with_test_cases
+            expect(subject).to eq test_files_with_test_cases
+          end
         end
-      end
 
-      context 'when slow test files are not detected' do
-        let(:slow_test_files) { [] }
+        context 'when slow test files are not detected' do
+          let(:slow_test_files) { [] }
 
-        it 'returns test files without test cases' do
-          expect(subject).to eq test_files_to_run
+          it 'returns test files without test cases' do
+            expect(subject).to eq test_files_to_run
+          end
         end
       end
     end

data/spec/knapsack_pro/config/env_spec.rb

@@ -1062,6 +1062,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.0
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-30 00:00:00.000000000 Z
+date: 2024-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake