debian-mirror-gitlab/spec/lib/gitlab/database/migration_helpers/v2_spec.rb

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

332 lines
12 KiB
Ruby
Raw Normal View History

2021-03-11 19:13:27 +05:30
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Gitlab::Database::MigrationHelpers::V2 do
include Database::TriggerHelpers
2021-11-11 11:23:49 +05:30
include Database::TableSchemaHelpers
2021-03-11 19:13:27 +05:30
let(:migration) do
ActiveRecord::Migration.new.extend(described_class)
end
before do
allow(migration).to receive(:puts)
2021-11-11 11:23:49 +05:30
allow(ActiveRecord::Base.connection).to receive(:transaction_open?).and_return(false)
2021-03-11 19:13:27 +05:30
end
shared_examples_for 'Setting up to rename a column' do
let(:model) { Class.new(ActiveRecord::Base) }
before do
2021-12-11 22:18:48 +05:30
model.table_name = :_test_table
2021-03-11 19:13:27 +05:30
end
context 'when called inside a transaction block' do
before do
allow(migration).to receive(:transaction_open?).and_return(true)
end
it 'raises an error' do
expect do
2021-12-11 22:18:48 +05:30
migration.public_send(operation, :_test_table, :original, :renamed)
2021-03-11 19:13:27 +05:30
end.to raise_error("#{operation} can not be run inside a transaction")
end
end
context 'when the existing column has a default value' do
before do
2021-12-11 22:18:48 +05:30
migration.change_column_default :_test_table, existing_column, 'default value'
2021-03-11 19:13:27 +05:30
end
it 'raises an error' do
expect do
2021-12-11 22:18:48 +05:30
migration.public_send(operation, :_test_table, :original, :renamed)
2021-03-11 19:13:27 +05:30
end.to raise_error("#{operation} does not currently support columns with default values")
end
end
context 'when passing a batch column' do
context 'when the batch column does not exist' do
it 'raises an error' do
expect do
2021-12-11 22:18:48 +05:30
migration.public_send(operation, :_test_table, :original, :renamed, batch_column_name: :missing)
end.to raise_error('Column missing does not exist on _test_table')
2021-03-11 19:13:27 +05:30
end
end
context 'when the batch column does exist' do
it 'passes it when creating the column' do
expect(migration).to receive(:create_column_from)
2021-12-11 22:18:48 +05:30
.with(:_test_table, existing_column, added_column, type: nil, batch_column_name: :status)
2021-03-11 19:13:27 +05:30
.and_call_original
2021-12-11 22:18:48 +05:30
migration.public_send(operation, :_test_table, :original, :renamed, batch_column_name: :status)
2021-03-11 19:13:27 +05:30
end
end
end
it 'creates the renamed column, syncing existing data' do
existing_record_1 = model.create!(status: 0, existing_column => 'existing')
existing_record_2 = model.create!(status: 0, existing_column => nil)
2021-12-11 22:18:48 +05:30
migration.send(operation, :_test_table, :original, :renamed)
2021-03-11 19:13:27 +05:30
model.reset_column_information
2021-12-11 22:18:48 +05:30
expect(migration.column_exists?(:_test_table, added_column)).to eq(true)
2021-03-11 19:13:27 +05:30
expect(existing_record_1.reload).to have_attributes(status: 0, original: 'existing', renamed: 'existing')
expect(existing_record_2.reload).to have_attributes(status: 0, original: nil, renamed: nil)
end
it 'installs triggers to sync new data' do
2021-12-11 22:18:48 +05:30
migration.public_send(operation, :_test_table, :original, :renamed)
2021-03-11 19:13:27 +05:30
model.reset_column_information
new_record_1 = model.create!(status: 1, original: 'first')
new_record_2 = model.create!(status: 1, renamed: 'second')
expect(new_record_1.reload).to have_attributes(status: 1, original: 'first', renamed: 'first')
expect(new_record_2.reload).to have_attributes(status: 1, original: 'second', renamed: 'second')
new_record_1.update!(original: 'updated')
new_record_2.update!(renamed: nil)
expect(new_record_1.reload).to have_attributes(status: 1, original: 'updated', renamed: 'updated')
expect(new_record_2.reload).to have_attributes(status: 1, original: nil, renamed: nil)
end
2022-06-21 17:19:12 +05:30
it 'requires the helper to run in ddl mode' do
expect(Gitlab::Database::QueryAnalyzers::RestrictAllowedSchemas).to receive(:require_ddl_mode!)
migration.public_send(operation, :_test_table, :original, :renamed)
end
2021-03-11 19:13:27 +05:30
end
describe '#rename_column_concurrently' do
before do
allow(migration).to receive(:transaction_open?).and_return(false)
2021-12-11 22:18:48 +05:30
migration.create_table :_test_table do |t|
2021-03-11 19:13:27 +05:30
t.integer :status, null: false
t.text :original
t.text :other_column
end
end
it_behaves_like 'Setting up to rename a column' do
let(:operation) { :rename_column_concurrently }
let(:existing_column) { :original }
let(:added_column) { :renamed }
end
context 'when the column to rename does not exist' do
it 'raises an error' do
expect do
2021-12-11 22:18:48 +05:30
migration.rename_column_concurrently :_test_table, :missing_column, :renamed
end.to raise_error('Column missing_column does not exist on _test_table')
2021-03-11 19:13:27 +05:30
end
end
end
describe '#undo_cleanup_concurrent_column_rename' do
before do
allow(migration).to receive(:transaction_open?).and_return(false)
2021-12-11 22:18:48 +05:30
migration.create_table :_test_table do |t|
2021-03-11 19:13:27 +05:30
t.integer :status, null: false
t.text :other_column
t.text :renamed
end
end
it_behaves_like 'Setting up to rename a column' do
let(:operation) { :undo_cleanup_concurrent_column_rename }
let(:existing_column) { :renamed }
let(:added_column) { :original }
end
context 'when the renamed column does not exist' do
it 'raises an error' do
expect do
2021-12-11 22:18:48 +05:30
migration.undo_cleanup_concurrent_column_rename :_test_table, :original, :missing_column
end.to raise_error('Column missing_column does not exist on _test_table')
2021-03-11 19:13:27 +05:30
end
end
end
shared_examples_for 'Cleaning up from renaming a column' do
let(:connection) { migration.connection }
before do
allow(migration).to receive(:transaction_open?).and_return(false)
2021-12-11 22:18:48 +05:30
migration.create_table :_test_table do |t|
2021-03-11 19:13:27 +05:30
t.integer :status, null: false
t.text :original
t.text :other_column
end
2021-12-11 22:18:48 +05:30
migration.rename_column_concurrently :_test_table, :original, :renamed
2021-03-11 19:13:27 +05:30
end
context 'when the helper is called repeatedly' do
before do
2021-12-11 22:18:48 +05:30
migration.public_send(operation, :_test_table, :original, :renamed)
2021-03-11 19:13:27 +05:30
end
it 'does not make repeated attempts to cleanup' do
expect(migration).not_to receive(:remove_column)
expect do
2021-12-11 22:18:48 +05:30
migration.public_send(operation, :_test_table, :original, :renamed)
2021-03-11 19:13:27 +05:30
end.not_to raise_error
end
end
context 'when the renamed column exists' do
let(:triggers) do
[
2021-12-11 22:18:48 +05:30
['trigger_020dbcb8cdd0', 'function_for_trigger_020dbcb8cdd0', before: 'insert'],
['trigger_6edaca641d03', 'function_for_trigger_6edaca641d03', before: 'update'],
['trigger_a3fb9f3add34', 'function_for_trigger_a3fb9f3add34', before: 'update']
2021-03-11 19:13:27 +05:30
]
end
it 'removes the sync triggers and renamed columns' do
triggers.each do |(trigger_name, function_name, event)|
expect_function_to_exist(function_name)
2021-12-11 22:18:48 +05:30
expect_valid_function_trigger(:_test_table, trigger_name, function_name, event)
2021-03-11 19:13:27 +05:30
end
2021-12-11 22:18:48 +05:30
expect(migration.column_exists?(:_test_table, added_column)).to eq(true)
2021-03-11 19:13:27 +05:30
2021-12-11 22:18:48 +05:30
migration.public_send(operation, :_test_table, :original, :renamed)
2021-03-11 19:13:27 +05:30
2021-12-11 22:18:48 +05:30
expect(migration.column_exists?(:_test_table, added_column)).to eq(false)
2021-03-11 19:13:27 +05:30
triggers.each do |(trigger_name, function_name, _)|
2021-12-11 22:18:48 +05:30
expect_trigger_not_to_exist(:_test_table, trigger_name)
2021-03-11 19:13:27 +05:30
expect_function_not_to_exist(function_name)
end
end
end
end
describe '#undo_rename_column_concurrently' do
it_behaves_like 'Cleaning up from renaming a column' do
let(:operation) { :undo_rename_column_concurrently }
let(:added_column) { :renamed }
end
end
describe '#cleanup_concurrent_column_rename' do
it_behaves_like 'Cleaning up from renaming a column' do
let(:operation) { :cleanup_concurrent_column_rename }
let(:added_column) { :original }
end
end
2021-11-11 11:23:49 +05:30
describe '#create_table' do
2021-12-11 22:18:48 +05:30
let(:table_name) { :_test_table }
2021-11-11 11:23:49 +05:30
let(:column_attributes) do
[
{ name: 'id', sql_type: 'bigint', null: false, default: nil },
{ name: 'created_at', sql_type: 'timestamp with time zone', null: false, default: nil },
{ name: 'updated_at', sql_type: 'timestamp with time zone', null: false, default: nil },
{ name: 'some_id', sql_type: 'integer', null: false, default: nil },
{ name: 'active', sql_type: 'boolean', null: false, default: 'true' },
{ name: 'name', sql_type: 'text', null: true, default: nil }
]
end
context 'using a limit: attribute on .text' do
it 'creates the table as expected' do
migration.create_table table_name do |t|
t.timestamps_with_timezone
t.integer :some_id, null: false
t.boolean :active, null: false, default: true
t.text :name, limit: 100
end
expect_table_columns_to_match(column_attributes, table_name)
2021-12-11 22:18:48 +05:30
expect_check_constraint(table_name, 'check_e9982cf9da', 'char_length(name) <= 100')
2021-11-11 11:23:49 +05:30
end
end
end
describe '#with_lock_retries' do
let(:model) do
ActiveRecord::Migration.new.extend(described_class)
end
let(:buffer) { StringIO.new }
let(:in_memory_logger) { Gitlab::JsonLogger.new(buffer) }
let(:env) { { 'DISABLE_LOCK_RETRIES' => 'true' } }
it 'sets the migration class name in the logs' do
model.with_lock_retries(env: env, logger: in_memory_logger) { }
buffer.rewind
expect(buffer.read).to include("\"class\":\"#{model.class}\"")
end
where(raise_on_exhaustion: [true, false])
with_them do
it 'sets raise_on_exhaustion as requested' do
with_lock_retries = double
expect(Gitlab::Database::WithLockRetries).to receive(:new).and_return(with_lock_retries)
expect(with_lock_retries).to receive(:run).with(raise_on_exhaustion: raise_on_exhaustion)
model.with_lock_retries(env: env, logger: in_memory_logger, raise_on_exhaustion: raise_on_exhaustion) { }
end
end
it 'does not raise on exhaustion by default' do
with_lock_retries = double
expect(Gitlab::Database::WithLockRetries).to receive(:new).and_return(with_lock_retries)
expect(with_lock_retries).to receive(:run).with(raise_on_exhaustion: false)
model.with_lock_retries(env: env, logger: in_memory_logger) { }
end
it 'defaults to disallowing subtransactions' do
with_lock_retries = double
expect(Gitlab::Database::WithLockRetries).to receive(:new).with(hash_including(allow_savepoints: false)).and_return(with_lock_retries)
expect(with_lock_retries).to receive(:run).with(raise_on_exhaustion: false)
model.with_lock_retries(env: env, logger: in_memory_logger) { }
end
context 'when in transaction' do
before do
allow(model).to receive(:transaction_open?).and_return(true)
end
context 'when lock retries are enabled' do
before do
allow(model).to receive(:enable_lock_retries?).and_return(true)
end
it 'does not use Gitlab::Database::WithLockRetries and executes the provided block directly' do
expect(Gitlab::Database::WithLockRetries).not_to receive(:new)
expect(model.with_lock_retries(env: env, logger: in_memory_logger) { :block_result }).to eq(:block_result)
end
end
context 'when lock retries are not enabled' do
before do
allow(model).to receive(:enable_lock_retries?).and_return(false)
end
it 'raises an error' do
expect { model.with_lock_retries(env: env, logger: in_memory_logger) { } }.to raise_error /can not be run inside an already open transaction/
end
end
end
end
2021-03-11 19:13:27 +05:30
end