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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Projects::Prometheus::AlertsController do
let_it_be(:user) { create(:user) }
let_it_be(:project) { create(:project) }
let_it_be(:environment) { create(:environment, project: project) }
let_it_be(:metric) { create(:prometheus_metric, project: project) }
before do
project.add_maintainer(user)
sign_in(user)
end
shared_examples 'unprivileged' do
before do
project.add_developer(user)
end
it 'returns not_found' do
make_request
expect(response).to have_gitlab_http_status(:not_found)
end
end
shared_examples 'project non-specific environment' do |status|
let(:other) { create(:environment) }
it "returns #{status}" do
make_request(environment_id: other)
expect(response).to have_gitlab_http_status(status)
end
if status == :ok
it 'returns no prometheus alerts' do
make_request(environment_id: other)
expect(json_response).to be_empty
end
end
end
shared_examples 'project non-specific metric' do |status|
let(:other) { create(:prometheus_alert) }
it "returns #{status}" do
make_request(id: other.prometheus_metric_id)
expect(response).to have_gitlab_http_status(status)
end
end
describe 'GET #index' do
def make_request(opts = {})
get :index, params: request_params(opts, environment_id: environment)
end
context 'when project has no prometheus alert' do
it 'returns an empty response' do
make_request
expect(response).to have_gitlab_http_status(:ok)
expect(json_response).to be_empty
end
end
context 'when project has prometheus alerts' do
let(:production) { create(:environment, project: project) }
let(:staging) { create(:environment, project: project) }
let(:json_alert_ids) { json_response.map { |alert| alert['id'] } }
let!(:production_alerts) do
create_list(:prometheus_alert, 2, project: project, environment: production)
end
let!(:staging_alerts) do
create_list(:prometheus_alert, 1, project: project, environment: staging)
end
it 'contains prometheus alerts only for the production environment' do
make_request(environment_id: production)
expect(response).to have_gitlab_http_status(:ok)
expect(json_response.count).to eq(2)
expect(json_alert_ids).to eq(production_alerts.map(&:id))
end
it 'contains prometheus alerts only for the staging environment' do
make_request(environment_id: staging)
expect(response).to have_gitlab_http_status(:ok)
expect(json_response.count).to eq(1)
expect(json_alert_ids).to eq(staging_alerts.map(&:id))
end
it 'does not return prometheus alerts without environment' do
make_request(environment_id: nil)
expect(response).to have_gitlab_http_status(:ok)
expect(json_response).to be_empty
end
end
it_behaves_like 'unprivileged'
it_behaves_like 'project non-specific environment', :ok
end
describe 'GET #show' do
let(:alert) do
create(:prometheus_alert,
:with_runbook_url,
project: project,
environment: environment,
prometheus_metric: metric)
end
def make_request(opts = {})
get :show, params: request_params(
opts,
id: alert.prometheus_metric_id,
environment_id: environment
)
end
context 'when alert does not exist' do
it 'returns not_found' do
make_request(id: 0)
expect(response).to have_gitlab_http_status(:not_found)
end
end
context 'when alert exists' do
let(:alert_params) do
{
'id' => alert.id,
'title' => alert.title,
'query' => alert.query,
'operator' => alert.computed_operator,
'threshold' => alert.threshold,
'runbook_url' => alert.runbook_url,
'alert_path' => alert_path(alert)
}
end
it 'renders the alert' do
make_request
expect(response).to have_gitlab_http_status(:ok)
expect(json_response).to include(alert_params)
end
it_behaves_like 'unprivileged'
it_behaves_like 'project non-specific environment', :not_found
it_behaves_like 'project non-specific metric', :not_found
end
end
describe 'POST #notify' do
let(:alert_1) { build(:alert_management_alert, :prometheus, project: project) }
let(:alert_2) { build(:alert_management_alert, :prometheus, project: project) }
let(:service_response) { ServiceResponse.success(payload: { alerts: [alert_1, alert_2] }) }
let(:notify_service) { instance_double(Projects::Prometheus::Alerts::NotifyService, execute: service_response) }
before do
sign_out(user)
expect(Projects::Prometheus::Alerts::NotifyService)
.to receive(:new)
.with(project, duck_type(:permitted?))
.and_return(notify_service)
end
it 'returns ok if notification succeeds' do
expect(notify_service).to receive(:execute).and_return(service_response)
post :notify, params: project_params, session: { as: :json }
expect(json_response).to contain_exactly(
{ 'iid' => alert_1.iid, 'title' => alert_1.title },
{ 'iid' => alert_2.iid, 'title' => alert_2.title }
)
expect(response).to have_gitlab_http_status(:ok)
end
it 'returns unprocessable entity if notification fails' do
expect(notify_service).to receive(:execute).and_return(
ServiceResponse.error(message: 'Unprocessable Entity', http_status: :unprocessable_entity)
)
post :notify, params: project_params, session: { as: :json }
expect(response).to have_gitlab_http_status(:unprocessable_entity)
end
context 'bearer token' do
context 'when set' do
it 'extracts bearer token' do
request.headers['HTTP_AUTHORIZATION'] = 'Bearer some token'
expect(notify_service).to receive(:execute).with('some token')
post :notify, params: project_params, as: :json
end
it 'pass nil if cannot extract a non-bearer token' do
request.headers['HTTP_AUTHORIZATION'] = 'some token'
expect(notify_service).to receive(:execute).with(nil)
post :notify, params: project_params, as: :json
end
end
context 'when missing' do
it 'passes nil' do
expect(notify_service).to receive(:execute).with(nil)
post :notify, params: project_params, as: :json
end
end
end
end
describe 'GET #metrics_dashboard' do
let!(:alert) do
create(:prometheus_alert,
project: project,
environment: environment,
prometheus_metric: metric)
end
it 'returns a json object with the correct keys' do
get :metrics_dashboard, params: request_params(id: metric.id, environment_id: alert.environment.id), format: :json
expect(response).to have_gitlab_http_status(:ok)
expect(json_response.keys).to contain_exactly('dashboard', 'status', 'metrics_data')
end
it 'is the correct embed' do
get :metrics_dashboard, params: request_params(id: metric.id, environment_id: alert.environment.id), format: :json
title = json_response['dashboard']['panel_groups'][0]['panels'][0]['title']
expect(title).to eq(metric.title)
end
it 'finds the first alert embed without environment_id' do
get :metrics_dashboard, params: request_params(id: metric.id), format: :json
title = json_response['dashboard']['panel_groups'][0]['panels'][0]['title']
expect(title).to eq(metric.title)
end
it 'returns 404 for non-existant alerts' do
get :metrics_dashboard, params: request_params(id: 0), format: :json
expect(response).to have_gitlab_http_status(:not_found)
end
end
def project_params(opts = {})
opts.reverse_merge(namespace_id: project.namespace, project_id: project)
end
def request_params(opts = {}, defaults = {})
project_params(opts.reverse_merge(defaults))
end
def alert_path(alert)
project_prometheus_alert_path(
project,
alert.prometheus_metric_id,
environment_id: alert.environment,
format: :json
)
end
end
|