knapsack 0.0.3 → 0.1.0

data/lib/knapsack/distributors/leftover_distributor.rb

@@ -0,0 +1,49 @@
+module Knapsack
+  module Distributors
+    class LeftoverDistributor < BaseDistributor
+      attr_reader :spec_pattern
+
+      def report_specs
+        @report_specs ||= @report.keys
+      end
+
+      def all_specs
+        @all_specs ||= Dir[spec_pattern]
+      end
+
+      def leftover_specs
+        @leftover_specs ||= all_specs - report_specs
+      end
+
+      private
+
+      def post_initialize(args={})
+        @spec_pattern = args[:spec_pattern] || default_spec_pattern
+      end
+
+      def default_spec_pattern
+        'spec/**/*_spec.rb'
+      end
+
+      def post_assign_spec_files_to_node
+        leftover_specs.each do |spec_file|
+          node_specs[@node_index] << spec_file
+          update_node_index
+        end
+      end
+
+      def post_specs_for_node(node_index)
+        spec_files = node_specs[node_index]
+        return unless spec_files
+        spec_files
+      end
+
+      def default_node_specs
+        @node_specs = []
+        ci_node_total.times do |index|
+          @node_specs[index] = []
+        end
+      end
+    end
+  end
+end

data/lib/knapsack/distributors/report_distributor.rb

@@ -0,0 +1,76 @@
+module Knapsack
+  module Distributors
+    class ReportDistributor < BaseDistributor
+      def sorted_report
+        @sorted_report ||= report.sort_by{|k,v| v}.reverse
+      end
+
+      def total_time_execution
+        @total_time_execution ||= report.values.reduce(0, :+).to_f
+      end
+
+      def node_time_execution
+        @node_time_execution ||= total_time_execution / ci_node_total
+      end
+
+      private
+
+      def post_assign_spec_files_to_node
+        assign_slow_spec_files
+        assign_remaining_spec_files
+      end
+
+      def post_specs_for_node(node_index)
+        node_spec = node_specs[node_index]
+        return unless node_spec
+        node_spec[:spec_files_with_time].map(&:first)
+      end
+
+      def default_node_specs
+        @node_specs = []
+        ci_node_total.times do |index|
+          @node_specs << {
+            node_index: index,
+            time_left: node_time_execution,
+            spec_files_with_time: []
+          }
+        end
+      end
+
+      def assign_slow_spec_files
+        @not_assigned_spec_files = []
+        @node_index = 0
+        sorted_report.each do |spec_file_with_time|
+          assign_slow_spec_file(spec_file_with_time)
+          update_node_index
+        end
+      end
+
+      def assign_slow_spec_file(spec_file_with_time)
+        time = spec_file_with_time[1]
+        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
+        else
+          @not_assigned_spec_files << spec_file_with_time
+        end
+      end
+
+      def assign_remaining_spec_files
+        @not_assigned_spec_files.each do |spec_file_with_time|
+          index = node_with_max_time_left
+          time = spec_file_with_time[1]
+          node_specs[index][:time_left] -= time
+          node_specs[index][:spec_files_with_time] << spec_file_with_time
+        end
+      end
+
+      def node_with_max_time_left
+        node_spec = node_specs.max { |a,b| a[:time_left] <=> b[:time_left] }
+        node_spec[:node_index]
+      end
+    end
+  end
+end

data/lib/knapsack/presenter.rb

@@ -5,19 +5,52 @@ module Knapsack
   class Presenter
     class << self
       def report_yml
-        Knapsack.tracker.files.to_yaml
+        Knapsack.tracker.spec_files_with_time.to_yaml
       end
 
       def report_json
-        JSON.pretty_generate(Knapsack.tracker.files)
+        JSON.pretty_generate(Knapsack.tracker.spec_files_with_time)
+      end
+
+      def report_details
+        "Knapsack report was generated. Preview:\n" + Presenter.report_json
       end
 
       def global_time
-        "Knapsack global time execution for specs: #{Knapsack.tracker.global_time}s"
+        "\nKnapsack global time execution for specs: #{Knapsack.tracker.global_time}s"
       end
 
-      def report_details
-        "Knapsack report was generated. Preview:\n" + Presenter.report_json
+      def time_offset
+        "Time offset: #{Knapsack.tracker.config[:time_offset_in_seconds]}s"
+      end
+
+      def max_allowed_node_time_execution
+        "Max allowed node time execution: #{Knapsack.tracker.max_node_time_execution}s"
+      end
+
+      def exceeded_time
+        "Exceeded time: #{Knapsack.tracker.exceeded_time}s"
+      end
+
+      def time_offset_warning
+        str = %{\n========= Knapsack Time Offset Warning ==========
+#{Presenter.time_offset}
+#{Presenter.max_allowed_node_time_execution}
+#{Presenter.exceeded_time}
+        }
+        if Knapsack.tracker.time_exceeded?
+          str << %{
+Specs 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.}
+        else
+          str << %{
+Global time execution for this CI node is fine.
+Happy testing!}
+        end
+        str << "\n=================================================\n"
+        str
       end
     end
   end

data/lib/knapsack/report.rb

@@ -1,20 +1,35 @@
 module Knapsack
   class Report
-    REPORT_PATH = 'knapsack_report.json'
+    include Singleton
 
-    class << self
-      def save
-        File.open(REPORT_PATH, 'w+') do |f|
-          f.write(Presenter.report_json)
-        end
-      end
+    def config(opts={})
+      @config ||= default_config
+      @config.merge!(opts)
+    end
 
-      def open
-        report = File.read(REPORT_PATH)
-        JSON.parse(report)
-      rescue Errno::ENOENT
-        raise "Knapsack report file doesn't exist. Please generate report first!"
+    def save
+      File.open(config[:report_path], 'w+') do |f|
+        f.write(report_json)
       end
     end
+
+    def open
+      report = File.read(config[:report_path])
+      JSON.parse(report)
+    rescue Errno::ENOENT
+      raise "Knapsack report file doesn't exist. Please generate report first!"
+    end
+
+    private
+
+    def default_config
+      {
+        report_path: 'knapsack_report.json'
+      }
+    end
+
+    def report_json
+      Presenter.report_json
+    end
   end
 end

data/lib/knapsack/task_loader.rb

@@ -0,0 +1,11 @@
+require 'rake'
+
+module Knapsack
+  class TaskLoader
+    include ::Rake::DSL
+
+    def load_tasks
+      Dir.glob("#{Knapsack.root}/lib/tasks/*.rake").each { |r| import r }
+    end
+  end
+end

data/lib/knapsack/tracker.rb

@@ -1,20 +1,14 @@
-require 'singleton'
-
 module Knapsack
   class Tracker
     include Singleton
 
-    attr_reader :global_time, :files
+    attr_reader :global_time, :spec_files_with_time
     attr_writer :spec_path
 
     def initialize
       set_defaults
     end
 
-    def generate_report?
-      ENV['KNAPSACK_GENERATE_REPORT'] || false
-    end
-
     def config(opts={})
       @config ||= default_config
       @config.merge!(opts)
@@ -35,18 +29,41 @@ module Knapsack
       @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(/^\.\//, '')
+    end
+
+    def time_exceeded?
+      global_time > max_node_time_execution
+    end
+
+    def max_node_time_execution
+      report_distributor.node_time_execution + config[:time_offset_in_seconds]
+    end
+
+    def exceeded_time
+      global_time - max_node_time_execution
+    end
+
     private
 
     def default_config
       {
         enable_time_offset_warning: true,
-        time_offset_warning: 30,
+        time_offset_in_seconds: 30,
+        generate_report: generate_report
       }
     end
 
+    def generate_report
+      ENV['KNAPSACK_GENERATE_REPORT'] || false
+    end
+
     def set_defaults
       @global_time = 0
-      @files = {}
+      @spec_files_with_time = {}
+      @spec_path = nil
     end
 
     def update_global_time
@@ -54,12 +71,12 @@ module Knapsack
     end
 
     def update_spec_file_time
-      @files[spec_path] ||= 0
-      @files[spec_path] += @execution_time
+      @spec_files_with_time[spec_path] ||= 0
+      @spec_files_with_time[spec_path] += @execution_time
     end
 
-    def spec_path
-      @spec_path || raise("spec_path needs to be set by Knapsack Adapter's bind method")
+    def report_distributor
+      @report_distributor ||= Knapsack::Distributors::ReportDistributor.new
     end
   end
 end

data/lib/knapsack/version.rb

@@ -1,3 +1,3 @@
 module Knapsack
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/lib/tasks/knapsack.rake

@@ -0,0 +1,21 @@
+require 'knapsack'
+
+namespace :knapsack do
+  task :rspec do
+    allocator = Knapsack::Allocator.new
+
+    puts
+    puts 'Report specs:'
+    puts allocator.report_node_specs
+    puts
+    puts 'Leftover specs:'
+    puts allocator.leftover_node_specs
+    puts
+
+    custom_spec_dir = allocator.custom_spec_dir
+    default_path = custom_spec_dir ? "--default-path #{custom_spec_dir}" : nil
+    cmd = %Q[bundle exec rspec #{default_path} -- #{allocator.stringify_node_specs}]
+
+    exec(cmd)
+  end
+end

data/spec/knapsack/adapters/base_adapter_spec.rb

@@ -0,0 +1,91 @@
+describe Knapsack::Adapters::BaseAdapter do
+  describe '.bind' do
+    let(:adapter) { instance_double(described_class) }
+
+    subject { described_class.bind }
+
+    before do
+      expect(described_class).to receive(:new).and_return(adapter)
+      expect(adapter).to receive(:bind)
+    end
+
+    it { should eql adapter }
+  end
+
+  describe '#bind' do
+    let(:tracker) { instance_double(Knapsack::Tracker) }
+
+    before do
+      allow(subject).to receive(:tracker).and_return(tracker)
+    end
+
+    context 'when generate report' do
+      before do
+        expect(tracker).to receive(:config).and_return({ generate_report: true })
+      end
+
+      it do
+        expect(subject).to receive(:bind_time_tracker)
+        expect(subject).to receive(:bind_report_generator)
+        expect(subject).not_to receive(:bind_time_offset_warning)
+        subject.bind
+      end
+    end
+
+    context 'when enable time offset warning' do
+      before do
+        expect(tracker).to receive(:config).twice.and_return({
+          generate_report: false,
+          enable_time_offset_warning: true
+        })
+      end
+
+      it do
+        expect(subject).to receive(:bind_time_tracker)
+        expect(subject).to receive(:bind_time_offset_warning)
+        expect(subject).not_to receive(:bind_report_generator)
+        subject.bind
+      end
+    end
+
+    context 'when adapter is off' do
+      before do
+        expect(tracker).to receive(:config).twice.and_return({
+          generate_report: false,
+          enable_time_offset_warning: false
+        })
+      end
+
+      it do
+        expect(subject).not_to receive(:bind_time_tracker)
+        expect(subject).not_to receive(:bind_report_generator)
+        expect(subject).not_to receive(:bind_time_offset_warning)
+        subject.bind
+      end
+    end
+  end
+
+  describe '#bind_time_tracker' do
+    it do
+      expect {
+        subject.bind_time_tracker
+      }.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe '#bind_report_generator' do
+    it do
+      expect {
+        subject.bind_report_generator
+      }.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe '#bind_time_offset_warning' do
+    it do
+      expect {
+        subject.bind_time_offset_warning
+      }.to raise_error(NotImplementedError)
+    end
+  end
+end