Debian Codegraph @

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

raw
1 # (c) 2018-2023, 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 template for ONTAP Ansible module '''
5
6 from __future__ import (absolute_import, division, print_function)
7 __metaclass__ = type
8 import copy
9 import pytest
10 import sys
11
12 from ansible_collections.netapp.ontap.tests.unit.compat.mock import patch
13 import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils
14 # pylint: disable=unused-import
15 from ansible_collections.netapp.ontap.tests.unit.plugins.module_utils.ansible_mocks import assert_no_warnings, \
16 assert_warning_was_raised, print_warnings, call_main, create_module, expect_and_capture_ansible_exception, patch_ansible
17 from ansible_collections.netapp.ontap.tests.unit.framework.mock_rest_and_zapi_requests import\
18 patch_request_and_invoke, register_responses
19 from ansible_collections.netapp.ontap.tests.unit.framework.rest_factory import rest_error_message, rest_responses
20 from ansible_collections.netapp.ontap.tests.unit.framework.zapi_factory import build_zapi_error, build_zapi_response, zapi_responses
21 from ansible_collections.netapp.ontap.plugins.modules.na_ontap_interface \
22 import NetAppOntapInterface as interface_module, main as my_main
23
24
25 if not netapp_utils.HAS_REQUESTS and sys.version_info < (2, 7):
26 pytestmark = pytest.mark.skip('Skipping Unit Tests on 2.6 as requests is not be available')
27
28
29 def interface_info(dns=True, address='2.2.2.2', netmask='1.1.1.1'):
30 info = {
31 'attributes-list': {
32 'net-interface-info': {
33 'interface-name': 'abc_if',
34 'administrative-status': 'up',
35 'failover-group': 'failover_group',
36 'failover-policy': 'up',
37 'firewall-policy': 'up',
38 'is-auto-revert': 'true',
39 'home-node': 'node',
40 'current-node': 'node',
41 'home-port': 'e0c',
42 'current-port': 'e0c',
43 'address': address,
44 'netmask': netmask,
45 'role': 'data',
46 'listen-for-dns-query': 'true',
47 'is-dns-update-enabled': 'true',
48 'is-ipv4-link-local': 'false',
49 'service-policy': 'service_policy',
50 }
51 }
52 }
53 if dns:
54 info['attributes-list']['net-interface-info']['dns-domain-name'] = 'test.com'
55 return info
56
57
58 node_info = {
59 'attributes-list': {
60 'cluster-node-info': {
61 'node-name': 'node_1',
62 }
63 }
64 }
65
66
67 ZRR = zapi_responses({
68 'interface_info': build_zapi_response(interface_info(), 1),
69 'interface_ipv4': build_zapi_response(interface_info(address='10.10.10.13', netmask='255.255.255.0'), 1),
70 'interface_info_no_dns': build_zapi_response(interface_info(dns=False), 1),
71 'node_info': build_zapi_response(node_info, 1),
72 'error_17': build_zapi_error(17, 'A LIF with the same name already exists'),
73 'error_13003': build_zapi_error(13003, 'ZAPI is not enabled in pre-cluster mode.'),
74 })
75
76
77 DEFAULT_ARGS = {
78 'hostname': '10.10.10.10',
79 'username': 'admin',
80 'password': 'password',
81 'home_port': 'e0c',
82 'interface_name': 'abc_if',
83 }
84
85
86 def test_module_fail_when_required_args_missing():
87 ''' required arguments are reported as errors '''
88 module_args = {
89 'vserver': 'vserver',
90 'use_rest': 'never'
91 }
92 error = create_module(interface_module, module_args, fail=True)['msg']
93 assert 'missing required arguments:' in error
94 assert 'interface_name' in error
95
96
97 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
98 def test_create_error_missing_param():
99 ''' Test successful create '''
100 register_responses([
101 ('ZAPI', 'net-interface-get-iter', ZRR['no_records']),
102 ])
103 module_args = {
104 'vserver': 'vserver',
105 'home_node': 'node',
106 'use_rest': 'never'
107 }
108 msg = 'Error: Missing one or more required parameters for creating interface:'
109 error = call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
110 assert msg in error
111 assert 'role' in error
112
113
114 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
115 def test_successful_create():
116 ''' Test successful create '''
117 register_responses([
118 ('ZAPI', 'net-interface-get-iter', ZRR['no_records']),
119 ('ZAPI', 'net-interface-create', ZRR['success'])
120 ])
121 module_args = {
122 'use_rest': 'never',
123 'vserver': 'vserver',
124 'home_node': 'node',
125 'role': 'data',
126 # 'subnet_name': 'subnet_name',
127 'address': '10.10.10.13',
128 'netmask': '255.255.255.0',
129 'failover_policy': 'system-defined',
130 'failover_group': 'failover_group',
131 'firewall_policy': 'firewall_policy',
132 'is_auto_revert': True,
133 'admin_status': 'down',
134 'force_subnet_association': True,
135 'dns_domain_name': 'dns_domain_name',
136 'listen_for_dns_query': True,
137 'is_dns_update_enabled': True,
138 # 'is_ipv4_link_local': False,
139 'service_policy': 'service_policy'
140 }
141 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
142
143
144 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
145 def test_modify_ip_subnet_cidr_mask():
146 ''' Test successful modify ip/subnet mask '''
147 register_responses([
148 ('ZAPI', 'net-interface-get-iter', ZRR['interface_info']),
149 ('ZAPI', 'net-interface-modify', ZRR['success']),
150 ('ZAPI', 'net-interface-get-iter', ZRR['interface_ipv4']),
151 ])
152 module_args = {
153 'use_rest': 'never',
154 'vserver': 'vserver',
155 'home_node': 'node',
156 'role': 'data',
157 'address': '10.10.10.13',
158 'netmask': '24'
159 }
160 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
161 assert not call_main(my_main, DEFAULT_ARGS, module_args)['changed']
162
163
164 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
165 def test_successful_create_for_NVMe():
166 ''' Test successful create for NVMe protocol'''
167 register_responses([
168 ('ZAPI', 'net-interface-get-iter', ZRR['no_records']),
169 ('ZAPI', 'cluster-node-get-iter', ZRR['node_info']),
170 ('ZAPI', 'net-interface-create', ZRR['success']),
171 ])
172 module_args = {
173 'vserver': 'vserver',
174 # 'home_node': 'node',
175 'role': 'data',
176 'protocols': ['fc-nvme'],
177 'subnet_name': 'subnet_name',
178 'use_rest': 'never'
179 }
180 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
181
182
183 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
184 def test_create_idempotency_for_NVMe():
185 ''' Test successful create for NVMe protocol'''
186 register_responses([
187 ('ZAPI', 'net-interface-get-iter', ZRR['interface_info']),
188 ])
189 module_args = {
190 'vserver': 'vserver',
191 'home_node': 'node',
192 'role': 'data',
193 'protocols': ['fc-nvme'],
194 'use_rest': 'never'
195 }
196 assert not call_main(my_main, DEFAULT_ARGS, module_args)['changed']
197
198
199 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
200 def test_create_error_for_NVMe():
201 ''' Test if create throws an error if required param 'protocols' uses NVMe'''
202 register_responses([
203 ('ZAPI', 'net-interface-get-iter', ZRR['no_records']),
204 ])
205 msg = 'Error: Following parameters for creating interface are not supported for data-protocol fc-nvme:'
206 module_args = {
207 'vserver': 'vserver',
208 'protocols': ['fc-nvme'],
209 'address': '1.1.1.1',
210 'use_rest': 'never'
211 }
212 error = call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
213 assert msg in error
214 for option in ('netmask', 'address', 'firewall_policy'):
215 assert option in error
216
217
218 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
219 def test_create_idempotency():
220 ''' Test create idempotency, and ignore EMS logging error '''
221 register_responses([
222 ('ZAPI', 'net-interface-get-iter', ZRR['interface_info']),
223 ])
224 module_args = {
225 'vserver': 'vserver',
226 'use_rest': 'never'
227 }
228 assert not call_main(my_main, DEFAULT_ARGS, module_args)['changed']
229
230
231 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
232 def test_successful_delete():
233 ''' Test delete existing interface, and ignore EMS logging error '''
234 register_responses([
235 ('ZAPI', 'net-interface-get-iter', ZRR['interface_info_no_dns']),
236 ('ZAPI', 'net-interface-modify', ZRR['success']), # offline
237 ('ZAPI', 'net-interface-delete', ZRR['success']),
238 ])
239 module_args = {
240 'state': 'absent',
241 'vserver': 'vserver',
242 'use_rest': 'never'
243 }
244 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
245
246
247 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
248 def test_delete_idempotency():
249 ''' Test delete idempotency '''
250 register_responses([
251 ('ZAPI', 'net-interface-get-iter', ZRR['no_records']),
252 ])
253 module_args = {
254 'state': 'absent',
255 'vserver': 'vserver',
256 'use_rest': 'never'
257 }
258 assert not call_main(my_main, DEFAULT_ARGS, module_args)['changed']
259
260
261 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
262 def test_successful_modify():
263 ''' Test successful modify interface_minutes '''
264 register_responses([
265 ('ZAPI', 'net-interface-get-iter', ZRR['interface_info']),
266 ('ZAPI', 'net-interface-modify', ZRR['success']),
267 ])
268 module_args = {
269 'vserver': 'vserver',
270 'dns_domain_name': 'test2.com',
271 'home_port': 'e0d',
272 'is_dns_update_enabled': False,
273 'is_ipv4_link_local': True,
274 'listen_for_dns_query': False,
275 'use_rest': 'never'
276 }
277 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
278
279
280 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
281 def test_modify_idempotency():
282 ''' Test modify idempotency '''
283 register_responses([
284 ('ZAPI', 'net-interface-get-iter', ZRR['interface_info']),
285 ])
286 module_args = {
287 'vserver': 'vserver',
288 'use_rest': 'never'
289 }
290 assert not call_main(my_main, DEFAULT_ARGS, module_args)['changed']
291
292
293 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
294 def test_error_message():
295 register_responses([
296 # create, missing params
297 ('ZAPI', 'net-interface-get-iter', ZRR['no_records']),
298 ('ZAPI', 'cluster-node-get-iter', ZRR['no_records']),
299
300 # create - get home_node error
301 ('ZAPI', 'net-interface-get-iter', ZRR['no_records']),
302 ('ZAPI', 'cluster-node-get-iter', ZRR['error']),
303
304 # create error
305 ('ZAPI', 'net-interface-get-iter', ZRR['no_records']),
306 ('ZAPI', 'cluster-node-get-iter', ZRR['error_13003']),
307 ('ZAPI', 'net-interface-create', ZRR['error']),
308
309 # create error
310 ('ZAPI', 'net-interface-get-iter', ZRR['no_records']),
311 ('ZAPI', 'cluster-node-get-iter', ZRR['no_records']),
312 ('ZAPI', 'net-interface-create', ZRR['error_17']),
313
314 # modify error
315 ('ZAPI', 'net-interface-get-iter', ZRR['interface_info']),
316 ('ZAPI', 'net-interface-modify', ZRR['error']),
317
318 # rename error
319 ('ZAPI', 'net-interface-get-iter', ZRR['no_records']),
320 ('ZAPI', 'net-interface-get-iter', ZRR['interface_info']),
321 ('ZAPI', 'net-interface-rename', ZRR['error']),
322
323 # delete error
324 ('ZAPI', 'net-interface-get-iter', ZRR['interface_info']),
325 ('ZAPI', 'net-interface-modify', ZRR['success']),
326 ('ZAPI', 'net-interface-delete', ZRR['error']),
327
328 # get error
329 ('ZAPI', 'net-interface-get-iter', ZRR['error']),
330 ])
331 module_args = {
332 'vserver': 'vserver',
333 'use_rest': 'never',
334 }
335 msg = 'Error: Missing one or more required parameters for creating interface:'
336 assert msg in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
337 module_args['home_port'] = 'e0d'
338 module_args['role'] = 'data'
339 module_args['address'] = '10.11.12.13'
340 module_args['netmask'] = '255.192.0.0'
341 msg = 'Error fetching node for interface abc_if: NetApp API failed. Reason - 12345:'
342 assert msg in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
343 msg = 'Error Creating interface abc_if: NetApp API failed. Reason - 12345:'
344 assert msg in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
345 # LIF already exists (error 17)
346 assert not call_main(my_main, DEFAULT_ARGS, module_args)['changed']
347 module_args['home_port'] = 'new_port'
348 msg = 'Error modifying interface abc_if: NetApp API failed. Reason - 12345:'
349 assert msg in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
350 module_args['from_name'] = 'old_name'
351 msg = 'Error renaming old_name to abc_if: NetApp API failed. Reason - 12345:'
352 assert msg in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
353 module_args['state'] = 'absent'
354 msg = 'Error deleting interface abc_if: NetApp API failed. Reason - 12345:'
355 assert msg in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
356 msg = 'Error fetching interface details for abc_if: NetApp API failed. Reason - 12345:'
357 assert msg in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
358
359
360 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
361 def test_successful_rename():
362 ''' Test successful '''
363 register_responses([
364 ('ZAPI', 'net-interface-get-iter', ZRR['no_records']),
365 ('ZAPI', 'net-interface-get-iter', ZRR['interface_info']),
366 ('ZAPI', 'net-interface-rename', ZRR['success']),
367 ('ZAPI', 'net-interface-modify', ZRR['success']),
368 ])
369 module_args = {
370 'vserver': 'vserver',
371 'dns_domain_name': 'test2.com',
372 'from_name': 'from_interface_name',
373 'home_port': 'new_port',
374 'is_dns_update_enabled': False,
375 'listen_for_dns_query': False,
376 'use_rest': 'never'
377 }
378 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
379
380
381 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
382 def test_negative_rename_not_found():
383 ''' Test from interface not found '''
384 register_responses([
385 ('ZAPI', 'net-interface-get-iter', ZRR['no_records']),
386 ('ZAPI', 'net-interface-get-iter', ZRR['no_records']),
387 ])
388 msg = 'Error renaming interface abc_if: no interface with from_name from_interface_name.'
389 module_args = {
390 'vserver': 'vserver',
391 'dns_domain_name': 'test2.com',
392 'from_name': 'from_interface_name',
393 'home_port': 'new_port',
394 'is_dns_update_enabled': False,
395 'listen_for_dns_query': False,
396 'use_rest': 'never'
397 }
398 assert msg in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
399
400
401 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
402 def test_successful_migrate():
403 ''' Test successful '''
404 register_responses([
405 ('ZAPI', 'net-interface-get-iter', ZRR['interface_info']),
406 ('ZAPI', 'net-interface-modify', ZRR['success']),
407 ('ZAPI', 'net-interface-migrate', ZRR['success']),
408 ('ZAPI', 'net-interface-migrate', ZRR['success']),
409 ])
410 module_args = {
411 'vserver': 'vserver',
412 'dns_domain_name': 'test2.com',
413 'current_node': 'new_node',
414 'is_dns_update_enabled': False,
415 'listen_for_dns_query': False,
416 'use_rest': 'never'
417 }
418 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
419
420
421 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
422 def test_negative_migrate():
423 ''' Test successful '''
424 register_responses([
425 ('ZAPI', 'net-interface-get-iter', ZRR['interface_info']),
426 ('ZAPI', 'net-interface-modify', ZRR['success']),
427
428 # 2nd try
429 ('ZAPI', 'net-interface-get-iter', ZRR['interface_info']),
430 ('ZAPI', 'net-interface-modify', ZRR['success']),
431 ('ZAPI', 'net-interface-migrate', ZRR['error']),
432
433 # 3rd try
434 ('ZAPI', 'net-interface-get-iter', ZRR['interface_info']),
435 ('ZAPI', 'net-interface-modify', ZRR['success']),
436 ('ZAPI', 'net-interface-migrate', ZRR['success']),
437 ('ZAPI', 'net-interface-migrate', ZRR['error']),
438 ])
439 module_args = {
440 'vserver': 'vserver',
441 'dns_domain_name': 'test2.com',
442 'current_port': 'new_port',
443 'is_dns_update_enabled': False,
444 'listen_for_dns_query': False,
445 'use_rest': 'never'
446 }
447 msg = 'current_node must be set to migrate'
448 assert msg in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
449 module_args['current_node'] = 'new_node'
450 msg = 'Error migrating new_node: NetApp API failed. Reason - 12345'
451 assert msg in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
452 msg = 'Error migrating new_node: NetApp API failed. Reason - 12345'
453 assert msg in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
454
455
456 SRR = rest_responses({
457 'one_record_home_node': (200, {'records': [
458 {'name': 'node2_abc_if',
459 'uuid': '54321',
460 'enabled': True,
461 'location': {'home_port': {'name': 'e0c'}, 'home_node': {'name': 'node2'}, 'node': {'name': 'node2'}, 'port': {'name': 'e0c'}}
462 }]}, None),
463 'one_record_vserver': (200, {'records': [{
464 'name': 'abc_if',
465 'uuid': '54321',
466 'svm': {'name': 'vserver', 'uuid': 'svm_uuid'},
467 'dns_zone': 'netapp.com',
468 'ddns_enabled': True,
469 'data_protocol': ['nfs'],
470 'enabled': True,
471 'ip': {'address': '10.11.12.13', 'netmask': '10'},
472 'location': {
473 'home_port': {'name': 'e0c'},
474 'home_node': {'name': 'node2'},
475 'node': {'name': 'node2'},
476 'port': {'name': 'e0c'},
477 'auto_revert': True,
478 'failover': True
479 },
480 'service_policy': {'name': 'data-mgmt'},
481 'probe_port': 65431
482 }]}, None),
483 'one_record_vserver_subnet1': (200, {'records': [{
484 'name': 'abc_if',
485 'uuid': '54321',
486 'svm': {'name': 'vserver', 'uuid': 'svm_uuid'},
487 'dns_zone': 'netapp.com',
488 'ddns_enabled': True,
489 'data_protocol': ['nfs'],
490 'enabled': True,
491 'ip': {'address': '10.11.12.13', 'netmask': '10'},
492 'location': {
493 'home_port': {'name': 'e0c'},
494 'home_node': {'name': 'node2'},
495 'node': {'name': 'node2'},
496 'port': {'name': 'e0c'},
497 'auto_revert': True,
498 'failover': True
499 },
500 'service_policy': {'name': 'data-mgmt'},
501 'subnet': {'name': 'subnet1'}
502 }]}, None),
503 'one_record_fcp': (200, {'records': [{
504 'data_protocol': 'fcp',
505 'enabled': False,
506 'location': {
507 'home_node': {'name': 'ontap910-01', 'uuid': 'ecb4061b'},
508 'home_port': {'name': '1a', 'node': {'name': 'ontap910-01'}, 'uuid': '1c9a72de'},
509 'is_home': True,
510 'node': {'name': 'ontap910-01', 'uuid': 'ecb4061b'},
511 'port': {'name': '1a', 'node': {'name': 'ontap910-01'}, 'uuid': '1c9a72de'}
512 },
513 'name': 'abc_if',
514 'svm': {'name': 'svm0_iscsi', 'uuid': 'a59e775d'},
515 'uuid': 'a3935ab5'
516 }]}, None),
517 'two_records': (200, {'records': [{'name': 'node2_abc_if'}, {'name': 'node2_abc_if'}]}, None),
518 'error_precluster': (500, None, {'message': 'are available in precluster.'}),
519 'cluster_identity': (200, {'location': 'Oz', 'name': 'abc'}, None),
520 'nodes': (200, {'records': [
521 {'name': 'node2', 'uuid': 'uuid2', 'cluster_interfaces': [{'ip': {'address': '10.10.10.2'}}]}
522 ]}, None),
523 'nodes_two_records': (200, {'records': [
524 {'name': 'node2', 'uuid': 'uuid2', 'cluster_interfaces': [{'ip': {'address': '10.10.10.2'}}]},
525 {'name': 'node3', 'uuid': 'uuid2', 'cluster_interfaces': [{'ip': {'address': '10.10.10.2'}}]}
526 ]}, None),
527 }, False)
528
529
530 def test_rest_create_ip_no_svm():
531 ''' create cluster '''
532 register_responses([
533 ('GET', 'cluster', SRR['is_rest_97']),
534 ('GET', 'network/ip/interfaces', SRR['zero_records']), # get IP
535 ('GET', 'cluster/nodes', SRR['nodes']), # get nodes
536 ('POST', 'network/ip/interfaces', SRR['success']), # post
537 ])
538 module_args = {
539 'use_rest': 'always',
540 'ipspace': 'cluster',
541 'address': '10.12.12.13',
542 'netmask': '255.255.192.0',
543 }
544 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
545
546
547 def test_rest_create_ip_no_svm_idempotent():
548 ''' create cluster '''
549 register_responses([
550 ('GET', 'cluster', SRR['is_rest_97']),
551 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']), # get IP
552 ('GET', 'cluster/nodes', SRR['nodes']), # get nodes
553 ])
554 module_args = {
555 'use_rest': 'always',
556 'ipspace': 'cluster',
557 'address': '10.12.12.13',
558 'netmask': '255.255.192.0',
559 }
560 assert not call_main(my_main, DEFAULT_ARGS, module_args)['changed']
561
562
563 def test_rest_create_ip_no_svm_idempotent_localhost():
564 ''' create cluster '''
565 register_responses([
566 ('GET', 'cluster', SRR['is_rest_97']),
567 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']), # get IP
568 ('GET', 'cluster/nodes', SRR['nodes']), # get nodes
569 ])
570 module_args = {
571 'use_rest': 'always',
572 'ipspace': 'cluster',
573 'home_node': 'localhost',
574 'address': '10.12.12.13',
575 'netmask': '255.255.192.0',
576 }
577 assert not call_main(my_main, DEFAULT_ARGS, module_args)['changed']
578
579
580 def test_rest_create_ip_with_svm():
581 ''' create cluster '''
582 register_responses([
583 ('GET', 'cluster', SRR['is_rest_97']),
584 ('GET', 'network/ip/interfaces', SRR['zero_records']), # get IP
585 ('GET', 'cluster/nodes', SRR['nodes']), # get nodes
586 ('POST', 'network/ip/interfaces', SRR['success']), # post
587 ])
588 module_args = {
589 'use_rest': 'always',
590 'ipspace': 'cluster',
591 'vserver': 'vserver',
592 'address': '10.12.12.13',
593 'netmask': '255.255.192.0',
594 }
595 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
596
597
598 def test_rest_create_fc_with_svm():
599 ''' create FC interface '''
600 register_responses([
601 ('GET', 'cluster', SRR['is_rest_9_8_0']),
602 ('GET', 'network/fc/interfaces', SRR['zero_records']), # get FC
603 ('POST', 'network/fc/interfaces', SRR['success']), # post
604 ])
605 module_args = {
606 'use_rest': 'always',
607 'vserver': 'vserver',
608 'data_protocol': 'fc_nvme',
609 'home_node': 'my_node',
610 'protocols': 'fc-nvme'
611 }
612 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
613
614
615 def test_rest_create_fc_with_svm_no_home_port():
616 ''' create FC interface '''
617 register_responses([
618 ('GET', 'cluster', SRR['is_rest_97']),
619 ('GET', 'network/fc/interfaces', SRR['zero_records']), # get FC
620 ('GET', 'cluster/nodes', SRR['nodes']), # get nodes
621 ('POST', 'network/fc/interfaces', SRR['success']), # post
622 ])
623 args = dict(DEFAULT_ARGS)
624 module_args = {
625 'use_rest': 'always',
626 'vserver': 'vserver',
627 'data_protocol': 'fc_nvme',
628 'protocols': 'fc-nvme',
629 'current_port': args.pop('home_port'),
630 'current_node': 'my_node',
631 }
632 assert call_main(my_main, args, module_args)['changed']
633
634
635 @patch('time.sleep')
636 def test_rest_create_ip_with_cluster_svm(dont_sleep):
637 ''' create cluster '''
638 register_responses([
639 ('GET', 'cluster', SRR['is_rest_9_10_1']),
640 ('GET', 'network/ip/interfaces', SRR['zero_records']), # get IP
641 ('GET', 'cluster/nodes', SRR['nodes']), # get nodes
642 ('POST', 'network/ip/interfaces', SRR['one_record_vserver']), # post
643 ('PATCH', 'network/ip/interfaces/54321', SRR['one_record_vserver']), # migrate
644 ('GET', 'network/ip/interfaces', SRR['one_record_vserver']), # get IP
645 ])
646 module_args = {
647 'use_rest': 'always',
648 'admin_status': 'up',
649 'current_port': 'e0c',
650 'failover_scope': 'home_node_only',
651 'ipspace': 'cluster',
652 'vserver': 'vserver',
653 'address': '10.12.12.13',
654 'netmask': '255.255.192.0',
655 'role': 'intercluster',
656 'probe_port': 65431,
657 }
658 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
659 print_warnings()
660 assert_warning_was_raised('Ignoring vserver with REST for non data SVM.')
661
662
663 def test_rest_negative_create_ip():
664 ''' create cluster '''
665 register_responses([
666 ('GET', 'cluster', SRR['is_rest_97']),
667 ('GET', 'network/ip/interfaces', SRR['zero_records']), # get IP
668 ('GET', 'cluster/nodes', SRR['zero_records']), # get nodes
669 ])
670 msg = 'Error: Cannot guess home_node, home_node is required when home_port is present with REST.'
671 module_args = {
672 'use_rest': 'always',
673 'ipspace': 'cluster',
674 'address': '10.12.12.13',
675 'netmask': '255.255.192.0',
676 }
677 assert msg in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
678
679
680 def test_rest_negative_create_ip_with_svm_no_home_port():
681 ''' create FC interface '''
682 register_responses([
683 ('GET', 'cluster', SRR['is_rest_97']),
684 ('GET', 'network/ip/interfaces', SRR['zero_records']), # get IP
685 ('GET', 'cluster/nodes', SRR['nodes']), # get nodes
686 # ('POST', 'network/fc/interfaces', SRR['success']), # post
687 ])
688 args = dict(DEFAULT_ARGS)
689 args.pop('home_port')
690 module_args = {
691 'use_rest': 'always',
692 'vserver': 'vserver',
693 'interface_type': 'ip',
694 }
695 error = "Error: At least one of 'broadcast_domain', 'home_port', 'home_node' is required to create an IP interface."
696 assert error in call_main(my_main, args, module_args, fail=True)['msg']
697
698
699 def test_rest_negative_create_no_ip_address():
700 ''' create cluster '''
701 register_responses([
702 ('GET', 'cluster', SRR['is_rest_97']),
703 ('GET', 'network/ip/interfaces', SRR['zero_records']), # get IP
704 ('GET', 'cluster/nodes', SRR['nodes']), # get nodes
705 ])
706 msg = 'Error: Missing one or more required parameters for creating interface: interface_type.'
707 module_args = {
708 'use_rest': 'always',
709 'ipspace': 'cluster',
710 }
711 assert msg in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
712
713
714 def test_rest_get_fc_no_svm():
715 ''' create cluster '''
716 register_responses([
717 ('GET', 'cluster', SRR['is_rest_97']),
718 ('GET', 'cluster/nodes', SRR['nodes']), # get nodes
719 ])
720 module_args = {
721 'use_rest': 'always',
722 'interface_type': 'fc',
723 }
724 msg = "A data 'vserver' is required for FC interfaces."
725 assert msg in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
726
727
728 def test_rest_negative_get_multiple_ip_if():
729 ''' create cluster '''
730 register_responses([
731 ('GET', 'cluster', SRR['is_rest_97']),
732 ('GET', 'network/ip/interfaces', SRR['two_records']), # get IP
733 ('GET', 'cluster/nodes', SRR['nodes']), # get nodes
734 ])
735 msg = 'Error: multiple records for: node2_abc_if'
736 module_args = {
737 'use_rest': 'always',
738 'ipspace': 'cluster',
739 }
740 assert msg in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
741
742
743 def test_rest_negative_get_multiple_fc_if():
744 ''' create cluster '''
745 register_responses([
746 ('GET', 'cluster', SRR['is_rest_97']),
747 ('GET', 'network/ip/interfaces', SRR['zero_records']), # get IP
748 ('GET', 'network/fc/interfaces', SRR['two_records']), # get FC
749 ])
750 msg = 'Error: unexpected records for name: abc_if, vserver: not_cluster'
751 module_args = {
752 'use_rest': 'always',
753 'vserver': 'not_cluster',
754 }
755 assert msg in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
756
757
758 def test_rest_negative_get_multiple_ip_fc_if():
759 ''' create cluster '''
760 register_responses([
761 ('GET', 'cluster', SRR['is_rest_97']),
762 ('GET', 'network/ip/interfaces', SRR['one_record_vserver']), # get IP
763 ('GET', 'network/fc/interfaces', SRR['one_record_vserver']), # get FC
764 ])
765 msg = 'Error fetching interface abc_if - found duplicate entries, please indicate interface_type.'
766 module_args = {
767 'use_rest': 'always',
768 'vserver': 'not_cluster',
769 }
770 assert msg in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
771
772
773 def test_rest_modify_idempotent_ip_no_svm():
774 ''' create cluster '''
775 register_responses([
776 ('GET', 'cluster', SRR['is_rest_97']),
777 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']), # get IP
778 ('GET', 'cluster/nodes', SRR['nodes']), # get nodes
779 ])
780 module_args = {
781 'use_rest': 'always',
782 'ipspace': 'cluster',
783 'address': '10.12.12.13',
784 'netmask': '255.255.192.0',
785 }
786 assert not call_main(my_main, DEFAULT_ARGS, module_args)['changed']
787
788
789 def test_rest_modify_ip_no_svm():
790 ''' create cluster '''
791 register_responses([
792 ('GET', 'cluster', SRR['is_rest_97']),
793 ('GET', 'network/ip/interfaces', SRR['zero_records']), # get IP
794 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']), # get IP
795 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
796 ])
797 module_args = {
798 'use_rest': 'always',
799 'ipspace': 'cluster',
800 'address': '10.12.12.13',
801 'netmask': '255.255.192.0',
802 'home_node': 'node2',
803 'interface_name': 'new_name',
804 'from_name': 'abc_if'
805 }
806 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
807
808
809 def test_rest_modify_ip_svm():
810 ''' create cluster '''
811 register_responses([
812 ('GET', 'cluster', SRR['is_rest_97']),
813 ('GET', 'network/ip/interfaces', SRR['one_record_vserver']), # get IP
814 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
815 ])
816 module_args = {
817 'use_rest': 'always',
818 'vserver': 'vserver',
819 'address': '10.12.12.13',
820 'netmask': '255.255.192.0',
821 'home_node': 'node1',
822 }
823 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
824
825
826 @patch('time.sleep')
827 def test_rest_migrate_ip_no_svm(sleep_mock):
828 ''' create cluster '''
829 modified = copy.deepcopy(SRR['one_record_home_node'])
830 modified[1]['records'][0]['location']['node']['name'] = 'node1'
831 register_responses([
832 ('GET', 'cluster', SRR['is_rest_97']),
833 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']), # get IP
834 ('GET', 'cluster/nodes', SRR['nodes']), # get nodes (for get)
835 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
836 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']), # get - no change
837 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
838 ('GET', 'network/ip/interfaces', modified),
839 ])
840 module_args = {
841 'use_rest': 'always',
842 'ipspace': 'cluster',
843 'address': '10.12.12.13',
844 'netmask': '255.255.192.0',
845 'current_node': 'node1',
846 }
847 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
848
849
850 @patch('time.sleep')
851 def test_rest_migrate_ip_no_svm_port(sleep_mock):
852 ''' create cluster '''
853 modified = copy.deepcopy(SRR['one_record_home_node'])
854 modified[1]['records'][0]['location']['port']['name'] = 'port1'
855 register_responses([
856 ('GET', 'cluster', SRR['is_rest_97']),
857 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']), # get IP
858 ('GET', 'cluster/nodes', SRR['nodes']), # get nodes (for get)
859 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
860 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']), # get - no change
861 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
862 ('GET', 'network/ip/interfaces', modified),
863 ])
864 module_args = {
865 'use_rest': 'always',
866 'ipspace': 'cluster',
867 'address': '10.12.12.13',
868 'netmask': '255.255.192.0',
869 'current_port': 'port1',
870 }
871 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
872
873
874 @patch('time.sleep')
875 def test_rest_migrate_ip_svm(sleep_mock):
876 ''' create cluster '''
877 modified = copy.deepcopy(SRR['one_record_home_node'])
878 modified[1]['records'][0]['location']['node']['name'] = 'node1'
879 register_responses([
880 ('GET', 'cluster', SRR['is_rest_97']),
881 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']), # get IP
882 ('GET', 'cluster/nodes', SRR['nodes']), # get nodes (for get)
883 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
884 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
885 ('GET', 'network/ip/interfaces', SRR['generic_error']),
886 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
887 ('GET', 'network/ip/interfaces', SRR['generic_error']),
888 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
889 ('GET', 'network/ip/interfaces', modified),
890 ])
891 module_args = {
892 'use_rest': 'always',
893 'ipspace': 'cluster',
894 'address': '10.12.12.13',
895 'netmask': '255.255.192.0',
896 'current_node': 'node1',
897 'vserver': 'vserver'
898 }
899 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
900
901
902 @patch('time.sleep')
903 def test_rest_migrate_ip_error(sleep_mock):
904 ''' create cluster '''
905 modified = copy.deepcopy(SRR['one_record_home_node'])
906 modified[1]['records'][0]['location']['node']['name'] = 'node1'
907 register_responses([
908 ('GET', 'cluster', SRR['is_rest_97']),
909 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']), # get IP
910 ('GET', 'cluster/nodes', SRR['nodes']), # get nodes (for get)
911 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
912 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
913 ('GET', 'network/ip/interfaces', SRR['generic_error']),
914 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
915 ('GET', 'network/ip/interfaces', SRR['generic_error']),
916 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
917 ('GET', 'network/ip/interfaces', SRR['generic_error']),
918 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
919 ('GET', 'network/ip/interfaces', SRR['generic_error']),
920 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
921 ('GET', 'network/ip/interfaces', SRR['generic_error']),
922 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
923 ('GET', 'network/ip/interfaces', SRR['generic_error']),
924 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
925 ('GET', 'network/ip/interfaces', SRR['generic_error']),
926 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
927 ('GET', 'network/ip/interfaces', SRR['generic_error']),
928 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
929 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']),
930 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
931 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']),
932 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
933 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']),
934 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
935 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']),
936 ])
937 module_args = {
938 'use_rest': 'always',
939 'ipspace': 'cluster',
940 'address': '10.12.12.13',
941 'netmask': '255.255.192.0',
942 'current_node': 'node1',
943 'vserver': 'vserver'
944 }
945 error = rest_error_message('Errors waiting for migration to complete', 'network/ip/interfaces')
946 assert error in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
947
948
949 @patch('time.sleep')
950 def test_rest_migrate_ip_timeout(sleep_mock):
951 ''' create cluster '''
952 modified = copy.deepcopy(SRR['one_record_home_node'])
953 modified[1]['records'][0]['location']['node']['name'] = 'node1'
954 register_responses([
955 ('GET', 'cluster', SRR['is_rest_97']),
956 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']), # get IP
957 ('GET', 'cluster/nodes', SRR['nodes']), # get nodes (for get)
958 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
959 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
960 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']),
961 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
962 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']),
963 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
964 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']),
965 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
966 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']),
967 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
968 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']),
969 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
970 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']),
971 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
972 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']),
973 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
974 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']),
975 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
976 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']),
977 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
978 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']),
979 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
980 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']),
981 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
982 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']),
983 ])
984 module_args = {
985 'use_rest': 'always',
986 'ipspace': 'cluster',
987 'address': '10.12.12.13',
988 'netmask': '255.255.192.0',
989 'current_node': 'node1',
990 'vserver': 'vserver'
991 }
992 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
993 assert_warning_was_raised('Failed to confirm interface is migrated after 120 seconds')
994
995
996 def test_rest_create_migrate_fc_error():
997 ''' create cluster '''
998 register_responses([
999 ('GET', 'cluster', SRR['is_rest_9_8_0']),
1000 ('GET', 'network/fc/interfaces', SRR['empty_records']),
1001 ('GET', 'cluster', SRR['is_rest_9_8_0']),
1002 ('GET', 'network/fc/interfaces', SRR['one_record_fcp'])
1003 ])
1004 module_args = {
1005 'use_rest': 'always',
1006 'home_node': 'ontap910-01',
1007 'current_node': 'ontap910-02',
1008 'current_port': '1b',
1009 'interface_type': 'fc',
1010 'vserver': 'svm0_iscsi'
1011 }
1012 error = 'Error: Missing one or more required parameters for creating interface'
1013 assert error in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
1014 module_args['home_port'] = '1a'
1015 error = 'Error: cannot migrate FC interface'
1016 assert error in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
1017
1018
1019 def test_rest_delete_ip_no_svm():
1020 ''' create cluster '''
1021 register_responses([
1022 ('GET', 'cluster', SRR['is_rest_97']),
1023 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']), # get IP
1024 ('GET', 'cluster/nodes', SRR['nodes']), # get nodes (for get)
1025 ('DELETE', 'network/ip/interfaces/54321', SRR['success']), # delete
1026 ])
1027 module_args = {
1028 'use_rest': 'always',
1029 'ipspace': 'cluster',
1030 'address': '10.12.12.13',
1031 'netmask': '255.255.192.0',
1032 'state': 'absent',
1033 }
1034 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
1035
1036
1037 def test_rest_disable_delete_fc():
1038 ''' create cluster '''
1039 register_responses([
1040 ('GET', 'cluster', SRR['is_rest_97']),
1041 ('GET', 'network/fc/interfaces', SRR['one_record_vserver']), # get IP
1042 ('PATCH', 'network/fc/interfaces/54321', SRR['success']), # disable fc before delete
1043 ('DELETE', 'network/fc/interfaces/54321', SRR['success']), # delete
1044 ])
1045 module_args = {
1046 'use_rest': 'always',
1047 'state': 'absent',
1048 "admin_status": "up",
1049 "protocols": "fc-nvme",
1050 "role": "data",
1051 "vserver": "svm3",
1052 "current_port": "1a"
1053 }
1054 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
1055
1056
1057 def test_rest_delete_idempotent_ip_no_svm():
1058 ''' create cluster '''
1059 register_responses([
1060 ('GET', 'cluster', SRR['is_rest_97']),
1061 ('GET', 'network/ip/interfaces', SRR['zero_records']), # get IP
1062 ])
1063 module_args = {
1064 'use_rest': 'always',
1065 'ipspace': 'cluster',
1066 'address': '10.12.12.13',
1067 'netmask': '255.255.192.0',
1068 'state': 'absent',
1069 }
1070 assert not call_main(my_main, DEFAULT_ARGS, module_args)['changed']
1071
1072
1073 def test_derive_fc_protocol_fcp():
1074 register_responses([
1075 ('GET', 'cluster', SRR['is_rest_97']),
1076 ])
1077 module_args = {
1078 'use_rest': 'always',
1079 'protocols': ['fcp'],
1080 }
1081 my_obj = create_module(interface_module, DEFAULT_ARGS, module_args)
1082 my_obj.derive_fc_data_protocol()
1083 assert my_obj.parameters['data_protocol'] == 'fcp'
1084
1085
1086 def test_derive_fc_protocol_nvme():
1087 register_responses([
1088 ('GET', 'cluster', SRR['is_rest_97']),
1089 ])
1090 module_args = {
1091 'use_rest': 'always',
1092 'protocols': ['fc-nvme'],
1093 }
1094 my_obj = create_module(interface_module, DEFAULT_ARGS, module_args)
1095 my_obj.derive_fc_data_protocol()
1096 assert my_obj.parameters['data_protocol'] == 'fc_nvme'
1097
1098
1099 def test_derive_fc_protocol_empty():
1100 register_responses([
1101 ('GET', 'cluster', SRR['is_rest_97']),
1102 ])
1103 module_args = {
1104 'use_rest': 'always',
1105 'protocols': [],
1106 }
1107 my_obj = create_module(interface_module, DEFAULT_ARGS, module_args)
1108 assert my_obj.derive_fc_data_protocol() is None
1109
1110
1111 def test_negative_derive_fc_protocol_nvme():
1112 register_responses([
1113 ('GET', 'cluster', SRR['is_rest_97']),
1114 ])
1115 module_args = {
1116 'use_rest': 'always',
1117 'protocols': ['fc-nvme', 'fcp'],
1118 }
1119 my_obj = create_module(interface_module, DEFAULT_ARGS, module_args)
1120 msg = "A single protocol entry is expected for FC interface, got ['fc-nvme', 'fcp']."
1121 assert msg in expect_and_capture_ansible_exception(my_obj.derive_fc_data_protocol, 'fail')['msg']
1122
1123
1124 def test_negative_derive_fc_protocol_nvme_mismatch():
1125 register_responses([
1126 ('GET', 'cluster', SRR['is_rest_97']),
1127 ])
1128 module_args = {
1129 'use_rest': 'always',
1130 'protocols': ['fc-nvme'],
1131 'data_protocol': 'fcp'
1132 }
1133 my_obj = create_module(interface_module, DEFAULT_ARGS, module_args)
1134 msg = "Error: mismatch between configured data_protocol: fcp and data_protocols: ['fc-nvme']"
1135 assert msg in expect_and_capture_ansible_exception(my_obj.derive_fc_data_protocol, 'fail')['msg']
1136
1137
1138 def test_negative_derive_fc_protocol_unexpected():
1139 register_responses([
1140 ('GET', 'cluster', SRR['is_rest_97']),
1141 ])
1142 module_args = {
1143 'use_rest': 'always',
1144 'protocols': ['fc-unknown'],
1145 'data_protocol': 'fcp'
1146 }
1147 my_obj = create_module(interface_module, DEFAULT_ARGS, module_args)
1148 msg = "Unexpected protocol value fc-unknown."
1149 assert msg in expect_and_capture_ansible_exception(my_obj.derive_fc_data_protocol, 'fail')['msg']
1150
1151
1152 def test_derive_interface_type_nvme():
1153 register_responses([
1154 ('GET', 'cluster', SRR['is_rest_97']),
1155 ])
1156 module_args = {
1157 'use_rest': 'always',
1158 'protocols': ['fc-nvme'],
1159 }
1160 my_obj = create_module(interface_module, DEFAULT_ARGS, module_args)
1161 my_obj.derive_interface_type()
1162 assert my_obj.parameters['interface_type'] == 'fc'
1163
1164
1165 def test_derive_interface_type_iscsi():
1166 register_responses([
1167 ('GET', 'cluster', SRR['is_rest_97']),
1168 ])
1169 module_args = {
1170 'use_rest': 'always',
1171 'protocols': ['iscsi'],
1172 }
1173 my_obj = create_module(interface_module, DEFAULT_ARGS, module_args)
1174 my_obj.derive_interface_type()
1175 assert my_obj.parameters['interface_type'] == 'ip'
1176
1177
1178 def test_derive_interface_type_cluster():
1179 register_responses([
1180 ('GET', 'cluster', SRR['is_rest_97']),
1181 ])
1182 module_args = {
1183 'use_rest': 'always',
1184 'role': 'cluster',
1185 }
1186 my_obj = create_module(interface_module, DEFAULT_ARGS, module_args)
1187 my_obj.derive_interface_type()
1188 assert my_obj.parameters['interface_type'] == 'ip'
1189
1190
1191 def test_negative_derive_interface_type_nvme_mismatch():
1192 register_responses([
1193 ('GET', 'cluster', SRR['is_rest_97']),
1194 ])
1195 msg = "Error: mismatch between configured interface_type: ip and derived interface_type: fc."
1196 module_args = {
1197 'use_rest': 'always',
1198 'protocols': ['fc-nvme'],
1199 'interface_type': 'ip'
1200 }
1201 my_obj = create_module(interface_module, DEFAULT_ARGS, module_args)
1202 assert msg in expect_and_capture_ansible_exception(my_obj.derive_interface_type, 'fail')['msg']
1203
1204
1205 def test_negative_derive_interface_type_unknown():
1206 register_responses([
1207 ('GET', 'cluster', SRR['is_rest_97']),
1208 ])
1209 msg = "Error: unable to determine interface type, please set interface_type: unexpected value(s) for protocols: ['unexpected']"
1210 module_args = {
1211 'use_rest': 'always',
1212 'protocols': ['unexpected'],
1213 }
1214 my_obj = create_module(interface_module, DEFAULT_ARGS, module_args)
1215 assert msg in expect_and_capture_ansible_exception(my_obj.derive_interface_type, 'fail')['msg']
1216
1217
1218 def test_negative_derive_interface_type_multiple():
1219 register_responses([
1220 ('GET', 'cluster', SRR['is_rest_97']),
1221 ])
1222 msg = "Error: unable to determine interface type, please set interface_type: incompatible value(s) for protocols: ['fc-nvme', 'cifs']"
1223 module_args = {
1224 'use_rest': 'always',
1225 'protocols': ['fc-nvme', 'cifs'],
1226 }
1227 my_obj = create_module(interface_module, DEFAULT_ARGS, module_args)
1228 assert msg in expect_and_capture_ansible_exception(my_obj.derive_interface_type, 'fail')['msg']
1229
1230
1231 def test_derive_block_file_type_fcp():
1232 register_responses([
1233 ('GET', 'cluster', SRR['is_rest_97']),
1234 ('GET', 'cluster', SRR['is_rest_97']),
1235 ])
1236 module_args = {
1237 'use_rest': 'always',
1238 }
1239 my_obj = create_module(interface_module, DEFAULT_ARGS, module_args)
1240 block_p, file_p, fcp = my_obj.derive_block_file_type(['fcp'])
1241 assert block_p
1242 assert not file_p
1243 assert fcp
1244 module_args['interface_type'] = 'fc'
1245 my_obj = create_module(interface_module, DEFAULT_ARGS, module_args)
1246 block_p, file_p, fcp = my_obj.derive_block_file_type(None)
1247 assert block_p
1248 assert not file_p
1249 assert fcp
1250
1251
1252 def test_derive_block_file_type_iscsi():
1253 register_responses([
1254 ('GET', 'cluster', SRR['is_rest_97']),
1255 ])
1256 module_args = {
1257 'use_rest': 'always',
1258 }
1259 my_obj = create_module(interface_module, DEFAULT_ARGS, module_args)
1260 block_p, file_p, fcp = my_obj.derive_block_file_type(['iscsi'])
1261 assert block_p
1262 assert not file_p
1263 assert not fcp
1264
1265
1266 def test_derive_block_file_type_cifs():
1267 register_responses([
1268 ('GET', 'cluster', SRR['is_rest_97']),
1269 ])
1270 module_args = {
1271 'use_rest': 'always',
1272 }
1273 my_obj = create_module(interface_module, DEFAULT_ARGS, module_args)
1274 block_p, file_p, fcp = my_obj.derive_block_file_type(['cifs'])
1275 assert not block_p
1276 assert file_p
1277 assert not fcp
1278
1279
1280 def test_derive_block_file_type_mixed():
1281 register_responses([
1282 ('GET', 'cluster', SRR['is_rest_97']),
1283 ])
1284 module_args = {
1285 'use_rest': 'always',
1286 }
1287 my_obj = create_module(interface_module, DEFAULT_ARGS, module_args)
1288 error = "Cannot use any of ['fcp'] with ['cifs']"
1289 assert expect_and_capture_ansible_exception(my_obj.derive_block_file_type, 'fail', ['cifs', 'fcp'])['msg'] == error
1290
1291
1292 def test_map_failover_policy():
1293 register_responses([
1294 ('GET', 'cluster', SRR['is_rest_97']),
1295 ])
1296 module_args = {
1297 'use_rest': 'always',
1298 'failover_policy': 'local-only',
1299 }
1300 my_obj = create_module(interface_module, DEFAULT_ARGS, module_args)
1301 my_obj.map_failover_policy()
1302 assert my_obj.parameters['failover_scope'] == 'home_node_only'
1303
1304
1305 def test_rest_negative_unsupported_zapi_option_fail():
1306 ''' create cluster '''
1307 register_responses([
1308 ])
1309 msg = "REST API currently does not support 'is_ipv4_link_local'"
1310 module_args = {
1311 'use_rest': 'always',
1312 'ipspace': 'cluster',
1313 'is_ipv4_link_local': True,
1314 }
1315 assert msg in create_module(interface_module, DEFAULT_ARGS, module_args, fail=True)['msg']
1316
1317
1318 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
1319 def test_rest_negative_rest_only_option():
1320 ''' create cluster '''
1321 register_responses([
1322 ])
1323 msg = "probe_port requires REST."
1324 module_args = {
1325 'use_rest': 'never',
1326 'ipspace': 'cluster',
1327 'probe_port': 65431,
1328 }
1329 assert msg in create_module(interface_module, DEFAULT_ARGS, module_args, fail=True)['msg']
1330
1331
1332 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
1333 def test_rest_negative_unsupported_zapi_option_force_zapi_1():
1334 ''' create cluster '''
1335 register_responses([
1336 ('GET', 'cluster', SRR['is_rest_97']),
1337 ])
1338 msg = "missing required argument with ZAPI: vserver"
1339 module_args = {
1340 'use_rest': 'auto',
1341 'ipspace': 'cluster',
1342 'is_ipv4_link_local': True,
1343 }
1344 assert msg in create_module(interface_module, DEFAULT_ARGS, module_args, fail=True)['msg']
1345
1346
1347 @patch('ansible_collections.netapp.ontap.plugins.module_utils.netapp.has_netapp_lib')
1348 def test_rest_negative_unsupported_zapi_option_force_zapi_2(mock_netapp_lib):
1349 ''' create cluster '''
1350 register_responses([
1351 ('GET', 'cluster', SRR['is_rest_97']),
1352 ])
1353 mock_netapp_lib.return_value = False
1354 msg = "the python NetApp-Lib module is required"
1355 module_args = {
1356 'use_rest': 'auto',
1357 'ipspace': 'cluster',
1358 'is_ipv4_link_local': True,
1359 }
1360 assert msg in create_module(interface_module, DEFAULT_ARGS, module_args, fail=True)['msg']
1361
1362
1363 def test_rest_negative_unsupported_rest_version():
1364 ''' create cluster '''
1365 register_responses([
1366 ('GET', 'cluster', SRR['is_rest_96']),
1367 ])
1368 msg = "Error: REST requires ONTAP 9.7 or later for interface APIs."
1369 module_args = {'use_rest': 'always'}
1370 assert msg == create_module(interface_module, DEFAULT_ARGS, module_args, fail=True)['msg']
1371
1372
1373 @pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib")
1374 def test_rest_auto_falls_back_to_zapi_if_ip_9_6():
1375 register_responses([
1376 ('GET', 'cluster', SRR['is_rest_96'])
1377 ])
1378 module_args = {'use_rest': 'auto'}
1379 # vserver is a required parameter with ZAPI
1380 msg = "missing required argument with ZAPI: vserver"
1381 assert msg in create_module(interface_module, DEFAULT_ARGS, module_args, fail=True)['msg']
1382 print_warnings
1383 assert_warning_was_raised('Falling back to ZAPI: REST requires ONTAP 9.7 or later for interface APIs.')
1384
1385
1386 def test_fix_errors():
1387 register_responses([
1388 ('GET', 'cluster', SRR['is_rest_97'])
1389 ])
1390 module_args = {'use_rest': 'auto'}
1391 my_obj = create_module(interface_module, DEFAULT_ARGS, module_args)
1392 control = {'xx': 11, 'yy': 22}
1393 # no role in error
1394 errors = dict(control)
1395 assert my_obj.fix_errors(None, errors) is None
1396 assert errors == control
1397 # role/firewall_policy/protocols/service_policy -> service_policy
1398 tests = [
1399 ('data', 'data', ['nfs'], None, 'default-data-files', True),
1400 ('data', 'data', ['cifs'], None, 'default-data-files', True),
1401 ('data', 'data', ['iscsi'], None, 'default-data-blocks', True),
1402 ('data', '', ['fc-nvme'], None, 'unchanged', True),
1403 ('data', 'mgmt', ['ignored'], None, 'default-management', True),
1404 ('data', '', ['nfs'], None, 'default-data-files', True),
1405 ('data', '', ['cifs'], None, 'default-data-files', True),
1406 ('data', '', ['iscsi'], None, 'default-data-blocks', True),
1407 ('data', 'mgmt', ['ignored'], None, 'default-management', True),
1408 ('intercluster', 'intercluster', ['ignored'], None, 'default-intercluster', True),
1409 ('intercluster', '', ['ignored'], None, 'default-intercluster', True),
1410 ('cluster', 'mgmt', ['ignored'], None, 'default-cluster', True),
1411 ('cluster', '', ['ignored'], None, 'default-cluster', True),
1412 ('cluster', 'other', ['ignored'], None, 'unchanged', False),
1413 ]
1414 for role, firewall_policy, protocols, service_policy, expected_service_policy, fixed in tests:
1415 my_obj.parameters['protocols'] = protocols
1416 if service_policy:
1417 my_obj['service_policy'] = service_policy
1418 options = {'service_policy': 'unchanged'}
1419 errors = dict(control)
1420 errors['role'] = role
1421 if firewall_policy:
1422 errors['firewall_policy'] = firewall_policy
1423 assert my_obj.fix_errors(options, errors) is None
1424 print('OPTIONS', options)
1425 assert 'service_policy' in options
1426 assert options['service_policy'] == expected_service_policy
1427 assert errors == control or not fixed
1428 assert fixed or 'role' in errors
1429
1430
1431 def test_error_messages_get_interface_rest():
1432 register_responses([
1433 ('GET', 'cluster', SRR['is_rest_97']),
1434 ('GET', 'network/ip/interfaces', SRR['two_records']), # get IP
1435 ('GET', 'cluster/nodes', SRR['generic_error']), # get nodes
1436 # second call
1437 ('GET', 'network/ip/interfaces', SRR['one_record_vserver']), # get IP
1438 ('GET', 'network/fc/interfaces', SRR['generic_error']), # get FC
1439 # third call
1440 ('GET', 'network/ip/interfaces', SRR['generic_error']), # get IP
1441 ('GET', 'network/fc/interfaces', SRR['one_record_vserver']), # get FC
1442 # fourth call
1443 ('GET', 'network/ip/interfaces', SRR['generic_error']), # get IP
1444 ('GET', 'network/fc/interfaces', SRR['generic_error']), # get FC
1445 # fifth call
1446 ('GET', 'network/ip/interfaces', SRR['error_precluster']), # get IP
1447 ])
1448 module_args = {'use_rest': 'auto'}
1449 my_obj = create_module(interface_module, DEFAULT_ARGS, module_args)
1450 # first call
1451 error = 'Error fetching cluster node info'
1452 assert expect_and_capture_ansible_exception(my_obj.get_interface_rest, 'fail', 'my_lif')['msg'] == rest_error_message(error, 'cluster/nodes')
1453 # second call
1454 # reset value, as it was set for ip
1455 del my_obj.parameters['interface_type']
1456 my_obj.parameters['vserver'] = 'not_cluster'
1457 assert my_obj.get_interface_rest('my_lif') is not None
1458 # third call
1459 # reset value, as it was set for ip
1460 del my_obj.parameters['interface_type']
1461 my_obj.parameters['vserver'] = 'not_cluster'
1462 assert my_obj.get_interface_rest('my_lif') is not None
1463 # fourth call
1464 # reset value, as it was set for fc
1465 del my_obj.parameters['interface_type']
1466 error = expect_and_capture_ansible_exception(my_obj.get_interface_rest, 'fail', 'my_lif')['msg']
1467 assert rest_error_message('Error fetching interface details for my_lif', 'network/ip/interfaces') in error
1468 assert rest_error_message('', 'network/fc/interfaces') in error
1469 # fifth call
1470 error = 'This module cannot use REST in precluster mode, ZAPI can be forced with use_rest: never.'
1471 assert error in expect_and_capture_ansible_exception(my_obj.get_interface_rest, 'fail', 'my_lif')['msg']
1472
1473
1474 def test_error_messages_rest_find_interface():
1475 register_responses([
1476 ('GET', 'cluster', SRR['is_rest_97']),
1477 ('GET', 'cluster/nodes', SRR['nodes_two_records']), # get nodes
1478 ])
1479 module_args = {'use_rest': 'auto'}
1480 my_obj = create_module(interface_module, DEFAULT_ARGS, module_args)
1481 # no calls
1482 # no interface type
1483 error = 'Error: missing option "interface_type (or could not be derived)'
1484 assert error in expect_and_capture_ansible_exception(my_obj.get_net_int_api, 'fail')['msg']
1485 # multiple records for cluster
1486 records = [
1487 {'name': 'node_name'},
1488 {'name': 'node_name'}
1489 ]
1490 error = 'Error: multiple records for: node_name - %s' % records
1491 assert error in expect_and_capture_ansible_exception(my_obj.find_interface_record, 'fail', records, 'node', 'name')['msg']
1492 # multiple records with vserver
1493 records = [1, 2]
1494 my_obj.parameters['vserver'] = 'vserver'
1495 error = 'Error: unexpected records for name: name, vserver: vserver - [1, 2]'
1496 assert error in expect_and_capture_ansible_exception(my_obj.find_exact_match, 'fail', records, 'name')['msg']
1497 # multiple records with ambiguity, home_node set (warn)
1498 del my_obj.parameters['vserver']
1499 my_obj.parameters['home_node'] = 'node'
1500 records = [
1501 {'name': 'node_name'},
1502 {'name': 'node_name'}
1503 ]
1504 error = 'Error: multiple records for: node_name - %s' % records
1505 assert error in expect_and_capture_ansible_exception(my_obj.find_exact_match, 'fail', records, 'name')['msg']
1506 records = [
1507 {'name': 'node_name'},
1508 {'name': 'name'}
1509 ]
1510 record = my_obj.find_exact_match(records, 'name')
1511 assert record == {'name': 'node_name'}
1512 assert_warning_was_raised("Found both ['name', 'node_name'], selecting node_name")
1513 # fifth call (get nodes, cached)
1514 # multiple records with different home nodes
1515 del my_obj.parameters['home_node']
1516 records = [
1517 {'name': 'node2_name'},
1518 {'name': 'node3_name'}
1519 ]
1520 error = "Error: multiple matches for name: name: ['node2_name', 'node3_name']. Set home_node parameter."
1521 assert error in expect_and_capture_ansible_exception(my_obj.find_exact_match, 'fail', records, 'name')['msg']
1522 # multiple records with home node and no home node
1523 records = [
1524 {'name': 'node2_name'},
1525 {'name': 'name'}
1526 ]
1527 error = "Error: multiple matches for name: name: ['name', 'node2_name']. Set home_node parameter."
1528 assert error in expect_and_capture_ansible_exception(my_obj.find_exact_match, 'fail', records, 'name')['msg']
1529 # sixth call
1530 error = "Error: multiple matches for name: name: ['name', 'node2_name']. Set home_node parameter."
1531 assert error in expect_and_capture_ansible_exception(my_obj.find_exact_match, 'fail', records, 'name')['msg']
1532
1533
1534 def test_error_messages_rest_misc():
1535 register_responses([
1536 ('GET', 'cluster', SRR['is_rest_97']),
1537 ('POST', 'network/type/interfaces', SRR['generic_error']),
1538 ('PATCH', 'network/type/interfaces/uuid', SRR['generic_error']),
1539 ('DELETE', 'network/type/interfaces/uuid', SRR['generic_error']),
1540 ])
1541 module_args = {'use_rest': 'auto'}
1542 my_obj = create_module(interface_module, DEFAULT_ARGS, module_args)
1543 # no calls
1544 # no interface type
1545 error = 'Error, expecting uuid in existing record'
1546 assert error in expect_and_capture_ansible_exception(my_obj.build_rest_payloads, 'fail', 'delete', {}, {})['msg']
1547 my_obj.parameters['interface_type'] = 'type'
1548 error = rest_error_message('Error creating interface abc_if', 'network/type/interfaces')
1549 assert error in expect_and_capture_ansible_exception(my_obj.create_interface_rest, 'fail', {})['msg']
1550 error = rest_error_message('Error modifying interface abc_if', 'network/type/interfaces/uuid')
1551 assert error in expect_and_capture_ansible_exception(my_obj.modify_interface_rest, 'fail', 'uuid', {'xxx': 'yyy'})['msg']
1552 error = rest_error_message('Error deleting interface abc_if', 'network/type/interfaces/uuid')
1553 assert error in expect_and_capture_ansible_exception(my_obj.delete_interface_rest, 'fail', 'uuid')['msg']
1554
1555
1556 def test_error_messages_build_rest_body_and_validations():
1557 register_responses([
1558 ('GET', 'cluster', SRR['is_rest_97']),
1559 ])
1560 module_args = {'use_rest': 'always'}
1561 my_obj = create_module(interface_module, DEFAULT_ARGS, module_args)
1562 my_obj.parameters['home_node'] = 'node1'
1563 my_obj.parameters['protocols'] = ['nfs']
1564 my_obj.parameters['role'] = 'intercluster'
1565 error = 'Error: Missing one or more required parameters for creating interface: interface_type.'
1566 assert error in expect_and_capture_ansible_exception(my_obj.build_rest_body, 'fail')['msg']
1567 my_obj.parameters['interface_type'] = 'type'
1568 error = 'Error: unexpected value for interface_type: type.'
1569 assert error in expect_and_capture_ansible_exception(my_obj.build_rest_body, 'fail')['msg']
1570 my_obj.parameters['interface_type'] = 'ip'
1571 my_obj.parameters['ipspace'] = 'ipspace'
1572 error = 'Error: Protocol cannot be specified for intercluster role, failed to create interface.'
1573 assert error in expect_and_capture_ansible_exception(my_obj.build_rest_body, 'fail')['msg']
1574 del my_obj.parameters['protocols']
1575 my_obj.parameters['interface_type'] = 'fc'
1576 error = "Error: 'home_port' is not supported for FC interfaces with 9.7, use 'current_port', avoid home_node."
1577 assert error in expect_and_capture_ansible_exception(my_obj.build_rest_body, 'fail')['msg']
1578 print_warnings()
1579 assert_warning_was_raised("Avoid 'home_node' with FC interfaces with 9.7, use 'current_node'.")
1580 del my_obj.parameters['home_port']
1581 error = "Error: A data 'vserver' is required for FC interfaces."
1582 assert error in expect_and_capture_ansible_exception(my_obj.build_rest_body, 'fail')['msg']
1583 my_obj.parameters['current_port'] = '0a'
1584 my_obj.parameters['data_protocol'] = 'fc'
1585 my_obj.parameters['force_subnet_association'] = True
1586 my_obj.parameters['failover_group'] = 'failover_group'
1587 my_obj.parameters['vserver'] = 'vserver'
1588 error = "Error: 'role' is deprecated, and 'data' is the only value supported for FC interfaces: found intercluster."
1589 assert error in expect_and_capture_ansible_exception(my_obj.build_rest_body, 'fail')['msg']
1590 my_obj.parameters['role'] = 'data'
1591 error = "Error creating interface, unsupported options: {'failover_group': 'failover_group'}"
1592 assert error in expect_and_capture_ansible_exception(my_obj.build_rest_body, 'fail')['msg']
1593 del my_obj.parameters['failover_group']
1594 my_obj.parameters['broadcast_domain'] = 'BDD1'
1595 error = "Error: broadcast_domain option only supported for IP interfaces: abc_if, interface_type: fc"
1596 assert error in expect_and_capture_ansible_exception(my_obj.build_rest_body, 'fail', None)['msg']
1597 my_obj.parameters['service_policy'] = 'svc_pol'
1598 error = "Error: 'service_policy' is not supported for FC interfaces."
1599 assert error in expect_and_capture_ansible_exception(my_obj.build_rest_body, 'fail', None)['msg']
1600 del my_obj.parameters['service_policy']
1601 my_obj.parameters['probe_port'] = 65431
1602 error = "Error: 'probe_port' is not supported for FC interfaces."
1603 assert error in expect_and_capture_ansible_exception(my_obj.build_rest_body, 'fail', None)['msg']
1604 print_warnings()
1605 assert_warning_was_raised('Ignoring force_subnet_association')
1606 my_obj.parameters['interface_type'] = 'ip'
1607 del my_obj.parameters['vserver']
1608 del my_obj.parameters['ipspace']
1609 error = 'Error: ipspace name must be provided if scope is cluster, or vserver for svm scope.'
1610 assert error in expect_and_capture_ansible_exception(my_obj.build_rest_body, 'fail')['msg']
1611 modify = {'ipspace': 'ipspace'}
1612 error = "The following option cannot be modified: ipspace.name"
1613 assert error in expect_and_capture_ansible_exception(my_obj.build_rest_body, 'fail', modify)['msg']
1614 del my_obj.parameters['role']
1615 my_obj.parameters['current_port'] = 'port1'
1616 my_obj.parameters['home_port'] = 'port1'
1617 my_obj.parameters['ipspace'] = 'ipspace'
1618 error = "Error: home_port and broadcast_domain are mutually exclusive for creating: abc_if"
1619 assert error in expect_and_capture_ansible_exception(my_obj.build_rest_body, 'fail', None)['msg']
1620
1621
1622 def test_dns_domain_ddns_enabled():
1623 ''' domain and ddns enabled option test '''
1624 register_responses([
1625 ('GET', 'cluster', SRR['is_rest_9_9_1']),
1626 ('GET', 'network/ip/interfaces', SRR['zero_records']),
1627 ('GET', 'cluster/nodes', SRR['nodes']),
1628 ('POST', 'network/ip/interfaces', SRR['success']),
1629 ('GET', 'cluster', SRR['is_rest_9_9_1']),
1630 ('GET', 'network/ip/interfaces', SRR['one_record_vserver']),
1631 ('GET', 'cluster/nodes', SRR['nodes']),
1632 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
1633 ('GET', 'cluster', SRR['is_rest_9_9_1']),
1634 ('GET', 'network/fc/interfaces', SRR['zero_records']),
1635 ('GET', 'cluster', SRR['is_rest_9_9_0'])
1636 ])
1637 module_args = {
1638 'use_rest': 'always',
1639 'address': '10.11.12.13',
1640 'netmask': '255.192.0.0',
1641 'vserver': 'vserver',
1642 'dns_domain_name': 'netapp1.com',
1643 'is_dns_update_enabled': False
1644 }
1645 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
1646 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
1647 del module_args['address']
1648 del module_args['netmask']
1649 args = {'data_protocol': 'fc_nvme', 'home_node': 'my_node', 'protocols': 'fc-nvme', 'interface_type': 'fc'}
1650 module_args.update(args)
1651 assert 'dns_domain_name, is_dns_update_enabled options only supported for IP interfaces' in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
1652 assert 'Error: Minimum version of ONTAP for is_dns_update_enabled is (9, 9, 1).' in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
1653
1654
1655 def test_subnet_name():
1656 ''' domain and ddns enabled option test '''
1657 register_responses([
1658 ('GET', 'cluster', SRR['is_rest_9_11_1']),
1659 ('GET', 'network/ip/interfaces', SRR['zero_records']),
1660 ('GET', 'cluster/nodes', SRR['nodes']),
1661 ('POST', 'network/ip/interfaces', SRR['success']),
1662 # idemptocency
1663 ('GET', 'cluster', SRR['is_rest_9_11_1']),
1664 ('GET', 'network/ip/interfaces', SRR['one_record_vserver_subnet1']),
1665 # modify subnet
1666 ('GET', 'cluster', SRR['is_rest_9_11_1']),
1667 ('GET', 'network/ip/interfaces', SRR['one_record_vserver_subnet1']),
1668 ('GET', 'cluster/nodes', SRR['nodes']),
1669 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
1670 # error cases
1671 ('GET', 'cluster', SRR['is_rest_9_9_1']),
1672 ('GET', 'cluster', SRR['is_rest_9_11_1']),
1673 ('GET', 'network/fc/interfaces', SRR['zero_records']),
1674 ])
1675 module_args = {
1676 'use_rest': 'always',
1677 'ipspace': 'Default',
1678 'subnet_name': 'subnet1',
1679 'vserver': 'vserver',
1680 }
1681 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
1682 assert not call_main(my_main, DEFAULT_ARGS, module_args)['changed']
1683 module_args['subnet_name'] = 'subnet2'
1684 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
1685 assert 'Minimum version of ONTAP for subnet_name is (9, 11, 1)' in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
1686 args = {'data_protocol': 'fc_nvme', 'home_node': 'my_node', 'protocols': 'fc-nvme', 'interface_type': 'fc'}
1687 module_args.update(args)
1688 assert 'subnet_name option only supported for IP interfaces' in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
1689 assert_warning_was_raised('ipspace is ignored for FC interfaces.')
1690
1691
1692 def test_fail_if_subnet_conflicts():
1693 ''' domain and ddns enabled option test '''
1694 register_responses([
1695 ('GET', 'cluster', SRR['is_rest_9_11_1']),
1696 ('GET', 'network/ip/interfaces', SRR['zero_records']),
1697 ('GET', 'cluster/nodes', SRR['nodes']),
1698 ('POST', 'network/ip/interfaces', SRR['success']),
1699 # idemptocency
1700 ('GET', 'cluster', SRR['is_rest_9_11_1']),
1701 ('GET', 'network/ip/interfaces', SRR['one_record_vserver']),
1702 # modify subnet
1703 ('GET', 'cluster', SRR['is_rest_9_11_1']),
1704 ('GET', 'network/ip/interfaces', SRR['one_record_vserver']),
1705 ('GET', 'cluster/nodes', SRR['nodes']),
1706 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
1707 # error cases
1708 ('GET', 'cluster', SRR['is_rest_9_9_1']),
1709 ('GET', 'cluster', SRR['is_rest_9_11_1']),
1710 ('GET', 'network/fc/interfaces', SRR['zero_records']),
1711 ])
1712 module_args = {
1713 'use_rest': 'always',
1714 'ipspace': 'Default',
1715 'fail_if_subnet_conflicts': False,
1716 'vserver': 'vserver',
1717 'address': '10.11.12.13',
1718 'netmask': '255.192.0.0',
1719 }
1720 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
1721 assert not call_main(my_main, DEFAULT_ARGS, module_args)['changed']
1722 module_args['address'] = '10.11.12.14'
1723 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
1724 assert 'Minimum version of ONTAP for fail_if_subnet_conflicts is (9, 11, 1)' in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
1725 args = {'data_protocol': 'fc_nvme', 'home_node': 'my_node', 'protocols': 'fc-nvme', 'interface_type': 'fc'}
1726 module_args.update(args)
1727 assert 'fail_if_subnet_conflicts option only supported for IP interfaces' in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']
1728 assert_warning_was_raised('ipspace is ignored for FC interfaces.')
1729
1730
1731 def check_options(my_obj, parameters, exp_options, exp_migrate_options, exp_errors):
1732 options, migrate_options, errors = my_obj.set_options_rest(parameters)
1733 assert options == exp_options
1734 assert migrate_options == exp_migrate_options
1735 assert errors == exp_errors
1736
1737
1738 def test_set_options_rest():
1739 register_responses([
1740 ('GET', 'cluster', SRR['is_rest_97']),
1741 # ('GET', 'cluster/nodes', SRR['nodes']),
1742 ])
1743 module_args = {'use_rest': 'always'}
1744 my_obj = create_module(interface_module, DEFAULT_ARGS, module_args)
1745 parameters = None
1746 my_obj.parameters = {
1747 'interface_type': 'other'
1748 }
1749 check_options(my_obj, parameters, {}, {}, {})
1750 # unknown modify options
1751 check_options(my_obj, {'x': 'y'}, {}, {}, {})
1752 # valid options
1753 my_obj.parameters = {
1754 'interface_type': 'ip',
1755 'fail_if_subnet_conflicts': False
1756 }
1757 check_options(my_obj, parameters, {'fail_if_subnet_conflicts': False}, {}, {})
1758 check_options(my_obj, {'subnet_name': 'subnet1'}, {'subnet.name': 'subnet1'}, {}, {})
1759 my_obj.parameters['home_node'] = 'node1'
1760 check_options(my_obj, {'home_node': 'node1', 'home_port': 'port1'}, {'location': {'home_port': {'name': 'port1', 'node': {'name': 'node1'}}}}, {}, {})
1761 my_obj.parameters['current_node'] = 'node1'
1762 check_options(my_obj, {'current_node': 'node1', 'current_port': 'port1'}, {}, {'location': {'port': {'name': 'port1', 'node': {'name': 'node1'}}}}, {})
1763
1764
1765 def test_not_throw_warnings_in_rename():
1766 ''' assert no warnings raised during rename '''
1767 register_responses([
1768 ('GET', 'cluster', SRR['is_rest_9_10_1']),
1769 ('GET', 'network/ip/interfaces', SRR['zero_records']),
1770 ('GET', 'network/ip/interfaces', SRR['one_record_vserver']),
1771 ('GET', 'cluster/nodes', SRR['nodes']),
1772 ('PATCH', 'network/ip/interfaces/54321', SRR['success']),
1773 ])
1774 module_args = {
1775 "from_name": "abc_if",
1776 "interface_name": "abc_if_update",
1777 }
1778 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
1779 assert_no_warnings()
1780
1781
1782 def test_throw_warnings_modify_rename():
1783 ''' assert warnings raised when interface_name does not have node name in it. '''
1784 register_responses([
1785 ('GET', 'cluster', SRR['is_rest_9_10_1']),
1786 ('GET', 'network/ip/interfaces', SRR['one_record_home_node']),
1787 ('GET', 'cluster/nodes', SRR['nodes'])
1788 ])
1789 assert not call_main(my_main, DEFAULT_ARGS)['changed']
1790 print_warnings()
1791 # current record name is 'node2_abc_if' and interface_name does not have node name in it.
1792 # adjust to avoid rename attempt.
1793 assert_warning_was_raised('adjusting name from abc_if to node2_abc_if')