knapsack_pro 3.8.0 → 7.0.0

data/spec/knapsack_pro/formatters/time_tracker_specs.rb

@@ -0,0 +1,424 @@
+# 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 'tempfile'
+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 == 1
+      raise unless times[0]["path"] == spec_paths.first
+      raise unless times[0]["time_execution"] == 0.0
+    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_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
+
+    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
+  end
+
+  private
+
+  def run_specs(specs)
+    files = Array(specs).map.with_index do |spec, i|
+      file = Tempfile.new(["time_tracker_#{i}", "_spec.rb"], "./spec/knapsack_pro/formatters/")
+      file.write(spec)
+      file.rewind
+      file
+    end
+
+    paths = files.map(&:path).map { _1.sub("./", "") }
+
+    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) }
+      end
+    yield(paths, times, time_tracker)
+
+  ensure
+    # 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

data/spec/knapsack_pro/hooks/queue_spec.rb

@@ -93,8 +93,8 @@ describe KnapsackPro::Hooks::Queue do
       let(:subset_queue_id) { double }
 
       before do
-        expect(KnapsackPro::Config::Env).to receive(:queue_id).twice.and_return(queue_id)
-        expect(KnapsackPro::Config::Env).to receive(:subset_queue_id).twice.and_return(subset_queue_id)
+        expect(KnapsackPro::Config::Env).to receive(:queue_id).at_least(:once).and_return(queue_id)
+        expect(KnapsackPro::Config::Env).to receive(:subset_queue_id).at_least(:once).and_return(subset_queue_id)
 
         $expected_called_blocks = []
 

data/spec/knapsack_pro/presenter_spec.rb

@@ -8,7 +8,7 @@ describe KnapsackPro::Presenter do
       expect(KnapsackPro).to receive(:tracker).and_return(tracker)
     end
 
-    it { should eql "Global time execution for tests: 01h 02m 03s" }
+    it { should eql "Global test execution duration: 01h 02m 03s" }
   end
 
   describe '.pretty_seconds' do

data/spec/knapsack_pro/pure/queue/rspec_pure_spec.rb

@@ -0,0 +1,224 @@
+require(KnapsackPro.root + '/lib/knapsack_pro/formatters/time_tracker')
+require(KnapsackPro.root + '/lib/knapsack_pro/extensions/rspec_extension')
+
+describe KnapsackPro::Pure::Queue::RSpecPure do
+  let(:rspec_pure) { described_class.new }
+
+  describe '#add_knapsack_pro_formatters_to' do
+    subject { rspec_pure.add_knapsack_pro_formatters_to(spec_opts) }
+
+    context 'when no spec_opts' do
+      let(:spec_opts) { nil }
+
+      it 'returns no spec_opts' do
+        expect(subject).to be nil
+      end
+    end
+
+    context 'when spec_opts have Knapsack Pro formatters' do
+      let(:spec_opts) { '--color --format d --format KnapsackPro::Formatters::TimeTracker' }
+
+      it 'returns spec_opts' do
+        expect(subject).to eq spec_opts
+      end
+    end
+
+    context 'when spec_opts have no Knapsack Pro formatters' do
+      let(:spec_opts) { '--color --format d' }
+
+      it 'returns spec_opts with added Knapsack Pro formatters' do
+        expect(subject).to eq '--color --format d --format KnapsackPro::Formatters::TimeTracker'
+      end
+    end
+  end
+
+  describe '#error_exit_code' do
+    subject { rspec_pure.error_exit_code(rspec_error_exit_code) }
+
+    context 'when RSpec has no defined error exit code' do
+      let(:rspec_error_exit_code) { nil }
+
+      it 'returns 1 as the default exit code' do
+        expect(subject).to eq 1
+      end
+    end
+
+    context 'when RSpec has a defined error exit code' do
+      let(:rspec_error_exit_code) { 2 }
+
+      it 'returns the custom exit code' do
+        expect(subject).to eq rspec_error_exit_code
+      end
+    end
+  end
+
+  describe '#args_with_seed_option_added_when_viable' do
+    let(:order_option) { KnapsackPro::Adapters::RSpecAdapter.order_option(args) }
+
+    subject { rspec_pure.args_with_seed_option_added_when_viable(order_option, seed, args) }
+
+    context 'when the order option is not random' do
+      let(:args) { ['--order', 'defined'] }
+      let(:seed) { KnapsackPro::Extensions::RSpecExtension::Seed.new(value: nil, used?: false) }
+
+      it 'does not add the seed option to args' do
+        expect(subject).to eq ['--order', 'defined']
+      end
+    end
+
+    ['random', 'rand'].each do |random_option_value|
+      context "when the order option is `#{random_option_value}`" do
+        let(:args) { ['--order', random_option_value] }
+
+        context 'when the seed is not used' do
+          let(:seed) { KnapsackPro::Extensions::RSpecExtension::Seed.new(value: '123', used?: false) }
+
+          it 'does not add the seed option to args' do
+            expect(subject).to eq ['--order', random_option_value]
+          end
+        end
+
+        context 'when the seed is used' do
+          let(:seed) { KnapsackPro::Extensions::RSpecExtension::Seed.new(value: '123', used?: true) }
+
+          it 'adds the seed option to args' do
+            expect(subject).to eq ['--order', random_option_value, '--seed', '123']
+          end
+        end
+      end
+    end
+
+    context 'when the order option is `rand:123`' do
+      let(:args) { ['--order', 'rand:123'] }
+      let(:seed) { KnapsackPro::Extensions::RSpecExtension::Seed.new(value: '123', used?: true) }
+
+      it 'does not add the seed option to args' do
+        expect(subject).to eq ['--order', 'rand:123']
+      end
+    end
+
+    context 'when the order option is not set in args AND seed is used' do
+      let(:args) { ['--format', 'documentation'] }
+      let(:seed) { KnapsackPro::Extensions::RSpecExtension::Seed.new(value: '123', used?: true) }
+
+      it 'adds the seed option to args' do
+        expect(subject).to eq ['--format', 'documentation', '--seed', '123']
+      end
+    end
+
+    context 'when the order option is not set in args AND seed is not used' do
+      let(:args) { ['--format', 'documentation'] }
+      let(:seed) { KnapsackPro::Extensions::RSpecExtension::Seed.new(value: '123', used?: false) }
+
+      it 'does not add the seed option to args' do
+        expect(subject).to eq ['--format', 'documentation']
+      end
+    end
+  end
+
+  describe '#prepare_cli_args' do
+    subject { rspec_pure.prepare_cli_args(args, has_format_option, test_dir) }
+
+    context 'when no args' do
+      let(:args) { nil }
+      let(:has_format_option) { false }
+      let(:test_dir) { 'spec' }
+
+      it 'adds the default progress formatter and the default path and the time tracker formatter' do
+        expect(subject).to eq [
+          '--format', 'progress',
+          '--default-path', 'spec',
+          '--format', 'KnapsackPro::Formatters::TimeTracker',
+        ]
+      end
+    end
+
+    context 'when args are present and a custom test directory is set' do
+      let(:args) { '--color --profile' }
+      let(:has_format_option) { false }
+      let(:test_dir) { 'custom_spec_dir' }
+
+      it do
+        expect(subject).to eq [
+          '--color',
+          '--profile',
+          '--format', 'progress',
+          '--default-path', 'custom_spec_dir',
+          '--format', 'KnapsackPro::Formatters::TimeTracker',
+        ]
+      end
+    end
+
+    context 'when args are present and has format option' do
+      let(:args) { '--color --profile --format d' }
+      let(:has_format_option) { true }
+      let(:test_dir) { 'spec' }
+
+      it 'uses the format option from args instead of the default formatter' do
+        expect(subject).to eq [
+          '--color',
+          '--profile',
+          '--format', 'd',
+          '--default-path', 'spec',
+          '--format', 'KnapsackPro::Formatters::TimeTracker',
+        ]
+      end
+    end
+  end
+
+  describe '#rspec_command' do
+    let(:args) { ['--format', 'documentation'] }
+    let(:test_file_paths) { ['a_spec.rb', 'b_spec.rb'] }
+
+    subject { rspec_pure.rspec_command(args, test_file_paths, scope) }
+
+    context 'when there are no test file paths' do
+      let(:scope) { :queue_finished }
+      let(:test_file_paths) { [] }
+
+      it 'returns no messages' do
+        expect(subject).to eq []
+      end
+    end
+
+    context 'when a subset of queue (a batch of tests fetched from the Queue API)' do
+      let(:scope) { :batch_finished }
+
+      it 'returns messages with the RSpec command' do
+        expect(subject).to eq([
+          'To retry the last batch of tests fetched from the Queue API, please run the following command on your machine:',
+          'bundle exec rspec --format documentation "a_spec.rb" "b_spec.rb"',
+        ])
+      end
+    end
+
+    context 'when all tests fetched from the Queue API' do
+      let(:scope) { :queue_finished }
+
+      it 'returns messages with the RSpec command' do
+        expect(subject).to eq([
+          'To retry all the tests assigned to this CI node, please run the following command on your machine:',
+          'bundle exec rspec --format documentation "a_spec.rb" "b_spec.rb"',
+        ])
+      end
+    end
+
+    describe '#exit_summary' do
+      subject { rspec_pure.exit_summary(unexecuted_test_files) }
+
+      context 'when there are no unexecuted test files' do
+        let(:unexecuted_test_files) { [] }
+
+        it { expect(subject).to be_nil }
+      end
+
+      context 'when there are unexecuted test files' do
+        let(:unexecuted_test_files) { ['b_spec.rb', 'c_spec.rb'] }
+
+        it 'returns a warning message' do
+          expect(subject).to eq 'Unexecuted tests on this CI node (including pending tests): b_spec.rb c_spec.rb'
+        end
+      end
+    end
+  end
+end