knapsack_pro 1.12.1 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74b370cb50a79631e4168dfbc8303ac3efdd5cfb0c34758f6bea4845757dcdbf
-  data.tar.gz: 25cba47e95daef7952743d604b6f48388cb39368deff071d570ec8fe5272c312
+  metadata.gz: c6b31c406c88ef954bb9a6d72f9ee4ba3a4245a98fd4ba4421fd3d22808e573c
+  data.tar.gz: a0990305e67b692e88b3f3136399c41e8330732868628d69873504c7f4020ae2
 SHA512:
-  metadata.gz: 74a62e6902ee09d62d5290e815e870dda6abbdd47e1bfdb21bf6a5b95d9dc0625e017ec24704ee71c6760f3762bcd3c6e41338a985919cd8ca32b315fff5757e
-  data.tar.gz: 72e4cd22c704ae1f088b631c7ba5bf1d3f78cc85b8f300daff9b9cb01b09bb3f923c871d88b3ac8c2d6a1d89ea64911288b40e396f3a191b24bb1fbb962cdf54
+  metadata.gz: 811f24df9900bc81b942d9aba6f112e4bb523f19aa9d717711b071239cf36751559b3f56eaf99e0b9e1575bafcf499d595936a22dcca2e567f1995c984c2039c
+  data.tar.gz: fa4e5826771f41d4ed1b907d2045a1aab3a9bd3414a68ab7adcbf19fe82917b36bbbcfefdeb4cafd1fe468041dd507127aa05d0a36e955d0db35706ffa48c3e5

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+### 1.13.0
+
+* Add support for job index and job count for parallelism in Semaphore 2.0
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/89
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v1.12.1...v1.13.0
+
 ### 1.12.1
 
 * Use `CI_PIPELINE_ID` as build ID for GitLab CI because it is unique across parallel jobs

data/README.md

@@ -127,6 +127,7 @@ You can see list of questions for common problems and tips in below [Table of Co
       - [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)
       - [Why when I use Queue Mode for RSpec then my rake tasks are run twice?](#why-when-i-use-queue-mode-for-rspec-then-my-rake-tasks-are-run-twice)
       - [Why when I use Queue Mode for RSpec then I see error `superclass mismatch for class`?](#why-when-i-use-queue-mode-for-rspec-then-i-see-error-superclass-mismatch-for-class)
+      - [Why when I use Queue Mode for RSpec then `.rspec` config is ignored?](#why-when-i-use-queue-mode-for-rspec-then-rspec-config-is-ignored)
       - [Why I don't see collected time execution data for my build in user dashboard?](#why-i-dont-see-collected-time-execution-data-for-my-build-in-user-dashboard)
       - [Why all test files have 0.1s time execution for my CI build in user dashboard?](#why-all-test-files-have-01s-time-execution-for-my-ci-build-in-user-dashboard)
       - [Why when I use Queue Mode for RSpec and test fails then I see multiple times info about failed test in RSpec result?](#why-when-i-use-queue-mode-for-rspec-and-test-fails-then-i-see-multiple-times-info-about-failed-test-in-rspec-result)
@@ -904,9 +905,7 @@ More info about global and matrix ENV configuration in [travis docs](https://doc
 knapsack_pro gem supports environment variables provided by Semaphore CI 2.0 to run your tests. You will have to define a few things in `.semaphore/semaphore.yml` config file.
 
 * You need to set `KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC`. If you don't want to commit secrets in yml file then you can [follow this guide](https://docs.semaphoreci.com/article/66-environment-variables-and-secrets).
-* You need to create as many jobs with unique names (Node 0 - Knapsack Pro, Node 1 - Knapsack Pro etc) as many parallel jobs you want to run. If your test suite is long you should use more parallel jobs.
-* If you have 2 parallel jobs you need to set `KNAPSACK_PRO_CI_NODE_TOTAL=2` for each job.
-* You need to set job index starting from 0 like `KNAPSACK_PRO_CI_NODE_INDEX=0` for Node 0.
+* You should create as many parallel jobs as you need with `parallelism` property. If your test suite is long you should use more parallel jobs.
 
 Below you can find full Semaphore CI 2.0 config for Rails project.
 
@@ -985,13 +984,10 @@ blocks:
           - bundle exec rake db:setup
 
       jobs:
-      - name: Node 0 - Knapsack Pro
+      - name: Run tests with Knapsack Pro
+        parallelism: 2
         commands:
-          - KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 bundle exec rake knapsack_pro:queue:rspec
-
-      - name: Node 1 - Knapsack Pro
-        commands:
-          - KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=1 bundle exec rake knapsack_pro:queue:rspec
+        - bundle exec rake knapsack_pro:queue:rspec
 ```
 
 ##### Semaphore 1.0
@@ -1058,6 +1054,27 @@ Here you can find article [how to set up a new pipeline for your project in Buil
 
 If you want to use Buildkite retry single agent feature to retry just failed tests on particular agent (CI node) then you should set [`KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true`](#knapsack_pro_fixed_queue_split-remember-queue-split-on-retry-ci-node).
 
+When using the `docker-compose` plugin on Buildkite, you have to tell it which environment variables to pass to the docker container. Thanks to it knapsack_pro can detect info about CI build like commit, branch name, amount of parallel nodes.
+
+```yaml
+steps:
+  - label: "Test"
+    parallelism: 2
+    plugins:
+      - docker-compose#3.0.3:
+        run: app
+        # use here proper knapsack_pro command for your test runner
+        command: bundle exec rake knapsack_pro:queue:rspec
+        config: docker-compose.test.yml
+        env:
+          - BUILDKITE_PARALLEL_JOB_COUNT
+          - BUILDKITE_PARALLEL_JOB
+          - BUILDKITE_BUILD_NUMBER
+          - BUILDKITE_COMMIT
+          - BUILDKITE_BRANCH
+          - BUILDKITE_BUILD_CHECKOUT_PATH
+```
+
 #### Info for GitLab CI users
 
 Remember to add API tokens like `KNAPSACK_PRO_TEST_SUITE_TOKEN_CUCUMBER` and `KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC` to [Secret Variables](https://gitlab.com/help/ci/variables/README.md#secret-variables) in `GitLab CI Settings -> CI/CD Pipelines -> Secret Variables`.
@@ -1632,6 +1649,16 @@ end
 
 Instead of mocking like shown above you could use [RSpec stub_const](https://relishapp.com/rspec/rspec-mocks/docs/mutating-constants) to solve error `superclass mismatch for class BatchClass`.
 
+##### Why when I use Queue Mode for RSpec then `.rspec` config is ignored?
+
+The `.rspec` config file is ignored in Queue Mode because knapsack_pro has to pass explicitly arguments to `RSpec::Core::Runner` underhood. You can set your arguments from `.rspec` file in an inline way.
+
+```
+bundle exec rake "knapsack_pro:queue:rspec[--format documentation --require rails_helper]"
+```
+
+See [passing arguments to RSpec](#passing-arguments-to-rspec).
+
 ##### Why I don't see collected time execution data for my build in user dashboard?
 
 If you go to [user dashboard](https://knapsackpro.com/dashboard) and open `Build metrics` for your API token and you open build for your last git commit you should see there info about collected time execution data from all CI nodes. If you don't see collected time execution data for CI nodes then please ensure:
@@ -2691,7 +2718,7 @@ Regarding payments we use the BraintreePayments.com and they store credit cards
 
 I’m the only admin so I can preview data in case you need help with debugging some problem etc. I’m not able to decrypt them without knowing the salt.
 
-When you sign in to your user dashboard then you can preview data for recent 100 builds on CI. If the test file paths are encrypted then you only see hashes for test file paths.
+When you sign in to your user dashboard then you can preview data for recent CI builds. If the test file paths are encrypted then you only see hashes for test file paths.
 You need to [decrypt](#how-to-debug-test-file-names) them locally on your machine to find out what each test file hash is.
 
 ## Gem tests

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

@@ -4,11 +4,12 @@ module KnapsackPro
     module CI
       class Semaphore2 < Base
         def node_total
-          # not provided
+          ENV['SEMAPHORE_JOB_COUNT']
         end
 
         def node_index
-          # not provided
+          index = ENV['SEMAPHORE_JOB_INDEX']
+          index.to_i - 1 if index
         end
 
         def node_build_id

data/lib/knapsack_pro/version.rb

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

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

@@ -10,13 +10,27 @@ describe KnapsackPro::Config::CI::Semaphore2 do
   describe '#node_total' do
     subject { described_class.new.node_total }
 
-    it { should be nil }
+    context 'when environment exists' do
+      let(:env) { { 'SEMAPHORE_JOB_COUNT' => 4 } }
+      it { should eql 4 }
+    end
+
+    context "when environment doesn't exist" do
+      it { should be nil }
+    end
   end
 
   describe '#node_index' do
     subject { described_class.new.node_index }
 
-    it { should be nil }
+    context 'when environment exists' do
+      let(:env) { { 'SEMAPHORE_JOB_INDEX' => 4 } }
+      it { should eql 3 }
+    end
+
+    context "when environment doesn't exist" do
+      it { should be nil }
+    end
   end
 
   describe '#node_build_id' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 1.12.1
+  version: 1.13.0
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-05 00:00:00.000000000 Z
+date: 2019-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake