Debian Codegraph @

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

raw
1 # (c) 2018, 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 pytest
9
10 from ansible_collections.netapp.ontap.tests.unit.compat import unittest
11 from ansible_collections.netapp.ontap.tests.unit.compat.mock import patch
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 import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils
16
17 from ansible_collections.netapp.ontap.plugins.modules.na_ontap_node \
18 import NetAppOntapNode as node_module # module under test
19
20
21 if not netapp_utils.has_netapp_lib():
22 pytestmark = pytest.mark.skip('skipping as missing required netapp_lib')
23
24 # REST API canned responses when mocking send_request
25 SRR = {
26 # common responses
27 'is_rest': (200, {}, None),
28 'is_zapi': (400, {}, "Unreachable"),
29 'empty_good': (200, {}, None),
30 'end_of_sequence': (500, None, "Unexpected call to send_request"),
31 'generic_error': (400, None, "Expected error"),
32 'node_record': (200, {"num_records": 1, "records": [
33 {
34 "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7",
35 "name": 'node1',
36 "location": 'myloc'}
37 ]}, None)
38 }
39
40
41 class MockONTAPConnection(object):
42 ''' mock server connection to ONTAP host '''
43
44 def __init__(self, kind=None, data=None):
45 ''' save arguments '''
46 self.type = kind
47 self.params = data
48 self.xml_in = None
49 self.xml_out = None
50
51 def invoke_successfully(self, xml, enable_tunneling): # pylint: disable=unused-argument
52 ''' mock invoke_successfully returning xml data '''
53 self.xml_in = xml
54 if self.type == 'node':
55 xml = self.build_node_info()
56 elif self.type == 'node_fail':
57 raise netapp_utils.zapi.NaApiError(code='TEST', message="This exception is from the unit test")
58 self.xml_out = xml
59 return xml
60
61 @staticmethod
62 def build_node_info():
63 ''' build xml data for node-details-info '''
64 xml = netapp_utils.zapi.NaElement('xml')
65 data = {
66 'attributes': {
67 'node-details-info': {
68 "node": "node1",
69 "node-location": "myloc",
70 "node-asset-tag": "mytag"
71 }
72 }
73 }
74 xml.translate_struct(data)
75 return xml
76
77
78 class TestMyModule(unittest.TestCase):
79 ''' a group of related Unit Tests '''
80
81 def set_default_args(self, use_rest=None):
82 hostname = '10.10.10.10'
83 username = 'username'
84 password = 'password'
85 name = 'node1'
86
87 args = dict({
88 'hostname': hostname,
89 'username': username,
90 'password': password,
91 'name': name,
92 'location': 'myloc'
93 })
94
95 if use_rest is not None:
96 args['use_rest'] = use_rest
97
98 return args
99
100 @staticmethod
101 def get_node_mock_object(cx_type='zapi', kind=None):
102 node_obj = node_module()
103 if cx_type == 'zapi':
104 if kind is None:
105 node_obj.server = MockONTAPConnection()
106 else:
107 node_obj.server = MockONTAPConnection(kind=kind)
108 return node_obj
109
110 def test_ensure_get_called(self):
111 ''' test get_node for non-existent entry'''
112 set_module_args(self.set_default_args(use_rest='Never'))
113 print('starting')
114 my_obj = node_module()
115 print('use_rest:', my_obj.use_rest)
116 my_obj.cluster = MockONTAPConnection('node')
117 assert my_obj.get_node is not None
118
119 def test_successful_rename(self):
120 ''' renaming node and testing idempotency '''
121 data = self.set_default_args(use_rest='Never')
122 data['from_name'] = 'node1'
123 data['name'] = 'node2'
124 set_module_args(data)
125 my_obj = node_module()
126 my_obj.cluster = MockONTAPConnection('node')
127 with pytest.raises(AnsibleExitJson) as exc:
128 my_obj.apply()
129 assert exc.value.args[0]['changed']
130 # to reset na_helper from remembering the previous 'changed' value
131 data['name'] = 'node1'
132 set_module_args(data)
133 my_obj = node_module()
134 my_obj.cluster = MockONTAPConnection('node')
135 with pytest.raises(AnsibleExitJson) as exc:
136 my_obj.apply()
137 assert not exc.value.args[0]['changed']
138
139 def test_successful_modify(self):
140 ''' modifying node and testing idempotency '''
141 data = self.set_default_args(use_rest='Never')
142 data['location'] = 'myloc1'
143 set_module_args(data)
144 my_obj = node_module()
145 my_obj.cluster = MockONTAPConnection('node')
146 with pytest.raises(AnsibleExitJson) as exc:
147 my_obj.apply()
148 assert exc.value.args[0]['changed']
149 # to reset na_helper from remembering the previous 'changed' value
150 data['location'] = 'myloc'
151 set_module_args(data)
152 my_obj = node_module()
153 my_obj.cluster = MockONTAPConnection('node')
154 with pytest.raises(AnsibleExitJson) as exc:
155 my_obj.apply()
156 assert not exc.value.args[0]['changed']
157
158 def test_if_all_methods_catch_exception(self):
159 data = self.set_default_args(use_rest='Never')
160 data['from_name'] = 'node1'
161 data['name'] = 'node2'
162 set_module_args(data)
163 my_obj = node_module()
164 my_obj.cluster = MockONTAPConnection('node_fail')
165 with pytest.raises(AnsibleFailJson) as exc:
166 my_obj.rename_node()
167 assert 'Error renaming node: ' in exc.value.args[0]['msg']
168 data = self.set_default_args(use_rest='Never')
169 data['location'] = 'myloc1'
170 set_module_args(data)
171 my_obj1 = node_module()
172 my_obj1.cluster = MockONTAPConnection('node_fail')
173 with pytest.raises(AnsibleFailJson) as exc:
174 my_obj1.modify_node()
175 assert 'Error modifying node: ' in exc.value.args[0]['msg']
176
177 @patch('ansible_collections.netapp.ontap.plugins.module_utils.netapp.OntapRestAPI.send_request')
178 def test_successful_modify_rest(self, mock_request):
179 data = self.set_default_args()
180 data['from_name'] = 'node2'
181 data['location'] = 'mylocnew'
182 set_module_args(data)
183 mock_request.side_effect = [
184 SRR['is_rest'],
185 SRR['node_record'], # get
186 SRR['empty_good'], # no response for modify
187 SRR['end_of_sequence']
188 ]
189 with pytest.raises(AnsibleExitJson) as exc:
190 self.get_node_mock_object(cx_type='rest').apply()
191 assert exc.value.args[0]['changed']
192
193 @patch('ansible_collections.netapp.ontap.plugins.module_utils.netapp.OntapRestAPI.send_request')
194 def test_successful_rename_rest(self, mock_request):
195 data = self.set_default_args()
196 data['from_name'] = 'node'
197 data['name'] = 'node2'
198 set_module_args(data)
199 mock_request.side_effect = [
200 SRR['is_rest'],
201 SRR['node_record'], # get
202 SRR['empty_good'], # no response for modify
203 SRR['end_of_sequence']
204 ]
205 with pytest.raises(AnsibleExitJson) as exc:
206 self.get_node_mock_object(cx_type='rest').apply()
207 assert exc.value.args[0]['changed']
208
209 @patch('ansible_collections.netapp.ontap.plugins.module_utils.netapp.OntapRestAPI.send_request')
210 def test_successful_modify_location_rest(self, mock_request):
211 data = self.set_default_args()
212 data['location'] = 'mylocnew'
213 set_module_args(data)
214 mock_request.side_effect = [
215 SRR['is_rest'],
216 SRR['node_record'], # get
217 SRR['empty_good'], # no response for modify
218 SRR['end_of_sequence']
219 ]
220 with pytest.raises(AnsibleExitJson) as exc:
221 self.get_node_mock_object(cx_type='rest').apply()
222 assert exc.value.args[0]['changed']