Debian Codegraph @

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

raw
1 # (c) 2018-2026, NetApp, Inc
2 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
3
4 ''' unit tests ONTAP Ansible module: na_ontap_quotas '''
5 from __future__ import (absolute_import, division, print_function)
6
7 __metaclass__ = type
8 import pytest
9
10 from ansible_collections.netapp.ontap.tests.unit.compat.mock import patch
11 import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils
12 # pylint: disable=unused-import
13 from ansible_collections.netapp.ontap.tests.unit.plugins.module_utils.ansible_mocks import patch_ansible, \
14 call_main, create_module, create_and_apply, expect_and_capture_ansible_exception, assert_warning_was_raised, print_warnings
15 from ansible_collections.netapp.ontap.tests.unit.framework.mock_rest_and_zapi_requests import patch_request_and_invoke, \
16 register_responses
17 from ansible_collections.netapp.ontap.tests.unit.framework.rest_factory import rest_responses
18 from ansible_collections.netapp.ontap.tests.unit.framework.zapi_factory import build_zapi_response, zapi_responses
19
20 from ansible_collections.netapp.ontap.plugins.modules.na_ontap_qtree \
21 import NetAppOntapQTree as qtree_module, main as my_main # module under test
22
23 # if not netapp_utils.has_netapp_lib():
24 # pytestmark = pytest.mark.skip('skipping as missing required netapp_lib')
25
26
27 DEFAULT_ARGS = {
28 'state': 'present',
29 'hostname': 'hostname',
30 'username': 'username',
31 'password': 'password',
32 'name': 'ansible',
33 'vserver': 'ansible',
34 'flexvol_name': 'ansible',
35 'export_policy': 'ansible',
36 'security_style': 'unix',
37 'unix_permissions': '755',
38 'use_rest': 'never'
39 }
40
41
42 qtree_info = {
43 'num-records': 1,
44 'attributes-list': {
45 'qtree-info': {
46 'export-policy': 'ansible',
47 'vserver': 'ansible',
48 'qtree': 'ansible',
49 'oplocks': 'enabled',
50 'security-style': 'unix',
51 'mode': '755',
52 'volume': 'ansible'
53 }
54 }
55 }
56
57
58 ZRR = zapi_responses({
59 'qtree_info': build_zapi_response(qtree_info)
60 })
61
62
63 # REST API canned responses when mocking send_request
64 SRR = rest_responses({
65 'qtree_record': (200, {"records": [{
66 "svm": {"name": "ansible"},
67 "id": 1,
68 "name": "ansible",
69 "security_style": "unix",
70 "unix_permissions": 755,
71 "export_policy": {"name": "ansible"},
72 "volume": {"uuid": "uuid", "name": "volume1"}}
73 ]}, None),
74 'job_info': (200, {
75 "job": {
76 "uuid": "d78811c1-aebc-11ec-b4de-005056b30cfa",
77 "_links": {"self": {"href": "/api/cluster/jobs/d78811c1-aebc-11ec-b4de-005056b30cfa"}}
78 }}, None),
79 'job_not_found': (404, "", {"message": "entry doesn't exist", "code": "4", "target": "uuid"}),
80 'process_running_error': (400, None, "calling: storage/qtrees/1: got job reported error: Timeout error: Process still running, \
81 received {'job': {'uuid': 'd708b0a5-d197-11ee-9138-d039ea45654b', '_links': {'self': {'href': \
82 '/api/cluster/jobs/d708b0a5-d197-11ee-9138-d039ea45654b'}}}}.."),
83 })
84
85
86 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
87 def test_module_fail_when_required_args_missing():
88 ''' required arguments are reported as errors '''
89 # with python 2.6, dictionaries are not ordered
90 fragments = ["missing required arguments:", "hostname", "name", "vserver", "flexvol_name"]
91 error = create_module(qtree_module, {}, fail=True)['msg']
92 for fragment in fragments:
93 assert fragment in error
94
95
96 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
97 def test_ensure_get_called():
98 ''' test get_qtree for non-existent qtree'''
99 register_responses([
100 ('qtree-list-iter', ZRR['empty'])
101 ])
102 my_obj = create_module(qtree_module, DEFAULT_ARGS)
103 portset = my_obj.get_qtree()
104 assert portset is None
105
106
107 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
108 def test_ensure_get_called_existing():
109 ''' test get_qtree for existing qtree'''
110 register_responses([
111 ('qtree-list-iter', ZRR['qtree_info'])
112 ])
113 my_obj = create_module(qtree_module, DEFAULT_ARGS)
114 assert my_obj.get_qtree()
115
116
117 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
118 def test_successful_create():
119 ''' creating qtree '''
120 register_responses([
121 ('qtree-list-iter', ZRR['empty']),
122 ('qtree-create', ZRR['success'])
123 ])
124 module_args = {
125 'oplocks': 'enabled'
126 }
127 assert create_and_apply(qtree_module, DEFAULT_ARGS, module_args)['changed']
128
129
130 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
131 def test_successful_delete():
132 ''' deleting qtree '''
133 register_responses([
134 ('qtree-list-iter', ZRR['qtree_info']),
135 ('qtree-delete', ZRR['success'])
136 ])
137 args = {'state': 'absent'}
138 assert create_and_apply(qtree_module, DEFAULT_ARGS, args)['changed']
139
140
141 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
142 def test_successful_delete_idempotency():
143 ''' deleting qtree idempotency '''
144 register_responses([
145 ('qtree-list-iter', ZRR['empty'])
146 ])
147 args = {'state': 'absent'}
148 assert create_and_apply(qtree_module, DEFAULT_ARGS, args)['changed'] is False
149
150
151 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
152 def test_successful_modify():
153 ''' modifying qtree '''
154 register_responses([
155 ('qtree-list-iter', ZRR['qtree_info']),
156 ('qtree-modify', ZRR['success'])
157 ])
158 args = {
159 'export_policy': 'test',
160 'oplocks': 'enabled'
161 }
162 assert create_and_apply(qtree_module, DEFAULT_ARGS, args)['changed']
163
164
165 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
166 def test_failed_rename():
167 ''' test error rename qtree '''
168 register_responses([
169 ('qtree-list-iter', ZRR['empty']),
170 ('qtree-list-iter', ZRR['empty'])
171 ])
172 args = {'from_name': 'test'}
173 error = 'Error renaming: qtree %s does not exist' % args['from_name']
174 assert error in create_and_apply(qtree_module, DEFAULT_ARGS, args, fail=True)['msg']
175
176
177 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
178 def test_successful_rename():
179 ''' rename qtree '''
180 register_responses([
181 ('qtree-list-iter', ZRR['empty']),
182 ('qtree-list-iter', ZRR['qtree_info']),
183 ('qtree-rename', ZRR['success'])
184 ])
185 args = {'from_name': 'ansible_old'}
186 assert create_and_apply(qtree_module, DEFAULT_ARGS, args)['changed']
187
188
189 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
190 def test_if_all_methods_catch_exception():
191 ''' test error zapi - get/create/rename/modify/delete'''
192 register_responses([
193 ('qtree-list-iter', ZRR['error']),
194 ('qtree-create', ZRR['error']),
195 ('qtree-rename', ZRR['error']),
196 ('qtree-modify', ZRR['error']),
197 ('qtree-delete', ZRR['error'])
198 ])
199 qtree_obj = create_module(qtree_module, DEFAULT_ARGS, {'from_name': 'name'})
200
201 assert 'Error fetching qtree' in expect_and_capture_ansible_exception(qtree_obj.get_qtree, 'fail')['msg']
202 assert 'Error creating qtree' in expect_and_capture_ansible_exception(qtree_obj.create_qtree, 'fail')['msg']
203 assert 'Error renaming qtree' in expect_and_capture_ansible_exception(qtree_obj.rename_qtree, 'fail')['msg']
204 assert 'Error modifying qtree' in expect_and_capture_ansible_exception(qtree_obj.modify_qtree, 'fail')['msg']
205 assert 'Error deleting qtree' in expect_and_capture_ansible_exception(qtree_obj.delete_qtree, 'fail')['msg']
206
207
208 def test_get_error_rest():
209 ''' test get qtree error in rest'''
210 register_responses([
211 ('GET', 'cluster', SRR['is_rest_9_9_1']),
212 ('GET', 'storage/qtrees', SRR['generic_error'])
213 ])
214 error = 'Error fetching qtree'
215 assert error in create_and_apply(qtree_module, DEFAULT_ARGS, {'use_rest': 'always'}, 'fail')['msg']
216
217
218 def test_create_error_rest():
219 ''' test get qtree error in rest'''
220 register_responses([
221 ('GET', 'cluster', SRR['is_rest_9_9_1']),
222 ('GET', 'storage/qtrees', SRR['empty_records']),
223 ('POST', 'storage/qtrees', SRR['generic_error'])
224 ])
225 error = 'Error creating qtree'
226 assert error in create_and_apply(qtree_module, DEFAULT_ARGS, {'use_rest': 'always'}, 'fail')['msg']
227
228
229 def test_modify_error_rest():
230 ''' test get qtree error in rest'''
231 register_responses([
232 ('GET', 'cluster', SRR['is_rest_9_9_1']),
233 ('GET', 'storage/qtrees', SRR['qtree_record']),
234 ('PATCH', 'storage/qtrees/uuid/1', SRR['generic_error'])
235 ])
236 args = {'use_rest': 'always', 'unix_permissions': '777'}
237 error = 'Error modifying qtree'
238 assert error in create_and_apply(qtree_module, DEFAULT_ARGS, args, 'fail')['msg']
239
240
241 def test_rename_error_rest():
242 ''' test get qtree error in rest'''
243 register_responses([
244 ('GET', 'cluster', SRR['is_rest_9_9_1']),
245 ('GET', 'storage/qtrees', SRR['empty_records']),
246 ('GET', 'storage/qtrees', SRR['empty_records'])
247 ])
248 args = {'use_rest': 'always', 'from_name': 'abcde', 'name': 'qtree'}
249 error = 'Error renaming: qtree'
250 assert error in create_and_apply(qtree_module, DEFAULT_ARGS, args, 'fail')['msg']
251
252
253 def test_delete_error_rest():
254 ''' test get qtree error in rest'''
255 register_responses([
256 ('GET', 'cluster', SRR['is_rest_9_9_1']),
257 ('GET', 'storage/qtrees', SRR['qtree_record']),
258 ('DELETE', 'storage/qtrees/uuid/1', SRR['generic_error'])
259 ])
260 args = {'use_rest': 'always', 'state': 'absent'}
261 error = 'Error deleting qtree'
262 assert error in create_and_apply(qtree_module, DEFAULT_ARGS, args, 'fail')['msg']
263
264
265 def test_successful_create_rest():
266 ''' test create qtree rest '''
267 register_responses([
268 ('GET', 'cluster', SRR['is_rest_9_9_1']),
269 ('GET', 'storage/qtrees', SRR['empty_records']),
270 ('POST', 'storage/qtrees', SRR['success'])
271 ])
272 assert create_and_apply(qtree_module, DEFAULT_ARGS, {'use_rest': 'always'})['changed']
273
274
275 def test_idempotent_create_rest():
276 ''' test create qtree idempotency '''
277 register_responses([
278 ('GET', 'cluster', SRR['is_rest_9_9_1']),
279 ('GET', 'storage/qtrees', SRR['qtree_record'])
280 ])
281 assert create_and_apply(qtree_module, DEFAULT_ARGS, {'use_rest': 'always'})['changed'] is False
282
283
284 @patch('time.sleep')
285 def test_successful_create_rest_job_error(sleep):
286 ''' test create qtree rest '''
287 register_responses([
288 ('GET', 'cluster', SRR['is_rest_9_9_1']),
289 ('GET', 'storage/qtrees', SRR['empty_records']),
290 ('POST', 'storage/qtrees', SRR['job_info']),
291 ('GET', 'cluster/jobs/d78811c1-aebc-11ec-b4de-005056b30cfa', SRR['job_not_found']),
292 ('GET', 'cluster/jobs/d78811c1-aebc-11ec-b4de-005056b30cfa', SRR['job_not_found']),
293 ('GET', 'cluster/jobs/d78811c1-aebc-11ec-b4de-005056b30cfa', SRR['job_not_found']),
294 ('GET', 'cluster/jobs/d78811c1-aebc-11ec-b4de-005056b30cfa', SRR['job_not_found'])
295 ])
296 assert create_and_apply(qtree_module, DEFAULT_ARGS, {'use_rest': 'always'})['changed']
297 print_warnings()
298 assert_warning_was_raised('Ignoring job status, assuming success.')
299
300
301 def test_successful_delete_rest():
302 ''' test delete qtree rest '''
303 register_responses([
304 ('GET', 'cluster', SRR['is_rest_9_9_1']),
305 ('GET', 'storage/qtrees', SRR['qtree_record']),
306 ('DELETE', 'storage/qtrees/uuid/1', SRR['success'])
307 ])
308 args = {'use_rest': 'always', 'state': 'absent'}
309 assert create_and_apply(qtree_module, DEFAULT_ARGS, args)['changed']
310
311
312 def test_idempotent_delete_rest():
313 ''' test delete qtree idempotency'''
314 register_responses([
315 ('GET', 'cluster', SRR['is_rest_9_9_1']),
316 ('GET', 'storage/qtrees', SRR['empty_records'])
317 ])
318 args = {'use_rest': 'always', 'state': 'absent'}
319 assert create_and_apply(qtree_module, DEFAULT_ARGS, args)['changed'] is False
320
321
322 def test_successful_delete_rest_job_running_warning():
323 ''' test delete qtree warning in rest'''
324 register_responses([
325 ('GET', 'cluster', SRR['is_rest_9_9_1']),
326 ('GET', 'storage/qtrees', SRR['qtree_record']),
327 ('DELETE', 'storage/qtrees/uuid/1', SRR['process_running_error'])
328 ])
329 args = {'use_rest': 'always', 'state': 'absent', 'wait_for_completion': False}
330 assert create_and_apply(qtree_module, DEFAULT_ARGS, args)['changed']
331 print_warnings()
332 assert_warning_was_raised("Process is still running in the background, exiting with no further waiting as 'wait_for_completion' is set to false.")
333
334
335 def test_successful_modify_rest():
336 ''' test modify qtree rest '''
337 register_responses([
338 ('GET', 'cluster', SRR['is_rest_9_9_1']),
339 ('GET', 'storage/qtrees', SRR['qtree_record']),
340 ('PATCH', 'storage/qtrees/uuid/1', SRR['success'])
341 ])
342 args = {'use_rest': 'always', 'unix_permissions': '777'}
343 assert create_and_apply(qtree_module, DEFAULT_ARGS, args)['changed']
344
345
346 def test_idempotent_modify_rest():
347 ''' test modify qtree idempotency '''
348 register_responses([
349 ('GET', 'cluster', SRR['is_rest_9_9_1']),
350 ('GET', 'storage/qtrees', SRR['qtree_record'])
351 ])
352 args = {'use_rest': 'always'}
353 assert create_and_apply(qtree_module, DEFAULT_ARGS, {'use_rest': 'always'})['changed'] is False
354
355
356 def test_successful_rename_rest():
357 ''' test rename qtree rest '''
358 register_responses([
359 ('GET', 'cluster', SRR['is_rest_9_9_1']),
360 ('GET', 'storage/qtrees', SRR['zero_records']),
361 ('GET', 'storage/qtrees', SRR['qtree_record']),
362 ('PATCH', 'storage/qtrees/uuid/1', SRR['success'])
363 ])
364 args = {'use_rest': 'always', 'from_name': 'abcde', 'name': 'qtree'}
365 assert create_and_apply(qtree_module, DEFAULT_ARGS, args)['changed']
366
367
368 def test_successful_rename_rest_idempotent():
369 ''' test rename qtree in rest - idempotency'''
370 register_responses([
371 ('GET', 'cluster', SRR['is_rest_9_9_1']),
372 ('GET', 'storage/qtrees', SRR['qtree_record'])
373 ])
374 args = {'use_rest': 'always', 'from_name': 'abcde'}
375 assert create_and_apply(qtree_module, DEFAULT_ARGS, args)['changed'] is False
376
377
378 def test_successful_rename_and_modify_rest():
379 ''' test rename and modify qtree rest '''
380 register_responses([
381 ('GET', 'cluster', SRR['is_rest_9_9_1']),
382 ('GET', 'storage/qtrees', SRR['empty_records']),
383 ('GET', 'storage/qtrees', SRR['qtree_record']),
384 ('PATCH', 'storage/qtrees/uuid/1', SRR['success'])
385 ])
386 args = {
387 'use_rest': 'always',
388 'from_name': 'abcde',
389 'name': 'qtree',
390 'unix_permissions': '744',
391 'unix_user': 'user',
392 'unix_group': 'group',
393 }
394 assert call_main(my_main, DEFAULT_ARGS, args)['changed']
395
396
397 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
398 @patch('ansible_collections.netapp.ontap.plugins.module_utils.netapp.has_netapp_lib')
399 def test_missing_netapp_lib(mock_has_netapp_lib):
400 module_args = {
401 'use_rest': 'never'
402 }
403 mock_has_netapp_lib.return_value = False
404 error = 'Error: the python NetApp-Lib module is required. Import error: None'
405 assert error == call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
406
407
408 def test_force_delete_error():
409 register_responses([
410 ('GET', 'cluster', SRR['is_rest_9_9_1']),
411 ('GET', 'storage/qtrees', SRR['qtree_record']),
412 ])
413 module_args = {
414 'use_rest': 'always',
415 'force_delete': False,
416 'state': 'absent'
417 }
418 error = 'Error: force_delete option is not supported for REST, unless set to true.'
419 assert error == call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
420
421
422 def test_rename_qtree_not_used_with_rest():
423 register_responses([
424 ('GET', 'cluster', SRR['is_rest_9_9_1']),
425 ])
426 module_args = {
427 'use_rest': 'always',
428 }
429 my_obj = create_module(qtree_module, DEFAULT_ARGS, module_args)
430 error = 'Internal error, use modify with REST'
431 assert error in expect_and_capture_ansible_exception(my_obj.rename_qtree, 'fail')['msg']