knapsack_pro 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9207f8f421d46b1760bb1f73849d061d570f92b0f25d6f562786d707404d9de6
-  data.tar.gz: d76fa0771d644dcc45b41a471d4196bbe1fd76ec4663a5316d73f60e7f587f42
+  metadata.gz: 406093c37a1985ce7cf5b2c89f625a226c4d42d8c4554eaac9037901fcfc3707
+  data.tar.gz: b299828d599720303c5203caee6bebe3d5b96e122fbf878924ac00c6cf4b6db2
 SHA512:
-  metadata.gz: 106bba52089e1f8984ae7b7c0f136d6c66a0196fbbccb070d103ed331fc07d5d63a0618e55e6ec04bbe0531b29f2ba9d3d7306e5d039ccb5a76343688363a922
-  data.tar.gz: 3ef0616787f95bbfe59b4837b96947f397c7307f7ae61824fc28126a90c10f252b6d5844153755337baab963cb7ef53b86c05021847fda2725401335730db808
+  metadata.gz: aa7533794502874dee1c1275197166f99a5cb8ff63e3e37736fc4c2d66586af7a53088ca4a3a194f54a50a94d62c071253f421255a608bf9250cb5a9521bd3ef
+  data.tar.gz: 59b4abd2a72a5f979aa0dbde8cab8a62f1e8c06f37415bba258649ae6c9d7e373cdbe131514e7ad2f7b6870b8251a3c25ae50c37fd1847650e1761802ce39378

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+### 1.5.0
+
+* Add support for Semaphore CI 2.0
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/77
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v1.4.0...v1.5.0
+
 ### 1.4.0
 
 * Use .test domain for development mode

data/README.md

@@ -98,7 +98,9 @@ You can see list of questions for common problems and tips in below [Table of Co
     - [Info for CircleCI users](#info-for-circleci-users)
       - [CircleCI and knapsack_pro Queue Mode](#circleci-and-knapsack_pro-queue-mode)
     - [Info for Travis users](#info-for-travis-users)
-    - [Info for semaphoreapp.com users](#info-for-semaphoreappcom-users)
+    - [Info for semaphoreci.com users](#info-for-semaphorecicom-users)
+      - [Semaphore 2.0](#semaphore-20)
+      - [Semaphore 1.0](#semaphore-10)
     - [Info for buildkite.com users](#info-for-buildkitecom-users)
     - [Info for GitLab CI users](#info-for-gitlab-ci-users)
       - [GitLab CI `>= 11.5`](#gitlab-ci--115)
@@ -121,6 +123,7 @@ You can see list of questions for common problems and tips in below [Table of Co
     - [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)
+      - [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 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)
@@ -582,9 +585,11 @@ Note this is for knapack_pro regular mode only.
 
 This is only for maintainer of knapsack_pro gem. Not for the end users.
 
-`KNAPSACK_PRO_ENDPOINT` - Default value is `https://api.knapsackpro.com` which is endpoint for [Knapsack Pro API](http://docs.knapsackpro.com).
+* `KNAPSACK_PRO_ENDPOINT` - Default value is `https://api.knapsackpro.com` which is endpoint for [Knapsack Pro API](http://docs.knapsackpro.com).
 
-`KNAPSACK_PRO_MODE` - Default value is `production`. When mode is `development` then endpoint is `http://api.knapsackpro.test:3000`. When mode is `test` then endpoint is `http://api-staging.knapsackpro.com`.
+* `KNAPSACK_PRO_MODE` - Default value is `production` and then endpoint is `https://api.knapsackpro.com`.
+  * When mode is `development` then endpoint is `http://api.knapsackpro.test:3000`.
+  * When mode is `test` then endpoint is `https://api-staging.knapsackpro.com`.
 
 ### Passing arguments to rake task
 
@@ -865,7 +870,104 @@ Such configuration will generate matrix with 2 following ENV rows:
 
 More info about global and matrix ENV configuration in [travis docs](https://docs.travis-ci.com/user/customizing-the-build/#build-matrix).
 
-#### Info for semaphoreapp.com users
+#### Info for semaphoreci.com users
+
+##### Semaphore 2.0
+
+knapack_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.
+
+Below you can find full Semaphore CI 2.0 config for Rails project.
+
+```yaml
+# .semaphore/semaphore.yml
+# Use the latest stable version of Semaphore 2.0 YML syntax:
+version: v1.0
+
+# Name your pipeline. In case you connect multiple pipelines with promotions,
+# the name will help you differentiate between, for example, a CI build phase
+# and delivery phases.
+name: Demo Rails 5 app
+
+# An agent defines the environment in which your code runs.
+# It is a combination of one of available machine types and operating
+# system images.
+# See https://docs.semaphoreci.com/article/20-machine-types
+# and https://docs.semaphoreci.com/article/32-ubuntu-1804-image
+agent:
+  machine:
+    type: e1-standard-2
+    os_image: ubuntu1804
+
+# Blocks are the heart of a pipeline and are executed sequentially.
+# Each block has a task that defines one or more jobs. Jobs define the
+# commands to execute.
+# See https://docs.semaphoreci.com/article/62-concepts
+blocks:
+  - name: Setup
+    task:
+      env_vars:
+        - name: RAILS_ENV
+          value: test
+      jobs:
+        - name: bundle
+          commands:
+          # Checkout code from Git repository. This step is mandatory if the
+          # job is to work with your code.
+          # Optionally you may use --use-cache flag to avoid roundtrip to
+          # remote repository.
+          # See https://docs.semaphoreci.com/article/54-toolbox-reference#libcheckout
+          - checkout
+          # Restore dependencies from cache.
+          # Read about caching: https://docs.semaphoreci.com/article/54-toolbox-reference#cache
+          - cache restore gems-$SEMAPHORE_GIT_BRANCH-$(checksum Gemfile.lock),gems-$SEMAPHORE_GIT_BRANCH-,gems-master-
+          # Set Ruby version:
+          - sem-version ruby 2.6.1
+          - bundle install --jobs=4 --retry=3 --path vendor/bundle
+          # Store the latest version of dependencies in cache,
+          # to be used in next blocks and future workflows:
+          - cache store gems-$SEMAPHORE_GIT_BRANCH-$(checksum Gemfile.lock) vendor/bundle
+
+  - name: RSpec tests
+    task:
+      env_vars:
+        - name: RAILS_ENV
+          value: test
+        - name: PGHOST
+          value: 127.0.0.1
+        - name: PGUSER
+          value: postgres
+        - name: KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC
+          value: your_api_token_here
+      # This block runs two jobs in parallel and they both share common
+      # setup steps. We can group them in a prologue.
+      # See https://docs.semaphoreci.com/article/50-pipeline-yaml#prologue
+      prologue:
+        commands:
+          - checkout
+          - cache restore gems-$SEMAPHORE_GIT_BRANCH-$(checksum Gemfile.lock),gems-$SEMAPHORE_GIT_BRANCH-,gems-master-
+          # Start Postgres database service.
+          # See https://docs.semaphoreci.com/article/54-toolbox-reference#sem-service
+          - sem-service start postgres
+          - sem-version ruby 2.6.1
+          - bundle install --jobs=4 --retry=3 --path vendor/bundle
+          - bundle exec rake db:setup
+
+      jobs:
+      - name: Node 0 - Knapsack Pro
+        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
+```
+
+##### Semaphore 1.0
 
 Knapsack Pro supports semaphoreapp ENVs `SEMAPHORE_THREAD_COUNT` and `SEMAPHORE_CURRENT_THREAD`. The only thing you need to do is set up knapsack_pro rspec/cucumber/minitest/test_unit command for as many threads as you need. Here is an example:
 
@@ -1346,6 +1448,25 @@ FactoryBot.define do
 end
 ```
 
+##### Why when I use Queue Mode for RSpec then my rake tasks are run twice?
+
+Why rake tasks are being ran twice in Queue Mode? If you have tests for your rake task then you want to ensure you clear the rake task before loading it inside of test file.
+In Queue Mode the  rake task could be already loaded and loading it again in test file may result in running the task twice.
+
+```ruby
+before do
+  # Clear rake task from memory if it was already loaded.
+  # This ensures rake task is loaded only once in knapsack_pro Queue Mode.
+  Rake::Task[task_name].clear if Rake::Task.task_defined?(task_name)
+
+  # loaad rake task only once here
+  Rake.application.rake_require("tasks/dummy")
+  Rake::Task.define_task(:environment)
+end
+```
+
+Here is the full [example how to test rake task along with dummy rake task](https://github.com/KnapsackPro/rails-app-with-knapsack_pro/commit/9f068e900deb3554bd72633e8d61c1cc7f740306) from our example rails project.
+
 ##### Why when I use Queue Mode for RSpec then I see error `superclass mismatch for class`?
 
 You may see error like:
@@ -2022,7 +2143,9 @@ To ensure everything works you can check output for each CI node.
 
 Flaky (nondeterministic) tests, are tests that exhibit both a passing and a failing result with the same code.
 
-You can use [only failures option in RSpec](https://relishapp.com/rspec/rspec-core/docs/command-line/only-failures) to rerun failed tests.
+I recommend to use [rspec-retry](https://github.com/NoRedInk/rspec-retry) gem that can retry failing test. It can be useful for randomly failing features specs. For instance you can configure it to retry 3 times features test before marking it as failing.
+
+Alternative way is to use built into [RSpec only failures option](https://relishapp.com/rspec/rspec-core/docs/command-line/only-failures) to rerun failed tests.
 
 Please add to your RSpec configuration:
 
@@ -2146,7 +2269,7 @@ The test file pattern and exclude pattern support any glob pattern handled by [`
 
 #### How to use CodeClimate with knapsack_pro?
 
-You can check CodeClimate docs about [parallel and multiple test suites](https://docs.codeclimate.com/docs/configuring-test-coverage#section-parallel-and-multiple-test-suites).
+You can check CodeClimate docs about [parallel tests](https://docs.codeclimate.com/docs/configuring-test-coverage#section-parallel-tests) and [multiple test suites](https://docs.codeclimate.com/docs/configuring-test-coverage#section-multiple-test-suites).
 
 #### How to run knapsack_pro only on a few parallel CI nodes instead of all?
 

data/lib/knapsack_pro.rb

@@ -16,6 +16,7 @@ require_relative 'knapsack_pro/config/ci/circle'
 require_relative 'knapsack_pro/config/ci/cirrus_ci'
 require_relative 'knapsack_pro/config/ci/gitlab_ci'
 require_relative 'knapsack_pro/config/ci/semaphore'
+require_relative 'knapsack_pro/config/ci/semaphore2'
 require_relative 'knapsack_pro/config/ci/buildkite'
 require_relative 'knapsack_pro/config/ci/travis'
 require_relative 'knapsack_pro/config/ci/snap_ci'

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

@@ -0,0 +1,34 @@
+# https://docs.semaphoreci.com/article/12-environment-variables
+module KnapsackPro
+  module Config
+    module CI
+      class Semaphore2 < Base
+        def node_total
+          # not provided
+        end
+
+        def node_index
+          # not provided
+        end
+
+        def node_build_id
+          ENV['SEMAPHORE_WORKFLOW_ID']
+        end
+
+        def commit_hash
+          ENV['SEMAPHORE_GIT_SHA']
+        end
+
+        def branch
+          ENV['SEMAPHORE_GIT_BRANCH']
+        end
+
+        def project_dir
+          if ENV['HOME'] && ENV['SEMAPHORE_GIT_DIR']
+            "#{ENV['HOME']}/#{ENV['SEMAPHORE_GIT_DIR']}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '1.4.0'
+  VERSION = '1.5.0'
 end

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

@@ -0,0 +1,96 @@
+describe KnapsackPro::Config::CI::Semaphore2 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) { { 'SEMAPHORE_WORKFLOW_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) { { 'SEMAPHORE_GIT_SHA' => '4323320992a21b1169e3ac5b7789d379597738e6' } }
+      it { should eql '4323320992a21b1169e3ac5b7789d379597738e6' }
+    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) { { 'SEMAPHORE_GIT_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 HOME and SEMAPHORE_GIT_DIR environments exist' do
+      let(:env) do
+        {
+          'HOME' => '/home/semaphore',
+          'SEMAPHORE_GIT_DIR' => 'project-name',
+        }
+      end
+      it { should eql '/home/semaphore/project-name' }
+    end
+
+    context 'when only HOME environment exists' do
+      let(:env) do
+        {
+          'HOME' => '/home/semaphore',
+        }
+      end
+      it { should be nil }
+    end
+
+    context 'when only SEMAPHORE_GIT_DIR environment exists' do
+      let(:env) do
+        {
+          'SEMAPHORE_GIT_DIR' => 'project-name'
+        }
+      end
+      it { should be nil }
+    end
+
+    context "when environments don'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: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-03 00:00:00.000000000 Z
+date: 2019-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -242,6 +242,7 @@ files:
 - lib/knapsack_pro/config/ci/gitlab_ci.rb
 - lib/knapsack_pro/config/ci/heroku.rb
 - lib/knapsack_pro/config/ci/semaphore.rb
+- lib/knapsack_pro/config/ci/semaphore2.rb
 - lib/knapsack_pro/config/ci/snap_ci.rb
 - lib/knapsack_pro/config/ci/solano_ci.rb
 - lib/knapsack_pro/config/ci/travis.rb
@@ -322,6 +323,7 @@ files:
 - spec/knapsack_pro/config/ci/codeship_spec.rb
 - spec/knapsack_pro/config/ci/gitlab_ci_spec.rb
 - spec/knapsack_pro/config/ci/heroku_spec.rb
+- spec/knapsack_pro/config/ci/semaphore2_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
@@ -431,6 +433,7 @@ test_files:
 - spec/knapsack_pro/config/ci/codeship_spec.rb
 - spec/knapsack_pro/config/ci/gitlab_ci_spec.rb
 - spec/knapsack_pro/config/ci/heroku_spec.rb
+- spec/knapsack_pro/config/ci/semaphore2_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