Ensure the schema is loaded with post_migrations included

If doing a schema load, the post_migrations should also be marked as up,
even if SKIP_POST_DEPLOYMENT_MIGRATIONS was set, otherwise future
migration runs will be broken.
This commit is contained in:
DJ Mountney 2018-09-11 18:41:14 -07:00
parent f6097cbfaa
commit 76cfe4f1fd
4 changed files with 48 additions and 11 deletions

View file

@ -1,14 +1,4 @@
# Post deployment migrations are included by default. This file must be loaded
# before other initializers as Rails may otherwise memoize a list of migrations
# excluding the post deployment migrations.
unless ENV['SKIP_POST_DEPLOYMENT_MIGRATIONS']
Rails.application.config.paths['db'].each do |db_path|
path = Rails.root.join(db_path, 'post_migrate').to_s
Rails.application.config.paths['db/migrate'] << path
# Rails memoizes migrations at certain points where it won't read the above
# path just yet. As such we must also update the following list of paths.
ActiveRecord::Migrator.migrations_paths << path
end
end
Gitlab::Database.add_post_migrate_path_to_rails

View file

@ -249,5 +249,21 @@ module Gitlab
end
private_class_method :database_version
def self.add_post_migrate_path_to_rails(force: false)
return if ENV['SKIP_POST_DEPLOYMENT_MIGRATIONS'] && !force
Rails.application.config.paths['db'].each do |db_path|
path = Rails.root.join(db_path, 'post_migrate').to_s
unless Rails.application.config.paths['db/migrate'].include? path
Rails.application.config.paths['db/migrate'] << path
# Rails memoizes migrations at certain points where it won't read the above
# path just yet. As such we must also update the following list of paths.
ActiveRecord::Migrator.migrations_paths << path
end
end
end
end
end

View file

@ -51,6 +51,8 @@ namespace :gitlab do
if ActiveRecord::Base.connection.tables.count > 1
Rake::Task['db:migrate'].invoke
else
# Add post-migrate paths to ensure we mark all migrations as up
Gitlab::Database.add_post_migrate_path_to_rails(force: true)
Rake::Task['db:schema:load'].invoke
Rake::Task['db:seed_fu'].invoke
end

View file

@ -61,6 +61,35 @@ describe 'gitlab:db namespace rake task' do
expect(Rake::Task['db:migrate']).not_to receive(:invoke)
expect { run_rake_task('gitlab:db:configure') }.to raise_error(RuntimeError, 'error')
end
context 'SKIP_POST_DEPLOYMENT_MIGRATIONS environment variable set' do
let :migrations_paths do
root = Rails::Paths::Root.new(Rails.root)
root.add('db/migrate')
end
before do
allow(ENV).to receive(:[]).and_call_original
allow(ENV).to receive(:[]).with('SKIP_POST_DEPLOYMENT_MIGRATIONS').and_return true
# Our environment has already been loaded, so we need to pretent like post_migrations were not
allow(Rails.application.config.paths).to receive(:[]).and_call_original
allow(Rails.application.config.paths).to receive(:[]).with('db/migrate').and_return(migrations_paths)
allow(ActiveRecord::Migrator).to receive(:migrations_paths).and_return(migrations_paths)
end
it 'adds post deployment migrations before schema load if the schema is not already loaded' do
allow(ActiveRecord::Base.connection).to receive(:tables).and_return([])
expect(Gitlab::Database).to receive(:add_post_migrate_path_to_rails)
expect(Rake::Task['db:schema:load']).to receive(:invoke)
expect(Rake::Task['db:seed_fu']).to receive(:invoke)
expect(Rake::Task['db:migrate']).not_to receive(:invoke)
expect(Rails.application.config.paths).to receive(:[]).with('db/migrate')
expect { run_rake_task('gitlab:db:configure') }.not_to raise_error
expect(migrations_paths.include?(File.join(Rails.root, 'db', 'post_migrate'))).to be(true)
end
end
end
def run_rake_task(task_name)