knapsack_pro 1.22.0 → 1.22.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c1620234d6399fb4f66840cc101d290f70e9b8c6bbb6c7f2df7b2f2fa16062a
-  data.tar.gz: f0d3b9c93244b37baa1817bb2b910d1e4e1f3a84e13482f90755a528a04c8a5a
+  metadata.gz: 1ff5e0f88a008abb13c1ca010f4b430be290ecf4e349719cac39611eebc575a4
+  data.tar.gz: 83650913e5d6cd21201ebce5ae48c731d61a0bc27bb37f566fcdc3d96a9b0598
 SHA512:
-  metadata.gz: 5bfe8f48e23514d4dc3c9dd957fbaa5d14d39fae4b9c6eb5c9426eeaae9a57007fb379d6a00860ea30b4cb9766444678e55bf306bba742cf80d470387e22c9a7
-  data.tar.gz: 171de7e1e9c7dbf18b291ffd0f183459e0b9a41b0c60ff2c15de4867db6c07caefcae8e3d57718a001e04c49320878cc022656cfc82709b948e48770dafb2b5c
+  metadata.gz: 3b3d2dc24c6592040f559f77f59168502bb949b135406a06f59c836494902412e202a28bc781760e0862f416ccaa2d2c9a246269fee87e9fd3d9120ba803f4ab
+  data.tar.gz: 9d4005922f963d765b494ab2b35642fa3be85787a6deb8b490ed3e1f64e5055d474d4cdae5b1bba4d4668b4c63fd59d9063102baf7036830e53d409ba8cf016a

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+### 1.22.1
+
+* Fix for an auto split of slow RSpec test files by test examples when using `KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES=true` and `parallel_tests` gem. Save the JSON reports with unique file names with the CI node index in the name to avoid accidentally overriding the files on the same disk.
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/113
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v1.22.0...v1.22.1
+
 ### 1.22.0
 
 * Increase request retry timebox from 4s to 8s to not flood Knapsack Pro API with too many requests in a short period of time and to give time for API server to autoscale and add additional machines to serve traffic

data/README.md

@@ -711,7 +711,7 @@ Read below required configuration step if you use Queue Mode and you set [`KNAPS
 
   If you use other CI server you need to manually configure your CI server to set `KNAPSACK_PRO_CI_NODE_RETRY_COUNT=1` only during retry CI node attempt. If `KNAPSACK_PRO_CI_NODE_RETRY_COUNT > 0` then knapsack_pro won't allow starting running tests in Fallback Mode and instead will raise error so a user can manually retry CI node later when a connection to Knapsack Pro API can be established.
 
-  If you cannot set `KNAPSACK_PRO_CI_NODE_RETRY_COUNT` only for retried CI node or it is not possible for your CI server then you can disable Fallback Mode completely `KNAPSACK_PRO_FALLBACK_MODE_ENABLED=false`.
+  If you cannot set `KNAPSACK_PRO_CI_NODE_RETRY_COUNT` only for retried CI node or it is not possible for your CI server then you can disable Fallback Mode completely `KNAPSACK_PRO_FALLBACK_MODE_ENABLED=false`. When Fallback Mode is disabled then knapsack_pro gem will try to connect to Knapsack Pro API 6 times instead of only 3 times to ensure there is a low chance of failing your CI node due to lost connection with the API.
 
 ### Passing arguments to rake task
 
@@ -991,19 +991,28 @@ You can parallelize your builds across virtual machines with [travis matrix feat
 
 ```yaml
 script:
-  # Step for RSpec
+  # Step for RSpec in Regular Mode
   - "bundle exec rake knapsack_pro:rspec"
 
-  # Step for Cucumber
+  # Step for RSpec in Queue Mode
+  - "bundle exec rake knapsack_pro:queue:rspec"
+
+  # Step for Cucumber in Regular Mode
   - "bundle exec rake knapsack_pro:cucumber"
 
-  # Step for Minitest
+  # Step for Cucumber in Queue Mode
+  - "bundle exec rake knapsack_pro:queue:cucumber"
+
+  # Step for Minitest in Regular Mode
   - "bundle exec rake knapsack_pro:minitest"
 
-  # Step for test-unit
+  # Step for Minitest in Queue Mode
+  - "bundle exec rake knapsack_pro:queue:minitest"
+
+  # Step for test-unit in Regular Mode
   - "bundle exec rake knapsack_pro:test_unit"
 
-  # Step for Spinach
+  # Step for Spinach in Regular Mode
   - "bundle exec rake knapsack_pro:spinach"
 
 env:
@@ -1015,6 +1024,10 @@ env:
     - KNAPSACK_PRO_TEST_SUITE_TOKEN_TEST_UNIT=test-unit-token
     - KNAPSACK_PRO_TEST_SUITE_TOKEN_SPINACH=spinach-token
 
+    # if you use Knapsack Pro Queue Mode you must set below env variable
+    # to be able to retry single failed parallel job from Travis UI
+    - KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true
+
     - KNAPSACK_PRO_CI_NODE_TOTAL=2
   jobs:
     - KNAPSACK_PRO_CI_NODE_INDEX=0

data/lib/knapsack_pro/slow_test_file_determiner.rb

@@ -2,7 +2,6 @@ module KnapsackPro
   class SlowTestFileDeterminer
     TIME_THRESHOLD_PER_CI_NODE = 0.7 # 70%
     REPORT_DIR = 'tmp/knapsack_pro/slow_test_file_determiner'
-    REPORT_PATH = "#{REPORT_DIR}/slow_test_files.json"
 
     # test_files: { 'path' => 'a_spec.rb', 'time_execution' => 0.0 }
     # time_execution: of build distribution (total time of CI build run)
@@ -16,13 +15,19 @@ module KnapsackPro
 
     def self.save_to_json_report(test_files)
       FileUtils.mkdir_p(REPORT_DIR)
-      File.write(REPORT_PATH, test_files.to_json)
+      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)
-      slow_test_files_json_report = File.read(REPORT_PATH)
+      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)
+      slow_test_files_json_report = File.read(report_path)
       JSON.parse(slow_test_files_json_report)
     end
+
+    private
+
+    def self.report_path
+      "#{REPORT_DIR}/slow_test_files_node_#{KnapsackPro::Config::Env.ci_node_index}.json"
+    end
   end
 end

data/lib/knapsack_pro/test_case_detectors/rspec_test_example_detector.rb

@@ -2,7 +2,6 @@ module KnapsackPro
   module TestCaseDetectors
     class RSpecTestExampleDetector
       REPORT_DIR = 'tmp/knapsack_pro/test_case_detectors/rspec'
-      REPORT_PATH = "#{REPORT_DIR}/rspec_dry_run_json_report.json"
 
       def generate_json_report
         require 'rspec/core'
@@ -22,13 +21,13 @@ module KnapsackPro
 
         if test_file_entities.empty?
           no_examples_json = { examples: [] }.to_json
-          File.write(REPORT_PATH, no_examples_json)
+          File.write(report_path, no_examples_json)
           return
         end
 
         cli_args = cli_format + [
           '--dry-run',
-          '--out', REPORT_PATH,
+          '--out', report_path,
           '--default-path', test_dir,
         ] + KnapsackPro::TestFilePresenter.paths(test_file_entities)
         options = RSpec::Core::ConfigurationOptions.new(cli_args)
@@ -39,9 +38,9 @@ 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.exists?(report_path)
 
-        json_report = File.read(REPORT_PATH)
+        json_report = File.read(report_path)
         hash_report = JSON.parse(json_report)
         hash_report
           .fetch('examples')
@@ -61,6 +60,10 @@ module KnapsackPro
 
       private
 
+      def report_path
+        "#{REPORT_DIR}/rspec_dry_run_json_report_node_#{KnapsackPro::Config::Env.ci_node_index}.json"
+      end
+
       def adapter_class
         KnapsackPro::Adapters::RSpecAdapter
       end
@@ -78,7 +81,7 @@ module KnapsackPro
       end
 
       def remove_old_json_report
-        File.delete(REPORT_PATH) if File.exists?(REPORT_PATH)
+        File.delete(report_path) if File.exists?(report_path)
       end
 
       def test_file_hash_for(test_file_path)

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '1.22.0'
+  VERSION = '1.22.1'
 end

data/spec/knapsack_pro/slow_test_file_determiner_spec.rb

@@ -27,7 +27,7 @@ describe KnapsackPro::SlowTestFileDeterminer do
   end
 
   describe '.save_to_json_report', :clear_tmp do
-    let(:json_report_path) { 'tmp/knapsack_pro/slow_test_file_determiner/slow_test_files.json' }
+    let(:json_report_path) { 'tmp/knapsack_pro/slow_test_file_determiner/slow_test_files_node_0.json' }
     let(:test_files) do
       [
         { 'path' => 'a_spec.rb', 'time_execution' => 1.0 },

data/spec/knapsack_pro/test_case_detectors/rspec_test_example_detector_spec.rb

@@ -1,6 +1,6 @@
 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.json' }
+  let(:report_path) { 'tmp/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
@@ -116,7 +116,7 @@ describe KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector do
       it do
         expect(File).to receive(:exists?).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.json')
+        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')
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 1.22.0
+  version: 1.22.1
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-20 00:00:00.000000000 Z
+date: 2020-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake