activerecord 5.0.7.2 → 6.1.1

data/lib/active_record/tasks/mysql_database_tasks.rb

@@ -1,48 +1,35 @@
+# frozen_string_literal: true
+
 module ActiveRecord
   module Tasks # :nodoc:
     class MySQLDatabaseTasks # :nodoc:
-      ACCESS_DENIED_ERROR = 1045
+      ER_DB_CREATE_EXISTS = 1007
 
       delegate :connection, :establish_connection, to: ActiveRecord::Base
 
-      def initialize(configuration)
-        @configuration = configuration
+      def self.using_database_configurations?
+        true
+      end
+
+      def initialize(db_config)
+        @db_config = db_config
+        @configuration_hash = db_config.configuration_hash
       end
 
       def create
-        establish_connection configuration_without_database
-        connection.create_database configuration['database'], creation_options
-        establish_connection configuration
-      rescue ActiveRecord::StatementInvalid => error
-        if /database exists/ === error.message
-          raise DatabaseAlreadyExists
-        else
-          raise
-        end
-      rescue error_class => error
-        if error.respond_to?(:errno) && error.errno == ACCESS_DENIED_ERROR
-          $stdout.print error.message
-          establish_connection root_configuration_without_database
-          connection.create_database configuration['database'], creation_options
-          if configuration['username'] != 'root'
-            connection.execute grant_statement.gsub(/\s+/, ' ').strip
-          end
-          establish_connection configuration
-        else
-          $stderr.puts error.inspect
-          $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['encoding']
-        end
+        establish_connection(configuration_hash_without_database)
+        connection.create_database(db_config.database, creation_options)
+        establish_connection(db_config)
       end
 
       def drop
-        establish_connection configuration
-        connection.drop_database configuration['database']
+        establish_connection(db_config)
+        connection.drop_database(db_config.database)
       end
 
       def purge
-        establish_connection configuration
-        connection.recreate_database configuration['database'], creation_options
+        establish_connection(db_config)
+        connection.recreate_database(db_config.database, creation_options)
       end
 
       def charset
@@ -53,99 +40,74 @@ module ActiveRecord
         connection.collation
       end
 
-      def structure_dump(filename)
+      def structure_dump(filename, extra_flags)
         args = prepare_command_options
         args.concat(["--result-file", "#{filename}"])
         args.concat(["--no-data"])
         args.concat(["--routines"])
-        args.concat(["#{configuration['database']}"])
+        args.concat(["--skip-comments"])
 
-        run_cmd('mysqldump', args, 'dumping')
-      end
+        ignore_tables = ActiveRecord::SchemaDumper.ignore_tables
+        if ignore_tables.any?
+          args += ignore_tables.map { |table| "--ignore-table=#{db_config.database}.#{table}" }
+        end
 
-      def structure_load(filename)
-        args = prepare_command_options
-        args.concat(['--execute', %{SET FOREIGN_KEY_CHECKS = 0; SOURCE #{filename}; SET FOREIGN_KEY_CHECKS = 1}])
-        args.concat(["--database", "#{configuration['database']}"])
+        args.concat([db_config.database.to_s])
+        args.unshift(*extra_flags) if extra_flags
 
-        run_cmd('mysql', args, 'loading')
+        run_cmd("mysqldump", args, "dumping")
       end
 
-      private
+      def structure_load(filename, extra_flags)
+        args = prepare_command_options
+        args.concat(["--execute", %{SET FOREIGN_KEY_CHECKS = 0; SOURCE #{filename}; SET FOREIGN_KEY_CHECKS = 1}])
+        args.concat(["--database", db_config.database.to_s])
+        args.unshift(*extra_flags) if extra_flags
 
-      def configuration
-        @configuration
+        run_cmd("mysql", args, "loading")
       end
 
-      def configuration_without_database
-        configuration.merge('database' => nil)
-      end
+      private
+        attr_reader :db_config, :configuration_hash
 
-      def creation_options
-        Hash.new.tap do |options|
-          options[:charset]     = configuration['encoding']   if configuration.include? 'encoding'
-          options[:collation]   = configuration['collation']  if configuration.include? 'collation'
+        def configuration_hash_without_database
+          configuration_hash.merge(database: nil)
         end
-      end
 
-      def error_class
-        if configuration['adapter'] =~ /jdbc/
-          require 'active_record/railties/jdbcmysql_error'
-          ArJdbcMySQL::Error
-        elsif defined?(Mysql2)
-          Mysql2::Error
-        else
-          StandardError
+        def creation_options
+          Hash.new.tap do |options|
+            options[:charset]     = configuration_hash[:encoding]   if configuration_hash.include?(:encoding)
+            options[:collation]   = configuration_hash[:collation]  if configuration_hash.include?(:collation)
+          end
         end
-      end
-
-      def grant_statement
-        <<-SQL
-GRANT ALL PRIVILEGES ON #{configuration['database']}.*
-  TO '#{configuration['username']}'@'localhost'
-IDENTIFIED BY '#{configuration['password']}' WITH GRANT OPTION;
-        SQL
-      end
-
-      def root_configuration_without_database
-        configuration_without_database.merge(
-          'username' => 'root',
-          'password' => root_password
-        )
-      end
-
-      def root_password
-        $stdout.print "Please provide the root password for your MySQL installation\n>"
-        $stdin.gets.strip
-      end
 
-      def prepare_command_options
-        args = {
-          'host'      => '--host',
-          'port'      => '--port',
-          'socket'    => '--socket',
-          'username'  => '--user',
-          'password'  => '--password',
-          'encoding'  => '--default-character-set',
-          'sslca'     => '--ssl-ca',
-          'sslcert'   => '--ssl-cert',
-          'sslcapath' => '--ssl-capath',
-          'sslcipher' => '--ssl-cipher',
-          'sslkey'    => '--ssl-key'
-        }.map { |opt, arg| "#{arg}=#{configuration[opt]}" if configuration[opt] }.compact
-
-        args
-      end
+        def prepare_command_options
+          args = {
+            host:      "--host",
+            port:      "--port",
+            socket:    "--socket",
+            username:  "--user",
+            password:  "--password",
+            encoding:  "--default-character-set",
+            sslca:     "--ssl-ca",
+            sslcert:   "--ssl-cert",
+            sslcapath: "--ssl-capath",
+            sslcipher: "--ssl-cipher",
+            sslkey:    "--ssl-key"
+          }.map { |opt, arg| "#{arg}=#{configuration_hash[opt]}" if configuration_hash[opt] }.compact
+
+          args
+        end
 
-      def run_cmd(cmd, args, action)
-        fail run_cmd_error(cmd, args, action) unless Kernel.system(cmd, *args)
-      end
+        def run_cmd(cmd, args, action)
+          fail run_cmd_error(cmd, args, action) unless Kernel.system(cmd, *args)
+        end
 
-      def run_cmd_error(cmd, args, action)
-        msg = "failed to execute: `#{cmd}`\n"
-        msg << "Please check the output above for any errors and make sure that `#{cmd}` is installed in your PATH and has proper permissions.\n\n"
-        msg
-      end
+        def run_cmd_error(cmd, args, action)
+          msg = +"failed to execute: `#{cmd}`\n"
+          msg << "Please check the output above for any errors and make sure that `#{cmd}` is installed in your PATH and has proper permissions.\n\n"
+          msg
+        end
     end
   end
 end

data/lib/active_record/tasks/postgresql_database_tasks.rb

@@ -1,31 +1,35 @@
+# frozen_string_literal: true
+
+require "tempfile"
+
 module ActiveRecord
   module Tasks # :nodoc:
     class PostgreSQLDatabaseTasks # :nodoc:
-      DEFAULT_ENCODING = ENV['CHARSET'] || 'utf8'
+      DEFAULT_ENCODING = ENV["CHARSET"] || "utf8"
+      ON_ERROR_STOP_1 = "ON_ERROR_STOP=1"
+      SQL_COMMENT_BEGIN = "--"
 
       delegate :connection, :establish_connection, :clear_active_connections!,
         to: ActiveRecord::Base
 
-      def initialize(configuration)
-        @configuration = configuration
+      def self.using_database_configurations?
+        true
+      end
+
+      def initialize(db_config)
+        @db_config = db_config
+        @configuration_hash = db_config.configuration_hash
       end
 
       def create(master_established = false)
         establish_master_connection unless master_established
-        connection.create_database configuration['database'],
-          configuration.merge('encoding' => encoding)
-        establish_connection configuration
-      rescue ActiveRecord::StatementInvalid => error
-        if error.cause.is_a?(PG::DuplicateDatabase)
-          raise DatabaseAlreadyExists
-        else
-          raise
-        end
+        connection.create_database(db_config.database, configuration_hash.merge(encoding: encoding))
+        establish_connection(db_config)
       end
 
       def drop
         establish_master_connection
-        connection.drop_database configuration['database']
+        connection.drop_database(db_config.database)
       end
 
       def charset
@@ -42,69 +46,93 @@ module ActiveRecord
         create true
       end
 
-      def structure_dump(filename)
+      def structure_dump(filename, extra_flags)
         set_psql_env
 
-        search_path = case ActiveRecord::Base.dump_schemas
-        when :schema_search_path
-          configuration['schema_search_path']
-        when :all
-          nil
-        when String
-          ActiveRecord::Base.dump_schemas
-        end
+        search_path = \
+          case ActiveRecord::Base.dump_schemas
+          when :schema_search_path
+            configuration_hash[:schema_search_path]
+          when :all
+            nil
+          when String
+            ActiveRecord::Base.dump_schemas
+          end
 
-        args = ['-s', '-x', '-O', '-f', filename]
+        args = ["--schema-only", "--no-privileges", "--no-owner", "--file", filename]
+        args.concat(Array(extra_flags)) if extra_flags
         unless search_path.blank?
-          args += search_path.split(',').map do |part|
+          args += search_path.split(",").map do |part|
             "--schema=#{part.strip}"
           end
         end
-        args << configuration['database']
-        run_cmd('pg_dump', args, 'dumping')
+
+        ignore_tables = ActiveRecord::SchemaDumper.ignore_tables
+        if ignore_tables.any?
+          args += ignore_tables.flat_map { |table| ["-T", table] }
+        end
+
+        args << db_config.database
+        run_cmd("pg_dump", args, "dumping")
+        remove_sql_header_comments(filename)
         File.open(filename, "a") { |f| f << "SET search_path TO #{connection.schema_search_path};\n\n" }
       end
 
-      def structure_load(filename)
+      def structure_load(filename, extra_flags)
         set_psql_env
-        args = [ '-q', '-f', filename, configuration['database'] ]
-        run_cmd('psql', args, 'loading' )
+        args = ["--set", ON_ERROR_STOP_1, "--quiet", "--no-psqlrc", "--file", filename]
+        args.concat(Array(extra_flags)) if extra_flags
+        args << db_config.database
+        run_cmd("psql", args, "loading")
       end
 
       private
+        attr_reader :db_config, :configuration_hash
 
-      def configuration
-        @configuration
-      end
+        def encoding
+          configuration_hash[:encoding] || DEFAULT_ENCODING
+        end
 
-      def encoding
-        configuration['encoding'] || DEFAULT_ENCODING
-      end
+        def establish_master_connection
+          establish_connection configuration_hash.merge(
+            database: "postgres",
+            schema_search_path: "public"
+          )
+        end
 
-      def establish_master_connection
-        establish_connection configuration.merge(
-          'database'           => 'postgres',
-          'schema_search_path' => 'public'
-        )
-      end
+        def set_psql_env
+          ENV["PGHOST"]     = db_config.host                     if db_config.host
+          ENV["PGPORT"]     = configuration_hash[:port].to_s     if configuration_hash[:port]
+          ENV["PGPASSWORD"] = configuration_hash[:password].to_s if configuration_hash[:password]
+          ENV["PGUSER"]     = configuration_hash[:username].to_s if configuration_hash[:username]
+        end
 
-      def set_psql_env
-        ENV['PGHOST']     = configuration['host']          if configuration['host']
-        ENV['PGPORT']     = configuration['port'].to_s     if configuration['port']
-        ENV['PGPASSWORD'] = configuration['password'].to_s if configuration['password']
-        ENV['PGUSER']     = configuration['username'].to_s if configuration['username']
-      end
+        def run_cmd(cmd, args, action)
+          fail run_cmd_error(cmd, args, action) unless Kernel.system(cmd, *args)
+        end
 
-      def run_cmd(cmd, args, action)
-        fail run_cmd_error(cmd, args, action) unless Kernel.system(cmd, *args)
-      end
+        def run_cmd_error(cmd, args, action)
+          msg = +"failed to execute:\n"
+          msg << "#{cmd} #{args.join(' ')}\n\n"
+          msg << "Please check the output above for any errors and make sure that `#{cmd}` is installed in your PATH and has proper permissions.\n\n"
+          msg
+        end
 
-      def run_cmd_error(cmd, args, action)
-        msg = "failed to execute:\n"
-        msg << "#{cmd} #{args.join(' ')}\n\n"
-        msg << "Please check the output above for any errors and make sure that `#{cmd}` is installed in your PATH and has proper permissions.\n\n"
-        msg
-      end
+        def remove_sql_header_comments(filename)
+          removing_comments = true
+          tempfile = Tempfile.open("uncommented_structure.sql")
+          begin
+            File.foreach(filename) do |line|
+              unless removing_comments && (line.start_with?(SQL_COMMENT_BEGIN) || line.blank?)
+                tempfile << line
+                removing_comments = false
+              end
+            end
+          ensure
+            tempfile.close
+          end
+          FileUtils.cp(tempfile.path, filename)
+        end
     end
   end
 end

data/lib/active_record/tasks/sqlite_database_tasks.rb

@@ -1,27 +1,34 @@
+# frozen_string_literal: true
+
 module ActiveRecord
   module Tasks # :nodoc:
     class SQLiteDatabaseTasks # :nodoc:
       delegate :connection, :establish_connection, to: ActiveRecord::Base
 
-      def initialize(configuration, root = ActiveRecord::Tasks::DatabaseTasks.root)
-        @configuration, @root = configuration, root
+      def self.using_database_configurations?
+        true
+      end
+
+      def initialize(db_config, root = ActiveRecord::Tasks::DatabaseTasks.root)
+        @db_config = db_config
+        @root = root
       end
 
       def create
-        raise DatabaseAlreadyExists if File.exist?(configuration['database'])
+        raise DatabaseAlreadyExists if File.exist?(db_config.database)
 
-        establish_connection configuration
+        establish_connection(db_config)
         connection
       end
 
       def drop
-        require 'pathname'
-        path = Pathname.new configuration['database']
+        require "pathname"
+        path = Pathname.new(db_config.database)
         file = path.absolute? ? path.to_s : File.join(root, path)
 
         FileUtils.rm(file)
       rescue Errno::ENOENT => error
-        raise NoDatabaseError.new(error.message, error)
+        raise NoDatabaseError.new(error.message)
       end
 
       def purge
@@ -35,25 +42,39 @@ module ActiveRecord
         connection.encoding
       end
 
-      def structure_dump(filename)
-        dbfile = configuration['database']
-        `sqlite3 #{dbfile} .schema > #{filename}`
+      def structure_dump(filename, extra_flags)
+        args = []
+        args.concat(Array(extra_flags)) if extra_flags
+        args << db_config.database
+
+        ignore_tables = ActiveRecord::SchemaDumper.ignore_tables
+        if ignore_tables.any?
+          condition = ignore_tables.map { |table| connection.quote(table) }.join(", ")
+          args << "SELECT sql FROM sqlite_master WHERE tbl_name NOT IN (#{condition}) ORDER BY tbl_name, type DESC, name"
+        else
+          args << ".schema"
+        end
+        run_cmd("sqlite3", args, filename)
       end
 
-      def structure_load(filename)
-        dbfile = configuration['database']
-        `sqlite3 #{dbfile} < "#{filename}"`
+      def structure_load(filename, extra_flags)
+        flags = extra_flags.join(" ") if extra_flags
+        `sqlite3 #{flags} #{db_config.database} < "#{filename}"`
       end
 
       private
+        attr_reader :db_config, :root
 
-      def configuration
-        @configuration
-      end
+        def run_cmd(cmd, args, out)
+          fail run_cmd_error(cmd, args) unless Kernel.system(cmd, *args, out: out)
+        end
 
-      def root
-        @root
-      end
+        def run_cmd_error(cmd, args)
+          msg = +"failed to execute:\n"
+          msg << "#{cmd} #{args.join(' ')}\n\n"
+          msg << "Please check the output above for any errors and make sure that `#{cmd}` is installed in your PATH and has proper permissions.\n\n"
+          msg
+        end
     end
   end
 end