knapsack_pro 2.11.0 → 2.16.0

data/lib/knapsack_pro/adapters/rspec_adapter.rb

@@ -21,7 +21,15 @@ module KnapsackPro
 
       def bind_time_tracker
         ::RSpec.configure do |config|
+          config.prepend_before(:context) do
+            KnapsackPro.tracker.start_timer
+          end
+
           config.around(:each) do |example|
+            # stop timer to update time for a previously run test example
+            # this way we count time spend in runtime for the previous test example after around(:each) is already done
+            KnapsackPro.tracker.stop_timer
+
             current_example_group =
               if ::RSpec.respond_to?(:current_example)
                 ::RSpec.current_example.metadata[:example_group]
@@ -38,10 +46,12 @@ module KnapsackPro
                 current_test_path
               end
 
-            KnapsackPro.tracker.start_timer
-
             example.run
+          end
 
+          config.append_after(:context) do
+            # after(:context) hook is run one time only, after all of the examples in a group
+            # stop timer to count time for the very last executed test example
             KnapsackPro.tracker.stop_timer
           end
 

data/lib/knapsack_pro/allocator.rb

@@ -26,7 +26,7 @@ module KnapsackPro
         KnapsackPro.logger.error(message)
         raise message
       else
-        KnapsackPro.logger.warn("Fallback mode started. We could not connect with Knapsack Pro API. Your tests will be executed based on directory names. Read more about fallback mode at https://github.com/KnapsackPro/knapsack_pro-ruby#what-happens-when-knapsack-pro-api-is-not-availablenot-reachable-temporarily")
+        KnapsackPro.logger.warn("Fallback mode started. We could not connect with Knapsack Pro API. Your tests will be executed based on directory names. Read more about fallback mode at https://knapsackpro.com/faq/question/what-happens-when-knapsack-pro-api-is-not-availablenot-reachable-temporarily")
         fallback_test_files
       end
     end

data/lib/knapsack_pro/queue_allocator.rb

@@ -39,7 +39,7 @@ module KnapsackPro
         raise message
       else
         @fallback_activated = true
-        KnapsackPro.logger.warn("Fallback mode started. We could not connect with Knapsack Pro API. Your tests will be executed based on directory names. If other CI nodes were able to connect with Knapsack Pro API then you may notice that some of the test files will be executed twice across CI nodes. The most important thing is to guarantee each of test files is run at least once! Read more about fallback mode at https://github.com/KnapsackPro/knapsack_pro-ruby#what-happens-when-knapsack-pro-api-is-not-availablenot-reachable-temporarily")
+        KnapsackPro.logger.warn("Fallback mode started. We could not connect with Knapsack Pro API. Your tests will be executed based on directory names. If other CI nodes were able to connect with Knapsack Pro API then you may notice that some of the test files will be executed twice across CI nodes. The most important thing is to guarantee each of test files is run at least once! Read more about fallback mode at https://knapsackpro.com/faq/question/what-happens-when-knapsack-pro-api-is-not-availablenot-reachable-temporarily")
         fallback_test_files(executed_test_files)
       end
     end

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/tracker.rb

@@ -4,7 +4,7 @@ module KnapsackPro
 
     # when test file is pending, empty with no tests or has syntax error then assume time execution
     # to better allocate it in Queue Mode for future CI build runs
-    DEFAULT_TEST_FILE_TIME = 0.1 # seconds
+    DEFAULT_TEST_FILE_TIME = 0.0 # seconds
 
     attr_reader :global_time_since_beginning, :global_time, :test_files_with_time
     attr_writer :current_test_path
@@ -19,13 +19,22 @@ module KnapsackPro
     end
 
     def start_timer
+      @start_time ||= now_without_mock_time.to_f
+    end
+
+    def reset_timer
       @start_time = now_without_mock_time.to_f
     end
 
     def stop_timer
       execution_time = @start_time ? now_without_mock_time.to_f - @start_time : 0.0
-      update_global_time(execution_time)
-      update_test_file_time(execution_time)
+
+      if @current_test_path
+        update_global_time(execution_time)
+        update_test_file_time(execution_time)
+        reset_timer
+      end
+
       execution_time
     end
 
@@ -63,7 +72,7 @@ module KnapsackPro
     def set_defaults
       @global_time = 0
       @test_files_with_time = {}
-      @test_path = nil
+      @current_test_path = nil
     end
 
     def update_global_time(execution_time)

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '2.11.0'
+  VERSION = '2.16.0'
 end

data/spec/knapsack_pro/adapters/rspec_adapter_spec.rb

@@ -86,20 +86,26 @@ describe KnapsackPro::Adapters::RSpecAdapter do
         end
 
         it 'records time for current test path' do
+          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(example)
+          expect(config).to receive(:append_after).with(:context).and_yield
           expect(config).to receive(:after).with(:suite).and_yield
           expect(::RSpec).to receive(:configure).and_yield(config)
 
+          expect(tracker).to receive(:stop_timer).ordered
+
           expect(::RSpec).to receive(:current_example).twice.and_return(current_example)
           expect(described_class).to receive(:test_path).with(example_group).and_return(test_path)
 
-          allow(KnapsackPro).to receive(:tracker).and_return(tracker)
-          expect(tracker).to receive(:current_test_path=).with(test_path)
-          expect(tracker).to receive(:start_timer)
+          expect(tracker).to receive(:current_test_path=).with(test_path).ordered
 
           expect(example).to receive(:run)
 
-          expect(tracker).to receive(:stop_timer)
+          expect(tracker).to receive(:stop_timer).ordered
 
           expect(KnapsackPro::Presenter).to receive(:global_time).and_return(global_time)
           expect(KnapsackPro).to receive(:logger).and_return(logger)
@@ -124,20 +130,26 @@ describe KnapsackPro::Adapters::RSpecAdapter do
           it 'records time for example.id' do
             expect(example).to receive(:id).and_return(test_example_path)
 
+            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(example)
+            expect(config).to receive(:append_after).with(:context).and_yield
             expect(config).to receive(:after).with(:suite).and_yield
             expect(::RSpec).to receive(:configure).and_yield(config)
 
+            expect(tracker).to receive(:stop_timer).ordered
+
             expect(::RSpec).to receive(:current_example).twice.and_return(current_example)
             expect(described_class).to receive(:test_path).with(example_group).and_return(test_path)
 
-            allow(KnapsackPro).to receive(:tracker).and_return(tracker)
-            expect(tracker).to receive(:current_test_path=).with(test_example_path)
-            expect(tracker).to receive(:start_timer)
+            expect(tracker).to receive(:current_test_path=).with(test_example_path).ordered
 
             expect(example).to receive(:run)
 
-            expect(tracker).to receive(:stop_timer)
+            expect(tracker).to receive(:stop_timer).ordered
 
             expect(KnapsackPro::Presenter).to receive(:global_time).and_return(global_time)
             expect(KnapsackPro).to receive(:logger).and_return(logger)
@@ -153,20 +165,26 @@ describe KnapsackPro::Adapters::RSpecAdapter do
           end
 
           it 'records time for current test path' do
+            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(example)
+            expect(config).to receive(:append_after).with(:context).and_yield
             expect(config).to receive(:after).with(:suite).and_yield
             expect(::RSpec).to receive(:configure).and_yield(config)
 
             expect(::RSpec).to receive(:current_example).twice.and_return(current_example)
             expect(described_class).to receive(:test_path).with(example_group).and_return(test_path)
 
-            allow(KnapsackPro).to receive(:tracker).and_return(tracker)
-            expect(tracker).to receive(:current_test_path=).with(test_path)
-            expect(tracker).to receive(:start_timer)
+            expect(tracker).to receive(:stop_timer).ordered
+
+            expect(tracker).to receive(:current_test_path=).with(test_path).ordered
 
             expect(example).to receive(:run)
 
-            expect(tracker).to receive(:stop_timer)
+            expect(tracker).to receive(:stop_timer).ordered
 
             expect(KnapsackPro::Presenter).to receive(:global_time).and_return(global_time)
             expect(KnapsackPro).to receive(:logger).and_return(logger)

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

data/spec/knapsack_pro/tracker_spec.rb

@@ -95,10 +95,12 @@ describe KnapsackPro::Tracker do
         end
       end
 
-      it { expect(tracker.global_time).to eq 0 }
+      it { expect(tracker.global_time).to be > 0 }
       it { expect(tracker.test_files_with_time.keys.size).to eql 2 }
       it { expect(tracker.test_files_with_time['a_spec.rb'][:time_execution]).to eq 0 }
-      it { expect(tracker.test_files_with_time['b_spec.rb'][:time_execution]).to eq 0 }
+      it '2nd spec (b_spec.rb) should have recorded time execution - because start_time was set during first call of stop_timer for the first spec (a_spec.rb)' do
+        expect(tracker.test_files_with_time['b_spec.rb'][:time_execution]).to be > 0
+      end
       it_behaves_like '#to_a'
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 2.11.0
+  version: 2.16.0
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-04 00:00:00.000000000 Z
+date: 2021-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake