knapsack_pro 3.8.0 → 7.0.0

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

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Config
     module CI
+      # Semaphore Classic is deprecated
+      # https://semaphoreci.com/blog/semaphore-classic-deprecation
       class Semaphore < Base
         def node_total
           ENV['SEMAPHORE_THREAD_COUNT']
@@ -26,6 +30,18 @@ module KnapsackPro
         def project_dir
           ENV['SEMAPHORE_PROJECT_DIR']
         end
+
+        def detected
+          ENV.key?('SEMAPHORE_BUILD_NUMBER') ? self.class : nil
+        end
+
+        def fixed_queue_split
+          false
+        end
+
+        def ci_provider
+          "Semaphore CI 1.0"
+        end
       end
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # https://docs.semaphoreci.com/article/12-environment-variables
 module KnapsackPro
   module Config
@@ -29,6 +31,23 @@ module KnapsackPro
             "#{ENV['HOME']}/#{ENV['SEMAPHORE_GIT_DIR']}"
           end
         end
+
+        def user_seat
+          # not provided
+        end
+
+        def detected
+          # check 2 keys to be sure we are using Semaphore 2.0
+          ENV.key?('SEMAPHORE') && ENV.key?('SEMAPHORE_WORKFLOW_ID') ? self.class : nil
+        end
+
+        def fixed_queue_split
+          false
+        end
+
+        def ci_provider
+          "Semaphore CI 2.0"
+        end
       end
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Config
     module CI
@@ -17,6 +19,22 @@ module KnapsackPro
         def project_dir
           ENV['TRAVIS_BUILD_DIR']
         end
+
+        def user_seat
+          # not provided
+        end
+
+        def detected
+          ENV.key?('TRAVIS') ? self.class : nil
+        end
+
+        def fixed_queue_split
+          true
+        end
+
+        def ci_provider
+          "Travis CI"
+        end
       end
     end
   end

data/lib/knapsack_pro/config/env.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Config
     class Env
@@ -23,9 +25,10 @@ module KnapsackPro
         end
 
         def ci_node_build_id
-          ENV['KNAPSACK_PRO_CI_NODE_BUILD_ID'] ||
+          env_name = 'KNAPSACK_PRO_CI_NODE_BUILD_ID'
+          ENV[env_name] ||
             ci_env_for(:node_build_id) ||
-            'missing-build-id'
+            raise("Missing environment variable #{env_name}. Read more at #{KnapsackPro::Urls::KNAPSACK_PRO_CI_NODE_BUILD_ID}")
         end
 
         def ci_node_retry_count
@@ -58,6 +61,17 @@ module KnapsackPro
             ci_env_for(:project_dir)
         end
 
+        def user_seat
+          ENV['KNAPSACK_PRO_USER_SEAT'] ||
+            ci_env_for(:user_seat)
+        end
+
+        def masked_user_seat
+          return unless user_seat
+
+          KnapsackPro::MaskString.call(user_seat)
+        end
+
         def test_file_pattern
           ENV['KNAPSACK_PRO_TEST_FILE_PATTERN']
         end
@@ -130,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
@@ -175,7 +181,16 @@ module KnapsackPro
         end
 
         def fixed_queue_split
-          ENV.fetch('KNAPSACK_PRO_FIXED_QUEUE_SPLIT', false)
+          @fixed_queue_split ||= begin
+            env_name = 'KNAPSACK_PRO_FIXED_QUEUE_SPLIT'
+            computed = ENV.fetch(env_name, ci_env_for(:fixed_queue_split)).to_s
+
+            if !ENV.key?(env_name)
+              KnapsackPro.logger.info("#{env_name} is not set. Using default value: #{computed}. Learn more at #{KnapsackPro::Urls::FIXED_QUEUE_SPLIT}")
+            end
+
+            computed
+          end
         end
 
         def fixed_queue_split?
@@ -235,21 +250,25 @@ module KnapsackPro
         end
 
         def ci_env_for(env_name)
-          value = nil
-          ci_list = KnapsackPro::Config::CI.constants - [:Base, :GitlabCI]
-          # load GitLab CI first to avoid edge case with order of loading envs for CI_NODE_INDEX
-          ci_list = [:GitlabCI] + ci_list
-          ci_list.each do |ci_name|
-            ci_class = Object.const_get("KnapsackPro::Config::CI::#{ci_name}")
-            ci = ci_class.new
-            value = ci.send(env_name)
-            break unless value.nil?
+          detected_ci.new.send(env_name)
+        end
+
+        def detected_ci
+          detected = KnapsackPro::Config::CI.constants.map do |constant|
+            Object.const_get("KnapsackPro::Config::CI::#{constant}").new.detected
           end
-          value
+            .compact
+            .first
+
+          detected || KnapsackPro::Config::CI::Base
+        end
+
+        def ci_provider
+          detected_ci.new.ci_provider
         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
@@ -264,6 +283,11 @@ module KnapsackPro
           ENV['KNAPSACK_PRO_TEST_RUNNER_ADAPTER'] = adapter_class.to_s.split('::').last
         end
 
+        def ci?
+          ENV.fetch('CI', 'false').downcase == 'true' ||
+            detected_ci != KnapsackPro::Config::CI::Base
+        end
+
         private
 
         def required_env(env_name)

data/lib/knapsack_pro/config/env_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Config
     class EnvGenerator

data/lib/knapsack_pro/config/temp_files.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Config
     class TempFiles
@@ -22,10 +24,12 @@ module KnapsackPro
       end
 
       def self.gitignore_file_content
-        "# This directory is used by knapsack_pro gem for storing temporary files during tests runtime.\n" <<
-        "# Ignore all files, and do not commit this directory into your repository.\n" <<
-        "# Learn more at https://knapsackpro.com\n" <<
-        "*"
+        <<~GITIGNORE
+        # This directory is used by knapsack_pro gem for storing temporary files during tests runtime.
+        # Ignore all files, and do not commit this directory into your repository.
+        # Learn more at https://knapsackpro.com
+        *
+        GITIGNORE
       end
 
       def self.create_gitignore_file!

data/lib/knapsack_pro/crypto/branch_encryptor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Crypto
     class BranchEncryptor

data/lib/knapsack_pro/crypto/decryptor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Crypto
     class Decryptor

data/lib/knapsack_pro/crypto/digestor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Crypto
     class Digestor

data/lib/knapsack_pro/crypto/encryptor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Crypto
     class Encryptor

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec::Support.require_rspec_core('formatters/json_formatter')
 
 # based on https://github.com/rspec/rspec-core/blob/master/lib/rspec/core/formatters/json_formatter.rb

data/lib/knapsack_pro/formatters/time_tracker.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+require 'stringio'
+
+module KnapsackPro
+  module Formatters
+    class TimeTracker
+      ::RSpec::Core::Formatters.register self,
+        :example_group_started,
+        :example_started,
+        :example_finished,
+        :example_group_finished
+
+      attr_reader :output # RSpec < v3.10.2
+
+      def initialize(_output)
+        @output = StringIO.new
+        @time_each = nil
+        @time_all = nil
+        @before_all = 0.0
+        @group = {}
+        @paths = {}
+        @suite_started = now
+      end
+
+      def example_group_started(notification)
+        return unless top_level_group?(notification.group)
+        @time_all = now
+      end
+
+      def example_started(_notification)
+        @before_all = now - @time_all if @before_all == 0.0
+        @time_each = now
+      end
+
+      def example_finished(notification)
+        record_example(@group, notification.example, @time_each)
+        @time_all = now
+      end
+
+      def example_group_finished(notification)
+        return unless top_level_group?(notification.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
+
+      def queue(scheduled_paths)
+        recorded_paths = @paths.values.map do |example|
+          KnapsackPro::Adapters::RSpecAdapter.parse_file_path(example[:path])
+        end
+
+        missing = (scheduled_paths - recorded_paths).each_with_object({}) do |path, object|
+          object[path] = { path: path, time_execution: 0.0 }
+        end
+
+        merge(@paths, missing).values.map do |example|
+          example.transform_keys(&:to_s)
+        end
+      end
+
+      def batch
+        @paths.values.map do |example|
+          example.transform_keys(&:to_s)
+        end
+      end
+
+      def duration
+        now - @suite_started
+      end
+
+      def unexecuted_test_files(scheduled_paths)
+        pending_paths = @paths.values
+          .filter { |example| example[:time_execution] == 0.0 }
+          .map { |example| example[:path] }
+
+        not_run_paths = scheduled_paths -
+          @paths.values
+          .map { |example| example[:path] }
+
+        pending_paths + not_run_paths
+      end
+
+      private
+
+      def top_level_group?(group)
+        group.metadata[:parent_example_group].nil?
+      end
+
+      def add_hooks_time(group, before_all, after_all)
+        group.each do |_, example|
+          next if example[:time_execution] == 0.0
+          example[:time_execution] += before_all + after_all
+        end
+      end
+
+      def record_example(accumulator, example, started_at)
+        path = path_for(example)
+        return if path.nil?
+
+        time_execution = time_execution_for(example, started_at)
+        if accumulator.key?(path)
+          accumulator[path][:time_execution] += time_execution
+        else
+          accumulator[path] = { path: path, time_execution: time_execution }
+        end
+      end
+
+      def path_for(example)
+        file = file_path_for(example)
+        return nil if file == ""
+
+        path = rspec_split_by_test_example?(file) ? example.id : file
+        KnapsackPro::TestFileCleaner.clean(path)
+      end
+
+      def rspec_split_by_test_example?(file)
+        return false unless KnapsackPro::Config::Env.rspec_split_by_test_examples?
+        return false unless KnapsackPro::Adapters::RSpecAdapter.slow_test_file?(KnapsackPro::Adapters::RSpecAdapter, file)
+        true
+      end
+
+      def file_path_for(example)
+        KnapsackPro::Adapters::RSpecAdapter.file_path_for(example)
+      end
+
+      def time_execution_for(example, started_at)
+        if example.execution_result.status.to_s == "pending"
+          0.0
+        else
+          (now - started_at).to_f
+        end
+      end
+
+      def merge(h1, h2)
+        h1.merge(h2) do |key, v1, v2|
+          {
+            path: key,
+            time_execution: v1[:time_execution] + v2[:time_execution]
+          }
+        end
+      end
+
+      def now
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+    end
+  end
+end

data/lib/knapsack_pro/formatters/time_tracker_fetcher.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module KnapsackPro
+  module Formatters
+    class TimeTrackerFetcher
+      def self.call
+        ::RSpec
+          .configuration
+          .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/hooks/queue.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Hooks
     class Queue

data/lib/knapsack_pro/logger_wrapper.rb

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

data/lib/knapsack_pro/mask_string.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module KnapsackPro
+  class MaskString
+    def self.call(string)
+      string.gsub(/(?<=\w{2})[a-zA-Z]/, "*")
+    end
+  end
+end

data/lib/knapsack_pro/presenter.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   class Presenter
     class << self
-      def global_time
-        global_time = pretty_seconds(KnapsackPro.tracker.global_time)
-        "Global time execution for tests: #{global_time}"
+      def global_time(time = nil)
+        time = KnapsackPro.tracker.global_time if time.nil?
+        global_time = pretty_seconds(time)
+        "Global test execution duration: #{global_time}"
       end
 
       def pretty_seconds(seconds)