Adds the bigip_gtm_global module (#40430)

This module can be used to manage the global GTM settings on a BIGIP

lib/ansible/modules/network/f5/bigip_gtm_global.py

@@ -0,0 +1,335 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+#
+# Copyright: (c) 2018, 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
+
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+DOCUMENTATION = r'''
+---
+module: bigip_gtm_global
+short_description: Manages global GTM settings
+description:
+  - Manages global GTM settings. These settings include general, load balancing, and metrics
+    related settings.
+version_added: 2.6
+options:
+  synchronization:
+    description:
+      - Specifies whether this system is a member of a synchronization group.
+      - When you enable synchronization, the system periodically queries other systems in
+        the synchronization group to obtain and distribute configuration and metrics collection
+        updates.
+      - The synchronization group may contain systems configured as Global Traffic Manager and
+        Link Controller systems.
+    type: bool
+  synchronization_group_name:
+    description:
+      - Specifies the name of the synchronization group to which the system belongs.
+  synchronize_zone_files:
+    description:
+      - Specifies that the system synchronizes Domain Name System (DNS) zone files among the
+        synchronization group members.
+    type: bool
+extends_documentation_fragment: f5
+author:
+  - Tim Rupp (@caphrim007)
+'''
+
+EXAMPLES = r'''
+- name: Configure synchronization settings
+  bigip_gtm_global:
+    synchronization: yes
+    synchronization_group_name: my-group
+    synchronize_zone_files: yes
+    password: secret
+    server: lb.mydomain.com
+    state: present
+    user: admin
+  delegate_to: localhost
+'''
+
+RETURN = r'''
+synchronization:
+  description: The synchronization setting on the system.
+  returned: changed
+  type: bool
+  sample: true
+synchronization_group_name:
+  description: The synchronization group name.
+  returned: changed
+  type: string
+  sample: my-group
+synchronize_zone_files:
+  description: Whether or not the system will sync zone files.
+  returned: changed
+  type: string
+  sample: my-group
+'''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.basic import env_fallback
+
+try:
+    from library.module_utils.network.f5.bigip import HAS_F5SDK
+    from library.module_utils.network.f5.bigip import F5Client
+    from library.module_utils.network.f5.common import F5ModuleError
+    from library.module_utils.network.f5.common import AnsibleF5Parameters
+    from library.module_utils.network.f5.common import cleanup_tokens
+    from library.module_utils.network.f5.common import fq_name
+    from library.module_utils.network.f5.common import f5_argument_spec
+    try:
+        from library.module_utils.network.f5.common import iControlUnexpectedHTTPError
+    except ImportError:
+        HAS_F5SDK = False
+except ImportError:
+    from ansible.module_utils.network.f5.bigip import HAS_F5SDK
+    from ansible.module_utils.network.f5.bigip import F5Client
+    from ansible.module_utils.network.f5.common import F5ModuleError
+    from ansible.module_utils.network.f5.common import AnsibleF5Parameters
+    from ansible.module_utils.network.f5.common import cleanup_tokens
+    from ansible.module_utils.network.f5.common import fq_name
+    from ansible.module_utils.network.f5.common import f5_argument_spec
+    try:
+        from ansible.module_utils.network.f5.common import iControlUnexpectedHTTPError
+    except ImportError:
+        HAS_F5SDK = False
+
+
+class Parameters(AnsibleF5Parameters):
+    api_map = {
+        'synchronizationGroupName': 'synchronization_group_name',
+        'synchronizeZoneFiles': 'synchronize_zone_files'
+    }
+
+    api_attributes = [
+        'synchronizeZoneFiles', 'synchronizationGroupName', 'synchronization'
+    ]
+
+    returnables = [
+        'synchronization', 'synchronization_group_name', 'synchronize_zone_files'
+    ]
+
+    updatables = [
+        'synchronization', 'synchronization_group_name', 'synchronize_zone_files'
+    ]
+
+
+class ApiParameters(Parameters):
+    @property
+    def synchronization(self):
+        if self._values['synchronization'] is None:
+            return None
+        elif self._values['synchronization'] == 'no':
+            return False
+        else:
+            return True
+
+    @property
+    def synchronize_zone_files(self):
+        if self._values['synchronize_zone_files'] is None:
+            return None
+        elif self._values['synchronize_zone_files'] == 'no':
+            return False
+        else:
+            return True
+
+    @property
+    def synchronization_group_name(self):
+        if self._values['synchronization_group_name'] is None:
+            return None
+        return str(self._values['synchronization_group_name'])
+
+
+class ModuleParameters(Parameters):
+    pass
+
+
+class Changes(Parameters):
+    def to_return(self):
+        result = {}
+        try:
+            for returnable in self.returnables:
+                result[returnable] = getattr(self, returnable)
+            result = self._filter_params(result)
+        except Exception:
+            pass
+        return result
+
+
+class UsableChanges(Changes):
+    @property
+    def synchronization(self):
+        if self._values['synchronization'] is None:
+            return None
+        elif self._values['synchronization'] is False:
+            return 'no'
+        else:
+            return 'yes'
+
+    @property
+    def synchronize_zone_files(self):
+        if self._values['synchronize_zone_files'] is None:
+            return None
+        elif self._values['synchronize_zone_files'] is False:
+            return 'no'
+        else:
+            return 'yes'
+
+
+class ReportableChanges(Changes):
+    pass
+
+
+class Difference(object):
+    def __init__(self, want, have=None):
+        self.want = want
+        self.have = have
+
+    def compare(self, param):
+        try:
+            result = getattr(self, param)
+            return result
+        except AttributeError:
+            return self.__default(param)
+
+    def __default(self, param):
+        attr1 = getattr(self.want, param)
+        try:
+            attr2 = getattr(self.have, param)
+            if attr1 != attr2:
+                return attr1
+        except AttributeError:
+            return attr1
+
+    @property
+    def synchronization_group_name(self):
+        if self.want.synchronization_group_name is None:
+            return None
+        if self.want.synchronization_group_name == '' and self.have.synchronization_group_name is None:
+            return None
+        if self.want.synchronization_group_name != self.have.synchronization_group_name:
+            return self.want.synchronization_group_name
+
+
+class ModuleManager(object):
+    def __init__(self, *args, **kwargs):
+        self.module = kwargs.get('module', None)
+        self.client = kwargs.get('client', None)
+        self.want = ModuleParameters(params=self.module.params)
+        self.have = ApiParameters()
+        self.changes = UsableChanges()
+
+    def _update_changed_options(self):
+        diff = Difference(self.want, self.have)
+        updatables = Parameters.updatables
+        changed = dict()
+        for k in updatables:
+            change = diff.compare(k)
+            if change is None:
+                continue
+            else:
+                if isinstance(change, dict):
+                    changed.update(change)
+                else:
+                    changed[k] = change
+        if changed:
+            self.changes = UsableChanges(params=changed)
+            return True
+        return False
+
+    def should_update(self):
+        result = self._update_changed_options()
+        if result:
+            return True
+        return False
+
+    def exec_module(self):
+        result = dict()
+
+        try:
+            changed = self.present()
+        except iControlUnexpectedHTTPError as e:
+            raise F5ModuleError(str(e))
+
+        reportable = ReportableChanges(params=self.changes.to_return())
+        changes = reportable.to_return()
+        result.update(**changes)
+        result.update(dict(changed=changed))
+        self._announce_deprecations(result)
+        return result
+
+    def _announce_deprecations(self, result):
+        warnings = result.pop('__warnings', [])
+        for warning in warnings:
+            self.client.module.deprecate(
+                msg=warning['msg'],
+                version=warning['version']
+            )
+
+    def present(self):
+        return self.update()
+
+    def update(self):
+        self.have = self.read_current_from_device()
+        if not self.should_update():
+            return False
+        if self.module.check_mode:
+            return True
+        self.update_on_device()
+        return True
+
+    def update_on_device(self):
+        params = self.changes.api_params()
+        resource = self.client.api.tm.gtm.global_settings.general.load()
+        resource.modify(**params)
+
+    def read_current_from_device(self):
+        resource = self.client.api.tm.gtm.global_settings.general.load()
+        result = resource.attrs
+        return ApiParameters(params=result)
+
+
+class ArgumentSpec(object):
+    def __init__(self):
+        self.supports_check_mode = True
+        argument_spec = dict(
+            synchronization=dict(type='bool'),
+            synchronization_group_name=dict(),
+            synchronize_zone_files=dict(type='bool')
+        )
+        self.argument_spec = {}
+        self.argument_spec.update(f5_argument_spec)
+        self.argument_spec.update(argument_spec)
+
+
+def main():
+    spec = ArgumentSpec()
+
+    module = AnsibleModule(
+        argument_spec=spec.argument_spec,
+        supports_check_mode=spec.supports_check_mode
+    )
+    if not HAS_F5SDK:
+        module.fail_json(msg="The python f5-sdk module is required")
+
+    try:
+        client = F5Client(**module.params)
+        mm = ModuleManager(module=module, client=client)
+        results = mm.exec_module()
+        cleanup_tokens(client)
+        module.exit_json(**results)
+    except F5ModuleError as ex:
+        cleanup_tokens(client)
+        module.fail_json(msg=str(ex))
+
+
+if __name__ == '__main__':
+    main()

test/units/modules/network/f5/fixtures/load_gtm_global_settings_general_1.json

@@ -0,0 +1,25 @@
+{
+    "kind": "tm:gtm:global-settings:general:generalstate",
+    "selfLink": "https://localhost/mgmt/tm/gtm/global-settings/general?ver=13.1.0.4",
+    "autoDiscovery": "yes",
+    "autoDiscoveryInterval": 30,
+    "automaticConfigurationSaveTimeout": 15,
+    "cacheLdnsServers": "yes",
+    "domainNameCheck": "allow-underscore",
+    "drainPersistentRequests": "yes",
+    "forwardStatus": "disabled",
+    "gtmSetsRecursion": "no",
+    "heartbeatInterval": 10,
+    "monitorDisabledObjects": "no",
+    "nethsmTimeout": 20,
+    "sendWildcardRrs": "disabled",
+    "staticPersistCidrIpv4": 32,
+    "staticPersistCidrIpv6": 128,
+    "synchronization": "no",
+    "synchronizationGroupName": "default",
+    "synchronizationTimeTolerance": 10,
+    "synchronizationTimeout": 180,
+    "synchronizeZoneFiles": "no",
+    "synchronizeZoneFilesTimeout": 300,
+    "virtualsDependOnServerState": "yes"
+}

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

@@ -0,0 +1,120 @@
+# -*- 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_gtm_global import ApiParameters
+    from library.modules.bigip_gtm_global import ModuleParameters
+    from library.modules.bigip_gtm_global import ModuleManager
+    from library.modules.bigip_gtm_global 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_gtm_global import ApiParameters
+        from ansible.modules.network.f5.bigip_gtm_global import ModuleParameters
+        from ansible.modules.network.f5.bigip_gtm_global import ModuleManager
+        from ansible.modules.network.f5.bigip_gtm_global 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(
+            synchronization=True,
+            synchronization_group_name='foo',
+            synchronize_zone_files=True
+        )
+
+        p = ModuleParameters(params=args)
+        assert p.synchronization is True
+        assert p.synchronization_group_name == 'foo'
+        assert p.synchronize_zone_files is True
+
+    def test_api_parameters(self):
+        args = load_fixture('load_gtm_global_settings_general_1.json')
+
+        p = ApiParameters(params=args)
+        assert p.synchronization is False
+        assert p.synchronization_group_name == 'default'
+        assert p.synchronize_zone_files is False
+
+
+@patch('ansible.module_utils.f5_utils.AnsibleF5Client._get_mgmt_root',
+       return_value=True)
+class TestManager(unittest.TestCase):
+
+    def setUp(self):
+        self.spec = ArgumentSpec()
+
+    def update(self, *args):
+        set_module_args(dict(
+            synchronization="yes",
+            synchronization_group_name='foo',
+            synchronize_zone_files="yes",
+            server='localhost',
+            password='password',
+            user='admin'
+        ))
+
+        current = ApiParameters(params=load_fixture('load_gtm_global_settings_general_1.json'))
+        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.update_on_device = Mock(return_value=True)
+        mm.read_current_from_device = Mock(return_value=current)
+
+        results = mm.exec_module()
+
+        assert results['changed'] is True
+        assert results['synchronization'] == 'yes'
+        assert results['synchronization_group_name'] == 'foo'
+        assert results['synchronize_zone_files'] == 'yes'