knapsack 0.5.0 → 1.0.0

data/spec/knapsack/allocator_spec.rb

@@ -1,57 +1,56 @@
 describe Knapsack::Allocator do
-  let(:spec_pattern) { nil }
+  let(:test_file_pattern) { nil }
   let(:args) do
     {
       ci_node_total: nil,
       ci_node_index: nil,
-      spec_pattern: spec_pattern,
+      test_file_pattern: test_file_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(:report_tests) { ['a_spec.rb', 'b_spec.rb'] }
+  let(:leftover_tests) { ['c_spec.rb', 'd_spec.rb'] }
+  let(:node_tests) { report_tests + leftover_tests }
   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)
+    allow(report_distributor).to receive(:tests_for_current_node).and_return(report_tests)
+    allow(leftover_distributor).to receive(:tests_for_current_node).and_return(leftover_tests)
   end
 
-  describe '#report_node_specs' do
-    subject { allocator.report_node_specs }
-    it { should eql report_specs }
+  describe '#report_node_tests' do
+    subject { allocator.report_node_tests }
+    it { should eql report_tests }
   end
 
-  describe '#leftover_node_specs' do
-    subject { allocator.leftover_node_specs }
-    it { should eql leftover_specs }
+  describe '#leftover_node_tests' do
+    subject { allocator.leftover_node_tests }
+    it { should eql leftover_tests }
   end
 
-  describe '#node_specs' do
-    subject { allocator.node_specs }
-    it { should eql node_specs }
+  describe '#node_tests' do
+    subject { allocator.node_tests }
+    it { should eql node_tests }
   end
 
-  describe '#stringify_node_specs' do
-    subject { allocator.stringify_node_specs }
-    it { should eql node_specs.join(' ') }
+  describe '#stringify_node_tests' do
+    subject { allocator.stringify_node_tests }
+    it { should eql node_tests.join(' ') }
   end
 
-  describe '#spec_dir' do
-    subject { allocator.spec_dir }
+  describe '#test_dir' do
+    let(:test_file_pattern) { "test_dir/**/*_spec.rb" }
 
-    context 'when spec pattern exists' do
-      let(:spec_pattern) { "spec_dir/**/*_spec.rb" }
-      it { should eql 'spec_dir/' }
-    end
+    subject { allocator.test_dir }
 
-    context "when spec pattern doesn't exist" do
-      it { should eql 'spec/' }
+    before do
+      expect(report_distributor).to receive(:test_file_pattern).and_return(test_file_pattern)
     end
+
+    it { should eql 'test_dir/' }
   end
 end

data/spec/knapsack/{config_spec.rb → config/env_spec.rb}

@@ -1,15 +1,15 @@
-describe Knapsack::Config do
+describe Knapsack::Config::Env do
   describe '.report_path' do
     subject { described_class.report_path }
 
     context 'when ENV exists' do
-      let(:report_path) { 'custom_knapsack_report.json' }
+      let(:report_path) { 'knapsack_custom_report.json' }
       before { stub_const("ENV", { 'KNAPSACK_REPORT_PATH' => report_path }) }
       it { should eql report_path }
     end
 
     context "when ENV doesn't exist" do
-      it { should eql 'knapsack_report.json' }
+      it { should be_nil }
     end
   end
 
@@ -63,40 +63,17 @@ describe Knapsack::Config do
     end
   end
 
-  describe '.spec_pattern' do
-    subject { described_class.spec_pattern }
+  describe '.test_file_pattern' do
+    subject { described_class.test_file_pattern }
 
     context 'when ENV exists' do
-      let(:spec_pattern) { 'custom_spec/**/*_spec.rb' }
-      before { stub_const("ENV", { 'KNAPSACK_SPEC_PATTERN' => spec_pattern }) }
-      it { should eql spec_pattern }
+      let(:test_file_pattern) { 'custom_spec/**/*_spec.rb' }
+      before { stub_const("ENV", { 'KNAPSACK_TEST_FILE_PATTERN' => test_file_pattern }) }
+      it { should eql test_file_pattern }
     end
 
     context "when ENV doesn't exist" do
-      it { should eql 'spec/**/*_spec.rb' }
-    end
-  end
-
-  describe '.enable_time_offset_warning' do
-    subject { described_class.enable_time_offset_warning }
-    it { should be true }
-  end
-
-  describe '.time_offset_in_seconds' do
-    subject { described_class.time_offset_in_seconds }
-    it { should eql 30 }
-  end
-
-  describe '.generate_report' do
-    subject { described_class.generate_report }
-
-    context 'when ENV exists' do
-      before { stub_const("ENV", { 'KNAPSACK_GENERATE_REPORT' => true }) }
-      it { should be true }
-    end
-
-    context "when ENV doesn't exist" do
-      it { should be false }
+      it { should be_nil }
     end
   end
 end

data/spec/knapsack/config/tracker_spec.rb

@@ -0,0 +1,24 @@
+describe Knapsack::Config::Tracker do
+  describe '.enable_time_offset_warning' do
+    subject { described_class.enable_time_offset_warning }
+    it { should be true }
+  end
+
+  describe '.time_offset_in_seconds' do
+    subject { described_class.time_offset_in_seconds }
+    it { should eql 30 }
+  end
+
+  describe '.generate_report' do
+    subject { described_class.generate_report }
+
+    context 'when ENV exists' do
+      before { stub_const("ENV", { 'KNAPSACK_GENERATE_REPORT' => true }) }
+      it { should be true }
+    end
+
+    context "when ENV doesn't exist" do
+      it { should be false }
+    end
+  end
+end

data/spec/knapsack/distributors/base_distributor_spec.rb

@@ -1,27 +1,27 @@
 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)
+  let(:report) { { 'a_spec.rb' => 1.0 } }
+  let(:default_args) do
+    {
+      report: report,
+      test_file_pattern: 'spec/**/*_spec.rb',
+      ci_node_total: '1',
+      ci_node_index: '0'
     }
   end
+  let(:args) { default_args.merge(custom_args) }
+  let(:custom_args) { {} }
+  let(:distributor) { described_class.new(args) }
 
   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) }
+      let(:custom_args) { { report: nil } }
+      it { expect { subject }.to raise_error('Missing report') }
     end
   end
 
@@ -29,13 +29,12 @@ describe Knapsack::Distributors::BaseDistributor do
     subject { distributor.ci_node_total }
 
     context 'when ci_node_total is given' do
-      let(:args) { { ci_node_total: 4 } }
-
-      it { should eql 4 }
+      it { should eql 1 }
     end
 
     context 'when ci_node_total is not given' do
-      it { should eql 1 }
+      let(:custom_args) { { ci_node_total: nil } }
+      it { expect { subject }.to raise_error('Missing ci_node_total') }
     end
   end
 
@@ -43,43 +42,31 @@ describe Knapsack::Distributors::BaseDistributor do
     subject { distributor.ci_node_index }
 
     context 'when ci_node_index is given' do
-      let(:args) { { ci_node_index: 3 } }
-
-      it { should eql 3 }
+      it { should eql 0 }
     end
 
     context 'when ci_node_index is not given' do
-      it { should eql 0 }
+      let(:custom_args) { { ci_node_index: nil } }
+      it { expect { subject }.to raise_error('Missing ci_node_index') }
     end
   end
 
-  describe '#specs_for_current_node' do
-    let(:args) do
+  describe '#tests_for_current_node' do
+    let(:custom_args) do
       {
         ci_node_total: 3,
         ci_node_index: ci_node_index
       }
     end
-    let(:specs) { double }
+    let(:ci_node_index) { 2 }
+    let(:tests) { double }
 
-    subject { distributor.specs_for_current_node }
+    subject { distributor.tests_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
+    before do
+      expect(distributor).to receive(:tests_for_node).with(ci_node_index).and_return(tests)
     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
+    it { should eql tests }
   end
 end

data/spec/knapsack/distributors/leftover_distributor_spec.rb

@@ -1,6 +1,5 @@
 describe Knapsack::Distributors::LeftoverDistributor do
-  let(:args) { {} }
-  let(:default_report) do
+  let(:report) do
     {
       'a_spec.rb' => 1.0,
       'b_spec.rb' => 1.5,
@@ -8,40 +7,59 @@ describe Knapsack::Distributors::LeftoverDistributor do
       '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)
+  let(:test_file_pattern) { 'spec/**/*_spec.rb' }
+  let(:default_args) do
+    {
+      report: report,
+      test_file_pattern: test_file_pattern,
+      ci_node_total: '1',
+      ci_node_index: '0'
     }
   end
+  let(:args) { default_args.merge(custom_args) }
+  let(:custom_args) { {} }
+  let(:distributor) { described_class.new(args) }
 
-  describe '#report_specs' do
-    subject { distributor.report_specs }
+  describe '#report_tests' do
+    subject { distributor.report_tests }
     it { should eql ['a_spec.rb', 'b_spec.rb', 'c_spec.rb', 'd_spec.rb'] }
   end
 
-  describe '#all_specs' do
-    subject { distributor.all_specs }
+  describe '#all_tests' do
+    subject { distributor.all_tests }
 
-    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' }
+    context 'when given test_file_pattern' do
+      context 'spec/**/*_spec.rb' 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 'spec_examples/**/*_spec.rb' do
+        let(:test_file_pattern) { 'spec_examples/**/*_spec.rb' }
+
+        it { should_not be_empty }
+        it { should include 'spec_examples/fast/1_spec.rb' }
+        it { should include 'spec_examples/leftover/a_spec.rb' }
+      end
     end
 
-    context 'when fake spec pattern' do
-      let(:args) { { spec_pattern: 'fake_pattern' } }
+    context 'when fake test_file_pattern' do
+      let(:test_file_pattern) { 'fake_pattern' }
       it { should be_empty }
     end
+
+    context 'when missing test_file_pattern' do
+      let(:test_file_pattern) { nil }
+      it { expect { subject }.to raise_error('Missing test_file_pattern') }
+    end
   end
 
-  describe '#leftover_specs' do
-    subject { distributor.leftover_specs }
+  describe '#leftover_tests' do
+    subject { distributor.leftover_tests }
 
     before do
-      expect(distributor).to receive(:all_specs).and_return([
+      expect(distributor).to receive(:all_tests).and_return([
         'a_spec.rb',
         'b_spec.rb',
         'c_spec.rb',
@@ -55,8 +73,8 @@ describe Knapsack::Distributors::LeftoverDistributor do
   end
 
   context do
-    let(:args) { { ci_node_total: 3 } }
-    let(:leftover_specs) {[
+    let(:custom_args) { { ci_node_total: 3 } }
+    let(:leftover_tests) {[
       'a_spec.rb',
       'b_spec.rb',
       'c_spec.rb',
@@ -67,16 +85,16 @@ describe Knapsack::Distributors::LeftoverDistributor do
     ]}
 
     before do
-      expect(distributor).to receive(:leftover_specs).and_return(leftover_specs)
+      expect(distributor).to receive(:leftover_tests).and_return(leftover_tests)
     end
 
-    describe '#assign_spec_files_to_node' do
+    describe '#assign_test_files_to_node' do
       before do
-        distributor.assign_spec_files_to_node
+        distributor.assign_test_files_to_node
       end
 
       it do
-        expect(distributor.node_specs[0]).to eql([
+        expect(distributor.node_tests[0]).to eql([
           'a_spec.rb',
           'd_spec.rb',
           'g_spec.rb',
@@ -84,23 +102,23 @@ describe Knapsack::Distributors::LeftoverDistributor do
       end
 
       it do
-        expect(distributor.node_specs[1]).to eql([
+        expect(distributor.node_tests[1]).to eql([
           'b_spec.rb',
           'e_spec.rb',
         ])
       end
 
       it do
-        expect(distributor.node_specs[2]).to eql([
+        expect(distributor.node_tests[2]).to eql([
           'c_spec.rb',
           'f_spec.rb',
         ])
       end
     end
 
-    describe '#specs_for_node' do
+    describe '#tests_for_node' do
       it do
-        expect(distributor.specs_for_node(1)).to eql([
+        expect(distributor.tests_for_node(1)).to eql([
           'b_spec.rb',
           'e_spec.rb',
         ])

data/spec/knapsack/distributors/report_distributor_spec.rb

@@ -1,14 +1,16 @@
 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)
+  let(:report) { { 'a_spec.rb' => 1.0 } }
+  let(:default_args) do
+    {
+      report: report,
+      test_file_pattern: 'spec/**/*_spec.rb',
+      ci_node_total: '1',
+      ci_node_index: '0'
     }
   end
+  let(:args) { default_args.merge(custom_args) }
+  let(:custom_args) { {} }
+  let(:distributor) { described_class.new(args) }
 
   describe '#sorted_report' do
     subject { distributor.sorted_report }
@@ -23,7 +25,6 @@ describe Knapsack::Distributors::ReportDistributor do
         'b_spec.rb' => 1.5,
       }
     end
-    let(:args) { { report: report } }
 
     it do
       should eql([
@@ -37,16 +38,8 @@ describe Knapsack::Distributors::ReportDistributor do
     end
   end
 
-  describe '#sorted_report_with_existing_specs' do
-    subject { distributor.sorted_report_with_existing_specs }
-
-    before do
-      expect(distributor).to receive(:all_specs).exactly(6).times.and_return([
-        'b_spec.rb',
-        'd_spec.rb',
-        'f_spec.rb',
-      ])
-    end
+  describe '#sorted_report_with_existing_tests' do
+    subject { distributor.sorted_report_with_existing_tests }
 
     let(:report) do
       {
@@ -58,7 +51,14 @@ describe Knapsack::Distributors::ReportDistributor do
         'b_spec.rb' => 1.5,
       }
     end
-    let(:args) { { report: report } }
+
+    before do
+      expect(distributor).to receive(:all_tests).exactly(6).times.and_return([
+        'b_spec.rb',
+        'd_spec.rb',
+        'f_spec.rb',
+      ])
+    end
 
     it do
       should eql([
@@ -77,10 +77,9 @@ describe Knapsack::Distributors::ReportDistributor do
         'c_spec.rb' => 1.5,
       }
     end
-    let(:args) { { report: report } }
 
     before do
-      allow(distributor).to receive(:all_specs).and_return(report.keys)
+      allow(distributor).to receive(:all_tests).and_return(report.keys)
     end
 
     describe '#total_time_execution' do
@@ -104,7 +103,7 @@ describe Knapsack::Distributors::ReportDistributor do
 
     describe '#node_time_execution' do
       subject { distributor.node_time_execution }
-      let(:args) { { report: report, ci_node_total: 4 } }
+      let(:custom_args) { { ci_node_total: 4 } }
       it { should eql 1.375 }
     end
   end
@@ -122,35 +121,30 @@ describe Knapsack::Distributors::ReportDistributor do
         'b_spec.rb' => 1.5,
       }
     end
-    let(:args) do
-      {
-        report: report,
-        ci_node_total: 3,
-      }
-    end
+    let(:custom_args) { { ci_node_total: 3 } }
 
     before do
-      allow(distributor).to receive(:all_specs).and_return(report.keys)
+      allow(distributor).to receive(:all_tests).and_return(report.keys)
     end
 
-    describe '#assign_spec_files_to_node' do
-      before { distributor.assign_spec_files_to_node }
+    describe '#assign_test_files_to_node' do
+      before { distributor.assign_test_files_to_node }
 
       it do
-        expect(distributor.node_specs[0]).to eql({
+        expect(distributor.node_tests[0]).to eql({
           :node_index => 0,
           :time_left => -0.5,
-          :spec_files_with_time => [
+          :test_files_with_time => [
             ["g_spec.rb", 9.0]
           ]
         })
       end
 
       it do
-        expect(distributor.node_specs[1]).to eql({
+        expect(distributor.node_tests[1]).to eql({
           :node_index => 1,
           :time_left => 0.0,
-          :spec_files_with_time => [
+          :test_files_with_time => [
             ["f_spec.rb", 3.5],
             ["d_spec.rb", 2.5],
             ["a_spec.rb", 1.0],
@@ -160,10 +154,10 @@ describe Knapsack::Distributors::ReportDistributor do
       end
 
       it do
-        expect(distributor.node_specs[2]).to eql({
+        expect(distributor.node_tests[2]).to eql({
           :node_index => 2,
           :time_left => 0.5,
-          :spec_files_with_time => [
+          :test_files_with_time => [
             ["h_spec.rb", 3.0],
             ["c_spec.rb", 2.0],
             ["i_spec.rb", 3.0]
@@ -172,10 +166,10 @@ describe Knapsack::Distributors::ReportDistributor do
       end
     end
 
-    describe '#specs_for_node' do
+    describe '#tests_for_node' do
       context 'when node exists' do
         it do
-          expect(distributor.specs_for_node(1)).to eql([
+          expect(distributor.tests_for_node(1)).to eql([
             'f_spec.rb',
             'd_spec.rb',
             'a_spec.rb',
@@ -185,7 +179,7 @@ describe Knapsack::Distributors::ReportDistributor do
       end
 
       context "when node doesn't exist" do
-        it { expect(distributor.specs_for_node(42)).to be_nil }
+        it { expect(distributor.tests_for_node(42)).to be_nil }
       end
     end
   end