| 1 |
# (c) 2019, 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, Mock |
| 12 |
import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils |
| 13 |
# pylint: disable=unused-import |
| 14 |
from ansible_collections.netapp.ontap.tests.unit.plugins.module_utils.ansible_mocks import set_module_args, \ |
| 15 |
AnsibleFailJson, AnsibleExitJson, patch_ansible |
| 16 |
|
| 17 |
from ansible_collections.netapp.ontap.plugins.modules.na_ontap_ndmp \ |
| 18 |
import NetAppONTAPNdmp as ndmp_module # module under test |
| 19 |
|
| 20 |
if not netapp_utils.has_netapp_lib(): |
| 21 |
pytestmark = pytest.mark.skip('skipping as missing required netapp_lib') |
| 22 |
|
| 23 |
# REST API canned responses when mocking send_request |
| 24 |
SRR = { |
| 25 |
# common responses |
| 26 |
'is_rest': (200, {}, None), |
| 27 |
'is_zapi': (400, {}, "Unreachable"), |
| 28 |
'get_uuid': (200, {'records': [{'uuid': 'testuuid'}]}, None), |
| 29 |
'empty_good': (200, {}, None), |
| 30 |
'end_of_sequence': (500, None, "Unexpected call to send_request"), |
| 31 |
'generic_error': (400, None, 'Error fetching ndmp from ansible: NetApp API failed. Reason - Unexpected error:', |
| 32 |
"REST API currently does not support 'backup_log_enable, ignore_ctime_enabled'"), |
| 33 |
'get_ndmp_uuid': (200, {"records": [{"svm": {"name": "svm1", "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"}}]}, None), |
| 34 |
'get_ndmp': (200, {"enabled": True, "authentication_types": ["test"], |
| 35 |
"records": [{"svm": {"name": "svm1", "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"}}]}, None) |
| 36 |
} |
| 37 |
|
| 38 |
|
| 39 |
class MockONTAPConnection(object): |
| 40 |
''' mock server connection to ONTAP host ''' |
| 41 |
|
| 42 |
def __init__(self, kind=None, data=None): |
| 43 |
''' save arguments ''' |
| 44 |
self.type = kind |
| 45 |
self.data = data |
| 46 |
self.xml_in = None |
| 47 |
self.xml_out = None |
| 48 |
|
| 49 |
def invoke_successfully(self, xml, enable_tunneling): # pylint: disable=unused-argument |
| 50 |
''' mock invoke_successfully returning xml data ''' |
| 51 |
self.xml_in = xml |
| 52 |
if self.type == 'ndmp': |
| 53 |
xml = self.build_ndmp_info(self.data) |
| 54 |
if self.type == 'error': |
| 55 |
error = netapp_utils.zapi.NaApiError('test', 'error') |
| 56 |
raise error |
| 57 |
self.xml_out = xml |
| 58 |
return xml |
| 59 |
|
| 60 |
@staticmethod |
| 61 |
def build_ndmp_info(ndmp_details): |
| 62 |
''' build xml data for ndmp ''' |
| 63 |
xml = netapp_utils.zapi.NaElement('xml') |
| 64 |
attributes = { |
| 65 |
'num-records': 1, |
| 66 |
'attributes-list': { |
| 67 |
'ndmp-vserver-attributes-info': { |
| 68 |
'ignore_ctime_enabled': ndmp_details['ignore_ctime_enabled'], |
| 69 |
'backup_log_enable': ndmp_details['backup_log_enable'], |
| 70 |
|
| 71 |
'authtype': [ |
| 72 |
{'ndmpd-authtypes': 'plaintext'}, |
| 73 |
{'ndmpd-authtypes': 'challenge'} |
| 74 |
] |
| 75 |
} |
| 76 |
} |
| 77 |
} |
| 78 |
xml.translate_struct(attributes) |
| 79 |
return xml |
| 80 |
|
| 81 |
|
| 82 |
class TestMyModule(unittest.TestCase): |
| 83 |
''' a group of related Unit Tests ''' |
| 84 |
|
| 85 |
def setUp(self): |
| 86 |
self.mock_ndmp = { |
| 87 |
'ignore_ctime_enabled': True, |
| 88 |
'backup_log_enable': 'false', |
| 89 |
'authtype': 'plaintext', |
| 90 |
'enable': True |
| 91 |
} |
| 92 |
|
| 93 |
def mock_args(self, rest=False): |
| 94 |
if rest: |
| 95 |
return { |
| 96 |
'authtype': self.mock_ndmp['authtype'], |
| 97 |
'enable': True, |
| 98 |
'vserver': 'ansible', |
| 99 |
'hostname': 'test', |
| 100 |
'username': 'test_user', |
| 101 |
'password': 'test_pass!', |
| 102 |
'https': 'False' |
| 103 |
} |
| 104 |
else: |
| 105 |
return { |
| 106 |
'vserver': 'ansible', |
| 107 |
'authtype': self.mock_ndmp['authtype'], |
| 108 |
'ignore_ctime_enabled': self.mock_ndmp['ignore_ctime_enabled'], |
| 109 |
'backup_log_enable': self.mock_ndmp['backup_log_enable'], |
| 110 |
'enable': self.mock_ndmp['enable'], |
| 111 |
'hostname': 'test', |
| 112 |
'username': 'test_user', |
| 113 |
'password': 'test_pass!', |
| 114 |
'use_rest': 'never' |
| 115 |
} |
| 116 |
|
| 117 |
def get_ndmp_mock_object(self, kind=None, cx_type='zapi'): |
| 118 |
""" |
| 119 |
Helper method to return an na_ontap_ndmp object |
| 120 |
:param kind: passes this param to MockONTAPConnection() |
| 121 |
:return: na_ontap_ndmp object |
| 122 |
""" |
| 123 |
obj = ndmp_module() |
| 124 |
if cx_type == 'zapi': |
| 125 |
obj.asup_log_for_cserver = Mock(return_value=None) |
| 126 |
obj.server = Mock() |
| 127 |
obj.server.invoke_successfully = Mock() |
| 128 |
if kind is None: |
| 129 |
obj.server = MockONTAPConnection() |
| 130 |
else: |
| 131 |
obj.server = MockONTAPConnection(kind=kind, data=self.mock_ndmp) |
| 132 |
return obj |
| 133 |
|
| 134 |
@patch('ansible_collections.netapp.ontap.plugins.modules.na_ontap_ndmp.NetAppONTAPNdmp.ndmp_get_iter') |
| 135 |
def test_successful_modify(self, ger_ndmp): |
| 136 |
''' Test successful modify ndmp''' |
| 137 |
data = self.mock_args() |
| 138 |
set_module_args(data) |
| 139 |
current = { |
| 140 |
'ignore_ctime_enabled': False, |
| 141 |
'backup_log_enable': True |
| 142 |
} |
| 143 |
ger_ndmp.side_effect = [ |
| 144 |
current |
| 145 |
] |
| 146 |
with pytest.raises(AnsibleExitJson) as exc: |
| 147 |
self.get_ndmp_mock_object('ndmp').apply() |
| 148 |
assert exc.value.args[0]['changed'] |
| 149 |
|
| 150 |
@patch('ansible_collections.netapp.ontap.plugins.modules.na_ontap_ndmp.NetAppONTAPNdmp.ndmp_get_iter') |
| 151 |
def test_modify_error(self, ger_ndmp): |
| 152 |
''' Test modify error ''' |
| 153 |
data = self.mock_args() |
| 154 |
set_module_args(data) |
| 155 |
current = { |
| 156 |
'ignore_ctime_enabled': False, |
| 157 |
'backup_log_enable': True |
| 158 |
} |
| 159 |
ger_ndmp.side_effect = [ |
| 160 |
current |
| 161 |
] |
| 162 |
with pytest.raises(AnsibleFailJson) as exc: |
| 163 |
self.get_ndmp_mock_object('error').apply() |
| 164 |
assert exc.value.args[0]['msg'] == 'Error modifying ndmp on ansible: NetApp API failed. Reason - test:error' |
| 165 |
|
| 166 |
@patch('ansible_collections.netapp.ontap.plugins.module_utils.netapp.OntapRestAPI.send_request') |
| 167 |
def test_rest_error(self, mock_request): |
| 168 |
data = self.mock_args() |
| 169 |
data['use_rest'] = 'Always' |
| 170 |
set_module_args(data) |
| 171 |
mock_request.side_effect = [ |
| 172 |
SRR['is_rest'], |
| 173 |
SRR['generic_error'], |
| 174 |
SRR['end_of_sequence'] |
| 175 |
] |
| 176 |
with pytest.raises(AnsibleFailJson) as exc: |
| 177 |
self.get_ndmp_mock_object(cx_type='rest').apply() |
| 178 |
assert exc.value.args[0]['msg'] == SRR['generic_error'][3] |
| 179 |
|
| 180 |
@patch('ansible_collections.netapp.ontap.plugins.module_utils.netapp.OntapRestAPI.send_request') |
| 181 |
def test_rest_successfully_modify(self, mock_request): |
| 182 |
data = self.mock_args(rest=True) |
| 183 |
data['use_rest'] = 'Always' |
| 184 |
set_module_args(data) |
| 185 |
mock_request.side_effect = [ |
| 186 |
SRR['is_rest'], # Was not called because of Always, but we now call it :) |
| 187 |
SRR['get_ndmp_uuid'], # for get svm uuid: protocols/ndmp/svms |
| 188 |
SRR['get_ndmp'], # for get ndmp details: '/protocols/ndmp/svms/' + uuid |
| 189 |
SRR['get_ndmp_uuid'], # for get svm uuid: protocols/ndmp/svms (before modify) |
| 190 |
SRR['empty_good'], # modify (patch) |
| 191 |
SRR['end_of_sequence'], |
| 192 |
] |
| 193 |
my_obj = ndmp_module() |
| 194 |
with pytest.raises(AnsibleExitJson) as exc: |
| 195 |
my_obj.apply() |
| 196 |
assert exc.value.args[0]['changed'] |