knapsack_pro 2.14.0 → 2.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebb896076bc1dc61363682126869b0add7f9ca6a9a8dfde47c8b7472d3ebb2cb
-  data.tar.gz: 86ee89293cbc0425c1d2c521c98983d4dd4d41954e614661979ca69e7d300c6b
+  metadata.gz: a97f9fbc29f0a109fbbf35b6a544f2ad86208feb697b7ff81f8458b679843c91
+  data.tar.gz: 434871e67293512331dfe99ed7915eb0f96ae27d2a7b3a1023e8752c752455ac
 SHA512:
-  metadata.gz: 8caa055376e60414a8596a941782fa99d24f92bc6c7bb6fa4aa26937d645d7b217b4fcc091a6d277edfbad29caccc08c09ce2c07db03fa375f0891dc69d4c5b0
-  data.tar.gz: d7f922e9a271d761f038eec7d1df91a86e51d54ad9e77dd304bba2507540ccae097269919861c8e1204e71f39f6c604fbd6d6555c097a3375a72bdfea5556451
+  metadata.gz: 3d5be26f0d227707d789b5d7243f3617ea6f839154725b555f0ada89b6600aef0b18aaa2532d018344c797a1f79465e27d3caadebb955d1ca00684b08f1be4ea
+  data.tar.gz: ddb85043aad801bbb9f47f51c36bace0c34b73f958968e821c7b2e8845cc0a302ef05d9e55033d260a86817d4a99d924084f8c29c86b87ce2c2a75fd96fef4af

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+### 2.15.0
+
+* Do not allow to use the RSpec tag option together with the RSpec split by test examples feature
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/139
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v2.14.0...v2.15.0
+
 ### 2.14.0
 
 * Track time spend in RSpec context hook

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

@@ -14,12 +14,18 @@ module KnapsackPro
           runner = new(KnapsackPro::Adapters::RSpecAdapter)
 
           cli_args = (args || '').split
-          # if user didn't provide the format then use explicitly default progress formatter
-          # in order to avoid KnapsackPro::Formatters::RSpecQueueSummaryFormatter being the only default formatter
-          if !cli_args.any? { |arg| arg.start_with?('-f') || arg.start_with?('--format')}
-            cli_args += ['--format', 'progress']
+
+          if KnapsackPro::Config::Env.rspec_split_by_test_examples? && has_tag_option?(cli_args)
+            error_message = 'It is not allowed to use the RSpec tag option together with the RSpec split by test examples feature. Please see: https://knapsackpro.com/faq/question/how-to-split-slow-rspec-test-files-by-test-examples-by-individual-it#warning-dont-use-rspec-tag-option'
+            KnapsackPro.logger.error(error_message)
+            raise error_message
           end
+
+          # when format option is not defined by user then use progress formatter to show tests execution progress
+          cli_args += ['--format', 'progress'] unless has_format_option?(cli_args)
+
           cli_args += [
+            # shows summary of all tests executed in Queue Mode at the very end
             '--format', KnapsackPro::Formatters::RSpecQueueSummaryFormatter.to_s,
             '--default-path', runner.test_dir,
           ]
@@ -148,6 +154,19 @@ module KnapsackPro
             ::RSpec.configuration.reset_filters
           end
         end
+
+        def self.has_tag_option?(cli_args)
+          # use start_with? because user can define tag option in a few ways:
+          # -t mytag
+          # -tmytag
+          # --tag mytag
+          # --tag=mytag
+          cli_args.any? { |arg| arg.start_with?('-t') || arg.start_with?('--tag') }
+        end
+
+        def self.has_format_option?(cli_args)
+          cli_args.any? { |arg| arg.start_with?('-f') || arg.start_with?('--format') }
+        end
       end
     end
   end

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '2.14.0'
+  VERSION = '2.15.0'
 end

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

@@ -30,7 +30,7 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
     end
 
     context 'when args provided' do
-      context 'when format param is not provided' do
+      context 'when format option is not provided' do
         let(:args) { '--example-arg example-value' }
 
         it 'uses default formatter progress' do
@@ -55,10 +55,10 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
         end
       end
 
-      context 'when format param is provided as --format' do
+      context 'when format option is provided as --format' do
         let(:args) { '--format documentation' }
 
-        it 'uses provided format param instead of default formatter progress' do
+        it 'uses provided format option instead of default formatter progress' do
           expected_exitstatus = 0
           expected_accumulator = {
             status: :completed,
@@ -80,10 +80,10 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
         end
       end
 
-      context 'when format param is provided as -f' do
+      context 'when format option is provided as -f' do
         let(:args) { '-f d' }
 
-        it 'uses provided format param instead of default formatter progress' do
+        it 'uses provided format option instead of default formatter progress' do
           expected_exitstatus = 0
           expected_accumulator = {
             status: :completed,
@@ -105,10 +105,10 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
         end
       end
 
-      context 'when format param is provided without a delimiter' do
+      context 'when format option is provided without a delimiter' do
         let(:args) { '-fMyCustomFormatter' }
 
-        it 'uses provided format param instead of default formatter progress' do
+        it 'uses provided format option instead of default formatter progress' do
           expected_exitstatus = 0
           expected_accumulator = {
             status: :completed,
@@ -129,6 +129,36 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
           subject
         end
       end
+
+      context 'when RSpec split by test examples feature is enabled' do
+        before do
+          expect(KnapsackPro::Config::Env).to receive(:rspec_split_by_test_examples?).and_return(true)
+        end
+
+        context 'when tag option is provided as --tag' do
+          let(:args) { '--tag example-value' }
+
+          it do
+            expect { subject }.to raise_error(/It is not allowed to use the RSpec tag option together with the RSpec split by test examples feature/)
+          end
+        end
+
+        context 'when tag option is provided as -t' do
+          let(:args) { '-t example-value' }
+
+          it do
+            expect { subject }.to raise_error(/It is not allowed to use the RSpec tag option together with the RSpec split by test examples feature/)
+          end
+        end
+
+        context 'when tag option is provided without delimiter' do
+          let(:args) { '-texample-value' }
+
+          it do
+            expect { subject }.to raise_error(/It is not allowed to use the RSpec tag option together with the RSpec split by test examples feature/)
+          end
+        end
+      end
     end
 
     context 'when args not provided' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 2.14.0
+  version: 2.15.0
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-15 00:00:00.000000000 Z
+date: 2021-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake