diff --git a/lib/ansible/modules/network/f5/bigip_snat_pool.py b/lib/ansible/modules/network/f5/bigip_snat_pool.py index 934093ed83..9a0a66171d 100644 --- a/lib/ansible/modules/network/f5/bigip_snat_pool.py +++ b/lib/ansible/modules/network/f5/bigip_snat_pool.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 @@ -44,6 +44,7 @@ options: extends_documentation_fragment: f5 author: - Tim Rupp (@caphrim007) + - Wojciech Wypior (@wojtek0806) ''' EXAMPLES = r''' @@ -94,29 +95,27 @@ 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 - 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.ipaddress import is_valid_ip - try: - from ansible.module_utils.network.f5.common import iControlUnexpectedHTTPError - except ImportError: - HAS_F5SDK = False class Parameters(AnsibleF5Parameters): @@ -134,34 +133,12 @@ class Parameters(AnsibleF5Parameters): 'members' ] - def to_return(self): - result = {} - for returnable in self.returnables: - result[returnable] = getattr(self, returnable) - result = self._filter_params(result) - return result - def api_params(self): - result = {} - for api_attribute in self.api_attributes: - if self.api_map is not None and api_attribute in self.api_map: - result[api_attribute] = getattr(self, self.api_map[api_attribute]) - else: - result[api_attribute] = getattr(self, api_attribute) - result = self._filter_params(result) - return result +class ApiParameters(Parameters): + pass - @property - def members(self): - if self._values['members'] is None: - return None - result = set() - for member in self._values['members']: - member = self._clear_member_prefix(member) - address = self._format_member_address(member) - result.update([address]) - return list(result) +class ModuleParameters(Parameters): def _clear_member_prefix(self, member): result = os.path.basename(member) return result @@ -175,8 +152,35 @@ class Parameters(AnsibleF5Parameters): 'The provided member address is not a valid IP address' ) + @property + def members(self): + if self._values['members'] is None: + return None + result = set() + for member in self._values['members']: + member = self._clear_member_prefix(member) + address = self._format_member_address(member) + result.update([address]) + return list(result) + class Changes(Parameters): + def to_return(self): + result = {} + for returnable in self.returnables: + try: + result[returnable] = getattr(self, returnable) + except Exception: + pass + result = self._filter_params(result) + return result + + +class UsableChanges(Changes): + pass + + +class ReportableChanges(Changes): pass @@ -192,15 +196,6 @@ class Difference(object): except AttributeError: return self.__default(param) - @property - def members(self): - if self.want.members is None: - return None - if set(self.want.members) == set(self.have.members): - return None - result = list(set(self.want.members)) - return result - def __default(self, param): attr1 = getattr(self.want, param) try: @@ -210,14 +205,31 @@ class Difference(object): except AttributeError: return attr1 + @property + def members(self): + if self.want.members is None: + return None + if set(self.want.members) == set(self.have.members): + return None + result = list(set(self.want.members)) + return result + class ModuleManager(object): def __init__(self, *args, **kwargs): self.module = kwargs.get('module', None) self.client = kwargs.get('client', None) - self.have = None - self.want = Parameters(params=self.module.params) - self.changes = Changes() + self.want = ModuleParameters(params=self.module.params) + self.have = ApiParameters() + self.changes = UsableChanges() + + def _announce_deprecations(self, result): + warnings = result.pop('__warnings', []) + for warning in warnings: + self.module.deprecate( + msg=warning['msg'], + version=warning['version'] + ) def _set_changed_options(self): changed = {} @@ -225,7 +237,7 @@ class ModuleManager(object): if getattr(self.want, key) is not None: changed[key] = getattr(self.want, key) if changed: - self.changes = Changes(params=changed) + self.changes = UsableChanges(params=changed) def _update_changed_options(self): diff = Difference(self.want, self.have) @@ -236,9 +248,12 @@ class ModuleManager(object): if change is None: continue else: - changed[k] = change + if isinstance(change, dict): + changed.update(change) + else: + changed[k] = change if changed: - self.changes = Changes(params=changed) + self.changes = UsableChanges(params=changed) return True return False @@ -247,32 +262,18 @@ class ModuleManager(object): 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() - changes = self.changes.to_return() + reportable = ReportableChanges(params=self.changes.to_return()) + changes = reportable.to_return() result.update(**changes) result.update(dict(changed=changed)) - self._announce_deprecations() + self._announce_deprecations(result) return result - def _announce_deprecations(self): - warnings = [] - if self.want: - warnings += self.want._values.get('__warnings', []) - if self.have: - warnings += self.have._values.get('__warnings', []) - for warning in warnings: - self.module.deprecate( - msg=warning['msg'], - version=warning['version'] - ) - def present(self): if self.exists(): return self.update() @@ -285,21 +286,6 @@ class ModuleManager(object): changed = self.remove() return changed - def read_current_from_device(self): - resource = self.client.api.tm.ltm.snatpools.snatpool.load( - name=self.want.name, - partition=self.want.partition - ) - result = resource.attrs - return Parameters(params=result) - - def exists(self): - result = self.client.api.tm.ltm.snatpools.snatpool.exists( - name=self.want.name, - partition=self.want.partition - ) - return result - def should_update(self): result = self._update_changed_options() if result: @@ -315,15 +301,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.ltm.snatpools.snatpool.load( - name=self.want.name, - partition=self.want.partition - ) - resource.modify(**params) - def create(self): self._set_changed_options() if self.module.check_mode: @@ -333,14 +310,6 @@ class ModuleManager(object): raise F5ModuleError("Failed to create the SNAT pool") return True - def create_on_device(self): - params = self.want.api_params() - self.client.api.tm.ltm.snatpools.snatpool.create( - name=self.want.name, - partition=self.want.partition, - **params - ) - def remove(self): if self.module.check_mode: return True @@ -349,12 +318,91 @@ class ModuleManager(object): raise F5ModuleError("Failed to delete the SNAT pool") return True - def remove_from_device(self): - resource = self.client.api.tm.ltm.snatpools.snatpool.load( - name=self.want.name, - partition=self.want.partition + def exists(self): + uri = "https://{0}:{1}/mgmt/tm/ltm/snatpool/{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.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() + params['name'] = self.want.name + params['partition'] = self.want.partition + uri = "https://{0}:{1}/mgmt/tm/ltm/snatpool/".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 update_on_device(self): + params = self.changes.api_params() + uri = "https://{0}:{1}/mgmt/tm/ltm/snatpool/{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): + uri = "https://{0}:{1}/mgmt/tm/ltm/snatpool/{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) + + def read_current_from_device(self): + uri = "https://{0}:{1}/mgmt/tm/ltm/snatpool/{2}".format( + self.client.provider['server'], + self.client.provider['server_port'], + transform_name(self.want.partition, self.want.name) + ) + query = '?expandSubcollections=true' + resp = self.client.api.get(uri + query) + 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) class ArgumentSpec(object): @@ -391,18 +439,17 @@ def main(): supports_check_mode=spec.supports_check_mode, required_if=spec.required_if ) - 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_snat_pool.py b/test/units/modules/network/f5/test_bigip_snat_pool.py index f40e5a0247..4e64673f12 100644 --- a/test/units/modules/network/f5/test_bigip_snat_pool.py +++ b/test/units/modules/network/f5/test_bigip_snat_pool.py @@ -14,25 +14,32 @@ 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: - from library.modules.bigip_snat_pool import Parameters + from library.modules.bigip_snat_pool import ModuleParameters + from library.modules.bigip_snat_pool import ApiParameters from library.modules.bigip_snat_pool import ModuleManager from library.modules.bigip_snat_pool 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_snat_pool import Parameters + from ansible.modules.network.f5.bigip_snat_pool import ModuleParameters + from ansible.modules.network.f5.bigip_snat_pool import ApiParameters from ansible.modules.network.f5.bigip_snat_pool import ModuleManager from ansible.modules.network.f5.bigip_snat_pool 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") @@ -67,7 +74,7 @@ class TestParameters(unittest.TestCase): members=['10.10.10.10', '20.20.20.20'], partition='Common' ) - p = Parameters(params=args) + p = ModuleParameters(params=args) assert p.name == 'my-snat-pool' assert p.state == 'present' assert len(p.members) == 2 @@ -78,10 +85,10 @@ class TestParameters(unittest.TestCase): args = dict( members=['/Common/10.10.10.10', '/foo/20.20.20.20'] ) - p = Parameters(params=args) + p = ApiParameters(params=args) assert len(p.members) == 2 assert '/Common/10.10.10.10' in p.members - assert '/Common/20.20.20.20' in p.members + assert '/foo/20.20.20.20' in p.members class TestManager(unittest.TestCase): @@ -126,7 +133,7 @@ class TestManager(unittest.TestCase): user='admin' )) - current = Parameters(params=load_fixture('load_ltm_snatpool.json')) + current = ApiParameters(params=load_fixture('load_ltm_snatpool.json')) module = AnsibleModule( argument_spec=self.spec.argument_spec, @@ -152,7 +159,7 @@ class TestManager(unittest.TestCase): user='admin' )) - current = Parameters(params=load_fixture('load_ltm_snatpool.json')) + current = ApiParameters(params=load_fixture('load_ltm_snatpool.json')) module = AnsibleModule( argument_spec=self.spec.argument_spec,