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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe API::Admin::BatchedBackgroundMigrations, feature_category: :database do
let(:admin) { create(:admin) }
let(:unauthorized_user) { create(:user) }
describe 'GET /admin/batched_background_migrations/:id' do
let!(:migration) { create(:batched_background_migration, :paused) }
let(:database) { :main }
let(:params) { { database: database } }
subject(:show_migration) do
get api("/admin/batched_background_migrations/#{migration.id}", admin), params: { database: database }
end
it 'fetches the batched background migration' do
show_migration
aggregate_failures "testing response" do
expect(response).to have_gitlab_http_status(:ok)
expect(json_response['id']).to eq(migration.id)
expect(json_response['status']).to eq('paused')
expect(json_response['job_class_name']).to eq(migration.job_class_name)
expect(json_response['progress']).to be_zero
end
end
context 'when the batched background migration does not exist' do
it 'returns 404' do
get api("/admin/batched_background_migrations/#{non_existing_record_id}", admin), params: params
expect(response).to have_gitlab_http_status(:not_found)
end
end
context 'when multiple database is enabled' do
before do
skip_if_multiple_databases_not_setup
end
let(:ci_model) { Ci::ApplicationRecord }
let(:database) { :ci }
it 'uses the correct connection' do
expect(Gitlab::Database::SharedModel).to receive(:using_connection).with(ci_model.connection).and_yield
show_migration
end
end
context 'when authenticated as a non-admin user' do
it 'returns 403' do
get api("/admin/batched_background_migrations/#{migration.id}", unauthorized_user)
expect(response).to have_gitlab_http_status(:forbidden)
end
end
context 'when the database name does not exist' do
let(:database) { :wrong_database }
it 'returns bad request' do
get api("/admin/batched_background_migrations/#{migration.id}", admin), params: params
expect(response).to have_gitlab_http_status(:bad_request)
expect(response.body).to include('database does not have a valid value')
end
end
end
describe 'GET /admin/batched_background_migrations' do
let!(:migration) { create(:batched_background_migration) }
context 'when is an admin user' do
it 'returns batched background migrations' do
get api('/admin/batched_background_migrations', admin)
aggregate_failures "testing response" do
expect(response).to have_gitlab_http_status(:ok)
expect(json_response.count).to eq(1)
expect(json_response.first['id']).to eq(migration.id)
expect(json_response.first['job_class_name']).to eq(migration.job_class_name)
expect(json_response.first['table_name']).to eq(migration.table_name)
expect(json_response.first['status']).to eq(migration.status_name.to_s)
expect(json_response.first['progress']).to be_zero
end
end
context 'when multiple database is enabled', :add_ci_connection do
let(:database) { :ci }
let(:schema) { :gitlab_ci }
let(:ci_model) { Ci::ApplicationRecord }
let(:params) { { database: database } }
context 'when CI database is provided' do
let(:db_config) { instance_double(ActiveRecord::DatabaseConfigurations::HashConfig, name: 'fake_db') }
let(:default_model) { ActiveRecord::Base }
let(:base_models) { { 'fake_db' => default_model, 'ci' => ci_model }.with_indifferent_access }
it "uses CI database connection" do
allow(Gitlab::Database).to receive(:db_config_for_connection).and_return(db_config)
allow(Gitlab::Database).to receive(:database_base_models).and_return(base_models)
expect(Gitlab::Database::SharedModel).to receive(:using_connection).with(ci_model.connection).and_yield
get api('/admin/batched_background_migrations', admin), params: params
end
context 'when the database name does not exist' do
let(:database) { :wrong_database }
it 'returns bad request' do
get api("/admin/batched_background_migrations", admin), params: params
expect(response).to have_gitlab_http_status(:bad_request)
expect(response.body).to include('database does not have a valid value')
end
end
it 'returns CI database records' do
# If we only have one DB we'll see both migrations
skip_if_multiple_databases_not_setup
ci_database_migration = Gitlab::Database::SharedModel.using_connection(ci_model.connection) do
create(:batched_background_migration, :active, gitlab_schema: schema)
end
get api('/admin/batched_background_migrations', admin), params: params
aggregate_failures "testing response" do
expect(response).to have_gitlab_http_status(:ok)
expect(json_response.count).to eq(1)
expect(json_response.first['id']).to eq(ci_database_migration.id)
expect(json_response.first['job_class_name']).to eq(ci_database_migration.job_class_name)
expect(json_response.first['table_name']).to eq(ci_database_migration.table_name)
expect(json_response.first['status']).to eq(ci_database_migration.status_name.to_s)
expect(json_response.first['progress']).to be_zero
end
end
end
end
end
context 'when authenticated as a non-admin user' do
it 'returns 403' do
get api('/admin/batched_background_migrations', unauthorized_user)
expect(response).to have_gitlab_http_status(:forbidden)
end
end
end
describe 'PUT /admin/batched_background_migrations/:id/resume' do
let!(:migration) { create(:batched_background_migration, :paused) }
let(:database) { :main }
let(:params) { { database: database } }
subject(:resume) do
put api("/admin/batched_background_migrations/#{migration.id}/resume", admin), params: params
end
it 'pauses the batched background migration' do
resume
aggregate_failures "testing response" do
expect(response).to have_gitlab_http_status(:ok)
expect(json_response['id']).to eq(migration.id)
expect(json_response['status']).to eq('active')
end
end
context 'when the batched background migration does not exist' do
it 'returns 404' do
put api("/admin/batched_background_migrations/#{non_existing_record_id}/resume", admin), params: params
expect(response).to have_gitlab_http_status(:not_found)
end
end
context 'when the migration is not paused' do
let!(:migration) { create(:batched_background_migration, :failed) }
it 'returns 422' do
put api("/admin/batched_background_migrations/#{migration.id}/resume", admin), params: params
expect(response).to have_gitlab_http_status(:unprocessable_entity)
end
end
context 'when multiple database is enabled' do
let(:ci_model) { Ci::ApplicationRecord }
let(:database) { :ci }
before do
skip_if_multiple_databases_not_setup
end
it 'uses the correct connection' do
expect(Gitlab::Database::SharedModel).to receive(:using_connection).with(ci_model.connection).and_yield
resume
end
context 'when the database name does not exist' do
let(:database) { :wrong_database }
it 'returns bad request' do
put api("/admin/batched_background_migrations/#{migration.id}/resume", admin), params: params
expect(response).to have_gitlab_http_status(:bad_request)
expect(response.body).to include('database does not have a valid value')
end
end
end
context 'when authenticated as a non-admin user' do
it 'returns 403' do
put api("/admin/batched_background_migrations/#{migration.id}/resume", unauthorized_user)
expect(response).to have_gitlab_http_status(:forbidden)
end
end
end
describe 'PUT /admin/batched_background_migrations/:id/pause' do
let!(:migration) { create(:batched_background_migration, :active) }
let(:database) { :main }
let(:params) { { database: database } }
it 'pauses the batched background migration' do
put api("/admin/batched_background_migrations/#{migration.id}/pause", admin), params: params
aggregate_failures "testing response" do
expect(response).to have_gitlab_http_status(:ok)
expect(json_response['id']).to eq(migration.id)
expect(json_response['status']).to eq('paused')
end
end
context 'when the batched background migration does not exist' do
it 'returns 404' do
put api("/admin/batched_background_migrations/#{non_existing_record_id}/pause", admin), params: params
expect(response).to have_gitlab_http_status(:not_found)
end
end
context 'when the migration is not active' do
let!(:migration) { create(:batched_background_migration, :failed) }
it 'returns 422' do
put api("/admin/batched_background_migrations/#{migration.id}/pause", admin), params: params
expect(response).to have_gitlab_http_status(:unprocessable_entity)
end
end
context 'when multiple database is enabled' do
let(:ci_model) { Ci::ApplicationRecord }
let(:database) { :ci }
before do
skip_if_multiple_databases_not_setup
end
it 'uses the correct connection' do
expect(Gitlab::Database::SharedModel).to receive(:using_connection).with(ci_model.connection).and_yield
put api("/admin/batched_background_migrations/#{migration.id}/pause", admin), params: params
end
context 'when the database name does not exist' do
let(:database) { :wrong_database }
it 'returns bad request' do
put api("/admin/batched_background_migrations/#{migration.id}/pause", admin), params: params
expect(response).to have_gitlab_http_status(:bad_request)
expect(response.body).to include('database does not have a valid value')
end
end
end
context 'when authenticated as a non-admin user' do
it 'returns 403' do
put api("/admin/batched_background_migrations/#{non_existing_record_id}/pause", unauthorized_user)
expect(response).to have_gitlab_http_status(:forbidden)
end
end
end
end
|