knapsack 1.18.0 → 3.1.0

data/README.md

@@ -1 +1,36 @@
-# [Open README](http://docs.knapsackpro.com/ruby/knapsack)
+# knapsack gem
+
+Knapsack splits tests evenly across parallel CI nodes to run fast CI build and save you time.
+
+|                                              | knapsack gem | knapsack_pro gem |
+| -------------------------------------------- | ------------ | ---------------- |
+| __Is free__                                  | ✓ Yes        | ✓ Yes, [free plan](https://knapsackpro.com?utm_source=github&utm_medium=readme&utm_campaign=knapsack_gem&utm_content=free_plan) |
+| __Regular Mode - a static tests split__      | ✓ Yes        | ✓ Yes |
+| __Queue Mode - a dynamic tests split__ <br>([ensures all CI nodes finish work at the same time](https://docs.knapsackpro.com/2020/how-to-speed-up-ruby-and-javascript-tests-with-ci-parallelisation))       | No           | ✓ Yes |
+| __Auto [split slow RSpec test file](https://knapsackpro.com/faq/question/how-to-split-slow-rspec-test-files-by-test-examples-by-individual-it) between parallel CI nodes__ <br>(a single test file can be auto split by test examples between parallel jobs) | No           | ✓ Yes |
+| Tracking tests timing per commit, branch     | No           | ✓ Yes |
+| Support for other programming languages      | No           | ✓ Yes |
+| Support for CI providers                     | limited      | ✓ Yes |
+| __Installation README__                      | [Install README](http://docs.knapsackpro.com/ruby/knapsack) | [Install README](https://docs.knapsackpro.com/integration/) |
+
+[Features of knapsack vs knapsack_pro Ruby gem](https://knapsackpro.com/features/ruby_knapsack_pro_vs_knapsack?utm_source=github&utm_medium=readme&utm_campaign=knapsack_gem&utm_content=ruby_knapsack_pro_vs_knapsack)
+
+# Do you use Heroku?
+
+Do you know Knapsack Pro Ruby gem is available as Heroku add-on that's currently in beta and it's free to all beta users? It works with your current CI server.
+https://elements.heroku.com/addons/knapsack-pro
+
+Knapsack Pro has Queue Mode that will split Ruby & JS tests in a dynamic way across parallel CI nodes to ensure each parallel job takes a similar time. Thanks to that there is no bottleneck in your CI pipelines.
+
+__See introduction how the Knapsack Pro add-on works__
+https://youtu.be/rmXES2N0_QU
+
+You may also find useful article how to run parallel dynos on Heroku CI to complete tests faster
+https://docs.knapsackpro.com/2019/how-to-run-tests-faster-on-heroku-ci-with-parallel-dynos
+
+## Do you know
+
+* Knapsack Pro is risk-free integration! Knapsack Pro runs tests in Fallback Mode if your CI servers can't reach our API for any reason.
+* We don't need access to your repository. Knapsack Pro is just wrapper around test runner like RSpec, Cucumber, Minitest etc.
+* Hundreds of developers use Knapsack Pro every day to run fast CI builds.
+* It works with other programming languages.

data/knapsack.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["arturtrzop@gmail.com"]
   spec.summary       = %q{Knapsack splits tests across CI nodes and makes sure that tests will run comparable time on each node.}
   spec.description   = %q{Parallel tests across CI server nodes based on each test file's time execution. It generates a test time execution report and uses it for future test runs.}
-  spec.homepage      = "https://github.com/ArturT/knapsack"
+  spec.homepage      = "https://github.com/KnapsackPro/knapsack"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -18,17 +18,16 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_ruby_version = '>= 2.2'
 
   spec.add_dependency 'rake', '>= 0'
 
   spec.add_development_dependency 'bundler', '>= 1.6'
   spec.add_development_dependency 'rspec', '~> 3.0', '>= 2.10.0'
-  spec.add_development_dependency 'rspec-its', '~> 1.2'
+  spec.add_development_dependency 'rspec-its', '~> 1.3'
   spec.add_development_dependency 'cucumber', '>= 0'
   spec.add_development_dependency 'spinach', '>= 0.8'
   spec.add_development_dependency 'minitest', '>= 5.0.0'
-  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0'
   spec.add_development_dependency 'pry', '~> 0'
-  spec.add_development_dependency 'timecop', '>= 0.1.0'
+  spec.add_development_dependency 'timecop', '>= 0.9.4'
 end

data/lib/knapsack/adapters/minitest_adapter.rb

@@ -23,20 +23,20 @@ module Knapsack
       def bind_time_tracker
         ::Minitest::Test.send(:include, BindTimeTrackerMinitestPlugin)
 
-        add_post_run_callback do
+        Minitest.after_run do
           Knapsack.logger.info(Presenter.global_time)
         end
       end
 
       def bind_report_generator
-        add_post_run_callback do
+        Minitest.after_run do
           Knapsack.report.save
           Knapsack.logger.info(Presenter.report_details)
         end
       end
 
       def bind_time_offset_warning
-        add_post_run_callback do
+        Minitest.after_run do
           Knapsack.logger.log(
             Presenter.time_offset_log_level,
             Presenter.time_offset_warning
@@ -64,16 +64,6 @@ module Knapsack
         # test_path will look like ./test/dir/unit_test.rb
         test_path
       end
-
-      private
-
-      def add_post_run_callback(&block)
-        if Minitest.respond_to?(:after_run)
-          Minitest.after_run { block.call }
-        else
-          Minitest::Unit.after_tests { block.call }
-        end
-      end
     end
   end
 end

data/lib/knapsack/adapters/rspec_adapter.rb

@@ -6,6 +6,10 @@ module Knapsack
 
       def bind_time_tracker
         ::RSpec.configure do |config|
+          config.prepend_before(:context) do
+            Knapsack.tracker.start_timer
+          end
+
           config.prepend_before(:each) do
             current_example_group =
               if ::RSpec.respond_to?(:current_example)
@@ -14,10 +18,9 @@ module Knapsack
                 example.metadata
               end
             Knapsack.tracker.test_path = RSpecAdapter.test_path(current_example_group)
-            Knapsack.tracker.start_timer
           end
 
-          config.append_after(:each) do
+          config.append_after(:context) do
             Knapsack.tracker.stop_timer
           end
 

data/lib/knapsack/config/env.rb

@@ -7,11 +7,11 @@ module Knapsack
         end
 
         def ci_node_total
-          ENV['CI_NODE_TOTAL'] || ENV['CIRCLE_NODE_TOTAL'] || ENV['SEMAPHORE_JOB_COUNT'] || ENV['SEMAPHORE_THREAD_COUNT'] || ENV['BUILDKITE_PARALLEL_JOB_COUNT'] || ENV['SNAP_WORKER_TOTAL'] || 1
+          ENV['CI_NODE_TOTAL'] || ENV['CIRCLE_NODE_TOTAL'] || ENV['SEMAPHORE_JOB_COUNT'] || ENV['SEMAPHORE_THREAD_COUNT'] || ENV['BUILDKITE_PARALLEL_JOB_COUNT'] || ENV['SNAP_WORKER_TOTAL'] || ENV['BITBUCKET_PARALLEL_STEP_COUNT'] || 1
         end
 
         def ci_node_index
-          gitlab_ci_node_index || ENV['CI_NODE_INDEX'] || ENV['CIRCLE_NODE_INDEX'] || semaphore_job_index || semaphore_current_thread || ENV['BUILDKITE_PARALLEL_JOB'] || snap_ci_worker_index || 0
+          gitlab_ci_node_index || ENV['CI_NODE_INDEX'] || ENV['CIRCLE_NODE_INDEX'] || semaphore_job_index || semaphore_current_thread || ENV['BUILDKITE_PARALLEL_JOB'] || snap_ci_worker_index || ENV['BITBUCKET_PARALLEL_STEP'] || 0
         end
 
         def test_file_pattern

data/lib/knapsack/distributors/report_distributor.rb

@@ -2,7 +2,7 @@ module Knapsack
   module Distributors
     class ReportDistributor < BaseDistributor
       def sorted_report
-        @sorted_report ||= report.sort_by { |test_path, time| time }.reverse
+        @sorted_report ||= report.sort_by { |_test_path, time| -time }
       end
 
       def sorted_report_with_existing_tests
@@ -10,7 +10,7 @@ module Knapsack
       end
 
       def total_time_execution
-        @total_time_execution ||= sorted_report_with_existing_tests.map(&:last).reduce(0, :+).to_f
+        @total_time_execution ||= sorted_report_with_existing_tests.map { |_test_path, time| time }.reduce(0, :+).to_f
       end
 
       def node_time_execution
@@ -20,73 +20,52 @@ module Knapsack
       private
 
       def post_assign_test_files_to_node
-        assign_slow_test_files
-        assign_remaining_test_files
+        assign_test_files
         sort_assigned_test_files
       end
 
       def sort_assigned_test_files
-        ci_node_total.times do |index|
-          # sort by first key (file name)
-          # reverse it and then sort by second key (time) in reverse order
-          node_tests[index][:test_files_with_time].sort!.reverse!.sort! do |x, y|
-            y[1] <=> x[1]
-          end
+        node_tests.map do |node|
+          node[:test_files_with_time]
+            .sort_by! { |file_name, _time| file_name }
+            .reverse!
+            .sort_by! { |_file_name, time| time }
+            .reverse!
         end
       end
 
       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)
+        node_test[:test_files_with_time].map { |file_name, _time| file_name }
       end
 
       def default_node_tests
-        @node_tests = []
-        ci_node_total.times do |index|
-          @node_tests << {
+        @node_tests = Array.new(ci_node_total) do |index|
+          {
             node_index: index,
             time_left: node_time_execution,
-            test_files_with_time: []
+            test_files_with_time: [],
+            weight: 0
           }
         end
       end
 
-      def assign_slow_test_files
-        @not_assigned_test_files = []
-        node_index = 0
-        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_test_files
+        sorted_report_with_existing_tests.map do |test_file_with_time|
+          test_execution_time = test_file_with_time.last
 
-      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
+          current_lightest_node = node_tests.min_by { |node| node[:weight] }
 
-        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_test_files << test_file_with_time
-        end
-      end
+          updated_node_data = {
+            time_left:            current_lightest_node[:time_left] - test_execution_time,
+            weight:               current_lightest_node[:weight] + test_execution_time,
+            test_files_with_time: current_lightest_node[:test_files_with_time] << test_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 = test_file_with_time[1]
-          node_tests[index][:time_left] -= time
-          node_tests[index][:test_files_with_time] << test_file_with_time
+          current_lightest_node.merge!(updated_node_data)
         end
       end
-
-      def node_with_max_time_left
-        node_test = node_tests.max { |a,b| a[:time_left] <=> b[:time_left] }
-        node_test[:node_index]
-      end
     end
   end
 end

data/lib/knapsack/presenter.rb

@@ -51,10 +51,14 @@ module Knapsack
         }
         if Knapsack.tracker.time_exceeded?
           str << %{
-Tests on this CI node took more than max allowed node time execution.
+Test on this CI node ran for longer than the max allowed node time execution.
 Please regenerate your knapsack report.
-If that didn't help then split your heavy test file
-or bump time_offset_in_seconds setting.}
+
+If that doesn't help, you can split your slowest test files into smaller files, or bump up the time_offset_in_seconds setting.
+
+You can also allow the knapsack_pro gem to automatically divide your slow test files across parallel CI nodes.
+https://knapsackpro.com/faq/question/how-to-auto-split-test-files-by-test-cases-on-parallel-jobs-ci-nodes?utm_source=knapsack_gem&utm_medium=knapsack_gem_output&utm_campaign=knapsack_gem_time_offset_warning
+}
         else
           str << %{
 Global time execution for this CI node is fine.
@@ -63,9 +67,8 @@ Happy testing!}
         str << "\n\nNeed explanation? See FAQ:"
         str << "\nhttps://docs.knapsackpro.com/ruby/knapsack#faq"
         str << "\n=================================================\n"
-        str << %{See how to split tests in a dynamic way using Queue Mode to ensure all parallel nodes
-finish work at a similar time even when your CI or random test execution is a bottleneck:
-https://youtu.be/hUEB1XDKEFY
+        str << %{Read up on the benefits of a dynamic test split with Knapsack Pro Queue Mode:
+https://docs.knapsackpro.com/2020/how-to-speed-up-ruby-and-javascript-tests-with-ci-parallelisation
 
 Sign up for Knapsack Pro here:
 https://knapsackpro.com}

data/lib/knapsack/tracker.rb

@@ -23,15 +23,19 @@ module Knapsack
     end
 
     def stop_timer
-      @execution_time = now_without_mock_time.to_f - @start_time
-      update_global_time
-      update_test_file_time
-      @execution_time
+      execution_time = now_without_mock_time.to_f - @start_time
+
+      if test_path
+        update_global_time(execution_time)
+        update_test_file_time(execution_time)
+        @test_path = nil
+      end
+
+      execution_time
     end
 
     def test_path
-      raise("test_path needs to be set by Knapsack Adapter's bind method") unless @test_path
-      @test_path.sub(/^\.\//, '')
+      @test_path.sub(/^\.\//, '') if @test_path
     end
 
     def time_exceeded?
@@ -62,13 +66,13 @@ module Knapsack
       @test_path = nil
     end
 
-    def update_global_time
-      @global_time += @execution_time
+    def update_global_time(execution_time)
+      @global_time += execution_time
     end
 
-    def update_test_file_time
+    def update_test_file_time(execution_time)
       @test_files_with_time[test_path] ||= 0
-      @test_files_with_time[test_path] += @execution_time
+      @test_files_with_time[test_path] += execution_time
     end
 
     def report_distributor
@@ -81,11 +85,7 @@ module Knapsack
     end
 
     def now_without_mock_time
-      if defined?(Timecop)
-        Time.now_without_mock_time
-      else
-        Time.raw_now
-      end
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
     end
   end
 end

data/lib/knapsack/version.rb

@@ -1,3 +1,3 @@
 module Knapsack
-  VERSION = '1.18.0'
+  VERSION = '3.1.0'
 end

data/spec/knapsack/adapters/rspec_adapter_spec.rb

@@ -24,8 +24,9 @@ describe Knapsack::Adapters::RSpecAdapter do
       end
 
       it do
+        expect(config).to receive(:prepend_before).with(:context).and_yield
         expect(config).to receive(:prepend_before).with(:each).and_yield
-        expect(config).to receive(:append_after).with(:each).and_yield
+        expect(config).to receive(:append_after).with(:context).and_yield
         expect(config).to receive(:after).with(:suite).and_yield
         expect(::RSpec).to receive(:configure).and_yield(config)
 
@@ -33,10 +34,9 @@ describe Knapsack::Adapters::RSpecAdapter do
         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(:test_path=).with(test_path)
-        expect(tracker).to receive(:start_timer)
-
-        expect(tracker).to receive(:stop_timer)
+        expect(tracker).to receive(:start_timer).ordered
+        expect(tracker).to receive(:test_path=).with(test_path).ordered
+        expect(tracker).to receive(:stop_timer).ordered
 
         expect(Knapsack::Presenter).to receive(:global_time).and_return(global_time)
         expect(logger).to receive(:info).with(global_time)

data/spec/knapsack/config/env_spec.rb

@@ -46,6 +46,11 @@ describe Knapsack::Config::Env do
         before { stub_const("ENV", { 'SNAP_WORKER_TOTAL' => 6 }) }
         it { should eql 6 }
       end
+
+      context 'when BITBUCKET_PARALLEL_STEP_COUNT has value' do
+        before { stub_const("ENV", { 'BITBUCKET_PARALLEL_STEP_COUNT' => 8 }) }
+        it { should eql 8 }
+      end
     end
 
     context "when ENV doesn't exist" do
@@ -91,6 +96,11 @@ describe Knapsack::Config::Env do
         before { stub_const("ENV", { 'SNAP_WORKER_INDEX' => 4 }) }
         it { should eql 3 }
       end
+
+      context 'when BITBUCKET_PARALLEL_STEP has value' do
+        before { stub_const("ENV", { 'BITBUCKET_PARALLEL_STEP' => 7 }) }
+        it { should eql 7 }
+      end
     end
 
     context "when ENV doesn't exist" do

data/spec/knapsack/distributors/report_distributor_spec.rb

@@ -118,7 +118,7 @@ describe Knapsack::Distributors::ReportDistributor do
         'c_spec.rb' => 2.0,
         'd_spec.rb' => 2.5,
         'a_spec.rb' => 1.0,
-        'b_spec.rb' => 1.5,
+        'b_spec.rb' => 1.5
       }
     end
     let(:custom_args) { { ci_node_total: 3 } }
@@ -134,6 +134,7 @@ describe Knapsack::Distributors::ReportDistributor do
         expect(distributor.node_tests[0]).to eql({
           :node_index => 0,
           :time_left => -0.5,
+          :weight => 9.0,
           :test_files_with_time => [
             ["g_spec.rb", 9.0]
           ]
@@ -143,12 +144,12 @@ describe Knapsack::Distributors::ReportDistributor do
       it do
         expect(distributor.node_tests[1]).to eql({
           :node_index => 1,
-          :time_left => 0.0,
+          :time_left => 0.5,
+          :weight => 8.0,
           :test_files_with_time => [
             ["f_spec.rb", 3.5],
             ["d_spec.rb", 2.5],
-            ["b_spec.rb", 1.5],
-            ["a_spec.rb", 1.0]
+            ["c_spec.rb", 2.0]
           ]
         })
       end
@@ -156,11 +157,13 @@ describe Knapsack::Distributors::ReportDistributor do
       it do
         expect(distributor.node_tests[2]).to eql({
           :node_index => 2,
-          :time_left => 0.5,
+          :time_left => 0.0,
+          :weight => 8.5,
           :test_files_with_time => [
-            ["i_spec.rb", 3.0],
             ["h_spec.rb", 3.0],
-            ["c_spec.rb", 2.0]
+            ["i_spec.rb", 3.0],
+            ["b_spec.rb", 1.5],
+            ["a_spec.rb", 1.0]
           ]
         })
       end
@@ -170,10 +173,9 @@ describe Knapsack::Distributors::ReportDistributor do
       context 'when node exists' do
         it do
           expect(distributor.tests_for_node(1)).to eql([
-            'f_spec.rb',
-            'd_spec.rb',
-            'b_spec.rb',
-            'a_spec.rb'
+            "f_spec.rb",
+            "d_spec.rb",
+            "c_spec.rb"
           ])
         end
       end
@@ -183,4 +185,78 @@ describe Knapsack::Distributors::ReportDistributor do
       end
     end
   end
+
+  describe 'algorithmic efficiency' do
+    subject(:node_weights) do
+      distro = distributor
+      distro.assign_test_files_to_node
+      distro.node_tests.map { |node| node[:weight] }
+    end
+
+    before do
+      allow(distributor).to receive(:all_tests).and_return(report.keys)
+    end
+
+    let(:custom_args) { { ci_node_total: 3 } }
+
+    context 'with the most simple example' do
+      let(:report) do
+        {
+          'a_spec.rb' => 1.0,
+          'b_spec.rb' => 1.0,
+          'c_spec.rb' => 1.0,
+          'd_spec.rb' => 1.0,
+          'e_spec.rb' => 1.0,
+          'f_spec.rb' => 1.0,
+          'g_spec.rb' => 1.0,
+          'h_spec.rb' => 1.0,
+          'i_spec.rb' => 1.0
+        }
+      end
+
+      it 'assigns all nodes equally' do
+        expect(node_weights.uniq).to contain_exactly 3.0
+      end
+    end
+
+    context 'with a medium difficulty example' do
+      let(:report) do
+        {
+          'a_spec.rb' => 1.0,
+          'b_spec.rb' => 2.0,
+          'c_spec.rb' => 3.0,
+          'd_spec.rb' => 1.0,
+          'e_spec.rb' => 2.0,
+          'f_spec.rb' => 3.0,
+          'g_spec.rb' => 1.0,
+          'h_spec.rb' => 2.0,
+          'i_spec.rb' => 3.0
+        }
+      end
+
+      it 'assigns all nodes equally' do
+        expect(node_weights.uniq).to contain_exactly 6.0
+      end
+    end
+
+    context 'with a difficult example' do
+      let(:report) do
+        {
+          'a_spec.rb' => 2.0,
+          'b_spec.rb' => 2.0,
+          'c_spec.rb' => 3.0,
+          'd_spec.rb' => 1.0,
+          'e_spec.rb' => 1.0,
+          'f_spec.rb' => 1.0,
+          'g_spec.rb' => 9.0,
+          'h_spec.rb' => 1.0,
+          'i_spec.rb' => 10.0
+        }
+      end
+
+      it 'assigns all nodes equally' do
+        expect(node_weights.uniq).to contain_exactly 10.0
+      end
+    end
+  end
 end