ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-22 04:40:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

Remove the f5-sdk from bigip_smtp (#48032)

Browse source
This commit is contained in:
Tim Rupp 2018-11-02 22:42:02 -07:00 • committed by GitHub
commit 1373a25ed3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 129 additions and 74 deletions
Download patch file Download diff file Expand all files Collapse all files

181
lib/ansible/modules/network/f5/bigip_smtp.py
View file

@ -74,7 +74,6 @@ options:
description: description:
- When C(present), ensures that the SMTP configuration exists. - When C(present), ensures that the SMTP configuration exists.
- When C(absent), ensures that the SMTP configuration does not exist. - When C(absent), ensures that the SMTP configuration does not exist.
required: False
default: present default: present
choices: choices:
- present - present
@ -150,31 +149,27 @@ from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.basic import env_fallback from ansible.module_utils.basic import env_fallback
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 is_valid_hostname
from library.module_utils.network.f5.common import f5_argument_spec from library.module_utils.network.f5.common import f5_argument_spec
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.common import transform_name
from library.module_utils.network.f5.common import is_valid_hostname
from library.module_utils.network.f5.ipaddress import is_valid_ip 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: 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 is_valid_hostname
from ansible.module_utils.network.f5.common import f5_argument_spec from ansible.module_utils.network.f5.common import f5_argument_spec
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.common import transform_name
from ansible.module_utils.network.f5.common import is_valid_hostname
from ansible.module_utils.network.f5.ipaddress import is_valid_ip 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): class Parameters(AnsibleF5Parameters):
@ -187,25 +182,41 @@ class Parameters(AnsibleF5Parameters):
'encryptedConnection': 'encryption', 'encryptedConnection': 'encryption',
'authenticationEnabled': 'authentication_enabled', 'authenticationEnabled': 'authentication_enabled',
'authenticationDisabled': 'authentication_disabled', 'authenticationDisabled': 'authentication_disabled',
'fromAddress': 'from_address' 'fromAddress': 'from_address',
} }
api_attributes = [ api_attributes = [
'username', 'passwordEncrypted', 'localHostName', 'smtpServerHostName', 'username',
'smtpServerPort', 'encryptedConnection', 'authenticationEnabled', 'passwordEncrypted',
'authenticationDisabled', 'fromAddress' 'localHostName',
'smtpServerHostName',
'smtpServerPort',
'encryptedConnection',
'authenticationEnabled',
'authenticationDisabled',
'fromAddress',
] ]
returnables = [ returnables = [
'smtp_server_username', 'smtp_server_password', 'local_host_name', 'smtp_server_username',
'smtp_server', 'smtp_server_port', 'encryption', 'authentication', 'smtp_server_password',
'from_address' 'local_host_name',
'smtp_server',
'smtp_server_port',
'encryption',
'authentication',
'from_address',
] ]
updatables = [ updatables = [
'smtp_server_username', 'smtp_server_password', 'local_host_name', 'smtp_server_username',
'smtp_server', 'smtp_server_port', 'encryption', 'authentication', 'smtp_server_password',
'from_address' 'local_host_name',
'smtp_server',
'smtp_server_port',
'encryption',
'authentication',
'from_address',
] ]
@ -362,13 +373,10 @@ class ModuleManager(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))
reportable = ReportableChanges(params=self.changes.to_return()) reportable = ReportableChanges(params=self.changes.to_return())
changes = reportable.to_return() changes = reportable.to_return()
@ -391,12 +399,10 @@ class ModuleManager(object):
else: else:
return self.create() return self.create()
def exists(self): def absent(self):
result = self.client.api.tm.sys.smtp_servers.smtp_server.exists( if self.exists():
name=self.want.name, return self.remove()
partition=self.want.partition return False
)
return result
def update(self): def update(self):
self.have = self.read_current_from_device() self.have = self.read_current_from_device()
@ -422,42 +428,88 @@ class ModuleManager(object):
self.create_on_device() self.create_on_device()
return True return True
def exists(self):
uri = "https://{0}:{1}/mgmt/tm/sys/smtp-server/{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 create_on_device(self): def create_on_device(self):
params = self.want.api_params() params = self.want.api_params()
self.client.api.tm.sys.smtp_servers.smtp_server.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/smtp-server/".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))
if 'code' in response and response['code'] in [400, 403]:
if 'message' in response:
raise F5ModuleError(response['message'])
else:
raise F5ModuleError(resp.content)
def update_on_device(self): def update_on_device(self):
params = self.want.api_params() params = self.want.api_params()
resource = self.client.api.tm.sys.smtp_servers.smtp_server.load( uri = "https://{0}:{1}/mgmt/tm/sys/smtp-server/{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)
) )
resource.modify(**params) resp = self.client.api.patch(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'] == 400:
if self.exists(): if 'message' in response:
return self.remove() raise F5ModuleError(response['message'])
return False else:
raise F5ModuleError(resp.content)
def remove_from_device(self): def remove_from_device(self):
resource = self.client.api.tm.sys.smtp_servers.smtp_server.load( uri = "https://{0}:{1}/mgmt/tm/sys/smtp-server/{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 resource: resp = self.client.api.delete(uri)
resource.delete() if resp.status == 200:
return True
def read_current_from_device(self): def read_current_from_device(self):
resource = self.client.api.tm.sys.smtp_servers.smtp_server.load( uri = "https://{0}:{1}/mgmt/tm/sys/smtp-server/{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 ApiParameters(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 ApiParameters(params=response)
class ArgumentSpec(object): class ArgumentSpec(object):
@ -498,18 +550,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__':

22
test/units/modules/network/f5/test_bigip_smtp.py
View file

@ -8,16 +8,12 @@ __metaclass__ = type
import os import os
import json import json
import pytest
import sys import sys
from nose.plugins.skip import SkipTest 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,17 +21,25 @@ try:
from library.modules.bigip_smtp import ModuleParameters from library.modules.bigip_smtp import ModuleParameters
from library.modules.bigip_smtp import ModuleManager from library.modules.bigip_smtp import ModuleManager
from library.modules.bigip_smtp import ArgumentSpec from library.modules.bigip_smtp 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_smtp import ApiParameters from ansible.modules.network.f5.bigip_smtp import ApiParameters
from ansible.modules.network.f5.bigip_smtp import ModuleParameters from ansible.modules.network.f5.bigip_smtp import ModuleParameters
from ansible.modules.network.f5.bigip_smtp import ModuleManager from ansible.modules.network.f5.bigip_smtp import ModuleManager
from ansible.modules.network.f5.bigip_smtp import ArgumentSpec from ansible.modules.network.f5.bigip_smtp 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")