Overhauling integration test mechanism.

Author: MrJoy

.gitignore

@@ -8,6 +8,12 @@
 /Gemfile.lock
 *.gem
 /.idea/
-.rvmrc
+/.rvmrc
 .bundle
 /.rbx
+/spec/integration/*/bin/
+/spec/integration/*/log/*
+!/spec/integration/*/log/.gitkeep
+/spec/integration/*/tmp/*
+!/spec/integration/*/tmp/.gitkeep
+/spec/integration/*/db/test.*

CHANGELOG.rdoc

@@ -15,6 +15,12 @@
 * Added support for new FactoryGirl naming convention.
 * Fix behavior of route annotations in newer versions of Rake that don't spit
   out the CWD as their first line of output.
+* Overhauled integration testing system to be much easier to work with, better
+  compartmentalized, and so forth -- at the cost that you must be using RVM to
+  utilize it.  (It'll spit out appropriate pending messages if you don't.)
+  Also includes a mode for "tinkering" by hand with a scenario, and won't let
+  you run it through rspect if the repo is in a dirty state.  Added appropriate
+  rake tasks to help with all of this.
 * Routes can now be appended, pre-pended, or removed -- and do sane things in
   all cases.
 * Expose all `position_*` variables as CLI params.

Rakefile

@@ -31,6 +31,88 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   t.rspec_opts = ['--backtrace', '--format d']
 end
 
+# Placeholder for running bin/* in development...
+task :environment
+
+task :integration_environment do
+  require './spec/spec_helper'
+end
+
+namespace :gemsets do
+  desc "Completely empty any gemsets used by scenarios, so they'll be perfectly clean on the next run."
+  task :empty => [:integration_environment] do
+    Annotate::Integration::SCENARIOS.each do |test_rig, base_dir, test_name|
+      Annotate::Integration.empty_gemset(test_rig)
+    end
+  end
+end
+task :clobber => :'gemsets:empty'
+
+namespace :integration do
+  desc "Remove any cruft generated by manual debugging runs which is .gitignore'd."
+  task :clean => :integration_environment do
+    Annotate::Integration.nuke_all_cruft
+  end
+
+  desc "Reset any changed files, and remove any untracked files in spec/integration/*/, plus run integration:clean."
+  task :clobber => [:integration_environment, :'integration:clean'] do
+    Annotate::Integration.reset_dirty_files
+    Annotate::Integration.clear_untracked_files
+  end
+
+  task :symlink => [:integration_environment] do
+    require 'digest/md5'
+
+    integration_dir = File.expand_path(File.join(File.dirname(__FILE__), 'spec', 'integration'))
+    fixture_dir = File.expand_path(File.join(File.dirname(__FILE__), 'spec', 'fixtures'))
+    target_dir = File.expand_path(ENV['TARGET']) if(ENV['TARGET'])
+    raise "Must specify TARGET=x, where x is an integration test scenario!" unless(target_dir && Dir.exist?(target_dir))
+    raise "TARGET directory must be within spec/integration/!" unless(target_dir.start_with?(integration_dir))
+    candidates = {}
+    FileList[
+      "#{target_dir}/.rvmrc",
+      "#{target_dir}/**/*"
+    ].select { |fname| !(File.symlink?(fname) || File.directory?(fname)) }.
+      map { |fname| fname.sub(integration_dir, '') }.
+      reject do |fname|
+        fname =~ /\/\.gitkeep$/ ||
+        fname =~ /\/app\/models\// ||
+        fname =~ /\/routes\.rb$/ ||
+        fname =~ /\/fixtures\// ||
+        fname =~ /\/factories\// ||
+        fname =~ /\.sqlite3$/ ||
+        (fname =~ /\/test\// && fname !~ /_helper\.rb$/) ||
+        (fname =~ /\/spec\// && fname !~ /_helper\.rb$/)
+      end.
+      map { |fname| "#{integration_dir}#{fname}"}.
+      each do |fname|
+        digest = Digest::MD5.hexdigest(File.read(fname))
+        candidates[digest] ||= []
+        candidates[digest] << fname
+      end
+    fixtures = {}
+    FileList["spec/fixtures/**/*"].each do |fname|
+      fixtures[Digest::MD5.hexdigest(File.read(fname))] = File.expand_path(fname)
+    end
+
+    candidates.keys.each do |digest|
+      if(fixtures.has_key?(digest))
+        candidates[digest].each do |fname|
+          # Double-check contents in case of hash collision...
+          if(FileUtils.identical?(fname, fixtures[digest]))
+            destination_dir = Pathname.new(File.dirname(fname))
+            relative_target = Pathname.new(fixtures[digest]).relative_path_from(destination_dir)
+            Dir.chdir(destination_dir) do
+              sh("ln", "-sfn", relative_target.to_s, File.basename(fname))
+            end
+          end
+        end
+      end
+    end
+  end
+end
+task :clobber => :'integration:clobber'
+
 require 'yard'
 YARD::Rake::YardocTask.new do |t|
   # t.files   = ['features/**/*.feature', 'features/**/*.rb', 'lib/**/*.rb']

spec/fixtures/20120816164927_create_tasks.rb

@@ -0,0 +1,9 @@
+class CreateTasks < ActiveRecord::Migration
+  def change
+    create_table :tasks do |t|
+      t.string :content
+
+      t.timestamps
+    end
+  end
+end

spec/fixtures/database.yml

@@ -0,0 +1,16 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 1
+  timeout: 5000
+
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 1
+  timeout: 5000

spec/fixtures/rails32_boot.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])

spec/fixtures/rails32_unified_initializer.rb

@@ -0,0 +1,8 @@
+# secret_token.rb
+TestApp::Application.config.secret_token = '4768b21141022d583b141fde0db7e0b31759321b7fce459963914fdd82db248ea0318d9568030dcde70d404d4e86003ce5f51a7a83c8130842e5a97062b68c3c'
+
+# session_store.rb
+TestApp::Application.config.session_store :cookie_store, key: '_session'
+
+# wrap_parameters.rb
+ActiveSupport.on_load(:active_record) { self.include_root_in_json = false }

spec/fixtures/rails_328_gemfile

@@ -0,0 +1,24 @@
+# This file is a hybrid file meant for live debugging without going through an
+# actual RSpec run, and for being used in an RSpec run.  To change it, change
+# template.Gemfile and run 'rake templates:rebuild' which will do so for all
+# templates in all build scenarios.
+#
+# ALSO, be sure NOT to commit any changes that happen in app/* or config/*
+# when debugging this way as that will defeat the point of the automated tests!
+#
+# In fact, before running RSpec again after manual testing, you should run
+# 'rake integration:clober' to reset modified files to their pristine state,
+# and remove cruft that may interfere with the build.
+source 'https://rubygems.org'
+
+gem 'rails', '3.2.8'
+
+gem 'sqlite3'
+
+group :development do
+  if(ENV['AUTOMATED_TEST'] && ENV['AUTOMATED_TEST'] != '')
+    gem 'annotate', :path => ENV['AUTOMATED_TEST']
+  else
+    gem 'annotate', :path => '../../..'
+  end
+end

spec/fixtures/rails_328_gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: ../../..
+  specs:
+    annotate (2.5.0.beta4)
+      activesupport (>= 2.3.0)
+      rake (>= 0.8.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.8)
+      actionpack (= 3.2.8)
+      mail (~> 2.4.4)
+    actionpack (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activerecord (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    journey (1.0.4)
+    json (1.7.4)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.3.6)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.8)
+      actionmailer (= 3.2.8)
+      actionpack (= 3.2.8)
+      activerecord (= 3.2.8)
+      activeresource (= 3.2.8)
+      activesupport (= 3.2.8)
+      bundler (~> 1.0)
+      railties (= 3.2.8)
+    railties (3.2.8)
+      actionpack (= 3.2.8)
+      activesupport (= 3.2.8)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.6)
+    thor (0.16.0)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  annotate!
+  rails (= 3.2.8)
+  sqlite3

spec/fixtures/rails_32_development.rb

@@ -0,0 +1,9 @@
+TestApp::Application.configure do
+  config.action_dispatch.best_standards_support = :builtin
+  config.active_record.auto_explain_threshold_in_seconds = 0.5
+  config.active_record.mass_assignment_sanitizer = :strict
+  config.active_support.deprecation = :log
+  config.cache_classes = false
+  config.consider_all_requests_local = true
+  config.whiny_nils = true
+end