Debian Codegraph @

ansible_collections/netapp/ontap/tests/unit/plugins/modules/test_na_ontap_debug.py

raw
1 # (c) 2018-2025, NetApp, Inc
2 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
3
4 ''' unit test for ONTAP debug Ansible module '''
5
6 from __future__ import (absolute_import, division, print_function)
7 __metaclass__ = type
8
9 import copy
10 import pytest
11
12 from ansible_collections.netapp.ontap.tests.unit.compat.mock import patch
13 from ansible_collections.netapp.ontap.plugins.modules.na_ontap_debug \
14 import NetAppONTAPDebug as my_module # module under test
15 import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils
16 # pylint: disable=unused-import
17 from ansible_collections.netapp.ontap.tests.unit.plugins.module_utils.ansible_mocks import \
18 assert_no_warnings, assert_no_warnings_except_zapi, assert_warning_was_raised, call_main, create_and_apply, create_module, \
19 expect_and_capture_ansible_exception, patch_ansible
20 from ansible_collections.netapp.ontap.tests.unit.framework.mock_rest_and_zapi_requests import patch_request_and_invoke, register_responses
21 from ansible_collections.netapp.ontap.tests.unit.framework.rest_factory import rest_responses
22 from ansible_collections.netapp.ontap.tests.unit.framework.zapi_factory import build_zapi_error, zapi_responses
23
24 # not available on 2.6 anymore
25 if not netapp_utils.has_netapp_lib():
26 pytestmark = pytest.mark.skip('skipping as missing required netapp_lib')
27
28 DEFAULT_ARGS = {
29 'hostname': '10.10.10.10',
30 'username': 'admin',
31 'https': 'true',
32 'validate_certs': 'false',
33 'password': 'password',
34 'vserver': 'vserver',
35 }
36
37 # REST API canned responses when mocking send_request
38 SRR = rest_responses({
39 'is_rest_9_8': (200, dict(version=dict(generation=9, major=8, minor=0, full='dummy_9_8_0')), None),
40 'one_record_uuid': (200, dict(records=[dict(uuid='a1b2c3')], num_records=1), None),
41 'one_vserver_record_with_intf': (200, {
42 "records": [{
43 'name': 'vserver1',
44 'ip_interfaces': [
45 dict(services=['management'])],
46 }],
47 'num_records': 1
48 }, None),
49 'one_user_record': (200, {
50 "records": [{
51 'name': 'user1',
52 'applications': [
53 dict(application='http'),
54 dict(application='ontapi'),
55 ],
56 'locked': False,
57 'owner': {'name': 'vserver'}
58 }],
59 'num_records': 1
60 }, None),
61 'one_user_record_admin': (200, {
62 "records": [{
63 'name': 'user1',
64 'applications': [
65 dict(application='http'),
66 dict(application='ontapi'),
67 ],
68 'locked': False,
69 'owner': {'name': 'vserver'},
70 'role': {'name': 'admin'}
71 }],
72 'num_records': 1
73 }, None),
74 'ConnectTimeoutError': (400, None, "Connection timed out"),
75 'Name or service not known': (400, None, "Name or service not known"),
76 'not_authorized': (400, None, "not authorized for that command"),
77 }, allow_override=False)
78
79 ZRR = zapi_responses({
80 'ConnectTimeoutError': build_zapi_error('123', 'ConnectTimeoutError'),
81 'Name or service not known': build_zapi_error('123', 'Name or service not known'),
82 }, allow_override=False)
83
84
85 if netapp_utils.has_netapp_lib():
86 REST_ZAPI_FLOW = [
87 ('system-get-version', ZRR['version']), # get version
88 ('GET', 'cluster', SRR['is_rest_9_8']), # get_version
89 ]
90 else:
91 REST_ZAPI_FLOW = [
92 ('GET', 'cluster', SRR['is_rest_9_8']), # get_version
93 ]
94
95
96 def test_success_no_vserver():
97 ''' test get'''
98 register_responses(REST_ZAPI_FLOW + [
99 ('GET', 'security/accounts', SRR['one_user_record_admin']) # get user
100 ])
101 args = dict(DEFAULT_ARGS)
102 args.pop('vserver')
103 results = create_and_apply(my_module, args)
104 print('Info: %s' % results)
105 assert_warning_was_raised(netapp_utils.ZAPI_DEPRECATION_MESSAGE)
106 assert 'notes' in results
107 assert 'msg' in results
108 assert "NOTE: application console not found for user: user1: ['http', 'ontapi']" in results['notes']
109 assert 'ZAPI connected successfully.' in results['msg']
110
111
112 def test_success_with_vserver():
113 ''' test get'''
114 register_responses(REST_ZAPI_FLOW + [
115 ('GET', 'security/accounts', SRR['one_user_record']), # get user
116 ('GET', 'svm/svms', SRR['one_vserver_record_with_intf']), # get_svms
117 ('GET', 'security/accounts', SRR['one_user_record']) # get_users
118 ])
119
120 results = create_and_apply(my_module, DEFAULT_ARGS)
121 print('Info: %s' % results)
122 # assert results['changed'] is False
123 assert_warning_was_raised(netapp_utils.ZAPI_DEPRECATION_MESSAGE)
124 assert 'notes' not in results
125
126
127 def test_fail_with_vserver_locked():
128 ''' test get'''
129 user = copy.deepcopy(SRR['one_user_record'])
130 user[1]['records'][0]['locked'] = True
131 register_responses(REST_ZAPI_FLOW + [
132 ('GET', 'security/accounts', SRR['one_user_record']), # get user
133 ('GET', 'svm/svms', SRR['one_vserver_record_with_intf']), # get_svms
134 ('GET', 'security/accounts', user) # get_users
135 ])
136
137 results = create_and_apply(my_module, DEFAULT_ARGS, fail=True)
138 print('Info: %s' % results)
139 assert_warning_was_raised(netapp_utils.ZAPI_DEPRECATION_MESSAGE)
140 assert 'notes' in results
141 assert 'user: user1 is locked on vserver: vserver' in results['notes'][0]
142
143
144 def test_fail_with_vserver_missing_app():
145 ''' test get'''
146 user = copy.deepcopy(SRR['one_user_record'])
147 user[1]['records'][0]['applications'] = [dict(application='http')]
148
149 register_responses(REST_ZAPI_FLOW + [
150 ('GET', 'security/accounts', SRR['one_user_record']), # get user
151 ('GET', 'svm/svms', SRR['one_vserver_record_with_intf']), # get_svms
152 ('GET', 'security/accounts', user) # get_users
153 ])
154
155 results = create_and_apply(my_module, DEFAULT_ARGS, fail=True)
156 print('Info: %s' % results)
157 assert_warning_was_raised(netapp_utils.ZAPI_DEPRECATION_MESSAGE)
158 assert 'notes' in results
159 assert 'application ontapi not found for user: user1' in results['notes'][0]
160 assert 'Error: no unlocked user for ontapi on vserver: vserver' in results['msg']
161
162
163 def test_fail_with_vserver_list_user_not_found():
164 ''' test get'''
165 register_responses(REST_ZAPI_FLOW + [
166 ('GET', 'security/accounts', SRR['one_user_record']), # get user
167 ('GET', 'svm/svms', SRR['one_vserver_record_with_intf']), # get_svms
168 ('GET', 'security/accounts', SRR['empty_records']) # get_users
169 ])
170
171 results = create_and_apply(my_module, DEFAULT_ARGS, fail=True)
172 print('Info: %s' % results)
173 assert_warning_was_raised(netapp_utils.ZAPI_DEPRECATION_MESSAGE)
174 assert 'Error getting accounts for: vserver: none found' in results['msg']
175
176
177 def test_fail_with_vserver_list_user_error_on_get_users():
178 ''' test get'''
179 register_responses(REST_ZAPI_FLOW + [
180 ('GET', 'security/accounts', SRR['one_user_record']), # get user
181 ('GET', 'svm/svms', SRR['one_vserver_record_with_intf']), # get_svms
182 ('GET', 'security/accounts', SRR['generic_error']) # get_users
183 ])
184
185 results = create_and_apply(my_module, DEFAULT_ARGS, fail=True)
186 print('Info: %s' % results)
187 assert_warning_was_raised(netapp_utils.ZAPI_DEPRECATION_MESSAGE)
188 assert 'Error getting accounts for: vserver: calling: security/accounts: got Expected error.' in results['msg']
189
190
191 def test_success_with_vserver_list_user_not_authorized():
192 ''' test get'''
193 register_responses(REST_ZAPI_FLOW + [
194 ('GET', 'security/accounts', SRR['one_user_record']), # get user
195 ('GET', 'svm/svms', SRR['one_vserver_record_with_intf']), # get_svms
196 ('GET', 'security/accounts', SRR['not_authorized']) # get_users
197 ])
198
199 results = create_and_apply(my_module, DEFAULT_ARGS)
200 print('Info: %s' % results)
201 assert_warning_was_raised(netapp_utils.ZAPI_DEPRECATION_MESSAGE)
202 assert 'Not autorized to get accounts for: vserver: calling: security/accounts: got not authorized for that command.' in results['msg']
203
204
205 def test_fail_with_vserver_no_interface():
206 ''' test get'''
207 vserver = copy.deepcopy(SRR['one_vserver_record_with_intf'])
208 vserver[1]['records'][0].pop('ip_interfaces')
209 register_responses(REST_ZAPI_FLOW + [
210 ('GET', 'security/accounts', SRR['one_user_record_admin']), # get user
211 ('GET', 'svm/svms', vserver), # get_svms
212 ('GET', 'security/accounts', SRR['one_user_record']) # get_users
213 ])
214
215 results = create_and_apply(my_module, DEFAULT_ARGS, fail=True)
216 print('Info: %s' % results)
217 assert_warning_was_raised(netapp_utils.ZAPI_DEPRECATION_MESSAGE)
218 assert 'notes' in results
219 assert "NOTE: application console not found for user: user1: ['http', 'ontapi']" in results['notes']
220 assert 'Error vserver is not associated with a network interface: vserver' in results['msg']
221
222
223 def test_fail_with_vserver_not_found():
224 ''' test get'''
225 register_responses(REST_ZAPI_FLOW + [
226 ('GET', 'security/accounts', SRR['one_user_record_admin']), # get user
227 ('GET', 'svm/svms', SRR['empty_records']), # get_svms
228 ('GET', 'security/accounts', SRR['one_user_record']) # get_users
229 ])
230
231 results = create_and_apply(my_module, DEFAULT_ARGS, fail=True)
232 print('Info: %s' % results)
233 assert_warning_was_raised(netapp_utils.ZAPI_DEPRECATION_MESSAGE)
234 assert 'notes' in results
235 assert "NOTE: application console not found for user: user1: ['http', 'ontapi']" in results['notes']
236 assert 'Error getting vserver in list_interfaces: vserver: not found' in results['msg']
237
238
239 def test_fail_with_vserver_error_on_get_svms():
240 ''' test get'''
241 register_responses(REST_ZAPI_FLOW + [
242 ('GET', 'security/accounts', SRR['one_user_record_admin']), # get user
243 ('GET', 'svm/svms', SRR['generic_error']), # get_svms
244 ('GET', 'security/accounts', SRR['one_user_record']) # get_users
245 ])
246
247 results = create_and_apply(my_module, DEFAULT_ARGS, fail=True)
248 print('Info: %s' % results)
249 assert_warning_was_raised(netapp_utils.ZAPI_DEPRECATION_MESSAGE)
250 assert 'notes' in results
251 assert "NOTE: application console not found for user: user1: ['http', 'ontapi']" in results['notes']
252 assert 'Error getting vserver in list_interfaces: vserver: calling: svm/svms: got Expected error.' in results['msg']
253
254
255 def test_note_with_vserver_no_management_service():
256 ''' test get'''
257 vserver = copy.deepcopy(SRR['one_vserver_record_with_intf'])
258 vserver[1]['records'][0]['ip_interfaces'][0]['services'] = ['data_core']
259 register_responses(REST_ZAPI_FLOW + [
260 ('GET', 'security/accounts', SRR['one_user_record_admin']), # get user
261 ('GET', 'svm/svms', vserver), # get_svms
262 ('GET', 'security/accounts', SRR['one_user_record']) # get_users
263 ])
264
265 results = create_and_apply(my_module, DEFAULT_ARGS)
266 print('Info: %s' % results)
267 assert_warning_was_raised(netapp_utils.ZAPI_DEPRECATION_MESSAGE)
268 assert 'notes' in results
269 assert 'no management policy in services' in results['notes'][2]
270
271
272 def test_fail_zapi_error():
273 ''' test get'''
274 register_responses([
275 ('system-get-version', ZRR['error']),
276 ('GET', 'cluster', SRR['is_rest_9_8']), # get_version
277 ('GET', 'security/accounts', SRR['one_user_record']), # get_user
278 ('GET', 'svm/svms', SRR['one_vserver_record_with_intf']), # get_vservers
279 ('GET', 'security/accounts', SRR['one_user_record']), # get_users
280 ('system-get-version', ZRR['ConnectTimeoutError']),
281 ('GET', 'cluster', SRR['is_rest_9_8']), # get_version
282 ('GET', 'security/accounts', SRR['one_user_record']), # get_user
283 ('GET', 'svm/svms', SRR['one_vserver_record_with_intf']), # get_vservers
284 ('GET', 'security/accounts', SRR['one_user_record']), # get_users
285 ('system-get-version', ZRR['Name or service not known']),
286 ('GET', 'cluster', SRR['is_rest_9_8']), # get_version
287 ('GET', 'security/accounts', SRR['one_user_record']), # get_user
288 ('GET', 'svm/svms', SRR['one_vserver_record_with_intf']), # get_vservers
289 ('GET', 'security/accounts', SRR['one_user_record']) # get_users
290 ])
291 results = create_and_apply(my_module, DEFAULT_ARGS, fail=True)
292 print('Info: %s' % results)
293 assert_warning_was_raised(netapp_utils.ZAPI_DEPRECATION_MESSAGE)
294 assert 'notes' not in results
295 assert 'Unclassified, see msg' in results['msg']
296 results = create_and_apply(my_module, DEFAULT_ARGS, fail=True)
297 assert 'Error in hostname - Address does not exist or is not reachable: NetApp API failed. Reason - 123:ConnectTimeoutError' in results['msg']
298 results = create_and_apply(my_module, DEFAULT_ARGS, fail=True)
299 assert 'Error in hostname - DNS name cannot be resolved: NetApp API failed. Reason - 123:Name or service not known' in results['msg']
300
301
302 def test_fail_rest_error():
303 ''' test get'''
304 register_responses([
305 ('system-get-version', ZRR['version']),
306 ('GET', 'cluster', SRR['is_zapi']), # get_version
307 ('system-get-version', ZRR['version']),
308 ('GET', 'cluster', SRR['ConnectTimeoutError']), # get_version
309 ('system-get-version', ZRR['version']),
310 ('GET', 'cluster', SRR['Name or service not known']), # get_version
311 ])
312 results = create_and_apply(my_module, DEFAULT_ARGS, fail=True)
313 print('Info: %s' % results)
314 assert_warning_was_raised(netapp_utils.ZAPI_DEPRECATION_MESSAGE)
315 assert 'notes' not in results
316 assert 'Other error for hostname: 10.10.10.10 using REST: Unreachable.' in results['msg']
317 results = create_and_apply(my_module, DEFAULT_ARGS, fail=True)
318 assert 'Error in hostname - Address does not exist or is not reachable: Connection timed out' in results['msg']
319 results = create_and_apply(my_module, DEFAULT_ARGS, fail=True)
320 assert 'Error in hostname - DNS name cannot be resolved: Name or service not known' in results['msg']
321
322
323 @patch('ansible_collections.netapp.ontap.plugins.module_utils.netapp.has_netapp_lib')
324 def test_fail_netapp_lib_error(mock_has_netapp_lib):
325 ''' test get'''
326 register_responses([
327 ('GET', 'cluster', SRR['is_rest_9_8']), # get_version
328 ('GET', 'security/accounts', SRR['one_user_record']), # get_user
329 ('GET', 'svm/svms', SRR['one_vserver_record_with_intf']), # get_vservers
330 ('GET', 'security/accounts', SRR['one_user_record']) # get_users
331 ])
332
333 mock_has_netapp_lib.return_value = False
334
335 results = create_and_apply(my_module, DEFAULT_ARGS, fail=True)
336 print('Info: %s' % results)
337 assert_no_warnings_except_zapi()
338 assert 'notes' not in results
339 assert 'Install the python netapp-lib module or a missing dependency' in results['msg'][0]
340
341
342 def test_check_connection_internal_error():
343 ''' expecting REST or ZAPI '''
344 error = 'Internal error, unexpected connection type: rest'
345 assert error == expect_and_capture_ansible_exception(create_module(my_module, DEFAULT_ARGS).check_connection, 'fail', 'rest')['msg']