Various bigip gtm server and vs enhancements (#40033)

* Refactor bigip_gtm_virtual_server
* Add translation_address to bigip_gtm_virtual_server
* Add translation_port to bigip_gtm_virtual_server
* Add availability_requirements to bigip_gtm_virtual_server
* Add monitors to bigip_gtm_virtual_server
* Add virtual_server_dependencies to bigip_gtm_virtual_server
* Add link to bigip_gtm_virtual_server
* Add limits to bigip_gtm_virtual_server
* Add partition to bigip_gtm_virtual_server
* Fix bigip_gtm_server to correctly create other server types

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

@@ -19,7 +19,7 @@ short_description: Manages F5 BIG-IP GTM servers
 description:
   - Manage BIG-IP server configuration. This module is able to manipulate the server
     definitions in a BIG-IP.
-version_added: "2.5"
+version_added: 2.5
 options:
   name:
     description:
@@ -184,35 +184,27 @@ datacenter:
   sample: datacenter01
 '''
 
-from distutils.version import LooseVersion
-
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.basic import env_fallback
-
+from distutils.version import LooseVersion
-HAS_DEVEL_IMPORTS = False
 
 try:
-    # Sideband repository used for dev
     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 fqdn_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
-    HAS_DEVEL_IMPORTS = True
 except ImportError:
-    # Upstream Ansible
     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 fqdn_name
     from ansible.module_utils.network.f5.common import f5_argument_spec
     try:
         from ansible.module_utils.network.f5.common import iControlUnexpectedHTTPError
@@ -420,12 +412,16 @@ class Difference(object):
             devices = self.have.devices
         else:
             devices = self.want.devices
+        if self.have.devices is None:
+            have_devices = []
+        else:
+            have_devices = self.have.devices
         if len(devices) == 0:
             raise F5ModuleError(
                 "A GTM server must have at least one device associated with it."
             )
         want = [OrderedDict(sorted(d.items())) for d in devices]
-        have = [OrderedDict(sorted(d.items())) for d in self.have.devices]
+        have = [OrderedDict(sorted(d.items())) for d in have_devices]
         if want != have:
             return True
         return False
@@ -645,7 +641,9 @@ class BaseManager(object):
             self.want.update({'disabled': True})
         elif self.want.state in ['present', 'enabled']:
             self.want.update({'enabled': True})
-        self._set_changed_options()
+
+        self.adjust_server_type_by_version()
+        self.should_update()
 
         if self.want.devices is None:
             raise F5ModuleError(
@@ -662,7 +660,7 @@ class BaseManager(object):
             raise F5ModuleError("Failed to create the server")
 
     def create_on_device(self):
-        params = self.want.api_params()
+        params = self.changes.api_params()
         self.client.api.tm.gtm.servers.server.create(
             name=self.want.name,
             partition=self.want.partition,
@@ -740,17 +738,18 @@ class V1Manager(BaseManager):
                 self.want.update({'server_type': 'single-bigip'})
             else:
                 self.want.update({'server_type': 'redundant-bigip'})
-        else:
-            if len(self.want.devices) == 1:
-                self.want.update({'server_type': 'single-bigip'})
-            else:
-                self.want.update({'server_type': 'redundant-bigip'})
         if self.want.link_discovery is None:
             self.want.update({'link_discovery': 'disabled'})
         if self.want.virtual_server_discovery is None:
             self.want.update({'virtual_server_discovery': 'disabled'})
         self._check_link_discovery_requirements()
 
+    def adjust_server_type_by_version(self):
+        if len(self.want.devices) == 1 and self.want.server_type == 'bigip':
+            self.want.update({'server_type': 'single-bigip'})
+        if len(self.want.devices) > 1 and self.want.server_type == 'bigip':
+            self.want.update({'server_type': 'redundant-bigip'})
+
 
 class V2Manager(BaseManager):
     def _assign_creation_defaults(self):
@@ -762,6 +761,9 @@ class V2Manager(BaseManager):
             self.want.update({'virtual_server_discovery': 'disabled'})
         self._check_link_discovery_requirements()
 
+    def adjust_server_type_by_version(self):
+        pass
+
 
 class ArgumentSpec(object):
     def __init__(self):

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

@@ -0,0 +1,18 @@
+{
+    "kind": "tm:gtm:server:virtual-servers:virtual-serversstate",
+    "name": "vs2",
+    "fullPath": "vs2",
+    "generation": 129,
+    "selfLink": "https://localhost/mgmt/tm/gtm/server/~Common~server1/virtual-servers/vs2?ver=13.0.0",
+    "destination": "6.6.6.6:8080",
+    "enabled": true,
+    "limitMaxBps": 100,
+    "limitMaxBpsStatus": "enabled",
+    "limitMaxConnections": 300,
+    "limitMaxConnectionsStatus": "enabled",
+    "limitMaxPps": 200,
+    "limitMaxPpsStatus": "enabled",
+    "monitor": "/Common/gtp ",
+    "translationAddress": "none",
+    "translationPort": 0
+}

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

@@ -21,12 +21,12 @@ from ansible.compat.tests.mock import patch
 from ansible.module_utils.basic import AnsibleModule
 
 try:
-    from library.bigip_gtm_server import ApiParameters
+    from library.modules.bigip_gtm_server import ApiParameters
-    from library.bigip_gtm_server import ModuleParameters
+    from library.modules.bigip_gtm_server import ModuleParameters
-    from library.bigip_gtm_server import ModuleManager
+    from library.modules.bigip_gtm_server import ModuleManager
-    from library.bigip_gtm_server import V1Manager
+    from library.modules.bigip_gtm_server import V1Manager
-    from library.bigip_gtm_server import V2Manager
+    from library.modules.bigip_gtm_server import V2Manager
-    from library.bigip_gtm_server import ArgumentSpec
+    from library.modules.bigip_gtm_server 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
@@ -196,6 +196,8 @@ class TestV1Manager(unittest.TestCase):
         m1 = V1Manager(module=module, params=module.params)
         m1.exists = Mock(side_effect=[False, True])
         m1.create_on_device = Mock(return_value=True)
+        m1.client = Mock()
+        m1.client.api.tmos_version = '12.0.0'
 
         # Override methods in the specific type of manager
         mm = ModuleManager(module=module)
@@ -272,6 +274,8 @@ class TestV2Manager(unittest.TestCase):
         m1 = V2Manager(module=module)
         m1.exists = Mock(side_effect=[False, True])
         m1.create_on_device = Mock(return_value=True)
+        m1.client = Mock()
+        m1.client.api.tmos_version = '13.1.0'
 
         # Override methods in the specific type of manager
         mm = ModuleManager(module=module)

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

@@ -0,0 +1,164 @@
+# -*- 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_virtual_server import ApiParameters
+    from library.modules.bigip_gtm_virtual_server import ModuleParameters
+    from library.modules.bigip_gtm_virtual_server import ModuleManager
+    from library.modules.bigip_gtm_virtual_server 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_virtual_server import ApiParameters
+        from ansible.modules.network.f5.bigip_gtm_virtual_server import ModuleParameters
+        from ansible.modules.network.f5.bigip_gtm_virtual_server import ModuleManager
+        from ansible.modules.network.f5.bigip_gtm_virtual_server 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',
+            server_name='server1',
+            address='1.1.1.1',
+            port=22,
+            translation_address='2.2.2.2',
+            translation_port=443,
+            availability_requirements=dict(
+                type='at_least',
+                at_least=2,
+            ),
+            monitors=['http', 'tcp', 'gtp'],
+            virtual_server_dependencies=[
+                dict(
+                    server='server2',
+                    virtual_server='vs2'
+                )
+            ],
+            link='link1',
+            limits=dict(
+                bits_enabled=True,
+                packets_enabled=True,
+                connections_enabled=True,
+                bits_limit=100,
+                packets_limit=200,
+                connections_limit=300
+            ),
+            state='present'
+        )
+
+        p = ModuleParameters(params=args)
+        assert p.name == 'foo'
+        assert p.server_name == 'server1'
+        assert p.address == '1.1.1.1'
+        assert p.port == 22
+        assert p.translation_address == '2.2.2.2'
+        assert p.translation_port == 443
+        assert p.availability_requirement_type == 'at_least'
+        assert p.at_least == 2
+        assert p.monitors == 'min 2 of { /Common/http /Common/tcp /Common/gtp }'
+        assert len(p.virtual_server_dependencies) == 1
+        assert p.link == '/Common/link1'
+        assert p.bits_enabled == 'enabled'
+        assert p.bits_limit == 100
+        assert p.packets_enabled == 'enabled'
+        assert p.packets_limit == 200
+        assert p.connections_enabled == 'enabled'
+        assert p.connections_limit == 300
+
+    def test_api_parameters(self):
+        args = load_fixture('load_gtm_server_virtual_2.json')
+
+        p = ApiParameters(params=args)
+        assert p.name == 'vs2'
+        assert p.address == '6.6.6.6'
+        assert p.port == 8080
+        assert p.translation_address == 'none'
+        assert p.translation_port == 0
+        assert p.availability_requirement_type == 'all'
+        assert p.monitors == '/Common/gtp'
+        assert p.bits_enabled == 'enabled'
+        assert p.bits_limit == 100
+        assert p.packets_enabled == 'enabled'
+        assert p.packets_limit == 200
+        assert p.connections_enabled == 'enabled'
+        assert p.connections_limit == 300
+
+
+@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_datacenter(self, *args):
+        set_module_args(dict(
+            server_name='foo',
+            name='vs1',
+            address='1.1.1.1',
+            state='present',
+            password='admin',
+            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(side_effect=[False, True])
+        mm.create_on_device = Mock(return_value=True)
+
+        results = mm.exec_module()
+        assert results['changed'] is True