knapsack_pro 7.10.0 → 7.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 173300dc2ec82a1b5a15005c91ac3ceb942c40acbb14fd2ba57e64d2a32b67d8
-  data.tar.gz: c0c856044ce6773dce0968ebd620f4c49e1fea170c30d880af90ace2e1fb66c1
+  metadata.gz: a1ef8aab90f4a3bec0602ae96afb11f6c74d7b8b045bfb7bb649be8a6a5df61c
+  data.tar.gz: f86cbe57dab02bab4b7f93096b94e73d7948f740a017beee8d44b7cf1b274a88
 SHA512:
-  metadata.gz: e078dce53b72374ef499087c9675eea34272769a46154997e55dc06ab23e4da7fa016206297eed8b3cc660c5238a99b16177abb6f45c191e3bd38dc60c9cee6f
-  data.tar.gz: 5a80b8cbc3dc3273e297693263a9223fab250d1ee6adbd2c6c909f904d35430f3403a1f9da92dc2709adc3f30f8311b8d05d34b6292e8952e1aae42c88f8f977
+  metadata.gz: 4b56ad88170012a6d956a097bfef88ccfe63a24db56e06432babbbac530ef24f0a20f43e30ddf62a604f05e80eafed1ba718b6a06733c3208d5c36dda16670c7
+  data.tar.gz: 2ce859941cd08128e364f4cab359dd5bc17d5d7b480bd709c38ef44762becc569cc126aac0d86258e86cb9c3172d623cd8341df7167004df5948469f9670c8cc

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+### 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
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/281
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v7.10.0...v7.11.0
+
 ### 7.10.0
 
 * Improve the RSpec split by examples feature. Use test file execution times for existing test files on the disk to determine slow test files. This fixes issue with detecting slow test files when API token is shared between multiple test suites.

data/knapsack_pro.gemspec

@@ -39,4 +39,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'vcr', '>= 6.0'
   spec.add_development_dependency 'webmock', '>= 3.13'
   spec.add_development_dependency 'timecop', '>= 0.9.9'
+  spec.add_development_dependency 'ostruct', '>= 0.6.0'
 end

data/lib/knapsack_pro/test_case_mergers/rspec_merger.rb

@@ -4,17 +4,27 @@ module KnapsackPro
   module TestCaseMergers
     class RSpecMerger < BaseMerger
       def call
-        merged_test_files_hash = {}
+        all_test_files_hash = {}
+        merged_test_file_examples_hash = {}
+
         test_files.each do |test_file|
-          test_file_path = extract_test_file_path(test_file.fetch('path'))
+          path = test_file.fetch('path')
+          test_file_path = extract_test_file_path(path)
+
+          if rspec_id_path?(path)
+            merged_test_file_examples_hash[test_file_path] ||= 0.0
+            merged_test_file_examples_hash[test_file_path] += test_file.fetch('time_execution')
+          else
+            all_test_files_hash[test_file_path] = test_file.fetch('time_execution')
+          end
+        end
 
-          # must be float (default type for time execution from API)
-          merged_test_files_hash[test_file_path] ||= 0.0
-          merged_test_files_hash[test_file_path] += test_file.fetch('time_execution')
+        merged_test_file_examples_hash.each do |path, time_execution|
+          all_test_files_hash[path] = [time_execution, all_test_files_hash[path]].compact.max
         end
 
         merged_test_files = []
-        merged_test_files_hash.each do |path, time_execution|
+        all_test_files_hash.each do |path, time_execution|
           merged_test_files << {
             'path' => path,
             'time_execution' => time_execution
@@ -31,6 +41,12 @@ module KnapsackPro
       def extract_test_file_path(path)
         path.gsub(/\.rb\[.+\]$/, '.rb')
       end
+
+      def rspec_id_path?(path)
+        path_with_id_regex = /.+_spec\.rb\[.+\]$/
+
+        path&.match?(path_with_id_regex)
+      end
     end
   end
 end

data/lib/knapsack_pro/version.rb

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

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

@@ -1,6 +1,7 @@
 require 'open3'
 require 'json'
 require 'nokogiri'
+require 'ostruct'
 
 describe "#{KnapsackPro::Runners::Queue::RSpecRunner} - Integration tests", :clear_tmp do
   SPEC_DIRECTORY = 'spec_integration'
@@ -1061,7 +1062,7 @@ describe "#{KnapsackPro::Runners::Queue::RSpecRunner} - Integration tests", :cle
       expect(actual.stdout).to_not include('C1 test example')
 
       expect(actual.stdout).to include('An error occurred while loading ./spec_integration/failing_spec.rb')
-      expect(actual.stdout).to match(/undefined local variable or method `a_fake_method' for.* RSpec::ExampleGroups::BDescribe/)
+      expect(actual.stdout).to match(/undefined local variable or method .a_fake_method. for.* RSpec::ExampleGroups::BDescribe/)
       expect(actual.stdout).to include('WARN -- : [knapsack_pro] RSpec wants to quit')
       expect(actual.stdout).to include('1 example, 0 failures, 1 error occurred outside of examples')
 
@@ -1104,7 +1105,7 @@ describe "#{KnapsackPro::Runners::Queue::RSpecRunner} - Integration tests", :cle
       actual = subject
 
       expect(actual.stdout).to include('An error occurred while loading spec_helper.')
-      expect(actual.stdout).to include("undefined local variable or method `a_fake_method' for main")
+      expect(actual.stdout).to match(/undefined local variable or method .a_fake_method. for main/)
       expect(actual.stdout).to include('0 examples, 0 failures, 1 error occurred outside of examples')
 
       expect(actual.exit_code).to eq 1
@@ -1407,9 +1408,9 @@ describe "#{KnapsackPro::Runners::Queue::RSpecRunner} - Integration tests", :cle
 
       expect(actual.stdout).to include('Use the following backtrace(s) to find the line of code that got stuck if the CI node hung and terminated your tests.')
       expect(actual.stdout).to include('Main thread backtrace:')
-      expect(actual.stdout).to include("spec_integration/b_spec.rb:7:in `kill'")
+      expect(actual.stdout).to match(/spec_integration\/b_spec\.rb:7:in .*kill/)
       expect(actual.stdout).to include('Non-main thread backtrace:')
-      expect(actual.stdout).to include("spec_integration/a_spec.rb:6:in `sleep'")
+      expect(actual.stdout).to match(/spec_integration\/a_spec\.rb:6:in .*sleep/)
 
 
       expect(actual.exit_code).to eq 1
@@ -2019,7 +2020,7 @@ describe "#{KnapsackPro::Runners::Queue::RSpecRunner} - Integration tests", :cle
 
       actual = subject
 
-      expect(actual.stdout).to include('DEBUG -- : [knapsack_pro] Detected 1 slow test files: [{"path"=>"spec_integration/a_spec.rb"}]')
+      expect(actual.stdout).to match(/DEBUG -- : \[knapsack_pro\] Detected 1 slow test files: \[\{"path".?=>.?"spec_integration\/a_spec\.rb"\}\]/)
 
       expect(actual.stdout).to include(
         <<~OUTPUT

data/spec/knapsack_pro/test_case_mergers/rspec_merger_spec.rb

@@ -2,7 +2,7 @@ describe KnapsackPro::TestCaseMergers::RSpecMerger do
   describe '#call' do
     subject { described_class.new(test_files).call }
 
-    context 'when all test files are not test example paths' do
+    context 'when test files are regular file paths (not test example paths)' do
       let(:test_files) do
         [
           { 'path' => 'spec/a_spec.rb', 'time_execution' => 1.1 },
@@ -10,7 +10,7 @@ describe KnapsackPro::TestCaseMergers::RSpecMerger do
         ]
       end
 
-      it do
+      it 'returns the test files unchanged' do
         expect(subject).to eq([
           { 'path' => 'spec/a_spec.rb', 'time_execution' => 1.1 },
           { 'path' => 'spec/b_spec.rb', 'time_execution' => 2.2 },
@@ -28,7 +28,7 @@ describe KnapsackPro::TestCaseMergers::RSpecMerger do
         ]
       end
 
-      it 'returns merged paths for test examples and sum of their time_execution' do
+      it 'merges the test example paths and sums their execution times' do
         expect(subject).to eq([
           { 'path' => 'spec/a_spec.rb', 'time_execution' => 1.1 },
           { 'path' => 'spec/test_case_spec.rb', 'time_execution' => 3.0 },
@@ -36,23 +36,45 @@ describe KnapsackPro::TestCaseMergers::RSpecMerger do
       end
     end
 
-    context 'when test files have test example paths and at the same time test file path for test example path is present as full test file path' do
-      let(:test_files) do
-        [
-          { 'path' => 'spec/a_spec.rb', 'time_execution' => 1.1 },
-          # full test file path is present despite existing test example paths
-          { 'path' => 'spec/test_case_spec.rb', 'time_execution' => 1.0 },
-          # test example paths
-          { 'path' => 'spec/test_case_spec.rb[1:1]', 'time_execution' => 2.2 },
-          { 'path' => 'spec/test_case_spec.rb[1:2]', 'time_execution' => 0.8 },
-        ]
+    context 'when test files have test example paths and the full test file path exists simultaneously' do
+      context 'when the full test file path has a higher execution time than the sum of test example paths' do
+        let(:test_files) do
+          [
+            { 'path' => 'spec/a_spec.rb', 'time_execution' => 1.1 },
+            # full test file path exists alongside test example paths
+            { 'path' => 'spec/test_case_spec.rb', 'time_execution' => 3.1 },
+            # test example paths
+            { 'path' => 'spec/test_case_spec.rb[1:1]', 'time_execution' => 2.2 },
+            { 'path' => 'spec/test_case_spec.rb[1:2]', 'time_execution' => 0.8 },
+          ]
+        end
+
+        it 'returns the full test file path execution time' do
+          expect(subject).to eq([
+            { 'path' => 'spec/a_spec.rb', 'time_execution' => 1.1 },
+            { 'path' => 'spec/test_case_spec.rb', 'time_execution' => 3.1 },
+          ])
+        end
       end
 
-      it 'returns merged paths for test examples and sum of their time_execution' do
-        expect(subject).to eq([
-          { 'path' => 'spec/a_spec.rb', 'time_execution' => 1.1 },
-          { 'path' => 'spec/test_case_spec.rb', 'time_execution' => 4.0 },
-        ])
+      context 'when the full test file path has a lower execution time than the sum of test example paths' do
+        let(:test_files) do
+          [
+            { 'path' => 'spec/a_spec.rb', 'time_execution' => 1.1 },
+            # full test file path exists alongside test example paths
+            { 'path' => 'spec/test_case_spec.rb', 'time_execution' => 2.9 },
+            # test example paths
+            { 'path' => 'spec/test_case_spec.rb[1:1]', 'time_execution' => 2.2 },
+            { 'path' => 'spec/test_case_spec.rb[1:2]', 'time_execution' => 0.8 },
+          ]
+        end
+
+        it "returns the sum of test example paths' execution times" do
+          expect(subject).to eq([
+            { 'path' => 'spec/a_spec.rb', 'time_execution' => 1.1 },
+            { 'path' => 'spec/test_case_spec.rb', 'time_execution' => 3.0 },
+          ])
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 7.10.0
+  version: 7.11.0
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-29 00:00:00.000000000 Z
+date: 2024-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -178,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.9
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 description: Knapsack Pro wraps your current test runner(s) and works with your existing
   CI infrastructure to parallelize tests optimally. It dynamically splits your tests
   based on up-to-date test execution data. It's designed from the ground up for CI