gitlab-org--gitlab-foss/spec/support/helpers/migrations_helpers.rb
Stan Hu 8fd2c8b16a Prevent attr_encrypted models from being overriden
Fix failing spec in spec/controllers/admin/hooks_controller_spec.rb

attr_encrypted expects models to have their attribute methods defined,
or it will override them with standard Ruby accessors. Migration specs
that rolled back the state of the database after columns were migrated
to encrypted values were interfering with these definitions. To ensure
that the SystemHook specs pass, we need to call
`SystemHook.define_attribute_methods` to ensure that attr_encrypted sees
the right methods that reflect the latest state of the database.

Closes https://gitlab.com/gitlab-org/gitlab-ee/issues/8234
2018-11-07 12:18:04 -08:00

114 lines
2.9 KiB
Ruby

module MigrationsHelpers
def active_record_base
ActiveRecord::Base
end
def table(name)
Class.new(active_record_base) do
self.table_name = name
self.inheritance_column = :_type_disabled
def self.name
table_name.singularize.camelcase
end
end
end
def migrations_paths
ActiveRecord::Migrator.migrations_paths
end
def migrations
ActiveRecord::Migrator.migrations(migrations_paths)
end
def clear_schema_cache!
active_record_base.connection_pool.connections.each do |conn|
conn.schema_cache.clear!
end
end
def foreign_key_exists?(source, target = nil, column: nil)
ActiveRecord::Base.connection.foreign_keys(source).any? do |key|
if column
key.options[:column].to_s == column.to_s
else
key.to_table.to_s == target.to_s
end
end
end
def reset_column_in_all_models
clear_schema_cache!
# Reset column information for the most offending classes **after** we
# migrated the schema up, otherwise, column information could be
# outdated. We have a separate method for this so we can override it in EE.
active_record_base.descendants.each(&method(:reset_column_information))
end
def refresh_attribute_methods
# Without this, we get errors because of missing attributes, e.g.
# super: no superclass method `elasticsearch_indexing' for #<ApplicationSetting:0x00007f85628508d8>
# attr_encrypted also expects ActiveRecord attribute methods to be
# defined, or it will override the accessors:
# https://gitlab.com/gitlab-org/gitlab-ee/issues/8234#note_113976421
[ApplicationSetting, SystemHook].each do |model|
model.define_attribute_methods
end
end
def reset_column_information(klass)
klass.reset_column_information
end
def previous_migration
migrations.each_cons(2) do |previous, migration|
break previous if migration.name == described_class.name
end
end
def migration_schema_version
metadata_schema = self.class.metadata[:schema]
if metadata_schema == :latest
migrations.last.version
else
metadata_schema || previous_migration.version
end
end
def schema_migrate_down!
disable_migrations_output do
ActiveRecord::Migrator.migrate(migrations_paths,
migration_schema_version)
end
reset_column_in_all_models
end
def schema_migrate_up!
reset_column_in_all_models
disable_migrations_output do
ActiveRecord::Migrator.migrate(migrations_paths)
end
reset_column_in_all_models
refresh_attribute_methods
end
def disable_migrations_output
ActiveRecord::Migration.verbose = false
yield
ensure
ActiveRecord::Migration.verbose = true
end
def migrate!
ActiveRecord::Migrator.up(migrations_paths) do |migration|
migration.name == described_class.name
end
end
end