pt-online-migration 0.0.3

data/.gitattributes

@@ -0,0 +1 @@
+*.rb diff=ruby

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+gem 'debugger'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 LeadKarma LLC
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,108 @@
+# PtOnlineMigration
+
+Schema changes tend to lock tables, which can be unacceptable for your production
+database. The wonderful people at Percona have developed a tool which helps you
+avoid this problem on MySQL databases.
+
+PTOnlineMigration patches ActiveRecord to have the option of altering tables through
+the pt-online-schema-change command.
+
+It is highly recommended that you study up on said command:
+	http://www.percona.com/doc/percona-toolkit/2.2/pt-online-schema-change.html
+
+This gem depends on the Percona Toolkit, and therefore only works with MySQL.
+
+## Installation
+
+Download/install the percona toolkit from their downloads page:
+	http://www.percona.com/downloads/percona-toolkit/
+
+Add this line to your application's Gemfile:
+
+	gem 'pt-online-migration'
+
+And then execute:
+
+	$ bundle
+
+Or install it yourself as:
+
+	$ gem install pt-online-migration
+
+## Usage
+
+The syntax is very similar to `change_table`
+
+e.g.
+
+```ruby
+	class SimpleAlterFoo < ActiveRecord::Migration
+		def up
+			online_alter_table :foo_table, :execute do |t|
+				t.integer :new_column_name
+			end
+		end
+
+		def down
+			online_alter_table :foo_table, :execute do |t|
+				t.remove :new_column_name
+			end
+		end
+	end
+```
+
+or
+
+```ruby
+	class ComplexAlterFoo < ActiveRecord::Migration
+		def up
+			online_alter_table :foo_table, :execute, :database => 'foo_database', :critical_load => 'Threads_running:50' do |t|
+				t.integer :new_column_name, :another_new_column_name, :limit => 7
+				t.decimal :new_column_with_more_options, :precision => 5, :scale => 3
+				t.change :foo_column, :boolean, :null => false
+				t.rename :bar_column, :baz_column, :string, :limit => 140
+				t.index  :foo_column, :unique => true, :name => 'foo_index'
+			end
+		end
+
+		def down
+			online_alter_table :foo_table, :execute, :database => 'foo_database', :critical_load => 'Threads_running:50' do |t|
+				t.remove :new_column_name, :another_new_column_name, :new_column_with_more_options
+				t.change :foo_column, :string
+				t.rename :baz_column, :bar_column, :string
+				t.remove_index :name => 'foo_index'
+			end
+		end
+	end
+```
+
+but not
+
+```ruby
+	class FailAlterFoo < ActiveRecord::Migration
+		def change
+			online_alter_table :foo_table, :execute do |t|
+				t.integer :new_column_name
+			end
+		end
+	end
+```
+
+Change is not supported.
+
+The major difference is that the online_alter_table method takes a few new parameters.
+Without the symbol :execute, pt-online-schema-change will perform a dry-run and no actual schema change will be made.
+The new method also takes a hash of options which are given to the pt-online-schema-change
+command itself. Note in the complex example above a database is specified. If you
+don't specify a database  `ActiveRecord::Base.connection.current_database` is assumed.
+
+For a list of accepted options check out the percona-toolkit documention:
+	http://www.percona.com/doc/percona-toolkit/2.2/pt-online-schema-change.html
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake.application.options.suppress_backtrace_pattern = /.*/
+Rake::TestTask.new do |t|
+	t.libs << 'test'
+	t.pattern = 'test/*_test.rb'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/pt_online_migration.rb

@@ -0,0 +1,44 @@
+require "pt_online_migration/version"
+require "pt_online_migration/pt_command_builder"
+
+module PtOnlineMigration
+
+	class PtOnlineMigrationError < ActiveRecord::ActiveRecordError
+	end
+
+	class ActiveRecord::Migration
+		alias_method :orig_announce, :announce
+
+		def announce(message)
+			new_message = message
+			if @is_online_schema_change and message =~ /^(migrated|reverted)/
+				if @executed
+					new_message = 'pt-online-schema-change executed, %s' % message
+				else
+					new_message = 'pt-online-schema-change dry-run complete %s' % message.split(' ')[1]
+				end
+			end
+			orig_announce new_message
+		end
+
+
+		def online_alter_table(*args)
+			raise "online_alter_table not supported within 'change' migration" if caller[0][/`.*'/][1..-2] == 'change'
+
+			@is_online_schema_change = true
+
+			host, username, password = Rails.configuration.database_configuration[Rails.env].values_at('host', 'username', 'password')
+			default_options = {:host => host, :username => username, :password => password, :database => connection.current_database}
+			options = default_options.merge(args.extract_options!.symbolize_keys)
+			pt_command = PTCommandBuilder.new(args[0], options, args[1] == :execute)
+			@executed = args[1] == :execute
+			yield pt_command
+			puts pt_command.command
+			system("nohup #{pt_command.command} >#{@name}_#{pt_command.table_name}.nohup.out 2>&1")
+			unless $?.success?
+				raise PtOnlineMigrationError.new
+			end
+		end
+	end
+end
+

data/lib/pt_online_migration/pt_command_builder.rb

@@ -0,0 +1,113 @@
+
+module PtOnlineMigration
+
+	class PTCommandBuilder
+
+		def initialize(table_name, options, execute)
+			@table_name = table_name
+			execute_clause = execute ? '--execute' : '--dry-run'
+			@cmd_prefix = ["pt-online-schema-change h=#{options.delete(:host)},u=#{options.delete(:username)},p=#{options.delete(:password)},D=#{options.delete(:database)},t=#{table_name} #{execute_clause} --print"]
+			@pt_options = options
+			@alter_statements = []
+		end
+
+
+		def table_name
+			@table_name
+		end
+
+
+		%w( string text integer float decimal datetime timestamp time date binary boolean ).each do |type|
+			define_method type do |*args|
+				options = args.extract_options!
+				args.each do |name|
+					add_column(name, type.to_sym, options)
+				end
+			end
+		end
+
+
+		def add_column(name, type, options)
+			alter_statement
+			definition = column_definition(type, options)
+			@alter_statements.push "add column #{name.to_s} #{definition}"
+		end
+
+
+		def index(columns, options = {})
+			alter_statement
+			columns = Array(columns)
+			options[:name] ||= "#{@table_name}_#{columns.join('_')}_index"
+			@alter_statements.push "add#{' unique' if options[:unique]} index #{options[:name].to_s} (#{columns.join(', ')})"
+		end
+
+
+		def rename(old_name, new_name, type, options = {})
+			alter_statement
+			@cmd_prefix.push '--no-check-alter'
+			definition = column_definition(type, options)
+			@alter_statements.push "change column #{old_name} #{new_name} #{definition}"
+		end
+
+
+		def command
+			options = ''
+			@pt_options.map do |k, v|
+				options += " --#{k.to_s.gsub('_', '-')} '#{v}'"
+			end
+
+			return "#{@cmd_prefix.join(' ') + options} #{@modification_type} '#{@alter_statements.join(', ')}'"
+		end
+
+
+		def change(name, type, options = {})
+			alter_statement
+			@alter_statements.push "modify column #{name.to_s} #{column_definition(type, options)}"
+		end
+
+
+		def remove(*column_names)
+			alter_statement
+			@alter_statements.concat(column_names.map {|name| "drop column #{name.to_s}"})
+		end
+
+
+		def remove_index(options)
+			alter_statement
+			options = {:column => options} if options.class == Symbol
+			index = index_name(options)
+			@alter_statements.push "drop index #{index}"
+		end
+
+		private
+
+		def alter_statement
+			@modification_type ||= '--alter'
+		end
+
+
+		def column_definition(type, options)
+			default_options = {:default => :no_default, :precision => 1, :null => true, :scale => 0}
+			options = default_options.merge(options)
+
+			column_definition = [ActiveRecord::Base.connection.type_to_sql(type, options[:limit], options[:precision], options[:scale])]
+
+			column_definition.push 'not null' if options[:null] == false
+			options[:default] ||= 'null'
+			column_definition.push "default #{options[:default]}" unless options[:default] == :no_default
+			column_definition.push 'auto_increment' if options[:auto_increment]
+			column_definition.push 'first' if options[:first]
+			column_definition.push "after #{options[:after]}" if options[:after]
+
+			return column_definition.join(' ')
+		end
+
+
+		def index_name(options)
+			return "#{@table_name}_#{options[:column]}_index" if options[:column]
+			return "#{@table_name}_#{options[:columns].join('_')}_index" if options[:columns]
+			return options[:name] if options[:name]
+			raise ArgumentError, "unable to determine index name from #{options.inspect}"
+		end
+	end
+end

data/lib/pt_online_migration/version.rb

@@ -0,0 +1,3 @@
+module PtOnlineMigration
+  VERSION = "0.0.3"
+end

data/pt_online_migration.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pt_online_migration/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pt-online-migration"
+  spec.version       = PtOnlineMigration::VERSION
+  spec.authors        = ['LeadKarma, LLC']
+  spec.email          = ['support@leadkarma.com']
+  spec.description   = %q{active record migration wrapper for pt-online-schema-change cli command}
+  spec.summary       = %q{online schema migrations for mysql}
+  spec.homepage      = "http://www.leadkarma.com/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activerecord'
+  spec.add_dependency 'mysql2'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'mocha'
+  spec.add_development_dependency 'rake'
+end

data/test/pt_online_migration_test.rb

@@ -0,0 +1,129 @@
+require 'active_record'
+require 'active_record/connection_adapters/mysql2_adapter'
+require 'pt_online_migration'
+require 'test/unit'
+require 'mysql2'
+require 'mocha/setup'
+
+Rails = Class.new
+
+class PTOnlineMigrationTest < Test::Unit::TestCase
+
+	def setup
+		@test_migration = ActiveRecord::Migration.new
+
+		@test_migration.class.class_eval do
+			attr_accessor :cmd, :puts_message
+
+			def system(command)
+				self.cmd = command
+			end
+
+			def puts(message)
+				self.puts_message = message
+			end
+		end
+
+		Mysql2::Client.expects(:new).at_least_once.returns(nil)
+		ActiveRecord::ConnectionAdapters::Mysql2Adapter.any_instance.expects(:configure_connection).at_least_once.returns(true)
+		ActiveRecord::ConnectionAdapters::Mysql2Adapter.any_instance.expects(:current_database).returns('stub_db')
+		Rails.stubs(:configuration => stub(:database_configuration => { 'test' => {'host' => 'stub_host', 'username' => 'stub_user', 'password' => 'stub_password'}}))
+		Rails.expects(:env).returns('test').at_least_once
+		ActiveRecord::Base.establish_connection({
+			"adapter"=>"mysql2",
+			"database"=>"stub_db",
+		})
+	end
+
+
+	def test_complicated_migration
+		@test_migration.online_alter_table :foo_table, :execute, :host => 'bar_host', :database => 'foo_database', :username => 'baz_user', :password => 'biz_password', :critical_load => 'Threads_running:50' do |t|
+			t.integer :new_column, :another_new_column, :limit => 7
+			t.decimal :new_column_with_more_options, :precision => 5, :scale => 3, :default => nil
+			t.change :foo_column, :boolean, :null => false
+			t.rename :bar_column, :baz_column, :string, :limit => 140
+			t.index  :foo_column, :unique => true, :name => 'foo_index'
+		end
+
+		expected_pt_command = [
+			'pt-online-schema-change h=bar_host,u=baz_user,p=biz_password,D=foo_database,t=foo_table --execute --print',
+			"--no-check-alter --critical-load 'Threads_running:50' --alter 'add column",
+			'new_column bigint, add column another_new_column bigint, add column',
+			'new_column_with_more_options decimal(5,3) default null, modify column foo_column tinyint(1)',
+			'not null, change column bar_column baz_column varchar(140), add unique index',
+			"foo_index (foo_column)'"
+		]
+
+		expected = "nohup #{expected_pt_command.join(' ')} >#{@test_migration.name}_foo_table.nohup.out 2>&1"
+		assert_equal expected, @test_migration.cmd
+	end
+
+
+	def test_remove_migration
+		@test_migration.online_alter_table :foo_table, :execute, :host => 'bar_host', :username => 'baz_user', :password => 'biz_password', :database => 'foo_database', :critical_load => 'Threads_running:50' do |t|
+			t.remove :new_column, :another_new_column, :new_column_with_more_options
+			t.change :foo_column, :string
+			t.rename :baz_column, :bar_column, :string
+			t.remove_index :name => 'foo_index'
+		end
+
+		expected_pt_command = [
+			"pt-online-schema-change h=bar_host,u=baz_user,p=biz_password,D=foo_database,t=foo_table --execute --print --no-check-alter --critical-load 'Threads_running:50' --alter",
+			"'drop column new_column, drop column another_new_column, drop column new_column_with_more_options,",
+			"modify column foo_column varchar(255), change column baz_column bar_column varchar(255), drop index foo_index'"
+		]
+
+		expected = "nohup #{expected_pt_command.join(' ')} >#{@test_migration.name}_foo_table.nohup.out 2>&1"
+		assert_equal expected, @test_migration.cmd
+	end
+
+
+	def test_simple_migration
+		@test_migration.online_alter_table :foo_table, :execute do |t|
+			t.integer :new_column_name
+		end
+
+		expected_pt_command = "pt-online-schema-change h=stub_host,u=stub_user,p=stub_password,D=stub_db,t=foo_table --execute --print --alter 'add column new_column_name int(11)'"
+		expected = "nohup #{expected_pt_command} >#{@test_migration.name}_foo_table.nohup.out 2>&1"
+		assert_equal expected, @test_migration.cmd
+	end
+
+
+	def test_simple_dry_run
+		@test_migration.online_alter_table :foo_table do |t|
+			t.integer :new_column_name
+		end
+
+		expected_pt_command = "pt-online-schema-change h=stub_host,u=stub_user,p=stub_password,D=stub_db,t=foo_table --dry-run --print --alter 'add column new_column_name int(11)'"
+		expected = "nohup #{expected_pt_command} >#{@test_migration.name}_foo_table.nohup.out 2>&1"
+		assert_equal expected, @test_migration.cmd
+	end
+
+
+	def test_announce_pass_through
+		@test_migration.online_alter_table :foo_table do |t|
+			t.integer :new_column_name
+		end
+		@test_migration.announce 'this should pass through'
+		assert_nil @test_migration.puts_message =~ /pt-online-schema-change/
+		assert_not_nil @test_migration.puts_message =~ /this should pass through/
+	end
+
+
+	def test_announce_migrated
+		@test_migration.online_alter_table :foo_table do |t|
+			t.integer :new_column_name
+		end
+		@test_migration.announce 'migrated, this should get cut off'
+		assert_not_nil @test_migration.puts_message =~ /pt-online-schema-change dry-run complete this/
+	end
+
+
+	def test_announce_reverted
+		@test_migration.online_alter_table :foo_table, :execute do |t|
+			t.integer :new_column_name
+		end
+		@test_migration.announce 'reverted, this should get appended'
+		assert_not_nil @test_migration.puts_message =~ /pt-online-schema-change executed, reverted, this should get appended/
+	end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: pt-online-migration
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- LeadKarma, LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: active record migration wrapper for pt-online-schema-change cli command
+email:
+- support@leadkarma.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitattributes
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pt_online_migration.rb
+- lib/pt_online_migration/pt_command_builder.rb
+- lib/pt_online_migration/version.rb
+- pt_online_migration.gemspec
+- test/pt_online_migration_test.rb
+homepage: http://www.leadkarma.com/
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: online schema migrations for mysql
+test_files:
+- test/pt_online_migration_test.rb