Adds the bigip_remote_syslog module

This patchs add a remote-syslog module that can be used by people
to manage their (basic, not HSL) syslog configuration
This commit is contained in:
Tim Rupp 2017-10-02 11:34:23 -07:00 committed by Toshio Kuratomi
commit 75c5d0fedc
3 changed files with 703 additions and 0 deletions

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/remotesyslog1",
"host": "20.20.20.20",
"localIp": "1.1.1.1",
"remotePort": 8000
}
]
}

View file

@ -0,0 +1,218 @@
# -*- coding: utf-8 -*-
#
# Copyright 2017 F5 Networks Inc.
#
# This file is part of Ansible
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public Liccense for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
import os
import json
import sys
from nose.plugins.skip import SkipTest
if sys.version_info < (2, 7):
raise SkipTest("F5 Ansible modules require Python >= 2.7")
from ansible.compat.tests import unittest
from ansible.compat.tests.mock import patch, Mock
from ansible.module_utils import basic
from ansible.module_utils._text import to_bytes
from ansible.module_utils.f5_utils import AnsibleF5Client
try:
from library.bigip_remote_syslog import Parameters
from library.bigip_remote_syslog import ModuleManager
from library.bigip_remote_syslog import ArgumentSpec
from library.bigip_remote_syslog import HAS_F5SDK
from library.bigip_remote_syslog import HAS_NETADDR
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
except ImportError:
raise SkipTest("F5 Ansible modules require the f5-sdk Python library")
from ansible.modules.network.f5.bigip_remote_syslog import HAS_NETADDR
if not HAS_NETADDR:
raise SkipTest("F5 Ansible modules require the netaddr Python library")
fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures')
fixture_data = {}
def set_module_args(args):
args = json.dumps({'ANSIBLE_MODULE_ARGS': args})
basic._ANSIBLE_ARGS = to_bytes(args)
def load_fixture(name):
path = os.path.join(fixture_path, name)
if path in fixture_data:
return fixture_data[path]
with open(path) as f:
data = f.read()
try:
data = json.loads(data)
except Exception:
pass
fixture_data[path] = data
return data
class TestParameters(unittest.TestCase):
def test_module_parameters(self):
args = dict(
remote_host='10.10.10.10',
remote_port=514,
local_ip='1.1.1.1'
)
p = Parameters(args)
assert p.remote_host == '10.10.10.10'
assert p.remote_port == 514
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(args)
assert len(p.remoteServers) == 1
@patch('ansible.module_utils.f5_utils.AnsibleF5Client._get_mgmt_root',
return_value=True)
class TestManager(unittest.TestCase):
def setUp(self):
self.spec = ArgumentSpec()
def test_create_remote_syslog(self, *args):
set_module_args(dict(
remote_host='10.10.10.10',
server='localhost',
password='password',
user='admin'
))
client = AnsibleF5Client(
argument_spec=self.spec.argument_spec,
supports_check_mode=self.spec.supports_check_mode,
f5_product_name=self.spec.f5_product_name
)
# Override methods in the specific type of manager
mm = ModuleManager(client)
mm.exists = Mock(side_effect=[False, True])
mm.update_on_device = Mock(return_value=True)
results = mm.exec_module()
assert results['changed'] is True
def test_create_remote_syslog_idempotent(self, *args):
set_module_args(dict(
remote_host='10.10.10.10',
server='localhost',
password='password',
user='admin'
))
current = Parameters(load_fixture('load_tm_sys_syslog.json'))
client = AnsibleF5Client(
argument_spec=self.spec.argument_spec,
supports_check_mode=self.spec.supports_check_mode,
f5_product_name=self.spec.f5_product_name
)
# Override methods in the specific type of manager
mm = ModuleManager(client)
mm.exists = Mock(return_value=True)
mm.read_current_from_device = Mock(return_value=current)
results = mm.exec_module()
assert results['changed'] is False
def test_update_remote_port(self, *args):
set_module_args(dict(
remote_host='10.10.10.10',
remote_port=800,
server='localhost',
password='password',
user='admin'
))
current = Parameters(load_fixture('load_tm_sys_syslog.json'))
client = AnsibleF5Client(
argument_spec=self.spec.argument_spec,
supports_check_mode=self.spec.supports_check_mode,
f5_product_name=self.spec.f5_product_name
)
# Override methods in the specific type of manager
mm = ModuleManager(client)
mm.exists = Mock(return_value=True)
mm.read_current_from_device = Mock(return_value=current)
mm.update_on_device = Mock(return_value=True)
results = mm.exec_module()
assert results['changed'] is True
assert results['remote_port'] == 800
def test_update_local_ip(self, *args):
set_module_args(dict(
remote_host='10.10.10.10',
local_ip='2.2.2.2',
server='localhost',
password='password',
user='admin'
))
current = Parameters(load_fixture('load_tm_sys_syslog.json'))
client = AnsibleF5Client(
argument_spec=self.spec.argument_spec,
supports_check_mode=self.spec.supports_check_mode,
f5_product_name=self.spec.f5_product_name
)
# Override methods in the specific type of manager
mm = ModuleManager(client)
mm.exists = Mock(return_value=True)
mm.read_current_from_device = Mock(return_value=current)
mm.update_on_device = Mock(return_value=True)
results = mm.exec_module()
assert results['changed'] is True
assert results['local_ip'] == '2.2.2.2'