From 7b97abf6a25b88caf66195af78db9190bf2228dc Mon Sep 17 00:00:00 2001 From: Wojciech Wypior Date: Wed, 7 Aug 2019 14:44:57 +0100 Subject: [PATCH] adds apm module to manage network access components for APM (#59993) --- .../network/f5/bigip_apm_network_access.py | 1032 +++++++++++++++++ .../f5/fixtures/load_apm_network_access.json | 98 ++ .../f5/test_bigip_apm_network_access.py | 211 ++++ 3 files changed, 1341 insertions(+) create mode 100644 lib/ansible/modules/network/f5/bigip_apm_network_access.py create mode 100644 test/units/modules/network/f5/fixtures/load_apm_network_access.json create mode 100644 test/units/modules/network/f5/test_bigip_apm_network_access.py diff --git a/lib/ansible/modules/network/f5/bigip_apm_network_access.py b/lib/ansible/modules/network/f5/bigip_apm_network_access.py new file mode 100644 index 00000000000..b19b5a01026 --- /dev/null +++ b/lib/ansible/modules/network/f5/bigip_apm_network_access.py @@ -0,0 +1,1032 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# +# Copyright: (c) 2019, F5 Networks Inc. +# 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 +__metaclass__ = type + + +ANSIBLE_METADATA = {'metadata_version': '1.1', + 'status': ['preview'], + 'supported_by': 'certified'} + +DOCUMENTATION = r''' +--- +module: bigip_apm_network_access +short_description: Manage APM Network Access resource +description: + - Manage APM Network Access resource. +version_added: 2.9 +options: + name: + description: + - Specifies the name of the APM network access to manage/create. + type: str + required: True + description: + description: + - User created network access description. + type: str + ip_version: + description: + - Supported IP version on the network access resource. + type: str + choices: + - ipv4 + - ipv4-ipv6 + allow_local_subnet: + description: + - Enables local subnet access and local access to any host or subnet in routes specified in the client routing + table. + - When C(yes) the system does not support integrated IP filtering. + type: bool + allow_local_dns: + description: + - Enables local access to DNS servers configured on client prior to establishing network access connection. + type: bool + split_tunnel: + description: + - Specifies that only the traffic targeted to a specified address space is sent over the network access tunnel. + type: bool + snat_pool: + description: + - Specifies the name of a SNAT pool used for implementing selective and intelligent SNATs. + - When C(none) the system uses no SNAT pool for this network resource. + - When C(automap) the system uses all of the self IP addresses as the translation addresses for the pool. + type: str + dtls: + description: + - When C(yes) the network access connection uses Datagram Transport Level Security instead of TCP, + to provide better throughput for high demand applications like VoIP or streaming video. + type: bool + dtls_port: + description: + - Specifies the port number that the network access resource uses for secure UDP traffic with DTLS. + type: int + ipv4_lease_pool: + description: + - Specifies IPV4 lease pool resource to use with network access. + - Referencing lease pool can be done in the full path format for example, C(/Common/pool_name). + - When lease pool is referenced in full path format, the C(partition) parameter is ignored. + type: str + ipv6_lease_pool: + description: + - Specifies IPV6 lease pool resource to use with network access. + - Referencing lease pool can be done in the full path format for example, C(/Common/pool_name). + - When lease pool is referenced in full path format, the C(partition) parameter is ignored. + type: str + excluded_ipv6_adresses: + description: + - Specifies IPV6 address spaces for which traffic is not forced through the tunnel. + type: list + suboptions: + subnet: + description: + - "The address of subnet in CIDR format, e.g. C(2001:db8:abcd:8000::/52)" + - Host addresses can be specified without the CIDR mask notation. + type: str + excluded_ipv4_adresses: + description: + - Specifies IPV4 address spaces for which traffic is not forced through the tunnel. + type: list + suboptions: + subnet: + description: + - "The address of subnet in CIDR format, e.g. C(192.168.1.0/24)" + - Host addresses can be specified without the CIDR mask notation. + type: str + excluded_dns_addresses: + description: + - Specifies the DNS address spaces for which traffic is not forced through the tunnel. + type: list + dns_address_space: + description: + - Specifies a list of domain names describing the target LAN DNS addresses. + type: list + ipv4_address_space: + description: + - Specifies a list of IPv4 hosts or networks describing the target LAN. + - This option is mandatory when creating a new resource and C(split_tunnel) is set to C(yes). + type: list + suboptions: + subnet: + description: + - "The address of subnet in CIDR format, e.g. C(192.168.1.0/24)" + - Host addresses can be specified without the CIDR mask notation. + type: str + ipv6_address_space: + description: + - Specifies a list of IPv6 hosts or networks describing the target LAN. + - This option is mandatory when creating a new resource and C(split_tunnel) is set to C(yes). + type: list + suboptions: + subnet: + description: + - "The address of subnet in CIDR format, e.g. C(2001:db8:abcd:8000::/52)" + - Host addresses can be specified without the CIDR mask notation. + type: str + partition: + description: + - Device partition to manage resources on. + type: str + default: Common + state: + description: + - When C(state) is C(present), ensures that the ACL exists. + - When C(state) is C(absent), ensures that the ACL is removed. + type: str + choices: + - present + - absent + default: present +extends_documentation_fragment: f5 +author: + - Wojciech Wypior (@wojtek0806) +''' + +EXAMPLES = r''' +- name: Create a split tunnel IPV4 Network Access + bigip_apm_network_access: + name: foobar + ip_version: ipv4 + split_tunnel: yes + snat_pool: "none" + ipv4_lease_pool: leasefoo + ipv4_address_space: + - subnet: 10.10.1.1 + - subnet: 10.10.2.0/24 + excluded_ipv4_adresses: + - subnet: 192.168.1.0/24 + provider: + password: secret + server: lb.mydomain.com + user: admin + delegate_to: localhost + +- name: Modify a split tunnel IPV4 Network Access + bigip_apm_network_access: + name: foobar + snat_pool: /Common/poolsnat + ipv4_address_space: + - subnet: 172.16.23.0/24 + excluded_ipv4_adresses: + - subnet: 10.10.2.0/24 + allow_local_subnet: yes + allow_local_dns: yes + provider: + password: secret + server: lb.mydomain.com + user: admin + delegate_to: localhost + +- name: Remove Network Access + bigip_apm_network_access: + name: foobar + state: absent + provider: + password: secret + server: lb.mydomain.com + user: admin + delegate_to: localhost +''' + +RETURN = r''' +description: + description: The new description of Network Access. + returned: changed + type: str + sample: My Access +ip_version: + description: Supported IP version on the network access resource. + returned: changed + type: str + sample: ipv4-ipv6 +allow_local_subnet: + description: Enables local subnet access. + returned: changed + type: bool + sample: yes +allow_local_dns: + description: Enables local access to DNS servers configured on client. + returned: changed + type: bool + sample: yes +split_tunnel: + description: Enables split tunnel on network access resource. + returned: changed + type: bool + sample: yes +snat_pool: + description: The name of a SNAT pool used by network access resource. + returned: changed + type: str + sample: /Common/my-pool +dtls: + description: Enables use of DTLS by network access. + returned: changed + type: bool + sample: no +dtls_port: + description: Specifies the port number that the network access resource uses for DTLS. + returned: changed + type: int + sample: 4433 +ipv4_lease_pool: + description: Specifies IPV4 lease pool resource to use with network access. + returned: changed + type: str + sample: /Common/leasepoolv4 +ipv6_lease_pool: + description: Specifies IPV6 lease pool resource to use with network access. + returned: changed + type: str + sample: /Common/leasepoolv6 +excluded_ipv6_adresses: + description: Specifies IPV6 address spaces for which traffic is not forced through the tunnel. + type: complex + returned: changed + contains: + subnet: + description: The host or network address. + returned: changed + type: str + sample: "2001:DB8:ABCD:0012::0" + sample: hash/dictionary of values +excluded_ipv4_adresses: + description: Specifies IPV4 address spaces for which traffic is not forced through the tunnel. + type: complex + returned: changed + contains: + subnet: + description: The host or network address. + returned: changed + type: str + sample: 192.168.10.1 + sample: hash/dictionary of values +excluded_dns_addresses: + description: Specifies the DNS address spaces for which traffic is not forced through the tunnel. + returned: changed + type: list + sample: ['foobar.com', 'bazbar.org'] +dns_address_space: + description: Specifies a list of domain names describing the target LAN DNS addresses. + returned: changed + type: list + sample: ['internal.net', '*.engnet.org'] +ipv6_address_space: + description: Specifies a list of IPv6 hosts or networks describing the target LAN. + type: complex + returned: changed + contains: + subnet: + description: The host or network address. + returned: changed + type: str + sample: "2001:DB8:ABCD:0012::0" + sample: hash/dictionary of values +ipv4_address_space: + description: Specifies a list of IPv4 hosts or networks describing the target LAN. + type: complex + returned: changed + contains: + subnet: + description: The host or network address. + returned: changed + type: str + sample: 192.168.10.1 + sample: hash/dictionary of values +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible.module_utils.basic import env_fallback + +try: + from library.module_utils.network.f5.bigip import F5RestClient + 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 fq_name + from library.module_utils.network.f5.common import transform_name + from library.module_utils.network.f5.common import f5_argument_spec + from library.module_utils.network.f5.common import flatten_boolean + from library.module_utils.network.f5.common import is_empty_list + from library.module_utils.network.f5.compare import cmp_str_with_none + from library.module_utils.network.f5.compare import cmp_simple_list + from library.module_utils.network.f5.compare import compare_complex_list + from library.module_utils.network.f5.ipaddress import ip_network + from library.module_utils.network.f5.ipaddress import is_valid_ip + from library.module_utils.network.f5.ipaddress import is_valid_ip_network +except ImportError: + from ansible.module_utils.network.f5.bigip import F5RestClient + 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 fq_name + from ansible.module_utils.network.f5.common import transform_name + from ansible.module_utils.network.f5.common import f5_argument_spec + from ansible.module_utils.network.f5.common import flatten_boolean + from ansible.module_utils.network.f5.common import is_empty_list + from ansible.module_utils.network.f5.compare import cmp_str_with_none + from ansible.module_utils.network.f5.compare import cmp_simple_list + from ansible.module_utils.network.f5.compare import compare_complex_list + from ansible.module_utils.network.f5.ipaddress import ip_network + from ansible.module_utils.network.f5.ipaddress import is_valid_ip + from ansible.module_utils.network.f5.ipaddress import is_valid_ip_network + + +class Parameters(AnsibleF5Parameters): + api_map = { + 'supportedIpVersion': 'ip_version', + 'splitTunneling': 'split_tunnel', + 'addressSpaceLocalSubnetsExcluded': 'allow_local_subnet', + 'addressSpaceLocDnsServersExcluded': 'allow_local_dns', + 'dtlsPort': 'dtls_port', + 'leasepoolName': 'ipv4_lease_pool', + 'ipv6LeasepoolName': 'ipv6_lease_pool', + 'ipv6AddressSpaceExcludeSubnet': 'excluded_ipv6_adresses', + 'addressSpaceExcludeSubnet': 'excluded_ipv4_adresses', + 'addressSpaceExcludeDnsName': 'excluded_dns_addresses', + 'addressSpaceIncludeDnsName': 'dns_address_space', + 'addressSpaceIncludeSubnet': 'ipv4_address_space', + 'ipv6AddressSpaceIncludeSubnet': 'ipv6_address_space', + 'snatpool': 'snat_pool', + } + + api_attributes = [ + 'supportedIpVersion', + 'splitTunneling', + 'addressSpaceLocalSubnetsExcluded', + 'addressSpaceLocDnsServersExcluded', + 'dtlsPort', + 'leasepoolName', + 'ipv6LeasepoolName', + 'ipv6AddressSpaceExcludeSubnet', + 'addressSpaceExcludeSubnet', + 'addressSpaceExcludeDnsName', + 'addressSpaceIncludeSubnet', + 'ipv6AddressSpaceIncludeSubnet', + 'addressSpaceIncludeDnsName', + 'snat', + 'snatpool', + 'dtls', + 'description', + ] + + returnables = [ + 'description', + 'ip_version', + 'split_tunnel', + 'allow_local_subnet', + 'allow_local_dns', + 'snat_pool', + 'dtls', + 'dtls_port', + 'ipv4_lease_pool', + 'ipv6_lease_pool', + 'excluded_ipv6_adresses', + 'excluded_ipv4_adresses', + 'excluded_dns_addresses', + 'dns_address_space', + 'ipv4_address_space', + 'ipv6_address_space', + ] + + updatables = [ + 'description', + 'ip_version', + 'split_tunnel', + 'allow_local_subnet', + 'allow_local_dns', + 'snat_pool', + 'dtls', + 'dtls_port', + 'ipv4_lease_pool', + 'ipv6_lease_pool', + 'excluded_ipv6_adresses', + 'excluded_ipv4_adresses', + 'excluded_dns_addresses', + 'dns_address_space', + 'ipv4_address_space', + 'ipv6_address_space', + ] + + +class ApiParameters(Parameters): + @property + def snat_pool(self): + if self._values['snat'] is None and self._values['snat_pool'] is None: + return None + if self._values['snat'] in ['automap', 'none']: + return self._values['snat'] + return self._values['snat_pool'] + + +class ModuleParameters(Parameters): + def _handle_booleans(self, item): + result = flatten_boolean(item) + if result == 'yes': + return 'true' + if result == 'no': + return 'false' + return None + + def _convert_address(self, item): + ip = ip_network(u'{0}'.format(item)) + return ip.with_prefixlen + + def _format_subnets(self, items): + result = [] + for x in items: + to_change = dict() + to_change['subnet'] = self._convert_address(x['subnet']) + result.append(to_change) + return result + + @property + def description(self): + if self._values['description'] is None: + return None + if self._values['description'] in ['none', '']: + return '' + return self._values['description'] + + @property + def split_tunnel(self): + return self._handle_booleans(self._values['split_tunnel']) + + @property + def allow_local_subnet(self): + return self._handle_booleans(self._values['allow_local_subnet']) + + @property + def allow_local_dns(self): + return self._handle_booleans(self._values['allow_local_dns']) + + @property + def dtls(self): + return self._handle_booleans(self._values['dtls']) + + @property + def dtls_port(self): + if self._values['dtls_port'] is None: + return None + if 0 < self._values['dtls_port'] > 65535: + raise F5ModuleError( + "Specified port number is out of valid range, correct range is between 0 and 65535." + ) + return self._values['dtls_port'] + + @property + def ipv4_lease_pool(self): + if self._values['ipv4_lease_pool'] is None: + return None + if self._values['ipv4_lease_pool'] in ['none', '']: + return '' + return fq_name(self.partition, self._values['ipv4_lease_pool']) + + @property + def ipv6_lease_pool(self): + if self._values['ipv6_lease_pool'] is None: + return None + if self._values['ipv6_lease_pool'] in ['none', '']: + return '' + return fq_name(self.partition, self._values['ipv6_lease_pool']) + + @property + def excluded_ipv6_adresses(self): + if self._values['excluded_ipv6_adresses'] is None: + return None + if is_empty_list(self._values['excluded_ipv6_adresses']): + return [] + result = self._format_subnets(self._values['excluded_ipv6_adresses']) + return result + + @property + def excluded_ipv4_adresses(self): + if self._values['excluded_ipv4_adresses'] is None: + return None + if is_empty_list(self._values['excluded_ipv4_adresses']): + return [] + result = self._format_subnets(self._values['excluded_ipv4_adresses']) + return result + + @property + def ipv4_address_space(self): + if self._values['ipv4_address_space'] is None: + return None + if is_empty_list(self._values['ipv4_address_space']): + return [] + result = self._format_subnets(self._values['ipv4_address_space']) + return result + + @property + def ipv6_address_space(self): + if self._values['ipv6_address_space'] is None: + return None + if is_empty_list(self._values['ipv6_address_space']): + return [] + result = self._format_subnets(self._values['ipv6_address_space']) + return result + + @property + def dns_address_space(self): + if self._values['dns_address_space'] is None: + return None + if is_empty_list(self._values['dns_address_space']): + return [] + return self._values['dns_address_space'] + + @property + def excluded_dns_addresses(self): + if self._values['excluded_dns_addresses'] is None: + return None + if is_empty_list(self._values['excluded_dns_addresses']): + return [] + return self._values['excluded_dns_addresses'] + + @property + def snat_pool(self): + if self._values['snat_pool'] is None: + return None + if self._values['snat_pool'] in ['automap', 'none']: + return self._values['snat_pool'] + result = fq_name(self.partition, self._values['snat_pool']) + return result + + +class Changes(Parameters): + def to_return(self): + result = {} + try: + for returnable in self.returnables: + result[returnable] = getattr(self, returnable) + result = self._filter_params(result) + except Exception: + pass + return result + + +class UsableChanges(Changes): + @property + def snat(self): + if self._values['snat_pool'] is None: + return None + if self._values['snat_pool'] in ['automap', 'none']: + return self._values['snat_pool'] + + @property + def snat_pool(self): + if self._values['snat_pool'] in [None, 'automap', 'none']: + return None + return self._values['snat_pool'] + + +class ReportableChanges(Changes): + def _parse_hosts(self, item): + ip = ip_network(u'{0}'.format(item)) + if ip.prefixlen in [32, 128]: + result = item.split('/')[0] + return result + return item + + def _format_subnets(self, items): + result = [] + for x in items: + to_change = dict() + to_change['subnet'] = self._parse_hosts(x['subnet']) + result.append(to_change) + return result + + @property + def split_tunnel(self): + return flatten_boolean(self._values['split_tunnel']) + + @property + def allow_local_subnet(self): + return flatten_boolean(self._values['allow_local_subnet']) + + @property + def allow_local_dns(self): + return flatten_boolean(self._values['allow_local_dns']) + + @property + def dtls(self): + return flatten_boolean(self._values['dtls']) + + @property + def excluded_ipv4_adresses(self): + if self._values['excluded_ipv4_adresses'] is None: + return None + if not self._values['excluded_ipv4_adresses']: + return [] + result = self._format_subnets(self._values['excluded_ipv4_adresses']) + return result + + @property + def excluded_ipv6_adresses(self): + if self._values['excluded_ipv6_adresses'] is None: + return None + if not self._values['excluded_ipv6_adresses']: + return [] + result = self._format_subnets(self._values['excluded_ipv6_adresses']) + return result + + @property + def ipv4_address_space(self): + if self._values['ipv4_address_space'] is None: + return None + if not self._values['ipv4_address_space']: + return [] + result = self._format_subnets(self._values['ipv4_address_space']) + return result + + @property + def ipv6_address_space(self): + if self._values['ipv6_address_space'] is None: + return None + if not self._values['ipv6_address_space']: + return [] + result = self._format_subnets(self._values['ipv6_address_space']) + return result + + +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: + return self.__default(param) + + def __default(self, param): + attr1 = getattr(self.want, param) + try: + attr2 = getattr(self.have, param) + if attr1 != attr2: + return attr1 + except AttributeError: + return attr1 + + @property + def description(self): + result = cmp_str_with_none(self.want.description, self.have.description) + return result + + @property + def ipv4_lease_pool(self): + result = cmp_str_with_none(self.want.ipv4_lease_pool, self.have.ipv4_lease_pool) + return result + + @property + def ipv6_lease_pool(self): + result = cmp_str_with_none(self.want.ipv6_lease_pool, self.have.ipv6_lease_pool) + return result + + @property + def excluded_dns_addresses(self): + result = cmp_simple_list(self.want.excluded_dns_addresses, self.have.excluded_dns_addresses) + return result + + @property + def dns_address_space(self): + result = cmp_simple_list(self.want.dns_address_space, self.have.dns_address_space) + return result + + @property + def excluded_ipv4_adresses(self): + result = compare_complex_list(self.want.excluded_ipv4_adresses, self.have.excluded_ipv4_adresses) + return result + + @property + def excluded_ipv6_adresses(self): + result = compare_complex_list(self.want.excluded_ipv6_adresses, self.have.excluded_ipv6_adresses) + return result + + @property + def ipv4_address_space(self): + result = compare_complex_list(self.want.ipv4_address_space, self.have.ipv4_address_space) + return result + + @property + def ipv6_address_space(self): + result = compare_complex_list(self.want.ipv6_address_space, self.have.ipv6_address_space) + return result + + +class ModuleManager(object): + def __init__(self, *args, **kwargs): + self.module = kwargs.get('module', None) + self.client = F5RestClient(**self.module.params) + self.want = ModuleParameters(params=self.module.params) + self.have = ApiParameters() + self.changes = UsableChanges() + + 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 = UsableChanges(params=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: + if isinstance(change, dict): + changed.update(change) + else: + changed[k] = change + if changed: + self.changes = UsableChanges(params=changed) + return True + return False + + def _announce_deprecations(self, result): + warnings = result.pop('__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 + + if state == "present": + changed = self.present() + elif state == "absent": + changed = self.absent() + + reportable = ReportableChanges(params=self.changes.to_return()) + changes = reportable.to_return() + result.update(**changes) + result.update(dict(changed=changed)) + self._announce_deprecations(result) + return result + + def present(self): + if self.exists(): + return self.update() + else: + return self.create() + + def absent(self): + if self.exists(): + return self.remove() + return False + + 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() + self.check_required_params() + if not self.should_update(): + return False + if self.module.check_mode: + return True + self.update_on_device() + return True + + def remove(self): + if self.module.check_mode: + return True + self.remove_from_device() + if self.exists(): + raise F5ModuleError("Failed to delete the resource.") + return True + + def create(self): + self._set_changed_options() + self.check_required_params() + if self.module.check_mode: + return True + self.create_on_device() + return True + + def check_required_params(self): + if self.want.split_tunnel == 'true': + if self.want.ip_version == 'ipv4': + if self.want.ipv4_address_space in [None, []]: + raise F5ModuleError( + 'The ipv4_address_space cannot be empty, when split_tunnel is set to {0}'.format( + self.want.split_tunnel + ) + ) + if self.want.ip_version == 'ipv4-ipv6': + if self.want.ipv4_address_space in [None, []]: + raise F5ModuleError( + 'The ipv4_address_space cannot be empty, when split_tunnel is set to {0}'.format( + self.want.split_tunnel + ) + ) + if self.want.ipv6_address_space in [None, []]: + raise F5ModuleError( + 'The ipv6_address_space cannot be empty, when split_tunnel is set to {0}'.format( + self.want.split_tunnel + ) + ) + if self.have.split_tunnel == 'true': + if self.have.ip_version == 'ipv4': + if self.want.ipv4_address_space is not None and not self.want.ipv4_address_space: + raise F5ModuleError( + 'Cannot remove ipv4_address_space when split_tunnel on device is: {0}'.format( + self.have.split_tunnel + ) + ) + if self.have.ip_version == 'ipv4-ipv6': + if self.want.ipv4_address_space is not None and not self.want.ipv4_address_space: + raise F5ModuleError( + 'Cannot remove ipv4_address_space when split_tunnel on device is: {0}'.format( + self.have.split_tunnel + ) + ) + if self.want.ipv6_address_space is not None and not self.want.ipv6_address_space: + raise F5ModuleError( + 'Cannot remove ipv6_address_space when split_tunnel on device is: {0}'.format( + self.have.split_tunnel + ) + ) + + def exists(self): + uri = "https://{0}:{1}/mgmt/tm/apm/resource/network-access/{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): + params = self.changes.api_params() + params['name'] = self.want.name + params['partition'] = self.want.partition + uri = "https://{0}:{1}/mgmt/tm/apm/resource/network-access/".format( + 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, 409]: + if 'message' in response: + raise F5ModuleError(response['message']) + else: + raise F5ModuleError(resp.content) + return True + + def update_on_device(self): + params = self.changes.api_params() + uri = "https://{0}:{1}/mgmt/tm/apm/resource/network-access/{2}".format( + self.client.provider['server'], + self.client.provider['server_port'], + transform_name(self.want.partition, self.want.name) + ) + 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 remove_from_device(self): + uri = "https://{0}:{1}/mgmt/tm/apm/resource/network-access/{2}".format( + self.client.provider['server'], + self.client.provider['server_port'], + transform_name(self.want.partition, self.want.name) + ) + response = self.client.api.delete(uri) + if response.status == 200: + return True + raise F5ModuleError(response.content) + + def read_current_from_device(self): + uri = "https://{0}:{1}/mgmt/tm/apm/resource/network-access/{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 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): + def __init__(self): + self.supports_check_mode = True + argument_spec = dict( + name=dict(required=True), + ip_version=dict( + choices=['ipv4', 'ipv4-ipv6'] + ), + split_tunnel=dict( + type='bool', + ), + allow_local_subnet=dict(type='bool'), + allow_local_dns=dict(type='bool'), + snat_pool=dict(), + description=dict(), + dtls=dict(type='bool'), + dtls_port=dict(type='int'), + ipv4_lease_pool=dict(), + ipv6_lease_pool=dict(), + excluded_ipv6_adresses=dict( + type='list', + options=dict( + subnet=dict(), + ) + ), + excluded_ipv4_adresses=dict( + type='list', + options=dict( + subnet=dict(), + ) + ), + excluded_dns_addresses=dict( + type='list' + ), + dns_address_space=dict( + type='list' + ), + ipv4_address_space=dict( + type='list', + options=dict( + subnet=dict(), + ) + ), + ipv6_address_space=dict( + type='list', + options=dict( + subnet=dict(), + ) + ), + partition=dict( + default='Common', + fallback=(env_fallback, ['F5_PARTITION']) + ), + state=dict( + default='present', + choices=['present', 'absent'] + ) + ) + self.argument_spec = {} + self.argument_spec.update(f5_argument_spec) + self.argument_spec.update(argument_spec) + + +def main(): + spec = ArgumentSpec() + + module = AnsibleModule( + argument_spec=spec.argument_spec, + supports_check_mode=spec.supports_check_mode, + ) + + try: + mm = ModuleManager(module=module) + results = mm.exec_module() + module.exit_json(**results) + except F5ModuleError as ex: + module.fail_json(msg=str(ex)) + + +if __name__ == '__main__': + main() diff --git a/test/units/modules/network/f5/fixtures/load_apm_network_access.json b/test/units/modules/network/f5/fixtures/load_apm_network_access.json new file mode 100644 index 00000000000..9c8b897f730 --- /dev/null +++ b/test/units/modules/network/f5/fixtures/load_apm_network_access.json @@ -0,0 +1,98 @@ +{ + "kind": "tm:apm:resource:network-access:network-accessstate", + "name": "test", + "partition": "Common", + "fullPath": "/Common/test", + "generation": 1140, + "selfLink": "https://localhost/mgmt/tm/apm/resource/network-access/~Common~test?ver=12.1.4", + "addressSpaceDhcpRequestsExcluded": "true", + "addressSpaceExcludeDnsName": [ + "baz.com", + "bazfoo.com" + ], + "addressSpaceIncludeDnsName": [ + "foo.com", + "bar.com" + ], + "addressSpaceLocDnsServersExcluded": "true", + "addressSpaceLocalSubnetsExcluded": "true", + "addressSpaceProtect": "false", + "applicationLaunchWarning": "true", + "autoLaunch": "false", + "clientInterfaceSpeed": 100000000, + "clientIpFilterEngine": "false", + "clientPowerManagement": "ignore", + "clientProxy": "false", + "clientProxyAddress": "any6", + "clientProxyEnforceSubnets": "true", + "clientProxyIgnoreAutoConfigError": "false", + "clientProxyLocalBypass": "false", + "clientProxyPort": 0, + "clientProxyUseHttpPac": "false", + "clientProxyUseLocalProxy": "false", + "clientTrayIcon": "true", + "compression": "none", + "customizationGroup": "/Common/test_resource_network_access_customization", + "customizationGroupReference": { + "link": "https://localhost/mgmt/tm/apm/policy/customization-group/~Common~test_resource_network_access_customization?ver=12.1.4" + }, + "dnsEnforceSearchOrder": "true", + "dnsPrimary": "any6", + "dnsRegisterConnection": "false", + "dnsSecondary": "any6", + "dnsUseDnsSuffixForRegistration": "false", + "dtls": "false", + "dtlsPort": 4433, + "executeLogoffScripts": "false", + "idleTimeoutThreshold": 0, + "idleTimeoutWindow": 0, + "ipv6DnsPrimary": "any6", + "ipv6DnsSecondary": "any6", + "ipv6LeasepoolName": "/Common/ipv6lease", + "ipv6LeasepoolNameReference": { + "link": "https://localhost/mgmt/tm/apm/resource/ipv6-leasepool/~Common~ipv6lease?ver=12.1.4" + }, + "leasepoolName": "/Common/ipv4lease", + "leasepoolNameReference": { + "link": "https://localhost/mgmt/tm/apm/resource/leasepool/~Common~ipv4lease?ver=12.1.4" + }, + "locationSpecific": "true", + "microsoftNetworkClient": "true", + "microsoftNetworkServer": "false", + "networkTunnel": "enabled", + "preserveSourcePortStrict": "none", + "provideClientCert": "true", + "proxyArp": "false", + "snat": "automap", + "splitTunneling": "true", + "supportedIpVersion": "ipv4-ipv6", + "syncWithActiveDirectory": "false", + "type": "network-access", + "winsPrimary": "any6", + "winsSecondary": "any6", + "addressSpaceExcludeSubnet": [ + { + "subnet": "192.168.1.0/24" + }, + { + "subnet": "192.168.2.1/32" + } + ], + "addressSpaceIncludeSubnet": [ + { + "subnet": "10.10.10.1/32" + }, + { + "subnet": "10.11.11.0/24" + } + ], + "ipv6AddressSpaceIncludeSubnet": [ + { + "subnet": "2607:f0d0:1002:51::4/128" + } + ], + "optimizedAppReference": { + "link": "https://localhost/mgmt/tm/apm/resource/network-access/~Common~test/optimized-app?ver=12.1.4", + "isSubcollection": true + } +} diff --git a/test/units/modules/network/f5/test_bigip_apm_network_access.py b/test/units/modules/network/f5/test_bigip_apm_network_access.py new file mode 100644 index 00000000000..94e52450da0 --- /dev/null +++ b/test/units/modules/network/f5/test_bigip_apm_network_access.py @@ -0,0 +1,211 @@ +# -*- coding: utf-8 -*- +# +# Copyright: (c) 2019, F5 Networks Inc. +# 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) +__metaclass__ = type + +import os +import json +import pytest +import sys + +if sys.version_info < (2, 7): + pytestmark = pytest.mark.skip("F5 Ansible modules require Python >= 2.7") + +from ansible.module_utils.basic import AnsibleModule + +try: + from library.modules.bigip_apm_network_access import ApiParameters + from library.modules.bigip_apm_network_access import ModuleParameters + from library.modules.bigip_apm_network_access import ModuleManager + from library.modules.bigip_apm_network_access import ArgumentSpec + + # 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_apm_network_access import ApiParameters + from ansible.modules.network.f5.bigip_apm_network_access import ModuleParameters + from ansible.modules.network.f5.bigip_apm_network_access import ModuleManager + from ansible.modules.network.f5.bigip_apm_network_access import ArgumentSpec + + # 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_data = {} + + +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', + ip_version='ipv4', + split_tunnel=True, + description='foobar', + allow_local_subnet=True, + allow_local_dns=True, + snat_pool='foo_pool', + dtls=True, + dtls_port=4443, + ipv4_lease_pool='ipv4lease', + excluded_ipv4_adresses=[dict(subnet='10.10.10.1')], + ipv4_address_space=[dict(subnet='192.168.1.0/24')], + dns_address_space=['foobar.com'], + excluded_dns_addresses=['bar-foo.org'] + ) + + p = ModuleParameters(params=args) + assert p.name == 'foo' + assert p.ip_version == 'ipv4' + assert p.split_tunnel == 'true' + assert p.allow_local_subnet == 'true' + assert p.allow_local_dns == 'true' + assert p.snat_pool == '/Common/foo_pool' + assert p.description == 'foobar' + assert p.dtls == 'true' + assert p.dtls_port == 4443 + assert p.ipv4_lease_pool == '/Common/ipv4lease' + assert p.excluded_ipv4_adresses == [dict(subnet='10.10.10.1/32')] + assert p.ipv4_address_space == [dict(subnet='192.168.1.0/24')] + assert p.dns_address_space == ['foobar.com'] + assert p.excluded_dns_addresses == ['bar-foo.org'] + + def test_api_parameters(self): + args = load_fixture('load_apm_network_access.json') + + p = ApiParameters(params=args) + assert p.name == 'test' + assert p.ip_version == 'ipv4-ipv6' + assert p.split_tunnel == 'true' + assert p.allow_local_subnet == 'true' + assert p.allow_local_dns == 'true' + assert p.snat_pool == 'automap' + assert p.dtls == 'false' + assert p.dtls_port == 4433 + assert p.ipv4_lease_pool == '/Common/ipv4lease' + assert p.excluded_ipv4_adresses == [ + dict(subnet='192.168.1.0/24'), + dict(subnet='192.168.2.1/32') + ] + assert p.ipv4_address_space == [ + dict(subnet='10.10.10.1/32'), + dict(subnet='10.11.11.0/24') + ] + assert p.dns_address_space == ['foo.com', 'bar.com'] + assert p.excluded_dns_addresses == ['baz.com', 'bazfoo.com'] + assert p.ipv6_address_space == [dict(subnet="2607:f0d0:1002:51::4/128")] + + +class TestManager(unittest.TestCase): + def setUp(self): + self.spec = ArgumentSpec() + + def test_create_ipv4_net_access(self, *args): + set_module_args(dict( + name='foo', + ip_version='ipv4', + split_tunnel=True, + description='foobar', + allow_local_subnet=True, + allow_local_dns=True, + snat_pool='foo_pool', + dtls=True, + dtls_port=4443, + ipv4_lease_pool='ipv4lease', + excluded_ipv4_adresses=[dict(subnet='10.10.10.1')], + ipv4_address_space=[dict(subnet='192.168.1.0/24')], + dns_address_space=['foobar.com'], + excluded_dns_addresses=['bar-foo.org'], + provider=dict( + server='localhost', + password='password', + user='admin' + ) + )) + + 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=False) + mm.create_on_device = Mock(return_value=True) + + results = mm.exec_module() + + assert results['changed'] is True + assert results['ip_version'] == 'ipv4' + assert results['split_tunnel'] == 'yes' + assert results['allow_local_subnet'] == 'yes' + assert results['allow_local_dns'] == 'yes' + assert results['snat_pool'] == '/Common/foo_pool' + assert results['description'] == 'foobar' + assert results['dtls'] == 'yes' + assert results['dtls_port'] == 4443 + assert results['ipv4_lease_pool'] == '/Common/ipv4lease' + assert results['excluded_ipv4_adresses'] == [dict(subnet='10.10.10.1')] + assert results['ipv4_address_space'] == [dict(subnet='192.168.1.0/24')] + assert results['dns_address_space'] == ['foobar.com'] + assert results['excluded_dns_addresses'] == ['bar-foo.org'] + + def test_update_ipv4_net_access(self, *args): + set_module_args(dict( + name='test', + excluded_ipv4_adresses=[dict(subnet='10.10.10.1')], + ipv4_address_space=[dict(subnet='192.168.1.0/24')], + provider=dict( + server='localhost', + password='password', + user='admin' + ) + )) + + current = ApiParameters(params=load_fixture('load_apm_network_access.json')) + + 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.update_on_device = Mock(return_value=True) + mm.read_current_from_device = Mock(return_value=current) + + results = mm.exec_module() + + assert results['changed'] is True + assert results['excluded_ipv4_adresses'] == [dict(subnet='10.10.10.1')] + assert results['ipv4_address_space'] == [dict(subnet='192.168.1.0/24')]