knapsack_pro 0.37.0 → 0.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8e029c932abfe418c4cd91a812046b361459fcf
-  data.tar.gz: '059e9c338debb8b3650c25481496123865293325'
+  metadata.gz: 58513c4532159921b31333f16c66a2558d5d1d37
+  data.tar.gz: efe8d50df9c61c480cf2a98429569d86f84d85c8
 SHA512:
-  metadata.gz: 985a24992946ac1d91d55f444de53cd1f9afab5aa1322f462af59575c62dd12127bef4a10f02d38f93b71568f9dc71c12ba29be86ef3d7a657d7785b50442553
-  data.tar.gz: 5c0c74743d01b9183282ca13659827b5bddbd9ddfee9c1bd43d5bfe1bce7b038f3889e2c0590bdb5f829099a119e3bea8fd2645974b662f8e159baf0b02ba6dc
+  metadata.gz: 0f8f2c220f41c9becf921e5d144192d7d52d175f3f2a8ea1d4492049a3f2dd47de5479dbd02d8f4ea8b5a15caf6810e6e1cecf748cf5d378ab01f7013824b7a2
+  data.tar.gz: c647fe42e829f4c04ff61d445e8244ad6919891681769730a193a7237d2b8236e1aae4eff851379927e85c96f6b95d027021dd0e74fbdc71076f336808267855

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 * TODO
 
+### 0.38.0
+
+* Add support for Gitlab CI.
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/36
+
+* More info about Buildkite in installer.
+* More info about CircleCI in installer.
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v0.37.0...v0.38.0
+
 ### 0.37.0
 
 * Add another explanation why test files could not be executed on CI node in Queue Mode.

data/README.md

@@ -96,6 +96,7 @@ The knapsack_pro has also [queue mode](#queue-mode) to get most optimal test sui
     - [Info for Travis users](#info-for-travis-users)
     - [Info for semaphoreapp.com users](#info-for-semaphoreappcom-users)
     - [Info for buildkite.com users](#info-for-buildkitecom-users)
+    - [Info for Gitlab CI users](#info-for-gitlab-ci-users)
     - [Info for snap-ci.com users](#info-for-snap-cicom-users)
     - [Info for Jenkins users](#info-for-jenkins-users)
 - [FAQ](#faq)
@@ -724,6 +725,40 @@ Here you can find article [how to set up a new pipeline for your project in Buil
 * [Buildkite Rails Parallel Example with Knapsack Pro](https://github.com/KnapsackPro/buildkite-rails-parallel-example-with-knapsack_pro)
 * [Buildkite Rails Docker Parallel Example with Knapsack Pro](https://github.com/KnapsackPro/buildkite-rails-docker-parallel-example-with-knapsack_pro)
 
+#### Info for Gitlab CI users
+
+Gitlab CI does not provide parallel jobs environment variables so you will have to define `KNAPSACK_PRO_CI_NODE_TOTAL` and `KNAPSACK_PRO_CI_NODE_INDEX` for each parallel job running as part of the same `test` stage. Below is relevant part of `.gitlab-ci.yml` configuration for 2 parallel jobs.
+
+```
+# .gitlab-ci.yml
+stages:
+  - test
+
+variables:
+  KNAPSACK_PRO_CI_NODE_TOTAL: 2
+
+# first CI node running in parallel
+test_ci_node_0:
+  stage: test
+  script:
+    - export KNAPSACK_PRO_CI_NODE_INDEX=0
+    # Cucumber tests in Knapsack Pro Regular Mode (deterministic test suite split)
+    - bundle exec rake knapsack_pro:cucumber
+    # RSpec tests in Knapsack Pro Queue Mode (dynamic test suite split)
+    # It will autobalance bulid because it is executed after Cucumber tests.
+    - bundle exec rake knapsack_pro:queue:rspec
+
+# second CI node running in parallel
+test_ci_node_1:
+  stage: test
+  script:
+    - export KNAPSACK_PRO_CI_NODE_INDEX=1
+    - bundle exec rake knapsack_pro:cucumber
+    - bundle exec rake knapsack_pro:queue:rspec
+```
+
+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`.
+
 #### Info for snap-ci.com users
 
 Knapsack Pro supports snap-ci.com ENVs `SNAP_WORKER_TOTAL` and `SNAP_WORKER_INDEX`. The only thing you need to do is to configure number of workers for your project in configuration settings in order to enable parallelism. Next thing is to set below commands to be executed in your stage:
@@ -1167,6 +1202,7 @@ Now you need to set parallel_tests command per CI node:
 
     ```
     export PARALLEL_TESTS_CONCURRENCY=2; # this must be export
+    RAILS_ENV=test \
     KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC=xxx \
     KNAPSACK_PRO_CI_NODE_TOTAL=$YOUR_CI_NODE_TOTAL \
     KNAPSACK_PRO_CI_NODE_INDEX=$YOUR_CI_NODE_INDEX \
@@ -1177,6 +1213,7 @@ Now you need to set parallel_tests command per CI node:
 
     ```
     export PARALLEL_TESTS_CONCURRENCY=2; # this must be export
+    RAILS_ENV=test \
     KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC=xxx \
     KNAPSACK_PRO_CI_NODE_TOTAL=$YOUR_CI_NODE_TOTAL \
     KNAPSACK_PRO_CI_NODE_INDEX=$YOUR_CI_NODE_INDEX \
@@ -1190,7 +1227,7 @@ Please note you need to update `$YOUR_CI_NODE_TOTAL` and `$YOUR_CI_NODE_INDEX` t
 # KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC=xxx can be set in CircleCI ENV settings
 test:
   override:
-    - export PARALLEL_TESTS_CONCURRENCY=2; KNAPSACK_PRO_CI_NODE_TOTAL=$CIRCLE_NODE_TOTAL KNAPSACK_PRO_CI_NODE_INDEX=$CIRCLE_NODE_INDEX bundle exec parallel_test -n $PARALLEL_TESTS_CONCURRENCY -e './bin/parallel_tests':
+    - export PARALLEL_TESTS_CONCURRENCY=2; RAILS_ENV=test KNAPSACK_PRO_CI_NODE_TOTAL=$CIRCLE_NODE_TOTAL KNAPSACK_PRO_CI_NODE_INDEX=$CIRCLE_NODE_INDEX bundle exec parallel_test -n $PARALLEL_TESTS_CONCURRENCY -e './bin/parallel_tests':
         parallel: true # Caution: there are 8 spaces indentation!
 ```
 

data/lib/knapsack_pro.rb

@@ -12,6 +12,7 @@ require_relative 'knapsack_pro/utils'
 require_relative 'knapsack_pro/logger_wrapper'
 require_relative 'knapsack_pro/config/ci/base'
 require_relative 'knapsack_pro/config/ci/circle'
+require_relative 'knapsack_pro/config/ci/gitlab_ci'
 require_relative 'knapsack_pro/config/ci/semaphore'
 require_relative 'knapsack_pro/config/ci/buildkite'
 require_relative 'knapsack_pro/config/ci/travis'

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

@@ -0,0 +1,35 @@
+# https://docs.gitlab.com/ce/ci/variables/
+module KnapsackPro
+  module Config
+    module CI
+      class GitlabCI < Base
+        def node_total
+          # not provided by Gitlab CI
+        end
+
+        def node_index
+          # not provided by Gitlab CI
+        end
+
+        def node_build_id
+          ENV['CI_JOB_ID'] || # Gitlab Release 9.0+
+          ENV['CI_BUILD_ID']  # Gitlab Release 8.x
+        end
+
+        def commit_hash
+          ENV['CI_COMMIT_SHA'] || # Gitlab Release 9.0+
+          ENV['CI_BUILD_REF'] # Gitlab Release 8.x
+        end
+
+        def branch
+          ENV['CI_COMMIT_REF_NAME'] || # Gitlab Release 9.0+
+          ENV['CI_BUILD_REF_NAME'] # Gitlab Release 8.x
+        end
+
+        def project_dir
+          ENV['CI_PROJECT_DIR']
+        end
+      end
+    end
+  end
+end

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '0.37.0'
+  VERSION = '0.38.0'
 end

data/lib/tasks/install.rake

@@ -93,6 +93,19 @@ def step_for_ci_circle(prompt, answers)
 test:
   override:} + str), color: :cyan)
 
+  puts
+  prompt.say "Please read this section about example for CircleCI 1.0 and CircleCI 2.0 platform:"
+  prompt.say "https://github.com/KnapsackPro/knapsack_pro-ruby#info-for-circleci-users"
+
+  puts
+  set_api_tokens_on_ci(prompt, answers)
+end
+
+def step_for_ci_gitlab(prompt, answers)
+  prompt.say "Step for Gitlab CI https://about.gitlab.com/features/gitlab-ci-cd/", color: :yellow
+  prompt.say "Update .gitlab-ci.yml in your project as in this example:"
+  prompt.say "https://github.com/KnapsackPro/knapsack_pro-ruby#info-for-gitlab-ci-users"
+
   puts
   set_api_tokens_on_ci(prompt, answers)
 end
@@ -148,6 +161,10 @@ bundle exec rake knapsack_pro:#{tool}
     }, color: :cyan
   end
 
+  puts
+  prompt.say "Please read this section about example usage for Rails project with Docker and without it:"
+  prompt.say "https://github.com/KnapsackPro/knapsack_pro-ruby#info-for-buildkitecom-users"
+
   puts
   set_api_tokens_on_ci(prompt, answers)
 end
@@ -291,6 +308,7 @@ namespace :knapsack_pro do
       'https://buildkite.com' => :buildkite,
       'https://semaphoreci.com' => :semaphore,
       'https://snap-ci.com' => :snap_ci,
+      'Gitlab CI' => :gitlab,
       'Jenkins' => :jenkins,
       'other' => :other,
     }

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

@@ -0,0 +1,88 @@
+describe KnapsackPro::Config::CI::GitlabCI do
+  let(:env) { {} }
+
+  before do
+    stub_const('ENV', env)
+  end
+
+  it { should be_kind_of KnapsackPro::Config::CI::Base }
+
+  describe '#node_total' do
+    subject { described_class.new.node_total }
+
+    it { should be nil }
+  end
+
+  describe '#node_index' do
+    subject { described_class.new.node_index }
+
+    it { should be nil }
+  end
+
+  describe '#node_build_id' do
+    subject { described_class.new.node_build_id }
+
+    context 'when Gitlab Release 9.0+ and environment exists' do
+      let(:env) { { 'CI_JOB_ID' => 7046507 } }
+      it { should eql 7046507 }
+    end
+
+    context 'when Gitlab Release 8.x and environment exists' do
+      let(:env) { { 'CI_BUILD_ID' => 7046508 } }
+      it { should eql 7046508 }
+    end
+
+    context "when environment doesn't exist" do
+      it { should be nil }
+    end
+  end
+
+  describe '#commit_hash' do
+    subject { described_class.new.commit_hash }
+
+    context 'when Gitlab Release 9.0+ and environment exists' do
+      let(:env) { { 'CI_COMMIT_SHA' => '4e0c4feec2267261fbcc060e82d7776e' } }
+      it { should eql '4e0c4feec2267261fbcc060e82d7776e' }
+    end
+
+    context 'when Gitlab Release 8.x and environment exists' do
+      let(:env) { { 'CI_BUILD_REF' => 'f76c468e3e1d570f71f5822b1e48bb04' } }
+      it { should eql 'f76c468e3e1d570f71f5822b1e48bb04' }
+    end
+
+    context "when environment doesn't exist" do
+      it { should be nil }
+    end
+  end
+
+  describe '#branch' do
+    subject { described_class.new.branch }
+
+    context 'when Gitlab Release 9.0+ and environment exists' do
+      let(:env) { { 'CI_COMMIT_REF_NAME' => 'master' } }
+      it { should eql 'master' }
+    end
+
+    context 'when Gitlab Release 8.x and environment exists' do
+      let(:env) { { 'CI_BUILD_REF_NAME' => 'master' } }
+      it { should eql 'master' }
+    end
+
+    context "when environment doesn't exist" do
+      it { should be nil }
+    end
+  end
+
+  describe '#project_dir' do
+    subject { described_class.new.project_dir }
+
+    context 'when environment exists' do
+      let(:env) { { 'CI_PROJECT_DIR' => '/home/user/knapsack_pro-ruby' } }
+      it { should eql '/home/user/knapsack_pro-ruby' }
+    end
+
+    context "when environment doesn't exist" do
+      it { should be nil }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 0.37.0
+  version: 0.38.0
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-05 00:00:00.000000000 Z
+date: 2017-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -235,6 +235,7 @@ files:
 - lib/knapsack_pro/config/ci/base.rb
 - lib/knapsack_pro/config/ci/buildkite.rb
 - lib/knapsack_pro/config/ci/circle.rb
+- lib/knapsack_pro/config/ci/gitlab_ci.rb
 - lib/knapsack_pro/config/ci/semaphore.rb
 - lib/knapsack_pro/config/ci/snap_ci.rb
 - lib/knapsack_pro/config/ci/travis.rb
@@ -303,6 +304,7 @@ files:
 - spec/knapsack_pro/config/ci/base_spec.rb
 - spec/knapsack_pro/config/ci/buildkite_spec.rb
 - spec/knapsack_pro/config/ci/circle_spec.rb
+- spec/knapsack_pro/config/ci/gitlab_ci_spec.rb
 - spec/knapsack_pro/config/ci/semaphore_spec.rb
 - spec/knapsack_pro/config/ci/snap_ci_spec.rb
 - spec/knapsack_pro/config/ci/travis_spec.rb
@@ -397,6 +399,7 @@ test_files:
 - spec/knapsack_pro/config/ci/base_spec.rb
 - spec/knapsack_pro/config/ci/buildkite_spec.rb
 - spec/knapsack_pro/config/ci/circle_spec.rb
+- spec/knapsack_pro/config/ci/gitlab_ci_spec.rb
 - spec/knapsack_pro/config/ci/semaphore_spec.rb
 - spec/knapsack_pro/config/ci/snap_ci_spec.rb
 - spec/knapsack_pro/config/ci/travis_spec.rb