Refactor migration to move migrations paths to connection

Rails has some support for multiple databases but it can be hard to
handle migrations with those. The easiest way to implement multiple
databases is to contain migrations into their own folder ("db/migrate"
for the primary db and "db/seconddb_migrate" for the second db). Without
this you would need to write code that allowed you to switch connections
in migrations. I can tell you from experience that is not a fun way to
implement multiple databases.

This refactoring is a pre-requisite for implementing other features
related to parallel testing and improved handling for multiple
databases.

The refactoring here moves the class methods from the `Migrator` class
into it's own new class `MigrationContext`. The goal was to move the
`migrations_paths` method off of the `Migrator` class and onto the
connection. This allows users to do the following in their
`database.yml`:

```
development:
  adapter: mysql2
  username: root
  password:

development_seconddb:
  adapter: mysql2
  username: root
  password:
  migrations_paths: "db/second_db_migrate"
```

Migrations for the `seconddb` can now be store in the
`db/second_db_migrate` directory. Migrations for the primary database
are stored in `db/migrate`".

The refactoring here drastically reduces the internal API for migrations
since we don't need to pass `migrations_paths` around to every single
method. Additionally this change does not require any Rails applications
to make changes unless they want to use the new public API. All of the
class methods from the `Migrator` class were `nodoc`'d except for the
`migrations_paths` and `migrations_path` getter/setters respectively.

1 files changed, 83 insertions, 41 deletions

diff --git a/activerecord/test/cases/tasks/database_tasks_test.rb b/activerecord/test/cases/tasks/database_tasks_test.rb
index c114842dec..21226352ff 100644
--- a/activerecord/test/cases/tasks/database_tasks_test.rb
+++ b/activerecord/test/cases/tasks/database_tasks_test.rb
@@ -28,10 +28,10 @@ module ActiveRecord
 
   class DatabaseTasksUtilsTask < ActiveRecord::TestCase
     def test_raises_an_error_when_called_with_protected_environment
-      ActiveRecord::Migrator.stubs(:current_version).returns(1)
+      ActiveRecord::MigrationContext.any_instance.stubs(:current_version).returns(1)
 
       protected_environments = ActiveRecord::Base.protected_environments
-      current_env            = ActiveRecord::Migrator.current_environment
+      current_env            = ActiveRecord::Base.connection.migration_context.current_environment
       assert_not_includes protected_environments, current_env
       # Assert no error
       ActiveRecord::Tasks::DatabaseTasks.check_protected_environments!
@@ -45,10 +45,10 @@ module ActiveRecord
     end
 
     def test_raises_an_error_when_called_with_protected_environment_which_name_is_a_symbol
-      ActiveRecord::Migrator.stubs(:current_version).returns(1)
+      ActiveRecord::MigrationContext.any_instance.stubs(:current_version).returns(1)
 
       protected_environments = ActiveRecord::Base.protected_environments
-      current_env            = ActiveRecord::Migrator.current_environment
+      current_env            = ActiveRecord::Base.connection.migration_context.current_environment
       assert_not_includes protected_environments, current_env
       # Assert no error
       ActiveRecord::Tasks::DatabaseTasks.check_protected_environments!
@@ -63,7 +63,7 @@ module ActiveRecord
 
     def test_raises_an_error_if_no_migrations_have_been_made
       ActiveRecord::InternalMetadata.stubs(:table_exists?).returns(false)
-      ActiveRecord::Migrator.stubs(:current_version).returns(1)
+      ActiveRecord::MigrationContext.any_instance.stubs(:current_version).returns(1)
 
       assert_raise(ActiveRecord::NoEnvironmentInSchemaError) do
         ActiveRecord::Tasks::DatabaseTasks.check_protected_environments!
@@ -347,50 +347,92 @@ module ActiveRecord
     end
   end
 
-  class DatabaseTasksMigrateTest < ActiveRecord::TestCase
-    self.use_transactional_tests = false
+  if current_adapter?(:SQLite3Adapter) && !in_memory_db?
+    class DatabaseTasksMigrateTest < ActiveRecord::TestCase
+      self.use_transactional_tests = false
+
+      # Use a memory db here to avoid having to rollback at the end
+      setup do
+        migrations_path = MIGRATIONS_ROOT + "/valid"
+        file = ActiveRecord::Base.connection.raw_connection.filename
+        @conn = ActiveRecord::Base.establish_connection adapter: "sqlite3",
+          database: ":memory:", migrations_paths: migrations_path
+        source_db = SQLite3::Database.new file
+        dest_db = ActiveRecord::Base.connection.raw_connection
+        backup = SQLite3::Backup.new(dest_db, "main", source_db, "main")
+        backup.step(-1)
+        backup.finish
+      end
 
-    def setup
-      ActiveRecord::Tasks::DatabaseTasks.migrations_paths = "custom/path"
-    end
+      teardown do
+        @conn.release_connection if @conn
+        ActiveRecord::Base.establish_connection :arunit
+      end
 
-    def teardown
-      ActiveRecord::Tasks::DatabaseTasks.migrations_paths = nil
-    end
+      def test_migrate_set_and_unset_verbose_and_version_env_vars
+        verbose, version = ENV["VERBOSE"], ENV["VERSION"]
+        ENV["VERSION"] = "2"
+        ENV["VERBOSE"] = "false"
 
-    def test_migrate_receives_correct_env_vars
-      verbose, version = ENV["VERBOSE"], ENV["VERSION"]
+        # run down migration because it was already run on copied db
+        assert_empty capture_migration_output
 
-      ENV["VERBOSE"] = "false"
-      ENV["VERSION"] = "4"
-      ActiveRecord::Migrator.expects(:migrate).with("custom/path", 4)
-      ActiveRecord::Migration.expects(:verbose=).with(false)
-      ActiveRecord::Migration.expects(:verbose=).with(ActiveRecord::Migration.verbose)
-      ActiveRecord::Tasks::DatabaseTasks.migrate
+        ENV.delete("VERSION")
+        ENV.delete("VERBOSE")
 
-      ENV.delete("VERBOSE")
-      ENV.delete("VERSION")
-      ActiveRecord::Migrator.expects(:migrate).with("custom/path", nil)
-      ActiveRecord::Migration.expects(:verbose=).with(true)
-      ActiveRecord::Migration.expects(:verbose=).with(ActiveRecord::Migration.verbose)
-      ActiveRecord::Tasks::DatabaseTasks.migrate
+        # re-run up migration
+        assert_includes capture_migration_output, "migrating"
+      ensure
+        ENV["VERBOSE"], ENV["VERSION"] = verbose, version
+      end
 
-      ENV["VERBOSE"] = ""
-      ENV["VERSION"] = ""
-      ActiveRecord::Migrator.expects(:migrate).with("custom/path", nil)
-      ActiveRecord::Migration.expects(:verbose=).with(true)
-      ActiveRecord::Migration.expects(:verbose=).with(ActiveRecord::Migration.verbose)
-      ActiveRecord::Tasks::DatabaseTasks.migrate
+      def test_migrate_set_and_unset_empty_values_for_verbose_and_version_env_vars
+        verbose, version = ENV["VERBOSE"], ENV["VERSION"]
 
-      ENV["VERBOSE"] = "yes"
-      ENV["VERSION"] = "0"
-      ActiveRecord::Migrator.expects(:migrate).with("custom/path", 0)
-      ActiveRecord::Migration.expects(:verbose=).with(true)
-      ActiveRecord::Migration.expects(:verbose=).with(ActiveRecord::Migration.verbose)
-      ActiveRecord::Tasks::DatabaseTasks.migrate
-    ensure
-      ENV["VERBOSE"], ENV["VERSION"] = verbose, version
+        ENV["VERSION"] = "2"
+        ENV["VERBOSE"] = "false"
+
+        # run down migration because it was already run on copied db
+        assert_empty capture_migration_output
+
+        ENV["VERBOSE"] = ""
+        ENV["VERSION"] = ""
+
+        # re-run up migration
+        assert_includes capture_migration_output, "migrating"
+      ensure
+        ENV["VERBOSE"], ENV["VERSION"] = verbose, version
+      end
+
+      def test_migrate_set_and_unset_nonsense_values_for_verbose_and_version_env_vars
+        verbose, version = ENV["VERBOSE"], ENV["VERSION"]
+
+        # run down migration because it was already run on copied db
+        ENV["VERSION"] = "2"
+        ENV["VERBOSE"] = "false"
+
+        assert_empty capture_migration_output
+
+        ENV["VERBOSE"] = "yes"
+        ENV["VERSION"] = "2"
+
+        # run no migration because 2 was already run
+        assert_empty capture_migration_output
+      ensure
+        ENV["VERBOSE"], ENV["VERSION"] = verbose, version
+      end
+
+      private
+        def capture_migration_output
+          capture(:stdout) do
+            ActiveRecord::Tasks::DatabaseTasks.migrate
+          end
+        end
     end
+  end
+
+  class DatabaseTasksMigrateErrorTest < ActiveRecord::TestCase
+    self.use_transactional_tests = false
 
     def test_migrate_raise_error_on_invalid_version_format
       version = ENV["VERSION"]