knapsack_pro 8.0.2 → 8.1.0

data/spec/knapsack_pro/base_allocator_builder_spec.rb

@@ -99,106 +99,4 @@ describe KnapsackPro::BaseAllocatorBuilder do
       end
     end
   end
-
-  describe '#fallback_mode_test_files' do
-    subject { allocator_builder.fallback_mode_test_files }
-
-    it do
-      test_file_pattern = double
-      expect(KnapsackPro::TestFilePattern).to receive(:call).with(adapter_class).and_return(test_file_pattern)
-
-      test_files = double
-      expect(KnapsackPro::TestFileFinder).to receive(:call).with(test_file_pattern).and_return(test_files)
-
-      expect(subject).to eq test_files
-    end
-  end
-
-  describe '#fast_and_slow_test_files_to_run' do
-    subject { allocator_builder.fast_and_slow_test_files_to_run }
-
-    context 'when split by test cases disabled' do
-      it 'returns test files to run based on test files on the disk' do
-        test_file_pattern = double
-        expect(KnapsackPro::TestFilePattern).to receive(:call).with(adapter_class).and_return(test_file_pattern)
-
-        test_files = double
-        expect(KnapsackPro::TestFileFinder).to receive(:call).with(test_file_pattern).and_return(test_files)
-
-        expect(subject).to eq test_files
-      end
-    end
-
-    context 'when split by test cases enabled' do
-      let(:test_files_to_run) { double }
-
-      before  do
-        expect(adapter_class).to receive(:split_by_test_cases_enabled?).and_return(true)
-
-        test_file_pattern = double
-        expect(KnapsackPro::TestFilePattern).to receive(:call).with(adapter_class).and_return(test_file_pattern)
-
-        expect(KnapsackPro::TestFileFinder).to receive(:call).with(test_file_pattern).and_return(test_files_to_run)
-
-        expect(allocator_builder).to receive(:get_slow_test_files).and_return(slow_test_files)
-      end
-
-      context 'when slow test files are detected' do
-        let(:slow_test_files) do
-          [
-            '1_spec.rb',
-            '2_spec.rb',
-          ]
-        end
-
-        it 'returns test files with test cases' do
-          test_file_cases = double
-          expect(adapter_class).to receive(:test_file_cases_for).with(slow_test_files).and_return(test_file_cases)
-
-          test_files_with_test_cases = double
-          expect(KnapsackPro::TestFilesWithTestCasesComposer).to receive(:call).with(test_files_to_run, slow_test_files, test_file_cases).and_return(test_files_with_test_cases)
-
-          expect(subject).to eq test_files_with_test_cases
-        end
-      end
-
-      context 'when slow test files are not detected' do
-        let(:slow_test_files) { [] }
-
-        it 'returns test files without test cases' do
-          expect(subject).to eq test_files_to_run
-        end
-      end
-    end
-  end
-
-  describe 'private #get_slow_test_files' do
-    subject { allocator_builder.send(:get_slow_test_files) }
-
-    before do
-      expect(KnapsackPro::Config::Env).to receive(:slow_test_file_pattern).and_return(slow_test_file_pattern)
-    end
-
-    context 'when slow test file pattern is present' do
-      let(:slow_test_files) { double(:slow_test_files_based_on_pattern, size: 3) }
-      let(:slow_test_file_pattern) { double }
-
-      before do
-        expect(KnapsackPro::TestFileFinder).to receive(:slow_test_files_by_pattern).with(adapter_class).and_return(slow_test_files)
-      end
-
-      it { expect(subject).to eq slow_test_files }
-    end
-
-    context 'when slow test file pattern is not present' do
-      let(:slow_test_files) { double(:slow_test_files_based_on_api, size: 2) }
-      let(:slow_test_file_pattern) { nil }
-
-      before do
-        expect(KnapsackPro::SlowTestFileFinder).to receive(:call).with(adapter_class).and_return(slow_test_files)
-      end
-
-      it { expect(subject).to eq slow_test_files }
-    end
-  end
 end

data/spec/knapsack_pro/crypto/decryptor_spec.rb

@@ -15,7 +15,9 @@ describe KnapsackPro::Crypto::Decryptor do
   let(:decryptor) { described_class.new(test_files, encrypted_test_files) }
 
   describe '.call' do
-    subject { described_class.call(test_files, encrypted_test_files) }
+    let(:test_suite) { instance_double(KnapsackPro::TestSuite, calculate_test_files: instance_double(KnapsackPro::TestSuite::Result, test_files: test_files)) }
+
+    subject { described_class.call(test_suite, encrypted_test_files) }
 
     before do
       expect(KnapsackPro::Config::Env).to receive(:test_files_encrypted?).and_return(test_files_encrypted?)

data/spec/knapsack_pro/runners/base_runner_spec.rb

@@ -12,11 +12,11 @@ describe KnapsackPro::Runners::BaseRunner do
     let(:runner) do
       described_class.new(adapter_class)
     end
-    let(:allocator) { instance_double(KnapsackPro::Allocator) }
-    let(:allocator_builder) { instance_double(KnapsackPro::AllocatorBuilder) }
+    let(:allocator) { instance_double(KnapsackPro::RegularAllocator) }
+    let(:allocator_builder) { instance_double(KnapsackPro::RegularAllocatorBuilder) }
 
     before do
-      expect(KnapsackPro::AllocatorBuilder).to receive(:new).with(adapter_class).and_return(allocator_builder)
+      expect(KnapsackPro::RegularAllocatorBuilder).to receive(:new).with(adapter_class).and_return(allocator_builder)
       expect(allocator_builder).to receive(:allocator).and_return(allocator)
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 8.0.2
+  version: 8.1.0
 platform: ruby
 authors:
 - ArturT
@@ -224,8 +224,6 @@ files:
 - lib/knapsack_pro/adapters/rspec_adapter.rb
 - lib/knapsack_pro/adapters/spinach_adapter.rb
 - lib/knapsack_pro/adapters/test_unit_adapter.rb
-- lib/knapsack_pro/allocator.rb
-- lib/knapsack_pro/allocator_builder.rb
 - lib/knapsack_pro/base_allocator_builder.rb
 - lib/knapsack_pro/batch.rb
 - lib/knapsack_pro/build_distribution_fetcher.rb
@@ -268,6 +266,8 @@ files:
 - lib/knapsack_pro/queue_allocator.rb
 - lib/knapsack_pro/queue_allocator_builder.rb
 - lib/knapsack_pro/railtie.rb
+- lib/knapsack_pro/regular_allocator.rb
+- lib/knapsack_pro/regular_allocator_builder.rb
 - lib/knapsack_pro/report.rb
 - lib/knapsack_pro/repository_adapter_initiator.rb
 - lib/knapsack_pro/repository_adapters/base_adapter.rb
@@ -295,6 +295,7 @@ files:
 - lib/knapsack_pro/test_file_presenter.rb
 - lib/knapsack_pro/test_files_with_test_cases_composer.rb
 - lib/knapsack_pro/test_flat_distributor.rb
+- lib/knapsack_pro/test_suite.rb
 - lib/knapsack_pro/tracker.rb
 - lib/knapsack_pro/urls.rb
 - lib/knapsack_pro/utils.rb
@@ -329,8 +330,6 @@ files:
 - spec/knapsack_pro/adapters/rspec_adapter_spec.rb
 - spec/knapsack_pro/adapters/spinach_adapter_spec.rb
 - spec/knapsack_pro/adapters/test_unit_adapter_spec.rb
-- spec/knapsack_pro/allocator_builder_spec.rb
-- spec/knapsack_pro/allocator_spec.rb
 - spec/knapsack_pro/base_allocator_builder_spec.rb
 - spec/knapsack_pro/build_distribution_fetcher_spec.rb
 - spec/knapsack_pro/client/api/action_spec.rb
@@ -365,8 +364,6 @@ files:
 - spec/knapsack_pro/logger_wrapper_spec.rb
 - spec/knapsack_pro/presenter_spec.rb
 - spec/knapsack_pro/pure/queue/rspec_pure_spec.rb
-- spec/knapsack_pro/queue_allocator_builder_spec.rb
-- spec/knapsack_pro/queue_allocator_spec.rb
 - spec/knapsack_pro/queue_spec.rb
 - spec/knapsack_pro/report_spec.rb
 - spec/knapsack_pro/repository_adapter_initiator_spec.rb
@@ -455,8 +452,6 @@ test_files:
 - spec/knapsack_pro/adapters/rspec_adapter_spec.rb
 - spec/knapsack_pro/adapters/spinach_adapter_spec.rb
 - spec/knapsack_pro/adapters/test_unit_adapter_spec.rb
-- spec/knapsack_pro/allocator_builder_spec.rb
-- spec/knapsack_pro/allocator_spec.rb
 - spec/knapsack_pro/base_allocator_builder_spec.rb
 - spec/knapsack_pro/build_distribution_fetcher_spec.rb
 - spec/knapsack_pro/client/api/action_spec.rb
@@ -491,8 +486,6 @@ test_files:
 - spec/knapsack_pro/logger_wrapper_spec.rb
 - spec/knapsack_pro/presenter_spec.rb
 - spec/knapsack_pro/pure/queue/rspec_pure_spec.rb
-- spec/knapsack_pro/queue_allocator_builder_spec.rb
-- spec/knapsack_pro/queue_allocator_spec.rb
 - spec/knapsack_pro/queue_spec.rb
 - spec/knapsack_pro/report_spec.rb
 - spec/knapsack_pro/repository_adapter_initiator_spec.rb

data/spec/knapsack_pro/allocator_builder_spec.rb

@@ -1,36 +0,0 @@
-describe KnapsackPro::AllocatorBuilder do
-  let(:adapter_class) { KnapsackPro::Adapters::BaseAdapter }
-  let(:allocator_builder) { described_class.new(adapter_class) }
-
-  describe '#allocator' do
-    let(:allocator) { double }
-
-    subject { allocator_builder.allocator }
-
-    before do
-      fast_and_slow_test_files_to_run = double
-      expect(allocator_builder).to receive(:fast_and_slow_test_files_to_run).and_return(fast_and_slow_test_files_to_run)
-
-      fallback_mode_test_files = double
-      expect(allocator_builder).to receive(:fallback_mode_test_files).and_return(fallback_mode_test_files)
-
-      repository_adapter = double
-      expect(KnapsackPro::RepositoryAdapterInitiator).to receive(:call).and_return(repository_adapter)
-
-      ci_node_total = double
-      expect(KnapsackPro::Config::Env).to receive(:ci_node_total).and_return(ci_node_total)
-      ci_node_index = double
-      expect(KnapsackPro::Config::Env).to receive(:ci_node_index).and_return(ci_node_index)
-
-      expect(KnapsackPro::Allocator).to receive(:new).with(
-        fast_and_slow_test_files_to_run: fast_and_slow_test_files_to_run,
-        fallback_mode_test_files: fallback_mode_test_files,
-        ci_node_total: ci_node_total,
-        ci_node_index: ci_node_index,
-        repository_adapter: repository_adapter,
-      ).and_return(allocator)
-    end
-
-    it { should eq allocator }
-  end
-end

data/spec/knapsack_pro/allocator_spec.rb

@@ -1,233 +0,0 @@
-describe KnapsackPro::Allocator do
-  let(:fast_and_slow_test_files_to_run) { double }
-  let(:fallback_mode_test_files) { double }
-  let(:ci_node_total) { double }
-  let(:ci_node_index) { double }
-  let(:repository_adapter) { instance_double(KnapsackPro::RepositoryAdapters::EnvAdapter, commit_hash: double, branch: double) }
-
-  let(:allocator) do
-    described_class.new(
-      fast_and_slow_test_files_to_run: fast_and_slow_test_files_to_run,
-      fallback_mode_test_files: fallback_mode_test_files,
-      ci_node_total: ci_node_total,
-      ci_node_index: ci_node_index,
-      repository_adapter: repository_adapter
-    )
-  end
-
-  describe '#test_file_paths' do
-    let(:response) { double }
-    let(:api_code) { nil }
-
-    subject { allocator.test_file_paths }
-
-    shared_examples_for 'when connection to API failed (fallback mode)' do
-      context 'when fallback mode is disabled' do
-        before(:each) do
-          expect(KnapsackPro::Config::Env).to receive(:fallback_mode_enabled?).and_return(false)
-        end
-
-        it 'logs the error and exits' do
-          logger = instance_double(Logger)
-          allow(KnapsackPro).to receive(:logger).and_return(logger)
-          expect(logger).to receive(:error).with(
-            'Fallback Mode was disabled with KNAPSACK_PRO_FALLBACK_MODE_ENABLED=false. Please restart this CI node to retry tests. Most likely Fallback Mode was disabled due to https://knapsackpro.com/perma/ruby/regular-mode-connection-error-with-fallback-enabled-false'
-          )
-
-          expect { subject }.to raise_error(SystemExit)
-        end
-      end
-
-      context 'when CI node retry count > 0' do
-        before(:each) do
-          expect(KnapsackPro::Config::Env).to receive(:ci_node_retry_count).and_return(1)
-        end
-
-        context 'when fixed_test_suite_split=true' do
-          before(:each) do
-            expect(KnapsackPro::Config::Env).to receive(:fixed_test_suite_split).and_return(true)
-          end
-
-          it 'logs the error and exits' do
-            logger = instance_double(Logger)
-            allow(KnapsackPro).to receive(:logger).and_return(logger)
-
-            expect(logger).to receive(:error).with(
-              'knapsack_pro gem could not connect to Knapsack Pro API and the Fallback Mode cannot be used this time. Running tests in Fallback Mode are not allowed for retried parallel CI node to avoid running the wrong set of tests. Please manually retry this parallel job on your CI server then knapsack_pro gem will try to connect to Knapsack Pro API again and will run a correct set of tests for this CI node. Learn more https://knapsackpro.com/perma/ruby/regular-mode-connection-error-with-fallback-enabled-true-and-positive-retry-count'
-            )
-
-            expect { subject }.to raise_error(SystemExit)
-          end
-        end
-
-        context 'when fixed_test_suite_split=false' do
-          before(:each) do
-            expect(KnapsackPro::Config::Env).to receive(:fixed_test_suite_split).and_return(false)
-          end
-
-          it 'logs the error and exits' do
-            logger = instance_double(Logger)
-            allow(KnapsackPro).to receive(:logger).and_return(logger)
-
-            expect(logger).to receive(:error).with(
-              'knapsack_pro gem could not connect to Knapsack Pro API and the Fallback Mode cannot be used this time. Running tests in Fallback Mode are not allowed for retried parallel CI node to avoid running the wrong set of tests. Please manually retry this parallel job on your CI server then knapsack_pro gem will try to connect to Knapsack Pro API again and will run a correct set of tests for this CI node. Learn more https://knapsackpro.com/perma/ruby/regular-mode-connection-error-with-fallback-enabled-true-and-positive-retry-count Please ensure you have set KNAPSACK_PRO_FIXED_TEST_SUITE_SPLIT=true to allow Knapsack Pro API remember the recorded CI node tests so when you retry failed tests on the CI node then the same set of tests will be executed. See more https://knapsackpro.com/perma/ruby/fixed-test-suite-split'
-            )
-
-            expect { subject }.to raise_error(SystemExit)
-          end
-        end
-      end
-
-      context 'when fallback mode started' do
-        before(:each) do
-          test_flat_distributor = instance_double(KnapsackPro::TestFlatDistributor)
-          expect(KnapsackPro::TestFlatDistributor).to receive(:new).with(fallback_mode_test_files, ci_node_total).and_return(test_flat_distributor)
-          expect(test_flat_distributor).to receive(:test_files_for_node).with(ci_node_index).and_return([
-            { 'path' => 'c_spec.rb' },
-            { 'path' => 'd_spec.rb' },
-          ])
-        end
-
-        it { should eq ['c_spec.rb', 'd_spec.rb'] }
-      end
-    end
-
-    before(:each) do
-      encrypted_branch = double
-      expect(KnapsackPro::Crypto::BranchEncryptor).to receive(:call).with(repository_adapter.branch).and_return(encrypted_branch)
-
-      action = double
-      expect(KnapsackPro::Client::API::V1::BuildDistributions).to receive(:subset).with({
-        cache_read_attempt: true,
-        commit_hash: repository_adapter.commit_hash,
-        branch: encrypted_branch,
-        node_total: ci_node_total,
-        node_index: ci_node_index,
-        test_files: nil, # when `cache_read_attempt=true`, then expect `test_files` is `nil` to make the request fast due to a small payload
-      }).and_return(action)
-
-      connection = instance_double(KnapsackPro::Client::Connection,
-                                   call: response,
-                                   success?: success?,
-                                   errors?: errors?,
-                                   api_code: api_code)
-      expect(KnapsackPro::Client::Connection).to receive(:new).with(action).and_return(connection)
-    end
-
-    context 'when successful request to API' do
-      let(:success?) { true }
-
-      context 'when response has errors' do
-        let(:errors?) { true }
-
-        it do
-          expect { subject }.to raise_error(ArgumentError)
-        end
-      end
-
-      context 'when response has no errors' do
-        let(:errors?) { false }
-
-        context 'when the response returns test files (successful attempt to read from the cache - the cached test suite split exists on the API side)' do
-          let(:response) do
-            {
-              'test_files' => [
-                { 'path' => 'a_spec.rb' },
-                { 'path' => 'b_spec.rb' },
-              ]
-            }
-          end
-
-          before(:each) do
-            expect(KnapsackPro::Crypto::Decryptor).to receive(:call).with(fast_and_slow_test_files_to_run, response['test_files']).and_call_original
-          end
-
-          it { should eq ['a_spec.rb', 'b_spec.rb'] }
-        end
-
-        context 'when the response has the API code=TEST_SUITE_SPLIT_CACHE_MISS' do
-          let(:response) do
-            { 'code' => 'TEST_SUITE_SPLIT_CACHE_MISS' }
-          end
-          let(:api_code) { 'TEST_SUITE_SPLIT_CACHE_MISS' }
-
-          before(:each) do
-            encrypted_branch = double
-            expect(KnapsackPro::Crypto::BranchEncryptor).to receive(:call).with(repository_adapter.branch).and_return(encrypted_branch)
-
-            encrypted_test_files = double
-            expect(KnapsackPro::Crypto::Encryptor).to receive(:call).with(fast_and_slow_test_files_to_run).and_return(encrypted_test_files)
-
-            # 2nd request is not an attempt to read from the cache.
-            # Try to initalize a new test suite split by sending a list of test files from the disk.
-            action = double
-            expect(KnapsackPro::Client::API::V1::BuildDistributions).to receive(:subset).with({
-              cache_read_attempt: false,
-              commit_hash: repository_adapter.commit_hash,
-              branch: encrypted_branch,
-              node_total: ci_node_total,
-              node_index: ci_node_index,
-              test_files: encrypted_test_files,
-            }).and_return(action)
-
-            connection = instance_double(KnapsackPro::Client::Connection,
-                                         call: response2,
-                                         success?: response2_success?,
-                                         errors?: response2_errors?,
-                                         api_code: nil)
-            expect(KnapsackPro::Client::Connection).to receive(:new).with(action).and_return(connection)
-          end
-
-          context 'when successful 2nd request to API' do
-            let(:response2_success?) { true }
-
-            context 'when 2nd response has errors' do
-              let(:response2_errors?) { true }
-              let(:response2) { nil }
-
-              it do
-                expect { subject }.to raise_error(ArgumentError)
-              end
-            end
-
-            context 'when 2nd response has no errors' do
-              let(:response2_errors?) { false }
-
-              context 'when 2nd response returns test files' do
-                let(:response2) do
-                  {
-                    'test_files' => [
-                      { 'path' => 'a_spec.rb' },
-                      { 'path' => 'b_spec.rb' },
-                    ]
-                  }
-                end
-
-                before(:each) do
-                  expect(KnapsackPro::Crypto::Decryptor).to receive(:call).with(fast_and_slow_test_files_to_run, response2['test_files']).and_call_original
-                end
-
-                it { should eq ['a_spec.rb', 'b_spec.rb'] }
-              end
-            end
-          end
-
-          context 'when not successful 2nd request to API' do
-            let(:response2_success?) { false }
-            let(:response2_errors?) { false }
-            let(:response2) { nil }
-
-            it_behaves_like 'when connection to API failed (fallback mode)'
-          end
-        end
-      end
-    end
-
-    context 'when not successful request to API' do
-      let(:success?) { false }
-      let(:errors?) { false }
-
-      it_behaves_like 'when connection to API failed (fallback mode)'
-    end
-  end
-end

data/spec/knapsack_pro/queue_allocator_builder_spec.rb

@@ -1,39 +0,0 @@
-describe KnapsackPro::QueueAllocatorBuilder do
-  let(:adapter_class) { KnapsackPro::Adapters::BaseAdapter }
-  let(:allocator_builder) { described_class.new(adapter_class) }
-
-  describe '#allocator' do
-    let(:allocator) { double }
-
-    subject { allocator_builder.allocator }
-
-    before do
-      fast_and_slow_test_files_to_run = double
-      expect(allocator_builder).to receive(:fast_and_slow_test_files_to_run).and_return(fast_and_slow_test_files_to_run)
-
-      fallback_mode_test_files = double
-      expect(allocator_builder).to receive(:fallback_mode_test_files).and_return(fallback_mode_test_files)
-
-      repository_adapter = double
-      expect(KnapsackPro::RepositoryAdapterInitiator).to receive(:call).and_return(repository_adapter)
-
-      ci_node_total = double
-      expect(KnapsackPro::Config::Env).to receive(:ci_node_total).and_return(ci_node_total)
-      ci_node_index = double
-      expect(KnapsackPro::Config::Env).to receive(:ci_node_index).and_return(ci_node_index)
-      ci_node_build_id = double
-      expect(KnapsackPro::Config::Env).to receive(:ci_node_build_id).and_return(ci_node_build_id)
-
-      expect(KnapsackPro::QueueAllocator).to receive(:new).with(
-        fast_and_slow_test_files_to_run: fast_and_slow_test_files_to_run,
-        fallback_mode_test_files: fallback_mode_test_files,
-        ci_node_total: ci_node_total,
-        ci_node_index: ci_node_index,
-        ci_node_build_id: ci_node_build_id,
-        repository_adapter: repository_adapter,
-      ).and_return(allocator)
-    end
-
-    it { should eq allocator }
-  end
-end