percona_migrator 0.1.0.rc.6 → 0.1.0.rc.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c92cf9bc3f2fd48fbe1277d9196037bb9d92fec
-  data.tar.gz: 8df8aceabfb8822fe30c3c1cae0d9055b58e2834
+  metadata.gz: bda957042f0b8003133ed8fddcc2b0e1dd227f75
+  data.tar.gz: 733e11a6c52f6354b353f9866796a431e2045188
 SHA512:
-  metadata.gz: a1ee2cb57ce1d7062f34d6a3c604081f2c7c7863c76e2acccf7cdadb010239e4eb94350e0c28a17eb44a90f61c7c940239682dbec5e5d2bddcd18239386b1259
-  data.tar.gz: e9fb460fb9eaaecee4ef5a6e5d424a23da11b9717522fd4e4914fa01d27230c5c813dac1160c460f161414077e41f64f4348a94619f0c7e43f8071abc6a57100
+  metadata.gz: 76f26f49d302c27433b1ff95f3ea277e431b1da805f139f2ed1ec57839978d907e6f8d719c5897183a71c7049fe9b81e354ceebd511fe52613f7fd2cab3fbc8e
+  data.tar.gz: 01233203b600ee1f851a4bc2d0820ebd618f4018286fdda856db53fad1ae7e83673edb81126759a62d796f290d76359eb3797f995d6cf2db924c17fc1681700a

data/CHANGELOG.md

@@ -6,6 +6,18 @@ Please follow the format in [Keep a Changelog](http://keepachangelog.com/)
 
 ## [Unreleased]
 
+## [0.1.0.rc.7] - 2016-09-15
+
+### Added
+
+- Toggle pt-online-schema-change's output as well when toggling the migration's
+    verbose option.
+
+### Changed
+
+- Enabled pt-online-schema-change's output while running the migration, that got
+  broken in v0.1.0.rc.2
+
 ## [0.1.0.rc.6] - 2016-04-07
 
 ### Added

data/README.md

@@ -1,7 +1,7 @@
 # Percona Migrator [![Build Status](https://travis-ci.org/redbooth/percona_migrator.svg?branch=master)](https://travis-ci.org/redbooth/percona_migrator) [![Code Climate](https://codeclimate.com/github/redbooth/percona_migrator/badges/gpa.svg)](https://codeclimate.com/github/redbooth/percona_migrator)
 
 Percona Migrator is an **ActiveRecord connection adapter** that allows running
-**MySQL online and non-blocking DDL** `ActiveRecord::Migration` without needing
+**MySQL online and non-blocking DDL** through `ActiveRecord::Migration` without needing
     to use a different DSL other than Rails' migrations DSL.
 
 It uses `pt-online-schema-change` command-line tool of

data/lib/active_record/connection_adapters/percona_adapter.rb

@@ -11,9 +11,12 @@ module ActiveRecord
     def self.percona_connection(config)
       mysql2_connection = mysql2_connection(config)
 
+      verbose = ActiveRecord::Migration.verbose
+      percona_logger = PerconaMigrator::LoggerFactory.build(verbose: verbose)
       cli_generator = PerconaMigrator::CliGenerator.new(config)
+
       runner = PerconaMigrator::Runner.new(
-        logger,
+        percona_logger,
         cli_generator,
         mysql2_connection
       )

data/lib/percona_migrator.rb

@@ -4,6 +4,9 @@ require 'active_support/all'
 require 'percona_migrator/version'
 require 'percona_migrator/runner'
 require 'percona_migrator/cli_generator'
+require 'percona_migrator/logger'
+require 'percona_migrator/null_logger'
+require 'percona_migrator/logger_factory'
 
 require 'percona_migrator/railtie' if defined?(Rails)
 

data/lib/percona_migrator/logger.rb

@@ -0,0 +1,23 @@
+module PerconaMigrator
+  # Copies the ActiveRecord::Migration #say and #write 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
+
+    # 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
+    #
+    # @param text [String]
+    def write(text = '')
+      puts(text)
+    end
+  end
+end

data/lib/percona_migrator/logger_factory.rb

@@ -0,0 +1,17 @@
+module PerconaMigrator
+  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(verbose: true)
+      if verbose
+        PerconaMigrator::Logger.new
+      else
+        PerconaMigrator::NullLogger.new
+      end
+    end
+  end
+end

data/lib/percona_migrator/null_logger.rb

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

data/lib/percona_migrator/runner.rb

@@ -40,13 +40,12 @@ module PerconaMigrator
   class Runner
     COMMAND_NOT_FOUND = 127
 
-    NONE = "\e[0m"
-    CYAN = "\e[38;5;86m"
-    GREEN = "\e[32m"
-
     # Constructor
     #
-    # @param logger [IO]
+    # @param logger [#say, #write]
+    # @param cli_generator [CliGenerator]
+    # @param mysql_adapter [ActiveRecord::ConnectionAdapter] it must implement
+    #   #execute and #raw_connection
     def initialize(logger, cli_generator, mysql_adapter)
       @logger = logger
       @cli_generator = cli_generator
@@ -83,12 +82,14 @@ module PerconaMigrator
     def execute(command)
       @command = command
       logging { run_command }
+      validate_status
       status
     end
 
     private
 
-    attr_reader :command, :logger, :status, :cli_generator, :mysql_adapter
+    attr_reader :command, :logger, :status, :error_message, :cli_generator,
+      :mysql_adapter
 
     # Checks whether the sql statement is an ALTER TABLE
     #
@@ -107,37 +108,37 @@ module PerconaMigrator
       log_finished
     end
 
-    # TODO: log as a migration logger subitem
-    #
     # Logs when the execution started
     def log_started
-      logger.info "\n#{CYAN}-- #{command}#{NONE}\n\n"
+      logger.write("\n")
+      logger.say("Running #{command}\n\n", true)
     end
 
-    # Executes the command outputing any errors
-    #
-    # @raise [NoStatusError] if the spawned process' status can't be retrieved
-    # @raise [SignalError] if the spawned process receives a signal
-    # @raise [CommandNotFoundError] if pt-online-schema-change can't be found
+    # Executes the command and prints its output to the stdout
     def run_command
-      message = nil
       Open3.popen3(command) do |_stdin, stdout, stderr, waith_thr|
         @status = waith_thr.value
-        message = stderr.read
-        logger.info(stdout.read)
+        @error_message = stderr.read
+        logger.write(stdout.read)
       end
+    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 NoStatusError if status.nil?
       raise SignalError.new(status) if status.signaled?
       raise CommandNotFoundError if status.exitstatus == COMMAND_NOT_FOUND
-
-      raise Error, message unless status.success?
+      raise Error, error_message unless status.success?
     end
 
-    # Logs the status of the execution once it's finished. At this point we
-    # know it's a success
+    # Prints a line break to keep the logs separate from the execution time
+    # print by the migration
     def log_finished
-      logger.info("\n#{GREEN}Done!#{NONE}")
+      logger.write("\n")
     end
   end
 end

data/lib/percona_migrator/version.rb

@@ -1,3 +1,3 @@
 module PerconaMigrator
-  VERSION = '0.1.0.rc.6'.freeze
+  VERSION = '0.1.0.rc.7'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: percona_migrator
 version: !ruby/object:Gem::Version
-  version: 0.1.0.rc.6
+  version: 0.1.0.rc.7
 platform: ruby
 authors:
 - Ilya Zayats
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-07 00:00:00.000000000 Z
+date: 2016-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -154,6 +154,9 @@ files:
 - lib/percona_migrator.rb
 - lib/percona_migrator/alter_argument.rb
 - lib/percona_migrator/cli_generator.rb
+- lib/percona_migrator/logger.rb
+- lib/percona_migrator/logger_factory.rb
+- lib/percona_migrator/null_logger.rb
 - lib/percona_migrator/railtie.rb
 - lib/percona_migrator/runner.rb
 - lib/percona_migrator/version.rb
@@ -179,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: pt-online-schema-change runner for ActiveRecord migrations