lhm-teak 3.6.0

data/spec/unit/entangler_spec.rb

@@ -0,0 +1,187 @@
+# Copyright (c) 2011 - 2013, SoundCloud Ltd., Rany Keddo, Tobias Bielohlawek, Tobias
+# Schmidt
+
+require File.expand_path(File.dirname(__FILE__)) + '/unit_helper'
+
+require 'lhm/table'
+require 'lhm/migration'
+require 'lhm/entangler'
+require 'lhm/connection'
+
+describe Lhm::Entangler do
+  include UnitHelper
+
+  before(:each) do
+    @origin = Lhm::Table.new('origin')
+    @destination = Lhm::Table.new('destination')
+    @migration = Lhm::Migration.new(@origin, @destination)
+    @entangler = Lhm::Entangler.new(@migration)
+  end
+
+  describe 'activation' do
+    before(:each) do
+      @origin.columns['info'] = { :type => 'varchar(255)' }
+      @origin.columns['tags'] = { :type => 'varchar(255)' }
+
+      @destination.columns['info'] = { :type => 'varchar(255)' }
+      @destination.columns['tags'] = { :type => 'varchar(255)' }
+    end
+
+    it 'should create insert trigger to destination table' do
+      ddl = %Q{
+        create trigger `lhmt_ins_origin`
+        after insert on `origin` for each row
+        replace into `destination` (`info`, `tags`) /* large hadron migration */
+        values (`NEW`.`info`, `NEW`.`tags`)
+      }
+
+      value(@entangler.entangle).must_include strip(ddl)
+    end
+
+    it 'should create an update trigger to the destination table' do
+      ddl = %Q{
+        create trigger `lhmt_upd_origin`
+        after update on `origin` for each row
+        replace into `destination` (`info`, `tags`) /* large hadron migration */
+        values (`NEW`.`info`, `NEW`.`tags`)
+      }
+
+      value(@entangler.entangle).must_include strip(ddl)
+    end
+
+    it 'should create a delete trigger to the destination table' do
+      ddl = %Q{
+        create trigger `lhmt_del_origin`
+        after delete on `origin` for each row
+        delete ignore from `destination` /* large hadron migration */
+        where `destination`.`id` = OLD.`id`
+      }
+
+      value(@entangler.entangle).must_include strip(ddl)
+    end
+
+    it 'should retry trigger creation when it hits a lock wait timeout' do
+      tries = 1
+      ar_connection = mock()
+      ar_connection.stubs(:execute)
+                       .returns([["dummy"]], [["dummy"]], [["dummy"]])
+                       .then
+                       .raises(Mysql2::Error, 'Lock wait timeout exceeded; try restarting transaction')
+      ar_connection.stubs(:active?).returns(true)
+
+      connection = Lhm::Connection.new(connection: ar_connection, options: {
+        reconnect_with_consistent_host: true,
+        retriable: {
+          base_interval: 0,
+          tries: tries
+        }
+      })
+
+      @entangler = Lhm::Entangler.new(@migration, connection)
+
+      assert_raises(Mysql2::Error) { @entangler.before }
+    end
+
+    it 'should not retry trigger creation with other mysql errors' do
+      ar_connection = mock()
+      ar_connection.stubs(:execute)
+                   .returns([["dummy"]], [["dummy"]], [["dummy"]])
+                   .then
+                   .raises(Mysql2::Error, 'The MySQL server is running with the --read-only option so it cannot execute this statement.')
+      ar_connection.stubs(:active?).returns(true)
+      connection = Lhm::Connection.new(connection: ar_connection, options: {
+        reconnect_with_consistent_host: true,
+        retriable: {
+          base_interval: 0
+        },
+      })
+
+      @entangler = Lhm::Entangler.new(@migration, connection)
+      assert_raises(Mysql2::Error) { @entangler.before }
+    end
+
+    it 'should succesfully finish after retrying' do
+      ar_connection = mock()
+      ar_connection.stubs(:execute)
+                   .returns([["dummy"]], [["dummy"]], [["dummy"]])
+                   .then
+                   .raises(Mysql2::Error, 'Lock wait timeout exceeded; try restarting transaction')
+                   .then
+                   .returns([["dummy"]])
+      ar_connection.stubs(:active?).returns(true)
+
+      connection = Lhm::Connection.new(connection: ar_connection, options: {
+        reconnect_with_consistent_host: true,
+        retriable: {
+          base_interval: 0
+        },
+      })
+
+      @entangler = Lhm::Entangler.new(@migration, connection)
+
+      assert @entangler.before
+    end
+
+    it 'should retry as many times as specified by configuration' do
+      ar_connection = mock()
+      ar_connection.stubs(:execute)
+                   .returns([["dummy"]], [["dummy"]], [["dummy"]]) # initial
+                   .then
+                   .raises(Mysql2::Error, 'Lock wait timeout exceeded; try restarting transaction')
+                   .then
+                   .returns([["dummy"]]) # reconnect 1
+                   .then
+                   .raises(Mysql2::Error, 'Lock wait timeout exceeded; try restarting transaction')
+                   .then
+                   .returns([["dummy"]])  # reconnect 2
+                   .then
+                   .raises(Mysql2::Error, 'Lock wait timeout exceeded; try restarting transaction')
+                   .then
+                   .returns([["dummy"]])  # reconnect 3
+                   .then
+                   .raises(Mysql2::Error, 'Lock wait timeout exceeded; try restarting transaction')  # final error
+      ar_connection.stubs(:active?).returns(true)
+
+      connection = Lhm::Connection.new(connection: ar_connection, options: {
+        reconnect_with_consistent_host: true,
+        retriable: {
+          tries: 5,
+          base_interval: 0
+        },
+      })
+
+      @entangler = Lhm::Entangler.new(@migration, connection)
+
+      assert_raises(Mysql2::Error) { @entangler.before }
+    end
+
+    describe 'super long table names' do
+      before(:each) do
+        @origin = Lhm::Table.new('a' * 64)
+        @destination = Lhm::Table.new('b' * 64)
+        @migration = Lhm::Migration.new(@origin, @destination)
+        @entangler = Lhm::Entangler.new(@migration)
+      end
+
+      it 'should use truncated names' do
+        value(@entangler.trigger(:ins).length).must_be :<=, 64
+        value(@entangler.trigger(:upd).length).must_be :<=, 64
+        value(@entangler.trigger(:del).length).must_be :<=, 64
+      end
+    end
+  end
+
+  describe 'removal' do
+    it 'should remove insert trigger' do
+      value(@entangler.untangle).must_include('drop trigger if exists `lhmt_ins_origin`')
+    end
+
+    it 'should remove update trigger' do
+      value(@entangler.untangle).must_include('drop trigger if exists `lhmt_upd_origin`')
+    end
+
+    it 'should remove delete trigger' do
+      value(@entangler.untangle).must_include('drop trigger if exists `lhmt_del_origin`')
+    end
+  end
+end

data/spec/unit/intersection_spec.rb

@@ -0,0 +1,51 @@
+# Copyright (c) 2011 - 2013, SoundCloud Ltd., Rany Keddo, Tobias Bielohlawek, Tobias
+# Schmidt
+
+require File.expand_path(File.dirname(__FILE__)) + '/unit_helper'
+
+require 'lhm/table'
+require 'lhm/migrator'
+
+describe Lhm::Intersection do
+  include UnitHelper
+
+  it 'should not have dropped changes' do
+    origin = Lhm::Table.new('origin')
+    origin.columns['dropped']  = varchar
+    origin.columns['retained'] = varchar
+
+    destination = Lhm::Table.new('destination')
+    destination.columns['retained'] = varchar
+
+    intersection = Lhm::Intersection.new(origin, destination)
+    value(intersection.destination.include?('dropped')).must_equal(false)
+  end
+
+  it 'should have unchanged columns' do
+    origin = Lhm::Table.new('origin')
+    origin.columns['dropped']  = varchar
+    origin.columns['retained'] = varchar
+
+    destination = Lhm::Table.new('destination')
+    destination.columns['retained'] = varchar
+
+    intersection = Lhm::Intersection.new(origin, destination)
+    value(intersection.destination).must_equal(['retained'])
+  end
+
+  it 'should have renamed columns' do
+    origin = Lhm::Table.new('origin')
+    origin.columns['old_name']  = varchar
+
+    destination = Lhm::Table.new('destination')
+    destination.columns['new_name'] = varchar
+
+    intersection = Lhm::Intersection.new(origin, destination, { 'old_name' => 'new_name' })
+    value(intersection.origin).must_equal(['old_name'])
+    value(intersection.destination).must_equal(['new_name'])
+  end
+
+  def varchar
+    { :metadata => 'VARCHAR(255)' }
+  end
+end

data/spec/unit/lhm_spec.rb

@@ -0,0 +1,46 @@
+# Copyright (c) 2011 - 2013, SoundCloud Ltd.
+
+require File.expand_path(File.dirname(__FILE__)) + '/unit_helper'
+
+describe Lhm do
+
+  before(:each) do
+    Lhm.remove_class_variable :@@logger if Lhm.class_variable_defined? :@@logger
+  end
+
+  describe 'logger' do
+
+    it 'should use the default parameters if no logger explicitly set' do
+      value(Lhm.logger).must_be_kind_of Logger
+      value(Lhm.logger.level).must_equal Logger::INFO
+      value(Lhm.logger.instance_eval { @logdev }.dev).must_equal STDOUT
+    end
+
+    it 'should use s new logger if set' do
+      l = Logger.new('omg.ponies')
+      l.level = Logger::ERROR
+      Lhm.logger = l
+
+      value(Lhm.logger.level).must_equal Logger::ERROR
+      value(Lhm.logger.instance_eval { @logdev }.dev).must_be_kind_of File
+      value(Lhm.logger.instance_eval { @logdev }.dev.path).must_equal 'omg.ponies'
+    end
+  end
+
+  describe 'api' do
+
+    before(:each) do
+      @connection = mock()
+    end
+
+    it 'should create a new connection when calling setup' do
+      Lhm.setup(@connection)
+      value(Lhm.connection).must_be_kind_of(Lhm::Connection)
+    end
+
+    it 'should create a new connection when none is created' do
+      ActiveRecord::Base.stubs(:connection).returns(@connection)
+      value(Lhm.connection).must_be_kind_of(Lhm::Connection)
+    end
+  end
+end

data/spec/unit/locked_switcher_spec.rb

@@ -0,0 +1,46 @@
+# Copyright (c) 2011 - 2013, SoundCloud Ltd., Rany Keddo, Tobias Bielohlawek, Tobias
+# Schmidt
+
+require File.expand_path(File.dirname(__FILE__)) + '/unit_helper'
+
+require 'lhm/table'
+require 'lhm/migration'
+require 'lhm/locked_switcher'
+
+describe Lhm::LockedSwitcher do
+  include UnitHelper
+
+  before(:each) do
+    @start       = Time.now
+    @origin      = Lhm::Table.new('origin')
+    @destination = Lhm::Table.new('destination')
+    @migration   = Lhm::Migration.new(@origin, @destination, @start)
+    @switcher    = Lhm::LockedSwitcher.new(@migration, nil)
+  end
+
+  describe 'uncommitted' do
+    it 'should disable autocommit first' do
+      value(@switcher.statements[0..1]).must_equal([
+        'set @lhm_auto_commit = @@session.autocommit',
+        'set session autocommit = 0'
+      ])
+    end
+
+    it 'should reapply original autocommit settings at the end' do
+      value(@switcher.statements[-1])
+        .must_equal('set session autocommit = @lhm_auto_commit')
+    end
+  end
+
+  describe 'switch' do
+    it 'should lock origin and destination table, switch, commit and unlock' do
+      value(@switcher.switch).must_equal([
+        'lock table `origin` write, `destination` write',
+        "alter table `origin` rename `#{ @migration.archive_name }`",
+        'alter table `destination` rename `origin`',
+        'commit',
+        'unlock tables'
+      ])
+    end
+  end
+end

data/spec/unit/migrator_spec.rb

@@ -0,0 +1,144 @@
+# Copyright (c) 2011 - 2013, SoundCloud Ltd., Rany Keddo, Tobias Bielohlawek, Tobias
+# Schmidt
+
+require File.expand_path(File.dirname(__FILE__)) + '/unit_helper'
+
+require 'lhm/table'
+require 'lhm/migrator'
+
+describe Lhm::Migrator do
+  include UnitHelper
+
+  before(:each) do
+    @table = Lhm::Table.new('alt')
+    @creator = Lhm::Migrator.new(@table)
+  end
+
+  describe 'index changes' do
+    it 'should add an index' do
+      @creator.add_index(:a)
+
+      value(@creator.statements).must_equal([
+        'create index `index_alt_on_a` on `lhmn_alt` (`a`)'
+      ])
+    end
+
+    it 'should add a composite index' do
+      @creator.add_index([:a, :b])
+
+      value(@creator.statements).must_equal([
+        'create index `index_alt_on_a_and_b` on `lhmn_alt` (`a`, `b`)'
+      ])
+    end
+
+    it 'should add an index with prefix length' do
+      @creator.add_index(['a(10)', 'b'])
+
+      value(@creator.statements).must_equal([
+        'create index `index_alt_on_a_and_b` on `lhmn_alt` (`a`(10), `b`)'
+      ])
+    end
+
+    it 'should add an index with a custom name' do
+      @creator.add_index([:a, :b], :custom_index_name)
+
+      value(@creator.statements).must_equal([
+        'create index `custom_index_name` on `lhmn_alt` (`a`, `b`)'
+      ])
+    end
+
+    it 'should raise an error when the index name is not a string or symbol' do
+      assert_raises ArgumentError do
+        @creator.add_index([:a, :b], :name => :custom_index_name)
+      end
+    end
+
+    it 'should add a unique index' do
+      @creator.add_unique_index(['a(5)', :b])
+
+      value(@creator.statements).must_equal([
+        'create unique index `index_alt_on_a_and_b` on `lhmn_alt` (`a`(5), `b`)'
+      ])
+    end
+
+    it 'should add a unique index with a custom name' do
+      @creator.add_unique_index([:a, :b], :custom_index_name)
+
+      value(@creator.statements).must_equal([
+        'create unique index `custom_index_name` on `lhmn_alt` (`a`, `b`)'
+      ])
+    end
+
+    it 'should raise an error when the unique index name is not a string or symbol' do
+      assert_raises ArgumentError do
+        @creator.add_unique_index([:a, :b], :name => :custom_index_name)
+      end
+    end
+
+    it 'should remove an index' do
+      @creator.remove_index(['b', 'a'])
+
+      value(@creator.statements).must_equal([
+        'drop index `index_alt_on_b_and_a` on `lhmn_alt`'
+      ])
+    end
+
+    it 'should remove an index with a custom name' do
+      @creator.remove_index([:a, :b], :custom_index_name)
+
+      value(@creator.statements).must_equal([
+        'drop index `custom_index_name` on `lhmn_alt`'
+      ])
+    end
+  end
+
+  describe 'column changes' do
+    it 'should add a column' do
+      @creator.add_column('logins', 'INT(12)')
+
+      value(@creator.statements).must_equal([
+        'alter table `lhmn_alt` add column `logins` INT(12)'
+      ])
+    end
+
+    it 'should remove a column' do
+      @creator.remove_column('logins')
+
+      value(@creator.statements).must_equal([
+        'alter table `lhmn_alt` drop `logins`'
+      ])
+    end
+
+    it 'should change a column' do
+      @creator.change_column('logins', 'INT(11)')
+
+      value(@creator.statements).must_equal([
+        'alter table `lhmn_alt` modify column `logins` INT(11)'
+      ])
+    end
+  end
+
+  describe 'direct changes' do
+    it 'should accept a ddl statement' do
+      @creator.ddl('alter table `%s` add column `f` tinyint(1)' % @creator.name)
+
+      value(@creator.statements).must_equal([
+        'alter table `lhmn_alt` add column `f` tinyint(1)'
+      ])
+    end
+  end
+
+  describe 'multiple changes' do
+    it 'should add two columns' do
+      @creator.add_column('first', 'VARCHAR(64)')
+      @creator.add_column('last', 'VARCHAR(64)')
+      value(@creator.statements.length).must_equal(2)
+
+      value(@creator.statements[0])
+        .must_equal('alter table `lhmn_alt` add column `first` VARCHAR(64)')
+
+      value(@creator.statements[1])
+        .must_equal('alter table `lhmn_alt` add column `last` VARCHAR(64)')
+    end
+  end
+end

data/spec/unit/printer_spec.rb

@@ -0,0 +1,85 @@
+require File.expand_path(File.dirname(__FILE__)) + '/unit_helper'
+
+require 'lhm/printer'
+require 'logger'
+
+
+
+describe Lhm::Printer do
+  include UnitHelper
+
+  describe 'percentage printer' do
+
+    before(:each) do
+      @printer = Lhm::Printer::Percentage.new
+    end
+
+    it 'prints the percentage' do
+      r, w = IO.pipe
+      Lhm.logger = Logger.new(w)
+
+      10.times do |i|
+        @printer.notify(i, 10)
+        assert_match(/#{i}\/10/, log_expression_message(r.gets))
+      end
+    end
+
+    it 'always prints a bigger message' do
+      @length = 0
+
+      def assert_length(printer)
+        new_length = printer.instance_variable_get(:@max_length)
+        assert new_length >= @length
+        @length = new_length
+      end
+
+      @printer.notify(10, 100)
+      assert_length(@printer)
+      @printer.notify(0, 100)
+      assert_length(@printer)
+      @printer.notify(1, 1000000)
+      assert_length(@printer)
+      @printer.notify(0, 0)
+      assert_length(@printer)
+      @printer.notify(0, nil)
+      assert_length(@printer)
+    end
+
+    it 'prints the end message' do
+      r, w = IO.pipe
+      Lhm.logger = Logger.new(w)
+      @printer.end
+
+      assert_equal(log_expression_message(r.gets), "100% complete\n")
+    end
+
+    it 'prints the exception message' do
+      r, w = IO.pipe
+      Lhm.logger = Logger.new(w)
+      e = StandardError.new('woops')
+      @printer.exception(e)
+
+      assert_equal(log_expression_message(r.gets), "failed: #{e}\n")
+    end
+  end
+
+  describe 'dot printer' do
+
+    before(:each) do
+      @printer = Lhm::Printer::Dot.new
+    end
+
+    it 'prints the dots' do
+      mock  = MiniTest::Mock.new
+      10.times do
+        mock.expect(:write, :return_value, ['.'])
+      end
+
+      @printer.instance_variable_set(:@output, mock)
+      10.times { @printer.notify }
+
+      mock.verify
+    end
+
+  end
+end

data/spec/unit/sql_helper_spec.rb

@@ -0,0 +1,28 @@
+# Copyright (c) 2011 - 2013, SoundCloud Ltd., Rany Keddo, Tobias Bielohlawek, Tobias
+# Schmidt
+
+require File.expand_path(File.dirname(__FILE__)) + '/unit_helper'
+
+require 'lhm/sql_helper'
+
+describe Lhm::SqlHelper do
+  it 'should name index with a single column' do
+    value(Lhm::SqlHelper.idx_name(:users, :name))
+      .must_equal('index_users_on_name')
+  end
+
+  it 'should name index with multiple columns' do
+    value(Lhm::SqlHelper.idx_name(:users, [:name, :firstname]))
+      .must_equal('index_users_on_name_and_firstname')
+  end
+
+  it 'should name index with prefixed column' do
+    value(Lhm::SqlHelper.idx_name(:tracks, ['title(10)', 'album']))
+      .must_equal('index_tracks_on_title_and_album')
+  end
+
+  it 'should quote column names in index specification' do
+    value(Lhm::SqlHelper.idx_spec(['title(10)', 'album']))
+      .must_equal('`title`(10), `album`')
+  end
+end

data/spec/unit/table_name_spec.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+describe Lhm::TableName do
+  describe "#archived" do
+    it "prefixes and timestamps the old table" do
+      subject = Lhm::TableName.new("original", Time.new(2000,01,02,03,04,05))
+      assert_equal "lhma_2000_01_02_03_04_05_000_original", subject.archived
+    end
+
+    it "truncates names below 64 characters" do
+      subject = Lhm::TableName.new("some_very_long_original_table_name_that_exceeds_64_characters", Time.new(2000,01,02,03,04,05))
+      assert_equal "lhma_2000_01_02_03_04_05_000_some_very_long_original_table_name_", subject.archived
+    end
+  end
+
+  describe "#failed" do
+    it "prefixes and postfixes and timestamps the old table" do
+      subject = Lhm::TableName.new("original", Time.new(2000,01,02,03,04,05))
+      assert_equal "lhma_2000_01_02_03_04_05_000_original_failed", subject.failed
+    end
+
+    it "truncates names below 64 characters" do
+      subject = Lhm::TableName.new("some_very_long_original_table_name_that_exceeds_64_characters", Time.new(2000,01,02,03,04,05))
+      assert_equal "lhma_2000_01_02_03_04_05_000_some_very_long_original_tabl_failed", subject.failed
+    end
+  end
+
+  describe "#new" do
+    it "prefixes and postfixes and timestamps the old table" do
+      subject = Lhm::TableName.new("original")
+      assert_equal "lhmn_original", subject.new
+    end
+
+    it "truncates names below 64 characters" do
+      subject = Lhm::TableName.new("some_very_long_original_table_name_that_exceeds_64_characters")
+      assert_equal "lhmn_some_very_long_original_table_name_that_exceeds_64_characte", subject.new
+    end
+  end
+end

data/spec/unit/table_spec.rb

@@ -0,0 +1,47 @@
+# Copyright (c) 2011 - 2013, SoundCloud Ltd., Rany Keddo, Tobias Bielohlawek, Tobias
+# Schmidt
+
+require File.expand_path(File.dirname(__FILE__)) + '/unit_helper'
+
+require 'lhm/table'
+
+describe Lhm::Table do
+  include UnitHelper
+
+  describe 'names' do
+    it 'should name destination' do
+      @table = Lhm::Table.new('users')
+      value(@table.destination_name).must_equal 'lhmn_users'
+    end
+  end
+
+  describe 'constraints' do
+    def set_columns(table, columns)
+      table.instance_variable_set('@columns', columns)
+    end
+
+    it 'should be satisfied with a single column primary key called id' do
+      @table = Lhm::Table.new('table', 'id')
+      set_columns(@table, { 'id' => { :type => 'int(1)' } })
+      value(@table.satisfies_id_column_requirement?).must_equal true
+    end
+
+    it 'should be satisfied with a primary key not called id, as long as there is still an id' do
+      @table = Lhm::Table.new('table', 'uuid')
+      set_columns(@table, { 'id' => { :type => 'int(1)' } })
+      value(@table.satisfies_id_column_requirement?).must_equal true
+    end
+
+    it 'should be satisifed if display attributes are not present (deprecated in mysql 8)' do
+      @table = Lhm::Table.new('table', 'id')
+      set_columns(@table, { 'id' => { :type => 'int' } })
+      value(@table.satisfies_id_column_requirement?).must_equal true
+    end
+
+    it 'should not be satisfied if id is not numeric' do
+      @table = Lhm::Table.new('table', 'id')
+      set_columns(@table, { 'id' => { :type => 'varchar(255)' } })
+      value(@table.satisfies_id_column_requirement?).must_equal false
+    end
+  end
+end