From 708c2b4b71aaabf7422b9e975fc1afa8f31d0870 Mon Sep 17 00:00:00 2001 From: Tim Rupp Date: Sun, 11 Nov 2018 11:14:56 -0800 Subject: [PATCH] Removes the f5-sdk from bigip_selfip (#48544) --- .../modules/network/f5/bigip_selfip.py | 285 ++++++++++++------ .../modules/network/f5/test_bigip_selfip.py | 21 +- 2 files changed, 209 insertions(+), 97 deletions(-) diff --git a/lib/ansible/modules/network/f5/bigip_selfip.py b/lib/ansible/modules/network/f5/bigip_selfip.py index 762b356caed..e68de515d11 100644 --- a/lib/ansible/modules/network/f5/bigip_selfip.py +++ b/lib/ansible/modules/network/f5/bigip_selfip.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- # -# Copyright (c) 2016 F5 Networks Inc. +# Copyright: (c) 2016, 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 @@ -37,6 +37,10 @@ options: - If this parameter is not specified, then it will default to the value supplied in the C(address) parameter. required: True + description: + description: + - Description of the traffic selector. + version_added: 2.8 netmask: description: - The netmask for the self IP. When creating a new Self IP, this value @@ -77,6 +81,7 @@ options: extends_documentation_fragment: f5 author: - Tim Rupp (@caphrim007) + - Wojciech Wypior (@wojtek0806) ''' EXAMPLES = r''' @@ -218,66 +223,72 @@ 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.ipaddress import is_valid_ip from library.module_utils.network.f5.ipaddress import ipv6_netmask_to_cidr from library.module_utils.compat.ipaddress import ip_address from library.module_utils.compat.ipaddress import ip_network from library.module_utils.compat.ipaddress import ip_interface - try: - from library.module_utils.network.f5.common import iControlUnexpectedHTTPError - except ImportError: - HAS_F5SDK = False + from library.module_utils.network.f5.compare import cmp_str_with_none 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.ipaddress import is_valid_ip from ansible.module_utils.network.f5.ipaddress import ipv6_netmask_to_cidr from ansible.module_utils.compat.ipaddress import ip_address from ansible.module_utils.compat.ipaddress import ip_network from ansible.module_utils.compat.ipaddress import ip_interface - try: - from ansible.module_utils.network.f5.common import iControlUnexpectedHTTPError - except ImportError: - HAS_F5SDK = False + from ansible.module_utils.network.f5.compare import cmp_str_with_none class Parameters(AnsibleF5Parameters): api_map = { 'trafficGroup': 'traffic_group', - 'allowService': 'allow_service' + 'allowService': 'allow_service', } updatables = [ - 'traffic_group', 'allow_service', 'vlan', 'netmask', 'address' + 'traffic_group', + 'allow_service', + 'vlan', + 'netmask', + 'address', + 'description', ] returnables = [ - 'traffic_group', 'allow_service', 'vlan', 'route_domain', 'netmask', 'address' + 'traffic_group', + 'allow_service', + 'vlan', + 'route_domain', + 'netmask', + 'address', + 'description', ] api_attributes = [ - 'trafficGroup', 'allowService', 'vlan', 'address' + 'trafficGroup', + 'allowService', + 'vlan', + 'address', + 'description', ] - def to_return(self): - result = {} - for returnable in self.returnables: - result[returnable] = getattr(self, returnable) - result = self._filter_params(result) - return result - @property def vlan(self): if self._values['vlan'] is None: @@ -399,6 +410,14 @@ class ModuleParameters(Parameters): result = sorted(list(set(result))) return result + @property + def description(self): + if self._values['description'] is None: + return None + elif self._values['description'] in ['none', '']: + return '' + return self._values['description'] + class ApiParameters(Parameters): @property @@ -433,8 +452,36 @@ class ApiParameters(Parameters): result = ip_interface(self.destination_ip) return str(result.ip) + @property + def description(self): + if self._values['description'] in [None, 'none']: + return None + return self._values['description'] + 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 allow_service(self): + if self._values['allow_service'] is None: + return None + if self._values['allow_service'] == ['all']: + return 'all' + return sorted(self._values['allow_service']) + + +class ReportableChanges(Changes): pass @@ -520,19 +567,9 @@ class Difference(object): if self.want.traffic_group != self.have.traffic_group: return self.want.traffic_group - -class UsableChanges(Changes): @property - def allow_service(self): - if self._values['allow_service'] is None: - return None - if self._values['allow_service'] == ['all']: - return 'all' - return sorted(self._values['allow_service']) - - -class ReportableChanges(Changes): - pass + def description(self): + return cmp_str_with_none(self.want.description, self.have.description) class ModuleManager(object): @@ -569,22 +606,29 @@ class ModuleManager(object): 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 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)) - - changes = self.changes.to_return() + 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 present(self): @@ -600,21 +644,20 @@ class ModuleManager(object): changed = self.remove() return changed + def remove(self): + if self.module.check_mode: + return True + self.remove_from_device() + if self.exists(): + raise F5ModuleError("Failed to delete the Self IP") + return True + def should_update(self): result = self._update_changed_options() if result: return True return False - def read_current_from_device(self): - resource = self.client.api.tm.net.selfips.selfip.load( - name=self.want.name, - partition=self.want.partition - ) - result = resource.attrs - params = ApiParameters(params=result) - return params - def update(self): self.have = self.read_current_from_device() if not self.should_update(): @@ -624,18 +667,6 @@ class ModuleManager(object): self.update_on_device() return True - def update_on_device(self): - params = self.changes.api_params() - resource = self.client.api.tm.net.selfips.selfip.load( - name=self.want.name, - partition=self.want.partition - ) - resource.modify(**params) - - def read_partition_default_route_domain_from_device(self): - resource = self.client.api.tm.auth.partitions.partition.load(name=self.want.partition) - return int(resource.defaultRouteDomain) - def create(self): if self.want.address is None or self.want.netmask is None: raise F5ModuleError( @@ -669,35 +700,107 @@ class ModuleManager(object): else: raise F5ModuleError("Failed to create the Self IP") + def exists(self): + uri = "https://{0}:{1}/mgmt/tm/net/self/{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: + return False + if resp.status == 404 or 'code' in response and response['code'] == 404: + return False + return True + def create_on_device(self): params = self.changes.api_params() - self.client.api.tm.net.selfips.selfip.create( - name=self.want.name, - partition=self.want.partition, - **params + params['name'] = self.want.name + params['partition'] = self.want.partition + uri = "https://{0}:{1}/mgmt/tm/net/self/".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)) - def remove(self): - if self.module.check_mode: - return True - self.remove_from_device() - if self.exists(): - raise F5ModuleError("Failed to delete the Self IP") - return True + if 'code' in response and response['code'] in [400, 403]: + if 'message' in response: + raise F5ModuleError(response['message']) + else: + raise F5ModuleError(resp.content) + + def update_on_device(self): + params = self.changes.api_params() + uri = "https://{0}:{1}/mgmt/tm/net/self/{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 remove_from_device(self): - resource = self.client.api.tm.net.selfips.selfip.load( - name=self.want.name, - partition=self.want.partition + uri = "https://{0}:{1}/mgmt/tm/net/self/{2}".format( + self.client.provider['server'], + self.client.provider['server_port'], + transform_name(self.want.partition, self.want.name) ) - resource.delete() + resp = self.client.api.delete(uri) + if resp.status == 200: + return True - def exists(self): - result = self.client.api.tm.net.selfips.selfip.exists( - name=self.want.name, - partition=self.want.partition + def read_current_from_device(self): + uri = "https://{0}:{1}/mgmt/tm/net/self/{2}".format( + self.client.provider['server'], + self.client.provider['server_port'], + transform_name(self.want.partition, self.want.name) ) - return 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 read_partition_default_route_domain_from_device(self): + uri = "https://{0}:{1}/mgmt/tm/auth/partition/{2}".format( + self.client.provider['server'], + self.client.provider['server_port'], + self.want.partition + ) + 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 int(response['defaultRouteDomain']) class ArgumentSpec(object): @@ -711,6 +814,7 @@ class ArgumentSpec(object): traffic_group=dict(), vlan=dict(), route_domain=dict(type='int'), + description=dict(), state=dict( default='present', choices=['present', 'absent'] @@ -732,18 +836,17 @@ def main(): 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") + + 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_selfip.py b/test/units/modules/network/f5/test_bigip_selfip.py index 6fc5358e797..d7fe073351a 100644 --- a/test/units/modules/network/f5/test_bigip_selfip.py +++ b/test/units/modules/network/f5/test_bigip_selfip.py @@ -15,9 +15,6 @@ 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 +22,29 @@ try: from library.modules.bigip_selfip import ModuleParameters from library.modules.bigip_selfip import ModuleManager from library.modules.bigip_selfip 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_selfip import ApiParameters from ansible.modules.network.f5.bigip_selfip import ModuleParameters from ansible.modules.network.f5.bigip_selfip import ModuleManager from ansible.modules.network.f5.bigip_selfip 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")