knapsack 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53cb2c59c972a7fe5a858ced2695d4bd6bf76631
-  data.tar.gz: d8c1d8bca8a3389d2da75e2e046a91b00621f504
+  metadata.gz: 8d7cc1eea5e971f88d8ecbf9770abff5729f12d6
+  data.tar.gz: 2d5aabc7712378be6352a4e1d8a0118a3dc51008
 SHA512:
-  metadata.gz: 29732cd69e2577317468c48d74543c50d2c811696d785aac4361f1863d1e64a796aa41e65c740cc825061a89991a5bff61fec751ffc0b7d61de941a1e43eabe4
-  data.tar.gz: c5ac456de00a76758094d53f1cdd412e3b836040c208956b5b55e3adc6ffdf9fca09bd673e74157b144a73801a749bf8450aacab848673dff5a126e588760ad1
+  metadata.gz: 63bcee2574ba094111d130dd6bfcbdec7028a81e98ec5a9d06fa33e850c3a3a917da9938712da6e842ab4b7964c85a24989c1d91f509c76f3abe3fe512203771
+  data.tar.gz: ab4c75f8bae3c992f6fe58077a08006d284cfec5de8ed4442a7508341f40d81a1025d2bb055b1ac2f5237b386ad18bf0c0425e4072cb988a514b42375df82c59

data/.travis.yml

@@ -26,9 +26,12 @@ script:
   - 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
 
+  - echo "Run specs with custom knapsack logger"
+  - CUSTOM_LOGGER=true KNAPSACK_SPEC_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_SPEC_PATTERN="spec_examples/**/*_spec.rb" KNAPSACK_REPORT_PATH="custom_knapsack_report.json" bundle exec rake knapsack:rspec
+  - KNAPSACK_REPORT_PATH="custom_knapsack_report.json" KNAPSACK_SPEC_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"
   - rm spec_examples/fast/1_spec.rb

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 * TODO
 
+### 0.2.0
+
+* Add knapsack logger. Allow to use custom logger.
+
 ### 0.1.4
 
 * Fix wrong time presentation for negative seconds.

data/README.md

@@ -12,9 +12,19 @@
 
 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.
 
+Short [presentation](http://slides.com/arturt/knapsack) about gem.
+
+### Without Knapsack
+
+![Without Knapsack gem](docs/images/without_knapsack.png)
+
+### With Knapsack
+
+![With Knapsack gem](docs/images/with_knapsack.png)
+
 ## Installation
 
-Add this line to your application's Gemfile in test group:
+Add this line to your application's Gemfile:
 
     gem 'knapsack'
 
@@ -30,8 +40,8 @@ Add at the beginning of your `spec_helper.rb`:
 
     # default configuration, you can change it or omit completely
     Knapsack.tracker.config({
-        enable_time_offset_warning: true,
-        time_offset_in_seconds: 30
+      enable_time_offset_warning: true,
+      time_offset_in_seconds: 30
     })
 
     # default configuration for report, you can change it or omit completely
@@ -39,6 +49,12 @@ Add at the beginning of your `spec_helper.rb`:
       report_path: 'knapsack_report.json'
     })
 
+    # you can use your own logger or omit completely
+    require 'logger'
+    Knapsack.logger = Logger.new(STDOUT)
+    Knapsack.logger.level = Logger::INFO
+
+    # bind adapter, required
     Knapsack::Adapters::RspecAdapter.bind
 
 Add in your `Rakefile` this lines:
@@ -52,6 +68,8 @@ Generate time execution report for your spec files. Run it on your CI machine.
 
 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.
+
 ## Setup your CI server
 
 On your CI server run this command for the first CI node. Update `CI_NODE_INDEX` for the next one.
@@ -78,11 +96,23 @@ If you are using circleci.com you can omit `CI_NODE_TOTAL` and `CI_NODE_INDEX`.
 
 Here is example for test configuration in your `circleci.yml` file.
 
+For the first time run all specs on a single CI node with enabled report generator.
+
+    test:
+      override:
+        - 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.
+
+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
 
+Now everything should works. You will get warning at the end of rspec results if time execution will take too much.
+
 ## Tests
 
 ### Spec

data/lib/knapsack.rb

@@ -1,6 +1,7 @@
 require 'singleton'
 require_relative 'knapsack/version'
 require_relative 'knapsack/config'
+require_relative 'knapsack/logger'
 require_relative 'knapsack/tracker'
 require_relative 'knapsack/presenter'
 require_relative 'knapsack/report'
@@ -14,6 +15,8 @@ require_relative 'knapsack/adapters/rspec_adapter'
 
 module Knapsack
   class << self
+    @@logger = nil
+
     def tracker
       Knapsack::Tracker.instance
     end
@@ -30,5 +33,16 @@ module Knapsack
       task_loader = Knapsack::TaskLoader.new
       task_loader.load_tasks
     end
+
+    def logger
+      return @@logger if @@logger
+      log = Knapsack::Logger.new
+      log.level = Knapsack::Logger::INFO
+      @@logger = log
+    end
+
+    def logger=(value)
+      @@logger = value
+    end
   end
 end

data/lib/knapsack/adapters/base_adapter.rb

@@ -9,15 +9,15 @@ module Knapsack
 
       def bind
         if tracker.config[:generate_report]
-          puts 'Knapsack report generator started!'
+          Knapsack.logger.info 'Knapsack report generator started!'
           bind_time_tracker
           bind_report_generator
         elsif tracker.config[:enable_time_offset_warning]
-          puts 'Knapsack time offset warning enabled!'
+          Knapsack.logger.info 'Knapsack time offset warning enabled!'
           bind_time_tracker
           bind_time_offset_warning
         else
-          puts 'Knapsack is off!'
+          Knapsack.logger.warn 'Knapsack adapter is off!'
         end
       end
 

data/lib/knapsack/adapters/rspec_adapter.rb

@@ -13,7 +13,7 @@ module Knapsack
           end
 
           config.after(:suite) do
-            puts Presenter.global_time
+            Knapsack.logger.info(Presenter.global_time)
           end
         end
       end
@@ -22,7 +22,7 @@ module Knapsack
         ::RSpec.configure do |config|
           config.after(:suite) do
             Knapsack.report.save
-            puts Presenter.report_details
+            Knapsack.logger.info(Presenter.report_details)
           end
         end
       end
@@ -30,16 +30,14 @@ module Knapsack
       def bind_time_offset_warning
         ::RSpec.configure do |config|
           config.after(:suite) do
-            puts Presenter.time_offset_warning
+            Knapsack.logger.warn(Presenter.time_offset_warning)
           end
         end
       end
 
-      protected
-
       def self.spec_path
         example_group = ::RSpec.current_example.metadata[:example_group]
-        while !example_group[:parent_example_group].nil?
+        until example_group[:parent_example_group].nil?
           example_group = example_group[:parent_example_group]
         end
         example_group[:file_path]

data/lib/knapsack/logger.rb

@@ -0,0 +1,24 @@
+module Knapsack
+  class Logger
+    attr_accessor :level
+
+    DEBUG = 0
+    INFO = 1
+    WARN = 2
+
+    def debug(text=nil)
+      return if level != DEBUG
+      puts text
+    end
+
+    def info(text=nil)
+      return if level > INFO
+      puts text
+    end
+
+    def warn(text=nil)
+      return if level > WARN
+      puts text
+    end
+  end
+end

data/lib/knapsack/version.rb

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

data/spec/knapsack/adapters/rspec_adapter_spec.rb

@@ -1,29 +1,98 @@
 describe Knapsack::Adapters::RspecAdapter do
-  before do
-    expect(::RSpec).to receive(:configure)
-  end
+  it_behaves_like 'adapter'
+
+  describe 'bind methods' do
+    let(:config) { double }
+    let(:logger) { instance_double(Knapsack::Logger) }
+
+    before do
+      expect(Knapsack).to receive(:logger).and_return(logger)
+    end
+
+    describe '#bind_time_tracker' do
+      let(:tracker) { instance_double(Knapsack::Tracker) }
+      let(:spec_path) { 'spec/a_spec.rb' }
+      let(:global_time) { 'Global time: 01m 05s' }
+
+      it do
+        expect(described_class).to receive(:spec_path).and_return(spec_path)
+
+        allow(Knapsack).to receive(:tracker).and_return(tracker)
+        expect(tracker).to receive(:spec_path=).with(spec_path)
+        expect(tracker).to receive(:start_timer)
+        expect(tracker).to receive(:stop_timer)
+
+        expect(Knapsack::Presenter).to receive(:global_time).and_return(global_time)
+
+        expect(config).to receive(:before).with(:each).and_yield
+        expect(config).to receive(:after).with(:each).and_yield
+        expect(config).to receive(:after).with(:suite).and_yield
+        expect(::RSpec).to receive(:configure).and_yield(config)
+
+        expect(logger).to receive(:info).with(global_time)
 
-  describe '#bind_time_tracker' do
-    it do
-      expect {
         subject.bind_time_tracker
-      }.not_to raise_error
+      end
     end
-  end
 
-  describe '#bind_report_generator' do
-    it do
-      expect {
+    describe '#bind_report_generator' do
+      let(:report) { instance_double(Knapsack::Report) }
+      let(:report_details) { 'Report details' }
+
+      it do
+        expect(Knapsack).to receive(:report).and_return(report)
+        expect(report).to receive(:save)
+
+        expect(Knapsack::Presenter).to receive(:report_details).and_return(report_details)
+
+        expect(config).to receive(:after).with(:suite).and_yield
+        expect(::RSpec).to receive(:configure).and_yield(config)
+
+        expect(logger).to receive(:info).with(report_details)
+
         subject.bind_report_generator
-      }.not_to raise_error
+      end
     end
-  end
 
-  describe '#bind_time_offset_warning' do
-    it do
-      expect {
+    describe '#bind_time_offset_warning' do
+      let(:time_offset_warning) { 'Time offset warning' }
+
+      it do
+        expect(Knapsack::Presenter).to receive(:time_offset_warning).and_return(time_offset_warning)
+
+        expect(config).to receive(:after).with(:suite).and_yield
+        expect(::RSpec).to receive(:configure).and_yield(config)
+
+        expect(logger).to receive(:warn).with(time_offset_warning)
+
         subject.bind_time_offset_warning
-      }.not_to raise_error
+      end
     end
   end
+
+  describe '.spec_path' do
+    let(:current_example) { double }
+    let(:metadata) do
+      {
+        example_group: {
+          file_path: '1_shared_example.rb',
+          parent_example_group: {
+            file_path: '2_shared_example.rb',
+            parent_example_group: {
+              file_path: 'a_spec.rb'
+            }
+          }
+        }
+      }
+    end
+
+    subject { described_class.spec_path }
+
+    before do
+      allow(::RSpec).to receive(:current_example).and_return(current_example)
+      allow(current_example).to receive(:metadata).and_return(metadata)
+    end
+
+    it { should eql 'a_spec.rb' }
+  end
 end

data/spec/knapsack/logger_spec.rb

@@ -0,0 +1,60 @@
+describe Knapsack::Logger do
+  let(:text) { 'Text' }
+
+  describe '#debug' do
+    before { subject.level = level }
+
+    context 'when level is DEBUG' do
+      let(:level) { described_class::DEBUG }
+      it { expect { subject.debug(text) }.to output(/#{text}/).to_stdout }
+    end
+
+    context 'when level is INFO' do
+      let(:level) { described_class::INFO }
+      it { expect { subject.debug(text) }.to output('').to_stdout }
+    end
+
+    context 'when level is WARN' do
+      let(:level) { described_class::WARN }
+      it { expect { subject.debug(text) }.to output('').to_stdout }
+    end
+  end
+
+  describe '#info' do
+    before { subject.level = level }
+
+    context 'when level is DEBUG' do
+      let(:level) { described_class::DEBUG }
+      it { expect { subject.info(text) }.to output(/#{text}/).to_stdout }
+    end
+
+    context 'when level is INFO' do
+      let(:level) { described_class::INFO }
+      it { expect { subject.info(text) }.to output(/#{text}/).to_stdout }
+    end
+
+    context 'when level is WARN' do
+      let(:level) { described_class::WARN }
+      it { expect { subject.info(text) }.to output('').to_stdout }
+    end
+  end
+
+  describe '#warn' do
+    before { subject.level = level }
+
+    context 'when level is DEBUG' do
+      let(:level) { described_class::DEBUG }
+      it { expect { subject.warn(text) }.to output(/#{text}/).to_stdout }
+    end
+
+    context 'when level is INFO' do
+      let(:level) { described_class::INFO }
+      it { expect { subject.warn(text) }.to output(/#{text}/).to_stdout }
+    end
+
+    context 'when level is WARN' do
+      let(:level) { described_class::WARN }
+      it { expect { subject.warn(text) }.to output(/#{text}/).to_stdout }
+    end
+  end
+end

data/spec/knapsack_spec.rb

@@ -28,4 +28,32 @@ describe Knapsack do
       described_class.load_tasks
     end
   end
+
+  describe '.logger' do
+    subject { described_class.logger }
+
+    before { described_class.logger = nil }
+    after  { described_class.logger = nil }
+
+    context 'when default logger' do
+      let(:logger) { instance_double(Knapsack::Logger) }
+
+      before do
+        expect(Knapsack::Logger).to receive(:new).and_return(logger)
+        expect(logger).to receive(:level=).with(Knapsack::Logger::INFO)
+      end
+
+      it { should eql logger }
+    end
+
+    context 'when custom logger' do
+      let(:logger) { double('custom logger') }
+
+      before do
+        described_class.logger = logger
+      end
+
+      it { should eql logger }
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -6,6 +6,8 @@ CodeClimate::TestReporter.start
 
 require 'knapsack'
 
+Dir["#{Knapsack.root}/spec/support/**/*.rb"].each { |f| require f }
+
 RSpec.configure do |config|
   config.order = :random
   config.mock_with :rspec do |mocks|

data/spec/support/shared_examples/adapter.rb

@@ -0,0 +1,29 @@
+shared_examples 'adapter' do
+  before do
+    expect(::RSpec).to receive(:configure)
+  end
+
+  describe '#bind_time_tracker' do
+    it do
+      expect {
+        subject.bind_time_tracker
+      }.not_to raise_error
+    end
+  end
+
+  describe '#bind_report_generator' do
+    it do
+      expect {
+        subject.bind_report_generator
+      }.not_to raise_error
+    end
+  end
+
+  describe '#bind_time_offset_warning' do
+    it do
+      expect {
+        subject.bind_time_offset_warning
+      }.not_to raise_error
+    end
+  end
+end

data/spec_examples/spec_helper.rb

@@ -8,6 +8,13 @@ Knapsack.tracker.config({
 Knapsack.report.config({
   report_path: 'knapsack_report.json'
 })
+
+if ENV['CUSTOM_LOGGER']
+  require 'logger'
+  Knapsack.logger = Logger.new(STDOUT)
+  Knapsack.logger.level = Logger::INFO
+end
+
 Knapsack::Adapters::RspecAdapter.bind
 
 RSpec.configure do |config|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-13 00:00:00.000000000 Z
+date: 2014-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -104,6 +104,8 @@ files:
 - README.md
 - Rakefile
 - TODO.md
+- docs/images/with_knapsack.png
+- docs/images/without_knapsack.png
 - knapsack.gemspec
 - knapsack_report.json
 - lib/knapsack.rb
@@ -114,6 +116,7 @@ files:
 - lib/knapsack/distributors/base_distributor.rb
 - lib/knapsack/distributors/leftover_distributor.rb
 - lib/knapsack/distributors/report_distributor.rb
+- lib/knapsack/logger.rb
 - lib/knapsack/presenter.rb
 - lib/knapsack/report.rb
 - lib/knapsack/task_loader.rb
@@ -127,12 +130,14 @@ files:
 - spec/knapsack/distributors/base_distributor_spec.rb
 - spec/knapsack/distributors/leftover_distributor_spec.rb
 - spec/knapsack/distributors/report_distributor_spec.rb
+- spec/knapsack/logger_spec.rb
 - spec/knapsack/presenter_spec.rb
 - spec/knapsack/report_spec.rb
 - spec/knapsack/task_loader_spec.rb
 - spec/knapsack/tracker_spec.rb
 - spec/knapsack_spec.rb
 - spec/spec_helper.rb
+- spec/support/shared_examples/adapter.rb
 - spec_examples/fast/1_spec.rb
 - spec_examples/fast/2_spec.rb
 - spec_examples/fast/3_spec.rb
@@ -179,9 +184,11 @@ test_files:
 - spec/knapsack/distributors/base_distributor_spec.rb
 - spec/knapsack/distributors/leftover_distributor_spec.rb
 - spec/knapsack/distributors/report_distributor_spec.rb
+- spec/knapsack/logger_spec.rb
 - spec/knapsack/presenter_spec.rb
 - spec/knapsack/report_spec.rb
 - spec/knapsack/task_loader_spec.rb
 - spec/knapsack/tracker_spec.rb
 - spec/knapsack_spec.rb
 - spec/spec_helper.rb
+- spec/support/shared_examples/adapter.rb