knapsack 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf3e5a9aba000c4d624a76850d39373731918bbdcba5c1627a98131983823ff9
-  data.tar.gz: 524c4e365f94683bd571fbd33538aa737df1a4c44a73d66ee64d512097221c84
+  metadata.gz: d27f3b6225aefe7c7a2ff1a4071961e65c5e087a5256d7294bca73398ce2c997
+  data.tar.gz: 38f324e2d35800297e8c071caef06100688d1e1617bb8f3339076b9c9c1de828
 SHA512:
-  metadata.gz: 0a365bc8c5bc58458191e864263184307d2a8c5fb3ecfba965c22e8f78d9a322af4a14b8721456ace7729e4a50c4df2f4788acb84141910202ebf9d6794b7bf9
-  data.tar.gz: 82228079c42fb2c423f6085b402c7e014d99f96388b42d0d831e1e03d631bbe56980f9902eb498306a21cb67ae183dceeba43f82e94bc66c4397870ac68aa1bd
+  metadata.gz: 0d635a77401b2d65914edab41f2ac726901d38b937869fb408cc2548d6547114a0d968c06a8c9adfe4f5a2c3d3d7c11bea5bb0c8161d706e17870ea3682b5be0
+  data.tar.gz: b5aa3601e1d7cbdffdfa33a4de64d562782c74371f9e3c58b0754b262a86554c8320e7fb0aff1c84cd6e05755b66c29b61b87f83ffb3a44d4f06eb9c38c8dfd6

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 * TODO
 
+### 3.1.0
+
+* Sorting Algorithm: round robin to least connections
+
+    https://github.com/KnapsackPro/knapsack/pull/99
+
+https://github.com/KnapsackPro/knapsack/compare/v3.0.0...v3.1.0
+
 ### 3.0.0
 
 * __(breaking change)__ Require minimum Ruby 2.2 version

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/version.rb

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-22 00:00:00.000000000 Z
+date: 2021-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake