knapsack_pro 8.1.3 → 8.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f23120ba50c0ecf87cb9812a1238debd7d723c59e87fd006b93e1bbed2077cc1
-  data.tar.gz: 65758d5c380cb93332756af1ce05c1ad917d59340d5ca0e3c5fb563783b56059
+  metadata.gz: 5d8372acfe13485ea86eeb30fdd524624cfbe05a374e4c6671048f898ecb5e94
+  data.tar.gz: 56df068506c0271ee9b55e92a7659dd1176bbfd7eef716f17f5ac9e67cd003cd
 SHA512:
-  metadata.gz: e54574fe5e0656917394d6246ab61f0b4840262907c35fff7c824f2a8ed854b9b072a30968d82230b4e6454d7683fdb095bba31a21bf4458361ea399e0a93653
-  data.tar.gz: 8a5030dd9184aa6d85330f884d849efdc3037e43614736386c718c041170553fdf1aadfe00331f748f2111fec299bd9b8332aa5e14719c241f1761c02c3b8bf4
+  metadata.gz: ac7bff173d40c9c83aa0d1a1053890d216e4939970af363415a5462264bd7c07fd95afe5e61c00930669f3f1b6ccee678762763bb6b5066b2923db7307afc48c
+  data.tar.gz: 27488c936d5cea663853d319a4564476568abe774ecaa91a2eb7f83e168ac4c1221091fb6969ac4b44d383673a30c4b141591051ba81987f95af75fb066c95bb

data/.circleci/config.yml

@@ -357,7 +357,6 @@ jobs:
           KNAPSACK_PRO_ENDPOINT: https://api-staging.knapsackpro.com
           KNAPSACK_PRO_TEST_SUITE_TOKEN_MINITEST: $KNAPSACK_PRO_TEST_SUITE_TOKEN_MINITEST
           KNAPSACK_PRO_RSPEC_DISABLED: true
-          EXTRA_TEST_FILES_DELAY: 10
       - image: cimg/postgres:14.7
         environment:
           POSTGRES_DB: rails-app-with-knapsack_pro_test
@@ -404,7 +403,6 @@ jobs:
           KNAPSACK_PRO_ENDPOINT: https://api-staging.knapsackpro.com
           KNAPSACK_PRO_TEST_SUITE_TOKEN_MINITEST: $KNAPSACK_PRO_TEST_SUITE_TOKEN_MINITEST
           KNAPSACK_PRO_RSPEC_DISABLED: true
-          EXTRA_TEST_FILES_DELAY: 10
       - image: cimg/postgres:14.7
         environment:
           POSTGRES_DB: rails-app-with-knapsack_pro_test

data/CHANGELOG.md

@@ -2,10 +2,20 @@
 
 ### UNRELEASED
 
+### 8.2.0
+
+* Avoid needing a shell to support Distroless Container Images (in most cases)
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/299
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v8.1.3...v8.2.0
+
 ### 8.1.3
 
 * Update `changelog_uri` in gemspec
 
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v8.1.2...v8.1.3
+
 ### 8.1.2
 
 * Allow running RSpec with `--force-color` (and the default Split by Test Examples)

data/README.md

@@ -72,6 +72,42 @@ 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/distroless/Dockerfile

@@ -0,0 +1,37 @@
+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"]

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(cmd)
-          raise "Could not generate JSON report for RSpec. Rake task failed when running #{cmd}"
+        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}"
         end
 
         # read the JSON report

data/lib/knapsack_pro/repository_adapters/git_adapter.rb

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

data/lib/knapsack_pro/runners/spinach_runner.rb

@@ -15,10 +15,12 @@ module KnapsackPro
 
           KnapsackPro.tracker.set_prerun_tests(runner.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}]
+          cmd = %Q[bundle exec spinach #{args} --features_path #{runner.test_dir} -- #{runner.stringify_test_file_paths}]
 
-          Kernel.system(cmd)
-          Kernel.exit(child_status.exitstatus) unless child_status.exitstatus.zero?
+          Kernel.exec({
+            'KNAPSACK_PRO_REGULAR_MODE_ENABLED' => 'true',
+            'KNAPSACK_PRO_TEST_SUITE_TOKEN' => ENV['KNAPSACK_PRO_TEST_SUITE_TOKEN']
+          }, cmd)
         end
       end
     end

data/lib/knapsack_pro/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KnapsackPro
-  VERSION = '8.1.3'
+  VERSION = '8.2.0'
 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,19 +57,36 @@ describe KnapsackPro::Adapters::RSpecAdapter do
 
     subject { described_class.test_file_cases_for(slow_test_files) }
 
-    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.")
+    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
 
-      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)
+        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
     end
 
-    context 'when the rake task to detect RSpec test examples succeeded' do
-      let(:cmd_result) { true }
+    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)
 
-      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)
 
@@ -81,9 +98,11 @@ describe KnapsackPro::Adapters::RSpecAdapter do
     end
 
     context 'when the rake task to detect RSpec test examples failed' do
-      let(:cmd_result) { false }
-
       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)
+
         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/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(:stringify_test_file_paths) { test_file_paths.join(' ') }
       let(:test_dir) { 'fake-test-dir' }
+      let(:stringify_test_file_paths) { test_file_paths.join(' ') }
       let(:runner) do
         instance_double(described_class,
                         test_dir: test_dir,
@@ -30,42 +30,19 @@ describe KnapsackPro::Runners::SpinachRunner do
       end
       let(:child_status) { double }
 
-      before do
+      it do
         expect(KnapsackPro::Adapters::SpinachAdapter).to receive(:verify_bind_method_called)
 
         tracker = instance_double(KnapsackPro::Tracker)
         expect(KnapsackPro).to receive(:tracker).and_return(tracker)
         expect(tracker).to receive(:set_prerun_tests).with(test_file_paths)
 
-        expect(Kernel).to receive(:system).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')
-
-        allow(described_class).to receive(:child_status).and_return(child_status)
-      end
-
-      after { subject }
-
-      context 'when command exit with success code' do
-        let(:exitstatus) { 0 }
+        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'
+        )
 
-        before do
-          expect(child_status).to receive(:exitstatus).and_return(exitstatus)
-        end
-
-        it do
-          expect(Kernel).not_to receive(:exit)
-        end
-      end
-
-      context 'when command exit without success code' do
-        let(:exitstatus) { 1 }
-
-        before do
-          expect(child_status).to receive(:exitstatus).twice.and_return(exitstatus)
-        end
-
-        it do
-          expect(Kernel).to receive(:exit).with(exitstatus)
-        end
+        subject
       end
     end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 8.1.3
+  version: 8.2.0
 platform: ruby
 authors:
 - ArturT
 bindir: bin
 cert_chain: []
-date: 2025-05-09 00:00:00.000000000 Z
+date: 2025-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -216,6 +216,7 @@ files:
 - Rakefile
 - bin/knapsack_pro
 - bin/test
+- distroless/Dockerfile
 - knapsack_pro.gemspec
 - lib/knapsack_pro.rb
 - lib/knapsack_pro/adapters/base_adapter.rb