ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-08-03 12:44:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

Removes f5-sdk from bigip_uce_fetch module (#48002)

Browse source 
This is part of the ongoing effort to fully remove the f5-sdk from
the f5 ansible modules
This commit is contained in:
Tim Rupp 2018-11-02 11:54:40 -07:00 • committed by GitHub
commit f6309d19a3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 157 additions and 65 deletions
Download patch file Download diff file Expand all files Collapse all files

201
lib/ansible/modules/network/f5/bigip_ucs_fetch.py
View file

@ -1,7 +1,7 @@
#!/usr/bin/python #!/usr/bin/python
# -*- coding: utf-8 -*- # -*- 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) # 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 from __future__ import absolute_import, division, print_function
@ -65,6 +65,7 @@ notes:
extends_documentation_fragment: f5 extends_documentation_fragment: f5
author: author:
- Tim Rupp (@caphrim007) - Tim Rupp (@caphrim007)
- Wojciech Wypior (@wojtek0806)
''' '''
EXAMPLES = r''' EXAMPLES = r'''
@ -146,32 +147,37 @@ from ansible.module_utils.basic import AnsibleModule
from distutils.version import LooseVersion from distutils.version import LooseVersion
try: try:
from library.module_utils.network.f5.bigip import HAS_F5SDK from library.module_utils.network.f5.bigip import F5RestClient
from library.module_utils.network.f5.bigip import F5Client
from library.module_utils.network.f5.common import F5ModuleError 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 AnsibleF5Parameters
from library.module_utils.network.f5.common import cleanup_tokens from library.module_utils.network.f5.common import cleanup_tokens
from library.module_utils.network.f5.common import f5_argument_spec from library.module_utils.network.f5.common import f5_argument_spec
try: from library.module_utils.network.f5.common import exit_json
from library.module_utils.network.f5.common import iControlUnexpectedHTTPError from library.module_utils.network.f5.common import fail_json
except ImportError: from library.module_utils.network.f5.common import transform_name
HAS_F5SDK = False from library.module_utils.network.f5.icontrol import download_file
from library.module_utils.network.f5.icontrol import tmos_version
except ImportError: except ImportError:
from ansible.module_utils.network.f5.bigip import HAS_F5SDK from ansible.module_utils.network.f5.bigip import F5RestClient
from ansible.module_utils.network.f5.bigip import F5Client
from ansible.module_utils.network.f5.common import F5ModuleError 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 AnsibleF5Parameters
from ansible.module_utils.network.f5.common import cleanup_tokens from ansible.module_utils.network.f5.common import cleanup_tokens
from ansible.module_utils.network.f5.common import f5_argument_spec from ansible.module_utils.network.f5.common import f5_argument_spec
try: from ansible.module_utils.network.f5.common import exit_json
from ansible.module_utils.network.f5.common import iControlUnexpectedHTTPError from ansible.module_utils.network.f5.common import fail_json
except ImportError: from ansible.module_utils.network.f5.common import transform_name
HAS_F5SDK = False from ansible.module_utils.network.f5.icontrol import download_file
from ansible.module_utils.network.f5.icontrol import tmos_version
class Parameters(AnsibleF5Parameters): class Parameters(AnsibleF5Parameters):
updatables = [] updatables = []
returnables = ['dest', 'src', 'md5sum', 'checksum', 'backup_file'] returnables = [
'dest',
'src',
'md5sum',
'checksum',
'backup_file']
api_attributes = [] api_attributes = []
api_map = {} api_map = {}
@ -271,7 +277,7 @@ class ModuleManager(object):
:return: bool :return: bool
""" """
version = self.client.api.tmos_version version = tmos_version(self.client)
if LooseVersion(version) < LooseVersion('12.1.0'): if LooseVersion(version) < LooseVersion('12.1.0'):
return True return True
else: else:
@ -288,10 +294,7 @@ class BaseManager(object):
def exec_module(self): def exec_module(self):
result = dict() result = dict()
try: self.present()
self.present()
except iControlUnexpectedHTTPError as e:
raise F5ModuleError(str(e))
reportable = ReportableChanges(params=self.changes.to_return()) reportable = ReportableChanges(params=self.changes.to_return())
changes = reportable.to_return() changes = reportable.to_return()
@ -366,19 +369,34 @@ class BaseManager(object):
def create_on_device(self): def create_on_device(self):
if self.want.passphrase: if self.want.passphrase:
self.client.api.tm.sys.ucs.exec_cmd( params = dict(
'save', command='save',
name=self.want.src, name=self.want.src,
options=[{'passphrase': self.want.encryption_password}] options=[{'passphrase': self.want.encryption_password}]
) )
else: else:
self.client.api.tm.sys.ucs.exec_cmd( params = dict(
'save', command='save',
name=self.want.src name=self.want.src,
) )
uri = "https://{0}:{1}/mgmt/tm/sys/ucs".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)
def download(self): def download(self):
self.download_from_device() self.download_from_device(self.want.dest)
if os.path.exists(self.want.dest): if os.path.exists(self.want.dest):
return True return True
raise F5ModuleError( raise F5ModuleError(
@ -394,16 +412,33 @@ class V1Manager(BaseManager):
def read_current(self): def read_current(self):
result = None result = None
output = self.read_current_from_device() output = self.read_current_from_device()
if hasattr(output, 'commandResult'): if 'commandResult' in output:
result = self._read_ucs_files_from_output(output.commandResult) result = self._read_ucs_files_from_output(output['commandResult'])
return result return result
def read_current_from_device(self): def read_current_from_device(self):
output = self.client.api.tm.util.bash.exec_cmd( params = dict(
'run', command='run',
utilCmdArgs='-c "tmsh list sys ucs"' utilCmdArgs='-c "tmsh list sys ucs"'
) )
return output
uri = "https://{0}:{1}/mgmt/tm/util/bash".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
def _read_ucs_files_from_output(self, output): def _read_ucs_files_from_output(self, output):
search = re.compile(r'filename\s+(.*)').search search = re.compile(r'filename\s+(.*)').search
@ -418,40 +453,84 @@ class V1Manager(BaseManager):
return True return True
return False return False
def download_from_device(self): def download_from_device(self, dest):
madm = self.client.api.shared.file_transfer.madm url = 'https://{0}:{1}/mgmt/shared/file-transfer/madm/{2}'.format(
madm.download_file(self.want.filename, self.want.dest) self.client.provider['server'],
self.client.provider['server_port'],
self.want.filename
)
try:
download_file(self.client, url, dest)
except F5ModuleError:
raise F5ModuleError(
"Failed to download the file."
)
if os.path.exists(self.want.dest): if os.path.exists(self.want.dest):
return True return True
return False return False
def _move_to_download(self): def _move_to_download(self):
move_path = '/var/local/ucs/{0} {1}/{0}'.format(
self.want.filename, self.remote_dir
)
params = dict(
command='run',
utilCmdArgs=move_path
)
uri = "https://{0}:{1}/mgmt/tm/util/unix-mv/".format(
self.client.provider['server'],
self.client.provider['server_port']
)
resp = self.client.api.post(uri, json=params)
try: try:
move_path = '/var/local/ucs/{0} {1}/{0}'.format( response = resp.json()
self.want.filename, self.remote_dir if 'commandResult' in response:
) if 'cannot stat' in response['commandResult']:
self.client.api.tm.util.unix_mv.exec_cmd( raise F5ModuleError(response['commandResult'])
'run', except ValueError as ex:
utilCmdArgs=move_path raise F5ModuleError(str(ex))
)
return True if 'code' in response and response['code'] in [400, 403]:
except Exception: if 'message' in response:
return False raise F5ModuleError(response['message'])
else:
raise F5ModuleError(resp.content)
return True
class V2Manager(BaseManager): class V2Manager(BaseManager):
def read_current_from_device(self):
uri = "https://{0}:{1}/mgmt/tm/sys/ucs".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 response
def read_current(self): def read_current(self):
collection = self.read_current_from_device() collection = self.read_current_from_device()
if 'items' not in collection.attrs: if 'items' not in collection:
return [] return []
resources = collection.attrs['items'] resources = collection['items']
result = [x['apiRawValues']['filename'] for x in resources] result = [x['apiRawValues']['filename'] for x in resources]
return result return result
def read_current_from_device(self):
collection = self.client.api.tm.sys.ucs.load()
return collection
def exists(self): def exists(self):
collection = self.read_current() collection = self.read_current()
base = os.path.basename(self.want.src) base = os.path.basename(self.want.src)
@ -459,9 +538,18 @@ class V2Manager(BaseManager):
return True return True
return False return False
def download_from_device(self): def download_from_device(self, dest):
ucs = self.client.api.shared.file_transfer.ucs_downloads url = 'https://{0}:{1}/mgmt/shared/file-transfer/ucs-downloads/{2}'.format(
ucs.download_file(self.want.src, self.want.dest) self.client.provider['server'],
self.client.provider['server_port'],
self.want.src
)
try:
download_file(self.client, url, dest)
except F5ModuleError:
raise F5ModuleError(
"Failed to download the file."
)
if os.path.exists(self.want.dest): if os.path.exists(self.want.dest):
return True return True
return False return False
@ -508,18 +596,17 @@ def main():
supports_check_mode=spec.supports_check_mode, supports_check_mode=spec.supports_check_mode,
add_file_common_args=spec.add_file_common_args add_file_common_args=spec.add_file_common_args
) )
if not HAS_F5SDK:
module.fail_json(msg="The python f5-sdk module is required") client = F5RestClient(**module.params)
try: try:
client = F5Client(**module.params)
mm = ModuleManager(module=module, client=client) mm = ModuleManager(module=module, client=client)
results = mm.exec_module() results = mm.exec_module()
cleanup_tokens(client) cleanup_tokens(client)
module.exit_json(**results) exit_json(module, results, client)
except F5ModuleError as ex: except F5ModuleError as ex:
cleanup_tokens(client) cleanup_tokens(client)
module.fail_json(msg=str(ex)) fail_json(module, ex, client)
if __name__ == '__main__': if __name__ == '__main__':

21
test/units/modules/network/f5/test_bigip_ucs_fetch.py
View file

@ -14,9 +14,6 @@ from nose.plugins.skip import SkipTest
if sys.version_info < (2, 7): if sys.version_info < (2, 7):
raise SkipTest("F5 Ansible modules require Python >= 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 from ansible.module_utils.basic import AnsibleModule
try: try:
@ -25,9 +22,13 @@ try:
from library.modules.bigip_ucs_fetch import V1Manager from library.modules.bigip_ucs_fetch import V1Manager
from library.modules.bigip_ucs_fetch import V2Manager from library.modules.bigip_ucs_fetch import V2Manager
from library.modules.bigip_ucs_fetch import ArgumentSpec from library.modules.bigip_ucs_fetch import ArgumentSpec
from library.module_utils.network.f5.common import F5ModuleError
from library.module_utils.network.f5.common import iControlUnexpectedHTTPError # In Ansible 2.8, Ansible changed import paths.
from test.unit.modules.utils import set_module_args 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: except ImportError:
try: try:
from ansible.modules.network.f5.bigip_ucs_fetch import Parameters from ansible.modules.network.f5.bigip_ucs_fetch import Parameters
@ -35,8 +36,12 @@ except ImportError:
from ansible.modules.network.f5.bigip_ucs_fetch import V1Manager from ansible.modules.network.f5.bigip_ucs_fetch import V1Manager
from ansible.modules.network.f5.bigip_ucs_fetch import V2Manager from ansible.modules.network.f5.bigip_ucs_fetch import V2Manager
from ansible.modules.network.f5.bigip_ucs_fetch import ArgumentSpec from ansible.modules.network.f5.bigip_ucs_fetch 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 from units.modules.utils import set_module_args
except ImportError: except ImportError:
raise SkipTest("F5 Ansible modules require the f5-sdk Python library") raise SkipTest("F5 Ansible modules require the f5-sdk Python library")