knapsack 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66e29adad8c5ac42ab419a5b37de9741ff51430c
-  data.tar.gz: 6dd72187cd1fa6edc33f52d2b22ed0322b34e47a
+  metadata.gz: b9c0c3f2c4c9ade9a8b93a9285ae2ec1fef1810f
+  data.tar.gz: ba827b1b39aa68a0df7052f579d635dc91331700
 SHA512:
-  metadata.gz: 88a2e270d5ad38f0df8a4d989125d533ae0c29aee78d364b07cf6991c8053d9e7602710c1b26551acb54a28311351547cfc1c0106de65a6dd73454b4b76ff629
-  data.tar.gz: d886bee4e155577ee534d37785a1892361813c24cbfdfc70947325df8083e1bd29c23c69387fc52c08cc8aa3d04a6e6cd2da48ccde964cb84ef309ed4c4321ee
+  metadata.gz: 210967c7a39fb22ee932848d362b15356173270e62e58cd427fecc9b4d6e732dfee5a4501d4947440d13a134b9a149e38bb160ebf052ef577dfaf24e978a533a
+  data.tar.gz: 76ad4ccb462dd2e732add681a6db6274b300866fe4ef58266e812914c768ced59e88bbac60d1cf6f7e92a8c0c69ebbb9635d0ffca3d83dd3e71718b6eb60f225

data/.travis.yml

@@ -12,21 +12,26 @@ addons:
 before_install:
   - "echo 'gem: --no-ri --no-rdoc' > ~/.gemrc"
 script:
+  - echo "Run specs for Knapsack gem"
   - bundle exec rspec spec
 
-  # generate knapsack report
+  - echo "Generate knapsack report"
   - KNAPSACK_GENERATE_REPORT=true bundle exec rspec --default-path spec_examples --tag focus
 
-  # run specs with enabled time offset warning
+  - echo "Run specs with enabled time offset warning"
   - bundle exec rspec --default-path spec_examples
 
-  # run rake task for the first CI node
+  - echo "Run rake task for the first CI node"
   - CI_NODE_TOTAL=2 CI_NODE_INDEX=0 KNAPSACK_SPEC_PATTERN="spec_examples/**/*_spec.rb" bundle exec rake knapsack:rspec
-  # run rake task for the second CI node
+  - echo "Run rake task for the second CI node"
   - CI_NODE_TOTAL=2 CI_NODE_INDEX=1 KNAPSACK_SPEC_PATTERN="spec_examples/**/*_spec.rb" bundle exec rake knapsack:rspec
 
-  # run specs for custom knapsack report path
+  - echo "Run specs for custom knapsack report path"
   - cp knapsack_report.json custom_knapsack_report.json
   - KNAPSACK_SPEC_PATTERN="spec_examples/**/*_spec.rb" KNAPSACK_REPORT_PATH="custom_knapsack_report.json" bundle exec rake knapsack:rspec
+
+  - echo "Run specs when spec file was removed and still exists in knapsack report json"
+  - rm spec_examples/fast/1_spec.rb
+  - KNAPSACK_SPEC_PATTERN="spec_examples/**/*_spec.rb" bundle exec rake knapsack:rspec
 notifications:
   email: false

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 ### unreleased
 
-* nothing yet
+* TODO
+
+### 0.1.2
+
+* Fix case when someone removes spec file which exists in knapsack report.
+* Extract config to separate class and fix wrong node time execution on CI.
 
 ### 0.1.1
 

data/lib/knapsack.rb

@@ -1,5 +1,6 @@
 require 'singleton'
 require_relative 'knapsack/version'
+require_relative 'knapsack/config'
 require_relative 'knapsack/tracker'
 require_relative 'knapsack/presenter'
 require_relative 'knapsack/report'

data/lib/knapsack/allocator.rb

@@ -1,9 +1,9 @@
 module Knapsack
   class Allocator
     def initialize(args={})
-      @config = default_args.merge(args)
-      @report_distributor = Knapsack::Distributors::ReportDistributor.new(@config)
-      @leftover_distributor = Knapsack::Distributors::LeftoverDistributor.new(@config)
+      @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
@@ -22,44 +22,8 @@ module Knapsack
       node_specs.join(' ')
     end
 
-    def custom_spec_dir
-      return unless @config[:spec_pattern]
-      @config[:spec_pattern].gsub(/^(.*?)\//).first
-    end
-
-    private
-
-    def default_args
-      {
-        ci_node_total: env_ci_node_total,
-        ci_node_index: env_ci_node_index,
-        spec_pattern: env_spec_pattern,
-        report: report
-      }
-    end
-
-    def env_ci_node_total
-      ENV['CI_NODE_TOTAL'] || ENV['CIRCLE_NODE_TOTAL']
-    end
-
-    def env_ci_node_index
-      ENV['CI_NODE_INDEX'] || ENV['CIRCLE_NODE_INDEX']
-    end
-
-    def env_spec_pattern
-      ENV['KNAPSACK_SPEC_PATTERN']
-    end
-
-    def env_report_path
-      ENV['KNAPSACK_REPORT_PATH']
-    end
-
-    def report
-      return unless env_report_path
-      Knapsack.report.config({
-        report_path: env_report_path
-      })
-      Knapsack.report.open
+    def spec_dir
+      @spec_pattern.gsub(/^(.*?)\//).first
     end
   end
 end

data/lib/knapsack/config.rb

@@ -0,0 +1,33 @@
+module Knapsack
+  class Config
+    class << self
+      def report_path
+        ENV['KNAPSACK_REPORT_PATH'] || 'knapsack_report.json'
+      end
+
+      def ci_node_total
+        ENV['CI_NODE_TOTAL'] || ENV['CIRCLE_NODE_TOTAL'] || 1
+      end
+
+      def ci_node_index
+        ENV['CI_NODE_INDEX'] || ENV['CIRCLE_NODE_INDEX'] || 0
+      end
+
+      def spec_pattern
+        ENV['KNAPSACK_SPEC_PATTERN'] || 'spec/**/*_spec.rb'
+      end
+
+      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

data/lib/knapsack/distributors/base_distributor.rb

@@ -1,20 +1,13 @@
 module Knapsack
   module Distributors
     class BaseDistributor
-      attr_reader :report, :node_specs
-
-      DEFAULT_CI_NODE_TOTAL = 1
-      DEFAULT_CI_NODE_INDEX = 0
+      attr_reader :report, :node_specs, :spec_pattern
 
       def initialize(args={})
         @report = args[:report] || default_report
-        @ci_node_total = args[:ci_node_total] || DEFAULT_CI_NODE_TOTAL
-        @ci_node_index = args[:ci_node_index] || DEFAULT_CI_NODE_INDEX
-        post_initialize(args)
-      end
-
-      def default_report
-        Knapsack.report.open
+        @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
       end
 
       def ci_node_total
@@ -40,12 +33,12 @@ module Knapsack
         post_assign_spec_files_to_node
       end
 
-      protected
-
-      def post_initialize(args)
-        nil
+      def all_specs
+        @all_specs ||= Dir[spec_pattern]
       end
 
+      protected
+
       def post_specs_for_node(node_index)
         raise NotImplementedError
       end
@@ -58,6 +51,16 @@ module Knapsack
         raise NotImplementedError
       end
 
+      private
+
+      def config
+        Knapsack::Config
+      end
+
+      def default_report
+        Knapsack.report.open
+      end
+
       def update_node_index
         @node_index += 1
         @node_index = 0 if @node_index == ci_node_total

data/lib/knapsack/distributors/leftover_distributor.rb

@@ -1,14 +1,8 @@
 module Knapsack
   module Distributors
     class LeftoverDistributor < BaseDistributor
-      attr_reader :spec_pattern
-
       def report_specs
-        @report_specs ||= @report.keys
-      end
-
-      def all_specs
-        @all_specs ||= Dir[spec_pattern]
+        @report_specs ||= report.keys
       end
 
       def leftover_specs
@@ -17,14 +11,6 @@ module Knapsack
 
       private
 
-      def post_initialize(args={})
-        @spec_pattern = args[:spec_pattern] || default_spec_pattern
-      end
-
-      def default_spec_pattern
-        'spec/**/*_spec.rb'
-      end
-
       def post_assign_spec_files_to_node
         leftover_specs.each do |spec_file|
           node_specs[@node_index] << spec_file

data/lib/knapsack/distributors/report_distributor.rb

@@ -2,11 +2,15 @@ module Knapsack
   module Distributors
     class ReportDistributor < BaseDistributor
       def sorted_report
-        @sorted_report ||= report.sort_by{|k,v| v}.reverse
+        @sorted_report ||= report.sort_by { |spec_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) }
       end
 
       def total_time_execution
-        @total_time_execution ||= report.values.reduce(0, :+).to_f
+        @total_time_execution ||= sorted_report_with_existing_specs.map(&:last).reduce(0, :+).to_f
       end
 
       def node_time_execution
@@ -40,7 +44,7 @@ module Knapsack
       def assign_slow_spec_files
         @not_assigned_spec_files = []
         @node_index = 0
-        sorted_report.each do |spec_file_with_time|
+        sorted_report_with_existing_specs.each do |spec_file_with_time|
           assign_slow_spec_file(spec_file_with_time)
           update_node_index
         end

data/lib/knapsack/report.rb

@@ -24,7 +24,7 @@ module Knapsack
 
     def default_config
       {
-        report_path: 'knapsack_report.json'
+        report_path: Config.report_path
       }
     end
 

data/lib/knapsack/tracker.rb

@@ -50,16 +50,12 @@ module Knapsack
 
     def default_config
       {
-        enable_time_offset_warning: true,
-        time_offset_in_seconds: 30,
-        generate_report: generate_report
+        enable_time_offset_warning: Config.enable_time_offset_warning,
+        time_offset_in_seconds: Config.time_offset_in_seconds,
+        generate_report: Config.generate_report
       }
     end
 
-    def generate_report
-      ENV['KNAPSACK_GENERATE_REPORT'] || false
-    end
-
     def set_defaults
       @global_time = 0
       @spec_files_with_time = {}

data/lib/knapsack/version.rb

@@ -1,3 +1,3 @@
 module Knapsack
-  VERSION = "0.1.1"
+  VERSION = '0.1.2'
 end

data/lib/tasks/knapsack.rake

@@ -12,9 +12,7 @@ namespace :knapsack do
     puts allocator.leftover_node_specs
     puts
 
-    custom_spec_dir = allocator.custom_spec_dir
-    default_path = custom_spec_dir ? "--default-path #{custom_spec_dir}" : nil
-    cmd = %Q[bundle exec rspec #{default_path} -- #{allocator.stringify_node_specs}]
+    cmd = %Q[bundle exec rspec --default-path #{allocator.spec_dir} -- #{allocator.stringify_node_specs}]
 
     exec(cmd)
   end

data/spec/knapsack/allocator_spec.rb

@@ -42,16 +42,16 @@ describe Knapsack::Allocator do
     it { should eql node_specs.join(' ') }
   end
 
-  describe '#custom_spec_dir' do
-    subject { allocator.custom_spec_dir }
+  describe '#spec_dir' do
+    subject { allocator.spec_dir }
 
     context 'when spec pattern exists' do
-      let(:spec_pattern) { "custom_spec_dir/**/*_spec.rb" }
-      it { should eql 'custom_spec_dir/' }
+      let(:spec_pattern) { "spec_dir/**/*_spec.rb" }
+      it { should eql 'spec_dir/' }
     end
 
     context "when spec pattern doesn't exist" do
-      it { should be_nil }
+      it { should eql 'spec/' }
     end
   end
 end

data/spec/knapsack/config_spec.rb

@@ -0,0 +1,92 @@
+describe Knapsack::Config do
+  describe '.report_path' do
+    subject { described_class.report_path }
+
+    context 'when ENV exists' do
+      let(:report_path) { 'custom_knapsack_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' }
+    end
+  end
+
+  describe '.ci_node_total' do
+    subject { described_class.ci_node_total }
+
+    context 'when ENV exists' do
+      context 'when CI_NODE_TOTAL has value' do
+        before { stub_const("ENV", { 'CI_NODE_TOTAL' => 5 }) }
+        it { should eql 5 }
+      end
+
+      context 'when CIRCLE_NODE_TOTAL has value' do
+        before { stub_const("ENV", { 'CIRCLE_NODE_TOTAL' => 4 }) }
+        it { should eql 4 }
+      end
+    end
+
+    context "when ENV doesn't exist" do
+      it { should eql 1 }
+    end
+  end
+
+  describe '.ci_node_index' do
+    subject { described_class.ci_node_index }
+
+    context 'when ENV exists' do
+      context 'when CI_NODE_INDEX has value' do
+        before { stub_const("ENV", { 'CI_NODE_INDEX' => 3 }) }
+        it { should eql 3 }
+      end
+
+      context 'when CIRCLE_NODE_INDEX has value' do
+        before { stub_const("ENV", { 'CIRCLE_NODE_INDEX' => 2 }) }
+        it { should eql 2 }
+      end
+    end
+
+    context "when ENV doesn't exist" do
+      it { should eql 0 }
+    end
+  end
+
+  describe '.spec_pattern' do
+    subject { described_class.spec_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 }
+    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 }
+    end
+  end
+end

data/spec/knapsack/distributors/report_distributor_spec.rb

@@ -27,12 +27,44 @@ describe Knapsack::Distributors::ReportDistributor do
 
     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],
+        ['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
+
+  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
+
+    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],
+        ['d_spec.rb', 2.5],
+        ['b_spec.rb', 1.5],
       ])
     end
   end
@@ -47,6 +79,10 @@ describe Knapsack::Distributors::ReportDistributor do
     end
     let(:args) { { report: report } }
 
+    before do
+      allow(distributor).to receive(:all_specs).and_return(report.keys)
+    end
+
     describe '#total_time_execution' do
       subject { distributor.total_time_execution }
 
@@ -93,6 +129,10 @@ describe Knapsack::Distributors::ReportDistributor do
       }
     end
 
+    before do
+      allow(distributor).to receive(:all_specs).and_return(report.keys)
+    end
+
     describe '#assign_spec_files_to_node' do
       before { distributor.assign_spec_files_to_node }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knapsack
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - ArturT
@@ -110,6 +110,7 @@ files:
 - lib/knapsack/adapters/base_adapter.rb
 - lib/knapsack/adapters/rspec_adapter.rb
 - lib/knapsack/allocator.rb
+- lib/knapsack/config.rb
 - lib/knapsack/distributors/base_distributor.rb
 - lib/knapsack/distributors/leftover_distributor.rb
 - lib/knapsack/distributors/report_distributor.rb
@@ -122,6 +123,7 @@ files:
 - spec/knapsack/adapters/base_adapter_spec.rb
 - spec/knapsack/adapters/rspec_adapter_spec.rb
 - spec/knapsack/allocator_spec.rb
+- spec/knapsack/config_spec.rb
 - spec/knapsack/distributors/base_distributor_spec.rb
 - spec/knapsack/distributors/leftover_distributor_spec.rb
 - spec/knapsack/distributors/report_distributor_spec.rb
@@ -173,6 +175,7 @@ test_files:
 - spec/knapsack/adapters/base_adapter_spec.rb
 - spec/knapsack/adapters/rspec_adapter_spec.rb
 - spec/knapsack/allocator_spec.rb
+- spec/knapsack/config_spec.rb
 - spec/knapsack/distributors/base_distributor_spec.rb
 - spec/knapsack/distributors/leftover_distributor_spec.rb
 - spec/knapsack/distributors/report_distributor_spec.rb