Adds tcp profile module for BIGIP (#39268)

This patch adds a module to support manipulation of TCP profiles
on a BIGIP

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

@@ -0,0 +1,405 @@
+#!/usr/bin/python
+# -*- 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
+
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+DOCUMENTATION = r'''
+---
+module: bigip_profile_tcp
+short_description: Manage TCP profiles on a BIG-IP
+description:
+  - Manage TCP profiles on a BIG-IP. There are a variety of TCP profiles, each with their
+    own adjustments to the standard C(tcp) profile. Users of this module should be aware
+    that many of the adjustable knobs have no module default. Instead, the default is
+    assigned by the BIG-IP system itself which, in most cases, is acceptable.
+version_added: 2.6
+options:
+  name:
+    description:
+      - Specifies the name of the profile.
+    required: True
+  parent:
+    description:
+      - Specifies the profile from which this profile inherits settings.
+      - When creating a new profile, if this parameter is not specified, the default
+        is the system-supplied C(tcp) profile.
+  idle_timeout:
+    description:
+      - Specifies the length of time that a connection is idle (has no traffic) before
+        the connection is eligible for deletion.
+      - When creating a new profile, if this parameter is not specified, the remote
+        device will choose a default value appropriate for the profile, based on its
+        C(parent) profile.
+      - When a number is specified, indicates the number of seconds that the TCP
+        connection can remain idle before the system deletes it.
+      - When C(0), or C(indefinite), specifies that the system does not delete TCP connections
+        regardless of how long they remain idle.
+  partition:
+    description:
+      - Device partition to manage resources on.
+    default: Common
+  state:
+    description:
+      - When C(present), ensures that the profile exists.
+      - When C(absent), ensures the profile is removed.
+    default: present
+    choices:
+      - present
+      - absent
+extends_documentation_fragment: f5
+author:
+  - Tim Rupp (@caphrim007)
+'''
+
+EXAMPLES = r'''
+- name: Create a TCP profile
+  bigip_profile_tcp:
+    name: foo
+    parent: f5-tcp-progressive
+    idle_timeout: 300
+    password: secret
+    server: lb.mydomain.com
+    state: present
+    user: admin
+  delegate_to: localhost
+'''
+
+RETURN = r'''
+parent:
+  description: The new parent of the resource.
+  returned: changed
+  type: string
+  sample: f5-tcp-optimized
+idle_timeout:
+  description: The new idle timeout of the resource.
+  returned: changed
+  type: int
+  sample: 100
+'''
+
+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 = {
+        'idleTimeout': 'idle_timeout',
+        'defaultsFrom': 'parent'
+    }
+
+    api_attributes = [
+        'idleTimeout',
+        'defaultsFrom'
+    ]
+
+    returnables = [
+        'idle_timeout',
+        'parent'
+    ]
+
+    updatables = [
+        'idle_timeout',
+        'parent'
+    ]
+
+
+class ApiParameters(Parameters):
+    pass
+
+
+class ModuleParameters(Parameters):
+    @property
+    def parent(self):
+        if self._values['parent'] is None:
+            return None
+        result = fq_name(self.partition, self._values['parent'])
+        return result
+
+    @property
+    def idle_timeout(self):
+        if self._values['idle_timeout'] is None:
+            return None
+        if self._values['idle_timeout'] == 'indefinite':
+            return 4294967295
+        return int(self._values['idle_timeout'])
+
+
+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 idle_timeout(self):
+        if self._values['idle_timeout'] is None:
+            return None
+        if 0 <= self._values['idle_timeout'] <= 4294967295:
+            return self._values['idle_timeout']
+        raise F5ModuleError(
+            "Valid 'idle_timeout' must be in range 1 - 4294967295, or 'indefinite'."
+        )
+
+
+class ReportableChanges(Changes):
+    @property
+    def idle_timeout(self):
+        if self._values['idle_timeout'] is None:
+            return None
+        if self._values['idle_timeout'] == 4294967295:
+            return 'indefinite'
+        return int(self._values['idle_timeout'])
+
+
+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
+
+
+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 _set_changed_options(self):
+        changed = {}
+        for key in Parameters.returnables:
+            if getattr(self.want, key) is not None:
+                changed[key] = getattr(self.want, key)
+        if changed:
+            self.changes = UsableChanges(params=changed)
+
+    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):
+        changed = False
+        result = dict()
+        state = self.want.state
+
+        try:
+            if state == "present":
+                changed = self.present()
+            elif state == "absent":
+                changed = self.absent()
+        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):
+        if self.exists():
+            return self.update()
+        else:
+            return self.create()
+
+    def exists(self):
+        result = self.client.api.tm.ltm.profile.tcps.tcp.exists(
+            name=self.want.name,
+            partition=self.want.partition
+        )
+        return result
+
+    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 remove(self):
+        if self.module.check_mode:
+            return True
+        self.remove_from_device()
+        if self.exists():
+            raise F5ModuleError("Failed to delete the resource.")
+        return True
+
+    def create(self):
+        if self.want.parent is None:
+            self.want.update({'parent': fq_name(self.want.partition, 'tcp')})
+        self._set_changed_options()
+        if self.module.check_mode:
+            return True
+        self.create_on_device()
+        return True
+
+    def create_on_device(self):
+        params = self.changes.api_params()
+        self.client.api.tm.ltm.profile.tcps.tcp.create(
+            name=self.want.name,
+            partition=self.want.partition,
+            **params
+        )
+
+    def update_on_device(self):
+        params = self.changes.api_params()
+        resource = self.client.api.tm.ltm.profile.tcps.tcp.load(
+            name=self.want.name,
+            partition=self.want.partition
+        )
+        resource.modify(**params)
+
+    def absent(self):
+        if self.exists():
+            return self.remove()
+        return False
+
+    def remove_from_device(self):
+        resource = self.client.api.tm.ltm.profile.tcps.tcp.load(
+            name=self.want.name,
+            partition=self.want.partition
+        )
+        if resource:
+            resource.delete()
+
+    def read_current_from_device(self):
+        resource = self.client.api.tm.ltm.profile.tcps.tcp.load(
+            name=self.want.name,
+            partition=self.want.partition
+        )
+        result = resource.attrs
+        return ApiParameters(params=result)
+
+
+class ArgumentSpec(object):
+    def __init__(self):
+        self.supports_check_mode = True
+        argument_spec = dict(
+            name=dict(required=True),
+            parent=dict(),
+            idle_timeout=dict(),
+            state=dict(
+                default='present',
+                choices=['present', 'absent']
+            ),
+            partition=dict(
+                default='Common',
+                fallback=(env_fallback, ['F5_PARTITION'])
+            )
+        )
+        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_ltm_profile_tcp_1.json

@@ -0,0 +1,92 @@
+{
+    "kind": "tm:ltm:profile:tcp:tcpstate",
+    "name": "foo",
+    "partition": "Common",
+    "fullPath": "/Common/foo",
+    "generation": 92,
+    "selfLink": "https://localhost/mgmt/tm/ltm/profile/tcp/~Common~foo?ver=13.1.0.4",
+    "abc": "enabled",
+    "ackOnPush": "enabled",
+    "appService": "none",
+    "autoProxyBufferSize": "disabled",
+    "autoReceiveWindowSize": "disabled",
+    "autoSendBufferSize": "disabled",
+    "closeWaitTimeout": 5,
+    "cmetricsCache": "enabled",
+    "cmetricsCacheTimeout": 0,
+    "congestionControl": "high-speed",
+    "defaultsFrom": "/Common/tcp",
+    "defaultsFromReference": {
+        "link": "https://localhost/mgmt/tm/ltm/profile/tcp/~Common~tcp?ver=13.1.0.4"
+    },
+    "deferredAccept": "disabled",
+    "delayWindowControl": "disabled",
+    "delayedAcks": "enabled",
+    "description": "none",
+    "dsack": "disabled",
+    "earlyRetransmit": "enabled",
+    "ecn": "enabled",
+    "enhancedLossRecovery": "disabled",
+    "fastOpen": "disabled",
+    "fastOpenCookieExpiration": 21600,
+    "finWait_2Timeout": 300,
+    "finWaitTimeout": 5,
+    "hardwareSynCookie": "enabled",
+    "idleTimeout": 300,
+    "initCwnd": 3,
+    "initRwnd": 3,
+    "ipDfMode": "pmtu",
+    "ipTosToClient": "0",
+    "ipTtlMode": "proxy",
+    "ipTtlV4": 255,
+    "ipTtlV6": 64,
+    "keepAliveInterval": 1800,
+    "limitedTransmit": "enabled",
+    "linkQosToClient": "0",
+    "maxRetrans": 8,
+    "maxSegmentSize": 1460,
+    "md5Signature": "disabled",
+    "minimumRto": 1000,
+    "mptcp": "disabled",
+    "mptcpCsum": "disabled",
+    "mptcpCsumVerify": "disabled",
+    "mptcpDebug": "disabled",
+    "mptcpFallback": "reset",
+    "mptcpFastjoin": "disabled",
+    "mptcpIdleTimeout": 300,
+    "mptcpJoinMax": 5,
+    "mptcpMakeafterbreak": "disabled",
+    "mptcpNojoindssack": "disabled",
+    "mptcpRtomax": 5,
+    "mptcpRxmitmin": 1000,
+    "mptcpSubflowmax": 6,
+    "mptcpTimeout": 3600,
+    "nagle": "disabled",
+    "pktLossIgnoreBurst": 0,
+    "pktLossIgnoreRate": 0,
+    "proxyBufferHigh": 49152,
+    "proxyBufferLow": 32768,
+    "proxyMss": "enabled",
+    "proxyOptions": "disabled",
+    "pushFlag": "default",
+    "ratePace": "disabled",
+    "ratePaceMaxRate": 0,
+    "receiveWindowSize": 65535,
+    "resetOnTimeout": "enabled",
+    "rexmtThresh": 3,
+    "selectiveAcks": "enabled",
+    "selectiveNack": "disabled",
+    "sendBufferSize": 65535,
+    "slowStart": "enabled",
+    "synCookieEnable": "enabled",
+    "synCookieWhitelist": "disabled",
+    "synMaxRetrans": 3,
+    "synRtoBase": 3000,
+    "tailLossProbe": "disabled",
+    "tcpOptions": "none",
+    "timeWaitRecycle": "enabled",
+    "timeWaitTimeout": "2000",
+    "timestamps": "enabled",
+    "verifiedAccept": "disabled",
+    "zeroWindowTimeout": 20000
+}

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

@@ -0,0 +1,114 @@
+# -*- 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_profile_tcp import ApiParameters
+    from library.modules.bigip_profile_tcp import ModuleParameters
+    from library.modules.bigip_profile_tcp import ModuleManager
+    from library.modules.bigip_profile_tcp 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_profile_tcp import ApiParameters
+        from ansible.modules.network.f5.bigip_profile_tcp import ModuleParameters
+        from ansible.modules.network.f5.bigip_profile_tcp import ModuleManager
+        from ansible.modules.network.f5.bigip_profile_tcp 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',
+            parent='bar',
+            idle_timeout='500'
+        )
+
+        p = ModuleParameters(params=args)
+        assert p.name == 'foo'
+        assert p.parent == '/Common/bar'
+        assert p.idle_timeout == 500
+
+    def test_api_parameters(self):
+        args = load_fixture('load_ltm_profile_tcp_1.json')
+        p = ApiParameters(params=args)
+        assert p.name == 'foo'
+        assert p.idle_timeout == 300
+
+
+class TestManager(unittest.TestCase):
+
+    def setUp(self):
+        self.spec = ArgumentSpec()
+
+    def test_create(self, *args):
+        # Configure the arguments that would be sent to the Ansible module
+        set_module_args(dict(
+            name='foo',
+            parent='bar',
+            idle_timeout=500,
+            password='password',
+            server='localhost',
+            user='admin'
+        ))
+
+        module = AnsibleModule(
+            argument_spec=self.spec.argument_spec,
+            supports_check_mode=self.spec.supports_check_mode
+        )
+        mm = ModuleManager(module=module)
+
+        # Override methods to force specific logic in the module to happen
+        mm.exists = Mock(return_value=False)
+        mm.create_on_device = Mock(return_value=True)
+
+        results = mm.exec_module()
+
+        assert results['changed'] is True
+        assert results['idle_timeout'] == 500