knapsack_pro 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71348dc37d5dee552caf5ccb37c7cedb48dd3f51e5f45ba00e96ccc63e894a87
-  data.tar.gz: 1bba20bcf45f0baf139f6aa4e0f0454bbf92dce045ce2285491717a8f2e395c6
+  metadata.gz: 887d94f1fe7361816cb0ac93c60b82e2ad85d6564ba42c4045024018be9f5c10
+  data.tar.gz: 50d568f984f87ac6ba824544f96c579d9ea7a49592fd92838faad77418c85384
 SHA512:
-  metadata.gz: 03100f82dcd86e6f352b452d7a99aa5834e8880325512e7d3fb6644d0d7d9077266188e5d10b86117a3516b2979e127873f5b06dab98b4c9cd793665bc93de95
-  data.tar.gz: 94972e32887092d86ee031726c510fb0382fc6ba8da23edf131b8539d827e9c5b57cb6814d3024814816bd82f1738770ee88a7ce46c15c189a88b0ff6508f52c
+  metadata.gz: 59731658ea95a807af73b3ddcdb4f183593e98e825e2705287f784208668cd7ad14423f0e2ca5edd720eaef7766d7c26ea15e8a3bea13fb111f79f90acac607f
+  data.tar.gz: bb9721dfdb287a6a8566e0dd72ef4f0f7216915952bd7dd4386560b3b4b81ada0a9176cdde8a42938b4b9be6aa79c01f0796d66a42f42b35126550f564149bac

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 * TODO
 
+### 1.2.1
+
+* Run Fallback Mode for exception `Errno::EPIPE`
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/75
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v1.2.0...v1.2.1
+
 ### 1.2.0
 
 * Add support for GitLab CI env vars CI_NODE_TOTAL and CI_NODE_INDEX.

data/README.md

@@ -102,7 +102,7 @@ The knapsack_pro has also [queue mode](#queue-mode) to get an optimal test suite
     - [Info for Travis users](#info-for-travis-users)
     - [Info for semaphoreapp.com users](#info-for-semaphoreappcom-users)
     - [Info for buildkite.com users](#info-for-buildkitecom-users)
-    - [Info for Gitlab CI users](#info-for-gitlab-ci-users)
+    - [Info for GitLab CI users](#info-for-gitlab-ci-users)
       - [GitLab CI `>= 11.5`](#gitlab-ci--115)
       - [GitLab CI `< 11.5` (old GitLab CI)](#gitlab-ci--115-old-gitlab-ci)
     - [Info for codeship.com users](#info-for-codeshipcom-users)
@@ -118,9 +118,11 @@ The knapsack_pro has also [queue mode](#queue-mode) to get an optimal test suite
     - [Why I see `LoadError: cannot load such file -- spec_helper`?](#why-i-see-loaderror-cannot-load-such-file----spec_helper)
     - [Why my CI build fails when I use Test::Unit even when all tests passed?](#why-my-ci-build-fails-when-i-use-testunit-even-when-all-tests-passed)
     - [Why I see HEAD as branch name in user dashboard for Build metrics for my API token?](#why-i-see-head-as-branch-name-in-user-dashboard-for-build-metrics-for-my-api-token)
+    - [Why Capybara feature tests randomly fail when using CI parallelisation?](#why-capybara-feature-tests-randomly-fail-when-using-ci-parallelisation)
     - [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 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 when I use Queue Mode for RSpec and test fails then I see multiple times info about failed test in RSpec result?](#why-when-i-use-queue-mode-for-rspec-and-test-fails-then-i-see-multiple-times-info-about-failed-test-in-rspec-result)
       - [Why when I use Queue Mode for RSpec then I see multiple times the same pending tests?](#why-when-i-use-queue-mode-for-rspec-then-i-see-multiple-times-the-same-pending-tests)
@@ -129,6 +131,7 @@ The knapsack_pro has also [queue mode](#queue-mode) to get an optimal test suite
       - [How to fix capybara-screenshot fail with `SystemStackError: stack level too deep` when using Queue Mode for RSpec?](#how-to-fix-capybara-screenshot-fail-with-systemstackerror-stack-level-too-deep-when-using-queue-mode-for-rspec)
       - [Parallel tests Cucumber and RSpec with Cucumber failures exit CI node early leaving fewer CI nodes to finish RSpec Queue.](#parallel-tests-cucumber-and-rspec-with-cucumber-failures-exit-ci-node-early-leaving-fewer-ci-nodes-to-finish-rspec-queue)
       - [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)
   - [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)
@@ -885,9 +888,9 @@ Here you can find article [how to set up a new pipeline for your project in Buil
 
 If you want to use Buildkite retry single agent feature to retry just failed tests on particular agent (CI node) then you should set [`KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true`](#knapsack_pro_fixed_queue_split-remember-queue-split-on-retry-ci-node).
 
-#### Info for Gitlab CI users
+#### Info for GitLab CI users
 
-Remember to add API tokens like `KNAPSACK_PRO_TEST_SUITE_TOKEN_CUCUMBER` and `KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC` to [Secret Variables](https://gitlab.com/help/ci/variables/README.md#secret-variables) in `Gitlab CI Settings -> CI/CD Pipelines -> Secret Variables`.
+Remember to add API tokens like `KNAPSACK_PRO_TEST_SUITE_TOKEN_CUCUMBER` and `KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC` to [Secret Variables](https://gitlab.com/help/ci/variables/README.md#secret-variables) in `GitLab CI Settings -> CI/CD Pipelines -> Secret Variables`.
 
 ##### GitLab CI `>= 11.5`
 
@@ -895,17 +898,19 @@ Remember to add API tokens like `KNAPSACK_PRO_TEST_SUITE_TOKEN_CUCUMBER` and `KN
 test:
   parallel: 2
 
-  # RSpec tests in Knapsack Pro Queue Mode (dynamic test suite split)
-  script: bundle exec rake knapsack_pro:queue:rspec
+  # Knapsack Pro Regular Mode (deterministic test suite split)
+  script: bundle exec rake knapsack_pro:rspec
 
   # Other commands you could use:
 
   # Knapsack Pro Regular Mode (deterministic test suite split)
-  # 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
 
   # Knapsack Pro Queue Mode (dynamic test suite split)
+  # bundle exec rake knapsack_pro:queue:rspec
   # bundle exec rake knapsack_pro:queue:minitest
 ```
 
@@ -913,7 +918,7 @@ Here you can find info [how to configure the GitLab parallel CI nodes](https://d
 
 ##### GitLab CI `< 11.5` (old GitLab CI)
 
-Gitlab CI does not provide parallel jobs environment variables so you will have to define `KNAPSACK_PRO_CI_NODE_TOTAL` and `KNAPSACK_PRO_CI_NODE_INDEX` for each parallel job running as part of the same `test` stage. Below is relevant part of `.gitlab-ci.yml` configuration for 2 parallel jobs.
+GitLab CI does not provide parallel jobs environment variables so you will have to define `KNAPSACK_PRO_CI_NODE_TOTAL` and `KNAPSACK_PRO_CI_NODE_INDEX` for each parallel job running as part of the same `test` stage. Below is relevant part of `.gitlab-ci.yml` configuration for 2 parallel jobs.
 
 ```
 # .gitlab-ci.yml
@@ -1220,6 +1225,20 @@ knapack_pro uses git command `git -C /home/user/project_dir rev-parse --abbrev-r
 
 If you would like to see exact branch name instead of `HEAD` in your `build metrics` history in [user dashboard](https://knapsackpro.com/dashboard) then you can explicitly provide the branch name with `KNAPSACK_PRO_BRANCH` for each CI build.
 
+#### Why Capybara feature tests randomly fail when using CI parallelisation?
+
+It can happen that when you use CI parallelisation then your CI machine is overloaded and some of Capybara feature specs may randomly fail when tested website loaded slowly.
+
+You can try to increase default Capybara max wait time from 2 seconds to something bigger like 5 seconds to ensure the Capybara will wait longer till the website is loaded before marking test as failed.
+
+```ruby
+# spec/rails_helper.rb
+Capybara.default_max_wait_time = 5 # in seconds
+```
+
+For instance, this tip might be helpful for Heroku CI users who use Heroku dynos with lower performance.
+
+
 #### Queue Mode problems
 
 ##### Why when I use Queue Mode for RSpec then my tests fail?
@@ -1265,6 +1284,60 @@ FactoryBot.define do
 end
 ```
 
+##### Why when I use Queue Mode for RSpec then I see error `superclass mismatch for class`?
+
+You may see error like:
+
+```
+TypeError:
+  superclass mismatch for class BatchClass
+```
+
+when you have 2 test files like this one:
+
+```
+# spec/a_spec.rb
+class BaseBatchClass
+end
+
+module Mock
+  module FakeModels
+    class BatchClass < BaseBatchClass
+      def args
+      end
+    end
+  end
+end
+
+describe 'A test of something' do
+  it do
+  end
+end
+```
+
+```
+# spec/b_spec.rb
+class DifferentBaseBatchClass
+end
+
+module Mock
+  module FakeModels
+    # Note the base class is different here!
+    class BatchClass < DifferentBaseBatchClass
+      def args
+      end
+    end
+  end
+end
+
+describe 'B test of something' do
+  it do
+  end
+end
+```
+
+Instead of mocking like shown above you could use [RSpec stub_const](https://relishapp.com/rspec/rspec-mocks/docs/mutating-constants) to solve error `superclass mismatch for class BatchClass`.
+
 ##### Why I don't see collected time execution data for my build in user dashboard?
 
 If you go to [user dashboard](https://knapsackpro.com/dashboard) and open `Build metrics` for your API token and you open build for your last git commit you should see there info about collected time execution data from all CI nodes. If you don't see collected time execution data for CI nodes then please ensure:
@@ -1342,6 +1415,14 @@ There is one edge case with that solution. Please note that the knapsack_pro gem
 
 To avoid this you should specify a unique `KNAPSACK_PRO_CI_NODE_BUILD_ID` environment variable for each CI build. This mean that each CI node that is part of particular CI build should have the same value for `KNAPSACK_PRO_CI_NODE_BUILD_ID`.
 
+##### Why knapsack_pro hangs / freezes / is stale i.e. for Codeship in Queue Mode?
+
+Some users with larger projects notice that in Queue Mode knapsack_pro ruby process hangs, for instance for CodeShip CI users.
+
+It happens due too big RSpec log output in Queue Mode. To produce less logs on output you can change log level to `KNAPSACK_PRO_LOG_LEVEL=warn`.
+
+Learn more about [log levels](#how-can-i-change-log-level).
+
 ##### How to find seed in RSpec output when I use Queue Mode for RSpec?
 
 In output for RSpec in knapack_pro Queue Mode you may see message:

data/lib/knapsack_pro/client/connection.rb

@@ -103,7 +103,7 @@ module KnapsackPro
         end
 
         response_body
-      rescue Errno::ECONNREFUSED, Errno::ETIMEDOUT, EOFError, SocketError, Net::OpenTimeout, Net::ReadTimeout => e
+      rescue Errno::ECONNREFUSED, Errno::ETIMEDOUT, Errno::EPIPE, EOFError, SocketError, Net::OpenTimeout, Net::ReadTimeout => e
         logger.warn(e.inspect)
         retries += 1
         if retries < 3

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '1.2.0'
+  VERSION = '1.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-15 00:00:00.000000000 Z
+date: 2019-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -42,22 +42,22 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.10.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.10.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -392,7 +392,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Knapsack Pro splits tests across CI nodes and makes sure that tests will