From a90bf9fb3273ca6e053e7a2912d60c6e2e424d69 Mon Sep 17 00:00:00 2001 From: Tim Rupp Date: Fri, 2 Nov 2018 22:17:13 -0700 Subject: [PATCH] Removes f5-sdk from bigip_software_update (#48024) --- .../network/f5/bigip_software_update.py | 97 +++++++++++-------- .../network/f5/test_bigip_software_update.py | 21 ++-- 2 files changed, 70 insertions(+), 48 deletions(-) diff --git a/lib/ansible/modules/network/f5/bigip_software_update.py b/lib/ansible/modules/network/f5/bigip_software_update.py index d9d224333cd..79825605054 100644 --- a/lib/ansible/modules/network/f5/bigip_software_update.py +++ b/lib/ansible/modules/network/f5/bigip_software_update.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- # -# Copyright (c) 2017 F5 Networks Inc. +# Copyright: (c) 2017, 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 @@ -40,24 +40,27 @@ options: extends_documentation_fragment: f5 author: - Tim Rupp (@caphrim007) + - Wojciech Wypior (@wojtek0806) ''' EXAMPLES = r''' - name: Enable automatic update checking bigip_software_update: auto_check: yes - password: secret - server: lb.mydomain.com - user: admin + provider: + password: secret + server: lb.mydomain.com + user: admin delegate_to: localhost - name: Disable automatic update checking and phoning home bigip_software_update: auto_check: no auto_phone_home: no - password: secret - server: lb.mydomain.com - user: admin + provider: + password: secret + server: lb.mydomain.com + user: admin delegate_to: localhost ''' @@ -82,29 +85,21 @@ frequency: 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 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 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 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 class Parameters(AnsibleF5Parameters): @@ -114,15 +109,15 @@ class Parameters(AnsibleF5Parameters): } api_attributes = [ - 'autoCheck', 'autoPhonehome', 'frequency' + 'autoCheck', 'autoPhonehome', 'frequency', ] updatables = [ - 'auto_check', 'auto_phone_home', 'frequency' + 'auto_check', 'auto_phone_home', 'frequency', ] returnables = [ - 'auto_check', 'auto_phone_home', 'frequency' + 'auto_check', 'auto_phone_home', 'frequency', ] @@ -216,13 +211,10 @@ class ModuleManager(object): self.want = ModuleParameters(params=self.module.params) self.changes = UsableChanges() - def exec_module(self): + def exec_module(self): # lgtm [py/similar-function] result = dict() - try: - changed = self.update() - except iControlUnexpectedHTTPError as e: - raise F5ModuleError(str(e)) + changed = self.update() reportable = ReportableChanges(params=self.changes.to_return()) changes = reportable.to_return() @@ -272,15 +264,41 @@ class ModuleManager(object): self.update_on_device() return True + def read_current_from_device(self): + uri = "https://{0}:{1}/mgmt/tm/sys/software/update/".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) + def update_on_device(self): params = self.changes.api_params() - result = self.client.api.tm.sys.software.update.load() - result.modify(**params) + uri = "https://{0}:{1}/mgmt/tm/sys/software/update/".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)) - def read_current_from_device(self): - resource = self.client.api.tm.sys.software.update.load() - result = resource.attrs - return ApiParameters(params=result) + if 'code' in response and response['code'] == 400: + if 'message' in response: + raise F5ModuleError(response['message']) + else: + raise F5ModuleError(resp.content) class ArgumentSpec(object): @@ -309,18 +327,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_software_update.py b/test/units/modules/network/f5/test_bigip_software_update.py index 840c541cc1b..716ccec4347 100644 --- a/test/units/modules/network/f5/test_bigip_software_update.py +++ b/test/units/modules/network/f5/test_bigip_software_update.py @@ -14,9 +14,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: @@ -24,17 +21,25 @@ try: from library.modules.bigip_software_update import ModuleParameters from library.modules.bigip_software_update import ModuleManager from library.modules.bigip_software_update 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_software_update import ApiParameters from ansible.modules.network.f5.bigip_software_update import ModuleParameters from ansible.modules.network.f5.bigip_software_update import ModuleManager from ansible.modules.network.f5.bigip_software_update 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")