knapsack_pro 0.50.1 → 0.51.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f32dbba867743ab3b02ad56fe56507c7bdef81df
-  data.tar.gz: 3e08b6ad44aac4d400e92caef47897c2163b5998
+  metadata.gz: 10e2d8e67cd45d4f4624e1c9630b27e5d83b6967
+  data.tar.gz: 160d472acb1cab42aa1870d62ee84dd1c897e216
 SHA512:
-  metadata.gz: 2339de8c7ef40f0ee30c5c57582641d599b7bcff66e639075e8feaebdd9a7ec7d231db3191d1b4f485f46a77aa29736fe2cb67612976c28455fbb82853c81be8
-  data.tar.gz: 60aabaa69b57233e94f76034c9fb4484ddcab86cd70ccc90ddbe80ca78303df65ee5a4cec1fc4bddf84eefc19f7d7d9c5418ffbb5ca3b54a36b20f78cba99ebf
+  metadata.gz: 6aa5e6a9480e6c8e96669ddfa20bce9b62251ecb8aafb95d5ef25aec88a34ca138e922f5b8e8452e8a9577cd645be19c5a016efafe26a94319a7c6763dc57557
+  data.tar.gz: 96d936aacfb332ebe49b0e669fcd2b55ded28c9e563a82f50da74a68892820be58091d53595e6b77e0d1a0ce314268613f7cf3ff7b6ac121db332ebd3cc295ca

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 * TODO
 
+### 0.51.0
+
+* Add support for test-unit test runner.
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/53
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v0.50.1...v0.51.0
+
 ### 0.50.1
 
 * Update RSpec timing adapter to be more resilient.

data/README.md

@@ -5,6 +5,8 @@
 [![Code Climate](https://codeclimate.com/github/KnapsackPro/knapsack_pro-ruby/badges/gpa.svg)](https://codeclimate.com/github/KnapsackPro/knapsack_pro-ruby)
 [![Test Coverage](https://codeclimate.com/github/KnapsackPro/knapsack-pro-ruby/badges/coverage.svg)](https://codeclimate.com/github/KnapsackPro/knapsack-pro-ruby/coverage)
 
+Follow us on [Twitter @KnapsackPro](https://twitter.com/KnapsackPro) and give Like on [Facebook KnapsackPro](https://www.facebook.com/KnapsackPro)
+
 Knapsack Pro gem splits tests across CI nodes and makes sure that tests will run comparable time on each node. It uses [KnapsackPro.com API](http://docs.knapsackpro.com). You can learn more at [https://knapsackpro.com](https://knapsackpro.com?utm_source=github&utm_medium=readme&utm_campaign=knapsack_pro-ruby_gem&utm_content=learn_more)
 
 The knapsack_pro gem supports:
@@ -12,6 +14,7 @@ The knapsack_pro gem supports:
 * [RSpec](http://rspec.info)
 * [Cucumber](https://cucumber.io)
 * [Minitest](http://docs.seattlerb.org/minitest/)
+* [test-unit](https://github.com/test-unit/test-unit)
 * [Spinach](https://github.com/codegram/spinach)
 * [Turnip](https://github.com/jnicklas/turnip)
 
@@ -60,6 +63,7 @@ The knapsack_pro has also [queue mode](#queue-mode) to get an optimal test suite
     - [Step for RSpec](#step-for-rspec)
     - [Step for Cucumber](#step-for-cucumber)
     - [Step for Minitest](#step-for-minitest)
+    - [Step for test-unit](#step-for-test-unit)
     - [Step for Spinach](#step-for-spinach)
     - [Custom configuration](#custom-configuration)
   - [Setup your CI server (How to set up 2 of 3)](#setup-your-ci-server-how-to-set-up-2-of-3)
@@ -84,6 +88,7 @@ The knapsack_pro has also [queue mode](#queue-mode) to get an optimal test suite
     - [Passing arguments to rspec](#passing-arguments-to-rspec)
     - [Passing arguments to cucumber](#passing-arguments-to-cucumber)
     - [Passing arguments to minitest](#passing-arguments-to-minitest)
+    - [Passing arguments to test-unit](#passing-arguments-to-test-unit)
     - [Passing arguments to spinach](#passing-arguments-to-spinach)
   - [Knapsack Pro binary](#knapsack-pro-binary)
   - [Test file names encryption](#test-file-names-encryption)
@@ -93,6 +98,7 @@ The knapsack_pro has also [queue mode](#queue-mode) to get an optimal test suite
     - [How to debug branch names?](#how-to-debug-branch-names)
   - [Supported CI providers](#supported-ci-providers)
     - [Info for CircleCI users](#info-for-circleci-users)
+      - [CircleCI and knapsack_pro Queue Mode](#circleci-and-knapsack_pro-queue-mode)
     - [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)
@@ -105,6 +111,7 @@ The knapsack_pro has also [queue mode](#queue-mode) to get an optimal test suite
     - [Why I see API error commit_hash parameter is required?](#why-i-see-api-error-commit_hash-parameter-is-required)
     - [Why I see `LoadError: cannot load such file -- spec_helper`?](#why-i-see-loaderror-cannot-load-such-file----spec_helper)
     - [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 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)
@@ -256,6 +263,19 @@ knapsack_pro_adapter = KnapsackPro::Adapters::MinitestAdapter.bind
 knapsack_pro_adapter.set_test_helper_path(__FILE__)
 ```
 
+#### Step for test-unit
+
+Add at the beginning of your `test_helper.rb`:
+
+```ruby
+require 'knapsack_pro'
+
+# CUSTOM_CONFIG_GOES_HERE
+
+knapsack_pro_adapter = KnapsackPro::Adapters::TestUnitAdapter.bind
+knapsack_pro_adapter.set_test_helper_path(__FILE__)
+```
+
 #### Step for Spinach
 
 Create file `features/support/knapsack_pro.rb` and add there:
@@ -270,7 +290,7 @@ KnapsackPro::Adapters::SpinachAdapter.bind
 
 #### Custom configuration
 
-You can change the default Knapsack Pro configuration for RSpec, Cucumber, Minitest or Spinach tests. Here are examples what you can do. Put the configuration below in place of `CUSTOM_CONFIG_GOES_HERE` (in the configuration samples above).
+You can change the default Knapsack Pro configuration for RSpec, Cucumber, Minitest, test-unit or Spinach tests. Here are examples what you can do. Put the configuration below in place of `CUSTOM_CONFIG_GOES_HERE` (in the configuration samples above).
 
 ```ruby
 # you can use your own logger
@@ -290,7 +310,8 @@ Set one or more tokens depending on how many test suites you run on CI server.
 * `KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC` - as value set token for rspec test suite. Token can be generated when you sign in to [knapsackpro.com](http://www.knapsackpro.com).
 * `KNAPSACK_PRO_TEST_SUITE_TOKEN_CUCUMBER` - token for cucumber test suite.
 * `KNAPSACK_PRO_TEST_SUITE_TOKEN_MINITEST` - token for minitest test suite.
-* `KNAPSACK_PRO_TEST_SUITE_TOKEN_SPINACH` - token for minitest test suite.
+* `KNAPSACK_PRO_TEST_SUITE_TOKEN_TEST_UNIT` - token for test-unit test suite.
+* `KNAPSACK_PRO_TEST_SUITE_TOKEN_SPINACH` - token for spinach test suite.
 
 __Tip:__ In case you have for instance multiple rspec test suites then prepend each of knapsack_pro command which executes tests with `KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC` variable.
 
@@ -307,6 +328,9 @@ On your CI server run this command for the first CI node. Update `KNAPSACK_PRO_C
     # Step for Minitest
     $ KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 bundle exec rake knapsack_pro:minitest
 
+    # Step for test-unit
+    $ KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 bundle exec rake knapsack_pro:test_unit
+
     # Step for Spinach
     $ KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 bundle exec rake knapsack_pro:spinach
 
@@ -321,6 +345,9 @@ You can add `KNAPSACK_PRO_TEST_FILE_PATTERN` if your tests are not in default di
     # Step for Minitest
     $ KNAPSACK_PRO_TEST_FILE_PATTERN="directory_with_tests/**{,/*/**}/*_test.rb" KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 bundle exec rake knapsack_pro:minitest
 
+    # Step for test-unit
+    $ KNAPSACK_PRO_TEST_FILE_PATTERN="directory_with_tests/**{,/*/**}/*_test.rb" KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 bundle exec rake knapsack_pro:test_unit
+
     # Step for Spinach
     $ KNAPSACK_PRO_TEST_FILE_PATTERN="directory_with_features/**{,/*/**}/*.feature" KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 bundle exec rake knapsack_pro:spinach
 
@@ -529,6 +556,16 @@ For instance to run verbose tests:
 
     $ bundle exec rake "knapsack_pro:minitest[--verbose]"
 
+#### Passing arguments to test-unit
+
+Add arguments to knapsack_pro test-unit task like this:
+
+    $ bundle exec rake "knapsack_pro:test_unit[--arg_name value]"
+
+For instance to run verbose tests:
+
+    $ bundle exec rake "knapsack_pro:test_unit[--verbose]"
+
 #### Passing arguments to spinach
 
 Add arguments to knapsack_pro spinach task like this:
@@ -543,6 +580,7 @@ You can install knapsack_pro globally and use binary. For instance:
     $ knapsack_pro queue:rspec "--tag custom_tag_name --profile"
     $ knapsack_pro cucumber "--name feature"
     $ knapsack_pro minitest "--verbose --pride"
+    $ knapsack_pro test_unit "--verbose"
     $ knapsack_pro spinach "--arg_name value"
 
 This is optional way of using knapsack_pro when you don't want to add it to `Gemfile`.
@@ -576,7 +614,7 @@ If you need to check what is the encryption hash for particular test file you ca
 
     $ KNAPSACK_PRO_SALT=xxx bundle exec rake knapsack_pro:encrypted_test_file_names[rspec]
 
-You can pass the name of test runner like `rspec`, `minitest`, `cucumber`, `spinach` as argument to rake task.
+You can pass the name of test runner like `rspec`, `minitest`, `test_unit`, `cucumber`, `spinach` as argument to rake task.
 
 #### How to enable branch names encryption?
 
@@ -617,6 +655,7 @@ machine:
     # KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC: rspec-token
     # KNAPSACK_PRO_TEST_SUITE_TOKEN_CUCUMBER: cucumber-token
     # KNAPSACK_PRO_TEST_SUITE_TOKEN_MINITEST: minitest-token
+    # KNAPSACK_PRO_TEST_SUITE_TOKEN_TEST_UNIT: test-unit-token
     # KNAPSACK_PRO_TEST_SUITE_TOKEN_SPINACH: spinach-token
 test:
   override:
@@ -632,6 +671,10 @@ test:
     - bundle exec rake knapsack_pro:minitest:
         parallel: true # Caution: there are 8 spaces indentation!
 
+    # Step for test-unit
+    - bundle exec rake knapsack_pro:test_unit:
+        parallel: true # Caution: there are 8 spaces indentation!
+
     # Step for Spinach
     - bundle exec rake knapsack_pro:spinach:
         parallel: true # Caution: there are 8 spaces indentation!
@@ -658,6 +701,36 @@ Here is another example for CircleCI 2.0 platform.
 
 Please remember to add additional containers for your project in CircleCI settings.
 
+##### CircleCI and knapsack_pro Queue Mode
+
+If you use knapack_pro Queue Mode with CircleCI you may want to [collect metadata](https://circleci.com/docs/1.0/test-metadata/#metadata-collection-in-custom-test-steps) like junit xml report about your RSpec test suite.
+
+Here you can read how to configure [junit formatter](#how-to-use-junit-formatter-with-knapsack_pro-queue-mode). Step for CircleCI is to copy the xml report to `$CIRCLE_TEST_REPORTS` directory. Below is full config for your `spec_helper.rb`:
+
+```ruby
+# spec_helper.rb or rails_helper.rb
+
+# TODO This must be the same path as value for rspec --out argument
+TMP_RSPEC_XML_REPORT = 'tmp/rspec.xml'
+# move results to FINAL_RSPEC_XML_REPORT so the results won't accumulate with duplicated xml tags in TMP_RSPEC_XML_REPORT
+FINAL_RSPEC_XML_REPORT = 'tmp/rspec_final_results.xml'
+
+KnapsackPro::Hooks::Queue.after_subset_queue do |queue_id, subset_queue_id|
+  if File.exist?(TMP_RSPEC_XML_REPORT)
+    FileUtils.mv(TMP_RSPEC_XML_REPORT, FINAL_RSPEC_XML_REPORT)
+  end
+end
+
+# Here is additional configuration to ensure the xml report will be visible by CircleCI
+KnapsackPro::Hooks::Queue.after_queue do |queue_id|
+  # Metadata collection
+  # https://circleci.com/docs/1.0/test-metadata/#metadata-collection-in-custom-test-steps
+  if File.exist?(FINAL_RSPEC_XML_REPORT) && ENV['CIRCLE_TEST_REPORTS']
+    FileUtils.cp(FINAL_RSPEC_XML_REPORT, "#{ENV['CIRCLE_TEST_REPORTS']}/rspec.xml")
+  end
+end
+```
+
 #### Info for Travis users
 
 You can parallelize your builds across virtual machines with [travis matrix feature](http://docs.travis-ci.com/user/speeding-up-the-build/#Parallelizing-your-builds-across-virtual-machines). Edit `.travis.yml`
@@ -673,6 +746,9 @@ script:
   # Step for Minitest
   - "bundle exec rake knapsack_pro:minitest"
 
+  # Step for test-unit
+  - "bundle exec rake knapsack_pro:test_unit"
+
   # Step for Spinach
   - "bundle exec rake knapsack_pro:spinach"
 
@@ -682,6 +758,7 @@ env:
     - KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC=rspec-token
     - KNAPSACK_PRO_TEST_SUITE_TOKEN_CUCUMBER=cucumber-token
     - KNAPSACK_PRO_TEST_SUITE_TOKEN_MINITEST=minitest-token
+    - KNAPSACK_PRO_TEST_SUITE_TOKEN_TEST_UNIT=test-unit-token
     - KNAPSACK_PRO_TEST_SUITE_TOKEN_SPINACH=spinach-token
 
     - KNAPSACK_PRO_CI_NODE_TOTAL=2
@@ -692,14 +769,14 @@ env:
 
 Such configuration will generate matrix with 2 following ENV rows:
 
-    KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC=rspec-token KNAPSACK_PRO_TEST_SUITE_TOKEN_CUCUMBER=cucumber-token KNAPSACK_PRO_TEST_SUITE_TOKEN_MINITEST=minitest-token KNAPSACK_PRO_TEST_SUITE_TOKEN_SPINACH=spinach-token
-    KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=1 KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC=rspec-token KNAPSACK_PRO_TEST_SUITE_TOKEN_CUCUMBER=cucumber-token KNAPSACK_PRO_TEST_SUITE_TOKEN_MINITEST=minitest-token KNAPSACK_PRO_TEST_SUITE_TOKEN_SPINACH=spinach-token
+    KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC=rspec-token KNAPSACK_PRO_TEST_SUITE_TOKEN_CUCUMBER=cucumber-token KNAPSACK_PRO_TEST_SUITE_TOKEN_MINITEST=minitest-token KNAPSACK_PRO_TEST_SUITE_TOKEN_TEST_UNIT=test-unit-token KNAPSACK_PRO_TEST_SUITE_TOKEN_SPINACH=spinach-token
+    KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=1 KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC=rspec-token KNAPSACK_PRO_TEST_SUITE_TOKEN_CUCUMBER=cucumber-token KNAPSACK_PRO_TEST_SUITE_TOKEN_MINITEST=minitest-token KNAPSACK_PRO_TEST_SUITE_TOKEN_TEST_UNIT=test-unit-token KNAPSACK_PRO_TEST_SUITE_TOKEN_SPINACH=spinach-token
 
 More info about global and matrix ENV configuration in [travis docs](https://docs.travis-ci.com/user/customizing-the-build/#Build-Matrix).
 
 #### Info for semaphoreapp.com users
 
-Knapsack Pro supports semaphoreapp ENVs `SEMAPHORE_THREAD_COUNT` and `SEMAPHORE_CURRENT_THREAD`. The only thing you need to do is set up knapsack_pro rspec/cucumber/minitest command for as many threads as you need. Here is an example:
+Knapsack Pro supports semaphoreapp ENVs `SEMAPHORE_THREAD_COUNT` and `SEMAPHORE_CURRENT_THREAD`. The only thing you need to do is set up knapsack_pro rspec/cucumber/minitest/test_unit command for as many threads as you need. Here is an example:
 
     # Thread 1
     ## Step for RSpec
@@ -708,6 +785,8 @@ Knapsack Pro supports semaphoreapp ENVs `SEMAPHORE_THREAD_COUNT` and `SEMAPHORE_
     bundle exec rake knapsack_pro:cucumber
     ## Step for Minitest
     bundle exec rake knapsack_pro:minitest
+    ## Step for test-unit
+    bundle exec rake knapsack_pro:test_unit
     ## Step for Spinach
     bundle exec rake knapsack_pro:spinach
 
@@ -718,6 +797,8 @@ Knapsack Pro supports semaphoreapp ENVs `SEMAPHORE_THREAD_COUNT` and `SEMAPHORE_
     bundle exec rake knapsack_pro:cucumber
     ## Step for Minitest
     bundle exec rake knapsack_pro:minitest
+    ## Step for test-unit
+    bundle exec rake knapsack_pro:test_unit
     ## Step for Spinach
     bundle exec rake knapsack_pro:spinach
 
@@ -738,6 +819,9 @@ Knapsack Pro supports buildkite ENVs `BUILDKITE_PARALLEL_JOB_COUNT` and `BUILDKI
     # Step for Minitest
     bundle exec rake knapsack_pro:minitest
 
+    # Step for test-unit
+    bundle exec rake knapsack_pro:test_unit
+
     # Step for Spinach
     bundle exec rake knapsack_pro:spinach
 
@@ -829,6 +913,9 @@ Knapsack Pro supports snap-ci.com ENVs `SNAP_WORKER_TOTAL` and `SNAP_WORKER_INDE
     # Step for Minitest
     bundle exec rake knapsack_pro:minitest
 
+    # Step for test-unit
+    bundle exec rake knapsack_pro:test_unit
+
     # Step for Spinach
     bundle exec rake knapsack_pro:spinach
 
@@ -921,6 +1008,16 @@ then problem might be related to the fact you specified complex `KNAPSACK_PRO_TE
 
 #### Queue Mode problems
 
+##### Why when I use Queue Mode for RSpec then my tests fail?
+
+knapsack_pro Queue Mode uses `RSpec::Core::Runner` feature that allows [running specs multiple times with different runner options in the same process](https://relishapp.com/rspec/rspec-core/docs/running-specs-multiple-times-with-different-runner-options-in-the-same-process).
+Thanks to that we can run subset of test suite pulled from Knapsack Pro API work queue. This allows dynamic allocation of your tests across CI nodes without reloading whole Ruby/Rails application for each run of test suite subset .
+
+If you have custom things that are not common in how typical RSpec spec looks like then the RSpec feature won't be able to handle it between test suite subset runs.
+In that case you need to resolve failed tests in a way that allows RSpec to run the tests. Feel free to [ask me for help](https://knapsackpro.com/contact).
+
+You can learn more about [recent RSpec team changes](https://github.com/KnapsackPro/knapsack_pro-ruby/pull/42) that was backported into knapsack_pro.
+
 ##### 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:
@@ -986,7 +1083,7 @@ For instance to run subset of tests for the first CI node with specified seed yo
     KNAPSACK_PRO_CI_NODE_INDEX=0 \
     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.
+Above example is for RSpec. You can use respectively rake task name and token environment variable when you want to run tests for minitest, test_unit, 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.
@@ -1081,7 +1178,7 @@ A lot of small test files will give you better test suite split results.
 
 Another way is to use tags to mark subset of tests in particular test file and then split tests based on tags.
 
-This example is for knapack_pro Regular Mode. I don't recommend to user this approach with Queue Mode.
+This example is for knapack_pro Regular Mode. You can also use knapack_pro Queue Mode with tags.
 
 Here is example of test file with specified tags for describe groups:
 
@@ -1103,7 +1200,7 @@ describe 'Feature' do
 end
 ```
 
-You need to create multiple API tokens for different tags. In this example we need 3 different API tokens.
+You need to create API token per each tag. In this example we need 3 different API tokens.
 
 You need to run below commands for each CI node.
 
@@ -1168,12 +1265,16 @@ You can use junit formatter for rspec thanks to gem [rspec_junit_formatter](http
 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
+
+    # TODO This must be the same path as value for rspec --out argument
+    TMP_RSPEC_XML_REPORT = 'tmp/rspec.xml'
+    # move results to FINAL_RSPEC_XML_REPORT so the results won't accumulate with duplicated xml tags in TMP_RSPEC_XML_REPORT
+    FINAL_RSPEC_XML_REPORT = 'tmp/rspec_final_results.xml'
+
     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.exist?(old_xml_file)
+      if File.exist?(TMP_RSPEC_XML_REPORT)
+        FileUtils.mv(TMP_RSPEC_XML_REPORT, FINAL_RSPEC_XML_REPORT)
+      end
     end
 
 #### How many API keys I need?

data/Rakefile

@@ -1,4 +1,2 @@
 require 'bundler/gem_tasks'
 require 'knapsack_pro'
-
-#KnapsackPro.load_tasks

data/bin/knapsack_pro

@@ -10,6 +10,7 @@ MAP = {
   'queue:rspec' => KnapsackPro::Runners::Queue::RSpecRunner,
   'cucumber' => KnapsackPro::Runners::CucumberRunner,
   'minitest' => KnapsackPro::Runners::MinitestRunner,
+  'test_unit' => KnapsackPro::Runners::TestUnitRunner,
   'spinach' => KnapsackPro::Runners::SpinachRunner,
 }
 

data/circle.yml

@@ -3,3 +3,10 @@ machine:
     version: 2.4.0
   environment:
     CODECLIMATE_REPO_TOKEN: b6626e682a8e97e0c5978febc92c3526792a2d018b41b8e1b52689da37fb7d92
+test:
+  override:
+    # Specify command explicitly because CircleCI 1.0 adds arguments to RSpec
+    #   $ bundle exec rspec "--color --require spec_helper --format documentation" "" "spec"
+    # and this cause error because in tests we load test-unit gem that tries to parse
+    # the unknown arguments.
+    - bundle exec rspec spec

data/knapsack_pro.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'cucumber', '>= 0'
   spec.add_development_dependency 'spinach', '>= 0.8'
   spec.add_development_dependency 'minitest', '>= 5.0.0'
+  spec.add_development_dependency 'test-unit', '>= 3.0.0'
   spec.add_development_dependency 'codeclimate-test-reporter', '~> 0'
   spec.add_development_dependency 'pry', '~> 0'
   spec.add_development_dependency 'vcr', '~> 2.9'

data/lib/knapsack_pro.rb

@@ -49,11 +49,13 @@ require_relative 'knapsack_pro/adapters/base_adapter'
 require_relative 'knapsack_pro/adapters/rspec_adapter'
 require_relative 'knapsack_pro/adapters/cucumber_adapter'
 require_relative 'knapsack_pro/adapters/minitest_adapter'
+require_relative 'knapsack_pro/adapters/test_unit_adapter'
 require_relative 'knapsack_pro/adapters/spinach_adapter'
 require_relative 'knapsack_pro/runners/base_runner'
 require_relative 'knapsack_pro/runners/rspec_runner'
 require_relative 'knapsack_pro/runners/cucumber_runner'
 require_relative 'knapsack_pro/runners/minitest_runner'
+require_relative 'knapsack_pro/runners/test_unit_runner'
 require_relative 'knapsack_pro/runners/spinach_runner'
 require_relative 'knapsack_pro/runners/queue/base_runner'
 require_relative 'knapsack_pro/runners/queue/rspec_runner'

data/lib/knapsack_pro/adapters/test_unit_adapter.rb

@@ -0,0 +1,72 @@
+module KnapsackPro
+  module Adapters
+    class TestUnitAdapter < BaseAdapter
+      TEST_DIR_PATTERN = 'test/**{,/*/**}/*_test.rb'
+      @@parent_of_test_dir = nil
+
+      def self.test_path(obj)
+        first_test = obj.tests.first
+        method = first_test.method_name
+        full_test_path = first_test.method(method).source_location.first
+        parent_of_test_dir_regexp = Regexp.new("^#{@@parent_of_test_dir}")
+        test_path = full_test_path.gsub(parent_of_test_dir_regexp, '.')
+        # test_path will look like ./test/dir/unit_test.rb
+        test_path
+      end
+
+      # Overrides the method from unit-test gem
+      # https://github.com/test-unit/test-unit/blob/master/lib/test/unit/testsuite.rb
+      module BindTimeTrackerTestUnitPlugin
+        def run_startup(result)
+          return if @test_case.nil?
+          KnapsackPro.tracker.current_test_path = KnapsackPro::Adapters::TestUnitAdapter.test_path(self)
+          KnapsackPro.tracker.start_timer
+          return if !@test_case.respond_to?(:startup)
+          begin
+            @test_case.startup
+          rescue Exception
+            raise unless handle_exception($!, result)
+          end
+        end
+
+        def run_shutdown(result)
+          return if @test_case.nil?
+          KnapsackPro.tracker.stop_timer
+          return if !@test_case.respond_to?(:shutdown)
+          begin
+            @test_case.shutdown
+          rescue Exception
+            raise unless handle_exception($!, result)
+          end
+        end
+      end
+
+      def bind_time_tracker
+        Test::Unit::TestSuite.send(:prepend, BindTimeTrackerTestUnitPlugin)
+
+        add_post_run_callback do
+          KnapsackPro.logger.debug(KnapsackPro::Presenter.global_time)
+        end
+      end
+
+      def bind_save_report
+        add_post_run_callback do
+          KnapsackPro::Report.save
+        end
+      end
+
+      def set_test_helper_path(file_path)
+        test_dir_path = File.dirname(file_path)
+        @@parent_of_test_dir = File.expand_path('../', test_dir_path)
+      end
+
+      private
+
+      def add_post_run_callback(&block)
+        Test::Unit.at_exit do
+          block.call
+        end
+      end
+    end
+  end
+end

data/lib/knapsack_pro/config/env.rb

@@ -136,6 +136,10 @@ module KnapsackPro
           ENV['KNAPSACK_PRO_TEST_SUITE_TOKEN_MINITEST']
         end
 
+        def test_suite_token_test_unit
+          ENV['KNAPSACK_PRO_TEST_SUITE_TOKEN_TEST_UNIT']
+        end
+
         def test_suite_token_cucumber
           ENV['KNAPSACK_PRO_TEST_SUITE_TOKEN_CUCUMBER']
         end

data/lib/knapsack_pro/runners/test_unit_runner.rb

@@ -0,0 +1,28 @@
+module KnapsackPro
+  module Runners
+    class TestUnitRunner < BaseRunner
+      def self.run(args)
+        ENV['KNAPSACK_PRO_TEST_SUITE_TOKEN'] = KnapsackPro::Config::Env.test_suite_token_test_unit
+        ENV['KNAPSACK_PRO_RECORDING_ENABLED'] = 'true'
+
+        runner = new(KnapsackPro::Adapters::TestUnitAdapter)
+
+        if runner.test_files_to_execute_exist?
+          require 'test/unit'
+
+          cli_args =
+            (args || '').split +
+            runner.test_file_paths.map do |f|
+              File.expand_path(f)
+            end
+
+          exit Test::Unit::AutoRunner.run(
+            true,
+            runner.test_dir,
+            cli_args
+          )
+        end
+      end
+    end
+  end
+end

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '0.50.1'
+  VERSION = '0.51.0'
 end

data/lib/tasks/encrypted_test_file_names.rake

@@ -9,12 +9,14 @@ namespace :knapsack_pro do
                       KnapsackPro::Adapters::RSpecAdapter
                     when 'minitest'
                       KnapsackPro::Adapters::MinitestAdapter
+                    when 'test_unit'
+                      KnapsackPro::Adapters::TestUnitAdapter
                     when 'cucumber'
                       KnapsackPro::Adapters::CucumberAdapter
                     when 'spinach'
                       KnapsackPro::Adapters::SpinachAdapter
                     else
-                      raise('Provide adapter name like rspec, minitest, cucumber, spinach')
+                      raise('Provide adapter name like rspec, minitest, test_unit, cucumber, spinach')
                     end
 
     test_file_pattern = KnapsackPro::TestFilePattern.call(adapter_class)

data/lib/tasks/test_unit.rake

@@ -0,0 +1,7 @@
+require 'knapsack_pro'
+
+namespace :knapsack_pro do
+  task :test_unit, [:test_unit_args] do |_, args|
+    KnapsackPro::Runners::TestUnitRunner.run(args[:test_unit_args])
+  end
+end

data/spec/knapsack_pro/adapters/test_unit_adapter_spec.rb

@@ -0,0 +1,80 @@
+require 'test/unit/testcase'
+
+describe KnapsackPro::Adapters::TestUnitAdapter do
+  it do
+    expect(described_class::TEST_DIR_PATTERN).to eq 'test/**{,/*/**}/*_test.rb'
+  end
+
+  describe '.test_path' do
+    subject { described_class.test_path(obj) }
+
+    before do
+      parent_of_test_dir = File.expand_path('../../../', File.dirname(__FILE__))
+      parent_of_test_dir_regexp = Regexp.new("^#{parent_of_test_dir}")
+      described_class.class_variable_set(:@@parent_of_test_dir, parent_of_test_dir_regexp)
+    end
+
+    context 'when regular test' do
+      class FakeTestUnitTest
+        def method_name
+          "test_something"
+        end
+
+        def test_something
+        end
+      end
+
+      class FakeTestUnitTestSuite
+        def tests
+          [FakeTestUnitTest.new]
+        end
+      end
+
+      let(:obj) { FakeTestUnitTestSuite.new }
+
+      it { should eq './spec/knapsack_pro/adapters/test_unit_adapter_spec.rb' }
+    end
+  end
+
+  describe 'bind methods' do
+    describe '#bind_time_tracker' do
+      let(:logger) { instance_double(Logger) }
+      let(:global_time) { 'Global time: 01m 05s' }
+
+      it do
+        expect(Test::Unit::TestSuite).to receive(:send).with(:prepend, KnapsackPro::Adapters::TestUnitAdapter::BindTimeTrackerTestUnitPlugin)
+
+        expect(subject).to receive(:add_post_run_callback).and_yield
+
+        expect(KnapsackPro::Presenter).to receive(:global_time).and_return(global_time)
+        expect(KnapsackPro).to receive(:logger).and_return(logger)
+        expect(logger).to receive(:debug).with(global_time)
+
+        subject.bind_time_tracker
+      end
+    end
+
+    describe '#bind_save_report' do
+      it do
+        expect(subject).to receive(:add_post_run_callback).and_yield
+
+        expect(KnapsackPro::Report).to receive(:save)
+
+        subject.bind_save_report
+      end
+    end
+  end
+
+  describe '#set_test_helper_path' do
+    let(:adapter) { described_class.new }
+    let(:test_helper_path) { '/code/project/test/test_helper.rb' }
+
+    subject { adapter.set_test_helper_path(test_helper_path) }
+
+    after do
+      expect(described_class.class_variable_get(:@@parent_of_test_dir)).to eq '/code/project'
+    end
+
+    it { should eql '/code/project' }
+  end
+end

data/spec/knapsack_pro/config/env_spec.rb

@@ -513,6 +513,20 @@ describe KnapsackPro::Config::Env do
     end
   end
 
+  describe '.test_suite_token_test_unit' do
+    subject { described_class.test_suite_token_test_unit }
+
+    context 'when ENV exists' do
+      let(:test_suite_token_test_unit) { 'test-unit-token' }
+      before { stub_const("ENV", { 'KNAPSACK_PRO_TEST_SUITE_TOKEN_TEST_UNIT' => test_suite_token_test_unit }) }
+      it { should eq test_suite_token_test_unit }
+    end
+
+    context "when ENV doesn't exist" do
+      it { should be_nil }
+    end
+  end
+
   describe '.test_suite_token_cucumber' do
     subject { described_class.test_suite_token_cucumber }
 

data/spec/knapsack_pro/runners/test_unit_runner_spec.rb

@@ -0,0 +1,57 @@
+require 'test/unit'
+
+describe KnapsackPro::Runners::TestUnitRunner do
+  subject { described_class.new(KnapsackPro::Adapters::TestUnitAdapter) }
+
+  it { should be_kind_of KnapsackPro::Runners::BaseRunner }
+
+  describe '.run' do
+    let(:args) { '--verbose --order=random' }
+
+    subject { described_class.run(args) }
+
+    before do
+      stub_const("ENV", { 'KNAPSACK_PRO_TEST_SUITE_TOKEN_TEST_UNIT' => 'test-unit-token' })
+    end
+
+    context 'when test files were returned by Knapsack Pro API' do
+      it 'runs tests' do
+        test_file_paths = ['test-unit_fake/a_test.rb', 'test-unit_fake/b_test.rb']
+        runner = instance_double(described_class,
+                                 test_dir: 'test-unit_fake',
+                                 test_file_paths: test_file_paths,
+                                 test_files_to_execute_exist?: true)
+        expect(described_class).to receive(:new)
+        .with(KnapsackPro::Adapters::TestUnitAdapter).and_return(runner)
+
+        auto_runner_exit_code = 0
+        expect(Test::Unit::AutoRunner).to receive(:run) do |flag, test_dir, cli_args|
+          expect(flag).to be true
+          expect(test_dir).to eq 'test-unit_fake'
+          expect(cli_args.size).to eq 4
+          expect(cli_args[0]).to eq '--verbose'
+          expect(cli_args[1]).to eq '--order=random'
+          expect(cli_args[2]).to end_with 'test-unit_fake/a_test.rb'
+          expect(cli_args[3]).to end_with 'test-unit_fake/b_test.rb'
+        end.and_return(auto_runner_exit_code)
+        expect(described_class).to receive(:exit).with(auto_runner_exit_code)
+
+        subject
+
+        expect(ENV['KNAPSACK_PRO_TEST_SUITE_TOKEN']).to eq 'test-unit-token'
+        expect(ENV['KNAPSACK_PRO_RECORDING_ENABLED']).to eq 'true'
+      end
+    end
+
+    context 'when test files were not returned by Knapsack Pro API' do
+      it "doesn't run tests" do
+        runner = instance_double(described_class,
+                                 test_files_to_execute_exist?: false)
+        expect(described_class).to receive(:new)
+        .with(KnapsackPro::Adapters::TestUnitAdapter).and_return(runner)
+
+        subject
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 0.50.1
+  version: 0.51.0
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-25 00:00:00.000000000 Z
+date: 2017-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -114,6 +114,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -209,6 +223,7 @@ files:
 - lib/knapsack_pro/adapters/minitest_adapter.rb
 - lib/knapsack_pro/adapters/rspec_adapter.rb
 - lib/knapsack_pro/adapters/spinach_adapter.rb
+- lib/knapsack_pro/adapters/test_unit_adapter.rb
 - lib/knapsack_pro/allocator.rb
 - lib/knapsack_pro/allocator_builder.rb
 - lib/knapsack_pro/base_allocator_builder.rb
@@ -253,6 +268,7 @@ files:
 - lib/knapsack_pro/runners/queue/rspec_runner.rb
 - lib/knapsack_pro/runners/rspec_runner.rb
 - lib/knapsack_pro/runners/spinach_runner.rb
+- lib/knapsack_pro/runners/test_unit_runner.rb
 - lib/knapsack_pro/task_loader.rb
 - lib/knapsack_pro/test_file_cleaner.rb
 - lib/knapsack_pro/test_file_finder.rb
@@ -270,6 +286,7 @@ files:
 - lib/tasks/rspec.rake
 - lib/tasks/salt.rake
 - lib/tasks/spinach.rake
+- lib/tasks/test_unit.rake
 - 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
 - spec/fixtures/vcr_cassettes/api/v1/build_subsets/create/invalid_test_suite_token.yml
@@ -281,6 +298,7 @@ files:
 - spec/knapsack_pro/adapters/minitest_adapter_spec.rb
 - spec/knapsack_pro/adapters/rspec_adapter_spec.rb
 - spec/knapsack_pro/adapters/spinach_adapter_spec.rb
+- spec/knapsack_pro/adapters/test_unit_adapter_spec.rb
 - spec/knapsack_pro/allocator_builder_spec.rb
 - spec/knapsack_pro/allocator_spec.rb
 - spec/knapsack_pro/base_allocator_builder_spec.rb
@@ -322,6 +340,7 @@ files:
 - spec/knapsack_pro/runners/queue/rspec_runner_spec.rb
 - spec/knapsack_pro/runners/rspec_runner_spec.rb
 - spec/knapsack_pro/runners/spinach_runner_spec.rb
+- spec/knapsack_pro/runners/test_unit_runner_spec.rb
 - spec/knapsack_pro/task_loader_spec.rb
 - spec/knapsack_pro/test_file_cleaner_spec.rb
 - spec/knapsack_pro/test_file_finder_spec.rb
@@ -379,6 +398,7 @@ test_files:
 - spec/knapsack_pro/adapters/minitest_adapter_spec.rb
 - spec/knapsack_pro/adapters/rspec_adapter_spec.rb
 - spec/knapsack_pro/adapters/spinach_adapter_spec.rb
+- spec/knapsack_pro/adapters/test_unit_adapter_spec.rb
 - spec/knapsack_pro/allocator_builder_spec.rb
 - spec/knapsack_pro/allocator_spec.rb
 - spec/knapsack_pro/base_allocator_builder_spec.rb
@@ -420,6 +440,7 @@ test_files:
 - spec/knapsack_pro/runners/queue/rspec_runner_spec.rb
 - spec/knapsack_pro/runners/rspec_runner_spec.rb
 - spec/knapsack_pro/runners/spinach_runner_spec.rb
+- spec/knapsack_pro/runners/test_unit_runner_spec.rb
 - spec/knapsack_pro/task_loader_spec.rb
 - spec/knapsack_pro/test_file_cleaner_spec.rb
 - spec/knapsack_pro/test_file_finder_spec.rb