knapsack_pro 5.3.3 → 5.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 388e3d47f2da2b0d9f1377677b912a44af5919111a86869115713488a83d84e2
-  data.tar.gz: '08fd59b79cc652a4045f11f24a363cac8928644a2cf2a705b766e558e77d104f'
+  metadata.gz: 6952ceb372cbcc2dc8c2c5514f0fe68bc4be51572199168e3d7f7992eabdfe43
+  data.tar.gz: '077863b80cab5c090ad84c62cbb0c2d680757ea19da59e94c92cb9ee2770ba90'
 SHA512:
-  metadata.gz: 881dc5a753a3af8ffc1320eab7dd5a50ba38909812e971a1aeb2e282a3566f27afea3b601d99784d27d9959d7cf13f2d93b8db7634f73ccfb72a82b33e4243b2
-  data.tar.gz: d7887b2f0bb7854b1d926f422b70ab1e4ac21904026e01863aa9b83e7a690a4df0d576f6ed863fe86e8f9dfb574db106553a7a61fc0913b1dc26ac22903c422b
+  metadata.gz: 3ba6a868b796019d571c077131e1cd33016bee27e7a8cbd1b1d35cfe31532c2049734d1cf24686ac5ef63a881a82ed0c3d811d4e04ccf17ba0444a856121e363
+  data.tar.gz: a717af5c831cfd8984ac2c2d691b557dd7cd919e1e7a223d9347eac8d28345700bdcefdf50d0fc5ab10a23c2c9dd4811e95198c443530d83006e7baeee898dbb

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+### 5.3.4
+
+* fix(Queue Mode): handle OS signals and RSpec internal `wants_to_quit` and `rspec_is_quitting` states to stop consuming tests from the Queue API when the CI node is terminated
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/207
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v5.3.3...v5.3.4
+
 ### 5.3.3
 
 * Fix hanging CI when `git fetch --shallow-since` takes too long

data/lib/knapsack_pro/runners/queue/base_runner.rb

@@ -2,6 +2,10 @@ module KnapsackPro
   module Runners
     module Queue
       class BaseRunner
+        TERMINATION_SIGNALS = %w(HUP INT TERM ABRT QUIT USR1 USR2)
+
+        @@terminate_process = false
+
         def self.run(args)
           raise NotImplementedError
         end
@@ -13,6 +17,7 @@ module KnapsackPro
         def initialize(adapter_class)
           @allocator_builder = KnapsackPro::QueueAllocatorBuilder.new(adapter_class)
           @allocator = allocator_builder.allocator
+          trap_signals
         end
 
         def test_file_paths(args)
@@ -33,6 +38,23 @@ module KnapsackPro
         def self.child_status
           $?
         end
+
+        def self.handle_signal!
+          raise 'Knapsack Pro process was terminated!' if @@terminate_process
+        end
+
+        def self.set_terminate_process
+          @@terminate_process = true
+        end
+
+        def trap_signals
+          TERMINATION_SIGNALS.each do |signal|
+            Signal.trap(signal) {
+              puts "#{signal} signal has been received. Terminating Knapsack Pro..."
+              @@terminate_process = true
+            }
+          end
+        end
       end
     end
   end

data/lib/knapsack_pro/runners/queue/cucumber_runner.rb

@@ -22,6 +22,7 @@ module KnapsackPro
             all_test_file_paths: [],
           }
           while accumulator[:status] == :next
+            handle_signal!
             accumulator = run_tests(accumulator)
           end
 

data/lib/knapsack_pro/runners/queue/minitest_runner.rb

@@ -29,6 +29,7 @@ module KnapsackPro
             all_test_file_paths: [],
           }
           while accumulator[:status] == :next
+            handle_signal!
             accumulator = run_tests(accumulator)
           end
 

data/lib/knapsack_pro/runners/queue/rspec_runner.rb

@@ -37,6 +37,7 @@ module KnapsackPro
             all_test_file_paths: [],
           }
           while accumulator[:status] == :next
+            handle_signal!
             accumulator = run_tests(accumulator)
           end
 
@@ -94,6 +95,15 @@ module KnapsackPro
             exit_code = rspec_runner.run($stderr, $stdout)
             exitstatus = exit_code if exit_code != 0
 
+            if rspec_runner.world.wants_to_quit
+              KnapsackPro.logger.warn('RSpec wants to quit.')
+              set_terminate_process
+            end
+            if rspec_runner.world.rspec_is_quitting
+              KnapsackPro.logger.warn('RSpec is quitting.')
+              set_terminate_process
+            end
+
             printable_args = args_with_seed_option_added_when_viable(args, rspec_runner)
             log_rspec_command(printable_args, test_file_paths, :subset_queue)
 

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '5.3.3'
+  VERSION = '5.3.4'
 end

data/lib/tasks/queue/cucumber.rake

@@ -4,7 +4,13 @@ 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]}]'")
-      Kernel.exit($?.exitstatus)
+      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
     end
 
     task :cucumber_go, [:cucumber_args] do |_, args|

data/lib/tasks/queue/minitest.rake

@@ -4,7 +4,13 @@ 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]}]'")
-      Kernel.exit($?.exitstatus)
+      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
     end
 
     task :minitest_go, [:minitest_args] do |_, args|

data/lib/tasks/queue/rspec.rake

@@ -4,7 +4,13 @@ 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]}]'")
-      Kernel.exit($?.exitstatus)
+      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
     end
 
     task :rspec_go, [:rspec_args] do |_, args|

data/spec/knapsack_pro/runners/queue/cucumber_runner_spec.rb

@@ -41,6 +41,7 @@ describe KnapsackPro::Runners::Queue::CucumberRunner do
           exitstatus: 0,
           all_test_file_paths: [],
         }
+        expect(described_class).to receive(:handle_signal!)
         expect(described_class).to receive(:run_tests).with(accumulator).and_return(expected_accumulator)
 
         expect(Kernel).to receive(:exit).with(expected_exitstatus)
@@ -66,6 +67,7 @@ describe KnapsackPro::Runners::Queue::CucumberRunner do
           exitstatus: 0,
           all_test_file_paths: [],
         }
+        expect(described_class).to receive(:handle_signal!)
         expect(described_class).to receive(:run_tests).with(accumulator).and_return(expected_accumulator)
 
         expect(Kernel).to receive(:exit).with(expected_exitstatus)

data/spec/knapsack_pro/runners/queue/minitest_runner_spec.rb

@@ -43,6 +43,7 @@ describe KnapsackPro::Runners::Queue::MinitestRunner do
           exitstatus: 0,
           all_test_file_paths: [],
         }
+        expect(described_class).to receive(:handle_signal!)
         expect(described_class).to receive(:run_tests).with(accumulator).and_return(expected_accumulator)
 
         expect(Kernel).to receive(:exit).with(expected_exitstatus)
@@ -68,6 +69,7 @@ describe KnapsackPro::Runners::Queue::MinitestRunner do
           exitstatus: 0,
           all_test_file_paths: [],
         }
+        expect(described_class).to receive(:handle_signal!)
         expect(described_class).to receive(:run_tests).with(accumulator).and_return(expected_accumulator)
 
         expect(Kernel).to receive(:exit).with(expected_exitstatus)

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

@@ -49,6 +49,7 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
             exitstatus: 0,
             all_test_file_paths: [],
           }
+          expect(described_class).to receive(:handle_signal!)
           expect(described_class).to receive(:run_tests).with(accumulator).and_return(expected_accumulator)
 
           expect(Kernel).to receive(:exit).with(expected_exitstatus)
@@ -74,6 +75,7 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
             exitstatus: 0,
             all_test_file_paths: [],
           }
+          expect(described_class).to receive(:handle_signal!)
           expect(described_class).to receive(:run_tests).with(accumulator).and_return(expected_accumulator)
 
           expect(Kernel).to receive(:exit).with(expected_exitstatus)
@@ -99,6 +101,7 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
             exitstatus: 0,
             all_test_file_paths: [],
           }
+          expect(described_class).to receive(:handle_signal!)
           expect(described_class).to receive(:run_tests).with(accumulator).and_return(expected_accumulator)
 
           expect(Kernel).to receive(:exit).with(expected_exitstatus)
@@ -124,6 +127,7 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
             exitstatus: 0,
             all_test_file_paths: [],
           }
+          expect(described_class).to receive(:handle_signal!)
           expect(described_class).to receive(:run_tests).with(accumulator).and_return(expected_accumulator)
 
           expect(Kernel).to receive(:exit).with(expected_exitstatus)
@@ -165,6 +169,7 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
           exitstatus: 0,
           all_test_file_paths: [],
         }
+        expect(described_class).to receive(:handle_signal!)
         expect(described_class).to receive(:run_tests).with(accumulator).and_return(expected_accumulator)
 
         expect(Kernel).to receive(:exit).with(expected_exitstatus)
@@ -200,6 +205,12 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
       let(:test_file_paths) { ['a_spec.rb', 'b_spec.rb'] }
       let(:logger) { double }
       let(:rspec_seed) { 7771 }
+      let(:exit_code) { [0, 1].sample }
+      let(:rspec_wants_to_quit) { false }
+      let(:rspec_is_quitting) { false }
+      let(:rspec_core_runner) do
+        double(world: double(wants_to_quit: rspec_wants_to_quit, rspec_is_quitting: rspec_is_quitting))
+      end
 
       before do
         subset_queue_id = 'fake-subset-queue-id'
@@ -220,7 +231,6 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
           'a_spec.rb', 'b_spec.rb',
         ]).and_return(options)
 
-        rspec_core_runner = double
         expect(RSpec::Core::Runner).to receive(:new).with(options).and_return(rspec_core_runner)
         expect(rspec_core_runner).to receive(:run).with($stderr, $stdout).and_return(exit_code)
 
@@ -237,13 +247,13 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
         expect(configuration).to receive(:seed_used?).and_return(true)
         expect(configuration).to receive(:seed).and_return(rspec_seed)
 
-        expect(KnapsackPro).to receive(:logger).twice.and_return(logger)
+        expect(KnapsackPro).to receive(:logger).at_least(2).and_return(logger)
         expect(logger).to receive(:info)
           .with("To retry the last batch of tests fetched from the API Queue, please run the following command on your machine:")
         expect(logger).to receive(:info).with(/#{args.join(' ')} --seed #{rspec_seed}/)
       end
 
-      context 'when exit code is zero' do
+      context 'when the exit code is zero' do
         let(:exit_code) { 0 }
 
         it do
@@ -258,7 +268,7 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
         end
       end
 
-      context 'when exit code is not zero' do
+      context 'when the exit code is not zero' do
         let(:exit_code) { double }
 
         it do
@@ -272,6 +282,58 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
           })
         end
       end
+
+      context 'when RSpec wants to quit' do
+        let(:exit_code) { 0 }
+        let(:rspec_wants_to_quit) { true }
+
+        after do
+          described_class.class_variable_set(:@@terminate_process, false)
+        end
+
+        it 'terminates the process' do
+          expect(logger).to receive(:warn).with('RSpec wants to quit.')
+
+          expect(described_class.class_variable_get(:@@terminate_process)).to be false
+
+          expect(subject).to eq({
+            status: :next,
+            runner: runner,
+            can_initialize_queue: false,
+            args: args,
+            exitstatus: exitstatus,
+            all_test_file_paths: test_file_paths,
+          })
+
+          expect(described_class.class_variable_get(:@@terminate_process)).to be true
+        end
+      end
+
+      context 'when RSpec is quitting' do
+        let(:exit_code) { 0 }
+        let(:rspec_is_quitting) { true }
+
+        after do
+          described_class.class_variable_set(:@@terminate_process, false)
+        end
+
+        it 'terminates the process' do
+          expect(logger).to receive(:warn).with('RSpec is quitting.')
+
+          expect(described_class.class_variable_get(:@@terminate_process)).to be false
+
+          expect(subject).to eq({
+            status: :next,
+            runner: runner,
+            can_initialize_queue: false,
+            args: args,
+            exitstatus: exitstatus,
+            all_test_file_paths: test_file_paths,
+          })
+
+          expect(described_class.class_variable_get(:@@terminate_process)).to be true
+        end
+      end
     end
 
     context "when test files don't exist" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 5.3.3
+  version: 5.3.4
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-21 00:00:00.000000000 Z
+date: 2023-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake