knapsack_pro 0.40.0 → 0.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b643c8be1b319ebbee7eba6e71a1c9006086129
-  data.tar.gz: b75182aa4e028e1192fdaf3562ff77ecef0c38d7
+  metadata.gz: 13b0f54f8e0ffa8fa8a1dafac285ccdad9ee4559
+  data.tar.gz: e7208a544178784df5dcfc4d00032f4333e22408
 SHA512:
-  metadata.gz: be387a13a2f6e29459ad46a46a8c8ff3d350e50d3ea3b3e6672214d2c00832797e8b3aabae7bca7629fe072573e51f4a5c25440d2c9de9106cefb938482dd229
-  data.tar.gz: 22d8a26c14cb995c3399e3a5ab438d1c08e247f72d88412ad5853df903ded0cfa055fdc582f231b53dacf7f5ae29c6185c78b9e3673f609a28b85ec419f1fba5
+  metadata.gz: 91ceb897da7ec79de2c86a8dc76298d4f9d3a091fe90a66657c3cb6a81b9188e613fcc65e3376309742922f3f0513e0b5f7a9d3b7ac0055febec6c31fb500994
+  data.tar.gz: 0a7f9b2160f50e6423f2a58afb4fdf774e779524ab5f2a8efb6a6a8b0cee6ff9e97b859916ce27427eda5de6faf806bce2294a58f7ad19d57ebae7f166cdb1a4

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 * TODO
 
+### 0.41.0
+
+* Add after subset queue hook and example how to use JUnit formatter in Queue Mode.
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/41
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v0.40.0...v0.41.0
+
 ### 0.40.0
 
 * Replace rake task installer `knapsack_pro:install` with online installation guide. Remove `tty-prompt` gem dependency.

data/README.md

@@ -41,7 +41,7 @@ For instance when you will run tests with `rake knapsack_pro:rspec` then:
 * knapsack_pro will run test files which got from API
 * after tests finished knapsack_pro will send information about time execution of each file to API http://docs.knapsackpro.com/api/v1/#build_subsets_post so data can be used for future test runs
 
-The knapsack_pro has also [queue mode](#queue-mode) to get most optimal test suite split.
+The knapsack_pro has also [queue mode](#queue-mode) to get optimal test suite split.
 
 # Requirements
 
@@ -121,6 +121,8 @@ The knapsack_pro has also [queue mode](#queue-mode) to get most optimal test sui
       - [B. Use tags to mark set of tests in particular test file](#b-use-tags-to-mark-set-of-tests-in-particular-test-file)
     - [How to make knapsack_pro works for forked repositories of my project?](#how-to-make-knapsack_pro-works-for-forked-repositories-of-my-project)
     - [How to use junit formatter?](#how-to-use-junit-formatter)
+      - [How to use junit formatter with knapsack_pro regular mode?](#how-to-use-junit-formatter-with-knapsack_pro-regular-mode)
+      - [How to use junit formatter with knapsack_pro queue mode?](#how-to-use-junit-formatter-with-knapsack_pro-queue-mode)
     - [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)
@@ -395,7 +397,7 @@ There might be some cached test suite splits for git commits you run in past for
 
 * `KNAPSACK_PRO_FIXED_QUEUE_SPLIT=false` (default)
 
-  By default, the fixed queue split is off. It means when you will run tests for the same commit hash and a total number of nodes and for the same branch, and the CI build ID is different with second tests run then the queue will be generated dynamically and CI nodes will fetch from Knapsack Pro API the test files in a dynamic way. This is default because it gives the most optimal test suite split for the whole test build across all CI nodes.
+  By default, the fixed queue split is off. It means when you will run tests for the same commit hash and a total number of nodes and for the same branch, and the CI build ID is different with second tests run then the queue will be generated dynamically and CI nodes will fetch from Knapsack Pro API the test files in a dynamic way. This is default because it gives the optimal test suite split for the whole test build across all CI nodes.
 
 * `KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true`
 
@@ -889,7 +891,7 @@ Please use fixed version of capybara-screenshot.
 ```
 # Gemfile
 group :test do
-  gem 'capybara-screenshot', github: 'ArturT/capybara-screenshot', branch: 'fix-reporter_module-loaded-twice'
+  gem 'capybara-screenshot', github: 'mattheworiordan/capybara-screenshot', branch: 'master'
 end
 ```
 
@@ -1075,16 +1077,32 @@ Remember to follow other steps required for your CI provider.
 
 #### How to use junit formatter?
 
+##### How to use junit formatter with knapsack_pro regular mode?
+
 You can use junit formatter for rspec thanks to gem [rspec_junit_formatter](https://github.com/sj26/rspec_junit_formatter).
 Here you can find example how to generate `rspec.xml` file with junit format and at the same time show normal documentation format output for RSpec.
 
     # Regular Mode
     bundle exec rake "knapsack_pro:rspec[--format documentation --format RspecJunitFormatter --out tmp/rspec.xml]"
 
+##### How to use junit formatter with knapsack_pro queue mode?
+
+You can use junit formatter for rspec thanks to gem [rspec_junit_formatter](https://github.com/sj26/rspec_junit_formatter).
+
     # Queue Mode
-    # The xml report will contain all tests executed across intermediate test subset runs based on queue
     bundle exec rake "knapsack_pro:queue:rspec[--format documentation --format RspecJunitFormatter --out tmp/rspec.xml]"
 
+The xml report will contain all tests executed across intermediate test subset runs based on work queue. You need to add after subset queue hook to rename `rspec.xml` to `rspec_final_results.xml` thanks to that the final results file will contain only single xml tag with all tests executed on the CI node. This is related to the way how queue mode works. Detailed explanation is in the [issue](https://github.com/KnapsackPro/knapsack_pro-ruby/issues/40).
+
+    # spec_helper.rb or rails_helper.rb
+    KnapsackPro::Hooks::Queue.after_subset_queue do |queue_id, subset_queue_id|
+      # TODO This must be the same path as value for rspec --out argument
+      old_xml_file = 'tmp/rspec.xml'
+      # move results to new_xml_file so the results won't accumulate with duplicated xml tags in old_xml_file
+      new_xml_file = 'tmp/rspec_final_results.xml'
+      FileUtils.mv(old_xml_file, new_xml_file) if File.exists?(old_xml_file)
+    end
+
 #### How many API keys I need?
 
 Basically you need as many API keys as you have steps in your build.

data/lib/knapsack_pro.rb

@@ -8,6 +8,7 @@ require 'digest'
 require 'securerandom'
 require_relative 'knapsack_pro/version'
 require_relative 'knapsack_pro/extensions/time'
+require_relative 'knapsack_pro/hooks/queue'
 require_relative 'knapsack_pro/utils'
 require_relative 'knapsack_pro/logger_wrapper'
 require_relative 'knapsack_pro/config/ci/base'

data/lib/knapsack_pro/hooks/queue.rb

@@ -0,0 +1,25 @@
+module KnapsackPro
+  module Hooks
+    class Queue
+      class << self
+        attr_reader :after_subset_queue
+
+        def reset_after_subset_queue
+          @after_subset_queue = nil
+        end
+
+        def after_subset_queue(&block)
+          @after_subset_queue ||= block
+        end
+
+        def call_after_subset_queue
+          return unless after_subset_queue
+          after_subset_queue.call(
+            KnapsackPro::Config::Env.queue_id,
+            KnapsackPro::Config::Env.subset_queue_id
+          )
+        end
+      end
+    end
+  end
+end

data/lib/knapsack_pro/runners/queue/rspec_runner.rb

@@ -51,6 +51,8 @@ module KnapsackPro
             exitstatus = exit_code if exit_code != 0
             RSpec.world.example_groups.clear
 
+            KnapsackPro::Hooks::Queue.call_after_subset_queue
+
             run_tests(runner, false, args, exitstatus, all_test_file_paths)
           end
         end

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '0.40.0'
+  VERSION = '0.41.0'
 end

data/spec/knapsack_pro/hooks/queue_spec.rb

@@ -0,0 +1,29 @@
+describe KnapsackPro::Hooks::Queue do
+  describe '.call_after_subset_queue' do
+    subject { described_class.call_after_subset_queue }
+
+    context 'when callback is not set' do
+      before do
+        described_class.reset_after_subset_queue
+      end
+
+      it { should be_nil }
+    end
+
+    context 'when callback is set' do
+      let(:queue_id) { double }
+      let(:subset_queue_id) { double }
+
+      before do
+        expect(KnapsackPro::Config::Env).to receive(:queue_id).and_return(queue_id)
+        expect(KnapsackPro::Config::Env).to receive(:subset_queue_id).and_return(subset_queue_id)
+
+        described_class.after_subset_queue do |q_id, subset_q_id|
+          [:fake_value, q_id, subset_q_id]
+        end
+      end
+
+      it { should eq [:fake_value, queue_id, subset_queue_id] }
+    end
+  end
+end

data/spec/knapsack_pro/runners/queue/rspec_runner_spec.rb

@@ -1,4 +1,3 @@
-
 describe KnapsackPro::Runners::Queue::RSpecRunner do
   before do
     # we don't want to modify rspec formatters because we want to see tests summary at the end
@@ -100,6 +99,8 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
 
         expect(RSpec).to receive_message_chain(:world, :example_groups, :clear)
 
+        expect(KnapsackPro::Hooks::Queue).to receive(:call_after_subset_queue)
+
         # second call of run_tests because of recursion
         expect(runner).to receive(:test_file_paths).with(can_initialize_queue: false).and_return([])
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 0.40.0
+  version: 0.41.0
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-14 00:00:00.000000000 Z
+date: 2017-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -234,6 +234,7 @@ files:
 - lib/knapsack_pro/extensions/time.rb
 - lib/knapsack_pro/formatters/rspec_queue_profile_formatter_extension.rb
 - lib/knapsack_pro/formatters/rspec_queue_summary_formatter.rb
+- lib/knapsack_pro/hooks/queue.rb
 - lib/knapsack_pro/logger_wrapper.rb
 - lib/knapsack_pro/presenter.rb
 - lib/knapsack_pro/queue_allocator.rb
@@ -301,6 +302,7 @@ files:
 - spec/knapsack_pro/crypto/digestor_spec.rb
 - spec/knapsack_pro/crypto/encryptor_spec.rb
 - spec/knapsack_pro/extensions/time_spec.rb
+- spec/knapsack_pro/hooks/queue_spec.rb
 - spec/knapsack_pro/logger_wrapper_spec.rb
 - spec/knapsack_pro/presenter_spec.rb
 - spec/knapsack_pro/queue_allocator_builder_spec.rb
@@ -397,6 +399,7 @@ test_files:
 - spec/knapsack_pro/crypto/digestor_spec.rb
 - spec/knapsack_pro/crypto/encryptor_spec.rb
 - spec/knapsack_pro/extensions/time_spec.rb
+- spec/knapsack_pro/hooks/queue_spec.rb
 - spec/knapsack_pro/logger_wrapper_spec.rb
 - spec/knapsack_pro/presenter_spec.rb
 - spec/knapsack_pro/queue_allocator_builder_spec.rb