From 7ce3d7c8ef6f9f4777008f5746fdfb824eb66631 Mon Sep 17 00:00:00 2001 From: Tim Rupp Date: Sat, 10 Nov 2018 14:53:54 -0800 Subject: [PATCH] Removes the f5-sdk from bigip_gtm_global (#48496) --- .../modules/network/f5/bigip_gtm_global.py | 121 +++++++++++------- .../network/f5/test_bigip_gtm_global.py | 24 ++-- 2 files changed, 86 insertions(+), 59 deletions(-) diff --git a/lib/ansible/modules/network/f5/bigip_gtm_global.py b/lib/ansible/modules/network/f5/bigip_gtm_global.py index 29cc47ea20..4038618955 100644 --- a/lib/ansible/modules/network/f5/bigip_gtm_global.py +++ b/lib/ansible/modules/network/f5/bigip_gtm_global.py @@ -41,6 +41,7 @@ options: extends_documentation_fragment: f5 author: - Tim Rupp (@caphrim007) + - Wojciech Wypior (@wojtek0806) ''' EXAMPLES = r''' @@ -77,45 +78,43 @@ synchronize_zone_files: from ansible.module_utils.basic import AnsibleModule 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 - try: - from library.module_utils.network.f5.common import iControlUnexpectedHTTPError - except ImportError: - HAS_F5SDK = False + 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 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 - try: - from ansible.module_utils.network.f5.common import iControlUnexpectedHTTPError - except ImportError: - HAS_F5SDK = False + 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 class Parameters(AnsibleF5Parameters): api_map = { 'synchronizationGroupName': 'synchronization_group_name', - 'synchronizeZoneFiles': 'synchronize_zone_files' + 'synchronizeZoneFiles': 'synchronize_zone_files', } api_attributes = [ - 'synchronizeZoneFiles', 'synchronizationGroupName', 'synchronization' + 'synchronizeZoneFiles', 'synchronizationGroupName', 'synchronization', ] returnables = [ - 'synchronization', 'synchronization_group_name', 'synchronize_zone_files' + 'synchronization', 'synchronization_group_name', 'synchronize_zone_files', ] updatables = [ - 'synchronization', 'synchronization_group_name', 'synchronize_zone_files' + 'synchronization', 'synchronization_group_name', 'synchronize_zone_files', ] @@ -242,27 +241,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): # lgtm [py/similar-function] - result = dict() - - try: - changed = self.present() - 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: @@ -271,6 +249,22 @@ class ModuleManager(object): version=warning['version'] ) + def exec_module(self): # lgtm [py/similar-function] + if not module_provisioned(self.client, 'gtm'): + raise F5ModuleError( + "GTM must be provisioned to use this module." + ) + result = dict() + + changed = self.present() + + 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): return self.update() @@ -283,15 +277,47 @@ class ModuleManager(object): self.update_on_device() return True + def should_update(self): + result = self._update_changed_options() + if result: + return True + return False + def update_on_device(self): params = self.changes.api_params() - resource = self.client.api.tm.gtm.global_settings.general.load() - resource.modify(**params) + uri = "https://{0}:{1}/mgmt/tm/gtm/global-settings/general/".format( + self.client.provider['server'], + self.client.provider['server_port'], + ) + 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 read_current_from_device(self): - resource = self.client.api.tm.gtm.global_settings.general.load() - result = resource.attrs - return ApiParameters(params=result) + uri = "https://{0}:{1}/mgmt/tm/gtm/global-settings/general/".format( + self.client.provider['server'], + self.client.provider['server_port'], + ) + 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) class ArgumentSpec(object): @@ -312,20 +338,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_global.py b/test/units/modules/network/f5/test_bigip_gtm_global.py index b24833f650..5fb8658b04 100644 --- a/test/units/modules/network/f5/test_bigip_gtm_global.py +++ b/test/units/modules/network/f5/test_bigip_gtm_global.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_global import ModuleParameters from library.modules.bigip_gtm_global import ModuleManager from library.modules.bigip_gtm_global 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_global import ApiParameters from ansible.modules.network.f5.bigip_gtm_global import ModuleParameters from ansible.modules.network.f5.bigip_gtm_global import ModuleManager from ansible.modules.network.f5.bigip_gtm_global 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") @@ -84,8 +88,6 @@ class TestParameters(unittest.TestCase): assert p.synchronize_zone_files is False -@patch('ansible.module_utils.f5_utils.AnsibleF5Client._get_mgmt_root', - return_value=True) class TestManager(unittest.TestCase): def setUp(self):