knapsack_pro 3.8.0 → 7.0.0

data/lib/knapsack_pro/adapters/rspec_adapter.rb

@@ -1,8 +1,41 @@
+# frozen_string_literal: true
+
+require_relative '../formatters/time_tracker_fetcher'
+
 module KnapsackPro
   module Adapters
     class RSpecAdapter < BaseAdapter
       TEST_DIR_PATTERN = 'spec/**{,/*/**}/*_spec.rb'
 
+      def self.split_by_test_cases_enabled?
+        return false unless KnapsackPro::Config::Env.rspec_split_by_test_examples?
+
+        require 'rspec/core/version'
+        unless Gem::Version.new(::RSpec::Core::Version::STRING) >= Gem::Version.new('3.3.0')
+          raise "RSpec >= 3.3.0 is required to split test files by test examples. Learn more: #{KnapsackPro::Urls::SPLIT_BY_TEST_EXAMPLES}"
+        end
+
+        true
+      end
+
+      def self.test_file_cases_for(slow_test_files)
+        KnapsackPro.logger.info("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 #{slow_test_files.size} slow test files.")
+
+        # generate the RSpec JSON report in a separate process to not pollute the RSpec state
+        cmd = [
+          'RACK_ENV=test',
+          'RAILS_ENV=test',
+          KnapsackPro::Config::Env.rspec_test_example_detector_prefix,
+          'rake knapsack_pro:rspec_test_example_detector',
+        ].join(' ')
+        unless Kernel.system(cmd)
+          raise "Could not generate JSON report for RSpec. Rake task failed when running #{cmd}"
+        end
+
+        # read the JSON report
+        KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector.new.test_file_example_paths
+      end
+
       def self.ensure_no_tag_option_when_rspec_split_by_test_examples_enabled!(cli_args)
         if KnapsackPro::Config::Env.rspec_split_by_test_examples? && has_tag_option?(cli_args)
           error_message = "It is not allowed to use the RSpec tag option together with the RSpec split by test examples feature. Please see: #{KnapsackPro::Urls::RSPEC__SPLIT_BY_TEST_EXAMPLES__TAG}"
@@ -23,63 +56,63 @@ module KnapsackPro
         parsed_options(cli_args)&.[](:order)
       end
 
-      def self.test_path(example)
-        example_group = example.metadata[:example_group]
-
-        if defined?(::Turnip) && Gem::Version.new(::Turnip::VERSION) < Gem::Version.new('2.0.0')
-          unless example_group[:turnip]
-            until example_group[:parent_example_group].nil?
-              example_group = example_group[:parent_example_group]
-            end
-          end
-        else
-          until example_group[:parent_example_group].nil?
-            example_group = example_group[:parent_example_group]
+      def self.file_path_for(example)
+        [
+          -> { parse_file_path(example.id) },
+          -> { example.metadata[:file_path] },
+          -> { example.metadata[:example_group][:file_path] },
+          -> { top_level_group(example)[:file_path] },
+        ]
+          .each do |path|
+            p = path.call
+            return p if p.include?('_spec.rb') || p.include?('.feature')
           end
-        end
 
-        example_group[:file_path]
+        return ''
       end
 
-      def bind_time_tracker
-        ::RSpec.configure do |config|
-          config.prepend_before(:context) do
-            KnapsackPro.tracker.start_timer
-          end
+      def self.parse_file_path(id)
+        # https://github.com/rspec/rspec-core/blob/1eeadce5aa7137ead054783c31ff35cbfe9d07cc/lib/rspec/core/example.rb#L122
+        id.match(/\A(.*?)(?:\[([\d\s:,]+)\])?\z/).captures.first
+      end
 
-          config.around(:each) do |example|
-            current_test_path = KnapsackPro::Adapters::RSpecAdapter.test_path(example)
-
-            # Stop timer to update time for a previously run test example.
-            # This way we count time spent in runtime for the previous test example after around(:each) is already done.
-            # Only do that if we're in the same test file. Otherwise, `before(:all)` execution time in the current file
-            # will be applied to the previously ran test file.
-            if KnapsackPro.tracker.current_test_path&.start_with?(KnapsackPro::TestFileCleaner.clean(current_test_path))
-              KnapsackPro.tracker.stop_timer
-            end
+      # private
+      def self.top_level_group(example)
+        group = example.metadata[:example_group]
+        until group[:parent_example_group].nil?
+          group = group[:parent_example_group]
+        end
+        group
+      end
 
-            KnapsackPro.tracker.current_test_path =
-              if KnapsackPro::Config::Env.rspec_split_by_test_examples? && KnapsackPro::Adapters::RSpecAdapter.slow_test_file?(RSpecAdapter, current_test_path)
-                example.id
-              else
-                current_test_path
-              end
+      def bind_time_tracker
+        ensure_no_focus!
+        log_tests_duration
+      end
 
+      def ensure_no_focus!
+        ::RSpec.configure do |config|
+          config.around(:each) do |example|
             if example.metadata[:focus] && KnapsackPro::Adapters::RSpecAdapter.rspec_configuration.filter.rules[:focus]
-              raise "We detected a test file path #{current_test_path} with a test using the metadata `:focus` tag. RSpec might not run some tests in the Queue Mode (causing random tests skipping problem). Please remove the `:focus` tag from your codebase. See more: #{KnapsackPro::Urls::RSPEC__SKIPS_TESTS}"
+              file_path = KnapsackPro::Adapters::RSpecAdapter.file_path_for(example)
+              file_path = KnapsackPro::TestFileCleaner.clean(file_path)
+
+              raise "Knapsack Pro found an example tagged with focus in #{file_path}, please remove it. See more: #{KnapsackPro::Urls::RSPEC__SKIPS_TESTS}"
             end
 
             example.run
           end
+        end
+      end
 
-          config.append_after(:context) do
-            # after(:context) hook is run one time only, after all of the examples in a group
-            # stop timer to count time for the very last executed test example
-            KnapsackPro.tracker.stop_timer
-          end
-
-          config.after(:suite) do
-            KnapsackPro.logger.debug(KnapsackPro::Presenter.global_time)
+      def log_tests_duration
+        ::RSpec.configure do |config|
+          config.append_after(:suite) do
+            time_tracker = KnapsackPro::Formatters::TimeTrackerFetcher.call
+            if time_tracker
+              formatted = KnapsackPro::Presenter.global_time(time_tracker.duration)
+              KnapsackPro.logger.debug(formatted)
+            end
           end
         end
       end
@@ -87,7 +120,8 @@ module KnapsackPro
       def bind_save_report
         ::RSpec.configure do |config|
           config.after(:suite) do
-            KnapsackPro::Report.save
+            time_tracker = KnapsackPro::Formatters::TimeTrackerFetcher.call
+            KnapsackPro::Report.save(time_tracker.batch)
           end
         end
       end
@@ -95,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/adapters/spinach_adapter.rb

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

data/lib/knapsack_pro/adapters/test_unit_adapter.rb

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

data/lib/knapsack_pro/allocator.rb

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

data/lib/knapsack_pro/allocator_builder.rb

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

data/lib/knapsack_pro/base_allocator_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   class BaseAllocatorBuilder
     TEST_RUNNER_MAP = {
@@ -33,35 +35,16 @@ module KnapsackPro
     def fast_and_slow_test_files_to_run
       test_files_to_run = all_test_files_to_run
 
-      if adapter_class == KnapsackPro::Adapters::RSpecAdapter && KnapsackPro::Config::Env.rspec_split_by_test_examples?
-        require 'rspec/core/version'
-        unless Gem::Version.new(::RSpec::Core::Version::STRING) >= Gem::Version.new('3.3.0')
-          raise "RSpec >= 3.3.0 is required to split test files by test examples. Learn more: #{KnapsackPro::Urls::SPLIT_BY_TEST_EXAMPLES}"
-        end
-
+      if adapter_class.split_by_test_cases_enabled?
         slow_test_files = get_slow_test_files
+        return test_files_to_run if slow_test_files.empty?
 
-        KnapsackPro.logger.info("Generating RSpec test examples JSON report for slow test files to prepare it to be split by test examples (by individual 'it's. Thanks to that a single slow test file can be split across parallel CI nodes). Analyzing #{slow_test_files.size} slow test files.")
-
-        # generate RSpec JSON report in separate process to not pollute RSpec state
-        cmd = [
-          'RACK_ENV=test',
-          'RAILS_ENV=test',
-          KnapsackPro::Config::Env.rspec_test_example_detector_prefix,
-          'rake knapsack_pro:rspec_test_example_detector',
-        ].join(' ')
-        unless Kernel.system(cmd)
-          raise "Could not generate JSON report for RSpec. Rake task failed when running #{cmd}"
-        end
-
-        # read JSON report
-        detector = KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector.new
-        test_file_example_paths = detector.test_file_example_paths
+        test_file_cases = adapter_class.test_file_cases_for(slow_test_files)
 
-        KnapsackPro::TestFilesWithTestCasesComposer.call(test_files_to_run, slow_test_files, test_file_example_paths)
-      else
-        test_files_to_run
+        return KnapsackPro::TestFilesWithTestCasesComposer.call(test_files_to_run, slow_test_files, test_file_cases)
       end
+
+      test_files_to_run
     end
 
     private

data/lib/knapsack_pro/build_distribution_fetcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   class BuildDistributionFetcher
     class BuildDistributionEntity

data/lib/knapsack_pro/client/api/action.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Client
     module API

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Client
     module API

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Client
     module API
@@ -15,6 +17,9 @@ module KnapsackPro
                 :node_total => args.fetch(:node_total),
                 :node_index => args.fetch(:node_index),
                 :ci_build_id => KnapsackPro::Config::Env.ci_node_build_id,
+                :user_seat => KnapsackPro::Config::Env.masked_user_seat,
+                :build_author => KnapsackPro::RepositoryAdapters::GitAdapter.new.build_author,
+                :commit_authors => KnapsackPro::RepositoryAdapters::GitAdapter.new.commit_authors,
               }
 
               unless request_hash[:cache_read_attempt]

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Client
     module API

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Client
     module API
@@ -16,11 +18,14 @@ module KnapsackPro
                 :node_total => args.fetch(:node_total),
                 :node_index => args.fetch(:node_index),
                 :node_build_id => KnapsackPro::Config::Env.ci_node_build_id,
+                :user_seat => KnapsackPro::Config::Env.masked_user_seat,
               }
 
               if request_hash[:can_initialize_queue] && !request_hash[:attempt_connect_to_queue]
                 request_hash.merge!({
-                  :test_files => args.fetch(:test_files)
+                  :test_files => args.fetch(:test_files),
+                  :build_author => KnapsackPro::RepositoryAdapters::GitAdapter.new.build_author,
+                  :commit_authors => KnapsackPro::RepositoryAdapters::GitAdapter.new.commit_authors,
                 })
               end
 

data/lib/knapsack_pro/client/connection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Client
     class Connection
@@ -59,18 +61,15 @@ module KnapsackPro
         request_hash.to_json
       end
 
-      def test_suite_token
-        KnapsackPro::Config::Env.test_suite_token
-      end
-
       def json_headers
         {
           'Content-Type' => 'application/json',
           'Accept' => 'application/json',
           'KNAPSACK-PRO-CLIENT-NAME' => client_name,
           'KNAPSACK-PRO-CLIENT-VERSION' => KnapsackPro::VERSION,
-          'KNAPSACK-PRO-TEST-SUITE-TOKEN' => test_suite_token,
-        }
+          'KNAPSACK-PRO-TEST-SUITE-TOKEN' => KnapsackPro::Config::Env.test_suite_token,
+          'KNAPSACK-PRO-CI-PROVIDER' => KnapsackPro::Config::Env.ci_provider,
+        }.compact
       end
 
       def client_name

data/lib/knapsack_pro/config/ci/app_veyor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # https://www.appveyor.com/docs/environment-variables/
 module KnapsackPro
   module Config
@@ -26,6 +28,22 @@ module KnapsackPro
         def project_dir
           ENV['APPVEYOR_BUILD_FOLDER']
         end
+
+        def user_seat
+          ENV['APPVEYOR_REPO_COMMIT_AUTHOR']
+        end
+
+        def detected
+          ENV.key?('APPVEYOR') ? self.class : nil
+        end
+
+        def fixed_queue_split
+          false
+        end
+
+        def ci_provider
+          "AppVeyor"
+        end
       end
     end
   end

data/lib/knapsack_pro/config/ci/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Config
     module CI
@@ -22,6 +24,31 @@ module KnapsackPro
 
         def project_dir
         end
+
+        def user_seat
+        end
+
+        def detected
+        end
+
+        def fixed_queue_split
+          true
+        end
+
+        def ci_provider
+          return 'AWS CodeBuild' if ENV.key?('CODEBUILD_BUILD_ARN')
+          return 'Azure Pipelines' if ENV.key?('SYSTEM_TEAMFOUNDATIONCOLLECTIONURI')
+          return 'Bamboo' if ENV.key?('bamboo_planKey')
+          return 'Bitbucket Pipelines' if ENV.key?('BITBUCKET_COMMIT')
+          return 'Buddy.works' if ENV.key?('BUDDY')
+          return 'Drone.io' if ENV.key?('DRONE')
+          return 'Google Cloud Build' if ENV.key?('BUILDER_OUTPUT')
+          return 'Jenkins' if ENV.key?('JENKINS_URL')
+          return 'TeamCity' if ENV.key?('TEAMCITY_VERSION')
+          return 'Other' if KnapsackPro::Config::Env.ci?
+
+          nil
+        end
       end
     end
   end

data/lib/knapsack_pro/config/ci/buildkite.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Config
     module CI
@@ -29,6 +31,22 @@ module KnapsackPro
         def project_dir
           ENV['BUILDKITE_BUILD_CHECKOUT_PATH']
         end
+
+        def user_seat
+          ENV['BUILDKITE_BUILD_AUTHOR'] || ENV['BUILDKITE_BUILD_CREATOR']
+        end
+
+        def detected
+          ENV.key?('BUILDKITE') ? self.class : nil
+        end
+
+        def fixed_queue_split
+          true
+        end
+
+        def ci_provider
+          "Buildkite"
+        end
       end
     end
   end

data/lib/knapsack_pro/config/ci/circle.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Config
     module CI
@@ -25,6 +27,22 @@ module KnapsackPro
         def project_dir
           ENV['CIRCLE_WORKING_DIRECTORY']
         end
+
+        def user_seat
+          ENV['CIRCLE_USERNAME'] || ENV['CIRCLE_PR_USERNAME']
+        end
+
+        def detected
+          ENV.key?('CIRCLECI') ? self.class : nil
+        end
+
+        def fixed_queue_split
+          false
+        end
+
+        def ci_provider
+          "CircleCI"
+        end
       end
     end
   end

data/lib/knapsack_pro/config/ci/cirrus_ci.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Config
     module CI
@@ -25,6 +27,22 @@ module KnapsackPro
         def project_dir
           ENV['CIRRUS_WORKING_DIR']
         end
+
+        def user_seat
+          # not provided
+        end
+
+        def detected
+          ENV.key?('CIRRUS_CI') ? self.class : nil
+        end
+
+        def fixed_queue_split
+          false
+        end
+
+        def ci_provider
+          "Cirrus CI"
+        end
       end
     end
   end

data/lib/knapsack_pro/config/ci/codefresh.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # https://codefresh.io/docs/docs/codefresh-yaml/variables/#system-provided-variables
 module KnapsackPro
   module Config
@@ -26,6 +28,22 @@ module KnapsackPro
         def project_dir
           # not provided
         end
+
+        def user_seat
+          ENV['CF_BUILD_INITIATOR']
+        end
+
+        def detected
+          ENV.key?('CF_BUILD_ID') ? self.class : nil
+        end
+
+        def fixed_queue_split
+          false
+        end
+
+        def ci_provider
+          "Codefresh"
+        end
       end
     end
   end

data/lib/knapsack_pro/config/ci/codeship.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Config
     module CI
@@ -25,6 +27,22 @@ module KnapsackPro
         def project_dir
           # not provided
         end
+
+        def user_seat
+          ENV['CI_COMMITTER_NAME']
+        end
+
+        def detected
+          ENV['CI_NAME'] == 'codeship' ? self.class : nil
+        end
+
+        def fixed_queue_split
+          true
+        end
+
+        def ci_provider
+          "Codeship"
+        end
       end
     end
   end

data/lib/knapsack_pro/config/ci/github_actions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables
 module KnapsackPro
   module Config
@@ -16,6 +18,14 @@ module KnapsackPro
           ENV['GITHUB_RUN_ID']
         end
 
+        def node_retry_count
+          # A unique number for each attempt of a particular workflow run in a repository.
+          # This number begins at 1 for the workflow run's first attempt, and increments with each re-run.
+          run_attempt = ENV['GITHUB_RUN_ATTEMPT']
+          return unless run_attempt
+          run_attempt.to_i - 1
+        end
+
         def commit_hash
           ENV['GITHUB_SHA']
         end
@@ -29,6 +39,22 @@ module KnapsackPro
         def project_dir
           ENV['GITHUB_WORKSPACE']
         end
+
+        def user_seat
+          ENV['GITHUB_ACTOR']
+        end
+
+        def detected
+          ENV.key?('GITHUB_ACTIONS') ? self.class : nil
+        end
+
+        def fixed_queue_split
+          true
+        end
+
+        def ci_provider
+          "GitHub Actions"
+        end
       end
     end
   end

data/lib/knapsack_pro/config/ci/gitlab_ci.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # https://docs.gitlab.com/ce/ci/variables/
 module KnapsackPro
   module Config
@@ -16,7 +18,7 @@ module KnapsackPro
 
         def node_build_id
           ENV['CI_PIPELINE_ID'] || # Gitlab Release 9.0+
-          ENV['CI_BUILD_ID']  # Gitlab Release 8.x
+          ENV['CI_BUILD_ID'] # Gitlab Release 8.x
         end
 
         def commit_hash
@@ -32,6 +34,23 @@ module KnapsackPro
         def project_dir
           ENV['CI_PROJECT_DIR']
         end
+
+        def user_seat
+          ENV['GITLAB_USER_NAME'] || # Gitlab Release 10.0
+          ENV['GITLAB_USER_EMAIL'] # Gitlab Release 8.12
+        end
+
+        def detected
+          ENV.key?('GITLAB_CI') ? self.class : nil
+        end
+
+        def fixed_queue_split
+          true
+        end
+
+        def ci_provider
+          "Gitlab CI"
+        end
       end
     end
   end

data/lib/knapsack_pro/config/ci/heroku.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Config
     module CI
@@ -25,6 +27,22 @@ module KnapsackPro
         def project_dir
           '/app' if node_build_id
         end
+
+        def user_seat
+          # not provided
+        end
+
+        def detected
+          ENV.key?('HEROKU_TEST_RUN_ID') ? self.class : nil
+        end
+
+        def fixed_queue_split
+          false
+        end
+
+        def ci_provider
+          "Heroku CI"
+        end
       end
     end
   end