knapsack 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90ec4edcbad6472bf58996551cbbee025f76c331
-  data.tar.gz: 09432da8440f7dbcd561b4eef460e9b5caa4f4ab
+  metadata.gz: 1d9f16bd65a7c6af4fdd57f421108b1f3cc22008
+  data.tar.gz: aca4f9264ed06bc1ca55ba107c4382d05f2821b9
 SHA512:
-  metadata.gz: 14ca18bfc0e3c7f43a29ac7dd2447a614f9ff0a69d020454f818122a5e4cc3380a08135b78e956d7fd7bea35c504846452279211a1ddbcc82aa1fda63e2ba001
-  data.tar.gz: df60d915e28551227d9b56b8b8810710c15622886c960c61deab6f87cd9f5cbddb052b02add401fee68fc7790f29cf7e7dea47747d73a22f1b6a41840e9e4fe2
+  metadata.gz: eba6f582a89e2df694accf1b63b9d213c8db0781102276323514c41702837ee1749c775d912df95a5510704adf7ac3518acbd307311ac62475f68002ba867c00
+  data.tar.gz: bc55f58146b90c4acaf835566be3e657341eca9c0653f64c47a908d1151725de4bb17d0cf55e4a28fb692d969870248b2151afcca1efa419b49e76c4a72519d0

data/.travis.yml

@@ -49,6 +49,8 @@ script:
   - rm spec_examples/fast/1_spec.rb
   - KNAPSACK_TEST_FILE_PATTERN="spec_examples/**{,/*/**}/*_spec.rb" bundle exec rake knapsack:rspec
 
+  - bin/print_header.sh "Run specs from multiple directories with manually specified test_dir"
+  - KNAPSACK_TEST_DIR=spec_examples KNAPSACK_TEST_FILE_PATTERN="{spec_examples,spec_engine_examples}/**{,/*/**}/*_spec.rb" bundle exec rake knapsack:rspec
 
   - bin/print_header.sh "------------------------------------------------------"
 

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 * TODO
 
+### 1.7.0
+
+* Add ability to run tests from multiple directories
+
+    https://github.com/ArturT/knapsack/pull/35
+
+https://github.com/ArturT/knapsack/compare/v1.6.1...v1.7.0
+
 ### 1.6.1
 
 * Changed rake task in minitest_runner.rb to have no warnings output

data/README.md

@@ -68,6 +68,10 @@ Presentations about gem:
     - [Step 1](#step-1-4)
     - [Step 2](#step-2-4)
 - [FAQ](#faq)
+  - [What time offset warning means?](#what-time-offset-warning-means)
+  - [How to generate knapsack report?](#how-to-generate-knapsack-report)
+  - [What does "leftover specs" mean?](#what-does-leftover-specs-mean)
+  - [How can I run tests from multiple directories?](#how-can-i-run-tests-from-multiple-directories)
 - [Gem tests](#gem-tests)
   - [Spec](#spec)
   - [Spec examples](#spec-examples)
@@ -492,7 +496,7 @@ Knapsack supports snap-ci.com ENVs `SNAP_WORKER_TOTAL` and `SNAP_WORKER_INDEX`.
 
 ## FAQ
 
-* What time offset warning means?
+### What time offset warning means?
 
 At the end of tests execution results you can see warning like this:
 
@@ -509,12 +513,38 @@ Exceeded time: 37s
 
 `Exceeded time: 37s` - it means tests on particular CI node took 37s longer than `max allowed node time execution`. Sometimes this value is negative when tests executed faster than `max allowed node time execution`.
 
+### How to generate knapsack report?
+
 If you want to regenerate report take a look [here](#common-step).
 
 `KNAPSACK_GENERATE_REPORT=true bundle exec rspec spec`
 
 If you run command like this on your development machine then test suite time execution might be different than if you generate a report on CI machine (for instance tests might be faster on your machine then on CI node) so that might be a reason why you see warning about regenerating report. You can generate the report on single CI node which should give you result specific for your CI node instead of your development machine. In case you don't want to bother about manually regenerating knapsack report please take a look on [knapsack_pro gem](http://knapsackpro.com).
 
+### What does "leftover specs" mean?
+
+When you run your specs with knapsack rake task then you will see in the output something like:
+
+```
+Report specs:
+spec/models/user_spec.rb
+spec/controllers/users_controller_spec.rb
+
+Leftover specs:
+spec/models/book_spec.rb
+spec/models/author_spec.rb
+```
+
+The leftover specs mean we don't have recorded time execution for those test files so the leftover specs were distributed across CI nodes based on file name instead.
+The reason might be that someone added a new test file after knapsack report was generated. Another reason might be an empty spec file.
+If you have a lot of leftover specs then you can [generate knapsack report again](#how-to-generate-knapsack-report) to improve you test distribution across CI nodes.
+
+### How can I run tests from multiple directories?
+
+The test file pattern config option supports any glob pattern handled by [`Dir.glob`](http://ruby-doc.org/core-2.2.0/Dir.html#method-c-glob) and can be configured to pull test files from multiple directories. An example of this when using RSpec would be `"{spec,engines/**/spec}/**{,/*/**}/*_spec.rb"`. For complex cases like this, the test directory can't be extracted and must be specified manually using the `KNAPSACK_TEST_DIR` environment variable:
+
+    $ KNAPSACK_TEST_DIR=spec KNAPSACK_TEST_FILE_PATTERN="{spec,engines/**/spec}/**{,/*/**}/*_spec.rb" bundle exec rake knapsack:rspec
+
 ## Gem tests
 
 ### Spec

data/lib/knapsack/allocator.rb

@@ -22,7 +22,7 @@ module Knapsack
     end
 
     def test_dir
-      @report_distributor.test_file_pattern.gsub(/^(.*?)\//).first
+      Knapsack::Config::Env.test_dir || @report_distributor.test_file_pattern.gsub(/^(.*?)\//).first
     end
   end
 end

data/lib/knapsack/allocator_builder.rb

@@ -15,7 +15,7 @@ module Knapsack
     end
 
     def test_dir
-      test_file_pattern.split('/').first
+      Knapsack::Config::Env.test_dir || test_file_pattern.split('/').first
     end
 
     private

data/lib/knapsack/config/env.rb

@@ -18,6 +18,10 @@ module Knapsack
           ENV['KNAPSACK_TEST_FILE_PATTERN']
         end
 
+        def test_dir
+          ENV['KNAPSACK_TEST_DIR']
+        end
+
         private
 
         def index_starting_from_one(index)

data/lib/knapsack/version.rb

@@ -1,3 +1,3 @@
 module Knapsack
-  VERSION = '1.6.1'
+  VERSION = '1.7.0'
 end

data/spec/knapsack/allocator_builder_spec.rb

@@ -97,18 +97,28 @@ describe Knapsack::AllocatorBuilder do
 
     subject { allocator_builder.test_dir }
 
-    before do
-      expect(Knapsack::Config::Env).to receive(:test_file_pattern).and_return(env_test_file_pattern)
-    end
-
-    context 'when ENV test_file_pattern has value' do
-      let(:env_test_file_pattern) { 'custom_spec/**{,/*/**}/*_spec.rb' }
+    context 'when ENV test_dir has value' do
+      before do
+        expect(Knapsack::Config::Env).to receive(:test_dir).and_return("custom_spec")
+      end
 
       it { should eq 'custom_spec' }
     end
 
-    context 'when ENV test_file_pattern has no value' do
-      it { should eq 'spec' }
+    context 'when ENV test_dir has no value' do
+      before do
+        expect(Knapsack::Config::Env).to receive(:test_file_pattern).and_return(env_test_file_pattern)
+      end
+
+      context 'when ENV test_file_pattern has value' do
+        let(:env_test_file_pattern) { 'custom_spec/**{,/*/**}/*_spec.rb' }
+
+        it { should eq 'custom_spec' }
+      end
+
+      context 'when ENV test_file_pattern has no value' do
+        it { should eq 'spec' }
+      end
     end
   end
 end

data/spec/knapsack/allocator_spec.rb

@@ -43,14 +43,26 @@ describe Knapsack::Allocator do
   end
 
   describe '#test_dir' do
-    let(:test_file_pattern) { "test_dir/**{,/*/**}/*_spec.rb" }
-
     subject { allocator.test_dir }
 
-    before do
-      expect(report_distributor).to receive(:test_file_pattern).and_return(test_file_pattern)
+    context 'when ENV test_dir has value' do
+      let(:test_dir) { "custom_dir" }
+
+      before do
+        expect(Knapsack::Config::Env).to receive(:test_dir).and_return(test_dir)
+      end
+
+      it { should eql 'custom_dir' }
     end
 
-    it { should eql 'test_dir/' }
+    context 'when ENV test_dir has no value' do
+      let(:test_file_pattern) { "test_dir/**{,/*/**}/*_spec.rb" }
+
+      before do
+        expect(report_distributor).to receive(:test_file_pattern).and_return(test_file_pattern)
+      end
+
+      it { should eql 'test_dir/' }
+    end
   end
 end

data/spec/knapsack/config/env_spec.rb

@@ -96,4 +96,18 @@ describe Knapsack::Config::Env do
       it { should be_nil }
     end
   end
+
+  describe '.test_dir' do
+    subject { described_class.test_dir }
+
+    context 'when ENV exists' do
+      let(:test_dir) { 'spec' }
+      before { stub_const("ENV", { 'KNAPSACK_TEST_DIR' => test_dir }) }
+      it { should eql test_dir }
+    end
+
+    context "when ENV doesn't exist" do
+      it { should be_nil }
+    end
+  end
 end

data/spec_engine_examples/1_spec.rb

@@ -0,0 +1,3 @@
+describe 'Engine 1' do
+  it {}
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.0
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-18 00:00:00.000000000 Z
+date: 2016-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -220,6 +220,7 @@ files:
 - spec/support/fakes/cucumber.rb
 - spec/support/fakes/minitest.rb
 - spec/support/shared_examples/adapter.rb
+- spec_engine_examples/1_spec.rb
 - spec_examples/fast/1_spec.rb
 - spec_examples/fast/2_spec.rb
 - spec_examples/fast/3_spec.rb