ansible.utils/plugins/plugin_utils/to_xml.py

#
# -*- coding: utf-8 -*-
# Copyright 2021 Red Hat
# GNU General Public License v3.0+
# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#

"""
The to_xml plugin
"""
from __future__ import absolute_import, division, print_function


__metaclass__ = type

from ansible.errors import AnsibleFilterError


try:
    import xmltodict

    HAS_XMLTODICT = True
except ImportError:
    HAS_XMLTODICT = False


def _raise_error(msg):
    """Raise an error message, prepend with filter name

    :param msg: The message
    :type msg: str
    :raises: AnsibleError
    """
    error = "Error when using plugin 'to_xml': {msg}".format(msg=msg)
    raise AnsibleFilterError(error)


def to_xml(data, engine, indent, indent_width, full_document):
    """Convert data which is in json to xml"

    :param data: The data passed in (data|to_xml(...))
    :type data: xml
    :param engine: Conversion library default=xmltodict
    :param indent: Indent char default='tabs'
    :param indent_width: Indent char multiplier default=4
    :param full_document: Flag to disable xml declaration
    """

    indent_char = "\t"

    if indent == "spaces":
        indent_char = " " * indent_width

    if engine == "xmltodict":
        if not HAS_XMLTODICT:
            _raise_error("Missing required library xmltodict")
        try:
            res = xmltodict.unparse(
                data,
                pretty=True,
                indent=indent_char,
                full_document=full_document,
            )
        except Exception:
            _raise_error("Input json is not valid")
        return res
    else:
        error = "engine: {engine} is not supported ".format(engine=engine)
        _raise_error(error)