knapsack_pro 1.12.0 → 1.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9136de69ec2946c504045fcc1d87f265d0a72813ca9b08005822a1a3d1204f0
-  data.tar.gz: 84e21fb2cd6a32b8cbdd08f2ca47d8f97613783e6d4aa08fa821c96c98b63cc9
+  metadata.gz: 74b370cb50a79631e4168dfbc8303ac3efdd5cfb0c34758f6bea4845757dcdbf
+  data.tar.gz: 25cba47e95daef7952743d604b6f48388cb39368deff071d570ec8fe5272c312
 SHA512:
-  metadata.gz: 0bc36feebf7c2e4548fdece973557f7babe6ac31b0faf504d1e80fa99a4b472c324eed71b90eb4c2619cc785aca9251fe1124cd179d50e578220778475e9b154
-  data.tar.gz: ecb801b9ad989c9106ccbc74aa421ac4a2fbbc164188eb80bd3a82fc5fdc191ee20365707041c00ffefbe6a6ac6635d6c2e278c3fb10261daa4c8a7c156f32e5
+  metadata.gz: 74a62e6902ee09d62d5290e815e870dda6abbdd47e1bfdb21bf6a5b95d9dc0625e017ec24704ee71c6760f3762bcd3c6e41338a985919cd8ca32b315fff5757e
+  data.tar.gz: 72e4cd22c704ae1f088b631c7ba5bf1d3f78cc85b8f300daff9b9cb01b09bb3f923c871d88b3ac8c2d6a1d89ea64911288b40e396f3a191b24bb1fbb962cdf54

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change Log
 
+### 1.12.1
+
+* Use `CI_PIPELINE_ID` as build ID for GitLab CI because it is unique across parallel jobs
+* Load GitLab CI first to avoid edge case with order of loading envs for `CI_NODE_INDEX`
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/88
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v1.12.0...v1.12.1
+
 ### 1.12.0
 
 * Add Queue Mode for Cucumber

data/README.md

@@ -121,6 +121,7 @@ You can see list of questions for common problems and tips in below [Table of Co
     - [Why Capybara feature tests randomly fail when using CI parallelisation?](#why-capybara-feature-tests-randomly-fail-when-using-ci-parallelisation)
     - [Why knapsack_pro freezes / hangs my CI (for instance Travis)?](#why-knapsack_pro-freezes--hangs-my-ci-for-instance-travis)
     - [Why tests hitting external API fail?](#why-tests-hitting-external-api-fail)
+    - [Why green test suite for Cucumber 2.99 tests always fails with `invalid option: --require`?](#why-green-test-suite-for-cucumber-299-tests-always-fails-with-invalid-option---require)
     - [Queue Mode problems](#queue-mode-problems)
       - [Why when I use Queue Mode for RSpec then my tests fail?](#why-when-i-use-queue-mode-for-rspec-then-my-tests-fail)
       - [Why when I use Queue Mode for RSpec then FactoryBot/FactoryGirl tests fail?](#why-when-i-use-queue-mode-for-rspec-then-factorybotfactorygirl-tests-fail)
@@ -1459,6 +1460,48 @@ To fix that you can think of:
 * using [VCR](https://github.com/vcr/vcr) gem to record HTTP requests and then instead of doing real HTTP requests just reply recorded requests.
 * maybe you could write your tests in a way when you generate some fake customers or subscriptions with fake id and each test has different customer id so there will be no conflict when 2 tests are run at the same time.
 
+#### Why green test suite for Cucumber 2.99 tests always fails with `invalid option: --require`?
+
+If you use old Cucumber version 2.99 and `cucumber-rails` gem you could notice bug that knapsack_pro for Cucumber fails with `1` exit status. Error you may see:
+
+```
+invalid option: --require
+
+minitest options:
+    -h, --help                       Display this help.
+        --no-plugins                 Bypass minitest plugin auto-loading (or set $MT_NO_PLUGINS).
+    -s, --seed SEED                  Sets random seed. Also via env. Eg: SEED=n rake
+    -v, --verbose                    Verbose. Show progress processing files.
+    -n, --name PATTERN               Filter run on /regexp/ or string.
+        --exclude PATTERN            Exclude /regexp/ or string from run.
+
+Known extensions: rails, pride
+    -w, --warnings                   Run with Ruby warnings enabled
+    -e, --environment ENV            Run tests in the ENV environment
+    -b, --backtrace                  Show the complete backtrace
+    -d, --defer-output               Output test failures and errors after the test run
+    -f, --fail-fast                  Abort test run on first failure or error
+    -c, --[no-]color                 Enable color in the output
+    -p, --pride                      Pride. Show your testing pride!
+
+# exit status is 1 - which means failed tests
+> echo $?
+1
+```
+
+The root problem is that Rails add `minitest` gem and it is started when `cucumber/rails` is loaded. It should not be. You can fix it by adding below in file `features/support/env.rb`:
+
+```ruby
+# features/support/env.rb
+require 'cucumber/rails'
+
+# this must be after we require cucumber/rails
+require 'multi_test'
+MultiTest.disable_autorun
+```
+
+The solution comes from: [cucumber/multi_test](https://github.com/cucumber/multi_test/pull/2#issuecomment-21863459)
+
 #### Queue Mode problems
 
 ##### Why when I use Queue Mode for RSpec then my tests fail?
@@ -1601,8 +1644,8 @@ 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:
+* you should not 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 that allows to measure tests:
 
 ```ruby
 require 'knapsack_pro'
@@ -2547,6 +2590,30 @@ 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.
 
+If you use for instance Heroku CI that allows you to provide only one test command you can make a bash script to control what's executed on particular CI node:
+
+```bash
+#!/bin/bash
+# add this file in bin/knapsack_pro_rspec_and_npm_test and change chmod
+# $ chmod a+x bin/knapsack_pro_rspec_and_npm_test
+
+# 15 is last CI node (index starts from 0, so in total we have 16 parallel Heroku dynos)
+if [ "$CI_NODE_TOTAL" == "15" ]; then
+  # run npm tests on the last CI node
+  npm test
+else
+  KNAPSACK_PRO_CI_NODE_TOTAL=$((CI_NODE_TOTAL-1)) bundle exec rake knapsack_pro:queue:rspec
+fi
+```
+
+then in your Heroku CI config `app.json` set:
+
+```
+"scripts": {
+  "test": "bin/knapsack_pro_rspec_and_npm_test"
+}
+```
+
 #### How to use CodeClimate with knapsack_pro?
 
 You can check articles about CodeClimate configuration with knapsack_pro gem:

data/knapsack_pro.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'rake', '>= 0'
 
-  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'bundler', '>= 1.6'
   spec.add_development_dependency 'rspec', '~> 3.0', '>= 2.10.0'
   spec.add_development_dependency 'rspec-its', '~> 1.2'
   spec.add_development_dependency 'cucumber', '>= 0'

data/lib/knapsack_pro/config/ci/gitlab_ci.rb

@@ -15,7 +15,7 @@ module KnapsackPro
         end
 
         def node_build_id
-          ENV['CI_JOB_ID'] || # Gitlab Release 9.0+
+          ENV['CI_PIPELINE_ID'] || # Gitlab Release 9.0+
           ENV['CI_BUILD_ID']  # Gitlab Release 8.x
         end
 

data/lib/knapsack_pro/config/env.rb

@@ -177,7 +177,9 @@ module KnapsackPro
 
         def ci_env_for(env_name)
           value = nil
-          ci_list = KnapsackPro::Config::CI.constants - [:Base]
+          ci_list = KnapsackPro::Config::CI.constants - [:Base, :GitlabCI]
+          # load GitLab CI first to avoid edge case with order of loading envs for CI_NODE_INDEX
+          ci_list = [:GitlabCI] + ci_list
           ci_list.each do |ci_name|
             ci_class = Object.const_get("KnapsackPro::Config::CI::#{ci_name}")
             ci = ci_class.new

data/lib/knapsack_pro/version.rb

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

data/spec/knapsack_pro/config/ci/gitlab_ci_spec.rb

@@ -37,7 +37,7 @@ describe KnapsackPro::Config::CI::GitlabCI do
     subject { described_class.new.node_build_id }
 
     context 'when Gitlab Release 9.0+ and environment exists' do
-      let(:env) { { 'CI_JOB_ID' => 7046507 } }
+      let(:env) { { 'CI_PIPELINE_ID' => 7046507 } }
       it { should eql 7046507 }
     end
 

data/spec/knapsack_pro/config/env_spec.rb

@@ -40,6 +40,13 @@ describe KnapsackPro::Config::Env do
 
         it { should eq 2 }
       end
+
+      context 'when order of loading envs does matter' do
+        context 'when GitLab CI' do
+          before { stub_const("ENV", { 'CI_NODE_INDEX' => '2', 'GITLAB_CI' => 'true' }) }
+          it { should eq 1 }
+        end
+      end
     end
 
     context "when ENV doesn't exist" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.12.1
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-07 00:00:00.000000000 Z
+date: 2019-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -28,14 +28,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency