knapsack_pro 7.5.0 → 7.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cea03959b8de66cd8cbb686deb3ac76129f9cce7ee24b1da2a0ef9e57dd790df
-  data.tar.gz: ec12a1f99f57207e967846df739a5dfea4a1423e6823431ee9cf26f1d2f9a473
+  metadata.gz: 4c20774d9ffe521fc4a3a137558b47c79cc27b085e96f2b00d3a61711e43f0c9
+  data.tar.gz: af712f88ca12cf15de791d3b755fc75d6a527e938034d835ddaa0e07b77a5fd2
 SHA512:
-  metadata.gz: cd53605f0d47ce2a3bc83410eb56d459a65aa1b75b169c420f5a11e3693b2aa7abee8e5b984eff35ab876de53809a2c113abb38b253e1e1b42726c817bccae6b
-  data.tar.gz: 93eaec09e20ba573cfb69b0f1ad2e8a04f5db2ab95637767a1abed0d8640cf131447b1adae67196998d73165232ea1a23e2c1fe547ab01b14436ace7d422edc5
+  metadata.gz: ad574926a94e992932fbc8538d15040535624631c22f3679ca3c39d4d304f2e87b0efa30c536eb2695698b419b3f9e58708f1e4e5afc83d6df565e4eae6c3e7b
+  data.tar.gz: 21365b7b89c96193c3ad9ae45657d6916760745b584f1552a7e85ac686b2de6e12d6b7203c8847e2cd09997b456462f742490cc4d140d42cf135ddbd5cc23865

data/.github/pull_request_template.md

@@ -16,6 +16,7 @@ TODO: changes introduced by this PR
 
 # Checklist reminder
 
+- [ ] You added the changes to the `UNRELEASED` section of the `CHANGELOG.md`, including the needed bump (ie, patch, minor, major)
 - [ ] You follow the architecture outlined below for RSpec in Queue Mode, which is a work in progress (feel free to propose changes):
   - Pure: `lib/knapsack_pro/pure/queue/rspec_pure.rb` contains pure functions that are unit tested.
   - Extension: `lib/knapsack_pro/extensions/rspec_extension.rb` encapsulates calls to RSpec internals and is integration and e2e tested.

data/CHANGELOG.md

@@ -1,6 +1,25 @@
 # Changelog
 
+### UNRELEASED
+
+### 7.6.0
+
+* Avoid starting an unnecessary process in Queue Mode.
+  * Fix: the terminal is returned to the user correctly (output looks good) when you use CTRL+C
+  * Improvement: the backtrace looks better when something fails (for example, the gem handles an OS signal)
+
+  https://github.com/KnapsackPro/knapsack_pro-ruby/pull/260
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v7.5.1...v7.6.0
+
+### 7.5.1
+
+* Revert to 7.4.0.
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v7.5.0...v7.5.1
+
 ### 7.5.0
+
 * Raise when `KNAPSACK_PRO_CI_NODE_TOTAL` or `KNAPSACK_PRO_CI_NODE_INDEX` is missing and can't be determined from supported CI environments, instead of defaulting to arbitrary numbers.
 
   https://github.com/KnapsackPro/knapsack_pro-ruby/pull/256
@@ -8,6 +27,7 @@
 https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v7.4.0...v7.5.0
 
 ### 7.4.0
+
 * Warn when `KNAPSACK_PRO_*` environment variables are set manually if their values could be automatically determined from supported CI environments.
 
   https://github.com/KnapsackPro/knapsack_pro-ruby/pull/254
@@ -225,6 +245,34 @@ https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v6.0.4...v7.0.0
 
     https://github.com/KnapsackPro/knapsack_pro-ruby/pull/236
 
+    __(breaking change)__ for SimpleCov and Minitest in Knapsack Pro Queue Mode users.
+
+    Please add the following to your configuration:
+
+    ```ruby
+    KnapsackPro::Hooks::Queue.after_queue do
+      SimpleCov.result.format!
+    end
+    ```
+
+    The full example:
+
+    ```ruby
+    # test/test_helper.rb
+    require 'knapsack_pro'
+    require 'simplecov'
+
+    SimpleCov.start
+
+    KnapsackPro::Hooks::Queue.before_queue do |queue_id|
+      SimpleCov.command_name("minitest_ci_node_#{KnapsackPro::Config::Env.ci_node_index}")
+    end
+
+    KnapsackPro::Hooks::Queue.after_queue do
+      SimpleCov.result.format!
+    end
+    ```
+
 https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v6.0.3...v6.0.4
 
 ### 6.0.3

data/README.md

@@ -74,28 +74,13 @@ Scripted tests can be found in the [Rails App With Knapsack Pro repository](http
 
 ### Publishing
 
-1. Update the `CHANGELOG.md` as part of your PR.
+1. Move the changes listed in the `UNRELEASED` section of the `CHANGELOG.md` to the proper version
 
-2. After your PR has been merged, update the gem version in `lib/knapsack_pro/version.rb` directly on the `master` branch:
+2. Update the gem version in `lib/knapsack_pro/version.rb`
 
-```bash
-git commit -m "Bump version X.X.X"
-git push origin master
-```
-
-3. Create a git tag for the release:
+3. `git commit -am "chore: prepare release"`
 
-```bash
-git tag -a vX.X.X -m "Release vX.X.X"
-git push --tags
-```
-
-4. Build the gem and publish it to RubyGems:
-
-```bash
-gem build knapsack_pro.gemspec
-gem push knapsack_pro-X.X.X.gem
-```
+4. Build, tag, push, release: `bundle exec rake release`
 
 5. Update the latest available gem version in `TestSuiteClientVersionChecker` for the Knapsack Pro API repository.
 

data/lib/knapsack_pro/config/env.rb

@@ -13,17 +13,11 @@ module KnapsackPro
 
       class << self
         def ci_node_total
-          env_name = 'KNAPSACK_PRO_CI_NODE_TOTAL'
-          env_value = env_for(env_name, :node_total)
-
-          env_value ? env_value.to_i : raise_missing_env_for(env_name)
+          (env_for('KNAPSACK_PRO_CI_NODE_TOTAL', :node_total) || 1).to_i
         end
 
         def ci_node_index
-          env_name = 'KNAPSACK_PRO_CI_NODE_INDEX'
-          env_value = env_for(env_name, :node_index)
-
-          env_value ? env_value.to_i : raise_missing_env_for(env_name)
+          (env_for('KNAPSACK_PRO_CI_NODE_INDEX', :node_index) || 0).to_i
         end
 
         def ci_node_build_id
@@ -280,7 +274,7 @@ module KnapsackPro
         private
 
         def required_env(env_name)
-          ENV[env_name] || raise_missing_env_for(env_name)
+          ENV[env_name] || raise("Missing environment variable #{env_name}")
         end
 
         def env_for(knapsack_env_name, ci_env_method)
@@ -297,10 +291,6 @@ module KnapsackPro
         def ci_env_for(env_name)
           detected_ci.new.send(env_name)
         end
-
-        def raise_missing_env_for(env_name)
-          raise("Missing environment variable #{env_name}")
-        end
       end
     end
   end

data/lib/knapsack_pro/version.rb

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

data/lib/tasks/queue/cucumber.rake

@@ -5,14 +5,7 @@ require 'knapsack_pro'
 namespace :knapsack_pro do
   namespace :queue do
     task :cucumber, [:cucumber_args] do |_, args|
-      Kernel.system("RAILS_ENV=test RACK_ENV=test #{$PROGRAM_NAME} 'knapsack_pro:queue:cucumber_go[#{args[:cucumber_args]}]'")
-      exitstatus = $?.exitstatus
-      if exitstatus.nil?
-        puts 'Something went wrong. Most likely, the process has been killed. Knapsack Pro has been terminated.'
-        Kernel.exit(1)
-      else
-        Kernel.exit(exitstatus)
-      end
+      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,14 +5,7 @@ require 'knapsack_pro'
 namespace :knapsack_pro do
   namespace :queue do
     task :minitest, [:minitest_args] do |_, args|
-      Kernel.system("RAILS_ENV=test RACK_ENV=test #{$PROGRAM_NAME} 'knapsack_pro:queue:minitest_go[#{args[:minitest_args]}]'")
-      exitstatus = $?.exitstatus
-      if exitstatus.nil?
-        puts 'Something went wrong. Most likely, the process has been killed. Knapsack Pro has been terminated.'
-        Kernel.exit(1)
-      else
-        Kernel.exit(exitstatus)
-      end
+      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,14 +5,7 @@ require 'knapsack_pro'
 namespace :knapsack_pro do
   namespace :queue do
     task :rspec, [:rspec_args] do |_, args|
-      Kernel.system("RAILS_ENV=test RACK_ENV=test #{$PROGRAM_NAME} 'knapsack_pro:queue:rspec_go[#{args[:rspec_args]}]'")
-      exitstatus = $?.exitstatus
-      if exitstatus.nil?
-        puts 'Something went wrong. Most likely, the process has been killed. Knapsack Pro has been terminated.'
-        Kernel.exit(1)
-      else
-        Kernel.exit(exitstatus)
-      end
+      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/integration/runners/queue/rspec_runner_spec.rb

@@ -18,18 +18,23 @@ describe "#{KnapsackPro::Runners::Queue::RSpecRunner} - Integration tests", :cle
   # @param spec_batches Array[Array[String]]
   def generate_specs(spec_helper, rspec_options, spec_batches)
     ENV['TEST__RSPEC_OPTIONS'] = rspec_options
+    generate_spec_helper(spec_helper)
+    paths = generate_spec_files(spec_batches.flatten)
+    stub_spec_batches(
+      spec_batches.map { _1.map(&:path) }
+    )
+  end
 
+  def generate_spec_helper(spec_helper)
     spec_helper_path = "#{SPEC_DIRECTORY}/spec_helper.rb"
     File.open(spec_helper_path, 'w') { |file| file.write(spec_helper) }
+  end
 
-    paths = spec_batches.flatten.map do |spec_item|
+  def generate_spec_files(specs)
+    specs.map do |spec_item|
       File.open(spec_item.path, 'w') { |file| file.write(spec_item.content) }
       spec_item.path
     end
-
-    stub_spec_batches(
-      spec_batches.map { _1.map(&:path) }
-    )
   end
 
   def create_rails_helper_file(rails_helper)
@@ -73,8 +78,9 @@ describe "#{KnapsackPro::Runners::Queue::RSpecRunner} - Integration tests", :cle
     SPEC
   end
 
+  let(:command) { 'ruby spec/integration/runners/queue/rspec_runner.rb' }
+
   subject do
-    command = 'ruby spec/integration/runners/queue/rspec_runner.rb'
     stdout, stderr, status = Open3.capture3(command)
     log_command_result(stdout, stderr, status)
     OpenStruct.new(stdout: stdout, stderr: stderr, exit_code: status.exitstatus)
@@ -2537,4 +2543,28 @@ describe "#{KnapsackPro::Runners::Queue::RSpecRunner} - Integration tests", :cle
       expect(actual.exit_code).to eq 0
     end
   end
+
+  context 'when rspec is run without knapsack_pro' do
+    let(:spec) { Spec.new('a_spec.rb', <<~SPEC) }
+      require_relative "spec_helper.rb"
+
+      describe 'A_describe' do
+        it 'A1 test example' do
+          expect(1).to eq 1
+        end
+      end
+    SPEC
+
+    let(:command) { "bundle exec rspec #{spec.path}" }
+
+    it 'runs successfully' do
+      generate_spec_helper(spec_helper_with_knapsack)
+      generate_spec_files([spec])
+
+      actual = subject
+
+      expect(actual.stdout).to include('1 example, 0 failures')
+      expect(actual.exit_code).to eq 0
+    end
+  end
 end

data/spec/knapsack_pro/config/env_spec.rb

@@ -54,9 +54,7 @@ describe KnapsackPro::Config::Env do
     end
 
     context "when ENV doesn't exist" do
-      it 'raises' do
-        expect { subject }.to raise_error(/Missing environment variable KNAPSACK_PRO_CI_NODE_TOTAL/)
-      end
+      it { should eq 1 }
     end
   end
 
@@ -120,9 +118,7 @@ describe KnapsackPro::Config::Env do
     end
 
     context "when ENV doesn't exist" do
-      it 'raises' do
-        expect { subject }.to raise_error(/Missing environment variable KNAPSACK_PRO_CI_NODE_INDEX/)
-      end
+      it { should eq 0 }
     end
   end
 

data/spec/knapsack_pro_spec.rb

@@ -36,11 +36,13 @@ describe KnapsackPro do
           stub_const('ENV', {
             'KNAPSACK_PRO_LOG_DIR' => 'log',
           })
-        end
 
-        it 'raises' do
-          expect { subject }.to raise_error(/Missing environment variable KNAPSACK_PRO_CI_NODE_INDEX/)
+          expect(Logger).to receive(:new).with('log/knapsack_pro_node_0.log').and_return(logger)
+          expect(logger).to receive(:level=).with(Logger::INFO)
+          expect(KnapsackPro::LoggerWrapper).to receive(:new).with(logger).and_return(logger_wrapper)
         end
+
+        it { should eql logger_wrapper }
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 7.5.0
+  version: 7.6.0
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-27 00:00:00.000000000 Z
+date: 2024-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -415,7 +415,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Knapsack Pro splits tests across parallel CI nodes and ensures each parallel