| 1 |
# (c) 2018, NTT Europe Ltd. |
| 2 |
# (c) 2023, NetApp, Inc |
| 3 |
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) |
| 4 |
|
| 5 |
""" unit test for Ansible module: na_ontap_ipspace """ |
| 6 |
|
| 7 |
from __future__ import (absolute_import, division, print_function) |
| 8 |
__metaclass__ = type |
| 9 |
import pytest |
| 10 |
|
| 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, patch_ansible, create_module, create_and_apply, expect_and_capture_ansible_exception |
| 15 |
from ansible_collections.netapp.ontap.tests.unit.framework.mock_rest_and_zapi_requests import patch_request_and_invoke, \ |
| 16 |
register_responses |
| 17 |
from ansible_collections.netapp.ontap.tests.unit.framework.rest_factory import rest_responses |
| 18 |
from ansible_collections.netapp.ontap.tests.unit.framework.zapi_factory import build_zapi_response, zapi_responses |
| 19 |
|
| 20 |
from ansible_collections.netapp.ontap.plugins.modules.na_ontap_ipspace \ |
| 21 |
import NetAppOntapIpspace as my_module # module under test |
| 22 |
|
| 23 |
if not netapp_utils.has_netapp_lib(): |
| 24 |
pytestmark = pytest.mark.skip('skipping as missing required netapp_lib') |
| 25 |
|
| 26 |
|
| 27 |
DEFAULT_ARGS = { |
| 28 |
"hostname": "10.10.10.10", |
| 29 |
"username": "admin", |
| 30 |
"password": "netapp1!", |
| 31 |
"validate_certs": "no", |
| 32 |
"https": "yes", |
| 33 |
"state": "present", |
| 34 |
"name": "test_ipspace" |
| 35 |
} |
| 36 |
|
| 37 |
|
| 38 |
ipspace_info = { |
| 39 |
'num-records': 1, |
| 40 |
'attributes-list': { |
| 41 |
'net-ipspaces-info': { |
| 42 |
'ipspace': 'test_ipspace' |
| 43 |
} |
| 44 |
} |
| 45 |
} |
| 46 |
|
| 47 |
ipspace_info_renamed = { |
| 48 |
'num-records': 1, |
| 49 |
'attributes-list': { |
| 50 |
'net-ipspaces-info': { |
| 51 |
'ipspace': 'test_ipspace_renamed' |
| 52 |
} |
| 53 |
} |
| 54 |
} |
| 55 |
|
| 56 |
ZRR = zapi_responses({ |
| 57 |
'ipspace_info': build_zapi_response(ipspace_info), |
| 58 |
'ipspace_info_renamed': build_zapi_response(ipspace_info_renamed), |
| 59 |
}) |
| 60 |
|
| 61 |
SRR = rest_responses({ |
| 62 |
'ipspace_record': (200, {'records': [{ |
| 63 |
"name": "test_ipspace", |
| 64 |
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"}]}, None), |
| 65 |
'ipspace_record_renamed': (200, {'records': [{ |
| 66 |
"name": "test_ipspace_renamed", |
| 67 |
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"}]}, None) |
| 68 |
}) |
| 69 |
|
| 70 |
|
| 71 |
def test_module_fail_when_required_args_missing(): |
| 72 |
''' required arguments are reported as errors ''' |
| 73 |
with pytest.raises(AnsibleFailJson) as exc: |
| 74 |
set_module_args({}) |
| 75 |
my_module() |
| 76 |
msg = 'missing required arguments:' |
| 77 |
assert msg in exc.value.args[0]['msg'] |
| 78 |
|
| 79 |
|
| 80 |
def test_get_ipspace_iscalled(): |
| 81 |
''' test if get_ipspace() is called ''' |
| 82 |
register_responses([ |
| 83 |
('net-ipspaces-get-iter', ZRR['empty']) |
| 84 |
]) |
| 85 |
ipsace_obj = create_module(my_module, DEFAULT_ARGS, {'use_rest': 'never'}) |
| 86 |
result = ipsace_obj.get_ipspace('dummy') |
| 87 |
assert result is None |
| 88 |
|
| 89 |
|
| 90 |
def test_ipspace_apply_iscalled(): |
| 91 |
''' test if apply() is called - create and rename''' |
| 92 |
register_responses([ |
| 93 |
# create |
| 94 |
('net-ipspaces-get-iter', ZRR['empty']), |
| 95 |
('net-ipspaces-create', ZRR['success']), |
| 96 |
# create idempotent check |
| 97 |
('net-ipspaces-get-iter', ZRR['ipspace_info']), |
| 98 |
# rename |
| 99 |
('net-ipspaces-get-iter', ZRR['empty']), |
| 100 |
('net-ipspaces-get-iter', ZRR['ipspace_info']), |
| 101 |
('net-ipspaces-rename', ZRR['success']), |
| 102 |
# rename idempotent check |
| 103 |
('net-ipspaces-get-iter', ZRR['ipspace_info_renamed']), |
| 104 |
# delete |
| 105 |
('net-ipspaces-get-iter', ZRR['ipspace_info']), |
| 106 |
('net-ipspaces-destroy', ZRR['success']) |
| 107 |
]) |
| 108 |
args = {'use_rest': 'never'} |
| 109 |
assert create_and_apply(my_module, DEFAULT_ARGS, args)['changed'] |
| 110 |
assert not create_and_apply(my_module, DEFAULT_ARGS, args)['changed'] |
| 111 |
args['from_name'] = 'test_ipspace' |
| 112 |
args['name'] = 'test_ipspace_renamed' |
| 113 |
assert create_and_apply(my_module, DEFAULT_ARGS, args)['changed'] |
| 114 |
assert not create_and_apply(my_module, DEFAULT_ARGS, args)['changed'] |
| 115 |
args = {'use_rest': 'never', 'state': 'absent'} |
| 116 |
assert create_and_apply(my_module, DEFAULT_ARGS, args)['changed'] |
| 117 |
|
| 118 |
|
| 119 |
def test_successful_create_rest(): |
| 120 |
''' Test successful create and idempotent check''' |
| 121 |
register_responses([ |
| 122 |
('GET', 'cluster', SRR['is_rest_9_9_0']), |
| 123 |
('GET', 'network/ipspaces', SRR['empty_records']), |
| 124 |
('POST', 'network/ipspaces', SRR['success']), |
| 125 |
# idempotent |
| 126 |
('GET', 'cluster', SRR['is_rest_9_9_0']), |
| 127 |
('GET', 'network/ipspaces', SRR['ipspace_record']) |
| 128 |
]) |
| 129 |
assert create_and_apply(my_module, DEFAULT_ARGS)['changed'] |
| 130 |
assert not create_and_apply(my_module, DEFAULT_ARGS)['changed'] |
| 131 |
|
| 132 |
|
| 133 |
def test_successful_delete_rest(): |
| 134 |
''' Test successful delete and idempotent check''' |
| 135 |
register_responses([ |
| 136 |
('GET', 'cluster', SRR['is_rest_9_9_0']), |
| 137 |
('GET', 'network/ipspaces', SRR['ipspace_record']), |
| 138 |
('DELETE', 'network/ipspaces/1cd8a442-86d1-11e0-ae1c-123478563412', SRR['success']), |
| 139 |
# idempotent |
| 140 |
('GET', 'cluster', SRR['is_rest_9_9_0']), |
| 141 |
('GET', 'network/ipspaces', SRR['empty_records']) |
| 142 |
]) |
| 143 |
assert create_and_apply(my_module, DEFAULT_ARGS, {'state': 'absent'})['changed'] |
| 144 |
assert not create_and_apply(my_module, DEFAULT_ARGS, {'state': 'absent'})['changed'] |
| 145 |
|
| 146 |
|
| 147 |
def test_successful_rename_rest(): |
| 148 |
''' Test successful rename and idempotent check''' |
| 149 |
register_responses([ |
| 150 |
('GET', 'cluster', SRR['is_rest_9_9_0']), |
| 151 |
('GET', 'network/ipspaces', SRR['empty_records']), |
| 152 |
('GET', 'network/ipspaces', SRR['ipspace_record']), |
| 153 |
('PATCH', 'network/ipspaces/1cd8a442-86d1-11e0-ae1c-123478563412', SRR['success']), |
| 154 |
# idempotent |
| 155 |
('GET', 'cluster', SRR['is_rest_9_9_0']), |
| 156 |
('GET', 'network/ipspaces', SRR['ipspace_record_renamed']) |
| 157 |
]) |
| 158 |
args = {'from_name': 'test_ipspace', 'name': 'test_ipspace_renamed'} |
| 159 |
assert create_and_apply(my_module, DEFAULT_ARGS, args)['changed'] |
| 160 |
assert not create_and_apply(my_module, DEFAULT_ARGS, args)['changed'] |
| 161 |
|
| 162 |
|
| 163 |
def test_if_all_methods_catch_exception_zapi_rest(): |
| 164 |
register_responses([ |
| 165 |
# zapi |
| 166 |
('net-ipspaces-get-iter', ZRR['error']), |
| 167 |
('net-ipspaces-create', ZRR['error']), |
| 168 |
('net-ipspaces-rename', ZRR['error']), |
| 169 |
('net-ipspaces-destroy', ZRR['error']), |
| 170 |
# REST |
| 171 |
('GET', 'cluster', SRR['is_rest_9_9_0']), |
| 172 |
('GET', 'network/ipspaces', SRR['generic_error']), |
| 173 |
('POST', 'network/ipspaces', SRR['generic_error']), |
| 174 |
('PATCH', 'network/ipspaces/abdcdef', SRR['generic_error']), |
| 175 |
('DELETE', 'network/ipspaces/abdcdef', SRR['generic_error']) |
| 176 |
|
| 177 |
]) |
| 178 |
my_obj = create_module(my_module, DEFAULT_ARGS, {'from_name': 'test_ipspace_rename', 'use_rest': 'never'}) |
| 179 |
assert 'Error getting ipspace' in expect_and_capture_ansible_exception(my_obj.get_ipspace, 'fail')['msg'] |
| 180 |
assert 'Error provisioning ipspace' in expect_and_capture_ansible_exception(my_obj.create_ipspace, 'fail')['msg'] |
| 181 |
assert 'Error renaming ipspace' in expect_and_capture_ansible_exception(my_obj.rename_ipspace, 'fail')['msg'] |
| 182 |
assert 'Error removing ipspace' in expect_and_capture_ansible_exception(my_obj.delete_ipspace, 'fail')['msg'] |
| 183 |
|
| 184 |
my_obj = create_module(my_module, DEFAULT_ARGS, {'from_name': 'test_ipspace_rename'}) |
| 185 |
my_obj.uuid = 'abdcdef' |
| 186 |
assert 'Error getting ipspace' in expect_and_capture_ansible_exception(my_obj.get_ipspace, 'fail')['msg'] |
| 187 |
assert 'Error provisioning ipspace' in expect_and_capture_ansible_exception(my_obj.create_ipspace, 'fail')['msg'] |
| 188 |
assert 'Error renaming ipspace' in expect_and_capture_ansible_exception(my_obj.rename_ipspace, 'fail')['msg'] |
| 189 |
assert 'Error removing ipspace' in expect_and_capture_ansible_exception(my_obj.delete_ipspace, 'fail')['msg'] |