-
Notifications
You must be signed in to change notification settings - Fork 4.9k
/
test_dashboard.py
384 lines (312 loc) · 15.1 KB
/
test_dashboard.py
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
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
from base import BaseTest
import os
import os.path
import subprocess
from nose.plugins.attrib import attr
import unittest
from unittest import SkipTest
import requests
import semver
INTEGRATION_TESTS = os.environ.get('INTEGRATION_TESTS', False)
class Test(BaseTest):
@unittest.skipUnless(INTEGRATION_TESTS, "integration test")
@attr('integration')
def test_load_without_dashboard(self):
"""
Test loading without dashboards
"""
self.render_config_template()
beat = self.start_beat(
logging_args=["-e", "-d", "*"],
extra_args=["setup",
"--dashboards",
"-E", "setup.dashboards.file=" +
os.path.join(self.beat_path, "tests", "files", "testbeat-no-dashboards.zip"),
"-E", "setup.dashboards.beat=testbeat",
"-E", "setup.kibana.protocol=http",
"-E", "setup.kibana.host=" + self.get_kibana_host(),
"-E", "setup.kibana.port=" + self.get_kibana_port(),
"-E", "output.elasticsearch.hosts=['" + self.get_host() + "']",
"-E", "output.file.enabled=false"]
)
beat.check_wait(exit_code=0)
assert self.log_contains("Skipping loading dashboards")
@unittest.skipUnless(INTEGRATION_TESTS, "integration test")
@attr('integration')
def test_load_dashboard(self):
"""
Test loading dashboards
"""
self.render_config_template()
beat = self.start_beat(
logging_args=["-e", "-d", "*"],
extra_args=["setup",
"--dashboards",
"-E", "setup.dashboards.file=" +
os.path.join(self.beat_path, "tests", "files", "testbeat-dashboards.zip"),
"-E", "setup.dashboards.beat=testbeat",
"-E", "setup.kibana.protocol=http",
"-E", "setup.kibana.host=" + self.get_kibana_host(),
"-E", "setup.kibana.port=" + self.get_kibana_port(),
"-E", "output.elasticsearch.hosts=['" + self.get_host() + "']",
"-E", "output.file.enabled=false"]
)
beat.check_wait(exit_code=0)
assert self.log_contains("Kibana dashboards successfully loaded") is True
@unittest.skipUnless(INTEGRATION_TESTS, "integration test")
@attr('integration')
def test_load_dashboard_into_space(self, create_space=True):
"""
Test loading dashboards into Kibana space
"""
version = self.get_version()
if semver.compare(version, "6.5.0") == -1:
# Skip for Kibana versions < 6.5.0 as Kibana Spaces not available
raise SkipTest
self.render_config_template()
if create_space:
self.create_kibana_space()
beat = self.start_beat(
logging_args=["-e", "-d", "*"],
extra_args=["setup",
"--dashboards",
"-E", "setup.dashboards.file=" +
os.path.join(self.beat_path, "tests", "files", "testbeat-dashboards.zip"),
"-E", "setup.dashboards.beat=testbeat",
"-E", "setup.kibana.protocol=http",
"-E", "setup.kibana.host=" + self.get_kibana_host(),
"-E", "setup.kibana.port=" + self.get_kibana_port(),
"-E", "setup.kibana.space.id=foo-bar",
"-E", "output.elasticsearch.hosts=['" + self.get_host() + "']",
"-E", "output.file.enabled=false"]
)
beat.check_wait(exit_code=0)
assert self.log_contains("Kibana dashboards successfully loaded") is True
@unittest.skipUnless(INTEGRATION_TESTS, "integration test")
@attr('integration')
def test_load_only_index_patterns(self):
"""
Test loading dashboards
"""
self.render_config_template()
beat = self.start_beat(
logging_args=["-e", "-d", "*"],
extra_args=["setup",
"--dashboards",
"-E", "setup.dashboards.file=" +
os.path.join(self.beat_path, "tests", "files", "testbeat-dashboards.zip"),
"-E", "setup.dashboards.beat=testbeat",
"-E", "setup.dashboards.only_index=true",
"-E", "setup.kibana.protocol=http",
"-E", "setup.kibana.host=" + self.get_kibana_host(),
"-E", "setup.kibana.port=" + self.get_kibana_port(),
"-E", "output.elasticsearch.hosts=['" + self.get_host() + "']",
"-E", "output.file.enabled=false"]
)
beat.check_wait(exit_code=0)
assert self.log_contains("Kibana dashboards successfully loaded") is True
@unittest.skipUnless(INTEGRATION_TESTS, "integration test")
@attr('integration')
def test_export_dashboard_cmd_export_dashboard_by_id_and_decoding(self):
"""
Test testbeat export dashboard can export dashboards
and removes unsupported characters
"""
self.render_config_template()
self.test_load_dashboard()
beat = self.start_beat(
logging_args=["-e", "-d", "*"],
extra_args=["export",
"dashboard",
"-E", "setup.kibana.protocol=http",
"-E", "setup.kibana.host=" + self.get_kibana_host(),
"-E", "setup.kibana.port=" + self.get_kibana_port(),
"-decode",
"-id", "Metricbeat-system-overview"]
)
beat.check_wait(exit_code=0)
assert self.log_contains("\"id\": \"Metricbeat-system-overview\",") is True
@unittest.skipUnless(INTEGRATION_TESTS, "integration test")
@attr('integration')
def test_export_dashboard_cmd_export_dashboard_by_id(self):
"""
Test testbeat export dashboard can export dashboards
"""
self.render_config_template()
self.test_load_dashboard()
beat = self.start_beat(
logging_args=["-e", "-d", "*"],
extra_args=["export",
"dashboard",
"-E", "setup.kibana.protocol=http",
"-E", "setup.kibana.host=" + self.get_kibana_host(),
"-E", "setup.kibana.port=" + self.get_kibana_port(),
"-id", "Metricbeat-system-overview"]
)
beat.check_wait(exit_code=0)
assert self.log_contains("\"id\": \"Metricbeat-system-overview\",") is True
@unittest.skipUnless(INTEGRATION_TESTS, "integration test")
@attr('integration')
def test_export_dashboard_cmd_export_dashboard_by_id_unknown_id(self):
"""
Test testbeat export dashboard fails gracefully when dashboard with unknown ID is requested
"""
self.render_config_template()
beat = self.start_beat(
logging_args=["-e", "-d", "*"],
extra_args=["export",
"dashboard",
"-E", "setup.kibana.protocol=http",
"-E", "setup.kibana.host=" + self.get_kibana_host(),
"-E", "setup.kibana.port=" + self.get_kibana_port(),
"-id", "No-such-dashboard"]
)
beat.check_wait(exit_code=1)
assert self.log_contains("error exporting dashboard: Not found") is True
@unittest.skipUnless(INTEGRATION_TESTS, "integration test")
@attr('integration')
def test_export_dashboard_cmd_export_dashboard_from_yml(self):
"""
Test testbeat export dashboard can export dashboards from dashboards YAML file
and removes unsupported characters
"""
self.render_config_template()
self.test_load_dashboard()
beat = self.start_beat(
logging_args=["-e", "-d", "*"],
extra_args=["export",
"dashboard",
"-E", "setup.kibana.protocol=http",
"-E", "setup.kibana.host=" + self.get_kibana_host(),
"-E", "setup.kibana.port=" + self.get_kibana_port(),
"-yml", os.path.join(self.beat_path, "tests", "files", "dashboards.yml")]
)
beat.check_wait(exit_code=0)
version = self.get_version()
kibana_semver = semver.VersionInfo.parse(version)
exported_dashboard_path = os.path.join(self.beat_path, "tests", "files", "_meta",
"kibana", str(kibana_semver.major), "dashboard", "Metricbeat-system-test-overview.json")
with open(exported_dashboard_path) as f:
content = f.read()
assert "Metricbeat-system-overview" in content
os.remove(exported_dashboard_path)
@unittest.skipUnless(INTEGRATION_TESTS, "integration test")
@attr('integration')
def test_export_dashboard_cmd_export_dashboard_from_not_existent_yml(self):
"""
Test testbeat export dashboard fails gracefully when cannot find YAML file
"""
self.render_config_template()
beat = self.start_beat(
logging_args=["-e", "-d", "*"],
extra_args=["export",
"dashboard",
"-E", "setup.kibana.protocol=http",
"-E", "setup.kibana.host=" + self.get_kibana_host(),
"-E", "setup.kibana.port=" + self.get_kibana_port(),
"-yml", os.path.join(self.beat_path, "tests", "files", "no-such-file.yml")]
)
beat.check_wait(exit_code=1)
assert self.log_contains("Error exporting dashboards from yml")
assert self.log_contains("error opening the list of dashboards")
@unittest.skipUnless(INTEGRATION_TESTS, "integration test")
@attr('integration')
def test_dev_tool_export_dashboard_by_id(self):
"""
Test dev-tools/cmd/dashboards exports dashboard and removes unsupported characters
"""
self.test_load_dashboard()
path = os.path.normpath(self.beat_path + "/../dev-tools/cmd/dashboards/export_dashboards.go")
command = path + " -kibana http://" + self.get_kibana_host() + ":" + self.get_kibana_port()
command = "go run " + command + " -dashboard Metricbeat-system-overview"
p = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
content, err = p.communicate()
assert p.returncode == 0
assert os.path.isfile("output.json") is True
with open('output.json') as f:
content = f.read()
assert "Metricbeat-system-overview" in content
os.remove("output.json")
@unittest.skipUnless(INTEGRATION_TESTS, "integration test")
@attr('integration')
def test_dev_tool_export_dashboard_by_id_unknown_id(self):
"""
Test dev-tools/cmd/dashboards fails gracefully when dashboard with unknown ID is requested
"""
path = os.path.normpath(self.beat_path + "/../dev-tools/cmd/dashboards/export_dashboards.go")
command = path + " -kibana http://" + self.get_kibana_host() + ":" + self.get_kibana_port()
command = "go run " + command + " -dashboard No-such-dashboard"
p = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
content, err = p.communicate()
assert p.returncode != 0
@unittest.skipUnless(INTEGRATION_TESTS, "integration test")
@attr('integration')
def test_dev_tool_export_dashboard_by_id_from_space(self):
"""
Test dev-tools/cmd/dashboards exports dashboard from Kibana space
and removes unsupported characters
"""
version = self.get_version()
if semver.compare(version, "6.5.0") == -1:
# Skip for Kibana versions < 6.5.0 as Kibana Spaces not available
raise SkipTest
self.test_load_dashboard_into_space(False)
path = os.path.normpath(self.beat_path + "/../dev-tools/cmd/dashboards/export_dashboards.go")
command = path + " -kibana http://" + self.get_kibana_host() + ":" + self.get_kibana_port()
command = "go run " + command + " -dashboard Metricbeat-system-overview -space-id foo-bar"
p = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
content, err = p.communicate()
assert p.returncode == 0
assert os.path.isfile("output.json") is True
with open('output.json') as f:
content = f.read()
assert "Metricbeat-system-overview" in content
os.remove("output.json")
@unittest.skipUnless(INTEGRATION_TESTS, "integration test")
@attr('integration')
def test_dev_tool_export_dashboard_from_yml(self):
"""
Test dev-tools/cmd/dashboards exports dashboard from dashboards YAML file
and removes unsupported characters
"""
self.test_load_dashboard()
path = os.path.normpath(self.beat_path + "/../dev-tools/cmd/dashboards/export_dashboards.go")
command = path + " -kibana http://" + self.get_kibana_host() + ":" + self.get_kibana_port()
command = "go run " + command + " -yml " + os.path.join(self.beat_path, "tests", "files", "dashboards.yml")
p = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
content, err = p.communicate()
assert p.returncode == 0
version = self.get_version()
kibana_semver = semver.VersionInfo.parse(version)
exported_dashboard_path = os.path.join(self.beat_path, "tests", "files", "_meta",
"kibana", str(kibana_semver.major), "dashboard", "Metricbeat-system-test-overview.json")
with open(exported_dashboard_path) as f:
content = f.read()
assert "Metricbeat-system-overview" in content
os.remove(exported_dashboard_path)
def get_host(self):
return os.getenv('ES_HOST', 'localhost') + ':' + os.getenv('ES_PORT', '9200')
def get_kibana_host(self):
return os.getenv('KIBANA_HOST', 'localhost')
def get_kibana_port(self):
return os.getenv('KIBANA_PORT', '5601')
def create_kibana_space(self):
url = "http://" + self.get_kibana_host() + ":" + self.get_kibana_port() + \
"/api/spaces/space"
data = {
"id": "libbeat-system-tests",
"name": "Libbeat System Tests"
}
headers = {
"kbn-xsrf": "1"
}
r = requests.post(url, json=data, headers=headers)
if r.status_code != 200 and r.status_code != 409:
self.fail('Bad Kibana status code when creating space: {}'.format(r.status_code))
def get_version(self):
url = "http://" + self.get_kibana_host() + ":" + self.get_kibana_port() + \
"/api/status"
r = requests.get(url)
body = r.json()
version = body["version"]["number"]
return version