diff --git a/lib/ansible/module_utils/f5_utils.py b/lib/ansible/module_utils/f5_utils.py index e237253e1c..09fedd85db 100644 --- a/lib/ansible/module_utils/f5_utils.py +++ b/lib/ansible/module_utils/f5_utils.py @@ -146,7 +146,7 @@ try: from f5.bigiq import ManagementRoot as BigIqMgmt from f5.iworkflow import ManagementRoot as iWorkflowMgmt - from icontrol.session import iControlUnexpectedHTTPError + from icontrol.exceptions import iControlUnexpectedHTTPError HAS_F5SDK = True except ImportError: HAS_F5SDK = False diff --git a/lib/ansible/modules/network/f5/bigip_monitor_tcp_echo.py b/lib/ansible/modules/network/f5/bigip_monitor_tcp_echo.py new file mode 100644 index 0000000000..b8b0472e20 --- /dev/null +++ b/lib/ansible/modules/network/f5/bigip_monitor_tcp_echo.py @@ -0,0 +1,529 @@ +#!/usr/bin/python +# -*- 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 License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Ansible. If not, see . + +ANSIBLE_METADATA = { + 'status': ['preview'], + 'supported_by': 'community', + 'metadata_version': '1.0' +} + +DOCUMENTATION = ''' +--- +module: bigip_monitor_tcp_echo +short_description: Manages F5 BIG-IP LTM tcp monitors. +description: Manages F5 BIG-IP LTM tcp monitors via iControl SOAP API. +version_added: "2.4" +options: + name: + description: + - Monitor name. + required: True + aliases: + - monitor + parent: + description: + - The parent template of this monitor template. Once this value has + been set, it cannot be changed. By default, this value is the C(tcp) + parent on the C(Common) partition. + default: "/Common/tcp" + ip: + description: + - IP address part of the IP/port definition. If this parameter is not + provided when creating a new monitor, then the default value will be + '*'. + - If this value is an IP address, and the C(type) is C(tcp) (the default), + then a C(port) number must be specified. + interval: + description: + - The interval specifying how frequently the monitor instance of this + template will run. If this parameter is not provided when creating + a new monitor, then the default value will be 5. This value B(must) + be less than the C(timeout) value. + timeout: + description: + - The number of seconds in which the node or service must respond to + the monitor request. If the target responds within the set time + period, it is considered up. If the target does not respond within + the set time period, it is considered down. You can change this + number to any number you want, however, it should be 3 times the + interval number of seconds plus 1 second. If this parameter is not + provided when creating a new monitor, then the default value will be 16. + time_until_up: + description: + - Specifies the amount of time in seconds after the first successful + response before a node will be marked up. A value of 0 will cause a + node to be marked up immediately after a valid response is received + from the node. If this parameter is not provided when creating + a new monitor, then the default value will be 0. +notes: + - Requires the f5-sdk Python package on the host. This is as easy as pip + install f5-sdk. + - Requires BIG-IP software version >= 12 +requirements: + - f5-sdk >= 2.2.3 +extends_documentation_fragment: f5 +author: + - Tim Rupp (@caphrim007) +''' + +EXAMPLES = ''' +- name: Create TCP Echo Monitor + bigip_monitor_tcp_echo: + state: "present" + server: "lb.mydomain.com" + user: "admin" + ip: 10.10.10.10 + password: "secret" + name: "my_tcp_monitor" + delegate_to: localhost + +- name: Remove TCP Echo Monitor + bigip_monitor_tcp_echo: + state: "absent" + server: "lb.mydomain.com" + user: "admin" + password: "secret" + name: "my_tcp_monitor" + delegate_to: localhost +''' + +RETURN = ''' +parent: + description: New parent template of the monitor. + returned: changed + type: string + sample: "tcp" +ip: + description: The new IP of IP/port definition. + returned: changed + type: string + sample: "10.12.13.14" +interval: + description: The new interval in which to run the monitor check. + returned: changed + type: int + sample: 2 +timeout: + description: The new timeout in which the remote system must respond to the monitor. + returned: changed + type: int + sample: 10 +time_until_up: + description: The new time in which to mark a system as up after first successful response. + returned: changed + type: int + sample: 2 +''' + +import os + +try: + import netaddr + HAS_NETADDR = True +except ImportError: + HAS_NETADDR = False + +from ansible.module_utils.f5_utils import AnsibleF5Client +from ansible.module_utils.f5_utils import AnsibleF5Parameters +from ansible.module_utils.f5_utils import HAS_F5SDK +from ansible.module_utils.f5_utils import F5ModuleError +from ansible.module_utils.f5_utils import iteritems +from ansible.module_utils.f5_utils import defaultdict + +try: + from ansible.module_utils.f5_utils import iControlUnexpectedHTTPError +except ImportError: + HAS_F5SDK = False + + +class Parameters(AnsibleF5Parameters): + api_map = { + 'timeUntilUp': 'time_until_up', + 'defaultsFrom': 'parent' + } + + api_attributes = [ + 'timeUntilUp', 'defaultsFrom', 'interval', 'timeout', 'destination' + ] + + returnables = [ + 'parent', 'ip', 'interval', 'timeout', 'time_until_up' + ] + + updatables = [ + 'ip', 'interval', 'timeout', 'time_until_up' + ] + + def __init__(self, params=None): + self._values = defaultdict(lambda: None) + self._values['__warnings'] = [] + if params: + self.update(params=params) + + def update(self, params=None): + if params: + for k, v in iteritems(params): + if self.api_map is not None and k in self.api_map: + map_key = self.api_map[k] + else: + map_key = k + + # Handle weird API parameters like `dns.proxy.__iter__` by + # using a map provided by the module developer + class_attr = getattr(type(self), map_key, None) + if isinstance(class_attr, property): + # There is a mapped value for the api_map key + if class_attr.fset is None: + # If the mapped value does not have + # an associated setter + self._values[map_key] = v + else: + # The mapped value has a setter + setattr(self, map_key, v) + else: + # If the mapped value is not a @property + self._values[map_key] = v + + def to_return(self): + result = {} + try: + for returnable in self.returnables: + result[returnable] = getattr(self, returnable) + result = self._filter_params(result) + return result + except Exception: + return result + + def api_params(self): + result = {} + for api_attribute in self.api_attributes: + if self.api_map is not None and api_attribute in self.api_map: + result[api_attribute] = getattr(self, self.api_map[api_attribute]) + else: + result[api_attribute] = getattr(self, api_attribute) + result = self._filter_params(result) + return result + + @property + def interval(self): + if self._values['interval'] is None: + return None + if 1 > int(self._values['interval']) > 86400: + raise F5ModuleError( + "Interval value must be between 1 and 86400" + ) + return int(self._values['interval']) + + @property + def timeout(self): + if self._values['timeout'] is None: + return None + return int(self._values['timeout']) + + @property + def ip(self): + if self._values['ip'] is None: + return None + try: + if self._values['ip'] in ['*', '0.0.0.0']: + return '*' + result = str(netaddr.IPAddress(self._values['ip'])) + return result + except netaddr.core.AddrFormatError: + raise F5ModuleError( + "The provided 'ip' parameter is not an IP address." + ) + + @property + def destination(self): + return self.ip + + @destination.setter + def destination(self, value): + self._values['ip'] = value + + @property + def time_until_up(self): + if self._values['time_until_up'] is None: + return None + return int(self._values['time_until_up']) + + @property + def parent(self): + if self._values['parent'] is None: + return None + if self._values['parent'].startswith('/'): + parent = os.path.basename(self._values['parent']) + result = '/{0}/{1}'.format(self.partition, parent) + else: + result = '/{0}/{1}'.format(self.partition, self._values['parent']) + return result + + @property + def type(self): + return 'tcp_echo' + + +class Difference(object): + def __init__(self, want, have=None): + self.want = want + self.have = have + + def compare(self, param): + try: + result = getattr(self, param) + return result + except AttributeError: + result = self.__default(param) + return result + + @property + def parent(self): + if self.want.parent != self.want.parent: + raise F5ModuleError( + "The parent monitor cannot be changed" + ) + + @property + def destination(self): + if self.want.ip is None: + return None + if self.want.destination != self.have.destination: + return self.want.destination + + @property + def interval(self): + if self.want.timeout is not None and self.want.interval is not None: + if self.want.interval >= self.want.timeout: + raise F5ModuleError( + "Parameter 'interval' must be less than 'timeout'." + ) + elif self.want.timeout is not None: + if self.have.interval >= self.want.timeout: + raise F5ModuleError( + "Parameter 'interval' must be less than 'timeout'." + ) + elif self.want.interval is not None: + if self.want.interval >= self.have.timeout: + raise F5ModuleError( + "Parameter 'interval' must be less than 'timeout'." + ) + if self.want.interval != self.have.interval: + return self.want.interval + + def __default(self, param): + attr1 = getattr(self.want, param) + try: + attr2 = getattr(self.have, param) + if attr1 != attr2: + return attr1 + except AttributeError: + return attr1 + + +class ModuleManager(object): + def __init__(self, client): + self.client = client + self.have = None + self.want = Parameters(self.client.module.params) + self.changes = Parameters() + + def _set_changed_options(self): + changed = {} + for key in Parameters.returnables: + if getattr(self.want, key) is not None: + changed[key] = getattr(self.want, key) + if changed: + self.changes = Parameters(changed) + + def _update_changed_options(self): + diff = Difference(self.want, self.have) + updatables = Parameters.updatables + changed = dict() + for k in updatables: + change = diff.compare(k) + if change is None: + continue + else: + changed[k] = change + if changed: + self.changes = Parameters(changed) + return True + return False + + def _announce_deprecations(self): + warnings = [] + if self.want: + warnings += self.want._values.get('__warnings', []) + if self.have: + warnings += self.have._values.get('__warnings', []) + for warning in warnings: + self.client.module.deprecate( + msg=warning['msg'], + version=warning['version'] + ) + + def exec_module(self): + changed = False + result = dict() + state = self.want.state + + try: + 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() + result.update(**changes) + result.update(dict(changed=changed)) + self._announce_deprecations() + return result + + def present(self): + if self.exists(): + return self.update() + else: + return self.create() + + def create(self): + self._set_changed_options() + if self.want.timeout is None: + self.want.update({'timeout': 16}) + if self.want.interval is None: + self.want.update({'interval': 5}) + if self.want.time_until_up is None: + self.want.update({'time_until_up': 0}) + if self.want.ip is None: + self.want.update({'ip': '*'}) + if self.client.check_mode: + return True + self.create_on_device() + return True + + def should_update(self): + result = self._update_changed_options() + if result: + return True + return False + + def update(self): + self.have = self.read_current_from_device() + if not self.should_update(): + return False + if self.client.check_mode: + return True + self.update_on_device() + return True + + def absent(self): + if self.exists(): + return self.remove() + return False + + def remove(self): + if self.client.check_mode: + return True + self.remove_from_device() + if self.exists(): + raise F5ModuleError("Failed to delete the monitor.") + return True + + def read_current_from_device(self): + resource = self.client.api.tm.ltm.monitor.tcp_echos.tcp_echo.load( + name=self.want.name, + partition=self.want.partition + ) + result = resource.attrs + return Parameters(result) + + def exists(self): + result = self.client.api.tm.ltm.monitor.tcp_echos.tcp_echo.exists( + name=self.want.name, + partition=self.want.partition + ) + return result + + def update_on_device(self): + params = self.want.api_params() + result = self.client.api.tm.ltm.monitor.tcp_echos.tcp_echo.load( + name=self.want.name, + partition=self.want.partition + ) + result.modify(**params) + + def create_on_device(self): + params = self.want.api_params() + self.client.api.tm.ltm.monitor.tcp_echos.tcp_echo.create( + name=self.want.name, + partition=self.want.partition, + **params + ) + + def remove_from_device(self): + result = self.client.api.tm.ltm.monitor.tcp_echos.tcp_echo.load( + name=self.want.name, + partition=self.want.partition + ) + if result: + result.delete() + + +class ArgumentSpec(object): + def __init__(self): + self.supports_check_mode = True + self.argument_spec = dict( + name=dict(required=True), + parent=dict(), + ip=dict(), + interval=dict(type='int'), + timeout=dict(type='int'), + time_until_up=dict(type='int') + ) + self.f5_product_name = 'bigip' + + +def main(): + try: + spec = ArgumentSpec() + + client = AnsibleF5Client( + argument_spec=spec.argument_spec, + supports_check_mode=spec.supports_check_mode, + f5_product_name=spec.f5_product_name + ) + + if not HAS_F5SDK: + raise F5ModuleError("The python f5-sdk module is required") + + if not HAS_NETADDR: + raise F5ModuleError("The python netaddr module is required") + + mm = ModuleManager(client) + results = mm.exec_module() + client.module.exit_json(**results) + except F5ModuleError as e: + client.module.fail_json(msg=str(e)) + + +if __name__ == '__main__': + main() diff --git a/test/units/modules/network/f5/fixtures/load_ltm_monitor_tcp_echo.json b/test/units/modules/network/f5/fixtures/load_ltm_monitor_tcp_echo.json new file mode 100644 index 0000000000..1a5183466a --- /dev/null +++ b/test/units/modules/network/f5/fixtures/load_ltm_monitor_tcp_echo.json @@ -0,0 +1,21 @@ +{ + "kind": "tm:ltm:monitor:tcp-echo:tcp-echostate", + "name": "foo", + "partition": "Common", + "fullPath": "/Common/foo", + "generation": 0, + "selfLink": "https://localhost/mgmt/tm/ltm/monitor/tcp-echo/~Common~foo?ver=13.0.0", + "adaptive": "disabled", + "adaptiveDivergenceType": "relative", + "adaptiveDivergenceValue": 25, + "adaptiveLimit": 200, + "adaptiveSamplingTimespan": 300, + "defaultsFrom": "/Common/tcp_echo", + "destination": "10.10.10.10", + "interval": 20, + "manualResume": "disabled", + "timeUntilUp": 60, + "timeout": 30, + "transparent": "disabled", + "upInterval": 0 +} diff --git a/test/units/modules/network/f5/test_bigip_monitor_tcp_echo.py b/test/units/modules/network/f5/test_bigip_monitor_tcp_echo.py new file mode 100644 index 0000000000..b50b94567e --- /dev/null +++ b/test/units/modules/network/f5/test_bigip_monitor_tcp_echo.py @@ -0,0 +1,337 @@ +# -*- 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 . + +from __future__ import (absolute_import, division, print_function) +__metaclass__ = type + +import os +import json +import sys +import pytest + +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 +from ansible.module_utils.f5_utils import F5ModuleError + +try: + from library.bigip_monitor_tcp_echo import Parameters + from library.bigip_monitor_tcp_echo import ModuleManager + from library.bigip_monitor_tcp_echo import ArgumentSpec +except ImportError: + try: + from ansible.modules.network.f5.bigip_monitor_tcp_echo import Parameters + from ansible.modules.network.f5.bigip_monitor_tcp_echo import ModuleManager + from ansible.modules.network.f5.bigip_monitor_tcp_echo import ArgumentSpec + except ImportError: + raise SkipTest("F5 Ansible modules require the f5-sdk 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( + name='foo', + parent='parent', + ip='10.10.10.10', + interval=20, + timeout=30, + time_until_up=60, + partition='Common' + ) + + p = Parameters(args) + assert p.name == 'foo' + assert p.parent == '/Common/parent' + assert p.ip == '10.10.10.10' + assert p.type == 'tcp_echo' + assert p.destination == '10.10.10.10' + assert p.interval == 20 + assert p.timeout == 30 + assert p.time_until_up == 60 + + def test_module_parameters_ints_as_strings(self): + args = dict( + name='foo', + parent='parent', + ip='10.10.10.10', + interval='20', + timeout='30', + time_until_up='60', + partition='Common' + ) + + p = Parameters(args) + assert p.name == 'foo' + assert p.parent == '/Common/parent' + assert p.ip == '10.10.10.10' + assert p.type == 'tcp_echo' + assert p.destination == '10.10.10.10' + assert p.interval == 20 + assert p.timeout == 30 + assert p.time_until_up == 60 + + def test_api_parameters(self): + args = dict( + name='foo', + defaultsFrom='/Common/parent', + destination='10.10.10.10', + interval=20, + timeout=30, + timeUntilUp=60 + ) + + p = Parameters(args) + assert p.name == 'foo' + assert p.parent == '/Common/parent' + assert p.ip == '10.10.10.10' + assert p.type == 'tcp_echo' + assert p.destination == '10.10.10.10' + assert p.interval == 20 + assert p.timeout == 30 + assert p.time_until_up == 60 + + +@patch('ansible.module_utils.f5_utils.AnsibleF5Client._get_mgmt_root', + return_value=True) +class TestManagerEcho(unittest.TestCase): + + def setUp(self): + self.spec = ArgumentSpec() + + def test_create_monitor(self, *args): + set_module_args(dict( + name='foo', + ip='10.10.10.10', + interval=20, + timeout=30, + time_until_up=60, + 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.create_on_device = Mock(return_value=True) + + results = mm.exec_module() + + assert results['changed'] is True + + def test_create_monitor_idempotent(self, *args): + set_module_args(dict( + name='foo', + ip='10.10.10.10', + interval=20, + timeout=30, + time_until_up=60, + server='localhost', + password='password', + user='admin' + )) + + current = Parameters(load_fixture('load_ltm_monitor_tcp_echo.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_interval(self, *args): + set_module_args(dict( + name='foo', + interval=10, + server='localhost', + password='password', + user='admin' + )) + + current = Parameters(load_fixture('load_ltm_monitor_tcp_echo.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['interval'] == 10 + + def test_update_interval_larger_than_existing_timeout(self, *args): + set_module_args(dict( + name='foo', + interval=30, + server='localhost', + password='password', + user='admin' + )) + + current = Parameters(load_fixture('load_ltm_monitor_tcp_echo.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) + + with pytest.raises(F5ModuleError) as ex: + mm.exec_module() + + assert "must be less than" in str(ex) + + def test_update_interval_larger_than_new_timeout(self, *args): + set_module_args(dict( + name='foo', + interval=10, + timeout=5, + server='localhost', + password='password', + user='admin' + )) + + current = Parameters(load_fixture('load_ltm_monitor_tcp_echo.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) + + with pytest.raises(F5ModuleError) as ex: + mm.exec_module() + + assert "must be less than" in str(ex) + + def test_update_timeout(self, *args): + set_module_args(dict( + name='foo', + timeout=300, + server='localhost', + password='password', + user='admin' + )) + + current = Parameters(load_fixture('load_ltm_monitor_tcp_echo.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['timeout'] == 300 + + def test_update_time_until_up(self, *args): + set_module_args(dict( + name='foo', + time_until_up=300, + server='localhost', + password='password', + user='admin' + )) + + current = Parameters(load_fixture('load_ltm_monitor_tcp_echo.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['time_until_up'] == 300