knapsack_pro 2.18.1 → 3.1.1

data/lib/knapsack_pro/test_case_detectors/rspec_test_example_detector.rb

@@ -1,8 +1,6 @@
 module KnapsackPro
   module TestCaseDetectors
     class RSpecTestExampleDetector
-      REPORT_DIR = "#{KnapsackPro::Config::Env::TMP_DIR}/test_case_detectors/rspec"
-
       def generate_json_report
         require 'rspec/core'
 
@@ -47,7 +45,7 @@ module KnapsackPro
       end
 
       def test_file_example_paths
-        raise "No report found at #{report_path}" unless File.exists?(report_path)
+        raise "No report found at #{report_path}" unless File.exist?(report_path)
 
         json_report = File.read(report_path)
         hash_report = JSON.parse(json_report)
@@ -69,8 +67,12 @@ module KnapsackPro
 
       private
 
+      def report_dir
+        "#{KnapsackPro::Config::TempFiles::TEMP_DIRECTORY_PATH}/test_case_detectors/rspec"
+      end
+
       def report_path
-        "#{REPORT_DIR}/rspec_dry_run_json_report_node_#{KnapsackPro::Config::Env.ci_node_index}.json"
+        "#{report_dir}/rspec_dry_run_json_report_node_#{KnapsackPro::Config::Env.ci_node_index}.json"
       end
 
       def adapter_class
@@ -86,11 +88,12 @@ module KnapsackPro
       end
 
       def ensure_report_dir_exists
-        FileUtils.mkdir_p(REPORT_DIR)
+        KnapsackPro::Config::TempFiles.ensure_temp_directory_exists!
+        FileUtils.mkdir_p(report_dir)
       end
 
       def remove_old_json_report
-        File.delete(report_path) if File.exists?(report_path)
+        File.delete(report_path) if File.exist?(report_path)
       end
 
       def test_file_hash_for(test_file_path)

data/lib/knapsack_pro/tracker.rb

@@ -6,16 +6,23 @@ module KnapsackPro
     # to better allocate it in Queue Mode for future CI build runs
     DEFAULT_TEST_FILE_TIME = 0.0 # seconds
 
-    attr_reader :global_time_since_beginning, :global_time, :test_files_with_time
+    attr_reader :global_time_since_beginning, :global_time, :test_files_with_time, :prerun_tests_loaded
     attr_writer :current_test_path
 
     def initialize
       @global_time_since_beginning = 0
+      KnapsackPro::Config::TempFiles.ensure_temp_directory_exists!
+      FileUtils.mkdir_p(tracker_dir_path)
       set_defaults
     end
 
     def reset!
       set_defaults
+
+      # Remove report only when the reset! method is called explicitly.
+      # The report should be persisted on the disk so that multiple tracker instances can share the report state.
+      # Tracker instance can be created by knapsack_pro process and a separate tracker is created by rake task (e.g., RSpec) in Regular Mode.
+      File.delete(prerun_tests_report_path) if File.exist?(prerun_tests_report_path)
     end
 
     def start_timer
@@ -54,9 +61,18 @@ module KnapsackPro
           measured_time: false,
         }
       end
+
+      save_prerun_tests_report(@test_files_with_time)
+
+      @prerun_tests_loaded = true
     end
 
     def to_a
+      # When the test files are not loaded in the memory then load them from the disk.
+      # Useful for the Regular Mode when the memory is not shared between tracker instances.
+      # Tracker instance can be created by knapsack_pro process and a separate tracker is created by rake task (e.g., RSpec)
+      load_prerun_tests unless prerun_tests_loaded
+
       test_files = []
       @test_files_with_time.each do |path, hash|
         test_files << {
@@ -73,6 +89,45 @@ module KnapsackPro
       @global_time = 0
       @test_files_with_time = {}
       @current_test_path = nil
+      @prerun_tests_loaded = false
+    end
+
+    def tracker_dir_path
+      "#{KnapsackPro::Config::TempFiles::TEMP_DIRECTORY_PATH}/tracker"
+    end
+
+    def prerun_tests_report_path
+      raise 'Test runner adapter not set. Report a bug to the Knapsack Pro support.' unless KnapsackPro::Config::Env.test_runner_adapter
+      report_name = "prerun_tests_#{KnapsackPro::Config::Env.test_runner_adapter}_node_#{KnapsackPro::Config::Env.ci_node_index}.json"
+      File.join(tracker_dir_path, report_name)
+    end
+
+    def save_prerun_tests_report(hash)
+      report_json = JSON.pretty_generate(hash)
+
+      File.open(prerun_tests_report_path, 'w+') do |f|
+        f.write(report_json)
+      end
+    end
+
+    def read_prerun_tests_report
+      raise "Report #{prerun_tests_report_path} doest not exist on the disk. Most likely, it was removed accidentally. Please report the bug to the Knapsack Pro support team at https://knapsackpro.com/contact" unless File.exist?(prerun_tests_report_path)
+      JSON.parse(File.read(prerun_tests_report_path))
+    end
+
+    def load_prerun_tests
+      read_prerun_tests_report.each do |test_file_path, hash|
+        # Load only test files that were not measured. For example,
+        # track test files assigned to CI node but never executed by test runner (e.g., pending RSpec spec files).
+        next if @test_files_with_time.key?(test_file_path)
+
+        @test_files_with_time[test_file_path] = {
+          time_execution: hash.fetch('time_execution'),
+          measured_time: hash.fetch('measured_time'),
+        }
+      end
+
+      @prerun_tests_loaded = true
     end
 
     def update_global_time(execution_time)

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '2.18.1'
+  VERSION = '3.1.1'
 end

data/lib/knapsack_pro.rb

@@ -27,6 +27,7 @@ require_relative 'knapsack_pro/config/ci/github_actions'
 require_relative 'knapsack_pro/config/ci/heroku'
 require_relative 'knapsack_pro/config/env'
 require_relative 'knapsack_pro/config/env_generator'
+require_relative 'knapsack_pro/config/temp_files'
 require_relative 'knapsack_pro/logger_wrapper'
 require_relative 'knapsack_pro/client/api/action'
 require_relative 'knapsack_pro/client/api/v1/base'

data/spec/knapsack_pro/adapters/base_adapter_spec.rb

@@ -32,14 +32,13 @@ describe KnapsackPro::Adapters::BaseAdapter do
     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' }
-
+      it { expect(subject).to eq '.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' }
+      it { expect(subject).to eq '.knapsack_pro/KnapsackPro-Adapters-BaseAdapter-bind_method_called_for_node_1.txt' }
     end
   end
 
@@ -93,18 +92,20 @@ describe KnapsackPro::Adapters::BaseAdapter do
   end
 
   describe '.verify_bind_method_called' do
+    let(:temp_directory_path) { '.knapsack_pro' }
+
     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)
+      expect(File).to receive(:exist?).with('.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')
+        expect(File).to receive(:delete).with('.knapsack_pro/KnapsackPro-Adapters-BaseAdapter-bind_method_called_for_node_0.txt')
         subject
       end
     end
@@ -120,12 +121,13 @@ describe KnapsackPro::Adapters::BaseAdapter do
   end
 
   describe '#bind' do
+    let(:temp_directory_path) { '.knapsack_pro' }
     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::TempFiles).to receive(:ensure_temp_directory_exists!)
+      expect(File).to receive(:write).with('.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?)

data/spec/knapsack_pro/adapters/rspec_adapter_spec.rb

@@ -111,7 +111,7 @@ describe KnapsackPro::Adapters::RSpecAdapter do
   end
 
   describe '.test_path' do
-    let(:current_example_metadata) do
+    let(:example_group) do
       {
         file_path: '1_shared_example.rb',
         parent_example_group: {
@@ -122,14 +122,19 @@ describe KnapsackPro::Adapters::RSpecAdapter do
         }
       }
     end
+    let(:current_example) do
+      OpenStruct.new(metadata: {
+        example_group: example_group
+      })
+    end
 
-    subject { described_class.test_path(current_example_metadata) }
+    subject { described_class.test_path(current_example) }
 
     it { should eql 'a_spec.rb' }
 
     context 'with turnip features' do
       describe 'when the turnip version is less than 2' do
-        let(:current_example_metadata) do
+        let(:example_group) do
           {
             file_path: "./spec/features/logging_in.feature",
             turnip: true,
@@ -145,7 +150,7 @@ describe KnapsackPro::Adapters::RSpecAdapter do
       end
 
       describe 'when turnip is version 2 or greater' do
-        let(:current_example_metadata) do
+        let(:example_group) do
           {
             file_path: "gems/turnip-2.0.0/lib/turnip/rspec.rb",
             turnip: true,
@@ -170,13 +175,7 @@ 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(:example) { double }
-      let(:example_group) { double }
-      let(:current_example) do
-        OpenStruct.new(metadata: {
-          example_group: example_group
-        })
-      end
+      let(:current_example) { double }
 
       context 'when rspec split by test examples is disabled' do
         before do
@@ -189,19 +188,18 @@ describe KnapsackPro::Adapters::RSpecAdapter do
           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(:around).with(:each).and_yield(current_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)
+          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(example).to receive(:run)
+          expect(current_example).to receive(:run)
 
           expect(tracker).to receive(:stop_timer).ordered
 
@@ -226,26 +224,25 @@ describe KnapsackPro::Adapters::RSpecAdapter do
           end
 
           it 'records time for example.id' do
-            expect(example).to receive(:id).and_return(test_example_path)
+            expect(current_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(:around).with(:each).and_yield(current_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)
+            expect(described_class).to receive(:test_path).with(current_example).and_return(test_path)
 
             expect(tracker).to receive(:current_test_path=).with(test_example_path).ordered
 
-            expect(example).to receive(:run)
+            expect(current_example).to receive(:run)
 
             expect(tracker).to receive(:stop_timer).ordered
 
@@ -268,19 +265,18 @@ describe KnapsackPro::Adapters::RSpecAdapter do
             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(:around).with(:each).and_yield(current_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)
+            expect(described_class).to receive(:test_path).with(current_example).and_return(test_path)
 
             expect(tracker).to receive(:stop_timer).ordered
 
             expect(tracker).to receive(:current_test_path=).with(test_path).ordered
 
-            expect(example).to receive(:run)
+            expect(current_example).to receive(:run)
 
             expect(tracker).to receive(:stop_timer).ordered
 

data/spec/knapsack_pro/config/env_spec.rb

@@ -950,4 +950,29 @@ describe KnapsackPro::Config::Env do
       it { should be_nil }
     end
   end
+
+  describe '.test_runner_adapter' do
+    subject { described_class.test_runner_adapter }
+
+    context 'when ENV exists' do
+      let(:test_runner_adapter) { 'RSpecAdapter' }
+      before { stub_const('ENV', { 'KNAPSACK_PRO_TEST_RUNNER_ADAPTER' => test_runner_adapter }) }
+      it { should eql 'RSpecAdapter' }
+    end
+
+    context "when ENV doesn't exist" do
+      it { should be_nil }
+    end
+  end
+
+  describe '.set_test_runner_adapter' do
+    let(:adapter_class) { KnapsackPro::Adapters::RSpecAdapter }
+
+    subject { described_class.set_test_runner_adapter(adapter_class) }
+
+    it 'sets test runner adapter' do
+      subject
+      expect(described_class.test_runner_adapter).to eql 'RSpecAdapter'
+    end
+  end
 end

data/spec/knapsack_pro/config/temp_files_spec.rb

@@ -0,0 +1,25 @@
+describe KnapsackPro::Config::TempFiles do
+  describe 'TEMP_DIRECTORY_PATH' do
+    subject { described_class::TEMP_DIRECTORY_PATH }
+
+    it 'returns temporary directory path' do
+      expect(subject).to eq '.knapsack_pro'
+    end
+  end
+
+  describe '.ensure_temp_directory_exists!', :clear_tmp do
+    let(:gitignore_file_path) { '.knapsack_pro/.gitignore' }
+
+    subject { described_class.ensure_temp_directory_exists! }
+
+    it 'creates .gitignore file' do
+      expect { subject }.to change { File.exist?(gitignore_file_path) }.from(false).to(true)
+    end
+
+    it '.gitignore file has correct content to ignore all files in temporary directory' do
+      subject
+
+      expect(File.read(gitignore_file_path)).to match /^\*$/
+    end
+  end
+end

data/spec/knapsack_pro/report_spec.rb

@@ -25,6 +25,8 @@ describe KnapsackPro::Report do
       subset_queue_id = 'fake-subset-queue-id'
       expect(KnapsackPro::Config::Env).to receive(:subset_queue_id).and_return(subset_queue_id)
 
+      expect(KnapsackPro::Config::TempFiles).to receive(:ensure_temp_directory_exists!)
+
       queue_id = 'fake-queue-id'
       expect(KnapsackPro::Config::Env).to receive(:queue_id).twice.and_return(queue_id)
     end
@@ -34,7 +36,7 @@ describe KnapsackPro::Report do
 
       expect(
         JSON.parse(
-          File.read('tmp/knapsack_pro/queue/fake-queue-id/fake-subset-queue-id.json')
+          File.read('.knapsack_pro/queue/fake-queue-id/fake-subset-queue-id.json')
         )
       ).to eq([
         { 'path' => fake_path }
@@ -56,7 +58,7 @@ describe KnapsackPro::Report do
         queue_id = 'fake-queue-id'
         expect(KnapsackPro::Config::Env).to receive(:queue_id).and_return(queue_id)
 
-        expect(Dir).to receive(:glob).with('tmp/knapsack_pro/queue/fake-queue-id/*.json').and_return([
+        expect(Dir).to receive(:glob).with('.knapsack_pro/queue/fake-queue-id/*.json').and_return([
           json_test_file_a_path,
           json_test_file_b_path
         ])
@@ -89,7 +91,7 @@ describe KnapsackPro::Report do
         queue_id = 'fake-queue-id'
         expect(KnapsackPro::Config::Env).to receive(:queue_id).and_return(queue_id)
 
-        expect(Dir).to receive(:glob).with('tmp/knapsack_pro/queue/fake-queue-id/*.json').and_return([
+        expect(Dir).to receive(:glob).with('.knapsack_pro/queue/fake-queue-id/*.json').and_return([
           json_test_file_a_path,
           json_test_file_b_path
         ])
@@ -102,9 +104,9 @@ describe KnapsackPro::Report do
         logger = instance_double(Logger)
         expect(KnapsackPro).to receive(:logger).exactly(4).and_return(logger)
         expect(logger).to receive(:warn).with('2 test files were executed on this CI node but the recorded time was lost due to:')
-        expect(logger).to receive(:warn).with('1. Probably you have a code (i.e. RSpec hooks) that clears tmp directory in your project. Please ensure you do not remove the content of tmp/knapsack_pro/queue/ directory between tests run.')
-        expect(logger).to receive(:warn).with('2. Another reason might be that you forgot to add Knapsack::Adapters::RSpecAdapter.bind in your rails_helper.rb or spec_helper.rb. Please follow the installation guide again: https://docs.knapsackpro.com/integration/')
-        expect(logger).to receive(:warn).with('3. All your tests are empty test files, are pending tests or have syntax error and could not be executed hence no measured time execution by knapsack_pro.')
+        expect(logger).to receive(:warn).with('1. Please ensure you do not remove the contents of the .knapsack_pro directory between tests run.')
+        expect(logger).to receive(:warn).with("2. Ensure you've added Knapsack::Adapters::RSpecAdapter.bind in your rails_helper.rb or spec_helper.rb. Please follow the installation guide again: https://docs.knapsackpro.com/integration/")
+        expect(logger).to receive(:warn).with('3. Another potential reason for this warning is that all your tests are empty test files, pending tests, or they have syntax errors, and the time execution was not recorded for them.')
 
         expect(described_class).to receive(:create_build_subset).with(
           json_test_file_a + json_test_file_b
@@ -121,15 +123,14 @@ describe KnapsackPro::Report do
         queue_id = 'fake-queue-id'
         expect(KnapsackPro::Config::Env).to receive(:queue_id).and_return(queue_id)
 
-        expect(Dir).to receive(:glob).with('tmp/knapsack_pro/queue/fake-queue-id/*.json').and_return([])
+        expect(Dir).to receive(:glob).with('.knapsack_pro/queue/fake-queue-id/*.json').and_return([])
       end
 
       it 'logs warning about reasons why no test files were executed on this CI node' do
         logger = instance_double(Logger)
-        expect(KnapsackPro).to receive(:logger).exactly(3).and_return(logger)
+        expect(KnapsackPro).to receive(:logger).exactly(2).and_return(logger)
         expect(logger).to receive(:warn).with('No test files were executed on this CI node.')
-        expect(logger).to receive(:debug).with('When you use knapsack_pro queue mode then probably reason might be that CI node was started after the test files from the queue were already executed by other CI nodes. That is why this CI node has no test files to execute.')
-        expect(logger).to receive(:debug).with("Another reason might be when your CI node failed in a way that prevented knapsack_pro to save time execution data to Knapsack Pro API and you have just tried to retry failed CI node but instead you got no test files to execute. In that case knapsack_pro don't know what tests should be executed here.")
+        expect(logger).to receive(:debug).with('This CI node likely started work late after the test files were already executed by other CI nodes consuming the queue.')
 
         expect(described_class).to receive(:create_build_subset).with([])