Debian Codegraph @

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

raw
1 # (c) 2018-2022, 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_ucadapter '''
5
6 from __future__ import (absolute_import, division, print_function)
7 __metaclass__ = type
8 import pytest
9 import sys
10 import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils
11 # pylint: disable=unused-import
12 from ansible_collections.netapp.ontap.tests.unit.plugins.module_utils.ansible_mocks import patch_ansible, \
13 create_module, create_and_apply, expect_and_capture_ansible_exception
14 from ansible_collections.netapp.ontap.tests.unit.framework.mock_rest_and_zapi_requests import patch_request_and_invoke, \
15 register_responses
16 from ansible_collections.netapp.ontap.tests.unit.framework.rest_factory import rest_responses
17 from ansible_collections.netapp.ontap.tests.unit.framework.zapi_factory import build_zapi_response, zapi_responses
18 from ansible_collections.netapp.ontap.plugins.modules.na_ontap_ucadapter \
19 import NetAppOntapadapter as ucadapter_module # module under test
20
21 if not netapp_utils.has_netapp_lib():
22 pytestmark = pytest.mark.skip('skipping as missing required netapp_lib')
23
24 if not netapp_utils.HAS_REQUESTS and sys.version_info < (2, 7):
25 pytestmark = pytest.mark.skip('Skipping Unit Tests on 2.6 as requests is not be available')
26
27 DEFAULT_ARGS = {
28 'hostname': '10.0.0.0',
29 'username': 'user',
30 'password': 'pass',
31 'node_name': 'node1',
32 'adapter_name': '0f',
33 'mode': 'fc',
34 'type': 'target',
35 'use_rest': 'never'
36 }
37
38 ucm_info_mode_fc = {
39 'attributes': {
40 'uc-adapter-info': {
41 'mode': 'fc',
42 'pending-mode': 'abc',
43 'type': 'target',
44 'pending-type': 'intitiator',
45 'status': 'up',
46 }
47 }
48 }
49
50 ucm_info_mode_cna = {
51 'attributes': {
52 'uc-adapter-info': {
53 'mode': 'cna',
54 'pending-mode': 'cna',
55 'type': 'target',
56 'pending-type': 'intitiator',
57 'status': 'up',
58 }
59 }
60 }
61
62
63 ZRR = zapi_responses({
64 'ucm_info': build_zapi_response(ucm_info_mode_fc),
65 'ucm_info_cna': build_zapi_response(ucm_info_mode_cna)
66 })
67
68
69 SRR = rest_responses({
70 'ucm_info': (200, {"records": [{
71 'current_mode': 'fc',
72 'current_type': 'target',
73 'status_admin': 'up'
74 }], "num_records": 1}, None),
75 'ucm_info_cna': (200, {"records": [{
76 'current_mode': 'cna',
77 'current_type': 'target',
78 'status_admin': 'up'
79 }], "num_records": 1}, None),
80 'fc_adapter_info': (200, {"records": [{
81 'uuid': 'abcdef'
82 }], "num_records": 1}, None)
83 })
84
85
86 def test_module_fail_when_required_args_missing():
87 ''' required arguments are reported as errors '''
88 # with python 2.6, dictionaries are not ordered
89 fragments = ["missing required arguments:", "hostname", "node_name", "adapter_name"]
90 error = create_module(ucadapter_module, {}, fail=True)['msg']
91 for fragment in fragments:
92 assert fragment in error
93
94
95 def test_ensure_ucadapter_get_called():
96 ''' fetching ucadapter details '''
97 register_responses([
98 ('ucm-adapter-get', ZRR['empty'])
99 ])
100 ucm_obj = create_module(ucadapter_module, DEFAULT_ARGS)
101 assert ucm_obj.get_adapter() is None
102
103
104 def test_change_mode_from_cna_to_fc():
105 ''' configuring ucadaptor and checking idempotency '''
106 register_responses([
107 ('ucm-adapter-get', ZRR['ucm_info_cna']),
108 ('fcp-adapter-config-down', ZRR['success']),
109 ('ucm-adapter-modify', ZRR['success']),
110 ('fcp-adapter-config-up', ZRR['success']),
111 ('ucm-adapter-get', ZRR['ucm_info_cna'])
112 ])
113 assert create_and_apply(ucadapter_module, DEFAULT_ARGS)['changed']
114 args = {'mode': 'cna'}
115 assert not create_and_apply(ucadapter_module, DEFAULT_ARGS, args)['changed']
116
117
118 def test_change_mode_from_fc_to_cna():
119 register_responses([
120 ('ucm-adapter-get', ZRR['ucm_info']),
121 ('fcp-adapter-config-down', ZRR['success']),
122 ('ucm-adapter-modify', ZRR['success']),
123 ('fcp-adapter-config-up', ZRR['success']),
124 ])
125 args = {'mode': 'cna'}
126 assert create_and_apply(ucadapter_module, DEFAULT_ARGS, args)['changed']
127
128
129 def test_if_all_methods_catch_exception():
130 register_responses([
131 ('ucm-adapter-get', ZRR['error']),
132 ('ucm-adapter-modify', ZRR['error']),
133 ('fcp-adapter-config-down', ZRR['error']),
134 ('fcp-adapter-config-up', ZRR['error']),
135 ('GET', 'cluster', SRR['is_rest_9_9_0']),
136 ('GET', 'network/fc/ports', SRR['generic_error']),
137 ('GET', 'private/cli/ucadmin', SRR['generic_error']),
138 ('PATCH', 'private/cli/ucadmin', SRR['generic_error']),
139 ('PATCH', 'network/fc/ports/abcdef', SRR['generic_error']),
140 ('PATCH', 'network/fc/ports/abcdef', SRR['generic_error']),
141 ('GET', 'network/fc/ports', SRR['empty_records'])
142 ])
143 ucm_obj = create_module(ucadapter_module, DEFAULT_ARGS)
144 assert 'Error fetching ucadapter' in expect_and_capture_ansible_exception(ucm_obj.get_adapter, 'fail')['msg']
145 assert 'Error modifying adapter' in expect_and_capture_ansible_exception(ucm_obj.modify_adapter, 'fail')['msg']
146 assert 'Error trying to down' in expect_and_capture_ansible_exception(ucm_obj.online_or_offline_adapter, 'fail', 'down', '0f')['msg']
147 assert 'Error trying to up' in expect_and_capture_ansible_exception(ucm_obj.online_or_offline_adapter, 'fail', 'up', '0f')['msg']
148
149 ucm_obj = create_module(ucadapter_module, DEFAULT_ARGS, {'use_rest': 'always'})
150 ucm_obj.adapters_uuids = {'0f': 'abcdef'}
151 assert 'Error fetching adapter 0f uuid' in expect_and_capture_ansible_exception(ucm_obj.get_adapter_uuid, 'fail', '0f')['msg']
152 assert 'Error fetching ucadapter' in expect_and_capture_ansible_exception(ucm_obj.get_adapter, 'fail')['msg']
153 assert 'Error modifying adapter' in expect_and_capture_ansible_exception(ucm_obj.modify_adapter, 'fail')['msg']
154 assert 'Error trying to down' in expect_and_capture_ansible_exception(ucm_obj.online_or_offline_adapter, 'fail', 'down', '0f')['msg']
155 assert 'Error trying to up' in expect_and_capture_ansible_exception(ucm_obj.online_or_offline_adapter, 'fail', 'up', '0f')['msg']
156 assert 'Error: Adapter(s) 0f not exist' in expect_and_capture_ansible_exception(ucm_obj.get_adapters_uuids, 'fail')['msg']
157
158
159 def test_change_mode_from_cna_to_fc_rest():
160 ''' configuring ucadaptor '''
161 register_responses([
162 ('GET', 'cluster', SRR['is_rest_9_9_0']),
163 ('GET', 'private/cli/ucadmin', SRR['ucm_info_cna']),
164 ('GET', 'network/fc/ports', SRR['fc_adapter_info']),
165 ('PATCH', 'network/fc/ports/abcdef', SRR['success']),
166 ('PATCH', 'private/cli/ucadmin', SRR['success']),
167 ('PATCH', 'network/fc/ports/abcdef', SRR['success']),
168 ('GET', 'cluster', SRR['is_rest_9_9_0']),
169 ('GET', 'private/cli/ucadmin', SRR['ucm_info_cna'])
170 ])
171 assert create_and_apply(ucadapter_module, DEFAULT_ARGS, {'use_rest': 'always'})['changed']
172 args = {'mode': 'cna', 'use_rest': 'always'}
173 assert not create_and_apply(ucadapter_module, DEFAULT_ARGS, args)['changed']