1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
# (c) 2020, NetApp, Inc
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
""" unit tests for Ansible module: na_um_volumes_info """
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
import json
import pytest
import sys
from ansible.module_utils import basic
from ansible.module_utils._text import to_bytes
from ansible_collections.netapp.um_info.tests.unit.compat import unittest
from ansible_collections.netapp.um_info.tests.unit.compat.mock import patch, Mock
import ansible_collections.netapp.um_info.plugins.module_utils.netapp as netapp_utils
from ansible_collections.netapp.um_info.plugins.modules.na_um_volumes_info\
import NetAppUMVolume as my_module # module under test
if not netapp_utils.HAS_REQUESTS and sys.version_info < (2, 7):
pytestmark = pytest.mark.skip('Skipping Unit Tests on 2.6 as requests is not be available')
# REST API canned responses when mocking send_request
SRR = {
# common responses
'empty_good': ({}, None),
'end_of_sequence': (None, "Unexpected call to send_request"),
'generic_error': (None, "Expected error"),
'get_next': (dict(_links=dict(self='me', next=dict(href='next_records'))), None),
'get_data': (dict(_links=dict(self='me'), records=['data1', 'data2'], total_records=2), None),
'get_data_missing_field': (dict(_links=dict(self='me'), records=['data1', 'data2']), None),
# module specific responses
'get_volumes': {'name': 'ansible'}
}
def set_module_args(args):
"""prepare arguments so that they will be picked up during module creation"""
args = json.dumps({'ANSIBLE_MODULE_ARGS': args})
basic._ANSIBLE_ARGS = to_bytes(args) # pylint: disable=protected-access
class AnsibleExitJson(Exception):
"""Exception class to be raised by module.exit_json and caught by the test case"""
pass
class AnsibleFailJson(Exception):
"""Exception class to be raised by module.fail_json and caught by the test case"""
pass
def exit_json(*args, **kwargs): # pylint: disable=unused-argument
"""function to patch over exit_json; package return data into an exception"""
if 'changed' not in kwargs:
kwargs['changed'] = False
raise AnsibleExitJson(kwargs)
def fail_json(*args, **kwargs): # pylint: disable=unused-argument
"""function to patch over fail_json; package return data into an exception"""
kwargs['failed'] = True
raise AnsibleFailJson(kwargs)
class MockUMConnection(object):
''' mock server connection to Unified Manager host '''
def __init__(self):
''' pass init '''
class TestMyModule(unittest.TestCase):
''' a group of related Unit Tests '''
def setUp(self):
self.mock_module_helper = patch.multiple(basic.AnsibleModule,
exit_json=exit_json,
fail_json=fail_json)
self.mock_module_helper.start()
self.addCleanup(self.mock_module_helper.stop)
self.server = MockUMConnection()
# whether to use a mock or a simulator
self.onbox = False
def set_default_args(self):
if self.onbox:
hostname = '10.10.10.10'
username = 'admin'
password = 'password'
else:
hostname = 'hostname'
username = 'username'
password = 'password'
return dict({
'hostname': hostname,
'username': username,
'password': password,
})
def test_module_fail_when_required_args_missing(self):
''' required arguments are reported as errors '''
with pytest.raises(AnsibleFailJson) as exc:
set_module_args({})
my_module()
print('Info: %s' % exc.value.args[0]['msg'])
@patch('ansible_collections.netapp.um_info.plugins.modules.na_um_volumes_info.NetAppUMVolume.get_volumes')
def test_ensure_list_volumes_get_called(self, get_volumes):
''' fetching details of volumes '''
set_module_args(self.set_default_args())
my_obj = my_module()
my_obj.server = self.server
my_obj.get_volumes = Mock(return_value=SRR['get_volumes'])
with pytest.raises(AnsibleExitJson) as exc:
my_obj.apply()
assert exc.value.args[0]['changed']
@patch('ansible_collections.netapp.um_info.plugins.modules.na_um_volumes_info.NetAppUMVolume.get_volumes')
def test_ensure_get_called_existing(self, get_volumes):
''' test for existing volumes'''
set_module_args(self.set_default_args())
my_obj = my_module()
my_obj.get_volumes = Mock(return_value=SRR['get_volumes'])
assert my_obj.get_volumes() is not None
@patch('ansible_collections.netapp.um_info.plugins.module_utils.netapp.UMRestAPI.send_request')
def test_get_next(self, mock_request):
''' test for existing volumes'''
set_module_args(self.set_default_args())
mock_request.side_effect = [
SRR['get_next'],
SRR['get_data'],
SRR['end_of_sequence'],
]
my_obj = my_module()
assert my_obj.get_volumes() is not None
@patch('ansible_collections.netapp.um_info.plugins.module_utils.netapp.UMRestAPI.send_request')
def test_negative_get_next(self, mock_request):
''' test for existing volumes'''
set_module_args(self.set_default_args())
mock_request.side_effect = [
SRR['get_next'],
SRR['get_data_missing_field'],
SRR['end_of_sequence'],
]
my_obj = my_module()
with pytest.raises(AnsibleFailJson) as exc:
my_obj.get_volumes() is not None
print(exc.value.args[0])
msg = 'unexpected response from datacenter/storage/volumes'
assert msg in exc.value.args[0]['msg']
msg = "expecting key: 'total_records'"
assert msg in exc.value.args[0]['msg']
|
