arrival 0.1.0

data/lib/arrival/command.rb

@@ -0,0 +1,96 @@
+module Arrival
+  # 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/arrival/configuration.rb

@@ -0,0 +1,19 @@
+module Arrival
+  class Configuration
+    attr_accessor :tmp_path, :global_percona_args
+
+    def initialize
+      @tmp_path = '.'.freeze
+      @error_log_filename = 'arrival_error.log'.freeze
+      @global_percona_args = nil
+    end
+
+    def error_log_path
+      File.join(tmp_path, error_log_filename)
+    end
+
+    private
+
+    attr_reader :error_log_filename
+  end
+end

data/lib/arrival/connection_details.rb

@@ -0,0 +1,96 @@
+require 'shellwords'
+module Arrival
+  # 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/arrival/dsn.rb

@@ -0,0 +1,24 @@
+module Arrival
+  # 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/arrival/errors.rb

@@ -0,0 +1,39 @@
+module Arrival
+  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/arrival/log_sanitizers/password_sanitizer.rb

@@ -0,0 +1,22 @@
+module Arrival
+  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

data/lib/arrival/logger.rb

@@ -0,0 +1,42 @@
+module Arrival
+  # Copies the ActiveRecord::Migration #say and #write plus a new
+  # #write_no_newline to log the migration's status. It's not possible to reuse
+  # the from ActiveRecord::Migration because the migration's instance can't be
+  # seen from the connection adapter.
+  class Logger
+    def initialize(sanitizers)
+      @sanitizers = sanitizers
+    end
+
+    # Outputs the message through the stdout, following the
+    # ActiveRecord::Migration log format
+    #
+    # @param message [String]
+    # @param subitem [Boolean] whether to show message as a nested log item
+    def say(message, subitem = false)
+      write "#{subitem ? '   ->' : '--'} #{message}"
+    end
+
+    # Outputs the text through the stdout adding a new line at the end
+    #
+    # @param text [String]
+    def write(text = '')
+      puts(sanitize(text))
+    end
+
+    # Outputs the text through the stdout without adding a new line at the end
+    #
+    # @param text [String]
+    def write_no_newline(text)
+      print(sanitize(text))
+    end
+
+    private
+
+    attr_accessor :sanitizers
+
+    def sanitize(text)
+      sanitizers.inject(text) { |memo, sanitizer| sanitizer.execute(memo) }
+    end
+  end
+end

data/lib/arrival/logger_factory.rb

@@ -0,0 +1,16 @@
+module Arrival
+  module LoggerFactory
+    # Returns the appropriate logger instance for the given configuration. Use
+    # :verbose option to log to the stdout
+    #
+    # @param verbose [Boolean]
+    # @return [#say, #write]
+    def self.build(sanitizers: [], verbose: true)
+      if verbose
+        Arrival::Logger.new(sanitizers)
+      else
+        Arrival::NullLogger.new
+      end
+    end
+  end
+end

data/lib/arrival/null_logger.rb

@@ -0,0 +1,15 @@
+module Arrival
+  class NullLogger
+    def say(_message, _subitem = false)
+      # noop
+    end
+
+    def write(_text)
+      # noop
+    end
+
+    def write_no_newline(_text)
+      # noop
+    end
+  end
+end

data/lib/arrival/option.rb

@@ -0,0 +1,75 @@
+module Arrival
+  class Option
+    attr_reader :name, :value
+
+    # Builds an instance by parsing its name and value out of the given string.
+    #
+    # @param string [String]
+    # @return [Option]
+    def self.from_string(string)
+      name, value = string.split(/\s|=/, 2)
+      new(name, value)
+    end
+
+    # Constructor
+    #
+    # @param name [String]
+    # @param optional value [String]
+    def initialize(name, value = nil)
+      @name = normalize_option(name)
+      @value = value
+    end
+
+    # Compares two options
+    #
+    # @param [Option]
+    # @return [Boolean]
+    def ==(other)
+      name == other.name
+    end
+    alias eql? ==
+
+    # Returns the option's hash
+    #
+    # @return [Fixnum]
+    def hash
+      name.hash
+    end
+
+    # Returns the option as string following the "--<name>=<value>" format or
+    # the short "-n=value" format
+    #
+    # @return [String]
+    def to_s
+      "#{name}#{value_as_string}"
+    end
+
+    private
+
+    # Returns the option name in "long" format, e.g., "--name"
+    #
+    # @return [String]
+    def normalize_option(name)
+      if name.start_with?('-')
+        name
+      elsif name.length == 1
+        "-#{name}"
+      else
+        "--#{name}"
+      end
+    end
+
+    # Returns the value fragment of the option string if any value is specified
+    #
+    # @return [String]
+    def value_as_string
+      if value.nil?
+        ''
+      elsif value.include?('=')
+        " #{value}"
+      else
+        "=#{value}"
+      end
+    end
+  end
+end