knapsack 0.5.0 → 1.0.0

data/lib/knapsack/presenter.rb

@@ -5,11 +5,11 @@ module Knapsack
   class Presenter
     class << self
       def report_yml
-        Knapsack.tracker.spec_files_with_time.to_yaml
+        Knapsack.tracker.test_files_with_time.to_yaml
       end
 
       def report_json
-        JSON.pretty_generate(Knapsack.tracker.spec_files_with_time)
+        JSON.pretty_generate(Knapsack.tracker.test_files_with_time)
       end
 
       def report_details
@@ -18,7 +18,7 @@ module Knapsack
 
       def global_time
         global_time = pretty_seconds(Knapsack.tracker.global_time)
-        "\nKnapsack global time execution for specs: #{global_time}"
+        "\nKnapsack global time execution for tests: #{global_time}"
       end
 
       def time_offset
@@ -43,7 +43,7 @@ module Knapsack
         }
         if Knapsack.tracker.time_exceeded?
           str << %{
-Specs on this CI node took more than time offset.
+Tests on this CI node took more than time offset.
 Please regenerate your knapsack report.
 If that didn't help then split your heavy test file
 or bump time_offset_in_seconds setting.}

data/lib/knapsack/report.rb

@@ -2,19 +2,27 @@ module Knapsack
   class Report
     include Singleton
 
-    def config(opts={})
-      @config ||= default_config
-      @config.merge!(opts)
+    def config(args={})
+      @config ||= args
+      @config.merge!(args)
+    end
+
+    def report_path
+      config[:report_path] || raise('Missing report_path')
+    end
+
+    def test_file_pattern
+      config[:test_file_pattern] || raise('Missing test_file_pattern')
     end
 
     def save
-      File.open(config[:report_path], 'w+') do |f|
+      File.open(report_path, 'w+') do |f|
         f.write(report_json)
       end
     end
 
     def open
-      report = File.read(config[:report_path])
+      report = File.read(report_path)
       JSON.parse(report)
     rescue Errno::ENOENT
       raise "Knapsack report file doesn't exist. Please generate report first!"
@@ -22,12 +30,6 @@ module Knapsack
 
     private
 
-    def default_config
-      {
-        report_path: Config.report_path
-      }
-    end
-
     def report_json
       Presenter.report_json
     end

data/lib/knapsack/tracker.rb

@@ -2,8 +2,8 @@ module Knapsack
   class Tracker
     include Singleton
 
-    attr_reader :global_time, :spec_files_with_time
-    attr_writer :spec_path
+    attr_reader :global_time, :test_files_with_time
+    attr_writer :test_path
 
     def initialize
       set_defaults
@@ -25,13 +25,13 @@ module Knapsack
     def stop_timer
       @execution_time = Time.now.to_f - @start_time
       update_global_time
-      update_spec_file_time
+      update_test_file_time
       @execution_time
     end
 
-    def spec_path
-      raise("spec_path needs to be set by Knapsack Adapter's bind method") unless @spec_path
-      @spec_path.sub(/^\.\//, '')
+    def test_path
+      raise("test_path needs to be set by Knapsack Adapter's bind method") unless @test_path
+      @test_path.sub(/^\.\//, '')
     end
 
     def time_exceeded?
@@ -50,29 +50,34 @@ module Knapsack
 
     def default_config
       {
-        enable_time_offset_warning: Config.enable_time_offset_warning,
-        time_offset_in_seconds: Config.time_offset_in_seconds,
-        generate_report: Config.generate_report
+        enable_time_offset_warning: Config::Tracker.enable_time_offset_warning,
+        time_offset_in_seconds: Config::Tracker.time_offset_in_seconds,
+        generate_report: Config::Tracker.generate_report
       }
     end
 
     def set_defaults
       @global_time = 0
-      @spec_files_with_time = {}
-      @spec_path = nil
+      @test_files_with_time = {}
+      @test_path = nil
     end
 
     def update_global_time
       @global_time += @execution_time
     end
 
-    def update_spec_file_time
-      @spec_files_with_time[spec_path] ||= 0
-      @spec_files_with_time[spec_path] += @execution_time
+    def update_test_file_time
+      @test_files_with_time[test_path] ||= 0
+      @test_files_with_time[test_path] += @execution_time
     end
 
     def report_distributor
-      @report_distributor ||= Knapsack::Distributors::ReportDistributor.new
+      @report_distributor ||= Knapsack::Distributors::ReportDistributor.new({
+        report: Knapsack.report.open,
+        test_file_pattern: Knapsack::Config::Env.test_file_pattern || Knapsack.report.config[:test_file_pattern],
+        ci_node_total: Knapsack::Config::Env.ci_node_total,
+        ci_node_index: Knapsack::Config::Env.ci_node_index
+      })
     end
   end
 end

data/lib/knapsack/version.rb

@@ -1,3 +1,3 @@
 module Knapsack
-  VERSION = '0.5.0'
+  VERSION = '1.0.0'
 end

data/lib/tasks/knapsack_cucumber.rake

@@ -0,0 +1,19 @@
+require 'knapsack'
+
+namespace :knapsack do
+  task :cucumber, [:cucumber_args] do |t, args|
+    allocator = Knapsack::AllocatorBuilder.new(Knapsack::Adapters::CucumberAdapter).allocator
+
+    puts
+    puts 'Report features:'
+    puts allocator.report_node_tests
+    puts
+    puts 'Leftover features:'
+    puts allocator.leftover_node_tests
+    puts
+
+    cmd = %Q[bundle exec cucumber #{args[:cucumber_args]} -- #{allocator.stringify_node_tests}]
+
+    exec(cmd)
+  end
+end

data/lib/tasks/knapsack_rspec.rake

@@ -0,0 +1,19 @@
+require 'knapsack'
+
+namespace :knapsack do
+  task :rspec, [:rspec_args] do |t, args|
+    allocator = Knapsack::AllocatorBuilder.new(Knapsack::Adapters::RspecAdapter).allocator
+
+    puts
+    puts 'Report specs:'
+    puts allocator.report_node_tests
+    puts
+    puts 'Leftover specs:'
+    puts allocator.leftover_node_tests
+    puts
+
+    cmd = %Q[bundle exec rspec #{args[:rspec_args]} --default-path #{allocator.test_dir} -- #{allocator.stringify_node_tests}]
+
+    exec(cmd)
+  end
+end

data/spec/knapsack/adapters/cucumber_adapter_spec.rb

@@ -0,0 +1,69 @@
+describe Knapsack::Adapters::CucumberAdapter do
+  context do
+    before do
+      allow(::Cucumber::RbSupport::RbDsl).to receive(:register_rb_hook)
+      allow(Kernel).to receive(:at_exit)
+    end
+
+    it_behaves_like 'adapter'
+  end
+
+  describe 'bind methods' do
+    let(:file) { 'features/a.feature' }
+    let(:scenario) { double(file: file) }
+    let(:block) { double }
+    let(:logger) { instance_double(Knapsack::Logger) }
+    let(:global_time) { 'Global time: 01m 05s' }
+
+    before do
+      expect(Knapsack).to receive(:logger).and_return(logger)
+    end
+
+    describe '#bind_time_tracker' do
+      let(:tracker) { instance_double(Knapsack::Tracker) }
+
+      it do
+        expect(subject).to receive(:Around).and_yield(scenario, block)
+        allow(Knapsack).to receive(:tracker).and_return(tracker)
+        expect(tracker).to receive(:test_path=).with(file)
+        expect(tracker).to receive(:start_timer)
+        expect(block).to receive(:call)
+        expect(tracker).to receive(:stop_timer)
+
+        expect(::Kernel).to receive(:at_exit).and_yield
+        expect(Knapsack::Presenter).to receive(:global_time).and_return(global_time)
+        expect(logger).to receive(:info).with(global_time)
+
+        subject.bind_time_tracker
+      end
+    end
+
+    describe '#bind_report_generator' do
+      let(:report) { instance_double(Knapsack::Report) }
+      let(:report_details) { 'Report details' }
+
+      it do
+        expect(::Kernel).to receive(:at_exit).and_yield
+        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(logger).to receive(:info).with(report_details)
+
+        subject.bind_report_generator
+      end
+    end
+
+    describe '#bind_time_offset_warning' do
+      let(:time_offset_warning) { 'Time offset warning' }
+
+      it do
+        expect(::Kernel).to receive(:at_exit).and_yield
+        expect(Knapsack::Presenter).to receive(:time_offset_warning).and_return(time_offset_warning)
+        expect(logger).to receive(:warn).with(time_offset_warning)
+
+        subject.bind_time_offset_warning
+      end
+    end
+  end
+end

data/spec/knapsack/adapters/rspec_adapter_spec.rb

@@ -1,5 +1,8 @@
 describe Knapsack::Adapters::RspecAdapter do
-  it_behaves_like 'adapter'
+  context do
+    before { expect(::RSpec).to receive(:configure) }
+    it_behaves_like 'adapter'
+  end
 
   describe 'bind methods' do
     let(:config) { double }
@@ -11,24 +14,31 @@ describe Knapsack::Adapters::RspecAdapter do
 
     describe '#bind_time_tracker' do
       let(:tracker) { instance_double(Knapsack::Tracker) }
-      let(:spec_path) { 'spec/a_spec.rb' }
+      let(:test_path) { 'spec/a_spec.rb' }
       let(:global_time) { 'Global time: 01m 05s' }
+      let(:example_group) { double }
+      let(:current_example) do
+        OpenStruct.new(metadata: {
+          example_group: example_group
+        })
+      end
 
       it do
-        expect(described_class).to receive(:spec_path).and_return(spec_path)
+        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(::RSpec).to receive(:current_example).twice.and_return(current_example)
+        expect(described_class).to receive(:test_path).with(example_group).and_return(test_path)
 
         allow(Knapsack).to receive(:tracker).and_return(tracker)
-        expect(tracker).to receive(:spec_path=).with(spec_path)
+        expect(tracker).to receive(:test_path=).with(test_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)
 
         subject.bind_time_tracker
@@ -40,14 +50,13 @@ describe Knapsack::Adapters::RspecAdapter do
       let(:report_details) { 'Report details' }
 
       it do
+        expect(config).to receive(:after).with(:suite).and_yield
+        expect(::RSpec).to receive(:configure).and_yield(config)
+
         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
@@ -58,11 +67,10 @@ describe Knapsack::Adapters::RspecAdapter 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(Knapsack::Presenter).to receive(:time_offset_warning).and_return(time_offset_warning)
         expect(logger).to receive(:warn).with(time_offset_warning)
 
         subject.bind_time_offset_warning
@@ -70,7 +78,7 @@ describe Knapsack::Adapters::RspecAdapter do
     end
   end
 
-  describe '.spec_path' do
+  describe '.test_path' do
     let(:current_example_metadata) do
       {
           file_path: '1_shared_example.rb',
@@ -83,7 +91,7 @@ describe Knapsack::Adapters::RspecAdapter do
       }
     end
 
-    subject { described_class.spec_path(current_example_metadata) }
+    subject { described_class.test_path(current_example_metadata) }
 
     it { should eql 'a_spec.rb' }
   end

data/spec/knapsack/allocator_builder_spec.rb

@@ -0,0 +1,88 @@
+describe Knapsack::AllocatorBuilder do
+  let(:allocator_builder) { described_class.new(adapter_class) }
+  let(:allocator) { double }
+
+  let(:report) { double }
+  let(:knapsack_report) { instance_double(Knapsack::Report) }
+
+  let(:adapter_report_path) { adapter_class::REPORT_PATH }
+  let(:adapter_test_file_pattern) { adapter_class::TEST_DIR_PATTERN }
+
+  let(:env_ci_node_total) { double }
+  let(:env_ci_node_index) { double }
+  let(:env_report_path) { nil }
+  let(:env_test_file_pattern) { nil }
+
+  describe '#allocator' do
+    subject { allocator_builder.allocator }
+
+    before do
+      expect(Knapsack::Config::Env).to receive(:report_path).and_return(env_report_path)
+      expect(Knapsack::Config::Env).to receive(:test_file_pattern).and_return(env_test_file_pattern)
+      expect(Knapsack::Config::Env).to receive(:ci_node_total).and_return(env_ci_node_total)
+      expect(Knapsack::Config::Env).to receive(:ci_node_index).and_return(env_ci_node_index)
+
+      expect(Knapsack).to receive(:report).twice.and_return(knapsack_report)
+      expect(knapsack_report).to receive(:open).and_return(report)
+
+      expect(knapsack_report).to receive(:config).with(report_config)
+      expect(Knapsack::Allocator).to receive(:new).with(allocator_args).and_return(allocator)
+    end
+
+    shared_examples 'allocator builder' do
+      context 'when ENVs are nil' do
+        let(:report_config) { { report_path: adapter_report_path } }
+        let(:allocator_args) do
+          {
+            report: report,
+            test_file_pattern: adapter_test_file_pattern,
+            ci_node_total: env_ci_node_total,
+            ci_node_index: env_ci_node_index
+          }
+        end
+
+        it { should eql allocator }
+      end
+
+      context 'when ENV report_path has value' do
+        let(:env_report_path) { 'knapsack_custom_report.json' }
+        let(:report_config) { { report_path: env_report_path } }
+        let(:allocator_args) do
+          {
+            report: report,
+            test_file_pattern: adapter_test_file_pattern,
+            ci_node_total: env_ci_node_total,
+            ci_node_index: env_ci_node_index
+          }
+        end
+
+        it { should eql allocator }
+      end
+
+      context 'when ENV test_file_pattern has value' do
+        let(:env_test_file_pattern) { 'custom_spec/**/*_spec.rb' }
+        let(:report_config) { { report_path: adapter_report_path } }
+        let(:allocator_args) do
+          {
+            report: report,
+            test_file_pattern: env_test_file_pattern,
+            ci_node_total: env_ci_node_total,
+            ci_node_index: env_ci_node_index
+          }
+        end
+
+        it { should eql allocator }
+      end
+    end
+
+    context 'when RspecAdapter' do
+      let(:adapter_class) { Knapsack::Adapters::RspecAdapter }
+      it_behaves_like 'allocator builder'
+    end
+
+    context 'when CucumberAdapter' do
+      let(:adapter_class) { Knapsack::Adapters::CucumberAdapter }
+      it_behaves_like 'allocator builder'
+    end
+  end
+end