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
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
|
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import json
import os
import sys
import tempfile
import unittest
from unittest import mock
import eventlet
eventlet.monkey_patch() # noqa
from ironic_inspector import introspection_state as istate
from ironic_inspector import process
from ironic_inspector.test import functional
from keystoneauth1 import session as ks_session
from keystoneauth1 import token_endpoint
from oslo_concurrency import processutils
import ironic_inspector_client as client
from ironic_inspector_client import shell
class TestV1PythonAPI(functional.Base):
def setUp(self):
super(TestV1PythonAPI, self).setUp()
self.auth = token_endpoint.Token(endpoint='http://127.0.0.1:5050',
token='token')
self.session = ks_session.Session(self.auth)
self.client = client.ClientV1(session=self.session)
def my_status_index(self, statuses):
my_status = self._fake_status()
return statuses.index(my_status)
def test_introspect_get_status(self):
self.client.introspect(self.uuid)
eventlet.greenthread.sleep(functional.DEFAULT_SLEEP)
self.cli.set_node_power_state.assert_called_once_with(self.uuid,
'rebooting')
status = self.client.get_status(self.uuid)
self.check_status(status, finished=False, state=istate.States.waiting)
res = self.call_continue(self.data)
self.assertEqual({'uuid': self.uuid}, res)
eventlet.greenthread.sleep(functional.DEFAULT_SLEEP)
self.assertCalledWithPatch(self.patch, self.cli.patch_node)
self.cli.create_port.assert_called_once_with(
node_uuid=self.uuid, address='11:22:33:44:55:66',
is_pxe_enabled=True, extra={})
status = self.client.get_status(self.uuid)
self.check_status(status, finished=True, state=istate.States.finished)
def test_introspect_list_statuses(self):
self.client.introspect(self.uuid)
eventlet.greenthread.sleep(functional.DEFAULT_SLEEP)
self.cli.set_node_power_state.assert_called_once_with(self.uuid,
'rebooting')
statuses = self.client.list_statuses()
my_status = statuses[self.my_status_index(statuses)]
self.check_status(my_status, finished=False,
state=istate.States.waiting)
res = self.call_continue(self.data)
self.assertEqual({'uuid': self.uuid}, res)
eventlet.greenthread.sleep(functional.DEFAULT_SLEEP)
self.assertCalledWithPatch(self.patch, self.cli.patch_node)
self.cli.create_port.assert_called_once_with(
node_uuid=self.uuid, address='11:22:33:44:55:66',
is_pxe_enabled=True, extra={})
statuses = self.client.list_statuses()
my_status = statuses[self.my_status_index(statuses)]
self.check_status(my_status, finished=True,
state=istate.States.finished)
def test_wait_for_finish(self):
shared = [0] # mutable structure to hold number of retries
def fake_waiter(delay):
shared[0] += 1
if shared[0] == 2:
# On the second wait simulate data arriving
res = self.call_continue(self.data)
self.assertEqual({'uuid': self.uuid}, res)
elif shared[0] > 2:
# Just wait afterwards
eventlet.greenthread.sleep(delay)
self.client.introspect(self.uuid)
eventlet.greenthread.sleep(functional.DEFAULT_SLEEP)
status = self.client.get_status(self.uuid)
self.check_status(status, finished=False, state=istate.States.waiting)
self.client.wait_for_finish([self.uuid], sleep_function=fake_waiter,
retry_interval=functional.DEFAULT_SLEEP)
status = self.client.get_status(self.uuid)
self.check_status(status, finished=True, state=istate.States.finished)
def test_reprocess_stored_introspection_data(self):
port_create_call = mock.call(node_uuid=self.uuid,
address='11:22:33:44:55:66',
is_pxe_enabled=True, extra={})
# assert reprocessing doesn't work before introspection
self.assertRaises(client.ClientError, self.client.reprocess,
self.uuid)
self.client.introspect(self.uuid)
eventlet.greenthread.sleep(functional.DEFAULT_SLEEP)
self.cli.set_node_power_state.assert_called_once_with(self.uuid,
'rebooting')
status = self.client.get_status(self.uuid)
self.check_status(status, finished=False, state=istate.States.waiting)
res = self.call_continue(self.data)
self.assertEqual({'uuid': self.uuid}, res)
eventlet.greenthread.sleep(functional.DEFAULT_SLEEP)
status = self.client.get_status(self.uuid)
self.check_status(status, finished=True, state=istate.States.finished)
self.cli.create_port.assert_has_calls([port_create_call],
any_order=True)
res = self.client.reprocess(self.uuid)
self.assertEqual(202, res.status_code)
self.assertEqual('{}\n', res.text)
eventlet.greenthread.sleep(functional.DEFAULT_SLEEP)
self.check_status(status, finished=True, state=istate.States.finished)
self.cli.create_port.assert_has_calls([port_create_call,
port_create_call],
any_order=True)
def test_abort_introspection(self):
# assert abort doesn't work before introspect request
# TODO(iurygregory): We need to figure out why we can't
# use self.uuid, my current assumption is that previous
# tests executed introspection for the given uuid and
# introspection finished, so we don't get the error when
# we ask to abort.
self.assertRaises(client.ClientError, self.client.abort,
"2e31df61-84b1-5856-bfb6-6b5f2cd3dd11")
self.client.introspect(self.uuid)
eventlet.greenthread.sleep(functional.DEFAULT_SLEEP)
self.cli.set_node_power_state.assert_called_once_with(self.uuid,
'rebooting')
status = self.client.get_status(self.uuid)
self.check_status(status, finished=False, state=istate.States.waiting)
res = self.client.abort(self.uuid)
eventlet.greenthread.sleep(functional.DEFAULT_SLEEP)
self.assertEqual(202, res.status_code)
self.assertEqual('{}\n', res.text)
status = self.client.get_status(self.uuid)
self.check_status(status, finished=True, state=istate.States.error,
error='Canceled by operator')
# assert continue doesn't work after abort
self.call_continue(self.data, expect_error=400)
def test_api_versions(self):
minv, maxv = self.client.server_api_versions()
self.assertEqual((1, 0), minv)
self.assertGreaterEqual(maxv, (1, 0))
self.assertLess(maxv, (2, 0))
def test_client_init(self):
self.assertRaises(client.VersionNotSupported,
client.ClientV1, session=self.session,
api_version=(1, 999))
self.assertRaises(client.VersionNotSupported,
client.ClientV1, session=self.session,
api_version=2)
self.assertTrue(client.ClientV1(
api_version=1, session=self.session).server_api_versions())
self.assertTrue(client.ClientV1(
api_version='1.0', session=self.session).server_api_versions())
self.assertTrue(client.ClientV1(
api_version=(1, 0), session=self.session).server_api_versions())
self.assertTrue(
client.ClientV1(inspector_url='http://127.0.0.1:5050')
.server_api_versions())
self.assertTrue(
client.ClientV1(inspector_url='http://127.0.0.1:5050/v1')
.server_api_versions())
def test_rules_api(self):
res = self.client.rules.get_all()
self.assertEqual([], res)
rule = {'conditions': [],
'actions': [{'action': 'fail', 'message': 'boom'}],
'description': 'Cool actions',
'scope': None,
'uuid': self.uuid}
res = self.client.rules.from_json(rule)
self.assertEqual(self.uuid, res['uuid'])
rule['links'] = res['links']
self.assertEqual(rule, res)
res = self.client.rules.get(self.uuid)
self.assertEqual(rule, res)
res = self.client.rules.get_all()
self.assertEqual(rule['links'], res[0].pop('links'))
self.assertEqual([{'uuid': self.uuid,
'description': 'Cool actions',
'scope': None}],
res)
self.client.rules.delete(self.uuid)
res = self.client.rules.get_all()
self.assertEqual([], res)
for _ in range(3):
res = self.client.rules.create(conditions=rule['conditions'],
actions=rule['actions'],
description=rule['description'])
self.assertTrue(res['uuid'])
for key in ('conditions', 'actions', 'description'):
self.assertEqual(rule[key], res[key])
res = self.client.rules.get_all()
self.assertEqual(3, len(res))
self.client.rules.delete_all()
res = self.client.rules.get_all()
self.assertEqual([], res)
self.assertRaises(client.ClientError, self.client.rules.get,
self.uuid)
self.assertRaises(client.ClientError, self.client.rules.delete,
self.uuid)
BASE_CMD = [os.path.join(sys.prefix, 'bin', 'openstack'),
'--os-auth-type', 'none', '--os-endpoint', 'http://127.0.0.1:5050']
class BaseCLITest(functional.Base):
def openstack(self, cmd, expect_error=False, parse_json=False):
real_cmd = BASE_CMD + cmd
if parse_json:
real_cmd += ['-f', 'json']
try:
out, _err = processutils.execute(*real_cmd)
except processutils.ProcessExecutionError as exc:
if expect_error:
return exc.stderr
else:
raise
else:
if expect_error:
raise AssertionError('Command %s returned unexpected success' %
cmd)
elif parse_json:
return json.loads(out)
else:
return out
def run_cli(self, *cmd, **kwargs):
return self.openstack(['baremetal', 'introspection'] + list(cmd),
**kwargs)
class TestCLI(BaseCLITest):
def setup_lldp(self):
self.all_interfaces = {
'eth1': {'mac': self.macs[0], 'ip': self.ips[0],
'client_id': None, 'lldp_processed':
{'switch_chassis_id': "11:22:33:aa:bb:cc",
'switch_port_vlans':
[{"name": "vlan101", "id": 101},
{"name": "vlan102", "id": 102},
{"name": "vlan104", "id": 104},
{"name": "vlan201", "id": 201},
{"name": "vlan203", "id": 203}],
'switch_port_id': "554",
'switch_port_mtu': 1514}},
'eth3': {'mac': self.macs[1], 'ip': None,
'client_id': None, 'lldp_processed':
{'switch_chassis_id': "11:22:33:aa:bb:cc",
'switch_port_vlans':
[{"name": "vlan101", "id": 101},
{"name": "vlan102", "id": 102},
{"name": "vlan104", "id": 106}],
'switch_port_id': "557",
'switch_port_mtu': 9216}}
}
self.data['all_interfaces'] = self.all_interfaces
def _fake_status(self, **kwargs):
# to remove the hidden fields
hidden_status_items = shell.StatusCommand.hidden_status_items
fake_status = super(TestCLI, self)._fake_status(**kwargs)
fake_status = dict(item for item in fake_status.items()
if item[0] not in hidden_status_items)
return fake_status
def test_cli_negative(self):
msg_missing_param = 'the following arguments are required'
err = self.run_cli('start', expect_error=True)
self.assertIn(msg_missing_param, err)
err = self.run_cli('status', expect_error=True)
self.assertIn(msg_missing_param, err)
err = self.run_cli('rule', 'show', 'uuid', expect_error=True)
self.assertIn('not found', err)
err = self.run_cli('rule', 'delete', 'uuid', expect_error=True)
self.assertIn('not found', err)
err = self.run_cli('interface', 'list', expect_error=True)
self.assertIn(msg_missing_param, err)
def test_introspect_get_status(self):
self.run_cli('start', self.uuid)
eventlet.greenthread.sleep(functional.DEFAULT_SLEEP)
self.cli.set_node_power_state.assert_called_once_with(self.uuid,
'rebooting')
status = self.run_cli('status', self.uuid, parse_json=True)
self.check_status(status, finished=False, state=istate.States.waiting)
res = self.call_continue(self.data)
self.assertEqual({'uuid': self.uuid}, res)
eventlet.greenthread.sleep(functional.DEFAULT_SLEEP)
self.assertCalledWithPatch(self.patch, self.cli.patch_node)
self.cli.create_port.assert_called_once_with(
node_uuid=self.uuid, address='11:22:33:44:55:66',
is_pxe_enabled=True, extra={})
status = self.run_cli('status', self.uuid, parse_json=True)
self.check_status(status, finished=True, state=istate.States.finished)
def test_rules_api(self):
res = self.run_cli('rule', 'list', parse_json=True)
self.assertEqual([], res)
rule = {'conditions': [],
'actions': [{'action': 'fail', 'message': 'boom'}],
'description': 'Cool actions',
'scope': None,
'uuid': self.uuid}
with tempfile.NamedTemporaryFile(mode='w') as fp:
json.dump(rule, fp)
fp.flush()
res = self.run_cli('rule', 'import', fp.name, parse_json=True)
self.assertEqual([{'UUID': self.uuid,
'Description': 'Cool actions'}],
res)
res = self.run_cli('rule', 'show', self.uuid, parse_json=True)
self.assertEqual(rule, res)
res = self.run_cli('rule', 'list', parse_json=True)
self.assertEqual([{'UUID': self.uuid,
'Description': 'Cool actions'}],
res)
self.run_cli('rule', 'delete', self.uuid)
res = self.run_cli('rule', 'list', parse_json=True)
self.assertEqual([], res)
with tempfile.NamedTemporaryFile(mode='w') as fp:
rule.pop('uuid')
json.dump([rule, rule], fp)
fp.flush()
res = self.run_cli('rule', 'import', fp.name, parse_json=True)
self.run_cli('rule', 'purge')
res = self.run_cli('rule', 'list', parse_json=True)
self.assertEqual([], res)
@mock.patch.object(process, 'get_introspection_data', autospec=True)
def test_interface_list(self, get_mock):
self.setup_lldp()
get_mock.return_value = json.dumps(self.data)
expected_eth1 = {u'Interface': u'eth1',
u'MAC Address': u'11:22:33:44:55:66',
u'Switch Chassis ID': u'11:22:33:aa:bb:cc',
u'Switch Port ID': u'554',
u'Switch Port VLAN IDs': [101, 102, 104, 201, 203]}
expected_eth3 = {u'Interface': u'eth3',
u'MAC Address': u'66:55:44:33:22:11',
u'Switch Chassis ID': u'11:22:33:aa:bb:cc',
u'Switch Port ID': u'557',
u'Switch Port VLAN IDs': [101, 102, 106]}
res = self.run_cli('interface', 'list', self.uuid, parse_json=True)
self.assertIn(expected_eth1, res)
self.assertIn(expected_eth3, res)
# Filter on vlan
res = self.run_cli('interface', 'list', self.uuid, '--vlan', '106',
parse_json=True)
self.assertIn(expected_eth3, res)
# Select fields
res = self.run_cli('interface', 'list', self.uuid, '--fields',
'switch_port_mtu',
parse_json=True)
self.assertIn({u'Switch Port MTU': 1514}, res)
self.assertIn({u'Switch Port MTU': 9216}, res)
@mock.patch.object(process, 'get_introspection_data', autospec=True)
def test_interface_show(self, get_mock):
self.setup_lldp()
get_mock.return_value = json.dumps(self.data)
res = self.run_cli('interface', 'show', self.uuid, "eth1",
parse_json=True)
expected = {u'interface': u'eth1',
u'mac': u'11:22:33:44:55:66',
u'switch_chassis_id': u'11:22:33:aa:bb:cc',
u'switch_port_id': u'554',
u'switch_port_mtu': 1514,
u'switch_port_vlan_ids': [101, 102, 104, 201, 203],
u'switch_port_vlans': [{u'id': 101, u'name': u'vlan101'},
{u'id': 102, u'name': u'vlan102'},
{u'id': 104, u'name': u'vlan104'},
{u'id': 201, u'name': u'vlan201'},
{u'id': 203, u'name': u'vlan203'}]}
self.assertLessEqual(expected.items(), res.items())
if __name__ == '__main__':
if len(sys.argv) > 1:
test_name = sys.argv[1]
else:
test_name = None
with functional.mocked_server():
unittest.main(verbosity=2, defaultTest=test_name)
|
