knapsack 0.5.0 → 1.0.0

data/lib/knapsack.rb

@@ -1,17 +1,20 @@
 require 'singleton'
 require_relative 'knapsack/version'
-require_relative 'knapsack/config'
+require_relative 'knapsack/config/env'
+require_relative 'knapsack/config/tracker'
 require_relative 'knapsack/logger'
 require_relative 'knapsack/tracker'
 require_relative 'knapsack/presenter'
 require_relative 'knapsack/report'
 require_relative 'knapsack/allocator'
+require_relative 'knapsack/allocator_builder'
 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'
+require_relative 'knapsack/adapters/cucumber_adapter'
 
 module Knapsack
   class << self
@@ -26,7 +29,7 @@ module Knapsack
     end
 
     def root
-      File.expand_path '../..', __FILE__
+      File.expand_path('../..', __FILE__)
     end
 
     def load_tasks

data/lib/knapsack/adapters/base_adapter.rb

@@ -1,6 +1,10 @@
 module Knapsack
   module Adapters
     class BaseAdapter
+      # Just examples, please overwrite constants in subclasses
+      TEST_DIR_PATTERN = 'test/**/*_test.rb'
+      REPORT_PATH = 'knapsack_base_report.json'
+
       def self.bind
         adapter = new
         adapter.bind
@@ -8,6 +12,8 @@ module Knapsack
       end
 
       def bind
+        update_report_config
+
         if tracker.config[:generate_report]
           Knapsack.logger.info 'Knapsack report generator started!'
           bind_time_tracker
@@ -33,11 +39,21 @@ module Knapsack
         raise NotImplementedError
       end
 
-      protected
+      private
 
       def tracker
         Knapsack.tracker
       end
+
+      def update_report_config
+        current_test_file_pattern = Knapsack.report.config[:test_file_pattern]
+        current_report_path = Knapsack.report.config[:report_path]
+
+        Knapsack.report.config({
+          test_file_pattern: Knapsack::Config::Env.test_file_pattern || current_test_file_pattern || self.class::TEST_DIR_PATTERN,
+          report_path: Knapsack::Config::Env.report_path || current_report_path || self.class::REPORT_PATH
+        })
+      end
     end
   end
 end

data/lib/knapsack/adapters/cucumber_adapter.rb

@@ -0,0 +1,40 @@
+module Knapsack
+  module Adapters
+    class CucumberAdapter < BaseAdapter
+      TEST_DIR_PATTERN = 'features/**/*.feature'
+      REPORT_PATH = 'knapsack_cucumber_report.json'
+
+      def bind_time_tracker
+        Around do |scenario, block|
+          Knapsack.tracker.test_path = scenario.file
+          Knapsack.tracker.start_timer
+          block.call
+          Knapsack.tracker.stop_timer
+        end
+
+        ::Kernel.at_exit do
+          Knapsack.logger.info(Presenter.global_time)
+        end
+      end
+
+      def bind_report_generator
+        ::Kernel.at_exit do
+          Knapsack.report.save
+          Knapsack.logger.info(Presenter.report_details)
+        end
+      end
+
+      def bind_time_offset_warning
+        ::Kernel.at_exit do
+          Knapsack.logger.warn(Presenter.time_offset_warning)
+        end
+      end
+
+      private
+
+      def Around(*tag_expressions, &proc)
+        ::Cucumber::RbSupport::RbDsl.register_rb_hook('around', tag_expressions, proc)
+      end
+    end
+  end
+end

data/lib/knapsack/adapters/rspec_adapter.rb

@@ -1,6 +1,9 @@
 module Knapsack
   module Adapters
     class RspecAdapter < BaseAdapter
+      TEST_DIR_PATTERN = 'spec/**/*_spec.rb'
+      REPORT_PATH = 'knapsack_rspec_report.json'
+
       def bind_time_tracker
         ::RSpec.configure do |config|
           config.before(:each) do
@@ -10,7 +13,7 @@ module Knapsack
               else
                 example.metadata
               end
-            Knapsack.tracker.spec_path = RspecAdapter.spec_path(current_example_group)
+            Knapsack.tracker.test_path = RspecAdapter.test_path(current_example_group)
             Knapsack.tracker.start_timer
           end
 
@@ -41,7 +44,7 @@ module Knapsack
         end
       end
 
-      def self.spec_path(example_group)
+      def self.test_path(example_group)
         until example_group[:parent_example_group].nil?
           example_group = example_group[:parent_example_group]
         end

data/lib/knapsack/allocator.rb

@@ -1,29 +1,28 @@
 module Knapsack
   class Allocator
     def initialize(args={})
-      @spec_pattern = args[:spec_pattern] || Config.spec_pattern
       @report_distributor = Knapsack::Distributors::ReportDistributor.new(args)
       @leftover_distributor = Knapsack::Distributors::LeftoverDistributor.new(args)
     end
 
-    def report_node_specs
-      @report_node_specs ||= @report_distributor.specs_for_current_node
+    def report_node_tests
+      @report_node_tests ||= @report_distributor.tests_for_current_node
     end
 
-    def leftover_node_specs
-      @leftover_node_specs ||= @leftover_distributor.specs_for_current_node
+    def leftover_node_tests
+      @leftover_node_tests ||= @leftover_distributor.tests_for_current_node
     end
 
-    def node_specs
-      @node_specs ||= report_node_specs + leftover_node_specs
+    def node_tests
+      @node_tests ||= report_node_tests + leftover_node_tests
     end
 
-    def stringify_node_specs
-      node_specs.join(' ')
+    def stringify_node_tests
+      node_tests.join(' ')
     end
 
-    def spec_dir
-      @spec_pattern.gsub(/^(.*?)\//).first
+    def test_dir
+      @report_distributor.test_file_pattern.gsub(/^(.*?)\//).first
     end
   end
 end

data/lib/knapsack/allocator_builder.rb

@@ -0,0 +1,33 @@
+module Knapsack
+  class AllocatorBuilder
+    def initialize(adapter_class)
+      @adapter_class = adapter_class
+      set_report_path
+    end
+
+    def allocator
+      Knapsack::Allocator.new({
+        report: Knapsack.report.open,
+        test_file_pattern: test_file_pattern,
+        ci_node_total: Knapsack::Config::Env.ci_node_total,
+        ci_node_index: Knapsack::Config::Env.ci_node_index
+      })
+    end
+
+    private
+
+    def set_report_path
+      Knapsack.report.config({
+        report_path: report_path
+      })
+    end
+
+    def report_path
+      Knapsack::Config::Env.report_path || @adapter_class::REPORT_PATH
+    end
+
+    def test_file_pattern
+      Knapsack::Config::Env.test_file_pattern || @adapter_class::TEST_DIR_PATTERN
+    end
+  end
+end

data/lib/knapsack/config/env.rb

@@ -0,0 +1,30 @@
+module Knapsack
+  module Config
+    class Env
+      class << self
+        def report_path
+          ENV['KNAPSACK_REPORT_PATH']
+        end
+
+        def ci_node_total
+          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'] || semaphore_current_thread || 0
+        end
+
+        def test_file_pattern
+          ENV['KNAPSACK_TEST_FILE_PATTERN']
+        end
+
+        private
+
+        def semaphore_current_thread
+          index = ENV['SEMAPHORE_CURRENT_THREAD']
+          index.to_i - 1 if index
+        end
+      end
+    end
+  end
+end

data/lib/knapsack/config/tracker.rb

@@ -0,0 +1,19 @@
+module Knapsack
+  module Config
+    class Tracker
+      class << self
+        def enable_time_offset_warning
+          true
+        end
+
+        def time_offset_in_seconds
+          30
+        end
+
+        def generate_report
+          ENV['KNAPSACK_GENERATE_REPORT'] || false
+        end
+      end
+    end
+  end
+end

data/lib/knapsack/distributors/base_distributor.rb

@@ -1,13 +1,13 @@
 module Knapsack
   module Distributors
     class BaseDistributor
-      attr_reader :report, :node_specs, :spec_pattern
+      attr_reader :report, :node_tests, :test_file_pattern
 
       def initialize(args={})
-        @report = args[:report] || default_report
-        @ci_node_total = args[:ci_node_total] || config.ci_node_total
-        @ci_node_index = args[:ci_node_index] || config.ci_node_index
-        @spec_pattern = args[:spec_pattern] || config.spec_pattern
+        @report = args[:report] || raise('Missing report')
+        @test_file_pattern = args[:test_file_pattern] || raise('Missing test_file_pattern')
+        @ci_node_total = args[:ci_node_total] || raise('Missing ci_node_total')
+        @ci_node_index = args[:ci_node_index] || raise('Missing ci_node_index')
       end
 
       def ci_node_total
@@ -18,47 +18,37 @@ module Knapsack
         @ci_node_index.to_i
       end
 
-      def specs_for_current_node
-        specs_for_node(ci_node_index)
+      def tests_for_current_node
+        tests_for_node(ci_node_index)
       end
 
-      def specs_for_node(node_index)
-        assign_spec_files_to_node
-        post_specs_for_node(node_index)
+      def tests_for_node(node_index)
+        assign_test_files_to_node
+        post_tests_for_node(node_index)
       end
 
-      def assign_spec_files_to_node
-        default_node_specs
-        post_assign_spec_files_to_node
+      def assign_test_files_to_node
+        default_node_tests
+        post_assign_test_files_to_node
       end
 
-      def all_specs
-        @all_specs ||= Dir[spec_pattern]
+      def all_tests
+        @all_tests ||= Dir[test_file_pattern]
       end
 
       protected
 
-      def post_specs_for_node(node_index)
+      def post_tests_for_node(node_index)
         raise NotImplementedError
       end
 
-      def post_assign_spec_files_to_node
+      def post_assign_test_files_to_node
         raise NotImplementedError
       end
 
-      def default_node_specs
+      def default_node_tests
         raise NotImplementedError
       end
-
-      private
-
-      def config
-        Knapsack::Config
-      end
-
-      def default_report
-        Knapsack.report.open
-      end
     end
   end
 end

data/lib/knapsack/distributors/leftover_distributor.rb

@@ -1,35 +1,35 @@
 module Knapsack
   module Distributors
     class LeftoverDistributor < BaseDistributor
-      def report_specs
-        @report_specs ||= report.keys
+      def report_tests
+        @report_tests ||= report.keys
       end
 
-      def leftover_specs
-        @leftover_specs ||= all_specs - report_specs
+      def leftover_tests
+        @leftover_tests ||= all_tests - report_tests
       end
 
       private
 
-      def post_assign_spec_files_to_node
+      def post_assign_test_files_to_node
         node_index = 0
-        leftover_specs.each do |spec_file|
-          node_specs[node_index] << spec_file
+        leftover_tests.each do |test_file|
+          node_tests[node_index] << test_file
           node_index += 1
           node_index %= ci_node_total
         end
       end
 
-      def post_specs_for_node(node_index)
-        spec_files = node_specs[node_index]
-        return unless spec_files
-        spec_files
+      def post_tests_for_node(node_index)
+        test_files = node_tests[node_index]
+        return unless test_files
+        test_files
       end
 
-      def default_node_specs
-        @node_specs = []
+      def default_node_tests
+        @node_tests = []
         ci_node_total.times do |index|
-          @node_specs[index] = []
+          @node_tests[index] = []
         end
       end
     end

data/lib/knapsack/distributors/report_distributor.rb

@@ -2,15 +2,15 @@ module Knapsack
   module Distributors
     class ReportDistributor < BaseDistributor
       def sorted_report
-        @sorted_report ||= report.sort_by { |spec_path, time| time }.reverse
+        @sorted_report ||= report.sort_by { |test_path, time| time }.reverse
       end
 
-      def sorted_report_with_existing_specs
-        @sorted_report_with_existing_specs ||= sorted_report.select { |spec_path, time| all_specs.include?(spec_path) }
+      def sorted_report_with_existing_tests
+        @sorted_report_with_existing_tests ||= sorted_report.select { |test_path, time| all_tests.include?(test_path) }
       end
 
       def total_time_execution
-        @total_time_execution ||= sorted_report_with_existing_specs.map(&:last).reduce(0, :+).to_f
+        @total_time_execution ||= sorted_report_with_existing_tests.map(&:last).reduce(0, :+).to_f
       end
 
       def node_time_execution
@@ -19,62 +19,62 @@ module Knapsack
 
       private
 
-      def post_assign_spec_files_to_node
-        assign_slow_spec_files
-        assign_remaining_spec_files
+      def post_assign_test_files_to_node
+        assign_slow_test_files
+        assign_remaining_test_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)
+      def post_tests_for_node(node_index)
+        node_test = node_tests[node_index]
+        return unless node_test
+        node_test[:test_files_with_time].map(&:first)
       end
 
-      def default_node_specs
-        @node_specs = []
+      def default_node_tests
+        @node_tests = []
         ci_node_total.times do |index|
-          @node_specs << {
+          @node_tests << {
             node_index: index,
             time_left: node_time_execution,
-            spec_files_with_time: []
+            test_files_with_time: []
           }
         end
       end
 
-      def assign_slow_spec_files
-        @not_assigned_spec_files = []
+      def assign_slow_test_files
+        @not_assigned_test_files = []
         node_index = 0
-        sorted_report_with_existing_specs.each do |spec_file_with_time|
-          assign_slow_spec_file(node_index, spec_file_with_time)
+        sorted_report_with_existing_tests.each do |test_file_with_time|
+          assign_slow_test_file(node_index, test_file_with_time)
           node_index += 1
           node_index %= ci_node_total
         end
       end
 
-      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
+      def assign_slow_test_file(node_index, test_file_with_time)
+        time = test_file_with_time[1]
+        time_left = node_tests[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_tests[node_index][:test_files_with_time].empty?
+          node_tests[node_index][:time_left] -= time
+          node_tests[node_index][:test_files_with_time] << test_file_with_time
         else
-          @not_assigned_spec_files << spec_file_with_time
+          @not_assigned_test_files << test_file_with_time
         end
       end
 
-      def assign_remaining_spec_files
-        @not_assigned_spec_files.each do |spec_file_with_time|
+      def assign_remaining_test_files
+        @not_assigned_test_files.each do |test_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
+          time = test_file_with_time[1]
+          node_tests[index][:time_left] -= time
+          node_tests[index][:test_files_with_time] << test_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]
+        node_test = node_tests.max { |a,b| a[:time_left] <=> b[:time_left] }
+        node_test[:node_index]
       end
     end
   end