departure-76c9880 6.2.0

data/lib/departure/alter_argument.rb

@@ -0,0 +1,49 @@
+module Departure
+  class InvalidAlterStatement < StandardError; end
+
+  # Represents the '--alter' argument of Percona's pt-online-schema-change
+  # See https://www.percona.com/doc/percona-toolkit/2.0/pt-online-schema-change.html
+  class AlterArgument
+    ALTER_TABLE_REGEX = /\AALTER TABLE [^\s]*[\n]* /
+
+    attr_reader :table_name
+
+    # Constructor
+    #
+    # @param statement [String]
+    # @raise [InvalidAlterStatement] if the statement is not an ALTER TABLE
+    def initialize(statement)
+      @statement = statement
+
+      match = statement.match(ALTER_TABLE_REGEX)
+      raise InvalidAlterStatement unless match
+      # Separates the ALTER TABLE from the table_name
+      #
+      # Removes the grave marks, if they are there, so we can get the table_name
+      @table_name = String(match)
+                      .split(' ')[2]
+                      .delete('`')
+    end
+
+    # Returns the '--alter' pt-online-schema-change argument as a string. See
+    # https://www.percona.com/doc/percona-toolkit/2.0/pt-online-schema-change.html
+    def to_s
+      "--alter \"#{parsed_statement}\""
+    end
+
+    private
+
+    attr_reader :statement
+
+    # Removes the 'ALTER TABLE' portion of the SQL statement
+    #
+    # @return [String]
+    def parsed_statement
+      @parsed_statement ||= statement
+        .gsub(ALTER_TABLE_REGEX, '')
+        .gsub('`', '\\\`')
+        .gsub(/\\n/, '')
+        .gsub('"', '\\\"')
+    end
+  end
+end

data/lib/departure/cli_generator.rb

@@ -0,0 +1,84 @@
+require 'departure/dsn'
+require 'departure/option'
+require 'departure/alter_argument'
+require 'departure/connection_details'
+require 'departure/user_options'
+
+module Departure
+  # Generates the equivalent Percona's pt-online-schema-change command to the
+  # given SQL statement
+  #
+  # --no-check-alter is used to allow running CHANGE COLUMN statements. For more details, check:
+  # www.percona.com/doc/percona-toolkit/2.2/pt-online-schema-change.html#cmdoption-pt-online-schema-change--[no]check-alter # rubocop:disable Metrics/LineLength
+  #
+  class CliGenerator
+    COMMAND_NAME = 'pt-online-schema-change'.freeze
+    DEFAULT_OPTIONS = Set.new(
+      [
+        Option.new('execute'),
+        Option.new('statistics'),
+        Option.new('alter-foreign-keys-method', 'auto'),
+        Option.new('no-check-alter')
+      ]
+    ).freeze
+
+    # TODO: Better doc.
+    #
+    # Constructor. Specify any arguments to pass to pt-online-schema-change
+    # passing the PERCONA_ARGS env var when executing the migration
+    #
+    # @param connection_data [Hash]
+    def initialize(connection_details)
+      @connection_details = connection_details
+    end
+
+    # Generates the percona command. Fills all the connection credentials from
+    # the current AR connection, but that can be amended via ENV-vars:
+    # PERCONA_DB_HOST, PERCONA_DB_USER, PERCONA_DB_PASSWORD, PERCONA_DB_NAME
+    # Table name can't not be amended, it populates automatically from the
+    # migration data
+    #
+    # @param table_name [String]
+    # @param statement [String] MySQL statement
+    # @return [String]
+    def generate(table_name, statement)
+      alter_argument = AlterArgument.new(statement)
+      dsn = DSN.new(connection_details.database, table_name)
+
+      "#{command} #{all_options} #{dsn} #{alter_argument}"
+    end
+
+    # Generates the percona command for a raw MySQL statement. Fills all the
+    # connection credentials from the current AR connection, but that can
+    # amended via ENV-vars: PERCONA_DB_HOST, PERCONA_DB_USER,
+    # PERCONA_DB_PASSWORD, PERCONA_DB_NAME Table name can't not be amended, it
+    # populates automatically from the migration data
+    #
+    # @param statement [String] MySQL statement
+    # @return [String]
+    def parse_statement(statement)
+      alter_argument = AlterArgument.new(statement)
+      dsn = DSN.new(connection_details.database, alter_argument.table_name)
+
+      "#{command} #{all_options} #{dsn} #{alter_argument}"
+    end
+
+    private
+
+    attr_reader :connection_details
+
+    def command
+      "#{COMMAND_NAME} #{connection_details}"
+    end
+
+    # Returns all the arguments to execute pt-online-schema-change with
+    #
+    # @return [String]
+    def all_options
+      env_variable_options = UserOptions.new
+      global_configuration_options = UserOptions.new(Departure.configuration.global_percona_args)
+      options = env_variable_options.merge(global_configuration_options).merge(DEFAULT_OPTIONS)
+      options.to_a.join(' ')
+    end
+  end
+end

data/lib/departure/command.rb

@@ -0,0 +1,96 @@
+module Departure
+  # Executes the given command returning it's status and errors
+  class Command
+    COMMAND_NOT_FOUND = 127
+
+    # Constructor
+    #
+    # @param command_line [String]
+    # @param error_log_path [String]
+    # @param logger [#write_no_newline]
+    def initialize(command_line, error_log_path, logger)
+      @command_line = command_line
+      @error_log_path = error_log_path
+      @logger = logger
+    end
+
+    # Executes the command returning its status. It also prints its stdout to
+    # the logger and its stderr to the file specified in error_log_path.
+    #
+    # @raise [NoStatusError] if the spawned process' status can't be retrieved
+    # @raise [SignalError] if the spawned process received a signal
+    # @raise [CommandNotFoundError] if pt-online-schema-change can't be found
+    #
+    # @return [Process::Status]
+    def run
+      log_started
+
+      run_in_process
+
+      log_finished
+
+      validate_status!
+      status
+    end
+
+    private
+
+    attr_reader :command_line, :error_log_path, :logger, :status
+
+    # Runs the command in a separate process, capturing its stdout and
+    # execution status
+    def run_in_process
+      Open3.popen3(full_command) do |_stdin, stdout, _stderr, waith_thr|
+        begin
+          loop do
+            IO.select([stdout])
+            data = stdout.read_nonblock(8192)
+            logger.write_no_newline(data)
+          end
+        rescue EOFError # rubocop:disable Lint/HandleExceptions
+          # noop
+        ensure
+          @status = waith_thr.value
+        end
+      end
+    end
+
+    # Builds the actual command including stderr redirection to the specified
+    # log file
+    #
+    # @return [String]
+    def full_command
+      "#{command_line} 2> #{error_log_path}"
+    end
+
+    # Validates the status of the execution
+    #
+    # @raise [NoStatusError] if the spawned process' status can't be retrieved
+    # @raise [SignalError] if the spawned process received a signal
+    # @raise [CommandNotFoundError] if pt-online-schema-change can't be found
+    def validate_status!
+      raise SignalError.new(status) if status.signaled? # rubocop:disable Style/RaiseArgs
+      raise CommandNotFoundError if status.exitstatus == COMMAND_NOT_FOUND
+      raise Error, error_message unless status.success?
+    end
+
+    # Returns the error message that appeared in the process' stderr
+    #
+    # @return [String]
+    def error_message
+      File.read(error_log_path)
+    end
+
+    # Logs when the execution started
+    def log_started
+      logger.write("\n")
+      logger.say("Running #{command_line}\n\n", true)
+    end
+
+    # Prints a line break to keep the logs separate from the execution time
+    # print by the migration
+    def log_finished
+      logger.write("\n")
+    end
+  end
+end

data/lib/departure/configuration.rb

@@ -0,0 +1,20 @@
+module Departure
+  class Configuration
+    attr_accessor :tmp_path, :global_percona_args, :enabled_by_default
+
+    def initialize
+      @tmp_path = '.'.freeze
+      @error_log_filename = 'departure_error.log'.freeze
+      @global_percona_args = nil
+      @enabled_by_default = true
+    end
+
+    def error_log_path
+      File.join(tmp_path, error_log_filename)
+    end
+
+    private
+
+    attr_reader :error_log_filename
+  end
+end

data/lib/departure/connection_base.rb

@@ -0,0 +1,9 @@
+module Departure
+  class ConnectionBase < ActiveRecord::Base
+    def self.establish_connection(config = nil)
+      super.tap do
+        ActiveRecord::Base.connection_specification_name = connection_specification_name
+      end
+    end
+  end
+end

data/lib/departure/connection_details.rb

@@ -0,0 +1,96 @@
+require 'shellwords'
+module Departure
+  # Holds the parameters of the DB connection and formats them to string
+  class ConnectionDetails
+    DEFAULT_PORT = 3306
+    # Constructor
+    #
+    # @param [Hash] connection parametes as used in #establish_conneciton
+    def initialize(connection_data)
+      @connection_data = connection_data
+    end
+
+    # Returns the details formatted as an string to be used with
+    # pt-online-schema-change. It follows the mysql client's format.
+    #
+    # @return [String]
+    def to_s
+      @to_s ||= "#{host_argument} -P #{port} -u #{user} #{password_argument}"
+    end
+
+    # TODO: Doesn't the abstract adapter already handle this somehow?
+    # Returns the database name. If PERCONA_DB_NAME is passed its value will be
+    # used instead
+    #
+    # Returns the database name
+    #
+    # @return [String]
+    def database
+      ENV.fetch('PERCONA_DB_NAME', connection_data[:database])
+    end
+
+    # Returns the password fragment of the details string if a password is passed
+    #
+    # @return [String]
+    def password_argument
+      if password.present?
+        %(--password #{Shellwords.escape(password)} )
+      else
+        ''
+      end
+    end
+
+    # Returns the host fragment of the details string, adds ssl options if needed
+    #
+    # @return [String]
+    def host_argument
+      host_string = host
+      if ssl_ca.present?
+        host_string += ";mysql_ssl=1;mysql_ssl_client_ca=#{ssl_ca}"
+      end
+      "-h \"#{host_string}\""
+    end
+
+    private
+
+    attr_reader :connection_data
+
+    # Returns the database host name, defaulting to localhost. If PERCONA_DB_HOST
+    # is passed its value will be used instead
+    #
+    # @return [String]
+    def host
+      ENV.fetch('PERCONA_DB_HOST', connection_data[:host]) || 'localhost'
+    end
+
+    # Returns the database user. If PERCONA_DB_USER is passed its value will be
+    # used instead
+    #
+    # @return [String]
+    def user
+      ENV.fetch('PERCONA_DB_USER', connection_data[:username])
+    end
+
+    # Returns the database user's password. If PERCONA_DB_PASSWORD is passed its
+    # value will be used instead
+    #
+    # @return [String]
+    def password
+      ENV.fetch('PERCONA_DB_PASSWORD', connection_data[:password])
+    end
+
+    # Returns the database's port.
+    #
+    # @return [String]
+    def port
+      connection_data.fetch(:port, DEFAULT_PORT)
+    end
+
+    # Returns the database' SSL CA certificate.
+    #
+    # @return [String]
+    def ssl_ca
+      connection_data.fetch(:sslca, nil)
+    end
+  end
+end

data/lib/departure/dsn.rb

@@ -0,0 +1,24 @@
+module Departure
+  # Represents the 'DSN' argument of Percona's pt-online-schema-change
+  # See https://www.percona.com/doc/percona-toolkit/2.0/pt-online-schema-change.html#dsn-options
+  class DSN
+    # Constructor
+    #
+    # @param database [String, Symbol]
+    # @param table_name [String, Symbol]
+    def initialize(database, table_name)
+      @database = database
+      @table_name = table_name
+    end
+
+    # Returns the pt-online-schema-change DSN string. See
+    # https://www.percona.com/doc/percona-toolkit/2.0/pt-online-schema-change.html#dsn-options
+    def to_s
+      "D=#{database},t=#{table_name}"
+    end
+
+    private
+
+    attr_reader :table_name, :database
+  end
+end

data/lib/departure/errors.rb

@@ -0,0 +1,39 @@
+module Departure
+  class Error < StandardError; end
+
+  # Used when for whatever reason we couldn't get the spawned process'
+  # status.
+  class NoStatusError < Error
+    def message
+      'Status could not be retrieved'.freeze
+    end
+  end
+
+  # Used when the spawned process failed by receiving a signal.
+  # pt-online-schema-change returns "SIGSEGV (signal 11)" on failures.
+  class SignalError < Error
+    attr_reader :status
+
+    # Constructor
+    #
+    # @param status [Process::Status]
+    def initialize(status)
+      super
+      @status = status
+    end
+
+    def message
+      status.to_s
+    end
+  end
+
+  class CommandNotFoundError < Error
+    def message
+      'Please install pt-online-schema-change. Check: https://www.percona.com/doc/percona-toolkit for further details'
+    end
+  end
+
+  # Used to prevent running the db:migrate rake task when providing arguments
+  # through PERCONA_ARGS env var
+  class ArgumentsNotSupported < Error; end
+end

data/lib/departure/log_sanitizers/password_sanitizer.rb

@@ -0,0 +1,22 @@
+module Departure
+  module LogSanitizers
+    class PasswordSanitizer
+      PASSWORD_REPLACEMENT = '[filtered_password]'.freeze
+
+      delegate :password_argument, to: :connection_details
+
+      def initialize(connection_details)
+        @connection_details = connection_details
+      end
+
+      def execute(log_statement)
+        return log_statement if password_argument.blank?
+        log_statement.gsub(password_argument, PASSWORD_REPLACEMENT)
+      end
+
+      private
+
+      attr_accessor :connection_details
+    end
+  end
+end