knapsack_pro 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 640a408f0a698ec1f064a7857699aeaf5ec27c72a3b30e96a0dfc80655473549
-  data.tar.gz: b8a305a9e170cf0f015be62a85c0415bfe3ba76c1255122fdc0c1b0c46a8d934
+  metadata.gz: e9136de69ec2946c504045fcc1d87f265d0a72813ca9b08005822a1a3d1204f0
+  data.tar.gz: 84e21fb2cd6a32b8cbdd08f2ca47d8f97613783e6d4aa08fa821c96c98b63cc9
 SHA512:
-  metadata.gz: 7e6ecaf953291bf583006846a3511162f7896f5e0ad374dcf861c8aa99dc017f2d102bf0a85b96133b24afc4a3ce99632aaded1384e853a6cd6c2a7d48c77c0d
-  data.tar.gz: 0350dafb658f2d965bd46728f0f18ae1d3dc0e44639eb1d54969c6f203bdc82f2d7653da63ec71fe7de9fe0013b8faf1e5142ef26dac7b702342f012449b7f6c
+  metadata.gz: 0bc36feebf7c2e4548fdece973557f7babe6ac31b0faf504d1e80fa99a4b472c324eed71b90eb4c2619cc785aca9251fe1124cd179d50e578220778475e9b154
+  data.tar.gz: ecb801b9ad989c9106ccbc74aa421ac4a2fbbc164188eb80bd3a82fc5fdc191ee20365707041c00ffefbe6a6ac6635d6c2e278c3fb10261daa4c8a7c156f32e5

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+### 1.12.0
+
+* Add Queue Mode for Cucumber
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/87
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v1.11.0...v1.12.0
+
 ### 1.11.0
 
 * Add support for `KNAPSACK_PRO_TEST_FILE_LIST` environment variable to run explicitly listed tests

data/README.md

@@ -158,6 +158,7 @@ You can see list of questions for common problems and tips in below [Table of Co
       - [How to use junit formatter with knapsack_pro queue mode?](#how-to-use-junit-formatter-with-knapsack_pro-queue-mode)
         - [How to use junit formatter with knapsack_pro queue mode when CI nodes use common local drive?](#how-to-use-junit-formatter-with-knapsack_pro-queue-mode-when-ci-nodes-use-common-local-drive)
         - [Why `tmp/rspec_final_results.xml` is corrupted when I use junit formatter with knapsack_pro queue mode?](#why-tmprspec_final_resultsxml-is-corrupted-when-i-use-junit-formatter-with-knapsack_pro-queue-mode)
+        - [How to use junit formatter with knapsack_pro queue mode in Cucumber?](#how-to-use-junit-formatter-with-knapsack_pro-queue-mode-in-cucumber)
     - [How to use JSON formatter for RSpec?](#how-to-use-json-formatter-for-rspec)
       - [How to use RSpec JSON formatter with knapsack_pro Queue Mode?](#how-to-use-rspec-json-formatter-with-knapsack_pro-queue-mode)
         - [How to use RSpec JSON formatter with knapsack_pro Queue Mode when CI nodes use common local drive?](#how-to-use-rspec-json-formatter-with-knapsack_pro-queue-mode-when-ci-nodes-use-common-local-drive)
@@ -165,6 +166,7 @@ You can see list of questions for common problems and tips in below [Table of Co
     - [What is optimal order of test commands?](#what-is-optimal-order-of-test-commands)
     - [How to set `before(:suite)` and `after(:suite)` RSpec hooks in Queue Mode (Percy.io example)?](#how-to-set-beforesuite-and-aftersuite-rspec-hooks-in-queue-mode-percyio-example)
     - [How to call `before(:suite)` and `after(:suite)` RSpec hooks only once in Queue Mode?](#how-to-call-beforesuite-and-aftersuite-rspec-hooks-only-once-in-queue-mode)
+    - [What hooks are supported in Queue Mode?](#what-hooks-are-supported-in-queue-mode)
     - [How to run knapsack_pro with parallel_tests gem?](#how-to-run-knapsack_pro-with-parallel_tests-gem)
       - [parallel_tests with knapsack_pro on parallel CI nodes](#parallel_tests-with-knapsack_pro-on-parallel-ci-nodes)
       - [parallel_tests with knapsack_pro on single CI machine](#parallel_tests-with-knapsack_pro-on-single-ci-machine)
@@ -175,8 +177,8 @@ You can see list of questions for common problems and tips in below [Table of Co
     - [How to run only RSpec feature tests or non feature tests?](#how-to-run-only-rspec-feature-tests-or-non-feature-tests)
     - [How to exclude tests from running them?](#how-to-exclude-tests-from-running-them)
     - [How to run a specific list of test files or only some tests from test file?](#how-to-run-a-specific-list-of-test-files-or-only-some-tests-from-test-file)
-    - [How to use CodeClimate with knapsack_pro?](#how-to-use-codeclimate-with-knapsack_pro)
     - [How to run knapsack_pro only on a few parallel CI nodes instead of all?](#how-to-run-knapsack_pro-only-on-a-few-parallel-ci-nodes-instead-of-all)
+    - [How to use CodeClimate with knapsack_pro?](#how-to-use-codeclimate-with-knapsack_pro)
     - [How to use simplecov in Queue Mode?](#how-to-use-simplecov-in-queue-mode)
     - [Do I need to use separate API token for Queue Mode and Regular Mode?](#do-i-need-to-use-separate-api-token-for-queue-mode-and-regular-mode)
     - [How to stop running tests on the first failed test (fail fast tests in RSpec)?](#how-to-stop-running-tests-on-the-first-failed-test-fail-fast-tests-in-rspec)
@@ -437,9 +439,12 @@ See how it works and what problems can be solved with Queue Mode https://youtu.b
 
 ### How to use queue mode?
 
-Please use a separate API token for queue mode from one used already for regular mode.
+Please don't use the same API token to run tests in Regular Mode and Queue Mode at the same time for your daily work.
 
-Use this command to run queue mode:
+Only when you setup your project for the first time use the same API token and please record whole test suite with Regular Mode then change knapsack pro command to Queue Mode and keep using the same API token.
+Thanks to that your first CI build run in Queue Mode will use timing data recorded with Regular Mode to run tests in Queue Mode faster for the very first run.
+
+Use this command to run Queue Mode:
 
 ```bash
 # RSpec >= 3.x
@@ -447,16 +452,19 @@ bundle exec rake knapsack_pro:queue:rspec
 
 # Minitest
 bundle exec rake knapsack_pro:queue:minitest
+
+# Cucumber
+bundle exec rake knapsack_pro:queue:cucumber
 ```
 
-If the above command fails then you may need to explicitly pass an argument to require the `rails_helper` file or `spec_helper` in case you are not doing this in some of your test files:
+If the above command fails for RSpec then you may need to explicitly pass an argument to require the `rails_helper` file or `spec_helper` in case you are not doing this in some of your test files:
 
 ```bash
 bundle exec rake "knapsack_pro:queue:rspec[--require rails_helper]"
 ```
 
-Note: when you run queue mode command for the first time it might be slower.
-The second build should have a more optimal test suite split.
+Note: when you run Queue Mode command for the first time without recording tests first in Regular Mode then CI build might be slower (especially for Cucumber).
+The second CI build should have optimal test suite split with faster tests distribution across CI nodes in Queue Mode.
 
 __Please ensure you have explicitly set `RAILS_ENV=test` on your CI nodes.__
 
@@ -544,6 +552,7 @@ At this moment the queue mode works for:
 
 * RSpec
 * Minitest
+* Cucumber
 
 ## Extra configuration for CI server
 
@@ -668,6 +677,7 @@ You can install knapsack_pro globally and use binary. For instance:
 knapsack_pro rspec "--tag custom_tag_name --profile"
 knapsack_pro queue:rspec "--tag custom_tag_name --profile"
 knapsack_pro cucumber "--name feature"
+knapsack_pro queue:cucumber "--name feature"
 knapsack_pro minitest "--verbose --pride"
 knapsack_pro queue:minitest "--verbose"
 knapsack_pro test_unit "--verbose"
@@ -801,6 +811,13 @@ Here is another example for CircleCI 2.0 platform.
     # export word is important here!
     export RAILS_ENV=test
     bundle exec rake "knapsack_pro:queue:minitest[--verbose]"
+
+- run:
+  name: Cucumber via knapsack_pro Queue Mode
+  command: |
+    # export word is important here!
+    export RAILS_ENV=test
+    bundle exec rake knapsack_pro:queue:cucumber
 ```
 
 Please remember to add additional containers for your project in CircleCI settings.
@@ -1064,6 +1081,7 @@ test:
   # Knapsack Pro Queue Mode (dynamic test suite split)
   # bundle exec rake knapsack_pro:queue:rspec
   # bundle exec rake knapsack_pro:queue:minitest
+  # bundle exec rake knapsack_pro:queue:cucumber
 ```
 
 Here you can find info [how to configure the GitLab parallel CI nodes](https://docs.gitlab.com/ee/ci/yaml/#parallel).
@@ -1087,6 +1105,8 @@ test_ci_node_0:
     - export KNAPSACK_PRO_CI_NODE_INDEX=0
     # Cucumber tests in Knapsack Pro Regular Mode (deterministic test suite split)
     - bundle exec rake knapsack_pro:cucumber
+    # or use Cucumber tests in Knapsack Pro Queue Mode (dynamic test suite split)
+    - bundle exec rake knapsack_pro:queue:cucumber
     # RSpec tests in Knapsack Pro Queue Mode (dynamic test suite split)
     # It will autobalance build because it is executed after Cucumber tests.
     - bundle exec rake knapsack_pro:queue:rspec
@@ -1097,6 +1117,7 @@ test_ci_node_1:
   script:
     - export KNAPSACK_PRO_CI_NODE_INDEX=1
     - bundle exec rake knapsack_pro:cucumber
+    - bundle exec rake knapsack_pro:queue:cucumber
     - bundle exec rake knapsack_pro:queue:rspec
 ```
 
@@ -1112,6 +1133,9 @@ Configure test pipelines (1/2 used)
 # Cucumber tests in Knapsack Pro Regular Mode (deterministic test suite split)
 KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 bundle exec rake knapsack_pro:cucumber
 
+# or use Cucumber tests in Knapsack Pro Queue Mode (dynamic test suite split)
+KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 bundle exec rake knapsack_pro:queue:cucumber
+
 # RSpec tests in Knapsack Pro Queue Mode (dynamic test suite split)
 # It will autobalance build because it is executed after Cucumber tests.
 KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 bundle exec rake knapsack_pro:queue:rspec
@@ -1125,6 +1149,9 @@ Configure test pipelines (2/2 used)
 # Cucumber tests in Knapsack Pro Regular Mode (deterministic test suite split)
 KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=1 bundle exec rake knapsack_pro:cucumber
 
+# or use Cucumber tests in Knapsack Pro Queue Mode (dynamic test suite split)
+KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=1 bundle exec rake knapsack_pro:queue:cucumber
+
 # RSpec tests in Knapsack Pro Queue Mode (dynamic test suite split)
 # It will autobalance build because it is executed after Cucumber tests.
 KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=1 bundle exec rake knapsack_pro:queue:rspec
@@ -2016,6 +2043,15 @@ end
 The `tmp/rspec_final_results.xml` might be corrupted due syntax error in your test suite. First check if your test suite is green.
 Another reason might be that you did not configure the junit formatter as shown in the example for Queue Mode. Please check above 2 questions & answers explaing that.
 
+###### How to use junit formatter with knapsack_pro queue mode in Cucumber?
+
+Please provide in `--out` argument directory path where xml files for each test file will be created. It must be a directory in order to work in Queue Mode because in Queue Mode the Cucumber test runner is executed multiple times.
+Each time for set of tests fetched from Queue so it means multiple xml files will be created in junit format.
+
+```bash
+bundle exec rake "knapsack_pro:queue:cucumber[--format junit --out tmp/test-reports/cucumber/queue_mode/]"
+```
+
 #### How to use JSON formatter for RSpec?
 
 ##### How to use RSpec JSON formatter with knapsack_pro Queue Mode?
@@ -2160,6 +2196,61 @@ KnapsackPro::Hooks::Queue.after_queue do |queue_id|
 end
 ```
 
+#### What hooks are supported in Queue Mode?
+
+* RSpec in knapsack_pro Queue Mode supports hooks:
+
+```ruby
+# spec_helper.rb or rails_helper.rb
+KnapsackPro::Hooks::Queue.before_queue do |queue_id|
+  print 'Before Queue Hook - run before test suite'
+end
+
+# this will be run after set of tests fetched from Queue has been executed
+KnapsackPro::Hooks::Queue.after_subset_queue do |queue_id, subset_queue_id|
+  print 'After Subset Queue Hook - run after subset of test suite'
+end
+
+KnapsackPro::Hooks::Queue.after_queue do |queue_id|
+  print 'After Queue Hook - run after test suite'
+end
+```
+
+* Minitest in knapsack_pro Queue Mode supports hooks:
+
+```ruby
+# test/test_helper.rb
+KnapsackPro::Hooks::Queue.before_queue do |queue_id|
+  print 'Before Queue Hook - run before test suite'
+end
+
+KnapsackPro::Hooks::Queue.after_subset_queue do |queue_id, subset_queue_id|
+  print 'After Subset Queue Hook - run after subset of test suite'
+end
+
+KnapsackPro::Hooks::Queue.after_queue do |queue_id|
+  print 'After Queue Hook - run after test suite'
+end
+```
+
+* Cucumber in knapsack_pro Queue Mode supports hooks:
+
+```ruby
+# features/support/knapsack_pro.rb
+KnapsackPro::Hooks::Queue.before_queue do |queue_id|
+  print 'Before Queue Hook - run before test suite'
+end
+
+KnapsackPro::Hooks::Queue.after_subset_queue do |queue_id, subset_queue_id|
+  print 'After Subset Queue Hook - run after subset of test suite'
+end
+
+# this hook is not supported and won't run
+KnapsackPro::Hooks::Queue.after_queue do |queue_id|
+  print 'After Queue Hook - run after test suite'
+end
+```
+
 #### How to run knapsack_pro with parallel_tests gem?
 
 ##### parallel_tests with knapsack_pro on parallel CI nodes
@@ -2436,12 +2527,6 @@ Note when you set `KNAPSACK_PRO_TEST_FILE_LIST` then below environment variables
 * `KNAPSACK_PRO_TEST_FILE_PATTERN`
 * `KNAPSACK_PRO_TEST_FILE_EXCLUDE_PATTERN`
 
-#### How to use CodeClimate with knapsack_pro?
-
-You can check CodeClimate docs about [parallel tests](https://docs.codeclimate.com/docs/configuring-test-coverage#section-parallel-tests) and [multiple test suites](https://docs.codeclimate.com/docs/configuring-test-coverage#section-multiple-test-suites).
-
-You can also read our article [how to merge CodeClimate reports for parallel jobs (CI nodes)](https://docs.knapsackpro.com/2019/how-to-merge-codeclimate-reports-for-parallel-jobs-ci-nodes).
-
 #### How to run knapsack_pro only on a few parallel CI nodes instead of all?
 
 You may want to run knapsack_pro only on a few CI nodes when you would like to run a different job on other CI nodes.
@@ -2462,6 +2547,12 @@ On the 3rd CI node, you can run other things like linters etc.
 If you would like to check what is the CI node total ENV variable name exposed by your CI provider you can check that in your CI provider environment variables docs
 or preview the [ENV variables that knapsack_pro can read](https://github.com/KnapsackPro/knapsack_pro-ruby/tree/master/lib/knapsack_pro/config/ci) for supported CI providers.
 
+#### How to use CodeClimate with knapsack_pro?
+
+You can check articles about CodeClimate configuration with knapsack_pro gem:
+* [CodeClimate and CircleCI 2.0 parallel builds config for RSpec with SimpleCov and JUnit formatter](https://docs.knapsackpro.com/2019/codeclimate-and-circleci-2-0-parallel-builds-config-for-rspec-with-simplecov-and-junit-formatter)
+* [How to merge CodeClimate reports for parallel jobs (CI nodes) on Semaphore CI 2.0](https://docs.knapsackpro.com/2019/how-to-merge-codeclimate-reports-for-parallel-jobs-ci-nodes).
+
 #### How to use simplecov in Queue Mode?
 
 If you would like to make [simplecov](https://github.com/colszowka/simplecov) gem work with knapsack_pro Queue Mode to correctly track code coverage for parallel CI nodes please do:

data/bin/knapsack_pro

@@ -9,6 +9,7 @@ MAP = {
   'rspec' => KnapsackPro::Runners::RSpecRunner,
   'queue:rspec' => KnapsackPro::Runners::Queue::RSpecRunner,
   'cucumber' => KnapsackPro::Runners::CucumberRunner,
+  'queue:cucumber' => KnapsackPro::Runners::Queue::CucumberRunner,
   'minitest' => KnapsackPro::Runners::MinitestRunner,
   'queue:minitest' => KnapsackPro::Runners::Queue::MinitestRunner,
   'test_unit' => KnapsackPro::Runners::TestUnitRunner,

data/lib/knapsack_pro/adapters/cucumber_adapter.rb

@@ -53,6 +53,25 @@ module KnapsackPro
         end
       end
 
+      def bind_before_queue_hook
+        Around do |object, block|
+          unless ENV['KNAPSACK_PRO_BEFORE_QUEUE_HOOK_CALLED']
+            KnapsackPro::Hooks::Queue.call_before_queue
+            ENV['KNAPSACK_PRO_BEFORE_QUEUE_HOOK_CALLED'] = 'true'
+          end
+          block.call
+        end
+      end
+
+      def bind_queue_mode
+        super
+
+        ::Kernel.at_exit do
+          KnapsackPro::Hooks::Queue.call_after_subset_queue
+          KnapsackPro::Report.save_subset_queue_to_file
+        end
+      end
+
       private
 
       def Around(*tag_expressions, &proc)

data/lib/knapsack_pro/report.rb

@@ -47,7 +47,7 @@ module KnapsackPro
       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("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
 

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

@@ -0,0 +1,96 @@
+module KnapsackPro
+  module Runners
+    module Queue
+      class CucumberRunner < BaseRunner
+        def self.run(args)
+          require 'cucumber/rake/task'
+
+          ENV['KNAPSACK_PRO_TEST_SUITE_TOKEN'] = KnapsackPro::Config::Env.test_suite_token_cucumber
+          ENV['KNAPSACK_PRO_QUEUE_RECORDING_ENABLED'] = 'true'
+          ENV['KNAPSACK_PRO_QUEUE_ID'] = KnapsackPro::Config::EnvGenerator.set_queue_id
+
+          runner = new(KnapsackPro::Adapters::CucumberAdapter)
+
+          accumulator = {
+            status: :next,
+            runner: runner,
+            can_initialize_queue: true,
+            args: 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(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
+          )
+
+          if test_file_paths.empty?
+            KnapsackPro::Hooks::Queue.call_after_queue
+
+            KnapsackPro::Report.save_node_queue_to_api
+
+            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
+
+            KnapsackPro.tracker.reset!
+            KnapsackPro.tracker.set_prerun_tests(test_file_paths)
+
+            all_test_file_paths += test_file_paths
+
+            result_exitstatus = cucumber_run(runner, test_file_paths, args)
+            exitstatus = 1 if result_exitstatus != 0
+
+            # KnapsackPro::Hooks::Queue.call_after_subset_queue
+            # KnapsackPro::Report.save_subset_queue_to_file
+            # are called in adapter: lib/knapsack_pro/adapters/cucumber_adapter.rb
+
+            return {
+              status: :next,
+              runner: runner,
+              can_initialize_queue: false,
+              args: args,
+              exitstatus: exitstatus,
+              all_test_file_paths: all_test_file_paths,
+            }
+          end
+        end
+
+        private
+
+        def self.cucumber_run(runner, test_file_paths, args)
+          stringify_test_file_paths = KnapsackPro::TestFilePresenter.stringify_paths(test_file_paths)
+
+          cmd = %Q[bundle exec cucumber #{args} --require #{runner.test_dir} -- #{stringify_test_file_paths}]
+
+          Kernel.system(cmd)
+
+          # it must be set here so when we call next time above cmd we won't run again:
+          # KnapsackPro::Hooks::Queue.call_before_queue
+          # which is defined in lib/knapsack_pro/adapters/cucumber_adapter.rb
+          ENV['KNAPSACK_PRO_BEFORE_QUEUE_HOOK_CALLED'] = 'true'
+
+          $?.exitstatus
+        end
+      end
+    end
+  end
+end

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '1.11.0'
+  VERSION = '1.12.0'
 end

data/lib/knapsack_pro.rb

@@ -64,6 +64,7 @@ require_relative 'knapsack_pro/runners/test_unit_runner'
 require_relative 'knapsack_pro/runners/spinach_runner'
 require_relative 'knapsack_pro/runners/queue/base_runner'
 require_relative 'knapsack_pro/runners/queue/rspec_runner'
+require_relative 'knapsack_pro/runners/queue/cucumber_runner'
 require_relative 'knapsack_pro/runners/queue/minitest_runner'
 require_relative 'knapsack_pro/crypto/encryptor'
 require_relative 'knapsack_pro/crypto/branch_encryptor'

data/lib/tasks/queue/cucumber.rake

@@ -0,0 +1,9 @@
+require 'knapsack_pro'
+
+namespace :knapsack_pro do
+  namespace :queue do
+    task :cucumber, [:cucumber_args] do |_, args|
+      KnapsackPro::Runners::Queue::CucumberRunner.run(args[:cucumber_args])
+    end
+  end
+end

data/spec/knapsack_pro/adapters/cucumber_adapter_spec.rb

@@ -168,5 +168,52 @@ describe KnapsackPro::Adapters::CucumberAdapter do
         end
       end
     end
+
+    describe '#bind_before_queue_hook' do
+      let(:block) { double }
+      let(:scenario) { double(:scenario) }
+
+      context 'when KNAPSACK_PRO_BEFORE_QUEUE_HOOK_CALLED is not set' do
+        before { stub_const("ENV", {}) }
+
+        it do
+          expect(subject).to receive(:Around).and_yield(scenario, block)
+
+          expect(KnapsackPro::Hooks::Queue).to receive(:call_before_queue)
+          expect(ENV).to receive(:[]=).with('KNAPSACK_PRO_BEFORE_QUEUE_HOOK_CALLED', 'true')
+
+          expect(block).to receive(:call)
+
+          subject.bind_before_queue_hook
+        end
+      end
+
+      context 'when KNAPSACK_PRO_BEFORE_QUEUE_HOOK_CALLED is set' do
+        before { stub_const("ENV", { 'KNAPSACK_PRO_BEFORE_QUEUE_HOOK_CALLED' => 'true' }) }
+
+        it do
+          expect(subject).to receive(:Around).and_yield(scenario, block)
+
+          expect(KnapsackPro::Hooks::Queue).not_to receive(:call_before_queue)
+
+          expect(block).to receive(:call)
+
+          subject.bind_before_queue_hook
+        end
+      end
+    end
+
+    describe '#bind_queue_mode' do
+      it do
+        expect(subject).to receive(:bind_before_queue_hook)
+        expect(subject).to receive(:bind_time_tracker)
+
+        expect(::Kernel).to receive(:at_exit).and_yield
+        expect(KnapsackPro::Hooks::Queue).to receive(:call_after_subset_queue)
+        expect(KnapsackPro::Report).to receive(:save_subset_queue_to_file)
+
+        subject.bind_queue_mode
+      end
+    end
   end
 end

data/spec/knapsack_pro/report_spec.rb

@@ -103,7 +103,7 @@ describe KnapsackPro::Report do
         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('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(

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

@@ -0,0 +1,168 @@
+describe KnapsackPro::Runners::Queue::CucumberRunner do
+  describe '.run' do
+    let(:test_suite_token_cucumber) { 'fake-token' }
+    let(:queue_id) { 'fake-queue-id' }
+    let(:test_dir) { 'fake-features-dir' }
+    let(:runner) do
+      instance_double(described_class, test_dir: test_dir)
+    end
+
+    subject { described_class.run(args) }
+
+    before do
+      expect(described_class).to receive(:require).with('cucumber/rake/task')
+
+      expect(KnapsackPro::Config::Env).to receive(:test_suite_token_cucumber).and_return(test_suite_token_cucumber)
+      expect(KnapsackPro::Config::EnvGenerator).to receive(:set_queue_id).and_return(queue_id)
+
+      expect(ENV).to receive(:[]=).with('KNAPSACK_PRO_TEST_SUITE_TOKEN', test_suite_token_cucumber)
+      expect(ENV).to receive(:[]=).with('KNAPSACK_PRO_QUEUE_RECORDING_ENABLED', 'true')
+      expect(ENV).to receive(:[]=).with('KNAPSACK_PRO_QUEUE_ID', queue_id)
+
+      expect(described_class).to receive(:new).with(KnapsackPro::Adapters::CucumberAdapter).and_return(runner)
+    end
+
+    context 'when args provided' do
+      let(:args) { '--retry 5 --no-strict-flaky' }
+
+      it do
+        expected_exitstatus = 0
+        expected_accumulator = {
+          status: :completed,
+          exitstatus: expected_exitstatus
+        }
+        accumulator = {
+          status: :next,
+          runner: runner,
+          can_initialize_queue: true,
+          args: 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)
+
+        subject
+      end
+    end
+
+    context 'when args not provided' do
+      let(:args) { nil }
+
+      it do
+        expected_exitstatus = 0
+        expected_accumulator = {
+          status: :completed,
+          exitstatus: expected_exitstatus
+        }
+        accumulator = {
+          status: :next,
+          runner: runner,
+          can_initialize_queue: true,
+          args: nil,
+          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)
+
+        subject
+      end
+    end
+  end
+
+  describe '.run_tests' do
+    let(:test_dir) { 'fake-features-dir' }
+    let(:runner) do
+      instance_double(described_class, test_dir: test_dir)
+    end
+    let(:can_initialize_queue) { double(:can_initialize_queue) }
+    let(:args) { '--retry 5 --no-strict-flaky' }
+    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(accumulator) }
+
+    before do
+      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
+      let(:test_file_paths) { ['features/a.feature', 'features/b.feature'] }
+
+      before do
+        subset_queue_id = 'fake-subset-queue-id'
+        expect(KnapsackPro::Config::EnvGenerator).to receive(:set_subset_queue_id).and_return(subset_queue_id)
+
+        expect(ENV).to receive(:[]=).with('KNAPSACK_PRO_SUBSET_QUEUE_ID', subset_queue_id)
+
+        tracker = instance_double(KnapsackPro::Tracker)
+        expect(KnapsackPro).to receive(:tracker).twice.and_return(tracker)
+        expect(tracker).to receive(:reset!)
+        expect(tracker).to receive(:set_prerun_tests).with(test_file_paths)
+
+        # .cucumber_run
+        expect(Kernel).to receive(:system).with('bundle exec cucumber --retry 5 --no-strict-flaky --require fake-features-dir -- "features/a.feature" "features/b.feature"')
+
+        expect(ENV).to receive(:[]=).with('KNAPSACK_PRO_BEFORE_QUEUE_HOOK_CALLED', 'true')
+
+        expect($?).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,
+          })
+        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 test files don't exist" do
+      let(:test_file_paths) { [] }
+
+      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(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: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-17 00:00:00.000000000 Z
+date: 2019-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -270,6 +270,7 @@ files:
 - lib/knapsack_pro/runners/cucumber_runner.rb
 - lib/knapsack_pro/runners/minitest_runner.rb
 - lib/knapsack_pro/runners/queue/base_runner.rb
+- lib/knapsack_pro/runners/queue/cucumber_runner.rb
 - lib/knapsack_pro/runners/queue/minitest_runner.rb
 - lib/knapsack_pro/runners/queue/rspec_runner.rb
 - lib/knapsack_pro/runners/rspec_runner.rb
@@ -288,6 +289,7 @@ files:
 - lib/tasks/encrypted_branch_names.rake
 - lib/tasks/encrypted_test_file_names.rake
 - lib/tasks/minitest.rake
+- lib/tasks/queue/cucumber.rake
 - lib/tasks/queue/minitest.rake
 - lib/tasks/queue/rspec.rake
 - lib/tasks/rspec.rake
@@ -349,6 +351,7 @@ files:
 - spec/knapsack_pro/runners/cucumber_runner_spec.rb
 - spec/knapsack_pro/runners/minitest_runner_spec.rb
 - spec/knapsack_pro/runners/queue/base_runner_spec.rb
+- spec/knapsack_pro/runners/queue/cucumber_runner_spec.rb
 - spec/knapsack_pro/runners/queue/minitest_runner_spec.rb
 - spec/knapsack_pro/runners/queue/rspec_runner_spec.rb
 - spec/knapsack_pro/runners/rspec_runner_spec.rb
@@ -459,6 +462,7 @@ test_files:
 - spec/knapsack_pro/runners/cucumber_runner_spec.rb
 - spec/knapsack_pro/runners/minitest_runner_spec.rb
 - spec/knapsack_pro/runners/queue/base_runner_spec.rb
+- spec/knapsack_pro/runners/queue/cucumber_runner_spec.rb
 - spec/knapsack_pro/runners/queue/minitest_runner_spec.rb
 - spec/knapsack_pro/runners/queue/rspec_runner_spec.rb
 - spec/knapsack_pro/runners/rspec_runner_spec.rb