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
|
# frozen_string_literal: true
require 'spec_helper'
describe Gitlab::Prometheus::AdditionalMetricsParser do
include Prometheus::MetricBuilders
let(:parser_error_class) { Gitlab::Prometheus::ParsingError }
describe '#load_groups_from_yaml' do
subject { described_class.load_groups_from_yaml('dummy.yaml') }
describe 'parsing sample yaml' do
let(:sample_yaml) do
<<-EOF.strip_heredoc
- group: group_a
priority: 1
metrics:
- title: "title"
required_metrics: [ metric_a, metric_b ]
weight: 1
queries: [{ query_range: 'query_range_a', label: label, unit: unit }]
- title: "title"
required_metrics: [metric_a]
weight: 1
queries: [{ query_range: 'query_range_empty' }]
- group: group_b
priority: 1
metrics:
- title: title
required_metrics: ['metric_a']
weight: 1
queries: [{query_range: query_range_a}]
EOF
end
before do
allow(described_class).to receive(:load_yaml_file) { YAML.load(sample_yaml) }
end
it 'parses to two metric groups with 2 and 1 metric respectively' do
expect(subject.count).to eq(2)
expect(subject[0].metrics.count).to eq(2)
expect(subject[1].metrics.count).to eq(1)
end
it 'provide group data' do
expect(subject[0]).to have_attributes(name: 'group_a', priority: 1)
expect(subject[1]).to have_attributes(name: 'group_b', priority: 1)
end
it 'provides metrics data' do
metrics = subject.flat_map(&:metrics)
expect(metrics.count).to eq(3)
expect(metrics[0]).to have_attributes(title: 'title', required_metrics: %w(metric_a metric_b), weight: 1)
expect(metrics[1]).to have_attributes(title: 'title', required_metrics: %w(metric_a), weight: 1)
expect(metrics[2]).to have_attributes(title: 'title', required_metrics: %w{metric_a}, weight: 1)
end
it 'provides query data' do
queries = subject.flat_map(&:metrics).flat_map(&:queries)
expect(queries.count).to eq(3)
expect(queries[0]).to eq(query_range: 'query_range_a', label: 'label', unit: 'unit')
expect(queries[1]).to eq(query_range: 'query_range_empty')
expect(queries[2]).to eq(query_range: 'query_range_a')
end
end
shared_examples 'required field' do |field_name|
context "when #{field_name} is nil" do
before do
allow(described_class).to receive(:load_yaml_file) { YAML.load(field_missing) }
end
it 'throws parsing error' do
expect { subject }.to raise_error(parser_error_class, /#{field_name} can't be blank/i)
end
end
context "when #{field_name} are not specified" do
before do
allow(described_class).to receive(:load_yaml_file) { YAML.load(field_nil) }
end
it 'throws parsing error' do
expect { subject }.to raise_error(parser_error_class, /#{field_name} can't be blank/i)
end
end
end
describe 'group required fields' do
it_behaves_like 'required field', 'metrics' do
let(:field_nil) do
<<-EOF.strip_heredoc
- group: group_a
priority: 1
metrics:
EOF
end
let(:field_missing) do
<<-EOF.strip_heredoc
- group: group_a
priority: 1
EOF
end
end
it_behaves_like 'required field', 'name' do
let(:field_nil) do
<<-EOF.strip_heredoc
- group:
priority: 1
metrics: []
EOF
end
let(:field_missing) do
<<-EOF.strip_heredoc
- priority: 1
metrics: []
EOF
end
end
it_behaves_like 'required field', 'priority' do
let(:field_nil) do
<<-EOF.strip_heredoc
- group: group_a
priority:
metrics: []
EOF
end
let(:field_missing) do
<<-EOF.strip_heredoc
- group: group_a
metrics: []
EOF
end
end
end
describe 'metrics fields parsing' do
it_behaves_like 'required field', 'title' do
let(:field_nil) do
<<-EOF.strip_heredoc
- group: group_a
priority: 1
metrics:
- title:
required_metrics: []
weight: 1
queries: []
EOF
end
let(:field_missing) do
<<-EOF.strip_heredoc
- group: group_a
priority: 1
metrics:
- required_metrics: []
weight: 1
queries: []
EOF
end
end
it_behaves_like 'required field', 'required metrics' do
let(:field_nil) do
<<-EOF.strip_heredoc
- group: group_a
priority: 1
metrics:
- title: title
required_metrics:
weight: 1
queries: []
EOF
end
let(:field_missing) do
<<-EOF.strip_heredoc
- group: group_a
priority: 1
metrics:
- title: title
weight: 1
queries: []
EOF
end
end
it_behaves_like 'required field', 'weight' do
let(:field_nil) do
<<-EOF.strip_heredoc
- group: group_a
priority: 1
metrics:
- title: title
required_metrics: []
weight:
queries: []
EOF
end
let(:field_missing) do
<<-EOF.strip_heredoc
- group: group_a
priority: 1
metrics:
- title: title
required_metrics: []
queries: []
EOF
end
end
it_behaves_like 'required field', :queries do
let(:field_nil) do
<<-EOF.strip_heredoc
- group: group_a
priority: 1
metrics:
- title: title
required_metrics: []
weight: 1
queries:
EOF
end
let(:field_missing) do
<<-EOF.strip_heredoc
- group: group_a
priority: 1
metrics:
- title: title
required_metrics: []
weight: 1
EOF
end
end
end
end
end
|