knapsack_pro 6.0.3 → 7.0.0

data/lib/knapsack_pro/adapters/rspec_adapter.rb

@@ -87,7 +87,7 @@ module KnapsackPro
 
       def bind_time_tracker
         ensure_no_focus!
-        log_batch_duration
+        log_tests_duration
       end
 
       def ensure_no_focus!
@@ -105,12 +105,14 @@ module KnapsackPro
         end
       end
 
-      def log_batch_duration
+      def log_tests_duration
         ::RSpec.configure do |config|
-          config.after(:suite) do
+          config.append_after(:suite) do
             time_tracker = KnapsackPro::Formatters::TimeTrackerFetcher.call
-            formatted = KnapsackPro::Presenter.global_time(time_tracker.batch_duration)
-            KnapsackPro.logger.debug(formatted)
+            if time_tracker
+              formatted = KnapsackPro::Presenter.global_time(time_tracker.duration)
+              KnapsackPro.logger.debug(formatted)
+            end
           end
         end
       end
@@ -127,10 +129,15 @@ module KnapsackPro
       def bind_before_queue_hook
         ::RSpec.configure do |config|
           config.before(:suite) do
-            unless ENV['KNAPSACK_PRO_BEFORE_QUEUE_HOOK_CALLED']
-              ENV['KNAPSACK_PRO_BEFORE_QUEUE_HOOK_CALLED'] = 'true'
-              KnapsackPro::Hooks::Queue.call_before_queue
-            end
+            KnapsackPro::Hooks::Queue.call_before_queue
+          end
+        end
+      end
+
+      def bind_after_queue_hook
+        ::RSpec.configure do |config|
+          config.after(:suite) do
+            KnapsackPro::Hooks::Queue.call_after_queue
           end
         end
       end

data/lib/knapsack_pro/config/env.rb

@@ -144,14 +144,6 @@ module KnapsackPro
           test_files_encrypted == 'true'
         end
 
-        def modify_default_rspec_formatters
-          ENV.fetch('KNAPSACK_PRO_MODIFY_DEFAULT_RSPEC_FORMATTERS', true)
-        end
-
-        def modify_default_rspec_formatters?
-          modify_default_rspec_formatters.to_s == 'true'
-        end
-
         def branch_encrypted
           ENV['KNAPSACK_PRO_BRANCH_ENCRYPTED']
         end
@@ -276,7 +268,7 @@ module KnapsackPro
         end
 
         def log_level
-          LOG_LEVELS[ENV['KNAPSACK_PRO_LOG_LEVEL'].to_s.downcase] || ::Logger::DEBUG
+          LOG_LEVELS[ENV['KNAPSACK_PRO_LOG_LEVEL'].to_s.downcase] || ::Logger::INFO
         end
 
         def log_dir

data/lib/knapsack_pro/extensions/rspec_extension.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module KnapsackPro
+  module Extensions
+    # Facade to abstract calls to internal RSpec methods.
+    # To allow comparing the monkey patch with the original RSpec code, keep a similar method structure and permalink to the source.
+    module RSpecExtension
+      Seed = Struct.new(:value, :used?)
+
+      def self.setup!
+        RSpec::Core::World.prepend(World)
+        RSpec::Core::Runner.prepend(Runner)
+        RSpec::Core::Configuration.prepend(Configuration)
+      end
+
+      module World
+        # Based on:
+        # https://github.com/rspec/rspec-core/blob/f8c8880dabd8f0544a6f91d8d4c857c1bd8df903/lib/rspec/core/world.rb#L171
+        #
+        # Filters are not announced because we do not load tests during setup. It would print `No examples found.` and we don't want that.
+        def knapsack__announce_filters
+          fail_if_config_and_cli_options_invalid
+        end
+      end
+
+      module Runner
+        # Based on:
+        # https://github.com/rspec/rspec-core/blob/f8c8880dabd8f0544a6f91d8d4c857c1bd8df903/lib/rspec/core/runner.rb#L98
+        #
+        # `@configuration.load_spec_files` is not called because we load tests in batches with `knapsack__load_spec_files_batch` later on.
+        def knapsack__setup(stream_error = $stderr, stream_out = $stdout)
+          configure(stream_error, stream_out)
+        ensure
+          world.knapsack__announce_filters
+        end
+
+        def knapsack__wants_to_quit?
+          world.wants_to_quit
+        end
+
+        def knapsack__rspec_is_quitting?
+          world.respond_to?(:rspec_is_quitting) && world.rspec_is_quitting
+        end
+
+        def knapsack__exit_early
+          _exit_status = configuration.reporter.exit_early(exit_code)
+        end
+
+        # Based on:
+        # https://github.com/rspec/rspec-core/blob/f8c8880dabd8f0544a6f91d8d4c857c1bd8df903/lib/rspec/core/configuration.rb#L546
+        def knapsack__error_exit_code
+          configuration.error_exit_code # nil unless `--error-exit-code` is specified
+        end
+
+        # must be called after `Runner#knapsack__setup` that loads the `spec_helper.rb` configuration
+        def knapsack__deprecated_run_all_when_everything_filtered_enabled?
+          configuration.respond_to?(:run_all_when_everything_filtered) && !!configuration.run_all_when_everything_filtered
+        end
+
+        def knapsack__seed
+          Seed.new(configuration.seed.to_s, configuration.seed_used?)
+        end
+
+        # @param test_file_paths Array[String]
+        #   Example: ['a_spec.rb', 'b_spec.rb[1:1]']
+        def knapsack__load_spec_files_batch(test_file_paths)
+          world.reset
+
+          # Reset filters, but do not reset `configuration.static_config_filter_manager` to preserve the --tag option
+          filter_manager = RSpec::Core::FilterManager.new
+          options.configure_filter_manager(filter_manager)
+          configuration.filter_manager = filter_manager
+
+          configuration.knapsack__load_spec_files(test_file_paths)
+        end
+
+        # Based on:
+        # https://github.com/rspec/rspec-core/blob/f8c8880dabd8f0544a6f91d8d4c857c1bd8df903/lib/rspec/core/runner.rb#L113
+        #
+        # Ignore `configuration.fail_if_no_examples` in Queue Mode:
+        #   * a late CI node, started after all tests were executed by other nodes, is expected to receive an empty batch
+        #   * a batch could contain tests with no examples (e.g. commented out)
+        #
+        # @return [Fixnum] exit status code.
+        def knapsack__run_specs(queue_runner)
+          # Based on:
+          # https://github.com/rspec/rspec-core/blob/f8c8880dabd8f0544a6f91d8d4c857c1bd8df903/lib/rspec/core/world.rb#L53
+          ordering_strategy = configuration.ordering_registry.fetch(:global)
+          node_examples_passed = true
+
+          configuration.reporter.report(_expected_example_count = 0) do |reporter|
+            configuration.with_suite_hooks do
+              queue_runner.with_batch do |test_file_paths|
+                knapsack__load_spec_files_batch(test_file_paths)
+
+                examples_passed = ordering_strategy.order(world.example_groups).map do |example_group|
+                  queue_runner.handle_signal!
+                  example_group.run(reporter)
+                end.all?
+
+                node_examples_passed = false unless examples_passed
+
+                knapsack__persist_example_statuses
+
+                if reporter.fail_fast_limit_met?
+                  queue_runner.log_fail_fast_limit_met
+                  break
+                end
+              end
+            end
+
+            exit_code(node_examples_passed)
+          end
+        end
+
+        # Based on:
+        # https://github.com/rspec/rspec-core/blob/f8c8880dabd8f0544a6f91d8d4c857c1bd8df903/lib/rspec/core/runner.rb#L90
+        def knapsack__persist_example_statuses
+          persist_example_statuses
+        end
+      end
+
+      module Configuration
+        # Based on:
+        # https://github.com/rspec/rspec-core/blob/f8c8880dabd8f0544a6f91d8d4c857c1bd8df903/lib/rspec/core/configuration.rb#L1619
+        def knapsack__load_spec_files(test_file_paths)
+          batch_of_files_to_run = get_files_to_run(test_file_paths)
+          batch_of_files_to_run.each do |f|
+            file = File.expand_path(f)
+            load_file_handling_errors(:load, file)
+            loaded_spec_files << file
+          end
+        end
+      end
+    end
+  end
+end

data/lib/knapsack_pro/formatters/time_tracker.rb

@@ -9,24 +9,18 @@ module KnapsackPro
         :example_group_started,
         :example_started,
         :example_finished,
-        :example_group_finished,
-        :stop
+        :example_group_finished
 
       attr_reader :output # RSpec < v3.10.2
 
-      # Called at the beginning of each batch,
-      # but only the first instance of this class is used,
-      # so don't rely on the initializer to reset values.
       def initialize(_output)
         @output = StringIO.new
         @time_each = nil
         @time_all = nil
         @before_all = 0.0
         @group = {}
-        @batch = {}
-        @queue = {}
+        @paths = {}
         @suite_started = now
-        @batch_started = now
       end
 
       def example_group_started(notification)
@@ -47,21 +41,15 @@ module KnapsackPro
       def example_group_finished(notification)
         return unless top_level_group?(notification.group)
 
-        add_hooks_time(@group, @before_all, now - @time_all)
-        @batch = merge(@batch, @group)
+        after_all = @time_all.nil? ? 0.0 : now - @time_all
+        add_hooks_time(@group, @before_all, after_all)
         @before_all = 0.0
+        @paths = merge(@paths, @group)
         @group = {}
       end
 
-      # Called at the end of each batch
-      def stop(_notification)
-        @queue = merge(@queue, @batch)
-        @batch = {}
-        @batch_started = now
-      end
-
       def queue(scheduled_paths)
-        recorded_paths = @queue.values.map do |example|
+        recorded_paths = @paths.values.map do |example|
           KnapsackPro::Adapters::RSpecAdapter.parse_file_path(example[:path])
         end
 
@@ -69,13 +57,13 @@ module KnapsackPro
           object[path] = { path: path, time_execution: 0.0 }
         end
 
-        merge(@queue, missing).values.map do |example|
+        merge(@paths, missing).values.map do |example|
           example.transform_keys(&:to_s)
         end
       end
 
       def batch
-        @batch.values.map do |example|
+        @paths.values.map do |example|
           example.transform_keys(&:to_s)
         end
       end
@@ -84,17 +72,13 @@ module KnapsackPro
         now - @suite_started
       end
 
-      def batch_duration
-        now - @batch_started
-      end
-
       def unexecuted_test_files(scheduled_paths)
-        pending_paths = (@queue.values + @batch.values)
+        pending_paths = @paths.values
           .filter { |example| example[:time_execution] == 0.0 }
           .map { |example| example[:path] }
 
         not_run_paths = scheduled_paths -
-          (@queue.values + @batch.values)
+          @paths.values
           .map { |example| example[:path] }
 
         pending_paths + not_run_paths

data/lib/knapsack_pro/formatters/time_tracker_fetcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Formatters
     class TimeTrackerFetcher
@@ -7,6 +9,12 @@ module KnapsackPro
           .formatters
           .find { |f| f.class.to_s == "KnapsackPro::Formatters::TimeTracker" }
       end
+
+      def self.unexecuted_test_files(scheduled_paths)
+        time_tracker = call
+        return [] unless time_tracker
+        time_tracker.unexecuted_test_files(scheduled_paths)
+      end
     end
   end
 end

data/lib/knapsack_pro/presenter.rb

@@ -6,7 +6,7 @@ module KnapsackPro
       def global_time(time = nil)
         time = KnapsackPro.tracker.global_time if time.nil?
         global_time = pretty_seconds(time)
-        "Global time execution for tests: #{global_time}"
+        "Global test execution duration: #{global_time}"
       end
 
       def pretty_seconds(seconds)

data/lib/knapsack_pro/pure/queue/rspec_pure.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module KnapsackPro
+  module Pure
+    module Queue
+      class RSpecPure
+        FAILURE_EXIT_CODE = 1
+        FORMATTERS = [
+          'KnapsackPro::Formatters::TimeTracker',
+        ]
+
+        def add_knapsack_pro_formatters_to(spec_opts)
+          return spec_opts unless spec_opts
+          return spec_opts if FORMATTERS.all? { |formatter| spec_opts.include?(formatter) }
+
+          FORMATTERS.each do |formatter|
+            next if spec_opts.include?(formatter)
+            spec_opts += " --format #{formatter}"
+          end
+
+          spec_opts
+        end
+
+        def error_exit_code(rspec_error_exit_code)
+          rspec_error_exit_code || FAILURE_EXIT_CODE
+        end
+
+        def args_with_seed_option_added_when_viable(order_option, seed, args)
+          return args if order_option && !order_option.include?('rand')
+          return args if order_option && order_option.to_s.split(':')[1]
+
+          return args unless seed.used?
+
+          args + ['--seed', seed.value]
+        end
+
+        def prepare_cli_args(args, has_format_option, test_dir)
+          (args || '').split
+            .yield_self { args_with_at_least_one_formatter(_1, has_format_option) }
+            .yield_self { args_with_default_options(_1, test_dir) }
+        end
+
+        def rspec_command(args, test_file_paths, scope)
+          messages = []
+          return messages if test_file_paths.empty?
+
+          case scope
+          when :batch_finished
+            messages << 'To retry the last batch of tests fetched from the Queue API, please run the following command on your machine:'
+          when :queue_finished
+            messages << 'To retry all the tests assigned to this CI node, please run the following command on your machine:'
+          end
+
+          stringified_cli_args = args.join(' ')
+          FORMATTERS.each do |formatter|
+            stringified_cli_args.sub!(" --format #{formatter}", '')
+          end
+
+          messages << "bundle exec rspec #{stringified_cli_args} " + KnapsackPro::TestFilePresenter.stringify_paths(test_file_paths)
+
+          messages
+        end
+
+        def exit_summary(unexecuted_test_files)
+          return if unexecuted_test_files.empty?
+
+          "Unexecuted tests on this CI node (including pending tests): #{unexecuted_test_files.join(' ')}"
+        end
+
+        private
+
+        def args_with_at_least_one_formatter(cli_args, has_format_option)
+          return cli_args if has_format_option
+
+          cli_args + ['--format', 'progress']
+        end
+
+        def args_with_default_options(cli_args, test_dir)
+          new_cli_args = cli_args + [
+            '--default-path', test_dir,
+          ]
+
+          FORMATTERS.each do |formatter|
+            new_cli_args += ['--format', formatter]
+          end
+
+          new_cli_args
+        end
+      end
+    end
+  end
+end

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

@@ -4,6 +4,7 @@ module KnapsackPro
   module Runners
     module Queue
       class BaseRunner
+        TerminationError = Class.new(StandardError)
         TERMINATION_SIGNALS = %w(HUP INT TERM ABRT QUIT USR1 USR2)
 
         @@terminate_process = false
@@ -42,13 +43,17 @@ module KnapsackPro
         end
 
         def self.handle_signal!
-          raise 'Knapsack Pro process was terminated!' if @@terminate_process
+          raise TerminationError.new('Knapsack Pro process was terminated!') if @@terminate_process
         end
 
         def self.set_terminate_process
           @@terminate_process = true
         end
 
+        def set_terminate_process
+          self.class.set_terminate_process
+        end
+
         def trap_signals
           TERMINATION_SIGNALS.each do |signal|
             Signal.trap(signal) {

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

@@ -21,7 +21,7 @@ module KnapsackPro
             can_initialize_queue: true,
             args: args,
             exitstatus: 0,
-            all_test_file_paths: [],
+            node_test_file_paths: [],
           }
           while accumulator[:status] == :next
             handle_signal!
@@ -36,15 +36,15 @@ module KnapsackPro
           can_initialize_queue = accumulator.fetch(:can_initialize_queue)
           args = accumulator.fetch(:args)
           exitstatus = accumulator.fetch(:exitstatus)
-          all_test_file_paths = accumulator.fetch(:all_test_file_paths)
+          node_test_file_paths = accumulator.fetch(:node_test_file_paths)
 
           test_file_paths = runner.test_file_paths(
             can_initialize_queue: can_initialize_queue,
-            executed_test_files: all_test_file_paths
+            executed_test_files: node_test_file_paths
           )
 
           if test_file_paths.empty?
-            unless all_test_file_paths.empty?
+            unless node_test_file_paths.empty?
               KnapsackPro::Adapters::CucumberAdapter.verify_bind_method_called
             end
 
@@ -65,7 +65,7 @@ module KnapsackPro
 
             KnapsackPro::Hooks::Queue.call_before_subset_queue
 
-            all_test_file_paths += test_file_paths
+            node_test_file_paths += test_file_paths
 
             result_exitstatus = cucumber_run(runner, test_file_paths, args)
             exitstatus = result_exitstatus if result_exitstatus != 0
@@ -80,7 +80,7 @@ module KnapsackPro
               can_initialize_queue: false,
               args: args,
               exitstatus: exitstatus,
-              all_test_file_paths: all_test_file_paths,
+              node_test_file_paths: node_test_file_paths,
             }
           end
         end

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

@@ -7,6 +7,10 @@ module KnapsackPro
         def self.run(args)
           require 'minitest'
 
+          # Avoid installing `at_exit` since we are calling `Minitest.run` ourselves.
+          # Without this, Minitest would run again (autorun) after `Minitest.run`.
+          ::Minitest.class_variable_set('@@installed_at_exit', true)
+
           ENV['KNAPSACK_PRO_TEST_SUITE_TOKEN'] = KnapsackPro::Config::Env.test_suite_token_minitest
           ENV['KNAPSACK_PRO_QUEUE_RECORDING_ENABLED'] = 'true'
           ENV['KNAPSACK_PRO_QUEUE_ID'] = KnapsackPro::Config::EnvGenerator.set_queue_id
@@ -28,7 +32,7 @@ module KnapsackPro
             can_initialize_queue: true,
             args: cli_args,
             exitstatus: 0,
-            all_test_file_paths: [],
+            node_test_file_paths: [],
           }
           while accumulator[:status] == :next
             handle_signal!
@@ -43,15 +47,15 @@ module KnapsackPro
           can_initialize_queue = accumulator.fetch(:can_initialize_queue)
           args = accumulator.fetch(:args)
           exitstatus = accumulator.fetch(:exitstatus)
-          all_test_file_paths = accumulator.fetch(:all_test_file_paths)
+          node_test_file_paths = accumulator.fetch(:node_test_file_paths)
 
           test_file_paths = runner.test_file_paths(
             can_initialize_queue: can_initialize_queue,
-            executed_test_files: all_test_file_paths
+            executed_test_files: node_test_file_paths
           )
 
           if test_file_paths.empty?
-            unless all_test_file_paths.empty?
+            unless node_test_file_paths.empty?
               KnapsackPro::Adapters::MinitestAdapter.verify_bind_method_called
             end
 
@@ -72,7 +76,7 @@ module KnapsackPro
 
             KnapsackPro::Hooks::Queue.call_before_subset_queue
 
-            all_test_file_paths += test_file_paths
+            node_test_file_paths += test_file_paths
 
             result = minitest_run(runner, test_file_paths, args)
             exitstatus = 1 unless result
@@ -87,7 +91,7 @@ module KnapsackPro
               can_initialize_queue: false,
               args: args,
               exitstatus: exitstatus,
-              all_test_file_paths: all_test_file_paths,
+              node_test_file_paths: node_test_file_paths,
             }
           end
         end