knapsack_pro 2.18.0 → 3.1.0

data/spec/knapsack_pro/runners/cucumber_runner_spec.rb

@@ -18,16 +18,20 @@ describe KnapsackPro::Runners::CucumberRunner do
       expect(ENV).to receive(:[]=).with('KNAPSACK_PRO_TEST_SUITE_TOKEN', test_suite_token_cucumber)
       expect(ENV).to receive(:[]=).with('KNAPSACK_PRO_RECORDING_ENABLED', 'true')
 
+      expect(KnapsackPro::Config::Env).to receive(:set_test_runner_adapter).with(KnapsackPro::Adapters::CucumberAdapter)
+
       expect(described_class).to receive(:new)
       .with(KnapsackPro::Adapters::CucumberAdapter).and_return(runner)
     end
 
     context 'when test files were returned by Knapsack Pro API' do
       let(:test_dir) { 'fake-test-dir' }
-      let(:stringify_test_file_paths) { 'features/fake1.scenario features/fake2.scenario' }
+      let(:test_file_paths) { ['features/fake1.scenario', 'features/fake2.scenario'] }
+      let(:stringify_test_file_paths) { test_file_paths.join(' ') }
       let(:runner) do
         instance_double(described_class,
                         test_dir: test_dir,
+                        test_file_paths: test_file_paths,
                         stringify_test_file_paths: stringify_test_file_paths,
                         test_files_to_execute_exist?: true)
       end
@@ -36,6 +40,10 @@ describe KnapsackPro::Runners::CucumberRunner do
       before do
         expect(KnapsackPro::Adapters::CucumberAdapter).to receive(:verify_bind_method_called)
 
+        tracker = instance_double(KnapsackPro::Tracker)
+        expect(KnapsackPro).to receive(:tracker).and_return(tracker)
+        expect(tracker).to receive(:set_prerun_tests).with(test_file_paths)
+
         expect(Rake::Task).to receive(:[]).with('knapsack_pro:cucumber_run').at_least(1).and_return(task)
 
         t = double

data/spec/knapsack_pro/runners/minitest_runner_spec.rb

@@ -14,12 +14,17 @@ describe KnapsackPro::Runners::MinitestRunner do
     end
 
     context 'when test files were returned by Knapsack Pro API' do
+      let(:test_file_paths) { ['test_fake/a_test.rb', 'test_fake/b_test.rb'] }
+
       before do
         expect(KnapsackPro::Adapters::MinitestAdapter).to receive(:verify_bind_method_called)
+
+        tracker = instance_double(KnapsackPro::Tracker)
+        expect(KnapsackPro).to receive(:tracker).and_return(tracker)
+        expect(tracker).to receive(:set_prerun_tests).with(test_file_paths)
       end
 
       it 'runs tests' do
-        test_file_paths = ['test_fake/a_test.rb', 'test_fake/b_test.rb']
         runner = instance_double(described_class,
                                  test_dir: 'test',
                                  test_file_paths: test_file_paths,

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

@@ -19,6 +19,8 @@ describe KnapsackPro::Runners::Queue::CucumberRunner do
       expect(ENV).to receive(:[]=).with('KNAPSACK_PRO_QUEUE_RECORDING_ENABLED', 'true')
       expect(ENV).to receive(:[]=).with('KNAPSACK_PRO_QUEUE_ID', queue_id)
 
+      expect(KnapsackPro::Config::Env).to receive(:set_test_runner_adapter).with(KnapsackPro::Adapters::CucumberAdapter)
+
       expect(described_class).to receive(:new).with(KnapsackPro::Adapters::CucumberAdapter).and_return(runner)
     end
 

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

@@ -19,6 +19,8 @@ describe KnapsackPro::Runners::Queue::MinitestRunner do
       expect(ENV).to receive(:[]=).with('KNAPSACK_PRO_QUEUE_RECORDING_ENABLED', 'true')
       expect(ENV).to receive(:[]=).with('KNAPSACK_PRO_QUEUE_ID', queue_id)
 
+      expect(KnapsackPro::Config::Env).to receive(:set_test_runner_adapter).with(KnapsackPro::Adapters::MinitestAdapter)
+
       expect(described_class).to receive(:new).with(KnapsackPro::Adapters::MinitestAdapter).and_return(runner)
 
       expect($LOAD_PATH).to receive(:unshift).with(test_dir)

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

@@ -26,6 +26,8 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
       expect(ENV).to receive(:[]=).with('KNAPSACK_PRO_QUEUE_RECORDING_ENABLED', 'true')
       expect(ENV).to receive(:[]=).with('KNAPSACK_PRO_QUEUE_ID', queue_id)
 
+      expect(KnapsackPro::Config::Env).to receive(:set_test_runner_adapter).with(KnapsackPro::Adapters::RSpecAdapter)
+
       expect(described_class).to receive(:new).with(KnapsackPro::Adapters::RSpecAdapter).and_return(runner)
     end
 

data/spec/knapsack_pro/runners/rspec_runner_spec.rb

@@ -18,16 +18,20 @@ describe KnapsackPro::Runners::RSpecRunner do
       expect(ENV).to receive(:[]=).with('KNAPSACK_PRO_TEST_SUITE_TOKEN', test_suite_token_rspec)
       expect(ENV).to receive(:[]=).with('KNAPSACK_PRO_RECORDING_ENABLED', 'true')
 
+      expect(KnapsackPro::Config::Env).to receive(:set_test_runner_adapter).with(KnapsackPro::Adapters::RSpecAdapter)
+
       expect(described_class).to receive(:new)
       .with(KnapsackPro::Adapters::RSpecAdapter).and_return(runner)
     end
 
     context 'when test files were returned by Knapsack Pro API' do
       let(:test_dir) { 'fake-test-dir' }
-      let(:stringify_test_file_paths) { "spec/a_spec.rb spec/b_spec.rb[1:1]" }
+      let(:test_file_paths) { ['spec/a_spec.rb', 'spec/b_spec.rb[1:1]'] }
+      let(:stringify_test_file_paths) { test_file_paths.join(' ') }
       let(:runner) do
         instance_double(described_class,
                         test_dir: test_dir,
+                        test_file_paths: test_file_paths,
                         stringify_test_file_paths: stringify_test_file_paths,
                         test_files_to_execute_exist?: true)
       end
@@ -37,6 +41,10 @@ describe KnapsackPro::Runners::RSpecRunner do
         expect(KnapsackPro::Adapters::RSpecAdapter).to receive(:verify_bind_method_called).ordered
         expect(KnapsackPro::Adapters::RSpecAdapter).to receive(:ensure_no_tag_option_when_rspec_split_by_test_examples_enabled!).with(['--profile', '--color']).ordered
 
+        tracker = instance_double(KnapsackPro::Tracker)
+        expect(KnapsackPro).to receive(:tracker).and_return(tracker)
+        expect(tracker).to receive(:set_prerun_tests).with(test_file_paths)
+
         expect(Rake::Task).to receive(:[]).with('knapsack_pro:rspec_run').at_least(1).and_return(task)
 
         t = double

data/spec/knapsack_pro/runners/spinach_runner_spec.rb

@@ -11,16 +11,20 @@ describe KnapsackPro::Runners::SpinachRunner do
     before do
       stub_const("ENV", { 'KNAPSACK_PRO_TEST_SUITE_TOKEN_SPINACH' => 'spinach-token' })
 
+      expect(KnapsackPro::Config::Env).to receive(:set_test_runner_adapter).with(KnapsackPro::Adapters::SpinachAdapter)
+
       expect(described_class).to receive(:new)
       .with(KnapsackPro::Adapters::SpinachAdapter).and_return(runner)
     end
 
     context 'when test files were returned by Knapsack Pro API' do
-      let(:stringify_test_file_paths) { 'features/a.feature features/b.feature' }
+      let(:test_file_paths) { ['features/a.feature', 'features/b.feature'] }
+      let(:stringify_test_file_paths) { test_file_paths.join(' ') }
       let(:test_dir) { 'fake-test-dir' }
       let(:runner) do
         instance_double(described_class,
                         test_dir: test_dir,
+                        test_file_paths: test_file_paths,
                         stringify_test_file_paths: stringify_test_file_paths,
                         test_files_to_execute_exist?: true)
       end
@@ -29,6 +33,10 @@ describe KnapsackPro::Runners::SpinachRunner do
       before do
         expect(KnapsackPro::Adapters::SpinachAdapter).to receive(:verify_bind_method_called)
 
+        tracker = instance_double(KnapsackPro::Tracker)
+        expect(KnapsackPro).to receive(:tracker).and_return(tracker)
+        expect(tracker).to receive(:set_prerun_tests).with(test_file_paths)
+
         expect(Kernel).to receive(:system).with('KNAPSACK_PRO_RECORDING_ENABLED=true KNAPSACK_PRO_TEST_SUITE_TOKEN=spinach-token bundle exec spinach --custom-arg --features_path fake-test-dir -- features/a.feature features/b.feature')
 
         allow(described_class).to receive(:child_status).and_return(child_status)

data/spec/knapsack_pro/runners/test_unit_runner_spec.rb

@@ -13,10 +13,15 @@ describe KnapsackPro::Runners::TestUnitRunner do
     end
 
     context 'when test files were returned by Knapsack Pro API' do
+      let(:test_file_paths) { ['test-unit_fake/a_test.rb', 'test-unit_fake/b_test.rb'] }
+
       it 'runs tests' do
         expect(KnapsackPro::Adapters::TestUnitAdapter).to receive(:verify_bind_method_called)
 
-        test_file_paths = ['test-unit_fake/a_test.rb', 'test-unit_fake/b_test.rb']
+        tracker = instance_double(KnapsackPro::Tracker)
+        expect(KnapsackPro).to receive(:tracker).and_return(tracker)
+        expect(tracker).to receive(:set_prerun_tests).with(test_file_paths)
+
         runner = instance_double(described_class,
                                  test_dir: 'test-unit_fake',
                                  test_file_paths: test_file_paths,

data/spec/knapsack_pro/slow_test_file_determiner_spec.rb

@@ -27,7 +27,7 @@ describe KnapsackPro::SlowTestFileDeterminer do
   end
 
   describe '.save_to_json_report', :clear_tmp do
-    let(:json_report_path) { 'tmp/knapsack_pro/slow_test_file_determiner/slow_test_files_node_0.json' }
+    let(:json_report_path) { '.knapsack_pro/slow_test_file_determiner/slow_test_files_node_0.json' }
     let(:test_files) do
       [
         { 'path' => 'a_spec.rb', 'time_execution' => 1.0 },
@@ -67,7 +67,7 @@ describe KnapsackPro::SlowTestFileDeterminer do
 
     context 'when json report does not exist' do
       it do
-        expect { subject }.to raise_error(RuntimeError, 'Report with slow test files was not generated yet. If you have enabled split by test cases https://github.com/KnapsackPro/knapsack_pro-ruby#split-test-files-by-test-cases and you see this error it means that your tests accidentally cleaned up tmp/knapsack_pro directory. Please do not remove this directory during tests runtime!')
+        expect { subject }.to raise_error(RuntimeError, 'The report with slow test files has not been generated yet. If you have enabled split by test cases https://github.com/KnapsackPro/knapsack_pro-ruby#split-test-files-by-test-cases and you see this error it means that your tests accidentally cleaned up the .knapsack_pro directory. Please do not remove this directory during tests runtime!')
       end
     end
   end

data/spec/knapsack_pro/test_case_detectors/rspec_test_example_detector_spec.rb

@@ -1,15 +1,17 @@
 describe KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector do
-  let(:report_dir) { 'tmp/knapsack_pro/test_case_detectors/rspec' }
-  let(:report_path) { 'tmp/knapsack_pro/test_case_detectors/rspec/rspec_dry_run_json_report_node_0.json' }
+  let(:report_dir) { '.knapsack_pro/test_case_detectors/rspec' }
+  let(:report_path) { '.knapsack_pro/test_case_detectors/rspec/rspec_dry_run_json_report_node_0.json' }
   let(:rspec_test_example_detector) { described_class.new }
 
   describe '#generate_json_report' do
     subject { rspec_test_example_detector.generate_json_report }
 
     before do
+      expect(KnapsackPro::Config::TempFiles).to receive(:ensure_temp_directory_exists!)
+
       expect(FileUtils).to receive(:mkdir_p).with(report_dir)
 
-      expect(File).to receive(:exists?).with(report_path).and_return(true)
+      expect(File).to receive(:exist?).with(report_path).and_return(true)
       expect(File).to receive(:delete).with(report_path)
 
       expect(rspec_test_example_detector).to receive(:slow_test_files).and_return(test_file_entities)
@@ -95,7 +97,7 @@ describe KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector do
 
     context 'when JSON report exists' do
       it do
-        expect(File).to receive(:exists?).with(report_path).and_return(true)
+        expect(File).to receive(:exist?).with(report_path).and_return(true)
 
         json_file = {
           'examples' => [
@@ -114,9 +116,9 @@ describe KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector do
 
     context 'when JSON report does not exist' do
       it do
-        expect(File).to receive(:exists?).with(report_path).and_return(false)
+        expect(File).to receive(:exist?).with(report_path).and_return(false)
 
-        expect { subject }.to raise_error(RuntimeError, 'No report found at tmp/knapsack_pro/test_case_detectors/rspec/rspec_dry_run_json_report_node_0.json')
+        expect { subject }.to raise_error(RuntimeError, "No report found at .knapsack_pro/test_case_detectors/rspec/rspec_dry_run_json_report_node_0.json")
       end
     end
   end

data/spec/knapsack_pro/tracker_spec.rb

@@ -1,11 +1,18 @@
 shared_examples 'default trakcer attributes' do
   it { expect(tracker.global_time).to eql 0 }
   it { expect(tracker.test_files_with_time).to eql({}) }
+  it { expect(tracker.prerun_tests_loaded).to be false }
 end
 
 describe KnapsackPro::Tracker do
+  let(:adapter) { 'RSpecAdapter' }
   let(:tracker) { described_class.send(:new) }
 
+  before do
+    allow(KnapsackPro::Config::Env).to receive(:test_runner_adapter).and_return(adapter)
+    allow(KnapsackPro::Config::Env).to receive(:ci_node_index).and_return(0)
+  end
+
   it_behaves_like 'default trakcer attributes'
 
   describe '#current_test_path' do
@@ -34,6 +41,10 @@ describe KnapsackPro::Tracker do
     let(:test_paths) { ['a_spec.rb', 'b_spec.rb'] }
     let(:delta) { 0.02 }
 
+    before do
+      tracker.set_prerun_tests(test_paths)
+    end
+
     shared_examples '#to_a' do
       subject { tracker.to_a }
 
@@ -55,13 +66,14 @@ describe KnapsackPro::Tracker do
       end
 
       it { expect(tracker.global_time).to be_within(delta).of(0.3) }
+      it { expect(tracker.prerun_tests_loaded).to be true }
       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 be_within(delta).of(0.1) }
       it { expect(tracker.test_files_with_time['b_spec.rb'][:time_execution]).to be_within(delta).of(0.2) }
       it_behaves_like '#to_a'
     end
 
-    context "with Timecop - Timecop shouldn't have impact on measured test time" do
+    context "with Timecop - Timecop shouldn't have impact on the measured test time" do
       let(:now) { Time.now }
 
       before do
@@ -80,6 +92,7 @@ describe KnapsackPro::Tracker do
 
       it { expect(tracker.global_time).to be > 0 }
       it { expect(tracker.global_time).to be_within(delta).of(0) }
+      it { expect(tracker.prerun_tests_loaded).to be true }
       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 be_within(delta).of(0) }
       it { expect(tracker.test_files_with_time['b_spec.rb'][:time_execution]).to be_within(delta).of(0) }
@@ -96,6 +109,7 @@ describe KnapsackPro::Tracker do
       end
 
       it { expect(tracker.global_time).to be > 0 }
+      it { expect(tracker.prerun_tests_loaded).to be true }
       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 '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
@@ -103,15 +117,62 @@ describe KnapsackPro::Tracker do
       end
       it_behaves_like '#to_a'
     end
+
+    context 'when a new tracker instance is created' do
+      let(:non_pending_test_paths) { ['a_spec.rb', 'b_spec.rb'] }
+      let(:test_paths) { non_pending_test_paths + ['pending_spec.rb'] }
+
+      before do
+        # measure tests only for non pending tests
+        non_pending_test_paths.each_with_index do |test_path, index|
+          tracker.current_test_path = test_path
+          tracker.start_timer
+          sleep index.to_f / 10 + 0.1
+          tracker.stop_timer
+        end
+      end
+
+      it '2nd tracker instance loads prerun tests from the disk' do
+        expect(tracker.prerun_tests_loaded).to be true
+        expect(tracker.to_a.size).to eq 3
+        expect(tracker.to_a[0][:path]).to eq 'a_spec.rb'
+        expect(tracker.to_a[0][:time_execution]).to be >= 0
+        expect(tracker.to_a[1][:path]).to eq 'b_spec.rb'
+        expect(tracker.to_a[1][:time_execution]).to be >= 0
+        expect(tracker.to_a[2][:path]).to eq 'pending_spec.rb'
+        expect(tracker.to_a[2][:time_execution]).to eq 0
+
+        tracker2 = described_class.send(:new)
+        expect(tracker2.prerun_tests_loaded).to be false
+        expect(tracker2.to_a.size).to eq 3
+        expect(tracker2.to_a[0][:path]).to eq 'a_spec.rb'
+        expect(tracker2.to_a[0][:time_execution]).to be >= 0
+        expect(tracker2.to_a[1][:path]).to eq 'b_spec.rb'
+        expect(tracker2.to_a[1][:time_execution]).to be >= 0
+        expect(tracker2.to_a[2][:path]).to eq 'pending_spec.rb'
+        expect(tracker2.to_a[2][:time_execution]).to eq 0
+        expect(tracker2.prerun_tests_loaded).to be true
+      end
+    end
   end
 
   describe '#reset!' do
+    let(:test_file_path) { 'a_spec.rb' }
+
     before do
-      tracker.current_test_path = 'a_spec.rb'
+      tracker.set_prerun_tests([test_file_path])
+    end
+
+    before do
+      expect(tracker.prerun_tests_loaded).to be true
+
+      tracker.current_test_path = test_file_path
       tracker.start_timer
       sleep 0.1
       tracker.stop_timer
+
       expect(tracker.global_time).not_to eql 0
+
       tracker.reset!
     end
 
@@ -120,5 +181,9 @@ describe KnapsackPro::Tracker do
     it "global time since beginning won't be reset" do
       expect(tracker.global_time_since_beginning).to be >= 0.1
     end
+
+    it 'resets prerun_tests_loaded to false' do
+      expect(tracker.prerun_tests_loaded).to be false
+    end
   end
 end

data/spec/spec_helper.rb

@@ -16,6 +16,8 @@ require 'knapsack_pro'
 
 Dir["#{KnapsackPro.root}/spec/{support,fixtures}/**/*.rb"].each { |f| require f }
 
+KNAPSACK_PRO_TMP_DIR = File.join(KnapsackPro.root, '.knapsack_pro')
+
 RSpec.configure do |config|
   config.order = :random
   config.mock_with :rspec do |mocks|
@@ -29,13 +31,14 @@ RSpec.configure do |config|
 
   config.before(:each) do
     if RSpec.current_example.metadata[:clear_tmp]
-      FileUtils.mkdir_p(File.join(KnapsackPro.root, 'tmp'))
+      FileUtils.rm_r(KNAPSACK_PRO_TMP_DIR) if File.exist?(KNAPSACK_PRO_TMP_DIR)
+      FileUtils.mkdir_p(KNAPSACK_PRO_TMP_DIR)
     end
   end
 
   config.after(:each) do
     if RSpec.current_example.metadata[:clear_tmp]
-      FileUtils.rm_r(File.join(KnapsackPro.root, 'tmp'))
+      FileUtils.rm_r(KNAPSACK_PRO_TMP_DIR) if File.exist?(KNAPSACK_PRO_TMP_DIR)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 2.18.0
+  version: 3.1.0
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-08 00:00:00.000000000 Z
+date: 2021-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -45,9 +45,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -55,9 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.10.0
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -239,6 +233,7 @@ files:
 - lib/knapsack_pro/config/ci/travis.rb
 - lib/knapsack_pro/config/env.rb
 - lib/knapsack_pro/config/env_generator.rb
+- lib/knapsack_pro/config/temp_files.rb
 - lib/knapsack_pro/crypto/branch_encryptor.rb
 - lib/knapsack_pro/crypto/decryptor.rb
 - lib/knapsack_pro/crypto/digestor.rb
@@ -334,6 +329,7 @@ files:
 - spec/knapsack_pro/config/ci/travis_spec.rb
 - spec/knapsack_pro/config/env_generator_spec.rb
 - spec/knapsack_pro/config/env_spec.rb
+- spec/knapsack_pro/config/temp_files_spec.rb
 - spec/knapsack_pro/crypto/branch_encryptor_spec.rb
 - spec/knapsack_pro/crypto/decryptor_spec.rb
 - spec/knapsack_pro/crypto/digestor_spec.rb
@@ -409,7 +405,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Knapsack Pro splits tests across parallel CI nodes and ensures each parallel
@@ -455,6 +451,7 @@ test_files:
 - spec/knapsack_pro/config/ci/travis_spec.rb
 - spec/knapsack_pro/config/env_generator_spec.rb
 - spec/knapsack_pro/config/env_spec.rb
+- spec/knapsack_pro/config/temp_files_spec.rb
 - spec/knapsack_pro/crypto/branch_encryptor_spec.rb
 - spec/knapsack_pro/crypto/decryptor_spec.rb
 - spec/knapsack_pro/crypto/digestor_spec.rb