knapsack_pro 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5cda0e0e6281dd44b8b51af6d7cac7872f79b08e
-  data.tar.gz: c7911a8fc5345af87a0d29ac224a5143789e0c58
+  metadata.gz: b300b67986e3d1f899db86baa3c750e3c1984b6e
+  data.tar.gz: 537267adfaaeacf16890fb3ef30bde398aa82d04
 SHA512:
-  metadata.gz: 2082cbd396b2c6f4460eff48a7cc0878ca498ccd6285f5a98fa551e04e3e143d90ed1fbee31db9e928a944544f5888d3aff9a893bfd98bcada9c74c1d30198e5
-  data.tar.gz: 7cb3a536848041dfa7c940baeed3cfaf67b8450e6aa9c198e4de06c9a823d14a4837cc2c6a8f3ccf12e02ef46047024d7362a70422619f254fd40a996691394b
+  metadata.gz: 111b2b41ddec465bec5a5769427f3dacd8deb6309c9efc32e5ee43dd567e582824d78095832befcb0e73dcd4466d11a5a50fc20261f4e45c6055b1ee03ecc3b3
+  data.tar.gz: f43acacaca9c57986df0b64cdd2ad5995ad362f5ceeeab160224969ce9a8a3175c7c2457d39d49a58f3ede018d1e3e37e6143b2f0b1ceab75e3073d874e2001f

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 * TODO
 
+### 0.1.2
+
+* Fix Travis CI environment variables support
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/1
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v0.1.1...v0.1.2
+
 ### 0.1.1
 
 * Make knapsack_pro backwards compatible with earlier version of minitest

data/README.md

@@ -36,7 +36,7 @@ For instance when you will run tests with rake knapsack_pro:rspec then:
 
 # Requirements
 
-* >= Ruby 2.0
+* >= Ruby 2.1 (because gem uses required keyword arguments in ruby)
 
 # Table of Contents
 
@@ -57,6 +57,8 @@ For instance when you will run tests with rake knapsack_pro:rspec then:
 - [Extra configuration for CI server](#extra-configuration-for-ci-server)
   - [Info about ENV variables](#info-about-env-variables)
     - [Repository adapter](#repository-adapter)
+      - [When you set global variable `KNAPSACK_PRO_REPOSITORY_ADAPTER=git` (optional)](#when-you-set-global-variable-knapsack_pro_repository_adaptergit-optional)
+      - [When you NOT set global variable `KNAPSACK_PRO_REPOSITORY_ADAPTER` (default)](#when-you-not-set-global-variable-knapsack_pro_repository_adapter-default)
     - [Environment variables for debugging gem](#environment-variables-for-debugging-gem)
   - [Passing arguments to rake task](#passing-arguments-to-rake-task)
     - [Passing arguments to rspec](#passing-arguments-to-rspec)
@@ -202,15 +204,20 @@ In case when you use other CI provider for instance [Jenkins](https://jenkins-ci
 
 #### Repository adapter
 
-`KNAPSACK_PRO_REPOSITORY_ADAPTER` - When it has value `git` then your local version of git on CI server will be used to get info about branch name, commit hash and project directory path.
-By default this variable has no value so knapsack_pro will try to get those info from [supported CI](#supported-ci-providers) (CI providers have branch, commit, project directory stored as environment variables). In case when you use other CI provider like Jenkins then please set below variables on your own.
+##### When you set global variable `KNAPSACK_PRO_REPOSITORY_ADAPTER=git` (optional)
+
+`KNAPSACK_PRO_REPOSITORY_ADAPTER` - When it has value `git` then your local version of git on CI server will be used to get info about branch name and commit hash. You need to set also `KNAPSACK_PRO_PROJECT_DIR` with project directory path.
+
+`KNAPSACK_PRO_PROJECT_DIR` - Path to the project on CI node for instance `/home/ubuntu/my-app-repository`. It should be main directory of your repository.
+
+##### When you NOT set global variable `KNAPSACK_PRO_REPOSITORY_ADAPTER` (default)
+
+By default `KNAPSACK_PRO_REPOSITORY_ADAPTER` variable has no value so knapsack_pro will try to get info about branch name and commit hash from [supported CI](#supported-ci-providers) (CI providers have branch, commit, project directory stored as environment variables). In case when you use other CI provider like Jenkins then please set below variables on your own.
 
 `KNAPSACK_PRO_BRANCH` - It's branch name. You run tests on this branch.
 
 `KNAPSACK_PRO_COMMIT_HASH` - Commit hash. You run tests for this commit.
 
-`KNAPSACK_PRO_PROJECT_DIR` - Path to the project on CI node for instance `/home/ubuntu/my-app-repository`. It should be main directory of your repository.
-
 #### Environment variables for debugging gem
 
 `KNAPSACK_PRO_ENDPOINT` - Default value is `http://api.knapsackpro.com` which is endpoint for [Knapsack Pro API](http://docs.knapsackpro.com).
@@ -259,11 +266,17 @@ This is optional way of using knapsack_pro when you don't want to add it to `Gem
 
 #### Info for CircleCI users
 
-If you are using circleci.com you can omit `KNAPSACK_PRO_CI_NODE_TOTAL` and `KNAPSACK_PRO_CI_NODE_INDEX`. Knapsack Pro will use `KNAPSACK_PRO_CIRCLE_NODE_TOTAL` and `KNAPSACK_PRO_CIRCLE_NODE_INDEX` provided by CircleCI.
+If you are using circleci.com you can omit `KNAPSACK_PRO_CI_NODE_TOTAL` and `KNAPSACK_PRO_CI_NODE_INDEX`. Knapsack Pro will use `CIRCLE_NODE_TOTAL` and `CIRCLE_NODE_INDEX` provided by CircleCI.
 
 Here is an example for test configuration in your `circleci.yml` file.
 
 ```yaml
+machine:
+  environment:
+    # Tokens should be set in CircleCI settings to avoid expose tokens in build logs
+    # KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC: rspec-token
+    # KNAPSACK_PRO_TEST_SUITE_TOKEN_CUCUMBER: cucumber-token
+    # KNAPSACK_PRO_TEST_SUITE_TOKEN_MINITEST: minitest-token
 test:
   override:
     # Step for RSpec
@@ -285,24 +298,6 @@ Please remember to add additional containers for your project in CircleCI settin
 
 You can parallel your builds across virtual machines with [travis matrix feature](http://docs.travis-ci.com/user/speeding-up-the-build/#Parallelizing-your-builds-across-virtual-machines). Edit `.travis.yml`
 
-```yaml
-script:
-  # Step for RSpec
-  - "bundle exec rake knapsack_pro:rspec"
-
-  # Step for Cucumber
-  - "bundle exec rake knapsack_pro:cucumber"
-
-  # Step for Minitest
-  - "bundle exec rake knapsack_pro:minitest"
-
-env:
-  - KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0
-  - KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=1
-```
-
-If you want to have some global ENVs and matrix of ENVs then do it like this:
-
 ```yaml
 script:
   # Step for RSpec
@@ -316,8 +311,11 @@ script:
 
 env:
   global:
-    - RAILS_ENV=test
-    - MY_GLOBAL_VAR=123
+    # tokens should be set in travis settings in web interface to avoid expose tokens in build logs
+    - KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC=rspec-token
+    - KNAPSACK_PRO_TEST_SUITE_TOKEN_CUCUMBER=cucumber-token
+    - KNAPSACK_PRO_TEST_SUITE_TOKEN_MINITEST=minitest-token
+
     - KNAPSACK_PRO_CI_NODE_TOTAL=2
   matrix:
     - KNAPSACK_PRO_CI_NODE_INDEX=0
@@ -326,8 +324,8 @@ env:
 
 Such configuration will generate matrix with 2 following ENV rows:
 
-    KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 RAILS_ENV=test MY_GLOBAL_VAR=123
-    KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=1 RAILS_ENV=test MY_GLOBAL_VAR=123
+    KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC=rspec-token KNAPSACK_PRO_TEST_SUITE_TOKEN_CUCUMBER=cucumber-token KNAPSACK_PRO_TEST_SUITE_TOKEN_MINITEST=minitest-token
+    KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=1 KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC=rspec-token KNAPSACK_PRO_TEST_SUITE_TOKEN_CUCUMBER=cucumber-token KNAPSACK_PRO_TEST_SUITE_TOKEN_MINITEST=minitest-token
 
 More info about global and matrix ENV configuration in [travis docs](http://docs.travis-ci.com/user/build-configuration/#Environment-variables).
 
@@ -353,6 +351,8 @@ Knapsack Pro supports semaphoreapp ENVs `SEMAPHORE_THREAD_COUNT` and `SEMAPHORE_
 
 Tests will be split across threads.
 
+Please remember to set up token like `KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC` as global environment.
+
 #### Info for buildkite.com users
 
 Knapsack Pro supports buildkite ENVs `BUILDKITE_PARALLEL_JOB_COUNT` and `BUILDKITE_PARALLEL_JOB`. The only thing you need to do is to configure the parallelism parameter in your build step and run the appropiate command in your build
@@ -366,6 +366,8 @@ Knapsack Pro supports buildkite ENVs `BUILDKITE_PARALLEL_JOB_COUNT` and `BUILDKI
     # Step for Minitest
     bundle exec rake knapsack_pro:minitest
 
+Please remember to set up token like `KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC` as global environment.
+
 ## Gem tests
 
 ### Spec

data/lib/knapsack_pro.rb

@@ -12,6 +12,7 @@ require_relative 'knapsack_pro/config/ci/base'
 require_relative 'knapsack_pro/config/ci/circle'
 require_relative 'knapsack_pro/config/ci/semaphore'
 require_relative 'knapsack_pro/config/ci/buildkite'
+require_relative 'knapsack_pro/config/ci/travis'
 require_relative 'knapsack_pro/config/env'
 require_relative 'knapsack_pro/client/api/action'
 require_relative 'knapsack_pro/client/api/v1/base'

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

@@ -0,0 +1,19 @@
+module KnapsackPro
+  module Config
+    module CI
+      class Travis < Base
+        def commit_hash
+          ENV['TRAVIS_COMMIT']
+        end
+
+        def branch
+          ENV['TRAVIS_BRANCH']
+        end
+
+        def project_dir
+          ENV['TRAVIS_BUILD_DIR']
+        end
+      end
+    end
+  end
+end

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

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

@@ -0,0 +1,60 @@
+describe KnapsackPro::Config::CI::Travis 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 '#commit_hash' do
+    subject { described_class.new.commit_hash }
+
+    context 'when environment exists' do
+      let(:env) { { 'TRAVIS_COMMIT' => '3fa64859337f6e56409d49f865d13fd7' } }
+      it { should eql '3fa64859337f6e56409d49f865d13fd7' }
+    end
+
+    context "when environment doesn't exist" do
+      it { should be nil }
+    end
+  end
+
+  describe '#branch' do
+    subject { described_class.new.branch }
+
+    context 'when environment exists' do
+      let(:env) { { 'TRAVIS_BRANCH' => '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) { { 'TRAVIS_BUILD_DIR' => '/home/travis/build/KnapsackPro/rails-app-with-knapsack_pro' } }
+      it { should eql '/home/travis/build/KnapsackPro/rails-app-with-knapsack_pro' }
+    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.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-27 00:00:00.000000000 Z
+date: 2015-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -219,6 +219,7 @@ files:
 - lib/knapsack_pro/config/ci/buildkite.rb
 - lib/knapsack_pro/config/ci/circle.rb
 - lib/knapsack_pro/config/ci/semaphore.rb
+- lib/knapsack_pro/config/ci/travis.rb
 - lib/knapsack_pro/config/env.rb
 - lib/knapsack_pro/logger_wrapper.rb
 - lib/knapsack_pro/presenter.rb
@@ -263,6 +264,7 @@ files:
 - spec/knapsack_pro/config/ci/buildkite_spec.rb
 - spec/knapsack_pro/config/ci/circle_spec.rb
 - spec/knapsack_pro/config/ci/semaphore_spec.rb
+- spec/knapsack_pro/config/ci/travis_spec.rb
 - spec/knapsack_pro/config/env_spec.rb
 - spec/knapsack_pro/logger_wrapper_spec.rb
 - spec/knapsack_pro/presenter_spec.rb
@@ -341,6 +343,7 @@ test_files:
 - spec/knapsack_pro/config/ci/buildkite_spec.rb
 - spec/knapsack_pro/config/ci/circle_spec.rb
 - spec/knapsack_pro/config/ci/semaphore_spec.rb
+- spec/knapsack_pro/config/ci/travis_spec.rb
 - spec/knapsack_pro/config/env_spec.rb
 - spec/knapsack_pro/logger_wrapper_spec.rb
 - spec/knapsack_pro/presenter_spec.rb