knapsack_pro 8.3.3 → 9.0.0

data/spec/knapsack_pro/formatters/time_tracker_spec.rb

@@ -0,0 +1,448 @@
+require 'open3'
+require 'tmpdir'
+
+describe 'TimeTracker' do
+  around(:each) do |example|
+    Dir.mktmpdir(nil, 'spec_time_tracker') do |dir|
+      @dir = dir
+      example.run
+    end
+  end
+
+  describe '#queue' do
+    it 'single example' do
+      spec = <<~SPEC
+        describe 'KnapsackPro::Formatters::TimeTracker' do
+          it do
+            sleep 0.1
+            expect(1).to eq 1
+          end
+        end
+      SPEC
+
+      run_specs(spec, 'queue') do |spec_paths, queue|
+        expect(queue.size).to eq(1)
+        expect(queue[0]['path']).to eq(spec_paths[0])
+        expect(queue[0]['time_execution']).to be_between(0.10, 0.15)
+      end
+    end
+
+    it 'two files' do
+      spec0 = <<~SPEC
+        describe 'KnapsackPro::Formatters::TimeTracker 1' do
+          it do
+            sleep 0.1
+            expect(1).to eq 1
+          end
+        end
+      SPEC
+
+      spec1 = <<~SPEC
+        describe 'KnapsackPro::Formatters::TimeTracker 2' do
+          it do
+            sleep 0.2
+            expect(1).to eq 1
+          end
+        end
+      SPEC
+
+      run_specs([spec0, spec1], 'queue') do |spec_paths, queue|
+        expect(queue.size).to eq(2)
+        expect(queue[0]['path']).to eq(spec_paths[0])
+        expect(queue[0]['time_execution']).to be_between(0.10, 0.15)
+        expect(queue[1]['path']).to eq(spec_paths[1])
+        expect(queue[1]['time_execution']).to be_between(0.20, 0.25)
+      end
+    end
+
+    it 'failing example' do
+      spec = <<~SPEC
+        describe 'KnapsackPro::Formatters::TimeTracker' do
+          it do
+            sleep 0.1
+            expect(1).to eq 2
+          end
+        end
+      SPEC
+
+      run_specs(spec, 'queue') do |spec_paths, queue|
+        expect(queue.size).to eq(1)
+        expect(queue[0]['path']).to eq(spec_paths[0])
+        expect(queue[0]['time_execution']).to be_between(0.10, 0.15)
+      end
+    end
+
+    it 'pending example' do
+      spec = <<~SPEC
+        describe 'KnapsackPro::Formatters::TimeTracker' do
+          xit do
+            sleep 0.1
+            expect(1).to eq 2
+          end
+        end
+      SPEC
+
+      run_specs(spec, 'queue') do |spec_paths, queue|
+        expect(queue.size).to eq(1)
+        expect(queue[0]['path']).to eq(spec_paths[0])
+        expect(queue[0]['time_execution']).to eq(0.0)
+      end
+    end
+
+    it 'multiple top level groups' do
+      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, 'queue') do |spec_paths, queue|
+        expect(queue.size).to eq(1)
+        expect(queue[0]['path']).to eq(spec_paths[0])
+        expect(queue[0]['time_execution']).to be_between(0.30, 0.35)
+      end
+    end
+
+    it 'rspec split by test example' do
+      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, 'queue', env: 'TEST__SBTE=1') do |spec_paths, queue|
+        expect(queue.size).to eq(4)
+
+        spec_path = spec_paths[0]
+        expect(queue.find { |time| time['path'] == "#{spec_path}[1:1]" }['time_execution']).to be_between(0.00, 0.05).exclusive
+        expect(queue.find { |time| time['path'] == "#{spec_path}[1:2]" }['time_execution']).to be_between(0.10, 0.15)
+        expect(queue.find { |time| time['path'] == "#{spec_path}[2:1]" }['time_execution']).to be_between(0.20, 0.25)
+        expect(queue.find { |time| time['path'] == "#{spec_path}[2:2]" }['time_execution']).to be_between(0.30, 0.35)
+      end
+    end
+
+    it 'hooks' do
+      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, 'queue') do |spec_paths, queue|
+        expect(queue.size).to eq(1)
+        expect(queue[0]['path']).to eq(spec_paths[0])
+        expect(queue[0]['time_execution']).to be_between(0.60, 0.65)
+      end
+    end
+
+    it 'nested hooks' do
+      spec = <<~SPEC
+        describe 'KnapsackPro::Formatters::TimeTracker' do
+          before(:all) do
+            sleep 0.1
+          end
+
+          after(:all) do
+            sleep 0.1
+          end
+
+          it do
+            expect(1).to eq 1
+          end
+
+          describe do
+            before(:all) do
+              sleep 0.1
+            end
+
+            after(:all) do
+              sleep 0.1
+            end
+
+            it do
+              expect(1).to eq 1
+            end
+          end
+
+          describe do
+            before(:all) do
+              sleep 0.1
+            end
+
+            after(:all) do
+              sleep 0.1
+            end
+
+            it do
+              expect(1).to eq 1
+            end
+          end
+        end
+      SPEC
+
+      run_specs(spec, 'queue') do |spec_paths, queue|
+        expect(queue.size).to eq(1)
+        expect(queue[0]['path']).to eq(spec_paths[0])
+        expect(queue[0]['time_execution']).to be_between(0.60, 0.65)
+      end
+    end
+
+    it 'hooks with rspec split by test example' do
+      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, 'queue', env: 'TEST__SBTE=1') do |spec_paths, queue|
+        expect(queue.size).to eq(2)
+
+        spec_path = spec_paths[0]
+        expect(queue.find { |time| time['path'] == "#{spec_path}[1:1]" }['time_execution']).to be_between(0.40, 0.45)
+        expect(queue.find { |time| time['path'] == "#{spec_path}[1:2]" }['time_execution']).to be_between(0.40, 0.45)
+      end
+    end
+
+    it 'nested hooks with rspec split by test example' do
+      spec = <<~SPEC
+        describe 'KnapsackPro::Formatters::TimeTracker' do
+          before(:all) do
+            sleep 0.1
+          end
+
+          after(:all) do
+            sleep 0.1
+          end
+
+          it do
+            expect(1).to eq 1
+          end
+
+          describe do
+            before(:all) do
+              sleep 0.1
+            end
+
+            after(:all) do
+              sleep 0.1
+            end
+
+            it do
+              expect(1).to eq 1
+            end
+          end
+
+          describe do
+            before(:all) do
+              sleep 0.1
+            end
+
+            after(:all) do
+              sleep 0.1
+            end
+
+            it do
+              expect(1).to eq 1
+            end
+          end
+        end
+      SPEC
+
+      run_specs(spec, 'queue', env: 'TEST__SBTE=1') do |spec_paths, queue|
+        expect(queue.size).to eq(3)
+
+        spec_path = spec_paths[0]
+        expect(queue.find { |time| time['path'] == "#{spec_path}[1:1]" }['time_execution']).to be_between(0.20, 0.25)
+        expect(queue.find { |time| time['path'] == "#{spec_path}[1:2:1]" }['time_execution']).to be_between(0.40, 0.45)
+        expect(queue.find { |time| time['path'] == "#{spec_path}[1:3:1]" }['time_execution']).to be_between(0.40, 0.45)
+      end
+    end
+
+    it 'unknown path' do
+      spec = <<~SPEC
+        RSpec.configure do |config|
+          config.before(:all) do
+            time_tracker = ::RSpec.configuration.formatters.find { |f| f.class.to_s == 'TestableTimeTracker' }
+            time_tracker.scheduled_paths = ['#{@dir}/0_spec.rb']
+          end
+        end
+
+        describe 'KnapsackPro::Formatters::TimeTracker' do
+          it do
+            expect(1).to eq 1
+          end
+        end
+      SPEC
+
+      run_specs(spec, 'queue', env: 'TEST__EMPTY_FILE_PATH=1') do |spec_paths, queue|
+        expect(queue.size).to eq(1)
+        expect(queue[0]['path']).to eq(spec_paths[0])
+        expect(queue[0]['time_execution']).to eq(0.0)
+      end
+    end
+
+    it 'empty group' do
+      spec = <<~SPEC
+        RSpec.configure do |config|
+          config.before(:suite) do
+            time_tracker = ::RSpec.configuration.formatters.find { |f| f.class.to_s == 'TestableTimeTracker' }
+            time_tracker.scheduled_paths = ['#{@dir}/0_spec.rb']
+          end
+        end
+
+        describe 'KnapsackPro::Formatters::TimeTracker' do
+        end
+      SPEC
+
+      run_specs(spec, 'queue') do |spec_paths, queue|
+        expect(queue.size).to eq(1)
+        expect(queue[0]['path']).to eq(spec_paths[0])
+        expect(queue[0]['time_execution']).to eq(0.0)
+      end
+    end
+  end
+
+  describe '#duration' do
+    it do
+      spec = <<~SPEC
+        describe 'KnapsackPro::Formatters::TimeTracker' do
+          it do
+            expect(1).to eq 1
+          end
+        end
+      SPEC
+
+      run_specs(spec, 'duration') do |_, duration|
+        expect(duration).to be_between(0.00, 0.05).exclusive
+      end
+    end
+  end
+
+  describe '#unexecuted_test_files' do
+    it do
+      spec = <<~SPEC
+        RSpec.configure do |config|
+          config.before(:all) do
+            time_tracker = ::RSpec.configuration.formatters.find { |f| f.class.to_s == 'TestableTimeTracker' }
+            time_tracker.scheduled_paths = ['#{@dir}/0_spec.rb', 'foo_spec.rb[1:1]']
+          end
+        end
+
+        describe 'KnapsackPro::Formatters::TimeTracker' do
+          xit do
+          end
+        end
+      SPEC
+
+      run_specs(spec, 'unexecuted_test_files') do |spec_paths, unexecuted_test_files|
+        expect(unexecuted_test_files).to eq(["#{@dir}/0_spec.rb", 'foo_spec.rb[1:1]'])
+      end
+    end
+  end
+
+  describe '#batch' do
+    it do
+      spec = <<~SPEC
+        describe 'KnapsackPro::Formatters::TimeTracker' do
+          it do
+            sleep 0.1
+            expect(1).to eq 1
+          end
+        end
+      SPEC
+
+      run_specs(spec, 'batch') do |spec_paths, batch|
+        expect(batch.size).to eq(1)
+        expect(batch[0]['path']).to eq(spec_paths[0])
+        expect(batch[0]['time_execution']).to be_between(0.10, 0.15)
+      end
+    end
+  end
+
+  def run_specs(specs, method, env: '')
+    paths = Array(specs).map.with_index do |spec, i|
+      path = "#{@dir}/#{i}_spec.rb"
+      File.write(path, spec)
+      path
+    end
+
+    out, err, _status = Open3.capture3("#{env} TEST__METHOD=#{method} bundle exec rspec --default-path spec_time_tracker -f TestableTimeTracker spec_time_tracker")
+    puts err if ENV['TEST__DEBUG']
+    result = Marshal.load(out.lines.last)
+
+    yield(paths, result)
+  end
+end

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

@@ -59,7 +59,7 @@ describe KnapsackPro::Pure::Queue::RSpecPure do
 
     context 'when the order option is not random' do
       let(:args) { ['--order', 'defined'] }
-      let(:seed) { KnapsackPro::Extensions::RSpecExtension::Seed.new(value: nil, used?: false) }
+      let(:seed) { KnapsackPro::Extensions::RSpecExtension::Seed.new(nil, false) }
 
       it 'does not add the seed option to args' do
         expect(subject).to eq ['--order', 'defined']
@@ -71,7 +71,7 @@ describe KnapsackPro::Pure::Queue::RSpecPure 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) }
+          let(:seed) { KnapsackPro::Extensions::RSpecExtension::Seed.new('123', false) }
 
           it 'does not add the seed option to args' do
             expect(subject).to eq ['--order', random_option_value]
@@ -79,7 +79,7 @@ describe KnapsackPro::Pure::Queue::RSpecPure do
         end
 
         context 'when the seed is used' do
-          let(:seed) { KnapsackPro::Extensions::RSpecExtension::Seed.new(value: '123', used?: true) }
+          let(:seed) { KnapsackPro::Extensions::RSpecExtension::Seed.new('123', true) }
 
           it 'adds the seed option to args' do
             expect(subject).to eq ['--order', random_option_value, '--seed', '123']
@@ -90,7 +90,7 @@ describe KnapsackPro::Pure::Queue::RSpecPure do
 
     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) }
+      let(:seed) { KnapsackPro::Extensions::RSpecExtension::Seed.new('123', true) }
 
       it 'does not add the seed option to args' do
         expect(subject).to eq ['--order', 'rand:123']
@@ -99,7 +99,7 @@ describe KnapsackPro::Pure::Queue::RSpecPure do
 
     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) }
+      let(:seed) { KnapsackPro::Extensions::RSpecExtension::Seed.new('123', true) }
 
       it 'adds the seed option to args' do
         expect(subject).to eq ['--format', 'documentation', '--seed', '123']

data/spec/knapsack_pro/test_case_detectors/rspec_test_example_detector_spec.rb

@@ -148,7 +148,7 @@ describe KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector do
           subject_class.new.generate_json_report(rspec_args)
         end
           .to output(/Please only use one of `--force-color` and `--no-color`/).to_stderr
-          .and output(%r{ERROR -- : \[knapsack_pro\] Failed to generate the slow test files report: bundle exec rspec --no-color --force-color --format json --dry-run --out .knapsack_pro/test_case_detectors/rspec/rspec_dry_run_json_report_node_0.json --default-path spec spec/a_spec.rb}).to_stdout
+          .and output(%r{ERROR -- knapsack_pro: Failed to generate the slow test files report: bundle exec rspec --no-color --force-color --format json --dry-run --out .knapsack_pro/test_case_detectors/rspec/rspec_dry_run_json_report_node_0.json --default-path spec spec/a_spec.rb}).to_stdout
           .and raise_error(SystemExit) { |error| expect(error.status).to eq 1 }
       end
     end

data/spec/knapsack_pro_spec.rb

@@ -1,3 +1,5 @@
+require 'tmpdir'
+
 describe KnapsackPro do
   describe '.root' do
     subject { described_class.root }
@@ -6,70 +8,92 @@ describe KnapsackPro do
   end
 
   describe '.logger' do
-    let(:logger_wrapper) { double }
-
     subject { described_class.logger }
 
     before(:each) do
       described_class.reset_logger!
       KnapsackPro::Config::Env.remove_instance_variable(:@ci_node_index) if KnapsackPro::Config::Env.instance_variable_defined?(:@ci_node_index)
     end
+
     after { described_class.reset_logger! }
 
     context 'when KNAPSACK_PRO_LOG_DIR is set' do
-      let(:logger) { instance_double(Logger) }
-
       context 'when KNAPSACK_PRO_CI_NODE_INDEX is set' do
-        before do
-          stub_const('ENV', {
-            'KNAPSACK_PRO_LOG_DIR' => 'log',
-            'KNAPSACK_PRO_CI_NODE_INDEX' => 1,
-          })
-
-          expect(Logger).to receive(:new).with('log/knapsack_pro_node_1.log').and_return(logger)
-          expect(logger).to receive(:level=).with(Logger::INFO)
-          expect(KnapsackPro::LoggerWrapper).to receive(:new).with(logger).and_return(logger_wrapper)
+        it 'logs to a file in that dir named after the node index' do
+          Dir.mktmpdir do |dir|
+            stub_const('ENV', 'KNAPSACK_PRO_LOG_DIR' => dir, 'KNAPSACK_PRO_CI_NODE_INDEX' => 1)
+
+            KnapsackPro.logger.debug 'debug'
+            KnapsackPro.logger.info 'info'
+            KnapsackPro.logger.warn 'warn'
+
+            log = File.read "#{dir}/knapsack_pro_node_1.log"
+            expect(log).not_to include('DEBUG -- knapsack_pro: debug')
+            expect(log).to include('INFO -- knapsack_pro: info')
+            expect(log).to include('WARN -- knapsack_pro: warn')
+          end
         end
-
-        it { should eql logger_wrapper }
       end
 
       context 'when KNAPSACK_PRO_CI_NODE_INDEX is not set' do
-        before do
-          stub_const('ENV', {
-            'KNAPSACK_PRO_LOG_DIR' => 'log',
-          })
-
-          expect(Logger).to receive(:new).with('log/knapsack_pro_node_0.log').and_return(logger)
-          expect(logger).to receive(:level=).with(Logger::INFO)
-          expect(KnapsackPro::LoggerWrapper).to receive(:new).with(logger).and_return(logger_wrapper)
+        it 'logs to a file in that dir named after node index 0' do
+          Dir.mktmpdir do |dir|
+            stub_const('ENV', 'KNAPSACK_PRO_LOG_DIR' => dir)
+
+            KnapsackPro.logger.debug 'debug'
+            KnapsackPro.logger.info 'info'
+            KnapsackPro.logger.warn 'warn'
+
+            log = File.read "#{dir}/knapsack_pro_node_0.log"
+            expect(log).not_to include('DEBUG -- knapsack_pro: debug')
+            expect(log).to include('INFO -- knapsack_pro: info')
+            expect(log).to include('WARN -- knapsack_pro: warn')
+          end
         end
-
-        it { should eql logger_wrapper }
       end
     end
 
-    context 'when default logger' do
-      let(:logger) { instance_double(Logger) }
+    context 'with the default logger' do
+      it 'ignores debug to stdout' do
+        expect do
+          KnapsackPro.stdout = $stdout
+          KnapsackPro.logger.debug 'debug'
+        end
+          .not_to output.to_stdout
+      end
 
-      before do
-        expect(Logger).to receive(:new).with(STDOUT).and_return(logger)
-        expect(logger).to receive(:level=).with(Logger::INFO)
-        expect(KnapsackPro::LoggerWrapper).to receive(:new).with(logger).and_return(logger_wrapper)
+      it 'logs info to stdout' do
+        expect do
+          KnapsackPro.stdout = $stdout
+          KnapsackPro.logger.info 'info'
+        end
+          .to output(/INFO -- knapsack_pro: info/)
+          .to_stdout
       end
 
-      it { should eql logger_wrapper }
+      it 'logs warn to stdout' do
+        expect do
+          KnapsackPro.stdout = $stdout
+          KnapsackPro.logger.warn 'warn'
+        end
+          .to output(/WARN -- knapsack_pro: warn/)
+          .to_stdout
+      end
     end
 
-    context 'when custom logger' do
-      let(:logger) { double('custom logger') }
+    context 'with a custom logger' do
+      it 'logs using it' do
+        stream = StringIO.new
+        KnapsackPro.logger = ::Logger.new(stream)
 
-      before do
-        expect(KnapsackPro::LoggerWrapper).to receive(:new).with(logger).and_return(logger_wrapper)
-        described_class.logger = logger
-      end
+        KnapsackPro.logger.debug 'debug'
+        KnapsackPro.logger.info 'info'
+        KnapsackPro.logger.warn 'warn'
 
-      it { should eql logger_wrapper }
+        expect(stream.string).to include('DEBUG -- knapsack_pro: debug')
+        expect(stream.string).to include('INFO -- knapsack_pro: info')
+        expect(stream.string).to include('WARN -- knapsack_pro: warn')
+      end
     end
   end
 

data/spec_time_tracker/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'knapsack_pro'
+require_relative '../lib/knapsack_pro/formatters/time_tracker'
+
+class TestableTimeTracker < KnapsackPro::Formatters::TimeTracker
+  ::RSpec::Core::Formatters.register self, :dump_summary
+
+  if ENV['TEST__SBTE']
+    def rspec_split_by_test_example?(_file)
+      true
+    end
+  end
+
+  if ENV['TEST__EMPTY_FILE_PATH']
+    def file_path_for(_example)
+      ''
+    end
+  end
+
+  def dump_summary(_)
+    method = ENV['TEST__METHOD']
+    result = send(method)
+    puts Marshal.dump(result)
+    return if ENV['TEST__DEBUG'].nil?
+
+    warn 'DEBUG'
+    warn result
+    warn 'GUBED'
+  end
+end