knapsack_pro 0.24.0 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f5d89332f8fbd6085c892ff032cdc245ecf6002
-  data.tar.gz: d6ed82a6b2a2a4db849ede047366261d558f2254
+  metadata.gz: 911de2285757ea2787d872ff9e595910331d0e2c
+  data.tar.gz: 990c07a1d06f884849eeb98a904f360e741a33f8
 SHA512:
-  metadata.gz: deba77b348cb39a2acf95b538b11421969aa9833fff38209f4ca1be512d2a1f7d5a895dc0bbb177e8351ce876fb9c12f1204e813b3e999d8c9f7a48c9f72183e
-  data.tar.gz: 255880b403bfa18d332b791d7baf7757d32f60a2b35b67918903c2edd88ee4a159ffc09ab8cf89bcffca95e741929236172935ce8ece69c9f867eb7bfeef6eb5
+  metadata.gz: 3830d979ef91be8c88baaa9d79e446750c83bbaea35974ab5331bceac8e02b5dbfd3f05b1ae1834acdeabb39b27d32051a46934da541660a012910eeee5b8511
+  data.tar.gz: bc7922ae770633bf1f23c0bbb501df18b5e29cd64b0ddcba51b36e56cea427143200d7ee6c8316edce3534f4950634b7097e4aa90936c2b7c04b3ddeba93e902

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 * TODO
 
+### 0.25.0
+
+* Queue mode retry (remember queue split on retry CI node).
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/22
+
+* Fix bug in queue mode with recording test files time execution data. Previously the same test files time execution data where multiple times send to Knapsack Pro API.
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/23
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v0.24.0...v0.25.0
+
 ### 0.24.0
 
 * Send client name and version in headers for each request to Knapsack Pro API.

data/README.md

@@ -72,6 +72,8 @@ The knapsack_pro has also [queue mode](#queue-mode) to get most optimal test sui
   - [How queue mode works?](#how-queue-mode-works)
   - [How to use queue mode?](#how-to-use-queue-mode)
   - [Additional info about queue mode](#additional-info-about-queue-mode)
+  - [Extra configuration for Queue Mode](#extra-configuration-for-queue-mode)
+    - [KNAPSACK_PRO_FIXED_QUEUE_SPLIT (remember queue split on retry CI node)](#knapsack_pro_fixed_queue_split-remember-queue-split-on-retry-ci-node)
   - [Supported test runners in queue mode](#supported-test-runners-in-queue-mode)
 - [Extra configuration for CI server](#extra-configuration-for-ci-server)
   - [Info about ENV variables](#info-about-env-variables)
@@ -331,11 +333,38 @@ The second build should have better optimal test suite split.
 
   To avoid this you can specify unique `KNAPSACK_PRO_CI_NODE_BUILD_ID` environment variable for each CI build. This mean that each CI node that is part of particular CI build should have the same value for `KNAPSACK_PRO_CI_NODE_BUILD_ID`.
 
-* Note that in the queue mode you cannot retry the failed CI node with exactly the same subset of tests that were run on the CI node in the first place. It's possible only in regular mode ([read more](#knapsack_pro_fixed_test_suite_splite-test-suite-split-based-on-seed)).
+* Note that in the Queue Mode by default you cannot retry the failed CI node with exactly the same subset of tests that were run on the CI node in the first place. It's possible in regular mode ([read more](#knapsack_pro_fixed_test_suite_splite-test-suite-split-based-on-seed)). If you want to have similar behavior in Queue Mode you need to explicitly [enable it](#knapsack_pro_fixed_queue_split-remember-queue-split-on-retry-ci-node).
 
-  Let's say one of the CI nodes failed and you retry just this single CI node while other CI nodes are still running. The retried CI node will be connected to the queue consumed by running CI nodes.
+  By default the Queue Mode works this way:
 
-  In the case when there are no running CI nodes then your retried CI node will initialize a new queue and it will run whole test suite from the queue because there will be no other CI nodes running connected to the queue. The order of tests on retried CI node will be different than on the first run.
+  * If you retry the failed build and your all CI nodes will start a new build then there will be a new dynamic test suite split across CI nodes.
+
+  * Let's say one of the CI nodes failed and you retry just this single CI node while other CI nodes are still running. The retried CI node will be connected to the queue consumed by still running CI nodes.
+
+  * In the case when there are no running CI nodes then your retried CI node will initialize a new queue and it will run whole test suite from the queue because there will be no other CI nodes running connected to the queue. The order of tests on retried CI node will be different than on the first run.
+
+### Extra configuration for Queue Mode
+
+#### KNAPSACK_PRO_FIXED_QUEUE_SPLIT (remember queue split on retry CI node)
+
+* `KNAPSACK_PRO_FIXED_QUEUE_SPLIT=false` (default)
+
+  By default, the fixed queue split is off. It means when you will run tests for the same commit hash and a total number of nodes and for the same branch then each time the queue will be generated dynamically and CI nodes will fetch from Knapsack Pro API the test files in a dynamic way. This is default because it gives the most optimal test suite split for the whole test build across all CI nodes even when you retry the same build on CI many times.
+
+* `KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true`
+
+  You can enable fixed queue split in order to remember the test suite split across CI nodes when you used Queue Mode.
+
+  It means when you run test suite or just retry single CI node again for the same commit hash and a total number of nodes and for the same branch
+  then you will get exactly the same test suite split as it was when you run the build for the first time.
+
+  Thanks to that when tests on one of your node failed you can retry the node with exactly the same subset of tests that were run on the node in the first place.
+
+  Note when fixed queue split is enabled then you can run tests in a dynamic way only once for particular commit hash and a total number of nodes and for the same branch.
+
+  When Knapsack Pro API server has already information about previous queue split then the information will be used. You will see at the beginning of the knapsack command the log with info that queue name is nil because it was not generated this time. You will get the list of all test files that were executed on the particular CI node in the past.
+
+       [knapsack_pro] {"queue_name"=>nil, "test_files"=>[{"path"=>"spec/foo_spec.rb", "time_execution"=>1.23}]}
 
 ### Supported test runners in queue mode
 

data/lib/knapsack_pro/client/api/v1/queues.rb

@@ -9,6 +9,7 @@ module KnapsackPro
                 endpoint_path: '/v1/queues/queue',
                 http_method: :post,
                 request_hash: {
+                  :fixed_queue_split => KnapsackPro::Config::Env.fixed_queue_split,
                   :can_initialize_queue => args.fetch(:can_initialize_queue),
                   :commit_hash => args.fetch(:commit_hash),
                   :branch => args.fetch(:branch),

data/lib/knapsack_pro/config/env.rb

@@ -99,6 +99,10 @@ module KnapsackPro
           ENV.fetch('KNAPSACK_PRO_FIXED_TEST_SUITE_SPLIT', true)
         end
 
+        def fixed_queue_split
+          ENV.fetch('KNAPSACK_PRO_FIXED_QUEUE_SPLIT', false)
+        end
+
         def test_suite_token
           required_env('KNAPSACK_PRO_TEST_SUITE_TOKEN')
         end

data/lib/knapsack_pro/report.rb

@@ -7,6 +7,8 @@ module KnapsackPro
 
     def self.save_subset_queue_to_file
       test_files = KnapsackPro.tracker.to_a
+      KnapsackPro.tracker.reset!
+
       subset_queue_id = KnapsackPro::Config::Env.subset_queue_id
 
       FileUtils.mkdir_p(queue_path)

data/lib/knapsack_pro/repository_adapters/base_adapter.rb

@@ -11,4 +11,3 @@ module KnapsackPro
     end
   end
 end
-

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '0.24.0'
+  VERSION = '0.25.0'
 end

data/spec/knapsack_pro/client/api/v1/queues_spec.rb

@@ -1,5 +1,6 @@
 describe KnapsackPro::Client::API::V1::Queues do
   describe '.queue' do
+    let(:fixed_queue_split) { double }
     let(:can_initialize_queue) { double }
     let(:commit_hash) { double }
     let(:branch) { double }
@@ -18,6 +19,10 @@ describe KnapsackPro::Client::API::V1::Queues do
       )
     end
 
+    before do
+      expect(KnapsackPro::Config::Env).to receive(:fixed_queue_split).and_return(fixed_queue_split)
+    end
+
     it do
       node_build_id = double
       expect(KnapsackPro::Config::Env).to receive(:ci_node_build_id).and_return(node_build_id)
@@ -27,6 +32,7 @@ describe KnapsackPro::Client::API::V1::Queues do
         endpoint_path: '/v1/queues/queue',
         http_method: :post,
         request_hash: {
+          fixed_queue_split: fixed_queue_split,
           can_initialize_queue: can_initialize_queue,
           commit_hash: commit_hash,
           branch: branch,

data/spec/knapsack_pro/config/env_spec.rb

@@ -373,6 +373,20 @@ describe KnapsackPro::Config::Env do
     end
   end
 
+  describe '.fixed_queue_split' do
+    subject { described_class.fixed_queue_split }
+
+    context 'when ENV exists' do
+      before { stub_const("ENV", { 'KNAPSACK_PRO_FIXED_QUEUE_SPLIT' => true }) }
+      it { should eq true }
+    end
+
+    context "when ENV doesn't exist" do
+      before { stub_const("ENV", {}) }
+      it { should be false }
+    end
+  end
+
   describe '.test_suite_token' do
     subject { described_class.test_suite_token }
 

data/spec/knapsack_pro/report_spec.rb

@@ -20,7 +20,8 @@ describe KnapsackPro::Report do
     before do
       test_files = [{path: fake_path}]
       tracker = instance_double(KnapsackPro::Tracker, to_a: test_files)
-      expect(KnapsackPro).to receive(:tracker).and_return(tracker)
+      expect(KnapsackPro).to receive(:tracker).twice.and_return(tracker)
+      expect(tracker).to receive(:reset!)
 
       subset_queue_id = 'fake-subset-queue-id'
       expect(KnapsackPro::Config::Env).to receive(:subset_queue_id).and_return(subset_queue_id)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 0.24.0
+  version: 0.25.0
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-28 00:00:00.000000000 Z
+date: 2017-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake