knapsack_pro 8.2.0 → 8.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d8372acfe13485ea86eeb30fdd524624cfbe05a374e4c6671048f898ecb5e94
-  data.tar.gz: 56df068506c0271ee9b55e92a7659dd1176bbfd7eef716f17f5ac9e67cd003cd
+  metadata.gz: 8c6268ccfd0e07224b6fbae963baa01c2f6344b924b7b3b1097a42474c57e3b7
+  data.tar.gz: 909d3632bcede5ecd49e075edc62b4c8a602b31cd1e059c99097a92bd6b21c75
 SHA512:
-  metadata.gz: ac7bff173d40c9c83aa0d1a1053890d216e4939970af363415a5462264bd7c07fd95afe5e61c00930669f3f1b6ccee678762763bb6b5066b2923db7307afc48c
-  data.tar.gz: 27488c936d5cea663853d319a4564476568abe774ecaa91a2eb7f83e168ac4c1221091fb6969ac4b44d383673a30c4b141591051ba81987f95af75fb066c95bb
+  metadata.gz: 94cd957dcb04b6157e0aa6902cf6576e67857099b7c4db232742d7a420d08cc588e0dead4bb1d9ec7103024de0b2fe9edbeddacc0575d00533e530cd4c125465
+  data.tar.gz: cf30d4fddcab85d7ce32b589ef624bf08e78eb7d2ad236410c0d162538f3eee457311a7ff9a3ac08fb25440490574d707bf171d252e8dda4b9457138feced4b5

data/CHANGELOG.md

@@ -1,6 +1,23 @@
 # Changelog
 
-### UNRELEASED
+### UNRELEASED (patch)
+
+### 8.3.1
+
+* Fix RSpec TimeTracker to properly track `before(:all)/after(:all)`.
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/303
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v8.3.0...v8.3.1
+
+
+### 8.3.0
+
+* Revert to 8.1.3 because of [the issue #301](https://github.com/KnapsackPro/knapsack_pro-ruby/issues/301)
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/302
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v8.2.0...v8.3.0
 
 ### 8.2.0
 

data/README.md

@@ -72,42 +72,6 @@ bin/test
 
 Scripted tests can be found in the [Rails App With Knapsack Pro repository](https://github.com/KnapsackPro/rails-app-with-knapsack_pro/blob/master/bin/knapsack_pro_all.rb).
 
-### Distroless Container Images
-
-Ensure that Knapsack Pro is written in a way that supports Distroless Container Images. Avoid using a shell when calling methods like [`Kernel.system`](https://rubyapi.org/3.4/o/kernel#method-i-system) or [`Kernel.exec`](https://rubyapi.org/3.4/o/kernel#method-i-exec).
-
-✅ Good - shell is not required
-
-```ruby
-cmd = 'bundle exec rake knapsack_pro:something'
-Kernel.system({ 'RAILS_ENV' => 'test' }, cmd)
-
-cmd = ['bundle', 'exec', 'rake', 'knapsack_pro:example']
-Kernel.system({ 'RAILS_ENV' => 'test' }, *cmd)
-```
-
-⛔️ Bad - shell is required
-
-```ruby
-# Avoid embedding environment variables in the command string
-cmd = 'RAILS_ENV=test bundle exec rake knapsack_pro:something'
-Kernel.system(cmd)
-
-# Avoid output redirection
-cmd = 'program 2>/dev/null'
-Kernel.system(cmd)
-
-# Avoid using the pipe operator
-cmd = 'program1 | program2'
-Kernel.system(cmd)
-```
-
-Use [Dockerfile](distroless/Dockerfile) to test if the code requires a shell:
-
-```bash
-docker build -t test -f distroless/Dockerfile . && docker run --rm -it test
-```
-
 ### Publishing
 
 1. Move the changes listed in the `UNRELEASED` section of the `CHANGELOG.md` to the proper version

data/lib/knapsack_pro/adapters/rspec_adapter.rb

@@ -24,14 +24,14 @@ module KnapsackPro
         KnapsackPro.logger.info("Generating RSpec test examples JSON report for slow test files to prepare it to be split by test examples (by individual test cases). Thanks to that, a single slow test file can be split across parallel CI nodes. Analyzing #{slow_test_files.size} slow test files.")
 
         # generate the RSpec JSON report in a separate process to not pollute the RSpec state
-        envs = {'RACK_ENV' => 'test', 'RAILS_ENV' => 'test'}
         cmd = [
+          'RACK_ENV=test',
+          'RAILS_ENV=test',
           KnapsackPro::Config::Env.rspec_test_example_detector_prefix,
-          'rake knapsack_pro:rspec_test_example_detector'
+          'rake knapsack_pro:rspec_test_example_detector',
         ].join(' ')
-        unless Kernel.system(envs, cmd)
-          inline_cmd = envs.map { _1.join('=') }.join(' ') + ' ' + cmd
-          raise "Could not generate JSON report for RSpec. Rake task failed when running #{inline_cmd}"
+        unless Kernel.system(cmd)
+          raise "Could not generate JSON report for RSpec. Rake task failed when running #{cmd}"
         end
 
         # read the JSON report

data/lib/knapsack_pro/formatters/time_tracker.rb

@@ -19,7 +19,7 @@ module KnapsackPro
         @output = StringIO.new
         @time_each = nil
         @time_all = nil
-        @before_all = 0.0
+        @time_all_by_group_id_path = Hash.new(0)
         @group = {}
         @paths = {}
         @suite_started = now
@@ -38,12 +38,12 @@ module KnapsackPro
       end
 
       def example_group_started(notification)
-        return unless top_level_group?(notification.group)
+        record_time_all(notification.group.parent_groups[1], @time_all_by_group_id_path, @time_all)
         @time_all = now
       end
 
-      def example_started(_notification)
-        @before_all = now - @time_all if @before_all == 0.0
+      def example_started(notification)
+        record_time_all(notification.example.example_group, @time_all_by_group_id_path, @time_all)
         @time_each = now
       end
 
@@ -53,11 +53,12 @@ module KnapsackPro
       end
 
       def example_group_finished(notification)
+        record_time_all(notification.group, @time_all_by_group_id_path, @time_all)
+        @time_all = now
         return unless top_level_group?(notification.group)
 
-        after_all = @time_all.nil? ? 0.0 : now - @time_all
-        add_hooks_time(@group, @before_all, after_all)
-        @before_all = 0.0
+        add_hooks_time(@group, @time_all_by_group_id_path)
+        @time_all_by_group_id_path = Hash.new(0)
         @paths = merge(@paths, @group)
         @group = {}
       end
@@ -104,10 +105,17 @@ module KnapsackPro
         group.metadata[:parent_example_group].nil?
       end
 
-      def add_hooks_time(group, before_all, after_all)
+      def add_hooks_time(group, time_all_by_group_id_path)
         group.each do |_, example|
           next if example[:time_execution] == 0.0
-          example[:time_execution] += before_all + after_all
+
+          example[:time_execution] += time_all_by_group_id_path.sum do |group_id_path, time|
+            # :path is a file path (a_spec.rb), sum any before/after(:all) in the file
+            next time if group_id_path.start_with?(example[:path])
+            # :path is an id path (a_spec.rb[1:1]), sum any before/after(:all) above it
+            next time if example[:path].start_with?(group_id_path[0..-2])
+            0
+          end
         end
       end
 
@@ -123,6 +131,13 @@ module KnapsackPro
         end
       end
 
+      def record_time_all(group, time_all_by_group_id_path, time_all)
+        return unless group # above top level group
+
+        group_id_path = KnapsackPro::TestFileCleaner.clean(group.id)
+        time_all_by_group_id_path[group_id_path] += now - time_all
+      end
+
       def path_for(example)
         file_path = file_path_for(example)
         return nil if file_path == ""

data/lib/knapsack_pro/repository_adapters/git_adapter.rb

@@ -44,41 +44,26 @@ module KnapsackPro
 
       def git_commit_authors
         if KnapsackPro::Config::Env.ci? && shallow_repository?
-          command = 'git fetch --shallow-since "one month ago" --quiet'
+          command = 'git fetch --shallow-since "one month ago" --quiet 2>/dev/null'
           begin
             Timeout.timeout(5) do
-              Kernel.system(command, out: File::NULL, err: File::NULL)
+              `#{command}`
             end
           rescue Timeout::Error
             KnapsackPro.logger.debug("Skip the `#{command}` command because it took too long.")
           end
         end
 
-        IO.pipe do |log_r, log_w|
-          Kernel.system('git log --since "one month ago"', out: log_w, err: File::NULL)
-          log_w.close
-          IO.pipe do |shortlog_r, shortlog_w|
-            Kernel.system('git shortlog --summary --email', in: log_r, out: shortlog_w, err: File::NULL)
-            shortlog_w.close
-            shortlog_r.read
-          end
-        end
+        `git log --since "one month ago" 2>/dev/null | git shortlog --summary --email 2>/dev/null`
       end
 
       def git_build_author
-        IO.pipe do |r, w|
-          Kernel.system('git log --format="%aN <%aE>" -1', out: w, err: File::NULL)
-          w.close
-          r.read
-        end
+        `git log --format="%aN <%aE>" -1 2>/dev/null`
       end
 
       def shallow_repository?
-        IO.pipe do |r, w|
-          Kernel.system('git rev-parse --is-shallow-repository', out: w, err: File::NULL)
-          w.close
-          r.read.strip == 'true'
-        end
+        result = `git rev-parse --is-shallow-repository 2>/dev/null`
+        result.strip == 'true'
       end
 
       def working_dir

data/lib/knapsack_pro/runners/spinach_runner.rb

@@ -15,12 +15,9 @@ module KnapsackPro
 
           KnapsackPro.tracker.set_prerun_tests(runner.test_file_paths)
 
-          cmd = %Q[bundle exec spinach #{args} --features_path #{runner.test_dir} -- #{runner.stringify_test_file_paths}]
+          cmd = %Q[KNAPSACK_PRO_REGULAR_MODE_ENABLED=true KNAPSACK_PRO_TEST_SUITE_TOKEN=#{ENV['KNAPSACK_PRO_TEST_SUITE_TOKEN']} bundle exec spinach #{args} --features_path #{runner.test_dir} -- #{runner.stringify_test_file_paths}]
 
-          Kernel.exec({
-            'KNAPSACK_PRO_REGULAR_MODE_ENABLED' => 'true',
-            'KNAPSACK_PRO_TEST_SUITE_TOKEN' => ENV['KNAPSACK_PRO_TEST_SUITE_TOKEN']
-          }, cmd)
+          Kernel.exec(cmd)
         end
       end
     end

data/lib/knapsack_pro/version.rb

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

data/lib/tasks/queue/cucumber.rake

@@ -5,7 +5,7 @@ require 'knapsack_pro'
 namespace :knapsack_pro do
   namespace :queue do
     task :cucumber, [:cucumber_args] do |_, args|
-      Kernel.exec({ 'RAILS_ENV' => 'test', 'RACK_ENV' => 'test' }, $PROGRAM_NAME, "knapsack_pro:queue:cucumber_go[#{args[:cucumber_args]}]")
+      Kernel.exec("RAILS_ENV=test RACK_ENV=test #{$PROGRAM_NAME} 'knapsack_pro:queue:cucumber_go[#{args[:cucumber_args]}]'")
     end
 
     task :cucumber_go, [:cucumber_args] do |_, args|

data/lib/tasks/queue/minitest.rake

@@ -5,7 +5,7 @@ require 'knapsack_pro'
 namespace :knapsack_pro do
   namespace :queue do
     task :minitest, [:minitest_args] do |_, args|
-      Kernel.exec({ 'RAILS_ENV' => 'test', 'RACK_ENV' => 'test' }, $PROGRAM_NAME, "knapsack_pro:queue:minitest_go[#{args[:minitest_args]}]")
+      Kernel.exec("RAILS_ENV=test RACK_ENV=test #{$PROGRAM_NAME} 'knapsack_pro:queue:minitest_go[#{args[:minitest_args]}]'")
     end
 
     task :minitest_go, [:minitest_args] do |_, args|

data/lib/tasks/queue/rspec.rake

@@ -5,7 +5,7 @@ require 'knapsack_pro'
 namespace :knapsack_pro do
   namespace :queue do
     task :rspec, [:rspec_args] do |_, args|
-      Kernel.exec({ 'RAILS_ENV' => 'test', 'RACK_ENV' => 'test' }, $PROGRAM_NAME, "knapsack_pro:queue:rspec_go[#{args[:rspec_args]}]")
+      Kernel.exec("RAILS_ENV=test RACK_ENV=test #{$PROGRAM_NAME} 'knapsack_pro:queue:rspec_go[#{args[:rspec_args]}]'")
     end
 
     task :rspec_go, [:rspec_args] do |_, args|

data/spec/knapsack_pro/adapters/rspec_adapter_spec.rb

@@ -57,36 +57,19 @@ describe KnapsackPro::Adapters::RSpecAdapter do
 
     subject { described_class.test_file_cases_for(slow_test_files) }
 
-    context 'when the rake task to detect RSpec test examples succeeded' do
-      it 'returns test example paths for slow test files' do
-        logger = instance_double(Logger)
-        allow(KnapsackPro).to receive(:logger).and_return(logger)
-        allow(logger).to receive(:info)
-
-        cmd = 'bundle exec rake knapsack_pro:rspec_test_example_detector'
-        env = { 'RACK_ENV' => 'test', 'RAILS_ENV' => 'test' }
-        expect(Kernel).to receive(:system).with(env, cmd).and_return(true)
-
-        rspec_test_example_detector = instance_double(KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector)
-        expect(KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector).to receive(:new).and_return(rspec_test_example_detector)
-
-        test_file_example_paths = double
-        expect(rspec_test_example_detector).to receive(:test_file_example_paths).and_return(test_file_example_paths)
-
-        expect(subject).to eq test_file_example_paths
+    before do
+      logger = instance_double(Logger)
+      expect(KnapsackPro).to receive(:logger).and_return(logger)
+      expect(logger).to receive(:info).with("Generating RSpec test examples JSON report for slow test files to prepare it to be split by test examples (by individual test cases). Thanks to that, a single slow test file can be split across parallel CI nodes. Analyzing 5 slow test files.")
 
-        expect(logger).to have_received(:info).with("Generating RSpec test examples JSON report for slow test files to prepare it to be split by test examples (by individual test cases). Thanks to that, a single slow test file can be split across parallel CI nodes. Analyzing 5 slow test files.")
-      end
+      cmd = 'RACK_ENV=test RAILS_ENV=test bundle exec rake knapsack_pro:rspec_test_example_detector'
+      expect(Kernel).to receive(:system).with(cmd).and_return(cmd_result)
     end
 
-    context 'when KNAPSACK_PRO_RSPEC_TEST_EXAMPLE_DETECTOR_PREFIX is set with a custom environment variable' do
-      it 'calls Kernel.system using a single command including ENVs that is passed to a shell (does not work in a distroless environment)' do
-        stub_const('ENV', { 'KNAPSACK_PRO_RSPEC_TEST_EXAMPLE_DETECTOR_PREFIX' => 'CUSTOM_ENV_VAR=123 bundle exec' })
-
-        cmd = 'CUSTOM_ENV_VAR=123 bundle exec rake knapsack_pro:rspec_test_example_detector'
-        env = { 'RACK_ENV' => 'test', 'RAILS_ENV' => 'test' }
-        expect(Kernel).to receive(:system).with(env, cmd).and_return(true)
+    context 'when the rake task to detect RSpec test examples succeeded' do
+      let(:cmd_result) { true }
 
+      it 'returns test example paths for slow test files' do
         rspec_test_example_detector = instance_double(KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector)
         expect(KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector).to receive(:new).and_return(rspec_test_example_detector)
 
@@ -98,11 +81,9 @@ describe KnapsackPro::Adapters::RSpecAdapter do
     end
 
     context 'when the rake task to detect RSpec test examples failed' do
-      it do
-        cmd = 'bundle exec rake knapsack_pro:rspec_test_example_detector'
-        env = { 'RACK_ENV' => 'test', 'RAILS_ENV' => 'test' }
-        expect(Kernel).to receive(:system).with(env, cmd).and_return(false)
+      let(:cmd_result) { false }
 
+      it do
         expect { subject }.to raise_error(RuntimeError, 'Could not generate JSON report for RSpec. Rake task failed when running RACK_ENV=test RAILS_ENV=test bundle exec rake knapsack_pro:rspec_test_example_detector')
       end
     end

data/spec/knapsack_pro/formatters/time_tracker_specs.rb

@@ -220,6 +220,63 @@ class TestTimeTracker
     end
   end
 
+  def test_nested_hooks
+    KnapsackPro::Formatters::TimeTracker.define_method(:rspec_split_by_test_example?) do |_file|
+      false
+    end
+
+    spec = <<~SPEC
+      describe "KnapsackPro::Formatters::TimeTracker" do
+        before(:all) do
+          sleep 0.1
+        end
+
+        after(:all) do
+          sleep 0.1
+        end
+
+        it do
+          expect(1).to eq 1
+        end
+
+        describe do
+          before(:all) do
+            sleep 0.1
+          end
+
+          after(:all) do
+            sleep 0.1
+          end
+
+          it do
+            expect(1).to eq 1
+          end
+        end
+
+        describe do
+          before(:all) do
+            sleep 0.1
+          end
+
+          after(:all) do
+            sleep 0.1
+          end
+
+          it do
+            expect(1).to eq 1
+          end
+        end
+      end
+    SPEC
+
+    run_specs(spec) do |spec_paths, times|
+      raise unless times.size == 1
+      raise unless times[0]["path"] == spec_paths.first
+      raise unless times[0]["time_execution"] > 0.60
+      raise unless times[0]["time_execution"] < 0.65
+    end
+  end
+
   def test_hooks_with_rspec_split_by_test_example
     KnapsackPro::Formatters::TimeTracker.define_method(:rspec_split_by_test_example?) do |_file|
       true
@@ -263,6 +320,68 @@ class TestTimeTracker
     end
   end
 
+  def test_nested_hooks_with_rspec_split_by_test_example
+    KnapsackPro::Formatters::TimeTracker.define_method(:rspec_split_by_test_example?) do |_file|
+      true
+    end
+
+    spec = <<~SPEC
+      describe "KnapsackPro::Formatters::TimeTracker" do
+        before(:all) do
+          sleep 0.1
+        end
+
+        after(:all) do
+          sleep 0.1
+        end
+
+        it do
+          expect(1).to eq 1
+        end
+
+        describe do
+          before(:all) do
+            sleep 0.1
+          end
+
+          after(:all) do
+            sleep 0.1
+          end
+
+          it do
+            expect(1).to eq 1
+          end
+        end
+
+        describe do
+          before(:all) do
+            sleep 0.1
+          end
+
+          after(:all) do
+            sleep 0.1
+          end
+
+          it do
+            expect(1).to eq 1
+          end
+        end
+      end
+    SPEC
+
+    run_specs(spec) do |spec_paths, times|
+      raise unless times.size == 3
+      spec_path = spec_paths.first
+      raise unless times.find { |time| time["path"] == "#{spec_path}[1:1]" }["time_execution"] > 0.20
+      raise unless times.find { |time| time["path"] == "#{spec_path}[1:1]" }["time_execution"] < 0.25
+      raise unless times.find { |time| time["path"] == "#{spec_path}[1:2:1]" }["time_execution"] > 0.40
+      raise unless times.find { |time| time["path"] == "#{spec_path}[1:2:1]" }["time_execution"] < 0.45
+      raise unless times.find { |time| time["path"] == "#{spec_path}[1:3:1]" }["time_execution"] > 0.40
+      raise unless times.find { |time| time["path"] == "#{spec_path}[1:3:1]" }["time_execution"] < 0.45
+    end
+  end
+
+
   def test_unknown_path
     KnapsackPro::Formatters::TimeTracker.class_eval do
       alias_method :original_file_path_for, :file_path_for

data/spec/knapsack_pro/runners/spinach_runner_spec.rb

@@ -19,8 +19,8 @@ describe KnapsackPro::Runners::SpinachRunner do
 
     context 'when test files were returned by Knapsack Pro API' do
       let(:test_file_paths) { ['features/a.feature', 'features/b.feature'] }
-      let(:test_dir) { 'fake-test-dir' }
       let(:stringify_test_file_paths) { test_file_paths.join(' ') }
+      let(:test_dir) { 'fake-test-dir' }
       let(:runner) do
         instance_double(described_class,
                         test_dir: test_dir,
@@ -28,7 +28,6 @@ describe KnapsackPro::Runners::SpinachRunner do
                         stringify_test_file_paths: stringify_test_file_paths,
                         test_files_to_execute_exist?: true)
       end
-      let(:child_status) { double }
 
       it do
         expect(KnapsackPro::Adapters::SpinachAdapter).to receive(:verify_bind_method_called)
@@ -37,10 +36,7 @@ describe KnapsackPro::Runners::SpinachRunner do
         expect(KnapsackPro).to receive(:tracker).and_return(tracker)
         expect(tracker).to receive(:set_prerun_tests).with(test_file_paths)
 
-        expect(Kernel).to receive(:exec).with(
-          { 'KNAPSACK_PRO_REGULAR_MODE_ENABLED' => 'true', 'KNAPSACK_PRO_TEST_SUITE_TOKEN' => 'spinach-token' },
-          'bundle exec spinach --custom-arg --features_path fake-test-dir -- features/a.feature features/b.feature'
-        )
+        expect(Kernel).to receive(:exec).with('KNAPSACK_PRO_REGULAR_MODE_ENABLED=true KNAPSACK_PRO_TEST_SUITE_TOKEN=spinach-token bundle exec spinach --custom-arg --features_path fake-test-dir -- features/a.feature features/b.feature')
 
         subject
       end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 8.2.0
+  version: 8.3.1
 platform: ruby
 authors:
 - ArturT
 bindir: bin
 cert_chain: []
-date: 2025-05-21 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -216,7 +216,6 @@ files:
 - Rakefile
 - bin/knapsack_pro
 - bin/test
-- distroless/Dockerfile
 - knapsack_pro.gemspec
 - lib/knapsack_pro.rb
 - lib/knapsack_pro/adapters/base_adapter.rb
@@ -429,7 +428,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Knapsack Pro splits tests across parallel CI nodes and ensures each parallel
   job finish work at a similar time.

data/distroless/Dockerfile

@@ -1,37 +0,0 @@
-FROM cgr.dev/chainguard/ruby:latest-dev AS builder
-
-WORKDIR /build
-RUN <<RUN
-cat <<GEMFILE > Gemfile
-source "https://rubygems.org"
-GEMFILE
-
-gem install bundler
-bundle config set --local path vendor/bundle
-bundle install
-RUN
-
-RUN <<RUN
-cat <<RAKEFILE > Rakefile
-RAKEFILE
-
-mkdir bin
-cat <<CI > bin/ci
-ENV['PATH'] =+ "#{Gem.user_dir}/bin"
-require 'bundler/setup'
-
-success = Kernel.system({ 'RAILS_ENV' => 'test' }, 'bundle --version') # ✅
-raise "The command failed!" unless success
-
-success = Kernel.system({ 'RAILS_ENV' => 'test' }, 'bundle --version 2>/dev/null') # ⛔️
-raise "The command failed!" unless success
-
-CI
-RUN
-
-FROM cgr.dev/chainguard/ruby:latest
-
-WORKDIR /app
-COPY --from=builder /home/nonroot/.local /home/nonroot/.local
-COPY --from=builder /build /app
-CMD ["bin/ci"]