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
|
# 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 unittest import mock
import stevedore
from sushy import exceptions
from sushy.resources import base as res_base
from sushy.resources.oem import base as oem_base
from sushy.resources.oem import common as oem_common
from sushy.tests.unit import base
class ContosoResourceOEMExtension(oem_base.OEMResourceBase):
pass
class FauxResourceOEMExtension(oem_base.OEMResourceBase):
pass
class ResourceOEMCommonMethodsTestCase(base.TestCase):
def setUp(self):
super().setUp()
# We use ExtensionManager.make_test_instance() and instantiate the
# test instance outside of the test cases in setUp. Inside of the
# test cases we set this as the return value of the mocked
# constructor. Also note that this instrumentation has been done
# only for one specific resource namespace which gets passed in the
# constructor of ExtensionManager. Moreover, this setUp also enables
# us to verify that the constructor is called correctly while still
# using a more realistic ExtensionManager.
contoso_ep = mock.Mock()
contoso_ep.module_name = __name__
contoso_ep.attrs = ['ContosoResourceOEMExtension']
self.contoso_extn = stevedore.extension.Extension(
'contoso', contoso_ep, lambda: ContosoResourceOEMExtension, None)
self.contoso_extn_dup = stevedore.extension.Extension(
'contoso_dup', contoso_ep,
lambda: ContosoResourceOEMExtension, None)
faux_ep = mock.Mock()
faux_ep.module_name = __name__
faux_ep.attrs = ['FauxResourceOEMExtension']
self.faux_extn = stevedore.extension.Extension(
'faux', faux_ep, lambda: FauxResourceOEMExtension, None)
self.faux_extn_dup = stevedore.extension.Extension(
'faux_dup', faux_ep, lambda: FauxResourceOEMExtension, None)
self.fake_ext_mgr = (
stevedore.extension.ExtensionManager.make_test_instance(
[self.contoso_extn, self.faux_extn]))
self.fake_ext_mgr2 = (
stevedore.extension.ExtensionManager.make_test_instance(
[self.contoso_extn_dup, self.faux_extn_dup]))
def tearDown(self):
super().tearDown()
@mock.patch.dict(oem_common._global_extn_mgrs_by_resource, {}, clear=True)
@mock.patch.object(stevedore, 'ExtensionManager', autospec=True)
def test__create_extension_manager(self, ExtensionManager_mock):
system_resource_oem_ns = 'sushy.resources.system.oems'
ExtensionManager_mock.return_value = self.fake_ext_mgr
result = oem_common._create_extension_manager(
system_resource_oem_ns, 'system')
self.assertEqual(self.fake_ext_mgr, result)
ExtensionManager_mock.assert_called_once_with(
system_resource_oem_ns, propagate_map_exceptions=True,
on_load_failure_callback=oem_common._raise)
@mock.patch.dict(oem_common._global_extn_mgrs_by_resource, {}, clear=True)
@mock.patch.object(stevedore, 'ExtensionManager', autospec=True)
def test__create_extension_manager_no_extns(self, ExtensionManager_mock):
system_resource_oem_ns = 'sushy.resources.system.oems'
ExtensionManager_mock.return_value.names.return_value = []
self.assertRaisesRegex(
exceptions.ExtensionError, 'No extensions found',
oem_common._create_extension_manager,
system_resource_oem_ns, 'system')
@mock.patch.dict(oem_common._global_extn_mgrs_by_resource, {}, clear=True)
@mock.patch.object(stevedore, 'ExtensionManager', autospec=True)
def test__get_extension_manager_of_resource(self, ExtensionManager_mock):
ExtensionManager_mock.return_value = self.fake_ext_mgr
result = oem_common._get_extension_manager_of_resource('system')
self.assertEqual(self.fake_ext_mgr, result)
ExtensionManager_mock.assert_called_once_with(
namespace='sushy.resources.system.oems',
propagate_map_exceptions=True,
on_load_failure_callback=oem_common._raise)
ExtensionManager_mock.reset_mock()
result = oem_common._get_extension_manager_of_resource('manager')
self.assertEqual(self.fake_ext_mgr, result)
ExtensionManager_mock.assert_called_once_with(
namespace='sushy.resources.manager.oems',
propagate_map_exceptions=True,
on_load_failure_callback=oem_common._raise)
for name, extension in result.items():
self.assertIn(name, ('contoso', 'faux'))
self.assertIn(extension, (self.contoso_extn,
self.faux_extn))
@mock.patch.dict(oem_common._global_extn_mgrs_by_resource, {}, clear=True)
@mock.patch.object(stevedore, 'ExtensionManager', autospec=True)
def test_get_resource_extension_by_vendor(self, ExtensionManager_mock):
oem_resource_mock = mock.Mock()
oem_resource_mock.set_parent_resource = lambda *x: oem_resource_mock
resource_instance_mock = mock.Mock()
resource_instance_mock.clone_resource = lambda *x: oem_resource_mock
ExtensionManager_mock.side_effect = [self.fake_ext_mgr,
self.fake_ext_mgr2]
result = oem_common.get_resource_extension_by_vendor(
'system', 'Faux', resource_instance_mock)
self.assertEqual(result, oem_resource_mock)
ExtensionManager_mock.assert_called_once_with(
'sushy.resources.system.oems', propagate_map_exceptions=True,
on_load_failure_callback=oem_common._raise)
ExtensionManager_mock.reset_mock()
oem_resource_mock.obj = None
result = oem_common.get_resource_extension_by_vendor(
'system', 'Contoso', resource_instance_mock)
self.assertEqual(result, oem_resource_mock)
self.assertFalse(ExtensionManager_mock.called)
ExtensionManager_mock.reset_mock()
result = oem_common.get_resource_extension_by_vendor(
'manager', 'Faux_dup', resource_instance_mock)
self.assertEqual(result, oem_resource_mock)
ExtensionManager_mock.assert_called_once_with(
'sushy.resources.manager.oems', propagate_map_exceptions=True,
on_load_failure_callback=oem_common._raise)
ExtensionManager_mock.reset_mock()
result = oem_common.get_resource_extension_by_vendor(
'manager', 'Contoso_dup', resource_instance_mock)
self.assertEqual(result, oem_resource_mock)
self.assertFalse(ExtensionManager_mock.called)
ExtensionManager_mock.reset_mock()
@mock.patch.dict(oem_common._global_extn_mgrs_by_resource, {}, clear=True)
@mock.patch.object(stevedore, 'ExtensionManager', autospec=True)
def test_get_resource_extension_by_vendor_fail(
self, ExtensionManager_mock):
resource_instance_mock = mock.Mock(spec=res_base.ResourceBase)
# ``fake_ext_mgr2`` has extension names as ``faux_dup``
# and ``contoso_dup``.
ExtensionManager_mock.return_value = self.fake_ext_mgr2
self.assertRaisesRegex(
exceptions.OEMExtensionNotFoundError,
'No sushy.resources.system.oems OEM extension found '
'by name "faux"',
oem_common.get_resource_extension_by_vendor,
'sushy.resources.system.oems', 'Faux', resource_instance_mock)
@mock.patch.dict(oem_common._global_extn_mgrs_by_resource, {}, clear=True)
@mock.patch.object(stevedore, 'ExtensionManager', autospec=True)
def test_get_resource_extension_by_vendor_different_resources(
self, ExtensionManager_mock):
oem_resource_mock = mock.Mock()
oem_resource_mock.set_parent_resource = lambda *x: oem_resource_mock
resource_instance_mock = mock.Mock()
resource_instance_mock.clone_resource = lambda *x: oem_resource_mock
oem_resource_mock2 = mock.Mock()
oem_resource_mock2.set_parent_resource = lambda *x: oem_resource_mock2
resource_instance_mock2 = mock.Mock()
resource_instance_mock2.clone_resource = lambda *x: oem_resource_mock2
ExtensionManager_mock.side_effect = [self.fake_ext_mgr]
result = oem_common.get_resource_extension_by_vendor(
'system', 'Faux', resource_instance_mock)
self.assertEqual(result, oem_resource_mock)
ExtensionManager_mock.assert_called_once_with(
'sushy.resources.system.oems', propagate_map_exceptions=True,
on_load_failure_callback=oem_common._raise)
ExtensionManager_mock.reset_mock()
result2 = oem_common.get_resource_extension_by_vendor(
'system', 'Faux', resource_instance_mock2)
self.assertEqual(result2, oem_resource_mock2)
ExtensionManager_mock.assert_not_called()
ExtensionManager_mock.reset_mock()
|
