knapsack_pro 0.26.0 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7703c67b5430e96304f84ffe6180d2724ced2024
-  data.tar.gz: 42504a31a204cbec81297226b1106a5a93b3c97e
+  metadata.gz: aeedb148388f2fda48884dbd34b294419fb55711
+  data.tar.gz: 43a1a930c3e5a6703719d38a7dfff0ac3131fed8
 SHA512:
-  metadata.gz: b30a77c07bb4b62bcb67b767f279062d4ae0a7497f8da5d411a9b2f834ef2f48c1afe4562a3a339c869e81888a3f086256064b0154e3bc28526560f113e36cc6
-  data.tar.gz: 8099e1690a714695f646dd1dc3617554f257dea090b3b384f1a3407e693891d2f577b78c5678ae6c45b2f77f8362abbeaa99af6505bbc86451ebb5800b3d0f65
+  metadata.gz: cf278d4eecf850091463ad6ae7591e91c6993e7e82aa0a0d5b0f21beb6c0b25ef03ec742bb9e116b0b89861e52fa40be64aafd8d6e403459294ffae6cc7aec03
+  data.tar.gz: 7cf8746554c01f34b7a6570f7d952574bcd819cae080244596d99d29df5133468874071310be3018b834a6d052a9683c48bea5d111cef162d682843b0fa2c41c

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 * TODO
 
+### 0.27.0
+
+* Save build subset to API even when no test files were executed on CI node. Add warnings to notify why the test files were not executed on CI node in particular mode: regular or queue mode.
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v0.26.0...v0.27.0
+
 ### 0.26.0
 
 * Add info how to allow FakeWeb to connect with Knapsack Pro API in install rake task.

data/README.md

@@ -108,6 +108,8 @@ The knapsack_pro has also [queue mode](#queue-mode) to get most optimal test sui
     - [What data is sent to your servers?](#what-data-is-sent-to-your-servers)
     - [How is that data secured?](#how-is-that-data-secured)
     - [Who has access to the data?](#who-has-access-to-the-data)
+  - [Why when I use Queue Mode for RSpec and test fails then I see multiple times info about failed test in RSpec result?](#why-when-i-use-queue-mode-for-rspec-and-test-fails-then-i-see-multiple-times-info-about-failed-test-in-rspec-result)
+  - [Does in Queue Mode the RSpec is initialized many times that causes Rails load over and over again?](#does-in-queue-mode-the-rspec-is-initialized-many-times-that-causes-rails-load-over-and-over-again)
 - [Gem tests](#gem-tests)
   - [Spec](#spec)
 - [Contributing](#contributing)
@@ -325,7 +327,9 @@ that should be executed. Thanks to that each CI node will finish tests at the sa
 
 ### How to use queue mode?
 
-Please use this command to run queue mode:
+Please use different API token for queue mode than for regular mode.
+
+Use this command to run queue mode:
 
     bundle exec rake knapsack_pro:queue:rspec
 
@@ -338,6 +342,9 @@ The second build should have better optimal test suite split.
 
 ### Additional info about queue mode
 
+* You should use different API token for queue mode than for regular mode to avoid problem with test suite split in case you would like to go back to regular mode.
+There might be some cached test suite splits for git commits you run in past for API token you used in queue mode because of the [flag `KNAPSACK_PRO_FIXED_TEST_SUITE_SPLIT=true` for regular mode which is default](#knapsack_pro_fixed_test_suite_splite-test-suite-split-based-on-seed).
+
 * If you are not using one of [supported CI providers](#supported-ci-providers) then please note that knapsack_pro gem doesn't know what is CI build ID in order to generated queue for particular CI build. This may result in two different CI builds taking tests from the same queue when CI builds are running at the same time against the same git commit.
 
   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`.
@@ -820,6 +827,17 @@ I’m the only admin so I can preview data in case you need help with debugging
 When you sign in to your user dashboard then you can preview data for recent 100 builds on CI. If the test file paths are encrypted then you only see hashes for test file paths.
 You need to [decrypt](#how-to-debug-test-file-names) them locally on your machine to find out what each test file hash is.
 
+### Why when I use Queue Mode for RSpec and test fails then I see multiple times info about failed test in RSpec result?
+
+RSpec collects information about failed tests and presents it at the end of RSpec result.
+When you use Queue Mode then knapack_pro does multiple requests to Knapsack Pro API and fetches a few test files to execute.
+This means RSpec will remember failed tests so far and it will present them at the end of each executed test subset.
+You can see the list of all failed test files at the end of knapack_pro queue mode command.
+
+### Does in Queue Mode the RSpec is initialized many times that causes Rails load over and over again?
+
+No. In Queue Mode the RSpec configuration is updated every time when knapsack_pro gem gets a new set of test files from the Knapsack Pro API and it looks in knapsack_pro output like RSpec was loaded many times but in fact, it loads your project environment only once.
+
 ## Gem tests
 
 ### Spec

data/circle.yml

@@ -1,5 +1,5 @@
 machine:
   ruby:
-    version: 2.3.0
+    version: 2.4.0
   environment:
     CODECLIMATE_REPO_TOKEN: b6626e682a8e97e0c5978febc92c3526792a2d018b41b8e1b52689da37fb7d92

data/lib/knapsack_pro/report.rb

@@ -2,6 +2,11 @@ module KnapsackPro
   class Report
     def self.save
       test_files = KnapsackPro.tracker.to_a
+
+      if test_files.empty?
+        KnapsackPro.logger.info("No test files were executed on this CI node. 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.")
+      end
+
       create_build_subset(test_files)
     end
 
@@ -29,15 +34,14 @@ module KnapsackPro
         test_files += report
       end
 
+      if test_files.empty?
+        KnapsackPro.logger.info("No test files were executed on this CI node. 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.")
+      end
+
       create_build_subset(test_files)
     end
 
     def self.create_build_subset(test_files)
-      if test_files.empty?
-        KnapsackPro.logger.info("Didn't save time execution report on API server because there are no test files matching criteria on this node. 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.")
-        return
-      end
-
       repository_adapter = KnapsackPro::RepositoryAdapterInitiator.call
       test_files = KnapsackPro::Utils.unsymbolize(test_files)
       encrypted_test_files = KnapsackPro::Crypto::Encryptor.call(test_files)

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '0.26.0'
+  VERSION = '0.27.0'
 end

data/spec/knapsack_pro/report_spec.rb

@@ -3,7 +3,7 @@ describe KnapsackPro::Report do
     subject { described_class.save }
 
     it do
-      test_files = double
+      test_files = [double]
       tracker = instance_double(KnapsackPro::Tracker, to_a: test_files)
       expect(KnapsackPro).to receive(:tracker).and_return(tracker)
       expect(described_class).to receive(:create_build_subset).with(test_files)
@@ -77,53 +77,40 @@ describe KnapsackPro::Report do
   describe '.create_build_subset' do
     subject { described_class.create_build_subset(test_files) }
 
-    context "when test files doesn't exist" do
-      let(:test_files) { [] }
-
-      it do
-        logger = instance_double(Logger)
-        expect(KnapsackPro).to receive(:logger).and_return(logger)
-        expect(logger).to receive(:info).with("Didn't save time execution report on API server because there are no test files matching criteria on this node. 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.")
-        subject
-      end
+    before do
+      commit_hash = double
+      branch = double
+      repository_adapter = instance_double(KnapsackPro::RepositoryAdapters::EnvAdapter, commit_hash: commit_hash, branch: branch)
+      expect(KnapsackPro::RepositoryAdapterInitiator).to receive(:call).and_return(repository_adapter)
+
+      unsymbolize_test_files = double
+      expect(KnapsackPro::Utils).to receive(:unsymbolize).with(test_files).and_return(unsymbolize_test_files)
+
+      encrypted_test_files = double
+      expect(KnapsackPro::Crypto::Encryptor).to receive(:call).with(unsymbolize_test_files).and_return(encrypted_test_files)
+
+      node_total = double
+      node_index = double
+      expect(KnapsackPro::Config::Env).to receive(:ci_node_total).and_return(node_total)
+      expect(KnapsackPro::Config::Env).to receive(:ci_node_index).and_return(node_index)
+
+      action = double
+      expect(KnapsackPro::Client::API::V1::BuildSubsets).to receive(:create).with({
+        commit_hash: commit_hash,
+        branch: branch,
+        node_total: node_total,
+        node_index: node_index,
+        test_files: encrypted_test_files,
+      }).and_return(action)
+
+      connection = instance_double(KnapsackPro::Client::Connection, success?: success?, errors?: errors?)
+      expect(KnapsackPro::Client::Connection).to receive(:new).with(action).and_return(connection).and_return(connection)
+
+      response = double
+      expect(connection).to receive(:call).and_return(response)
     end
 
-    context 'when test files exists' do
-      let(:test_files) { [double] }
-
-      before do
-        commit_hash = double
-        branch = double
-        repository_adapter = instance_double(KnapsackPro::RepositoryAdapters::EnvAdapter, commit_hash: commit_hash, branch: branch)
-        expect(KnapsackPro::RepositoryAdapterInitiator).to receive(:call).and_return(repository_adapter)
-
-        unsymbolize_test_files = double
-        expect(KnapsackPro::Utils).to receive(:unsymbolize).with(test_files).and_return(unsymbolize_test_files)
-
-        encrypted_test_files = double
-        expect(KnapsackPro::Crypto::Encryptor).to receive(:call).with(unsymbolize_test_files).and_return(encrypted_test_files)
-
-        node_total = double
-        node_index = double
-        expect(KnapsackPro::Config::Env).to receive(:ci_node_total).and_return(node_total)
-        expect(KnapsackPro::Config::Env).to receive(:ci_node_index).and_return(node_index)
-
-        action = double
-        expect(KnapsackPro::Client::API::V1::BuildSubsets).to receive(:create).with({
-          commit_hash: commit_hash,
-          branch: branch,
-          node_total: node_total,
-          node_index: node_index,
-          test_files: encrypted_test_files,
-        }).and_return(action)
-
-        connection = instance_double(KnapsackPro::Client::Connection, success?: success?, errors?: errors?)
-        expect(KnapsackPro::Client::Connection).to receive(:new).with(action).and_return(connection).and_return(connection)
-
-        response = double
-        expect(connection).to receive(:call).and_return(response)
-      end
-
+    shared_examples_for 'create_build_subset method' do
       context 'when success' do
         let(:success?) { true }
 
@@ -156,5 +143,17 @@ describe KnapsackPro::Report do
         it { subject }
       end
     end
+
+    context "when test files doesn't exist" do
+      let(:test_files) { [] }
+
+      it_behaves_like 'create_build_subset method'
+    end
+
+    context 'when test files exists' do
+      let(:test_files) { [double] }
+
+      it_behaves_like 'create_build_subset method'
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 0.26.0
+  version: 0.27.0
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-05 00:00:00.000000000 Z
+date: 2017-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake