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
|
# -*- coding: utf-8 -*-
#
# Dell OpenManage Ansible Modules
# Version 8.2.0
# Copyright (C) 2021-2023 Dell Inc. or its subsidiaries. All Rights Reserved.
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
import json
import pytest
from ssl import SSLError
from io import StringIO
from ansible.module_utils.six.moves.urllib.error import HTTPError, URLError
from ansible.module_utils.urls import ConnectionError, SSLValidationError
from ansible.module_utils._text import to_text
from ansible_collections.dellemc.openmanage.plugins.modules import ome_device_power_settings
from ansible_collections.dellemc.openmanage.tests.unit.plugins.modules.common import FakeAnsibleModule
MODULE_PATH = 'ansible_collections.dellemc.openmanage.plugins.modules.ome_device_power_settings.'
DEVICE_FAIL_MSG = "Unable to complete the operation because the entered target device {0} '{1}' is invalid."
CONFIG_FAIL_MSG = "one of the following is required: power_configuration, " \
"redundancy_configuration, hot_spare_configuration"
CHANGES_FOUND = "Changes found to be applied."
NO_CHANGES_FOUND = "No changes found to be applied."
SUCCESS_MSG = "Successfully updated the power settings."
FETCH_FAIL_MSG = "Failed to fetch the device information."
POWER_FAIL_MSG = "Unable to complete the operation because the power settings " \
"are not supported on the specified device."
DOMAIN_FAIL_MSG = "The device location settings operation is supported only on " \
"OpenManage Enterprise Modular."
ERROR_JSON = {
"error": {
"code": "Base.1.0.GeneralError",
"message": "A general error has occurred. See ExtendedInfo for more information.",
"@Message.ExtendedInfo": [
{
"MessageId": "CGEN1004",
"RelatedProperties": [],
"Message": "Unable to process the request because an error occurred.",
"MessageArgs": [],
"Severity": "Critical",
"Resolution": "Retry the operation. If the issue persists, contact your system administrator."
}
]
}}
MPARAMS = {"hostname": "xxx.xxx.x.x",
"power_configuration": {"enable_power_cap": True, "power_cap": 3424}
}
POWER_JSON_DATA = {"value": [
{'Id': 1234, 'PublicAddress': "xxx.xxx.x.x",
'DeviceId': 1234, "Type": 1000},
{'PublicAddress': "xxx.xxx.xx.x", 'DeviceId': 1235, "Type": 1000}]}
@pytest.fixture
def ome_conn_mock_power(mocker, ome_response_mock):
connection_class_mock = mocker.patch(MODULE_PATH + 'RestOME')
ome_connection_mock_obj = connection_class_mock.return_value.__enter__.return_value
ome_connection_mock_obj.invoke_request.return_value = ome_response_mock
return ome_connection_mock_obj
class TestOMEMDevicePower(FakeAnsibleModule):
module = ome_device_power_settings
@pytest.mark.parametrize("params_inp", [
{"json_data": {"value": [
{'Id': 1234, 'PublicAddress': "xxx.xxx.x.x",
'DeviceServiceTag': 'ABCD123', "Type": 1000},
{'PublicAddress': "X.X.X.X", 'DeviceId': 1235, "Type": 1000}],
"EnableHotSpare": True,
"EnablePowerCapSettings": True,
"MaxPowerCap": "3424",
"MinPowerCap": "3291",
"PowerCap": "3425",
"PrimaryGrid": "GRID_1",
"RedundancyPolicy": "NO_REDUNDANCY",
"SettingType": "Power"},
'message': SUCCESS_MSG,
'mparams': {"hostname": "xxx.xxx.x.x",
"power_configuration": {"enable_power_cap": True, "power_cap": 3424},
"hot_spare_configuration": {"enable_hot_spare": False, "primary_grid": "GRID_1"},
"device_id": 1234,
}},
{"json_data": {"value": [
{'Id': 1234, 'PublicAddress': "xxx.xxx.x.x",
'DeviceServiceTag': 'ABCD123', "Type": 1000},
{'PublicAddress': "X.X.X.X", 'DeviceId': 1235, "Type": 1000}],
"EnableHotSpare": True,
"EnablePowerCapSettings": True,
"MaxPowerCap": "3424",
"MinPowerCap": "3291",
"PowerCap": "3425",
"PrimaryGrid": "GRID_1",
"RedundancyPolicy": "NO_REDUNDANCY",
"SettingType": "Power"},
'message': SUCCESS_MSG,
'mparams': {"hostname": "xxx.xxx.x.x",
"power_configuration": {"enable_power_cap": False, "power_cap": 3424},
"hot_spare_configuration": {"enable_hot_spare": True, "primary_grid": "GRID_1"},
"device_service_tag": 'ABCD123',
}},
{"json_data": {"value": [
{'Id': 1234, 'PublicAddress': "xxx.xxx.x.x",
'DeviceId': 1234, "Type": 1000},
{'PublicAddress': "X.X.X.X", 'DeviceId': 1235, "Type": 1000}],
"EnableHotSpare": True,
"EnablePowerCapSettings": True,
"MaxPowerCap": "3424",
"MinPowerCap": "3291",
"PowerCap": "3425",
"PrimaryGrid": "GRID_1",
"RedundancyPolicy": "NO_REDUNDANCY",
"SettingType": "Power"},
'message': SUCCESS_MSG,
'mparams': {"hostname": "xxx.xxx.x.x",
"power_configuration": {"enable_power_cap": False, "power_cap": 3424},
"hot_spare_configuration": {"enable_hot_spare": True, "primary_grid": "GRID_1"}
}},
{"json_data": {"value": [
{'Id': 1234, 'PublicAddress': "dummyhostname_shouldnotexist",
'DeviceId': 1234, "Type": 1000},
{'PublicAddress': "X.X.X.X", 'DeviceId': 1235, "Type": 1000}],
"EnableHotSpare": True,
"EnablePowerCapSettings": True,
"MaxPowerCap": "3424",
"MinPowerCap": "3291",
"PowerCap": "3425",
"PrimaryGrid": "GRID_1",
"RedundancyPolicy": "NO_REDUNDANCY",
"SettingType": "Power"},
'message': SUCCESS_MSG,
'mparams': {"hostname": "dummyhostname_shouldnotexist",
"power_configuration": {"enable_power_cap": False, "power_cap": 3424},
"hot_spare_configuration": {"enable_hot_spare": True, "primary_grid": "GRID_1"}
}}
])
def test_ome_devices_power_settings_success(self, params_inp, ome_conn_mock_power, ome_response_mock,
ome_default_args, module_mock, mocker):
ome_response_mock.success = params_inp.get("success", True)
ome_response_mock.json_data = params_inp['json_data']
ome_default_args.update(params_inp['mparams'])
result = self._run_module(
ome_default_args, check_mode=params_inp.get('check_mode', False))
assert result['msg'] == params_inp['message']
@pytest.mark.parametrize("params", [
{"json_data": POWER_JSON_DATA,
'message': DOMAIN_FAIL_MSG,
'http_error_json': {
"error": {
"code": "Base.1.0.GeneralError",
"message": "A general error has occurred. See ExtendedInfo for more information.",
"@Message.ExtendedInfo": [
{
"MessageId": "CGEN1006",
"RelatedProperties": [],
"Message": "Unable to process the request because an error occurred.",
"MessageArgs": [],
"Severity": "Critical",
"Resolution": "Retry the operation. If the issue persists, contact your system administrator."
}
]
}},
'mparams': {"hostname": "xxx.xxx.x.x",
"device_service_tag": 'ABCD123',
"power_configuration": {"enable_power_cap": True, "power_cap": 3424}
}},
{"json_data": {"value": [
{'Id': 1234, 'PublicAddress': "xxx.xxx.x.x",
'DeviceId': 1234, "Type": 1000},
{'PublicAddress': "X.X.X.X", 'DeviceId': 1235, "Type": 1000}]},
'message': POWER_FAIL_MSG,
'check_domain_service': 'mocked_check_domain_service',
'get_chassis_device': ('Id', 1234),
'http_error_json': ERROR_JSON,
'mparams': MPARAMS},
{"json_data": POWER_JSON_DATA,
'message': POWER_FAIL_MSG,
'check_domain_service': 'mocked_check_domain_service',
'get_chassis_device': ('Id', 1234),
'http_err_code': 404,
'http_error_json': ERROR_JSON,
'mparams': MPARAMS},
{"json_data": POWER_JSON_DATA,
'message': DEVICE_FAIL_MSG.format('id', 123),
'check_domain_service': 'mocked_check_domain_service',
'get_chassis_device': ('Id', 1234),
'mparams': {"hostname": "xxx.xxx.x.x", 'device_id': 123,
"power_configuration": {"enable_power_cap": True, "power_cap": 3424}
}},
{"json_data": {"value": [
{'Id': 1234, 'PublicAddress': "xxx.xxx.x.x",
'DeviceId': 1234, "Type": 1000},
{'PublicAddress': "X.X.X.X", 'DeviceId': 1235, "Type": 1000}]},
'message': CONFIG_FAIL_MSG,
'mparams': {"hostname": "xxx.xxx.x.x", "device_id": 123}}
])
def test_ome_devices_power_settings_failure(self, params, ome_conn_mock_power, ome_response_mock,
ome_default_args, module_mock, mocker):
ome_response_mock.success = params.get("success", True)
ome_response_mock.json_data = params['json_data']
mocks = ["check_domain_service", 'get_chassis_device']
for m in mocks:
if m in params:
mocker.patch(MODULE_PATH + m, return_value=params.get(m, {}))
if 'http_error_json' in params:
json_str = to_text(json.dumps(params.get('http_error_json', {})))
ome_conn_mock_power.invoke_request.side_effect = HTTPError(
'https://testhost.com', params.get('http_err_code', 401), 'http error message', {
"accept-type": "application/json"},
StringIO(json_str))
ome_default_args.update(params['mparams'])
result = self._run_module_with_fail_json(ome_default_args)
assert result['msg'] == params['message']
def test_check_domain_service(self, ome_conn_mock_power, ome_default_args):
f_module = self.get_module_mock()
result = self.module.check_domain_service(
f_module, ome_conn_mock_power)
assert result is None
def test_get_chassis_device(self, ome_conn_mock_power, ome_default_args, mocker, ome_response_mock):
mocker.patch(MODULE_PATH + "get_ip_from_host",
return_value="X.X.X.X")
ome_response_mock.json_data = {"value": [{"DeviceId": 25011, "DomainRoleTypeValue": "LEAD",
"PublicAddress": ["XX.XX.XX.XX"]},
{"DeviceId": 25012, "DomainRoleTypeValue": "STANDALONE",
"PublicAddress": ["YY.YY.YY.YY"]}]}
param = {"device_id": 25012, "hostname": "Y.Y.Y.Y",
"power_configuration": {"enable_power_cap": True, "power_cap": 3424}}
f_module = self.get_module_mock(params=param)
with pytest.raises(Exception) as err:
self.module.get_chassis_device(f_module, ome_conn_mock_power)
assert err.value.args[0] == "Failed to fetch the device information."
def test_check_mode_validation(self, ome_conn_mock_power, ome_default_args, ome_response_mock):
loc_data = {"PowerCap": "3424", "MinPowerCap": "3291", "MaxPowerCap": "3424",
"RedundancyPolicy": "NO_REDUNDANCY", "EnablePowerCapSettings": True,
"EnableHotSpare": True, "PrimaryGrid": "GRID_1", "PowerBudgetOverride": False}
param = {"power_configuration": {
"enable_power_cap": True, "power_cap": 3424}}
f_module = self.get_module_mock(params=param)
with pytest.raises(Exception) as err:
self.module.check_mode_validation(f_module, loc_data)
param = {"hot_spare_configuration": {"enable_hot_spare": False}}
f_module = self.get_module_mock(params=param)
f_module.check_mode = True
with pytest.raises(Exception) as err:
self.module.check_mode_validation(f_module, loc_data)
assert err.value.args[0] == "Changes found to be applied."
param = {"redundancy_configuration": {
"redundancy_policy": "NO_REDUNDANCY"}}
f_module = self.get_module_mock(params=param)
f_module.check_mode = True
with pytest.raises(Exception) as err:
self.module.check_mode_validation(f_module, loc_data)
assert err.value.args[0] == "No changes found to be applied."
def test_fetch_device_details(self, ome_conn_mock_power, ome_default_args, ome_response_mock):
param = {"device_id": 25012, "hostname": "Y.Y.Y.Y",
"power_configuration": {"enable_power_cap": True, "power_cap": 3424}}
f_module = self.get_module_mock(params=param)
ome_response_mock.status_code = 200
ome_response_mock.success = True
ome_response_mock.json_data = {"value": [], "PowerCap": "3424", "MinPowerCap": "3291",
"MaxPowerCap": "3424", "RedundancyPolicy": "NO_REDUNDANCY",
"EnablePowerCapSettings": True, "EnableHotSpare": True,
"PrimaryGrid": "GRID_1", "PowerBudgetOverride": False}
with pytest.raises(Exception) as err:
self.module.fetch_device_details(f_module, ome_conn_mock_power)
assert err.value.args[0] == "Unable to complete the operation because the entered target " \
"device id '25012' is invalid."
def test_get_ip_from_host(self, ome_conn_mock_power, ome_default_args, ome_response_mock):
result = self.module.get_ip_from_host("ZZ.ZZ.ZZ.ZZ")
assert result == "ZZ.ZZ.ZZ.ZZ"
@pytest.mark.parametrize("exc_type_ps",
[IOError, ValueError, SSLError, TypeError, ConnectionError, HTTPError, URLError])
def test_ome_device_power_main_exception_case(self, exc_type_ps, mocker, ome_default_args,
ome_conn_mock_power, ome_response_mock):
ome_default_args.update({"device_id": 25011, "power_configuration": {"enable_power_cap": True,
"power_cap": 3424}})
ome_response_mock.status_code = 400
ome_response_mock.success = False
json_str = to_text(json.dumps({"info": "error_details"}))
if exc_type_ps == URLError:
mocker.patch(MODULE_PATH + 'check_domain_service',
side_effect=exc_type_ps("url open error"))
result_ps = self._run_module(ome_default_args)
assert result_ps["unreachable"] is True
elif exc_type_ps not in [HTTPError, SSLValidationError]:
mocker.patch(MODULE_PATH + 'check_domain_service',
side_effect=exc_type_ps("exception message"))
result_ps = self._run_module_with_fail_json(ome_default_args)
assert result_ps['failed'] is True
else:
mocker.patch(MODULE_PATH + 'check_domain_service',
side_effect=exc_type_ps('https://testhost.com', 400, 'http error message',
{"accept-type": "application/json"}, StringIO(json_str)))
result_ps = self._run_module_with_fail_json(ome_default_args)
assert result_ps['failed'] is True
assert 'msg' in result_ps
|
