knapsack_pro 1.20.1 → 1.20.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 603cc339299caaeadecbe441f06abc2e8f169d0fa6acb6985dc286a770a120cd
-  data.tar.gz: 73b1e4583dbcc37d99aceeeb4029ffd2899bc3bc398b37278db1de36d92f44cf
+  metadata.gz: 6bbc828d338c810094114953894489db0696b70f013beac451b1c45602c323cd
+  data.tar.gz: ae287454ad0658666d1d0cd85c4eaf91eabe009ee95b05b3a76d719a245395ae
 SHA512:
-  metadata.gz: b5fcb7fd656ec4c9363b91c7b45cefb5b095588c53934fd5b173e68188059342a5d7545b344ec55cecd055917ea8cfb8413a438c453306c7769268d18c9c9f1b
-  data.tar.gz: ac11b94615e74cac40ffc49e5d62cf890f180d19912bc8dd6a13b27721b4286f5c22b0c49dbf2d37ce505e4d7b049393b078375dd4ccbfd7d3a7f1ba044eefb1
+  metadata.gz: f70aca52cc3808f0028d036dd8b5057130cf6610ede948075a293c3165ddf46e44e8fdf922e7457808dca8f390ded887adb5f4c95146a5b925535621b1de7a93
+  data.tar.gz: 32e5fb5098e39fdb93694184b16c26603ca1edcdc193ab1c513ab9cd55800fa2c54157b28b365260d2e2231bd3bea6ffcc5b2b1921c9076ab75e37095433e5ef

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+### 1.20.2
+
+* Raise an error when running Cucumber in Queue Mode and Cucumber system process doesn't finish execution correctly (for instance Cucumber process was killed by CI server due to lack of memory)
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/111
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v1.20.1...v1.20.2
+
 ### 1.20.1
 
 * Fix bug in RSpec split by test examples in < RSpec 3.6.0 (related to custom json formatter)

data/README.md

@@ -597,10 +597,10 @@ At this moment the queue mode works for:
 
 ## Split test files by test cases
 
-__Note:__ this is an experimental feature. It works for Regular Mode and Queue Mode. For large test suite with a few thousand test files, it may generate too many RSpec test example paths that may lead to too large JSON payload in request to Knapsack Pro API and this could trigger the API timeout.
-
-Please give us feedback so we could improve the feature.
-https://knapsackpro.com/contact
+> __Note:__ this is an experimental feature. It works for Regular Mode and Queue Mode. For large test suite with a few thousand test files, it may generate too many RSpec test example paths that may lead to too large JSON payload in request to Knapsack Pro API and this could trigger the API timeout.
+>
+> Please give us feedback so we could improve the feature.
+> https://knapsackpro.com/contact
 
 __How it works__: You can split slow test file by test cases. Thanks to that the test file can be split across parallel CI nodes because test cases from the test file will run on different CI nodes.
 
@@ -608,7 +608,7 @@ This is helpful when you have one or a few very slow test files that are a bottl
 
 ### RSpec split test files by test examples (by individual `it`s)
 
-__Requirement:__ It works with >= RSpec 3.6.0.
+> ❗ __WARNING (known issues):__ This is an experimental feature. We detected edge cases for Queue Mode when test examples might be ignored by RSpec and won't run test. Do not use this feature for production yet. We'll appreciate your [feedback](https://knapsackpro.com/contact) how it works while you test it on a separate branch. We work on improvements.
 
 In order to split RSpec test files by test examples across parallel CI nodes you need to set environment variable:
 

data/lib/knapsack_pro/report.rb

@@ -37,7 +37,7 @@ module KnapsackPro
       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.")
+        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 tests should be executed here.")
       end
 
       measured_test_files = test_files

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

@@ -91,7 +91,16 @@ module KnapsackPro
           # which is defined in lib/knapsack_pro/adapters/cucumber_adapter.rb
           ENV['KNAPSACK_PRO_BEFORE_QUEUE_HOOK_CALLED'] = 'true'
 
-          $?.exitstatus
+          process_status = $?
+
+          unless process_status.exited?
+            raise "Cucumber process execution failed. It's likely that your CI server has exceeded"\
+                    " its available memory. Please try changing CI config or retrying the CI build.\n"\
+                    "Failed command: #{cmd}\n"\
+                    "Process status: #{process_status.inspect}"
+          end
+
+          process_status.exitstatus
         end
       end
     end

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '1.20.1'
+  VERSION = '1.20.2'
 end

data/spec/knapsack_pro/report_spec.rb

@@ -129,7 +129,7 @@ describe KnapsackPro::Report do
         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(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 tests should be executed here.")
 
         expect(described_class).to receive(:create_build_subset).with([])
 

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

@@ -117,36 +117,49 @@ describe KnapsackPro::Runners::Queue::CucumberRunner do
 
         expect(ENV).to receive(:[]=).with('KNAPSACK_PRO_BEFORE_QUEUE_HOOK_CALLED', 'true')
 
-        expect($?).to receive(:exitstatus).and_return(exitstatus)
+        expect($?).to receive(:exited?).and_return(process_exited)
+        allow($?).to receive(:exitstatus).and_return(exitstatus)
       end
 
-      context 'when tests are passing' do
-        let(:exitstatus) { 0 }
-
-        it 'returns exit code 0' do
-          expect(subject).to eq({
-            status: :next,
-            runner: runner,
-            can_initialize_queue: false,
-            args: args,
-            exitstatus: exitstatus,
-            all_test_file_paths: test_file_paths,
-          })
+      context 'when system process finished its work (exited)' do
+        let(:process_exited) { true }
+
+        context 'when tests are passing' do
+          let(:exitstatus) { 0 }
+
+          it 'returns exit code 0' do
+            expect(subject).to eq({
+              status: :next,
+              runner: runner,
+              can_initialize_queue: false,
+              args: args,
+              exitstatus: exitstatus,
+              all_test_file_paths: test_file_paths,
+            })
+          end
+        end
+
+        context 'when tests are failing' do
+          let(:exitstatus) { 1 }
+
+          it 'returns exit code 1' do
+            expect(subject).to eq({
+              status: :next,
+              runner: runner,
+              can_initialize_queue: false,
+              args: args,
+              exitstatus: 1, # tests failed
+              all_test_file_paths: test_file_paths,
+            })
+          end
         end
       end
 
-      context 'when tests are failing' do
-        let(:exitstatus) { 1 }
-
-        it 'returns exit code 1' do
-          expect(subject).to eq({
-            status: :next,
-            runner: runner,
-            can_initialize_queue: false,
-            args: args,
-            exitstatus: 1, # tests failed
-            all_test_file_paths: test_file_paths,
-          })
+      context "when system process didn't finish its work (hasn't exited)" do
+        let(:process_exited) { false }
+
+        it 'raises an error' do
+          expect { subject }.to raise_error(RuntimeError, /^Cucumber process execution failed/)
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 1.20.1
+  version: 1.20.2
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-09 00:00:00.000000000 Z
+date: 2020-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -42,22 +42,22 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.10.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.10.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.10.0
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -410,7 +410,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Knapsack Pro splits tests across parallel CI nodes and ensures each parallel