knapsack_pro 1.14.0 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9d0dccb9e9eb3866b7a27653dafa2fff75cc46bef7c1ed45741e1ce6ddff8cb
-  data.tar.gz: aa1d8861fe22cf070b271153e64f73cadacc7781e13d98eeead1da0070a2b117
+  metadata.gz: 6de10d3f404a03841c25d3a554c9b44a9b0c9ca97386d46ebe38a3b9eb0eed5f
+  data.tar.gz: 625ad48ee1f6d3a1961f60bf7ce23fe209b26f4f03ec565876050969630eca3e
 SHA512:
-  metadata.gz: 1aa79fcdb37b38e263ac3fc06ff44d5c2c78d7f75b60428a16edeb5ec766ce1b9fbbe518ef22d14be608ba604b270093d2f3b5db77a83ac8fcfde7d6ffa11a34
-  data.tar.gz: 26fb92a07819d8d21fefe462fef1236e6ba6baa1672ce6edefd6d2e6c6cfcd2e8b8bec81c3371700ba07697e683313aeb66eeb5e74246340982fcc5685f37ba6
+  metadata.gz: 5c05eec67c0d656f85049b73f625678b15c813997d84d3ecbdefaa063532a445ecb888b8a08c928dbcf46314dafbf155b1bfb8a2319c923be3e7f958fc04f879
+  data.tar.gz: 0ffbca55a18ab1e35e741edcc90020e3ff7ef1fe58296aa860e9397b48557f85d0d0ae327d3be84794ac062528220e4ed9165aa7223e65d37534be71403bd2e3

data/.circleci/config.yml

@@ -8,7 +8,7 @@ jobs:
     parallelism: 1
     docker:
       # specify the version you desire here
-      - image: circleci/ruby:2.5.0
+      - image: circleci/ruby:2.6.5
         environment:
           CODECLIMATE_REPO_TOKEN: b6626e682a8e97e0c5978febc92c3526792a2d018b41b8e1b52689da37fb7d92
 

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+### 1.15.0
+
+* Add support for Codefresh.io CI provider
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/92
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v1.14.0...v1.15.0
+
 ### 1.14.0
 
 * Add support for GitHub Actions

data/README.md

@@ -113,6 +113,7 @@ You can see list of questions for common problems and tips in below [Table of Co
     - [Info for cirrus-ci.org users](#info-for-cirrus-ciorg-users)
     - [Info for Jenkins users](#info-for-jenkins-users)
     - [Info for GitHub Actions users](#info-for-github-actions-users)
+    - [Info for Codefresh.io users](#info-for-codefreshio-users)
 - [FAQ](#faq)
   - [Common problems](#common-problems)
     - [Why I see API error commit_hash parameter is required?](#why-i-see-api-error-commit_hash-parameter-is-required)
@@ -140,6 +141,7 @@ You can see list of questions for common problems and tips in below [Table of Co
       - [Why when I reran the same build (same commit hash, etc) on Codeship then no tests would get executed in Queue Mode?](#why-when-i-reran-the-same-build-same-commit-hash-etc-on-codeship-then-no-tests-would-get-executed-in-queue-mode)
       - [Why knapsack_pro hangs / freezes / is stale i.e. for Codeship in Queue Mode?](#why-knapsack_pro-hangs--freezes--is-stale-ie-for-codeship-in-queue-mode)
       - [How to find seed in RSpec output when I use Queue Mode for RSpec?](#how-to-find-seed-in-rspec-output-when-i-use-queue-mode-for-rspec)
+      - [How to configure puffing-billy gem with Knapsack Pro Queue Mode?](#how-to-configure-puffing-billy-gem-with-knapsack-pro-queue-mode)
   - [General questions](#general-questions)
     - [How to run tests for particular CI node in your development environment](#how-to-run-tests-for-particular-ci-node-in-your-development-environment)
       - [for knapsack_pro regular mode](#for-knapsack_pro-regular-mode)
@@ -168,6 +170,8 @@ You can see list of questions for common problems and tips in below [Table of Co
     - [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)
+      - [percy-capybara gem version < 4 (old)](#percy-capybara-gem-version--4-old)
+      - [percy-capybara gem version >= 4](#percy-capybara-gem-version--4)
     - [How to call `before(:suite)` and `after(:suite)` RSpec hooks only once in Queue Mode?](#how-to-call-beforesuite-and-aftersuite-rspec-hooks-only-once-in-queue-mode)
     - [What hooks are supported in Queue Mode?](#what-hooks-are-supported-in-queue-mode)
     - [How to run knapsack_pro with parallel_tests gem?](#how-to-run-knapsack_pro-with-parallel_tests-gem)
@@ -247,7 +251,7 @@ end
 
 # add below when you hook into webmock
 require 'webmock/rspec'
-WebMock.disable_net_connect!(allow: ['api.knapsackpro.com'])
+WebMock.disable_net_connect!(allow_localhost: true, allow: ['api.knapsackpro.com'])
 
 # add below when you use FakeWeb
 require 'fakeweb'
@@ -265,6 +269,22 @@ group :test do
 end
 ```
 
+If you happen to see your tests failing due to WebMock not allowing requests to Knapsack Pro API it means you probably reconfigure WebMock in some of your tests.
+For instance, you may use `WebMock.reset!` or it's called automatically in `after(:each)` block, if you `require 'webmock/rspec'` ([more about the issue](https://github.com/bblimke/webmock/issues/484#issuecomment-116193449)). It will remove api.knapsackpro.com from whitelisted domains. Please try below:
+
+```ruby
+RSpec.configure do |config|
+  config.after(:suite) do
+    WebMock.disable_net_connect!(
+      allow_localhost: true,
+      allow: [
+        'api.knapsackpro.com',
+      ],
+    )
+  end
+end
+```
+
 ### Usage (How to set up 1 of 3)
 
 __Tip:__ You can find here an example of a rails app with knapsack_pro already configured.
@@ -1419,6 +1439,7 @@ knapsack_pro gem supports environment variables provided by GitHub Actions to ru
 Below you can find full GitHub Actions config for Ruby on Rails project.
 
 ```yaml
+# .github/workflows/main.yaml
 name: Main
 
 on: [push]
@@ -1444,6 +1465,7 @@ jobs:
         options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
 
     strategy:
+      fail-fast: false
       matrix:
         # Set N number of parallel jobs you want to run tests on.
         # Use higher number if you have slow tests to split them on more parallel jobs.
@@ -1501,6 +1523,128 @@ jobs:
         bundle exec rake knapsack_pro:queue:minitest
 ```
 
+#### Info for Codefresh.io users
+
+knapsack_pro gem supports environment variables provided by Codefresh.io to run your tests. You will have to define a few things in `.codefresh/codefresh.yml` config file.
+
+* You need to set an API token like `KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC` in Codefresh dashboard, see left menu Pipelines -> settings (cog icon next to the pipeline) -> Variables tab (see a vertical menu on the right side). Add there new API token depending on the test runner you use:
+  * `KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC`
+  * `KNAPSACK_PRO_TEST_SUITE_TOKEN_CUCUMBER`
+  * `KNAPSACK_PRO_TEST_SUITE_TOKEN_MINITEST`
+  * `KNAPSACK_PRO_TEST_SUITE_TEST_UNIT`
+  * `KNAPSACK_PRO_TEST_SUITE_TOKEN_SPINACH`
+* Set where Codefresh YAML file can be found. In Codefresh dashboard, see left menu Pipelines -> settings (cog icon next to pipeline) -> Workflow tab (horizontal menu on the top) -> Path to YAML (set there `./.codefresh/codefresh.yml`).
+* Set how many parallel jobs (parallel CI nodes) you want to run with `KNAPSACK_PRO_CI_NODE_TOTAL` environment variable in `.codefresh/codefresh.yml` file.
+* Ensure in the `matrix` section you listed all `KNAPSACK_PRO_CI_NODE_INDEX` environment variables with a value from `0` to `KNAPSACK_PRO_CI_NODE_TOTAL-1`. Codefresh will generate a matrix of parallel jobs where each job has a different value for `KNAPSACK_PRO_CI_NODE_INDEX`. Thanks to that Knapsack Pro knows what tests should be run on each parallel job.
+
+Below you can find Codefresh YAML config and `Test.Dockerfile` used by Codefresh to run Ruby on Rails project with PostgreSQL inside of Docker container.
+
+```yaml
+# .codefresh/codefresh.yml
+version: "1.0"
+
+stages:
+  - "clone"
+  - "build"
+  - "tests"
+
+steps:
+  main_clone:
+    type: "git-clone"
+    description: "Cloning main repository..."
+    repo: "${{CF_REPO_OWNER}}/${{CF_REPO_NAME}}"
+    revision: "${{CF_BRANCH}}"
+    stage: "clone"
+  BuildTestDockerImage:
+    title: Building Test Docker image
+    type: build
+    arguments:
+      image_name: '${{CF_ACCOUNT}}/${{CF_REPO_NAME}}-test'
+      tag: '${{CF_BRANCH_TAG_NORMALIZED}}-${{CF_SHORT_REVISION}}'
+      dockerfile: Test.Dockerfile
+    stage: "build"
+
+  run_tests:
+    stage: "tests"
+    image: '${{BuildTestDockerImage}}'
+    working_directory: /src
+    fail_fast: false
+    environment:
+      - RAILS_ENV=test
+      # set how many parallel jobs you want to run
+      - KNAPSACK_PRO_CI_NODE_TOTAL=2
+      - PGHOST=postgres
+      - PGUSER=rails-app-with-knapsack_pro
+      - PGPASSWORD=password
+    services:
+      composition:
+        postgres:
+          image: postgres:latest
+          environment:
+            - POSTGRES_DB=rails-app-with-knapsack_pro_test
+            - POSTGRES_PASSWORD=password
+            - POSTGRES_USER=rails-app-with-knapsack_pro
+          ports:
+            - 5432
+    matrix:
+      environment:
+        # please ensure you have here listed N-1 indexes
+        # where N is KNAPSACK_PRO_CI_NODE_TOTAL
+        - KNAPSACK_PRO_CI_NODE_INDEX=0
+        - KNAPSACK_PRO_CI_NODE_INDEX=1
+    commands:
+      - bin/rails db:prepare
+
+      # run tests in Knapsack Pro Regular Mode
+      - bundle exec rake knapsack_pro:rspec
+      - bundle exec rake knapsack_pro:cucumber
+      - bundle exec rake knapsack_pro:minitest
+      - bundle exec rake knapsack_pro:test_unit
+      - bundle exec rake knapsack_pro:spinach
+
+      # you can use Knapsack Pro in Queue Mode once recorded first CI build with Regular Mode
+      - bundle exec rake knapsack_pro:queue:rspec
+      - bundle exec rake knapsack_pro:queue:cucumber
+      - bundle exec rake knapsack_pro:queue:minitest
+```
+
+Add `Test.Dockerfile` to your project repository.
+
+```Dockerfile
+# Test.Dockerfile
+FROM ruby:2.6.5-alpine3.10
+
+# Prepare Docker image for Nokogiri
+RUN apk add --update \
+  build-base \
+  libxml2-dev \
+  libxslt-dev \
+  jq \
+  nodejs \
+  npm \
+  postgresql-dev \
+  python3-dev \
+  sqlite-dev \
+  git \
+  && rm -rf /var/cache/apk/*
+
+# Install AWS CLI
+RUN pip3 install awscli
+
+# Use libxml2, libxslt a packages from alpine for building nokogiri
+RUN bundle config build.nokogiri --use-system-libraries
+
+# Install Codefresh CLI
+RUN wget https://github.com/codefresh-io/cli/releases/download/v0.31.1/codefresh-v0.31.1-alpine-x64.tar.gz
+RUN tar -xf codefresh-v0.31.1-alpine-x64.tar.gz -C /usr/local/bin/
+
+COPY . /src
+
+WORKDIR /src
+
+RUN bundle install
+```
+
 ## FAQ
 
 ### Common problems
@@ -1896,6 +2040,51 @@ bundle exec rspec --seed 11055 --default-path spec "spec/a_spec.rb" "spec/b_spec
 
 If you don't use RSpec argument `--order random` then you don't need to provide `--seed` number when you want to reproduce tests in development.
 
+##### How to configure puffing-billy gem with Knapsack Pro Queue Mode?
+
+If you use [puffing-billy](https://github.com/oesmith/puffing-billy) gem you may notice [puffing-billy may crash](https://github.com/oesmith/puffing-billy/issues/253). It happen due to the way how knapsack_pro in Queue Mode uses `RSpec::Core::Runner` ([see](#why-when-i-use-queue-mode-for-rspec-then-my-tests-fail)).
+
+Here is a patch for puffing-billy to make it work in knapsack_pro Queue Mode:
+
+```ruby
+# rails_helper.rb or spec_helper.rb
+
+# A patch to `puffing-billy`'s proxy so that it doesn't try to stop
+# eventmachine's reactor if it's not running.
+module BillyProxyPatch
+  def stop
+    return unless EM.reactor_running?
+    super
+  end
+end
+Billy::Proxy.prepend(BillyProxyPatch)
+
+# A patch to `puffing-billy` to start EM if it has been stopped
+Billy.module_eval do
+  def self.proxy
+    if @billy_proxy.nil? || !(EventMachine.reactor_running? && EventMachine.reactor_thread.alive?)
+      proxy = Billy::Proxy.new
+      proxy.start
+      @billy_proxy = proxy
+    else
+      @billy_proxy
+    end
+  end
+end
+
+if ENV["KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC"]
+  KnapsackPro::Hooks::Queue.before_queue do
+    # executes before Queue Mode starts work
+    Billy.proxy.start
+  end
+
+  KnapsackPro::Hooks::Queue.after_queue do
+    # executes after Queue Mode finishes work
+    Billy.proxy.stop
+  end
+end
+```
+
 ### General questions
 
 #### How to run tests for particular CI node in your development environment
@@ -2298,7 +2487,7 @@ Here is example:
 
 * Step 1. API_KEY_A for `bundle exec rake knapsack_pro:cucumber`
 * Step 2. API_KEY_B for `bundle exec rake knapsack_pro:rspec`
-* Step 3. API_KEY_C for `KNAPSACK_PRO_TEST_FILE_PATTERN="specs/features/*_spec.rb" bundle exec rake knapsack_pro:rspec`
+* Step 3. API_KEY_C for `KNAPSACK_PRO_TEST_FILE_PATTERN="spec/features/*_spec.rb" bundle exec rake knapsack_pro:rspec`
 * Step 4. API_KEY_D for `bundle exec rake knapsack_pro:rspec[--tag tagA]`
 * Step 5. API_KEY_E for `bundle exec rake knapsack_pro:rspec[--tag ~tagA]`
 * Step 6. API_KEY_F for `bundle exec rake knapsack_pro:queue:rspec`
@@ -2335,11 +2524,14 @@ You will run your javascript tests on single CI node and the knapsack_pro will a
 
 #### How to set `before(:suite)` and `after(:suite)` RSpec hooks in Queue Mode (Percy.io example)?
 
+##### percy-capybara gem version < 4 (old)
+
 Some tools like [Percy.io](https://percy.io/docs/clients/ruby/capybara-rails) requires to set hooks for RSpec `before(:suite)` and `after(:suite)`.
 Knapsack Pro Queue Mode runs subset of test files from the work queue many times. This means the RSpec hooks `before(:suite)` and `after(:suite)` will execute multiple times. If you want to run some code only once before Queue Mode starts work and after it finishes then you should do it this way:
 
 ```ruby
 # spec_helper.rb or rails_helper.rb
+# step for percy-capybara gem version < 4
 
 KnapsackPro::Hooks::Queue.before_queue do |queue_id|
   # executes before Queue Mode starts work
@@ -2352,6 +2544,32 @@ KnapsackPro::Hooks::Queue.after_queue do |queue_id|
 end
 ```
 
+##### percy-capybara gem version >= 4
+
+If you use [percy-capybara 4.x](https://docs.percy.io/v1/docs/capybara) then you don't need to set RSpec hooks. Insted you need to run knapsack_pro via percy npm command.
+
+```
+npx percy exec -- rake knapsack_pro:queue:rspec
+
+# or you can use knapsack_pro binary version instead of rake task
+npx percy exec -- knapsack_pro queue:rspec
+```
+
+Read more about [knapsack_pro binary version](#knapsack-pro-binary).
+
+Also you need to follow [Percy step for parallelism](https://docs.percy.io/docs/parallel-test-suites#section-manual-configuration-with-environment-variables).
+
+* `PERCY_PARALLEL_NONCE` - A unique identifier for this build. This can be anything, but it must be the same across parallel build nodes. Usually, this is just the CI build number or a shared timestamp. You can google environment variables for CI provider you use to check what's the env var for build ID.
+
+  You can also find CI build number for your CI provider in [knapsack_pro source code](https://github.com/KnapsackPro/knapsack_pro-ruby/tree/master/lib/knapsack_pro/config/ci). knapsack_pro has built in environment variables integration for various CI providers. See for example [CircleCI](https://github.com/KnapsackPro/knapsack_pro-ruby/blob/master/lib/knapsack_pro/config/ci/circle.rb) - look for method `node_build_id`.
+
+  ```bash
+  # example for using CircleCI build ID
+  export PERCY_PARALLEL_NONCE=$CIRCLE_BUILD_NUM
+  ```
+
+* `PERCY_PARALLEL_TOTAL` - The total number of parallel build nodes.
+
 #### How to call `before(:suite)` and `after(:suite)` RSpec hooks only once in Queue Mode?
 
 Knapsack Pro Queue Mode runs subset of test files from the work queue many times. This means the RSpec hooks `before(:suite)` and `after(:suite)` will be executed multiple times. If you want to run some code only once before Queue Mode starts work and after it finishes then you should do it this way:
@@ -2732,7 +2950,7 @@ If you use for instance Heroku CI that allows you to provide only one test comma
 # $ chmod a+x bin/knapsack_pro_rspec_and_npm_test
 
 # 15 is last CI node (index starts from 0, so in total we have 16 parallel Heroku dynos)
-if [ "$CI_NODE_TOTAL" == "15" ]; then
+if [ "$CI_NODE_INDEX" == "15" ]; then
   # run npm tests on the last CI node
   npm test
 else

data/lib/knapsack_pro.rb

@@ -14,6 +14,7 @@ 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/codefresh'
 require_relative 'knapsack_pro/config/ci/gitlab_ci'
 require_relative 'knapsack_pro/config/ci/semaphore'
 require_relative 'knapsack_pro/config/ci/semaphore2'

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

@@ -0,0 +1,32 @@
+# https://codefresh.io/docs/docs/codefresh-yaml/variables/#system-provided-variables
+module KnapsackPro
+  module Config
+    module CI
+      class Codefresh < Base
+        def node_total
+          # not provided
+        end
+
+        def node_index
+          # not provided
+        end
+
+        def node_build_id
+          ENV['CF_BUILD_ID']
+        end
+
+        def commit_hash
+          ENV['CF_REVISION']
+        end
+
+        def branch
+          ENV['CF_BRANCH']
+        end
+
+        def project_dir
+          # not provided
+        end
+      end
+    end
+  end
+end

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '1.14.0'
+  VERSION = '1.15.0'
 end

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

@@ -0,0 +1,66 @@
+describe KnapsackPro::Config::CI::Codefresh 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) { { 'CF_BUILD_ID' => '1005' } }
+      it { should eql '1005' }
+    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) { { 'CF_REVISION' => 'b624067a61d2134df1db74ebdabb1d8d' } }
+      it { should eql 'b624067a61d2134df1db74ebdabb1d8d' }
+    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) { { 'CF_BRANCH' => 'codefresh-branch' } }
+      it { should eql 'codefresh-branch' }
+    end
+
+    context "when environment doesn't exist" do
+      it { should be nil }
+    end
+  end
+
+  describe '#project_dir' do
+    subject { described_class.new.project_dir }
+
+    it { should be nil }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.15.0
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-13 00:00:00.000000000 Z
+date: 2019-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -240,6 +240,7 @@ files:
 - lib/knapsack_pro/config/ci/buildkite.rb
 - lib/knapsack_pro/config/ci/circle.rb
 - lib/knapsack_pro/config/ci/cirrus_ci.rb
+- lib/knapsack_pro/config/ci/codefresh.rb
 - lib/knapsack_pro/config/ci/codeship.rb
 - lib/knapsack_pro/config/ci/github_actions.rb
 - lib/knapsack_pro/config/ci/gitlab_ci.rb
@@ -325,6 +326,7 @@ files:
 - spec/knapsack_pro/config/ci/buildkite_spec.rb
 - spec/knapsack_pro/config/ci/circle_spec.rb
 - spec/knapsack_pro/config/ci/cirrus_ci_spec.rb
+- spec/knapsack_pro/config/ci/codefresh_spec.rb
 - spec/knapsack_pro/config/ci/codeship_spec.rb
 - spec/knapsack_pro/config/ci/github_actions_spec.rb
 - spec/knapsack_pro/config/ci/gitlab_ci_spec.rb
@@ -405,7 +407,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Knapsack Pro splits tests across parallel CI nodes and ensures each parallel
@@ -437,6 +439,7 @@ test_files:
 - spec/knapsack_pro/config/ci/buildkite_spec.rb
 - spec/knapsack_pro/config/ci/circle_spec.rb
 - spec/knapsack_pro/config/ci/cirrus_ci_spec.rb
+- spec/knapsack_pro/config/ci/codefresh_spec.rb
 - spec/knapsack_pro/config/ci/codeship_spec.rb
 - spec/knapsack_pro/config/ci/github_actions_spec.rb
 - spec/knapsack_pro/config/ci/gitlab_ci_spec.rb