Adds the bigip_smtp module (#39243)

This module can be used to manage smtp settings on a bigip.

test/units/modules/network/f5/test_bigip_smtp.py

@@ -0,0 +1,152 @@
+# -*- 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
+
+from nose.plugins.skip import SkipTest
+if sys.version_info < (2, 7):
+    raise SkipTest("F5 Ansible modules require Python >= 2.7")
+
+from ansible.compat.tests import unittest
+from ansible.compat.tests.mock import Mock
+from ansible.compat.tests.mock import patch
+from ansible.module_utils.basic import AnsibleModule
+
+try:
+    from library.modules.bigip_smtp import ApiParameters
+    from library.modules.bigip_smtp import ModuleParameters
+    from library.modules.bigip_smtp import ModuleManager
+    from library.modules.bigip_smtp import ArgumentSpec
+    from library.module_utils.network.f5.common import F5ModuleError
+    from library.module_utils.network.f5.common import iControlUnexpectedHTTPError
+    from test.unit.modules.utils import set_module_args
+except ImportError:
+    try:
+        from ansible.modules.network.f5.bigip_smtp import ApiParameters
+        from ansible.modules.network.f5.bigip_smtp import ModuleParameters
+        from ansible.modules.network.f5.bigip_smtp import ModuleManager
+        from ansible.modules.network.f5.bigip_smtp import ArgumentSpec
+        from ansible.module_utils.network.f5.common import F5ModuleError
+        from ansible.module_utils.network.f5.common import iControlUnexpectedHTTPError
+        from units.modules.utils import set_module_args
+    except ImportError:
+        raise SkipTest("F5 Ansible modules require the f5-sdk Python library")
+
+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(
+            name='foo',
+            smtp_server='1.1.1.1',
+            smtp_server_port='25',
+            smtp_server_username='admin',
+            smtp_server_password='password',
+            local_host_name='smtp.mydomain.com',
+            encryption='tls',
+            update_password='always',
+            from_address='no-reply@mydomain.com',
+            authentication=True,
+        )
+
+        p = ModuleParameters(params=args)
+        assert p.name == 'foo'
+        assert p.smtp_server == '1.1.1.1'
+        assert p.smtp_server_port == 25
+        assert p.smtp_server_username == 'admin'
+        assert p.smtp_server_password == 'password'
+        assert p.local_host_name == 'smtp.mydomain.com'
+        assert p.encryption == 'tls'
+        assert p.update_password == 'always'
+        assert p.from_address == 'no-reply@mydomain.com'
+        assert p.authentication_disabled is None
+        assert p.authentication_enabled is True
+
+    def test_api_parameters(self):
+        p = ApiParameters(params=load_fixture('load_sys_smtp_server.json'))
+        assert p.name == 'foo'
+        assert p.smtp_server == 'mail.foo.bar'
+        assert p.smtp_server_port == 465
+        assert p.smtp_server_username == 'admin'
+        assert p.smtp_server_password == '$M$Ch$this-is-encrypted=='
+        assert p.local_host_name == 'mail-host.foo.bar'
+        assert p.encryption == 'ssl'
+        assert p.from_address == 'no-reply@foo.bar'
+        assert p.authentication_disabled is None
+        assert p.authentication_enabled is True
+
+
+@patch('ansible.module_utils.f5_utils.AnsibleF5Client._get_mgmt_root',
+       return_value=True)
+class TestManager(unittest.TestCase):
+
+    def setUp(self):
+        self.spec = ArgumentSpec()
+
+    def test_create_monitor(self, *args):
+        set_module_args(dict(
+            name='foo',
+            smtp_server='1.1.1.1',
+            smtp_server_port='25',
+            smtp_server_username='admin',
+            smtp_server_password='password',
+            local_host_name='smtp.mydomain.com',
+            encryption='tls',
+            update_password='always',
+            from_address='no-reply@mydomain.com',
+            authentication=True,
+            partition='Common',
+            server='localhost',
+            password='password',
+            user='admin'
+        ))
+
+        module = AnsibleModule(
+            argument_spec=self.spec.argument_spec,
+            supports_check_mode=self.spec.supports_check_mode
+        )
+
+        # Override methods in the specific type of manager
+        mm = ModuleManager(module=module)
+        mm.exists = Mock(side_effect=[False, True])
+        mm.create_on_device = Mock(return_value=True)
+
+        results = mm.exec_module()
+
+        assert results['changed'] is True
+        assert results['encryption'] == 'tls'
+        assert results['smtp_server'] == '1.1.1.1'
+        assert results['smtp_server_port'] == 25
+        assert results['local_host_name'] == 'smtp.mydomain.com'
+        assert results['authentication'] is True
+        assert results['from_address'] == 'no-reply@mydomain.com'
+        assert 'smtp_server_username' not in results
+        assert 'smtp_server_password' not in results