1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
# frozen_string_literal: true
module Gitlab
module Database
module Migrations
class Runner
BASE_RESULT_DIR = Rails.root.join('tmp', 'migration-testing').freeze
METADATA_FILENAME = 'metadata.json'
SCHEMA_VERSION = 4 # Version of the output format produced by the runner
class << self
def up(database:, legacy_mode: false)
within_context_for_database(database) do
Runner.new(direction: :up, database: database, migrations: migrations_for_up(database), legacy_mode: legacy_mode)
end
end
def down(database:, legacy_mode: false)
within_context_for_database(database) do
Runner.new(direction: :down, database: database, migrations: migrations_for_down(database), legacy_mode: legacy_mode)
end
end
def background_migrations
TestBackgroundRunner.new(result_dir: BASE_RESULT_DIR.join('background_migrations'))
end
def batched_background_migrations(for_database:, legacy_mode: false)
runner = nil
result_dir = if legacy_mode
BASE_RESULT_DIR.join('background_migrations')
else
BASE_RESULT_DIR.join(for_database.to_s, 'background_migrations')
end
# Only one loop iteration since we pass `only:` here
Gitlab::Database::EachDatabase.each_database_connection(only: for_database) do |connection|
runner = Gitlab::Database::Migrations::TestBatchedBackgroundRunner
.new(result_dir: result_dir, connection: connection)
end
runner
end
def migration_context
# We're mirroring rails internal migration code, which requires that
# ActiveRecord::Base has connected to the current database. The correct database is chosen by
# within_context_for_database
ActiveRecord::Base.connection.migration_context # rubocop:disable Database/MultipleDatabases
end
# rubocop:disable Database/MultipleDatabases
def within_context_for_database(database)
original_db_config = ActiveRecord::Base.connection_db_config
# The config only works if passed a string
db_config = ActiveRecord::Base.configurations.configs_for(env_name: Rails.env, name: database.to_s)
raise ArgumentError, "Cannot find a database configuration for #{database}" unless db_config
ActiveRecord::Base.establish_connection(db_config) # rubocop:disable Database/EstablishConnection
yield
ensure
ActiveRecord::Base.establish_connection(original_db_config) # rubocop:disable Database/EstablishConnection
end
# rubocop:enable Database/MultipleDatabases
private
def migrations_for_up(database)
existing_versions = migration_context.get_all_versions.to_set
migration_context.migrations.reject do |migration|
existing_versions.include?(migration.version)
end
end
def migration_file_names_this_branch
`git diff --name-only origin/HEAD...HEAD db/post_migrate db/migrate`.split("\n")
end
def migrations_for_down(database)
versions_this_branch = migration_file_names_this_branch.map do |m_name|
m_name.match(%r{^db/(post_)?migrate/(\d+)}) { |m| m.captures[1]&.to_i }
end.to_set
existing_versions = migration_context.get_all_versions.to_set
migration_context.migrations.select do |migration|
existing_versions.include?(migration.version) && versions_this_branch.include?(migration.version)
end
end
end
attr_reader :direction, :result_dir, :migrations
delegate :migration_context, :within_context_for_database, to: :class
def initialize(direction:, database:, migrations:, legacy_mode: false)
raise "Direction must be up or down" unless %i[up down].include?(direction)
@direction = direction
@migrations = migrations
@result_dir = if legacy_mode
BASE_RESULT_DIR.join(direction.to_s)
else
BASE_RESULT_DIR.join(database.to_s, direction.to_s)
end
@database = database
@legacy_mode = legacy_mode
end
def run
FileUtils.mkdir_p(result_dir)
verbose_was = ActiveRecord::Migration.verbose
ActiveRecord::Migration.verbose = true
sorted_migrations = migrations.sort_by(&:version)
sorted_migrations.reverse! if direction == :down
instrumentation = Instrumentation.new(result_dir: result_dir)
within_context_for_database(@database) do
sorted_migrations.each do |migration|
instrumentation.observe(version: migration.version, name: migration.name, connection: ActiveRecord::Migration.connection) do
ActiveRecord::Migrator.new(direction, migration_context.migrations, migration_context.schema_migration, migration.version).run
end
end
end
ensure
metadata_filename = File.join(result_dir, METADATA_FILENAME)
version = if @legacy_mode
3
else
SCHEMA_VERSION
end
File.write(metadata_filename, { database: @database.to_s, version: version }.to_json)
# We clear the cache here to mirror the cache clearing that happens at the end of `db:migrate` tasks
# This clearing makes subsequent rake tasks in the same execution pick up database schema changes caused by
# the migrations that were just executed
ApplicationRecord.clear_cache!
ActiveRecord::Migration.verbose = verbose_was
end
end
end
end
end
|
