From 5b9f40ec1a13ef0e4e0e2a49ca9f70254216d1c3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miguel=20Angel=20Mu=C3=B1oz=20Gonz=C3=A1lez?= Date: Fri, 23 Aug 2019 07:13:18 +0200 Subject: [PATCH] Fortinet's new module for fortios_web_proxy_url_match (#61153) --- .../fortios/fortios_web_proxy_url_match.py | 348 ++++++++++++++++++ .../test_fortios_web_proxy_url_match.py | 249 +++++++++++++ 2 files changed, 597 insertions(+) create mode 100644 lib/ansible/modules/network/fortios/fortios_web_proxy_url_match.py create mode 100644 test/units/modules/network/fortios/test_fortios_web_proxy_url_match.py diff --git a/lib/ansible/modules/network/fortios/fortios_web_proxy_url_match.py b/lib/ansible/modules/network/fortios/fortios_web_proxy_url_match.py new file mode 100644 index 00000000000..b4510e96c97 --- /dev/null +++ b/lib/ansible/modules/network/fortios/fortios_web_proxy_url_match.py @@ -0,0 +1,348 @@ +#!/usr/bin/python +from __future__ import (absolute_import, division, print_function) +# Copyright 2019 Fortinet, Inc. +# +# This program 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. +# +# This program 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 this program. If not, see . + +__metaclass__ = type + +ANSIBLE_METADATA = {'status': ['preview'], + 'supported_by': 'community', + 'metadata_version': '1.1'} + +DOCUMENTATION = ''' +--- +module: fortios_web_proxy_url_match +short_description: Exempt URLs from web proxy forwarding and caching in Fortinet's FortiOS and FortiGate. +description: + - This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the + user to set and modify web_proxy feature and url_match category. + Examples include all parameters and values need to be adjusted to datasources before usage. + Tested with FOS v6.0.5 +version_added: "2.9" +author: + - Miguel Angel Munoz (@mamunozgonzalez) + - Nicolas Thomas (@thomnico) +notes: + - Requires fortiosapi library developed by Fortinet + - Run as a local_action in your playbook +requirements: + - fortiosapi>=0.9.8 +options: + host: + description: + - FortiOS or FortiGate IP address. + type: str + required: false + username: + description: + - FortiOS or FortiGate username. + type: str + required: false + password: + description: + - FortiOS or FortiGate password. + type: str + default: "" + vdom: + description: + - Virtual domain, among those defined previously. A vdom is a + virtual instance of the FortiGate that can be configured and + used as a different unit. + type: str + default: root + https: + description: + - Indicates if the requests towards FortiGate must use HTTPS protocol. + type: bool + default: true + ssl_verify: + description: + - Ensures FortiGate certificate must be verified by a proper CA. + type: bool + default: true + state: + description: + - Indicates whether to create or remove the object. + type: str + required: true + choices: + - present + - absent + web_proxy_url_match: + description: + - Exempt URLs from web proxy forwarding and caching. + default: null + type: dict + suboptions: + cache_exemption: + description: + - Enable/disable exempting this URL pattern from caching. + type: str + choices: + - enable + - disable + comment: + description: + - Comment. + type: str + forward_server: + description: + - Forward server name. Source web-proxy.forward-server.name web-proxy.forward-server-group.name. + type: str + name: + description: + - Configure a name for the URL to be exempted. + required: true + type: str + status: + description: + - Enable/disable exempting the URLs matching the URL pattern from web proxy forwarding and caching. + type: str + choices: + - enable + - disable + url_pattern: + description: + - URL pattern to be exempted from web proxy forwarding and caching. + type: str +''' + +EXAMPLES = ''' +- hosts: localhost + vars: + host: "192.168.122.40" + username: "admin" + password: "" + vdom: "root" + ssl_verify: "False" + tasks: + - name: Exempt URLs from web proxy forwarding and caching. + fortios_web_proxy_url_match: + host: "{{ host }}" + username: "{{ username }}" + password: "{{ password }}" + vdom: "{{ vdom }}" + https: "False" + state: "present" + web_proxy_url_match: + cache_exemption: "enable" + comment: "Comment." + forward_server: " (source web-proxy.forward-server.name web-proxy.forward-server-group.name)" + name: "default_name_6" + status: "enable" + url_pattern: "" +''' + +RETURN = ''' +build: + description: Build number of the fortigate image + returned: always + type: str + sample: '1547' +http_method: + description: Last method used to provision the content into FortiGate + returned: always + type: str + sample: 'PUT' +http_status: + description: Last result given by FortiGate on last operation applied + returned: always + type: str + sample: "200" +mkey: + description: Master key (id) used in the last call to FortiGate + returned: success + type: str + sample: "id" +name: + description: Name of the table used to fulfill the request + returned: always + type: str + sample: "urlfilter" +path: + description: Path of the table used to fulfill the request + returned: always + type: str + sample: "webfilter" +revision: + description: Internal revision number + returned: always + type: str + sample: "17.0.2.10658" +serial: + description: Serial number of the unit + returned: always + type: str + sample: "FGVMEVYYQT3AB5352" +status: + description: Indication of the operation's result + returned: always + type: str + sample: "success" +vdom: + description: Virtual domain used + returned: always + type: str + sample: "root" +version: + description: Version of the FortiGate + returned: always + type: str + sample: "v5.6.3" + +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible.module_utils.connection import Connection +from ansible.module_utils.network.fortios.fortios import FortiOSHandler +from ansible.module_utils.network.fortimanager.common import FAIL_SOCKET_MSG + + +def login(data, fos): + host = data['host'] + username = data['username'] + password = data['password'] + ssl_verify = data['ssl_verify'] + + fos.debug('on') + if 'https' in data and not data['https']: + fos.https('off') + else: + fos.https('on') + + fos.login(host, username, password, verify=ssl_verify) + + +def filter_web_proxy_url_match_data(json): + option_list = ['cache_exemption', 'comment', 'forward_server', + 'name', 'status', 'url_pattern'] + dictionary = {} + + for attribute in option_list: + if attribute in json and json[attribute] is not None: + dictionary[attribute] = json[attribute] + + return dictionary + + +def underscore_to_hyphen(data): + if isinstance(data, list): + for elem in data: + elem = underscore_to_hyphen(elem) + elif isinstance(data, dict): + new_data = {} + for k, v in data.items(): + new_data[k.replace('_', '-')] = underscore_to_hyphen(v) + data = new_data + + return data + + +def web_proxy_url_match(data, fos): + vdom = data['vdom'] + state = data['state'] + web_proxy_url_match_data = data['web_proxy_url_match'] + filtered_data = underscore_to_hyphen(filter_web_proxy_url_match_data(web_proxy_url_match_data)) + + if state == "present": + return fos.set('web-proxy', + 'url-match', + data=filtered_data, + vdom=vdom) + + elif state == "absent": + return fos.delete('web-proxy', + 'url-match', + mkey=filtered_data['name'], + vdom=vdom) + + +def is_successful_status(status): + return status['status'] == "success" or \ + status['http_method'] == "DELETE" and status['http_status'] == 404 + + +def fortios_web_proxy(data, fos): + + if data['web_proxy_url_match']: + resp = web_proxy_url_match(data, fos) + + return not is_successful_status(resp), \ + resp['status'] == "success", \ + resp + + +def main(): + fields = { + "host": {"required": False, "type": "str"}, + "username": {"required": False, "type": "str"}, + "password": {"required": False, "type": "str", "default": "", "no_log": True}, + "vdom": {"required": False, "type": "str", "default": "root"}, + "https": {"required": False, "type": "bool", "default": True}, + "ssl_verify": {"required": False, "type": "bool", "default": True}, + "state": {"required": True, "type": "str", + "choices": ["present", "absent"]}, + "web_proxy_url_match": { + "required": False, "type": "dict", "default": None, + "options": { + "cache_exemption": {"required": False, "type": "str", + "choices": ["enable", "disable"]}, + "comment": {"required": False, "type": "str"}, + "forward_server": {"required": False, "type": "str"}, + "name": {"required": True, "type": "str"}, + "status": {"required": False, "type": "str", + "choices": ["enable", "disable"]}, + "url_pattern": {"required": False, "type": "str"} + + } + } + } + + module = AnsibleModule(argument_spec=fields, + supports_check_mode=False) + + # legacy_mode refers to using fortiosapi instead of HTTPAPI + legacy_mode = 'host' in module.params and module.params['host'] is not None and \ + 'username' in module.params and module.params['username'] is not None and \ + 'password' in module.params and module.params['password'] is not None + + if not legacy_mode: + if module._socket_path: + connection = Connection(module._socket_path) + fos = FortiOSHandler(connection) + + is_error, has_changed, result = fortios_web_proxy(module.params, fos) + else: + module.fail_json(**FAIL_SOCKET_MSG) + else: + try: + from fortiosapi import FortiOSAPI + except ImportError: + module.fail_json(msg="fortiosapi module is required") + + fos = FortiOSAPI() + + login(module.params, fos) + is_error, has_changed, result = fortios_web_proxy(module.params, fos) + fos.logout() + + if not is_error: + module.exit_json(changed=has_changed, meta=result) + else: + module.fail_json(msg="Error in repo", meta=result) + + +if __name__ == '__main__': + main() diff --git a/test/units/modules/network/fortios/test_fortios_web_proxy_url_match.py b/test/units/modules/network/fortios/test_fortios_web_proxy_url_match.py new file mode 100644 index 00000000000..c3f6a666723 --- /dev/null +++ b/test/units/modules/network/fortios/test_fortios_web_proxy_url_match.py @@ -0,0 +1,249 @@ +# Copyright 2019 Fortinet, Inc. +# +# This program 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. +# +# This program 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 . + +# Make coding more python3-ish +from __future__ import (absolute_import, division, print_function) +__metaclass__ = type + +import os +import json +import pytest +from mock import ANY +from ansible.module_utils.network.fortios.fortios import FortiOSHandler + +try: + from ansible.modules.network.fortios import fortios_web_proxy_url_match +except ImportError: + pytest.skip("Could not load required modules for testing", allow_module_level=True) + + +@pytest.fixture(autouse=True) +def connection_mock(mocker): + connection_class_mock = mocker.patch('ansible.modules.network.fortios.fortios_web_proxy_url_match.Connection') + return connection_class_mock + + +fos_instance = FortiOSHandler(connection_mock) + + +def test_web_proxy_url_match_creation(mocker): + schema_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.schema') + + set_method_result = {'status': 'success', 'http_method': 'POST', 'http_status': 200} + set_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.set', return_value=set_method_result) + + input_data = { + 'username': 'admin', + 'state': 'present', + 'web_proxy_url_match': { + 'cache_exemption': 'enable', + 'comment': 'Comment.', + 'forward_server': 'test_value_5', + 'name': 'default_name_6', + 'status': 'enable', + 'url_pattern': 'test_value_8' + }, + 'vdom': 'root'} + + is_error, changed, response = fortios_web_proxy_url_match.fortios_web_proxy(input_data, fos_instance) + + expected_data = { + 'cache-exemption': 'enable', + 'comment': 'Comment.', + 'forward-server': 'test_value_5', + 'name': 'default_name_6', + 'status': 'enable', + 'url-pattern': 'test_value_8' + } + + set_method_mock.assert_called_with('web-proxy', 'url-match', data=expected_data, vdom='root') + schema_method_mock.assert_not_called() + assert not is_error + assert changed + assert response['status'] == 'success' + assert response['http_status'] == 200 + + +def test_web_proxy_url_match_creation_fails(mocker): + schema_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.schema') + + set_method_result = {'status': 'error', 'http_method': 'POST', 'http_status': 500} + set_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.set', return_value=set_method_result) + + input_data = { + 'username': 'admin', + 'state': 'present', + 'web_proxy_url_match': { + 'cache_exemption': 'enable', + 'comment': 'Comment.', + 'forward_server': 'test_value_5', + 'name': 'default_name_6', + 'status': 'enable', + 'url_pattern': 'test_value_8' + }, + 'vdom': 'root'} + + is_error, changed, response = fortios_web_proxy_url_match.fortios_web_proxy(input_data, fos_instance) + + expected_data = { + 'cache-exemption': 'enable', + 'comment': 'Comment.', + 'forward-server': 'test_value_5', + 'name': 'default_name_6', + 'status': 'enable', + 'url-pattern': 'test_value_8' + } + + set_method_mock.assert_called_with('web-proxy', 'url-match', data=expected_data, vdom='root') + schema_method_mock.assert_not_called() + assert is_error + assert not changed + assert response['status'] == 'error' + assert response['http_status'] == 500 + + +def test_web_proxy_url_match_removal(mocker): + schema_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.schema') + + delete_method_result = {'status': 'success', 'http_method': 'POST', 'http_status': 200} + delete_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.delete', return_value=delete_method_result) + + input_data = { + 'username': 'admin', + 'state': 'absent', + 'web_proxy_url_match': { + 'cache_exemption': 'enable', + 'comment': 'Comment.', + 'forward_server': 'test_value_5', + 'name': 'default_name_6', + 'status': 'enable', + 'url_pattern': 'test_value_8' + }, + 'vdom': 'root'} + + is_error, changed, response = fortios_web_proxy_url_match.fortios_web_proxy(input_data, fos_instance) + + delete_method_mock.assert_called_with('web-proxy', 'url-match', mkey=ANY, vdom='root') + schema_method_mock.assert_not_called() + assert not is_error + assert changed + assert response['status'] == 'success' + assert response['http_status'] == 200 + + +def test_web_proxy_url_match_deletion_fails(mocker): + schema_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.schema') + + delete_method_result = {'status': 'error', 'http_method': 'POST', 'http_status': 500} + delete_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.delete', return_value=delete_method_result) + + input_data = { + 'username': 'admin', + 'state': 'absent', + 'web_proxy_url_match': { + 'cache_exemption': 'enable', + 'comment': 'Comment.', + 'forward_server': 'test_value_5', + 'name': 'default_name_6', + 'status': 'enable', + 'url_pattern': 'test_value_8' + }, + 'vdom': 'root'} + + is_error, changed, response = fortios_web_proxy_url_match.fortios_web_proxy(input_data, fos_instance) + + delete_method_mock.assert_called_with('web-proxy', 'url-match', mkey=ANY, vdom='root') + schema_method_mock.assert_not_called() + assert is_error + assert not changed + assert response['status'] == 'error' + assert response['http_status'] == 500 + + +def test_web_proxy_url_match_idempotent(mocker): + schema_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.schema') + + set_method_result = {'status': 'error', 'http_method': 'DELETE', 'http_status': 404} + set_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.set', return_value=set_method_result) + + input_data = { + 'username': 'admin', + 'state': 'present', + 'web_proxy_url_match': { + 'cache_exemption': 'enable', + 'comment': 'Comment.', + 'forward_server': 'test_value_5', + 'name': 'default_name_6', + 'status': 'enable', + 'url_pattern': 'test_value_8' + }, + 'vdom': 'root'} + + is_error, changed, response = fortios_web_proxy_url_match.fortios_web_proxy(input_data, fos_instance) + + expected_data = { + 'cache-exemption': 'enable', + 'comment': 'Comment.', + 'forward-server': 'test_value_5', + 'name': 'default_name_6', + 'status': 'enable', + 'url-pattern': 'test_value_8' + } + + set_method_mock.assert_called_with('web-proxy', 'url-match', data=expected_data, vdom='root') + schema_method_mock.assert_not_called() + assert not is_error + assert not changed + assert response['status'] == 'error' + assert response['http_status'] == 404 + + +def test_web_proxy_url_match_filter_foreign_attributes(mocker): + schema_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.schema') + + set_method_result = {'status': 'success', 'http_method': 'POST', 'http_status': 200} + set_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.set', return_value=set_method_result) + + input_data = { + 'username': 'admin', + 'state': 'present', + 'web_proxy_url_match': { + 'random_attribute_not_valid': 'tag', + 'cache_exemption': 'enable', + 'comment': 'Comment.', + 'forward_server': 'test_value_5', + 'name': 'default_name_6', + 'status': 'enable', + 'url_pattern': 'test_value_8' + }, + 'vdom': 'root'} + + is_error, changed, response = fortios_web_proxy_url_match.fortios_web_proxy(input_data, fos_instance) + + expected_data = { + 'cache-exemption': 'enable', + 'comment': 'Comment.', + 'forward-server': 'test_value_5', + 'name': 'default_name_6', + 'status': 'enable', + 'url-pattern': 'test_value_8' + } + + set_method_mock.assert_called_with('web-proxy', 'url-match', data=expected_data, vdom='root') + schema_method_mock.assert_not_called() + assert not is_error + assert changed + assert response['status'] == 'success' + assert response['http_status'] == 200