cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Removes the f5-sdk from bigip_snmp_trap (#48027)

Browse source
This commit is contained in:
Tim Rupp 2018-11-02 22:20:39 -07:00 committed by GitHub
parent b45b2b3cc4
commit 5afe77933b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 195 additions and 94 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

265
lib/ansible/modules/network/f5/bigip_snmp_trap.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
@ -13,6 +13,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
'supported_by': 'certified'} 'supported_by': 'certified'}
DOCUMENTATION = r''' DOCUMENTATION = r'''
---
module: bigip_snmp_trap module: bigip_snmp_trap
short_description: Manipulate SNMP trap information on a BIG-IP short_description: Manipulate SNMP trap information on a BIG-IP
description: description:
@ -72,6 +73,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'''
@ -135,34 +137,32 @@ from ansible.module_utils.basic import env_fallback
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 transform_name
from library.module_utils.network.f5.common import iControlUnexpectedHTTPError from library.module_utils.network.f5.common import exit_json
except ImportError: from library.module_utils.network.f5.common import fail_json
HAS_F5SDK = False 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 transform_name
from ansible.module_utils.network.f5.common import iControlUnexpectedHTTPError from ansible.module_utils.network.f5.common import exit_json
except ImportError: from ansible.module_utils.network.f5.common import fail_json
HAS_F5SDK = False from ansible.module_utils.network.f5.icontrol import tmos_version
class Parameters(AnsibleF5Parameters): class Parameters(AnsibleF5Parameters):
api_map = { api_map = {
'version': 'snmp_version', 'version': 'snmp_version',
'community': 'community', 'community': 'community',
'host': 'destination' 'host': 'destination',
} }
@property @property
@ -187,15 +187,27 @@ class Parameters(AnsibleF5Parameters):
class V3Parameters(Parameters): class V3Parameters(Parameters):
updatables = [ updatables = [
'snmp_version', 'community', 'destination', 'port', 'network' 'snmp_version',
'community',
'destination',
'port',
'network',
] ]
returnables = [ returnables = [
'snmp_version', 'community', 'destination', 'port', 'network' 'snmp_version',
'community',
'destination',
'port',
'network',
] ]
api_attributes = [ api_attributes = [
'version', 'community', 'host', 'port', 'network' 'version',
'community',
'host',
'port',
'network',
] ]
@property @property
@ -216,15 +228,27 @@ class V3Parameters(Parameters):
class V2Parameters(Parameters): class V2Parameters(Parameters):
updatables = [ updatables = [
'snmp_version', 'community', 'destination', 'port', 'network' 'snmp_version',
'community',
'destination',
'port',
'network',
] ]
returnables = [ returnables = [
'snmp_version', 'community', 'destination', 'port', 'network' 'snmp_version',
'community',
'destination',
'port',
'network',
] ]
api_attributes = [ api_attributes = [
'version', 'community', 'host', 'port', 'network' 'version',
'community',
'host',
'port',
'network',
] ]
@property @property
@ -242,15 +266,24 @@ class V2Parameters(Parameters):
class V1Parameters(Parameters): class V1Parameters(Parameters):
updatables = [ updatables = [
'snmp_version', 'community', 'destination', 'port' 'snmp_version',
'community',
'destination',
'port',
] ]
returnables = [ returnables = [
'snmp_version', 'community', 'destination', 'port' 'snmp_version',
'community',
'destination',
'port',
] ]
api_attributes = [ api_attributes = [
'version', 'community', 'host', 'port' 'version',
'community',
'host',
'port',
] ]
@property @property
@ -280,7 +313,7 @@ class ModuleManager(object):
Returns: Returns:
bool: True when it is missing. False otherwise. bool: True when it is missing. False otherwise.
""" """
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:
@ -292,7 +325,7 @@ class ModuleManager(object):
Returns: Returns:
bool: True when it is missing. False otherwise. bool: True when it is missing. False otherwise.
""" """
version = self.client.api.tmos_version version = tmos_version(self.client)
if LooseVersion(version) < LooseVersion('13.1.0'): if LooseVersion(version) < LooseVersion('13.1.0'):
return True return True
else: else:
@ -310,32 +343,35 @@ class BaseManager(object):
result = dict() result = dict()
state = self.want.state state = self.want.state
try: if state == "present":
if state == "present": changed = self.present()
changed = self.present() elif state == "absent":
elif state == "absent": changed = self.absent()
changed = self.absent()
except iControlUnexpectedHTTPError as e:
raise F5ModuleError(str(e))
changes = self.changes.to_return() changes = self.changes.to_return()
result.update(**changes) result.update(**changes)
result.update(dict(changed=changed)) result.update(dict(changed=changed))
return result return result
def exists(self):
result = self.client.api.tm.sys.snmp.traps_s.trap.exists(
name=self.want.name,
partition=self.want.partition
)
return result
def present(self): def present(self):
if self.exists(): if self.exists():
return self.update() return self.update()
else: else:
return self.create() return self.create()
def absent(self):
if self.exists():
return self.remove()
return False
def remove(self):
if self.module.check_mode:
return True
self.remove_from_device()
if self.exists():
raise F5ModuleError("Failed to delete the snmp trap")
return True
def create(self): def create(self):
self._set_changed_options() self._set_changed_options()
if self.module.check_mode: if self.module.check_mode:
@ -363,42 +399,69 @@ class BaseManager(object):
self.update_on_device() self.update_on_device()
return True return True
def exists(self):
uri = "https://{0}:{1}/mgmt/tm/sys/snmp/traps/{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 update_on_device(self): def update_on_device(self):
params = self.want.api_params() params = self.want.api_params()
result = self.client.api.tm.sys.snmp.traps_s.trap.load( uri = "https://{0}:{1}/mgmt/tm/sys/snmp/traps/{2}".format(
name=self.want.name, self.client.provider['server'],
partition=self.want.partition self.client.provider['server_port'],
transform_name(self.want.partition, self.want.name)
) )
result.modify(**params) 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 create_on_device(self): def create_on_device(self):
params = self.want.api_params() params = self.want.api_params()
self.client.api.tm.sys.snmp.traps_s.trap.create( params['name'] = self.want.name
name=self.want.name, params['partition'] = self.want.partition
partition=self.want.partition, uri = "https://{0}:{1}/mgmt/tm/sys/snmp/traps/".format(
**params 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 absent(self): if 'code' in response and response['code'] in [400, 403]:
if self.exists(): if 'message' in response:
return self.remove() raise F5ModuleError(response['message'])
return False else:
raise F5ModuleError(resp.content)
def remove(self):
if self.module.check_mode:
return True
self.remove_from_device()
if self.exists():
raise F5ModuleError("Failed to delete the snmp trap")
return True
def remove_from_device(self): def remove_from_device(self):
result = self.client.api.tm.sys.snmp.traps_s.trap.load( uri = "https://{0}:{1}/mgmt/tm/sys/snmp/traps/{2}".format(
name=self.want.name, self.client.provider['server'],
partition=self.want.partition self.client.provider['server_port'],
transform_name(self.want.partition, self.want.name)
) )
if result: resp = self.client.api.delete(uri)
result.delete() if resp.status == 200:
return True
class V3Manager(BaseManager): class V3Manager(BaseManager):
@ -432,12 +495,23 @@ class V3Manager(BaseManager):
return False return False
def read_current_from_device(self): def read_current_from_device(self):
resource = self.client.api.tm.sys.snmp.traps_s.trap.load( uri = "https://{0}:{1}/mgmt/tm/sys/snmp/traps/{2}".format(
name=self.want.name, self.client.provider['server'],
partition=self.want.partition self.client.provider['server_port'],
transform_name(self.want.partition, self.want.name)
) )
result = resource.attrs resp = self.client.api.get(uri)
return V3Parameters(params=result) 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 V3Parameters(params=response)
class V2Manager(BaseManager): class V2Manager(BaseManager):
@ -471,13 +545,24 @@ class V2Manager(BaseManager):
return False return False
def read_current_from_device(self): def read_current_from_device(self):
resource = self.client.api.tm.sys.snmp.traps_s.trap.load( uri = "https://{0}:{1}/mgmt/tm/sys/snmp/traps/{2}".format(
name=self.want.name, self.client.provider['server'],
partition=self.want.partition self.client.provider['server_port'],
transform_name(self.want.partition, self.want.name)
) )
result = resource.attrs resp = self.client.api.get(uri)
self._ensure_network(result) try:
return V2Parameters(params=result) 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)
self._ensure_network(response)
return V2Parameters(params=response)
def _ensure_network(self, result): def _ensure_network(self, result):
# BIG-IP's value for "default" is that the key does not # BIG-IP's value for "default" is that the key does not
@ -521,12 +606,23 @@ class V1Manager(BaseManager):
return False return False
def read_current_from_device(self): def read_current_from_device(self):
resource = self.client.api.tm.sys.snmp.traps_s.trap.load( uri = "https://{0}:{1}/mgmt/tm/sys/snmp/traps/{2}".format(
name=self.want.name, self.client.provider['server'],
partition=self.want.partition self.client.provider['server_port'],
transform_name(self.want.partition, self.want.name)
) )
result = resource.attrs resp = self.client.api.get(uri)
return V1Parameters(params=result) 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 V1Parameters(params=response)
class ArgumentSpec(object): class ArgumentSpec(object):
@ -566,18 +662,17 @@ def main():
argument_spec=spec.argument_spec, 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: 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__':

24
test/units/modules/network/f5/test_bigip_snmp_trap.py
View file

@ -14,10 +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 units.compat.mock import DEFAULT
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule
try: try:
@ -27,9 +23,14 @@ try:
from library.modules.bigip_snmp_trap import V2Manager from library.modules.bigip_snmp_trap import V2Manager
from library.modules.bigip_snmp_trap import V1Manager from library.modules.bigip_snmp_trap import V1Manager
from library.modules.bigip_snmp_trap import ArgumentSpec from library.modules.bigip_snmp_trap 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.compat.mock import DEFAULT
from test.units.modules.utils import set_module_args
except ImportError: except ImportError:
try: try:
from ansible.modules.network.f5.bigip_snmp_trap import V2Parameters from ansible.modules.network.f5.bigip_snmp_trap import V2Parameters
@ -38,8 +39,13 @@ except ImportError:
from ansible.modules.network.f5.bigip_snmp_trap import V2Manager from ansible.modules.network.f5.bigip_snmp_trap import V2Manager
from ansible.modules.network.f5.bigip_snmp_trap import V1Manager from ansible.modules.network.f5.bigip_snmp_trap import V1Manager
from ansible.modules.network.f5.bigip_snmp_trap import ArgumentSpec from ansible.modules.network.f5.bigip_snmp_trap 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.compat.mock import DEFAULT
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")