From caa6ed3c669261142ea441c145a105ce2c4b84c9 Mon Sep 17 00:00:00 2001 From: Tim Rupp Date: Tue, 4 Dec 2018 11:24:34 -0800 Subject: [PATCH] Adds ASM policy fetch module (#49494) --- .../network/f5/bigip_asm_policy_fetch.py | 721 ++++++++++++++++++ .../network/f5/test_bigip_asm_policy_fetch.py | 133 ++++ 2 files changed, 854 insertions(+) create mode 100644 lib/ansible/modules/network/f5/bigip_asm_policy_fetch.py create mode 100644 test/units/modules/network/f5/test_bigip_asm_policy_fetch.py diff --git a/lib/ansible/modules/network/f5/bigip_asm_policy_fetch.py b/lib/ansible/modules/network/f5/bigip_asm_policy_fetch.py new file mode 100644 index 0000000000..b78b82ae7d --- /dev/null +++ b/lib/ansible/modules/network/f5/bigip_asm_policy_fetch.py @@ -0,0 +1,721 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# +# Copyright: (c) 2018, 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_asm_policy_fetch +short_description: Exports the asm policy from remote nodes. +description: + - Exports the asm policy from remote nodes. +version_added: 2.8 +options: + name: + description: + - The name of the policy exported to create a file on the remote device for downloading. + required: True + dest: + description: + - A directory to save the policy file into. + - Di + - This option is ignored when C(inline) is set to c(yes). + type: path + file: + description: + - The name of the file to be create on the remote device for downloading. + - When C(binary) is set to C(no) the ASM policy will be in XML format. + inline: + description: + - If C(yes), the ASM policy will be exported C(inline) as a string instead of a file. + - The policy can be be retrieved in playbook C(result) dictionary under C(inline_policy) key. + type: bool + compact: + description: + - If C(yes), only the ASM policy custom settings will be exported. + - Only applies to XML type ASM policy exports. + type: bool + base64: + description: + - If C(yes), the returned C(inline) ASM policy content will be Base64 encoded. + - Only applies to C(inline) ASM policy exports. + type: bool + binary: + description: + - If C(yes), the exported ASM policy will be in binary format. + - Only applies to C(file) ASM policy exports. + type: bool + force: + description: + - If C(no), the file will only be transferred if it does not exist in the the destination. + default: yes + type: bool + partition: + description: + - Device partition to which contain ASM policy to export. + default: Common +extends_documentation_fragment: f5 +author: + - Wojciech Wypior (@wojtek0806) +''' + +EXAMPLES = r''' +- name: Export policy in binary format + bigip_asm_policy_fetch: + name: foobar + file: export_foo + dst: /root/download + binary: yes + provider: + password: secret + server: lb.mydomain.com + user: admin + delegate_to: localhost + +- name: Export policy inline base64 encoded format + bigip_asm_policy_fetch: + name: foobar + inline: yes + base64: yes + provider: + password: secret + server: lb.mydomain.com + user: admin + delegate_to: localhost + +- name: Export policy in XML format + bigip_asm_policy_fetch: + name: foobar + file: export_foo + dst: /root/download + provider: + password: secret + server: lb.mydomain.com + user: admin + delegate_to: localhost + +- name: Export compact policy in XML format + bigip_asm_policy_fetch: + name: foobar + file: export_foo.xml + dst: /root/download/ + compact: yes + provider: + password: secret + server: lb.mydomain.com + user: admin + delegate_to: localhost + +- name: Export policy in binary format, autogenerate name + bigip_asm_policy_fetch: + name: foobar + dst: /root/download/ + binary: yes + provider: + password: secret + server: lb.mydomain.com + user: admin + delegate_to: localhost +''' + +RETURN = r''' +name: + description: Name of the ASM policy to be exported. + returned: changed + type: string + sample: Asm_APP1_Transparent +dst: + description: Local path to download exported ASM policy. + returned: changed + type: string + sample: /root/downloads/foobar.xml +file: + description: + - Name of the policy file on the remote BIG-IP to download. If not + specified, then this will be a randomly generated filename. + returned: changed + type: string + sample: foobar.xml +inline: + description: Set when ASM policy to be exported inline + returned: changed + type: bool + sample: yes +compact: + description: Set only to export custom ASM policy settings. + returned: changed + type: bool + sample: no +base64: + description: Set to encode inline export in base64 format. + returned: changed + type: bool + sample: no +binary: + description: Set to export ASM policy in binary format. + returned: changed + type: bool + sample: yes +''' + +import os +import time +import tempfile + +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 cleanup_tokens + from library.module_utils.network.f5.common import fq_name + 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 flatten_boolean + from library.module_utils.network.f5.icontrol import download_file + from library.module_utils.network.f5.icontrol import module_provisioned +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 cleanup_tokens + from ansible.module_utils.network.f5.common import fq_name + 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 flatten_boolean + from ansible.module_utils.network.f5.icontrol import download_file + from ansible.module_utils.network.f5.icontrol import module_provisioned + + +class Parameters(AnsibleF5Parameters): + api_map = { + 'filename': 'file', + 'minimal': 'compact', + 'isBase64': 'base64', + } + + api_attributes = [ + 'inline', + 'minimal', + 'isBase64', + 'policyReference', + 'filename', + ] + + returnables = [ + 'file', + 'compact', + 'base64', + 'inline', + 'force', + 'binary', + 'dest', + 'name', + 'inline_policy', + ] + + updatables = [ + + ] + + +class ApiParameters(Parameters): + pass + + +class ModuleParameters(Parameters): + def _policy_exists(self): + uri = 'https://{0}:{1}/mgmt/tm/asm/policies/'.format( + self.client.provider['server'], + self.client.provider['server_port'], + ) + query = '?$filter=name+eq+{0}+and+partition+eq+{1}&$select=name'.format(self.want.name, self.want.partition) + resp = self.client.api.get(uri + query) + try: + response = resp.json() + except ValueError as ex: + raise F5ModuleError(str(ex)) + if 'items' in response and response['items'] != []: + return True + return False + + @property + def name(self): + if self._policy_exists(): + return self._values['name'] + else: + raise F5ModuleError( + "The specified ASM policy {0} on partition {1} does not exist on device.".format( + self._values['name'], self._values['partition'] + ) + ) + + @property + def file(self): + if self._values['file'] is not None: + return self._values['file'] + if self.binary: + result = next(tempfile._get_candidate_names()) + '.plc' + else: + result = next(tempfile._get_candidate_names()) + '.xml' + self._values['file'] = result + return result + + @property + def fulldest(self): + result = None + if os.path.isdir(self.dest): + result = os.path.join(self.dest, self.file) + else: + if os.path.exists(os.path.dirname(self.dest)): + result = self.dest + else: + try: + # os.path.exists() can return false in some + # circumstances where the directory does not have + # the execute bit for the current user set, in + # which case the stat() call will raise an OSError + os.stat(os.path.dirname(result)) + except OSError as e: + if "permission denied" in str(e).lower(): + raise F5ModuleError( + "Destination directory {0} is not accessible".format(os.path.dirname(result)) + ) + raise F5ModuleError( + "Destination directory {0} does not exist".format(os.path.dirname(result)) + ) + + if not os.access(os.path.dirname(result), os.W_OK): + raise F5ModuleError( + "Destination {0} not writable".format(os.path.dirname(result)) + ) + return result + + @property + def inline(self): + result = flatten_boolean(self._values['inline']) + if result == 'yes': + return True + elif result == 'no': + return False + + @property + def compact(self): + result = flatten_boolean(self._values['compact']) + if result == 'yes': + return True + elif result == 'no': + return False + + @property + def base64(self): + result = flatten_boolean(self._values['base64']) + if result == 'yes': + return True + elif result == 'no': + return False + + +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): + pass + + +class ReportableChanges(Changes): + pass + + +class ModuleManager(object): + def __init__(self, *args, **kwargs): + self.module = kwargs.get('module', None) + self.client = kwargs.get('client', None) + self.want = ModuleParameters(params=self.module.params) + 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 _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): + if not module_provisioned(self.client, 'asm'): + raise F5ModuleError( + "ASM must be provisioned to use this module." + ) + result = dict() + + self.export() + + reportable = ReportableChanges(params=self.changes.to_return()) + changes = reportable.to_return() + result.update(**changes) + result.update(dict(changed=True)) + return result + + def export(self): + if self.exists(): + return self.update() + else: + return self.create() + + def update(self): + if os.path.exists(self.want.dest): + if not self.want.force: + raise F5ModuleError( + "File '{0}' already exists".format(self.want.fulldest) + ) + self.execute() + + def create(self): + self._set_changed_options() + if self.module.check_mode: + return True + if self.want.binary: + self.export_binary() + return True + self.create_on_device() + if not self.want.inline: + self.execute() + return True + + def export_binary(self): + self.export_binary_on_device() + self.execute() + return True + + def download(self): + self.download_from_device(self.want.fulldest) + if os.path.exists(self.want.fulldest): + return True + raise F5ModuleError( + "Failed to download the remote file." + ) + + def execute(self): + self.download() + self.remove_temp_policy_from_device() + return True + + def exists(self): + name = '{0}~{1}'.format(self.client.provider['user'], self.want.file) + tpath = '/ts/var/rest/{0}'.format( + name, + ) + params = dict( + command='run', + utilCmdArgs=tpath + ) + + uri = "https://{0}:{1}/mgmt/tm/util/unix-ls/".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, 403]: + if 'message' in response: + raise F5ModuleError(response['message']) + else: + raise F5ModuleError(resp.content) + + if 'commandResult' in response: + if 'cannot access' in response['commandResult']: + return False + return True + return False + + def create_on_device(self): + self._set_policy_link() + params = self.changes.api_params() + uri = "https://{0}:{1}/mgmt/tm/asm/tasks/export-policy/".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, 403]: + if 'message' in response: + raise F5ModuleError(response['message']) + else: + raise F5ModuleError(resp.content) + + result, output = self.wait_for_task(response['id']) + if result and output: + if 'file' in output: + self.changes.update(dict(inline_policy=output['file'])) + if result: + return True + + def wait_for_task(self, task_id): + uri = "https://{0}:{1}/mgmt/tm/asm/tasks/export-policy/{2}".format( + self.client.provider['server'], + self.client.provider['server_port'], + task_id + ) + while True: + 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) + + if response['status'] in ['COMPLETED', 'FAILURE']: + break + time.sleep(1) + + if response['status'] == 'FAILURE': + raise F5ModuleError( + 'Failed to export ASM policy.' + ) + if response['status'] == 'COMPLETED': + if not self.want.inline: + return True, None + else: + return True, response['result'] + + def _set_policy_link(self): + policy_link = None + uri = 'https://{0}:{1}/mgmt/tm/asm/policies/'.format( + self.client.provider['server'], + self.client.provider['server_port'], + ) + query = '?$filter=name+eq+{0}+and+partition+eq+{1}&$select=name'.format(self.want.name, self.want.partition) + resp = self.client.api.get(uri + query) + try: + response = resp.json() + except ValueError as ex: + raise F5ModuleError(str(ex)) + + if 'items' in response and response['items'] != []: + policy_link = response['items'][0]['selfLink'] + + if not policy_link: + raise F5ModuleError("The policy was not found") + + self.changes.update(dict(policyReference={'link': policy_link})) + return True + + def export_binary_on_device(self): + full_name = fq_name(self.want.partition, self.want.name) + cmd = 'tmsh save asm policy {0} bin-file {1}'.format(full_name, self.want.file) + uri = "https://{0}:{1}/mgmt/tm/util/bash/".format( + self.client.provider['server'], + self.client.provider['server_port'], + ) + args = dict( + command='run', + utilCmdArgs='-c "{0}"'.format(cmd) + ) + resp = self.client.api.post(uri, json=args) + + try: + response = resp.json() + if 'commandResult' in response: + if 'Unexpected Error' in response['commandResult']: + raise F5ModuleError(response['commandResult']) + 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) + + self._move_binary_to_download() + + return True + + def _move_binary_to_download(self): + name = '{0}~{1}'.format(self.client.provider['user'], self.want.file) + move_path = '/var/tmp/{0} {1}/{2}'.format( + self.want.file, + '/ts/var/rest', + name + ) + params = dict( + command='run', + utilCmdArgs=move_path + ) + + uri = "https://{0}:{1}/mgmt/tm/util/unix-mv/".format( + self.client.provider['server'], + self.client.provider['server_port'] + ) + + resp = self.client.api.post(uri, json=params) + + try: + response = resp.json() + if 'commandResult' in response: + if 'cannot stat' in response['commandResult']: + raise F5ModuleError(response['commandResult']) + except ValueError as ex: + raise F5ModuleError(str(ex)) + + if 'code' in response and response['code'] in [400, 403]: + if 'message' in response: + raise F5ModuleError(response['message']) + else: + raise F5ModuleError(resp.content) + + return True + + def download_from_device(self, dest): + url = 'https://{0}:{1}/mgmt/tm/asm/file-transfer/downloads/{2}'.format( + self.client.provider['server'], + self.client.provider['server_port'], + self.want.file + ) + try: + download_file(self.client, url, dest) + except F5ModuleError: + raise F5ModuleError( + "Failed to download the file." + ) + if os.path.exists(self.want.dest): + return True + return False + + def remove_temp_policy_from_device(self): + name = '{0}~{1}'.format(self.client.provider['user'], self.want.file) + tpath_name = '/ts/var/rest/{0}'.format(name) + uri = "https://{0}:{1}/mgmt/tm/util/unix-rm/".format( + self.client.provider['server'], + self.client.provider['server_port'], + ) + args = dict( + command='run', + utilCmdArgs=tpath_name + ) + resp = self.client.api.post(uri, json=args) + 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) + + +class ArgumentSpec(object): + def __init__(self): + self.supports_check_mode = True + argument_spec = dict( + name=dict( + required=True, + ), + dest=dict( + type='path' + ), + file=dict(), + inline=dict( + type='bool' + ), + compact=dict( + type='bool' + ), + base64=dict( + type='bool' + ), + binary=dict( + type='bool' + ), + force=dict( + default='yes', + type='bool' + ), + partition=dict( + default='Common', + fallback=(env_fallback, ['F5_PARTITION']) + ) + ) + self.argument_spec = {} + self.argument_spec.update(f5_argument_spec) + self.argument_spec.update(argument_spec) + self.mutually_exclusive = [ + ['binary', 'inline'], + ['binary', 'compact'], + ['dest', 'inline'], + ['file', 'inline'] + ] + + +def main(): + spec = ArgumentSpec() + + module = AnsibleModule( + argument_spec=spec.argument_spec, + supports_check_mode=spec.supports_check_mode, + mutually_exclusive=spec.mutually_exclusive, + ) + + client = F5RestClient(**module.params) + + try: + mm = ModuleManager(module=module, client=client) + results = mm.exec_module() + cleanup_tokens(client) + exit_json(module, results, client) + except F5ModuleError as ex: + cleanup_tokens(client) + fail_json(module, ex, client) + + +if __name__ == '__main__': + main() diff --git a/test/units/modules/network/f5/test_bigip_asm_policy_fetch.py b/test/units/modules/network/f5/test_bigip_asm_policy_fetch.py new file mode 100644 index 0000000000..ed3279b6b8 --- /dev/null +++ b/test/units/modules/network/f5/test_bigip_asm_policy_fetch.py @@ -0,0 +1,133 @@ +# -*- coding: utf-8 -*- +# +# Copyright: (c) 2018, 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_asm_policy_fetch import ApiParameters + from library.modules.bigip_asm_policy_fetch import ModuleParameters + from library.modules.bigip_asm_policy_fetch import ModuleManager + from library.modules.bigip_asm_policy_fetch 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_asm_policy_fetch import ApiParameters + from ansible.modules.network.f5.bigip_asm_policy_fetch import ModuleParameters + from ansible.modules.network.f5.bigip_asm_policy_fetch import ModuleManager + from ansible.modules.network.f5.bigip_asm_policy_fetch 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( + inline='yes', + compact='no', + base64='yes', + dest='/tmp/foo.xml', + force='yes', + file='foo.xml', + password='password', + server='localhost', + user='admin' + ) + p = ModuleParameters(params=args) + assert p.inline is True + assert p.compact is False + assert p.base64 is True + assert p.file == 'foo.xml' + + +class TestManager(unittest.TestCase): + def setUp(self): + self.spec = ArgumentSpec() + self.patcher1 = patch('time.sleep') + self.patcher1.start() + + try: + self.p1 = patch('library.modules.bigip_asm_policy_fetch.module_provisioned') + self.m1 = self.p1.start() + self.m1.return_value = True + except Exception: + self.p1 = patch('ansible.modules.network.f5.bigip_asm_policy_fetch.module_provisioned') + self.m1 = self.p1.start() + self.m1.return_value = True + + def tearDown(self): + self.patcher1.stop() + self.p1.stop() + + def test_create(self, *args): + set_module_args(dict( + name='fake_policy', + file='foobar.xml', + dest='/tmp/foobar.xml', + server='localhost', + password='password', + user='admin', + )) + + module = AnsibleModule( + argument_spec=self.spec.argument_spec, + supports_check_mode=self.spec.supports_check_mode, + mutually_exclusive=self.spec.mutually_exclusive, + ) + + mp = ModuleParameters(params=module.params) + mp._policy_exists = Mock(return_value=True) + mm = ModuleManager(module=module) + mm.want = Mock(return_value=mp) + mm.want.binary = False + mm.exists = Mock(return_value=False) + mm.create_on_device = Mock(return_value=True) + mm.execute = Mock(return_value=True) + + results = mm.exec_module() + + assert results['changed'] is True