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
|
# frozen_string_literal: true
RSpec.shared_examples 'create environment for job' do
let!(:job) { build(factory_type, project: project, pipeline: pipeline, **attributes) }
let(:merge_request) {} # rubocop:disable Lint/EmptyBlock
describe '#execute' do
subject { service.execute(job) }
shared_examples_for 'returning a correct environment' do
let(:expected_auto_stop_in_seconds) do
ChronicDuration.parse(expected_auto_stop_in).seconds if expected_auto_stop_in
end
it 'returns a persisted environment object' do
freeze_time do
expect { subject }.to change { Environment.count }.by(1)
expect(subject).to be_a(Environment)
expect(subject).to be_persisted
expect(subject.project).to eq(project)
expect(subject.name).to eq(expected_environment_name)
expect(subject.auto_stop_in).to eq(expected_auto_stop_in_seconds)
end
end
context 'when environment has already existed' do
let!(:environment) do
create(:environment,
project: project,
name: expected_environment_name
).tap do |env|
env.auto_stop_in = expected_auto_stop_in
end
end
it 'returns the existing environment object' do
expect { subject }.not_to change { Environment.count }
expect { subject }.not_to change { environment.auto_stop_at }
expect(subject).to be_persisted
expect(subject).to eq(environment)
end
end
end
context 'when job has environment name attribute' do
let(:environment_name) { 'production' }
let(:expected_environment_name) { 'production' }
let(:expected_auto_stop_in) { nil }
let(:attributes) do
{
environment: environment_name,
options: { environment: { name: environment_name } }
}
end
it_behaves_like 'returning a correct environment'
context 'and job environment also has an auto_stop_in attribute' do
let(:environment_auto_stop_in) { '5 minutes' }
let(:expected_auto_stop_in) { '5 minutes' }
let(:attributes) do
{
environment: environment_name,
options: {
environment: {
name: environment_name,
auto_stop_in: environment_auto_stop_in
}
}
}
end
it_behaves_like 'returning a correct environment'
end
context 'and job environment has an auto_stop_in variable attribute' do
let(:environment_auto_stop_in) { '10 minutes' }
let(:expected_auto_stop_in) { '10 minutes' }
let(:attributes) do
{
environment: environment_name,
options: {
environment: {
name: environment_name,
auto_stop_in: '$TTL'
}
},
yaml_variables: [
{ key: "TTL", value: environment_auto_stop_in, public: true }
]
}
end
it_behaves_like 'returning a correct environment'
end
end
context 'when job has deployment tier attribute' do
let(:attributes) do
{
environment: 'customer-portal',
options: {
environment: {
name: 'customer-portal',
deployment_tier: deployment_tier
}
}
}
end
let(:deployment_tier) { 'production' }
context 'when environment has not been created yet' do
it 'sets the specified deployment tier' do
is_expected.to be_production
end
context 'when deployment tier is staging' do
let(:deployment_tier) { 'staging' }
it 'sets the specified deployment tier' do
is_expected.to be_staging
end
end
context 'when deployment tier is unknown' do
let(:deployment_tier) { 'unknown' }
it 'raises an error' do
expect { subject }.to raise_error(ArgumentError, "'unknown' is not a valid tier")
end
end
end
context 'when environment has already been created' do
before do
create(:environment, project: project, name: 'customer-portal', tier: :staging)
end
it 'does not overwrite the specified deployment tier' do
# This is to be updated when a deployment succeeded i.e. Deployments::UpdateEnvironmentService.
is_expected.to be_staging
end
end
end
context 'when job starts a review app' do
let(:environment_name) { 'review/$CI_COMMIT_REF_NAME' }
let(:expected_environment_name) { "review/#{job.ref}" }
let(:expected_auto_stop_in) { nil }
let(:attributes) do
{
environment: environment_name,
options: { environment: { name: environment_name } }
}
end
it_behaves_like 'returning a correct environment'
end
context 'when job stops a review app' do
let(:environment_name) { 'review/$CI_COMMIT_REF_NAME' }
let(:expected_environment_name) { "review/#{job.ref}" }
let(:expected_auto_stop_in) { nil }
let(:attributes) do
{
environment: environment_name,
options: { environment: { name: environment_name, action: 'stop' } }
}
end
it_behaves_like 'returning a correct environment'
end
context 'when merge_request is provided' do
let(:pipeline) { create(:ci_pipeline, project: project, merge_request: merge_request) }
let(:environment_name) { 'development' }
let(:attributes) { { environment: environment_name, options: { environment: { name: environment_name } } } }
let(:merge_request) { create(:merge_request, source_project: project) }
let(:seed) { described_class.new(job) }
context 'and environment does not exist' do
let(:environment_name) { 'review/$CI_COMMIT_REF_NAME' }
it 'creates an environment associated with the merge request' do
expect { subject }.to change { Environment.count }.by(1)
expect(subject.merge_request).to eq(merge_request)
end
end
context 'and environment already exists' do
before do
create(:environment, project: project, name: environment_name)
end
it 'does not change the merge request associated with the environment' do
expect { subject }.not_to change { Environment.count }
expect(subject.merge_request).to be_nil
end
end
end
context 'when a pipeline contains a deployment job' do
let(:pipeline) { create(:ci_pipeline, project: project, merge_request: merge_request) }
let!(:job) { build(factory_type, :start_review_app, project: project, pipeline: pipeline) }
context 'and the environment does not exist' do
it 'creates the environment specified by the job' do
expect { subject }.to change { Environment.count }.by(1)
expect(environment).to be_present
expect(job.persisted_environment.name).to eq('review/master')
expect(job.metadata.expanded_environment_name).to eq('review/master')
end
context 'and the pipeline is for a merge request' do
let(:merge_request) { create(:merge_request, source_project: project) }
it 'associates the environment with the merge request' do
expect { subject }.to change { Environment.count }.by(1)
expect(environment.merge_request).to eq(merge_request)
end
end
end
context 'when an environment already exists' do
before do
create(:environment, project: project, name: 'review/master')
end
it 'ensures environment existence for the job' do
expect { subject }.not_to change { Environment.count }
expect(environment).to be_present
expect(job.persisted_environment.name).to eq('review/master')
expect(job.metadata.expanded_environment_name).to eq('review/master')
end
context 'and the pipeline is for a merge request' do
let(:merge_request) { create(:merge_request, source_project: project) }
it 'does not associate the environment with the merge request' do
expect { subject }.not_to change { Environment.count }
expect(environment.merge_request).to be_nil
end
end
end
context 'when an environment name contains an invalid character' do
before do
job.pipeline = build(:ci_pipeline, ref: '!!!', project: project)
end
it 'sets the failure status' do
expect { subject }.not_to change { Environment.count }
expect(job).to be_failed
expect(job).to be_environment_creation_failure
expect(job.persisted_environment).to be_nil
end
end
end
context 'when a pipeline contains a teardown job' do
let!(:job) { build(factory_type, :stop_review_app, project: project) }
it 'ensures environment existence for the job' do
expect { subject }.to change { Environment.count }.by(1)
expect(environment).to be_present
expect(job.persisted_environment.name).to eq('review/master')
expect(job.metadata.expanded_environment_name).to eq('review/master')
end
end
context 'when a pipeline does not contain a deployment job' do
let!(:job) { build(factory_type, project: project) }
it 'does not create any environments' do
expect { subject }.not_to change { Environment.count }
end
end
def environment
project.environments.find_by_name('review/master')
end
end
end
|