knapsack_pro 3.1.3 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fec041f1d838c8672e70c4a3703a2adfd3d727c912b2543c88c3cf01fe9ae65
-  data.tar.gz: 789349de506fcc48e3e76a881f9f87205544792c8d49243e4f20342c01627b01
+  metadata.gz: '099f5615951240d49a1087c5ebbb89169f161a35bfc2f0dc4ea7de80f188e3f9'
+  data.tar.gz: d4939ae9f79b358038147cd5f9a40dcee95760f1fa17d84314fc183cfad722a7
 SHA512:
-  metadata.gz: b28ea456bda112b8c2329a4728b82fa5d3363a883d090a10066023bf246f6f12f98c573f62cefc3d791aacca27f18a37cfc294ddd61b6b5f43af4027e4818e16
-  data.tar.gz: 90ee101ba4dc5a01e13960fe1fd469259b3242b0b0daeccfbc38300c20a3b0d7bf9f3849be6ffc8ebd649705838549a06519e031c13ba4c0896d0f019b3e255c
+  metadata.gz: adfe023532b15509a4bc1cb993c3d259ffde7df5078c76cf7cf392ec5ce8b6f8eb322ca093e77eadf3ec0c8eba4748ccd0f5ccf6666fd3559eb3bd1a55c0893a
+  data.tar.gz: 072f8d809aa4600ed5f4987f39946cd0030faac8e4ca9bae08cf38680c3aef24226744023d5c6a74aa53b76c2fe481c35692b2f33b98ba9a8d85d17ddeb990c6

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Change Log
 
+### 3.3.0
+
+* Show a JSON report file content when RSpec fails during a dry run 
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/172
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v3.2.1...v3.3.0
+
+### 3.2.1
+
+* Raise exception when using `:focus` tag to avoid skipping RSpec tests
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/167
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v3.2.0...v3.2.1
+
+### 3.2.0
+
+* Add an error message to `KnapsackPro::Adapters::RspecAdapter#bind`
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/165
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v3.1.3...v3.2.0
+
 ### 3.1.3
 
 * Run Fallback Mode when `Errno::ECONNRESET` exception happens

data/lib/knapsack_pro/adapters/rspec_adapter.rb

@@ -62,6 +62,10 @@ module KnapsackPro
                 current_test_path
               end
 
+            if example.metadata[:focus] && KnapsackPro::Adapters::RSpecAdapter.rspec_configuration.filter.rules[:focus]
+              raise "We detected a test file path #{current_test_path} with a test using the metadata `:focus` tag. RSpec might not run some tests in the Queue Mode (causing random tests skipping problem). Please remove the `:focus` tag from your codebase. See more: https://knapsackpro.com/faq/question/rspec-is-not-running-some-tests"
+            end
+
             example.run
           end
 
@@ -95,12 +99,25 @@ module KnapsackPro
           end
         end
       end
+
+      private
+
+      # Hide RSpec configuration so that we could mock it in the spec.
+      # Mocking existing RSpec configuration could impact test's runtime.
+      def self.rspec_configuration
+        ::RSpec.configuration
+      end
     end
 
     # This is added to provide backwards compatibility
     # In case someone is doing switch from knapsack gem to the knapsack_pro gem
     # and didn't notice the class name changed
     class RspecAdapter < RSpecAdapter
+      def self.bind
+        error_message = 'You have attempted to call KnapsackPro::Adapters::RspecAdapter.bind. Please switch to using the new class name: KnapsackPro::Adapters::RSpecAdapter. See https://docs.knapsackpro.com/knapsack_pro-ruby/guide for up-to-date configuration instructions.'
+        KnapsackPro.logger.error(error_message)
+        raise error_message
+      end
     end
   end
 end

data/lib/knapsack_pro/test_case_detectors/rspec_test_example_detector.rb

@@ -36,11 +36,19 @@ module KnapsackPro
           ] + cli_args).join(' ')
 
           KnapsackPro.logger.error('-'*10 + ' START of actionable error message ' + '-'*50)
-          KnapsackPro.logger.error('There was a problem while generating test examples for the slow test files using the RSpec dry-run flag. To reproduce the error triggered by the RSpec, please try to run below command (this way, you can find out what is causing the error):')
+          KnapsackPro.logger.error('RSpec (with a dry-run option) had a problem generating the report with test examples for the slow test files. Here is what you can do:')
+
+          KnapsackPro.logger.error("a) Please look for an error message from RSpec in the output above or below. If you don't see anything, that is fine. Sometimes RSpec does not produce any errors in the output.")
+
+          KnapsackPro.logger.error("b) Check if RSpec generated the report file #{report_path}. If the report exists, it may contain an error message. Here is a preview of the report file:")
+          KnapsackPro.logger.error(report_content || 'N/A')
+
+          KnapsackPro.logger.error('c) To reproduce the error manually, please run the following RSpec command. This way, you can find out what is causing the error. Please ensure you run the command in the same environment where the error occurred. For instance, if the error happens on the CI server, you should run the command in the CI environment:')
           KnapsackPro.logger.error(debug_cmd)
+
           KnapsackPro.logger.error('-'*10 + ' END of actionable error message ' + '-'*50)
 
-          raise 'There was a problem while generating test examples for the slow test files. Please read actionable error message above.'
+          raise 'There was a problem while generating test examples for the slow test files. Please read the actionable error message above.'
         end
       end
 
@@ -75,6 +83,10 @@ module KnapsackPro
         "#{report_dir}/rspec_dry_run_json_report_node_#{KnapsackPro::Config::Env.ci_node_index}.json"
       end
 
+      def report_content
+        File.read(report_path) if File.exist?(report_path)
+      end
+
       def adapter_class
         KnapsackPro::Adapters::RSpecAdapter
       end

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '3.1.3'
+  VERSION = '3.3.0'
 end

data/spec/knapsack_pro/adapters/rspec_adapter_spec.rb

@@ -175,7 +175,35 @@ describe KnapsackPro::Adapters::RSpecAdapter do
       let(:logger) { instance_double(Logger) }
       let(:global_time) { 'Global time: 01m 05s' }
       let(:test_path) { 'spec/a_spec.rb' }
-      let(:current_example) { double }
+      let(:current_example) { double(metadata: {}) }
+
+      context "when the example's metadata has :focus tag AND RSpec inclusion rule includes :focus" do
+        let(:current_example) { double(metadata: { focus: true }) }
+
+        it do
+          expect(KnapsackPro::Config::Env).to receive(:rspec_split_by_test_examples?).and_return(false)
+
+          expect(config).to receive(:prepend_before).with(:context).and_yield
+
+          allow(KnapsackPro).to receive(:tracker).and_return(tracker)
+          expect(tracker).to receive(:start_timer).ordered
+
+          expect(config).to receive(:around).with(:each).and_yield(current_example)
+          expect(::RSpec).to receive(:configure).and_yield(config)
+
+          expect(tracker).to receive(:stop_timer).ordered
+
+          expect(described_class).to receive(:test_path).with(current_example).and_return(test_path)
+
+          expect(tracker).to receive(:current_test_path=).with(test_path).ordered
+
+          expect(described_class).to receive_message_chain(:rspec_configuration, :filter, :rules, :[]).with(:focus).and_return(true)
+
+          expect {
+            subject.bind_time_tracker
+          }.to raise_error /We detected a test file path spec\/a_spec\.rb with a test using the metadata `:focus` tag/
+        end
+      end
 
       context 'when rspec split by test examples is disabled' do
         before do

data/spec/knapsack_pro/test_case_detectors/rspec_test_example_detector_spec.rb

@@ -11,7 +11,7 @@ describe KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector do
 
       expect(FileUtils).to receive(:mkdir_p).with(report_dir)
 
-      expect(File).to receive(:exist?).with(report_path).and_return(true)
+      expect(File).to receive(:exist?).at_least(:once).with(report_path).and_return(true)
       expect(File).to receive(:delete).with(report_path)
 
       expect(rspec_test_example_detector).to receive(:slow_test_files).and_return(test_file_entities)
@@ -68,8 +68,15 @@ describe KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector do
         context 'when exit code from RSpec::Core::Runner is 1' do
           let(:exit_code) { 1 }
 
+          before do
+            json_file = %{
+            {"version":"3.11.0","messages":["An error occurred while loading ./spec/a_spec.rb"],"examples":[],"summary":{"duration":3.6e-05,"example_count":0,"failure_count":0,"pending_count":0,"errors_outside_of_examples_count":1},"summary_line":"0 examples, 0 failures, 1 error occurred outside of examples"}
+            }.strip
+            expect(File).to receive(:read).with(report_path).and_return(json_file)
+          end
+
           it do
-            expect { subject }.to raise_error(RuntimeError, 'There was a problem while generating test examples for the slow test files. Please read actionable error message above.')
+            expect { subject }.to raise_error(RuntimeError, 'There was a problem while generating test examples for the slow test files. Please read the actionable error message above.')
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 3.1.3
+  version: 3.3.0
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-12 00:00:00.000000000 Z
+date: 2022-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -405,7 +405,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Knapsack Pro splits tests across parallel CI nodes and ensures each parallel