Merge pull request #7564 from kennyj/using_mysqldump

Use mysqldump native commands when rake db:structure:dump. Closes #5547
Fixes database tasks config to use encoding instead of charset.

activerecord/CHANGELOG.md

 ## Rails 4.0.0 (unreleased) ##
 
+*   Use native `mysqldump` command instead of `structure_dump` method
+    when dumping the database structure to a sql file. Fixes #5547.
+
+    *kennyj*
+
 *   Attribute predicate methods, such as `article.title?`, will now raise
     `ActiveModel::MissingAttributeError` if the attribute being queried for
     truthiness was not read from the database, instead of just returning false.

activerecord/lib/active_record/tasks/mysql_database_tasks.rb

@@ -27,7 +27,7 @@ def create
       rescue error_class => error
         $stderr.puts error.error
         $stderr.puts "Couldn't create database for #{configuration.inspect}, #{creation_options.inspect}"
-        $stderr.puts "(If you set the charset manually, make sure you have a matching collation)" if configuration['charset']
+        $stderr.puts "(If you set the charset manually, make sure you have a matching collation)" if configuration['encoding']
       end
 
       def drop
@@ -49,19 +49,17 @@ def collation
       end
 
       def structure_dump(filename)
-        establish_connection configuration
-        File.open(filename, "w:utf-8") { |f| f << ActiveRecord::Base.connection.structure_dump }
+        args = prepare_command_options('mysqldump')
+        args.concat(["--result-file", "#{filename}"])
+        args.concat(["--no-data"])
+        args.concat(["#{configuration['database']}"])
+        Kernel.system(*args)
       end
 
       def structure_load(filename)
-        args = ['mysql']
-        args.concat(['--user', configuration['username']]) if configuration['username']
-        args << "--password=#{configuration['password']}" if configuration['password']
-        args.concat(['--default-character-set', configuration['charset']]) if configuration['charset']
-        configuration.slice('host', 'port', 'socket', 'database').each do |k, v|
-          args.concat([ "--#{k}", v ]) if v
-        end
+        args = prepare_command_options('mysql')
         args.concat(['--execute', %{SET FOREIGN_KEY_CHECKS = 0; SOURCE #{filename}; SET FOREIGN_KEY_CHECKS = 1}])
+        args.concat(["--database", "#{configuration['database']}"])
         Kernel.system(*args)
       end
 
@@ -77,7 +75,7 @@ def configuration_without_database
 
       def creation_options
         {
-          charset:   (configuration['charset']   || DEFAULT_CHARSET),
+          charset:   (configuration['encoding']   || DEFAULT_CHARSET),
           collation: (configuration['collation'] || DEFAULT_COLLATION)
         }
       end
@@ -113,6 +111,18 @@ def root_password
         $stdout.print "Please provide the root password for your mysql installation\n>"
         $stdin.gets.strip
       end
+
+      def prepare_command_options(command)
+        args = [command]
+        args.concat(['--user', configuration['username']]) if configuration['username']
+        args << "--password=#{configuration['password']}"  if configuration['password']
+        args.concat(['--default-character-set', configuration['encoding']]) if configuration['encoding']
+        configuration.slice('host', 'port', 'socket').each do |k, v|
+          args.concat([ "--#{k}", v ]) if v
+        end
+        args
+      end
+
     end
   end
 end

activerecord/test/cases/tasks/mysql_rake_test.rb

@@ -32,7 +32,7 @@ def test_creates_database_with_given_options
         with('my-app-db', {:charset => 'latin', :collation => 'latin_ci'})
 
       ActiveRecord::Tasks::DatabaseTasks.create @configuration.merge(
-        'charset' => 'latin', 'collation' => 'latin_ci'
+        'encoding' => 'latin', 'collation' => 'latin_ci'
       )
     end
 
@@ -176,7 +176,7 @@ def test_recreates_database_with_the_given_options
         with('test-db', {:charset => 'latin', :collation => 'latin_ci'})
 
       ActiveRecord::Tasks::DatabaseTasks.purge @configuration.merge(
-        'charset' => 'latin', 'collation' => 'latin_ci'
+        'encoding' => 'latin', 'collation' => 'latin_ci'
       )
     end
   end
@@ -219,44 +219,31 @@ def test_db_retrieves_collation
 
   class MySQLStructureDumpTest < ActiveRecord::TestCase
     def setup
-      @connection    = stub(:structure_dump => true)
       @configuration = {
         'adapter'  => 'mysql',
         'database' => 'test-db'
       }
-
-      ActiveRecord::Base.stubs(:connection).returns(@connection)
-      ActiveRecord::Base.stubs(:establish_connection).returns(true)
     end
 
     def test_structure_dump
       filename = "awesome-file.sql"
-      ActiveRecord::Base.expects(:establish_connection).with(@configuration)
-      @connection.expects(:structure_dump)
+      Kernel.expects(:system).with("mysqldump", "--result-file", filename, "--no-data", "test-db")
 
       ActiveRecord::Tasks::DatabaseTasks.structure_dump(@configuration, filename)
-      assert File.exists?(filename)
-    ensure
-      FileUtils.rm(filename)
     end
   end
 
   class MySQLStructureLoadTest < ActiveRecord::TestCase
     def setup
-      @connection    = stub
       @configuration = {
         'adapter'  => 'mysql',
         'database' => 'test-db'
       }
-
-      ActiveRecord::Base.stubs(:connection).returns(@connection)
-      ActiveRecord::Base.stubs(:establish_connection).returns(true)
-      Kernel.stubs(:system)
     end
 
     def test_structure_load
       filename = "awesome-file.sql"
-      Kernel.expects(:system).with('mysql', '--database', 'test-db', '--execute', %{SET FOREIGN_KEY_CHECKS = 0; SOURCE #{filename}; SET FOREIGN_KEY_CHECKS = 1})
+      Kernel.expects(:system).with('mysql', '--execute', %{SET FOREIGN_KEY_CHECKS = 0; SOURCE #{filename}; SET FOREIGN_KEY_CHECKS = 1}, "--database", "test-db")
 
       ActiveRecord::Tasks::DatabaseTasks.structure_load(@configuration, filename)
     end