knapsack_pro 5.3.4 → 5.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6952ceb372cbcc2dc8c2c5514f0fe68bc4be51572199168e3d7f7992eabdfe43
-  data.tar.gz: '077863b80cab5c090ad84c62cbb0c2d680757ea19da59e94c92cb9ee2770ba90'
+  metadata.gz: 202eb37b7550c8556fadd902ed204ea71d5c928b2ed79f3452aa2f7dabee1a35
+  data.tar.gz: 846ec0dd9f9953bbbfeed2b9f77535a25e5182de8b3798dcff88a48fce1ba0f9
 SHA512:
-  metadata.gz: 3ba6a868b796019d571c077131e1cd33016bee27e7a8cbd1b1d35cfe31532c2049734d1cf24686ac5ef63a881a82ed0c3d811d4e04ccf17ba0444a856121e363
-  data.tar.gz: a717af5c831cfd8984ac2c2d691b557dd7cd919e1e7a223d9347eac8d28345700bdcefdf50d0fc5ab10a23c2c9dd4811e95198c443530d83006e7baeee898dbb
+  metadata.gz: 6e9e1bffd253bade681efd59cdb43a13c8ae99bb43981dbf8aaea0f7adc3e5d2cce530488e6308a7eb35821abfc9245f26236e3e3dc323b68dbd3fd457905865
+  data.tar.gz: aedf904bdf8f765e1fdcbe651ee9d1f839201c48fdad7750668c88cb2f70bb1f61fff1fa633062f0be3bf31770656d48b0467b61b970f6d03526c430b7dc12c8

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+### 5.3.5
+
+* Handle RSpec exceptions when running RSpec in Queue Mode
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/214
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/215
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v5.3.4...v5.3.5
+
 ### 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

data/lib/knapsack_pro/formatters/rspec_queue_summary_formatter.rb

@@ -62,11 +62,39 @@ module KnapsackPro
         unless most_recent_pending.empty?
           registered_output.puts('All pending tests on this CI node:')
           registered_output.puts(most_recent_pending)
+          registered_output.puts('')
         end
 
         unless most_recent_failures_summary.empty?
           registered_output.puts('All failed tests on this CI node:')
           registered_output.puts(most_recent_failures_summary)
+          registered_output.puts('')
+        end
+
+        registered_output.puts(most_recent_summary)
+      end
+
+      def self.print_exit_summary
+        registered_output.puts('Knapsack Pro Queue exited/aborted!')
+        registered_output.puts('')
+
+        unexecuted_test_files = KnapsackPro.tracker.unexecuted_test_files
+        unless unexecuted_test_files.empty?
+          registered_output.puts('Unexecuted tests on this CI node:')
+          registered_output.puts(unexecuted_test_files)
+          registered_output.puts('')
+        end
+
+        unless most_recent_pending.empty?
+          registered_output.puts('All pending tests on this CI node:')
+          registered_output.puts(most_recent_pending)
+          registered_output.puts('')
+        end
+
+        unless most_recent_failures_summary.empty?
+          registered_output.puts('All failed tests on this CI node:')
+          registered_output.puts(most_recent_failures_summary)
+          registered_output.puts('')
         end
 
         registered_output.puts(most_recent_summary)

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

@@ -92,35 +92,44 @@ module KnapsackPro
             options = ::RSpec::Core::ConfigurationOptions.new(cli_args)
             rspec_runner = ::RSpec::Core::Runner.new(options)
 
-            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
+            begin
+              exit_code = rspec_runner.run($stderr, $stdout)
+              exitstatus = exit_code if exit_code != 0
+            rescue Exception => exception
+              KnapsackPro.logger.error("Having exception when running RSpec: #{exception.inspect}")
+              KnapsackPro::Formatters::RSpecQueueSummaryFormatter.print_exit_summary
+              KnapsackPro::Hooks::Queue.call_after_subset_queue
+              KnapsackPro::Hooks::Queue.call_after_queue
+              Kernel.exit(1)
+              raise
+            else
+              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)
+
+              rspec_clear_examples
+
+              KnapsackPro::Hooks::Queue.call_after_subset_queue
+
+              KnapsackPro::Report.save_subset_queue_to_file
+
+              return {
+                status: :next,
+                runner: runner,
+                can_initialize_queue: false,
+                args: args,
+                exitstatus: exitstatus,
+                all_test_file_paths: all_test_file_paths,
+              }
             end
-
-            printable_args = args_with_seed_option_added_when_viable(args, rspec_runner)
-            log_rspec_command(printable_args, test_file_paths, :subset_queue)
-
-            rspec_clear_examples
-
-            KnapsackPro::Hooks::Queue.call_after_subset_queue
-
-            KnapsackPro::Report.save_subset_queue_to_file
-
-            return {
-              status: :next,
-              runner: runner,
-              can_initialize_queue: false,
-              args: args,
-              exitstatus: exitstatus,
-              all_test_file_paths: all_test_file_paths,
-            }
           end
         end
 

data/lib/knapsack_pro/tracker.rb

@@ -68,6 +68,12 @@ module KnapsackPro
       @prerun_tests_loaded = true
     end
 
+    def unexecuted_test_files
+      @test_files_with_time.map do |path, hash|
+        path unless hash[:measured_time]
+      end.compact
+    end
+
     def to_a
       # When the test files are not loaded in the memory then load them from the disk.
       # Useful for the Regular Mode when the memory is not shared between tracker instances.

data/lib/knapsack_pro/version.rb

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

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

@@ -212,126 +212,183 @@ describe KnapsackPro::Runners::Queue::RSpecRunner 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'
-        expect(KnapsackPro::Config::EnvGenerator).to receive(:set_subset_queue_id).and_return(subset_queue_id)
+      context 'having no exception when running RSpec' do
+        before do
+          subset_queue_id = 'fake-subset-queue-id'
+          expect(KnapsackPro::Config::EnvGenerator).to receive(:set_subset_queue_id).and_return(subset_queue_id)
 
-        expect(ENV).to receive(:[]=).with('KNAPSACK_PRO_SUBSET_QUEUE_ID', subset_queue_id)
+          expect(ENV).to receive(:[]=).with('KNAPSACK_PRO_SUBSET_QUEUE_ID', subset_queue_id)
 
-        tracker = instance_double(KnapsackPro::Tracker)
-        expect(KnapsackPro).to receive(:tracker).twice.and_return(tracker)
-        expect(tracker).to receive(:reset!)
-        expect(tracker).to receive(:set_prerun_tests).with(test_file_paths)
+          tracker = instance_double(KnapsackPro::Tracker)
+          expect(KnapsackPro).to receive(:tracker).twice.and_return(tracker)
+          expect(tracker).to receive(:reset!)
+          expect(tracker).to receive(:set_prerun_tests).with(test_file_paths)
 
-        expect(described_class).to receive(:ensure_spec_opts_have_rspec_queue_summary_formatter)
-        options = double
-        expect(RSpec::Core::ConfigurationOptions).to receive(:new).with([
-          '--no-color',
-          '--default-path', 'fake-test-dir',
-          'a_spec.rb', 'b_spec.rb',
-        ]).and_return(options)
+          expect(described_class).to receive(:ensure_spec_opts_have_rspec_queue_summary_formatter)
+          options = double
+          expect(RSpec::Core::ConfigurationOptions).to receive(:new).with([
+            '--no-color',
+            '--default-path', 'fake-test-dir',
+            'a_spec.rb', 'b_spec.rb',
+          ]).and_return(options)
 
-        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)
+          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)
 
-        expect(described_class).to receive(:rspec_clear_examples)
+          expect(described_class).to receive(:rspec_clear_examples)
 
-        expect(KnapsackPro::Hooks::Queue).to receive(:call_before_subset_queue)
+          expect(KnapsackPro::Hooks::Queue).to receive(:call_before_subset_queue)
 
-        expect(KnapsackPro::Hooks::Queue).to receive(:call_after_subset_queue)
+          expect(KnapsackPro::Hooks::Queue).to receive(:call_after_subset_queue)
 
-        expect(KnapsackPro::Report).to receive(:save_subset_queue_to_file)
+          expect(KnapsackPro::Report).to receive(:save_subset_queue_to_file)
 
-        configuration = double
-        expect(rspec_core_runner).to receive(:configuration).twice.and_return(configuration)
-        expect(configuration).to receive(:seed_used?).and_return(true)
-        expect(configuration).to receive(:seed).and_return(rspec_seed)
+          configuration = double
+          expect(rspec_core_runner).to receive(:configuration).twice.and_return(configuration)
+          expect(configuration).to receive(:seed_used?).and_return(true)
+          expect(configuration).to receive(:seed).and_return(rspec_seed)
 
-        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
+          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 the exit code is zero' do
-        let(:exit_code) { 0 }
+        context 'when the exit code is zero' do
+          let(:exit_code) { 0 }
 
-        it do
-          expect(subject).to eq({
-            status: :next,
-            runner: runner,
-            can_initialize_queue: false,
-            args: args,
-            exitstatus: exitstatus,
-            all_test_file_paths: test_file_paths,
-          })
+          it do
+            expect(subject).to eq({
+              status: :next,
+              runner: runner,
+              can_initialize_queue: false,
+              args: args,
+              exitstatus: exitstatus,
+              all_test_file_paths: test_file_paths,
+            })
+          end
         end
-      end
 
-      context 'when the exit code is not zero' do
-        let(:exit_code) { double }
+        context 'when the exit code is not zero' do
+          let(:exit_code) { double }
 
-        it do
-          expect(subject).to eq({
-            status: :next,
-            runner: runner,
-            can_initialize_queue: false,
-            args: args,
-            exitstatus: exit_code,
-            all_test_file_paths: test_file_paths,
-          })
+          it do
+            expect(subject).to eq({
+              status: :next,
+              runner: runner,
+              can_initialize_queue: false,
+              args: args,
+              exitstatus: exit_code,
+              all_test_file_paths: test_file_paths,
+            })
+          end
         end
-      end
 
-      context 'when RSpec wants to quit' do
-        let(:exit_code) { 0 }
-        let(:rspec_wants_to_quit) { true }
+        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.')
 
-        after do
-          described_class.class_variable_set(:@@terminate_process, false)
+            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
 
-        it 'terminates the process' do
-          expect(logger).to receive(:warn).with('RSpec wants to quit.')
+        context 'when RSpec is quitting' do
+          let(:exit_code) { 0 }
+          let(:rspec_is_quitting) { true }
 
-          expect(described_class.class_variable_get(:@@terminate_process)).to be false
+          after do
+            described_class.class_variable_set(:@@terminate_process, false)
+          end
 
-          expect(subject).to eq({
-            status: :next,
-            runner: runner,
-            can_initialize_queue: false,
-            args: args,
-            exitstatus: exitstatus,
-            all_test_file_paths: test_file_paths,
-          })
+          it 'terminates the process' do
+            expect(logger).to receive(:warn).with('RSpec is quitting.')
 
-          expect(described_class.class_variable_get(:@@terminate_process)).to be true
+            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 RSpec is quitting' do
-        let(:exit_code) { 0 }
-        let(:rspec_is_quitting) { true }
-
-        after do
-          described_class.class_variable_set(:@@terminate_process, false)
+      context 'having exception when running RSpec' do
+        before do
+          subset_queue_id = 'fake-subset-queue-id'
+          expect(KnapsackPro::Config::EnvGenerator).to receive(:set_subset_queue_id).and_return(subset_queue_id)
+
+          expect(ENV).to receive(:[]=).with('KNAPSACK_PRO_SUBSET_QUEUE_ID', subset_queue_id)
+
+          tracker = instance_double(KnapsackPro::Tracker)
+          expect(KnapsackPro).to receive(:tracker).twice.and_return(tracker)
+          expect(tracker).to receive(:reset!)
+          expect(tracker).to receive(:set_prerun_tests).with(test_file_paths)
+
+          expect(described_class).to receive(:ensure_spec_opts_have_rspec_queue_summary_formatter)
+          options = double
+          expect(RSpec::Core::ConfigurationOptions).to receive(:new).with([
+            '--no-color',
+            '--default-path', 'fake-test-dir',
+            '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_raise SystemExit
+          expect(KnapsackPro::Hooks::Queue).to receive(:call_before_subset_queue)
+          allow(KnapsackPro::Report).to receive(:save_subset_queue_to_file)
+          allow(KnapsackPro::Hooks::Queue).to receive(:call_after_subset_queue)
+          allow(KnapsackPro::Hooks::Queue).to receive(:call_after_queue)
+          allow(KnapsackPro::Formatters::RSpecQueueSummaryFormatter).to receive(:print_exit_summary)
+          expect(Kernel).to receive(:exit).with(1)
         end
 
-        it 'terminates the process' do
-          expect(logger).to receive(:warn).with('RSpec is quitting.')
+        it 'does not call #save_subset_queue_to_file or #rspec_clear_examples' do
+          expect(described_class).not_to receive(:rspec_clear_examples)
+          expect(KnapsackPro::Report).not_to receive(:save_subset_queue_to_file)
+          expect { subject }.to raise_error SystemExit
+        end
 
-          expect(described_class.class_variable_get(:@@terminate_process)).to be false
+        it 'logs the exception' do
+          expect(KnapsackPro).to receive(:logger).once.and_return(logger)
+          expect(logger).to receive(:error).with("Having exception when running RSpec: #<SystemExit: SystemExit>")
+          expect { subject }.to raise_error SystemExit
+        end
 
-          expect(subject).to eq({
-            status: :next,
-            runner: runner,
-            can_initialize_queue: false,
-            args: args,
-            exitstatus: exitstatus,
-            all_test_file_paths: test_file_paths,
-          })
+        it 'calls #print_exit_summary' do
+          expect(KnapsackPro::Formatters::RSpecQueueSummaryFormatter).to receive(:print_exit_summary)
+          expect { subject }.to raise_error SystemExit
+        end
 
-          expect(described_class.class_variable_get(:@@terminate_process)).to be true
+        it 'calls #call_after_subset_queue and #call_after_queue' do
+          expect(KnapsackPro::Hooks::Queue).to receive(:call_after_subset_queue)
+          expect(KnapsackPro::Hooks::Queue).to receive(:call_after_queue)
+          expect { subject }.to raise_error SystemExit
         end
       end
     end

data/spec/knapsack_pro/tracker_spec.rb

@@ -185,4 +185,21 @@ describe KnapsackPro::Tracker do
       expect(tracker.prerun_tests_loaded).to be false
     end
   end
+
+
+  describe '#unexecuted_test_files' do
+    before do
+      tracker.set_prerun_tests(['a_spec.rb', 'b_spec.rb', 'c_spec.rb'])
+
+      # measure execution time for b_spec.rb
+      tracker.current_test_path = 'b_spec.rb'
+      tracker.start_timer
+      sleep 0.1
+      tracker.stop_timer
+    end
+
+    it 'returns test files without measured time' do
+      expect(tracker.unexecuted_test_files).to eq(['a_spec.rb', 'c_spec.rb'])
+    end
+  end
 end

metadata

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