pt-osc 0.0.4 → 0.0.5

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.0.5
+
+- remove dependence on ActiveSupport/Rails
+- can specify log file in `percona` config
+
 ## 0.0.4
 
 - Make sure `active_record/migration` is `require`d

data/README.md

@@ -39,6 +39,7 @@ 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.
   - `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.
 
 ## Caveats
 

data/lib/active_record/connection_adapters/pt_osc_adapter.rb

@@ -109,25 +109,23 @@ module ActiveRecord
       end
 
       def get_commands_string(table_name)
-        @osc_commands ||= {}
-        @osc_commands[table_name] ||= []
-        @osc_commands[table_name].join(',')
+        get_commands[table_name] ||= []
+        get_commands[table_name].join(',')
       end
 
       def get_commanded_tables
-        @osc_commands.keys
+        get_commands.keys
       end
 
       protected
       def add_command(table_name, command)
-        @osc_commands ||= {}
-        @osc_commands[table_name] ||= []
-        @osc_commands[table_name] << command
+        get_commands[table_name] ||= []
+        get_commands[table_name] << command
       end
 
-      def get_commands(table_name)
+      def get_commands(table_name = nil)
         @osc_commands ||= {}
-        @osc_commands[table_name]
+        table_name.nil? ? @osc_commands : @osc_commands[table_name]
       end
     end
   end

data/lib/active_record/pt_osc_migration.rb

@@ -71,33 +71,36 @@ module ActiveRecord
     protected
     def execute_pt_osc
       return unless @connection.is_a? ActiveRecord::ConnectionAdapters::PtOscAdapter
+      return if @connection.get_commanded_tables.empty?
 
-      @connection.get_commanded_tables.each do |table_name|
-        execute_sql = @connection.get_commands_string(table_name)
+      database_name = database_config[:database]
+      announce 'running pt-online-schema-change'
 
-        Rails.logger.tagged('pt-osc') do |logger|
+      @connection.get_commanded_tables.each { |table| migrate_table(database_name, table) }
+      @connection.clear_commands
+    end
 
-          database_name = database_config[:database]
+    def migrate_table(database_name, table_name)
+      execute_sql = @connection.get_commands_string(table_name)
 
-          logger.info "Running on #{database_name}|#{table_name}: #{execute_sql}"
-          announce 'running pt-online-schema-change'
+      logger.info "Running on #{database_name}|#{table_name}: #{execute_sql}"
 
-          [true, false].each do |dry_run|
-            command = percona_command(execute_sql, database_name, table_name, execute: !dry_run)
-            logger.info "Command is #{command}"
-            success = Kernel.system command
-            if success
-              logger.info "Successfully #{dry_run ? 'dry ran' : 'executed'} on #{database_name}|#{table_name}: #{execute_sql}"
-            else
-              failure_message = "Unable to #{dry_run ? 'dry run' : 'execute'} query on #{database_name}|#{table_name}: #{execute_sql}"
-              logger.error failure_message
-              raise RuntimeError.new(failure_message)
-            end
-          end
-        end
-      end
+      [true, false].each { |dry_run| execute_sql_for_table(execute_sql, database_name, table_name, dry_run) }
+    end
 
-      @connection.clear_commands
+    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}"
+
+      success = Kernel.system command
+
+      if success
+        logger.info "Successfully #{dry_run ? 'dry ran' : 'executed'} on #{database_name}|#{table_name}: #{execute_sql}"
+      else
+        failure_message = "Unable to #{dry_run ? 'dry run' : 'execute'} query on #{database_name}|#{table_name}: #{execute_sql}"
+        logger.error failure_message
+        raise RuntimeError.new(failure_message)
+      end
     end
 
     def print_pt_osc
@@ -159,6 +162,18 @@ module ActiveRecord
       database_config[:percona] || {}
     end
 
+    def logfile
+      File.open(make_path_absolute(percona_config[:log] || 'log/pt_osc.log'), 'a')
+    end
+
+    def logger
+      return @logger if @logger
+      @logger = Logger.new(logfile)
+      @logger.formatter = Logger::Formatter.new # Don't let ActiveSupport override with SimpleFormatter
+      @logger.progname = 'pt-osc'
+      @logger
+    end
+
     private
     # Flag mutators
     def make_path_absolute(path)

data/lib/pt-osc/version.rb

@@ -1,5 +1,5 @@
 module Pt
   module Osc
-    VERSION = '0.0.4'
+    VERSION = '0.0.5'
   end
 end

data/test/unit/pt_osc_adapter_test.rb

@@ -191,6 +191,25 @@ class PtOscAdapterTest < Test::Unit::TestCase
           assert_nil @adapter.send(:get_commands, table_name)
         end
       end
+
+      context 'with existing commands' do
+        setup do
+          @commands_hash = 3.times.inject({}) do |hash|
+            hash[Faker::Lorem.word] = [Faker::Lorem.sentence]
+            hash
+          end
+          @adapter.instance_variable_set(:@osc_commands, @commands_hash)
+        end
+
+        should 'return the entire commands hash when no table is given' do
+          assert_equal @commands_hash, @adapter.send(:get_commands)
+        end
+
+        should "return only the given table's command array" do
+          table = @commands_hash.keys.first
+          assert_equal @commands_hash[table], @adapter.send(:get_commands, table)
+        end
+      end
     end
 
     context '#get_commands_string' do

data/test/unit/pt_osc_migration_unit_test.rb

@@ -99,5 +99,237 @@ class PtOscMigrationUnitTest < Test::Unit::TestCase
         end
       end
     end
+
+    context '#execute_pt_osc' do
+      context 'with a pt-osc connection' do
+        setup do
+          @mock_connection = mock
+          @mock_connection.stubs(:is_a?).with(ActiveRecord::ConnectionAdapters::PtOscAdapter).returns(true)
+
+          @old_connection = @migration.instance_variable_get(:@connection)
+          @migration.instance_variable_set(:@connection, @mock_connection)
+        end
+
+        teardown do
+          @migration.instance_variable_set(:@connection, @old_connection)
+        end
+
+        context 'connected to a database' do
+          setup do
+            @database_name = Faker::Lorem.word
+            @migration.stubs(:database_config).returns(database: @database_name)
+          end
+
+          teardown do
+            @migration.unstub(:database_config)
+          end
+
+          context 'with no tables or commands' do
+            setup do
+              fake_not_empty_array = []
+              fake_not_empty_array.stubs(:empty?).returns(false)
+              @mock_connection.stubs(:get_commanded_tables).returns(fake_not_empty_array)
+              @mock_connection.stubs(:clear_commands)
+            end
+
+            teardown do
+              @mock_connection.unstub(:get_commanded_tables)
+              @mock_connection.unstub(:clear_commands)
+            end
+
+            should 'announce its intention' do
+              @migration.expects(:announce).with('running pt-online-schema-change')
+              @migration.send(:execute_pt_osc)
+            end
+
+            should 'call migrate_table for each table' do
+              num_tables = (0..5).to_a.sample
+              @mock_connection.unstub(:get_commanded_tables)
+              @mock_connection.expects(:get_commanded_tables).twice.returns(num_tables.times.map { Faker::Lorem.word })
+
+              @migration.expects(:migrate_table).times(num_tables)
+              quietly { @migration.send(:execute_pt_osc) }
+            end
+
+            should 'clear commands when finished' do
+              @mock_connection.expects(:clear_commands)
+              quietly { @migration.send(:execute_pt_osc) }
+            end
+          end
+        end
+      end
+    end
+
+    context '#migrate_table' do
+      context 'with a pt-osc connection' do
+        setup do
+          @mock_connection = mock
+
+          @old_connection = @migration.instance_variable_get(:@connection)
+          @migration.instance_variable_set(:@connection, @mock_connection)
+        end
+
+        teardown do
+          @migration.instance_variable_set(:@connection, @old_connection)
+        end
+
+        context 'with a command string' do
+          setup do
+            @mock_connection.stubs(:get_commands_string).returns('<<command string>>')
+          end
+
+          teardown do
+            @mock_connection.unstub(:get_commands_string)
+          end
+
+          context 'with stubbed log' do
+            setup do
+              @dummy_log = StringIO.new
+              @migration.stubs(:logfile).returns(@dummy_log)
+            end
+
+            teardown do
+              @migration.unstub(:logfile)
+            end
+
+            should 'log the database, table, and SQL command' do
+              database_name = Faker::Lorem.word
+              table_name = Faker::Lorem.word
+
+              @migration.stubs(:execute_sql_for_table)
+              @migration.send(:migrate_table, database_name, table_name)
+
+              assert database_name.in?(@dummy_log.string), 'Log entry did not contain database name'
+              assert table_name.in?(@dummy_log.string),  'Log entry did not contain table name'
+              assert '<<command string>>'.in?(@dummy_log.string),  'Log entry did not contain command string'
+            end
+
+            should 'call execute twice (dry run and execute)' do
+              @migration.expects(:execute_sql_for_table).with(anything, anything, anything, true).once
+              @migration.expects(:execute_sql_for_table).with(anything, anything, anything, false).once
+              @migration.send(:migrate_table, nil, nil)
+            end
+          end
+        end
+      end
+    end
+
+    context '#execute_sql_for_table' do
+      context 'with stubbed command' do
+        setup do
+          Kernel.stubs(:system).returns(true)
+        end
+
+        teardown do
+          Kernel.unstub(:system)
+        end
+
+        context 'with stubbed log' do
+          setup do
+            @dummy_log = StringIO.new
+            @migration.stubs(:logfile).returns(@dummy_log)
+          end
+
+          teardown do
+            @migration.unstub(:logfile)
+          end
+
+          should 'log the command' do
+            @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'
+          end
+
+          context 'with successful execution' do
+            setup do
+              Kernel.expects(:system).returns(true)
+            end
+
+            teardown do
+              Kernel.unstub(:system)
+            end
+
+            should 'log success' do
+              @migration.send(:execute_sql_for_table, nil, nil, nil)
+              assert 'Success'.in?(@dummy_log.string), 'Success not mentioned in log'
+            end
+          end
+
+          context 'with failed execution' do
+            setup do
+              Kernel.expects(:system).returns(false)
+            end
+
+            teardown do
+              Kernel.unstub(:system)
+            end
+
+            should 'log failure' do
+              @migration.send(:execute_sql_for_table, nil, nil, nil) rescue nil
+              assert 'Unable to'.in?(@dummy_log.string), 'Failure not mentioned in log'
+            end
+
+            should 'raise a RuntimeError' do
+              assert_raises(RuntimeError) { @migration.send(:execute_sql_for_table, nil, nil, nil) }
+            end
+          end
+        end
+      end
+    end
+
+    context '#logger' do
+      context 'with stubbed log' do
+        setup do
+          @dummy_log = StringIO.new
+          @migration.stubs(:logfile).returns(@dummy_log)
+        end
+
+        teardown do
+          @migration.unstub(:logfile)
+        end
+
+        should 'log entries with "pt-osc"' do
+          logger = @migration.send(:logger)
+          logger.info 'test'
+          assert 'pt-osc'.in?(@dummy_log.string), "Log entry did not contain 'pt-osc': #{@dummy_log.string}"
+        end
+      end
+    end
+
+    context '#logfile' do
+      context 'with nothing in config' do
+        setup do
+          @migration.stubs(:percona_config).returns({})
+        end
+
+        teardown do
+          @migration.unstub(:percona_config)
+        end
+
+        should 'use log/pt_osc.log' do
+          @migration.stubs(:make_path_absolute).with('log/pt_osc.log')
+                    .returns(File.expand_path('../dummy/log/pt_osc.log', File.dirname(__FILE__)))
+          logfile = @migration.send(:logfile)
+          assert 'log/pt_osc.log'.in?(logfile.path), 'Default log file not found in path'
+        end
+      end
+
+      context 'with a logfile specified in config' do
+        setup do
+          @migration.stubs(:percona_config).returns(log: 'log/fakelog.file')
+        end
+
+        teardown do
+          @migration.unstub(:percona_config)
+        end
+
+        should 'use log/pt_osc.log' do
+          @migration.stubs(:make_path_absolute).with('log/fakelog.file')
+                    .returns(File.expand_path('../dummy/log/fakelog.file', File.dirname(__FILE__)))
+          logfile = @migration.send(:logfile)
+          assert 'log/fakelog.file'.in?(logfile.path), 'Configured log file not found in path'
+        end
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pt-osc
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -229,7 +229,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2272605143598001323
+      hash: -1631463669037670360
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -238,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2272605143598001323
+      hash: -1631463669037670360
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23