knapsack_pro 0.56.0 → 0.57.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da5bcf0250bd8e08462d58cb9b6a8d3886c02b692bbcf88923637cdce814c865
-  data.tar.gz: f01be1f4ea567e182e7d6f82b53c8d7eb2cba66a682b80c8d6c85e2ec6d01228
+  metadata.gz: 653d33cf8cec36e3f29ba1e3f5c1fd2ccd791e2c5f28dc9f902c61f634f6b881
+  data.tar.gz: 838eef54f03ff2bc88d0c4553ff0c535fd232f9aa7986e4ecac8734cbc297e25
 SHA512:
-  metadata.gz: ebdf97614db4bcdd15ead1d751c3872234edeac12d234101c073cbbce86e71cb1ae311cff9cc1046d2371aed4aca0866da1a464e20a66ba317629634f822c80f
-  data.tar.gz: 4d9a8fdce9c06e73e55afa1cfd4ab41e33e29a17c0e44e8c9fd3ba7dc9d9d17ac6153a53250ca67d5fe839e2aa7eba724c36ab882b882d0146f4659bc8241e6b
+  metadata.gz: c969994628a4db7b5f55f97260902a8d5e7ee76396db08103592daeec3a391ff92ac1b3b0a00f32ab0af6e46f50d07b7a688feb3675a21f500bb207d919e1c83
+  data.tar.gz: 5c188e1d96c4caf3274cfff5c8f791e6a243d67d3abd7ad30f9ebb4c7b3e851be8f227ec86dcc4be0dbabc563e2c108d4e43832b1a3826a9935e0ef9e6519fc1

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 * TODO
 
+### 0.57.0
+
+* Add support for Solano CI and AppVeyor
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/66
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v0.56.0...v0.57.0
+
 ### 0.56.0
 
 * Add support for Cirrus CI

data/README.md

@@ -105,6 +105,8 @@ The knapsack_pro has also [queue mode](#queue-mode) to get an optimal test suite
     - [Info for Gitlab CI users](#info-for-gitlab-ci-users)
     - [Info for codeship.com users](#info-for-codeshipcom-users)
     - [Info for Heroku CI users](#info-for-heroku-ci-users)
+    - [Info for Solano CI users](#info-for-solano-ci-users)
+    - [Info for AppVeyor users](#info-for-appveyor-users)
     - [Info for snap-ci.com users](#info-for-snap-cicom-users)
     - [Info for cirrus-ci.org users](#info-for-cirrus-ciorg-users)
     - [Info for Jenkins users](#info-for-jenkins-users)
@@ -141,6 +143,8 @@ The knapsack_pro has also [queue mode](#queue-mode) to get an optimal test suite
     - [How to use junit formatter?](#how-to-use-junit-formatter)
       - [How to use junit formatter with knapsack_pro regular mode?](#how-to-use-junit-formatter-with-knapsack_pro-regular-mode)
       - [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 many API keys I need?](#how-many-api-keys-i-need)
     - [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)
@@ -840,7 +844,7 @@ 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.
+Please remember to set up API token like `KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC` as global environment.
 
 #### Info for buildkite.com users
 
@@ -861,7 +865,7 @@ Knapsack Pro supports buildkite ENVs `BUILDKITE_PARALLEL_JOB_COUNT` and `BUILDKI
     # Step for Spinach
     bundle exec rake knapsack_pro:spinach
 
-Please remember to set up token like `KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC` as global environment.
+Please remember to set up API token like `KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC` as global environment.
 
 Here you can find article [how to set up a new pipeline for your project in Buildkite and configure Knapsack Pro](http://docs.knapsackpro.com/2017/auto-balancing-7-hours-tests-between-100-parallel-jobs-on-ci-buildkite-example) and 2 example repositories for Ruby/Rails projects:
 
@@ -976,6 +980,68 @@ Note the [Heroku CI Parallel Test Runs](https://devcenter.heroku.com/articles/he
 
 You can learn more about [Heroku CI](https://devcenter.heroku.com/articles/heroku-ci).
 
+#### Info for Solano CI users
+
+[Solano CI](https://www.solanolabs.com) 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 CI build.
+
+    # Step for RSpec for first CI node
+    KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 bundle exec rake knapsack_pro:rspec
+    # Step for RSpec for second CI node
+    KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=1 bundle exec rake knapsack_pro:rspec
+
+    # Step for Cucumber for first CI node
+    KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 bundle exec rake knapsack_pro:cucumber
+    # Step for Cucumber for second CI node
+    KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=1 bundle exec rake knapsack_pro:cucumber
+
+    # Step for Minitest for first CI node
+    KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 bundle exec rake knapsack_pro:minitest
+    # Step for Minitest for second CI node
+    KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=1 bundle exec rake knapsack_pro:minitest
+
+    # Step for test-unit for first CI node
+    KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 bundle exec rake knapsack_pro:test_unit
+    # Step for test-unit for second CI node
+    KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=1 bundle exec rake knapsack_pro:test_unit
+
+    # Step for Spinach for first CI node
+    KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 bundle exec rake knapsack_pro:spinach
+    # Step for Spinach for second CI node
+    KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=1 bundle exec rake knapsack_pro:spinach
+
+Please remember to set up API token like `KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC` as global environment.
+
+#### Info for AppVeyor users
+
+[AppVeyor](https://www.appveyor.com) 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 CI build.
+
+    # Step for RSpec for first CI node
+    KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 bundle exec rake knapsack_pro:rspec
+    # Step for RSpec for second CI node
+    KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=1 bundle exec rake knapsack_pro:rspec
+
+    # Step for Cucumber for first CI node
+    KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 bundle exec rake knapsack_pro:cucumber
+    # Step for Cucumber for second CI node
+    KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=1 bundle exec rake knapsack_pro:cucumber
+
+    # Step for Minitest for first CI node
+    KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 bundle exec rake knapsack_pro:minitest
+    # Step for Minitest for second CI node
+    KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=1 bundle exec rake knapsack_pro:minitest
+
+    # Step for test-unit for first CI node
+    KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 bundle exec rake knapsack_pro:test_unit
+    # Step for test-unit for second CI node
+    KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=1 bundle exec rake knapsack_pro:test_unit
+
+    # Step for Spinach for first CI node
+    KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 bundle exec rake knapsack_pro:spinach
+    # Step for Spinach for second CI node
+    KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=1 bundle exec rake knapsack_pro:spinach
+
+Please remember to set up API token like `KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC` as global environment.
+
 #### 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:
@@ -995,7 +1061,7 @@ Knapsack Pro supports snap-ci.com ENVs `SNAP_WORKER_TOTAL` and `SNAP_WORKER_INDE
     # Step for Spinach
     bundle exec rake knapsack_pro:spinach
 
-Please remember to set up token like `KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC` as global environment.
+Please remember to set up API token like `KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC` as global environment.
 
 #### Info for cirrus-ci.org users
 
@@ -1016,7 +1082,9 @@ Knapsack Pro supports cirrus-ci.org ENVs `CI_NODE_TOTAL` and `CI_NODE_INDEX`. Th
     # Step for Spinach
     bundle exec rake knapsack_pro:spinach
 
-Please remember to set up token like `KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC` as global environment.
+Please remember to set up API token like `KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC` as global environment.
+
+Here is example for [`.cirrus.yml` configuration file](https://cirrus-ci.org/examples/#ruby).
 
 #### Info for Jenkins users
 
@@ -1478,6 +1546,8 @@ The xml report will contain all tests executed across intermediate test subset r
       end
     end
 
+###### How to use junit formatter with knapsack_pro queue mode when CI nodes use common local drive?
+
 Note if you use a CI provider or your own CI solution that uses common local drive for all parallel CI nodes then above solution needs to be adjusted to produce report file with CI node index number in the file name to avoid file conflicts. Example file name with CI node index number: `tmp/rspec_final_results_N.xml`.
 
 ```
@@ -1508,6 +1578,11 @@ KnapsackPro::Hooks::Queue.after_subset_queue do |queue_id, subset_queue_id|
 end
 ```
 
+###### Why `tmp/rspec_final_results.xml` is corrupted when I use junit formatter with knapsack_pro queue mode?
+
+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 many API keys I need?
 
 Basically you need as many API keys as you have steps in your build.

data/lib/knapsack_pro.rb

@@ -12,6 +12,7 @@ require_relative 'knapsack_pro/hooks/queue'
 require_relative 'knapsack_pro/utils'
 require_relative 'knapsack_pro/logger_wrapper'
 require_relative 'knapsack_pro/config/ci/base'
+require_relative 'knapsack_pro/config/ci/app_veyor'
 require_relative 'knapsack_pro/config/ci/circle'
 require_relative 'knapsack_pro/config/ci/cirrus_ci'
 require_relative 'knapsack_pro/config/ci/gitlab_ci'
@@ -19,6 +20,7 @@ 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/ci/snap_ci'
+require_relative 'knapsack_pro/config/ci/solano_ci'
 require_relative 'knapsack_pro/config/ci/codeship'
 require_relative 'knapsack_pro/config/ci/heroku'
 require_relative 'knapsack_pro/config/env'

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

@@ -0,0 +1,32 @@
+# https://www.appveyor.com/docs/environment-variables/
+module KnapsackPro
+  module Config
+    module CI
+      class AppVeyor < Base
+        def node_total
+          # not provided
+        end
+
+        def node_index
+          # not provided
+        end
+
+        def node_build_id
+          ENV['APPVEYOR_BUILD_ID']
+        end
+
+        def commit_hash
+          ENV['APPVEYOR_REPO_COMMIT']
+        end
+
+        def branch
+          ENV['APPVEYOR_REPO_BRANCH']
+        end
+
+        def project_dir
+          ENV['APPVEYOR_BUILD_FOLDER']
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# http://docs.solanolabs.com/Setup/tddium-set-environment-variables/
+module KnapsackPro
+  module Config
+    module CI
+      class SolanoCI < Base
+        def node_total
+          # not provided
+        end
+
+        def node_index
+          # not provided
+        end
+
+        def node_build_id
+          ENV['TDDIUM_SESSION_ID']
+        end
+
+        def commit_hash
+          ENV['TDDIUM_CURRENT_COMMIT']
+        end
+
+        def branch
+          ENV['TDDIUM_CURRENT_BRANCH']
+        end
+
+        def project_dir
+          ENV['TDDIUM_REPO_ROOT']
+        end
+      end
+    end
+  end
+end

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '0.56.0'
+  VERSION = '0.57.0'
 end

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

@@ -0,0 +1,73 @@
+describe KnapsackPro::Config::CI::AppVeyor 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 environment exists' do
+      let(:env) { { 'APPVEYOR_BUILD_ID' => 123 } }
+      it { should eql 123 }
+    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 environment exists' do
+      let(:env) { { 'APPVEYOR_REPO_COMMIT' => '2e13512fc230d6f9ebf4923352718e4d' } }
+      it { should eql '2e13512fc230d6f9ebf4923352718e4d' }
+    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) { { 'APPVEYOR_REPO_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) { { 'APPVEYOR_BUILD_FOLDER' => '/path/to/clone/repo' } }
+      it { should eql '/path/to/clone/repo' }
+    end
+
+    context "when environment doesn't exist" do
+      it { should be nil }
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+describe KnapsackPro::Config::CI::SolanoCI 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 environment exists' do
+      let(:env) { { 'TDDIUM_SESSION_ID' => 123 } }
+      it { should eql 123 }
+    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 environment exists' do
+      let(:env) { { 'TDDIUM_CURRENT_COMMIT' => '2e13512fc230d6f9ebf4923352718e4d' } }
+      it { should eql '2e13512fc230d6f9ebf4923352718e4d' }
+    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) { { 'TDDIUM_CURRENT_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) { { 'TDDIUM_REPO_ROOT' => '/example/repo/root' } }
+      it { should eql '/example/repo/root' }
+    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.56.0
+  version: 0.57.0
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-16 00:00:00.000000000 Z
+date: 2018-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -233,6 +233,7 @@ files:
 - lib/knapsack_pro/client/api/v1/build_subsets.rb
 - lib/knapsack_pro/client/api/v1/queues.rb
 - lib/knapsack_pro/client/connection.rb
+- lib/knapsack_pro/config/ci/app_veyor.rb
 - lib/knapsack_pro/config/ci/base.rb
 - lib/knapsack_pro/config/ci/buildkite.rb
 - lib/knapsack_pro/config/ci/circle.rb
@@ -242,6 +243,7 @@ files:
 - lib/knapsack_pro/config/ci/heroku.rb
 - lib/knapsack_pro/config/ci/semaphore.rb
 - lib/knapsack_pro/config/ci/snap_ci.rb
+- lib/knapsack_pro/config/ci/solano_ci.rb
 - lib/knapsack_pro/config/ci/travis.rb
 - lib/knapsack_pro/config/env.rb
 - lib/knapsack_pro/config/env_generator.rb
@@ -312,6 +314,7 @@ files:
 - spec/knapsack_pro/client/api/v1/build_subsets_spec.rb
 - spec/knapsack_pro/client/api/v1/queues_spec.rb
 - spec/knapsack_pro/client/connection_spec.rb
+- spec/knapsack_pro/config/ci/app_veyor_spec.rb
 - spec/knapsack_pro/config/ci/base_spec.rb
 - spec/knapsack_pro/config/ci/buildkite_spec.rb
 - spec/knapsack_pro/config/ci/circle_spec.rb
@@ -321,6 +324,7 @@ files:
 - spec/knapsack_pro/config/ci/heroku_spec.rb
 - spec/knapsack_pro/config/ci/semaphore_spec.rb
 - spec/knapsack_pro/config/ci/snap_ci_spec.rb
+- spec/knapsack_pro/config/ci/solano_ci_spec.rb
 - spec/knapsack_pro/config/ci/travis_spec.rb
 - spec/knapsack_pro/config/env_generator_spec.rb
 - spec/knapsack_pro/config/env_spec.rb
@@ -415,6 +419,7 @@ test_files:
 - spec/knapsack_pro/client/api/v1/build_subsets_spec.rb
 - spec/knapsack_pro/client/api/v1/queues_spec.rb
 - spec/knapsack_pro/client/connection_spec.rb
+- spec/knapsack_pro/config/ci/app_veyor_spec.rb
 - spec/knapsack_pro/config/ci/base_spec.rb
 - spec/knapsack_pro/config/ci/buildkite_spec.rb
 - spec/knapsack_pro/config/ci/circle_spec.rb
@@ -424,6 +429,7 @@ test_files:
 - spec/knapsack_pro/config/ci/heroku_spec.rb
 - spec/knapsack_pro/config/ci/semaphore_spec.rb
 - spec/knapsack_pro/config/ci/snap_ci_spec.rb
+- spec/knapsack_pro/config/ci/solano_ci_spec.rb
 - spec/knapsack_pro/config/ci/travis_spec.rb
 - spec/knapsack_pro/config/env_generator_spec.rb
 - spec/knapsack_pro/config/env_spec.rb