knapsack_pro 9.2.1 → 9.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c214021f95c75ade998199d051fde0a287ae357174f82fb9193833a70792ae76
-  data.tar.gz: 5987335be91251d6dba92a1656d981932172897bca175525db2e3421ad718775
+  metadata.gz: a3330a86d699278a67d1523c197659a2a22921efe0df740c09d384d5721ae43f
+  data.tar.gz: c1a7821b44628a0f3c4e5d1f54b952221a53f66a5b48b917faea5d97093ce002
 SHA512:
-  metadata.gz: a47a53fb26eb3aba28c60045d13fda33fb00c6ea46321adb63986e662b74bc7b011097c2fbf90ec68a5be236cf06986a901b6ffef524864352d06d053dcbd962
-  data.tar.gz: f3210244a10fbd129649586d8ed09441bbb63202bfde66ca3bd1f997c235772cdb4891681b0b8a3918d204f18b4ad3c2522a25ed445bdb830a69423c09b695c2
+  metadata.gz: f6d0259620d28ef1e3ff77a051464404f668ddc574a503dafa3b430fff6ecfd7414013f2973eaac2a00c189e1885693c4cb91407df11390cc83005220a22e692
+  data.tar.gz: 37c7dd08524763b60e8ba9e401a7092e3d4c0bf11979e499915da8756fbbafcd7c03765469c079aca33af09ee34566478e672c47846e117e9f5379178aca2864

data/lib/knapsack_pro/adapters/base_adapter.rb

@@ -30,10 +30,8 @@ module KnapsackPro
           if File.exist?(adapter_bind_method_called_file)
             File.delete(adapter_bind_method_called_file)
           else
-            puts "\n\n"
-            KnapsackPro.logger.error('-'*10 + ' Configuration error ' + '-'*50)
-            KnapsackPro.logger.error("You forgot to call #{self}.bind method in your test runner configuration file. It is needed to record test files time execution. Please follow the installation guide to configure your project properly #{KnapsackPro::Urls::INSTALLATION_GUIDE}")
-            KnapsackPro.logger.error("If you already have #{self}.bind method added and you still see this error then one of your tests must have deleted the .knapsack_pro directory from the disk accidentally. Please ensure you do not remove the .knapsack_pro directory: #{KnapsackPro::Urls::DASHBOARD__ZEROISH_TEST_EXECUTION_TIMES}")
+            KnapsackPro.logger.error("The `#{self}.bind` method was not called in the test runner configuration. See: #{KnapsackPro::Urls::INSTALLATION_GUIDE}")
+            KnapsackPro.logger.error("If `#{self}.bind` was called and you still see this error, ensure the `.knapsack_pro` directory (or its contents) were not removed during the run: #{KnapsackPro::Urls::DASHBOARD__ZEROISH_TEST_EXECUTION_TIMES}")
             Kernel.exit(1)
           end
         end

data/lib/knapsack_pro/build_distribution_fetcher.rb

@@ -11,6 +11,10 @@ module KnapsackPro
         response.fetch('test_files')
       end
 
+      def test_queue_url # Can be present only when using the initialize command
+        response.fetch('test_queue_url', nil)
+      end
+
       private
 
       attr_reader :response

data/lib/knapsack_pro/client/api/v1/queues.rb

@@ -63,6 +63,32 @@ module KnapsackPro
                 request_hash: request_hash
               )
             end
+
+            def connect
+              git_adapter = KnapsackPro::RepositoryAdapters::GitAdapter.new
+              repository_adapter = KnapsackPro::RepositoryAdapterInitiator.call
+
+              request_hash = {
+                attempt_connect_to_queue: true,
+                branch: KnapsackPro::Crypto::BranchEncryptor.call(repository_adapter.branch),
+                build_author: git_adapter.build_author,
+                can_initialize_queue: true,
+                commit_authors: git_adapter.commit_authors,
+                commit_hash: repository_adapter.commit_hash,
+                fixed_queue_split: KnapsackPro::Config::Env.fixed_queue_split,
+                node_build_id: KnapsackPro::Config::Env.ci_node_build_id,
+                node_index: KnapsackPro::Config::Env.ci_node_index,
+                node_total: KnapsackPro::Config::Env.ci_node_total,
+                skip_pull: true,
+                user_seat: KnapsackPro::Config::Env.masked_user_seat,
+              }
+
+              action_class.new(
+                endpoint_path: '/v1/queues/queue',
+                http_method: :post,
+                request_hash: request_hash
+              )
+            end
           end
         end
       end

data/lib/knapsack_pro/report.rb

@@ -51,10 +51,10 @@ module KnapsackPro
         .select { |time_execution| time_execution != KnapsackPro::Tracker::DEFAULT_TEST_FILE_TIME }
 
       if test_files.size > 0 && measured_test_files.size == 0
-        KnapsackPro.logger.warn("#{test_files.size} test files were executed on this CI node but the recorded time was lost due to:")
-        KnapsackPro.logger.warn("1. Please ensure you do not remove the contents of the .knapsack_pro directory between tests run.")
-        KnapsackPro.logger.warn("2. Ensure you've added Knapsack::Adapters::RSpecAdapter.bind in your rails_helper.rb or spec_helper.rb. Please follow the installation guide again: #{KnapsackPro::Urls::INSTALLATION_GUIDE}")
-        KnapsackPro.logger.warn("3. Another potential reason for this warning is that all your tests are empty test files, pending tests, or they have syntax errors, and the time execution was not recorded for them.")
+        KnapsackPro.logger.warn("#{test_files.size} test files were executed, but their execution time could not be recorded. This usually happens when one of the following is true:")
+        KnapsackPro.logger.warn('- The `.knapsack_pro` directory (or its contents) were removed during the run.')
+        KnapsackPro.logger.warn("- The `bind` method was not called in the test runner configuration. See: #{KnapsackPro::Urls::INSTALLATION_GUIDE}")
+        KnapsackPro.logger.warn('- The test files did not run any tests because they are empty, contain only pending tests, or have syntax errors.')
       end
 
       create_build_subset(test_files)

data/lib/knapsack_pro/repository_adapters/git_adapter.rb

@@ -43,18 +43,39 @@ module KnapsackPro
       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
+        git_unshallow if KnapsackPro::Config::Env.ci? && shallow_repository?
+        `git log --since "one month ago" 2>/dev/null | git shortlog --summary --email 2>/dev/null`
+      end
+
+      def git_unshallow
+        args = ['git', 'fetch', '--quiet', '--shallow-since', 'one month ago']
+
+        begin
+          pid = Process.spawn(*args, [:out, :err] => File::NULL)
+        rescue StandardError => e
+          KnapsackPro.logger.debug("Failed to unshallow (#{args.join(' ')}): #{e.message}")
+          return
         end
 
-        `git log --since "one month ago" 2>/dev/null | git shortlog --summary --email 2>/dev/null`
+        begin
+          Timeout.timeout(5) { safe_waitpid(pid) }
+        rescue Timeout::Error
+          safe_kill(pid)
+          Timeout.timeout(1) { safe_waitpid(pid) } rescue Timeout::Error
+          KnapsackPro.logger.debug("Failed to unshallow (#{args.join(' ')}) in 5 seconds")
+        end
+      end
+
+      def safe_waitpid(pid)
+        Process.waitpid(pid)
+      rescue Errno::ECHILD
+        nil
+      end
+
+      def safe_kill(pid)
+        Process.kill('KILL', pid)
+      rescue Errno::ESRCH
+        nil
       end
 
       def git_build_author

data/lib/knapsack_pro/rspec/test_queue_initializer.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module KnapsackPro
+  module RSpec
+    class TestQueueInitializer
+      def call(args)
+        test_queue_url, slow_id_paths = KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector
+          .new
+          .calculate_slow_id_paths(args.to_s)
+          .values_at(:test_queue_url, :slow_id_paths)
+
+        unless test_queue_url.nil? # The test queue already existed when calculating the slow id paths.
+          KnapsackPro.logger.info "Test Queue URL: #{test_queue_url}"
+          exit 0
+        end
+
+        # The test queue was created by another node while this one calculated the slow id paths via the RSpec dry-run.
+        exit 0 if test_queue_exists?
+
+        initialize_test_queue(slow_id_paths)
+      end
+
+      private
+
+      def test_queue_exists?
+        action = KnapsackPro::Client::API::V1::Queues.connect
+        connection = KnapsackPro::Client::Connection.new(action)
+        response = connection.call
+
+        unless connection.success?
+          KnapsackPro.logger.error "Failed to initialize the test queue."
+          exit 1
+        end
+
+        if connection.errors?
+          KnapsackPro.logger.error "Failed to initialize the test queue."
+          KnapsackPro.logger.error response.inspect
+          exit 1
+        end
+
+        return false unless response.key?('url')
+
+        KnapsackPro.logger.info "Test Queue URL: #{response.fetch('url')}"
+        true
+      end
+
+      def initialize_test_queue(slow_id_paths)
+        all_test_files_to_run = KnapsackPro::TestSuite.new(KnapsackPro::Adapters::RSpecAdapter).all_test_files_to_run
+        paths = KnapsackPro::Adapters::RSpecAdapter.concat_paths(all_test_files_to_run, slow_id_paths)
+
+        if paths.empty?
+          KnapsackPro.logger.error "No paths to run."
+          exit 1
+        end
+
+        action = KnapsackPro::Client::API::V1::Queues.initialize(paths)
+        connection = KnapsackPro::Client::Connection.new(action)
+        response = connection.call
+
+        unless connection.success?
+          KnapsackPro.logger.error "Failed to initialize the test queue."
+          exit 1
+        end
+
+        if connection.errors?
+          KnapsackPro.logger.error "Failed to initialize the test queue."
+          KnapsackPro.logger.error response.inspect
+          exit 1
+        end
+
+        if response.key?('url')
+          KnapsackPro.logger.info "Test Queue URL: #{response.fetch('url')}"
+        end
+      end
+    end
+  end
+end

data/lib/knapsack_pro/test_case_detectors/rspec_test_example_detector.rb

@@ -3,7 +3,7 @@
 module KnapsackPro
   module TestCaseDetectors
     class RSpecTestExampleDetector
-      def dry_run_to_file(rspec_args, slow_test_files = slow_test_files(KnapsackPro::BuildDistributionFetcher.new))
+      def dry_run_to_file(rspec_args, slow_test_files = fetch_slow_file_paths.fetch(:slow_file_paths))
         KnapsackPro::Config::TempFiles.ensure_temp_directory_exists!
         FileUtils.mkdir_p(File.dirname(report_path))
         File.delete(report_path) if File.exist?(report_path)
@@ -27,8 +27,11 @@ module KnapsackPro
       end
 
       def calculate_slow_id_paths(rspec_args)
-        dry_run_to_file(rspec_args, slow_test_files(KnapsackPro::OptimizedBuildDistributionFetcher.new))
-        slow_id_paths!
+        result = fetch_slow_file_paths(KnapsackPro::OptimizedBuildDistributionFetcher.new)
+        return { slow_id_paths: [], test_queue_url: result.fetch(:test_queue_url) } unless result.fetch(:test_queue_url).nil?
+
+        dry_run_to_file(rspec_args, result.fetch(:slow_file_paths))
+        { slow_id_paths: slow_id_paths!, test_queue_url: nil }
       end
 
       def slow_id_paths!
@@ -66,12 +69,27 @@ module KnapsackPro
         "#{KnapsackPro::Config::TempFiles::TEMP_DIRECTORY_PATH}/test_case_detectors/rspec/rspec_dry_run_json_report_node_#{KnapsackPro::Config::Env.ci_node_index}.json"
       end
 
-      def slow_test_files(build_distribution_fetcher)
+      def fetch_slow_file_paths(build_distribution_fetcher = KnapsackPro::BuildDistributionFetcher.new)
         if KnapsackPro::Config::Env.slow_test_file_pattern
-          KnapsackPro::TestFileFinder.slow_test_files_by_pattern(adapter_class)
+          slow_file_paths = KnapsackPro::TestFileFinder.slow_test_files_by_pattern(adapter_class)
+          { slow_file_paths: slow_file_paths, test_queue_url: nil }
         else
-          KnapsackPro::RSpecSlowTestFileFinder.new(build_distribution_fetcher).call
+          determine_slow_file_paths(build_distribution_fetcher)
+        end
+      end
+
+      def determine_slow_file_paths(build_distribution_fetcher)
+        if KnapsackPro::Config::Env.test_files_encrypted?
+          raise "Split by test cases is not possible when you have enabled test file names encryption ( #{KnapsackPro::Urls::ENCRYPTION} ). You need to disable encryption with KNAPSACK_PRO_TEST_FILES_ENCRYPTED=false in order to use split by test cases #{KnapsackPro::Urls::SPLIT_BY_TEST_EXAMPLES}"
         end
+
+        build_distribution = build_distribution_fetcher.call
+        return { slow_file_paths: [], test_queue_url: build_distribution.test_queue_url } unless build_distribution.test_queue_url.nil?
+
+        merged_test_files_from_api = KnapsackPro::TestCaseMergers::RSpecMerger.new(build_distribution.test_files).call
+        test_files_existing_on_disk = KnapsackPro::TestFileFinder.select_test_files_that_can_be_run(KnapsackPro::Adapters::RSpecAdapter, merged_test_files_from_api)
+        slow_file_paths = KnapsackPro::SlowTestFileDeterminer.call(test_files_existing_on_disk)
+        { slow_file_paths: slow_file_paths, test_queue_url: nil }
       end
 
       def report

data/lib/knapsack_pro/version.rb

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

data/lib/knapsack_pro.rb

@@ -61,7 +61,6 @@ require_relative 'knapsack_pro/test_suite'
 require_relative 'knapsack_pro/test_case_mergers/rspec_merger'
 require_relative 'knapsack_pro/build_distribution_fetcher'
 require_relative 'knapsack_pro/slow_test_file_determiner'
-require_relative 'knapsack_pro/rspec_slow_test_file_finder'
 require_relative 'knapsack_pro/base_allocator_builder'
 require_relative 'knapsack_pro/regular_allocator_builder'
 require_relative 'knapsack_pro/queue_allocator_builder'

data/lib/tasks/queue/rspec.rake

@@ -16,12 +16,12 @@ namespace :knapsack_pro do
     namespace :rspec do
       desc 'Initialize the test queue to be consumed later.'
       task :initialize, [:rspec_args] do |_, args|
-        require_relative '../../knapsack_pro/queue_initializer'
+        require_relative '../../knapsack_pro/rspec/test_queue_initializer'
 
         ENV.delete('SPEC_OPTS') # Ignore `SPEC_OPTS` to not affect the RSpec execution within this rake task
         ENV['KNAPSACK_PRO_TEST_SUITE_TOKEN'] = KnapsackPro::Config::Env.test_suite_token_rspec
 
-        KnapsackPro::RSpec::QueueInitializer.new.call(args[:rspec_args].to_s)
+        KnapsackPro::RSpec::TestQueueInitializer.new.call(args[:rspec_args].to_s)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 9.2.1
+  version: 9.2.3
 platform: ruby
 authors:
 - ArturT
@@ -23,6 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -250,7 +264,6 @@ files:
 - lib/knapsack_pro/queue.rb
 - lib/knapsack_pro/queue_allocator.rb
 - lib/knapsack_pro/queue_allocator_builder.rb
-- lib/knapsack_pro/queue_initializer.rb
 - lib/knapsack_pro/railtie.rb
 - lib/knapsack_pro/regular_allocator.rb
 - lib/knapsack_pro/regular_allocator_builder.rb
@@ -259,7 +272,7 @@ files:
 - lib/knapsack_pro/repository_adapters/base_adapter.rb
 - lib/knapsack_pro/repository_adapters/env_adapter.rb
 - lib/knapsack_pro/repository_adapters/git_adapter.rb
-- lib/knapsack_pro/rspec_slow_test_file_finder.rb
+- lib/knapsack_pro/rspec/test_queue_initializer.rb
 - lib/knapsack_pro/runners/base_runner.rb
 - lib/knapsack_pro/runners/cucumber_runner.rb
 - lib/knapsack_pro/runners/minitest_runner.rb

data/lib/knapsack_pro/queue_initializer.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module KnapsackPro
-  module RSpec
-    class QueueInitializer
-      def call(args)
-        slow_id_paths = KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector.new.calculate_slow_id_paths(args.to_s)
-        all_test_files_to_run = KnapsackPro::TestSuite.new(KnapsackPro::Adapters::RSpecAdapter).all_test_files_to_run
-        paths = KnapsackPro::Adapters::RSpecAdapter.concat_paths(all_test_files_to_run, slow_id_paths)
-
-        raise 'No paths to run' if paths.empty?
-        action = KnapsackPro::Client::API::V1::Queues.initialize(paths)
-        connection = KnapsackPro::Client::Connection.new(action)
-        response = connection.call
-        return unless response.key?('url') # Race to initialize lost to another parallel node
-
-        KnapsackPro.logger.info "Build URL: #{response.fetch('url')}"
-      end
-    end
-  end
-end

data/lib/knapsack_pro/rspec_slow_test_file_finder.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module KnapsackPro
-  class RSpecSlowTestFileFinder
-    def initialize(build_distribution_fetcher)
-      @build_distribution_fetcher = build_distribution_fetcher
-    end
-
-    def call
-      if KnapsackPro::Config::Env.test_files_encrypted?
-        raise "Split by test cases is not possible when you have enabled test file names encryption ( #{KnapsackPro::Urls::ENCRYPTION} ). You need to disable encryption with KNAPSACK_PRO_TEST_FILES_ENCRYPTED=false in order to use split by test cases #{KnapsackPro::Urls::SPLIT_BY_TEST_EXAMPLES}"
-      end
-
-      test_files_from_api = @build_distribution_fetcher.call.test_files
-      merged_test_files_from_api = KnapsackPro::TestCaseMergers::RSpecMerger.new(test_files_from_api).call
-      test_files_existing_on_disk = KnapsackPro::TestFileFinder.select_test_files_that_can_be_run(KnapsackPro::Adapters::RSpecAdapter, merged_test_files_from_api)
-      KnapsackPro::SlowTestFileDeterminer.call(test_files_existing_on_disk)
-    end
-  end
-end