spec_tiller 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9b13142ceda1474ca093cd92a29fb161ea83642
-  data.tar.gz: 45db628b9fff9bc1c00457343564c995b4599fbd
+  metadata.gz: b52ba79a8f884b6a06ebbb64bbd10c0abc46efd3
+  data.tar.gz: ae6e9591d97e21148890c91995047b021f8eb73b
 SHA512:
-  metadata.gz: c8fecb888fa57185e06e798c688d6f897ebbfc4339b9fb9f57a1e43f84c41bf5859a8f76f74a807841d69c85c6a8f154fa89fe504f449df752ca5a532b533655
-  data.tar.gz: 0101f1acd5dc9af7ffdb0c2e033310ed942dfde104fd89965cbc55a32b819b13c96c998a2fe2174f109c864fcf8543ae6a8d8d86825dbfd50d50d47704e3b88a
+  metadata.gz: 748cc635596d90d335c48383439e32a2851ef8dba2fc73ffdce62e8df77e23988335e2e8302a1f163b4d797f1ee710bf26e12b4f624a56fb9a50f803dd3c2398
+  data.tar.gz: 8f8f6e270ad776cca46a98ba53dbe59a6f843e0920db184e13d0f7a6ffcc81cdc45d701bfd322f7e36fd7b8159d1c813d2fa14cc382aebf3bb1118e8a90d5c2c

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.idea/

data/README.md

@@ -30,7 +30,7 @@ Upon setting this up, any time you commit or merge, you'll notice the following
     Added:   [spec/file/added_spec.rb, spec/file/another_added_spec.rb]
 
 ####.travis.yml
-In your ``.travis.yml`` file, create a top-level variable **num_builds** and set it to the number of builds you want the spec files distributed over (deafult value is 5 builds). You must also make sure that the base of your script is as follows:  
+In your ``.travis.yml`` file, create a top-level variable **num_builds** and set it to the number of builds you want the spec files distributed over (default value is 5 builds). You must also make sure that the base of your script is as follows:
 
     bundle exec rspec $TEST_SUITE
 
@@ -62,6 +62,7 @@ Here is an example of what a ``.travis.yml`` file may look like after all is sai
     env:
       global:
       - SOME_OTHER_ENV_VAR="hello world"
+      - IGNORE_SPECS="spec/path/file_thirteen_spec.rb spec/path/file_fourteen_spec.rb"
       matrix:
       - TEST_SUITE="spec/path/file_one_spec.rb spec/path/file_two_spec.rb spec/path/file_three_spec.rb"
       - TEST_SUITE="spec/path/file_four_spec.rb"
@@ -76,6 +77,10 @@ Initially, and every so often, you will have to redistribute the spec files (mak
     spec_tiller:redistribute
 
 This will run your whole test suite, keeping track of how long each spec file takes to run, and the will distribute the spec files in order to maximize your test suite's run time, over the number of builds you've designated (with a default value of 5). **This rake task will not print the output of the rake task until it is complete.**
+
+#### Ignoring Files
+By default, both sync and redistribute will look for any tests following the "spec/**/*_spec.rb" pattern. If you want the tasks to ignore any specs, you can add the IGNORE_SPECS variable to your global variables. The value should be the patterns or specs you want to exclude, separated by spaces.
+
 ***
 ## Feature Requests & Bugs
 See [http://github.com/grnhse/spec-tiller/issues](http://github.com/grnhse/spec-tiller/issues)  

data/lib/spec_tiller/distribute_spec_files.rb

@@ -1,23 +1,5 @@
-require 'rake'
 require 'yaml'
 
-namespace :spec_tiller do
-  desc 'Runs whole test suite and redistributes spec files across builds according to file run time'
-  task :redistribute => :environment do
-    travis_yml_file = YAML::load(File.open('.travis.yml'))
-    env_variables = travis_yml_file['env']['global']
-    script = travis_yml_file['script'].first.gsub('$TEST_SUITE ', '')
-
-    profile_results = `#{env_variables.join(' ')} #{script} --profile 1000000000`
-
-    `echo "#{profile_results}" > spec/log/rspec_profile_output.txt`
-    TravisBuildMatrix::SpecDistributor.new(travis_yml_file, profile_results) do |content|
-      File.open('.travis.yml', 'w') { |file| file.write(content.to_yaml(:line_width => -1)) }
-    end
-    puts profile_results
-  end
-end
-
 module TravisBuildMatrix
 
   DEFAULT_NUM_BUILDS = 5

data/lib/spec_tiller/sync_spec_file_list.rb

@@ -1,27 +1,11 @@
-require 'rake'
 require 'yaml'
 
-namespace :spec_tiller do
-  desc 'Compares spec files in travis.yml to current list of spec files, and syncs accordingly'
-  task :sync do
-    content = YAML::load(File.open('.travis.yml'))
-    current_file_list = Dir.glob('spec/**/*_spec.rb').map { |file_path| file_path.slice(/(spec\/\S+$)/) }
-    
-    puts "\nSyncing list of spec files..."
-
-    SyncSpecFiles.rewrite_travis_content(content, current_file_list) do |original|
-      write_to_file(content)
-      puts file_diff(original, current_file_list)
-    end
-
-    `git add .travis.yml`
-  end
-end
-
 module SyncSpecFiles
   include BuildMatrixParser
 
   def rewrite_travis_content(content, current_file_list, &block)
+    ignore_specs = get_ignored_specs(content)
+    current_file_list = current_file_list.reject { |file_path| ignore_specs.include?(file_path) }
     env_matrix = BuildMatrixParser.parse_env_matrix(content)
     original = extract_spec_files(env_matrix)
     after_removed = delete_removed_files(original, current_file_list)
@@ -37,11 +21,22 @@ module SyncSpecFiles
 
     content['env']['matrix'] = BuildMatrixParser.format_matrix(env_matrix)
 
-    block.call(original) if block
+    block.call(content, original, current_file_list) if block
   end
 
   module_function :rewrite_travis_content
 
+  def self.get_ignored_specs(content)
+    ignore_specs = []
+    content['env']['global'].each do |row|
+      # Input: IGNORE_SPECS="spec/a.rb spec/b.rb"
+      # Output: ['spec/a.rb spec/b.rb']
+      matches = row.match(/IGNORE_SPECS="\s*([^"]+)"/)
+      ignore_specs << matches[1].split(' ') unless matches.nil?
+    end
+    ignore_specs.flatten
+  end
+
   private
 
     def self.extract_spec_files(env_matrix)
@@ -77,10 +72,6 @@ module SyncSpecFiles
       current_file_list - original.flatten
     end
 
-    def self.write_to_file(content)
-      File.open('.travis.yml', 'w') { |file| file.write(content.to_yaml(:line_width => -1)) }
-    end
-
     def self.file_diff(original, current_file_list)
       removed_files = deleted_files(original, current_file_list).sort
       removed = removed_files.empty? ? 'No spec files removed' : removed_files

data/lib/spec_tiller/version.rb

@@ -1,3 +1,3 @@
 module SpecTiller
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 end

data/lib/tasks/spec_tiller.rake

@@ -0,0 +1,36 @@
+namespace :spec_tiller do
+  desc 'Compares spec files in travis.yml to current list of spec files, and syncs accordingly'
+  task :sync do
+    content = YAML::load(File.open('.travis.yml'))
+    current_file_list = Dir.glob('spec/**/*_spec.rb').map { |file_path| file_path.slice(/(spec\/\S+$)/) }
+
+    puts "\nSyncing list of spec files..."
+
+    SyncSpecFiles.rewrite_travis_content(content, current_file_list) do |content, original, current_file_list|
+      File.open('.travis.yml', 'w') { |file| file.write(content.to_yaml(:line_width => -1)) }
+      puts SyncSpecFiles.file_diff(original, current_file_list)
+    end
+
+    `git add .travis.yml`
+  end
+
+  desc 'Runs whole test suite and redistributes spec files across builds according to file run time'
+  task :redistribute => :environment do
+    travis_yml_file = YAML::load(File.open('.travis.yml'))
+    env_variables = travis_yml_file['env']['global']
+    script = travis_yml_file['script'].first.gsub('$TEST_SUITE ', '')
+
+    ignore_specs = SyncSpecFiles.get_ignored_specs(travis_yml_file).map { |spec| %Q("#{spec}") }
+    script += %Q( --exclude-pattern #{ignore_specs.join(',')}) unless ignore_specs.empty?
+
+    profile_results = `#{env_variables.join(' ')} #{script} --profile 1000000000`
+
+    `echo "#{profile_results}" > spec/log/rspec_profile_output.txt`
+    TravisBuildMatrix::SpecDistributor.new(travis_yml_file, profile_results) do |content|
+      File.open('.travis.yml', 'w') { |file| file.write(content.to_yaml(:line_width => -1)) }
+    end
+
+    puts profile_results
+  end
+
+end

data/spec/documents/.travis.yml

@@ -25,6 +25,7 @@ script:
 env:
   global:
   - RUBY_GC_HEAP_OLDOBJECT_LIMIT_FACTOR=1.1
+  - IGNORE_SPECS="spec/features/ignore_me.rb"
   matrix:
   - TEST_SUITE="spec/features/three_vars.rb" RUN_JS="true" FAKE_VAR="fake.value.rb"
   - TEST_SUITE="spec/features/space_after.rb      spec/features/space_before.rb"          FIVE_TABS_BEFORE="tabs are ignored"

data/spec/documents/.travis2.yml

@@ -0,0 +1,31 @@
+---
+language: ruby
+rvm:
+- 2.1.2
+addons:
+  hosts:
+  - example.com
+branches:
+  only:
+  - develop
+  - master
+  - "/^release\\/.*$/"
+  - "/^hotfix\\/.*$/"
+  - "/^feature\\/testing-.+$/"
+cache: bundler
+before_install:
+- export DISPLAY=:99.0
+- "/sbin/start-stop-daemon --start --quiet --pidfile /tmp/custom_xvfb_99.pid --make-pidfile --background --exec /usr/bin/Xvfb -- :99 -ac -screen 0 1920x1080x16"
+before_script:
+- psql -c 'create database test;' -U postgres
+- RAILS_ENV=test bundle exec rake --trace db:test:load db:seed
+script:
+- RSPEC_RETRY_COUNT=2 bundle exec rspec --pattern "spec/documents/*_spec.rb" $TEST_SUITE --tag ~local_only
+env:
+  global:
+  - RUBY_GC_HEAP_OLDOBJECT_LIMIT_FACTOR=1.1
+  - IGNORE_SPECS="spec/documents/iterator5_spec.rb"
+  matrix:
+  - TEST_SUITE="spec/documents/iterator2_spec.rb"
+  - TEST_SUITE="spec/documents/iterator1_spec.rb spec/documents/iterator4_spec.rb spec/documents/iterator3_spec.rb"
+num_builds: 2

data/spec/documents/iterator1_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe 'Iterator1' do
+  let(:a) { Array.new(1000000) }
+
+  it 'iterates 1000000 times' do
+    i = 0
+    a.each { i += 1 }
+    expect(i).to eq(1000000)
+  end
+
+  it 'compares 1000000 times' do
+    a.each do
+      expect(1).to eq(1)
+    end
+  end
+
+  it 'compares 1000000 more times' do
+    a.each do
+      expect(1).to_not eq(2)
+    end
+  end
+end

data/spec/documents/iterator2_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe 'Iterator2' do
+  let(:a) { Array.new(2000000) }
+
+  it 'iterates 2000000 times' do
+    i = 0
+    a.each { i += 1 }
+    expect(i).to eq(2000000)
+  end
+
+  it 'compares 2000000 times' do
+    a.each do
+      expect(1).to eq(1)
+    end
+  end
+
+  it 'compares 2000000 more times' do
+    a.each do
+      expect(1).to_not eq(2)
+    end
+  end
+end

data/spec/documents/iterator3_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe 'Iterator3' do
+  let(:a) { Array.new(1000) }
+
+  it 'iterates 1000 times' do
+    i = 0
+    a.each { i += 1 }
+    expect(i).to eq(1000)
+  end
+
+  it 'compares 1000 times' do
+    a.each do
+      expect(1).to eq(1)
+    end
+  end
+
+  it 'compares 1000 more times' do
+    a.each do
+      expect(1).to_not eq(2)
+    end
+  end
+end

data/spec/documents/iterator4_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe 'Iterator4' do
+  let(:a) { Array.new(20000) }
+
+  it 'iterates 20000 times' do
+    i = 0
+    a.each { i += 1 }
+    expect(i).to eq(20000)
+  end
+
+  it 'compares 20000 times' do
+    a.each do
+      expect(1).to eq(1)
+    end
+  end
+
+  it 'compares 20000 more times' do
+    a.each do
+      expect(1).to_not eq(2)
+    end
+  end
+end

data/spec/documents/iterator5_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe 'Iterator1' do
+  let(:a) { Array.new(300000) }
+
+  it 'iterates 300000 times' do
+    i = 0
+    a.each { i += 1 }
+    expect(i).to eq(300000)
+  end
+
+  it 'compares 300000 times' do
+    a.each do
+      expect(1).to eq(1)
+    end
+  end
+
+  it 'compares 300000 more times' do
+    a.each do
+      expect(1).to_not eq(2)
+    end
+  end
+end

data/spec/support/shared_contexts/rake.rb

@@ -0,0 +1,26 @@
+# From http://robots.thoughtbot.com/test-rake-tasks-like-a-boss and
+require 'rake'
+
+shared_context 'rake' do
+  let(:rake) { Rake::Application.new }
+  let(:task_name) { self.class.top_level_description }
+  let(:task_path) { "lib/tasks/#{task_name.split(":").first}" }
+  subject(:task) { rake[task_name] }
+
+  def loaded_files_excluding_current_rake_file
+    $".reject { |file| file == [Dir.pwd].join("#{task_path}.rake").to_s }
+  end
+
+  before(:each) do
+    original_open = File.method(:open)
+    allow(File).to receive(:open) do |file_name, options, &block|
+      file_name = 'spec/documents/.travis2.yml' if file_name == '.travis.yml'
+      original_open.call(file_name, options, &block)
+    end
+
+    Rake.application = rake
+    Rake.application.rake_require(task_path, [Dir.pwd], loaded_files_excluding_current_rake_file)
+
+    Rake::Task.define_task(:environment)
+  end
+end

data/spec/sync_spec_file_list_spec.rb

@@ -7,6 +7,7 @@ describe 'SyncSpecFiles' do
 
     let(:current_file_list) do
       ['spec/test/new3.rb',
+      'spec/features/ignore_me.rb',
       'spec/features/space_after.rb', 'spec/features/space_before.rb',
       'spec/test/test1.rb', 'spec/test/test2.rb', 'spec/test/test3.rb', 'spec/test/test4.rb', 'spec/test/test5.rb', 'spec/test/test6.rb', 'spec/test/test7.rb', 'spec/test/test8.rb', 'spec/test/test9.rb', 'spec/test/test10.rb', 'spec/test/test11.rb', 'spec/test/test12.rb', 'spec/test/test13.rb', 'spec/test/test14.rb', 'spec/test/test15.rb', 'spec/test/test16.rb',
       'spec/test/new1.rb', 'spec/test2/new2.rb']
@@ -43,6 +44,13 @@ describe 'SyncSpecFiles' do
       expect(travis_yaml['env']['matrix'].length).to eq(2)
     end
 
+    it 'does not include ignored specs' do
+      travis_yaml['env']['matrix'].each do |bucket|
+        expect(bucket).not_to include('spec/features/ignore_me.rb')
+      end
+
+    end
+
   end
 
 end

data/spec/tasks/spec_tiller_rake_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'support/shared_contexts/rake'
+require 'yaml'
+
+describe 'spec_tiller:sync' do
+  include_context('rake')
+  before(:each) do
+    original_glob = Dir.method(:glob)
+    allow(Dir).to receive(:glob) do |pattern|
+      pattern = 'spec/documents/*_spec.rb' if pattern == 'spec/**/*_spec.rb'
+      original_glob.call(pattern)
+    end
+  end
+
+  it 'adds new files to last line' do
+    temp_file_name = 'spec/documents/new_added_spec.rb'
+    File.new(temp_file_name, 'w')
+    content_at_start = YAML::load(File.open('.travis.yml'))
+
+    task.invoke
+    content_at_end = YAML::load(File.open('.travis.yml'))
+    expect(content_at_end['env']['matrix'].last).to include(temp_file_name)
+
+    # Clean up added file and travis.yml
+    File.delete(temp_file_name)
+    File.open('.travis.yml', 'w') { |file| file.write(content_at_start.to_yaml(:line_width => -1)) }
+  end
+
+  it 'removes non-existent files' do
+    temp_file_name = 'spec/documents/old_removed_spec.rb'
+    content_at_start = YAML::load(File.open('.travis.yml'))
+    content_at_start['env']['matrix'] << %Q(TEST_SUITE="#{temp_file_name}")
+    File.open('.travis.yml', 'w') { |file| file.write(content_at_start.to_yaml(:line_width => -1)) }
+
+    task.invoke
+    content_at_end = YAML::load(File.open('.travis.yml'))
+
+    content_at_end['env']['matrix'].each do |bucket|
+      expect(bucket).to_not include(temp_file_name)
+    end
+
+  end
+
+end
+
+describe 'spec_tiller:redistribute' do
+  include_context('rake')
+
+  it 'distributes evenly based on run time' do
+    content_at_start = YAML::load(File.open('.travis.yml'))
+    task.invoke
+    content_at_end = YAML::load(File.open('.travis.yml'))
+
+    expect(content_at_end['env']['matrix']).to eq(content_at_start['env']['matrix'])
+    expect(content_at_end['env']['matrix'].length).to eq(2)
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spec_tiller
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Matt Schmaus
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-20 00:00:00.000000000 Z
+date: 2014-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -74,12 +74,21 @@ files:
 - lib/spec_tiller/distribute_spec_files.rb
 - lib/spec_tiller/sync_spec_file_list.rb
 - lib/spec_tiller/version.rb
+- lib/tasks/spec_tiller.rake
 - spec/build_matrix_parser_spec.rb
 - spec/distribute_spec_files_spec.rb
 - spec/documents/.travis.yml
+- spec/documents/.travis2.yml
+- spec/documents/iterator1_spec.rb
+- spec/documents/iterator2_spec.rb
+- spec/documents/iterator3_spec.rb
+- spec/documents/iterator4_spec.rb
+- spec/documents/iterator5_spec.rb
 - spec/documents/rspec_profile_results.txt
 - spec/spec_helper.rb
+- spec/support/shared_contexts/rake.rb
 - spec/sync_spec_file_list_spec.rb
+- spec/tasks/spec_tiller_rake_spec.rb
 - spec_tiller.gemspec
 homepage: ''
 licenses:
@@ -109,6 +118,14 @@ test_files:
 - spec/build_matrix_parser_spec.rb
 - spec/distribute_spec_files_spec.rb
 - spec/documents/.travis.yml
+- spec/documents/.travis2.yml
+- spec/documents/iterator1_spec.rb
+- spec/documents/iterator2_spec.rb
+- spec/documents/iterator3_spec.rb
+- spec/documents/iterator4_spec.rb
+- spec/documents/iterator5_spec.rb
 - spec/documents/rspec_profile_results.txt
 - spec/spec_helper.rb
+- spec/support/shared_contexts/rake.rb
 - spec/sync_spec_file_list_spec.rb
+- spec/tasks/spec_tiller_rake_spec.rb