knapsack_pro 3.1.3 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fec041f1d838c8672e70c4a3703a2adfd3d727c912b2543c88c3cf01fe9ae65
-  data.tar.gz: 789349de506fcc48e3e76a881f9f87205544792c8d49243e4f20342c01627b01
+  metadata.gz: d589b843abc560c3c17965cbda829fe472bb8eda866d090403c83157736b0246
+  data.tar.gz: 237764ce934370152bc6372f735d42f4fb0e660d0a555b99fd51842561f835e8
 SHA512:
-  metadata.gz: b28ea456bda112b8c2329a4728b82fa5d3363a883d090a10066023bf246f6f12f98c573f62cefc3d791aacca27f18a37cfc294ddd61b6b5f43af4027e4818e16
-  data.tar.gz: 90ee101ba4dc5a01e13960fe1fd469259b3242b0b0daeccfbc38300c20a3b0d7bf9f3849be6ffc8ebd649705838549a06519e031c13ba4c0896d0f019b3e255c
+  metadata.gz: 88a10b32de62fcc1e20ac7dbb1bb46a29dfa6072c188d396e4a772171b7667d105d61742b6f6a65af32125474566cf1d0108031fbf433bef4b54145995a3d615
+  data.tar.gz: c3ade290ea5d7080a0fa9185ef75c5e180e85b4d9224c251198d722564330543e7c445e00eb4b2c77270345f8d2af78157565f076e25194ab22c6bc8af5fa802

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Change Log
 
+### 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/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '3.1.3'
+  VERSION = '3.2.1'
 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 3.1.3
+  version: 3.2.1
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-12 00:00:00.000000000 Z
+date: 2022-03-24 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.2.32
 signing_key:
 specification_version: 4
 summary: Knapsack Pro splits tests across parallel CI nodes and ensures each parallel