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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Gitlab::AlertManagement::Payload::Prometheus do
let_it_be(:project) { create(:project) }
let(:raw_payload) { {} }
let(:parsed_payload) { described_class.new(project: project, payload: raw_payload) }
it_behaves_like 'subclass has expected api'
shared_context 'with environment' do
let_it_be(:environment) { create(:environment, project: project, name: 'production') }
end
describe '#title' do
subject { parsed_payload.title }
it_behaves_like 'parsable alert payload field',
'annotations/title',
'annotations/summary',
'labels/alertname'
end
describe '#description' do
subject { parsed_payload.description }
it_behaves_like 'parsable alert payload field', 'annotations/description'
end
describe '#annotations' do
subject { parsed_payload.annotations }
it_behaves_like 'parsable alert payload field', 'annotations'
end
describe '#status' do
subject { parsed_payload.status }
it_behaves_like 'parsable alert payload field', 'status'
end
describe '#starts_at' do
let(:current_time) { Time.current.utc }
around do |example|
freeze_time { example.run }
end
subject { parsed_payload.starts_at }
context 'without payload' do
it { is_expected.to eq(current_time) }
end
context "with startsAt" do
let(:value) { 10.minutes.ago.change(usec: 0).utc }
let(:raw_payload) { { 'startsAt' => value.rfc3339 } }
it { is_expected.to eq(value) }
end
end
describe '#ends_at' do
subject { parsed_payload.ends_at }
context 'without payload' do
it { is_expected.to be_nil }
end
context "with endsAt" do
let(:value) { Time.current.change(usec: 0).utc }
let(:raw_payload) { { 'endsAt' => value.rfc3339 } }
it { is_expected.to eq(value) }
end
end
describe '#generator_url' do
subject { parsed_payload.generator_url }
it_behaves_like 'parsable alert payload field', 'generatorURL'
end
describe '#runbook' do
subject { parsed_payload.runbook }
it_behaves_like 'parsable alert payload field', 'annotations/runbook'
end
describe '#alert_markdown' do
subject { parsed_payload.alert_markdown }
it_behaves_like 'parsable alert payload field', 'annotations/gitlab_incident_markdown'
end
describe '#environment_name' do
subject { parsed_payload.environment_name }
it_behaves_like 'parsable alert payload field', 'labels/gitlab_environment_name'
end
describe '#gitlab_y_label' do
subject { parsed_payload.gitlab_y_label }
it_behaves_like 'parsable alert payload field',
'annotations/gitlab_y_label',
'annotations/title',
'annotations/summary',
'labels/alertname'
end
describe '#monitoring_tool' do
subject { parsed_payload.monitoring_tool }
it { is_expected.to eq('Prometheus') }
end
describe '#full_query' do
using RSpec::Parameterized::TableSyntax
subject { parsed_payload.full_query }
where(:generator_url, :expected_query) do
nil | nil
'http://localhost' | nil
'invalid url' | nil
'http://localhost:9090/graph?g1.expr=vector%281%29' | nil
'http://localhost:9090/graph?g0.expr=vector%281%29' | 'vector(1)'
end
with_them do
let(:raw_payload) { { 'generatorURL' => generator_url } }
it { is_expected.to eq(expected_query) }
end
end
describe '#environment' do
subject { parsed_payload.environment }
it { is_expected.to be_nil }
context 'with environment_name' do
let(:raw_payload) { { 'labels' => { 'gitlab_environment_name' => 'production' } } }
it { is_expected.to be_nil }
context 'with matching environment' do
include_context 'with environment'
it { is_expected.to eq(environment) }
end
end
end
describe '#gitlab_fingerprint' do
let(:raw_payload) do
{
'startsAt' => Time.current.to_s,
'generatorURL' => 'http://localhost:9090/graph?g0.expr=vector%281%29',
'annotations' => { 'title' => 'title' }
}
end
subject { parsed_payload.gitlab_fingerprint }
it 'returns a fingerprint' do
plain_fingerprint = [
parsed_payload.send(:starts_at_raw),
parsed_payload.title,
parsed_payload.full_query
].join('/')
is_expected.to eq(Digest::SHA1.hexdigest(plain_fingerprint))
end
end
describe '#metrics_dashboard_url' do
include_context 'self-managed prometheus alert attributes' do
let(:raw_payload) { payload }
end
subject { parsed_payload.metrics_dashboard_url }
it { is_expected.to eq(dashboard_url_for_alert) }
context 'without environment' do
let(:raw_payload) { payload.except('labels') }
it { is_expected.to be_nil }
end
context 'without full query' do
let(:raw_payload) { payload.except('generatorURL') }
it { is_expected.to be_nil }
end
context 'without title' do
let(:raw_payload) { payload.except('annotations') }
it { is_expected.to be_nil }
end
end
describe '#has_required_attributes?' do
let(:starts_at) { Time.current.change(usec: 0).utc }
let(:raw_payload) { { 'annotations' => { 'title' => 'title' }, 'startsAt' => starts_at.rfc3339 } }
subject { parsed_payload.has_required_attributes? }
it { is_expected.to be_truthy }
context 'without project' do
let(:parsed_payload) { described_class.new(project: nil, payload: raw_payload) }
it { is_expected.to be_falsey }
end
context 'without title' do
let(:raw_payload) { { 'startsAt' => starts_at.rfc3339 } }
it { is_expected.to be_falsey }
end
context 'without startsAt' do
let(:raw_payload) { { 'annotations' => { 'title' => 'title' } } }
it { is_expected.to be_falsey }
end
context 'without payload' do
let(:parsed_payload) { described_class.new(project: project, payload: nil) }
it { is_expected.to be_falsey }
end
end
describe '#severity' do
subject { parsed_payload.severity }
context 'when set' do
using RSpec::Parameterized::TableSyntax
let(:raw_payload) { { 'labels' => { 'severity' => payload_severity } } }
where(:payload_severity, :expected_severity) do
'critical' | :critical
'high' | :high
'medium' | :medium
'low' | :low
'info' | :info
's1' | :critical
's2' | :high
's3' | :medium
's4' | :low
's5' | :info
'p1' | :critical
'p2' | :high
'p3' | :medium
'p4' | :low
'p5' | :info
'CRITICAL' | :critical
'cRiTiCaL' | :critical
'S1' | :critical
'unmapped' | nil
1 | nil
nil | nil
'debug' | :info
'information' | :info
'notice' | :info
'warn' | :low
'warning' | :low
'minor' | :low
'error' | :medium
'major' | :high
'emergency' | :critical
'fatal' | :critical
'alert' | :medium
'page' | :high
end
with_them do
it { is_expected.to eq(expected_severity) }
end
end
context 'without key' do
it { is_expected.to be_nil }
end
end
end
|