knapsack_pro 1.13.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6b31c406c88ef954bb9a6d72f9ee4ba3a4245a98fd4ba4421fd3d22808e573c
-  data.tar.gz: a0990305e67b692e88b3f3136399c41e8330732868628d69873504c7f4020ae2
+  metadata.gz: f9d0dccb9e9eb3866b7a27653dafa2fff75cc46bef7c1ed45741e1ce6ddff8cb
+  data.tar.gz: aa1d8861fe22cf070b271153e64f73cadacc7781e13d98eeead1da0070a2b117
 SHA512:
-  metadata.gz: 811f24df9900bc81b942d9aba6f112e4bb523f19aa9d717711b071239cf36751559b3f56eaf99e0b9e1575bafcf499d595936a22dcca2e567f1995c984c2039c
-  data.tar.gz: fa4e5826771f41d4ed1b907d2045a1aab3a9bd3414a68ab7adcbf19fe82917b36bbbcfefdeb4cafd1fe468041dd507127aa05d0a36e955d0db35706ffa48c3e5
+  metadata.gz: 1aa79fcdb37b38e263ac3fc06ff44d5c2c78d7f75b60428a16edeb5ec766ce1b9fbbe518ef22d14be608ba604b270093d2f3b5db77a83ac8fcfde7d6ffa11a34
+  data.tar.gz: 26fb92a07819d8d21fefe462fef1236e6ba6baa1672ce6edefd6d2e6c6cfcd2e8b8bec81c3371700ba07697e683313aeb66eeb5e74246340982fcc5685f37ba6

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+### 1.14.0
+
+* Add support for GitHub Actions
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/90
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v1.13.0...v1.14.0
+
 ### 1.13.0
 
 * Add support for job index and job count for parallelism in Semaphore 2.0

data/README.md

@@ -112,6 +112,7 @@ You can see list of questions for common problems and tips in below [Table of Co
     - [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)
+    - [Info for GitHub Actions users](#info-for-github-actions-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)
@@ -987,7 +988,21 @@ blocks:
       - name: Run tests with Knapsack Pro
         parallelism: 2
         commands:
+        # Step for RSpec in Queue Mode
         - bundle exec rake knapsack_pro:queue:rspec
+        # Step for Cucumber in Queue Mode
+        - bundle exec rake knapsack_pro:queue:cucumber
+
+        # Step for RSpec in Regular Mode
+        - bundle exec rake knapsack_pro:rspec
+        # Step for Cucumber in Regular Mode
+        - bundle exec rake knapsack_pro:cucumber
+        # Step for Minitest in Regular Mode
+        - bundle exec rake knapsack_pro:minitest
+        # Step for test-unit in Regular Mode
+        - bundle exec rake knapsack_pro:test_unit
+        # Step for Spinach in Regular Mode
+        - bundle exec rake knapsack_pro:spinach
 ```
 
 ##### Semaphore 1.0
@@ -1394,6 +1409,98 @@ Here is [list of environment variables per test runner](#set-api-key-token).
 Above example shows how to run cucumber tests in regular mode and later the rspec tests in queue mode to autobalance build.
 If you are going to relay on rspec to autobalance build when cucumber tests were not perfectly distributed you should be aware about [possible edge case if your rspec test suite is very short](#why-my-tests-are-executed-twice-in-queue-mode-why-ci-node-runs-whole-test-suite-again).
 
+#### Info for GitHub Actions users
+
+knapsack_pro gem supports environment variables provided by GitHub Actions to run your tests. You will have to define a few things in `.github/workflows/main.yaml` config file.
+
+* You need to set API token like `KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC` in GitHub settings -> Secrets for your repository. [Creating and using secrets in GitHub Actions](https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables).
+* You should create as many parallel jobs as you need with [`matrix` property](https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix). If your test suite is slow you should use more parallel jobs. See comment in below config.
+
+Below you can find full GitHub Actions config for Ruby on Rails project.
+
+```yaml
+name: Main
+
+on: [push]
+
+jobs:
+  vm-job:
+    runs-on: ubuntu-latest
+
+    # If you need DB like PostgreSQL then define service below.
+    # Example for Redis can be found here:
+    # https://github.com/actions/example-services/tree/master/.github/workflows
+    services:
+      postgres:
+        image: postgres:10.8
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: ""
+          POSTGRES_DB: postgres
+        ports:
+        # will assign a random free host port
+        - 5432/tcp
+        # needed because the postgres container does not provide a healthcheck
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+
+    strategy:
+      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.
+        # Remember to update ci_node_index below to 0..N-1
+        ci_node_total: [2]
+        # set N-1 indexes for parallel jobs
+        # When you run 2 parallel jobs then first job will have index 0, the second job will have index 1 etc
+        ci_node_index: [0, 1]
+
+    steps:
+    - uses: actions/checkout@v1
+
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.3
+
+    # required to compile pg ruby gem
+    - name: install PostgreSQL client
+      run: sudo apt-get install libpq-dev
+
+    - name: Build and create DB
+      env:
+        # use localhost for the host here because we have specified a container for the job.
+        # If we were running the job on the VM this would be postgres
+        PGHOST: localhost
+        PGUSER: postgres
+        PGPORT: ${{ job.services.postgres.ports[5432] }} # get randomly assigned published port
+        RAILS_ENV: test
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bin/rails db:setup
+
+    - name: Run tests
+      env:
+        PGHOST: localhost
+        PGUSER: postgres
+        PGPORT: ${{ job.services.postgres.ports[5432] }} # get randomly assigned published port
+        RAILS_ENV: test
+        KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC: ${{ secrets.KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC }}
+        KNAPSACK_PRO_CI_NODE_TOTAL: ${{ matrix.ci_node_total }}
+        KNAPSACK_PRO_CI_NODE_INDEX: ${{ matrix.ci_node_index }}
+      run: |
+        # 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
+```
+
 ## FAQ
 
 ### Common problems

data/knapsack_pro.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = KnapsackPro::VERSION
   spec.authors       = ['ArturT']
   spec.email         = ['arturtrzop@gmail.com']
-  spec.summary       = %q{Knapsack Pro splits tests across CI nodes and makes sure that tests will run comparable time on each node.}
-  spec.description   = %q{Parallel tests across CI server nodes based on each test file's time execution. It uses KnapsackPro.com API.}
+  spec.summary       = %q{Knapsack Pro splits tests across parallel CI nodes and ensures each parallel job finish work at a similar time.}
+  spec.description   = %q{Run tests in parallel across CI server nodes based on tests execution time. Split tests in a dynamic way to ensure parallel jobs are done at a similar time. Thanks to that your CI build time is as fast as possible. It works with many CI providers.}
   spec.homepage      = 'https://knapsackpro.com'
   spec.license       = 'MIT'
   spec.metadata    = {

data/lib/knapsack_pro.rb

@@ -22,6 +22,7 @@ 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/github_actions'
 require_relative 'knapsack_pro/config/ci/heroku'
 require_relative 'knapsack_pro/config/env'
 require_relative 'knapsack_pro/config/env_generator'

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

@@ -0,0 +1,34 @@
+# https://help.github.com/en/articles/virtual-environments-for-github-actions#environment-variables
+module KnapsackPro
+  module Config
+    module CI
+      class GithubActions < Base
+        def node_total
+          # not provided
+        end
+
+        def node_index
+          # not provided
+        end
+
+        def node_build_id
+          # not provided
+        end
+
+        def commit_hash
+          ENV['GITHUB_SHA']
+        end
+
+        def branch
+          # GITHUB_REF - The branch or tag ref that triggered the workflow. For example, refs/heads/feature-branch-1.
+          # If neither a branch or tag is available for the event type, the variable will not exist.
+          ENV['GITHUB_REF'] || ENV['GITHUB_SHA']
+        end
+
+        def project_dir
+          ENV['GITHUB_WORKSPACE']
+        end
+      end
+    end
+  end
+end

data/lib/knapsack_pro/version.rb

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

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

@@ -0,0 +1,84 @@
+describe KnapsackPro::Config::CI::GithubActions 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 }
+
+    it { should be nil }
+  end
+
+  describe '#commit_hash' do
+    subject { described_class.new.commit_hash }
+
+    context 'when environment exists' do
+      let(:env) { { 'GITHUB_SHA' => '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
+      context 'when GITHUB_REF has value' do
+        let(:env) do
+          {
+            'GITHUB_REF' => 'master',
+            'GITHUB_SHA' => '2e13512fc230d6f9ebf4923352718e4d',
+          }
+        end
+
+        it { should eql 'master' }
+      end
+
+      context 'when GITHUB_REF is not set' do
+        let(:env) do
+          {
+            'GITHUB_SHA' => '2e13512fc230d6f9ebf4923352718e4d',
+          }
+        end
+
+        it { should eql '2e13512fc230d6f9ebf4923352718e4d' }
+      end
+    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) { { 'GITHUB_WORKSPACE' => '/home/runner/work/my-repo-name/my-repo-name' } }
+      it { should eql '/home/runner/work/my-repo-name/my-repo-name' }
+    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: 1.13.0
+  version: 1.14.0
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-23 00:00:00.000000000 Z
+date: 2019-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -198,8 +198,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.0
-description: Parallel tests across CI server nodes based on each test file's time
-  execution. It uses KnapsackPro.com API.
+description: Run tests in parallel across CI server nodes based on tests execution
+  time. Split tests in a dynamic way to ensure parallel jobs are done at a similar
+  time. Thanks to that your CI build time is as fast as possible. It works with many
+  CI providers.
 email:
 - arturtrzop@gmail.com
 executables:
@@ -239,6 +241,7 @@ files:
 - lib/knapsack_pro/config/ci/circle.rb
 - lib/knapsack_pro/config/ci/cirrus_ci.rb
 - lib/knapsack_pro/config/ci/codeship.rb
+- lib/knapsack_pro/config/ci/github_actions.rb
 - lib/knapsack_pro/config/ci/gitlab_ci.rb
 - lib/knapsack_pro/config/ci/heroku.rb
 - lib/knapsack_pro/config/ci/semaphore.rb
@@ -323,6 +326,7 @@ files:
 - spec/knapsack_pro/config/ci/circle_spec.rb
 - spec/knapsack_pro/config/ci/cirrus_ci_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
 - spec/knapsack_pro/config/ci/heroku_spec.rb
 - spec/knapsack_pro/config/ci/semaphore2_spec.rb
@@ -404,8 +408,8 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Knapsack Pro splits tests across CI nodes and makes sure that tests will
-  run comparable time on each node.
+summary: Knapsack Pro splits tests across parallel CI nodes and ensures each parallel
+  job finish work at a similar time.
 test_files:
 - spec/fixtures/vcr_cassettes/api/v1/build_distributions/subset/invalid_test_suite_token.yml
 - spec/fixtures/vcr_cassettes/api/v1/build_distributions/subset/success.yml
@@ -434,6 +438,7 @@ test_files:
 - spec/knapsack_pro/config/ci/circle_spec.rb
 - spec/knapsack_pro/config/ci/cirrus_ci_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
 - spec/knapsack_pro/config/ci/heroku_spec.rb
 - spec/knapsack_pro/config/ci/semaphore2_spec.rb