knapsack 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d7cc1eea5e971f88d8ecbf9770abff5729f12d6
-  data.tar.gz: 2d5aabc7712378be6352a4e1d8a0118a3dc51008
+  metadata.gz: 181f987c696d1bc19a140cf92e482790f7b1c2ce
+  data.tar.gz: 92a9cb85bb6a341ddd9dd572a8324875fd30ef4d
 SHA512:
-  metadata.gz: 63bcee2574ba094111d130dd6bfcbdec7028a81e98ec5a9d06fa33e850c3a3a917da9938712da6e842ab4b7964c85a24989c1d91f509c76f3abe3fe512203771
-  data.tar.gz: ab4c75f8bae3c992f6fe58077a08006d284cfec5de8ed4442a7508341f40d81a1025d2bb055b1ac2f5237b386ad18bf0c0425e4072cb988a514b42375df82c59
+  metadata.gz: f9b0a1761048c7c9bd0dcd019e871bf98ac7f0551d10c3b9078f6f6d3dad25748a0450576cb5ae5d7d2be5f2748c8d3f71ab32034b289dddf6e7bc6b6b0b9091
+  data.tar.gz: a976683e07452a987816f8036afdaa97db0254268d2cd503f462da0e2fa91c049553a670412d88e2fcc4d4a0f653f11a0d5ae616e8665ea43603beabd76e22a8

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 * TODO
 
+### 0.3.0
+
+* Add support for semaphoreapp.com thread ENV variables.
+
 ### 0.2.0
 
 * Add knapsack logger. Allow to use custom logger.

data/README.md

@@ -1,4 +1,4 @@
-# Knapsack
+# ![Knapsack logo](docs/images/logos/knapsack-logo-@2.png)
 
 [![Gem Version](https://badge.fury.io/rb/knapsack.png)][gem_version]
 [![Build Status](https://travis-ci.org/ArturT/knapsack.svg?branch=master)][travis]
@@ -10,7 +10,7 @@
 [codeclimate]: https://codeclimate.com/github/ArturT/knapsack
 [coverage]: https://codeclimate.com/github/ArturT/knapsack
 
-Parallel specs across CI server nodes based on each spec file's time execution. It generates spec time execution report and uses it for further test runs.
+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.
 
 Short [presentation](http://slides.com/arturt/knapsack) about gem.
 
@@ -62,13 +62,13 @@ Add in your `Rakefile` this lines:
     require 'knapsack'
     Knapsack.load_tasks
 
-Generate time execution report for your spec files. Run it on your CI machine.
+Generate time execution report for your spec files. Run below command on one of your CI nodes.
 
     $ KNAPSACK_GENERATE_REPORT=true bundle exec rspec spec
 
 Commit generated report `knapsack_report.json` into your repository.
 
-Report should be updated only after you add a lot of new heavy test or you change existing one which causes a big time execution difference between CI nodes. Anyway you will get time offset warning at the end of rspec results which reminds you when it's good time to regenerate knapsack report.
+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.
 
 ## Setup your CI server
 
@@ -94,7 +94,9 @@ You can set `KNAPSACK_REPORT_PATH` if your knapsack report was saved in non defa
 
 If you are using circleci.com you can omit `CI_NODE_TOTAL` and `CI_NODE_INDEX`. Knapsack will use `CIRCLE_NODE_TOTAL` and `CIRCLE_NODE_INDEX` provided by CircleCI.
 
-Here is example for test configuration in your `circleci.yml` file.
+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.
 
@@ -104,6 +106,8 @@ For the first time run all specs on a single CI node with enabled report generat
 
 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 2
+
 Now you should update test command and enable parallel. Please remember to add additional containers for your project in CircleCI settings.
 
     test:
@@ -113,6 +117,65 @@ Now you should update test command and enable parallel. Please remember to add a
 
 Now everything should works. You will get warning at the end of rspec 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`
+
+    script: "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 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
+
+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
+
+Such configuration will generate matrix with 2 following ENV rows:
+
+    CI_NODE_TOTAL=2 CI_NODE_INDEX=0 RAILS_ENV=test MY_GLOBAL_VAR=123
+    CI_NODE_TOTAL=2 CI_NODE_INDEX=1 RAILS_ENV=test MY_GLOBAL_VAR=123
+
+More info about global and matrix ENV configuration in [travis docs](http://docs.travis-ci.com/user/build-configuration/#Environment-variables).
+
+### Info for semaphoreapp.com users
+
+#### Step 1
+
+For the first time run all specs at once with enabled report generator. Set up your build command:
+
+    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 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:
+
+    # thread 1
+    bundle exec rake knapsack:rspec
+
+    # thread 2
+    bundle exec rake knapsack:rspec
+
+Tests will be split across threads.
+
 ## Tests
 
 ### Spec
@@ -146,3 +209,7 @@ Specs in `spec_examples/leftover` take more than 3 seconds. This should cause a
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+## Acknowledgements
+
+Many thanks to [Małgorzata Nowak](https://github.com/informatykgosia) for beautiful logo.

data/knapsack.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   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 spec time execution report and uses it for further test runs.}
+  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.homepage      = "https://github.com/ArturT/knapsack"
   spec.license       = "MIT"
 

data/lib/knapsack/config.rb

@@ -6,11 +6,11 @@ module Knapsack
       end
 
       def ci_node_total
-        ENV['CI_NODE_TOTAL'] || ENV['CIRCLE_NODE_TOTAL'] || 1
+        ENV['CI_NODE_TOTAL'] || ENV['CIRCLE_NODE_TOTAL'] || ENV['SEMAPHORE_THREAD_COUNT'] || 1
       end
 
       def ci_node_index
-        ENV['CI_NODE_INDEX'] || ENV['CIRCLE_NODE_INDEX'] || 0
+        ENV['CI_NODE_INDEX'] || ENV['CIRCLE_NODE_INDEX'] || semaphore_current_thread || 0
       end
 
       def spec_pattern
@@ -28,6 +28,13 @@ module Knapsack
       def generate_report
         ENV['KNAPSACK_GENERATE_REPORT'] || false
       end
+
+      private
+
+      def semaphore_current_thread
+        index = ENV['SEMAPHORE_CURRENT_THREAD']
+        index.to_i - 1 if index
+      end
     end
   end
 end

data/lib/knapsack/distributors/base_distributor.rb

@@ -29,7 +29,6 @@ module Knapsack
 
       def assign_spec_files_to_node
         default_node_specs
-        @node_index = 0
         post_assign_spec_files_to_node
       end
 
@@ -60,11 +59,6 @@ module Knapsack
       def default_report
         Knapsack.report.open
       end
-
-      def update_node_index
-        @node_index += 1
-        @node_index = 0 if @node_index == ci_node_total
-      end
     end
   end
 end

data/lib/knapsack/distributors/leftover_distributor.rb

@@ -12,9 +12,11 @@ module Knapsack
       private
 
       def post_assign_spec_files_to_node
+        node_index = 0
         leftover_specs.each do |spec_file|
-          node_specs[@node_index] << spec_file
-          update_node_index
+          node_specs[node_index] << spec_file
+          node_index += 1
+          node_index %= ci_node_total
         end
       end
 

data/lib/knapsack/distributors/report_distributor.rb

@@ -43,20 +43,21 @@ module Knapsack
 
       def assign_slow_spec_files
         @not_assigned_spec_files = []
-        @node_index = 0
+        node_index = 0
         sorted_report_with_existing_specs.each do |spec_file_with_time|
-          assign_slow_spec_file(spec_file_with_time)
-          update_node_index
+          assign_slow_spec_file(node_index, spec_file_with_time)
+          node_index += 1
+          node_index %= ci_node_total
         end
       end
 
-      def assign_slow_spec_file(spec_file_with_time)
+      def assign_slow_spec_file(node_index, spec_file_with_time)
         time = spec_file_with_time[1]
-        time_left = node_specs[@node_index][:time_left] - time
+        time_left = node_specs[node_index][:time_left] - time
 
-        if time_left >= 0 or node_specs[@node_index][:spec_files_with_time].empty?
-          node_specs[@node_index][:time_left] -= time
-          node_specs[@node_index][:spec_files_with_time] << spec_file_with_time
+        if time_left >= 0 or node_specs[node_index][:spec_files_with_time].empty?
+          node_specs[node_index][:time_left] -= time
+          node_specs[node_index][:spec_files_with_time] << spec_file_with_time
         else
           @not_assigned_spec_files << spec_file_with_time
         end

data/lib/knapsack/version.rb

@@ -1,3 +1,3 @@
 module Knapsack
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/knapsack/config_spec.rb

@@ -26,6 +26,11 @@ describe Knapsack::Config do
         before { stub_const("ENV", { 'CIRCLE_NODE_TOTAL' => 4 }) }
         it { should eql 4 }
       end
+
+      context 'when SEMAPHORE_THREAD_COUNT has value' do
+        before { stub_const("ENV", { 'SEMAPHORE_THREAD_COUNT' => 3 }) }
+        it { should eql 3 }
+      end
     end
 
     context "when ENV doesn't exist" do
@@ -46,6 +51,11 @@ describe Knapsack::Config do
         before { stub_const("ENV", { 'CIRCLE_NODE_INDEX' => 2 }) }
         it { should eql 2 }
       end
+
+      context 'when SEMAPHORE_CURRENT_THREAD has value' do
+        before { stub_const("ENV", { 'SEMAPHORE_CURRENT_THREAD' => 1 }) }
+        it { should eql 0 }
+      end
     end
 
     context "when ENV doesn't exist" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-28 00:00:00.000000000 Z
+date: 2014-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,7 +87,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Parallel specs across CI server nodes based on each spec file's time
-  execution. It generates spec time execution report and uses it for further test
+  execution. It generates a spec time execution report and uses it for future test
   runs.
 email:
 - arturtrzop@gmail.com
@@ -104,6 +104,10 @@ files:
 - README.md
 - Rakefile
 - TODO.md
+- docs/images/logos/knapsack-@2.png
+- docs/images/logos/knapsack-logo-@2.png
+- docs/images/logos/knapsack-logo.png
+- docs/images/logos/knapsack.png
 - docs/images/with_knapsack.png
 - docs/images/without_knapsack.png
 - knapsack.gemspec