migration_test_helper 1.3.2 → 1.3.3

data/Manifest.txt

@@ -0,0 +1,39 @@
+.
+./generators
+./generators/full_migration_test
+./generators/full_migration_test/full_migration_test_generator.rb
+./generators/full_migration_test/templates
+./generators/full_migration_test/templates/full_migration_test.rb
+./generators/full_migration_test/USAGE
+./generators/migration_test
+./generators/migration_test/migration_test_generator.rb
+./generators/migration_test/templates
+./generators/migration_test/templates/migration_test.rb
+./init.rb
+./install.rb
+./lib
+./lib/migration_test_helper.rb
+./LICENSE
+./Manifest.txt
+./Rakefile
+./README
+./tasks
+./tasks/migration_test_helper_tasks.rake
+./test
+./test/config
+./test/config/database.yml
+./test/db
+./test/db/migrate_bad
+./test/db/migrate_bad/001_create_top_dogs.rb
+./test/db/migrate_good
+./test/db/migrate_good/001_create_top_dogs.rb
+./test/db/migrate_good/002_create_bottom_dogs.rb
+./test/db/migrate_good/003_create_cats.rb
+./test/db/schema.rb
+./test/foundry_only_helper.rb
+./test/full_migration_test_generator_test.rb
+./test/helper.rb
+./test/log
+./test/migration_test_generator_test.rb
+./test/migration_test_helper_test.rb
+./uninstall.rb

data/README

@@ -41,11 +41,12 @@ If you're using it outside of a Rails environment (for whatever reason) include
         t.column :book_id, :integer
         t.column :body,    :text
         t.column :rating,  :integer, :default => 0
+        t.index  :book_id, :name => 'index_book_id_on_reviews'
       end
     end
   end
 
-This would verify there are only two tables defined in the test database: _books_ and _reviews_ (schema_info is ignored).  It will also verify that the _book_ table has the three columns, _id_, _title_ and _author_, each with their respective types.
+This would verify there are only two tables defined in the test database: _books_ and _reviews_ (schema_info is ignored).  It will also verify that the _book_ table has the three columns, _id_, _title_ and _author_, each with their respective types. Indexes are verified too.
 
 
 *assert_table*: verify a table is found exactly as specified:
@@ -54,6 +55,7 @@ This would verify there are only two tables defined in the test database: _books
     t.column :id,     :integer
     t.column :title,  :string, :limit => 5
     t.column :author, :string
+    t.index  :author, :name => 'index_author_on_books'
   end
 
 
@@ -101,6 +103,7 @@ By combining the two helpers you can write a test that shows you can run all you
         t.column :book_id, :integer
         t.column :body,    :text
         t.column :rating,  :integer
+        t.index  :book_id, :name => 'index_book_id_on_reviews'
       end
     end
   end

data/Rakefile

@@ -16,7 +16,7 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-GEM_VERSION = '1.3.2'
+GEM_VERSION = '1.3.3'
 
 Hoe.new('migration_test_helper',GEM_VERSION) do |p|
   p.author = "Micah Alles" 
@@ -30,8 +30,6 @@ current state of the schema and executing migrations against the
 test database.
   EOS
 
-  p.gem_files = FileList["{test,lib,tasks}/**/*"] + %w|LICENSE README Rakefile init.rb install.rb uninstall.rb|
-
   p.changes = <<-EOS
 * fixed bug where test:migration was calling itself, thanks Patrick ;)
   EOS
@@ -52,13 +50,13 @@ task :plugin_release do
     status = `svn status` 
     raise "Please clean up before releasing.\n#{status}" unless status == ""
 
-    unless `svn ls svn+ssh://alles@rubyforge.org/var/svn/migrationtest/tags/rel-#{GEM_VERSION} -m`.strip.empty?
-      sh "svn del svn+ssh://alles@rubyforge.org/var/svn/migrationtest/tags/rel-#{GEM_VERSION} -m 'Preparing to update stable release tag'"
+    unless `svn ls svn+ssh://swieton@rubyforge.org/var/svn/migrationtest/tags/rel-#{GEM_VERSION} -m`.strip.empty?
+      sh "svn del svn+ssh://swieton@rubyforge.org/var/svn/migrationtest/tags/rel-#{GEM_VERSION} -m 'Preparing to update stable release tag'"
     end
-    sh "svn cp . svn+ssh://alles@rubyforge.org/var/svn/migrationtest/tags/rel-#{GEM_VERSION} -m 'Releasing version #{GEM_VERSION}'"
-    unless `svn ls svn+ssh://alles@rubyforge.org/var/svn/migrationtest/tags/migration_test_helper`.strip.empty?
-      sh "svn del svn+ssh://alles@rubyforge.org/var/svn/migrationtest/tags/migration_test_helper -m 'Preparing to update stable release tag'"
+    sh "svn cp . svn+ssh://swieton@rubyforge.org/var/svn/migrationtest/tags/rel-#{GEM_VERSION} -m 'Releasing version #{GEM_VERSION}'"
+    unless `svn ls svn+ssh://swieton@rubyforge.org/var/svn/migrationtest/tags/migration_test_helper`.strip.empty?
+      sh "svn del svn+ssh://swieton@rubyforge.org/var/svn/migrationtest/tags/migration_test_helper -m 'Preparing to update stable release tag'"
     end
-    sh "svn cp . svn+ssh://alles@rubyforge.org/var/svn/migrationtest/tags/migration_test_helper -m 'Updating stable tag to version #{GEM_VERSION}'"
+    sh "svn cp . svn+ssh://swieton@rubyforge.org/var/svn/migrationtest/tags/migration_test_helper -m 'Updating stable tag to version #{GEM_VERSION}'"
   end
 end

data/generators/full_migration_test/USAGE

@@ -0,0 +1,30 @@
+Description:
+    The controller generator creates stubs for a new controller and its views.
+
+    The generator takes a controller name and a list of views as arguments.
+    The controller name may be given in CamelCase or under_score and should
+    not be suffixed with 'Controller'.  To create a controller within a
+    module, specify the controller name as 'module/controller'.
+
+    The generator creates a controller class in app/controllers with view
+    templates in app/views/controller_name, a helper class in app/helpers,
+    and a functional test suite in test/functional.
+
+Example:
+    ./script/generate controller CreditCard open debit credit close
+
+    Credit card controller with URLs like /credit_card/debit.
+        Controller: app/controllers/credit_card_controller.rb
+        Views:      app/views/credit_card/debit.rhtml [...]
+        Helper:     app/helpers/credit_card_helper.rb
+        Test:       test/functional/credit_card_controller_test.rb
+
+Modules Example:
+    ./script/generate controller 'admin/credit_card' suspend late_fee
+
+    Credit card admin controller with URLs /admin/credit_card/suspend.
+        Controller: app/controllers/admin/credit_card_controller.rb
+        Views:      app/views/admin/credit_card/debit.rhtml [...]
+        Helper:     app/helpers/admin/credit_card_helper.rb
+        Test:       test/functional/admin/credit_card_controller_test.rb
+

data/generators/full_migration_test/full_migration_test_generator.rb

@@ -0,0 +1,10 @@
+class FullMigrationTestGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+
+      m.directory 'test/migration'
+      m.template 'full_migration_test.rb',
+                 'test/migration/full_migration_test.rb'
+    end
+  end
+end

data/generators/full_migration_test/templates/full_migration_test.rb

@@ -0,0 +1,89 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper') 
+
+#
+# This excercises the full set of migrations for your Rails app.
+# It proves:
+#   - After full migration, the database is in the expected state, including:
+#     - All table structure
+#     - Default data (if any)
+#   - Full downward (version 0) migration functions correctly.
+#
+# YOU NEED TO:
+#   - Update "see_full_schema"
+#   - Update "see_data"
+# 
+class FullMigrationTest < ActionController::IntegrationTest
+
+  # 
+  # Transactional fixtures can, on occasion, cause migration tests to hang.
+  # Applying this setting here will turn transactional fixtures off for THIS
+  # SUITE ONLY
+  #
+  # self.use_transactional_fixtures = false
+
+  def conn
+    ActiveRecord::Base.connection
+  end
+
+  def see_empty_schema
+    assert_schema do |s|
+      # is nothing 
+    end
+  end
+
+  #
+  # Structure and Content assertions
+  #
+
+  # Fully assert db structure after full migration
+  def see_full_schema
+    # TODO: add assertions here to verify your schema was built
+    flunk "implement me"
+    
+    #
+    # Something like this can be used to see the entire schema
+    # is as expeted.
+    #
+    # assert_schema do |s|
+    #   s.table :cat_tails do |t|
+    #     t.column :id,    :integer
+    #     t.column :name,  :string
+    #   end
+    #
+    #   s.table :dogs do |t|
+    #     t.column :id,    :integer
+    #     t.column :name,  :string
+    #   end
+    # end
+
+    #
+    # Alternatively individual tables can be checked.
+    #
+    # assert_table :cats_tails do |s|
+    #   t.column :id,    :integer
+    #   t.column :name,  :string
+    # end
+  end
+
+  # Make sure data you expect your migrations to load are in there:
+  def see_default_data
+    # TODO: add assertions here to verify any default data was loaded
+  end
+
+  #
+  # TESTS
+  #
+
+  def test_full_migration
+    drop_all_tables
+    
+    see_empty_schema
+
+    migrate
+
+    see_full_schema
+
+    see_default_data
+  end
+
+end

data/generators/migration_test/migration_test_generator.rb

@@ -0,0 +1,33 @@
+class MigrationTestGenerator < Rails::Generator::NamedBase
+  def manifest
+    schema_version = class_name.to_i
+    raise "Invalid schema version '#{class_name}'" unless schema_version > 0
+
+    schema_version_string = schema_version.to_s.rjust(3,'0')
+
+    migration = Dir["db/migrate/#{schema_version_string}*.rb"].first
+    raise "No migration found for schema version #{schema_version_string}" unless migration
+
+    migration_name = File.basename(migration,'.rb').sub(/^\d+_/,'')
+    test_class_name = migration_name.camelize + "Test"
+    test_file = "test/migration/#{schema_version_string}_#{migration_name}_test.rb"
+
+    record do |m|
+      m.directory 'test/migration'
+      m.template 'migration_test.rb', test_file, :assigns => {
+        :test_class_name => test_class_name,
+        :migration_name => migration_name,
+        :schema_version => schema_version,
+        :previous_schema_version => previous_schema_version(schema_version_string)
+      }
+    end
+  end
+
+  def previous_schema_version(current_version_string)
+    versions = Dir["db/migrate/*.rb"].map do |migration_file| 
+      migration_file.match(/db\/migrate\/(\d+)_.*\.rb/)[1]
+    end.sort
+    prev_index = versions.index(current_version_string) - 1
+    prev_index < 0 ? -1 : versions[prev_index].to_i
+  end
+end

data/generators/migration_test/templates/migration_test.rb

@@ -0,0 +1,25 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper') 
+
+class <%= test_class_name %> < Test::Unit::TestCase
+ 
+  def teardown
+    migrate
+  end
+
+  def test_migration_should_<%= migration_name %>
+    drop_all_tables
+
+    migrate :version => <%= previous_schema_version %>
+
+    flunk "TODO: setup test data"
+
+    migrate :version => <%= schema_version %>
+
+    flunk "TODO: examine results"
+
+    migrate :version => <%= previous_schema_version %>
+
+    flunk "TODO: examine results"
+  end
+
+end

data/lib/migration_test_helper.rb

@@ -114,7 +114,7 @@ module MigrationTestHelper
     end
 
     def verify #:nodoc:
-      actual_tables = conn.tables.reject {|t| t == 'schema_info' }
+      actual_tables = conn.tables.reject {|t| t == 'schema_info' || t == 'schema_migrations' }
       expected_tables = @tables.map {|t| t.name }
       assert_equal expected_tables.sort, actual_tables.sort, 'wrong tables in schema'
     end
@@ -128,6 +128,7 @@ module MigrationTestHelper
     def initialize(name) #:nodoc:
       @name = name.to_s
       @columns = []
+      @indexes = []
       assert conn.tables.include?(@name), "table <#{@name}> not found in schema"
     end
 
@@ -138,14 +139,21 @@ module MigrationTestHelper
       assert_not_nil col, "column <#{colname}> not found in table <#{self.name}>"
       assert_equal type, col.type, "wrong type for column <#{colname}> in table <#{name}>"
       options.each do |k,v|
-        k = k.to_sym
-        assert_equal v, col.send(k), "column <#{colname}> in table <#{name}> has wrong :#{k}"
+        k = k.to_sym; actual = col.send(k); actual = actual.is_a?(String) ? actual.sub(/'$/,'').sub(/^'/,'') : actual
+        assert_equal v, actual, "column <#{colname}> in table <#{name}> has wrong :#{k}"
       end
     end
 
+    def index(column_name, options = {})
+      @indexes << "name <#{options[:name]}> columns <#{Array(column_name).join(",")}> unique <#{options[:unique] == true}>" 
+    end
+
     def verify #:nodoc:
       actual_columns = conn.columns(name).map {|c| c.name }
       assert_equal @columns.sort, actual_columns.sort, "wrong columns for table: <#{name}>"
+
+      actual_indexes = conn.indexes(@name).collect { |i| "name <#{i.name}> columns <#{i.columns.join(",")}> unique <#{i.unique}>" }
+      assert_equal @indexes.sort, actual_indexes.sort, "wrong indexes for table: <#{name}>"
     end
   end
 end

data/test/db/schema.rb

@@ -2,4 +2,5 @@ ActiveRecord::Schema.define(:version => 1) do
   create_table "dogs", :force => true do |t|
     t.column "tail", :string, :default => 'top dog', :limit => 187
   end
+  add_index :dogs, :tail, :name => 'index_tail_on_dogs'
 end

data/test/foundry_only_helper.rb

@@ -12,6 +12,4 @@ class Test::Unit::TestCase
     should(behave,&block) if running_in_foundry
   end
 
-  def test_PLACEHOLDER; end
-
 end

data/test/migration_test_generator_test.rb

@@ -20,15 +20,17 @@ class MigrationTestGeneratorTest < Test::Unit::TestCase
   # HELPERS
   #
 
-  def generate_migration(expected_version, name)
+  def generate_migration(name)
     run_in_rails_root "script/generate migration #{name}"
-    migration_file = "db/migrate/#{expected_version}_#{name}.rb"
+    @output =~ /create  db\/migrate\/(\d+)_.*\.rb/
+    migration = $1
+    migration_file = "db/migrate/#{migration}_#{name}.rb"
     assert File.exists?(migration_file), "Migration not there: #{migration_file}"
+    migration
   end
 
   def generate_migration_test(version)
     run_in_rails_root "script/generate migration_test #{version}"
-
   end
 
   def rm_migrations
@@ -40,11 +42,11 @@ class MigrationTestGeneratorTest < Test::Unit::TestCase
   #
   
   in_foundry_should "generate a migration test for schema 1" do
-    generate_migration '001', 'create_the_dogs_table'
+    migration = generate_migration 'create_the_dogs_table'
 
-    generate_migration_test '1'
+    generate_migration_test migration
 
-    migration_test_file = "test/migration/001_create_the_dogs_table_test.rb"
+    migration_test_file = "test/migration/#{migration}_create_the_dogs_table_test.rb"
     assert File.exists?(migration_test_file), "Migration test not there: #{migration_test_file}"
 
     run_in_rails_root "ruby #{migration_test_file}"
@@ -55,10 +57,10 @@ class MigrationTestGeneratorTest < Test::Unit::TestCase
   end
 
   in_foundry_should "generate a migration test for schema 2" do
-    generate_migration '001', 'create_the_dogs_table'
-    generate_migration '002', 'transfer_cats_data'
-    generate_migration_test '002'
-    migration_test_file = "test/migration/002_transfer_cats_data_test.rb"
+    generate_migration 'create_the_dogs_table'
+    migration = generate_migration 'transfer_cats_data'
+    generate_migration_test migration
+    migration_test_file = "test/migration/#{migration}_transfer_cats_data_test.rb"
     assert File.exists?(migration_test_file), "Migration test not there: #{migration_test_file}"
 
     run_in_rails_root "ruby #{migration_test_file}"
@@ -69,19 +71,19 @@ class MigrationTestGeneratorTest < Test::Unit::TestCase
   end
 
   in_foundry_should "fail if no schema version is provided" do
-    generate_migration '001', 'create_the_dogs_table'
+    generate_migration 'create_the_dogs_table'
     generate_migration_test ''
     check_output 'Usage: script/generate migration_test MigrationTestName [options]'
   end
 
   in_foundry_should "fail if bad schema version is provided" do
-    generate_migration '001', 'create_the_dogs_table'
+    generate_migration 'create_the_dogs_table'
     generate_migration_test 'oops'
     check_output(/Invalid schema version 'oops'/i)
   end
 
   in_foundry_should "fail if schema version does not correspond to existing migration" do
-    generate_migration '001', 'create_the_dogs_table'
+    migration = generate_migration 'create_the_dogs_table'
     generate_migration_test '2'
     check_output "No migration found for schema version 002"
   end

data/test/migration_test_helper_test.rb

@@ -22,6 +22,11 @@ class MigrationTestHelperTest < Test::Unit::TestCase
       yield
     end
   end
+
+  def declare_columns_on_table(t)
+    t.column :id,   :integer
+    t.column :tail, :string, :default => 'top dog', :limit => 187
+  end
   
   #
   # TESTS
@@ -30,9 +35,10 @@ class MigrationTestHelperTest < Test::Unit::TestCase
     see_no_failure do
       assert_schema do |s|
         s.table :dogs do |t|
-          t.column :id,   :integer
-          t.column :tail, :string, :default => 'top dog', :limit => 187
+	  declare_columns_on_table(t)
+	  t.index :tail, :name => 'index_tail_on_dogs'
         end
+
       end
     end
   end
@@ -88,8 +94,8 @@ class MigrationTestHelperTest < Test::Unit::TestCase
   def test_assert_table_should_not_fail_if_table_is_matched
     see_no_failure do
       assert_table :dogs do |t|
-        t.column :id,   :integer
-        t.column :tail, :string, :default => 'top dog', :limit => 187
+        declare_columns_on_table(t)
+	t.index :tail, :name => 'index_tail_on_dogs'
       end
     end
   end
@@ -129,8 +135,39 @@ class MigrationTestHelperTest < Test::Unit::TestCase
     end
   end
 
+  def test_assert_table_should_fail_if_an_index_is_not_specified
+    see_failure 'wrong indexes for table: <dogs>' do
+      assert_table :dogs do |t|
+        declare_columns_on_table(t)
+      end
+    end
+  end
+
+  def test_assert_schema_should_fail_if_a_column_in_an_index_is_not_found
+    see_failure 'wrong indexes for table: <dogs>' do
+      assert_table :dogs do |t|
+        declare_columns_on_table(t)
+	t.index :legs, :name => 'index_legs_on_dogs'
+      end
+    end
+  end
+
+  def test_assert_schema_should_fail_if_wrong_options_on_an_index
+    see_failure 'wrong indexes for table: <dogs>' do
+      assert_table :dogs do |t|
+        declare_columns_on_table(t)
+	t.index :tail, :name => 'index_tail_on_dogs', :unique => true
+      end
+    end
+  end
+
   def test_should_drop_all_tables
-    assert_equal ['dogs','schema_info'].sort, ActiveRecord::Base.connection.tables.sort
+    if Rails::VERSION::MAJOR >= 2 && Rails::VERSION::MINOR >= 1
+      schema_table = 'schema_migrations'
+    else
+      schema_table = 'schema_info'
+    end
+    assert_equal ['dogs', schema_table].sort, ActiveRecord::Base.connection.tables.sort
     drop_all_tables
     assert_equal [], ActiveRecord::Base.connection.tables
     drop_all_tables

metadata

@@ -1,77 +1,94 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
-specification_version: 1
 name: migration_test_helper
 version: !ruby/object:Gem::Version 
-  version: 1.3.2
-date: 2007-03-31 00:00:00 -04:00
-summary: A Rails plugin for testing migrations
-require_paths: 
-- lib
-email: micah@atomicobject.com
-homepage: http://migrationtest.rubyforge.org
-rubyforge_project: migrationtest
-description: migration_test_helper makes testing your migrations easier by  adding helper methods to Test::Unit::TestCase for asserting the  current state of the schema and executing migrations against the  test database.
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 1.3.3
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Micah Alles
-files: 
-- test/config
-- test/db
-- test/foundry_only_helper.rb
-- test/full_migration_test_generator_test.rb
-- test/helper.rb
-- test/log
-- test/migration_test_generator_test.rb
-- test/migration_test_helper_test.rb
-- test/config/database.yml
-- test/db/migrate_bad
-- test/db/migrate_good
-- test/db/schema.rb
-- test/db/migrate_bad/001_create_top_dogs.rb
-- test/db/migrate_good/001_create_top_dogs.rb
-- test/db/migrate_good/002_create_bottom_dogs.rb
-- test/db/migrate_good/003_create_cats.rb
-- lib/migration_test_helper.rb
-- tasks/migration_test_helper_tasks.rake
-- LICENSE
-- README
-- Rakefile
-- init.rb
-- install.rb
-- uninstall.rb
-test_files: []
-
-rdoc_options: []
-
-extra_rdoc_files: []
-
-executables: []
-
-extensions: []
-
-requirements: []
+autorequire: 
+bindir: bin
+cert_chain: []
 
+date: 2009-12-04 00:00:00 -05:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: hoe
+  type: :development
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.1.7
+        version: 2.3.3
     version: 
+description: |
+  migration_test_helper makes testing your migrations easier by 
+  adding helper methods to Test::Unit::TestCase for asserting the 
+  current state of the schema and executing migrations against the 
+  test database.
+
+email: micah@atomicobject.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- ./Manifest.txt
+files: 
+- ./generators/full_migration_test/full_migration_test_generator.rb
+- ./generators/full_migration_test/templates/full_migration_test.rb
+- ./generators/full_migration_test/USAGE
+- ./generators/migration_test/migration_test_generator.rb
+- ./generators/migration_test/templates/migration_test.rb
+- ./init.rb
+- ./install.rb
+- ./lib/migration_test_helper.rb
+- ./LICENSE
+- ./Manifest.txt
+- ./Rakefile
+- ./README
+- ./tasks/migration_test_helper_tasks.rake
+- ./test/config/database.yml
+- ./test/db/migrate_bad/001_create_top_dogs.rb
+- ./test/db/migrate_good/001_create_top_dogs.rb
+- ./test/db/migrate_good/002_create_bottom_dogs.rb
+- ./test/db/migrate_good/003_create_cats.rb
+- ./test/db/schema.rb
+- ./test/foundry_only_helper.rb
+- ./test/full_migration_test_generator_test.rb
+- ./test/helper.rb
+- ./test/migration_test_generator_test.rb
+- ./test/migration_test_helper_test.rb
+- ./uninstall.rb
+has_rdoc: true
+homepage: http://migrationtest.rubyforge.org
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: migrationtest
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Rails plugin for testing migrations
+test_files: []
+