knapsack_pro 2.10.1 → 2.15.0

data/lib/knapsack_pro/adapters/base_adapter.rb

@@ -4,6 +4,11 @@ module KnapsackPro
       # Just example, please overwrite constant in subclass
       TEST_DIR_PATTERN = 'test/**{,/*/**}/*_test.rb'
 
+      def self.adapter_bind_method_called_file
+        adapter_name = self.to_s.gsub('::', '-')
+        "#{KnapsackPro::Config::Env::TMP_DIR}/#{adapter_name}-bind_method_called_for_node_#{KnapsackPro::Config::Env.ci_node_index}.txt"
+      end
+
       def self.slow_test_file?(adapter_class, test_file_path)
         @slow_test_file_paths ||=
           begin
@@ -26,7 +31,24 @@ module KnapsackPro
         adapter
       end
 
+      def self.verify_bind_method_called
+        ::Kernel.at_exit do
+          if File.exists?(adapter_bind_method_called_file)
+            File.delete(adapter_bind_method_called_file)
+          else
+            puts "\n\n"
+            KnapsackPro.logger.error('-'*10 + ' Configuration error ' + '-'*50)
+            KnapsackPro.logger.error("You forgot to call #{self}.bind method in your test runner configuration file. It is needed to record test files time execution. Please follow the installation guide to configure your project properly https://docs.knapsackpro.com/knapsack_pro-ruby/guide/")
+            KnapsackPro.logger.error("If you already have #{self}.bind method added and you still see this error then one of your tests must had to delete tmp/knapsack_pro directory from the disk accidentally. Please ensure you do not remove tmp/knapsack_pro directory: https://knapsackpro.com/faq/question/why-all-test-files-have-01s-time-execution-for-my-ci-build-in-user-dashboard")
+            Kernel.exit(1)
+          end
+        end
+      end
+
       def bind
+        FileUtils.mkdir_p(KnapsackPro::Config::Env::TMP_DIR)
+        File.write(self.class.adapter_bind_method_called_file, nil)
+
         if KnapsackPro::Config::Env.recording_enabled?
           KnapsackPro.logger.debug('Test suite time execution recording enabled.')
           bind_time_tracker

data/lib/knapsack_pro/adapters/rspec_adapter.rb

@@ -21,6 +21,10 @@ 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|
             current_example_group =
               if ::RSpec.respond_to?(:current_example)
@@ -38,10 +42,10 @@ module KnapsackPro
                 current_test_path
               end
 
-            KnapsackPro.tracker.start_timer
-
             example.run
+          end
 
+          config.append_after(:context) do
             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/config/env.rb

@@ -8,6 +8,7 @@ module KnapsackPro
         'info'  => ::Logger::INFO,
         'debug' => ::Logger::DEBUG,
       }
+      TMP_DIR = 'tmp/knapsack_pro'
 
       class << self
         def ci_node_total

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

@@ -80,7 +80,7 @@ module KnapsackPro
 
     def self.queue_path
       queue_id = KnapsackPro::Config::Env.queue_id
-      "tmp/knapsack_pro/queue/#{queue_id}"
+      "#{KnapsackPro::Config::Env::TMP_DIR}/queue/#{queue_id}"
     end
   end
 end

data/lib/knapsack_pro/runners/cucumber_runner.rb

@@ -5,9 +5,12 @@ module KnapsackPro
         ENV['KNAPSACK_PRO_TEST_SUITE_TOKEN'] = KnapsackPro::Config::Env.test_suite_token_cucumber
         ENV['KNAPSACK_PRO_RECORDING_ENABLED'] = 'true'
 
-        runner = new(KnapsackPro::Adapters::CucumberAdapter)
+        adapter_class = KnapsackPro::Adapters::CucumberAdapter
+        runner = new(adapter_class)
 
         if runner.test_files_to_execute_exist?
+          adapter_class.verify_bind_method_called
+
           require 'cucumber/rake/task'
 
           task_name = 'knapsack_pro:cucumber_run'

data/lib/knapsack_pro/runners/minitest_runner.rb

@@ -5,9 +5,12 @@ module KnapsackPro
         ENV['KNAPSACK_PRO_TEST_SUITE_TOKEN'] = KnapsackPro::Config::Env.test_suite_token_minitest
         ENV['KNAPSACK_PRO_RECORDING_ENABLED'] = 'true'
 
-        runner = new(KnapsackPro::Adapters::MinitestAdapter)
+        adapter_class = KnapsackPro::Adapters::MinitestAdapter
+        runner = new(adapter_class)
 
         if runner.test_files_to_execute_exist?
+          adapter_class.verify_bind_method_called
+
           task_name = 'knapsack_pro:minitest_run'
 
           if Rake::Task.task_defined?(task_name)

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

@@ -39,6 +39,10 @@ module KnapsackPro
           )
 
           if test_file_paths.empty?
+            unless all_test_file_paths.empty?
+              KnapsackPro::Adapters::CucumberAdapter.verify_bind_method_called
+            end
+
             KnapsackPro::Hooks::Queue.call_after_queue
 
             KnapsackPro::Report.save_node_queue_to_api

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

@@ -46,6 +46,10 @@ module KnapsackPro
           )
 
           if test_file_paths.empty?
+            unless all_test_file_paths.empty?
+              KnapsackPro::Adapters::MinitestAdapter.verify_bind_method_called
+            end
+
             KnapsackPro::Hooks::Queue.call_after_queue
 
             KnapsackPro::Report.save_node_queue_to_api

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,
           ]
@@ -53,6 +59,8 @@ module KnapsackPro
 
           if test_file_paths.empty?
             unless all_test_file_paths.empty?
+              KnapsackPro::Adapters::RSpecAdapter.verify_bind_method_called
+
               KnapsackPro::Formatters::RSpecQueueSummaryFormatter.print_summary
               KnapsackPro::Formatters::RSpecQueueProfileFormatterExtension.print_summary
 
@@ -146,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/runners/rspec_runner.rb

@@ -5,9 +5,12 @@ module KnapsackPro
         ENV['KNAPSACK_PRO_TEST_SUITE_TOKEN'] = KnapsackPro::Config::Env.test_suite_token_rspec
         ENV['KNAPSACK_PRO_RECORDING_ENABLED'] = 'true'
 
-        runner = new(KnapsackPro::Adapters::RSpecAdapter)
+        adapter_class = KnapsackPro::Adapters::RSpecAdapter
+        runner = new(adapter_class)
 
         if runner.test_files_to_execute_exist?
+          adapter_class.verify_bind_method_called
+
           require 'rspec/core/rake_task'
 
           task_name = 'knapsack_pro:rspec_run'

data/lib/knapsack_pro/runners/spinach_runner.rb

@@ -4,9 +4,12 @@ module KnapsackPro
       def self.run(args)
         ENV['KNAPSACK_PRO_TEST_SUITE_TOKEN'] = KnapsackPro::Config::Env.test_suite_token_spinach
 
-        runner = new(KnapsackPro::Adapters::SpinachAdapter)
+        adapter_class = KnapsackPro::Adapters::SpinachAdapter
+        runner = new(adapter_class)
 
         if runner.test_files_to_execute_exist?
+          adapter_class.verify_bind_method_called
+
           cmd = %Q[KNAPSACK_PRO_RECORDING_ENABLED=true KNAPSACK_PRO_TEST_SUITE_TOKEN=#{ENV['KNAPSACK_PRO_TEST_SUITE_TOKEN']} bundle exec spinach #{args} --features_path #{runner.test_dir} -- #{runner.stringify_test_file_paths}]
 
           Kernel.system(cmd)

data/lib/knapsack_pro/runners/test_unit_runner.rb

@@ -5,9 +5,12 @@ module KnapsackPro
         ENV['KNAPSACK_PRO_TEST_SUITE_TOKEN'] = KnapsackPro::Config::Env.test_suite_token_test_unit
         ENV['KNAPSACK_PRO_RECORDING_ENABLED'] = 'true'
 
-        runner = new(KnapsackPro::Adapters::TestUnitAdapter)
+        adapter_class = KnapsackPro::Adapters::TestUnitAdapter
+        runner = new(adapter_class)
 
         if runner.test_files_to_execute_exist?
+          adapter_class.verify_bind_method_called
+
           require 'test/unit'
 
           cli_args =

data/lib/knapsack_pro/slow_test_file_determiner.rb

@@ -1,7 +1,7 @@
 module KnapsackPro
   class SlowTestFileDeterminer
     TIME_THRESHOLD_PER_CI_NODE = 0.7 # 70%
-    REPORT_DIR = 'tmp/knapsack_pro/slow_test_file_determiner'
+    REPORT_DIR = "#{KnapsackPro::Config::Env::TMP_DIR}/slow_test_file_determiner"
 
     # test_files: { 'path' => 'a_spec.rb', 'time_execution' => 0.0 }
     # time_execution: of build distribution (total time of CI build run)

data/lib/knapsack_pro/test_case_detectors/rspec_test_example_detector.rb

@@ -1,7 +1,7 @@
 module KnapsackPro
   module TestCaseDetectors
     class RSpecTestExampleDetector
-      REPORT_DIR = 'tmp/knapsack_pro/test_case_detectors/rspec'
+      REPORT_DIR = "#{KnapsackPro::Config::Env::TMP_DIR}/test_case_detectors/rspec"
 
       def generate_json_report
         require 'rspec/core'

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
@@ -24,14 +24,18 @@ module KnapsackPro
 
     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)
+        @current_test_path = nil
+      end
+
       execution_time
     end
 
     def current_test_path
-      raise("current_test_path needs to be set by Knapsack Pro Adapter's bind method") unless @current_test_path
-      KnapsackPro::TestFileCleaner.clean(@current_test_path)
+      KnapsackPro::TestFileCleaner.clean(@current_test_path) if @current_test_path
     end
 
     def set_prerun_tests(test_file_paths)
@@ -63,7 +67,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.10.1'
+  VERSION = '2.15.0'
 end

data/spec/knapsack_pro/adapters/base_adapter_spec.rb

@@ -22,6 +22,27 @@ describe KnapsackPro::Adapters::BaseAdapter do
     end
   end
 
+  describe '.adapter_bind_method_called_file' do
+    subject { described_class.adapter_bind_method_called_file }
+
+    before do
+      expect(KnapsackPro::Config::Env).to receive(:ci_node_index).and_return(ci_node_index)
+    end
+
+    context 'when CI node index 0' do
+      let(:ci_node_index) { 0 }
+
+      it { expect(subject).to eq 'tmp/knapsack_pro/KnapsackPro-Adapters-BaseAdapter-bind_method_called_for_node_0.txt' }
+
+    end
+
+    context 'when CI node index 1' do
+      let(:ci_node_index) { 1 }
+
+      it { expect(subject).to eq 'tmp/knapsack_pro/KnapsackPro-Adapters-BaseAdapter-bind_method_called_for_node_1.txt' }
+    end
+  end
+
   describe '.slow_test_file?' do
     let(:adapter_class) { double }
     let(:slow_test_files) do
@@ -71,11 +92,41 @@ describe KnapsackPro::Adapters::BaseAdapter do
     it { should eql adapter }
   end
 
+  describe '.verify_bind_method_called' do
+    subject { described_class.verify_bind_method_called }
+
+    before do
+      expect(::Kernel).to receive(:at_exit).and_yield
+      expect(File).to receive(:exists?).with('tmp/knapsack_pro/KnapsackPro-Adapters-BaseAdapter-bind_method_called_for_node_0.txt').and_return(adapter_bind_method_called_file_exists)
+    end
+
+    context 'when adapter bind method called' do
+      let(:adapter_bind_method_called_file_exists) { true }
+
+      it do
+        expect(File).to receive(:delete).with('tmp/knapsack_pro/KnapsackPro-Adapters-BaseAdapter-bind_method_called_for_node_0.txt')
+        subject
+      end
+    end
+
+    context 'when adapter bind method was not call' do
+      let(:adapter_bind_method_called_file_exists) { false }
+
+      it do
+        expect(Kernel).to receive(:exit).with(1)
+        subject
+      end
+    end
+  end
+
   describe '#bind' do
     let(:recording_enabled?) { false }
     let(:queue_recording_enabled?) { false }
 
     before do
+      expect(FileUtils).to receive(:mkdir_p).with('tmp/knapsack_pro')
+      expect(File).to receive(:write).with('tmp/knapsack_pro/KnapsackPro-Adapters-BaseAdapter-bind_method_called_for_node_0.txt', nil)
+
       expect(KnapsackPro::Config::Env).to receive(:recording_enabled?).and_return(recording_enabled?)
       expect(KnapsackPro::Config::Env).to receive(:queue_recording_enabled?).and_return(queue_recording_enabled?)
     end

data/spec/knapsack_pro/adapters/rspec_adapter_spec.rb

@@ -86,7 +86,9 @@ describe KnapsackPro::Adapters::RSpecAdapter do
         end
 
         it 'records time for current test path' do
+          expect(config).to receive(:prepend_before).with(:context).and_yield
           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)
 
@@ -94,12 +96,12 @@ describe KnapsackPro::Adapters::RSpecAdapter do
           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(:start_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)
@@ -124,7 +126,9 @@ 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
             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)
 
@@ -132,12 +136,12 @@ describe KnapsackPro::Adapters::RSpecAdapter do
             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(:start_timer).ordered
+            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,7 +157,9 @@ describe KnapsackPro::Adapters::RSpecAdapter do
           end
 
           it 'records time for current test path' do
+            expect(config).to receive(:prepend_before).with(:context).and_yield
             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)
 
@@ -161,12 +167,12 @@ describe KnapsackPro::Adapters::RSpecAdapter do
             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(:start_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)