| 1 |
# (c) 2018-2021, 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 for ONTAP snmp Ansible module ''' |
| 5 |
|
| 6 |
from __future__ import (absolute_import, division, print_function) |
| 7 |
__metaclass__ = type |
| 8 |
import pytest |
| 9 |
import sys |
| 10 |
|
| 11 |
from ansible_collections.netapp.ontap.tests.unit.compat.mock import patch |
| 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 assert_no_warnings, set_module_args, \ |
| 15 |
AnsibleFailJson, AnsibleExitJson, patch_ansible |
| 16 |
|
| 17 |
|
| 18 |
from ansible_collections.netapp.ontap.plugins.modules.na_ontap_ntp \ |
| 19 |
import NetAppOntapNTPServer as my_module, main as uut_main # module under test |
| 20 |
|
| 21 |
|
| 22 |
if not netapp_utils.HAS_REQUESTS and sys.version_info < (2, 7): |
| 23 |
pytestmark = pytest.mark.skip('Skipping Unit Tests on 2.6 as requests is not available') |
| 24 |
|
| 25 |
|
| 26 |
def default_args(): |
| 27 |
return { |
| 28 |
'state': 'present', |
| 29 |
'hostname': '10.10.10.10', |
| 30 |
'username': 'admin', |
| 31 |
'https': 'true', |
| 32 |
'validate_certs': 'false', |
| 33 |
'password': 'password', |
| 34 |
'use_rest': 'always' |
| 35 |
} |
| 36 |
|
| 37 |
|
| 38 |
# REST API canned responses when mocking send_request |
| 39 |
SRR = { |
| 40 |
# common responses |
| 41 |
'is_rest': (200, dict(version=dict(generation=9, major=9, minor=0, full='dummy')), None), |
| 42 |
'is_rest_9_6': (200, dict(version=dict(generation=9, major=6, minor=0, full='dummy')), None), |
| 43 |
'is_rest_9_8': (200, dict(version=dict(generation=9, major=8, minor=0, full='dummy')), None), |
| 44 |
'is_zapi': (400, {}, "Unreachable"), |
| 45 |
'empty_good': (200, {}, None), |
| 46 |
'zero_record': (200, dict(records=[], num_records=0), None), |
| 47 |
'one_record_uuid': (200, dict(records=[dict(uuid='a1b2c3')], num_records=1), None), |
| 48 |
'end_of_sequence': (500, None, "Unexpected call to send_request"), |
| 49 |
'generic_error': (400, None, "Expected error"), |
| 50 |
'server_record': (200, { |
| 51 |
"records": [{ |
| 52 |
"server": "0.0.0.0", |
| 53 |
"version": "auto", |
| 54 |
}], |
| 55 |
'num_records': 1 |
| 56 |
}, None), |
| 57 |
'create_server': (200, { |
| 58 |
'job': { |
| 59 |
'uuid': 'fde79888-692a-11ea-80c2-005056b39fe7', |
| 60 |
'_links': { |
| 61 |
'self': { |
| 62 |
'href': '/api/cluster/jobs/fde79888-692a-11ea-80c2-005056b39fe7'}}} |
| 63 |
}, None), |
| 64 |
'job': (200, { |
| 65 |
"uuid": "fde79888-692a-11ea-80c2-005056b39fe7", |
| 66 |
"state": "success", |
| 67 |
"start_time": "2020-02-26T10:35:44-08:00", |
| 68 |
"end_time": "2020-02-26T10:47:38-08:00", |
| 69 |
"_links": { |
| 70 |
"self": { |
| 71 |
"href": "/api/cluster/jobs/fde79888-692a-11ea-80c2-005056b39fe7" |
| 72 |
} |
| 73 |
} |
| 74 |
}, None) |
| 75 |
} |
| 76 |
|
| 77 |
|
| 78 |
def test_module_fail_when_required_args_missing(patch_ansible): |
| 79 |
''' required arguments are reported as errors ''' |
| 80 |
with pytest.raises(AnsibleFailJson) as exc: |
| 81 |
set_module_args(dict(hostname='')) |
| 82 |
my_module() |
| 83 |
print('Info: %s' % exc.value.args[0]['msg']) |
| 84 |
msg = 'missing required arguments: server_name' |
| 85 |
assert msg == exc.value.args[0]['msg'] |
| 86 |
|
| 87 |
|
| 88 |
@patch('ansible_collections.netapp.ontap.plugins.module_utils.netapp.OntapRestAPI.send_request') |
| 89 |
def test_ensure_get_server_called(mock_request, patch_ansible): |
| 90 |
args = dict(default_args()) |
| 91 |
args['server_name'] = '0.0.0.0' |
| 92 |
set_module_args(args) |
| 93 |
mock_request.side_effect = [ |
| 94 |
SRR['is_rest_9_8'], # get version |
| 95 |
SRR['server_record'], # get |
| 96 |
SRR['end_of_sequence'] |
| 97 |
] |
| 98 |
my_obj = my_module() |
| 99 |
with pytest.raises(AnsibleExitJson) as exc: |
| 100 |
my_obj.apply() |
| 101 |
print('Info: %s' % exc.value.args[0]) |
| 102 |
assert exc.value.args[0]['changed'] is False |
| 103 |
assert_no_warnings() |
| 104 |
|
| 105 |
|
| 106 |
@patch('ansible_collections.netapp.ontap.plugins.module_utils.netapp.OntapRestAPI.send_request') |
| 107 |
def test_ensure_create_server_called(mock_request, patch_ansible): |
| 108 |
args = dict(default_args()) |
| 109 |
args['server_name'] = '0.0.0.0' |
| 110 |
set_module_args(args) |
| 111 |
mock_request.side_effect = [ |
| 112 |
SRR['is_rest_9_8'], # get version |
| 113 |
SRR['zero_record'], # get |
| 114 |
SRR['create_server'], # create |
| 115 |
SRR['job'], # Job |
| 116 |
SRR['end_of_sequence'] |
| 117 |
] |
| 118 |
my_obj = my_module() |
| 119 |
with pytest.raises(AnsibleExitJson) as exc: |
| 120 |
my_obj.apply() |
| 121 |
print('Info: %s' % exc.value.args[0]) |
| 122 |
assert exc.value.args[0]['changed'] is True |
| 123 |
assert_no_warnings() |
| 124 |
|
| 125 |
|
| 126 |
@patch('ansible_collections.netapp.ontap.plugins.module_utils.netapp.OntapRestAPI.send_request') |
| 127 |
def test_ensure_delete_server_called(mock_request, patch_ansible): |
| 128 |
args = dict(default_args()) |
| 129 |
args['server_name'] = '0.0.0.0' |
| 130 |
args['state'] = 'absent' |
| 131 |
set_module_args(args) |
| 132 |
mock_request.side_effect = [ |
| 133 |
SRR['is_rest_9_8'], # get version |
| 134 |
SRR['server_record'], # get |
| 135 |
SRR['empty_good'], # delete |
| 136 |
SRR['end_of_sequence'] |
| 137 |
] |
| 138 |
my_obj = my_module() |
| 139 |
with pytest.raises(AnsibleExitJson) as exc: |
| 140 |
my_obj.apply() |
| 141 |
print('Info: %s' % exc.value.args[0]) |
| 142 |
assert exc.value.args[0]['changed'] is True |
| 143 |
assert_no_warnings() |