knapsack_pro 2.18.2 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a298724c7651190199978edc99b96116abcbb827d12237e128f2c5d87297847
-  data.tar.gz: 2750130109b114747278d86fd4bc2477d143b2f1f3564f7b36d224f5044e29cf
+  metadata.gz: 7970b3bcbc62109c8b7e2161e75d5b4a8337494516817dbd8c2b4929b46bbd10
+  data.tar.gz: 60b57c64958cb342a9b21c1dc0db32bfa70e8e105ab4680e18fd430d4148a1b7
 SHA512:
-  metadata.gz: 7742dbaf98eb6bc1aeda1c15c2dd3b8f627fe27c91fa58a4f46e71d2ff4839d5899005b36deddcb619745689dd6426f9319df1b70ad26f317be2cea2e6922799
-  data.tar.gz: a102bc5ab00cabc5ec4f7007e52081fd97ca194ea8e84072b2df8fb66664c6e320ea7b76d0970aa702ed9549e36bd5c702a7156de914b5fbdf9fe00c43de8351
+  metadata.gz: 0b0a4160292a07b8ae1cc21f34c2cf0d8de1ce53d4e0501b4ba4715feb9aa51317e3f1503e3e00532d048daec816e58cd3a95dec2111fedd77f7a47206d81dcb
+  data.tar.gz: c083b70fb826837650d206c6f433f207cac995bbd3e6a36c386b038302bbf7b5bd90d3df201af9e8f5cdf5f68b38d4f45e1a4a7cdc0c4b9c2a533559b45cfe99

data/.circleci/config.yml

@@ -8,7 +8,7 @@ jobs:
     parallelism: 1
     docker:
       # specify the version you desire here
-      - image: circleci/ruby:3.0.1
+      - image: circleci/ruby:3.0.2
         environment:
           CODECLIMATE_REPO_TOKEN: b6626e682a8e97e0c5978febc92c3526792a2d018b41b8e1b52689da37fb7d92
 

data/.gitignore

@@ -8,6 +8,7 @@
 /test/tmp/
 /test/version_tmp/
 /tmp/
+.knapsack_pro
 
 ## Specific to RubyMotion:
 .dat*

data/CHANGELOG.md

@@ -1,5 +1,38 @@
 # Change Log
 
+### 3.1.2
+
+* Fix bug when test files have no recorded time execution then they should not be detected as slow test files for RSpec split by test examples feature
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/163
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v3.1.1...v3.1.2
+
+### 3.1.1
+
+* Rephrase log outputs in the Queue Mode RSpec runner
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/160
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v3.1.0...v3.1.1
+
+### 3.1.0
+
+* Use `.knapsack_pro` directory for temporary files instead of the `tmp` directory in the user's project directory
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/155
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v3.0.0...v3.1.0
+
+### 3.0.0
+
+* __(breaking change)__ Remove support for RSpec 2.x. This change was already done by accident in [the pull request](https://github.com/KnapsackPro/knapsack_pro-ruby/pull/143) when we added the RSpec `context` hook, which is available only since RSpec 3.x.
+* Use RSpec `example` block argument instead of the global `RSpec.current_example`. This allows to run tests with the `async-rspec` gem.
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/153
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v2.18.2...v3.0.0
+
 ### 2.18.2
 
 * Track all test files assigned to a CI node in Regular Mode including pending test files in order to retry proper set of tests on the retried CI node

data/README.md

@@ -1714,6 +1714,11 @@ $ gem push knapsack_pro-X.X.X.gem
 
 Update the latest available gem version in `TestSuiteClientVersionChecker` for the Knapsack Pro API repository.
 
+Update knapsack_pro gem version in:
+
+* https://github.com/KnapsackPro/rails-app-with-knapsack_pro
+* our private Knapsack Pro API repository
+
 ## Mentions
 
 List of articles where people mentioned Knapsack Pro:

data/knapsack_pro.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rake', '>= 0'
 
   spec.add_development_dependency 'bundler', '>= 1.6'
-  spec.add_development_dependency 'rspec', '~> 3.0', '>= 2.10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec-its', '~> 1.3'
   spec.add_development_dependency 'cucumber', '>= 0'
   spec.add_development_dependency 'spinach', '>= 0.8'

data/lib/knapsack_pro/adapters/base_adapter.rb

@@ -6,7 +6,7 @@ module KnapsackPro
 
       def self.adapter_bind_method_called_file
         adapter_name = self.to_s.gsub('::', '-')
-        "#{KnapsackPro::Config::Env::TMP_DIR}/#{adapter_name}-bind_method_called_for_node_#{KnapsackPro::Config::Env.ci_node_index}.txt"
+        "#{KnapsackPro::Config::TempFiles::TEMP_DIRECTORY_PATH}/#{adapter_name}-bind_method_called_for_node_#{KnapsackPro::Config::Env.ci_node_index}.txt"
       end
 
       def self.slow_test_file?(adapter_class, test_file_path)
@@ -33,20 +33,20 @@ module KnapsackPro
 
       def self.verify_bind_method_called
         ::Kernel.at_exit do
-          if File.exists?(adapter_bind_method_called_file)
+          if File.exist?(adapter_bind_method_called_file)
             File.delete(adapter_bind_method_called_file)
           else
             puts "\n\n"
             KnapsackPro.logger.error('-'*10 + ' Configuration error ' + '-'*50)
             KnapsackPro.logger.error("You forgot to call #{self}.bind method in your test runner configuration file. It is needed to record test files time execution. Please follow the installation guide to configure your project properly https://docs.knapsackpro.com/knapsack_pro-ruby/guide/")
-            KnapsackPro.logger.error("If you already have #{self}.bind method added and you still see this error then one of your tests must had to delete tmp/knapsack_pro directory from the disk accidentally. Please ensure you do not remove tmp/knapsack_pro directory: https://knapsackpro.com/faq/question/why-all-test-files-have-01s-time-execution-for-my-ci-build-in-user-dashboard")
+            KnapsackPro.logger.error("If you already have #{self}.bind method added and you still see this error then one of your tests must have deleted the .knapsack_pro directory from the disk accidentally. Please ensure you do not remove the .knapsack_pro directory: https://knapsackpro.com/faq/question/why-all-test-files-have-01s-time-execution-for-my-ci-build-in-user-dashboard")
             Kernel.exit(1)
           end
         end
       end
 
       def bind
-        FileUtils.mkdir_p(KnapsackPro::Config::Env::TMP_DIR)
+        KnapsackPro::Config::TempFiles.ensure_temp_directory_exists!
         File.write(self.class.adapter_bind_method_called_file, nil)
 
         if KnapsackPro::Config::Env.recording_enabled?

data/lib/knapsack_pro/adapters/rspec_adapter.rb

@@ -24,8 +24,10 @@ module KnapsackPro
         cli_args.any? { |arg| arg.start_with?('-f') || arg.start_with?('--format') }
       end
 
-      def self.test_path(example_group)
-        if defined?(::Turnip) && ::Turnip::VERSION.to_i < 2
+      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]
@@ -51,14 +53,7 @@ module KnapsackPro
             # this way we count time spend in runtime for the previous test example after around(:each) is already done
             KnapsackPro.tracker.stop_timer
 
-            current_example_group =
-              if ::RSpec.respond_to?(:current_example)
-                ::RSpec.current_example.metadata[:example_group]
-              else
-                example.metadata
-              end
-
-            current_test_path = KnapsackPro::Adapters::RSpecAdapter.test_path(current_example_group)
+            current_test_path = KnapsackPro::Adapters::RSpecAdapter.test_path(example)
 
             KnapsackPro.tracker.current_test_path =
               if KnapsackPro::Config::Env.rspec_split_by_test_examples? && KnapsackPro::Adapters::RSpecAdapter.slow_test_file?(RSpecAdapter, current_test_path)

data/lib/knapsack_pro/config/env.rb

@@ -8,7 +8,6 @@ module KnapsackPro
         'info'  => ::Logger::INFO,
         'debug' => ::Logger::DEBUG,
       }
-      TMP_DIR = 'tmp/knapsack_pro'
 
       class << self
         def ci_node_total

data/lib/knapsack_pro/config/temp_files.rb

@@ -0,0 +1,38 @@
+module KnapsackPro
+  module Config
+    class TempFiles
+      # relative to the directory where you run knapsack_pro gem (user's project)
+      TEMP_DIRECTORY_PATH = '.knapsack_pro'
+
+      def self.ensure_temp_directory_exists!
+        unless File.exist?(gitignore_file_path)
+          create_temp_directory!
+          create_gitignore_file!
+        end
+      end
+
+      private
+
+      def self.create_temp_directory!
+        FileUtils.mkdir_p(TEMP_DIRECTORY_PATH)
+      end
+
+      def self.gitignore_file_path
+        File.join(TEMP_DIRECTORY_PATH, '.gitignore')
+      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" <<
+        "*"
+      end
+
+      def self.create_gitignore_file!
+        File.open(gitignore_file_path, 'w+') do |f|
+          f.write(gitignore_file_content)
+        end
+      end
+    end
+  end
+end

data/lib/knapsack_pro/report.rb

@@ -5,7 +5,7 @@ module KnapsackPro
 
       if test_files.empty?
         KnapsackPro.logger.warn("No test files were executed on this CI node.")
-        KnapsackPro.logger.debug("When you use knapsack_pro regular mode then probably reason might be very narrowed tests list - you run only tests with specified tag and there are fewer test files with the tag than node total number.")
+        KnapsackPro.logger.debug("When you use knapsack_pro Regular Mode, the reason for no tests executing might be a very narrow tests list. Most likely, you run only tests with a specified tag, and there were fewer test files with the tag than parallel CI nodes.")
       end
 
       create_build_subset(test_files)
@@ -16,6 +16,7 @@ module KnapsackPro
 
       subset_queue_id = KnapsackPro::Config::Env.subset_queue_id
 
+      KnapsackPro::Config::TempFiles.ensure_temp_directory_exists!
       FileUtils.mkdir_p(queue_path)
 
       subset_queue_file_name = "#{subset_queue_id}.json"
@@ -36,8 +37,7 @@ module KnapsackPro
 
       if test_files.empty?
         KnapsackPro.logger.warn("No test files were executed on this CI node.")
-        KnapsackPro.logger.debug("When you use knapsack_pro queue mode then probably reason might be that CI node was started after the test files from the queue were already executed by other CI nodes. That is why this CI node has no test files to execute.")
-        KnapsackPro.logger.debug("Another reason might be when your CI node failed in a way that prevented knapsack_pro to save time execution data to Knapsack Pro API and you have just tried to retry failed CI node but instead you got no test files to execute. In that case knapsack_pro don't know what tests should be executed here.")
+        KnapsackPro.logger.debug("This CI node likely started work late after the test files were already executed by other CI nodes consuming the queue.")
       end
 
       measured_test_files = test_files
@@ -46,9 +46,9 @@ module KnapsackPro
 
       if test_files.size > 0 && measured_test_files.size == 0
         KnapsackPro.logger.warn("#{test_files.size} test files were executed on this CI node but the recorded time was lost due to:")
-        KnapsackPro.logger.warn("1. Probably you have a code (i.e. RSpec hooks) that clears tmp directory in your project. Please ensure you do not remove the content of tmp/knapsack_pro/queue/ directory between tests run.")
-        KnapsackPro.logger.warn("2. Another reason might be that you forgot to add Knapsack::Adapters::RSpecAdapter.bind in your rails_helper.rb or spec_helper.rb. Please follow the installation guide again: https://docs.knapsackpro.com/integration/")
-        KnapsackPro.logger.warn("3. All your tests are empty test files, are pending tests or have syntax error and could not be executed hence no measured time execution by knapsack_pro.")
+        KnapsackPro.logger.warn("1. Please ensure you do not remove the contents of the .knapsack_pro directory between tests run.")
+        KnapsackPro.logger.warn("2. Ensure you've added Knapsack::Adapters::RSpecAdapter.bind in your rails_helper.rb or spec_helper.rb. Please follow the installation guide again: https://docs.knapsackpro.com/integration/")
+        KnapsackPro.logger.warn("3. Another potential reason for this warning is that all your tests are empty test files, pending tests, or they have syntax errors, and the time execution was not recorded for them.")
       end
 
       create_build_subset(test_files)
@@ -79,8 +79,7 @@ module KnapsackPro
     private
 
     def self.queue_path
-      queue_id = KnapsackPro::Config::Env.queue_id
-      "#{KnapsackPro::Config::Env::TMP_DIR}/queue/#{queue_id}"
+      "#{KnapsackPro::Config::TempFiles::TEMP_DIRECTORY_PATH}/queue/#{KnapsackPro::Config::Env.queue_id}"
     end
   end
 end

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

@@ -110,9 +110,9 @@ module KnapsackPro
         def self.log_rspec_command(cli_args, test_file_paths, type)
           case type
           when :subset_queue
-            KnapsackPro.logger.info("To retry in development the subset of tests fetched from API queue please run below command on your machine. If you use --order random then remember to add proper --seed 123 that you will find at the end of rspec command.")
+            KnapsackPro.logger.info("To retry the last batch of tests fetched from the API Queue, please run the following command on your machine. (If you use the `-- order random` option, remember to add correct `--seed 123` that you can find at the end of the RSpec output.)")
           when :end_of_queue
-            KnapsackPro.logger.info("To retry in development the tests for this CI node please run below command on your machine. It will run all tests in a single run. If you need to reproduce a particular subset of tests fetched from API queue then above after each request to Knapsack Pro API you will find example rspec command.")
+            KnapsackPro.logger.info("To retry all the tests assigned to this CI node, please run the following command on your machine:")
           end
 
           stringify_cli_args = cli_args.join(' ')

data/lib/knapsack_pro/slow_test_file_determiner.rb

@@ -1,7 +1,6 @@
 module KnapsackPro
   class SlowTestFileDeterminer
     TIME_THRESHOLD_PER_CI_NODE = 0.7 # 70%
-    REPORT_DIR = "#{KnapsackPro::Config::Env::TMP_DIR}/slow_test_file_determiner"
 
     # test_files: { 'path' => 'a_spec.rb', 'time_execution' => 0.0 }
     # time_execution: of build distribution (total time of CI build run)
@@ -9,17 +8,19 @@ module KnapsackPro
       time_threshold = (time_execution / KnapsackPro::Config::Env.ci_node_total) * TIME_THRESHOLD_PER_CI_NODE
 
       test_files.select do |test_file|
-        test_file.fetch('time_execution') >= time_threshold
+        time_execution = test_file.fetch('time_execution')
+        time_execution >= time_threshold && time_execution > 0
       end
     end
 
     def self.save_to_json_report(test_files)
-      FileUtils.mkdir_p(REPORT_DIR)
+      KnapsackPro::Config::TempFiles.ensure_temp_directory_exists!
+      FileUtils.mkdir_p(report_dir)
       File.write(report_path, test_files.to_json)
     end
 
     def self.read_from_json_report
-      raise 'Report with slow test files was not generated yet. If you have enabled split by test cases https://github.com/KnapsackPro/knapsack_pro-ruby#split-test-files-by-test-cases and you see this error it means that your tests accidentally cleaned up tmp/knapsack_pro directory. Please do not remove this directory during tests runtime!' unless File.exists?(report_path)
+      raise 'The report with slow test files has not been generated yet. If you have enabled split by test cases https://github.com/KnapsackPro/knapsack_pro-ruby#split-test-files-by-test-cases and you see this error it means that your tests accidentally cleaned up the .knapsack_pro directory. Please do not remove this directory during tests runtime!' unless File.exist?(report_path)
       slow_test_files_json_report = File.read(report_path)
       JSON.parse(slow_test_files_json_report)
     end
@@ -27,7 +28,11 @@ module KnapsackPro
     private
 
     def self.report_path
-      "#{REPORT_DIR}/slow_test_files_node_#{KnapsackPro::Config::Env.ci_node_index}.json"
+      "#{report_dir}/slow_test_files_node_#{KnapsackPro::Config::Env.ci_node_index}.json"
+    end
+
+    def self.report_dir
+      "#{KnapsackPro::Config::TempFiles::TEMP_DIRECTORY_PATH}/slow_test_file_determiner"
     end
   end
 end

data/lib/knapsack_pro/test_case_detectors/rspec_test_example_detector.rb

@@ -1,8 +1,6 @@
 module KnapsackPro
   module TestCaseDetectors
     class RSpecTestExampleDetector
-      REPORT_DIR = "#{KnapsackPro::Config::Env::TMP_DIR}/test_case_detectors/rspec"
-
       def generate_json_report
         require 'rspec/core'
 
@@ -47,7 +45,7 @@ module KnapsackPro
       end
 
       def test_file_example_paths
-        raise "No report found at #{report_path}" unless File.exists?(report_path)
+        raise "No report found at #{report_path}" unless File.exist?(report_path)
 
         json_report = File.read(report_path)
         hash_report = JSON.parse(json_report)
@@ -69,8 +67,12 @@ module KnapsackPro
 
       private
 
+      def report_dir
+        "#{KnapsackPro::Config::TempFiles::TEMP_DIRECTORY_PATH}/test_case_detectors/rspec"
+      end
+
       def report_path
-        "#{REPORT_DIR}/rspec_dry_run_json_report_node_#{KnapsackPro::Config::Env.ci_node_index}.json"
+        "#{report_dir}/rspec_dry_run_json_report_node_#{KnapsackPro::Config::Env.ci_node_index}.json"
       end
 
       def adapter_class
@@ -86,11 +88,12 @@ module KnapsackPro
       end
 
       def ensure_report_dir_exists
-        FileUtils.mkdir_p(REPORT_DIR)
+        KnapsackPro::Config::TempFiles.ensure_temp_directory_exists!
+        FileUtils.mkdir_p(report_dir)
       end
 
       def remove_old_json_report
-        File.delete(report_path) if File.exists?(report_path)
+        File.delete(report_path) if File.exist?(report_path)
       end
 
       def test_file_hash_for(test_file_path)

data/lib/knapsack_pro/tracker.rb

@@ -11,6 +11,7 @@ module KnapsackPro
 
     def initialize
       @global_time_since_beginning = 0
+      KnapsackPro::Config::TempFiles.ensure_temp_directory_exists!
       FileUtils.mkdir_p(tracker_dir_path)
       set_defaults
     end
@@ -21,7 +22,7 @@ module KnapsackPro
       # Remove report only when the reset! method is called explicitly.
       # The report should be persisted on the disk so that multiple tracker instances can share the report state.
       # Tracker instance can be created by knapsack_pro process and a separate tracker is created by rake task (e.g., RSpec) in Regular Mode.
-      File.delete(prerun_tests_report_path) if File.exists?(prerun_tests_report_path)
+      File.delete(prerun_tests_report_path) if File.exist?(prerun_tests_report_path)
     end
 
     def start_timer
@@ -92,7 +93,7 @@ module KnapsackPro
     end
 
     def tracker_dir_path
-      "#{KnapsackPro::Config::Env::TMP_DIR}/tracker"
+      "#{KnapsackPro::Config::TempFiles::TEMP_DIRECTORY_PATH}/tracker"
     end
 
     def prerun_tests_report_path
@@ -110,6 +111,7 @@ module KnapsackPro
     end
 
     def read_prerun_tests_report
+      raise "Report #{prerun_tests_report_path} doest not exist on the disk. Most likely, it was removed accidentally. Please report the bug to the Knapsack Pro support team at https://knapsackpro.com/contact" unless File.exist?(prerun_tests_report_path)
       JSON.parse(File.read(prerun_tests_report_path))
     end
 

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '2.18.2'
+  VERSION = '3.1.2'
 end

data/lib/knapsack_pro.rb

@@ -27,6 +27,7 @@ require_relative 'knapsack_pro/config/ci/github_actions'
 require_relative 'knapsack_pro/config/ci/heroku'
 require_relative 'knapsack_pro/config/env'
 require_relative 'knapsack_pro/config/env_generator'
+require_relative 'knapsack_pro/config/temp_files'
 require_relative 'knapsack_pro/logger_wrapper'
 require_relative 'knapsack_pro/client/api/action'
 require_relative 'knapsack_pro/client/api/v1/base'

data/spec/knapsack_pro/adapters/base_adapter_spec.rb

@@ -32,14 +32,13 @@ describe KnapsackPro::Adapters::BaseAdapter do
     context 'when CI node index 0' do
       let(:ci_node_index) { 0 }
 
-      it { expect(subject).to eq 'tmp/knapsack_pro/KnapsackPro-Adapters-BaseAdapter-bind_method_called_for_node_0.txt' }
-
+      it { expect(subject).to eq '.knapsack_pro/KnapsackPro-Adapters-BaseAdapter-bind_method_called_for_node_0.txt' }
     end
 
     context 'when CI node index 1' do
       let(:ci_node_index) { 1 }
 
-      it { expect(subject).to eq 'tmp/knapsack_pro/KnapsackPro-Adapters-BaseAdapter-bind_method_called_for_node_1.txt' }
+      it { expect(subject).to eq '.knapsack_pro/KnapsackPro-Adapters-BaseAdapter-bind_method_called_for_node_1.txt' }
     end
   end
 
@@ -93,18 +92,20 @@ describe KnapsackPro::Adapters::BaseAdapter do
   end
 
   describe '.verify_bind_method_called' do
+    let(:temp_directory_path) { '.knapsack_pro' }
+
     subject { described_class.verify_bind_method_called }
 
     before do
       expect(::Kernel).to receive(:at_exit).and_yield
-      expect(File).to receive(:exists?).with('tmp/knapsack_pro/KnapsackPro-Adapters-BaseAdapter-bind_method_called_for_node_0.txt').and_return(adapter_bind_method_called_file_exists)
+      expect(File).to receive(:exist?).with('.knapsack_pro/KnapsackPro-Adapters-BaseAdapter-bind_method_called_for_node_0.txt').and_return(adapter_bind_method_called_file_exists)
     end
 
     context 'when adapter bind method called' do
       let(:adapter_bind_method_called_file_exists) { true }
 
       it do
-        expect(File).to receive(:delete).with('tmp/knapsack_pro/KnapsackPro-Adapters-BaseAdapter-bind_method_called_for_node_0.txt')
+        expect(File).to receive(:delete).with('.knapsack_pro/KnapsackPro-Adapters-BaseAdapter-bind_method_called_for_node_0.txt')
         subject
       end
     end
@@ -120,12 +121,13 @@ describe KnapsackPro::Adapters::BaseAdapter do
   end
 
   describe '#bind' do
+    let(:temp_directory_path) { '.knapsack_pro' }
     let(:recording_enabled?) { false }
     let(:queue_recording_enabled?) { false }
 
     before do
-      expect(FileUtils).to receive(:mkdir_p).with('tmp/knapsack_pro')
-      expect(File).to receive(:write).with('tmp/knapsack_pro/KnapsackPro-Adapters-BaseAdapter-bind_method_called_for_node_0.txt', nil)
+      expect(KnapsackPro::Config::TempFiles).to receive(:ensure_temp_directory_exists!)
+      expect(File).to receive(:write).with('.knapsack_pro/KnapsackPro-Adapters-BaseAdapter-bind_method_called_for_node_0.txt', nil)
 
       expect(KnapsackPro::Config::Env).to receive(:recording_enabled?).and_return(recording_enabled?)
       expect(KnapsackPro::Config::Env).to receive(:queue_recording_enabled?).and_return(queue_recording_enabled?)

data/spec/knapsack_pro/adapters/rspec_adapter_spec.rb

@@ -111,7 +111,7 @@ describe KnapsackPro::Adapters::RSpecAdapter do
   end
 
   describe '.test_path' do
-    let(:current_example_metadata) do
+    let(:example_group) do
       {
         file_path: '1_shared_example.rb',
         parent_example_group: {
@@ -122,14 +122,19 @@ describe KnapsackPro::Adapters::RSpecAdapter do
         }
       }
     end
+    let(:current_example) do
+      OpenStruct.new(metadata: {
+        example_group: example_group
+      })
+    end
 
-    subject { described_class.test_path(current_example_metadata) }
+    subject { described_class.test_path(current_example) }
 
     it { should eql 'a_spec.rb' }
 
     context 'with turnip features' do
       describe 'when the turnip version is less than 2' do
-        let(:current_example_metadata) do
+        let(:example_group) do
           {
             file_path: "./spec/features/logging_in.feature",
             turnip: true,
@@ -145,7 +150,7 @@ describe KnapsackPro::Adapters::RSpecAdapter do
       end
 
       describe 'when turnip is version 2 or greater' do
-        let(:current_example_metadata) do
+        let(:example_group) do
           {
             file_path: "gems/turnip-2.0.0/lib/turnip/rspec.rb",
             turnip: true,
@@ -170,13 +175,7 @@ describe KnapsackPro::Adapters::RSpecAdapter do
       let(:logger) { instance_double(Logger) }
       let(:global_time) { 'Global time: 01m 05s' }
       let(:test_path) { 'spec/a_spec.rb' }
-      let(:example) { double }
-      let(:example_group) { double }
-      let(:current_example) do
-        OpenStruct.new(metadata: {
-          example_group: example_group
-        })
-      end
+      let(:current_example) { double }
 
       context 'when rspec split by test examples is disabled' do
         before do
@@ -189,19 +188,18 @@ describe KnapsackPro::Adapters::RSpecAdapter do
           allow(KnapsackPro).to receive(:tracker).and_return(tracker)
           expect(tracker).to receive(:start_timer).ordered
 
-          expect(config).to receive(:around).with(:each).and_yield(example)
+          expect(config).to receive(:around).with(:each).and_yield(current_example)
           expect(config).to receive(:append_after).with(:context).and_yield
           expect(config).to receive(:after).with(:suite).and_yield
           expect(::RSpec).to receive(:configure).and_yield(config)
 
           expect(tracker).to receive(:stop_timer).ordered
 
-          expect(::RSpec).to receive(:current_example).twice.and_return(current_example)
-          expect(described_class).to receive(:test_path).with(example_group).and_return(test_path)
+          expect(described_class).to receive(:test_path).with(current_example).and_return(test_path)
 
           expect(tracker).to receive(:current_test_path=).with(test_path).ordered
 
-          expect(example).to receive(:run)
+          expect(current_example).to receive(:run)
 
           expect(tracker).to receive(:stop_timer).ordered
 
@@ -226,26 +224,25 @@ describe KnapsackPro::Adapters::RSpecAdapter do
           end
 
           it 'records time for example.id' do
-            expect(example).to receive(:id).and_return(test_example_path)
+            expect(current_example).to receive(:id).and_return(test_example_path)
 
             expect(config).to receive(:prepend_before).with(:context).and_yield
 
             allow(KnapsackPro).to receive(:tracker).and_return(tracker)
             expect(tracker).to receive(:start_timer).ordered
 
-            expect(config).to receive(:around).with(:each).and_yield(example)
+            expect(config).to receive(:around).with(:each).and_yield(current_example)
             expect(config).to receive(:append_after).with(:context).and_yield
             expect(config).to receive(:after).with(:suite).and_yield
             expect(::RSpec).to receive(:configure).and_yield(config)
 
             expect(tracker).to receive(:stop_timer).ordered
 
-            expect(::RSpec).to receive(:current_example).twice.and_return(current_example)
-            expect(described_class).to receive(:test_path).with(example_group).and_return(test_path)
+            expect(described_class).to receive(:test_path).with(current_example).and_return(test_path)
 
             expect(tracker).to receive(:current_test_path=).with(test_example_path).ordered
 
-            expect(example).to receive(:run)
+            expect(current_example).to receive(:run)
 
             expect(tracker).to receive(:stop_timer).ordered
 
@@ -268,19 +265,18 @@ describe KnapsackPro::Adapters::RSpecAdapter do
             allow(KnapsackPro).to receive(:tracker).and_return(tracker)
             expect(tracker).to receive(:start_timer).ordered
 
-            expect(config).to receive(:around).with(:each).and_yield(example)
+            expect(config).to receive(:around).with(:each).and_yield(current_example)
             expect(config).to receive(:append_after).with(:context).and_yield
             expect(config).to receive(:after).with(:suite).and_yield
             expect(::RSpec).to receive(:configure).and_yield(config)
 
-            expect(::RSpec).to receive(:current_example).twice.and_return(current_example)
-            expect(described_class).to receive(:test_path).with(example_group).and_return(test_path)
+            expect(described_class).to receive(:test_path).with(current_example).and_return(test_path)
 
             expect(tracker).to receive(:stop_timer).ordered
 
             expect(tracker).to receive(:current_test_path=).with(test_path).ordered
 
-            expect(example).to receive(:run)
+            expect(current_example).to receive(:run)
 
             expect(tracker).to receive(:stop_timer).ordered
 

data/spec/knapsack_pro/config/temp_files_spec.rb

@@ -0,0 +1,25 @@
+describe KnapsackPro::Config::TempFiles do
+  describe 'TEMP_DIRECTORY_PATH' do
+    subject { described_class::TEMP_DIRECTORY_PATH }
+
+    it 'returns temporary directory path' do
+      expect(subject).to eq '.knapsack_pro'
+    end
+  end
+
+  describe '.ensure_temp_directory_exists!', :clear_tmp do
+    let(:gitignore_file_path) { '.knapsack_pro/.gitignore' }
+
+    subject { described_class.ensure_temp_directory_exists! }
+
+    it 'creates .gitignore file' do
+      expect { subject }.to change { File.exist?(gitignore_file_path) }.from(false).to(true)
+    end
+
+    it '.gitignore file has correct content to ignore all files in temporary directory' do
+      subject
+
+      expect(File.read(gitignore_file_path)).to match /^\*$/
+    end
+  end
+end

data/spec/knapsack_pro/report_spec.rb

@@ -25,6 +25,8 @@ describe KnapsackPro::Report do
       subset_queue_id = 'fake-subset-queue-id'
       expect(KnapsackPro::Config::Env).to receive(:subset_queue_id).and_return(subset_queue_id)
 
+      expect(KnapsackPro::Config::TempFiles).to receive(:ensure_temp_directory_exists!)
+
       queue_id = 'fake-queue-id'
       expect(KnapsackPro::Config::Env).to receive(:queue_id).twice.and_return(queue_id)
     end
@@ -34,7 +36,7 @@ describe KnapsackPro::Report do
 
       expect(
         JSON.parse(
-          File.read('tmp/knapsack_pro/queue/fake-queue-id/fake-subset-queue-id.json')
+          File.read('.knapsack_pro/queue/fake-queue-id/fake-subset-queue-id.json')
         )
       ).to eq([
         { 'path' => fake_path }
@@ -56,7 +58,7 @@ describe KnapsackPro::Report do
         queue_id = 'fake-queue-id'
         expect(KnapsackPro::Config::Env).to receive(:queue_id).and_return(queue_id)
 
-        expect(Dir).to receive(:glob).with('tmp/knapsack_pro/queue/fake-queue-id/*.json').and_return([
+        expect(Dir).to receive(:glob).with('.knapsack_pro/queue/fake-queue-id/*.json').and_return([
           json_test_file_a_path,
           json_test_file_b_path
         ])
@@ -89,7 +91,7 @@ describe KnapsackPro::Report do
         queue_id = 'fake-queue-id'
         expect(KnapsackPro::Config::Env).to receive(:queue_id).and_return(queue_id)
 
-        expect(Dir).to receive(:glob).with('tmp/knapsack_pro/queue/fake-queue-id/*.json').and_return([
+        expect(Dir).to receive(:glob).with('.knapsack_pro/queue/fake-queue-id/*.json').and_return([
           json_test_file_a_path,
           json_test_file_b_path
         ])
@@ -102,9 +104,9 @@ describe KnapsackPro::Report do
         logger = instance_double(Logger)
         expect(KnapsackPro).to receive(:logger).exactly(4).and_return(logger)
         expect(logger).to receive(:warn).with('2 test files were executed on this CI node but the recorded time was lost due to:')
-        expect(logger).to receive(:warn).with('1. Probably you have a code (i.e. RSpec hooks) that clears tmp directory in your project. Please ensure you do not remove the content of tmp/knapsack_pro/queue/ directory between tests run.')
-        expect(logger).to receive(:warn).with('2. Another reason might be that you forgot to add Knapsack::Adapters::RSpecAdapter.bind in your rails_helper.rb or spec_helper.rb. Please follow the installation guide again: https://docs.knapsackpro.com/integration/')
-        expect(logger).to receive(:warn).with('3. All your tests are empty test files, are pending tests or have syntax error and could not be executed hence no measured time execution by knapsack_pro.')
+        expect(logger).to receive(:warn).with('1. Please ensure you do not remove the contents of the .knapsack_pro directory between tests run.')
+        expect(logger).to receive(:warn).with("2. Ensure you've added Knapsack::Adapters::RSpecAdapter.bind in your rails_helper.rb or spec_helper.rb. Please follow the installation guide again: https://docs.knapsackpro.com/integration/")
+        expect(logger).to receive(:warn).with('3. Another potential reason for this warning is that all your tests are empty test files, pending tests, or they have syntax errors, and the time execution was not recorded for them.')
 
         expect(described_class).to receive(:create_build_subset).with(
           json_test_file_a + json_test_file_b
@@ -121,15 +123,14 @@ describe KnapsackPro::Report do
         queue_id = 'fake-queue-id'
         expect(KnapsackPro::Config::Env).to receive(:queue_id).and_return(queue_id)
 
-        expect(Dir).to receive(:glob).with('tmp/knapsack_pro/queue/fake-queue-id/*.json').and_return([])
+        expect(Dir).to receive(:glob).with('.knapsack_pro/queue/fake-queue-id/*.json').and_return([])
       end
 
       it 'logs warning about reasons why no test files were executed on this CI node' do
         logger = instance_double(Logger)
-        expect(KnapsackPro).to receive(:logger).exactly(3).and_return(logger)
+        expect(KnapsackPro).to receive(:logger).exactly(2).and_return(logger)
         expect(logger).to receive(:warn).with('No test files were executed on this CI node.')
-        expect(logger).to receive(:debug).with('When you use knapsack_pro queue mode then probably reason might be that CI node was started after the test files from the queue were already executed by other CI nodes. That is why this CI node has no test files to execute.')
-        expect(logger).to receive(:debug).with("Another reason might be when your CI node failed in a way that prevented knapsack_pro to save time execution data to Knapsack Pro API and you have just tried to retry failed CI node but instead you got no test files to execute. In that case knapsack_pro don't know what tests should be executed here.")
+        expect(logger).to receive(:debug).with('This CI node likely started work late after the test files were already executed by other CI nodes consuming the queue.')
 
         expect(described_class).to receive(:create_build_subset).with([])
 

data/spec/knapsack_pro/runners/minitest_runner_spec.rb

@@ -14,12 +14,17 @@ describe KnapsackPro::Runners::MinitestRunner do
     end
 
     context 'when test files were returned by Knapsack Pro API' do
+      let(:test_file_paths) { ['test_fake/a_test.rb', 'test_fake/b_test.rb'] }
+
       before do
         expect(KnapsackPro::Adapters::MinitestAdapter).to receive(:verify_bind_method_called)
+
+        tracker = instance_double(KnapsackPro::Tracker)
+        expect(KnapsackPro).to receive(:tracker).and_return(tracker)
+        expect(tracker).to receive(:set_prerun_tests).with(test_file_paths)
       end
 
       it 'runs tests' do
-        test_file_paths = ['test_fake/a_test.rb', 'test_fake/b_test.rb']
         runner = instance_double(described_class,
                                  test_dir: 'test',
                                  test_file_paths: test_file_paths,

data/spec/knapsack_pro/runners/test_unit_runner_spec.rb

@@ -13,10 +13,15 @@ describe KnapsackPro::Runners::TestUnitRunner do
     end
 
     context 'when test files were returned by Knapsack Pro API' do
+      let(:test_file_paths) { ['test-unit_fake/a_test.rb', 'test-unit_fake/b_test.rb'] }
+
       it 'runs tests' do
         expect(KnapsackPro::Adapters::TestUnitAdapter).to receive(:verify_bind_method_called)
 
-        test_file_paths = ['test-unit_fake/a_test.rb', 'test-unit_fake/b_test.rb']
+        tracker = instance_double(KnapsackPro::Tracker)
+        expect(KnapsackPro).to receive(:tracker).and_return(tracker)
+        expect(tracker).to receive(:set_prerun_tests).with(test_file_paths)
+
         runner = instance_double(described_class,
                                  test_dir: 'test-unit_fake',
                                  test_file_paths: test_file_paths,

data/spec/knapsack_pro/slow_test_file_determiner_spec.rb

@@ -1,16 +1,6 @@
 describe KnapsackPro::SlowTestFileDeterminer do
   describe '.call' do
     let(:node_total) { 4 }
-    let(:time_execution) { 20.0 }
-    let(:test_files) do
-      [
-        { 'path' => 'a_spec.rb', 'time_execution' => 1.0 },
-        { 'path' => 'b_spec.rb', 'time_execution' => 3.4 },
-        # slow tests are above 3.5s threshold (20.0 / 4 * 0.7 = 3.5)
-        { 'path' => 'c_spec.rb', 'time_execution' => 3.5 },
-        { 'path' => 'd_spec.rb', 'time_execution' => 5.9 },
-      ]
-    end
 
     before do
       expect(KnapsackPro::Config::Env).to receive(:ci_node_total).and_return(node_total)
@@ -18,16 +8,43 @@ describe KnapsackPro::SlowTestFileDeterminer do
 
     subject { described_class.call(test_files, time_execution) }
 
-    it do
-      expect(subject).to eq([
-        { 'path' => 'c_spec.rb', 'time_execution' => 3.5 },
-        { 'path' => 'd_spec.rb', 'time_execution' => 5.9 },
-      ])
+    context 'when test files have recorded time execution' do
+      let(:time_execution) { 20.0 }
+      let(:test_files) do
+        [
+          { 'path' => 'a_spec.rb', 'time_execution' => 1.0 },
+          { 'path' => 'b_spec.rb', 'time_execution' => 3.4 },
+          # slow tests are above 3.5s threshold (20.0 / 4 * 0.7 = 3.5)
+          { 'path' => 'c_spec.rb', 'time_execution' => 3.5 },
+          { 'path' => 'd_spec.rb', 'time_execution' => 5.9 },
+        ]
+      end
+
+      it do
+        expect(subject).to eq([
+          { 'path' => 'c_spec.rb', 'time_execution' => 3.5 },
+          { 'path' => 'd_spec.rb', 'time_execution' => 5.9 },
+        ])
+      end
+    end
+
+    context 'when test files have no recorded time execution' do
+      let(:time_execution) { 0.0 }
+      let(:test_files) do
+        [
+          { 'path' => 'a_spec.rb', 'time_execution' => 0.0 },
+          { 'path' => 'b_spec.rb', 'time_execution' => 0.0 },
+        ]
+      end
+
+      it do
+        expect(subject).to eq([])
+      end
     end
   end
 
   describe '.save_to_json_report', :clear_tmp do
-    let(:json_report_path) { 'tmp/knapsack_pro/slow_test_file_determiner/slow_test_files_node_0.json' }
+    let(:json_report_path) { '.knapsack_pro/slow_test_file_determiner/slow_test_files_node_0.json' }
     let(:test_files) do
       [
         { 'path' => 'a_spec.rb', 'time_execution' => 1.0 },
@@ -67,7 +84,7 @@ describe KnapsackPro::SlowTestFileDeterminer do
 
     context 'when json report does not exist' do
       it do
-        expect { subject }.to raise_error(RuntimeError, 'Report with slow test files was not generated yet. If you have enabled split by test cases https://github.com/KnapsackPro/knapsack_pro-ruby#split-test-files-by-test-cases and you see this error it means that your tests accidentally cleaned up tmp/knapsack_pro directory. Please do not remove this directory during tests runtime!')
+        expect { subject }.to raise_error(RuntimeError, 'The report with slow test files has not been generated yet. If you have enabled split by test cases https://github.com/KnapsackPro/knapsack_pro-ruby#split-test-files-by-test-cases and you see this error it means that your tests accidentally cleaned up the .knapsack_pro directory. Please do not remove this directory during tests runtime!')
       end
     end
   end

data/spec/knapsack_pro/test_case_detectors/rspec_test_example_detector_spec.rb

@@ -1,15 +1,17 @@
 describe KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector do
-  let(:report_dir) { 'tmp/knapsack_pro/test_case_detectors/rspec' }
-  let(:report_path) { 'tmp/knapsack_pro/test_case_detectors/rspec/rspec_dry_run_json_report_node_0.json' }
+  let(:report_dir) { '.knapsack_pro/test_case_detectors/rspec' }
+  let(:report_path) { '.knapsack_pro/test_case_detectors/rspec/rspec_dry_run_json_report_node_0.json' }
   let(:rspec_test_example_detector) { described_class.new }
 
   describe '#generate_json_report' do
     subject { rspec_test_example_detector.generate_json_report }
 
     before do
+      expect(KnapsackPro::Config::TempFiles).to receive(:ensure_temp_directory_exists!)
+
       expect(FileUtils).to receive(:mkdir_p).with(report_dir)
 
-      expect(File).to receive(:exists?).with(report_path).and_return(true)
+      expect(File).to receive(:exist?).with(report_path).and_return(true)
       expect(File).to receive(:delete).with(report_path)
 
       expect(rspec_test_example_detector).to receive(:slow_test_files).and_return(test_file_entities)
@@ -95,7 +97,7 @@ describe KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector do
 
     context 'when JSON report exists' do
       it do
-        expect(File).to receive(:exists?).with(report_path).and_return(true)
+        expect(File).to receive(:exist?).with(report_path).and_return(true)
 
         json_file = {
           'examples' => [
@@ -114,9 +116,9 @@ describe KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector do
 
     context 'when JSON report does not exist' do
       it do
-        expect(File).to receive(:exists?).with(report_path).and_return(false)
+        expect(File).to receive(:exist?).with(report_path).and_return(false)
 
-        expect { subject }.to raise_error(RuntimeError, 'No report found at tmp/knapsack_pro/test_case_detectors/rspec/rspec_dry_run_json_report_node_0.json')
+        expect { subject }.to raise_error(RuntimeError, "No report found at .knapsack_pro/test_case_detectors/rspec/rspec_dry_run_json_report_node_0.json")
       end
     end
   end

data/spec/spec_helper.rb

@@ -16,6 +16,8 @@ require 'knapsack_pro'
 
 Dir["#{KnapsackPro.root}/spec/{support,fixtures}/**/*.rb"].each { |f| require f }
 
+KNAPSACK_PRO_TMP_DIR = File.join(KnapsackPro.root, '.knapsack_pro')
+
 RSpec.configure do |config|
   config.order = :random
   config.mock_with :rspec do |mocks|
@@ -29,13 +31,14 @@ RSpec.configure do |config|
 
   config.before(:each) do
     if RSpec.current_example.metadata[:clear_tmp]
-      FileUtils.mkdir_p(File.join(KnapsackPro.root, 'tmp'))
+      FileUtils.rm_r(KNAPSACK_PRO_TMP_DIR) if File.exist?(KNAPSACK_PRO_TMP_DIR)
+      FileUtils.mkdir_p(KNAPSACK_PRO_TMP_DIR)
     end
   end
 
   config.after(:each) do
     if RSpec.current_example.metadata[:clear_tmp]
-      FileUtils.rm_r(File.join(KnapsackPro.root, 'tmp'))
+      FileUtils.rm_r(KNAPSACK_PRO_TMP_DIR) if File.exist?(KNAPSACK_PRO_TMP_DIR)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 2.18.2
+  version: 3.1.2
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-29 00:00:00.000000000 Z
+date: 2021-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -45,9 +45,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -55,9 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.10.0
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -239,6 +233,7 @@ files:
 - lib/knapsack_pro/config/ci/travis.rb
 - lib/knapsack_pro/config/env.rb
 - lib/knapsack_pro/config/env_generator.rb
+- lib/knapsack_pro/config/temp_files.rb
 - lib/knapsack_pro/crypto/branch_encryptor.rb
 - lib/knapsack_pro/crypto/decryptor.rb
 - lib/knapsack_pro/crypto/digestor.rb
@@ -334,6 +329,7 @@ files:
 - spec/knapsack_pro/config/ci/travis_spec.rb
 - spec/knapsack_pro/config/env_generator_spec.rb
 - spec/knapsack_pro/config/env_spec.rb
+- spec/knapsack_pro/config/temp_files_spec.rb
 - spec/knapsack_pro/crypto/branch_encryptor_spec.rb
 - spec/knapsack_pro/crypto/decryptor_spec.rb
 - spec/knapsack_pro/crypto/digestor_spec.rb
@@ -409,7 +405,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Knapsack Pro splits tests across parallel CI nodes and ensures each parallel
@@ -455,6 +451,7 @@ test_files:
 - spec/knapsack_pro/config/ci/travis_spec.rb
 - spec/knapsack_pro/config/env_generator_spec.rb
 - spec/knapsack_pro/config/env_spec.rb
+- spec/knapsack_pro/config/temp_files_spec.rb
 - spec/knapsack_pro/crypto/branch_encryptor_spec.rb
 - spec/knapsack_pro/crypto/decryptor_spec.rb
 - spec/knapsack_pro/crypto/digestor_spec.rb