From 75661cc5f6656eb6981ae8bd118b1f4eaf8d1ded Mon Sep 17 00:00:00 2001 From: Tim Rupp Date: Sat, 10 Nov 2018 15:08:47 -0800 Subject: [PATCH] Removes the f5-sdk from bigip_gtm_monitor_external (#48498) --- .../network/f5/bigip_gtm_monitor_external.py | 254 +++++++++++------- .../f5/test_bigip_gtm_monitor_external.py | 37 ++- 2 files changed, 179 insertions(+), 112 deletions(-) diff --git a/lib/ansible/modules/network/f5/bigip_gtm_monitor_external.py b/lib/ansible/modules/network/f5/bigip_gtm_monitor_external.py index 8f700430833..ff979a0b816 100644 --- a/lib/ansible/modules/network/f5/bigip_gtm_monitor_external.py +++ b/lib/ansible/modules/network/f5/bigip_gtm_monitor_external.py @@ -84,6 +84,7 @@ options: extends_documentation_fragment: f5 author: - Tim Rupp (@caphrim007) + - Wojciech Wypior (@wojtek0806) ''' EXAMPLES = r''' @@ -155,33 +156,31 @@ from ansible.module_utils.basic import env_fallback from ansible.module_utils.six import iteritems 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.common import compare_dictionary + 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.common import compare_dictionary + 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): @@ -189,33 +188,23 @@ class Parameters(AnsibleF5Parameters): 'defaultsFrom': 'parent', 'apiRawValues': 'variables', 'run': 'external_program', - 'args': 'arguments' + 'args': 'arguments', } api_attributes = [ - 'defaultsFrom', 'interval', 'timeout', 'destination', 'run', 'args' + 'defaultsFrom', 'interval', 'timeout', 'destination', 'run', 'args', ] returnables = [ 'parent', 'ip', 'port', 'interval', 'timeout', 'variables', 'external_program', - 'arguments' + 'arguments', ] updatables = [ 'destination', 'interval', 'timeout', 'variables', 'external_program', - 'arguments' + 'arguments', ] - 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 - @property def destination(self): if self.ip is None and self.port is None: @@ -468,24 +457,37 @@ class ModuleManager(object): return True return False - def should_update(self): - result = self._update_changed_options() - if result: - return True - return False + def _announce_deprecations(self, result): + warnings = result.pop('__warnings', []) + for warning in warnings: + self.client.module.deprecate( + msg=warning['msg'], + version=warning['version'] + ) + + def _set_default_creation_values(self): + if self.want.timeout is None: + self.want.update({'timeout': 120}) + if self.want.interval is None: + self.want.update({'interval': 30}) + if self.want.ip is None: + self.want.update({'ip': '*'}) + if self.want.port is None: + self.want.update({'port': '*'}) 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 - try: - if state == "present": - changed = self.present() - elif state == "absent": - changed = self.absent() - except iControlUnexpectedHTTPError as e: - raise F5ModuleError(str(e)) + if state == "present": + changed = self.present() + elif state == "absent": + changed = self.absent() reportable = ReportableChanges(params=self.changes.to_return()) changes = reportable.to_return() @@ -494,35 +496,31 @@ class ModuleManager(object): 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 absent(self): + if self.exists(): + return self.remove() + return False + def create(self): self._set_changed_options() - if self.want.timeout is None: - self.want.update({'timeout': 120}) - if self.want.interval is None: - self.want.update({'interval': 30}) - if self.want.ip is None: - self.want.update({'ip': '*'}) - if self.want.port is None: - self.want.update({'port': '*'}) + self._set_default_creation_values() if self.module.check_mode: return True self.create_on_device() return True + 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() if not self.should_update(): @@ -532,11 +530,6 @@ class ModuleManager(object): self.update_on_device() return True - def absent(self): - if self.exists(): - return self.remove() - return False - def remove(self): if self.module.check_mode: return True @@ -545,57 +538,117 @@ class ModuleManager(object): raise F5ModuleError("Failed to delete the monitor.") return True - def read_current_from_device(self): - resource = self.client.api.tm.gtm.monitor.externals.external.load( - name=self.want.name, - partition=self.want.partition + def exists(self): + uri = "https://{0}:{1}/mgmt/tm/gtm/monitor/external/{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: + return False + if resp.status == 404 or 'code' in response and response['code'] == 404: + return False + return True - def exists(self): - result = self.client.api.tm.gtm.monitor.externals.external.exists( - name=self.want.name, - partition=self.want.partition + 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/external/".format( + self.client.provider['server'], + self.client.provider['server_port'], ) - return result + 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) + + if self.want.variables: + self.set_variable_on_device(self.want.variables) def update_on_device(self): params = self.changes.api_params() - result = self.client.api.tm.gtm.monitor.externals.external.load( - name=self.want.name, - partition=self.want.partition - ) if params: - result.modify(**params) + uri = "https://{0}:{1}/mgmt/tm/gtm/monitor/external/{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) if self.changes.variables: self.set_variable_on_device(self.changes.variables) - def set_variable_on_device(self, commands): - command = ' '.join(['user-defined {0} \\\"{1}\\\"'.format(k, v) for k, v in iteritems(commands)]) - command = 'tmsh modify gtm monitor external {0} {1}'.format(self.want.name, command) - self.client.api.tm.util.bash.exec_cmd( - 'run', - utilCmdArgs='-c "{0}"'.format(command) + def read_current_from_device(self): + uri = "https://{0}:{1}/mgmt/tm/gtm/monitor/external/{2}".format( + self.client.provider['server'], + self.client.provider['server_port'], + transform_name(self.want.partition, self.want.name) ) + resp = self.client.api.get(uri) + try: + response = resp.json() + except ValueError as ex: + raise F5ModuleError(str(ex)) - def create_on_device(self): - params = self.want.api_params() - self.client.api.tm.gtm.monitor.externals.external.create( - name=self.want.name, - partition=self.want.partition, - **params - ) - if self.want.variables: - self.set_variable_on_device(self.want.variables) + 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 remove_from_device(self): - result = self.client.api.tm.gtm.monitor.externals.external.load( - name=self.want.name, - partition=self.want.partition + uri = "https://{0}:{1}/mgmt/tm/gtm/monitor/external/{2}".format( + self.client.provider['server'], + self.client.provider['server_port'], + transform_name(self.want.partition, self.want.name), ) - if result: - result.delete() + response = self.client.api.delete(uri) + if response.status == 200: + return True + raise F5ModuleError(response.content) + + def set_variable_on_device(self, commands): + command = ' '.join(['user-defined {0} \\\"{1}\\\"'.format(k, v) for k, v in iteritems(commands)]) + command = 'tmsh modify gtm monitor external {0} {1}'.format(self.want.name, command) + uri = "https://{0}:{1}/mgmt/tm/util/bash".format( + self.client.provider['server'], + self.client.provider['server_port'], + ) + args = dict( + command='run', + utilCmdArgs='-c "{0}"'.format(command) + ) + resp = self.client.api.post(uri, json=args) + 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) class ArgumentSpec(object): @@ -630,20 +683,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__': diff --git a/test/units/modules/network/f5/test_bigip_gtm_monitor_external.py b/test/units/modules/network/f5/test_bigip_gtm_monitor_external.py index ac9b0f01201..bae095b7325 100644 --- a/test/units/modules/network/f5/test_bigip_gtm_monitor_external.py +++ b/test/units/modules/network/f5/test_bigip_gtm_monitor_external.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_external import ModuleParameters from library.modules.bigip_gtm_monitor_external import ModuleManager from library.modules.bigip_gtm_monitor_external 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_external import ApiParameters from ansible.modules.network.f5.bigip_gtm_monitor_external import ModuleParameters from ansible.modules.network.f5.bigip_gtm_monitor_external import ModuleManager from ansible.modules.network.f5.bigip_gtm_monitor_external 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") @@ -85,13 +89,23 @@ class TestParameters(unittest.TestCase): assert p.timeout == 30 -@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_external.module_provisioned') + self.m1 = self.p1.start() + self.m1.return_value = True + except Exception: + self.p1 = patch('ansible.modules.network.f5.bigip_gtm_monitor_external.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', @@ -115,6 +129,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()