summaryrefslogtreecommitdiff
path: root/test/units/modules/network/f5/test_bigip_snmp_community.py
blob: da18b893fb94a3e2f6a029c8bcdf0a071d2dd8b7 (plain)
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
# -*- coding: utf-8 -*-
#
# Copyright: (c) 2017, F5 Networks Inc.
# GNU General Public License v3.0 (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

from __future__ import (absolute_import, division, print_function)
__metaclass__ = type

import os
import json
import pytest
import sys

if sys.version_info < (2, 7):
    pytestmark = pytest.mark.skip("F5 Ansible modules require Python >= 2.7")

from ansible.module_utils.basic import AnsibleModule

try:
    from library.modules.bigip_snmp_community import ApiParameters
    from library.modules.bigip_snmp_community import ModuleParameters
    from library.modules.bigip_snmp_community import ModuleManager
    from library.modules.bigip_snmp_community import V1Manager
    from library.modules.bigip_snmp_community import V2Manager
    from library.modules.bigip_snmp_community import ArgumentSpec

    from library.module_utils.network.f5.common import F5ModuleError

    # In Ansible 2.8, Ansible changed import paths.
    from test.units.compat import unittest
    from test.units.compat.mock import Mock

    from test.units.modules.utils import set_module_args
except ImportError:
    from ansible.modules.network.f5.bigip_snmp_community import ApiParameters
    from ansible.modules.network.f5.bigip_snmp_community import ModuleParameters
    from ansible.modules.network.f5.bigip_snmp_community import ModuleManager
    from ansible.modules.network.f5.bigip_snmp_community import V1Manager
    from ansible.modules.network.f5.bigip_snmp_community import V2Manager
    from ansible.modules.network.f5.bigip_snmp_community import ArgumentSpec

    from ansible.module_utils.network.f5.common import F5ModuleError

    # Ansible 2.8 imports
    from units.compat import unittest
    from units.compat.mock import Mock

    from units.modules.utils import set_module_args


fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures')
fixture_data = {}


def load_fixture(name):
    path = os.path.join(fixture_path, name)

    if path in fixture_data:
        return fixture_data[path]

    with open(path) as f:
        data = f.read()

    try:
        data = json.loads(data)
    except Exception:
        pass

    fixture_data[path] = data
    return data


class TestParameters(unittest.TestCase):
    def test_module_parameters(self):
        args = dict(
            version='v2c',
            community='foo',
            source='1.1.1.1',
            port='8080',
            oid='.1',
            access='ro',
            ip_version=4,
            snmp_username='admin',
            snmp_auth_protocol='sha',
            snmp_auth_password='secretsecret',
            snmp_privacy_protocol='des',
            snmp_privacy_password='secretsecret',
            update_password='always',
            state='present'
        )

        p = ModuleParameters(params=args)
        assert p.version == 'v2c'
        assert p.community == 'foo'
        assert p.source == '1.1.1.1'
        assert p.port == 8080
        assert p.oid == '.1'
        assert p.access == 'ro'
        assert p.ip_version == 4
        assert p.snmp_username == 'admin'
        assert p.snmp_auth_protocol == 'sha'
        assert p.snmp_auth_password == 'secretsecret'
        assert p.snmp_privacy_protocol == 'des'
        assert p.snmp_privacy_password == 'secretsecret'
        assert p.update_password == 'always'
        assert p.state == 'present'

    def test_api_parameters_community_1(self):
        args = load_fixture('load_sys_snmp_communities_1.json')

        p = ApiParameters(params=args)
        assert p.access == 'ro'
        assert p.community == 'foo'
        assert p.ip_version == 4

    def test_api_parameters_community_2(self):
        args = load_fixture('load_sys_snmp_communities_2.json')

        p = ApiParameters(params=args)
        assert p.access == 'rw'
        assert p.community == 'foo'
        assert p.ip_version == 4
        assert p.oid == '.1'
        assert p.source == '1.1.1.1'

    def test_api_parameters_community_3(self):
        args = load_fixture('load_sys_snmp_communities_3.json')

        p = ApiParameters(params=args)
        assert p.access == 'ro'
        assert p.community == 'foo'
        assert p.ip_version == 6
        assert p.oid == '.1'
        assert p.source == '2001:0db8:85a3:0000:0000:8a2e:0370:7334'

    def test_api_parameters_community_4(self):
        args = load_fixture('load_sys_snmp_communities_4.json')

        p = ApiParameters(params=args)
        assert p.access == 'ro'
        assert p.community == 'foo'
        assert p.ip_version == 6

    def test_api_parameters_users_1(self):
        args = load_fixture('load_sys_snmp_users_1.json')

        p = ApiParameters(params=args)
        assert p.access == 'ro'
        assert p.snmp_auth_protocol == 'sha'
        assert p.oid == '.1'
        assert p.snmp_privacy_protocol == 'aes'
        assert p.snmp_username == 'foo'


class TestManager(unittest.TestCase):

    def setUp(self):
        self.spec = ArgumentSpec()

    def test_create_v2c_community_1(self, *args):
        set_module_args(dict(
            version='v2c',
            community='foo',
            source='1.1.1.1',
            port='8080',
            oid='.1',
            access='ro',
            ip_version=4,
            state='present',
            partition='Common',
            provider=dict(
                server='localhost',
                password='password',
                user='admin'
            )
        ))

        module = AnsibleModule(
            argument_spec=self.spec.argument_spec,
            supports_check_mode=self.spec.supports_check_mode,
            required_if=self.spec.required_if
        )
        m1 = V1Manager(module=module)

        # Override methods to force specific logic in the module to happen
        m1.exists = Mock(side_effect=[False, True])
        m1.create_on_device = Mock(return_value=True)

        m0 = ModuleManager(module=module)
        m0.get_manager = Mock(return_value=m1)

        results = m0.exec_module()

        assert results['changed'] is True

    def test_create_v1_community_1(self, *args):
        set_module_args(dict(
            name='foo',
            version='v1',
            community='foo',
            source='1.1.1.1',
            port='8080',
            oid='.1',
            access='ro',
            ip_version=4,
            state='present',
            partition='Common',
            provider=dict(
                server='localhost',
                password='password',
                user='admin'
            )
        ))

        module = AnsibleModule(
            argument_spec=self.spec.argument_spec,
            supports_check_mode=self.spec.supports_check_mode,
            required_if=self.spec.required_if
        )
        m1 = V1Manager(module=module)

        # Override methods to force specific logic in the module to happen
        m1.exists = Mock(side_effect=[False, True])
        m1.create_on_device = Mock(return_value=True)

        m0 = ModuleManager(module=module)
        m0.get_manager = Mock(return_value=m1)

        results = m0.exec_module()

        assert results['changed'] is True

    def test_create_v3_community_1(self, *args):
        set_module_args(dict(
            version='v3',
            oid='.1',
            access='ro',
            snmp_username='admin',
            snmp_auth_protocol='md5',
            snmp_auth_password='secretsecret',
            snmp_privacy_protocol='des',
            snmp_privacy_password='secretsecret',
            state='present',
            partition='Common',
            provider=dict(
                server='localhost',
                password='password',
                user='admin'
            )
        ))

        module = AnsibleModule(
            argument_spec=self.spec.argument_spec,
            supports_check_mode=self.spec.supports_check_mode,
            required_if=self.spec.required_if
        )
        m1 = V2Manager(module=module)

        # Override methods to force specific logic in the module to happen
        m1.exists = Mock(side_effect=[False, True])
        m1.create_on_device = Mock(return_value=True)

        m0 = ModuleManager(module=module)
        m0.get_manager = Mock(return_value=m1)

        results = m0.exec_module()

        assert results['changed'] is True

    def test_create_v3_community_2(self, *args):
        set_module_args(dict(
            version='v3',
            access='ro',
            snmp_username='admin',
            snmp_auth_protocol='md5',
            snmp_auth_password='secretsecret',
            snmp_privacy_protocol='des',
            snmp_privacy_password='secretsecret',
            state='present',
            partition='Common',
            provider=dict(
                server='localhost',
                password='password',
                user='admin'
            )
        ))

        module = AnsibleModule(
            argument_spec=self.spec.argument_spec,
            supports_check_mode=self.spec.supports_check_mode,
            required_if=self.spec.required_if
        )
        m1 = V2Manager(module=module)

        # Override methods to force specific logic in the module to happen
        m1.exists = Mock(side_effect=[False, True])
        m1.create_on_device = Mock(return_value=True)

        m0 = ModuleManager(module=module)
        m0.get_manager = Mock(return_value=m1)

        with pytest.raises(F5ModuleError) as ex:
            m0.exec_module()

        assert 'oid must be specified when creating a new v3 community.' == str(ex.value)