knapsack_pro 2.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 575934b81520ce3bbf894d8cf643ae5af0279fd43b0529c62d8a4b71a595fbc8
-  data.tar.gz: dbebdb5c243e9a363a0f4737d4d78d9c2f1ff66f18e8087faafaece2299998eb
+  metadata.gz: 653a964b0c75547cec30531146adeb0075f251e6bc6511d4d85d710b778cf539
+  data.tar.gz: 21bb3baafa53c8dcc609d87e8fd8adb2b700df40f3275908968dee74f4186921
 SHA512:
-  metadata.gz: e636160f7c6793f371840b481154a7bcb6a5215580f5d5a92cd4be21242a544bc3c6bbf6c64d92da66fb2228e20f1ccf3836408405881c460c85472b0f3fbcb4
-  data.tar.gz: 41375edcb7f40c0044bacba75a89f0e43766261db0c148b525a565580592ad08df3cc9f37843fd056bc29ef79e0e3437266512cbdb6ddc7ce81219ee5ba92edf
+  metadata.gz: a09a6f1318b285910c1db3eb8828a2d79034cfd7a1cf23926995b91b89d68f768bdab003f33ee4fc1480c1431fd22cffe6236bc69413494147bc9d12619ee73e
+  data.tar.gz: 1aa7010f7a371a8dca1f333a1254261341bfec1143e101dc2e6a717aa0dac43f31f4382050da248bb87a387268bd2ef39eeeb64ed76f348293dd5efafe9607e3

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Change Log
 
+### 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

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.

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

@@ -42,7 +42,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 +63,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/config/env.rb

@@ -179,6 +179,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/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 = '2.0.0'
+  VERSION = '2.1.1'
 end

data/spec/knapsack_pro/config/env_spec.rb

@@ -658,6 +658,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 }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.1
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-27 00:00:00.000000000 Z
+date: 2020-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake