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
|
# All Rights Reserved.
#
# 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.
from http import client as http_client
import json
from unittest import mock
import sushy
from sushy import exceptions
from sushy.resources.certificateservice import certificate
from sushy.resources.manager import constants as mgr_cons
from sushy.resources.manager import virtual_media
from sushy.tests.unit import base
class VirtualMediaTestCase(base.TestCase):
def setUp(self):
super().setUp()
self.conn = mock.Mock()
self.conn.get.return_value.headers = {'Allow': 'GET,HEAD'}
with open('sushy/tests/unit/json_samples/'
'virtual_media.json') as f:
self.json_doc = json.load(f)
self.conn.get.return_value.json.return_value = self.json_doc
self.sys_virtual_media = virtual_media.VirtualMedia(
self.conn, '/redfish/v1/Managers/BMC/VirtualMedia/Floppy1',
redfish_version='1.0.2')
def test__parse_attributes(self):
self.sys_virtual_media._parse_attributes(self.json_doc)
self.assertEqual('Virtual Removable Media',
self.sys_virtual_media.name)
self.assertEqual('Floppy1', self.sys_virtual_media.identity)
self.assertEqual('https://www.dmtf.org/freeImages/Sardine.img',
self.sys_virtual_media.image)
self.assertEqual('Sardine2.1.43.35.6a',
self.sys_virtual_media.image_name)
self.assertEqual(sushy.ConnectedVia.URI,
self.sys_virtual_media.connected_via)
self.assertEqual([sushy.VirtualMediaType.FLOPPY,
sushy.VirtualMediaType.USB_STICK],
self.sys_virtual_media.media_types)
self.assertEqual(True, self.sys_virtual_media.inserted)
self.assertEqual(False, self.sys_virtual_media.write_protected)
def test__parse_attributes_return(self):
attributes = self.sys_virtual_media._parse_attributes(self.json_doc)
# Test that various types are returned correctly
self.assertEqual('https://www.dmtf.org/freeImages/Sardine.img',
attributes.get('image'))
self.assertEqual(sushy.ConnectedVia.URI,
attributes.get('connected_via'))
self.assertEqual([sushy.VirtualMediaType.FLOPPY,
sushy.VirtualMediaType.USB_STICK],
attributes.get('media_types'))
def test_insert_media_none(self):
self.sys_virtual_media._actions.insert_media = None
self.assertRaisesRegex(
exceptions.MissingActionError, 'action #VirtualMedia.InsertMedia',
self.sys_virtual_media.insert_media,
"https://www.dmtf.org/freeImages/Sardine.img", True, False)
self.sys_virtual_media._actions = None
self.assertRaisesRegex(
exceptions.MissingActionError, 'action #VirtualMedia.InsertMedia',
self.sys_virtual_media.insert_media,
"https://www.dmtf.org/freeImages/Sardine.img", True, False)
def test_insert_media(self):
self.assertFalse(self.sys_virtual_media._is_stale)
self.sys_virtual_media.insert_media(
"https://www.dmtf.org/freeImages/Sardine.img", True, False)
self.sys_virtual_media._conn.post.assert_called_once_with(
("/redfish/v1/Managers/BMC/VirtualMedia/Floppy1/Actions"
"/VirtualMedia.InsertMedia"),
data={"Image": "https://www.dmtf.org/freeImages/Sardine.img",
"WriteProtected": False}
)
self.assertTrue(self.sys_virtual_media._is_stale)
def test_insert_media_rf_default(self):
self.assertFalse(self.sys_virtual_media._is_stale)
self.sys_virtual_media.insert_media(
"https://www.dmtf.org/freeImages/Sardine.img", True, True)
self.sys_virtual_media._conn.post.assert_called_once_with(
("/redfish/v1/Managers/BMC/VirtualMedia/Floppy1/Actions"
"/VirtualMedia.InsertMedia"),
data={"Image": "https://www.dmtf.org/freeImages/Sardine.img"}
)
self.assertTrue(self.sys_virtual_media._is_stale)
def test_insert_media_credentials(self):
self.assertFalse(self.sys_virtual_media._is_stale)
self.sys_virtual_media.insert_media(
"https://www.dmtf.org/freeImages/Sardine.img", True, False,
username="admin", password="pwd")
self.sys_virtual_media._conn.post.assert_called_once_with(
("/redfish/v1/Managers/BMC/VirtualMedia/Floppy1/Actions"
"/VirtualMedia.InsertMedia"),
data={"Image": "https://www.dmtf.org/freeImages/Sardine.img",
"WriteProtected": False,
"UserName": "admin", "Password": "pwd"}
)
self.assertTrue(self.sys_virtual_media._is_stale)
def test_insert_media_credentials_required(self):
self.assertFalse(self.sys_virtual_media._is_stale)
with open('sushy/tests/unit/json_samples/'
'credentials_required_error.json') as f:
response_obj = json.load(f)
response = mock.Mock(spec=['json', 'status_code'])
response.json.return_value = response_obj
error = exceptions.HTTPError('GET', 'VirtualMedia', response)
self.sys_virtual_media._conn.post.side_effect = [error, None]
self.assertFalse(self.sys_virtual_media._is_stale)
self.sys_virtual_media.insert_media(
"https://www.dmtf.org/freeImages/Sardine.img", True, False)
self.sys_virtual_media._conn.post.assert_called_with(
("/redfish/v1/Managers/BMC/VirtualMedia/Floppy1/Actions"
"/VirtualMedia.InsertMedia"),
data={"Image": "https://www.dmtf.org/freeImages/Sardine.img",
"WriteProtected": False, "UserName": "none",
"Password": "none"}
)
self.assertEqual(self.sys_virtual_media._conn.post.call_count, 2)
self.assertTrue(self.sys_virtual_media._is_stale)
def test_insert_media_transfer_method(self):
self.assertFalse(self.sys_virtual_media._is_stale)
self.sys_virtual_media.insert_media(
"https://www.dmtf.org/freeImages/Sardine.img", True, False,
transfer_method=mgr_cons.TransferMethod.UPLOAD)
self.sys_virtual_media._conn.post.assert_called_once_with(
("/redfish/v1/Managers/BMC/VirtualMedia/Floppy1/Actions"
"/VirtualMedia.InsertMedia"),
data={"Image": "https://www.dmtf.org/freeImages/Sardine.img",
"WriteProtected": False, "TransferMethod": "Upload"}
)
self.assertTrue(self.sys_virtual_media._is_stale)
def test_insert_media_transfer_method_wrong_input(self):
self.assertRaises(exceptions.InvalidParameterValueError,
self.sys_virtual_media.insert_media,
"https://www.dmtf.org/freeImages/Sardine.img",
True, False, transfer_method='quickly!')
def test_insert_media_fallback(self):
self.conn.get.return_value.headers = {'Allow': 'GET,HEAD,PATCH'}
self.sys_virtual_media._actions.insert_media = None
self.sys_virtual_media.insert_media(
"https://www.dmtf.org/freeImages/Sardine.img", True, False)
self.sys_virtual_media._conn.patch.assert_called_once_with(
("/redfish/v1/Managers/BMC/VirtualMedia/Floppy1"),
data={"Image": "https://www.dmtf.org/freeImages/Sardine.img",
"Inserted": True, "WriteProtected": False},
headers=None)
self.assertTrue(self.sys_virtual_media._is_stale)
def test_insert_media_fallback_with_etag(self):
self.conn.get.return_value.headers = {'Allow': 'GET,HEAD,PATCH',
'ETag': '"3d7b8a7360bf2941d"'}
self.sys_virtual_media._actions.insert_media = None
self.sys_virtual_media.insert_media(
"https://www.dmtf.org/freeImages/Sardine.img", True, False)
self.sys_virtual_media._conn.patch.assert_called_once_with(
("/redfish/v1/Managers/BMC/VirtualMedia/Floppy1"),
data={"Image": "https://www.dmtf.org/freeImages/Sardine.img",
"Inserted": True, "WriteProtected": False},
headers={"If-Match": '"3d7b8a7360bf2941d"'})
self.assertTrue(self.sys_virtual_media._is_stale)
def test_insert_media_fallback_with_weak_etag(self):
self.conn.get.return_value.headers = {'Allow': 'GET,HEAD,PATCH',
'ETag': 'W/"3d7b8a7360bf2941d"'}
self.sys_virtual_media._actions.insert_media = None
self.sys_virtual_media.insert_media(
"https://www.dmtf.org/freeImages/Sardine.img", True, False)
self.sys_virtual_media._conn.patch.assert_called_once_with(
("/redfish/v1/Managers/BMC/VirtualMedia/Floppy1"),
data={"Image": "https://www.dmtf.org/freeImages/Sardine.img",
"Inserted": True, "WriteProtected": False},
headers={"If-Match": 'W/"3d7b8a7360bf2941d"'})
self.assertTrue(self.sys_virtual_media._is_stale)
def test_is_transfer_protocol_required(self):
with open('sushy/tests/unit/json_samples/'
'transfer_proto_required_error.json') as f:
response_obj = json.load(f)
response = mock.Mock(spec=['json', 'status_code'])
response.json.return_value = response_obj
error = exceptions.HTTPError('GET', 'VirtualMedia', response)
retval = self.sys_virtual_media.is_transfer_protocol_required(error)
self.assertTrue(retval)
def test_is_transfer_protocol_required_alt(self):
with open('sushy/tests/unit/json_samples/'
'transfer_proto_required_error.json') as f:
response_obj = json.load(f)
response_obj['error']['code'] = 'Base.1.5.PropertyMissing'
response = mock.Mock(spec=['json', 'status_code'])
response.json.return_value = response_obj
error = exceptions.HTTPError('GET', 'VirtualMedia', response)
retval = self.sys_virtual_media.is_transfer_protocol_required(error)
self.assertTrue(retval)
def test_is_transfer_protocol_required_alt2(self):
with open('sushy/tests/unit/json_samples/'
'transfer_proto_required_error2.json') as f:
response_obj = json.load(f)
response = mock.Mock(spec=['json', 'status_code'])
response.json.return_value = response_obj
error = exceptions.HTTPError('GET', 'VirtualMedia', response)
retval = self.sys_virtual_media.is_transfer_protocol_required(error)
self.assertTrue(retval)
def test_is_transfer_protocol_required_alt3(self):
with open('sushy/tests/unit/json_samples/'
'transfer_proto_required_error3.json') as f:
response_obj = json.load(f)
response = mock.Mock(spec=['json', 'status_code'])
response.json.return_value = response_obj
error = exceptions.HTTPError('GET', 'VirtualMedia', response)
retval = self.sys_virtual_media.is_transfer_protocol_required(error)
self.assertTrue(retval)
def test_is_transfer_method_required(self):
with open('sushy/tests/unit/json_samples/'
'transfer_method_required_error.json') as f:
response_obj = json.load(f)
response = mock.Mock(spec=['json', 'status_code'])
response.json.return_value = response_obj
error = exceptions.HTTPError('POST', 'VirtualMedia', response)
retval = self.sys_virtual_media.is_transfer_method_required(error)
self.assertTrue(retval)
def test_eject_media_none(self):
self.sys_virtual_media._actions.eject_media = None
self.assertRaisesRegex(
exceptions.MissingActionError, 'action #VirtualMedia.EjectMedia',
self.sys_virtual_media.eject_media)
self.sys_virtual_media._actions = None
self.assertRaisesRegex(
exceptions.MissingActionError, 'action #VirtualMedia.EjectMedia',
self.sys_virtual_media.eject_media)
def test_eject_media(self):
self.assertFalse(self.sys_virtual_media._is_stale)
self.sys_virtual_media.eject_media()
self.sys_virtual_media._conn.post.assert_called_once_with(
"/redfish/v1/Managers/BMC/VirtualMedia/Floppy1/Actions"
"/VirtualMedia.EjectMedia")
self.assertTrue(self.sys_virtual_media._is_stale)
def test_eject_media_fallback(self):
self.conn.get.return_value.headers = {'Allow': 'GET,HEAD,PATCH'}
self.sys_virtual_media._actions.eject_media = None
self.sys_virtual_media.eject_media()
self.sys_virtual_media._conn.patch.assert_called_once_with(
("/redfish/v1/Managers/BMC/VirtualMedia/Floppy1"),
data={"Image": None, "Inserted": False}, headers=None)
self.assertTrue(self.sys_virtual_media._is_stale)
def test_eject_media_fallback_with_etag(self):
self.conn.get.return_value.headers = {'Allow': 'GET,HEAD,PATCH',
'ETag': '"3d7b8a7360bf2941d"'}
self.sys_virtual_media._actions.eject_media = None
self.sys_virtual_media.eject_media()
self.sys_virtual_media._conn.patch.assert_called_once_with(
("/redfish/v1/Managers/BMC/VirtualMedia/Floppy1"),
data={"Image": None, "Inserted": False},
headers={"If-Match": '"3d7b8a7360bf2941d"'})
self.assertTrue(self.sys_virtual_media._is_stale)
def test_eject_media_fallback_with_weak_etag(self):
self.conn.get.return_value.headers = {'Allow': 'GET,HEAD,PATCH',
'ETag': 'W/"3d7b8a7360bf2941d"'}
self.sys_virtual_media._actions.eject_media = None
self.sys_virtual_media.eject_media()
self.sys_virtual_media._conn.patch.assert_called_once_with(
("/redfish/v1/Managers/BMC/VirtualMedia/Floppy1"),
data={"Image": None, "Inserted": False},
headers={"If-Match": 'W/"3d7b8a7360bf2941d"'})
self.assertTrue(self.sys_virtual_media._is_stale)
def test_eject_media_pass_empty_dict_415(self):
target_uri = ("/redfish/v1/Managers/BMC/VirtualMedia/Floppy1/Actions"
"/VirtualMedia.EjectMedia")
self.conn.post.side_effect = [exceptions.HTTPError(
method='POST', url=target_uri, response=mock.MagicMock(
status_code=http_client.UNSUPPORTED_MEDIA_TYPE)), '200']
self.sys_virtual_media.eject_media()
post_calls = [
mock.call(target_uri),
mock.call(target_uri, data={})]
self.sys_virtual_media._conn.post.assert_has_calls(post_calls)
self.assertTrue(self.sys_virtual_media._is_stale)
def test_eject_media_pass_empty_dict_400(self):
target_uri = ("/redfish/v1/Managers/BMC/VirtualMedia/Floppy1/Actions"
"/VirtualMedia.EjectMedia")
self.conn.post.side_effect = [exceptions.HTTPError(
method='POST', url=target_uri, response=mock.MagicMock(
status_code=http_client.BAD_REQUEST)), '200']
self.sys_virtual_media.eject_media()
post_calls = [
mock.call(target_uri),
mock.call(target_uri, data={})]
self.sys_virtual_media._conn.post.assert_has_calls(post_calls)
self.assertTrue(self.sys_virtual_media._is_stale)
def test_eject_media_fail_but_media_is_ejected(self):
target_uri = ("/redfish/v1/Managers/BMC/VirtualMedia/Floppy1/Actions"
"/VirtualMedia.EjectMedia")
self.conn.post.side_effect = [
exceptions.HTTPError(
method='POST', url=target_uri, response=mock.MagicMock(
status_code=http_client.UNSUPPORTED_MEDIA_TYPE)),
exceptions.HTTPError(
method='POST', url=target_uri, response=mock.MagicMock(
status_code=http_client.INTERNAL_SERVER_ERROR))
]
self.sys_virtual_media.inserted = True
def fake_refresh(force=False):
self.sys_virtual_media.inserted = False
self.sys_virtual_media.refresh = mock.Mock(side_effect=fake_refresh)
self.sys_virtual_media.eject_media()
post_calls = [
mock.call(target_uri),
mock.call(target_uri, data={})]
self.sys_virtual_media.refresh.assert_called_once_with(force=True)
self.sys_virtual_media._conn.post.assert_has_calls(post_calls)
def test_set_verify_certificate(self):
self.conn.get.return_value.headers = {'Allow': 'GET,HEAD',
'ETag': '3d7b8a7360bf2941d'}
with mock.patch.object(
self.sys_virtual_media, 'invalidate',
autospec=True) as invalidate_mock:
self.sys_virtual_media.set_verify_certificate(True)
self.sys_virtual_media._conn.patch.assert_called_once_with(
"/redfish/v1/Managers/BMC/VirtualMedia/Floppy1",
data={'VerifyCertificate': True},
etag='3d7b8a7360bf2941d')
invalidate_mock.assert_called_once_with()
def test_set_verify_certificate_wrong_input(self):
self.assertRaises(exceptions.InvalidParameterValueError,
self.sys_virtual_media.set_verify_certificate, 'yes')
@mock.patch.object(certificate, 'CertificateCollection', autospec=True)
def test_certificate_collection(self, mock_cert_coll):
result = self.sys_virtual_media.certificates
self.assertEqual(mock_cert_coll.return_value, result)
mock_cert_coll.assert_called_once_with(
self.conn,
"/redfish/v1/Managers/BMC/VirtualMedia/Floppy1/Certificates/",
redfish_version='1.0.2',
registries=self.sys_virtual_media.registries,
root=self.sys_virtual_media.root)
|
