knapsack 0.0.3 → 0.1.0

data/spec/knapsack/adapters/rspec_adapter_spec.rb

@@ -0,0 +1,29 @@
+describe Knapsack::Adapters::RspecAdapter do
+  before do
+    expect(::RSpec).to receive(:configure)
+  end
+
+  describe '#bind_time_tracker' do
+    it do
+      expect {
+        subject.bind_time_tracker
+      }.not_to raise_error
+    end
+  end
+
+  describe '#bind_report_generator' do
+    it do
+      expect {
+        subject.bind_report_generator
+      }.not_to raise_error
+    end
+  end
+
+  describe '#bind_time_offset_warning' do
+    it do
+      expect {
+        subject.bind_time_offset_warning
+      }.not_to raise_error
+    end
+  end
+end

data/spec/knapsack/allocator_spec.rb

@@ -0,0 +1,57 @@
+describe Knapsack::Allocator do
+  let(:spec_pattern) { nil }
+  let(:args) do
+    {
+      ci_node_total: nil,
+      ci_node_index: nil,
+      spec_pattern: spec_pattern,
+      report: nil
+    }
+  end
+  let(:report_distributor) { instance_double(Knapsack::Distributors::ReportDistributor) }
+  let(:leftover_distributor) { instance_double(Knapsack::Distributors::LeftoverDistributor) }
+  let(:report_specs) { ['a_spec.rb', 'b_spec.rb'] }
+  let(:leftover_specs) { ['c_spec.rb', 'd_spec.rb'] }
+  let(:node_specs) { report_specs + leftover_specs }
+  let(:allocator) { described_class.new(args) }
+
+  before do
+    expect(Knapsack::Distributors::ReportDistributor).to receive(:new).with(args).and_return(report_distributor)
+    expect(Knapsack::Distributors::LeftoverDistributor).to receive(:new).with(args).and_return(leftover_distributor)
+    allow(report_distributor).to receive(:specs_for_current_node).and_return(report_specs)
+    allow(leftover_distributor).to receive(:specs_for_current_node).and_return(leftover_specs)
+  end
+
+  describe '#report_node_specs' do
+    subject { allocator.report_node_specs }
+    it { should eql report_specs }
+  end
+
+  describe '#leftover_node_specs' do
+    subject { allocator.leftover_node_specs }
+    it { should eql leftover_specs }
+  end
+
+  describe '#node_specs' do
+    subject { allocator.node_specs }
+    it { should eql node_specs }
+  end
+
+  describe '#stringify_node_specs' do
+    subject { allocator.stringify_node_specs }
+    it { should eql node_specs.join(' ') }
+  end
+
+  describe '#custom_spec_dir' do
+    subject { allocator.custom_spec_dir }
+
+    context 'when spec pattern exists' do
+      let(:spec_pattern) { "custom_spec_dir/**/*_spec.rb" }
+      it { should eql 'custom_spec_dir/' }
+    end
+
+    context "when spec pattern doesn't exist" do
+      it { should be_nil }
+    end
+  end
+end

data/spec/knapsack/distributors/base_distributor_spec.rb

@@ -0,0 +1,85 @@
+describe Knapsack::Distributors::BaseDistributor do
+  let(:args) { {} }
+  let(:default_report) { { 'default_report_spec.rb' => 1.0 } }
+
+  let(:distributor) { described_class.new(args) }
+
+  before do
+    allow(Knapsack).to receive(:report) {
+      instance_double(Knapsack::Report, open: default_report)
+    }
+  end
+
+  describe '#report' do
+    subject { distributor.report }
+
+    context 'when report is given' do
+      let(:report) { { 'a_spec.rb' => 2.0 } }
+      let(:args) { { report: report } }
+
+      it { should eql(report) }
+    end
+
+    context 'when report is not given' do
+      it { should eql(default_report) }
+    end
+  end
+
+  describe '#ci_node_total' do
+    subject { distributor.ci_node_total }
+
+    context 'when ci_node_total is given' do
+      let(:args) { { ci_node_total: 4 } }
+
+      it { should eql 4 }
+    end
+
+    context 'when ci_node_total is not given' do
+      it { should eql 1 }
+    end
+  end
+
+  describe '#ci_node_index' do
+    subject { distributor.ci_node_index }
+
+    context 'when ci_node_index is given' do
+      let(:args) { { ci_node_index: 3 } }
+
+      it { should eql 3 }
+    end
+
+    context 'when ci_node_index is not given' do
+      it { should eql 0 }
+    end
+  end
+
+  describe '#specs_for_current_node' do
+    let(:args) do
+      {
+        ci_node_total: 3,
+        ci_node_index: ci_node_index
+      }
+    end
+    let(:specs) { double }
+
+    subject { distributor.specs_for_current_node }
+
+    context 'when ci_node_index not set' do
+      let(:ci_node_index) { nil }
+
+      it do
+        expect(distributor).to receive(:specs_for_node).with(0).and_return(specs)
+        expect(subject).to eql specs
+      end
+    end
+
+    context 'when ci_node_index set' do
+      let(:ci_node_index) { 2 }
+
+      it do
+        expect(distributor).to receive(:specs_for_node).with(ci_node_index).and_return(specs)
+        expect(subject).to eql specs
+      end
+    end
+  end
+end

data/spec/knapsack/distributors/leftover_distributor_spec.rb

@@ -0,0 +1,110 @@
+describe Knapsack::Distributors::LeftoverDistributor do
+  let(:args) { {} }
+  let(:default_report) do
+    {
+      'a_spec.rb' => 1.0,
+      'b_spec.rb' => 1.5,
+      'c_spec.rb' => 2.0,
+      'd_spec.rb' => 2.5,
+    }
+  end
+
+  let(:distributor) { described_class.new(args) }
+
+  before do
+    allow(Knapsack).to receive(:report) {
+      instance_double(Knapsack::Report, open: default_report)
+    }
+  end
+
+  describe '#report_specs' do
+    subject { distributor.report_specs }
+    it { should eql ['a_spec.rb', 'b_spec.rb', 'c_spec.rb', 'd_spec.rb'] }
+  end
+
+  describe '#all_specs' do
+    subject { distributor.all_specs }
+
+    context 'when default spec pattern' do
+      it { should_not be_empty }
+      it { should include 'spec/knapsack/tracker_spec.rb' }
+      it { should include 'spec/knapsack/adapters/rspec_adapter_spec.rb' }
+    end
+
+    context 'when fake spec pattern' do
+      let(:args) { { spec_pattern: 'fake_pattern' } }
+      it { should be_empty }
+    end
+  end
+
+  describe '#leftover_specs' do
+    subject { distributor.leftover_specs }
+
+    before do
+      expect(distributor).to receive(:all_specs).and_return([
+        'a_spec.rb',
+        'b_spec.rb',
+        'c_spec.rb',
+        'd_spec.rb',
+        'e_spec.rb',
+        'f_spec.rb',
+      ])
+    end
+
+    it { should eql ['e_spec.rb', 'f_spec.rb'] }
+  end
+
+  context do
+    let(:args) { { ci_node_total: 3 } }
+    let(:leftover_specs) {[
+      'a_spec.rb',
+      'b_spec.rb',
+      'c_spec.rb',
+      'd_spec.rb',
+      'e_spec.rb',
+      'f_spec.rb',
+      'g_spec.rb',
+    ]}
+
+    before do
+      expect(distributor).to receive(:leftover_specs).and_return(leftover_specs)
+    end
+
+    describe '#assign_spec_files_to_node' do
+      before do
+        distributor.assign_spec_files_to_node
+      end
+
+      it do
+        expect(distributor.node_specs[0]).to eql([
+          'a_spec.rb',
+          'd_spec.rb',
+          'g_spec.rb',
+        ])
+      end
+
+      it do
+        expect(distributor.node_specs[1]).to eql([
+          'b_spec.rb',
+          'e_spec.rb',
+        ])
+      end
+
+      it do
+        expect(distributor.node_specs[2]).to eql([
+          'c_spec.rb',
+          'f_spec.rb',
+        ])
+      end
+    end
+
+    describe '#specs_for_node' do
+      it do
+        expect(distributor.specs_for_node(1)).to eql([
+          'b_spec.rb',
+          'e_spec.rb',
+        ])
+      end
+    end
+  end
+end

data/spec/knapsack/distributors/report_distributor_spec.rb

@@ -0,0 +1,152 @@
+describe Knapsack::Distributors::ReportDistributor do
+  let(:args) { {} }
+  let(:default_report) { { 'default_report_spec.rb' => 1.0 } }
+
+  let(:distributor) { described_class.new(args) }
+
+  before do
+    allow(Knapsack).to receive(:report) {
+      instance_double(Knapsack::Report, open: default_report)
+    }
+  end
+
+  describe '#sorted_report' do
+    subject { distributor.sorted_report }
+
+    let(:report) do
+      {
+        'e_spec.rb' => 3.0,
+        'f_spec.rb' => 3.5,
+        'c_spec.rb' => 2.0,
+        'd_spec.rb' => 2.5,
+        'a_spec.rb' => 1.0,
+        'b_spec.rb' => 1.5,
+      }
+    end
+    let(:args) { { report: report } }
+
+    it do
+      should eql([
+        ["f_spec.rb", 3.5],
+        ["e_spec.rb", 3.0],
+        ["d_spec.rb", 2.5],
+        ["c_spec.rb", 2.0],
+        ["b_spec.rb", 1.5],
+        ["a_spec.rb", 1.0],
+      ])
+    end
+  end
+
+  context do
+    let(:report) do
+      {
+        'a_spec.rb' => 3.0,
+        'b_spec.rb' => 1.0,
+        'c_spec.rb' => 1.5,
+      }
+    end
+    let(:args) { { report: report } }
+
+    describe '#total_time_execution' do
+      subject { distributor.total_time_execution }
+
+      context 'when time is float' do
+        it { should eql 5.5 }
+      end
+
+      context 'when time is not float' do
+        let(:report) do
+          {
+            'a_spec.rb' => 3,
+            'b_spec.rb' => 1,
+          }
+        end
+
+        it { should eql 4.0 }
+      end
+    end
+
+    describe '#node_time_execution' do
+      subject { distributor.node_time_execution }
+      let(:args) { { report: report, ci_node_total: 4 } }
+      it { should eql 1.375 }
+    end
+  end
+
+  context do
+    let(:report) do
+      {
+        'g_spec.rb' => 9.0,
+        'h_spec.rb' => 3.0,
+        'i_spec.rb' => 3.0,
+        'f_spec.rb' => 3.5,
+        'c_spec.rb' => 2.0,
+        'd_spec.rb' => 2.5,
+        'a_spec.rb' => 1.0,
+        'b_spec.rb' => 1.5,
+      }
+    end
+    let(:args) do
+      {
+        report: report,
+        ci_node_total: 3,
+      }
+    end
+
+    describe '#assign_spec_files_to_node' do
+      before { distributor.assign_spec_files_to_node }
+
+      it do
+        expect(distributor.node_specs[0]).to eql({
+          :node_index => 0,
+          :time_left => -0.5,
+          :spec_files_with_time => [
+            ["g_spec.rb", 9.0]
+          ]
+        })
+      end
+
+      it do
+        expect(distributor.node_specs[1]).to eql({
+          :node_index => 1,
+          :time_left => 0.0,
+          :spec_files_with_time => [
+            ["f_spec.rb", 3.5],
+            ["d_spec.rb", 2.5],
+            ["a_spec.rb", 1.0],
+            ["b_spec.rb", 1.5]
+          ]
+        })
+      end
+
+      it do
+        expect(distributor.node_specs[2]).to eql({
+          :node_index => 2,
+          :time_left => 0.5,
+          :spec_files_with_time => [
+            ["h_spec.rb", 3.0],
+            ["c_spec.rb", 2.0],
+            ["i_spec.rb", 3.0]
+          ]
+        })
+      end
+    end
+
+    describe '#specs_for_node' do
+      context 'when node exists' do
+        it do
+          expect(distributor.specs_for_node(1)).to eql([
+            'f_spec.rb',
+            'd_spec.rb',
+            'a_spec.rb',
+            'b_spec.rb'
+          ])
+        end
+      end
+
+      context "when node doesn't exist" do
+        it { expect(distributor.specs_for_node(42)).to be_nil }
+      end
+    end
+  end
+end

data/spec/knapsack/presenter_spec.rb

@@ -0,0 +1,83 @@
+describe Knapsack::Presenter do
+  let(:tracker) { instance_double(Knapsack::Tracker) }
+  let(:spec_files_with_time) do
+    {
+      'a_spec.rb' => 1.0,
+      'b_spec.rb' => 0.4
+    }
+  end
+
+  describe 'report methods' do
+    before do
+      expect(Knapsack).to receive(:tracker) { tracker }
+      expect(tracker).to receive(:spec_files_with_time).and_return(spec_files_with_time)
+    end
+
+    describe '.report_yml' do
+      subject { described_class.report_yml }
+      it { should eql spec_files_with_time.to_yaml }
+    end
+
+    describe '.report_json' do
+      subject { described_class.report_json }
+      it { should eql JSON.pretty_generate(spec_files_with_time) }
+    end
+  end
+
+  describe '.global_time' do
+    subject { described_class.global_time }
+
+    before do
+      expect(Knapsack).to receive(:tracker) { tracker }
+      expect(tracker).to receive(:global_time).and_return(4.2)
+    end
+
+    it { should eql "\nKnapsack global time execution for specs: 4.2s" }
+  end
+
+  describe '.report_details' do
+    subject { described_class.report_details }
+
+    before do
+      expect(described_class).to receive(:report_json).and_return('{}')
+    end
+
+    it { should eql "Knapsack report was generated. Preview:\n{}" }
+  end
+
+  describe '.time_offset_warning' do
+    let(:time_offset_in_seconds) { 30 }
+    let(:max_node_time_execution) { 60 }
+    let(:exceeded_time) { 3 }
+
+    subject { described_class.time_offset_warning }
+
+    before do
+      allow(Knapsack).to receive(:tracker) { tracker }
+      expect(tracker).to receive(:config).and_return({time_offset_in_seconds: time_offset_in_seconds})
+      expect(tracker).to receive(:max_node_time_execution).and_return(max_node_time_execution)
+      expect(tracker).to receive(:exceeded_time).and_return(exceeded_time)
+      expect(tracker).to receive(:time_exceeded?).and_return(time_exceeded?)
+    end
+
+    shared_examples 'knapsack time offset warning' do
+      it { should include 'Time offset: 30s' }
+      it { should include 'Max allowed node time execution: 60s' }
+      it { should include 'Exceeded time: 3s' }
+    end
+
+    context 'when time exceeded' do
+      let(:time_exceeded?) { true }
+
+      it_behaves_like 'knapsack time offset warning'
+      it { should include 'Please regenerate your knapsack report.' }
+    end
+
+    context "when time did not exceed" do
+      let(:time_exceeded?) { false }
+
+      it_behaves_like 'knapsack time offset warning'
+      it { should include 'Global time execution for this CI node is fine.' }
+    end
+  end
+end