knapsack_pro 0.55.1 → 0.55.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4afbe1e45d6ffd55d9607efb2581b3d2b86579fcd45e906d6c21c72c84da44b
-  data.tar.gz: 02455cfa2cf0876f44a71970a2fc4d4da4c4b49966098cffb7666ed3616ce970
+  metadata.gz: 659ee8cc41fe02f9756a80b1df0611052ef20132cb64afc909d050c3c438e5f0
+  data.tar.gz: 9c5f97c7a0606a936512542aea04d84aa21e23806215cdbba0445651eef354e2
 SHA512:
-  metadata.gz: 550f293d96680b1834ad29cf6ac6d44436d30333df2e90d4dcbc452a97a9bf0a1e07cdae624a6197d5eb13339727c9e6ba99301e562d6b1df8f8e94ab8ea01e4
-  data.tar.gz: 25966fbfc769750abcdbb75ff9884c6b0976c67729295c87ad2ce42b5187acafe053a795c6b3d98e5610a1071478d8e85e46240f9ec2336476684de9265b7272
+  metadata.gz: e48213d6111290298b56a7ada4621144279dc6b6e5e435e244c6a65a3f159b5e34297183803341b009a86c09acbe4827e8c9879a87e25f9a494fb5fb5af6d43d
+  data.tar.gz: aef93bd34c521290ec5096754b4cd1b531a9e5da828d48237b78d635e1771c63604b4dad88b5808808059fac9da407cddb679e76f219c4359483a1558b6f53e0

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 * TODO
 
+### 0.55.2
+
+* Remove recursion in Queue Mode
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/64
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v0.55.1...v0.55.2
+
 ### 0.55.1
 
 * Switch to fallback mode when failed to open TCP connection to API

data/README.md

@@ -215,7 +215,7 @@ end
 
 # add below when you hook into webmock
 require 'webmock/rspec'
-WebMock.disable_net_connect!(:allow => ['api.knapsackpro.com'])
+WebMock.disable_net_connect!(allow: ['api.knapsackpro.com'])
 
 # add below when you use FakeWeb
 require 'fakeweb'
@@ -745,6 +745,7 @@ Here you can read how to configure [junit formatter](#how-to-use-junit-formatter
 # spec_helper.rb or rails_helper.rb
 
 # TODO This must be the same path as value for rspec --out argument
+# Note the path should not contain sign ~, for instance path ~/project/tmp/rspec.xml may not work. Please use full path instead.
 TMP_RSPEC_XML_REPORT = 'tmp/rspec.xml'
 # move results to FINAL_RSPEC_XML_REPORT so the results won't accumulate with duplicated xml tags in TMP_RSPEC_XML_REPORT
 FINAL_RSPEC_XML_REPORT = 'tmp/rspec_final_results.xml'
@@ -1444,6 +1445,7 @@ The xml report will contain all tests executed across intermediate test subset r
     # spec_helper.rb or rails_helper.rb
 
     # TODO This must be the same path as value for rspec --out argument
+    # Note the path should not contain sign ~, for instance path ~/project/tmp/rspec.xml may not work. Please use full path instead.
     TMP_RSPEC_XML_REPORT = 'tmp/rspec.xml'
     # move results to FINAL_RSPEC_XML_REPORT so the results won't accumulate with duplicated xml tags in TMP_RSPEC_XML_REPORT
     FINAL_RSPEC_XML_REPORT = 'tmp/rspec_final_results.xml'
@@ -1472,6 +1474,7 @@ In below code we use CI node index number in `TMP_RSPEC_XML_REPORT` and `FINAL_R
 # spec_helper.rb or rails_helper.rb
 
 # TODO This must be the same path as value for rspec --out argument
+# Note the path should not contain sign ~, for instance path ~/project/tmp/rspec.xml may not work. Please use full path instead.
 TMP_RSPEC_XML_REPORT = "tmp/rspec_#{ENV['KNAPSACK_PRO_CI_NODE_INDEX']}.xml"
 # move results to FINAL_RSPEC_XML_REPORT so the results won't accumulate with duplicated xml tags in TMP_RSPEC_XML_REPORT
 FINAL_RSPEC_XML_REPORT = "tmp/rspec_final_results_#{ENV['KNAPSACK_PRO_CI_NODE_INDEX']}.xml"

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

@@ -17,10 +17,29 @@ module KnapsackPro
           $LOAD_PATH.unshift(runner.test_dir)
 
           cli_args = (args || '').split
-          run_tests(runner, true, cli_args, 0, [])
+
+          accumulator = {
+            status: :next,
+            runner: runner,
+            can_initialize_queue: true,
+            args: cli_args,
+            exitstatus: 0,
+            all_test_file_paths: [],
+          }
+          while accumulator[:status] == :next
+            accumulator = run_tests(accumulator)
+          end
+
+          Kernel.exit(accumulator[:exitstatus])
         end
 
-        def self.run_tests(runner, can_initialize_queue, args, exitstatus, all_test_file_paths)
+        def self.run_tests(accumulator)
+          runner = accumulator.fetch(:runner)
+          can_initialize_queue = accumulator.fetch(:can_initialize_queue)
+          args = accumulator.fetch(:args)
+          exitstatus = accumulator.fetch(:exitstatus)
+          all_test_file_paths = accumulator.fetch(:all_test_file_paths)
+
           test_file_paths = runner.test_file_paths(
             can_initialize_queue: can_initialize_queue,
             executed_test_files: all_test_file_paths
@@ -30,7 +49,11 @@ module KnapsackPro
             KnapsackPro::Hooks::Queue.call_after_queue
 
             KnapsackPro::Report.save_node_queue_to_api
-            exit(exitstatus)
+
+            return {
+              status: :completed,
+              exitstatus: exitstatus,
+            }
           else
             subset_queue_id = KnapsackPro::Config::EnvGenerator.set_subset_queue_id
             ENV['KNAPSACK_PRO_SUBSET_QUEUE_ID'] = subset_queue_id
@@ -46,7 +69,14 @@ module KnapsackPro
 
             KnapsackPro::Report.save_subset_queue_to_file
 
-            run_tests(runner, false, args, exitstatus, all_test_file_paths)
+            return {
+              status: :next,
+              runner: runner,
+              can_initialize_queue: false,
+              args: args,
+              exitstatus: exitstatus,
+              all_test_file_paths: all_test_file_paths,
+            }
           end
         end
 

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

@@ -21,10 +21,29 @@ module KnapsackPro
             '--format', KnapsackPro::Formatters::RSpecQueueSummaryFormatter.to_s,
             '--default-path', runner.test_dir,
           ]
-          run_tests(runner, true, cli_args, 0, [])
+
+          accumulator = {
+            status: :next,
+            runner: runner,
+            can_initialize_queue: true,
+            args: cli_args,
+            exitstatus: 0,
+            all_test_file_paths: [],
+          }
+          while accumulator[:status] == :next
+            accumulator = run_tests(accumulator)
+          end
+
+          Kernel.exit(accumulator[:exitstatus])
         end
 
-        def self.run_tests(runner, can_initialize_queue, args, exitstatus, all_test_file_paths)
+        def self.run_tests(accumulator)
+          runner = accumulator.fetch(:runner)
+          can_initialize_queue = accumulator.fetch(:can_initialize_queue)
+          args = accumulator.fetch(:args)
+          exitstatus = accumulator.fetch(:exitstatus)
+          all_test_file_paths = accumulator.fetch(:all_test_file_paths)
+
           test_file_paths = runner.test_file_paths(
             can_initialize_queue: can_initialize_queue,
             executed_test_files: all_test_file_paths
@@ -41,7 +60,11 @@ module KnapsackPro
             KnapsackPro::Hooks::Queue.call_after_queue
 
             KnapsackPro::Report.save_node_queue_to_api
-            exit(exitstatus)
+
+            return {
+              status: :completed,
+              exitstatus: exitstatus,
+            }
           else
             subset_queue_id = KnapsackPro::Config::EnvGenerator.set_subset_queue_id
             ENV['KNAPSACK_PRO_SUBSET_QUEUE_ID'] = subset_queue_id
@@ -59,7 +82,14 @@ module KnapsackPro
 
             KnapsackPro::Hooks::Queue.call_after_subset_queue
 
-            run_tests(runner, false, args, exitstatus, all_test_file_paths)
+            return {
+              status: :next,
+              runner: runner,
+              can_initialize_queue: false,
+              args: args,
+              exitstatus: exitstatus,
+              all_test_file_paths: all_test_file_paths,
+            }
           end
         end
 

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '0.55.1'
+  VERSION = '0.55.2'
 end

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

@@ -28,10 +28,24 @@ describe KnapsackPro::Runners::Queue::MinitestRunner do
       let(:args) { '--verbose --pride' }
 
       it do
-        result = double
-        expect(described_class).to receive(:run_tests).with(runner, true, ['--verbose', '--pride'], 0, []).and_return(result)
+        expected_exitstatus = 0
+        expected_accumulator = {
+          status: :completed,
+          exitstatus: expected_exitstatus
+        }
+        accumulator = {
+          status: :next,
+          runner: runner,
+          can_initialize_queue: true,
+          args: ['--verbose', '--pride'],
+          exitstatus: 0,
+          all_test_file_paths: [],
+        }
+        expect(described_class).to receive(:run_tests).with(accumulator).and_return(expected_accumulator)
+
+        expect(Kernel).to receive(:exit).with(expected_exitstatus)
 
-        expect(subject).to eq result
+        subject
       end
     end
 
@@ -39,10 +53,24 @@ describe KnapsackPro::Runners::Queue::MinitestRunner do
       let(:args) { nil }
 
       it do
-        result = double
-        expect(described_class).to receive(:run_tests).with(runner, true, [], 0, []).and_return(result)
+        expected_exitstatus = 0
+        expected_accumulator = {
+          status: :completed,
+          exitstatus: expected_exitstatus
+        }
+        accumulator = {
+          status: :next,
+          runner: runner,
+          can_initialize_queue: true,
+          args: [],
+          exitstatus: 0,
+          all_test_file_paths: [],
+        }
+        expect(described_class).to receive(:run_tests).with(accumulator).and_return(expected_accumulator)
+
+        expect(Kernel).to receive(:exit).with(expected_exitstatus)
 
-        expect(subject).to eq result
+        subject
       end
     end
   end
@@ -52,11 +80,21 @@ describe KnapsackPro::Runners::Queue::MinitestRunner do
     let(:can_initialize_queue) { double(:can_initialize_queue) }
     let(:args) { ['--verbose', '--pride'] }
     let(:exitstatus) { 0 }
+    let(:all_test_file_paths) { [] }
+    let(:accumulator) do
+      {
+        runner: runner,
+        can_initialize_queue: can_initialize_queue,
+        args: args,
+        exitstatus: exitstatus,
+        all_test_file_paths: all_test_file_paths,
+      }
+    end
 
-    subject { described_class.run_tests(runner, can_initialize_queue, args, exitstatus, []) }
+    subject { described_class.run_tests(accumulator) }
 
     before do
-      expect(runner).to receive(:test_file_paths).with(can_initialize_queue: can_initialize_queue, executed_test_files: []).and_return(test_file_paths)
+      expect(runner).to receive(:test_file_paths).with(can_initialize_queue: can_initialize_queue, executed_test_files: all_test_file_paths).and_return(test_file_paths)
     end
 
     context 'when test files exist' do
@@ -82,20 +120,20 @@ describe KnapsackPro::Runners::Queue::MinitestRunner do
         expect(KnapsackPro::Hooks::Queue).to receive(:call_after_subset_queue)
 
         expect(KnapsackPro::Report).to receive(:save_subset_queue_to_file)
-
-        # second call of run_tests because of recursion
-        expect(runner).to receive(:test_file_paths).with(can_initialize_queue: false, executed_test_files: ['a_test.rb', 'b_test.rb']).and_return([])
       end
 
       context 'when tests are passing' do
         let(:is_tests_green) { true }
 
         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(described_class).to receive(:exit).with(0)
-
-          subject
+          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
 
@@ -103,11 +141,14 @@ describe KnapsackPro::Runners::Queue::MinitestRunner do
         let(:is_tests_green) { false }
 
         it 'returns exit code 1' do
-          expect(KnapsackPro::Hooks::Queue).to receive(:call_after_queue)
-          expect(KnapsackPro::Report).to receive(:save_node_queue_to_api)
-          expect(described_class).to receive(:exit).with(1)
-
-          subject
+          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
@@ -118,9 +159,11 @@ 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(described_class).to receive(:exit).with(0)
 
-        subject
+        expect(subject).to eq({
+          status: :completed,
+          exitstatus: exitstatus,
+        })
       end
     end
   end

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

@@ -34,10 +34,24 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
         let(:args) { '--example-arg example-value' }
 
         it 'uses default formatter progress' do
-          result = double
-          expect(described_class).to receive(:run_tests).with(runner, true, ['--example-arg', 'example-value', '--format', 'progress', '--format', 'KnapsackPro::Formatters::RSpecQueueSummaryFormatter', '--default-path', 'fake-test-dir'], 0, []).and_return(result)
+          expected_exitstatus = 0
+          expected_accumulator = {
+            status: :completed,
+            exitstatus: expected_exitstatus
+          }
+          accumulator = {
+            status: :next,
+            runner: runner,
+            can_initialize_queue: true,
+            args: ['--example-arg', 'example-value', '--format', 'progress', '--format', 'KnapsackPro::Formatters::RSpecQueueSummaryFormatter', '--default-path', 'fake-test-dir'],
+            exitstatus: 0,
+            all_test_file_paths: [],
+          }
+          expect(described_class).to receive(:run_tests).with(accumulator).and_return(expected_accumulator)
+
+          expect(Kernel).to receive(:exit).with(expected_exitstatus)
 
-          expect(subject).to eq result
+          subject
         end
       end
 
@@ -45,10 +59,24 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
         let(:args) { '--format documentation' }
 
         it 'uses provided format param instead of default formatter progress' do
-          result = double
-          expect(described_class).to receive(:run_tests).with(runner, true, ['--format', 'documentation', '--format', 'KnapsackPro::Formatters::RSpecQueueSummaryFormatter', '--default-path', 'fake-test-dir'], 0, []).and_return(result)
+          expected_exitstatus = 0
+          expected_accumulator = {
+            status: :completed,
+            exitstatus: expected_exitstatus
+          }
+          accumulator = {
+            status: :next,
+            runner: runner,
+            can_initialize_queue: true,
+            args: ['--format', 'documentation', '--format', 'KnapsackPro::Formatters::RSpecQueueSummaryFormatter', '--default-path', 'fake-test-dir'],
+            exitstatus: 0,
+            all_test_file_paths: [],
+          }
+          expect(described_class).to receive(:run_tests).with(accumulator).and_return(expected_accumulator)
+
+          expect(Kernel).to receive(:exit).with(expected_exitstatus)
 
-          expect(subject).to eq result
+          subject
         end
       end
     end
@@ -57,10 +85,24 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
       let(:args) { nil }
 
       it do
-        result = double
-        expect(described_class).to receive(:run_tests).with(runner, true, ['--format', 'progress', '--format', 'KnapsackPro::Formatters::RSpecQueueSummaryFormatter', '--default-path', 'fake-test-dir'], 0, []).and_return(result)
+        expected_exitstatus = 0
+        expected_accumulator = {
+          status: :completed,
+          exitstatus: expected_exitstatus
+        }
+        accumulator = {
+          status: :next,
+          runner: runner,
+          can_initialize_queue: true,
+          args: ['--format', 'progress', '--format', 'KnapsackPro::Formatters::RSpecQueueSummaryFormatter', '--default-path', 'fake-test-dir'],
+          exitstatus: 0,
+          all_test_file_paths: [],
+        }
+        expect(described_class).to receive(:run_tests).with(accumulator).and_return(expected_accumulator)
+
+        expect(Kernel).to receive(:exit).with(expected_exitstatus)
 
-        expect(subject).to eq result
+        subject
       end
     end
   end
@@ -70,11 +112,21 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
     let(:can_initialize_queue) { double(:can_initialize_queue) }
     let(:args) { ['--example-arg', 'example-value', '--default-path', 'fake-test-dir'] }
     let(:exitstatus) { double }
+    let(:all_test_file_paths) { [] }
+    let(:accumulator) do
+      {
+        runner: runner,
+        can_initialize_queue: can_initialize_queue,
+        args: args,
+        exitstatus: exitstatus,
+        all_test_file_paths: all_test_file_paths,
+      }
+    end
 
-    subject { described_class.run_tests(runner, can_initialize_queue, args, exitstatus, []) }
+    subject { described_class.run_tests(accumulator) }
 
     before do
-      expect(runner).to receive(:test_file_paths).with(can_initialize_queue: can_initialize_queue, executed_test_files: []).and_return(test_file_paths)
+      expect(runner).to receive(:test_file_paths).with(can_initialize_queue: can_initialize_queue, executed_test_files: all_test_file_paths).and_return(test_file_paths)
     end
 
     context 'when test files exist' do
@@ -100,49 +152,71 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
         expect(described_class).to receive(:rspec_clear_examples)
 
         expect(KnapsackPro::Hooks::Queue).to receive(:call_after_subset_queue)
-
-        # second call of run_tests because of recursion
-        expect(runner).to receive(:test_file_paths).with(can_initialize_queue: false, executed_test_files: ['a_spec.rb', 'b_spec.rb']).and_return([])
       end
 
       context 'when exit code is zero' do
         let(:exit_code) { 0 }
 
         it do
-          expect(KnapsackPro::Formatters::RSpecQueueSummaryFormatter).to receive(:print_summary)
-          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(described_class).to receive(:exit).with(exitstatus)
-
-          subject
+          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 exit code is not zero' do
         let(:exit_code) { double }
 
+        it do
+          expect(subject).to eq({
+            status: :next,
+            runner: runner,
+            can_initialize_queue: false,
+            args: args,
+            exitstatus: exit_code,
+            all_test_file_paths: test_file_paths,
+          })
+        end
+      end
+    end
+
+    context "when test files don't exist" do
+      let(:test_file_paths) { [] }
+
+      context 'when all_test_file_paths exist' do
+        let(:all_test_file_paths) { ['a_spec.rb'] }
+
         it do
           expect(KnapsackPro::Formatters::RSpecQueueSummaryFormatter).to receive(:print_summary)
           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(described_class).to receive(:exit).with(exit_code)
 
-          subject
+          expect(subject).to eq({
+            status: :completed,
+            exitstatus: exitstatus,
+          })
         end
       end
-    end
 
-    context "when test files don't exist" do
-      let(:test_file_paths) { [] }
+      context "when all_test_file_paths don't exist" do
+        let(:all_test_file_paths) { [] }
 
-      it do
-        expect(KnapsackPro::Hooks::Queue).to receive(:call_after_queue)
-        expect(KnapsackPro::Report).to receive(:save_node_queue_to_api)
-        expect(described_class).to receive(:exit).with(exitstatus)
+        it do
+          expect(KnapsackPro::Hooks::Queue).to receive(:call_after_queue)
+          expect(KnapsackPro::Report).to receive(:save_node_queue_to_api)
 
-        subject
+          expect(subject).to eq({
+            status: :completed,
+            exitstatus: exitstatus,
+          })
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 0.55.1
+  version: 0.55.2
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-20 00:00:00.000000000 Z
+date: 2018-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake