debian-mirror-gitlab/spec/support/helpers/migrations_helpers.rb

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

210 lines
5.4 KiB
Ruby
Raw Normal View History

2019-10-12 21:52:04 +05:30
# frozen_string_literal: true
2017-09-10 17:25:29 +05:30
module MigrationsHelpers
2022-07-16 23:28:13 +05:30
def active_record_base(database: nil)
database_name = database || self.class.metadata[:database] || :main
unless Gitlab::Database::DATABASE_NAMES.include?(database_name.to_s)
raise ArgumentError, "#{database_name} is not a valid argument"
end
Gitlab::Database.database_base_models[database_name] || Gitlab::Database.database_base_models[:main]
2018-12-13 13:39:08 +05:30
end
2022-07-16 23:28:13 +05:30
def table(name, database: nil)
Class.new(active_record_base(database: database)) do
2018-05-01 15:08:00 +05:30
self.table_name = name
self.inheritance_column = :_type_disabled
2018-12-05 23:21:45 +05:30
def self.name
table_name.singularize.camelcase
end
2022-05-07 20:08:51 +05:30
yield self if block_given?
2018-05-01 15:08:00 +05:30
end
2017-09-10 17:25:29 +05:30
end
2021-10-27 15:23:28 +05:30
def partitioned_table(name, by: :created_at, strategy: :monthly)
klass = Class.new(active_record_base) do
include PartitionedTable
self.table_name = name
self.primary_key = :id
partitioned_by by, strategy: strategy
def self.name
table_name.singularize.camelcase
end
end
2021-11-11 11:23:49 +05:30
klass.tap { Gitlab::Database::Partitioning.sync_partitions([klass]) }
2021-10-27 15:23:28 +05:30
end
2017-09-10 17:25:29 +05:30
def migrations_paths
2021-12-11 22:18:48 +05:30
active_record_base.connection.migrations_paths
2017-09-10 17:25:29 +05:30
end
2019-09-30 21:07:59 +05:30
def migration_context
2020-03-13 15:44:24 +05:30
ActiveRecord::MigrationContext.new(migrations_paths, ActiveRecord::SchemaMigration)
2019-09-30 21:07:59 +05:30
end
2017-09-10 17:25:29 +05:30
def migrations
2019-09-30 21:07:59 +05:30
migration_context.migrations
2017-09-10 17:25:29 +05:30
end
2018-03-17 18:26:18 +05:30
def clear_schema_cache!
2018-12-13 13:39:08 +05:30
active_record_base.connection_pool.connections.each do |conn|
2018-03-17 18:26:18 +05:30
conn.schema_cache.clear!
end
end
2017-09-10 17:25:29 +05:30
2018-10-15 14:42:47 +05:30
def foreign_key_exists?(source, target = nil, column: nil)
2021-12-11 22:18:48 +05:30
active_record_base.connection.foreign_keys(source).any? do |key|
2018-10-15 14:42:47 +05:30
if column
key.options[:column].to_s == column.to_s
else
key.to_table.to_s == target.to_s
end
end
end
2018-03-17 18:26:18 +05:30
def reset_column_in_all_models
clear_schema_cache!
2017-09-10 17:25:29 +05:30
2018-03-17 18:26:18 +05:30
# Reset column information for the most offending classes **after** we
2018-03-27 19:54:05 +05:30
# migrated the schema up, otherwise, column information could be
# outdated. We have a separate method for this so we can override it in EE.
2018-12-13 13:39:08 +05:30
active_record_base.descendants.each(&method(:reset_column_information))
end
2018-03-17 18:26:18 +05:30
2018-12-13 13:39:08 +05:30
def refresh_attribute_methods
# Without this, we get errors because of missing attributes, e.g.
2018-03-17 18:26:18 +05:30
# super: no superclass method `elasticsearch_indexing' for #<ApplicationSetting:0x00007f85628508d8>
2018-12-13 13:39:08 +05:30
# attr_encrypted also expects ActiveRecord attribute methods to be
# defined, or it will override the accessors:
2019-12-04 20:38:33 +05:30
# https://gitlab.com/gitlab-org/gitlab/issues/8234#note_113976421
2018-12-13 13:39:08 +05:30
[ApplicationSetting, SystemHook].each do |model|
model.define_attribute_methods
end
2022-11-25 23:54:43 +05:30
Gitlab.ee { License.define_attribute_methods }
2017-09-10 17:25:29 +05:30
end
2018-03-27 19:54:05 +05:30
def reset_column_information(klass)
klass.reset_column_information
end
2019-02-15 15:39:39 +05:30
# In some migration tests, we're using factories to create records,
# however those models might be depending on a schema version which
# doesn't have the columns we want in application_settings.
# In these cases, we'll need to use the fake application settings
# as if we have migrations pending
def use_fake_application_settings
# We stub this way because we can't stub on
# `current_application_settings` due to `method_missing` is
# depending on current_application_settings...
2023-03-17 16:20:25 +05:30
allow(Gitlab::Database::Migration::V1_0::MigrationRecord.connection)
2019-02-15 15:39:39 +05:30
.to receive(:active?)
.and_return(false)
2020-04-22 19:07:51 +05:30
allow(Gitlab::Runtime)
.to receive(:rake?)
.and_return(true)
2019-02-15 15:39:39 +05:30
stub_env('IN_MEMORY_APPLICATION_SETTINGS', 'false')
end
2022-05-07 20:08:51 +05:30
def previous_migration(steps_back = 2)
migrations.each_cons(steps_back) do |cons|
break cons.first if cons.last.name == described_class.name
2017-09-10 17:25:29 +05:30
end
end
def migration_schema_version
2018-03-27 19:54:05 +05:30
metadata_schema = self.class.metadata[:schema]
if metadata_schema == :latest
migrations.last.version
else
metadata_schema || previous_migration.version
end
2017-09-10 17:25:29 +05:30
end
def schema_migrate_down!
disable_migrations_output do
2019-09-30 21:07:59 +05:30
migration_context.down(migration_schema_version)
2017-09-10 17:25:29 +05:30
end
2018-03-17 18:26:18 +05:30
reset_column_in_all_models
2017-09-10 17:25:29 +05:30
end
def schema_migrate_up!
2018-03-27 19:54:05 +05:30
reset_column_in_all_models
2017-09-10 17:25:29 +05:30
disable_migrations_output do
2019-09-30 21:07:59 +05:30
migration_context.up
2017-09-10 17:25:29 +05:30
end
2018-03-17 18:26:18 +05:30
reset_column_in_all_models
2018-12-13 13:39:08 +05:30
refresh_attribute_methods
2017-09-10 17:25:29 +05:30
end
def disable_migrations_output
ActiveRecord::Migration.verbose = false
yield
ensure
ActiveRecord::Migration.verbose = true
end
def migrate!
2023-03-17 16:20:25 +05:30
open_transactions = Gitlab::Database::Migration::V1_0::MigrationRecord.connection.open_transactions
2022-07-16 23:28:13 +05:30
allow_next_instance_of(described_class) do |migration|
allow(migration).to receive(:transaction_open?) do
2023-03-17 16:20:25 +05:30
Gitlab::Database::Migration::V1_0::MigrationRecord.connection.open_transactions > open_transactions
2022-07-16 23:28:13 +05:30
end
end
2019-09-30 21:07:59 +05:30
migration_context.up do |migration|
2017-09-10 17:25:29 +05:30
migration.name == described_class.name
end
end
2019-12-21 20:55:43 +05:30
class ReversibleMigrationTest
attr_reader :before_up, :after_up
def initialize
@before_up = -> {}
@after_up = -> {}
end
def before(expectations)
@before_up = expectations
self
end
def after(expectations)
@after_up = expectations
self
end
end
def reversible_migration(&block)
tests = yield(ReversibleMigrationTest.new)
tests.before_up.call
migrate!
tests.after_up.call
schema_migrate_down!
tests.before_up.call
end
2017-09-10 17:25:29 +05:30
end
2019-12-04 20:38:33 +05:30
2021-06-08 01:23:25 +05:30
MigrationsHelpers.prepend_mod_with('MigrationsHelpers')