| 1 |
# (c) 2022, 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 ONTAP Ansible module: na_ontap_nvme''' |
| 5 |
|
| 6 |
from __future__ import (absolute_import, division, print_function) |
| 7 |
__metaclass__ = type |
| 8 |
import pytest |
| 9 |
|
| 10 |
|
| 11 |
from ansible_collections.netapp.ontap.tests.unit.compat import unittest |
| 12 |
from ansible_collections.netapp.ontap.tests.unit.compat.mock import patch |
| 13 |
import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils |
| 14 |
# pylint: disable=unused-import |
| 15 |
from ansible_collections.netapp.ontap.tests.unit.plugins.module_utils.ansible_mocks import set_module_args, \ |
| 16 |
AnsibleFailJson, AnsibleExitJson, patch_ansible |
| 17 |
|
| 18 |
from ansible_collections.netapp.ontap.plugins.modules.na_ontap_nvme \ |
| 19 |
import NetAppONTAPNVMe as my_module |
| 20 |
|
| 21 |
if not netapp_utils.has_netapp_lib(): |
| 22 |
pytestmark = pytest.mark.skip('skipping as missing required netapp_lib') |
| 23 |
|
| 24 |
|
| 25 |
class MockONTAPConnection(object): |
| 26 |
''' mock server connection to ONTAP host ''' |
| 27 |
|
| 28 |
def __init__(self, kind=None): |
| 29 |
''' save arguments ''' |
| 30 |
self.type = kind |
| 31 |
self.xml_in = None |
| 32 |
self.xml_out = None |
| 33 |
|
| 34 |
def invoke_successfully(self, xml, enable_tunneling): # pylint: disable=unused-argument |
| 35 |
''' mock invoke_successfully returning xml data ''' |
| 36 |
self.xml_in = xml |
| 37 |
if self.type == 'nvme': |
| 38 |
xml = self.build_nvme_info() |
| 39 |
elif self.type == 'nvme_fail': |
| 40 |
raise netapp_utils.zapi.NaApiError(code='TEST', message="This exception is from the unit test") |
| 41 |
self.xml_out = xml |
| 42 |
return xml |
| 43 |
|
| 44 |
@staticmethod |
| 45 |
def build_nvme_info(): |
| 46 |
''' build xml data for nvme-info ''' |
| 47 |
xml = netapp_utils.zapi.NaElement('xml') |
| 48 |
data = {'num-records': 1, |
| 49 |
'attributes-list': [{'nvme-target-service-info': {'is-available': 'true'}}]} |
| 50 |
xml.translate_struct(data) |
| 51 |
return xml |
| 52 |
|
| 53 |
|
| 54 |
class TestMyModule(unittest.TestCase): |
| 55 |
''' a group of related Unit Tests ''' |
| 56 |
|
| 57 |
def setUp(self): |
| 58 |
self.server = MockONTAPConnection() |
| 59 |
self.onbox = False |
| 60 |
|
| 61 |
def set_default_args(self): |
| 62 |
if self.onbox: |
| 63 |
hostname = '10.193.75.3' |
| 64 |
username = 'admin' |
| 65 |
password = 'netapp1!' |
| 66 |
vserver = 'ansible' |
| 67 |
status_admin = True |
| 68 |
else: |
| 69 |
hostname = 'hostname' |
| 70 |
username = 'username' |
| 71 |
password = 'password' |
| 72 |
vserver = 'vserver' |
| 73 |
status_admin = True |
| 74 |
return dict({ |
| 75 |
'hostname': hostname, |
| 76 |
'username': username, |
| 77 |
'password': password, |
| 78 |
'vserver': vserver, |
| 79 |
'status_admin': status_admin, |
| 80 |
'use_rest': 'never', |
| 81 |
}) |
| 82 |
|
| 83 |
def test_module_fail_when_required_args_missing(self): |
| 84 |
''' required arguments are reported as errors ''' |
| 85 |
with pytest.raises(AnsibleFailJson) as exc: |
| 86 |
set_module_args({}) |
| 87 |
my_module() |
| 88 |
print('Info: %s' % exc.value.args[0]['msg']) |
| 89 |
|
| 90 |
def test_ensure_get_called(self): |
| 91 |
''' test get_nvme() for non-existent nvme''' |
| 92 |
set_module_args(self.set_default_args()) |
| 93 |
my_obj = my_module() |
| 94 |
my_obj.server = self.server |
| 95 |
assert my_obj.get_nvme() is None |
| 96 |
|
| 97 |
def test_ensure_get_called_existing(self): |
| 98 |
''' test get_nvme() for existing nvme''' |
| 99 |
set_module_args(self.set_default_args()) |
| 100 |
my_obj = my_module() |
| 101 |
my_obj.server = MockONTAPConnection(kind='nvme') |
| 102 |
assert my_obj.get_nvme() |
| 103 |
|
| 104 |
@patch('ansible_collections.netapp.ontap.plugins.modules.na_ontap_nvme.NetAppONTAPNVMe.create_nvme') |
| 105 |
def test_successful_create(self, create_nvme): |
| 106 |
''' creating nvme and testing idempotency ''' |
| 107 |
set_module_args(self.set_default_args()) |
| 108 |
my_obj = my_module() |
| 109 |
if not self.onbox: |
| 110 |
my_obj.server = self.server |
| 111 |
with pytest.raises(AnsibleExitJson) as exc: |
| 112 |
my_obj.apply() |
| 113 |
assert exc.value.args[0]['changed'] |
| 114 |
create_nvme.assert_called_with() |
| 115 |
# to reset na_helper from remembering the previous 'changed' value |
| 116 |
my_obj = my_module() |
| 117 |
if not self.onbox: |
| 118 |
my_obj.server = MockONTAPConnection('nvme') |
| 119 |
with pytest.raises(AnsibleExitJson) as exc: |
| 120 |
my_obj.apply() |
| 121 |
assert not exc.value.args[0]['changed'] |
| 122 |
|
| 123 |
@patch('ansible_collections.netapp.ontap.plugins.modules.na_ontap_nvme.NetAppONTAPNVMe.delete_nvme') |
| 124 |
def test_successful_delete(self, delete_nvme): |
| 125 |
''' deleting nvme and testing idempotency ''' |
| 126 |
data = self.set_default_args() |
| 127 |
data['state'] = 'absent' |
| 128 |
set_module_args(data) |
| 129 |
my_obj = my_module() |
| 130 |
if not self.onbox: |
| 131 |
my_obj.server = MockONTAPConnection('nvme') |
| 132 |
with pytest.raises(AnsibleExitJson) as exc: |
| 133 |
my_obj.apply() |
| 134 |
assert exc.value.args[0]['changed'] |
| 135 |
delete_nvme.assert_called_with() |
| 136 |
# to reset na_helper from remembering the previous 'changed' value |
| 137 |
my_obj = my_module() |
| 138 |
if not self.onbox: |
| 139 |
my_obj.server = self.server |
| 140 |
with pytest.raises(AnsibleExitJson) as exc: |
| 141 |
my_obj.apply() |
| 142 |
assert not exc.value.args[0]['changed'] |
| 143 |
|
| 144 |
@patch('ansible_collections.netapp.ontap.plugins.modules.na_ontap_nvme.NetAppONTAPNVMe.modify_nvme') |
| 145 |
def test_successful_modify(self, modify_nvme): |
| 146 |
''' modifying nvme and testing idempotency ''' |
| 147 |
data = self.set_default_args() |
| 148 |
data['status_admin'] = False |
| 149 |
set_module_args(data) |
| 150 |
my_obj = my_module() |
| 151 |
if not self.onbox: |
| 152 |
my_obj.server = MockONTAPConnection('nvme') |
| 153 |
with pytest.raises(AnsibleExitJson) as exc: |
| 154 |
my_obj.apply() |
| 155 |
assert exc.value.args[0]['changed'] |
| 156 |
modify_nvme.assert_called_with() |
| 157 |
# to reset na_helper from remembering the previous 'changed' value |
| 158 |
data = self.set_default_args() |
| 159 |
set_module_args(data) |
| 160 |
my_obj = my_module() |
| 161 |
if not self.onbox: |
| 162 |
my_obj.server = MockONTAPConnection('nvme') |
| 163 |
with pytest.raises(AnsibleExitJson) as exc: |
| 164 |
my_obj.apply() |
| 165 |
assert not exc.value.args[0]['changed'] |
| 166 |
|
| 167 |
def test_if_all_methods_catch_exception(self): |
| 168 |
module_args = {} |
| 169 |
module_args.update(self.set_default_args()) |
| 170 |
set_module_args(module_args) |
| 171 |
my_obj = my_module() |
| 172 |
if not self.onbox: |
| 173 |
my_obj.server = MockONTAPConnection('nvme_fail') |
| 174 |
with pytest.raises(AnsibleFailJson) as exc: |
| 175 |
my_obj.get_nvme() |
| 176 |
assert 'Error fetching nvme info:' in exc.value.args[0]['msg'] |
| 177 |
with pytest.raises(AnsibleFailJson) as exc: |
| 178 |
my_obj.create_nvme() |
| 179 |
assert 'Error creating nvme' in exc.value.args[0]['msg'] |
| 180 |
with pytest.raises(AnsibleFailJson) as exc: |
| 181 |
my_obj.delete_nvme() |
| 182 |
assert 'Error deleting nvme' in exc.value.args[0]['msg'] |
| 183 |
with pytest.raises(AnsibleFailJson) as exc: |
| 184 |
my_obj.modify_nvme() |
| 185 |
assert 'Error modifying nvme' in exc.value.args[0]['msg'] |