pt-osc 0.1.3 → 0.2.0

data/.travis.yml

@@ -3,7 +3,6 @@ branches:
     - master
 language: ruby
 rvm:
-  - 1.9.2
   - 1.9.3
   - 2.0.0
   - 2.1.2

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 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)
+- internal improvements to the way `percona` options are handled
+- removed support for Ruby 1.9.2
+
 ## 0.1.3
 
 - fix for loading percona config

data/README.md

@@ -38,9 +38,22 @@ environment:
 
 Additional/modified options for the `percona` hash include:
   - `defaults-file`: Can be specified as an absolute path (with leading `/`) or relative (without). Relative paths will be treated as relative to your project's working directory.
+  - `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.
 
+#### Migrations
+
+To run migrations with `pt-online-schema-change`, you need to explicitly opt them in by changing their parent class to `ActiveRecord::PtOscMigration`. For instance, if your migration was
+```ruby
+class CreateTeams < ActiveRecord::Migration
+```
+you should change it to
+```ruby
+class CreateTeams < ActiveRecord::PtOscMigration
+```
+If you have migrations that you do not want to be run with `pt-online-schema-change`, leave the same parent class and they will be run normally.
+
 ## Caveats
 
 This gem is not considered production ready. There will be bugs.
@@ -49,7 +62,6 @@ This gem is not considered production ready. There will be bugs.
 
 `pt-osc` is tested against:
 - ActiveRecord 3.2 branch
-  - Ruby 1.9.2
   - Ruby 1.9.3
   - Ruby 2.0.0
   - Ruby 2.1.2
@@ -57,6 +69,8 @@ This gem is not considered production ready. There will be bugs.
 
 Support for other versions of Ruby or ActiveRecord 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.
+
 `pt-osc` is compatible with versions 0.5.0 and later of [zdennis/activerecord-import](https://github.com/zdennis/activerecord-import). It will not work with earlier versions.
 
 #License and Copyright

data/lib/active_record/pt_osc_migration.rb

@@ -9,10 +9,17 @@ module ActiveRecord
         mutator: :make_path_absolute,
       },
       'recursion-method' => {
+        version: '>= 2.1',
       },
       'execute' => {
         default: false,
       },
+      'check-alter' => {
+        boolean: true,
+        default: true,
+        mutator: :execute_only,
+        version: '>= 2.1',
+      }
     }.freeze
 
     def self.percona_flags
@@ -140,18 +147,14 @@ module ActiveRecord
 
       # Set defaults
       self.class.percona_flags.each do |flag, flag_config|
-        options[flag] ||= flag_config[:default] if flag_config.key?(:default)
+        options[flag] = flag_config[:default] if flag_config.key?(:default) && !options.key?(flag)
       end
 
-      # Determine run mode
-      command += options.delete(:execute) ? ' --execute' : ' --dry-run'
-
-      options.each do |key, value|
-        value = send(self.class.percona_flags[key][:mutator], value) if self.class.percona_flags[key].try(:key?, :mutator)
-        command += " --#{key} #{value}"
-      end
+      "#{command}#{run_mode_flag(options)}#{command_flags(options)}"
+    end
 
-      command
+    def self.tool_version
+      @_tool_version ||= Gem::Version.new(get_tool_version.sub('pt-online-schema-change', '').strip)
     end
 
     def database_config
@@ -175,11 +178,48 @@ module ActiveRecord
     end
 
     private
+    def command_flags(options)
+      options.map do |key, value|
+        next if key == 'execute'
+        flag_options = self.class.percona_flags[key]
+
+        # Satisfy version requirements
+        if flag_options.try(:key?, :version)
+          next unless Gem::Requirement.new(flag_options[:version]).satisfied_by? self.class.tool_version
+        end
+
+        # Mutate the value if needed
+        if flag_options.try(:key?, :mutator)
+          value = send(flag_options[:mutator], value, all_options: options, flag_name: key)
+        end
+
+        # Handle boolean flags
+        if flag_options.try(:[], :boolean)
+          key = "no-#{key}" unless value
+          value = nil
+        end
+
+        " --#{key} #{value}"
+      end.join('')
+    end
+
+    def run_mode_flag(options)
+      options[:execute] ? ' --execute' : ' --dry-run'
+    end
+
+    def self.get_tool_version
+      `pt-online-schema-change --version`
+    end
+
     # Flag mutators
-    def make_path_absolute(path)
+    def make_path_absolute(path, _ = {})
       return path if path[0] == '/'
       # If path is not already absolute, treat it as relative to the app root
       File.expand_path(path, Dir.getwd)
     end
+
+    def execute_only(flag, options = {})
+      options[:all_options][:execute] ? flag : self.class.percona_flags[options[:flag_name]][:default]
+    end
   end
 end

data/lib/pt-osc/version.rb

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

data/pt-osc.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'shoulda'
   spec.add_development_dependency 'faker'
-  spec.add_development_dependency 'mocha'
+  spec.add_development_dependency 'mocha', '>= 0.9.0'
 
   # For testing using dummy Rails app
   spec.add_development_dependency 'rails', '~> 3.2'

data/test/config/database.yml

@@ -24,3 +24,8 @@ test_execute_string:
   <<: *test
   percona:
     run_mode: 'execute'
+
+test_no_check_alter:
+  <<: *test
+  percona:
+    check-alter: false

data/test/functional/pt_osc_migration_functional_test.rb

@@ -3,36 +3,45 @@ require 'test_helper'
 class PtOscMigrationFunctionalTest < ActiveRecord::TestCase
   class TestMigration < ActiveRecord::PtOscMigration; end
 
-  context 'a migration connected to a pt-osc database' do
+  context 'a migration' do
     setup do
-      ActiveRecord::Base.establish_connection(test_spec)
       @migration = TestMigration.new
-      @migration.instance_variable_set(:@connection, ActiveRecord::Base.connection)
+      ActiveRecord::PtOscMigration.stubs(:tool_version).returns(Gem::Version.new('100'))
     end
 
-    context 'on an existing table with an existing column' do
+    teardown do
+      ActiveRecord::PtOscMigration.unstub(:tool_version)
+    end
+
+    context 'connected to a pt-osc database' do
       setup do
-        @table_name = Faker::Lorem.word
-        @column_name = Faker::Lorem.word
-        @index_name = Faker::Lorem.words.join('_')
-        @index_name_2 = "#{@index_name}_2"
+        ActiveRecord::Base.establish_connection(test_spec)
+        @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
+          @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
+          ActiveRecord::Base.connection.execute "DROP TABLE IF EXISTS `#{@table_name}`;"
+          ActiveRecord::Base.connection.execute <<-SQL
           CREATE TABLE `#{@table_name}` (
             `#{@column_name}` varchar(255) DEFAULT NULL,
             KEY `#{@index_name}` (`#{@column_name}`)
           );
-        SQL
-      end
+          SQL
+        end
 
-      teardown do
-        ActiveRecord::Base.connection.execute "DROP TABLE IF EXISTS `#{@table_name}`;"
-      end
+        teardown do
+          ActiveRecord::Base.connection.execute "DROP TABLE IF EXISTS `#{@table_name}`;"
+        end
 
-      context 'a migration with only ALTER statements' do
-        setup do
-          TestMigration.class_eval <<-EVAL
+        context 'a migration with only ALTER statements' do
+          setup do
+            TestMigration.class_eval <<-EVAL
             def change
               rename_table  :#{@table_name}, :#{Faker::Lorem.word}
               add_column    :#{@table_name}, :#{Faker::Lorem.word}, :integer
@@ -42,58 +51,79 @@ class PtOscMigrationFunctionalTest < ActiveRecord::TestCase
               add_index     :#{@table_name}, :#{@column_name}, name: :#{@index_name_2}
               remove_index  :#{@table_name}, name: :#{@index_name}
             end
-          EVAL
-        end
-
-        teardown do
-          TestMigration.send(:remove_method, :change)
-        end
-
-        context 'ignoring schema lookups' 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)
+            EVAL
           end
 
           teardown do
-            ActiveRecord::SQLCounter.any_instance.unstub(:ignore)
+            TestMigration.send(:remove_method, :change)
           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)
-            end
-
-            should 'not execute any queries immediately' do
-              assert_no_queries { @migration.change }
+              ActiveRecord::SQLCounter.any_instance.unstub(:ignore)
             end
 
-            context 'with a working pt-online-schema-change' do
+            context 'with suppressed output' do
               setup do
-                Kernel.expects(:system).with(regexp_matches(/^pt-online-schema-change/)).twice.returns(true)
+                @migration.stubs(:write)
+                @migration.stubs(:announce)
               end
 
               teardown do
-                Kernel.unstub(:system)
+                @migration.unstub(:write, :announce)
               end
 
-              should 'not directly execute any queries when migrating' do
-                assert_no_queries { @migration.migrate(:up) }
+              should 'not execute any queries immediately' do
+                assert_no_queries { @migration.change }
+              end
+
+              context 'with a working pt-online-schema-change' do
+                setup do
+                  Kernel.expects(:system).with(regexp_matches(/^pt-online-schema-change/)).twice.returns(true)
+                end
+
+                teardown do
+                  Kernel.unstub(:system)
+                end
+
+                should 'not directly execute any queries when migrating' do
+                  assert_no_queries { @migration.migrate(:up) }
+                end
               end
             end
           end
         end
       end
     end
+
+    context 'connected without checking alter statements' do
+      setup do
+        @old_connection = @migration.instance_variable_get(:@connection)
+        ActiveRecord::Base.establish_connection(test_spec('test_no_check_alter'))
+        @migration.instance_variable_set(:@connection, ActiveRecord::Base.connection)
+      end
+
+      should 'check ALTER when dry-running sql' do
+        command = @migration.send(:percona_command, nil, nil, nil, execute: false)
+        assert command.include?('--check-alter'), "Command '#{command}' did not include ALTER check."
+        assert_equal false, command.include?('--no-check-alter'), "Command '#{command}' should not disable ALTER check."
+      end
+
+      should 'not check ALTER when executing sql' do
+        command = @migration.send(:percona_command, nil, nil, nil, execute: true)
+        assert command.include?('--no-check-alter'), "Command '#{command}' should not include ALTER check."
+        assert_equal false, command.include?('--check-alter'), "Command '#{command}' should disable ALTER check."
+      end
+    end
   end
 end

data/test/unit/pt_osc_migration_unit_test.rb

@@ -4,6 +4,12 @@ class PtOscMigrationUnitTest < Test::Unit::TestCase
   context 'with a pt-osc migration' do
     setup do
       @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'))
+    end
+
+    teardown do
+      ActiveRecord::PtOscMigration.unstub(:tool_version)
     end
 
     context '#percona_command' do
@@ -47,7 +53,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.key?(:default) && flag != 'execute' && !config[:boolean]
             end
 
             command = @migration.send(:percona_command, '', '', '')
@@ -58,6 +64,78 @@ class PtOscMigrationUnitTest < Test::Unit::TestCase
           end
         end
 
+        context 'with flags having version requirements' do
+          setup do
+            flags = ActiveRecord::PtOscMigration.percona_flags.merge({ 'flag-with-requirement' => { version: '> 2.0' } })
+            ActiveRecord::PtOscMigration.stubs(:percona_flags).returns(flags)
+          end
+
+          teardown do
+            ActiveRecord::PtOscMigration.unstub(:percona_flags)
+          end
+
+          context 'with matching tool version' do
+            setup do
+              @old_tool_version = @tool_version.current_state
+              ActiveRecord::PtOscMigration.stubs(:tool_version).returns(Gem::Version.new('2.6.40')).when(@tool_version.is('2.6.40'))
+              @tool_version.become('2.6.40')
+            end
+
+            teardown do
+              @tool_version.become(@old_tool_version)
+            end
+
+            should 'contain the flag in the output' do
+              command = @migration.send(:percona_command, '', '', '', 'flag-with-requirement' => 'foobar')
+              assert command.include?('--flag-with-requirement foobar'),
+                     "Flag was not included in command '#{command}' despite meeting version requirement."
+            end
+          end
+
+          context 'with non-matching tool version' do
+            setup do
+              @old_tool_version = @tool_version.current_state
+              ActiveRecord::PtOscMigration.stubs(:tool_version).returns(Gem::Version.new('1.12')).when(@tool_version.is('1.12'))
+              @tool_version.become('1.12')
+            end
+
+            teardown do
+              @tool_version.become(@old_tool_version)
+            end
+
+            should 'not contain the flag in the output' do
+              command = @migration.send(:percona_command, '', '', '', 'flag-with-requirement' => 'foobar')
+              assert_equal false, command.include?('--flag-with-requirement'),
+                           "Flag was included in command '#{command}' despite not meeting version requirement."
+            end
+          end
+        end
+
+        context 'with boolean flags' do
+          setup do
+            flags = ActiveRecord::PtOscMigration.percona_flags.merge({ 'boolean-flag' => { boolean: true } })
+            ActiveRecord::PtOscMigration.stubs(:percona_flags).returns(flags)
+          end
+
+          teardown do
+            ActiveRecord::PtOscMigration.unstub(:percona_flags)
+          end
+
+          should 'include just the flag (no value) when true' do
+            command = @migration.send(:percona_command, '', '', '', 'boolean-flag' => true)
+            matches_eof = command =~ /\-\-boolean\-flag\s*$/
+            matches_middle = command =~ /\-\-boolean\-flag\s*\-\-/
+            assert matches_eof || matches_middle, "Boolean flag was malformed in command '#{command}'."
+          end
+
+          should 'include a "no" version of the flag when false' do
+            command = @migration.send(:percona_command, '', '', '', 'boolean-flag' => false)
+            matches_eof = command =~ /\-\-no\-boolean\-flag\s*$/
+            matches_middle = command =~ /\-\-no\-boolean\-flag\s*\-\-/
+            assert matches_eof || matches_middle, "Boolean flag was malformed in command '#{command}'."
+          end
+        end
+
         should 'perform a dry run if execute not specified' do
           command = @migration.send(:percona_command, '', '', '')
           assert command.include?('--dry-run')
@@ -76,7 +154,7 @@ class PtOscMigrationUnitTest < Test::Unit::TestCase
           end
 
           should 'call #make_path_absolute' do
-            @migration.expects(:make_path_absolute).with(@path)
+            @migration.expects(:make_path_absolute).with(@path, anything)
             @migration.send(:percona_command, '', '', '', @options)
           end
         end
@@ -193,6 +271,24 @@ class PtOscMigrationUnitTest < Test::Unit::TestCase
       end
     end
 
+    context '#execute_only' do
+      should 'return the default flag value during a dry run' do
+        ActiveRecord::PtOscMigration.stubs(:percona_flags).returns('foo' => { default: 'bar' })
+        assert_equal 'bar', @migration.send(:execute_only, 'baz', all_options: { execute: false }, flag_name: 'foo')
+        ActiveRecord::PtOscMigration.unstub(:percona_flags)
+      end
+
+      should 'return nil during a dry run if there is no default value' do
+        ActiveRecord::PtOscMigration.stubs(:percona_flags).returns('foo' => {})
+        assert_nil @migration.send(:execute_only, 'baz', all_options: { execute: false }, flag_name: 'foo')
+        ActiveRecord::PtOscMigration.unstub(:percona_flags)
+      end
+
+      should 'pass the flag through when executing' do
+        assert_equal 'baz', @migration.send(:execute_only, 'baz', all_options: { execute: true }, flag_name: 'foo')
+      end
+    end
+
     context '#execute_pt_osc' do
       context 'with a pt-osc connection' do
         setup do
@@ -425,4 +521,21 @@ class PtOscMigrationUnitTest < Test::Unit::TestCase
       end
     end
   end
+
+  context '#tool_version' do
+    context 'with known tool version' do
+      setup do
+        ActiveRecord::PtOscMigration.stubs(:get_tool_version).returns('pt-online-schema-change 2.2.7')
+      end
+
+      teardown do
+        ActiveRecord::PtOscMigration.unstub(:get_tool_version)
+      end
+
+      should 'return a Gem::Version with the expected value' do
+        assert_instance_of Gem::Version, ActiveRecord::PtOscMigration.send(:tool_version)
+        assert_equal '2.2.7', ActiveRecord::PtOscMigration.send(:tool_version).version
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pt-osc
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-05 00:00:00.000000000 Z
+date: 2015-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,7 +82,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -90,7 +90,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -246,7 +246,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -738209304282433145
+      hash: 2714793465659180068
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -255,7 +255,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -738209304282433145
+      hash: 2714793465659180068
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23