knapsack_pro 3.8.0 → 7.0.0

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/queue_allocator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   class QueueAllocator
     def initialize(args)

data/lib/knapsack_pro/queue_allocator_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   class QueueAllocatorBuilder < BaseAllocatorBuilder
     def allocator

data/lib/knapsack_pro/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails'
 require 'knapsack_pro'
 

data/lib/knapsack_pro/report.rb

@@ -1,14 +1,18 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   class Report
-    def self.save
-      test_files = KnapsackPro.tracker.to_a
+    def self.save(tests = nil)
+      if tests.nil?
+        tests = KnapsackPro.tracker.to_a
+      end
 
-      if test_files.empty?
+      if tests.empty?
         KnapsackPro.logger.warn("No test files were executed on this CI node.")
         KnapsackPro.logger.debug("When you use knapsack_pro Regular Mode, the reason for no tests executing might be a very narrow tests list. Most likely, you run only tests with a specified tag, and there were fewer test files with the tag than parallel CI nodes.")
       end
 
-      create_build_subset(test_files)
+      create_build_subset(tests)
     end
 
     def self.save_subset_queue_to_file
@@ -28,11 +32,13 @@ module KnapsackPro
       end
     end
 
-    def self.save_node_queue_to_api
-      test_files = []
-      Dir.glob("#{queue_path}/*.json").each do |file|
-        report = JSON.parse(File.read(file))
-        test_files += report
+    def self.save_node_queue_to_api(test_files = nil)
+      if test_files.nil?
+        test_files = []
+        Dir.glob("#{queue_path}/*.json").each do |file|
+          report = JSON.parse(File.read(file))
+          test_files += report
+        end
       end
 
       if test_files.empty?

data/lib/knapsack_pro/repository_adapter_initiator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   class RepositoryAdapterInitiator
     def self.call

data/lib/knapsack_pro/repository_adapters/base_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module RepositoryAdapters
     class BaseAdapter

data/lib/knapsack_pro/repository_adapters/env_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module RepositoryAdapters
     class EnvAdapter < BaseAdapter

data/lib/knapsack_pro/repository_adapters/git_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module RepositoryAdapters
     class GitAdapter < BaseAdapter
@@ -14,8 +16,56 @@ module KnapsackPro
         str_branches.split("\n")
       end
 
+      def commit_authors
+        authors = git_commit_authors
+          .split("\n")
+          .map { |line| line.strip }
+          .map { |line| line.split("\t") }
+          .map do |commits, author|
+            { commits: commits.to_i, author: KnapsackPro::MaskString.call(author) }
+          end
+
+        raise if authors.empty?
+
+        authors
+      rescue Exception
+        []
+      end
+
+      def build_author
+        author = KnapsackPro::MaskString.call(git_build_author.strip)
+        raise if author.empty?
+        author
+      rescue Exception
+        "no git <no.git@example.com>"
+      end
+
       private
 
+      def git_commit_authors
+        if KnapsackPro::Config::Env.ci? && shallow_repository?
+          command = 'git fetch --shallow-since "one month ago" --quiet 2>/dev/null'
+          begin
+            Timeout.timeout(5) do
+              `#{command}`
+            end
+          rescue Timeout::Error
+            KnapsackPro.logger.debug("Skip the `#{command}` command because it took too long.")
+          end
+        end
+
+        `git log --since "one month ago" 2>/dev/null | git shortlog --summary --email 2>/dev/null`
+      end
+
+      def git_build_author
+        `git log --format="%aN <%aE>" -1 2>/dev/null`
+      end
+
+      def shallow_repository?
+        result = `git rev-parse --is-shallow-repository 2>/dev/null`
+        result.strip == 'true'
+      end
+
       def working_dir
         dir = KnapsackPro::Config::Env.project_dir
         File.expand_path(dir)

data/lib/knapsack_pro/runners/base_runner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Runners
     class BaseRunner

data/lib/knapsack_pro/runners/cucumber_runner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Runners
     class CucumberRunner < BaseRunner

data/lib/knapsack_pro/runners/minitest_runner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Runners
     class MinitestRunner < BaseRunner

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

@@ -1,7 +1,14 @@
+# frozen_string_literal: true
+
 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
+
         def self.run(args)
           raise NotImplementedError
         end
@@ -13,6 +20,7 @@ module KnapsackPro
         def initialize(adapter_class)
           @allocator_builder = KnapsackPro::QueueAllocatorBuilder.new(adapter_class)
           @allocator = allocator_builder.allocator
+          trap_signals
         end
 
         def test_file_paths(args)
@@ -33,6 +41,27 @@ module KnapsackPro
         def self.child_status
           $?
         end
+
+        def self.handle_signal!
+          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) {
+              puts "#{signal} signal has been received. Terminating Knapsack Pro..."
+              @@terminate_process = true
+            }
+          end
+        end
       end
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Runners
     module Queue
@@ -19,9 +21,10 @@ module KnapsackPro
             can_initialize_queue: true,
             args: args,
             exitstatus: 0,
-            all_test_file_paths: [],
+            node_test_file_paths: [],
           }
           while accumulator[:status] == :next
+            handle_signal!
             accumulator = run_tests(accumulator)
           end
 
@@ -33,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
 
@@ -62,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
@@ -77,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Runners
     module Queue
@@ -5,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
@@ -26,9 +32,10 @@ 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!
             accumulator = run_tests(accumulator)
           end
 
@@ -40,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
 
@@ -69,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
@@ -84,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