knapsack_pro 5.6.0 → 6.0.0

data/lib/knapsack_pro/runners/queue/rspec_runner.rb

@@ -8,6 +8,8 @@ module KnapsackPro
 
         def self.run(args)
           require 'rspec/core'
+          require_relative '../../formatters/time_tracker'
+          require_relative '../../formatters/time_tracker_fetcher'
           require_relative '../../formatters/rspec_queue_summary_formatter'
           require_relative '../../formatters/rspec_queue_profile_formatter_extension'
 
@@ -27,6 +29,7 @@ module KnapsackPro
           cli_args += [
             # shows summary of all tests executed in Queue Mode at the very end
             '--format', KnapsackPro::Formatters::RSpecQueueSummaryFormatter.to_s,
+            '--format', KnapsackPro::Formatters::TimeTracker.to_s,
             '--default-path', runner.test_dir,
           ]
 
@@ -72,7 +75,8 @@ module KnapsackPro
 
             KnapsackPro::Hooks::Queue.call_after_queue
 
-            KnapsackPro::Report.save_node_queue_to_api
+            time_tracker = KnapsackPro::Formatters::TimeTrackerFetcher.call
+            KnapsackPro::Report.save_node_queue_to_api(time_tracker&.queue(all_test_file_paths) || [])
 
             return {
               status: :completed,
@@ -82,15 +86,12 @@ module KnapsackPro
             subset_queue_id = KnapsackPro::Config::EnvGenerator.set_subset_queue_id
             ENV['KNAPSACK_PRO_SUBSET_QUEUE_ID'] = subset_queue_id
 
-            KnapsackPro.tracker.reset!
-            KnapsackPro.tracker.set_prerun_tests(test_file_paths)
-
             KnapsackPro::Hooks::Queue.call_before_subset_queue
 
             all_test_file_paths += test_file_paths
             cli_args = args + test_file_paths
 
-            ensure_spec_opts_have_rspec_queue_summary_formatter
+            ensure_spec_opts_have_knapsack_pro_formatters
             options = ::RSpec::Core::ConfigurationOptions.new(cli_args)
             rspec_runner = ::RSpec::Core::Runner.new(options)
 
@@ -99,7 +100,7 @@ module KnapsackPro
               exitstatus = exit_code if exit_code != 0
             rescue Exception => exception
               KnapsackPro.logger.error("Having exception when running RSpec: #{exception.inspect}")
-              KnapsackPro::Formatters::RSpecQueueSummaryFormatter.print_exit_summary
+              KnapsackPro::Formatters::RSpecQueueSummaryFormatter.print_exit_summary(all_test_file_paths)
               KnapsackPro::Hooks::Queue.call_after_subset_queue
               KnapsackPro::Hooks::Queue.call_after_queue
               Kernel.exit(1)
@@ -121,8 +122,6 @@ module KnapsackPro
 
               KnapsackPro::Hooks::Queue.call_after_subset_queue
 
-              KnapsackPro::Report.save_subset_queue_to_file
-
               return {
                 status: :next,
                 runner: runner,
@@ -135,13 +134,23 @@ module KnapsackPro
           end
         end
 
-        def self.ensure_spec_opts_have_rspec_queue_summary_formatter
-          spec_opts = ENV['SPEC_OPTS']
+        def self.ensure_spec_opts_have_knapsack_pro_formatters
+          return unless ENV['SPEC_OPTS']
+
+          if [
+              ENV['SPEC_OPTS'].include?(KnapsackPro::Formatters::RSpecQueueSummaryFormatter.to_s),
+              ENV['SPEC_OPTS'].include?(KnapsackPro::Formatters::TimeTracker.to_s),
+          ].all?
+            return
+          end
 
-          return unless spec_opts
-          return if spec_opts.include?(KnapsackPro::Formatters::RSpecQueueSummaryFormatter.to_s)
+          unless ENV['SPEC_OPTS'].include?(KnapsackPro::Formatters::RSpecQueueSummaryFormatter.to_s)
+            ENV['SPEC_OPTS'] = "#{ENV['SPEC_OPTS']} --format #{KnapsackPro::Formatters::RSpecQueueSummaryFormatter}"
+          end
 
-          ENV['SPEC_OPTS'] = "#{spec_opts} --format #{KnapsackPro::Formatters::RSpecQueueSummaryFormatter.to_s}"
+          unless ENV['SPEC_OPTS'].include?(KnapsackPro::Formatters::TimeTracker.to_s)
+            ENV['SPEC_OPTS'] = "#{ENV['SPEC_OPTS']} --format #{KnapsackPro::Formatters::TimeTracker}"
+          end
         end
 
         private
@@ -158,7 +167,9 @@ module KnapsackPro
             KnapsackPro.logger.info("To retry all the tests assigned to this CI node, please run the following command on your machine:")
           end
 
-          stringified_cli_args = cli_args.join(' ').sub(" --format #{KnapsackPro::Formatters::RSpecQueueSummaryFormatter}", '')
+          stringified_cli_args = cli_args.join(' ')
+            .sub(" --format #{KnapsackPro::Formatters::RSpecQueueSummaryFormatter}", '')
+            .sub(" --format #{KnapsackPro::Formatters::TimeTracker}", '')
 
           KnapsackPro.logger.info(
             "bundle exec rspec #{stringified_cli_args} " +

data/lib/knapsack_pro/runners/rspec_runner.rb

@@ -19,8 +19,6 @@ module KnapsackPro
           cli_args = (args || '').split
           adapter_class.ensure_no_tag_option_when_rspec_split_by_test_examples_enabled!(cli_args)
 
-          KnapsackPro.tracker.set_prerun_tests(runner.test_file_paths)
-
           require 'rspec/core/rake_task'
 
           task_name = 'knapsack_pro:rspec_run'
@@ -33,12 +31,30 @@ module KnapsackPro
             # because pattern does not accept test example path like spec/a_spec.rb[1:2]
             # instead we pass test files and test example paths to t.rspec_opts
             t.pattern = []
-            t.rspec_opts = "#{args} --default-path #{runner.test_dir} #{runner.stringify_test_file_paths}"
+            t.rspec_opts = "#{args} #{self.formatters} --default-path #{runner.test_dir} #{runner.stringify_test_file_paths}"
             t.verbose = KnapsackPro::Config::Env.log_level < ::Logger::WARN
           end
           Rake::Task[task_name].invoke
         end
       end
+
+      # Use RSpec::Core::ConfigurationOptions to respect external configurations like .rspec
+      def self.formatters
+        require_relative '../formatters/time_tracker'
+
+        formatters = ::RSpec::Core::ConfigurationOptions
+          .new([])
+          .options
+          .fetch(:formatters, [])
+          .map do |formatter, output|
+            arg = "--format #{formatter}"
+            arg += " --out #{output}" if output
+            arg
+          end
+        formatters = ['--format progress'] if formatters.empty?
+        formatters += ["--format #{KnapsackPro::Formatters::TimeTracker}"]
+        formatters.join(' ')
+      end
     end
   end
 end

data/lib/knapsack_pro/tracker.rb

@@ -8,11 +8,10 @@ module KnapsackPro
     # to better allocate it in Queue Mode for future CI build runs
     DEFAULT_TEST_FILE_TIME = 0.0 # seconds
 
-    attr_reader :global_time_since_beginning, :global_time, :test_files_with_time, :prerun_tests_loaded
+    attr_reader :global_time, :test_files_with_time, :prerun_tests_loaded
     attr_writer :current_test_path
 
     def initialize
-      @global_time_since_beginning = 0
       KnapsackPro::Config::TempFiles.ensure_temp_directory_exists!
       FileUtils.mkdir_p(tracker_dir_path)
       set_defaults
@@ -70,12 +69,6 @@ module KnapsackPro
       @prerun_tests_loaded = true
     end
 
-    def unexecuted_test_files
-      @test_files_with_time.map do |path, hash|
-        path unless hash[:measured_time]
-      end.compact
-    end
-
     def to_a
       # When the test files are not loaded in the memory then load them from the disk.
       # Useful for the Regular Mode when the memory is not shared between tracker instances.
@@ -141,7 +134,6 @@ module KnapsackPro
 
     def update_global_time(execution_time)
       @global_time += execution_time
-      @global_time_since_beginning += execution_time
     end
 
     def update_test_file_time(execution_time)

data/lib/knapsack_pro/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KnapsackPro
-  VERSION = '5.6.0'
+  VERSION = '6.0.0'
 end

data/lib/knapsack_pro.rb

@@ -11,7 +11,6 @@ require 'securerandom'
 require 'timeout'
 require_relative 'knapsack_pro/urls'
 require_relative 'knapsack_pro/version'
-require_relative 'knapsack_pro/extensions/time'
 require_relative 'knapsack_pro/hooks/queue'
 require_relative 'knapsack_pro/utils'
 require_relative 'knapsack_pro/config/ci/base'

data/spec/knapsack_pro/adapters/base_adapter_spec.rb

@@ -42,6 +42,18 @@ describe KnapsackPro::Adapters::BaseAdapter do
     end
   end
 
+  describe '.split_by_test_cases_enabled?' do
+    subject { described_class.split_by_test_cases_enabled? }
+
+    it { expect(subject).to be false }
+  end
+
+  describe '.test_file_cases_for' do
+    subject { described_class.test_file_cases_for([]) }
+
+    it { expect { subject }.to raise_error NotImplementedError }
+  end
+
   describe '.slow_test_file?' do
     let(:adapter_class) { double }
     let(:slow_test_files) do

data/spec/knapsack_pro/adapters/rspec_adapter_spec.rb

@@ -1,3 +1,5 @@
+require_relative '../../../lib/knapsack_pro/formatters/time_tracker'
+
 describe KnapsackPro::Adapters::RSpecAdapter do
   it 'backwards compatibility with knapsack gem old rspec adapter name' do
     expect(KnapsackPro::Adapters::RspecAdapter.new).to be_kind_of(described_class)
@@ -8,10 +10,85 @@ describe KnapsackPro::Adapters::RSpecAdapter do
   end
 
   context do
-    before { expect(::RSpec).to receive(:configure) }
+    before { expect(::RSpec).to receive(:configure).at_least(:once) }
     it_behaves_like 'adapter'
   end
 
+  describe '.split_by_test_cases_enabled?' do
+    subject { described_class.split_by_test_cases_enabled? }
+
+    before do
+      expect(KnapsackPro::Config::Env).to receive(:rspec_split_by_test_examples?).and_return(rspec_split_by_test_examples_enabled)
+    end
+
+    context 'when the RSpec split by test examples is enabled' do
+      let(:rspec_split_by_test_examples_enabled) { true }
+
+      it { expect(subject).to be true }
+
+      context 'when the RSpec version is < 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
+      end
+    end
+
+    context 'when the RSpec split by test examples is disabled' do
+      let(:rspec_split_by_test_examples_enabled) { false }
+
+      it { expect(subject).to be false }
+    end
+  end
+
+  describe '.test_file_cases_for' do
+    let(:slow_test_files) do
+      [
+        '1_spec.rb',
+        '2_spec.rb',
+        '3_spec.rb',
+        '4_spec.rb',
+        '5_spec.rb',
+      ]
+    end
+
+    subject { described_class.test_file_cases_for(slow_test_files) }
+
+    before do
+      logger = instance_double(Logger)
+      expect(KnapsackPro).to receive(:logger).and_return(logger)
+      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 test cases). Thanks to that, a single slow test file can be split across parallel CI nodes. Analyzing 5 slow test files.")
+
+      cmd = 'RACK_ENV=test RAILS_ENV=test bundle exec rake knapsack_pro:rspec_test_example_detector'
+      expect(Kernel).to receive(:system).with(cmd).and_return(cmd_result)
+    end
+
+    context 'when the rake task to detect RSpec test examples succeeded' do
+      let(:cmd_result) { true }
+
+      it 'returns test example paths for slow test files' do
+        rspec_test_example_detector = instance_double(KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector)
+        expect(KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector).to receive(:new).and_return(rspec_test_example_detector)
+
+        test_file_example_paths = double
+        expect(rspec_test_example_detector).to receive(:test_file_example_paths).and_return(test_file_example_paths)
+
+        expect(subject).to eq test_file_example_paths
+      end
+    end
+
+    context 'when the rake task to detect RSpec test examples failed' do
+      let(:cmd_result) { false }
+
+      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')
+      end
+    end
+  end
+
   describe '.ensure_no_tag_option_when_rspec_split_by_test_examples_enabled!' do
     let(:cli_args) { double }
 
@@ -162,59 +239,70 @@ describe KnapsackPro::Adapters::RSpecAdapter do
     end
   end
 
-  describe '.test_path' do
-    let(:example_group) do
-      {
-        file_path: '1_shared_example.rb',
-        parent_example_group: {
-          file_path: '2_shared_example.rb',
-          parent_example_group: {
-            file_path: 'a_spec.rb'
-          }
-        }
-      }
+  describe '.file_path_for' do
+    let(:current_example) { ::RSpec.describe.example }
+
+    subject { described_class.file_path_for(current_example) }
+
+    context "when id ends in _spec.rb" do
+      it "returns the first part of the id" do
+        allow(current_example).to receive(:id).and_return("./foo_spec.rb[1:1]")
+
+        expect(subject).to eq('./foo_spec.rb')
+      end
     end
-    let(:current_example) do
-      OpenStruct.new(metadata: {
-        example_group: example_group
-      })
+
+    context "when id does not end in _spec.rb" do
+      it "returns the file_path" do
+        allow(current_example).to receive(:id).and_return("./foo.rb")
+        allow(current_example).to receive(:metadata).and_return(file_path: "./foo_spec.rb")
+
+        expect(subject).to eq('./foo_spec.rb')
+      end
     end
 
-    subject { described_class.test_path(current_example) }
+    context "when id and file_path do not end in _spec.rb" do
+      it "returns the example_group's file_path" do
+        allow(current_example).to receive(:id).and_return("./foo.rb")
+        allow(current_example).to receive(:metadata).and_return(
+          file_path: "./foo.rb", example_group: { file_path: "./foo_spec.rb" }
+        )
 
-    it { should eql 'a_spec.rb' }
+        expect(subject).to eq('./foo_spec.rb')
+      end
+    end
 
-    context 'with turnip features' do
-      describe 'when the turnip version is less than 2' do
-        let(:example_group) do
-          {
-            file_path: "./spec/features/logging_in.feature",
-            turnip: true,
+    context "when id, file_path, and example_group's file_path do not end in _spec.rb" do
+      it "returns the top_level_group's file_path" do
+        allow(current_example).to receive(:id).and_return("./foo.rb")
+        allow(current_example).to receive(:metadata).and_return(
+          file_path: "./foo.rb",
+          example_group: {
+            file_path: "./foo.rb",
             parent_example_group: {
-              file_path: "gems/turnip-1.2.4/lib/turnip/rspec.rb"
+              file_path: "./foo_spec.rb",
             }
           }
-        end
+        )
 
-        before { stub_const("Turnip::VERSION", '1.2.4') }
-
-        it { should eql './spec/features/logging_in.feature' }
+        expect(subject).to eq('./foo_spec.rb')
       end
+    end
 
-      describe 'when turnip is version 2 or greater' do
-        let(:example_group) do
-          {
-            file_path: "gems/turnip-2.0.0/lib/turnip/rspec.rb",
-            turnip: true,
+    context "when id, file_path, example_group's, and top_level_group's file_path do not end in _spec.rb" do
+      it "returns empty string" do
+        allow(current_example).to receive(:id).and_return("./foo.rb")
+        allow(current_example).to receive(:metadata).and_return(
+          file_path: "./foo.rb",
+          example_group: {
+            file_path: "./foo.rb",
             parent_example_group: {
-              file_path: "./spec/features/logging_in.feature",
+              file_path: "./foo.rb",
             }
           }
-        end
-
-        before { stub_const("Turnip::VERSION",  '2.0.0') }
+        )
 
-        it { should eql './spec/features/logging_in.feature' }
+        expect(subject).to eq('')
       end
     end
   end
@@ -223,155 +311,48 @@ describe KnapsackPro::Adapters::RSpecAdapter do
     let(:config) { double }
 
     describe '#bind_time_tracker' do
-      let(:tracker) { instance_double(KnapsackPro::Tracker) }
-      let(:logger) { instance_double(Logger) }
-      let(:global_time) { 'Global time: 01m 05s' }
-      let(:test_path) { 'spec/a_spec.rb' }
       let(:current_example) { double(metadata: {}) }
 
       context "when the example's metadata has :focus tag AND RSpec inclusion rule includes :focus" do
         let(:current_example) { double(metadata: { focus: true }) }
+        let(:test_path) { 'spec/a_spec.rb' }
 
         it do
-          expect(KnapsackPro::Config::Env).to receive(:rspec_split_by_test_examples?).and_return(false)
-
-          expect(config).to receive(:prepend_before).with(:context).and_yield
-
-          allow(KnapsackPro).to receive(:tracker).and_return(tracker)
-          expect(tracker).to receive(:start_timer).ordered
-
           expect(config).to receive(:around).with(:each).and_yield(current_example)
           expect(::RSpec).to receive(:configure).and_yield(config)
 
-          expect(tracker).to receive(:current_test_path).ordered.and_return(test_path)
-          expect(tracker).to receive(:stop_timer).ordered
-
-          expect(described_class).to receive(:test_path).with(current_example).and_return(test_path)
-
-          expect(tracker).to receive(:current_test_path=).with(test_path).ordered
+          expect(described_class).to receive(:file_path_for).with(current_example).and_return(test_path)
 
           expect(described_class).to receive_message_chain(:rspec_configuration, :filter, :rules, :[]).with(:focus).and_return(true)
 
           expect {
             subject.bind_time_tracker
-          }.to raise_error /We detected a test file path spec\/a_spec\.rb with a test using the metadata `:focus` tag/
+          }.to raise_error /Knapsack Pro found an example tagged with focus in spec\/a_spec\.rb/i
         end
       end
 
-      context 'when rspec split by test examples is disabled' do
-        before do
-          expect(KnapsackPro::Config::Env).to receive(:rspec_split_by_test_examples?).and_return(false)
-        end
+      context 'with no focus' do
+        let(:logger) { instance_double(Logger) }
+        let(:duration) { 65 }
+        let(:global_time) { 'Global time execution for tests: 01m 05s' }
+        let(:time_tracker) { instance_double(KnapsackPro::Formatters::TimeTracker) }
 
         it 'records time for current test path' do
-          expect(config).to receive(:prepend_before).with(:context).and_yield
-
-          allow(KnapsackPro).to receive(:tracker).and_return(tracker)
-          expect(tracker).to receive(:start_timer).ordered
-
           expect(config).to receive(:around).with(:each).and_yield(current_example)
-          expect(config).to receive(:append_after).with(:context).and_yield
           expect(config).to receive(:after).with(:suite).and_yield
-          expect(::RSpec).to receive(:configure).and_yield(config)
-
-          expect(tracker).to receive(:current_test_path).ordered.and_return(test_path)
-          expect(tracker).to receive(:stop_timer).ordered
-
-          expect(described_class).to receive(:test_path).with(current_example).and_return(test_path)
-
-          expect(tracker).to receive(:current_test_path=).with(test_path).ordered
+          expect(::RSpec).to receive(:configure).twice.and_yield(config)
 
           expect(current_example).to receive(:run)
 
-          expect(tracker).to receive(:stop_timer).ordered
+          expect(time_tracker).to receive(:batch_duration).and_return(duration)
+          expect(KnapsackPro::Formatters::TimeTrackerFetcher).to receive(:call).and_return(time_tracker)
 
-          expect(KnapsackPro::Presenter).to receive(:global_time).and_return(global_time)
           expect(KnapsackPro).to receive(:logger).and_return(logger)
           expect(logger).to receive(:debug).with(global_time)
 
           subject.bind_time_tracker
         end
       end
-
-      context 'when rspec split by test examples is enabled' do
-        let(:test_example_path) { 'spec/a_spec.rb[1:1]' }
-
-        before do
-          expect(KnapsackPro::Config::Env).to receive(:rspec_split_by_test_examples?).and_return(true)
-        end
-
-        context 'when current test_path is a slow test file' do
-          before do
-            expect(described_class).to receive(:slow_test_file?).with(described_class, test_path).and_return(true)
-          end
-
-          it 'records time for example.id' do
-            expect(current_example).to receive(:id).and_return(test_example_path)
-
-            expect(config).to receive(:prepend_before).with(:context).and_yield
-
-            allow(KnapsackPro).to receive(:tracker).and_return(tracker)
-            expect(tracker).to receive(:start_timer).ordered
-
-            expect(config).to receive(:around).with(:each).and_yield(current_example)
-            expect(config).to receive(:append_after).with(:context).and_yield
-            expect(config).to receive(:after).with(:suite).and_yield
-            expect(::RSpec).to receive(:configure).and_yield(config)
-
-            expect(tracker).to receive(:current_test_path).ordered.and_return(test_path)
-            expect(tracker).to receive(:stop_timer).ordered
-
-            expect(described_class).to receive(:test_path).with(current_example).and_return(test_path)
-
-            expect(tracker).to receive(:current_test_path=).with(test_example_path).ordered
-
-            expect(current_example).to receive(:run)
-
-            expect(tracker).to receive(:stop_timer).ordered
-
-            expect(KnapsackPro::Presenter).to receive(:global_time).and_return(global_time)
-            expect(KnapsackPro).to receive(:logger).and_return(logger)
-            expect(logger).to receive(:debug).with(global_time)
-
-            subject.bind_time_tracker
-          end
-        end
-
-        context 'when current test_path is not a slow test file' do
-          before do
-            expect(described_class).to receive(:slow_test_file?).with(described_class, test_path).and_return(false)
-          end
-
-          it 'records time for current test path' do
-            expect(config).to receive(:prepend_before).with(:context).and_yield
-
-            allow(KnapsackPro).to receive(:tracker).and_return(tracker)
-            expect(tracker).to receive(:start_timer).ordered
-
-            expect(config).to receive(:around).with(:each).and_yield(current_example)
-            expect(config).to receive(:append_after).with(:context).and_yield
-            expect(config).to receive(:after).with(:suite).and_yield
-            expect(::RSpec).to receive(:configure).and_yield(config)
-
-            expect(described_class).to receive(:test_path).with(current_example).and_return(test_path)
-
-            expect(tracker).to receive(:current_test_path).ordered.and_return(test_path)
-            expect(tracker).to receive(:stop_timer).ordered
-
-            expect(tracker).to receive(:current_test_path=).with(test_path).ordered
-
-            expect(current_example).to receive(:run)
-
-            expect(tracker).to receive(:stop_timer).ordered
-
-            expect(KnapsackPro::Presenter).to receive(:global_time).and_return(global_time)
-            expect(KnapsackPro).to receive(:logger).and_return(logger)
-            expect(logger).to receive(:debug).with(global_time)
-
-            subject.bind_time_tracker
-          end
-        end
-      end
     end
 
     describe '#bind_save_report' do
@@ -379,7 +360,11 @@ describe KnapsackPro::Adapters::RSpecAdapter do
         expect(config).to receive(:after).with(:suite).and_yield
         expect(::RSpec).to receive(:configure).and_yield(config)
 
-        expect(KnapsackPro::Report).to receive(:save)
+        time_tracker = instance_double(KnapsackPro::Formatters::TimeTracker)
+        times = [{ path: "foo_spec.rb", time_execution: 1.0 }]
+        expect(time_tracker).to receive(:batch).and_return(times)
+        expect(KnapsackPro::Formatters::TimeTrackerFetcher).to receive(:call).and_return(time_tracker)
+        expect(KnapsackPro::Report).to receive(:save).with(times)
 
         subject.bind_save_report
       end