Debian Codegraph @

ansible_collections/netapp/ontap/tests/unit/plugins/modules/test_na_ontap_motd.py

raw
1 # (c) 2019-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_motd """
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.zapi_factory import build_zapi_response, zapi_error_message, zapi_responses
16 from ansible_collections.netapp.ontap.tests.unit.plugins.module_utils.ansible_mocks import\
17 assert_warning_was_raised, expect_and_capture_ansible_exception, call_main, create_module, patch_ansible
18
19 from ansible_collections.netapp.ontap.plugins.modules.na_ontap_motd import NetAppONTAPMotd as my_module, main as my_main # module under test
20
21 if not netapp_utils.has_netapp_lib():
22 pytestmark = pytest.mark.skip('skipping as missing required netapp_lib')
23
24
25 def motd_info(msg):
26 return {
27 'num-records': 1,
28 'attributes-list': {
29 'vserver-motd-info': {
30 'message': msg,
31 'vserver': 'ansible',
32 'is-cluster-message-enabled': 'true'}}
33 }
34
35
36 ZRR = zapi_responses({
37 'motd_info': build_zapi_response(motd_info('motd_message')),
38 'motd_none': build_zapi_response(motd_info('None')),
39 })
40
41
42 DEFAULT_ARGS = {
43 'hostname': 'hostname',
44 'username': 'username',
45 'password': 'password',
46 'use_rest': 'use_rest',
47 'motd_message': 'motd_message',
48 'vserver': 'ansible',
49 }
50
51
52 def test_module_fail_when_required_args_missing():
53 ''' required arguments are reported as errors '''
54 register_responses([
55 ])
56 module_args = {
57 }
58 print('Info: %s' % call_main(my_main, module_args, fail=True)['msg'])
59
60
61 def test_ensure_motd_get_called():
62 ''' fetching details of motd '''
63 register_responses([
64 ('ZAPI', 'vserver-motd-get-iter', ZRR['no_records']),
65 ])
66 module_args = {
67 'use_rest': 'never',
68 }
69 my_obj = create_module(my_module, DEFAULT_ARGS, module_args)
70 assert my_obj.motd_get() is None
71
72
73 def test_ensure_get_called_existing():
74 ''' test for existing motd'''
75 register_responses([
76 ('ZAPI', 'vserver-motd-get-iter', ZRR['motd_info']),
77 ])
78 module_args = {
79 'use_rest': 'never',
80 }
81 my_obj = create_module(my_module, DEFAULT_ARGS, module_args)
82 assert my_obj.motd_get()
83
84
85 def test_motd_create():
86 ''' test for creating motd'''
87 register_responses([
88 ('ZAPI', 'vserver-motd-get-iter', ZRR['no_records']),
89 ('ZAPI', 'vserver-motd-modify-iter', ZRR['success']),
90 # idempotency
91 ('ZAPI', 'vserver-motd-get-iter', ZRR['motd_info']),
92 # modify
93 ('ZAPI', 'vserver-motd-get-iter', ZRR['no_records']),
94 ('ZAPI', 'vserver-motd-modify-iter', ZRR['success']),
95 ])
96 module_args = {
97 'use_rest': 'never',
98 }
99 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
100 assert not call_main(my_main, DEFAULT_ARGS, module_args)['changed']
101 module_args['message'] = 'new_message'
102 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
103
104
105 def test_motd_delete():
106 ''' test for deleting motd'''
107 register_responses([
108 ('ZAPI', 'vserver-motd-get-iter', ZRR['motd_info']),
109 ('ZAPI', 'vserver-motd-modify-iter', ZRR['motd_info']),
110 ('ZAPI', 'vserver-motd-get-iter', ZRR['no_records']),
111 ('ZAPI', 'vserver-motd-get-iter', ZRR['motd_none']),
112 ])
113 module_args = {
114 'state': 'absent',
115 }
116 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
117 assert not call_main(my_main, DEFAULT_ARGS, module_args)['changed']
118 assert not call_main(my_main, DEFAULT_ARGS, module_args)['changed']
119
120
121 def test_if_all_methods_catch_exception():
122 register_responses([
123 ('ZAPI', 'vserver-motd-get-iter', ZRR['error']),
124 ('ZAPI', 'vserver-motd-modify-iter', ZRR['error']),
125 ])
126 module_args = {
127 'use_rest': 'never',
128 }
129 my_obj = create_module(my_module, DEFAULT_ARGS, module_args)
130 assert expect_and_capture_ansible_exception(my_obj.motd_get, 'fail')['msg'] == zapi_error_message('Error fetching motd info')
131 assert expect_and_capture_ansible_exception(my_obj.modify_motd, 'fail')['msg'] == zapi_error_message('Error creating motd')
132
133
134 def test_rest_required():
135 module_args = {
136 'use_rest': 'always',
137 }
138 error_msg = 'The module only supports ZAPI; refer to netapp.ontap.na_ontap_login_messages module for RESTful equivalent.'
139 assert call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg'] == 'Error: %s' % error_msg
140 register_responses([
141 ('ZAPI', 'vserver-motd-get-iter', ZRR['no_records']),
142 ('ZAPI', 'vserver-motd-modify-iter', ZRR['success']),
143 ('ZAPI', 'vserver-motd-get-iter', ZRR['no_records']),
144 ('ZAPI', 'vserver-motd-modify-iter', ZRR['success']),
145 ])
146 module_args = {
147 'use_rest': 'auto',
148 }
149 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
150 assert_warning_was_raised('Falling back to ZAPI: %s' % error_msg)
151 module_args = {
152 'use_rest': 'NevEr',
153 }
154 assert call_main(my_main, DEFAULT_ARGS, module_args)['changed']
155 assert_warning_was_raised(error_msg)
156
157
158 @patch('ansible_collections.netapp.ontap.plugins.module_utils.netapp.HAS_NETAPP_LIB', False)
159 def test_module_fail_when_netapp_lib_missing():
160 ''' required lib missing '''
161 module_args = {
162 'use_rest': 'never',
163 }
164 assert 'Error: the python NetApp-Lib module is required. Import error: None' in call_main(my_main, DEFAULT_ARGS, module_args, fail=True)['msg']