knapsack_pro 1.20.2 → 1.21.0

data/spec/knapsack_pro/config/env_spec.rb

@@ -183,6 +183,20 @@ describe KnapsackPro::Config::Env do
     end
   end
 
+  describe '.slow_test_file_pattern' do
+    subject { described_class.slow_test_file_pattern }
+
+    context 'when ENV exists' do
+      let(:slow_test_file_pattern) { 'spec/features/*_spec.rb' }
+      before { stub_const("ENV", { 'KNAPSACK_PRO_SLOW_TEST_FILE_PATTERN' => slow_test_file_pattern }) }
+      it { should eq slow_test_file_pattern }
+    end
+
+    context "when ENV doesn't exist" do
+      it { should be_nil }
+    end
+  end
+
   describe '.test_file_exclude_pattern' do
     subject { described_class.test_file_exclude_pattern }
 

data/spec/knapsack_pro/queue_allocator_builder_spec.rb

@@ -8,8 +8,11 @@ describe KnapsackPro::QueueAllocatorBuilder do
     subject { allocator_builder.allocator }
 
     before do
-      test_files = double
-      expect(allocator_builder).to receive(:test_files).and_return(test_files)
+      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)
@@ -22,7 +25,8 @@ describe KnapsackPro::QueueAllocatorBuilder do
       expect(KnapsackPro::Config::Env).to receive(:ci_node_build_id).and_return(ci_node_build_id)
 
       expect(KnapsackPro::QueueAllocator).to receive(:new).with(
-        test_files: test_files,
+        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,

data/spec/knapsack_pro/queue_allocator_spec.rb

@@ -1,5 +1,6 @@
 describe KnapsackPro::QueueAllocator do
-  let(:test_files) { double }
+  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(:ci_node_build_id) { double }
@@ -7,7 +8,8 @@ describe KnapsackPro::QueueAllocator do
 
   let(:queue_allocator) do
     described_class.new(
-      test_files: test_files,
+      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,
@@ -24,7 +26,7 @@ describe KnapsackPro::QueueAllocator do
 
     before do
       encrypted_test_files = double
-      expect(KnapsackPro::Crypto::Encryptor).to receive(:call).with(test_files).and_return(encrypted_test_files)
+      expect(KnapsackPro::Crypto::Encryptor).to receive(:call).with(fast_and_slow_test_files_to_run).and_return(encrypted_test_files)
 
       encrypted_branch = double
       expect(KnapsackPro::Crypto::BranchEncryptor).to receive(:call).with(repository_adapter.branch).and_return(encrypted_branch)
@@ -70,7 +72,7 @@ describe KnapsackPro::QueueAllocator do
         end
 
         before do
-          expect(KnapsackPro::Crypto::Decryptor).to receive(:call).with(test_files, response['test_files']).and_call_original
+          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'] }
@@ -120,7 +122,7 @@ describe KnapsackPro::QueueAllocator do
       context 'when fallback mode started' do
         before do
           test_flat_distributor = instance_double(KnapsackPro::TestFlatDistributor)
-          expect(KnapsackPro::TestFlatDistributor).to receive(:new).with(test_files, ci_node_total).and_return(test_flat_distributor)
+          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' },

data/spec/knapsack_pro/runners/rspec_runner_spec.rb

@@ -24,11 +24,11 @@ describe KnapsackPro::Runners::RSpecRunner do
 
     context 'when test files were returned by Knapsack Pro API' do
       let(:test_dir) { 'fake-test-dir' }
-      let(:test_file_paths) { double(:test_file_paths) }
+      let(:stringify_test_file_paths) { "spec/a_spec.rb spec/b_spec.rb[1:1]" }
       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
       let(:task) { double }
@@ -38,8 +38,8 @@ describe KnapsackPro::Runners::RSpecRunner do
 
         t = double
         expect(RSpec::Core::RakeTask).to receive(:new).with('knapsack_pro:rspec_run').and_yield(t)
-        expect(t).to receive(:rspec_opts=).with('--profile --color --default-path fake-test-dir')
-        expect(t).to receive(:pattern=).with(test_file_paths)
+        expect(t).to receive(:rspec_opts=).with('--profile --color --default-path fake-test-dir spec/a_spec.rb spec/b_spec.rb[1:1]')
+        expect(t).to receive(:pattern=).with([])
       end
 
       context 'when task already exists' do

data/spec/knapsack_pro/slow_test_file_determiner_spec.rb

@@ -0,0 +1,74 @@
+describe KnapsackPro::SlowTestFileDeterminer do
+  describe '.call' do
+    let(:node_total) { 4 }
+    let(:time_execution) { 20.0 }
+    let(:test_files) do
+      [
+        { 'path' => 'a_spec.rb', 'time_execution' => 1.0 },
+        { 'path' => 'b_spec.rb', 'time_execution' => 3.4 },
+        # slow tests are above 3.5s threshold (20.0 / 4 * 0.7 = 3.5)
+        { 'path' => 'c_spec.rb', 'time_execution' => 3.5 },
+        { 'path' => 'd_spec.rb', 'time_execution' => 5.9 },
+      ]
+    end
+
+    before do
+      expect(KnapsackPro::Config::Env).to receive(:ci_node_total).and_return(node_total)
+    end
+
+    subject { described_class.call(test_files, time_execution) }
+
+    it do
+      expect(subject).to eq([
+        { 'path' => 'c_spec.rb', 'time_execution' => 3.5 },
+        { 'path' => 'd_spec.rb', 'time_execution' => 5.9 },
+      ])
+    end
+  end
+
+  describe '.save_to_json_report', :clear_tmp do
+    let(:json_report_path) { 'tmp/knapsack_pro/slow_test_file_determiner/slow_test_files.json' }
+    let(:test_files) do
+      [
+        { 'path' => 'a_spec.rb', 'time_execution' => 1.0 },
+        # unique path to ensure we saved on disk a completely new report
+        { 'path' => "#{SecureRandom.hex}_spec.rb", 'time_execution' => 3.4 },
+      ]
+    end
+
+    subject { described_class.save_to_json_report(test_files) }
+
+    it do
+      subject
+      expect(File.read(json_report_path)).to eq(test_files.to_json)
+    end
+  end
+
+  describe '.read_from_json_report', :clear_tmp do
+    let(:test_files) do
+      [
+        { 'path' => 'a_spec.rb', 'time_execution' => 1.0 },
+        # unique path to ensure we saved on disk a completely new report
+        { 'path' => "#{SecureRandom.hex}_spec.rb", 'time_execution' => 3.4 },
+      ]
+    end
+
+    subject { described_class.read_from_json_report }
+
+    context 'when json report exists' do
+      before do
+        described_class.save_to_json_report(test_files)
+      end
+
+      it do
+        expect(subject).to eq test_files
+      end
+    end
+
+    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!')
+      end
+    end
+  end
+end

data/spec/knapsack_pro/slow_test_file_finder_spec.rb

@@ -0,0 +1,43 @@
+describe KnapsackPro::SlowTestFileFinder do
+  describe '.call' do
+    let(:adapter_class) { double }
+
+    subject { described_class.call(adapter_class) }
+
+    before do
+      expect(KnapsackPro::Config::Env).to receive(:test_files_encrypted?).and_return(test_files_encrypted?)
+    end
+
+    context 'when test files are not encrypted' do
+      let(:test_files_encrypted?) { false }
+
+      it do
+        test_files_from_api = double
+        time_execution = double
+        build_distribution_entity = instance_double(KnapsackPro::BuildDistributionFetcher::BuildDistributionEntity, test_files: test_files_from_api, time_execution: time_execution)
+        expect(KnapsackPro::BuildDistributionFetcher).to receive(:call).and_return(build_distribution_entity)
+
+        merged_test_files_from_api = double
+        expect(KnapsackPro::TestCaseMergers::BaseMerger).to receive(:call).with(adapter_class, test_files_from_api).and_return(merged_test_files_from_api)
+
+        test_files_existing_on_disk = double
+        expect(KnapsackPro::TestFileFinder).to receive(:select_test_files_that_can_be_run).with(adapter_class, merged_test_files_from_api).and_return(test_files_existing_on_disk)
+
+        slow_test_files = double
+        expect(KnapsackPro::SlowTestFileDeterminer).to receive(:call).with(test_files_existing_on_disk, time_execution).and_return(slow_test_files)
+
+        expect(KnapsackPro::SlowTestFileDeterminer).to receive(:save_to_json_report).with(slow_test_files)
+
+        expect(subject).to eq slow_test_files
+      end
+    end
+
+    context 'when test files are encrypted' do
+      let(:test_files_encrypted?) { true }
+
+      it do
+        expect { subject }.to raise_error RuntimeError, 'Split by test cases is not possible when you have enabled test file names encryption ( https://github.com/KnapsackPro/knapsack_pro-ruby#test-file-names-encryption ). You need to disable encryption with KNAPSACK_PRO_TEST_FILES_ENCRYPTED=false in order to use split by test cases https://github.com/KnapsackPro/knapsack_pro-ruby#split-test-files-by-test-cases'
+      end
+    end
+  end
+end

data/spec/knapsack_pro/test_case_detectors/rspec_test_example_detector_spec.rb

@@ -1,9 +1,10 @@
 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.json' }
+  let(:rspec_test_example_detector) { described_class.new }
 
   describe '#generate_json_report' do
-    subject { described_class.new.generate_json_report }
+    subject { rspec_test_example_detector.generate_json_report }
 
     before do
       expect(FileUtils).to receive(:mkdir_p).with(report_dir)
@@ -11,48 +12,63 @@ describe KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector do
       expect(File).to receive(:exists?).with(report_path).and_return(true)
       expect(File).to receive(:delete).with(report_path)
 
-      test_file_pattern = double
-      adapter_class = KnapsackPro::Adapters::RSpecAdapter
-      expect(KnapsackPro::TestFilePattern).to receive(:call).with(adapter_class).and_return(test_file_pattern)
-
-      test_file_paths = [
-        { 'path' => 'spec/a_spec.rb' },
-        { 'path' => 'spec/b_spec.rb' },
-      ]
-      expect(KnapsackPro::TestFileFinder).to receive(:call).with(test_file_pattern).and_return(test_file_paths)
-
-      test_dir = 'spec'
-      expect(KnapsackPro::Config::Env).to receive(:test_dir).and_return(nil)
-      expect(KnapsackPro::TestFilePattern).to receive(:test_dir).with(adapter_class).and_return(test_dir)
-
-      options = double
-      expect(RSpec::Core::ConfigurationOptions).to receive(:new).with([
-        '--format', expected_format,
-        '--dry-run',
-        '--out', report_path,
-        '--default-path', test_dir,
-        'spec/a_spec.rb', 'spec/b_spec.rb',
-      ]).and_return(options)
-
-      rspec_core_runner = double
-      expect(RSpec::Core::Runner).to receive(:new).with(options).and_return(rspec_core_runner)
-      expect(rspec_core_runner).to receive(:run).with($stderr, $stdout).and_return(exit_code)
+      expect(rspec_test_example_detector).to receive(:slow_test_files).and_return(test_file_entities)
     end
 
     shared_examples 'generate_json_report runs RSpec::Core::Runner' do
-      context 'when exit code from RSpec::Core::Runner is 0' do
-        let(:exit_code) { 0 }
+      context 'when there are no slow test files' do
+        let(:test_file_entities) { [] }
+
+        before do
+          expect(File).to receive(:write).with(report_path, { examples: [] }.to_json)
+        end
 
         it do
           expect(subject).to be_nil
         end
       end
 
-      context 'when exit code from RSpec::Core::Runner is 1' do
-        let(:exit_code) { 1 }
+      context 'when slow test files exist' do
+        let(:test_file_entities) do
+          [
+            { 'path' => 'spec/a_spec.rb' },
+            { 'path' => 'spec/b_spec.rb' },
+          ]
+        end
 
-        it do
-          expect { subject }.to raise_error(RuntimeError, 'There was problem to generate test examples for test suite')
+        before do
+          test_dir = 'spec'
+          expect(KnapsackPro::Config::Env).to receive(:test_dir).and_return(nil)
+          expect(KnapsackPro::TestFilePattern).to receive(:test_dir).with(KnapsackPro::Adapters::RSpecAdapter).and_return(test_dir)
+
+          options = double
+          expect(RSpec::Core::ConfigurationOptions).to receive(:new).with([
+            '--format', expected_format,
+            '--dry-run',
+            '--out', report_path,
+            '--default-path', test_dir,
+            'spec/a_spec.rb', 'spec/b_spec.rb',
+          ]).and_return(options)
+
+          rspec_core_runner = double
+          expect(RSpec::Core::Runner).to receive(:new).with(options).and_return(rspec_core_runner)
+          expect(rspec_core_runner).to receive(:run).with($stderr, $stdout).and_return(exit_code)
+        end
+
+        context 'when exit code from RSpec::Core::Runner is 0' do
+          let(:exit_code) { 0 }
+
+          it do
+            expect(subject).to be_nil
+          end
+        end
+
+        context 'when exit code from RSpec::Core::Runner is 1' do
+          let(:exit_code) { 1 }
+
+          it do
+            expect { subject }.to raise_error(RuntimeError, 'There was problem to generate test examples for test suite')
+          end
         end
       end
     end
@@ -77,7 +93,7 @@ describe KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector do
   describe '#test_file_example_paths' do
     subject { described_class.new.test_file_example_paths }
 
-    context 'when json report exists' do
+    context 'when JSON report exists' do
       it do
         expect(File).to receive(:exists?).with(report_path).and_return(true)
 
@@ -96,7 +112,7 @@ describe KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector do
       end
     end
 
-    context 'when json report does not exist' do
+    context 'when JSON report does not exist' do
       it do
         expect(File).to receive(:exists?).with(report_path).and_return(false)
 
@@ -104,4 +120,34 @@ describe KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector do
       end
     end
   end
+
+  describe '#slow_test_files' do
+    subject { described_class.new.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_file_pattern) { double }
+
+      it do
+        expected_slow_test_files = double
+        expect(KnapsackPro::TestFileFinder).to receive(:slow_test_files_by_pattern).with(KnapsackPro::Adapters::RSpecAdapter).and_return(expected_slow_test_files)
+
+        expect(subject).to eq expected_slow_test_files
+      end
+    end
+
+    context 'when slow test file pattern is not present' do
+      let(:slow_test_file_pattern) { nil }
+
+      it do
+        expected_slow_test_files = double
+        expect(KnapsackPro::SlowTestFileDeterminer).to receive(:read_from_json_report).and_return(expected_slow_test_files)
+
+        expect(subject).to eq expected_slow_test_files
+      end
+    end
+  end
 end

data/spec/knapsack_pro/test_case_mergers/base_merger_spec.rb

@@ -0,0 +1,27 @@
+describe KnapsackPro::TestCaseMergers::BaseMerger do
+  describe '.call' do
+    let(:test_files) { double }
+
+    subject { described_class.call(adapter_class, test_files) }
+
+    context 'when adapter_class is KnapsackPro::Adapters::RSpecAdapter' do
+      let(:adapter_class) { KnapsackPro::Adapters::RSpecAdapter }
+
+      it do
+        result = double
+        rspec_merger = instance_double(KnapsackPro::TestCaseMergers::RSpecMerger, call: result)
+        expect(KnapsackPro::TestCaseMergers::RSpecMerger).to receive(:new).with(test_files).and_return(rspec_merger)
+
+        expect(subject).to eq result
+      end
+    end
+
+    context 'when adapter_class is unknown' do
+      let(:adapter_class) { 'fake-adapter' }
+
+      it do
+        expect { subject }.to raise_error 'Test case merger does not exist for adapter_class: fake-adapter'
+      end
+    end
+  end
+end

data/spec/knapsack_pro/test_case_mergers/rspec_merger_spec.rb

@@ -0,0 +1,59 @@
+describe KnapsackPro::TestCaseMergers::RSpecMerger do
+  describe '#call' do
+    subject { described_class.new(test_files).call }
+
+    context 'when all test files are not test example paths' do
+      let(:test_files) do
+        [
+          { 'path' => 'spec/a_spec.rb', 'time_execution' => 1.1 },
+          { 'path' => 'spec/b_spec.rb', 'time_execution' => 2.2 },
+        ]
+      end
+
+      it do
+        expect(subject).to eq([
+          { 'path' => 'spec/a_spec.rb', 'time_execution' => 1.1 },
+          { 'path' => 'spec/b_spec.rb', 'time_execution' => 2.2 },
+        ])
+      end
+    end
+
+    context 'when test files have test example paths' do
+      let(:test_files) do
+        [
+          { 'path' => 'spec/a_spec.rb', 'time_execution' => 1.1 },
+          # test example paths
+          { 'path' => 'spec/test_case_spec.rb[1:1]', 'time_execution' => 2.2 },
+          { 'path' => 'spec/test_case_spec.rb[1:2]', 'time_execution' => 0.8 },
+        ]
+      end
+
+      it 'returns merged paths for test examples and sum of their time_execution' do
+        expect(subject).to eq([
+          { 'path' => 'spec/a_spec.rb', 'time_execution' => 1.1 },
+          { 'path' => 'spec/test_case_spec.rb', 'time_execution' => 3.0 },
+        ])
+      end
+    end
+
+    context 'when test files have test example paths and at the same time test file path for test example path is present as full test file path' do
+      let(:test_files) do
+        [
+          { 'path' => 'spec/a_spec.rb', 'time_execution' => 1.1 },
+          # full test file path is present despite existing test example paths
+          { 'path' => 'spec/test_case_spec.rb', 'time_execution' => 1.0 },
+          # test example paths
+          { 'path' => 'spec/test_case_spec.rb[1:1]', 'time_execution' => 2.2 },
+          { 'path' => 'spec/test_case_spec.rb[1:2]', 'time_execution' => 0.8 },
+        ]
+      end
+
+      it 'returns merged paths for test examples and sum of their time_execution' do
+        expect(subject).to eq([
+          { 'path' => 'spec/a_spec.rb', 'time_execution' => 1.1 },
+          { 'path' => 'spec/test_case_spec.rb', 'time_execution' => 4.0 },
+        ])
+      end
+    end
+  end
+end