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
|
# -*- coding: utf-8 -*-
# pylint: disable=too-many-arguments
from __future__ import absolute_import
import json
import threading
import sys
import time
import cherrypy
from cherrypy._cptools import HandlerWrapperTool
from cherrypy.test import helper
from pyfakefs import fake_filesystem
from mgr_module import CLICommand, MgrModule
from .. import logger, mgr
from ..controllers import json_error_page, generate_controller_routes
from ..services.auth import AuthManagerTool
from ..services.exception import dashboard_exception_handler
from ..plugins import PLUGIN_MANAGER
from ..plugins import feature_toggles, debug # noqa # pylint: disable=unused-import
PLUGIN_MANAGER.hook.init()
PLUGIN_MANAGER.hook.register_commands()
class CmdException(Exception):
def __init__(self, retcode, message):
super(CmdException, self).__init__(message)
self.retcode = retcode
def exec_dashboard_cmd(command_handler, cmd, **kwargs):
inbuf = kwargs['inbuf'] if 'inbuf' in kwargs else None
cmd_dict = {'prefix': 'dashboard {}'.format(cmd)}
cmd_dict.update(kwargs)
if cmd_dict['prefix'] not in CLICommand.COMMANDS:
ret, out, err = command_handler(cmd_dict)
if ret < 0:
raise CmdException(ret, err)
try:
return json.loads(out)
except ValueError:
return out
ret, out, err = CLICommand.COMMANDS[cmd_dict['prefix']].call(mgr, cmd_dict, inbuf)
if ret < 0:
raise CmdException(ret, err)
try:
return json.loads(out)
except ValueError:
return out
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)
class CLICommandTestMixin(KVStoreMockMixin):
@classmethod
def exec_cmd(cls, cmd, **kwargs):
return exec_dashboard_cmd(None, cmd, **kwargs)
class FakeFsMixin(object):
fs = fake_filesystem.FakeFilesystem()
f_open = fake_filesystem.FakeFileOpen(fs)
f_os = fake_filesystem.FakeOsModule(fs)
if sys.version_info > (3, 0):
builtins_open = 'builtins.open'
else:
builtins_open = '__builtin__.open'
class ControllerTestCase(helper.CPWebCase):
_endpoints_cache = {}
@classmethod
def setup_controllers(cls, ctrl_classes, base_url=''):
if not isinstance(ctrl_classes, list):
ctrl_classes = [ctrl_classes]
mapper = cherrypy.dispatch.RoutesDispatcher()
endpoint_list = []
for ctrl in ctrl_classes:
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}})
def __init__(self, *args, **kwargs):
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)
super(ControllerTestCase, self).__init__(*args, **kwargs)
def _request(self, url, method, data=None, headers=None):
if not data:
b = None
h = None
else:
b = json.dumps(data)
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):
self._request(url, 'GET', headers=headers)
def _post(self, url, data=None):
self._request(url, 'POST', data)
def _delete(self, url, data=None):
self._request(url, 'DELETE', data)
def _put(self, url, data=None):
self._request(url, 'PUT', data)
def _task_request(self, method, url, data, timeout):
self._request(url, method, data)
if self.status != '202 Accepted':
logger.info("task finished immediately")
return
res = self.jsonBody()
self.assertIsInstance(res, dict)
self.assertIn('name', res)
self.assertIn('metadata', res)
task_name = res['name']
task_metadata = res['metadata']
# pylint: disable=protected-access
class Waiter(threading.Thread):
def __init__(self, task_name, task_metadata, tc):
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
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))
res = self.tc.jsonBody()
for task in res['finished_tasks']:
if task['metadata'] == self.task_metadata:
# task finished
running = False
self.res_task = task
self.ev.set()
thread = Waiter(task_name, task_metadata, self)
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'])
if method == 'POST':
self.status = '201 Created'
elif method == 'PUT':
self.status = '200 OK'
elif method == 'DELETE':
self.status = '204 No Content'
return
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'])
return
def _task_post(self, url, data=None, timeout=60):
self._task_request('POST', url, data, timeout)
def _task_delete(self, url, timeout=60):
self._task_request('DELETE', url, None, timeout)
def _task_put(self, url, data=None, timeout=60):
self._task_request('PUT', url, data, timeout)
def jsonBody(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):
"""Fail if value != self.body."""
json_body = self.jsonBody()
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):
json_body = self.jsonBody()
if data not in json_body:
if msg is None:
msg = 'expected %r to be in %r' % (data, json_body)
self._handlewebError(msg)
|
