knapsack_pro 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '099f5615951240d49a1087c5ebbb89169f161a35bfc2f0dc4ea7de80f188e3f9'
-  data.tar.gz: d4939ae9f79b358038147cd5f9a40dcee95760f1fa17d84314fc183cfad722a7
+  metadata.gz: 23f9763190e37db931c1457e71dccca8ef1f9d6fcd99fe50b28b1571366833cc
+  data.tar.gz: d93d4734cf560ecc77ae06959562c1fcf1ac61489671f374c3fc8a3e2f2e040a
 SHA512:
-  metadata.gz: adfe023532b15509a4bc1cb993c3d259ffde7df5078c76cf7cf392ec5ce8b6f8eb322ca093e77eadf3ec0c8eba4748ccd0f5ccf6666fd3559eb3bd1a55c0893a
-  data.tar.gz: 072f8d809aa4600ed5f4987f39946cd0030faac8e4ca9bae08cf38680c3aef24226744023d5c6a74aa53b76c2fe481c35692b2f33b98ba9a8d85d17ddeb990c6
+  metadata.gz: 254b42538b48ef6483e2479e4db2f5619389df83496443b6924a6953b2d49485563615888864cb0ec3696cb36e2f0338873294ffa559461076ba4033929134bc
+  data.tar.gz: 310f6d28741d8631bba32b205e0f4a86a47b775f0c8f732a272ecf1151c88b2ca46e1975657f5fa5dcaaefefbaa2b2668b9e65e876addf838aa4013e83770723

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Change Log
 
+### 3.4.0
+
+* Update documentation and code because the encryption feature does not work with the RSpec split by examples feature
+
+    Update docs: https://github.com/KnapsackPro/knapsack_pro-ruby/pull/176
+
+    Update code: https://github.com/KnapsackPro/knapsack_pro-ruby/pull/177
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v3.3.1...v3.4.0
+
+### 3.3.1
+
+* Skip loading a test file path for Minitest in Queue Mode when it does not exist on the disk
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/174
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v3.3.0...v3.3.1
+
 ### 3.3.0
 
 * Show a JSON report file content when RSpec fails during a dry run 

data/README.md

@@ -97,7 +97,6 @@ The knapsack_pro has also [queue mode](#queue-mode) to get an optimal test suite
   - [Test file names encryption](#test-file-names-encryption)
     - [How to enable test file names encryption?](#how-to-enable-test-file-names-encryption)
     - [How to debug test file names?](#how-to-debug-test-file-names)
-      - [Preview encrypted RSpec test example paths?](#preview-encrypted-rspec-test-example-paths)
     - [How to enable branch names encryption?](#how-to-enable-branch-names-encryption)
     - [How to debug branch names?](#how-to-debug-branch-names)
   - [Supported CI providers](#supported-ci-providers)
@@ -719,72 +718,61 @@ This is optional way of using knapsack_pro when you don't want to add it to `Gem
 
 ### Test file names encryption
 
-knapsack_pro gem collects information about you test file names and time execution. Those data are stored on KnapsackPro.com server.
-If your test file names or branch names are sensitive data then you can encrypt the names before sending them to KnapsackPro.com API.
+The knapsack_pro gem collects information about your test file names, branch names, and execution times. The data are stored on the KnapsackPro.com server.
+If your test file names or branch names are considered sensitive data, then you can encrypt the data before sending it to the KnapsackPro.com API.
 
-By default, encryption is disabled because knapsack_pro can use your test files names to prepare better test suite split when the time execution data are not yet collected on KnapsackPro.com server.
-When you will enable test file names encryption then your first test suite split may be less optimal than it could be.
+Encryption is disabled by default because the knapsack_pro gem uses your test file names to prepare a better test suite split when the execution time data are not collected on the KnapsackPro.com server yet.
+When you enable the encryption, then your first test suite split may not be optimal.
 
-Each test file name is generated with `Digest::SHA2.hexdigest` method and 64 chars salt.
+Each test file name is generated with the `Digest::SHA2.hexdigest` method and 64 chars salt.
 
-Before you enable test file encryption please ensure you are using fresh API key. You should not use the same API key for encrypted and non encrypted test suite.
-You can generate API key for your test suite in [your dashboard](https://knapsackpro.com).
+Before you enable encryption, please ensure you are using a fresh API token. Do not use the same API token for the encrypted and non-encrypted test suite. You can generate an API token for your test suite in the [user dashboard](https://knapsackpro.com/dashboard).
 
-Next step is to generate salt which will be used to encrypt test files or branch names.
+The next step is to generate a salt to encrypt test files or branch names with it.
 
 ```bash
 bundle exec rake knapsack_pro:salt
 ```
 
-Add to your CI server generated environment variable `KNAPSACK_PRO_SALT`.
+Add the salt to your CI server as the `KNAPSACK_PRO_SALT` environment variable.
 
 #### How to enable test file names encryption?
 
-You need to add environment variable `KNAPSACK_PRO_TEST_FILES_ENCRYPTED=true` to your CI server.
+You need to add the `KNAPSACK_PRO_TEST_FILES_ENCRYPTED=true` environment variable to your CI server.
 
 #### How to debug test file names?
 
-If you need to check what is the encryption hash for particular test file you can check that with the rake task:
+If you need to check what is the hash value for a particular test file you can check that with the rake task:
 
 ```bash
-KNAPSACK_PRO_SALT=xxx bundle exec rake knapsack_pro:encrypted_test_file_names[rspec]
+KNAPSACK_PRO_SALT=xxx bundle exec rake "knapsack_pro:encrypted_test_file_names[rspec]"
 ```
 
-You can pass the name of test runner like `rspec`, `minitest`, `test_unit`, `cucumber`, `spinach` as argument to rake task.
-
-##### Preview encrypted RSpec test example paths?
-
-If you split RSpec tests by test examples (by individual `it`) you can preview encrypted test example paths this way:
-
-```bash
-KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES=true \
-KNAPSACK_PRO_SALT=xxx \
-bundle exec rake knapsack_pro:encrypted_test_file_names[rspec]
-```
+You can pass the name of a test runner like `rspec`, `minitest`, `test_unit`, `cucumber`, `spinach` as an argument to the rake task.
 
 #### How to enable branch names encryption?
 
-You need to add environment variable `KNAPSACK_PRO_BRANCH_ENCRYPTED=true` to your CI server.
+You need to add the `KNAPSACK_PRO_BRANCH_ENCRYPTED=true` environment variable to your CI server.
 
-Note: there are a few branch names that won't be encrypted because we use them as fallback branches on Knapsack Pro API side to determine time execution for test files during split for newly created branches.
+Note a few branch names won't be encrypted because we use them as fallback branches on the Knapsack Pro API side to determine time execution for test files during split for newly created branches.
 
 * develop
 * development
 * dev
 * master
 * staging
-* [see full list of encryption excluded branch names](https://github.com/KnapsackPro/knapsack_pro-ruby/blob/master/lib/knapsack_pro/crypto/branch_encryptor.rb#L4)
+* [see the full list of excluded branch names from encryption](https://github.com/KnapsackPro/knapsack_pro-ruby/blob/master/lib/knapsack_pro/crypto/branch_encryptor.rb#L4)
 
 #### How to debug branch names?
 
-If you need to check what is the encryption hash for particular branch then use the rake task:
+If you need to check what is the hash for a particular branch, then use the rake task:
 
 ```bash
 # show all local branches and respective hashes
 $ KNAPSACK_PRO_SALT=xxx bundle exec rake knapsack_pro:encrypted_branch_names
 
-# show hash for branch provided as argument to rake task
-$ KNAPSACK_PRO_SALT=xxx bundle exec rake knapsack_pro:encrypted_branch_names[not-encrypted-branch-name]
+# show the hash for a branch name passed as an argument to the rake task
+$ KNAPSACK_PRO_SALT=xxx bundle exec rake "knapsack_pro:encrypted_branch_names[not-encrypted-branch-name]"
 ```
 
 ### Supported CI providers

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

@@ -91,7 +91,13 @@ module KnapsackPro
 
         def self.minitest_run(runner, test_file_paths, args)
           test_file_paths.each do |test_file_path|
-            require "./#{test_file_path}"
+            relative_test_file_path = "./#{test_file_path}"
+
+            if File.exist?(relative_test_file_path)
+              require relative_test_file_path
+            else
+              KnapsackPro.logger.warn("Skip loading the #{relative_test_file_path} test file path because it does not exist on the disk. Most likely, the test file path should not be loaded. The test file path could have been recorded during the previous CI build when the knapsack_pro gem could not attribute the execution time of a test to a correct test file path. For instance, you have shared examples in your test suite, and the knapsack_pro gem could not correctly determine for which test file path they were executed. In such a case, the test file path should not be loaded because the actual test cases will be executed by loading a correct test file path. You can ignore this warning.")
+            end
           end
 
           # duplicate args because Minitest modifies args

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '3.3.0'
+  VERSION = '3.4.0'
 end

data/lib/tasks/encrypted_test_file_names.rake

@@ -19,15 +19,8 @@ namespace :knapsack_pro do
                       raise('Provide adapter name like rspec, minitest, test_unit, cucumber, spinach')
                     end
 
-    test_files =
-      if adapter_class == KnapsackPro::Adapters::RSpecAdapter && KnapsackPro::Config::Env.rspec_split_by_test_examples?
-        detector = KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector.new
-        detector.generate_json_report
-        detector.test_file_example_paths
-      else
-        test_file_pattern = KnapsackPro::TestFilePattern.call(adapter_class)
-        KnapsackPro::TestFileFinder.call(test_file_pattern)
-      end
+    test_file_pattern = KnapsackPro::TestFilePattern.call(adapter_class)
+    test_files = KnapsackPro::TestFileFinder.call(test_file_pattern)
 
     test_file_names = []
     test_files.each do |t|

data/spec/knapsack_pro/runners/queue/minitest_runner_spec.rb

@@ -100,7 +100,7 @@ describe KnapsackPro::Runners::Queue::MinitestRunner do
     end
 
     context 'when test files exist' do
-      let(:test_file_paths) { ['a_test.rb', 'b_test.rb'] }
+      let(:test_file_paths) { ['a_test.rb', 'b_test.rb', 'fake_path_test.rb'] }
 
       before do
         subset_queue_id = 'fake-subset-queue-id'
@@ -114,8 +114,12 @@ describe KnapsackPro::Runners::Queue::MinitestRunner do
         expect(tracker).to receive(:set_prerun_tests).with(test_file_paths)
 
         # .minitest_run
+        expect(File).to receive(:exist?).with('./a_test.rb').and_return(true)
+        expect(File).to receive(:exist?).with('./b_test.rb').and_return(true)
+        expect(File).to receive(:exist?).with('./fake_path_test.rb').and_return(false)
         expect(described_class).to receive(:require).with('./a_test.rb')
         expect(described_class).to receive(:require).with('./b_test.rb')
+        expect(described_class).to_not receive(:require).with('./fake_path_test.rb')
 
         expect(Minitest).to receive(:run).with(args).and_return(is_tests_green)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-11 00:00:00.000000000 Z
+date: 2022-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake