knapsack_pro 1.10.0 → 1.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15d64502a63c7087b4d8793ad780d0f7454d2414c93c0da46967e20620578fe0
-  data.tar.gz: 88addd61d85b84f2fc043ff17e554564d95b40be262fe55a51714efa5ae4f719
+  metadata.gz: fb705b44a624bdd6caa055a2caee16cb3ebcf4f9a15a1cc718b5f6a2f03f89ce
+  data.tar.gz: 6155ff3b7f0bf3d96f12dbad0009499eb02953d0415e48c1bcaf2c3ffbf94027
 SHA512:
-  metadata.gz: 67664f1170199a4f5f6cb2fbabdfd15fbebd2c73d04a0646bacdc20411411722f5b7b0946d8a76417150fcbe60211b13b97f27a09ca10840a44caaea8beccb0a
-  data.tar.gz: d835f28e6af4885f42e6daa218caace7401f1ab9e406d1f8a4c06af6f20ad671e37b8501e35aceaea41183d94d56feec462badb86747053843b7a1957ec64867
+  metadata.gz: 0e02c5b22c2a3a4261dd5cf75dce2a8bdeb086254df40166f38758766fcbfcb4c9c68aa3fb76ef748eab4db668a782ea7af2d4313bbf2e71491ada6af87cf320
+  data.tar.gz: 1d57f7e37be0f0d43c4b13e3cdcbcda612dce17ed9cb4854dca5e1d75d0e310ebc49cb2939476cca1eca275e565db597c3e82f7b3e1c8705c0f41afce887b570

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+### 1.10.1
+
+* Fix log info when measured time of tests was lost
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/85
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v1.10.0...v1.10.1
+
 ### 1.10.0
 
 * Logs error on lost info about recorded timing for test files due to missing json files in Queue Mode

data/lib/knapsack_pro/report.rb

@@ -27,7 +27,7 @@ module KnapsackPro
       end
     end
 
-    def self.save_node_queue_to_api(executed_test_files_count)
+    def self.save_node_queue_to_api
       test_files = []
       Dir.glob("#{queue_path}/*.json").each do |file|
         report = JSON.parse(File.read(file))
@@ -35,15 +35,20 @@ module KnapsackPro
       end
 
       if test_files.empty?
-        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
+        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
+
+      measured_test_files = test_files
+        .map { |t| t['time_execution'] }
+        .select { |time_execution| time_execution != KnapsackPro::Tracker::DEFAULT_TEST_FILE_TIME }
 
-        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
+      if test_files.size > 0 && measured_test_files.size == 0
+        KnapsackPro.logger.warn("#{test_files.size} test files were executed on this CI node but the recorded time was lost due to:")
+        KnapsackPro.logger.warn("1. 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.")
+        KnapsackPro.logger.warn("2. 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/")
+        KnapsackPro.logger.warn("3. All your tests are empty test files, are pending tests or have syntax error and could not be executed hence no measured time execution by knapsack_pro.")
       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(all_test_file_paths.count)
+            KnapsackPro::Report.save_node_queue_to_api
 
             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(all_test_file_paths.count)
+            KnapsackPro::Report.save_node_queue_to_api
 
             return {
               status: :completed,

data/lib/knapsack_pro/version.rb

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

data/spec/knapsack_pro/report_spec.rb

@@ -43,16 +43,14 @@ describe KnapsackPro::Report do
   end
 
   describe '.save_node_queue_to_api' do
-    context 'when json files with recorded time exist for executed test files' do
+    context 'when json files with recorded time does exist and test files have measured and default time execution' do
       let(:json_test_file_a_path) { double }
-      let(:json_test_file_a) { [{ 'path' => 'a_spec.rb' }] }
+      let(:json_test_file_a) { [{ 'path' => 'a_spec.rb', 'time_execution' => 0.1234 }] }
 
       let(:json_test_file_b_path) { double }
-      let(:json_test_file_b) { [{ 'path' => 'b_spec.rb' }] }
+      let(:json_test_file_b) { [{ 'path' => 'b_spec.rb', 'time_execution' => KnapsackPro::Tracker::DEFAULT_TEST_FILE_TIME }] }
 
-      let(:executed_test_files_count) { 2 }
-
-      subject { described_class.save_node_queue_to_api(executed_test_files_count) }
+      subject { described_class.save_node_queue_to_api }
 
       before do
         queue_id = 'fake-queue-id'
@@ -68,6 +66,8 @@ describe KnapsackPro::Report do
       end
 
       it 'creates build subset for 2 recorded test files timing' do
+        expect(KnapsackPro).not_to receive(:logger)
+
         expect(described_class).to receive(:create_build_subset).with(
           json_test_file_a + json_test_file_b
         )
@@ -76,33 +76,46 @@ describe KnapsackPro::Report do
       end
     end
 
-    context 'when json files with recorded time does not exist for executed test files' do
-      let(:executed_test_files_count) { 2 }
+    context 'when json files with recorded time does exist and all test files have default time execution' do
+      let(:json_test_file_a_path) { double }
+      let(:json_test_file_a) { [{ 'path' => 'a_spec.rb', 'time_execution' => KnapsackPro::Tracker::DEFAULT_TEST_FILE_TIME }] }
+
+      let(:json_test_file_b_path) { double }
+      let(:json_test_file_b) { [{ 'path' => 'b_spec.rb', 'time_execution' => KnapsackPro::Tracker::DEFAULT_TEST_FILE_TIME }] }
 
-      subject { described_class.save_node_queue_to_api(executed_test_files_count) }
+      subject { described_class.save_node_queue_to_api }
 
       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([])
+        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 '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(KnapsackPro).to receive(:logger).exactly(4).and_return(logger)
+        expect(logger).to receive(:warn).with('2 test files were executed on this CI node but the recorded time was lost due to:')
+        expect(logger).to receive(:warn).with('1. 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.')
+        expect(logger).to receive(:warn).with('2. 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(logger).to receive(:warn).with('3. All your tests are empty test files, are pending tests or have syntax error and could not be executed hence no measured time execution by knapsack_pro.')
 
-        expect(described_class).to receive(:create_build_subset).with([])
+        expect(described_class).to receive(:create_build_subset).with(
+          json_test_file_a + json_test_file_b
+        )
 
         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) }
+    context 'when json files with recorded time does not exist' do
+      subject { described_class.save_node_queue_to_api }
 
       before do
         queue_id = 'fake-queue-id'

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).with(0)
+        expect(KnapsackPro::Report).to receive(:save_node_queue_to_api)
 
         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).with(1)
+          expect(KnapsackPro::Report).to receive(:save_node_queue_to_api)
 
           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).with(0)
+          expect(KnapsackPro::Report).to receive(:save_node_queue_to_api)
 
           expect(subject).to eq({
             status: :completed,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.10.1
 platform: ruby
 authors:
 - ArturT