1# -*- coding: utf-8 -*-
2#
3# Copyright: (c) 2019, F5 Networks Inc.
4# GNU General Public License v3.0 (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
5
6from __future__ import (absolute_import, division, print_function)
7__metaclass__ = type
8
9import os
10import json
11import pytest
12import sys
13
14if sys.version_info < (2, 7):
15    pytestmark = pytest.mark.skip("F5 Ansible modules require Python >= 2.7")
16
17from ansible.module_utils.basic import AnsibleModule
18
19from ansible_collections.f5networks.f5_modules.plugins.modules.bigip_firewall_log_profile import (
20    ApiParameters, ModuleParameters, ModuleManager, ArgumentSpec
21)
22from ansible_collections.f5networks.f5_modules.tests.unit.compat import unittest
23from ansible_collections.f5networks.f5_modules.tests.unit.compat.mock import Mock, patch
24from ansible_collections.f5networks.f5_modules.tests.unit.modules.utils import set_module_args
25
26fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures')
27fixture_data = {}
28
29
30def load_fixture(name):
31    path = os.path.join(fixture_path, name)
32
33    if path in fixture_data:
34        return fixture_data[path]
35
36    with open(path) as f:
37        data = f.read()
38
39    try:
40        data = json.loads(data)
41    except Exception:
42        pass
43
44    fixture_data[path] = data
45    return data
46
47
48class TestParameters(unittest.TestCase):
49    def test_module_parameters(self):
50        args = dict(
51            name='foo',
52            description='my description',
53            partition='Common',
54            ip_intelligence=dict(
55                log_publisher='foobar',
56                rate_limit='300000',
57                log_translation_fields='yes',
58                log_rtbh='yes',
59                log_shun='yes',
60            ),
61            port_misuse=dict(
62                log_publisher='/Part/bazbar',
63                rate_limit='indefinite',
64            ),
65            dos_protection=dict(
66                sip_publisher='sip-pub',
67                dns_publisher='/Temp/dns-pub',
68                network_publisher='net-pub'
69            )
70        )
71
72        p = ModuleParameters(params=args)
73        assert p.name == 'foo'
74        assert p.description == 'my description'
75        assert p.ip_rate_limit == 300000
76        assert p.ip_log_publisher == '/Common/foobar'
77        assert p.ip_log_translation_fields == 'enabled'
78        assert p.ip_log_shun is None
79        assert p.ip_log_rtbh == 'enabled'
80        assert p.port_log_publisher == '/Part/bazbar'
81        assert p.port_rate_limit == 4294967295
82        assert p.dns_publisher == '/Temp/dns-pub'
83        assert p.sip_publisher == '/Common/sip-pub'
84        assert p.network_publisher == '/Common/net-pub'
85
86    def test_api_parameters(self):
87        args = load_fixture('load_afm_log_global_network_profile.json')
88
89        p = ApiParameters(params=args)
90        assert p.name == 'global-network'
91        assert p.description == 'Default logging profile for network events'
92        assert p.ip_log_shun == 'disabled'
93        assert p.ip_log_translation_fields == 'disabled'
94        assert p.ip_rate_limit == 4294967295
95        assert p.port_rate_limit == 4294967295
96        assert p.ip_log_publisher is None
97        assert p.port_log_publisher is None
98
99
100class TestManager(unittest.TestCase):
101
102    def setUp(self):
103        self.spec = ArgumentSpec()
104        self.p2 = patch('ansible_collections.f5networks.f5_modules.plugins.modules.bigip_firewall_log_profile.tmos_version')
105        self.p3 = patch('ansible_collections.f5networks.f5_modules.plugins.modules.bigip_firewall_log_profile.send_teem')
106        self.m2 = self.p2.start()
107        self.m2.return_value = '14.1.0'
108        self.m3 = self.p3.start()
109        self.m3.return_value = True
110
111    def tearDown(self):
112        self.p2.stop()
113        self.p3.stop()
114
115    def test_create(self, *args):
116        set_module_args(dict(
117            name='foo',
118            description='this is a description',
119            provider=dict(
120                server='localhost',
121                password='password',
122                user='admin'
123            )
124        ))
125
126        module = AnsibleModule(
127            argument_spec=self.spec.argument_spec,
128            supports_check_mode=self.spec.supports_check_mode
129        )
130        mm = ModuleManager(module=module)
131
132        # Override methods to force specific logic in the module to happen
133        mm.exists = Mock(side_effect=[False, True])
134        mm.create_on_device = Mock(return_value=True)
135
136        results = mm.exec_module()
137
138        assert results['changed'] is True
139        assert results['description'] == 'this is a description'
140