knapsack 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed337f85241e8de0a55b8f40474e07c491ffa954
-  data.tar.gz: 594c3f97f5076272f0883de5f093e6c6930e68f9
+  metadata.gz: 987e3a066be096679bd6378e1423d23b4235c9cf
+  data.tar.gz: 082b1df779eaf2db8f18f4dc4afb1c02539fda1d
 SHA512:
-  metadata.gz: 18e3ba7b288ce4b91d174b121b7f731564bf39e720ef7fa37191bfd68387696e5bbc45c1bc06a28fb0bc503c875078748d673a1f851af321eb657c92bcea78e4
-  data.tar.gz: 6eed013b760611599ce3bb8028cfc7bea32e6e853b5fc7a1366bdf26d8d2b41f443aed166777fd1d7dc7b6d2c467572f0a0cc7ab36dd4d94f26610030a2ef9f0
+  metadata.gz: aab5c000855a105e7b9691fa38390ce242eb768d59f8b5ff62eebba1e9fa015b8880015ab53cf70b1fb22f8f611deff7c594ad748952e883f12da4db88dfdfe7
+  data.tar.gz: 578b23a46f3e0d4f268d0a9761d9f1d40eb3104c041a6dd8130ab3bb39d8d566674598474e7ef124b19ebc4aaaa8f048e8d36cb15f26c437f4062caaf001b847

data/.travis.yml

@@ -13,9 +13,20 @@ before_install:
   - "echo 'gem: --no-ri --no-rdoc' > ~/.gemrc"
 script:
   - bundle exec rspec spec
+
   # generate knapsack report
-  - KNAPSACK_GENERATE_REPORT=true bundle exec rspec --default-path spec_examples
+  - KNAPSACK_GENERATE_REPORT=true bundle exec rspec --default-path spec_examples --tag focus
+
   # run specs with enabled time offset warning
   - bundle exec rspec --default-path spec_examples
+
+  # 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
+  # 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
+
+  # run specs for custom knapsack report path
+  - cp knapsack_report.json custom_knapsack_report.json
+  - KNAPSACK_SPEC_PATTERN="spec_examples/**/*_spec.rb" KNAPSACK_REPORT_PATH="custom_knapsack_report.json" bundle exec rake knapsack:rspec
 notifications:
   email: false

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+### unreleased
+
+* nothing yet
+
+### 0.1.0
+
+* Gem ready to use it!
+
+### 0.0.3
+
+* Test release. Not ready to use it.

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 ArturT
+Copyright (c) 2014 Artur Trzop
 
 MIT License
 

data/README.md

@@ -1,18 +1,20 @@
 # Knapsack
 
-[![Build Status](https://travis-ci.org/ArturT/knapsack.svg?branch=master)](travis)
-[![Code Climate](https://codeclimate.com/github/ArturT/knapsack.png)](codeclimate)
+[![Gem Version](https://badge.fury.io/rb/knapsack.png)][gem_version]
+[![Build Status](https://travis-ci.org/ArturT/knapsack.svg?branch=master)][travis]
+[![Code Climate](https://codeclimate.com/github/ArturT/knapsack.png)][codeclimate]
 [![Coverage Status](https://codeclimate.com/github/ArturT/knapsack/coverage.png)][coverage]
 
+[gem_version]: https://rubygems.org/gems/knapsack
 [travis]: http://travis-ci.org/ArturT/knapsack
 [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.
+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.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's Gemfile in test group:
 
     gem 'knapsack'
 
@@ -20,35 +22,66 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install knapsack
-
 ## Usage
 
 Add at the beginning of your `spec_helper.rb`:
 
     require 'knapsack'
-    # default configuration, you can change it or omit
+
+    # default configuration, you can change it or omit completely
     Knapsack.tracker.config({
         enable_time_offset_warning: true,
-        time_offset_warning: 30,
+        time_offset_in_seconds: 30
+    })
+
+    # default configuration for report, you can change it or omit completely
+    Knapsack.report.config({
+      report_path: 'knapsack_report.json'
     })
-    Knapsack::Adapters::Rspec.bind
+
+    Knapsack::Adapters::RspecAdapter.bind
+
+Add in your `Rakefile` this lines:
+
+    require 'knapsack'
+    Knapsack.load_tasks
 
 Generate time execution report for your spec files.
 
-    $ KNAPSACK_GENERATE_REPORT=true rspec spec
+    $ KNAPSACK_GENERATE_REPORT=true bundle exec rspec spec
 
 Commit generated report `knapsack_report.json` into your repository.
 
-## Contributing
+## Setup your CI server
 
-1. Fork it ( https://github.com/[my-github-username]/knapsack/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-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
+On your CI server run this command for the first CI node. Update `CI_NODE_INDEX` for the next one.
+
+    $ 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:
+
+    $ KNAPSACK_SPEC_PATTERN="directory_with_specs/**/*_spec.rb" CI_NODE_TOTAL=2 CI_NODE_INDEX=0 bundle exec rake knapsack:rspec
+
+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
+
+### Info about ENV variables
+
+`CI_NODE_TOTAL` - total number CI nodes you have.
+
+`CI_NODE_INDEX` - index of current CI node starts from 0. Second CI node should have `CI_NODE_INDEX=1`.
+
+### Info for CircleCI users
+
+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.
+
+    test:
+      override:
+        - bundle exec rake knapsack:rspec
+            parallel: true
 
 ## Tests
 
@@ -56,16 +89,30 @@ Commit generated report `knapsack_report.json` into your repository.
 
 To run specs for Knapsack gem type:
 
-    $ rspec spec
+    $ bundle exec rspec spec
 
 ### Spec examples
 
-Directory `spec_examples` contains examples of fast and slow specs. There is a `spec_helper.rb` with binded Knapsack.
+Directory `spec_examples` contains examples of fast and slow specs. There is a `spec_example/spec_helper.rb` with binded Knapsack.
+
+To generate a new knapsack report for specs with `focus` tag (only specs in `spec_examples/leftover` directory have no `focus` tag), please type:
 
-Change one spec to make it sure it will take more than 5 seconds then run below to see Knapsack time offset warning.
+    $ KNAPSACK_GENERATE_REPORT=true bundle exec rspec --default-path spec_examples --tag focus
 
-    $ rspec --default-path spec_examples
+**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.
 
-To generate a new knapsack report file please type:
+To see specs distributed for the first CI node type:
 
-    $ KNAPSACK_GENERATE_REPORT=true rspec --default-path spec_examples
+    $ CI_NODE_TOTAL=2 CI_NODE_INDEX=0 KNAPSACK_SPEC_PATTERN="spec_examples/**/*_spec.rb" bundle exec rake knapsack:rspec
+
+Specs in `spec_examples/leftover` take more than 3 seconds. This should cause a Knapsack time offset warning because we set `time_offset_in_seconds` to 3 in `spec_examples/spec_helper.rb`. Type below to see warning:
+
+    $ bundle exec rspec --default-path spec_examples
+
+## Contributing
+
+1. Fork it ( https://github.com/ArturT/knapsack/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -1,2 +1,4 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'knapsack'
 
+Knapsack.load_tasks

data/TODO.md

@@ -0,0 +1,5 @@
+# TODO
+
+* Add other adapters than RSpec.
+* Add support for ENV CI node total and CI node index other than CircleCI.
+

data/knapsack_report.json

@@ -1,14 +1,11 @@
 {
-  "./spec_examples/fast/1_spec.rb": 9.584426879882812e-05,
-  "./spec_examples/fast/2_spec.rb": 0.00014638900756835938,
-  "./spec_examples/fast/3_spec.rb": 0.0002243518829345703,
-  "./spec_examples/fast/4_spec.rb": 0.0002560615539550781,
-  "./spec_examples/fast/5_spec.rb": 0.00023126602172851562,
-  "./spec_examples/fast/6_spec.rb": 0.00020503997802734375,
-  "./spec_examples/slow/a_spec.rb": 1.6018133163452148,
-  "./spec_examples/slow/b_spec.rb": 3.202699661254883,
-  "./spec_examples/slow/c_spec.rb": 1.0021936893463135,
-  "./spec_examples/slow/d_spec.rb": 4.001989841461182,
-  "./spec_examples/slow/e_spec.rb": 2.4013099670410156,
-  "./spec_examples/slow/f_spec.rb": 0.60198974609375
+  "spec_examples/fast/6_spec.rb": 6.628036499023438e-05,
+  "spec_examples/fast/3_spec.rb": 2.8133392333984375e-05,
+  "spec_examples/fast/2_spec.rb": 2.002716064453125e-05,
+  "spec_examples/fast/1_spec.rb": 1.0013580322265625e-05,
+  "spec_examples/fast/5_spec.rb": 7.867813110351562e-05,
+  "spec_examples/slow/b_spec.rb": 0.9035449028015137,
+  "spec_examples/fast/4_spec.rb": 6.842613220214844e-05,
+  "spec_examples/slow/a_spec.rb": 1.6037836074829102,
+  "spec_examples/slow/c_spec.rb": 1.0028371810913086
 }

data/lib/knapsack.rb

@@ -1,14 +1,33 @@
-require 'knapsack/version'
-require 'knapsack/tracker'
-require 'knapsack/presenter'
-require 'knapsack/report'
-require 'knapsack/adapters/base'
-require 'knapsack/adapters/rspec'
+require 'singleton'
+require_relative 'knapsack/version'
+require_relative 'knapsack/tracker'
+require_relative 'knapsack/presenter'
+require_relative 'knapsack/report'
+require_relative 'knapsack/allocator'
+require_relative 'knapsack/task_loader'
+require_relative 'knapsack/distributors/base_distributor'
+require_relative 'knapsack/distributors/report_distributor'
+require_relative 'knapsack/distributors/leftover_distributor'
+require_relative 'knapsack/adapters/base_adapter'
+require_relative 'knapsack/adapters/rspec_adapter'
 
 module Knapsack
   class << self
     def tracker
       Knapsack::Tracker.instance
     end
+
+    def report
+      Knapsack::Report.instance
+    end
+
+    def root
+      File.expand_path '../..', __FILE__
+    end
+
+    def load_tasks
+      task_loader = Knapsack::TaskLoader.new
+      task_loader.load_tasks
+    end
   end
 end

data/lib/knapsack/adapters/{base.rb → base_adapter.rb}

@@ -1,21 +1,21 @@
 module Knapsack
   module Adapters
-    class Base
+    class BaseAdapter
       def self.bind
-        new
+        adapter = new
+        adapter.bind
+        adapter
       end
 
-      protected
-
-      def initialize
-        if Knapsack.tracker.generate_report?
+      def bind
+        if tracker.config[:generate_report]
           puts 'Knapsack report generator started!'
           bind_time_tracker
           bind_report_generator
-        elsif Knapsack.tracker.config[:enable_time_offset_warning]
+        elsif tracker.config[:enable_time_offset_warning]
           puts 'Knapsack time offset warning enabled!'
           bind_time_tracker
-          # TODO
+          bind_time_offset_warning
         else
           puts 'Knapsack is off!'
         end
@@ -28,6 +28,16 @@ module Knapsack
       def bind_report_generator
         raise NotImplementedError
       end
+
+      def bind_time_offset_warning
+        raise NotImplementedError
+      end
+
+      protected
+
+      def tracker
+        Knapsack.tracker
+      end
     end
   end
 end

data/lib/knapsack/adapters/{rspec.rb → rspec_adapter.rb}

@@ -1,12 +1,10 @@
 module Knapsack
   module Adapters
-    class Rspec < Base
-      protected
-
+    class RspecAdapter < BaseAdapter
       def bind_time_tracker
         ::RSpec.configure do |config|
           config.before(:each) do
-            Knapsack.tracker.spec_path = Rspec.spec_path
+            Knapsack.tracker.spec_path = RspecAdapter.spec_path
             Knapsack.tracker.start_timer
           end
 
@@ -15,7 +13,6 @@ module Knapsack
           end
 
           config.after(:suite) do
-            puts
             puts Presenter.global_time
           end
         end
@@ -24,12 +21,22 @@ module Knapsack
       def bind_report_generator
         ::RSpec.configure do |config|
           config.after(:suite) do
-            Report.save
+            Knapsack.report.save
             puts Presenter.report_details
           end
         end
       end
 
+      def bind_time_offset_warning
+        ::RSpec.configure do |config|
+          config.after(:suite) do
+            puts Presenter.time_offset_warning
+          end
+        end
+      end
+
+      protected
+
       def self.spec_path
         ::RSpec.current_example.metadata[:example_group][:file_path]
       end

data/lib/knapsack/allocator.rb

@@ -0,0 +1,65 @@
+module Knapsack
+  class Allocator
+    def initialize(args={})
+      @config = default_args.merge(args)
+      @report_distributor = Knapsack::Distributors::ReportDistributor.new(@config)
+      @leftover_distributor = Knapsack::Distributors::LeftoverDistributor.new(@config)
+    end
+
+    def report_node_specs
+      @report_node_specs ||= @report_distributor.specs_for_current_node
+    end
+
+    def leftover_node_specs
+      @leftover_node_specs ||= @leftover_distributor.specs_for_current_node
+    end
+
+    def node_specs
+      @node_specs ||= report_node_specs + leftover_node_specs
+    end
+
+    def stringify_node_specs
+      node_specs.join(' ')
+    end
+
+    def custom_spec_dir
+      return unless @config[:spec_pattern]
+      @config[:spec_pattern].gsub(/^(.*?)\//).first
+    end
+
+    private
+
+    def default_args
+      {
+        ci_node_total: env_ci_node_total,
+        ci_node_index: env_ci_node_index,
+        spec_pattern: env_spec_pattern,
+        report: report
+      }
+    end
+
+    def env_ci_node_total
+      ENV['CI_NODE_TOTAL'] || ENV['CIRCLE_NODE_TOTAL']
+    end
+
+    def env_ci_node_index
+      ENV['CI_NODE_INDEX'] || ENV['CIRCLE_NODE_INDEX']
+    end
+
+    def env_spec_pattern
+      ENV['KNAPSACK_SPEC_PATTERN']
+    end
+
+    def env_report_path
+      ENV['KNAPSACK_REPORT_PATH']
+    end
+
+    def report
+      return unless env_report_path
+      Knapsack.report.config({
+        report_path: env_report_path
+      })
+      Knapsack.report.open
+    end
+  end
+end

data/lib/knapsack/distributors/base_distributor.rb

@@ -0,0 +1,67 @@
+module Knapsack
+  module Distributors
+    class BaseDistributor
+      attr_reader :report, :node_specs
+
+      DEFAULT_CI_NODE_TOTAL = 1
+      DEFAULT_CI_NODE_INDEX = 0
+
+      def initialize(args={})
+        @report = args[:report] || default_report
+        @ci_node_total = args[:ci_node_total] || DEFAULT_CI_NODE_TOTAL
+        @ci_node_index = args[:ci_node_index] || DEFAULT_CI_NODE_INDEX
+        post_initialize(args)
+      end
+
+      def default_report
+        Knapsack.report.open
+      end
+
+      def ci_node_total
+        @ci_node_total.to_i
+      end
+
+      def ci_node_index
+        @ci_node_index.to_i
+      end
+
+      def specs_for_current_node
+        specs_for_node(ci_node_index)
+      end
+
+      def specs_for_node(node_index)
+        assign_spec_files_to_node
+        post_specs_for_node(node_index)
+      end
+
+      def assign_spec_files_to_node
+        default_node_specs
+        @node_index = 0
+        post_assign_spec_files_to_node
+      end
+
+      protected
+
+      def post_initialize(args)
+        nil
+      end
+
+      def post_specs_for_node(node_index)
+        raise NotImplementedError
+      end
+
+      def post_assign_spec_files_to_node
+        raise NotImplementedError
+      end
+
+      def default_node_specs
+        raise NotImplementedError
+      end
+
+      def update_node_index
+        @node_index += 1
+        @node_index = 0 if @node_index == ci_node_total
+      end
+    end
+  end
+end