pt-osc 0.2.0 → 0.2.2

data/.travis.yml

@@ -7,13 +7,23 @@ rvm:
   - 2.0.0
   - 2.1.2
   - 2.1
+  - 2.2
+  - ruby-head
 env:
-  - CODECLIMATE_REPO_TOKEN=0b58d4e91bfac6ed6e48b31606f6792598a3a59c27bded19d58ef8406c09f57c
+  global:
+    - CODECLIMATE_REPO_TOKEN=0b58d4e91bfac6ed6e48b31606f6792598a3a59c27bded19d58ef8406c09f57c
+  matrix:
+    - PT_OSC_VERSION=LATEST
+    - PT_OSC_VERSION=DEVELOPMENT
+    - PT_OSC_VERSION=2.2.12
+    - PT_OSC_VERSION=2.2.11
+    - PT_OSC_VERSION=2.1.11
 cache:
   - bundler
   - apt
 bundler_args: --binstubs --retry=5
 before_script:
+  - $TRAVIS_BUILD_DIR/test/travisci/install_pt_osc.sh
   - unset RAILS_ENV
   - unset RACK_ENV
   - bundle exec rake db:test_create
@@ -22,3 +32,11 @@ script:
 addons:
   code_climate:
     repo_token: 0b58d4e91bfac6ed6e48b31606f6792598a3a59c27bded19d58ef8406c09f57c
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: 2.2
+    - env: PT_OSC_VERSION=DEVELOPMENT
+    - env: PT_OSC_VERSION=1.0.2
+    - env: PT_OSC_VERSION=2.0.5

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.2.2
+
+- fix bugs with string quoting, use shellwords instead
+- added integration tests for execution of pt-osc migrations
+- support `user` and `password` flags in percona config
+- pull `username` and `password` from database config when available
+
+## 0.2.1
+
+- properly quote string values in MySQL commands
+- added additional tests
+
 ## 0.2.0
 
 - support for setting the [`--check-alter` flag](http://www.percona.com/doc/percona-toolkit/2.1/pt-online-schema-change.html#cmdoption-pt-online-schema-change--%5Bno%5Dcheck-alter)

data/README.md

@@ -41,6 +41,8 @@ Additional/modified options for the `percona` hash include:
   - `check-alter`: When set to `false`, `ALTER` commands will not be checked when executing (same as [`--no-check-alter`](http://www.percona.com/doc/percona-toolkit/2.1/pt-online-schema-change.html#cmdoption-pt-online-schema-change--%5Bno%5Dcheck-alter))
   - `run_mode`: Specify `'execute'` to actually run `pt-online-schema-change` when the migration runs. Specify `'print'` to output the commands to run to STDOUT instead. Default is `'print'`.
   - `log`: Specify the file used for logging activity. Can be a relative or absolute path.
+  - `username`: By default, the command will use the username given in your standard database config. Specify a username here to override. Specify `false` to omit username (such as when using a `defaults-file`.
+  - `password`: By default, the command will use the password given in your standard database config. Specify a password here to override. Specify `false` to omit password (such as when using a `defaults-file`.
 
 #### Migrations
 
@@ -58,16 +60,23 @@ If you have migrations that you do not want to be run with `pt-online-schema-cha
 
 This gem is not considered production ready. There will be bugs.
 
-##### Compatibility
+##### Requirements and Compatibility
 
-`pt-osc` is tested against:
-- ActiveRecord 3.2 branch
-  - Ruby 1.9.3
-  - Ruby 2.0.0
-  - Ruby 2.1.2
-  - Ruby 2.1 latest
+###### ActiveRecord
+- 3.2 branch
 
-Support for other versions of Ruby or ActiveRecord is unknown and not guaranteed.
+###### Ruby
+- Ruby 1.9.3
+- Ruby 2.0.0
+- Ruby 2.1.2
+- Ruby 2.1 latest
+
+###### Percona Toolkit
+- 2.2 branch (latest)
+- 2.1 branch (latest)
+- does **not** work with 2.0 or 1.0 branches
+
+Support for other versions of these tools is unknown and not guaranteed.
 
 `pt-osc` requires the use of `pt-online-schema-change` 2.0 or later. Some options may not work with all versions.
 

data/lib/active_record/pt_osc_migration.rb

@@ -1,5 +1,6 @@
 require 'active_record/migration'
 require 'active_record/connection_adapters/mysql_pt_osc_adapter'
+require 'shellwords'
 
 module ActiveRecord
   class PtOscMigration < Migration
@@ -19,7 +20,18 @@ module ActiveRecord
         default: true,
         mutator: :execute_only,
         version: '>= 2.1',
-      }
+      },
+      'user' => {
+        mutator: :get_from_config,
+        arguments: {
+          key_name: 'username',
+        },
+        default: nil,
+      },
+      'password' => {
+        mutator: :get_from_config,
+        default: nil,
+      },
     }.freeze
 
     def self.percona_flags
@@ -98,7 +110,7 @@ module ActiveRecord
 
     def execute_sql_for_table(execute_sql, database_name, table_name, dry_run = true)
       command = percona_command(execute_sql, database_name, table_name, execute: !dry_run)
-      logger.info "Command is #{command}"
+      logger.info "Command is #{self.class.sanitize_command(command)}"
 
       success = Kernel.system command
 
@@ -122,7 +134,7 @@ module ActiveRecord
         announce 'Run the following commands:'
 
         [true, false].each do |dry_run|
-          write percona_command(execute_sql, database_name, table_name, execute: !dry_run)
+          write self.class.sanitize_command(percona_command(execute_sql, database_name, table_name, execute: !dry_run))
         end
 
       end
@@ -131,7 +143,7 @@ module ActiveRecord
     end
 
     def percona_command(execute_sql, database_name, table_name, options = {})
-      command = "pt-online-schema-change --alter '#{execute_sql}' D=#{database_name},t=#{table_name}"
+      command = ['pt-online-schema-change', '--alter', execute_sql || '', "D=#{database_name},t=#{table_name}"]
 
       # Whitelist
       options = HashWithIndifferentAccess.new(options)
@@ -150,7 +162,9 @@ module ActiveRecord
         options[flag] = flag_config[:default] if flag_config.key?(:default) && !options.key?(flag)
       end
 
-      "#{command}#{run_mode_flag(options)}#{command_flags(options)}"
+      command_parts = command + [run_mode_flag(options)] + command_flags(options)
+
+      command_parts.shelljoin
     end
 
     def self.tool_version
@@ -158,7 +172,7 @@ module ActiveRecord
     end
 
     def database_config
-      @db_config ||= (@connection.instance_variable_get(:@config) || ActiveRecord::Base.connection_config).with_indifferent_access
+      @db_config ||= raw_database_config.with_indifferent_access
     end
 
     def percona_config
@@ -178,8 +192,12 @@ module ActiveRecord
     end
 
     private
+    def raw_database_config
+      connection.pool.spec.config || ActiveRecord::Base.connection_config
+    end
+
     def command_flags(options)
-      options.map do |key, value|
+      options.flat_map do |key, value|
         next if key == 'execute'
         flag_options = self.class.percona_flags[key]
 
@@ -190,7 +208,8 @@ module ActiveRecord
 
         # Mutate the value if needed
         if flag_options.try(:key?, :mutator)
-          value = send(flag_options[:mutator], value, all_options: options, flag_name: key)
+          value = send(flag_options[:mutator], value, { all_options: options, flag_name: key }.merge(flag_options[:arguments] || {}))
+          next if value.nil? # Allow a mutator to determine the flag shouldn't be used
         end
 
         # Handle boolean flags
@@ -199,18 +218,25 @@ module ActiveRecord
           value = nil
         end
 
-        " --#{key} #{value}"
-      end.join('')
+        ["--#{key}", value]
+      end.compact
     end
 
     def run_mode_flag(options)
-      options[:execute] ? ' --execute' : ' --dry-run'
+      options[:execute] ? '--execute' : '--dry-run'
     end
 
     def self.get_tool_version
       `pt-online-schema-change --version`
     end
 
+    def self.sanitize_command(command)
+      command_parts = command.shellsplit
+      password_index = command_parts.find_index('--password')
+      command_parts[password_index + 1] = '_hidden_' unless password_index.nil? || command_parts.length == password_index + 1
+      command_parts.shelljoin
+    end
+
     # Flag mutators
     def make_path_absolute(path, _ = {})
       return path if path[0] == '/'
@@ -221,5 +247,16 @@ module ActiveRecord
     def execute_only(flag, options = {})
       options[:all_options][:execute] ? flag : self.class.percona_flags[options[:flag_name]][:default]
     end
+
+    def get_from_config(flag, options = {})
+      case flag
+      when nil
+        database_config[options[:key_name] || options[:flag_name]]
+      when false
+        nil
+      else
+        flag
+      end
+    end
   end
 end

data/lib/pt-osc/version.rb

@@ -1,5 +1,5 @@
 module Pt
   module Osc
-    VERSION = '0.2.0'
+    VERSION = '0.2.2'
   end
 end

data/test/functional/pt_osc_migration_functional_test.rb

@@ -24,7 +24,6 @@ class PtOscMigrationFunctionalTest < ActiveRecord::TestCase
           @table_name = Faker::Lorem.word
           @column_name = Faker::Lorem.word
           @index_name = Faker::Lorem.words.join('_')
-          @index_name_2 = "#{@index_name}_2"
 
           ActiveRecord::Base.connection.execute "DROP TABLE IF EXISTS `#{@table_name}`;"
           ActiveRecord::Base.connection.execute <<-SQL
@@ -41,14 +40,22 @@ class PtOscMigrationFunctionalTest < ActiveRecord::TestCase
 
         context 'a migration with only ALTER statements' do
           setup do
+            @renamed_column_name = Faker::Lorem.word
+            @new_column_name = Faker::Lorem.word
+            @new_table_name = Faker::Lorem.word
+            @index_name_2 = "#{@index_name}_2"
+            @index_name_3 = "#{@index_name}_3"
+
             TestMigration.class_eval <<-EVAL
             def change
-              rename_table  :#{@table_name}, :#{Faker::Lorem.word}
-              add_column    :#{@table_name}, :#{Faker::Lorem.word}, :integer
+              rename_table  :#{@table_name}, :#{@new_table_name}
+              add_column    :#{@table_name}, :#{@new_column_name}, :integer
               change_column :#{@table_name}, :#{@column_name}, :varchar, default: 'newthing'
-              rename_column :#{@table_name}, :#{@column_name}, :#{Faker::Lorem.word}
+              change_column :#{@table_name}, :#{@column_name}, :varchar, default: :newsymbol
+              rename_column :#{@table_name}, :#{@column_name}, :#{@renamed_column_name}
               remove_column :#{@table_name}, :#{@column_name}
               add_index     :#{@table_name}, :#{@column_name}, name: :#{@index_name_2}
+              add_index     :#{@table_name}, [:#{@new_column_name}, :#{@renamed_column_name}], name: :#{@index_name_3}, unique: true
               remove_index  :#{@table_name}, name: :#{@index_name}
             end
             EVAL
@@ -58,29 +65,29 @@ class PtOscMigrationFunctionalTest < ActiveRecord::TestCase
             TestMigration.send(:remove_method, :change)
           end
 
-          context 'ignoring schema lookups' do
+          context 'with suppressed output' do
             setup do
-              # Kind of a hacky way to do this
-              ignored_sql = ActiveRecord::SQLCounter.ignored_sql + [
-                /^SHOW FULL FIELDS FROM/,
-                /^SHOW COLUMNS FROM/,
-                /^SHOW KEYS FROM/,
-              ]
-              ActiveRecord::SQLCounter.any_instance.stubs(:ignore).returns(ignored_sql)
+              @migration.stubs(:write)
+              @migration.stubs(:announce)
             end
 
             teardown do
-              ActiveRecord::SQLCounter.any_instance.unstub(:ignore)
+              @migration.unstub(:write, :announce)
             end
 
-            context 'with suppressed output' do
+            context 'ignoring schema lookups' do
               setup do
-                @migration.stubs(:write)
-                @migration.stubs(:announce)
+                # Kind of a hacky way to do this
+                ignored_sql = ActiveRecord::SQLCounter.ignored_sql + [
+                  /^SHOW FULL FIELDS FROM/,
+                  /^SHOW COLUMNS FROM/,
+                  /^SHOW KEYS FROM/,
+                ]
+                ActiveRecord::SQLCounter.any_instance.stubs(:ignore).returns(ignored_sql)
               end
 
               teardown do
-                @migration.unstub(:write, :announce)
+                ActiveRecord::SQLCounter.any_instance.unstub(:ignore)
               end
 
               should 'not execute any queries immediately' do
@@ -101,6 +108,26 @@ class PtOscMigrationFunctionalTest < ActiveRecord::TestCase
                 end
               end
             end
+
+            context 'the resulting command' do
+              should 'have the correct pt-osc ALTER statement' do
+                expected_alter = <<-ALTER
+                  RENAME TO `#{@new_table_name}`
+                  ADD `#{@new_column_name}` int(11)
+                  CHANGE `#{@column_name}` `#{@column_name}` varchar DEFAULT 'newthing'
+                  CHANGE `#{@column_name}` `#{@column_name}` varchar DEFAULT 'newsymbol'
+                  CHANGE `#{@column_name}` `#{@renamed_column_name}` varchar(255) DEFAULT NULL
+                  DROP COLUMN `#{@column_name}`
+                  ADD  INDEX `#{@index_name_2}` (`#{@column_name}`)
+                  ADD UNIQUE INDEX `#{@index_name_3}` (`#{@new_column_name}`, `#{@renamed_column_name}`)
+                  DROP INDEX `#{@index_name}`
+                ALTER
+                expected_alter.strip!.gsub!(/^\s*/, '').gsub!("\n", ',')
+
+                @migration.change
+                assert_equal expected_alter, @migration.connection.get_commands_string(@table_name)
+              end
+            end
           end
         end
       end

data/test/integration/pt_osc_migration_integration_test.rb

@@ -0,0 +1,102 @@
+require 'test_helper'
+
+class PtOscMigrationIntegrationTest < ActiveRecord::TestCase
+  class TestMigration < ActiveRecord::PtOscMigration; end
+
+  context 'a migration' do
+    setup do
+      @migration = TestMigration.new
+      @migration.stubs(:logger).returns(stub_everything)
+    end
+
+    context 'connected to a pt-osc database' do
+      setup do
+        ActiveRecord::Base.establish_connection(test_spec('test_execute'))
+        @migration.instance_variable_set(:@connection, ActiveRecord::Base.connection)
+      end
+
+      context 'on an existing table with an existing column' do
+        setup do
+          @table_name = Faker::Lorem.word
+          @index_name = Faker::Lorem.words.join('_')
+
+          ActiveRecord::Base.connection.execute "DROP TABLE IF EXISTS `#{@table_name}`;"
+          # can't use "id" because it's generated by Faker::Lorem.word :)
+          ActiveRecord::Base.connection.execute <<-SQL
+          CREATE TABLE `#{@table_name}` (
+            `primary` int(11) NOT NULL AUTO_INCREMENT,
+            PRIMARY KEY (`primary`)
+          );
+          SQL
+        end
+
+        teardown do
+          ActiveRecord::Base.connection.execute "DROP TABLE IF EXISTS `#{@table_name}`;"
+        end
+
+        context 'new columns' do
+          setup do
+            @new_column_name = Faker::Lorem.word
+            @arguments = [
+              nil,
+              @migration,
+              @table_name,
+              @new_column_name,
+              {}
+            ]
+          end
+
+          # Rails' "magic" time, for Time columns
+          # https://github.com/rails/rails/blob/fcf9b712b1dbbcb8f48644e6f20676ad9480ba66/activerecord/lib/active_record/type/time.rb#L16
+          base_date = Time.utc(2000, 1, 1, 0, 0, 0)
+
+          datetime_value = Time.at(Time.now.to_i).utc # Date types we're testing don't have sub-second precision
+          date_value = Time.utc(datetime_value.year, datetime_value.month, datetime_value.day)
+          rails_time_value = Time.utc(base_date.year, base_date.month, base_date.day, datetime_value.hour, datetime_value.min, datetime_value.sec)
+
+          [
+            { type: :integer, default: 42 },
+            { type: :string, default: ["'foobar'", ':bazqux'], expected_default: ['foobar', 'bazqux'] },
+            { type: :text, default: nil }, # TEXT columns cannot have a default http://dev.mysql.com/doc/refman/5.7/en/blob.html#idm140380410069472
+            { type: :float, default: 3.14159 },
+            { type: :datetime, default: "'#{datetime_value.strftime('%F %T')}'", expected_default: datetime_value },
+            { type: :time, default: "'#{datetime_value.strftime('%T')}'", expected_default: rails_time_value },
+            { type: :date, default: "'#{datetime_value.strftime('%F')}'", expected_default: date_value },
+            { type: :binary, default: nil }, # BLOB columns cannot have a default http://dev.mysql.com/doc/refman/5.7/en/blob.html#idm140380410069472
+            { type: :boolean, default: [false, true] },
+          ].each do |test|
+
+            defaults = [test[:default]].flatten(1).compact # remove nils for columns that can't have a default
+            expected_defaults = test[:expected_default] ? [test[:expected_default]].flatten(1) : defaults
+
+            should "add a nullable #{test[:type]} column with default null" do
+              column_name = "#{@new_column_name}_#{test[:type]}"
+              @arguments[0] = "add_column :#{@table_name}, :#{column_name}, :#{test[:type]}, default: nil, null: true"
+              @arguments[-2] = column_name
+              @arguments[-1] = { type: test[:type], null: true, default: nil }
+              migrate_and_test_field *@arguments
+            end
+
+            defaults.each_with_index do |default, index|
+              should "add a nullable #{test[:type]} column with default value #{default}" do
+                column_name = "#{@new_column_name}_#{test[:type]}"
+                @arguments[0] = "add_column :#{@table_name}, :#{column_name}, :#{test[:type]}, default: #{default}, null: true"
+                @arguments[-2] = column_name
+                @arguments[-1] = { type: test[:type], null: true, default: expected_defaults[index] }
+                migrate_and_test_field *@arguments
+              end
+
+              should "add a not-nullable #{test[:type]} column with default value #{default}" do
+                column_name = "#{@new_column_name}_#{test[:type]}"
+                @arguments[0] = "add_column :#{@table_name}, :#{column_name}, :#{test[:type]}, default: #{default}, null: false"
+                @arguments[-2] = column_name
+                @arguments[-1] = { type: test[:type], null: false, default: expected_defaults[index] }
+                migrate_and_test_field *@arguments
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -18,6 +18,29 @@ def test_spec(key = 'test')
   test_spec
 end
 
+def migrate_and_test_field(command, migration, table_name, field_name, assertions = {})
+  migration.class.class_eval "def change; #{command}; end"
+
+  migration.stubs(:write)
+  migration.stubs(:announce)
+  migration.migrate(:up)
+  migration.unstub(:write, :announce)
+
+  field = ActiveRecord::Base.connection.columns(table_name).find { |f| f.name == field_name }
+  if assertions.delete(:exists) == false
+    assert_nil field
+  else
+    assert_not_nil field
+    assert_equal field_name, field.name
+    assertions.each do |test, expected|
+      actual = field.send(test)
+      assert_equal expected, actual, "Expected #{command} to produce a field of #{test} #{expected}, but it was #{actual}"
+    end
+  end
+
+  migration.class.send(:remove_method, :change)
+end
+
 # SQLCounter is part of ActiveRecord but is not distributed with the gem (used for internal tests only)
 # see https://github.com/rails/rails/blob/3-2-stable/activerecord/test/cases/helper.rb#L59
 module ActiveRecord

data/test/travisci/install_pt_osc.sh

@@ -0,0 +1,30 @@
+#!/bin/bash
+set -ox
+
+VERSION=$(lsb_release -c -s)
+sudo apt-key adv --keyserver keys.gnupg.net --recv-keys 1C4CBDCDCD2EFD2A
+
+# Add the right repository
+case $PT_OSC_VERSION in
+  DEVELOPMENT) echo "deb http://repo.percona.com/apt $VERSION main testing" | sudo tee -a /etc/apt/sources.list; ;;
+  *) echo "deb http://repo.percona.com/apt $VERSION main" | sudo tee -a /etc/apt/sources.list; ;;
+esac
+
+# Update
+sudo apt-get update -qq
+
+# Install the right version
+case $PT_OSC_VERSION in
+  LATEST|DEVELOPMENT) sudo apt-get install -y percona-toolkit; ;;
+  2.2.*)
+    wget http://www.percona.com/downloads/percona-toolkit/"$PT_OSC_VERSION"/deb/percona-toolkit_"$PT_OSC_VERSION"_all.deb
+    sudo dpkg -i percona-toolkit_"$PT_OSC_VERSION"_all.deb
+    sudo apt-get install -f -y
+    ;;
+  *)
+    wget http://www.percona.com/downloads/percona-toolkit/"$PT_OSC_VERSION"/percona-toolkit_"$PT_OSC_VERSION"_all.deb
+    sudo dpkg -i percona-toolkit_"$PT_OSC_VERSION"_all.deb
+    sudo apt-get install -f -y
+    ;;
+esac
+

data/test/unit/pt_osc_migration_unit_test.rb

@@ -6,10 +6,13 @@ class PtOscMigrationUnitTest < Test::Unit::TestCase
       @migration = ActiveRecord::PtOscMigration.new
       @tool_version = states('tool_version').starts_as('100')
       ActiveRecord::PtOscMigration.stubs(:tool_version).returns(Gem::Version.new('100')).when(@tool_version.is('100'))
+      @migration.stubs(:write)
+      @migration.stubs(:announce)
     end
 
     teardown do
       ActiveRecord::PtOscMigration.unstub(:tool_version)
+      @migration.unstub(:write, :announce)
     end
 
     context '#percona_command' do
@@ -53,7 +56,7 @@ class PtOscMigrationUnitTest < Test::Unit::TestCase
 
           should 'set missing flags to default values' do
             flags_with_defaults = ActiveRecord::PtOscMigration.percona_flags.select do |flag, config|
-              config.key?(:default) && flag != 'execute' && !config[:boolean]
+              !config[:default].nil? && flag != 'execute' && !config[:boolean]
             end
 
             command = @migration.send(:percona_command, '', '', '')
@@ -158,6 +161,98 @@ class PtOscMigrationUnitTest < Test::Unit::TestCase
             @migration.send(:percona_command, '', '', '', @options)
           end
         end
+
+        context 'user flag' do
+          context 'with normal database username specified' do
+            setup do
+              @migration.stubs(:raw_database_config).returns(username: 'foobar')
+            end
+
+            should 'add the user to the command' do
+              command = @migration.send(:percona_command, '', '', '')
+              assert command.include?('--user foobar'), "command #{command} did not include user"
+            end
+          end
+
+          context 'with user specified in percona config' do
+            setup do
+              @migration.stubs(:raw_database_config).returns(percona: { user: 'foobar' })
+            end
+
+            should 'add the user to the command' do
+              command = @migration.send(:percona_command, '', '', '')
+              assert command.include?('--user foobar'), "command #{command} did not include user"
+            end
+          end
+
+          context 'with user specified in database and percona config' do
+            setup do
+              @migration.stubs(:raw_database_config).returns(username: 'foobar', percona: { user: 'bazqux' })
+            end
+
+            should 'add the percona user to the command' do
+              command = @migration.send(:percona_command, '', '', '')
+              assert command.include?('--user bazqux'), "command #{command} did not include the right user"
+            end
+          end
+
+          context 'with user forbidden in percona config' do
+            setup do
+              @migration.stubs(:raw_database_config).returns(username: 'foobar', percona: { user: false })
+            end
+
+            should 'not add a user to the command' do
+              command = @migration.send(:percona_command, '', '', '')
+              assert !command.include?('--user foobar'), "command #{command} included user but should not have"
+            end
+          end
+        end
+
+        context 'password flag' do
+          context 'with normal database password specified' do
+            setup do
+              @migration.stubs(:raw_database_config).returns(password: 'foobar')
+            end
+
+            should 'add the password to the command' do
+              command = @migration.send(:percona_command, '', '', '')
+              assert command.include?('--password foobar'), "command #{command} did not include password"
+            end
+          end
+
+          context 'with password specified in percona config' do
+            setup do
+              @migration.stubs(:raw_database_config).returns(percona: { password: 'foobar' })
+            end
+
+            should 'add the password to the command' do
+              command = @migration.send(:percona_command, '', '', '')
+              assert command.include?('--password foobar'), "command #{command} did not include password"
+            end
+          end
+
+          context 'with password specified in database and percona config' do
+            setup do
+              @migration.stubs(:raw_database_config).returns(password: 'foobar', percona: { password: 'bazqux' })
+            end
+
+            should 'add the percona password to the command' do
+              command = @migration.send(:percona_command, '', '', '')
+              assert command.include?('--password bazqux'), "command #{command} did not include the right password"
+            end
+          end
+
+          context 'with password forbidden in percona config' do
+            setup do
+              @migration.stubs(:raw_database_config).returns(password: 'foobar', percona: { password: false })
+            end
+
+            should 'not add a password to the command' do
+              command = @migration.send(:percona_command, '', '', '')
+              assert !command.include?('--password foobar'), "command #{command} included password but should not have"
+            end
+          end
+        end
       end
 
       context 'connected to a pt-osc database in print mode' do
@@ -249,6 +344,17 @@ class PtOscMigrationUnitTest < Test::Unit::TestCase
       end
     end
 
+    context '#sanitize_command' do
+      should 'strip password out of commands' do
+        assert_equal 'pt-online-schema-change --password _hidden_', @migration.class.send(:sanitize_command, 'pt-online-schema-change --password supersecret')
+        assert_equal 'pt-online-schema-change --password _hidden_', @migration.class.send(:sanitize_command, 'pt-online-schema-change --password %&$^*(!(#)CD&`+')
+        assert_equal 'pt-online-schema-change --password _hidden_', @migration.class.send(:sanitize_command, 'pt-online-schema-change --password "who uses spaces in passwords?"')
+        assert_equal 'pt-online-schema-change --other --password _hidden_ --fields', @migration.class.send(:sanitize_command, 'pt-online-schema-change --other --password supersecret --fields')
+        assert_equal 'pt-online-schema-change --other --fields --password _hidden_', @migration.class.send(:sanitize_command, 'pt-online-schema-change --other --fields --password supersecret')
+        assert_equal 'pt-online-schema-change --password', @migration.class.send(:sanitize_command, 'pt-online-schema-change --password')
+      end
+    end
+
     context '#make_path_absolute' do
       context 'with an absolute path' do
         setup do
@@ -289,6 +395,28 @@ class PtOscMigrationUnitTest < Test::Unit::TestCase
       end
     end
 
+    context '#get_from_config' do
+      setup do
+        @migration.stubs(:raw_database_config).returns(flag: 'foobar', other_flag: 'mooshu')
+      end
+
+      should 'return nil if false is specified' do
+        assert_nil @migration.send(:get_from_config, false)
+      end
+
+      should 'get the value from the config if it was not specified' do
+        assert_equal 'foobar', @migration.send(:get_from_config, nil, flag_name: 'flag')
+      end
+
+      should 'prefer the key name if given explicitly' do
+        assert_equal 'mooshu', @migration.send(:get_from_config, nil, flag_name: 'flag', key_name: 'other_flag')
+      end
+
+      should 'pass string values through' do
+        assert_equal 'bazqux', @migration.send(:get_from_config, 'bazqux')
+      end
+    end
+
     context '#execute_pt_osc' do
       context 'with a pt-osc connection' do
         setup do
@@ -306,7 +434,7 @@ class PtOscMigrationUnitTest < Test::Unit::TestCase
         context 'connected to a database' do
           setup do
             @database_name = Faker::Lorem.word
-            @migration.stubs(:database_config).returns(database: @database_name)
+            @migration.stubs(:raw_database_config).returns(database: @database_name)
           end
 
           teardown do
@@ -424,9 +552,9 @@ class PtOscMigrationUnitTest < Test::Unit::TestCase
           end
 
           should 'log the command' do
-            @migration.expects(:percona_command).returns('<<percona command>>')
+            @migration.expects(:percona_command).returns('percona command')
             @migration.send(:execute_sql_for_table, nil, nil, nil)
-            assert '<<percona command>>'.in?(@dummy_log.string), 'Log entry did not contain percona command'
+            assert 'percona command'.in?(@dummy_log.string), 'Log entry did not contain percona command'
           end
 
           context 'with successful execution' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pt-osc
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-15 00:00:00.000000000 Z
+date: 2015-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -229,7 +229,9 @@ files:
 - test/dummy/script/rails
 - test/functional/mysql_pt_osc_adapter_test.rb
 - test/functional/pt_osc_migration_functional_test.rb
+- test/integration/pt_osc_migration_integration_test.rb
 - test/test_helper.rb
+- test/travisci/install_pt_osc.sh
 - test/unit/mysql_pt_osc_adapter_test.rb
 - test/unit/pt_osc_migration_unit_test.rb
 homepage: https://github.com/steverice/pt-osc
@@ -246,7 +248,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2714793465659180068
+      hash: 999232518907264640
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -255,7 +257,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2714793465659180068
+      hash: 999232518907264640
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -301,6 +303,8 @@ test_files:
 - test/dummy/script/rails
 - test/functional/mysql_pt_osc_adapter_test.rb
 - test/functional/pt_osc_migration_functional_test.rb
+- test/integration/pt_osc_migration_integration_test.rb
 - test/test_helper.rb
+- test/travisci/install_pt_osc.sh
 - test/unit/mysql_pt_osc_adapter_test.rb
 - test/unit/pt_osc_migration_unit_test.rb