Debian Codegraph @

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

raw
1 # (c) 2021, 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 disks Ansible module '''
5
6 from __future__ import (absolute_import, division, print_function)
7 __metaclass__ = type
8 import pytest
9
10 from ansible_collections.netapp.ontap.tests.unit.compat.mock import patch, Mock
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 set_module_args, \
14 AnsibleFailJson, AnsibleExitJson, patch_ansible
15
16 from ansible_collections.netapp.ontap.plugins.modules.na_ontap_disks \
17 import NetAppOntapDisks as my_module # module under test
18
19 if not netapp_utils.has_netapp_lib():
20 pytestmark = pytest.mark.skip('skipping as missing required netapp_lib')
21
22
23 class MockONTAPConnection():
24 ''' mock server connection to ONTAP host '''
25
26 def __init__(self, kind=None):
27 ''' save arguments '''
28 self.type = kind
29 self.xml_in = None
30 self.xml_out = None
31
32 def invoke_successfully(self, xml, enable_tunneling): # pylint: disable=unused-argument
33 ''' mock invoke_successfully returning xml data '''
34 self.xml_in = xml
35
36 try:
37 container_type = self.xml_in['query']['storage-disk-info']['disk-raid-info']['container-type']
38 except LookupError:
39 container_type = None
40 try:
41 get_owned_disks = self.xml_in['query']['storage-disk-info']['disk-ownership-info']['home-node-name']
42 except LookupError:
43 get_owned_disks = None
44
45 api_call = self.xml_in.get_name()
46
47 if self.type == 'fail':
48 raise netapp_utils.zapi.NaApiError(code='TEST', message="This exception is from the unit test")
49 elif api_call == 'storage-disk-get-iter':
50 if container_type == 'spare':
51 xml = self.home_spare_disks()
52 elif get_owned_disks:
53 xml = self.owned_disks()
54 else:
55 xml = self.partner_spare_disks()
56 elif api_call == 'cf-status':
57 xml = self.partner_node_name()
58 self.xml_out = xml
59 return xml
60
61 @staticmethod
62 def owned_disks():
63 ''' build xml data for disk-inventory-info owned disks '''
64 xml = netapp_utils.zapi.NaElement('xml')
65 data = {
66 'attributes-list': [
67 {
68 'storage-disk-info': {
69 'disk-inventory-info': {
70 'disk-cluster-name': '1.0.8'
71 }
72 }
73 },
74 {
75 'storage-disk-info': {
76 'disk-inventory-info': {
77 'disk-cluster-name': '1.0.7'
78 }
79 }
80 },
81 {
82 'storage-disk-info': {
83 'disk-inventory-info': {
84 'disk-cluster-name': '1.0.10'
85 }
86 }
87 },
88 {
89 'storage-disk-info': {
90 'disk-inventory-info': {
91 'disk-cluster-name': '1.0.25'
92 }
93 }
94 },
95 {
96 'storage-disk-info': {
97 'disk-inventory-info': {
98 'disk-cluster-name': '1.0.18'
99 }
100 }
101 },
102 {
103 'storage-disk-info': {
104 'disk-inventory-info': {
105 'disk-cluster-name': '1.0.0'
106 }
107 }
108 },
109 {
110 'storage-disk-info': {
111 'disk-inventory-info': {
112 'disk-cluster-name': '1.0.6'
113 }
114 }
115 },
116 {
117 'storage-disk-info': {
118 'disk-inventory-info': {
119 'disk-cluster-name': '1.0.11'
120 }
121 }
122 },
123 {
124 'storage-disk-info': {
125 'disk-inventory-info': {
126 'disk-cluster-name': '1.0.12'
127 }
128 }
129 },
130 {
131 'storage-disk-info': {
132 'disk-inventory-info': {
133 'disk-cluster-name': '1.0.13'
134 }
135 }
136 },
137 {
138 'storage-disk-info': {
139 'disk-inventory-info': {
140 'disk-cluster-name': '1.0.23'
141 }
142 }
143 },
144 {
145 'storage-disk-info': {
146 'disk-inventory-info': {
147 'disk-cluster-name': '1.0.4'
148 }
149 }
150 },
151 {
152 'storage-disk-info': {
153 'disk-inventory-info': {
154 'disk-cluster-name': '1.0.9'
155 }
156 }
157 },
158 {
159 'storage-disk-info': {
160 'disk-inventory-info': {
161 'disk-cluster-name': '1.0.21'
162 }
163 }
164 },
165 {
166 'storage-disk-info': {
167 'disk-inventory-info': {
168 'disk-cluster-name': '1.0.16'
169 }
170 }
171 },
172 {
173 'storage-disk-info': {
174 'disk-inventory-info': {
175 'disk-cluster-name': '1.0.19'
176 }
177 }
178 },
179 {
180 'storage-disk-info': {
181 'disk-inventory-info': {
182 'disk-cluster-name': '1.0.2'
183 }
184 }
185 },
186 {
187 'storage-disk-info': {
188 'disk-inventory-info': {
189 'disk-cluster-name': '1.0.14'
190 }
191 }
192 },
193 {
194 'storage-disk-info': {
195 'disk-inventory-info': {
196 'disk-cluster-name': '1.0.20'
197 }
198 }
199 }
200 ],
201 'num-records': '19'
202 }
203 xml.translate_struct(data)
204 return xml
205
206 @staticmethod
207 def home_spare_disks():
208 ''' build xml data for disk-inventory-info home spare disks '''
209 xml = netapp_utils.zapi.NaElement('xml')
210 data = {
211 'attributes-list': [
212 {
213 'storage-disk-info': {
214 'disk-inventory-info': {
215 'disk-cluster-name': '1.0.9'
216 }
217 }
218 },
219 {
220 'storage-disk-info': {
221 'disk-inventory-info': {
222 'disk-cluster-name': '1.0.20'
223 }
224 }
225 },
226 {
227 'storage-disk-info': {
228 'disk-inventory-info': {
229 'disk-cluster-name': '1.0.9'
230 }
231 }
232 },
233 {
234 'storage-disk-info': {
235 'disk-inventory-info': {
236 'disk-cluster-name': '1.0.22'
237 }
238 }
239 },
240 {
241 'storage-disk-info': {
242 'disk-inventory-info': {
243 'disk-cluster-name': '1.0.13'
244 }
245 }
246 },
247 {
248 'storage-disk-info': {
249 'disk-inventory-info': {
250 'disk-cluster-name': '1.0.23'
251 }
252 }
253 },
254 {
255 'storage-disk-info': {
256 'disk-inventory-info': {
257 'disk-cluster-name': '1.0.16'
258 }
259 }
260 },
261 {
262 'storage-disk-info': {
263 'disk-inventory-info': {
264 'disk-cluster-name': '1.0.18'
265 }
266 }
267 }
268 ],
269 'num-records': '8'
270 }
271 xml.translate_struct(data)
272 return xml
273
274 @staticmethod
275 def partner_spare_disks():
276 ''' build xml data for disk-inventory-info partner spare disks '''
277 xml = netapp_utils.zapi.NaElement('xml')
278 data = {
279 'attributes-list': [
280 {
281 'storage-disk-info': {
282 'disk-inventory-info': {
283 'disk-cluster-name': '1.0.7'
284 }
285 }
286 },
287 {
288 'storage-disk-info': {
289 'disk-inventory-info': {
290 'disk-cluster-name': '1.0.15'
291 }
292 }
293 },
294 {
295 'storage-disk-info': {
296 'disk-inventory-info': {
297 'disk-cluster-name': '1.0.21'
298 }
299 }
300 },
301 {
302 'storage-disk-info': {
303 'disk-inventory-info': {
304 'disk-cluster-name': '1.0.23'
305 }
306 }
307 },
308 {
309 'storage-disk-info': {
310 'disk-inventory-info': {
311 'disk-cluster-name': '1.0.19'
312 }
313 }
314 },
315 {
316 'storage-disk-info': {
317 'disk-inventory-info': {
318 'disk-cluster-name': '1.0.11'
319 }
320 }
321 }
322 ],
323 'num-records': '6'
324 }
325 xml.translate_struct(data)
326 return xml
327
328 @staticmethod
329 def partner_node_name():
330 ''' build xml data for partner node name'''
331 xml = netapp_utils.zapi.NaElement('xml')
332 data = {
333 'cf-status': {
334 'partner-name': 'node2'
335 }
336 }
337 xml.translate_struct(data)
338 return xml
339
340 @staticmethod
341 def unassigned_disk_count():
342 ''' build xml data for the count of unassigned disks on a node '''
343 xml = netapp_utils.zapi.NaElement('xml')
344 data = {
345 'num-records': '0'
346 }
347 xml.translate_struct(data)
348 return xml
349
350
351 def default_args():
352 args = {
353 'disk_count': 15,
354 'node': 'node1',
355 'disk_type': 'SAS',
356 'hostname': '10.10.10.10',
357 'username': 'username',
358 'password': 'password',
359 'use_rest': 'always'
360 }
361 return args
362
363
364 # REST API canned responses when mocking send_request
365 SRR = {
366 # common responses
367 'is_rest': (200, dict(version=dict(generation=9, major=9, minor=0, full='dummy')), None),
368 'is_rest_9_8': (200, dict(version=dict(generation=9, major=8, minor=0, full='dummy')), None),
369 'is_zapi': (400, {}, "Unreachable"),
370 'empty_good': (200, {}, None),
371 'zero_record': (200, dict(records=[], num_records=0), None),
372 'one_record_uuid': (200, dict(records=[dict(uuid='a1b2c3')], num_records=1), None),
373 'end_of_sequence': (500, None, "Unexpected call to send_request"),
374 'generic_error': (400, None, "Expected error"),
375 'owned_disk_record': (
376 200, {
377 'records': [
378 {
379 "name": "1.0.8",
380 "type": "sas",
381 "container_type": "aggregate",
382 "home_node": {
383 "name": "node1"
384 }
385 },
386 {
387 "name": "1.0.7",
388 "type": "sas",
389 "container_type": "spare",
390 "home_node": {
391 "name": "node1"
392 }
393 },
394 {
395 "name": "1.0.10",
396 "type": "sas",
397 "container_type": "aggregate",
398 "home_node": {
399 "name": "node1"
400 }
401 },
402 {
403 "name": "1.0.18",
404 "type": "sas",
405 "container_type": "spare",
406 "home_node": {
407 "name": "node1"
408 }
409 },
410 {
411 "name": "1.0.0",
412 "type": "sas",
413 "container_type": "aggregate",
414 "home_node": {
415 "name": "node1"
416 }
417 },
418 {
419 "name": "1.0.6",
420 "type": "sas",
421 "container_type": "aggregate",
422 "home_node": {
423 "name": "node1"
424 }
425 },
426 {
427 "name": "1.0.11",
428 "type": "sas",
429 "container_type": "spare",
430 "home_node": {
431 "name": "node1"
432 }
433 },
434 {
435 "name": "1.0.12",
436 "type": "sas",
437 "container_type": "aggregate",
438 "home_node": {
439 "name": "node1"
440 }
441 },
442 {
443 "name": "1.0.13",
444 "type": "sas",
445 "container_type": "spare",
446 "home_node": {
447 "name": "node1"
448 }
449 },
450 {
451 "name": "1.0.23",
452 "type": "sas",
453 "container_type": "spare",
454 "home_node": {
455 "name": "node1"
456 }
457 },
458 {
459 "name": "1.0.22",
460 "type": "sas",
461 "container_type": "spare",
462 "home_node": {
463 "name": "node1"
464 }
465 },
466 {
467 "name": "1.0.4",
468 "type": "sas",
469 "container_type": "aggregate",
470 "home_node": {
471 "name": "node1"
472 }
473 },
474 {
475 "name": "1.0.9",
476 "type": "sas",
477 "container_type": "spare",
478 "home_node": {
479 "name": "node1"
480 }
481 },
482 {
483 "name": "1.0.21",
484 "type": "sas",
485 "container_type": "spare",
486 "home_node": {
487 "name": "node1"
488 }
489 },
490 {
491 "name": "1.0.16",
492 "type": "sas",
493 "container_type": "spare",
494 "home_node": {
495 "name": "node1"
496 }
497 },
498 {
499 "name": "1.0.19",
500 "type": "sas",
501 "container_type": "spare",
502 "home_node": {
503 "name": "node1"
504 }
505 },
506 {
507 "name": "1.0.2",
508 "type": "sas",
509 "container_type": "aggregate",
510 "home_node": {
511 "name": "node1"
512 }
513 },
514 {
515 "name": "1.0.14",
516 "type": "sas",
517 "container_type": "aggregate",
518 "home_node": {
519 "name": "node1"
520 }
521 },
522 {
523 "name": "1.0.20",
524 "type": "sas",
525 "container_type": "spare",
526 "home_node": {
527 "name": "node1"
528 }
529 }
530 ],
531 'num_records': 19},
532 None),
533
534 # 'owned_disk_record': (200, {'num_records': 15}),
535 'unassigned_disk_record': (
536 200, {
537 'records': [],
538 'num_records': 0},
539 None),
540 'home_spare_disk_info_record': (
541 200, {'records': [
542 {
543 'name': '1.0.20',
544 'type': 'sas',
545 'container_type': 'spare',
546 'home_node': {'name': 'node1'}},
547 {
548 'name': '1.0.9',
549 'type': 'sas',
550 'container_type': 'spare',
551 'home_node': {'name': 'node1'}},
552 {
553 'name': '1.0.22',
554 'type': 'sas',
555 'container_type': 'spare',
556 'home_node': {'name': 'node1'}},
557 {
558 'name': '1.0.13',
559 'type': 'sas',
560 'container_type': 'spare',
561 'home_node': {'name': 'node1'}},
562 {
563 'name': '1.0.17',
564 'type': 'sas',
565 'container_type': 'spare',
566 'home_node': {'name': 'node1'}},
567 {
568 'name': '1.0.23',
569 'type': 'sas',
570 'container_type': 'spare',
571 'home_node': {'name': 'node1'}},
572 {
573 'name': '1.0.16',
574 'type': 'sas',
575 'container_type': 'spare',
576 'home_node': {'name': 'node1'}},
577 {
578 'name': '1.0.18',
579 'type': 'sas',
580 'container_type': 'spare',
581 'home_node': {'name': 'node1'}}
582 ],
583 'num_records': 8,
584 '_links': {'self': {'href': '/api/storage/disks?home_node.name=node1&container_type=spare&type=SAS&fields=name'}}},
585 None),
586
587 'partner_node_name_record': (
588 200, {'records': [
589 {
590 'uuid': 'c345c182-a6a0-11eb-af7b-00a0984839de',
591 'name': 'node2',
592 'ha': {
593 'partners': [
594 {'name': 'node1'}
595 ]
596 }
597 }
598 ],
599 'num_records': 1},
600 None),
601
602 'partner_spare_disk_info_record': (
603 200, {'records': [
604 {
605 'name': '1.0.7',
606 'type': 'sas',
607 'container_type': 'spare',
608 'home_node': {'name': 'node2'}
609 },
610 {
611 'name': '1.0.15',
612 'type': 'sas',
613 'container_type': 'spare',
614 'home_node': {'name': 'node2'}
615 },
616 {
617 'name': '1.0.21',
618 'type': 'sas',
619 'container_type': 'spare',
620 'home_node': {'name': 'node2'}
621 },
622 {
623 'name': '1.0.23',
624 'type': 'sas',
625 'container_type': 'spare',
626 'home_node': {'name': 'node2'}
627 },
628 {
629 'name': '1.0.19',
630 'type': 'sas',
631 'container_type': 'spare',
632 'home_node': {'name': 'node2'}
633 },
634 {
635 'name': '1.0.11',
636 'type': 'sas',
637 'container_type': 'spare',
638 'home_node': {'name': 'node2'}
639 }
640 ],
641 'num_records': 6},
642 None)
643 }
644
645
646 def test_successful_assign(patch_ansible):
647 ''' successful assign and test idempotency '''
648 args = dict(default_args())
649 args['use_rest'] = 'never'
650 args['disk_count'] = '20'
651 set_module_args(args)
652 my_obj = my_module()
653 my_obj.server = MockONTAPConnection()
654 my_obj.ems_log_event = Mock(return_value=None)
655 with pytest.raises(AnsibleExitJson) as exc:
656 my_obj.apply()
657 print('Create: ' + repr(exc.value))
658 assert exc.value.args[0]['changed']
659 # mock_create.assert_called_with()
660 args['use_rest'] = 'never'
661 args['disk_count'] = '19'
662 set_module_args(args)
663 my_obj = my_module()
664 my_obj.server = MockONTAPConnection()
665 my_obj.ems_log_event = Mock(return_value=None)
666 with pytest.raises(AnsibleExitJson) as exc:
667 my_obj.apply()
668 print('Create: ' + repr(exc.value))
669 assert not exc.value.args[0]['changed']
670
671
672 def test_successful_unassign(patch_ansible):
673 ''' successful assign and test idempotency '''
674 args = dict(default_args())
675 args['use_rest'] = 'never'
676 args['disk_count'] = '17'
677 set_module_args(args)
678 my_obj = my_module()
679 my_obj.server = MockONTAPConnection()
680 my_obj.ems_log_event = Mock(return_value=None)
681 with pytest.raises(AnsibleExitJson) as exc:
682 my_obj.apply()
683 print('Create: ' + repr(exc.value))
684 assert exc.value.args[0]['changed']
685 # mock_create.assert_called_with()
686 args['use_rest'] = 'never'
687 args['disk_count'] = '19'
688 set_module_args(args)
689 my_obj = my_module()
690 my_obj.server = MockONTAPConnection()
691 my_obj.ems_log_event = Mock(return_value=None)
692 with pytest.raises(AnsibleExitJson) as exc:
693 my_obj.apply()
694 print('Create: ' + repr(exc.value))
695 assert not exc.value.args[0]['changed']
696
697
698 def test_module_fail_when_required_args_missing(patch_ansible):
699 ''' required arguments are reported as errors '''
700 with pytest.raises(AnsibleFailJson) as exc:
701 set_module_args({})
702 my_module()
703 print('Info: %s' % exc.value.args[0]['msg'])
704
705
706 def test_ensure_get_called(patch_ansible):
707 ''' test get_disks '''
708 args = dict(default_args())
709 args['use_rest'] = 'never'
710 set_module_args(args)
711 print('starting')
712 my_obj = my_module()
713 print('use_rest:', my_obj.use_rest)
714 my_obj.server = MockONTAPConnection()
715 assert my_obj.get_disks is not None
716
717
718 def test_rest_missing_arguments(patch_ansible): # pylint: disable=redefined-outer-name,unused-argument ##WHAT DOES THIS METHOD DO
719 ''' create scope '''
720 args = dict(default_args())
721 del args['hostname']
722 set_module_args(args)
723 with pytest.raises(AnsibleFailJson) as exc:
724 my_module()
725 msg = 'missing required arguments: hostname'
726 assert exc.value.args[0]['msg'] == msg
727
728
729 def test_if_all_methods_catch_exception(patch_ansible):
730 args = dict(default_args())
731 args['use_rest'] = 'never'
732 set_module_args(args)
733 my_obj = my_module()
734 my_obj.server = MockONTAPConnection('fail')
735 with pytest.raises(AnsibleFailJson) as exc:
736 my_obj.get_disks(container_type='owned', node='node1')
737 assert 'Error getting disk ' in exc.value.args[0]['msg']
738 with pytest.raises(AnsibleFailJson) as exc:
739 my_obj.get_disks(container_type='unassigned')
740 assert 'Error getting disk ' in exc.value.args[0]['msg']
741 with pytest.raises(AnsibleFailJson) as exc:
742 my_obj.get_disks(container_type='spare', node='node1')
743 assert 'Error getting disk ' in exc.value.args[0]['msg']
744 with pytest.raises(AnsibleFailJson) as exc:
745 my_obj.get_partner_node_name()
746 assert 'Error getting partner name ' in exc.value.args[0]['msg']
747 with pytest.raises(AnsibleFailJson) as exc:
748 my_obj.disk_assign(needed_disks=2)
749 assert 'Error assigning disks ' in exc.value.args[0]['msg']
750 with pytest.raises(AnsibleFailJson) as exc:
751 my_obj.disk_unassign(['1.0.0', '1.0.1'])
752 assert 'Error unassigning disks ' in exc.value.args[0]['msg']
753
754
755 @patch('ansible_collections.netapp.ontap.plugins.module_utils.netapp.OntapRestAPI.send_request')
756 def test_rest_assign(mock_request, patch_ansible): # pylint: disable=redefined-outer-name,unused-argument
757 ''' Steal disks from partner node and assign them to the requested node '''
758 args = dict(default_args())
759 set_module_args(args)
760 mock_request.side_effect = [
761 SRR['is_rest'],
762 SRR['owned_disk_record'],
763 SRR['unassigned_disk_record'],
764 SRR['home_spare_disk_info_record'],
765 SRR['partner_node_name_record'],
766 SRR['partner_spare_disk_info_record'],
767 SRR['empty_good'], # unassign
768 SRR['empty_good'], # assign
769 SRR['end_of_sequence']
770 ]
771 my_obj = my_module()
772 with pytest.raises(AnsibleExitJson) as exc:
773 my_obj.apply()
774 assert exc.value.args[0]['changed'] is True
775 print(mock_request.mock_calls)
776 assert len(mock_request.mock_calls) == 8
777
778
779 @patch('ansible_collections.netapp.ontap.plugins.module_utils.netapp.OntapRestAPI.send_request')
780 def test_rest_unassign(mock_request, patch_ansible): # pylint: disable=redefined-outer-name,unused-argument
781 ''' Steal disks from partner node and assign them to the requested node '''
782 args = dict(default_args())
783 args['disk_count'] = 17
784 print(args)
785 set_module_args(args)
786 mock_request.side_effect = [
787 SRR['is_rest'],
788 SRR['owned_disk_record'],
789 SRR['unassigned_disk_record'],
790 SRR['home_spare_disk_info_record'],
791 SRR['partner_node_name_record'],
792 SRR['partner_spare_disk_info_record'],
793 SRR['empty_good'], # unassign
794 SRR['end_of_sequence']
795 ]
796 my_obj = my_module()
797 with pytest.raises(AnsibleExitJson) as exc:
798 my_obj.apply()
799 assert exc.value.args[0]['changed'] is True
800 print(mock_request.mock_calls)
801 assert len(mock_request.mock_calls) == 6
802
803
804 @patch('ansible_collections.netapp.ontap.plugins.module_utils.netapp.OntapRestAPI.send_request')
805 def test_rest_no_action(mock_request, patch_ansible): # pylint: disable=redefined-outer-name,unused-argument
806 ''' disk_count matches arguments, do nothing '''
807 args = dict(default_args())
808 args['disk_count'] = 19
809 set_module_args(args)
810 mock_request.side_effect = [
811 SRR['is_rest'],
812 SRR['owned_disk_record'],
813 SRR['unassigned_disk_record'],
814 SRR['home_spare_disk_info_record'], # get
815 SRR['end_of_sequence']
816 ]
817 my_obj = my_module()
818 with pytest.raises(AnsibleExitJson) as exc:
819 my_obj.apply()
820 assert exc.value.args[0]['changed'] is False
821 print(mock_request.mock_calls)
822 assert len(mock_request.mock_calls) == 4