knapsack_pro 1.22.3 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36d79c8a60d76dff5b549e0507820264cf35c2f07f90eee9934f30e593191664
-  data.tar.gz: 532d70f5b50274cca485f527d3f553929c8a1e0432ede3bb517f0b29a5414df4
+  metadata.gz: a36ff1388dd1ad1c95c0fd5041fc771d27f28b36c0d02773fa8205ae4812818b
+  data.tar.gz: c07a145c9d4f62d9901cb1bb2122662ca57c69a75d8dd500771799af215204a0
 SHA512:
-  metadata.gz: 9b8755b6d9d1deb27982fc4c156baa1160fcf531799e77996248aa828070dbdcdbe8d5475b591bd2c5f3257de309056b2b39f685b42dd1c2378ce6dc9222f339
-  data.tar.gz: 7c24ae262d1691331b840783c530645440e22872372a56d8584e39b8e2a350c6235e75c9eac79dd5ecc4d0d05d74d65bdc4b176e937ee2b0277028d4c870b2f3
+  metadata.gz: 8aeb03d459916e73d5281fc28293300acc6e375747954afd070ef34cc062e08d603dee4bea5e614850ca723f15f3e926a69e7f0efee1399c02320baee0d18100
+  data.tar.gz: 1ac8483c14d798c0b4f8f163846e2f3e922223dad285516674568998ada15a917633a34b243b571b5f2e11f3d2a8d1086390ac1c39abd3205cb3c17aedf26c4f

data/CHANGELOG.md

@@ -1,5 +1,61 @@
 # Change Log
 
+### 2.3.0
+
+* When you use Regular Mode then try 6 attempts to connect to the API instead of 3 attempts
+
+    Add `KNAPSACK_PRO_MAX_REQUEST_RETRIES` environment variable to let user define their own number of request retries to the API. It is useful to set it to `0` for [forked repos](https://knapsackpro.com/faq/question/how-to-make-knapsack_pro-works-for-forked-repositories-of-my-project) when you want to relay on Fallback Mode.
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/124
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v2.2.1...v2.3.0
+
+### 2.2.1
+
+* Improve detection of test file path in test-unit runner for test files with shared examples
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/123
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v2.2.0...v2.2.1
+
+### 2.2.0
+
+* Allow defining Queue Mode hooks multiple times (`KnapsackPro::Hooks::Queue.before_queue`, `KnapsackPro::Hooks::Queue.after_subset_queue`, `KnapsackPro::Hooks::Queue.after_queue`)
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/122
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v2.1.1...v2.2.0
+
+### 2.1.1
+
+* Explicitly call root test runner class to avoid a confusing error when test runner gem is not loaded
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/120
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v2.1.0...v2.1.1
+
+### 2.1.0
+
+* Add `KNAPSACK_PRO_RSPEC_TEST_EXAMPLE_DETECTOR_PREFIX` to customize prefix for generating test examples report when using RSpec split by test examples
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/118
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v2.0.0...v2.1.0
+
+### 2.0.0
+
+* Add support for CI build ID for Github Actions
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/116
+
+    __Migration path for Github Actions users - required__
+
+    If you use Github Actions and Knapsack Pro Queue Mode then you must set in Github Actions environment variable: `KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true`. Thanks to that when you retry CI build then tests will run based on previously recorded tests. This solves problem mentioned in the [PR](https://github.com/KnapsackPro/knapsack_pro-ruby/pull/116).
+
+    __Migration path for other users__ - just update `knapsack_pro` gem. Nothing to change in your code :)
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v1.22.3...v2.0.0
+
 ### 1.22.3
 
 * Support for non-delimited formatting params of RSpec like `-fMyCustomFormatter`

data/README.md

@@ -84,6 +84,7 @@ We keep this old FAQ in README to not break old links spread across the web. You
   - [Supported test runners in queue mode](#supported-test-runners-in-queue-mode)
 - [Split test files by test cases](#split-test-files-by-test-cases)
   - [RSpec split test files by test examples (by individual `it`s)](#rspec-split-test-files-by-test-examples-by-individual-its)
+    - [Why I see error: Don't know how to build task 'knapsack_pro:rspec_test_example_detector'?](#why-i-see-error-dont-know-how-to-build-task-knapsack_prorspec_test_example_detector)
   - [How to manually define a list of slow test files to be split by test cases](#how-to-manually-define-a-list-of-slow-test-files-to-be-split-by-test-cases)
 - [Extra configuration for CI server](#extra-configuration-for-ci-server)
   - [Info about ENV variables](#info-about-env-variables)
@@ -618,6 +619,16 @@ KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES=true
 
 Thanks to that your CI build speed can be faster. We recommend using this feature with [Queue Mode](https://youtu.be/hUEB1XDKEFY) to ensure parallel CI nodes finish work at a similar time which gives you the shortest CI build time.
 
+#### Why I see error: Don't know how to build task 'knapsack_pro:rspec_test_example_detector'?
+
+If you will see error like:
+
+```
+Don't know how to build task 'knapsack_pro:rspec_test_example_detector' (See the list of available tasks with `rake --tasks`)
+```
+
+It probably means bundler can't find the rake task. You can try to remove the default prefix `bundle exec` used by knapsack_pro gem by setting `KNAPSACK_PRO_RSPEC_TEST_EXAMPLE_DETECTOR_PREFIX=""`.
+
 ### How to manually define a list of slow test files to be split by test cases
 
 If you don't want to rely on a list of test files from Knapsack Pro API to determine slow test files that should be split by test cases then you can define your own list of slow test files.
@@ -1639,6 +1650,9 @@ jobs:
         KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC: ${{ secrets.KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC }}
         KNAPSACK_PRO_CI_NODE_TOTAL: ${{ matrix.ci_node_total }}
         KNAPSACK_PRO_CI_NODE_INDEX: ${{ matrix.ci_node_index }}
+        # if you use Knapsack Pro Queue Mode you must set below env variable
+        # to be able to retry CI build and run previously recorded tests
+        KNAPSACK_PRO_FIXED_QUEUE_SPLIT: true
       run: |
         # run tests in Knapsack Pro Regular Mode
         bundle exec rake knapsack_pro:rspec
@@ -2306,11 +2320,19 @@ There are a few ways to reproduce tests executed on CI node in your development
 
 ##### for knapsack_pro regular mode
 
-knapsack_pro gem will retry requests to Knapsack Pro API multiple times every few seconds til it switch to fallback behavior and it will split test files across CI nodes based on popular test directory names. When knapsack_pro starts fallback mode then you will see a warning in the output.
+knapsack_pro gem will retry requests to Knapsack Pro API multiple times every few seconds till it switchs to fallback behavior (Fallback Mode) and it will split test files across CI nodes based on popular test directory names. When knapsack_pro starts Fallback Mode then you will see a warning in the output.
+
+Note there is an unlikely scenario when some of the CI nodes may start in Fallback Mode but others don't and then it could happen that some of test files might be skipped. You should [read this to learn more](https://github.com/KnapsackPro/knapsack_pro-ruby/pull/124) and decide if you like to use Fallback Mode when running tests with knapsack_pro Regular Mode.
+
+If your CI provider allows to retry only one of parallel CI nodes then please [read about this edge case as well](#required-ci-configuration-if-you-use-retry-single-failed-ci-node-feature-on-your-ci-server-when-knapsack_pro_fixed_queue_splittrue-in-queue-mode-or-knapsack_pro_fixed_test_suite_splittrue-in-regular-mode).
 
 ##### for knapsack_pro queue mode
 
-knapsack_pro gem will retry requests to Knapsack Pro API multiple times every few seconds till it switches to fallback behavior and it will split test files across CI nodes based on popular test directory names. Note that if one of CI nodes will lose connection to Knapsack Pro API but other not then you may see that some of the test files will be executed on multiple CI nodes. Fallback mode guarantees each of test files is run at least once across CI nodes. Thanks to that we know if the whole test suite is green or not. When knapsack_pro starts fallback mode then you will see a warning in the output.
+knapsack_pro gem will retry requests to Knapsack Pro API multiple times every few seconds till it switches to fallback behavior (Fallback Mode) and it will split test files across CI nodes based on popular test directory names.
+
+Note that if one of the CI nodes will lose connection to Knapsack Pro API but other not then you may see that some of the test files will be executed on multiple CI nodes. **Fallback Mode guarantees each of the test files is run at least once across CI nodes when you use knapsack_pro in Queue Mode.** Thanks to that we know if the whole test suite is green or not. When knapsack_pro starts Fallback Mode then you will see a warning in the output.
+
+If your CI provider allows to retry only one of parallel CI nodes then please [read about this edge case as well](#required-ci-configuration-if-you-use-retry-single-failed-ci-node-feature-on-your-ci-server-when-knapsack_pro_fixed_queue_splittrue-in-queue-mode-or-knapsack_pro_fixed_test_suite_splittrue-in-regular-mode).
 
 #### How can I change log level?
 
@@ -2723,6 +2745,8 @@ end
 
 #### What hooks are supported in Queue Mode?
 
+Note: Each hook type can be defined multiple times. For instance, if you define `KnapsackPro::Hooks::Queue.before_queue` twice then both block of code will be called when running your tests.
+
 * RSpec in knapsack_pro Queue Mode supports hooks:
 
 ```ruby

data/lib/knapsack_pro/adapters/cucumber_adapter.rb

@@ -4,7 +4,7 @@ module KnapsackPro
       TEST_DIR_PATTERN = 'features/**{,/*/**}/*.feature'
 
       def self.test_path(object)
-        if Cucumber::VERSION.to_i >= 2
+        if ::Cucumber::VERSION.to_i >= 2
           test_case = object
           test_case.location.file
         else

data/lib/knapsack_pro/adapters/minitest_adapter.rb

@@ -85,10 +85,10 @@ module KnapsackPro
       private
 
       def add_post_run_callback(&block)
-        if Minitest.respond_to?(:after_run)
-          Minitest.after_run { block.call }
+        if ::Minitest.respond_to?(:after_run)
+          ::Minitest.after_run { block.call }
         else
-          Minitest::Unit.after_tests { block.call }
+          ::Minitest::Unit.after_tests { block.call }
         end
       end
     end

data/lib/knapsack_pro/adapters/rspec_adapter.rb

@@ -4,7 +4,7 @@ module KnapsackPro
       TEST_DIR_PATTERN = 'spec/**{,/*/**}/*_spec.rb'
 
       def self.test_path(example_group)
-        if defined?(Turnip) && Turnip::VERSION.to_i < 2
+        if defined?(::Turnip) && ::Turnip::VERSION.to_i < 2
           unless example_group[:turnip]
             until example_group[:parent_example_group].nil?
               example_group = example_group[:parent_example_group]

data/lib/knapsack_pro/adapters/test_unit_adapter.rb

@@ -5,9 +5,29 @@ module KnapsackPro
       @@parent_of_test_dir = nil
 
       def self.test_path(obj)
-        first_test = obj.tests.first
-        method = first_test.method_name
-        full_test_path = first_test.method(method).source_location.first
+        full_test_path = nil
+        found_valid_test_file_path = false
+
+        obj.tests.each do |test_obj|
+          method = test_obj.method_name
+          full_test_path = test_obj.method(method).source_location.first
+          # if we find a test file path that is a valid test file path within test suite directory
+          # then break to stop looking further.
+          # If we won't find a valid test file path then the last found path will be used as full_test_path
+          # For instance if test file contains only shared examples then it's not possible to properly detect test file path
+          # so the wrong path can be used like:
+          # /Users/artur/.rvm/gems/ruby-2.6.5/gems/shared_should-0.10.0/lib/shared_should/shared_context.rb
+          if full_test_path.include?(@@parent_of_test_dir)
+            found_valid_test_file_path = true
+            break
+          end
+        end
+
+        unless found_valid_test_file_path
+          KnapsackPro.logger.warn('cannot detect a valid test file path. Probably the test file contains only shared examples. Please add test cases to your test file. Read more at https://github.com/KnapsackPro/knapsack_pro-ruby/pull/123')
+          KnapsackPro.logger.warn("See test file for #{obj.inspect}")
+        end
+
         parent_of_test_dir_regexp = Regexp.new("^#{@@parent_of_test_dir}")
         test_path = full_test_path.gsub(parent_of_test_dir_regexp, '.')
         # test_path will look like ./test/dir/unit_test.rb
@@ -42,7 +62,7 @@ module KnapsackPro
       end
 
       def bind_time_tracker
-        Test::Unit::TestSuite.send(:prepend, BindTimeTrackerTestUnitPlugin)
+        ::Test::Unit::TestSuite.send(:prepend, BindTimeTrackerTestUnitPlugin)
 
         add_post_run_callback do
           KnapsackPro.logger.debug(KnapsackPro::Presenter.global_time)
@@ -63,7 +83,7 @@ module KnapsackPro
       private
 
       def add_post_run_callback(&block)
-        Test::Unit.at_exit do
+        ::Test::Unit.at_exit do
           block.call
         end
       end

data/lib/knapsack_pro/base_allocator_builder.rb

@@ -34,7 +34,7 @@ module KnapsackPro
       test_files_to_run = all_test_files_to_run
 
       if adapter_class == KnapsackPro::Adapters::RSpecAdapter && KnapsackPro::Config::Env.rspec_split_by_test_examples?
-        unless Gem::Version.new(RSpec::Core::Version::STRING) >= Gem::Version.new('3.3.0')
+        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: https://github.com/KnapsackPro/knapsack_pro-ruby#split-test-files-by-test-cases'
         end
 
@@ -43,7 +43,12 @@ module KnapsackPro
         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 bundle exec rake knapsack_pro:rspec_test_example_detector'
+        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

data/lib/knapsack_pro/client/connection.rb

@@ -4,7 +4,6 @@ module KnapsackPro
       class ServerError < StandardError; end
 
       TIMEOUT = 15
-      MAX_RETRY = -> { KnapsackPro::Config::Env.fallback_mode_enabled? ? 3 : 6 }
       REQUEST_RETRY_TIMEBOX = 8
 
       def initialize(action)
@@ -118,7 +117,7 @@ module KnapsackPro
       rescue ServerError, Errno::ECONNREFUSED, Errno::ETIMEDOUT, Errno::EPIPE, EOFError, SocketError, Net::OpenTimeout, Net::ReadTimeout, OpenSSL::SSL::SSLError => e
         logger.warn(e.inspect)
         retries += 1
-        if retries < MAX_RETRY.call
+        if retries < max_request_retries
           wait = retries * REQUEST_RETRY_TIMEBOX
           logger.warn("Wait #{wait}s and retry request to Knapsack Pro API.")
           print_every = 2 # seconds
@@ -156,6 +155,22 @@ module KnapsackPro
           http.get(uri, json_headers)
         end
       end
+
+      def max_request_retries
+        # when user defined max request retries
+        return KnapsackPro::Config::Env.max_request_retries if KnapsackPro::Config::Env.max_request_retries
+
+        # when Fallback Mode is disabled then try more attempts to connect to the API
+        return 6 unless KnapsackPro::Config::Env.fallback_mode_enabled?
+
+        # when Regular Mode then try more attempts to connect to the API
+        # if only one CI node starts Fallback Mode instead of all then we can't guarantee all test files will be run
+        # https://github.com/KnapsackPro/knapsack_pro-ruby/pull/124
+        return 6 if KnapsackPro::Config::Env.regular_mode?
+
+        # default number of attempts
+        3
+      end
     end
   end
 end

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

@@ -1,4 +1,4 @@
-# https://help.github.com/en/articles/virtual-environments-for-github-actions#environment-variables
+# https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables
 module KnapsackPro
   module Config
     module CI
@@ -12,7 +12,8 @@ module KnapsackPro
         end
 
         def node_build_id
-          # not provided
+          # A unique number for each run within a repository. This number does not change if you re-run the workflow run.
+          ENV['GITHUB_RUN_ID']
         end
 
         def commit_hash

data/lib/knapsack_pro/config/env.rb

@@ -36,6 +36,13 @@ module KnapsackPro
           ).to_i
         end
 
+        def max_request_retries
+          number = ENV['KNAPSACK_PRO_MAX_REQUEST_RETRIES']
+          if number
+            number.to_i
+          end
+        end
+
         def commit_hash
           ENV['KNAPSACK_PRO_COMMIT_HASH'] ||
             ci_env_for(:commit_hash)
@@ -83,6 +90,10 @@ module KnapsackPro
           recording_enabled == 'true'
         end
 
+        def regular_mode?
+          recording_enabled?
+        end
+
         def queue_recording_enabled
           ENV['KNAPSACK_PRO_QUEUE_RECORDING_ENABLED']
         end
@@ -179,6 +190,10 @@ module KnapsackPro
           rspec_split_by_test_examples.to_s == 'true'
         end
 
+        def rspec_test_example_detector_prefix
+          ENV.fetch('KNAPSACK_PRO_RSPEC_TEST_EXAMPLE_DETECTOR_PREFIX', 'bundle exec')
+        end
+
         def test_suite_token
           env_name = 'KNAPSACK_PRO_TEST_SUITE_TOKEN'
           ENV[env_name] || raise("Missing environment variable #{env_name}. You should set environment variable like #{env_name}_RSPEC (note there is suffix _RSPEC at the end). knapsack_pro gem will set #{env_name} based on #{env_name}_RSPEC value. If you use other test runner than RSpec then use proper suffix.")

data/lib/knapsack_pro/formatters/rspec_json_formatter.rb

@@ -3,8 +3,8 @@ 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
 module KnapsackPro
   module Formatters
-    class RSpecJsonFormatter < RSpec::Core::Formatters::JsonFormatter
-      RSpec::Core::Formatters.register self
+    class RSpecJsonFormatter < ::RSpec::Core::Formatters::JsonFormatter
+      ::RSpec::Core::Formatters.register self
 
       private
 

data/lib/knapsack_pro/formatters/rspec_queue_profile_formatter_extension.rb

@@ -5,7 +5,7 @@ module KnapsackPro
     module RSpecQueueProfileFormatterExtension
       def self.print_summary
         return unless KnapsackPro::Config::Env.modify_default_rspec_formatters?
-        RSpec::Core::Formatters::ProfileFormatter.print_profile_summary
+        ::RSpec::Core::Formatters::ProfileFormatter.print_profile_summary
       end
 
       def initialize(output)

data/lib/knapsack_pro/formatters/rspec_queue_summary_formatter.rb

@@ -9,8 +9,8 @@ module KnapsackPro
       def dump_summary(summary); end
     end
 
-    class RSpecQueueSummaryFormatter < RSpec::Core::Formatters::BaseFormatter
-      RSpec::Core::Formatters.register self, :dump_summary, :dump_failures, :dump_pending
+    class RSpecQueueSummaryFormatter < ::RSpec::Core::Formatters::BaseFormatter
+      ::RSpec::Core::Formatters.register self, :dump_summary, :dump_failures, :dump_pending
 
       def self.registered_output=(output)
         @registered_output = {

data/lib/knapsack_pro/hooks/queue.rb

@@ -2,54 +2,63 @@ module KnapsackPro
   module Hooks
     class Queue
       class << self
-        attr_reader :before_queue,
-          :after_subset_queue,
-          :after_queue
+        attr_reader :before_queue_store,
+          :after_subset_queue_store,
+          :after_queue_store
 
         def reset_before_queue
-          @before_queue = nil
+          @before_queue_store = nil
         end
 
         def reset_after_subset_queue
-          @after_subset_queue = nil
+          @after_subset_queue_store = nil
         end
 
         def reset_after_queue
-          @after_queue = nil
+          @after_queue_store = nil
         end
 
         def before_queue(&block)
-          @before_queue ||= block
+          @before_queue_store ||= []
+          @before_queue_store << block
         end
 
         def after_subset_queue(&block)
-          @after_subset_queue ||= block
+          @after_subset_queue_store ||= []
+          @after_subset_queue_store << block
         end
 
         def after_queue(&block)
-          @after_queue ||= block
+          @after_queue_store ||= []
+          @after_queue_store << block
         end
 
         def call_before_queue
-          return unless before_queue
-          before_queue.call(
-            KnapsackPro::Config::Env.queue_id
-          )
+          return unless before_queue_store
+          before_queue_store.each do |block|
+            block.call(
+              KnapsackPro::Config::Env.queue_id
+            )
+          end
         end
 
         def call_after_subset_queue
-          return unless after_subset_queue
-          after_subset_queue.call(
-            KnapsackPro::Config::Env.queue_id,
-            KnapsackPro::Config::Env.subset_queue_id
-          )
+          return unless after_subset_queue_store
+          after_subset_queue_store.each do |block|
+            block.call(
+              KnapsackPro::Config::Env.queue_id,
+              KnapsackPro::Config::Env.subset_queue_id
+            )
+          end
         end
 
         def call_after_queue
-          return unless after_queue
-          after_queue.call(
-            KnapsackPro::Config::Env.queue_id
-          )
+          return unless after_queue_store
+          after_queue_store.each do |block|
+            block.call(
+              KnapsackPro::Config::Env.queue_id
+            )
+          end
         end
       end
     end

data/lib/knapsack_pro/runners/cucumber_runner.rb

@@ -15,7 +15,7 @@ module KnapsackPro
             Rake::Task[task_name].clear
           end
 
-          Cucumber::Rake::Task.new(task_name) do |t|
+          ::Cucumber::Rake::Task.new(task_name) do |t|
             t.cucumber_opts = "#{args} --require #{runner.test_dir} -- #{runner.stringify_test_file_paths}"
           end
           Rake::Task[task_name].invoke

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

@@ -89,9 +89,9 @@ module KnapsackPro
           end
 
           # duplicate args because Minitest modifies args
-          result = Minitest.run(args.dup)
+          result = ::Minitest.run(args.dup)
 
-          Minitest::Runnable.reset
+          ::Minitest::Runnable.reset
 
           result
         end

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

@@ -79,8 +79,8 @@ module KnapsackPro
 
             log_rspec_command(args, test_file_paths, :subset_queue)
 
-            options = RSpec::Core::ConfigurationOptions.new(cli_args)
-            exit_code = RSpec::Core::Runner.new(options).run($stderr, $stdout)
+            options = ::RSpec::Core::ConfigurationOptions.new(cli_args)
+            exit_code = ::RSpec::Core::Runner.new(options).run($stderr, $stdout)
             exitstatus = exit_code if exit_code != 0
 
             rspec_clear_examples
@@ -124,26 +124,26 @@ module KnapsackPro
         #
         # Keep formatters and report to accumulate info about failed/pending tests
         def self.rspec_clear_examples
-          if RSpec::ExampleGroups.respond_to?(:remove_all_constants)
-            RSpec::ExampleGroups.remove_all_constants
+          if ::RSpec::ExampleGroups.respond_to?(:remove_all_constants)
+            ::RSpec::ExampleGroups.remove_all_constants
           else
-            RSpec::ExampleGroups.constants.each do |constant|
-              RSpec::ExampleGroups.__send__(:remove_const, constant)
+            ::RSpec::ExampleGroups.constants.each do |constant|
+              ::RSpec::ExampleGroups.__send__(:remove_const, constant)
             end
           end
-          RSpec.world.example_groups.clear
-          RSpec.configuration.start_time = ::RSpec::Core::Time.now
+          ::RSpec.world.example_groups.clear
+          ::RSpec.configuration.start_time = ::RSpec::Core::Time.now
 
           if KnapsackPro::Config::Env.rspec_split_by_test_examples?
             # Reset example group counts to ensure scoped example ids in metadata
             # have correct index (not increased by each subsequent run).
             # Solves this problem: https://github.com/rspec/rspec-core/issues/2721
-            RSpec.world.instance_variable_set(:@example_group_counts_by_spec_file, Hash.new(0))
+            ::RSpec.world.instance_variable_set(:@example_group_counts_by_spec_file, Hash.new(0))
           end
 
           # skip reset filters for old RSpec versions
-          if RSpec.configuration.respond_to?(:reset_filters)
-            RSpec.configuration.reset_filters
+          if ::RSpec.configuration.respond_to?(:reset_filters)
+            ::RSpec.configuration.reset_filters
           end
         end
       end

data/lib/knapsack_pro/runners/rspec_runner.rb

@@ -15,7 +15,7 @@ module KnapsackPro
             Rake::Task[task_name].clear
           end
 
-          RSpec::Core::RakeTask.new(task_name) do |t|
+          ::RSpec::Core::RakeTask.new(task_name) do |t|
             # we cannot pass runner.test_file_paths array to t.pattern
             # because pattern does not accept test example path like spec/a_spec.rb[1:2]
             # instead we pass test files and test example paths to t.rspec_opts

data/lib/knapsack_pro/runners/test_unit_runner.rb

@@ -16,7 +16,7 @@ module KnapsackPro
               File.expand_path(f)
             end
 
-          exit Test::Unit::AutoRunner.run(
+          exit ::Test::Unit::AutoRunner.run(
             true,
             runner.test_dir,
             cli_args

data/lib/knapsack_pro/test_case_detectors/rspec_test_example_detector.rb

@@ -7,7 +7,7 @@ module KnapsackPro
         require 'rspec/core'
 
         cli_format =
-          if Gem::Version.new(RSpec::Core::Version::STRING) < Gem::Version.new('3.6.0')
+          if Gem::Version.new(::RSpec::Core::Version::STRING) < Gem::Version.new('3.6.0')
             require_relative '../formatters/rspec_json_formatter'
             ['--format', KnapsackPro::Formatters::RSpecJsonFormatter.to_s]
           else
@@ -30,8 +30,8 @@ module KnapsackPro
           '--out', report_path,
           '--default-path', test_dir,
         ] + KnapsackPro::TestFilePresenter.paths(test_file_entities)
-        options = RSpec::Core::ConfigurationOptions.new(cli_args)
-        exit_code = RSpec::Core::Runner.new(options).run($stderr, $stdout)
+        options = ::RSpec::Core::ConfigurationOptions.new(cli_args)
+        exit_code = ::RSpec::Core::Runner.new(options).run($stderr, $stdout)
         if exit_code != 0
           raise 'There was problem to generate test examples for test suite'
         end

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '1.22.3'
+  VERSION = '2.3.0'
 end

data/spec/knapsack_pro/adapters/test_unit_adapter_spec.rb

@@ -10,8 +10,7 @@ describe KnapsackPro::Adapters::TestUnitAdapter do
 
     before do
       parent_of_test_dir = File.expand_path('../../../', File.dirname(__FILE__))
-      parent_of_test_dir_regexp = Regexp.new("^#{parent_of_test_dir}")
-      described_class.class_variable_set(:@@parent_of_test_dir, parent_of_test_dir_regexp)
+      described_class.class_variable_set(:@@parent_of_test_dir, parent_of_test_dir)
     end
 
     context 'when regular test' do

data/spec/knapsack_pro/client/connection_spec.rb

@@ -108,6 +108,53 @@ shared_examples 'when retry request' do
       expect(connection.errors?).to be true
     end
 
+    context 'when max request retries defined' do
+      before do
+        expect(KnapsackPro::Config::Env).to receive(:max_request_retries).at_least(1).and_return(4)
+      end
+
+      it do
+        expect(logger).to receive(:debug).exactly(4).with("#{expected_http_method} http://api.knapsackpro.test:3000/v1/fake_endpoint")
+        expect(logger).to receive(:debug).exactly(4).with('API request UUID: fake-uuid')
+        expect(logger).to receive(:debug).exactly(4).with('API response:')
+
+        parsed_response = { 'error' => 'Internal Server Error' }
+
+        expect(logger).to receive(:error).exactly(4).with(parsed_response)
+
+        server_error = described_class::ServerError.new(parsed_response)
+        expect(logger).to receive(:warn).exactly(4).with(server_error.inspect)
+
+        expect(logger).to receive(:warn).with("Wait 8s and retry request to Knapsack Pro API.")
+        expect(logger).to receive(:warn).with("Next request in 8s...")
+        expect(logger).to receive(:warn).with("Next request in 6s...")
+        expect(logger).to receive(:warn).with("Next request in 4s...")
+        expect(logger).to receive(:warn).with("Next request in 2s...")
+
+        expect(logger).to receive(:warn).with("Wait 16s and retry request to Knapsack Pro API.")
+        expect(logger).to receive(:warn).with("Next request in 16s...")
+        expect(logger).to receive(:warn).with("Next request in 14s...")
+        expect(logger).to receive(:warn).with("Next request in 12s...")
+        expect(logger).to receive(:warn).with("Next request in 10s...")
+        expect(logger).to receive(:warn).with("Next request in 8s...")
+        expect(logger).to receive(:warn).with("Next request in 6s...")
+        expect(logger).to receive(:warn).with("Next request in 4s...")
+        expect(logger).to receive(:warn).with("Next request in 2s...")
+
+        expect(logger).to receive(:warn).with("Wait 24s and retry request to Knapsack Pro API.")
+        12.times do |i|
+          expect(logger).to receive(:warn).with("Next request in #{(i+1)*2}s...")
+        end
+
+        expect(Kernel).to receive(:sleep).exactly(4+8+12).with(2)
+
+        expect(subject).to eq(parsed_response)
+
+        expect(connection.success?).to be false
+        expect(connection.errors?).to be true
+      end
+    end
+
     context 'when Fallback Mode is disabled' do
       before do
         expect(KnapsackPro::Config::Env).to receive(:fallback_mode_enabled?).at_least(1).and_return(false)
@@ -164,6 +211,63 @@ shared_examples 'when retry request' do
         expect(connection.errors?).to be true
       end
     end
+
+    context 'when Regular Mode' do
+      before do
+        expect(KnapsackPro::Config::Env).to receive(:regular_mode?).at_least(1).and_return(true)
+      end
+
+      it do
+        expect(logger).to receive(:debug).exactly(6).with("#{expected_http_method} http://api.knapsackpro.test:3000/v1/fake_endpoint")
+        expect(logger).to receive(:debug).exactly(6).with('API request UUID: fake-uuid')
+        expect(logger).to receive(:debug).exactly(6).with('API response:')
+
+        parsed_response = { 'error' => 'Internal Server Error' }
+
+        expect(logger).to receive(:error).exactly(6).with(parsed_response)
+
+        server_error = described_class::ServerError.new(parsed_response)
+        expect(logger).to receive(:warn).exactly(6).with(server_error.inspect)
+
+        expect(logger).to receive(:warn).with("Wait 8s and retry request to Knapsack Pro API.")
+        expect(logger).to receive(:warn).with("Next request in 8s...")
+        expect(logger).to receive(:warn).with("Next request in 6s...")
+        expect(logger).to receive(:warn).with("Next request in 4s...")
+        expect(logger).to receive(:warn).with("Next request in 2s...")
+
+        expect(logger).to receive(:warn).with("Wait 16s and retry request to Knapsack Pro API.")
+        expect(logger).to receive(:warn).with("Next request in 16s...")
+        expect(logger).to receive(:warn).with("Next request in 14s...")
+        expect(logger).to receive(:warn).with("Next request in 12s...")
+        expect(logger).to receive(:warn).with("Next request in 10s...")
+        expect(logger).to receive(:warn).with("Next request in 8s...")
+        expect(logger).to receive(:warn).with("Next request in 6s...")
+        expect(logger).to receive(:warn).with("Next request in 4s...")
+        expect(logger).to receive(:warn).with("Next request in 2s...")
+
+        expect(logger).to receive(:warn).with("Wait 24s and retry request to Knapsack Pro API.")
+        12.times do |i|
+          expect(logger).to receive(:warn).with("Next request in #{(i+1)*2}s...")
+        end
+
+        expect(logger).to receive(:warn).with("Wait 32s and retry request to Knapsack Pro API.")
+        16.times do |i|
+          expect(logger).to receive(:warn).with("Next request in #{(i+1)*2}s...")
+        end
+
+        expect(logger).to receive(:warn).with("Wait 40s and retry request to Knapsack Pro API.")
+        20.times do |i|
+          expect(logger).to receive(:warn).with("Next request in #{(i+1)*2}s...")
+        end
+
+        expect(Kernel).to receive(:sleep).exactly(60).with(2)
+
+        expect(subject).to eq(parsed_response)
+
+        expect(connection.success?).to be false
+        expect(connection.errors?).to be true
+      end
+    end
   end
 end
 

data/spec/knapsack_pro/config/ci/github_actions_spec.rb

@@ -22,7 +22,14 @@ describe KnapsackPro::Config::CI::GithubActions do
   describe '#node_build_id' do
     subject { described_class.new.node_build_id }
 
-    it { should be nil }
+    context 'when environment exists' do
+      let(:env) { { 'GITHUB_RUN_ID' => 2706 } }
+      it { should eql 2706 }
+    end
+
+    context "when environment doesn't exist" do
+      it { should be nil }
+    end
   end
 
   describe '#commit_hash' do

data/spec/knapsack_pro/config/env_spec.rb

@@ -100,6 +100,19 @@ describe KnapsackPro::Config::Env do
     end
   end
 
+  describe '.max_request_retries' do
+    subject { described_class.max_request_retries }
+
+    context 'when ENV exists' do
+      before { stub_const("ENV", { 'KNAPSACK_PRO_MAX_REQUEST_RETRIES' => '2' }) }
+      it { should eq 2 }
+    end
+
+    context "when ENV doesn't exist" do
+      it { should be_nil }
+    end
+  end
+
   describe '.commit_hash' do
     subject { described_class.commit_hash }
 
@@ -267,6 +280,25 @@ describe KnapsackPro::Config::Env do
     end
   end
 
+
+  describe '.regular_mode?' do
+    subject { described_class.regular_mode? }
+
+    before do
+      expect(described_class).to receive(:recording_enabled?).and_return(recording_enabled)
+    end
+
+    context 'when recording is enabled' do
+      let(:recording_enabled) { true }
+      it { should be true }
+    end
+
+    context 'when recording is not enabled' do
+      let(:recording_enabled) { false }
+      it { should be false }
+    end
+  end
+
   describe '.recording_enabled?' do
     subject { described_class.recording_enabled? }
 
@@ -658,6 +690,20 @@ describe KnapsackPro::Config::Env do
     end
   end
 
+  describe '.rspec_test_example_detector_prefix' do
+    subject { described_class.rspec_test_example_detector_prefix }
+
+    context 'when ENV exists' do
+      before { stub_const("ENV", { 'KNAPSACK_PRO_RSPEC_TEST_EXAMPLE_DETECTOR_PREFIX' => '' }) }
+      it { should eq '' }
+    end
+
+    context "when ENV doesn't exist" do
+      before { stub_const("ENV", {}) }
+      it { should eq 'bundle exec' }
+    end
+  end
+
   describe '.test_suite_token' do
     subject { described_class.test_suite_token }
 

data/spec/knapsack_pro/hooks/queue_spec.rb

@@ -10,18 +10,30 @@ describe KnapsackPro::Hooks::Queue do
       it { should be_nil }
     end
 
-    context 'when callback is set' do
+    context 'when callback is set multiple times' do
       let(:queue_id) { double }
 
       before do
-        expect(KnapsackPro::Config::Env).to receive(:queue_id).and_return(queue_id)
+        expect(KnapsackPro::Config::Env).to receive(:queue_id).twice.and_return(queue_id)
 
+        $expected_called_blocks = []
+
+        described_class.before_queue do |q_id|
+          $expected_called_blocks << [:block_1_called, q_id]
+        end
         described_class.before_queue do |q_id|
-          [:fake_value, q_id]
+          $expected_called_blocks << [:block_2_called, q_id]
         end
       end
 
-      it { should eq [:fake_value, queue_id] }
+      it 'each block is called' do
+        subject
+
+        expect($expected_called_blocks).to eq([
+          [:block_1_called, queue_id],
+          [:block_2_called, queue_id],
+        ])
+      end
     end
   end
 
@@ -36,20 +48,32 @@ describe KnapsackPro::Hooks::Queue do
       it { should be_nil }
     end
 
-    context 'when callback is set' do
+    context 'when callback is set multiple times' do
       let(:queue_id) { double }
       let(:subset_queue_id) { double }
 
       before do
-        expect(KnapsackPro::Config::Env).to receive(:queue_id).and_return(queue_id)
-        expect(KnapsackPro::Config::Env).to receive(:subset_queue_id).and_return(subset_queue_id)
+        expect(KnapsackPro::Config::Env).to receive(:queue_id).twice.and_return(queue_id)
+        expect(KnapsackPro::Config::Env).to receive(:subset_queue_id).twice.and_return(subset_queue_id)
+
+        $expected_called_blocks = []
 
         described_class.after_subset_queue do |q_id, subset_q_id|
-          [:fake_value, q_id, subset_q_id]
+          $expected_called_blocks << [:block_1_called, q_id, subset_q_id]
+        end
+        described_class.after_subset_queue do |q_id, subset_q_id|
+          $expected_called_blocks << [:block_2_called, q_id, subset_q_id]
         end
       end
 
-      it { should eq [:fake_value, queue_id, subset_queue_id] }
+      it 'each block is called' do
+        subject
+
+        expect($expected_called_blocks).to eq([
+          [:block_1_called, queue_id, subset_queue_id],
+          [:block_2_called, queue_id, subset_queue_id],
+        ])
+      end
     end
   end
 
@@ -64,18 +88,30 @@ describe KnapsackPro::Hooks::Queue do
       it { should be_nil }
     end
 
-    context 'when callback is set' do
+    context 'when callback is set multiple times' do
       let(:queue_id) { double }
 
       before do
-        expect(KnapsackPro::Config::Env).to receive(:queue_id).and_return(queue_id)
+        expect(KnapsackPro::Config::Env).to receive(:queue_id).twice.and_return(queue_id)
+
+        $expected_called_blocks = []
 
         described_class.after_queue do |q_id|
-          [:fake_value, q_id]
+          $expected_called_blocks << [:block_1_called, q_id]
+        end
+        described_class.after_queue do |q_id|
+          $expected_called_blocks << [:block_2_called, q_id]
         end
       end
 
-      it { should eq [:fake_value, queue_id] }
+      it 'each block is called' do
+        subject
+
+        expect($expected_called_blocks).to eq([
+          [:block_1_called, queue_id],
+          [:block_2_called, queue_id],
+        ])
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 1.22.3
+  version: 2.3.0
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-22 00:00:00.000000000 Z
+date: 2020-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake