knapsack_pro 0.28.1 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed7d84e6a7751a94b9b7d9dc71f8a67b081dcc85
-  data.tar.gz: 48eb86e58ac7e812b94fad49fe16ed9a231d3d7b
+  metadata.gz: 90b70ad7eb455a9d71943d0d263d3521cfa3b9b2
+  data.tar.gz: 5fff38d0c65bdff7c8ec10006c2365ce8a441076
 SHA512:
-  metadata.gz: aa166fb2006447742c0759483884e766c826f4cf9ecc4ab95f1acecb007ec976ad6dd42e2bf011b0bc3950893be0c0cef90ed2b2b18a706cd3b4045a6786f67f
-  data.tar.gz: 5bc4cf8a32f606f7874bb974823d82cd8118eefcae389d4d38f3186200e994de06a4852b94aec079ad42a341946e73cab195e8df960d0a1c1a13cc484f133c3e
+  metadata.gz: 81287d9a98148dcb902a64ae4448adeb0459c8c84f9e77aee5dbfb101a49fecc6a58841472909de16cf4aa9565146fecff8ac3bab2973b565f60896ead9be810
+  data.tar.gz: b4c7ca6dacc16ff8c0c98ccf6ab1698a89fd69e9ef6eab5a39a9744ef8ec9d36f3b7d3bce178abbb8fd8cfe5eae65ef57fb19a182508448ed36f1794f40d2084

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 * TODO
 
+### 0.29.0
+
+* Add info about Jenkins to installer.
+* Extend info about final step in installer about verification if first test suite run was recorded correctly.
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v0.28.1...v0.29.0
+
 ### 0.28.1
 
 * Add support for test files in directory with spaces.

data/README.md

@@ -94,6 +94,7 @@ The knapsack_pro has also [queue mode](#queue-mode) to get most optimal test sui
     - [Info for semaphoreapp.com users](#info-for-semaphoreappcom-users)
     - [Info for buildkite.com users](#info-for-buildkitecom-users)
     - [Info for snap-ci.com users](#info-for-snap-cicom-users)
+    - [Info for Jenkins users](#info-for-jenkins-users)
 - [FAQ](#faq)
   - [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 knapack_pro regular mode](#for-knapack_pro-regular-mode)
@@ -679,6 +680,69 @@ Knapsack Pro supports snap-ci.com ENVs `SNAP_WORKER_TOTAL` and `SNAP_WORKER_INDE
 
 Please remember to set up token like `KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC` as global environment.
 
+#### Info for Jenkins users
+
+In order to run parallel jobs with Jenkins you should use Jenkins Pipeline.
+You can learn basics about it in the article [Parallelism and Distributed Builds with Jenkins](https://www.cloudbees.com/blog/parallelism-and-distributed-builds-jenkins).
+
+Here is example `Jenkinsfile` working with Jenkins Pipeline.
+
+```
+timeout(time: 60, unit: 'MINUTES') {
+  node() {
+    stage('Checkout') {
+      checkout([/* checkout code from git */])
+
+      // determine git commit hash because we need to pass it to knapsack_pro
+      COMMIT_HASH = sh(returnStdout: true, script: 'git rev-parse HEAD').trim()
+
+      stash 'source'
+    }
+  }
+
+  def num_nodes = 4; // define your total number of CI nodes (how many parallel jobs will be executed)
+  def nodes = [:]
+
+  for (int i = 0; i < num_nodes; i++) {
+    def index = i;
+    nodes["ci_node_${i}"] = {
+      node() {
+        stage('Setup') {
+          unstash 'source'
+          // other setup steps
+        }
+
+        def knapsack_options = """\
+            KNAPSACK_PRO_CI_NODE_TOTAL=${num_nodes}\
+            KNAPSACK_PRO_CI_NODE_INDEX=${index}\
+            KNAPSACK_PRO_COMMIT_HASH=${COMMIT_HASH}\
+            KNAPSACK_PRO_BRANCH=${env.BRANCH_NAME}\
+        """
+
+        // example how to run cucumber tests in Knapsack Pro Regular Mode
+        stage('Run cucumber') {
+          sh """${knapsack_options} bundle exec rake knapsack_pro:cucumber"""
+        }
+
+        // example how to run rspec tests in Knapsack Pro Queue Mode
+        // Queue Mode should be as a last stage so it can autobalance build if tests in regular mode were not perfectly distributed
+        stage('Run rspec') {
+          sh """KNAPSACK_PRO_CI_NODE_BUILD_ID=${env.BUILD_TAG} ${knapsack_options} bundle exec rake knapsack_pro:queue:rspec"""
+        }
+      }
+    }
+  }
+
+  parallel nodes // run CI nodes in parallel
+}
+```
+
+Remember to set environment variables in Jenkins configuration with your API tokens like `KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC` and `KNAPSACK_PRO_TEST_SUITE_TOKEN_CUCUMBER`.
+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).
+
 ## FAQ
 
 ### How to run tests for particular CI node in your development environment
@@ -940,8 +1004,8 @@ Thanks to that when for some reason the tests executed for cucumber in regular m
 
 ### Why my tests are executed twice in queue mode? Why CI node runs whole test suite again?
 
-This may happen when one of your CI node started work when all other CI nodes already executed whole test suite.
-This slow CI node will initialize a new queue hence the tests executed twice. To solve this problem you should set `KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true`.
+This may happen when one of your CI node started work later when all other CI nodes already executed whole test suite.
+The slow CI node will initialize a new queue hence the tests executed twice. To solve this problem you should set `KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true`.
 Please [read this](#knapsack_pro_fixed_queue_split-remember-queue-split-on-retry-ci-node).
 
 ## Gem tests

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '0.28.1'
+  VERSION = '0.29.0'
 end

data/lib/tasks/install.rake

@@ -188,6 +188,13 @@ bundle exec rake knapsack_pro:#{tool}
   set_api_tokens_on_ci(prompt, answers)
 end
 
+def step_for_ci_jenkins(prompt, answers)
+  prompt.say "Step for Jenkins", color: :yellow
+  prompt.say "Please visit page to see example Jenkinsfile:"
+  prompt.say "https://github.com/KnapsackPro/knapsack_pro-ruby#info-for-jenkins-users"
+  puts
+end
+
 def step_for_ci_other(prompt, answers)
   prompt.say "Step for other CI provider", color: :yellow
   prompt.say "Set below global variables on your CI server."
@@ -284,6 +291,7 @@ namespace :knapsack_pro do
       'https://buildkite.com' => :buildkite,
       'https://semaphoreci.com' => :semaphore,
       'https://snap-ci.com' => :snap_ci,
+      'Jenkins' => :jenkins,
       'other' => :other,
     }
     answers[:ci] = prompt.select("What is your CI provider?", CI_PROVIDER_CHOICES)
@@ -308,9 +316,14 @@ namespace :knapsack_pro do
 
     send("step_for_ci_#{answers[:ci]}", prompt, answers)
 
+    prompt.say "Final step", color: :yellow
     prompt.say "Now you are ready to use the gem!"
+    puts
     prompt.say "Please push a new commit to repository so knapsack_pro gem will record time execution of your test suite."
-    prompt.say "Your second test suite run on CI will be parallelized with optimal test suite split."
+    puts
+    prompt.say "Go to user dashboard https://knapsackpro.com/dashboard and click build metrics link next to your API token. Click show link on recent build and ensure the time execution data were recorded for all your CI nodes. You should see info that build subsets were collected."
+    puts
+    prompt.say "Your second test suite run on CI will be parallelized with optimal test suite split if first run was recorded correctly."
     puts
     puts
     prompt.say "Later you may want to learn about Queue Mode and how to enable it:"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 0.28.1
+  version: 0.29.0
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-22 00:00:00.000000000 Z
+date: 2017-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake