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
295
296
297
298
299
300
301
302
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe ProjectImportState, type: :model, feature_category: :importers do
let_it_be(:correlation_id) { 'cid' }
let_it_be(:import_state, refind: true) { create(:import_state, correlation_id_value: correlation_id) }
subject { import_state }
describe 'associations' do
it { is_expected.to belong_to(:project) }
end
describe 'validations' do
it { is_expected.to validate_presence_of(:project) }
describe 'checksums attribute' do
let(:import_state) { build(:import_state, checksums: checksums) }
before do
import_state.validate
end
context 'when the checksums attribute has invalid fields' do
let(:checksums) { { fetched: { issue: :foo, note: 20 } } }
it 'adds errors' do
expect(import_state.errors.details.keys).to include(:checksums)
end
end
context 'when the checksums attribute has valid fields' do
let(:checksums) { { fetched: { issue: 8, note: 2 }, imported: { issue: 3, note: 2 } } }
it 'does not add errors' do
expect(import_state.errors.details.keys).not_to include(:checksums)
end
end
end
end
describe 'Project import job' do
let_it_be(:project) { create(:project) }
let(:import_state) { create(:import_state, import_url: generate(:url), project: project) }
let(:jid) { '551d3ceac5f67a116719ce41' }
before do
# Works around https://github.com/rspec/rspec-mocks/issues/910
allow(Project).to receive(:find).with(project.id).and_return(project)
allow(project).to receive(:add_import_job).and_return(jid)
end
it 'imports a project', :sidekiq_might_not_need_inline do
expect { import_state.schedule }.to change { import_state.status }.from('none').to('scheduled')
end
it 'records job and correlation IDs', :sidekiq_might_not_need_inline do
allow(Labkit::Correlation::CorrelationId).to receive(:current_or_new_id).and_return(correlation_id)
import_state.schedule
expect(project).to have_received(:add_import_job)
expect(import_state.jid).to eq(jid)
expect(import_state.correlation_id).to eq(correlation_id)
end
end
describe '#relation_hard_failures' do
let_it_be(:failures) { create_list(:import_failure, 2, :hard_failure, project: import_state.project, correlation_id_value: correlation_id) }
it 'returns hard relation failures related to this import' do
expect(subject.relation_hard_failures(limit: 100)).to match_array(failures)
end
it 'limits returned collection to given maximum' do
expect(subject.relation_hard_failures(limit: 1).size).to eq(1)
end
end
describe '#mark_as_failed' do
let(:error_message) { 'some message' }
it 'logs error when update column fails' do
allow(import_state).to receive(:update_column).and_raise(ActiveRecord::ActiveRecordError)
expect_next_instance_of(Gitlab::Import::Logger) do |logger|
expect(logger).to receive(:error).with(
{
error: 'ActiveRecord::ActiveRecordError',
message: 'Error setting import status to failed',
original_error: error_message
}
)
end
import_state.mark_as_failed(error_message)
end
it 'updates last_error with error message' do
import_state.mark_as_failed(error_message)
expect(import_state.last_error).to eq(error_message)
end
it 'removes project import data' do
import_data = ProjectImportData.new(data: { 'test' => 'some data' })
project = create(:project, import_data: import_data)
import_state = create(:import_state, :started, project: project)
expect do
import_state.mark_as_failed(error_message)
end.to change { project.reload.import_data }.from(import_data).to(nil)
end
end
describe '#human_status_name' do
context 'when import_state exists' do
it 'returns the humanized status name' do
import_state = build(:import_state, :started)
expect(import_state.human_status_name).to eq("started")
end
end
end
describe '#expire_etag_cache' do
context 'when project import type has realtime changes endpoint' do
before do
import_state.project.import_type = 'github'
end
it 'expires revelant etag cache' do
expect_next_instance_of(Gitlab::EtagCaching::Store) do |instance|
expect(instance).to receive(:touch).with(Gitlab::Routing.url_helpers.realtime_changes_import_github_path(format: :json))
end
subject.expire_etag_cache
end
end
context 'when project import type does not have realtime changes endpoint' do
before do
import_state.project.import_type = 'jira'
end
it 'does not touch etag caches' do
expect(Gitlab::EtagCaching::Store).not_to receive(:new)
subject.expire_etag_cache
end
end
end
describe 'import state transitions' do
context 'state transition: [:started] => [:finished]' do
it 'resets last_error' do
error_message = 'Some error'
import_state = create(:import_state, :started, last_error: error_message)
expect { import_state.finish }.to change { import_state.last_error }.from(error_message).to(nil)
end
it 'enqueues housekeeping when an import of a fresh project is completed' do
project = create(:project_empty_repo, :import_started, import_type: :github)
expect(Projects::AfterImportWorker).to receive(:perform_async).with(project.id)
project.import_state.finish
end
it 'does not perform housekeeping when project repository does not exist' do
project = create(:project, :import_started, import_type: :github)
expect(Projects::AfterImportWorker).not_to receive(:perform_async)
project.import_state.finish
end
it 'does not enqueue housekeeping when project does not have a valid import type' do
project = create(:project, :import_started, import_type: nil)
expect(Projects::AfterImportWorker).not_to receive(:perform_async)
project.import_state.finish
end
end
context 'state transition: [:none, :scheduled, :started] => [:canceled]' do
it 'updates the import status' do
import_state = create(:import_state, :none)
expect { import_state.cancel }
.to change { import_state.status }
.from('none').to('canceled')
end
it 'unsets the JID' do
import_state = create(:import_state, :started, jid: '123')
expect(Gitlab::SidekiqStatus)
.to receive(:unset)
.with('123')
.and_call_original
import_state.cancel!
expect(import_state.jid).to be_nil
end
it 'removes import data' do
import_data = ProjectImportData.new(data: { 'test' => 'some data' })
project = create(:project, :import_scheduled, import_data: import_data)
expect(project)
.to receive(:remove_import_data)
.and_call_original
expect do
project.import_state.cancel
project.reload
end.to change { project.import_data }
.from(import_data).to(nil)
end
end
context 'state transition: started: [:finished, :canceled, :failed]' do
using RSpec::Parameterized::TableSyntax
let_it_be_with_reload(:project) { create(:project) }
where(
:import_type,
:import_status,
:transition,
:expected_checksums
) do
'github' | :started | :finish | { 'fetched' => {}, 'imported' => {} }
'github' | :started | :cancel | { 'fetched' => {}, 'imported' => {} }
'github' | :started | :fail_op | { 'fetched' => {}, 'imported' => {} }
'github' | :scheduled | :cancel | {}
'gitlab_project' | :started | :cancel | {}
end
with_them do
before do
create(:import_state, status: import_status, import_type: import_type, project: project)
end
it 'updates (or does not update) checksums' do
project.import_state.send(transition)
expect(project.import_state.checksums).to eq(expected_checksums)
end
end
end
end
describe 'clearing `jid` after finish', :clean_gitlab_redis_cache do
context 'without an JID' do
it 'does nothing' do
import_state = create(:import_state, :started)
expect(Gitlab::SidekiqStatus)
.not_to receive(:unset)
import_state.finish!
end
end
context 'with a JID' do
it 'unsets the JID' do
import_state = create(:import_state, :started, jid: '123')
expect(Gitlab::SidekiqStatus)
.to receive(:unset)
.with('123')
.and_call_original
import_state.finish!
expect(import_state.jid).to be_nil
end
end
end
describe 'callbacks' do
context 'after_commit :expire_etag_cache' do
before do
import_state.project.import_type = 'github'
end
it 'expires etag cache' do
expect_next_instance_of(Gitlab::EtagCaching::Store) do |instance|
expect(instance).to receive(:touch).with(Gitlab::Routing.url_helpers.realtime_changes_import_github_path(format: :json))
end
subject.save!
end
end
end
end
|