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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
# frozen_string_literal: true
require 'spec_helper'
require_relative '../../../lib/click_house/migration_support/migration_error'
RSpec.describe ClickHouse::MigrationSupport::MigrationContext,
click_house: :without_migrations, feature_category: :database do
include ClickHouseTestHelpers
# We don't need to delete data since we don't modify Postgres data
self.use_transactional_tests = false
let_it_be(:schema_migration) { ClickHouse::MigrationSupport::SchemaMigration }
let(:migrations_base_dir) { 'click_house/migrations' }
let(:migrations_dir) { expand_fixture_path("#{migrations_base_dir}/#{migrations_dirname}") }
let(:migration_context) { described_class.new(migrations_dir, schema_migration) }
let(:target_version) { nil }
after do
clear_consts(expand_fixture_path(migrations_base_dir))
end
describe 'performs migrations' do
subject(:migration) { migrate(target_version, migration_context) }
describe 'when creating a table' do
let(:migrations_dirname) { 'plain_table_creation' }
it 'creates a table' do
expect { migration }.to change { active_schema_migrations_count }.from(0).to(1)
table_schema = describe_table('some')
expect(schema_migrations).to contain_exactly(a_hash_including(version: '1', active: 1))
expect(table_schema).to match({
id: a_hash_including(type: 'UInt64'),
date: a_hash_including(type: 'Date')
})
end
end
describe 'when dropping a table' do
let(:migrations_dirname) { 'drop_table' }
let(:target_version) { 2 }
it 'drops table' do
migrate(1, migration_context)
expect(table_names).to include('some')
migration
expect(table_names).not_to include('some')
end
end
context 'when a migration raises an error' do
let(:migrations_dirname) { 'migration_with_error' }
it 'passes the error to caller as a StandardError' do
expect { migration }.to raise_error StandardError,
"An error has occurred, all later migrations canceled:\n\nA migration error happened"
expect(schema_migrations).to be_empty
end
end
context 'when a migration targets an unknown database' do
let(:migrations_dirname) { 'plain_table_creation_on_invalid_database' }
it 'raises ConfigurationError' do
expect { migration }.to raise_error ClickHouse::Client::ConfigurationError,
"The database 'unknown_database' is not configured"
end
end
context 'when migrations target multiple databases' do
let_it_be(:config) { ClickHouse::Client::Configuration.new }
let_it_be(:main_db_config) { [:main, config] }
let_it_be(:another_db_config) { [:another_db, config] }
let_it_be(:another_database_name) { 'gitlab_clickhouse_test_2' }
let(:migrations_dirname) { 'migrations_over_multiple_databases' }
before(:context) do
# Ensure we have a second database to run the test on
clone_database_configuration(:main, :another_db, another_database_name, config)
with_net_connect_allowed do
ClickHouse::Client.execute("CREATE DATABASE IF NOT EXISTS #{another_database_name}", :main, config)
end
end
after(:context) do
with_net_connect_allowed do
ClickHouse::Client.execute("DROP DATABASE #{another_database_name}", :another_db, config)
end
end
around do |example|
clear_db(config)
previous_config = ClickHouse::Migration.client_configuration
ClickHouse::Migration.client_configuration = config
example.run
ensure
ClickHouse::Migration.client_configuration = previous_config
end
def clone_database_configuration(source_db_identifier, target_db_identifier, target_db_name, target_config)
raw_config = Rails.application.config_for(:click_house)
raw_config.each do |database_identifier, db_config|
register_database(target_config, database_identifier, db_config)
end
target_db_config = raw_config[source_db_identifier].merge(database: target_db_name)
register_database(target_config, target_db_identifier, target_db_config)
target_config.http_post_proc = ClickHouse::Client.configuration.http_post_proc
target_config.json_parser = ClickHouse::Client.configuration.json_parser
target_config.logger = ::Logger.new(IO::NULL)
end
it 'registers migrations on respective database', :aggregate_failures do
expect { migrate(2, migration_context) }
.to change { active_schema_migrations_count(*main_db_config) }.from(0).to(1)
.and change { active_schema_migrations_count(*another_db_config) }.from(0).to(1)
expect(schema_migrations(*another_db_config)).to contain_exactly(a_hash_including(version: '2', active: 1))
expect(table_names(*main_db_config)).not_to include('some_on_another_db')
expect(table_names(*another_db_config)).not_to include('some')
expect(describe_table('some', *main_db_config)).to match({
id: a_hash_including(type: 'UInt64'),
date: a_hash_including(type: 'Date')
})
expect(describe_table('some_on_another_db', *another_db_config)).to match({
id: a_hash_including(type: 'UInt64'),
date: a_hash_including(type: 'Date')
})
expect { migrate(nil, migration_context) }
.to change { active_schema_migrations_count(*main_db_config) }.to(2)
.and not_change { active_schema_migrations_count(*another_db_config) }
expect(schema_migrations(*main_db_config)).to match([
a_hash_including(version: '1', active: 1),
a_hash_including(version: '3', active: 1)
])
expect(schema_migrations(*another_db_config)).to match_array(a_hash_including(version: '2', active: 1))
expect(describe_table('some', *main_db_config)).to match({
id: a_hash_including(type: 'UInt64'),
timestamp: a_hash_including(type: 'Date')
})
end
end
context 'when target_version is incorrect' do
let(:target_version) { 2 }
let(:migrations_dirname) { 'plain_table_creation' }
it 'raises UnknownMigrationVersionError' do
expect { migration }.to raise_error ClickHouse::MigrationSupport::UnknownMigrationVersionError
expect(active_schema_migrations_count).to eq 0
end
end
context 'when migrations with duplicate name exist' do
let(:migrations_dirname) { 'duplicate_name' }
it 'raises DuplicateMigrationNameError' do
expect { migration }.to raise_error ClickHouse::MigrationSupport::DuplicateMigrationNameError
expect(active_schema_migrations_count).to eq 0
end
end
context 'when migrations with duplicate version exist' do
let(:migrations_dirname) { 'duplicate_version' }
it 'raises DuplicateMigrationVersionError' do
expect { migration }.to raise_error ClickHouse::MigrationSupport::DuplicateMigrationVersionError
expect(active_schema_migrations_count).to eq 0
end
end
end
describe 'performs rollbacks' do
subject(:migration) { rollback(target_version, migration_context) }
before do
migrate(nil, migration_context)
end
context 'when migrating back all the way to 0' do
let(:target_version) { 0 }
context 'when down method is present' do
let(:migrations_dirname) { 'table_creation_with_down_method' }
it 'removes migration and performs down method' do
expect(table_names).to include('some')
expect { migration }.to change { active_schema_migrations_count }.from(1).to(0)
expect(table_names).not_to include('some')
expect(schema_migrations).to contain_exactly(a_hash_including(version: '1', active: 0))
end
end
context 'when down method is missing' do
let(:migrations_dirname) { 'plain_table_creation' }
it 'removes migration ignoring missing down method' do
expect { migration }.to change { active_schema_migrations_count }.from(1).to(0)
.and not_change { table_names & %w[some] }.from(%w[some])
end
end
end
context 'when target_version is incorrect' do
let(:target_version) { -1 }
let(:migrations_dirname) { 'plain_table_creation' }
it 'raises UnknownMigrationVersionError' do
expect { migration }.to raise_error ClickHouse::MigrationSupport::UnknownMigrationVersionError
expect(active_schema_migrations_count).to eq 1
end
end
end
end
|
