knapsack_pro 0.25.0 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 911de2285757ea2787d872ff9e595910331d0e2c
-  data.tar.gz: 990c07a1d06f884849eeb98a904f360e741a33f8
+  metadata.gz: 7703c67b5430e96304f84ffe6180d2724ced2024
+  data.tar.gz: 42504a31a204cbec81297226b1106a5a93b3c97e
 SHA512:
-  metadata.gz: 3830d979ef91be8c88baaa9d79e446750c83bbaea35974ab5331bceac8e02b5dbfd3f05b1ae1834acdeabb39b27d32051a46934da541660a012910eeee5b8511
-  data.tar.gz: bc7922ae770633bf1f23c0bbb501df18b5e29cd64b0ddcba51b36e56cea427143200d7ee6c8316edce3534f4950634b7097e4aa90936c2b7c04b3ddeba93e902
+  metadata.gz: b30a77c07bb4b62bcb67b767f279062d4ae0a7497f8da5d411a9b2f834ef2f48c1afe4562a3a339c869e81888a3f086256064b0154e3bc28526560f113e36cc6
+  data.tar.gz: 8099e1690a714695f646dd1dc3617554f257dea090b3b384f1a3407e693891d2f577b78c5678ae6c45b2f77f8362abbeaa99af6505bbc86451ebb5800b3d0f65

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 * TODO
 
+### 0.26.0
+
+* Add info how to allow FakeWeb to connect with Knapsack Pro API in install rake task.
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v0.25.0...v0.26.0
+
 ### 0.25.0
 
 * Queue mode retry (remember queue split on retry CI node).

data/README.md

@@ -96,6 +96,8 @@ The knapsack_pro has also [queue mode](#queue-mode) to get most optimal test sui
     - [Info for snap-ci.com users](#info-for-snap-cicom-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)
+    - [for knapsack_pro queue mode](#for-knapsack_pro-queue-mode)
   - [What happens when Knapsack Pro API is not available/not reachable temporarily?](#what-happens-when-knapsack-pro-api-is-not-availablenot-reachable-temporarily)
   - [How can I change log level?](#how-can-i-change-log-level)
   - [How to split tests based on test level instead of test file level?](#how-to-split-tests-based-on-test-level-instead-of-test-file-level)
@@ -145,7 +147,9 @@ You can read next section only if you want to better understand optional gem con
 
 ## How to set up
 
-If you are using [VCR gem](https://github.com/vcr/vcr) then add Knapsack Pro API subdomain to [ignore hosts](https://www.relishapp.com/vcr/vcr/v/2-9-3/docs/configuration/ignore-request):
+If you use [VCR](https://github.com/vcr/vcr), [WebMock](https://github.com/bblimke/webmock) or [FakeWeb](https://github.com/chrisk/fakeweb) gems then you need to allow them to make requests to Knapsack Pro API.
+
+For VCR add Knapsack Pro API subdomain to [ignore hosts](https://www.relishapp.com/vcr/vcr/v/2-9-3/docs/configuration/ignore-request):
 
 ```ruby
 # spec/spec_helper.rb or wherever is your VCR configuration
@@ -159,6 +163,10 @@ end
 # add below when you hook into webmock
 require 'webmock/rspec'
 WebMock.disable_net_connect!(:allow => ['api.knapsackpro.com'])
+
+# add below when you use FakeWeb
+require 'fakeweb'
+FakeWeb.allow_net_connect = %r[^https?://api\.knapsackpro\.com]
 ```
 
 Ensure you have require false for webmock gem when VCR is hook into it. Thanks to that webmock configuration in `spec_helper.rb` is loaded properly.
@@ -169,6 +177,7 @@ Ensure you have require false for webmock gem when VCR is hook into it. Thanks t
 group :test do
   gem 'vcr'
   gem 'webmock', require: false
+  gem 'fakeweb', require: false # example when you use fakeweb
 end
 ```
 
@@ -642,6 +651,8 @@ Please remember to set up token like `KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC` as gl
 
 ### How to run tests for particular CI node in your development environment
 
+#### for knapack_pro regular mode
+
 In your development environment you can debug tests that were run on the particular CI node.
 For instance to run subset of tests for the first CI node with specified seed you can do.
 
@@ -653,6 +664,51 @@ For instance to run subset of tests for the first CI node with specified seed yo
     bundle exec rake "knapsack_pro:rspec[--seed 123]"
 
 Above example is for RSpec. You can use respectively rake task name and token environment variable when you want to run tests for minitest, cucumber or spinach.
+It should work when all CI nodes finished work and sent time execution data to Knapsack Pro API.
+You can visit [user dashboard](https://knapsackpro.com/dashboard) to preview particular CI build and ensure time execution data were collected from all CI nodes.
+If at least one CI node has not sent time execution data to the Knapsack Pro API then you should check below solution.
+
+Check test runner output on particular CI node you would like to retry in development. You should see at the beginning of rspec command an output that can
+be copied and executed in development.
+
+    /Users/ubuntu/.rvm/gems/ruby-2.4.0/gems/rspec-core-3.4.4/exe/rspec spec/foo_spec.rb spec/bar_spec.rb --default-path spec
+
+Command similar to above can be executed in your development this way:
+
+    bundle exec rspec spec/foo_spec.rb spec/bar_spec.rb --default-path spec
+
+If you were running your tests with `--order random` on your CI then you can additionaly pass seed param with proper value in above command (`--seed 123`).
+
+#### for knapsack_pro queue mode
+
+To retry the particular CI node do this on your machine:
+
+    KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC=token \
+    KNAPSACK_PRO_REPOSITORY_ADAPTER=git \
+    KNAPSACK_PRO_PROJECT_DIR=~/projects/rails-app \
+    KNAPSACK_PRO_CI_NODE_TOTAL=2 \
+    KNAPSACK_PRO_CI_NODE_INDEX=0 \
+    KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true \
+    bundle exec rake "knapsack_pro:queue:rspec"
+
+If you were running your tests with `--order random` on your CI like this:
+
+    bundle exec rake "knapsack_pro:queue:rspec[--order random]"
+
+Then you can find the seed number visible in rspec output:
+
+    (...)
+    Randomized with seed 123
+
+You can pass the seed in your local environment to reproduce the tests in the same order as they were executed on CI node:
+
+    KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC=token \
+    KNAPSACK_PRO_REPOSITORY_ADAPTER=git \
+    KNAPSACK_PRO_PROJECT_DIR=~/projects/rails-app \
+    KNAPSACK_PRO_CI_NODE_TOTAL=2 \
+    KNAPSACK_PRO_CI_NODE_INDEX=0 \
+    KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true \
+    bundle exec rake "knapsack_pro:queue:rspec[--seed 123]"
 
 ### What happens when Knapsack Pro API is not available/not reachable temporarily?
 

data/lib/knapsack_pro/client/connection.rb

@@ -2,6 +2,7 @@ module KnapsackPro
   module Client
     class Connection
       TIMEOUT = 30
+      REQUEST_RETRY_TIMEBOX = 2
 
       def initialize(action)
         @action = action
@@ -103,7 +104,7 @@ module KnapsackPro
         logger.warn(e.inspect)
         retries += 1
         if retries < 5
-          wait = retries * 2
+          wait = retries * REQUEST_RETRY_TIMEBOX
           logger.warn("Wait #{wait}s and retry request to Knapsack Pro API.")
           sleep wait
           retry

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '0.25.0'
+  VERSION = '0.26.0'
 end

data/lib/tasks/install.rake

@@ -43,7 +43,7 @@ KnapsackPro::Adapters::SpinachAdapter.bind
 end
 
 def step_for_vcr(prompt)
-  prompt.say "Step for VCR gem", color: :yellow
+  prompt.say "Step for VCR/WebMock/FakeWeb gems", color: :yellow
   prompt.say "Add Knapsack Pro API subdomain to ignore hosts"
   prompt.say "in spec/spec_helper.rb or wherever is your VCR configuration:"
 
@@ -57,6 +57,10 @@ end
 # add below when you hook into webmock
 require 'webmock/rspec'
 WebMock.disable_net_connect!(:allow => ['api.knapsackpro.com'])
+
+# add below when you use FakeWeb
+require 'fakeweb'
+FakeWeb.allow_net_connect = %r[^https?://api\.knapsackpro\.com]
   }, color: :cyan
 
   puts
@@ -67,6 +71,7 @@ WebMock.disable_net_connect!(:allow => ['api.knapsackpro.com'])
 group :test do
   gem 'vcr'
   gem 'webmock', require: false
+  gem 'fakeweb', require: false # example when you use fakeweb
 end
   }, color: :cyan
 end
@@ -271,7 +276,7 @@ namespace :knapsack_pro do
       answers[:testing_tools] = prompt.multi_select("Choose your testing tools:", TESTING_TOOLS_CHOICES)
     end
 
-    answers[:has_vcr] = prompt.yes?('Do you use VCR gem?')
+    answers[:has_vcr] = prompt.yes?('Do you use VCR, WebMock or FakeWeb gem?')
 
     CI_PROVIDER_CHOICES = {
       'https://circleci.com' => :circle,

data/spec/integration/api/build_distributions_subset_spec.rb

@@ -62,6 +62,7 @@ describe 'Request API /v1/build_distributions/subset' do
 
     it do
       stub_const('KnapsackPro::Client::Connection::TIMEOUT', 0.01)
+      stub_const('KnapsackPro::Client::Connection::REQUEST_RETRY_TIMEBOX', 0.01)
       VCR.use_cassette('api/v1/build_distributions/subset/timeout') do
         response = connection.call
         puts response

data/spec/integration/api/build_subsets_create_spec.rb

@@ -64,6 +64,7 @@ describe 'Request API /v1/build_subsets' do
 
     it do
       stub_const('KnapsackPro::Client::Connection::TIMEOUT', 0.01)
+      stub_const('KnapsackPro::Client::Connection::REQUEST_RETRY_TIMEBOX', 0.01)
       VCR.use_cassette('api/v1/build_subsets/create/timeout') do
         response = connection.call
         puts response

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.26.0
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-03 00:00:00.000000000 Z
+date: 2017-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -363,7 +363,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Knapsack Pro splits tests across CI nodes and makes sure that tests will