| 1 |
# (c) 2018-2026, 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 for Ansible module: na_ontap_dns''' |
| 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 |
| 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.framework.mock_rest_and_zapi_requests import\ |
| 14 |
patch_request_and_invoke, register_responses |
| 15 |
from ansible_collections.netapp.ontap.tests.unit.framework.rest_factory import rest_error_message, rest_responses |
| 16 |
from ansible_collections.netapp.ontap.tests.unit.framework.zapi_factory import build_zapi_error, build_zapi_response, zapi_error_message, zapi_responses |
| 17 |
from ansible_collections.netapp.ontap.tests.unit.plugins.module_utils.ansible_mocks import call_main, create_module, expect_and_capture_ansible_exception, \ |
| 18 |
patch_ansible, assert_warning_was_raised, print_warnings |
| 19 |
|
| 20 |
|
| 21 |
from ansible_collections.netapp.ontap.plugins.modules.na_ontap_dns import main as my_main, NetAppOntapDns 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 |
# REST API canned responses when mocking send_request |
| 28 |
SRR = rest_responses({ |
| 29 |
# common responses |
| 30 |
'is_rest': (200, {}, None), |
| 31 |
'is_zapi': (400, {}, "Unreachable"), |
| 32 |
'empty_good': (200, {}, None), |
| 33 |
'end_of_sequence': (500, None, "Unexpected call to send_request"), |
| 34 |
'generic_error': (400, None, "Expected error"), |
| 35 |
'dns_record': (200, {"records": [{"domains": ['test.com'], |
| 36 |
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7", |
| 37 |
"servers": ['0.0.0.0'], |
| 38 |
"svm": {"name": "svm1", "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"}}]}, None), |
| 39 |
'cluster_data': (200, {"dns_domains": ['test.com'], |
| 40 |
"name_servers": ['0.0.0.0'], |
| 41 |
"name": "cserver", |
| 42 |
"uuid": "C2c9e252-41be-11e9-81d5-00a0986138f7"}, None), |
| 43 |
'cluster_name': (200, {"name": "cserver", |
| 44 |
"uuid": "C2c9e252-41be-11e9-81d5-00a0986138f7"}, None), |
| 45 |
}) |
| 46 |
|
| 47 |
dns_info = { |
| 48 |
'attributes': { |
| 49 |
'net-dns-info': { |
| 50 |
'name-servers': [{'ip-address': '0.0.0.0'}], |
| 51 |
'domains': [{'string': 'test.com'}], |
| 52 |
'skip-config-validation': 'true' |
| 53 |
} |
| 54 |
} |
| 55 |
} |
| 56 |
|
| 57 |
|
| 58 |
ZRR = zapi_responses({ |
| 59 |
'dns_info': build_zapi_response(dns_info), |
| 60 |
'error_15661': build_zapi_error(15661, 'not_found'), |
| 61 |
}) |
| 62 |
|
| 63 |
|
| 64 |
DEFAULT_ARGS = { |
| 65 |
'hostname': 'hostname', |
| 66 |
'username': 'username', |
| 67 |
'password': 'password', |
| 68 |
'nameservers': ['0.0.0.0'], |
| 69 |
'domains': ['test.com'], |
| 70 |
} |
| 71 |
|
| 72 |
|
| 73 |
@pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib") |
| 74 |
def test_module_fail_when_required_args_missing(): |
| 75 |
''' required arguments are reported as errors ''' |
| 76 |
register_responses([ |
| 77 |
]) |
| 78 |
module_args = { |
| 79 |
'use_rest': 'never', |
| 80 |
} |
| 81 |
error = 'Error: vserver is a required parameter with ZAPI.' |
| 82 |
assert error in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg'] |
| 83 |
|
| 84 |
|
| 85 |
@pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib") |
| 86 |
def test_zapi_get_error(): |
| 87 |
register_responses([ |
| 88 |
('ZAPI', 'net-dns-get', ZRR['error']), |
| 89 |
('ZAPI', 'net-dns-get', ZRR['error_15661']), |
| 90 |
]) |
| 91 |
module_args = { |
| 92 |
'use_rest': 'never', |
| 93 |
'vserver': 'svm_abc', |
| 94 |
} |
| 95 |
my_obj = create_module(my_module, DEFAULT_ARGS, module_args) |
| 96 |
# get |
| 97 |
error = zapi_error_message('Error getting DNS info') |
| 98 |
assert error in expect_and_capture_ansible_exception(my_obj.get_dns, 'fail')['msg'] |
| 99 |
assert my_obj.get_dns() is None |
| 100 |
|
| 101 |
|
| 102 |
@pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib") |
| 103 |
def test_idempotent_modify_dns(): |
| 104 |
register_responses([ |
| 105 |
('ZAPI', 'net-dns-get', ZRR['dns_info']), |
| 106 |
]) |
| 107 |
module_args = { |
| 108 |
'use_rest': 'never', |
| 109 |
'vserver': 'svm_abc', |
| 110 |
} |
| 111 |
|
| 112 |
assert not call_main(my_main, DEFAULT_ARGS, module_args)['changed'] |
| 113 |
|
| 114 |
|
| 115 |
@pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib") |
| 116 |
def test_zapi_modify_dns(): |
| 117 |
register_responses([ |
| 118 |
('ZAPI', 'net-dns-get', ZRR['dns_info']), |
| 119 |
('ZAPI', 'net-dns-modify', ZRR['success']), |
| 120 |
# idempotency |
| 121 |
('ZAPI', 'net-dns-get', ZRR['dns_info']), |
| 122 |
# error |
| 123 |
('ZAPI', 'net-dns-get', ZRR['dns_info']), |
| 124 |
('ZAPI', 'net-dns-modify', ZRR['error']), |
| 125 |
]) |
| 126 |
module_args = { |
| 127 |
'domains': ['new_test.com'], |
| 128 |
'nameservers': ['1.2.3.4'], |
| 129 |
'skip_validation': True, |
| 130 |
'use_rest': 'never', |
| 131 |
'vserver': 'svm_abc', |
| 132 |
} |
| 133 |
assert call_main(my_main, DEFAULT_ARGS, module_args)['changed'] |
| 134 |
module_args = { |
| 135 |
'domains': ['test.com'], |
| 136 |
'skip_validation': True, |
| 137 |
'use_rest': 'never', |
| 138 |
'vserver': 'svm_abc', |
| 139 |
} |
| 140 |
assert not call_main(my_main, DEFAULT_ARGS, module_args)['changed'] |
| 141 |
module_args = { |
| 142 |
'domains': ['new_test.com'], |
| 143 |
'nameservers': ['1.2.3.4'], |
| 144 |
'skip_validation': True, |
| 145 |
'use_rest': 'never', |
| 146 |
'vserver': 'svm_abc', |
| 147 |
} |
| 148 |
error = zapi_error_message('Error modifying dns') |
| 149 |
assert error in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg'] |
| 150 |
|
| 151 |
|
| 152 |
@pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib") |
| 153 |
def test_zapi_create_dns(): |
| 154 |
register_responses([ |
| 155 |
('ZAPI', 'net-dns-get', ZRR['empty']), |
| 156 |
('ZAPI', 'net-dns-create', ZRR['success']), |
| 157 |
# idempotency |
| 158 |
('ZAPI', 'net-dns-get', ZRR['dns_info']), |
| 159 |
# error |
| 160 |
('ZAPI', 'net-dns-get', ZRR['empty']), |
| 161 |
('ZAPI', 'net-dns-create', ZRR['error']), |
| 162 |
]) |
| 163 |
module_args = { |
| 164 |
'domains': ['test.com'], |
| 165 |
'skip_validation': True, |
| 166 |
'use_rest': 'never', |
| 167 |
'vserver': 'svm_abc', |
| 168 |
} |
| 169 |
assert call_main(my_main, DEFAULT_ARGS, module_args)['changed'] |
| 170 |
assert not call_main(my_main, DEFAULT_ARGS, module_args)['changed'] |
| 171 |
error = zapi_error_message('Error creating dns') |
| 172 |
assert error in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg'] |
| 173 |
|
| 174 |
|
| 175 |
@pytest.mark.skipif(not netapp_utils.has_netapp_lib(), reason="skipping as missing required netapp_lib") |
| 176 |
def test_zapi_delete_dns(): |
| 177 |
register_responses([ |
| 178 |
('ZAPI', 'net-dns-get', ZRR['dns_info']), |
| 179 |
('ZAPI', 'net-dns-destroy', ZRR['success']), |
| 180 |
# idempotency |
| 181 |
('ZAPI', 'net-dns-get', ZRR['empty']), |
| 182 |
# error |
| 183 |
('ZAPI', 'net-dns-get', ZRR['dns_info']), |
| 184 |
('ZAPI', 'net-dns-destroy', ZRR['error']), |
| 185 |
]) |
| 186 |
module_args = { |
| 187 |
'domains': ['new_test.com'], |
| 188 |
'state': 'absent', |
| 189 |
'use_rest': 'never', |
| 190 |
'vserver': 'svm_abc', |
| 191 |
} |
| 192 |
assert call_main(my_main, DEFAULT_ARGS, module_args)['changed'] |
| 193 |
assert not call_main(my_main, DEFAULT_ARGS, module_args)['changed'] |
| 194 |
error = zapi_error_message('Error destroying dns') |
| 195 |
assert error in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg'] |
| 196 |
|
| 197 |
|
| 198 |
def test_rest_error(): |
| 199 |
module_args = { |
| 200 |
'use_rest': 'always', |
| 201 |
} |
| 202 |
register_responses([ |
| 203 |
('GET', 'cluster', SRR['is_rest']), |
| 204 |
('GET', 'cluster', SRR['generic_error']), |
| 205 |
('GET', 'cluster', SRR['is_rest_9_9_1']), |
| 206 |
# create |
| 207 |
('PATCH', 'cluster', SRR['generic_error']), |
| 208 |
('PATCH', 'cluster', SRR['generic_error']), |
| 209 |
('POST', 'name-services/dns', SRR['generic_error']), |
| 210 |
# delete |
| 211 |
('DELETE', 'name-services/dns/uuid', SRR['generic_error']), |
| 212 |
# read |
| 213 |
('GET', 'name-services/dns', SRR['generic_error']), |
| 214 |
# modify |
| 215 |
('PATCH', 'cluster', SRR['generic_error']), |
| 216 |
('PATCH', 'name-services/dns/uuid', SRR['generic_error']), |
| 217 |
]) |
| 218 |
error = rest_error_message('Error getting cluster info', 'cluster') |
| 219 |
assert error in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg'] |
| 220 |
my_obj = create_module(my_module, DEFAULT_ARGS, module_args) |
| 221 |
# create |
| 222 |
my_obj.is_cluster = True |
| 223 |
error = rest_error_message('Error updating cluster DNS options', 'cluster') |
| 224 |
assert error in expect_and_capture_ansible_exception(my_obj.create_dns_rest, 'fail')['msg'] |
| 225 |
my_obj.is_cluster = False |
| 226 |
# still cluster scope, as verserver is not set |
| 227 |
assert error in expect_and_capture_ansible_exception(my_obj.create_dns_rest, 'fail')['msg'] |
| 228 |
my_obj.parameters['vserver'] = 'vserver' |
| 229 |
error = rest_error_message('Error creating DNS service', 'name-services/dns') |
| 230 |
assert error in expect_and_capture_ansible_exception(my_obj.create_dns_rest, 'fail')['msg'] |
| 231 |
# delete |
| 232 |
my_obj.is_cluster = True |
| 233 |
error = 'Error: cluster scope when deleting DNS with REST requires ONTAP 9.9.1 or later.' |
| 234 |
assert error in expect_and_capture_ansible_exception(my_obj.destroy_dns_rest, 'fail', {})['msg'] |
| 235 |
my_obj.is_cluster = False |
| 236 |
error = rest_error_message('Error deleting DNS service', 'name-services/dns/uuid') |
| 237 |
assert error in expect_and_capture_ansible_exception(my_obj.destroy_dns_rest, 'fail', {'uuid': 'uuid'})['msg'] |
| 238 |
# read, cluster scope |
| 239 |
del my_obj.parameters['vserver'] |
| 240 |
error = rest_error_message('Error getting DNS service', 'name-services/dns') |
| 241 |
assert error in expect_and_capture_ansible_exception(my_obj.get_dns_rest, 'fail')['msg'] |
| 242 |
# modify |
| 243 |
dns_attrs = { |
| 244 |
'domains': [], |
| 245 |
'nameservers': [], |
| 246 |
'uuid': 'uuid', |
| 247 |
} |
| 248 |
my_obj.is_cluster = True |
| 249 |
error = rest_error_message('Error updating cluster DNS options', 'cluster') |
| 250 |
assert error in expect_and_capture_ansible_exception(my_obj.modify_dns_rest, 'fail', dns_attrs)['msg'] |
| 251 |
my_obj.is_cluster = False |
| 252 |
error = rest_error_message('Error modifying DNS configuration', 'name-services/dns/uuid') |
| 253 |
assert error in expect_and_capture_ansible_exception(my_obj.modify_dns_rest, 'fail', dns_attrs)['msg'] |
| 254 |
|
| 255 |
|
| 256 |
def test_rest_successfully_create(): |
| 257 |
module_args = { |
| 258 |
'use_rest': 'always', |
| 259 |
'vserver': 'svm_abc', |
| 260 |
'skip_validation': True |
| 261 |
} |
| 262 |
register_responses([ |
| 263 |
('GET', 'cluster', SRR['is_rest_9_9_1']), |
| 264 |
('GET', 'name-services/dns', SRR['zero_records']), |
| 265 |
('POST', 'name-services/dns', SRR['success']), |
| 266 |
]) |
| 267 |
assert call_main(my_main, DEFAULT_ARGS, module_args)['changed'] |
| 268 |
|
| 269 |
|
| 270 |
def test_rest_successfully_create_is_cluster_vserver(): |
| 271 |
module_args = { |
| 272 |
'use_rest': 'always', |
| 273 |
'vserver': 'cserver' |
| 274 |
} |
| 275 |
register_responses([ |
| 276 |
('GET', 'cluster', SRR['is_rest']), |
| 277 |
('GET', 'name-services/dns', SRR['zero_records']), |
| 278 |
('GET', 'cluster', SRR['cluster_name']), |
| 279 |
('PATCH', 'cluster', SRR['empty_good']), |
| 280 |
]) |
| 281 |
assert call_main(my_main, DEFAULT_ARGS, module_args)['changed'] |
| 282 |
|
| 283 |
|
| 284 |
def test_rest_idempotent_create_dns(): |
| 285 |
module_args = { |
| 286 |
'use_rest': 'always', |
| 287 |
'vserver': 'svm_abc', |
| 288 |
} |
| 289 |
register_responses([ |
| 290 |
('GET', 'cluster', SRR['is_rest']), |
| 291 |
('GET', 'name-services/dns', SRR['dns_record']), |
| 292 |
]) |
| 293 |
assert not call_main(my_main, DEFAULT_ARGS, module_args)['changed'] |
| 294 |
|
| 295 |
|
| 296 |
def test_rest_successfully_destroy(): |
| 297 |
module_args = { |
| 298 |
'state': 'absent', |
| 299 |
'use_rest': 'always', |
| 300 |
'vserver': 'svm_abc', |
| 301 |
} |
| 302 |
register_responses([ |
| 303 |
('GET', 'cluster', SRR['is_rest']), |
| 304 |
('GET', 'name-services/dns', SRR['dns_record']), |
| 305 |
('DELETE', 'name-services/dns/02c9e252-41be-11e9-81d5-00a0986138f7', SRR['success']), |
| 306 |
]) |
| 307 |
assert call_main(my_main, DEFAULT_ARGS, module_args)['changed'] |
| 308 |
|
| 309 |
|
| 310 |
def test_rest_idempotently_destroy(): |
| 311 |
module_args = { |
| 312 |
'state': 'absent', |
| 313 |
'use_rest': 'always', |
| 314 |
'vserver': 'svm_abc', |
| 315 |
} |
| 316 |
register_responses([ |
| 317 |
('GET', 'cluster', SRR['is_rest']), |
| 318 |
('GET', 'name-services/dns', SRR['zero_records']), |
| 319 |
('GET', 'cluster', SRR['cluster_data']), |
| 320 |
]) |
| 321 |
assert not call_main(my_main, DEFAULT_ARGS, module_args)['changed'] |
| 322 |
|
| 323 |
|
| 324 |
def test_rest_successfully_modify(): |
| 325 |
module_args = { |
| 326 |
'domains': 'new_test.com', |
| 327 |
'state': 'present', |
| 328 |
'use_rest': 'always', |
| 329 |
'vserver': 'svm_abc' |
| 330 |
} |
| 331 |
register_responses([ |
| 332 |
('GET', 'cluster', SRR['is_rest']), |
| 333 |
('GET', 'name-services/dns', SRR['dns_record']), |
| 334 |
('PATCH', 'name-services/dns/02c9e252-41be-11e9-81d5-00a0986138f7', SRR['success']), |
| 335 |
]) |
| 336 |
assert call_main(my_main, DEFAULT_ARGS, module_args)['changed'] |
| 337 |
|
| 338 |
|
| 339 |
def test_rest_successfully_modify_is_cluster_vserver(): |
| 340 |
module_args = { |
| 341 |
'domains': 'new_test.com', |
| 342 |
'state': 'present', |
| 343 |
'use_rest': 'always', |
| 344 |
'vserver': 'cserver' |
| 345 |
} |
| 346 |
register_responses([ |
| 347 |
('GET', 'cluster', SRR['is_rest']), |
| 348 |
('GET', 'name-services/dns', SRR['zero_records']), |
| 349 |
('GET', 'cluster', SRR['cluster_data']), |
| 350 |
('PATCH', 'cluster', SRR['empty_good']), |
| 351 |
]) |
| 352 |
assert call_main(my_main, DEFAULT_ARGS, module_args)['changed'] |
| 353 |
|
| 354 |
|
| 355 |
def test_rest_idempotently_modify(): |
| 356 |
module_args = { |
| 357 |
'state': 'present', |
| 358 |
'use_rest': 'always', |
| 359 |
'vserver': 'svm_abc', |
| 360 |
} |
| 361 |
register_responses([ |
| 362 |
('GET', 'cluster', SRR['is_rest']), |
| 363 |
('GET', 'name-services/dns', SRR['dns_record']), |
| 364 |
]) |
| 365 |
assert not call_main(my_main, DEFAULT_ARGS, module_args)['changed'] |
| 366 |
|
| 367 |
|
| 368 |
def test_rest_successfully_modify_is_cluster_skip_validation(): |
| 369 |
module_args = { |
| 370 |
'domains': 'new_test.com', |
| 371 |
'state': 'present', |
| 372 |
'use_rest': 'always', |
| 373 |
'skip_validation': True |
| 374 |
} |
| 375 |
register_responses([ |
| 376 |
('GET', 'cluster', SRR['is_rest_9_9_1']), |
| 377 |
('GET', 'name-services/dns', SRR['zero_records']), |
| 378 |
('PATCH', 'cluster', SRR['empty_good']), |
| 379 |
# error if used skip_validation on earlier versions. |
| 380 |
('GET', 'cluster', SRR['is_rest']), |
| 381 |
]) |
| 382 |
assert call_main(my_main, DEFAULT_ARGS, module_args)['changed'] |
| 383 |
assert_warning_was_raised("skip_validation is ignored for cluster DNS operations in REST.") |
| 384 |
assert 'Error: Minimum version of ONTAP for skip_validation is (9, 9, 1)' in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg'] |
| 385 |
|
| 386 |
|
| 387 |
@patch('ansible_collections.netapp.ontap.plugins.module_utils.netapp.has_netapp_lib') |
| 388 |
def test_has_netapp_lib(has_netapp_lib): |
| 389 |
module_args = { |
| 390 |
'state': 'present', |
| 391 |
'use_rest': 'never', |
| 392 |
'vserver': 'svm_abc', |
| 393 |
} |
| 394 |
has_netapp_lib.return_value = False |
| 395 |
assert 'Error: the python NetApp-Lib module is required. Import error:' in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg'] |