Remove the f5-sdk from bigip_gtm_monitor_http (#48500)

2024-09-14 20:13:21 +02:00 · 2018-11-10 15:26:33 -08:00 · 2018-11-10 15:26:33 -08:00 · ce1c88a7b8
commit ce1c88a7b8
parent 75661cc5f6
2 changed files with 168 additions and 108 deletions
--- a/lib/ansible/modules/network/f5/bigip_gtm_monitor_http.py
+++ b/lib/ansible/modules/network/f5/bigip_gtm_monitor_http.py
@ -133,6 +133,7 @@ options:
 extends_documentation_fragment: f5
 author:
  - Tim Rupp (@caphrim007)
+  - Wojciech Wypior (@wojtek0806)
 '''

 EXAMPLES = r'''
@ -230,31 +231,29 @@ 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.bigip import F5RestClient
    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
+    from library.module_utils.network.f5.common import transform_name
+    from library.module_utils.network.f5.common import exit_json
+    from library.module_utils.network.f5.common import fail_json
+    from library.module_utils.network.f5.icontrol import module_provisioned
    from library.module_utils.network.f5.ipaddress import is_valid_ip
-    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.bigip import F5RestClient
    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
+    from ansible.module_utils.network.f5.common import transform_name
+    from ansible.module_utils.network.f5.common import exit_json
+    from ansible.module_utils.network.f5.common import fail_json
+    from ansible.module_utils.network.f5.icontrol import module_provisioned
    from ansible.module_utils.network.f5.ipaddress import is_valid_ip
-    try:
-        from ansible.module_utils.network.f5.common import iControlUnexpectedHTTPError
-    except ImportError:
-        HAS_F5SDK = False


 class Parameters(AnsibleF5Parameters):
@ -264,7 +263,7 @@ class Parameters(AnsibleF5Parameters):
        'probeTimeout': 'probe_timeout',
        'recv': 'receive',
        'username': 'target_username',
-        'password': 'target_password'
+        'password': 'target_password',
    }

    api_attributes = [
@ -279,7 +278,7 @@ class Parameters(AnsibleF5Parameters):
        'send',
        'recv',
        'username',
-        'password'
+        'password',
    ]

    returnables = [
@ -293,7 +292,7 @@ class Parameters(AnsibleF5Parameters):
        'ignore_down_response',
        'send',
        'receive',
-        'reverse'
+        'reverse',
    ]

    updatables = [
@ -309,7 +308,7 @@ class Parameters(AnsibleF5Parameters):
        'ip',
        'port',
        'target_username',
-        'target_password'
+        'target_password',
    ]


@ -596,32 +595,6 @@ class ModuleManager(object):
            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:
@ -648,18 +621,46 @@ class ModuleManager(object):
        if self.want.send is None:
            self.want.update({'send': 'GET /\r\n'})

+    def exec_module(self):
+        if not module_provisioned(self.client, 'gtm'):
+            raise F5ModuleError(
+                "GTM must be provisioned to use this module."
+            )
+        changed = False
+        result = dict()
+        state = self.want.state
+
+        if state == "present":
+            changed = self.present()
+        elif state == "absent":
+            changed = self.absent()
+
+        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 create(self):
+        self._set_default_creation_values()
+        self._set_changed_options()
+        if self.module.check_mode:
+            return True
+        self.create_on_device()
+        return True
+
    def present(self):
        if self.exists():
            return self.update()
        else:
            return self.create()

-    def exists(self):
-        result = self.client.api.tm.gtm.monitor.https.http.exists(
-            name=self.want.name,
-            partition=self.want.partition
-        )
-        return result
+    def should_update(self):
+        result = self._update_changed_options()
+        if result:
+            return True
+        return False

    def update(self):
        self.have = self.read_current_from_device()
@ -670,58 +671,103 @@ class ModuleManager(object):
        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):
-        self._set_default_creation_values()
-        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.gtm.monitor.https.http.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.gtm.monitor.https.http.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.gtm.monitor.https.http.load(
-            name=self.want.name,
-            partition=self.want.partition
+    def remove(self):
+        if self.module.check_mode:
+            return True
+        self.remove_from_device()
+        if self.exists():
+            raise F5ModuleError("Failed to delete the monitor.")
+        return True
+
+    def exists(self):
+        uri = "https://{0}:{1}/mgmt/tm/gtm/monitor/http/{2}".format(
+            self.client.provider['server'],
+            self.client.provider['server_port'],
+            transform_name(self.want.partition, self.want.name),
        )
-        if resource:
-            resource.delete()
+        resp = self.client.api.get(uri)
+        try:
+            response = resp.json()
+        except ValueError:
+            return False
+        if resp.status == 404 or 'code' in response and response['code'] == 404:
+            return False
+        return True

    def read_current_from_device(self):
-        resource = self.client.api.tm.gtm.monitor.https.http.load(
-            name=self.want.name,
-            partition=self.want.partition
+        uri = "https://{0}:{1}/mgmt/tm/gtm/monitor/http/{2}".format(
+            self.client.provider['server'],
+            self.client.provider['server_port'],
+            transform_name(self.want.partition, self.want.name),
        )
-        result = resource.attrs
-        return ApiParameters(params=result)
+        resp = self.client.api.get(uri)
+        try:
+            response = resp.json()
+        except ValueError as ex:
+            raise F5ModuleError(str(ex))
+
+        if 'code' in response and response['code'] == 400:
+            if 'message' in response:
+                raise F5ModuleError(response['message'])
+            else:
+                raise F5ModuleError(resp.content)
+        return ApiParameters(params=response)
+
+    def update_on_device(self):
+        params = self.changes.api_params()
+        uri = "https://{0}:{1}/mgmt/tm/gtm/monitor/http/{2}".format(
+            self.client.provider['server'],
+            self.client.provider['server_port'],
+            transform_name(self.want.partition, self.want.name),
+        )
+        resp = self.client.api.patch(uri, json=params)
+        try:
+            response = resp.json()
+        except ValueError as ex:
+            raise F5ModuleError(str(ex))
+
+        if 'code' in response and response['code'] == 400:
+            if 'message' in response:
+                raise F5ModuleError(response['message'])
+            else:
+                raise F5ModuleError(resp.content)
+
+    def create_on_device(self):
+        params = self.changes.api_params()
+        params['name'] = self.want.name
+        params['partition'] = self.want.partition
+        uri = "https://{0}:{1}/mgmt/tm/gtm/monitor/http/".format(
+            self.client.provider['server'],
+            self.client.provider['server_port'],
+        )
+        resp = self.client.api.post(uri, json=params)
+        try:
+            response = resp.json()
+        except ValueError as ex:
+            raise F5ModuleError(str(ex))
+
+        if 'code' in response and response['code'] in [400, 403]:
+            if 'message' in response:
+                raise F5ModuleError(response['message'])
+            else:
+                raise F5ModuleError(resp.content)
+        return response['selfLink']
+
+    def remove_from_device(self):
+        uri = "https://{0}:{1}/mgmt/tm/gtm/monitor/http/{2}".format(
+            self.client.provider['server'],
+            self.client.provider['server_port'],
+            transform_name(self.want.partition, self.want.name),
+        )
+        response = self.client.api.delete(uri)
+        if response.status == 200:
+            return True
+        raise F5ModuleError(response.content)


 class ArgumentSpec(object):
@ -765,20 +811,19 @@ def main():

    module = AnsibleModule(
        argument_spec=spec.argument_spec,
-        supports_check_mode=spec.supports_check_mode
+        supports_check_mode=spec.supports_check_mode,
    )
-    if not HAS_F5SDK:
-        module.fail_json(msg="The python f5-sdk module is required")
+
+    client = F5RestClient(**module.params)

    try:
-        client = F5Client(**module.params)
        mm = ModuleManager(module=module, client=client)
        results = mm.exec_module()
        cleanup_tokens(client)
-        module.exit_json(**results)
+        exit_json(module, results, client)
    except F5ModuleError as ex:
        cleanup_tokens(client)
-        module.fail_json(msg=str(ex))
+        fail_json(module, ex, client)


 if __name__ == '__main__':
--- a/test/units/modules/network/f5/test_bigip_gtm_monitor_http.py
+++ b/test/units/modules/network/f5/test_bigip_gtm_monitor_http.py
@ -8,16 +8,12 @@ __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 units.compat import unittest
-from units.compat.mock import Mock
-from units.compat.mock import patch
 from ansible.module_utils.basic import AnsibleModule

 try:
@ -25,17 +21,25 @@ try:
    from library.modules.bigip_gtm_monitor_http import ModuleParameters
    from library.modules.bigip_gtm_monitor_http import ModuleManager
    from library.modules.bigip_gtm_monitor_http 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
+
+    # In Ansible 2.8, Ansible changed import paths.
+    from test.units.compat import unittest
+    from test.units.compat.mock import Mock
+    from test.units.compat.mock import patch
+
+    from test.units.modules.utils import set_module_args
 except ImportError:
    try:
        from ansible.modules.network.f5.bigip_gtm_monitor_http import ApiParameters
        from ansible.modules.network.f5.bigip_gtm_monitor_http import ModuleParameters
        from ansible.modules.network.f5.bigip_gtm_monitor_http import ModuleManager
        from ansible.modules.network.f5.bigip_gtm_monitor_http import ArgumentSpec
-        from ansible.module_utils.network.f5.common import F5ModuleError
-        from ansible.module_utils.network.f5.common import iControlUnexpectedHTTPError
+
+        # Ansible 2.8 imports
+        from units.compat import unittest
+        from units.compat.mock import Mock
+        from units.compat.mock import patch
+
        from units.modules.utils import set_module_args
    except ImportError:
        raise SkipTest("F5 Ansible modules require the f5-sdk Python library")
@ -113,13 +117,23 @@ class TestParameters(unittest.TestCase):
        assert p.reverse 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()

+        try:
+            self.p1 = patch('library.modules.bigip_gtm_monitor_http.module_provisioned')
+            self.m1 = self.p1.start()
+            self.m1.return_value = True
+        except Exception:
+            self.p1 = patch('ansible.modules.network.f5.bigip_gtm_monitor_http.module_provisioned')
+            self.m1 = self.p1.start()
+            self.m1.return_value = True
+
+    def tearDown(self):
+        self.p1.stop()
+
    def test_create_monitor(self, *args):
        set_module_args(dict(
            name='foo',
@ -141,6 +155,7 @@ class TestManager(unittest.TestCase):
        mm = ModuleManager(module=module)
        mm.exists = Mock(side_effect=[False, True])
        mm.create_on_device = Mock(return_value=True)
+        mm.module_provisioned = Mock(return_value=True)

        results = mm.exec_module()