knapsack_pro 5.6.0 → 6.0.0

data/spec/knapsack_pro/base_allocator_builder_spec.rb

@@ -117,8 +117,8 @@ describe KnapsackPro::BaseAllocatorBuilder do
   describe '#fast_and_slow_test_files_to_run' do
     subject { allocator_builder.fast_and_slow_test_files_to_run }
 
-    context 'when looking for test files on disk by default' do
-      it do
+    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)
 
@@ -129,70 +129,44 @@ describe KnapsackPro::BaseAllocatorBuilder do
       end
     end
 
-    context 'when RSpec adapter AND rspec split by test examples is enabled' do
-      let(:adapter_class) { KnapsackPro::Adapters::RSpecAdapter }
+    context 'when split by test cases enabled' do
       let(:test_files_to_run) { double }
-      let(:cmd) { 'RACK_ENV=test RAILS_ENV=test bundle exec rake knapsack_pro:rspec_test_example_detector' }
 
-      before do
-        expect(KnapsackPro::Config::Env).to receive(:rspec_split_by_test_examples?).and_return(true)
+      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)
-      end
 
-      context 'when RSpec version < 3.3.0' do
-        before do
-          stub_const('RSpec::Core::Version::STRING', '3.2.0')
-        end
-
-        it do
-          expect { subject }.to raise_error RuntimeError, 'RSpec >= 3.3.0 is required to split test files by test examples. Learn more: https://knapsackpro.com/perma/ruby/split-by-test-examples'
-        end
+        expect(allocator_builder).to receive(:get_slow_test_files).and_return(slow_test_files)
       end
 
-      context 'when rake task to detect RSpec test examples works' do
-        let(:slow_test_files) { double(size: 5) }
-        let(:cmd_result) { true }
-        let(:test_file_example_paths) { double }
-        let(:logger) { instance_double(Logger) }
-        let(:test_files_with_test_cases) { double }
-
-        before do
-          expect(allocator_builder).to receive(:get_slow_test_files).and_return(slow_test_files)
-
-          expect(KnapsackPro).to receive(:logger).and_return(logger)
-
-          expect(Kernel).to receive(:system).with(cmd).and_return(cmd_result)
-
-          rspec_test_example_detector = instance_double(KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector)
-          expect(KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector).to receive(:new).and_return(rspec_test_example_detector)
-          expect(rspec_test_example_detector).to receive(:test_file_example_paths).and_return(test_file_example_paths)
-
-          expect(KnapsackPro::TestFilesWithTestCasesComposer).to receive(:call).with(test_files_to_run, slow_test_files, test_file_example_paths).and_return(test_files_with_test_cases)
+      context 'when slow test files are detected' do
+        let(:slow_test_files) do
+          [
+            '1_spec.rb',
+            '2_spec.rb',
+          ]
         end
 
-        it do
-          expect(logger).to receive(:info).with("Generating RSpec test examples JSON report for slow test files to prepare it to be split by test examples (by individual 'it's. Thanks to that a single slow test file can be split across parallel CI nodes). Analyzing 5 slow test files.")
+        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 rake task to detect RSpec test examples failed' do
-        let(:slow_test_files) { double(size: 5) }
-        let(:cmd_result) { false }
-
-        before do
-          expect(allocator_builder).to receive(:get_slow_test_files).and_return(slow_test_files)
-
-          expect(Kernel).to receive(:system).with(cmd).and_return(cmd_result)
-        end
+      context 'when slow test files are not detected' do
+        let(:slow_test_files) { [] }
 
-        it do
-          expect { subject }.to raise_error(RuntimeError, 'Could not generate JSON report for RSpec. Rake task failed when running RACK_ENV=test RAILS_ENV=test bundle exec rake knapsack_pro:rspec_test_example_detector')
+        it 'returns test files without test cases' do
+          expect(subject).to eq test_files_to_run
         end
       end
     end

data/spec/knapsack_pro/client/connection_spec.rb

@@ -282,15 +282,17 @@ describe KnapsackPro::Client::Connection do
                     request_hash: request_hash)
   end
   let(:test_suite_token) { '3fa64859337f6e56409d49f865d13fd7' }
-
   let(:connection) { described_class.new(action) }
-
-  before do
-    stub_const('ENV', {
+  let(:headers) do
+    {
       'KNAPSACK_PRO_ENDPOINT' => 'http://api.knapsackpro.test:3000',
       'KNAPSACK_PRO_TEST_SUITE_TOKEN' => test_suite_token,
       'GITHUB_ACTIONS' => 'true',
-    })
+    }
+  end
+
+  before do
+    stub_const('ENV', headers)
   end
 
   describe '#call' do
@@ -311,7 +313,7 @@ describe KnapsackPro::Client::Connection do
       expect(http).to receive(:read_timeout=).with(15)
     end
 
-    context 'when http method is POST' do
+    context 'when http method is POST on GitHub Actions' do
       let(:http_method) { :post }
 
       before do
@@ -334,7 +336,30 @@ describe KnapsackPro::Client::Connection do
       end
     end
 
-    context 'when http method is GET' do
+    context 'when http method is POST and CI is undetected' do
+      let(:http_method) { :post }
+
+      let(:headers) do
+        {
+          'KNAPSACK_PRO_ENDPOINT' => 'http://api.knapsackpro.test:3000',
+          'KNAPSACK_PRO_TEST_SUITE_TOKEN' => test_suite_token,
+        }
+      end
+
+      before do
+        expect(http).to receive(:post).with(
+          anything,
+          anything,
+          hash_not_including('KNAPSACK-PRO-CI-PROVIDER')
+        ).and_return(http_response)
+      end
+
+      it_behaves_like 'when request got response from API' do
+        let(:expected_http_method) { 'POST' }
+      end
+    end
+
+    context 'when http method is GET on GitHub Actions' do
       let(:http_method) { :get }
 
       before do
@@ -358,6 +383,28 @@ describe KnapsackPro::Client::Connection do
       end
     end
 
+    context 'when http method is GET and CI is undetected' do
+      let(:http_method) { :get }
+
+      let(:headers) do
+        {
+          'KNAPSACK_PRO_ENDPOINT' => 'http://api.knapsackpro.test:3000',
+          'KNAPSACK_PRO_TEST_SUITE_TOKEN' => test_suite_token,
+        }
+      end
+
+      before do
+        expect(http).to receive(:get).with(
+          anything,
+          hash_not_including('KNAPSACK-PRO-CI-PROVIDER')
+        ).and_return(http_response)
+      end
+
+      it_behaves_like 'when request got response from API' do
+        let(:expected_http_method) { 'GET' }
+      end
+    end
+
     context 'when retry request for http method POST' do
       let(:http_method) { :post }
 

data/spec/knapsack_pro/formatters/time_tracker_specs.rb

@@ -0,0 +1,453 @@
+# Named _specs.rb on purpose because it hangs if run as part of `bundle exec rspec`.
+# Use `bundle exec ruby spec/knapsack_pro/formatters/time_tracker_specs.rb` instead.
+
+require 'rspec/core'
+require 'knapsack_pro'
+require 'stringio'
+require_relative '../../../lib/knapsack_pro/formatters/time_tracker'
+
+class TestTimeTracker
+  def test_single_example
+    KnapsackPro::Formatters::TimeTracker.define_method(:rspec_split_by_test_example?) do |_file|
+      false
+    end
+
+    spec = <<~SPEC
+      describe "KnapsackPro::Formatters::TimeTracker" do
+        it do
+          sleep 0.1
+          expect(1).to eq 1
+        end
+      end
+    SPEC
+
+    run_specs(spec) do |spec_paths, times|
+      raise unless times.size == 1
+      raise unless times[0]["path"] == spec_paths.first
+      raise unless times[0]["time_execution"] > 0.10
+      raise unless times[0]["time_execution"] < 0.15
+    end
+  end
+
+  def test_two_files
+    KnapsackPro::Formatters::TimeTracker.define_method(:rspec_split_by_test_example?) do |_file|
+      false
+    end
+
+    spec_1 = <<~SPEC
+      describe "KnapsackPro::Formatters::TimeTracker 1" do
+        it do
+          sleep 0.1
+          expect(1).to eq 1
+        end
+      end
+    SPEC
+
+    spec_2 = <<~SPEC
+      describe "KnapsackPro::Formatters::TimeTracker 2" do
+        it do
+          sleep 0.2
+          expect(1).to eq 1
+        end
+      end
+    SPEC
+
+    run_specs([spec_1, spec_2]) do |spec_paths, times|
+      raise unless times.size == 2
+      raise unless times.first["path"] == spec_paths.first
+      raise unless times.first["time_execution"] > 0.10
+      raise unless times.first["time_execution"] < 0.15
+      raise unless times.last["path"] == spec_paths.last
+      raise unless times.last["time_execution"] > 0.20
+      raise unless times.last["time_execution"] < 0.25
+    end
+  end
+
+  def test_failing_example
+    KnapsackPro::Formatters::TimeTracker.define_method(:rspec_split_by_test_example?) do |_file|
+      false
+    end
+
+    spec = <<~SPEC
+      describe "KnapsackPro::Formatters::TimeTracker" do
+        it do
+          sleep 0.1
+          expect(1).to eq 2
+        end
+      end
+    SPEC
+
+    run_specs(spec) do |spec_paths, times|
+      raise unless times.size == 1
+      raise unless times[0]["path"] == spec_paths.first
+      raise unless times[0]["time_execution"] > 0.10
+      raise unless times[0]["time_execution"] < 0.15
+    end
+  end
+
+  def test_pending_example
+    KnapsackPro::Formatters::TimeTracker.define_method(:rspec_split_by_test_example?) do |_file|
+      false
+    end
+
+    spec = <<~SPEC
+      describe "KnapsackPro::Formatters::TimeTracker" do
+        xit do
+          sleep 0.1
+          expect(1).to eq 2
+        end
+      end
+    SPEC
+
+    run_specs(spec) do |spec_paths, times|
+      raise unless times.size == 1
+      raise unless times[0]["path"] == spec_paths.first
+      raise unless times[0]["time_execution"] == 0.0
+    end
+  end
+
+  def test_multiple_top_level_groups
+    KnapsackPro::Formatters::TimeTracker.define_method(:rspec_split_by_test_example?) do |_file|
+      false
+    end
+
+    spec = <<~SPEC
+      describe "KnapsackPro::Formatters::TimeTracker 1" do
+        it do
+          sleep 0.1
+          expect(1).to eq 1
+        end
+      end
+
+      describe "KnapsackPro::Formatters::TimeTracker 2" do
+        it do
+          sleep 0.2
+          expect(1).to eq 1
+        end
+      end
+    SPEC
+
+    run_specs(spec) do |spec_paths, times|
+      raise unless times.size == 1
+      raise unless times[0]["path"] == spec_paths.first
+      raise unless times[0]["time_execution"] > 0.30
+      raise unless times[0]["time_execution"] < 0.35
+    end
+  end
+
+  def test_rspec_split_by_test_example
+    KnapsackPro::Formatters::TimeTracker.define_method(:rspec_split_by_test_example?) do |_file|
+      true
+    end
+
+    spec = <<~SPEC
+      describe "KnapsackPro::Formatters::TimeTracker 1" do
+        it do
+          expect(1).to eq 1
+        end
+
+        it do
+          sleep 0.1
+          expect(1).to eq 1
+        end
+      end
+
+      describe "KnapsackPro::Formatters::TimeTracker 2" do
+        it do
+          sleep 0.2
+          expect(1).to eq 1
+        end
+
+        it do
+          sleep 0.3
+          expect(1).to eq 1
+        end
+      end
+    SPEC
+
+    run_specs(spec) do |spec_paths, times|
+      raise unless times.size == 4
+      spec_path = spec_paths.first
+      raise unless times.find { |time| time["path"] == "#{spec_path}[1:1]" }["time_execution"] < 0.05
+      raise unless times.find { |time| time["path"] == "#{spec_path}[1:2]" }["time_execution"] > 0.10
+      raise unless times.find { |time| time["path"] == "#{spec_path}[1:2]" }["time_execution"] < 0.15
+      raise unless times.find { |time| time["path"] == "#{spec_path}[2:1]" }["time_execution"] > 0.20
+      raise unless times.find { |time| time["path"] == "#{spec_path}[2:1]" }["time_execution"] < 0.25
+      raise unless times.find { |time| time["path"] == "#{spec_path}[2:2]" }["time_execution"] > 0.30
+      raise unless times.find { |time| time["path"] == "#{spec_path}[2:2]" }["time_execution"] < 0.35
+    end
+  end
+
+  def test_hooks
+    KnapsackPro::Formatters::TimeTracker.define_method(:rspec_split_by_test_example?) do |_file|
+      false
+    end
+
+    spec = <<~SPEC
+      describe "KnapsackPro::Formatters::TimeTracker" do
+        before(:all) do
+          sleep 0.1
+        end
+
+        before(:each) do
+          sleep 0.1
+        end
+
+        after(:each) do
+          sleep 0.1
+        end
+
+        it do
+          expect(1).to eq 1
+        end
+
+        it do
+          expect(1).to eq 1
+        end
+
+        after(:all) do
+          sleep 0.1
+        end
+      end
+    SPEC
+
+    run_specs(spec) do |spec_paths, times|
+      raise unless times.size == 1
+      raise unless times[0]["path"] == spec_paths.first
+      raise unless times[0]["time_execution"] > 0.60
+      raise unless times[0]["time_execution"] < 0.65
+    end
+  end
+
+  def test_hooks_with_rspec_split_by_test_example
+    KnapsackPro::Formatters::TimeTracker.define_method(:rspec_split_by_test_example?) do |_file|
+      true
+    end
+
+    spec = <<~SPEC
+      describe "KnapsackPro::Formatters::TimeTracker" do
+        before(:all) do
+          sleep 0.1
+        end
+
+        before(:each) do
+          sleep 0.1
+        end
+
+        after(:each) do
+          sleep 0.1
+        end
+
+        it do
+          expect(1).to eq 1
+        end
+
+        it do
+          expect(1).to eq 1
+        end
+
+        after(:all) do
+          sleep 0.1
+        end
+      end
+    SPEC
+
+    run_specs(spec) do |spec_paths, times|
+      raise unless times.size == 2
+      spec_path = spec_paths.first
+      raise unless times.find { |time| time["path"] == "#{spec_path}[1:1]" }["time_execution"] > 0.40
+      raise unless times.find { |time| time["path"] == "#{spec_path}[1:1]" }["time_execution"] < 0.45
+      raise unless times.find { |time| time["path"] == "#{spec_path}[1:2]" }["time_execution"] > 0.40
+      raise unless times.find { |time| time["path"] == "#{spec_path}[1:2]" }["time_execution"] < 0.45
+    end
+  end
+
+  def test_unknown_path
+    KnapsackPro::Formatters::TimeTracker.class_eval do
+      alias_method :original_file_path_for, :file_path_for
+
+      define_method(:file_path_for) do |_example|
+        ""
+      end
+    end
+
+    spec = <<~SPEC
+      describe "KnapsackPro::Formatters::TimeTracker" do
+        it do
+          expect(1).to eq 1
+        end
+      end
+    SPEC
+
+    run_specs(spec) do |spec_paths, times|
+      raise unless times.size == 2
+      raise unless times[0]["path"] == "UNKNOWN_PATH"
+      raise unless times[1]["path"] == spec_paths.first
+    end
+
+  ensure
+    KnapsackPro::Formatters::TimeTracker.class_eval do
+      undef :file_path_for
+      alias_method :file_path_for, :original_file_path_for
+    end
+  end
+
+  def test_empty_group
+    KnapsackPro::Formatters::TimeTracker.define_method(:rspec_split_by_test_example?) do |_file|
+      false
+    end
+
+    spec = <<~SPEC
+      describe "KnapsackPro::Formatters::TimeTracker" do
+      end
+    SPEC
+
+    run_specs(spec) do |spec_paths, times|
+      raise unless times.size == 1
+      raise unless times[0]["path"] == spec_paths.first
+      raise unless times[0]["time_execution"] == 0.0
+    end
+  end
+
+  def test_duration
+    KnapsackPro::Formatters::TimeTracker.define_method(:rspec_split_by_test_example?) do |_file|
+      false
+    end
+
+    spec = <<~SPEC
+      describe "KnapsackPro::Formatters::TimeTracker" do
+        it do
+          expect(1).to eq 1
+        end
+      end
+    SPEC
+
+    run_specs(spec) do |_, _, time_tracker|
+      raise unless time_tracker.duration > 0.0
+    end
+  end
+
+  def test_batch_duration
+    KnapsackPro::Formatters::TimeTracker.define_method(:rspec_split_by_test_example?) do |_file|
+      false
+    end
+
+    spec = <<~SPEC
+      describe "KnapsackPro::Formatters::TimeTracker" do
+        it do
+          expect(1).to eq 1
+        end
+      end
+    SPEC
+
+    run_specs(spec) do |_, _, time_tracker|
+      raise unless time_tracker.batch_duration > 0.0
+    end
+  end
+
+  def test_unexecuted_test_files
+    KnapsackPro::Formatters::TimeTracker.define_method(:rspec_split_by_test_example?) do |_file|
+      false
+    end
+
+    spec = <<~SPEC
+      describe "KnapsackPro::Formatters::TimeTracker" do
+        xit do
+        end
+      end
+    SPEC
+
+    run_specs(spec) do |spec_paths, _, time_tracker|
+      unexecuted_test_files = ["foo_spec.rb", "bar_spec.rb"]
+      # Need to filter because RSpec keeps accumulating state.
+      files = time_tracker
+        .unexecuted_test_files(spec_paths + unexecuted_test_files)
+        .filter { |file| spec_paths.include?(file) || unexecuted_test_files.include?(file) }
+
+      raise unless files.size == 3
+    end
+  end
+
+  def test_subset
+    KnapsackPro::Formatters::TimeTracker.define_method(:rspec_split_by_test_example?) do |_file|
+      false
+    end
+    KnapsackPro::Formatters::TimeTracker.class_eval do
+      alias_method :original_stop, :stop
+
+      # In Regular Mode, #subset is called before #stop.
+      # This test makes #stop a noop to simulate that behavior.
+      define_method(:stop) do |_|
+      end
+    end
+
+    spec = <<~SPEC
+      describe "KnapsackPro::Formatters::TimeTracker" do
+        it "works" do
+          sleep 0.1
+          expect(1).to eq 1
+        end
+      end
+    SPEC
+
+    run_specs(spec) do |spec_paths, times, time_tracker|
+      # Need to filter because RSpec keeps accumulating state.
+      files = time_tracker
+        .batch
+        .filter { |file| spec_paths.include?(file["path"]) }
+
+      raise unless files.size == 1
+      raise unless files[0]["path"] == spec_paths.first
+      raise unless files[0]["time_execution"] > 0.10
+      raise unless files[0]["time_execution"] < 0.15
+    end
+
+  ensure
+    KnapsackPro::Formatters::TimeTracker.class_eval do
+      undef :stop
+      alias_method :stop, :original_stop
+    end
+  end
+
+  private
+
+  def run_specs(specs)
+    paths = Array(specs).map.with_index do |spec, i|
+      path = "spec/knapsack_pro/formatters/#{i}_#{SecureRandom.uuid}_spec.rb"
+      File.open(path, 'w') { |file| file.write(spec) }
+      path
+    end
+
+    options = ::RSpec::Core::ConfigurationOptions.new([
+      "--format", KnapsackPro::Formatters::TimeTracker.to_s,
+      *paths,
+    ])
+    runner = ::RSpec::Core::Runner.new(options)
+    runner.run(StringIO.new, StringIO.new)
+
+    time_tracker = runner.configuration.formatters.find { |f| f.class.to_s == KnapsackPro::Formatters::TimeTracker.to_s }
+    # Need to filter because RSpec keeps accumulating state.
+    times = time_tracker
+      .queue(paths)
+      .sort_by { |time| time["path"] }
+      .filter do |time|
+        paths.any? { |path| time["path"].start_with?(path) || time["path"] == "UNKNOWN_PATH" }
+      end
+    yield(paths, times, time_tracker)
+
+  ensure
+    paths.each { |path| File.delete(path) }
+    # Need to reset because RSpec keeps reusing the same instance.
+    time_tracker.instance_variable_set(:@queue, {}) if time_tracker
+    time_tracker.instance_variable_set(:@started, time_tracker.send(:now)) if time_tracker
+  end
+end
+
+TestTimeTracker
+  .instance_methods
+  .filter { |method| method.to_s.start_with?("test_") }
+  .shuffle
+  .each do |method|
+    puts method
+    TestTimeTracker.new.public_send(method)
+  end