knapsack 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa40f580898155eb65fe8e84fc8345a476a0a0ab
-  data.tar.gz: 62ff398b48201c72d6074a9e174955c317b52718
+  metadata.gz: 16c44dfa2ed757dfcf1a0eb1cb207f01ec283160
+  data.tar.gz: f78966c7d310b9e46c1c4294ff308cde1598287e
 SHA512:
-  metadata.gz: f2c797ee5e47d102f93bb618dbe2fe2bf1fdd9c5efefcb5c42e886f19382efdbef2292b1d7c0ace2fbb4716e060f3bf26e652e39acb7532f72873c3be33856e2
-  data.tar.gz: 42450a7369f6e9989b31975d54aa49c7f4b1341a1dff1d9fec37c66c9eef33acdc148870b3bc48f5708edeeb27fce107b0b38176070917dcee99a33404fce3d5
+  metadata.gz: 94294aa56a3788c45f09560a599a1dc8b0c6993a4c5b79155830d0c25b2d1cda2c4d6fc361f4bae8f5f40e1aa49cbad3926d4ef787f9e24c2f34fbcd9516213f
+  data.tar.gz: d7061de09db8a6bd54d1e823aff71893016e48a8f1e4299282d6d8826d40e0e050558b1bd03c85de200ce482c62c91af0df3ad7e1e3487b9c2a1158b0ec0d682

data/.travis.yml

@@ -13,32 +13,32 @@ addons:
 before_install:
   - "echo 'gem: --no-ri --no-rdoc' > ~/.gemrc"
 script:
-  - echo "Run specs for Knapsack gem"
+  - bin/print_header.sh "Run specs for Knapsack gem"
   - bundle exec rspec spec
 
-  - echo "Generate knapsack report"
+  - bin/print_header.sh "Generate knapsack report"
   - KNAPSACK_GENERATE_REPORT=true bundle exec rspec --default-path spec_examples --tag focus
 
-  - echo "Run specs with enabled time offset warning"
+  - bin/print_header.sh "Run specs with enabled time offset warning"
   - bundle exec rspec --default-path spec_examples
 
-  - echo "Run rake task for the first CI node"
-  - CI_NODE_TOTAL=2 CI_NODE_INDEX=0 KNAPSACK_SPEC_PATTERN="spec_examples/**/*_spec.rb" bundle exec rake knapsack:rspec
-  - echo "Run rake task for the second CI node"
-  - CI_NODE_TOTAL=2 CI_NODE_INDEX=1 KNAPSACK_SPEC_PATTERN="spec_examples/**/*_spec.rb" bundle exec rake knapsack:rspec
+  - bin/print_header.sh "Run rake task for the first CI node"
+  - CI_NODE_TOTAL=2 CI_NODE_INDEX=0 KNAPSACK_TEST_FILE_PATTERN="spec_examples/**/*_spec.rb" bundle exec rake knapsack:rspec
+  - bin/print_header.sh "Run rake task for the second CI node"
+  - CI_NODE_TOTAL=2 CI_NODE_INDEX=1 KNAPSACK_TEST_FILE_PATTERN="spec_examples/**/*_spec.rb" bundle exec rake knapsack:rspec
 
-  - echo "Check passing arguments to rspec. Run only specs with custom_focus tag"
-  - KNAPSACK_SPEC_PATTERN="spec_examples/**/*_spec.rb" bundle exec rake "knapsack:rspec[--tag custom_focus]"
+  - bin/print_header.sh "Check passing arguments to rspec. Run only specs with custom_focus tag"
+  - KNAPSACK_TEST_FILE_PATTERN="spec_examples/**/*_spec.rb" bundle exec rake "knapsack:rspec[--tag custom_focus]"
 
-  - echo "Run specs with custom knapsack logger"
-  - CUSTOM_LOGGER=true KNAPSACK_SPEC_PATTERN="spec_examples/**/*_spec.rb" bundle exec rake knapsack:rspec
+  - bin/print_header.sh "Run specs with custom knapsack logger"
+  - CUSTOM_LOGGER=true KNAPSACK_TEST_FILE_PATTERN="spec_examples/**/*_spec.rb" bundle exec rake knapsack:rspec
 
-  - echo "Run specs for custom knapsack report path"
-  - cp knapsack_report.json custom_knapsack_report.json
-  - KNAPSACK_REPORT_PATH="custom_knapsack_report.json" KNAPSACK_SPEC_PATTERN="spec_examples/**/*_spec.rb" bundle exec rake knapsack:rspec
+  - bin/print_header.sh "Run specs for custom knapsack report path"
+  - cp knapsack_rspec_report.json knapsack_custom_report.json
+  - KNAPSACK_REPORT_PATH="knapsack_custom_report.json" KNAPSACK_TEST_FILE_PATTERN="spec_examples/**/*_spec.rb" bundle exec rake knapsack:rspec
 
-  - echo "Run specs when spec file was removed and still exists in knapsack report json"
+  - bin/print_header.sh "Run specs when spec file was removed and still exists in knapsack report json"
   - rm spec_examples/fast/1_spec.rb
-  - KNAPSACK_SPEC_PATTERN="spec_examples/**/*_spec.rb" bundle exec rake knapsack:rspec
+  - KNAPSACK_TEST_FILE_PATTERN="spec_examples/**/*_spec.rb" bundle exec rake knapsack:rspec
 notifications:
   email: false

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 * TODO
 
+### 1.0.0
+
+* Add cucumber support.
+* Rename environment variable KNAPSACK_SPEC_PATTERN to KNAPSACK_TEST_FILE_PATTERN.
+* Default name of knapsack report json file is based on adapter name so for RSpec the default report name is `knapsack_rspec_report.json` and for Cucumber the report name is `knapsack_cucumber_report.json`.
+
 ### 0.5.0
 
 * Allow passing arguments to rspec via knapsack:rspec task.

data/README.md

@@ -14,12 +14,12 @@
 
 **Knapsack splits tests across CI nodes and makes sure that tests will run comparable time on each node.**
 
-Parallel specs across CI server nodes based on each spec file's time execution. Knapsack generates a spec time execution report and uses it for future test runs.
+Parallel tests across CI server nodes based on each test file's time execution. Knapsack generates a test time execution report and uses it for future test runs.
 
 Presentations about gem:
 
-* [2014 X Kraków Ruby User Group](http://slides.com/arturt/parallel-tests-in-comparable-time)
-* [2014 VII Lunar Logic Dev Meeting](http://slides.com/arturt/knapsack)
+* [X 2014 Kraków Ruby User Group](http://slides.com/arturt/parallel-tests-in-comparable-time)
+* [VII 2014 Lunar Logic Dev Meeting](http://slides.com/arturt/knapsack)
 
 **[Sign up](http://knapsack.launchrock.com) to get info about launch Knapsack Pro with more features and free access for beta users.**
 
@@ -31,11 +31,17 @@ Presentations about gem:
 
 ![With Knapsack gem](docs/images/with_knapsack.png)
 
+## Update gem
+
+Please check [changelog](CHANGELOG.md) before update gem. Knapsack follows [semantic versioning](http://semver.org).
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'knapsack'
+```ruby
+gem 'knapsack'
+```
 
 And then execute:
 
@@ -43,55 +49,97 @@ And then execute:
 
 ## Usage
 
+### Step for RSpec
+
 Add at the beginning of your `spec_helper.rb`:
 
-    require 'knapsack'
+```ruby
+require 'knapsack'
+
+# CUSTOM_CONFIG_GOES_HERE
+
+Knapsack::Adapters::RspecAdapter.bind
+```
+
+### Step for Cucumber
+
+Create file `features/support/knapsack.rb` and add there:
+
+```ruby
+require 'knapsack'
 
-    # default configuration, you can change it or omit completely
-    Knapsack.tracker.config({
-      enable_time_offset_warning: true,
-      time_offset_in_seconds: 30
-    })
+# CUSTOM_CONFIG_GOES_HERE
 
-    # default configuration for report, you can change it or omit completely
-    Knapsack.report.config({
-      report_path: 'knapsack_report.json'
-    })
+Knapsack::Adapters::CucumberAdapter.bind
+```
 
-    # you can use your own logger or omit completely
-    require 'logger'
-    Knapsack.logger = Logger.new(STDOUT)
-    Knapsack.logger.level = Logger::INFO
+### Custom configuration
 
-    # bind adapter, required
-    Knapsack::Adapters::RspecAdapter.bind
+You can change default Knapsack configuration for RSpec or Cucumber tests. Here are examples what you can do. Put below configuration instead of `CUSTOM_CONFIG_GOES_HERE`.
+
+```ruby
+Knapsack.tracker.config({
+  enable_time_offset_warning: true,
+  time_offset_in_seconds: 30
+})
+
+Knapsack.report.config({
+  test_file_pattern: 'spec/**/*_spec.rb', # default value based on adapter
+  report_path: 'knapsack_custom_report.json'
+})
+
+# you can use your own logger
+require 'logger'
+Knapsack.logger = Logger.new(STDOUT)
+Knapsack.logger.level = Logger::INFO
+```
+
+### Common step
 
 Add in your `Rakefile` this lines:
 
-    require 'knapsack'
-    Knapsack.load_tasks
+```ruby
+require 'knapsack'
+Knapsack.load_tasks
+```
 
-Generate time execution report for your spec files. Run below command on one of your CI nodes.
+Generate time execution report for your test files. Run below command on one of your CI nodes.
 
+    # Step for RSpec
     $ KNAPSACK_GENERATE_REPORT=true bundle exec rspec spec
 
-Commit generated report `knapsack_report.json` into your repository.
+    # Step for Cucumber
+    $ KNAPSACK_GENERATE_REPORT=true bundle exec cucumber features
 
-This report should be updated only after you add a lot of new slow tests or you change existing ones which causes a big time execution difference between CI nodes. Either way, you will get time offset warning at the end of the rspec results which reminds you when it’s a good time to regenerate the knapsack report.
+Commit generated report `knapsack_rspec_report.json` or `knapsack_cucumber_report.json` into your repository.
+
+This report should be updated only after you add a lot of new slow tests or you change existing ones which causes a big time execution difference between CI nodes. Either way, you will get time offset warning at the end of the rspec/cucumber results which reminds you when it’s a good time to regenerate the knapsack report.
 
 ## Setup your CI server
 
 On your CI server run this command for the first CI node. Update `CI_NODE_INDEX` for the next one.
 
+    # Step for RSpec
     $ CI_NODE_TOTAL=2 CI_NODE_INDEX=0 bundle exec rake knapsack:rspec
 
-You can add `KNAPSACK_SPEC_PATTERN` if your specs are not in `spec` directory. For instance:
+    # Step for Cucumber
+    $ CI_NODE_TOTAL=2 CI_NODE_INDEX=0 bundle exec rake knapsack:cucumber
+
+You can add `KNAPSACK_TEST_FILE_PATTERN` if your tests are not in default directory. For instance:
+
+    # Step for RSpec
+    $ KNAPSACK_TEST_FILE_PATTERN="directory_with_specs/**/*_spec.rb" CI_NODE_TOTAL=2 CI_NODE_INDEX=0 bundle exec rake knapsack:rspec
 
-    $ KNAPSACK_SPEC_PATTERN="directory_with_specs/**/*_spec.rb" CI_NODE_TOTAL=2 CI_NODE_INDEX=0 bundle exec rake knapsack:rspec
+    # Step for Cucumber
+    $ KNAPSACK_TEST_FILE_PATTERN="directory_with_features/**/*.feature" CI_NODE_TOTAL=2 CI_NODE_INDEX=0 bundle exec rake knapsack:cucumber
 
 You can set `KNAPSACK_REPORT_PATH` if your knapsack report was saved in non default location. Example:
 
-    $ KNAPSACK_REPORT_PATH="custom_knapsack_report.json" CI_NODE_TOTAL=2 CI_NODE_INDEX=0 bundle exec rake knapsack:rspec
+    # Step for RSpec
+    $ KNAPSACK_REPORT_PATH="knapsack_custom_report.json" CI_NODE_TOTAL=2 CI_NODE_INDEX=0 bundle exec rake knapsack:rspec
+
+    # Step for Cucumber
+    $ KNAPSACK_REPORT_PATH="knapsack_custom_report.json" CI_NODE_TOTAL=2 CI_NODE_INDEX=0 bundle exec rake knapsack:cucumber
 
 ### Info about ENV variables
 
@@ -109,7 +157,13 @@ To do this with Knapsack you simply add your rspec arguments as parameters to th
 
     $ bundle exec rake "knapsack:rspec[--tag focus]"
 
-Remember that using tags to limit which specs get run will affect the time each file takes to run. One solution to this is to generate a new `knapsack_report.json` for the commonly run scenarios.
+Remember that using tags to limit which specs get run will affect the time each file takes to run. One solution to this is to generate a new `knapsack_rspec_report.json` for the commonly run scenarios.
+
+### Passing arguments to cucumber
+
+Add arguments to knapsack cucumber task like this:
+
+    $ bundle exec rake "knapsack:cucumber[--name feature]"
 
 ### Info for CircleCI users
 
@@ -119,54 +173,87 @@ Here is an example for test configuration in your `circleci.yml` file.
 
 #### Step 1
 
-For the first time run all specs on a single CI node with enabled report generator.
+For the first time run all tests on a single CI node with enabled report generator.
 
-    test:
-      override:
-        - KNAPSACK_GENERATE_REPORT=true bundle exec rspec spec
+```yaml
+test:
+  override:
+    # Step for RSpec
+    - KNAPSACK_GENERATE_REPORT=true bundle exec rspec spec
 
-After tests pass on your CircleCI machine your should copy knapsack json report which is rendered at the end of rspec results. Save it into your repository as `knapsack_report.json` file and commit.
+    # Step for Cucumber
+    - KNAPSACK_GENERATE_REPORT=true bundle exec cucumber features
+```
+
+After tests pass on your CircleCI machine your should copy knapsack json report which is rendered at the end of rspec/cucumber results. Save it into your repository as `knapsack_rspec_report.json` or `knapsack_cucumber_report.json` file and commit.
 
 #### Step 2
 
 Now you should update test command and enable parallel. Please remember to add additional containers for your project in CircleCI settings.
 
-    test:
-      override:
-        - bundle exec rake knapsack:rspec:
-            parallel: true
+```yaml
+test:
+  override:
+    # Step for RSpec
+    - bundle exec rake knapsack:rspec:
+        parallel: true
+
+    # Step for Cucumber
+    - bundle exec rake knapsack:cucumber:
+        parallel: true
+```
 
-Now everything should works. You will get warning at the end of rspec results if time execution will take too much.
+Now everything should works. You will get warning at the end of rspec/cucumber results if time execution will take too much.
 
 ### Info for Travis users
 
 #### Step 1
 
-For the first time run all specs at once with enabled report generator. Edit `.travis.yml`
+For the first time run all tests at once with enabled report generator. Edit `.travis.yml`
+
+```yaml
+# Step for RSpec
+script: "KNAPSACK_GENERATE_REPORT=true bundle exec rspec spec"
 
-    script: "KNAPSACK_GENERATE_REPORT=true bundle exec rspec spec"
+# Step for Cucumber
+script: "KNAPSACK_GENERATE_REPORT=true bundle exec cucumber features"
+```
 
-After tests pass your should copy knapsack json report which is rendered at the end of rspec results. Save it into your repository as `knapsack_report.json` file and commit.
+After tests pass your should copy knapsack json report which is rendered at the end of rspec/cucumber results. Save it into your repository as `knapsack_rspec_report.json` or `knapsack_cucumber_report.json` file and commit.
 
 #### Step 2
 
 You can parallel 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`
 
-    script: "bundle exec rake knapsack:rspec"
-    env:
-      - CI_NODE_TOTAL=2 CI_NODE_INDEX=0
-      - CI_NODE_TOTAL=2 CI_NODE_INDEX=1
+```yaml
+# Step for RSpec
+script: "bundle exec rake knapsack:rspec"
+
+# Step for Cucumber
+script: "bundle exec rake knapsack:cucumber"
+
+env:
+  - CI_NODE_TOTAL=2 CI_NODE_INDEX=0
+  - CI_NODE_TOTAL=2 CI_NODE_INDEX=1
+```
 
 If you want to have some global ENVs and matrix of ENVs then do it like this:
 
-    script: "bundle exec rake knapsack:rspec"
-    env:
-      global:
-        - RAILS_ENV=test
-        - MY_GLOBAL_VAR=123
-      matrix:
-        - CI_NODE_TOTAL=2 CI_NODE_INDEX=0
-        - CI_NODE_TOTAL=2 CI_NODE_INDEX=1
+```yaml
+# Step for RSpec
+script: "bundle exec rake knapsack:rspec"
+
+# Step for Cucumber
+script: "bundle exec rake knapsack:cucumber"
+
+env:
+  global:
+    - RAILS_ENV=test
+    - MY_GLOBAL_VAR=123
+  matrix:
+    - CI_NODE_TOTAL=2 CI_NODE_INDEX=0
+    - CI_NODE_TOTAL=2 CI_NODE_INDEX=1
+```
 
 Such configuration will generate matrix with 2 following ENV rows:
 
@@ -179,25 +266,35 @@ More info about global and matrix ENV configuration in [travis docs](http://docs
 
 #### Step 1
 
-For the first time run all specs at once with enabled report generator. Set up your build command:
+For the first time run all tests at once with enabled report generator. Set up your build command:
 
+    # Step for RSpec
     KNAPSACK_GENERATE_REPORT=true bundle exec rspec spec
 
-After tests pass your should copy knapsack json report which is rendered at the end of rspec results. Save it into your repository as `knapsack_report.json` file and commit.
+    # Step for Cucumber
+    KNAPSACK_GENERATE_REPORT=true bundle exec cucumber features
+
+After tests pass your should copy knapsack json report which is rendered at the end of rspec/cucumber results. Save it into your repository as `knapsack_rspec_report.json` or `knapsack_cucumber_report.json` file and commit.
 
 #### Step 2
 
-Knapsack supports semaphoreapp ENVs `SEMAPHORE_THREAD_COUNT` and `SEMAPHORE_CURRENT_THREAD`. The only thing you need to do is set up knapsack rspec command for as many threads as you need. Here is an example:
+Knapsack supports semaphoreapp ENVs `SEMAPHORE_THREAD_COUNT` and `SEMAPHORE_CURRENT_THREAD`. The only thing you need to do is set up knapsack rspec/cucumber command for as many threads as you need. Here is an example:
 
-    # thread 1
+    # Thread 1
+    ## Step for RSpec
     bundle exec rake knapsack:rspec
+    ## Step for Cucumber
+    bundle exec rake knapsack:cucumber
 
-    # thread 2
+    # Thread 2
+    ## Step for RSpec
     bundle exec rake knapsack:rspec
+    ## Step for Cucumber
+    bundle exec rake knapsack:cucumber
 
 Tests will be split across threads.
 
-## Tests
+## Gem tests
 
 ### Spec
 
@@ -213,7 +310,7 @@ To generate a new knapsack report for specs with `focus` tag (only specs in `spe
 
     $ KNAPSACK_GENERATE_REPORT=true bundle exec rspec --default-path spec_examples --tag focus
 
-**Warning:** Current `knapsack_report.json` file was generated for `spec_examples` except `spec_examples/leftover` directory. Just for testing reason to see how leftover specs will be distribute in a dumb way across CI nodes.
+**Warning:** Current `knapsack_rspec_report.json` file was generated for `spec_examples` except `spec_examples/leftover` directory. Just for testing reason to see how leftover specs will be distribute in a dumb way across CI nodes.
 
 To see specs distributed for the first CI node type:
 
@@ -223,6 +320,10 @@ Specs in `spec_examples/leftover` take more than 3 seconds. This should cause a
 
     $ bundle exec rspec --default-path spec_examples
 
+### Cucumber examples
+
+Here is [a fork of Loomio](https://github.com/ArturT/loomio) Rails application with a lot of cucumber features and some rspec examples. Knapsack was added there - [see code changes](https://github.com/ArturT/loomio/compare/loomio:master...add-knapsack-gem). Tests were splitted across a few machines on Travis CI - [see builds](https://travis-ci.org/ArturT/loomio/builds).
+
 ## Contributing
 
 1. Fork it ( https://github.com/ArturT/knapsack/fork )

data/TODO.md

@@ -1,4 +1,4 @@
 # TODO
 
-* Add other adapters and rake tasks than RSpec.
+* Add other adapters and rake tasks than RSpec and Cucumber.
 * Add support for ENV CI node total and CI node index other than CircleCI.

data/bin/print_header.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+echo ==========================================================================================================================
+echo $1
+echo ==========================================================================================================================

data/knapsack.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Knapsack::VERSION
   spec.authors       = ["ArturT"]
   spec.email         = ["arturtrzop@gmail.com"]
-  spec.summary       = %q{Parallel specs across CI server nodes based on each spec file's time execution.}
-  spec.description   = %q{Parallel specs across CI server nodes based on each spec file's time execution. It generates a spec time execution report and uses it for future test runs.}
+  spec.summary       = %q{Knapsack splits tests across CI nodes and makes sure that tests will run comparable time on each node.}
+  spec.description   = %q{Parallel tests across CI server nodes based on each test file's time execution. It generates a test time execution report and uses it for future test runs.}
   spec.homepage      = "https://github.com/ArturT/knapsack"
   spec.license       = "MIT"
 
@@ -21,6 +21,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake', '~> 0'
   spec.add_development_dependency 'rspec', '~> 3.0', '>= 2.0.0'
+  spec.add_development_dependency 'cucumber', '>= 1.3'
   spec.add_development_dependency 'timecop', '~> 0'
   spec.add_development_dependency 'codeclimate-test-reporter', '~> 0'
+  spec.add_development_dependency 'pry', '~> 0'
 end