knapsack_pro 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d7bf901385b7f5c6010f0ec20241cf9d74e4c954cf69ae75ca7f5ac1d4c549b
-  data.tar.gz: 0a24d55e70d9055e70ae052ef152e0cf1a85716d4d93025e800a5b1769853f0d
+  metadata.gz: 15d64502a63c7087b4d8793ad780d0f7454d2414c93c0da46967e20620578fe0
+  data.tar.gz: 88addd61d85b84f2fc043ff17e554564d95b40be262fe55a51714efa5ae4f719
 SHA512:
-  metadata.gz: '0482cd76a5a08df97ce43abf6d89763f1f8fb83cd3aca349c09de993513a87c623bfe0abb31a05d9dd5701101ebf19789e0a41145b3f2e435567a244a462a992'
-  data.tar.gz: 0b958c6d1bf0d8f9cdfcb4a97b5f48a0ad3b046acdc6c6b7198e0a7865f37928fe8f2d4d62acb0306489d5779bd07b613cb5774aca426dd774b81fd6cf431435
+  metadata.gz: 67664f1170199a4f5f6cb2fbabdfd15fbebd2c73d04a0646bacdc20411411722f5b7b0946d8a76417150fcbe60211b13b97f27a09ca10840a44caaea8beccb0a
+  data.tar.gz: d835f28e6af4885f42e6daa218caace7401f1ab9e406d1f8a4c06af6f20ad671e37b8501e35aceaea41183d94d56feec462badb86747053843b7a1957ec64867

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+### 1.10.0
+
+* Logs error on lost info about recorded timing for test files due to missing json files in Queue Mode
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/83
+
+* Fix bug: default test file time should not be added to measured time
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/84
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v1.9.0...v1.10.0
+
 ### 1.9.0
 
 * Reduce data transfer and speed up usage of Knapsack Pro API for Queue Mode

data/README.md

@@ -1414,7 +1414,7 @@ end
 ##### Why when I use Queue Mode for RSpec then my tests fail?
 
 knapsack_pro Queue Mode uses `RSpec::Core::Runner` feature that allows [running specs multiple times with different runner options in the same process](https://relishapp.com/rspec/rspec-core/docs/running-specs-multiple-times-with-different-runner-options-in-the-same-process).
-Thanks to that we can run subset of test suite pulled from Knapsack Pro API work queue. This allows dynamic allocation of your tests across CI nodes without reloading whole Ruby/Rails application for each run of test suite subset .
+Thanks to that we can run subset of test suite pulled from Knapsack Pro API work queue. This allows dynamic allocation of your tests across CI nodes without reloading whole Ruby/Rails application for each run of test suite subset.
 
 If you have custom things that are not common in how typical RSpec spec looks like then the RSpec feature won't be able to handle it between test suite subset runs.
 In that case you need to resolve failed tests in a way that allows RSpec to run the tests. Feel free to [ask me for help](https://knapsackpro.com/contact).
@@ -1540,6 +1540,15 @@ If you go to [user dashboard](https://knapsackpro.com/dashboard) and open `Build
 If you go to [user dashboard](https://knapsackpro.com/dashboard) and open `Build metrics` for your API token and you open CI build for your last git commit you should see there info about collected time execution data from all CI nodes. If you see all test files have 0.1s time execution then please ensure:
 
 * you don't clean up `tmp` directory in your tests (for instance in RSpec hooks like `before` or `after`) so knapsack_pro can publish measured time execution data to Knapsack Pro API server. knapsack_pro Queue Mode saves temporary files with collected time execution data in `your_rails_project/tmp/knapsack_pro/queue/`.
+* please ensure you have in your `rails_helper.rb` or `spec_helper.rb` line:
+
+```ruby
+require 'knapsack_pro'
+
+# CUSTOM_CONFIG_GOES_HERE
+
+KnapsackPro::Adapters::RSpecAdapter.bind
+```
 
 The 0.1s is a default time execution used when test file is an empty file or its content are all pending tests.
 

data/lib/knapsack_pro/report.rb

@@ -27,7 +27,7 @@ module KnapsackPro
       end
     end
 
-    def self.save_node_queue_to_api
+    def self.save_node_queue_to_api(executed_test_files_count)
       test_files = []
       Dir.glob("#{queue_path}/*.json").each do |file|
         report = JSON.parse(File.read(file))
@@ -35,9 +35,15 @@ module KnapsackPro
       end
 
       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 testes should be executed here.")
+        if executed_test_files_count == 0
+          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 testes should be executed here.")
+        end
+
+        if executed_test_files_count > 0
+          KnapsackPro.logger.error("#{executed_test_files_count} test files were executed on this CI node but the recorded time of it was lost. 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. 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/")
+        end
       end
 
       create_build_subset(test_files)

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

@@ -48,7 +48,7 @@ module KnapsackPro
           if test_file_paths.empty?
             KnapsackPro::Hooks::Queue.call_after_queue
 
-            KnapsackPro::Report.save_node_queue_to_api
+            KnapsackPro::Report.save_node_queue_to_api(all_test_file_paths.count)
 
             return {
               status: :completed,

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

@@ -59,7 +59,7 @@ module KnapsackPro
 
             KnapsackPro::Hooks::Queue.call_after_queue
 
-            KnapsackPro::Report.save_node_queue_to_api
+            KnapsackPro::Report.save_node_queue_to_api(all_test_file_paths.count)
 
             return {
               status: :completed,

data/lib/knapsack_pro/tracker.rb

@@ -2,6 +2,10 @@ module KnapsackPro
   class Tracker
     include Singleton
 
+    # when test file is pending, empty with no tests or has syntax error then assume time execution
+    # to better allocate it in Queue Mode for future CI build runs
+    DEFAULT_TEST_FILE_TIME = 0.1 # seconds
+
     attr_reader :global_time_since_beginning, :global_time, :test_files_with_time
     attr_writer :current_test_path
 
@@ -36,16 +40,19 @@ module KnapsackPro
         # in case when the test file will not be run
         # due syntax error or being pending.
         # The time is required by Knapsack Pro API.
-        @test_files_with_time[test_file_path] = 0.1
+        @test_files_with_time[test_file_path] = {
+          time_execution: DEFAULT_TEST_FILE_TIME,
+          measured_time: false,
+        }
       end
     end
 
     def to_a
       test_files = []
-      @test_files_with_time.each do |path, time_execution|
+      @test_files_with_time.each do |path, hash|
         test_files << {
           path: path,
-          time_execution: time_execution
+          time_execution: hash[:time_execution]
         }
       end
       test_files
@@ -65,8 +72,21 @@ module KnapsackPro
     end
 
     def update_test_file_time(execution_time)
-      @test_files_with_time[current_test_path] ||= 0
-      @test_files_with_time[current_test_path] += execution_time
+      @test_files_with_time[current_test_path] ||= {
+        time_execution: 0,
+        measured_time: false,
+      }
+
+      hash = @test_files_with_time[current_test_path]
+
+      if hash[:measured_time]
+        hash[:time_execution] += execution_time
+      else
+        hash[:time_execution] = execution_time
+        hash[:measured_time] = true
+      end
+
+      @test_files_with_time[current_test_path] = hash
     end
 
     def now_without_mock_time

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '1.9.0'
+  VERSION = '1.10.0'
 end

data/spec/knapsack_pro/report_spec.rb

@@ -43,33 +43,85 @@ describe KnapsackPro::Report do
   end
 
   describe '.save_node_queue_to_api' do
-    let(:json_test_file_a_path) { double }
-    let(:json_test_file_a) { [{ 'path' => 'a_spec.rb' }] }
+    context 'when json files with recorded time exist for executed test files' do
+      let(:json_test_file_a_path) { double }
+      let(:json_test_file_a) { [{ 'path' => 'a_spec.rb' }] }
 
-    let(:json_test_file_b_path) { double }
-    let(:json_test_file_b) { [{ 'path' => 'b_spec.rb' }] }
+      let(:json_test_file_b_path) { double }
+      let(:json_test_file_b) { [{ 'path' => 'b_spec.rb' }] }
 
-    subject { described_class.save_node_queue_to_api }
+      let(:executed_test_files_count) { 2 }
 
-    before do
-      queue_id = 'fake-queue-id'
-      expect(KnapsackPro::Config::Env).to receive(:queue_id).and_return(queue_id)
+      subject { described_class.save_node_queue_to_api(executed_test_files_count) }
 
-      expect(Dir).to receive(:glob).with('tmp/knapsack_pro/queue/fake-queue-id/*.json').and_return([
-        json_test_file_a_path,
-        json_test_file_b_path
-      ])
+      before 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([
+          json_test_file_a_path,
+          json_test_file_b_path
+        ])
+
+        expect(File).to receive(:read).with(json_test_file_a_path).and_return(json_test_file_a.to_json)
+        expect(File).to receive(:read).with(json_test_file_b_path).and_return(json_test_file_b.to_json)
+      end
+
+      it 'creates build subset for 2 recorded test files timing' do
+        expect(described_class).to receive(:create_build_subset).with(
+          json_test_file_a + json_test_file_b
+        )
 
-      expect(File).to receive(:read).with(json_test_file_a_path).and_return(json_test_file_a.to_json)
-      expect(File).to receive(:read).with(json_test_file_b_path).and_return(json_test_file_b.to_json)
+        subject
+      end
     end
 
-    it do
-      expect(described_class).to receive(:create_build_subset).with(
-        json_test_file_a + json_test_file_b
-      )
+    context 'when json files with recorded time does not exist for executed test files' do
+      let(:executed_test_files_count) { 2 }
 
-      subject
+      subject { described_class.save_node_queue_to_api(executed_test_files_count) }
+
+      before 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([])
+      end
+
+      it 'logs error on lost info about recorded timing for test files due missing json files AND creates empty build subset' do
+        logger = instance_double(Logger)
+        expect(KnapsackPro).to receive(:logger).and_return(logger)
+        expect(logger).to receive(:error).with('2 test files were executed on this CI node but the recorded time of it was lost. 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. 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(described_class).to receive(:create_build_subset).with([])
+
+        subject
+      end
+    end
+
+    context 'when json files with recorded time does not exist AND no executed test files' do
+      let(:executed_test_files_count) { 0 }
+
+      subject { described_class.save_node_queue_to_api(executed_test_files_count) }
+
+      before 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([])
+      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(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 testes should be executed here.")
+
+        expect(described_class).to receive(:create_build_subset).with([])
+
+        subject
+      end
     end
   end
 

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

@@ -161,7 +161,7 @@ describe KnapsackPro::Runners::Queue::MinitestRunner do
 
       it 'returns exit code 0' do
         expect(KnapsackPro::Hooks::Queue).to receive(:call_after_queue)
-        expect(KnapsackPro::Report).to receive(:save_node_queue_to_api)
+        expect(KnapsackPro::Report).to receive(:save_node_queue_to_api).with(0)
 
         expect(subject).to eq({
           status: :completed,

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

@@ -203,7 +203,7 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
           expect(KnapsackPro::Formatters::RSpecQueueProfileFormatterExtension).to receive(:print_summary)
 
           expect(KnapsackPro::Hooks::Queue).to receive(:call_after_queue)
-          expect(KnapsackPro::Report).to receive(:save_node_queue_to_api)
+          expect(KnapsackPro::Report).to receive(:save_node_queue_to_api).with(1)
 
           expect(subject).to eq({
             status: :completed,
@@ -217,7 +217,7 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
 
         it do
           expect(KnapsackPro::Hooks::Queue).to receive(:call_after_queue)
-          expect(KnapsackPro::Report).to receive(:save_node_queue_to_api)
+          expect(KnapsackPro::Report).to receive(:save_node_queue_to_api).with(0)
 
           expect(subject).to eq({
             status: :completed,

data/spec/knapsack_pro/tracker_spec.rb

@@ -56,8 +56,8 @@ describe KnapsackPro::Tracker do
 
       it { expect(tracker.global_time).to be_within(delta).of(0.3) }
       it { expect(tracker.test_files_with_time.keys.size).to eql 2 }
-      it { expect(tracker.test_files_with_time['a_spec.rb']).to be_within(delta).of(0.1) }
-      it { expect(tracker.test_files_with_time['b_spec.rb']).to be_within(delta).of(0.2) }
+      it { expect(tracker.test_files_with_time['a_spec.rb'][:time_execution]).to be_within(delta).of(0.1) }
+      it { expect(tracker.test_files_with_time['b_spec.rb'][:time_execution]).to be_within(delta).of(0.2) }
       it_behaves_like '#to_a'
     end
 
@@ -81,8 +81,8 @@ describe KnapsackPro::Tracker do
       it { expect(tracker.global_time).to be > 0 }
       it { expect(tracker.global_time).to be_within(delta).of(0) }
       it { expect(tracker.test_files_with_time.keys.size).to eql 2 }
-      it { expect(tracker.test_files_with_time['a_spec.rb']).to be_within(delta).of(0) }
-      it { expect(tracker.test_files_with_time['b_spec.rb']).to be_within(delta).of(0) }
+      it { expect(tracker.test_files_with_time['a_spec.rb'][:time_execution]).to be_within(delta).of(0) }
+      it { expect(tracker.test_files_with_time['b_spec.rb'][:time_execution]).to be_within(delta).of(0) }
       it_behaves_like '#to_a'
     end
 
@@ -97,8 +97,8 @@ describe KnapsackPro::Tracker do
 
       it { expect(tracker.global_time).to eq 0 }
       it { expect(tracker.test_files_with_time.keys.size).to eql 2 }
-      it { expect(tracker.test_files_with_time['a_spec.rb']).to eq 0 }
-      it { expect(tracker.test_files_with_time['b_spec.rb']).to eq 0 }
+      it { expect(tracker.test_files_with_time['a_spec.rb'][:time_execution]).to eq 0 }
+      it { expect(tracker.test_files_with_time['b_spec.rb'][:time_execution]).to eq 0 }
       it_behaves_like '#to_a'
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-13 00:00:00.000000000 Z
+date: 2019-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake