Remove the f5-sdk from bigip_remote_syslog (#48539)

This commit is contained in:
Tim Rupp 2018-11-16 15:13:08 -08:00 committed by GitHub
parent 5271f771f0
commit 9af5724bd4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 336 additions and 271 deletions

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
@ -25,17 +25,25 @@ options:
- Specifies the IP address, or hostname, for the remote system to - Specifies the IP address, or hostname, for the remote system to
which the system sends log messages. which the system sends log messages.
required: True required: True
name:
description:
- Specifies the name of the syslog object.
- This option is required when multiple C(remote_host) with the same IP
or hostname are present on the device.
- If C(name) is not provided C(remote_host) is used by default.
version_added: 2.8
remote_port: remote_port:
description: description:
- Specifies the port that the system uses to send messages to the - Specifies the port that the system uses to send messages to the
remote logging server. When creating a remote syslog, if this parameter remote logging server.
is not specified, the default value C(514) is used. - When creating a remote syslog, if this parameter is not specified, the
default value C(514) is used.
local_ip: local_ip:
description: description:
- Specifies the local IP address of the system that is logging. To - Specifies the local IP address of the system that is logging. To
provide no local IP, specify the value C(none). When creating a provide no local IP, specify the value C(none).
remote syslog, if this parameter is not specified, the default value - When creating a remote syslog, if this parameter is not specified, the
C(none) is used. default value C(none) is used.
state: state:
description: description:
- When C(present), guarantees that the remote syslog exists with the provided - When C(present), guarantees that the remote syslog exists with the provided
@ -48,26 +56,29 @@ options:
extends_documentation_fragment: f5 extends_documentation_fragment: f5
author: author:
- Tim Rupp (@caphrim007) - Tim Rupp (@caphrim007)
- Wojciech Wypior (@wojtek0806)
''' '''
EXAMPLES = r''' EXAMPLES = r'''
- name: Add a remote syslog server to log to - name: Add a remote syslog server to log to
bigip_remote_syslog: bigip_remote_syslog:
remote_host: 10.10.10.10 remote_host: 10.10.10.10
password: secret provider:
server: lb.mydomain.com password: secret
user: admin server: lb.mydomain.com
validate_certs: no user: admin
validate_certs: no
delegate_to: localhost delegate_to: localhost
- name: Add a remote syslog server on a non-standard port to log to - name: Add a remote syslog server on a non-standard port to log to
bigip_remote_syslog: bigip_remote_syslog:
remote_host: 10.10.10.10 remote_host: 10.10.10.10
remote_port: 1234 remote_port: 1234
password: secret provider:
server: lb.mydomain.com password: secret
user: admin server: lb.mydomain.com
validate_certs: no user: admin
validate_certs: no
delegate_to: localhost delegate_to: localhost
''' '''
@ -84,93 +95,84 @@ local_ip:
sample: 10.10.10.10 sample: 10.10.10.10
''' '''
import re
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.six import iteritems from ansible.module_utils.six import iteritems
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
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 compare_dictionary
from library.module_utils.network.f5.common import is_valid_hostname
from library.module_utils.network.f5.common import fq_name
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 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 compare_dictionary
from ansible.module_utils.network.f5.common import is_valid_hostname
from ansible.module_utils.network.f5.common import fq_name
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):
api_map = {
'remotePort': 'remote_port',
'localIp': 'local_ip',
'host': 'remote_host',
}
updatables = [ updatables = [
'remote_port', 'local_ip', 'remoteServers' 'remote_port',
'local_ip',
'remote_host',
'name',
] ]
returnables = [ returnables = [
'remote_port', 'local_ip' 'remote_port',
'local_ip',
'remote_host',
'name',
'remoteServers',
] ]
api_attributes = [ api_attributes = [
'remoteServers' 'remotePort',
'localIp',
'host',
'name',
'remoteServers',
] ]
def to_return(self):
result = {}
for returnable in self.returnables:
result[returnable] = getattr(self, returnable)
result = self._filter_params(result)
return result
class ApiParameters(Parameters):
pass
class ModuleParameters(Parameters):
@property @property
def remote_host(self): def remote_host(self):
if is_valid_ip(self._values['remote_host']): if is_valid_ip(self._values['remote_host']):
return self._values['remote_host'] return self._values['remote_host']
elif self.is_valid_hostname(self._values['remote_host']): elif is_valid_hostname(self._values['remote_host']):
return str(self._values['remote_host']) return str(self._values['remote_host'])
raise F5ModuleError( raise F5ModuleError(
"The provided 'remote_host' is not a valid IP or hostname" "The provided 'remote_host' is not a valid IP or hostname"
) )
def is_valid_hostname(self, host):
"""Reasonable attempt at validating a hostname
Compiled from various paragraphs outlined here
https://tools.ietf.org/html/rfc3696#section-2
https://tools.ietf.org/html/rfc1123
Notably,
* Host software MUST handle host names of up to 63 characters and
SHOULD handle host names of up to 255 characters.
* The "LDH rule", after the characters that it permits. (letters, digits, hyphen)
* If the hyphen is used, it is not permitted to appear at
either the beginning or end of a label
:param host:
:return:
"""
if len(host) > 255:
return False
host = host.rstrip(".")
allowed = re.compile(r'(?!-)[A-Z0-9-]{1,63}(?<!-)$', re.IGNORECASE)
return all(allowed.match(x) for x in host.split("."))
@property @property
def remote_port(self): def remote_port(self):
if self._values['remote_port'] is None: if self._values['remote_port'] in [None, 'none']:
return None return None
if self._values['remote_port'] == 0: if self._values['remote_port'] == 0:
raise F5ModuleError( raise F5ModuleError(
@ -189,15 +191,46 @@ class Parameters(AnsibleF5Parameters):
"The provided 'local_ip' is not a valid IP address" "The provided 'local_ip' is not a valid IP address"
) )
@property
def name(self):
if self._values['remote_host'] is None:
return None
if self._values['name'] is None:
return None
name = fq_name(self.partition, self._values['name'])
return name
class Changes(Parameters): class Changes(Parameters):
def to_return(self):
result = {}
try:
for returnable in self.returnables:
change = getattr(self, returnable)
if isinstance(change, dict):
result.update(change)
else:
result[returnable] = change
result = self._filter_params(result)
except Exception:
pass
return result
class UsableChanges(Changes):
pass
class ReportableChanges(Changes):
@property @property
def remote_port(self): def remote_port(self):
return self._values['remote_port'] if self._values['remote_port'] is None:
return None
return int(self._values['remote_port'])
@property @property
def local_ip(self): def remoteServers(self):
return self._values['local_ip'] pass
class Difference(object): class Difference(object):
@ -223,90 +256,28 @@ class Difference(object):
except AttributeError: except AttributeError:
return attr1 return attr1
@property
def remoteServers(self):
"""Return changed list of remote servers
The order of this list does not matter as BIG-IP will send to all the
items in it.
:return:
"""
changed = False
if self.want.remote_host is None:
return None
if self.have.remoteServers is None:
remote = dict()
else:
remote = self.have.remoteServers
current_hosts = dict((d['host'], d) for (i, d) in enumerate(remote))
if self.want.state == 'absent':
del current_hosts[self.want.remote_host]
result = [v for (k, v) in iteritems(current_hosts)]
return result
if self.want.remote_host in current_hosts:
item = current_hosts[self.want.remote_host]
if self.want.remote_port is not None:
if int(item['remotePort']) != self.want.remote_port:
item['remotePort'] = self.want.remote_port
self._remote_port = self.want.remote_port
changed = True
if self.want.local_ip is not None:
if item['localIp'] != self.want.local_ip:
item['localIp'] = self.want.local_ip
self._local_ip = self.want.local_ip
changed = True
else:
changed = True
count = len(current_hosts.keys()) + 1
host = self.want.remote_host
current_hosts[self.want.remote_host] = dict(
name="/Common/remotesyslog{0}".format(count),
host=host
)
if self.want.remote_port is not None:
current_hosts[host]['remotePort'] = self.want.remote_port
self._remote_port = self.want.remote_port
if self.want.local_ip is not None:
current_hosts[host]['localIp'] = self.want.local_ip
self._local_ip = self.want.local_ip
if changed:
result = [v for (k, v) in iteritems(current_hosts)]
return result
return None
@property
def remote_port(self):
_ = self.remoteServers
if self._remote_port:
return self._remote_port
@property
def local_ip(self):
_ = self.remoteServers
if self._local_ip:
return self._local_ip
class ModuleManager(object): class ModuleManager(object):
def __init__(self, *args, **kwargs): def __init__(self, *args, **kwargs):
self.module = kwargs.get('module', None) self.module = kwargs.pop('module', None)
self.client = kwargs.get('client', None) self.client = kwargs.pop('client', None)
self.have = None self.want = ModuleParameters(params=self.module.params)
self.want = Parameters(params=self.module.params) self.have = ApiParameters()
self.changes = Changes() self.changes = UsableChanges()
def _set_changed_options(self): # A list of all the syslogs queried from the API when reading current info
changed = {} # from the device. This is used when updating the API as the value that needs
for key in Parameters.returnables: # to be updated is a list of syslogs and PATCHing a list would override any
if getattr(self.want, key) is not None: # default settings.
changed[key] = getattr(self.want, key) self.syslogs = dict()
if changed:
self.changes = Changes(params=changed) def _announce_deprecations(self, result):
self.changes.update({'remote_host': self.want.remote_host}) warnings = result.pop('__warnings', [])
for warning in warnings:
self.module.deprecate(
msg=warning['msg'],
version=warning['version']
)
def _update_changed_options(self): def _update_changed_options(self):
diff = Difference(self.want, self.have) diff = Difference(self.want, self.have)
@ -322,59 +293,39 @@ class ModuleManager(object):
else: else:
changed[k] = change changed[k] = change
if changed: if changed:
self.changes = Changes(params=changed) self.changes = UsableChanges(params=changed)
self.changes.update({'remote_host': self.want.remote_host})
return True return True
return False return False
def format_syslogs(self, syslogs):
result = None
for x in syslogs:
syslog = ApiParameters(params=x)
self.syslogs[syslog.name] = x
if syslog.name == self.want.name:
result = syslog
elif syslog.remote_host == self.want.remote_host:
result = syslog
if not result:
return ApiParameters()
return result
def exec_module(self): def exec_module(self):
changed = False
result = dict() result = dict()
state = self.want.state
try: changed = self.present()
if state == "present":
changed = self.present()
elif state == "absent":
changed = self.absent()
except iControlUnexpectedHTTPError as e:
raise F5ModuleError(str(e))
changes = self.changes.to_return() reportable = ReportableChanges(params=self.changes.to_return())
changes = reportable.to_return()
result.update(**changes) result.update(**changes)
result.update(dict(changed=changed)) result.update(dict(changed=changed))
self._announce_deprecations(result)
return result return result
def present(self): def present(self):
if self.exists(): return self.update()
return self.update()
else:
return self.create()
def create(self):
self._set_valid_defaults()
self._update_changed_options()
if self.module.check_mode:
return True
# This is an unnamed resource, so we only need to update
self.update_on_device()
return True
def _set_valid_defaults(self):
if self.changes.local_ip is None:
self.changes.update({'local_ip': None})
if self.changes.remote_port is None:
self.changes.update({'remote_port': 514})
remote_servers = [
dict(
name='/{0}/remotesyslog1'.format(self.want.partition),
host=self.want.remote_host,
localIp=self.changes.local_ip,
remotePort=self.changes.remote_port
)
]
self.changes.update({'remoteServers': remote_servers})
def should_update(self): def should_update(self):
result = self._update_changed_options() result = self._update_changed_options()
@ -383,53 +334,103 @@ class ModuleManager(object):
return False return False
def update(self): def update(self):
self.have = self.read_current_from_device() self.have = self.format_syslogs(self.read_current_from_device())
if not self.should_update(): if not self.should_update() and self.want.state != 'absent':
return False return False
if self.module.check_mode: if self.module.check_mode:
return True return True
if self.want.name is None:
self.want.update({'name': self.want.remote_host})
syslogs = [v for k, v in iteritems(self.syslogs)]
dupes = [x for x in syslogs if x['host'] == self.want.remote_host]
if len(dupes) > 1:
raise F5ModuleError(
"Multiple occurrences of hostname: {0} detected, please specify 'name' parameter". format(self.want.remote_host)
)
# A absent syslog does not appear in the list of existing syslogs
if self.want.state == 'absent':
if self.want.name not in self.syslogs:
return False
# At this point we know the existing syslog is not absent, so we need
# to change it in some way.
#
# First, if we see that the syslog is in the current list of syslogs,
# we are going to update it
changes = dict(self.changes.api_params())
if self.want.name in self.syslogs:
self.syslogs[self.want.name].update(changes)
else:
# else, we are going to add it to the list of syslogs
self.syslogs[self.want.name] = changes
# Since the name attribute is not a parameter tracked in the Parameter
# classes, we will add the name to the list of attributes so that when
# we update the API, it creates the correct vector
self.syslogs[self.want.name].update({'name': self.want.name})
# Finally, the absent state forces us to remove the syslog from the
# list.
if self.want.state == 'absent':
del self.syslogs[self.want.name]
# All of the syslogs must be re-assembled into a list of dictionaries
# so that when we PATCH the API endpoint, the syslogs list is filled
# correctly.
#
# There are **not** individual API endpoints for the individual syslogs.
# Instead, the endpoint includes a list of syslogs that is part of the
# system config
result = [v for k, v in iteritems(self.syslogs)]
self.changes = Changes(params=dict(remoteServers=result))
self.changes.update(self.want._values)
self.update_on_device() self.update_on_device()
return True return True
def exists(self):
self.have = self.read_current_from_device()
if self.have.remoteServers is None:
return False
for server in self.have.remoteServers:
if server['host'] == self.want.remote_host:
return True
def update_on_device(self): def update_on_device(self):
params = self.changes.api_params() params = self.changes.api_params()
result = self.client.api.tm.sys.syslog.load() params = dict(
result.modify(**params) remoteServers=params.get('remoteServers')
)
uri = "https://{0}:{1}/mgmt/tm/sys/syslog/".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'] in [400, 409]:
if 'message' in response:
raise F5ModuleError(response['message'])
else:
raise F5ModuleError(resp.content)
def read_current_from_device(self): def read_current_from_device(self):
resource = self.client.api.tm.sys.syslog.load() uri = "https://{0}:{1}/mgmt/tm/sys/syslog/".format(
attrs = resource.attrs self.client.provider['server'],
result = Parameters(params=attrs) 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)
result = response.get('remoteServers', [])
return result return result
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 remote syslog.")
return True
def remove_from_device(self):
self._update_changed_options()
params = self.changes.api_params()
result = self.client.api.tm.sys.syslog.load()
result.modify(**params)
class ArgumentSpec(object): class ArgumentSpec(object):
def __init__(self): def __init__(self):
@ -440,6 +441,7 @@ class ArgumentSpec(object):
), ),
remote_port=dict(), remote_port=dict(),
local_ip=dict(), local_ip=dict(),
name=dict(),
state=dict( state=dict(
default='present', default='present',
choices=['absent', 'present'] choices=['absent', 'present']
@ -457,18 +459,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__':

View file

@ -29,7 +29,7 @@
"remotePort": 514 "remotePort": 514
}, },
{ {
"name": "/Common/remotesyslog1", "name": "/Common/remotesyslog2",
"host": "20.20.20.20", "host": "20.20.20.20",
"localIp": "1.1.1.1", "localIp": "1.1.1.1",
"remotePort": 8000 "remotePort": 8000

View file

@ -0,0 +1,38 @@
{
"kind": "tm:sys:syslog:syslogstate",
"selfLink": "https://localhost/mgmt/tm/sys/syslog?ver=13.0.0",
"authPrivFrom": "notice",
"authPrivTo": "emerg",
"clusteredHostSlot": "enabled",
"clusteredMessageSlot": "disabled",
"consoleLog": "enabled",
"cronFrom": "warning",
"cronTo": "emerg",
"daemonFrom": "notice",
"daemonTo": "emerg",
"isoDate": "disabled",
"kernFrom": "debug",
"kernTo": "emerg",
"local6From": "notice",
"local6To": "emerg",
"mailFrom": "notice",
"mailTo": "emerg",
"messagesFrom": "notice",
"messagesTo": "warning",
"userLogFrom": "notice",
"userLogTo": "emerg",
"remoteServers": [
{
"name": "/Common/remotesyslog1",
"host": "10.10.10.10",
"localIp": "none",
"remotePort": 514
},
{
"name": "/Common/remotesyslog2",
"host": "10.10.10.10",
"localIp": "1.1.1.1",
"remotePort": 8000
}
]
}

View file

@ -9,41 +9,43 @@ __metaclass__ = type
import os import os
import json import json
import sys import sys
import pytest
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:
from library.modules.bigip_remote_syslog import Parameters from library.modules.bigip_remote_syslog import ApiParameters
from library.modules.bigip_remote_syslog import ModuleParameters
from library.modules.bigip_remote_syslog import ModuleManager from library.modules.bigip_remote_syslog import ModuleManager
from library.modules.bigip_remote_syslog import ArgumentSpec from library.modules.bigip_remote_syslog import ArgumentSpec
from library.modules.bigip_remote_syslog import HAS_F5SDK
from library.modules.bigip_remote_syslog import HAS_NETADDR
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
except ImportError:
try:
from ansible.modules.network.f5.bigip_remote_syslog import Parameters
from ansible.modules.network.f5.bigip_remote_syslog import ModuleManager
from ansible.modules.network.f5.bigip_remote_syslog import ArgumentSpec
from ansible.modules.network.f5.bigip_remote_syslog import HAS_F5SDK
from ansible.modules.network.f5.bigip_remote_syslog import HAS_NETADDR
from ansible.module_utils.network.f5.common import F5ModuleError
from ansible.module_utils.network.f5.common import iControlUnexpectedHTTPError
from units.modules.utils import set_module_args
except ImportError:
raise SkipTest("F5 Ansible modules require the f5-sdk Python library")
from ansible.modules.network.f5.bigip_remote_syslog import HAS_NETADDR from library.module_utils.network.f5.common import F5ModuleError
if not HAS_NETADDR:
raise SkipTest("F5 Ansible modules require the netaddr Python library") # 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:
from ansible.modules.network.f5.bigip_remote_syslog import ApiParameters
from ansible.modules.network.f5.bigip_remote_syslog import ModuleParameters
from ansible.modules.network.f5.bigip_remote_syslog import ModuleManager
from ansible.modules.network.f5.bigip_remote_syslog import ArgumentSpec
from ansible.module_utils.network.f5.common import F5ModuleError
# 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
fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures') fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures')
fixture_data = {} fixture_data = {}
@ -75,26 +77,11 @@ class TestParameters(unittest.TestCase):
local_ip='1.1.1.1' local_ip='1.1.1.1'
) )
p = Parameters(params=args) p = ModuleParameters(params=args)
assert p.remote_host == '10.10.10.10' assert p.remote_host == '10.10.10.10'
assert p.remote_port == 514 assert p.remote_port == 514
assert p.local_ip == '1.1.1.1' assert p.local_ip == '1.1.1.1'
def test_api_parameters(self):
args = dict(
remoteServers=[
dict(
name='/Common/remotesyslog1',
host='10.10.10.10',
localIp='none',
remotePort=514
)
]
)
p = Parameters(params=args)
assert len(p.remoteServers) == 1
class TestManager(unittest.TestCase): class TestManager(unittest.TestCase):
@ -103,12 +90,15 @@ class TestManager(unittest.TestCase):
def test_create_remote_syslog(self, *args): def test_create_remote_syslog(self, *args):
set_module_args(dict( set_module_args(dict(
remote_host='10.10.10.10', remote_host='1.1.1.1',
server='localhost', server='localhost',
password='password', password='password',
user='admin' user='admin'
)) ))
fixture = load_fixture('load_tm_sys_syslog_1.json')
current = fixture['remoteServers']
module = AnsibleModule( module = AnsibleModule(
argument_spec=self.spec.argument_spec, argument_spec=self.spec.argument_spec,
supports_check_mode=self.spec.supports_check_mode supports_check_mode=self.spec.supports_check_mode
@ -118,6 +108,7 @@ class TestManager(unittest.TestCase):
mm = ModuleManager(module=module) mm = ModuleManager(module=module)
mm.exists = Mock(side_effect=[False, True]) mm.exists = Mock(side_effect=[False, True])
mm.update_on_device = Mock(return_value=True) mm.update_on_device = Mock(return_value=True)
mm.read_current_from_device = Mock(return_value=current)
results = mm.exec_module() results = mm.exec_module()
@ -125,13 +116,16 @@ class TestManager(unittest.TestCase):
def test_create_remote_syslog_idempotent(self, *args): def test_create_remote_syslog_idempotent(self, *args):
set_module_args(dict( set_module_args(dict(
name='remotesyslog1',
remote_host='10.10.10.10', remote_host='10.10.10.10',
server='localhost', server='localhost',
password='password', password='password',
user='admin' user='admin'
)) ))
current = Parameters(params=load_fixture('load_tm_sys_syslog.json')) fixture = load_fixture('load_tm_sys_syslog_1.json')
current = fixture['remoteServers']
module = AnsibleModule( module = AnsibleModule(
argument_spec=self.spec.argument_spec, argument_spec=self.spec.argument_spec,
supports_check_mode=self.spec.supports_check_mode supports_check_mode=self.spec.supports_check_mode
@ -155,7 +149,9 @@ class TestManager(unittest.TestCase):
user='admin' user='admin'
)) ))
current = Parameters(params=load_fixture('load_tm_sys_syslog.json')) fixture = load_fixture('load_tm_sys_syslog_1.json')
current = fixture['remoteServers']
module = AnsibleModule( module = AnsibleModule(
argument_spec=self.spec.argument_spec, argument_spec=self.spec.argument_spec,
supports_check_mode=self.spec.supports_check_mode supports_check_mode=self.spec.supports_check_mode
@ -181,7 +177,9 @@ class TestManager(unittest.TestCase):
user='admin' user='admin'
)) ))
current = Parameters(params=load_fixture('load_tm_sys_syslog.json')) fixture = load_fixture('load_tm_sys_syslog_1.json')
current = fixture['remoteServers']
module = AnsibleModule( module = AnsibleModule(
argument_spec=self.spec.argument_spec, argument_spec=self.spec.argument_spec,
supports_check_mode=self.spec.supports_check_mode supports_check_mode=self.spec.supports_check_mode
@ -197,3 +195,31 @@ class TestManager(unittest.TestCase):
assert results['changed'] is True assert results['changed'] is True
assert results['local_ip'] == '2.2.2.2' assert results['local_ip'] == '2.2.2.2'
def test_update_no_name_dupe_host(self, *args):
set_module_args(dict(
remote_host='10.10.10.10',
local_ip='2.2.2.2',
server='localhost',
password='password',
user='admin'
))
fixture = load_fixture('load_tm_sys_syslog_2.json')
current = fixture['remoteServers']
module = AnsibleModule(
argument_spec=self.spec.argument_spec,
supports_check_mode=self.spec.supports_check_mode
)
# Override methods in the specific type of manager
mm = ModuleManager(module=module)
mm.exists = Mock(return_value=True)
mm.read_current_from_device = Mock(return_value=current)
mm.update_on_device = Mock(return_value=True)
with pytest.raises(F5ModuleError) as ex:
mm.exec_module()
assert "Multiple occurrences of hostname" in str(ex)