percona_migrator 0.1.0.rc.4 → 0.1.0.rc.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e5da0e5e83003f39f3fbfda94fd8ae258d79052
-  data.tar.gz: 4ce4629ba354e7d4cd49345ef5298c33caef63e2
+  metadata.gz: e7301e478b66a555e4abe723cd9429914fba7820
+  data.tar.gz: fbf40c010ac9272f913b1e79285cb5f61fb11839
 SHA512:
-  metadata.gz: 4e1956e97df24759066e4b9ded281074330720274e20a54d6ae07b9b6a64fd292555e2a1a87f7c7ba09752c6c9dc7a0a36016ea6de018de3d8d59211bd718496
-  data.tar.gz: 11c8a7816627e264a7bd887e50c454145127519f79de24ff2433af3c77ea42a1326f773781e7748a363da053c3a6098374872a90206d2e5e3dbccb61a747f9db
+  metadata.gz: 39543206254ddc6f383446adca091ead90f3ac4a879dad0f7b246b8443d3bbeadc5eb95500fa26040fb8c28ef6182ad94e0620a1a4e8dd593f885f057555ed41
+  data.tar.gz: 011386f3f3e8866fb9db4c19c98f9e050c4899168bb5c0eb9d78ddd56451ad5eeb89caaa3973f7574f21038b89dbcda4f511353103c760f577007043e8f82af0

data/CHANGELOG.md

@@ -6,13 +6,23 @@ Please follow the format in [Keep a Changelog](http://keepachangelog.com/)
 
 ## [Unreleased]
 
+## [0.1.0.rc.5] - 2016-03-29
+
+### Changed
+
+- Raise a ActiveRecord::StatementInvalid on failed migration. It also provides
+    more detailed error message when possible such as pt-onlin-schema-change
+    being missing.
+
 ## [0.1.0.rc.4] - 2016-03-15
 
 ### Added
 
 - Support #drop_table
-- Support [Foreigner gem](https://github.com/matthuhiggins/foreigner) foreign
-    keys in Rails 3 apps that use it.
+- Support for foreing keys in db/schema.rb when using [Foreigner
+gem](https://github.com/matthuhiggins/foreigner) in Rails 3 apps. This allows to
+define foreign keys with #execute, but does not provide support for
+#add_foreign_key yet.
 
 ## [0.1.0.rc.3] - 2016-03-10
 

data/Gemfile

@@ -1,3 +1,5 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/README.md

@@ -1,4 +1,4 @@
-# PerconaMigrator [![Build Status](https://travis-ci.org/redbooth/percona_migrator.svg?branch=master)](https://travis-ci.org/redbooth/percona_migrator)
+# PerconaMigrator [![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 a tool for running online and non-blocking
 DDL `ActiveRecord::Migrations` using `pt-online-schema-change` command-line tool of

data/Rakefile

@@ -6,12 +6,12 @@ require './test_database'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
 
 namespace :db do
   desc 'Create the test database'
   task :create do
     config = Configuration.new
-    TestDatabase.new(config).create_test_database
+    TestDatabase.new(config).setup_test_database
   end
 end

data/lib/active_record/connection_adapters/percona_adapter.rb

@@ -83,7 +83,7 @@ module ActiveRecord
       def add_column(table_name, column_name, type, options = {})
         super
         command = cli_generator.generate(table_name, @sql)
-        runner.execute(command)
+        log(@sql, nil) { runner.execute(command) }
       end
 
       # Removes the column(s) from the table definition
@@ -93,7 +93,7 @@ module ActiveRecord
       def remove_column(table_name, *column_names)
         super
         command = cli_generator.generate(table_name, @sql)
-        runner.execute(command)
+        log(@sql, nil) { runner.execute(command) }
       end
 
       # Adds a new index to the table
@@ -106,7 +106,7 @@ module ActiveRecord
         execute "ADD #{index_type} INDEX #{quote_column_name(index_name)} (#{index_columns})#{index_options}"
 
         command = cli_generator.generate(table_name, @sql)
-        runner.execute(command)
+        log(@sql, nil) { runner.execute(command) }
       end
 
       # Remove the given index from the table.
@@ -118,7 +118,7 @@ module ActiveRecord
         execute "DROP INDEX #{quote_column_name(index_name)}"
 
         command = cli_generator.generate(table_name, @sql)
-        runner.execute(command)
+        log(@sql, nil) { runner.execute(command) }
       end
 
       # Records the SQL statement to be executed. This is used to then delegate
@@ -139,7 +139,7 @@ module ActiveRecord
       def percona_execute(sql, name)
         if alter_statement?(sql)
           command = cli_generator.parse_statement(sql)
-          runner.execute(command)
+          log(sql, nil) { runner.execute(command) }
         else
           mysql_adapter.execute(sql, name)
         end
@@ -154,6 +154,9 @@ module ActiveRecord
         yield mysql_adapter.execute(sql, name)
       end
 
+      def error_number(exception)
+      end
+
       private
 
       attr_reader :mysql_adapter, :logger, :runner, :cli_generator

data/lib/percona_migrator/cli_generator.rb

@@ -47,7 +47,7 @@ module PerconaMigrator
     end
 
     # Generates the percona command. Fills all the connection credentials from
-    # the current AR connection, but that can amended via ENV-vars:
+    # 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
@@ -59,7 +59,7 @@ module PerconaMigrator
       alter_argument = AlterArgument.new(statement)
       dsn = DSN.new(database, table_name)
 
-      "#{to_s} #{dsn} #{alter_argument}"
+      "#{self} #{dsn} #{alter_argument}"
     end
 
     # Generates the percona command for a raw MySQL statement. Fills all the
@@ -74,7 +74,7 @@ module PerconaMigrator
       alter_argument = AlterArgument.new(statement)
       dsn = DSN.new(database, alter_argument.table_name)
 
-      "#{to_s} #{dsn} #{alter_argument}"
+      "#{self} #{dsn} #{alter_argument}"
     end
 
     private

data/lib/percona_migrator/runner.rb

@@ -1,23 +1,48 @@
 require 'open3'
 
 module PerconaMigrator
+  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
 
   # It executes pt-online-schema-change commands in a new process and gets its
   # output and status
   class Runner
+    COMMAND_NOT_FOUND = 127
 
     NONE = "\e[0m"
     CYAN = "\e[38;5;86m"
     GREEN = "\e[32m"
-    RED = "\e[31m"
-
-    # Executes the given command printing the output to the logger
-    #
-    # @param command [String]
-    # @param logger [IO]
-    def self.execute(command, logger)
-      new(command, logger).execute
-    end
 
     # Constructor
     #
@@ -33,11 +58,7 @@ module PerconaMigrator
     # @return [Boolean]
     def execute(command)
       @command = command
-
-      log_started
-      run_command
-      log_finished
-
+      logging { run_command }
       status
     end
 
@@ -45,6 +66,15 @@ module PerconaMigrator
 
     attr_reader :command, :logger, :status
 
+    # Logs the start and end of the execution
+    #
+    # @yield
+    def logging
+      log_started
+      yield
+      log_finished
+    end
+
     # TODO: log as a migration logger subitem
     #
     # Logs when the execution started
@@ -56,33 +86,24 @@ module PerconaMigrator
     #
     # @raise [Errno::ENOENT] if pt-online-schema-change can't be found
     def run_command
-      Open3.popen2(command) do |_stdin, stdout, process|
-        @status = process.value
-        logger.info stdout.read
-      end
-
-      if status.nil?
-        Kernel.warn("Error running '#{command}': status could not be retrieved")
+      message = nil
+      Open3.popen3(command) do |_stdin, stdout, stderr, waith_thr|
+        @status = waith_thr.value
+        message = stderr.read
+        logger.info(stdout.read)
       end
 
-      if status && status.signaled?
-        Kernel.warn("Error running '#{command}': #{status.to_s}")
-      end
+      raise NoStatusError if status.nil?
+      raise SignalError.new(status) if status.signaled?
+      raise CommandNotFoundError if status.exitstatus == COMMAND_NOT_FOUND
 
-    rescue Errno::ENOENT
-      raise Errno::ENOENT, "Please install pt-online-schema-change. Check: https://www.percona.com/doc/percona-toolkit"
+      raise Error, message unless status.success?
     end
 
-    # Logs the status of the execution once it's finished
+    # Logs the status of the execution once it's finished. At this point we
+    # know it's a success
     def log_finished
-      return unless status
-
-      value = status.exitstatus
-      return unless value
-
-      message = value.zero? ? "#{GREEN}Done!#{NONE}" : "#{RED}Failed!#{NONE}"
-
-      logger.info("\n#{message}")
+      logger.info("\n#{GREEN}Done!#{NONE}")
     end
   end
 end

data/lib/percona_migrator/version.rb

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

data/test_database.rb

@@ -1,17 +1,33 @@
+# Setups the test database with the schema_migrations table that ActiveRecord
+# requires for the migrations, plus a table for the Comment model used throught
+# the tests.
+#
 class TestDatabase
+
+  # Constructor
+  #
+  # @param config [Hash]
   def initialize(config)
     @config = config
   end
 
-  # Creates the percona_migrator_test database and comments table in it
-  def create_test_database
-    %x(#{mysql_command} "DROP DATABASE IF EXISTS percona_migrator_test; CREATE DATABASE percona_migrator_test DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_unicode_ci")
-    %x(#{mysql_command} "USE percona_migrator_test; DROP TABLE IF EXISTS comments; CREATE TABLE comments (id int(12) NOT NULL AUTO_INCREMENT, PRIMARY KEY (id)) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;")
+  # Creates the test database, the schema_migrations and the comments tables.
+  # It drops any of them if they already exist
+  def setup
+    setup_test_database
+    drop_and_create_schema_migrations_table
+  end
+
+  # Creates the percona_migrator_test database and the comments table in it.
+  # Before, it drops both if they already exist
+  def setup_test_database
+    drop_and_create_test_database
+    drop_and_create_comments_table
   end
 
   # Creates the ActiveRecord's schema_migrations table required for
-  # migrations to work
-  def create_schema_migrations_table
+  # migrations to work. Before, it drops the table if it already exists
+  def drop_and_create_schema_migrations_table
     %x(#{mysql_command} "USE percona_migrator_test; DROP TABLE IF EXISTS schema_migrations; CREATE TABLE schema_migrations ( version varchar(255) COLLATE utf8_unicode_ci NOT NULL, UNIQUE KEY unique_schema_migrations (version)) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci")
   end
 
@@ -19,6 +35,16 @@ class TestDatabase
 
   attr_reader :config
 
+  def drop_and_create_test_database
+    %x(#{mysql_command} "DROP DATABASE IF EXISTS percona_migrator_test; CREATE DATABASE percona_migrator_test DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_unicode_ci;")
+  end
+
+  def drop_and_create_comments_table
+    %x(#{mysql_command} "USE percona_migrator_test; DROP TABLE IF EXISTS comments; CREATE TABLE comments ( id int(12) NOT NULL AUTO_INCREMENT, PRIMARY KEY (id)) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;")
+  end
+
+  # Returns the command to run the mysql client. It uses the crendentials from
+  # the provided config
   def mysql_command
     "mysql --user=#{config['username']} --password=#{config['password']} -e"
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: percona_migrator
 version: !ruby/object:Gem::Version
-  version: 0.1.0.rc.4
+  version: 0.1.0.rc.5
 platform: ruby
 authors:
 - Ilya Zayats
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-15 00:00:00.000000000 Z
+date: 2016-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails