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
385
386
387
388
389
390
391
|
# -*- coding: utf-8 -*-
# pylint: disable=too-many-arguments
import contextlib
import json
import logging
import threading
import time
from typing import Any, Dict, List, Optional
from unittest import mock
from unittest.mock import Mock
import cherrypy
from cherrypy._cptools import HandlerWrapperTool
from cherrypy.test import helper
from mgr_module import HandleCommandResult
from orchestrator import DaemonDescription, HostSpec, InventoryHost
from pyfakefs import fake_filesystem
from .. import mgr
from ..controllers import generate_controller_routes, json_error_page
from ..controllers._version import APIVersion
from ..module import Module
from ..plugins import PLUGIN_MANAGER, debug, feature_toggles # noqa
from ..services.auth import AuthManagerTool
from ..services.exception import dashboard_exception_handler
from ..tools import RequestLoggingTool
PLUGIN_MANAGER.hook.init()
PLUGIN_MANAGER.hook.register_commands()
logger = logging.getLogger('tests')
class ModuleTestClass(Module):
"""Dashboard module subclass for testing the module methods."""
def __init__(self) -> None:
pass
def _unconfigure_logging(self) -> None:
pass
class CmdException(Exception):
def __init__(self, retcode, message):
super(CmdException, self).__init__(message)
self.retcode = retcode
class KVStoreMockMixin(object):
CONFIG_KEY_DICT = {}
@classmethod
def mock_set_module_option(cls, attr, val):
cls.CONFIG_KEY_DICT[attr] = val
@classmethod
def mock_get_module_option(cls, attr, default=None):
return cls.CONFIG_KEY_DICT.get(attr, default)
@classmethod
def mock_kv_store(cls):
cls.CONFIG_KEY_DICT.clear()
mgr.set_module_option.side_effect = cls.mock_set_module_option
mgr.get_module_option.side_effect = cls.mock_get_module_option
# kludge below
mgr.set_store.side_effect = cls.mock_set_module_option
mgr.get_store.side_effect = cls.mock_get_module_option
@classmethod
def get_key(cls, key):
return cls.CONFIG_KEY_DICT.get(key, None)
# pylint: disable=protected-access
class CLICommandTestMixin(KVStoreMockMixin):
_dashboard_module = ModuleTestClass()
@classmethod
def exec_cmd(cls, cmd, **kwargs):
inbuf = kwargs['inbuf'] if 'inbuf' in kwargs else None
cmd_dict = {'prefix': 'dashboard {}'.format(cmd)}
cmd_dict.update(kwargs)
result = HandleCommandResult(*cls._dashboard_module._handle_command(inbuf, cmd_dict))
if result.retval < 0:
raise CmdException(result.retval, result.stderr)
try:
return json.loads(result.stdout)
except ValueError:
return result.stdout
class FakeFsMixin(object):
fs = fake_filesystem.FakeFilesystem()
f_open = fake_filesystem.FakeFileOpen(fs)
f_os = fake_filesystem.FakeOsModule(fs)
builtins_open = 'builtins.open'
class ControllerTestCase(helper.CPWebCase):
_endpoints_cache = {}
@classmethod
def setup_controllers(cls, ctrl_classes, base_url='', cp_config: Dict[str, Any] = None):
if not isinstance(ctrl_classes, list):
ctrl_classes = [ctrl_classes]
mapper = cherrypy.dispatch.RoutesDispatcher()
endpoint_list = []
for ctrl in ctrl_classes:
ctrl._cp_config = {
'tools.dashboard_exception_handler.on': True,
'tools.authenticate.on': False
}
if cp_config:
ctrl._cp_config.update(cp_config)
inst = ctrl()
# We need to cache the controller endpoints because
# BaseController#endpoints method is not idempontent
# and a controller might be needed by more than one
# unit test.
if ctrl not in cls._endpoints_cache:
ctrl_endpoints = ctrl.endpoints()
cls._endpoints_cache[ctrl] = ctrl_endpoints
ctrl_endpoints = cls._endpoints_cache[ctrl]
for endpoint in ctrl_endpoints:
endpoint.inst = inst
endpoint_list.append(endpoint)
endpoint_list = sorted(endpoint_list, key=lambda e: e.url)
for endpoint in endpoint_list:
generate_controller_routes(endpoint, mapper, base_url)
if base_url == '':
base_url = '/'
cherrypy.tree.mount(None, config={
base_url: {'request.dispatch': mapper}})
@classmethod
def setup_crud_controllers(cls, crud_ctrl_classes, base_url='',
cp_config: Dict[str, Any] = None):
if crud_ctrl_classes and not isinstance(crud_ctrl_classes, list):
crud_ctrl_classes = [crud_ctrl_classes]
ctrl_classes = []
for ctrl in crud_ctrl_classes:
ctrl_classes.append(ctrl.CRUDClass)
ctrl_classes.append(ctrl.CRUDClassMetadata)
cls.setup_controllers(ctrl_classes, base_url=base_url, cp_config=cp_config)
_request_logging = False
@classmethod
def setUpClass(cls):
super().setUpClass()
cherrypy.tools.authenticate = AuthManagerTool()
cherrypy.tools.dashboard_exception_handler = HandlerWrapperTool(dashboard_exception_handler,
priority=31)
cherrypy.config.update({
'error_page.default': json_error_page,
'tools.json_in.on': True,
'tools.json_in.force': False
})
PLUGIN_MANAGER.hook.configure_cherrypy(config=cherrypy.config)
if cls._request_logging:
cherrypy.tools.request_logging = RequestLoggingTool()
cherrypy.config.update({'tools.request_logging.on': True})
@classmethod
def tearDownClass(cls):
if cls._request_logging:
cherrypy.config.update({'tools.request_logging.on': False})
def _request(self, url, method, data=None, headers=None, version=APIVersion.DEFAULT):
if not data:
b = None
if version:
h = [('Accept', version.to_mime_type()),
('Content-Length', '0')]
else:
h = None
else:
b = json.dumps(data)
if version is not None:
h = [('Accept', version.to_mime_type()),
('Content-Type', 'application/json'),
('Content-Length', str(len(b)))]
else:
h = [('Content-Type', 'application/json'),
('Content-Length', str(len(b)))]
if headers:
h = headers
self.getPage(url, method=method, body=b, headers=h)
def _get(self, url, headers=None, version=APIVersion.DEFAULT):
self._request(url, 'GET', headers=headers, version=version)
def _post(self, url, data=None, version=APIVersion.DEFAULT):
self._request(url, 'POST', data, version=version)
def _delete(self, url, data=None, version=APIVersion.DEFAULT):
self._request(url, 'DELETE', data, version=version)
def _put(self, url, data=None, version=APIVersion.DEFAULT):
self._request(url, 'PUT', data, version=version)
def _task_request(self, method, url, data, timeout, version=APIVersion.DEFAULT):
self._request(url, method, data, version=version)
if self.status != '202 Accepted':
logger.info("task finished immediately")
return
res = self.json_body()
self.assertIsInstance(res, dict)
self.assertIn('name', res)
self.assertIn('metadata', res)
task_name = res['name']
task_metadata = res['metadata']
thread = Waiter(task_name, task_metadata, self, version)
thread.start()
status = thread.ev.wait(timeout)
if not status:
# timeout expired
thread.abort = True
thread.join()
raise Exception("Waiting for task ({}, {}) to finish timed out"
.format(task_name, task_metadata))
logger.info("task (%s, %s) finished", task_name, task_metadata)
if thread.res_task['success']:
self.body = json.dumps(thread.res_task['ret_value'])
self._set_success_status(method)
else:
if 'status' in thread.res_task['exception']:
self.status = thread.res_task['exception']['status']
else:
self.status = 500
self.body = json.dumps(thread.res_task['exception'])
def _set_success_status(self, method):
if method == 'POST':
self.status = '201 Created'
elif method == 'PUT':
self.status = '200 OK'
elif method == 'DELETE':
self.status = '204 No Content'
def _task_post(self, url, data=None, timeout=60, version=APIVersion.DEFAULT):
self._task_request('POST', url, data, timeout, version=version)
def _task_delete(self, url, timeout=60, version=APIVersion.DEFAULT):
self._task_request('DELETE', url, None, timeout, version=version)
def _task_put(self, url, data=None, timeout=60, version=APIVersion.DEFAULT):
self._task_request('PUT', url, data, timeout, version=version)
def json_body(self):
body_str = self.body.decode('utf-8') if isinstance(self.body, bytes) else self.body
return json.loads(body_str)
def assertJsonBody(self, data, msg=None): # noqa: N802
"""Fail if value != self.body."""
json_body = self.json_body()
if data != json_body:
if msg is None:
msg = 'expected body:\n%r\n\nactual body:\n%r' % (
data, json_body)
self._handlewebError(msg)
def assertInJsonBody(self, data, msg=None): # noqa: N802
json_body = self.json_body()
if data not in json_body:
if msg is None:
msg = 'expected %r to be in %r' % (data, json_body)
self._handlewebError(msg)
class Stub:
"""Test class for returning predefined values"""
@classmethod
def get_mgr_no_services(cls):
mgr.get = Mock(return_value={})
class RgwStub(Stub):
@classmethod
def get_daemons(cls):
mgr.get = Mock(return_value={'services': {'rgw': {'daemons': {
'5297': {
'addr': '192.168.178.3:49774/1534999298',
'metadata': {
'frontend_config#0': 'beast port=8000',
'id': 'daemon1',
'realm_name': 'realm1',
'zonegroup_name': 'zonegroup1',
'zone_name': 'zone1',
'hostname': 'daemon1.server.lan'
}
},
'5398': {
'addr': '[2001:db8:85a3::8a2e:370:7334]:49774/1534999298',
'metadata': {
'frontend_config#0': 'civetweb port=8002',
'id': 'daemon2',
'realm_name': 'realm2',
'zonegroup_name': 'zonegroup2',
'zone_name': 'zone2',
'hostname': 'daemon2.server.lan'
}
}
}}}})
@classmethod
def get_settings(cls):
settings = {
'RGW_API_ACCESS_KEY': 'fake-access-key',
'RGW_API_SECRET_KEY': 'fake-secret-key',
}
mgr.get_module_option = Mock(side_effect=settings.get)
# pylint: disable=protected-access
class Waiter(threading.Thread):
def __init__(self, task_name, task_metadata, tc, version):
super(Waiter, self).__init__()
self.task_name = task_name
self.task_metadata = task_metadata
self.ev = threading.Event()
self.abort = False
self.res_task = None
self.tc = tc
self.version = version
def run(self):
running = True
while running and not self.abort:
logger.info("task (%s, %s) is still executing", self.task_name,
self.task_metadata)
time.sleep(1)
self.tc._get('/api/task?name={}'.format(self.task_name), version=self.version)
res = self.tc.json_body()
for task in res['finished_tasks']:
if task['metadata'] == self.task_metadata:
# task finished
running = False
self.res_task = task
self.ev.set()
@contextlib.contextmanager
def patch_orch(available: bool, missing_features: Optional[List[str]] = None,
hosts: Optional[List[HostSpec]] = None,
inventory: Optional[List[dict]] = None,
daemons: Optional[List[DaemonDescription]] = None):
with mock.patch('dashboard.controllers.orchestrator.OrchClient.instance') as instance:
fake_client = mock.Mock()
fake_client.available.return_value = available
fake_client.get_missing_features.return_value = missing_features
if not daemons:
daemons = [
DaemonDescription(
daemon_type='mon',
daemon_id='a',
hostname='node0'
)
]
fake_client.services.list_daemons.return_value = daemons
if hosts is not None:
fake_client.hosts.list.return_value = hosts
if inventory is not None:
def _list_inventory(hosts=None, refresh=False): # pylint: disable=unused-argument
inv_hosts = []
for inv_host in inventory:
if hosts is None or inv_host['name'] in hosts:
inv_hosts.append(InventoryHost.from_json(inv_host))
return inv_hosts
fake_client.inventory.list.side_effect = _list_inventory
instance.return_value = fake_client
yield fake_client
|