Add to_xml and from_xml filter plugin

changelogs/fragments/add-xmltojson-and-jsontoxml-filter.yaml

@@ -0,0 +1,3 @@
+---
+minor_changes:
+  - Add from_xml and to_xml fiter plugin (https://github.com/ansible-collections/ansible.utils/pull/56).

plugins/filter/from_xml.py

@@ -0,0 +1,145 @@
+#
+# -*- 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 from_xml filter plugin
+"""
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+DOCUMENTATION = """
+    name: from_xml
+    author: Ashwini Mhatre (@amhatre)
+    version_added: "2.0.2"
+    short_description: convert given xml string to native python dictionary.
+    description:
+        - This plugin converts the xml string to native python dictionary.
+        - Using the parameters below- C(data|ansible.utils.from_xml)
+    options:
+      data:
+        description:
+        - The input xml string .
+        - This option represents the xml value that is passed to the filter plugin in pipe format.
+        - For example C(config_data|ansible.utils.from_xml), in this case C(config_data) represents this option.
+        type: str
+        required: True
+      engine:
+        description:
+        - Conversion library to use within the filter plugin.
+        type: str
+        default: xmltodict
+"""
+
+EXAMPLES = r"""
+
+#### Simple examples with out any engine. plugin will use default value as xmltodict
+
+tasks:
+  - name: convert given xml to native python dictionary
+    ansible.builtin.set_fact:
+      data: "
+        <netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\"><schemas><schema/></schemas></netconf-state>
+            "
+
+  - debug:
+      msg:  "{{ data|ansible.utils.from_xml }}"
+
+##TASK######
+# TASK [convert given xml to json] *****************************************************************************************************
+# task path: /Users/amhatre/ansible-collections/playbooks/test_utils.yaml:5
+# ok: [localhost] => {
+#     "ansible_facts": {
+#         "data": " <netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\"><schemas><schema/></schemas></netconf-state> "
+#     },
+#     "changed": false
+# }
+#
+# TASK [debug] *************************************************************************************************************************
+# task path: /Users/amhatre/ansible-collections/playbooks/test_utils.yaml:13
+# Loading collection ansible.utils from /Users/amhatre/ansible-collections/collections/ansible_collections/ansible/utils
+# ok: [localhost] => {
+#     "msg": {
+#         "netconf-state": {
+#             "@xmlns": "urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring",
+#             "schemas": {
+#                 "schema": null
+#             }
+#         }
+#     }
+# }
+
+#### example2 with engine=xmltodict
+
+tasks:
+  - name: convert given xml to json
+    ansible.builtin.set_fact:
+      data: "
+        <netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\"><schemas><schema/></schemas></netconf-state>
+            "
+
+  - debug:
+      msg:  "{{ data|ansible.utils.from_xml('xmltodict') }}"
+
+##TASK######
+# TASK [convert given xml to json] *****************************************************************************************************
+# task path: /Users/amhatre/ansible-collections/playbooks/test_utils.yaml:5
+# ok: [localhost] => {
+#     "ansible_facts": {
+#         "data": " <netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\"><schemas><schema/></schemas></netconf-state> "
+#     },
+#     "changed": false
+# }
+#
+# TASK [debug] *************************************************************************************************************************
+# task path: /Users/amhatre/ansible-collections/playbooks/test_utils.yaml:13
+# Loading collection ansible.utils from /Users/amhatre/ansible-collections/collections/ansible_collections/ansible/utils
+# ok: [localhost] => {
+#     "msg": {
+#         "netconf-state": {
+#             "@xmlns": "urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring",
+#             "schemas": {
+#                 "schema": null
+#             }
+#         }
+#     }
+# }
+"""
+
+from ansible.errors import AnsibleFilterError
+from jinja2.filters import environmentfilter
+from ansible_collections.ansible.utils.plugins.plugin_utils.from_xml import (
+    from_xml,
+)
+from ansible_collections.ansible.utils.plugins.module_utils.common.argspec_validate import (
+    AnsibleArgSpecValidator,
+)
+
+
+@environmentfilter
+def _from_xml(*args, **kwargs):
+    """Convert the given data from xml to json."""
+
+    keys = ["data", "engine"]
+    data = dict(zip(keys, args[1:]))
+    data.update(kwargs)
+    aav = AnsibleArgSpecValidator(
+        data=data, schema=DOCUMENTATION, name="from_xml"
+    )
+    valid, errors, updated_data = aav.validate()
+    if not valid:
+        raise AnsibleFilterError(errors)
+    return from_xml(**updated_data)
+
+
+class FilterModule(object):
+    """ from_xml  """
+
+    def filters(self):
+
+        """a mapping of filter names to functions"""
+        return {"from_xml": _from_xml}

plugins/filter/to_xml.py

@@ -0,0 +1,142 @@
+#
+# -*- 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 filter plugin
+"""
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+DOCUMENTATION = """
+    name: to_xml
+    author: Ashwini Mhatre (@amhatre)
+    version_added: "2.0.2"
+    short_description: convert given json string to xml
+    description:
+        - This plugin converts the json string to xml.
+        - Using the parameters below- C(data|ansible.utils.to_xml)
+    options:
+      data:
+        description:
+        - The input json string .
+        - This option represents the json value that is passed to the filter plugin in pipe format.
+        - For example C(config_data|ansible.utils.to_xml), in this case C(config_data) represents this option.
+        type: str
+        required: True
+      engine:
+        description:
+        - Conversion library to use within the filter plugin.
+        type: str
+        default: xmltodict
+"""
+
+EXAMPLES = r"""
+
+#### Simple examples with out any engine. plugin will use default value as xmltodict
+
+- name: Define json data
+  ansible.builtin.set_fact:
+      data: {
+        "interface-configurations": {
+          "@xmlns": "http://cisco.com/ns/yang/Cisco-IOS-XR-ifmgr-cfg",
+          "interface-configuration": null
+        }
+      }
+- debug:
+    msg:  "{{ data|ansible.utils.to_xml }}"
+
+# TASK [Define json data ] *************************************************************************
+# task path: /Users/amhatre/ansible-collections/playbooks/test_utils_json_to_xml.yaml:5
+# ok: [localhost] => {
+#     "ansible_facts": {
+#         "data": {
+#             "interface-configurations": {
+#                 "@xmlns": "http://cisco.com/ns/yang/Cisco-IOS-XR-ifmgr-cfg",
+#                 "interface-configuration": null
+#             }
+#         }
+#     },
+#     "changed": false
+# }
+#
+# TASK [debug] ***********************************************************************************************************
+# task path: /Users/amhatre/ansible-collections/playbooks/test_utils_json_to_xml.yaml:13
+# Loading collection ansible.utils from /Users/amhatre/ansible-collections/collections/ansible_collections/ansible/utils
+# ok: [localhost] => {
+#     "msg": "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<interface-configurations xmlns=\"http://cisco.com/ns/yang/
+#     Cisco-IOS-XR-ifmgr-cfg\">\n\t<interface-configuration></interface-configuration>\n</interface-configurations>"
+# }
+
+#### example2 with engine=xmltodict
+
+- name: Define json data
+  ansible.builtin.set_fact:
+    data: {
+        "interface-configurations": {
+          "@xmlns": "http://cisco.com/ns/yang/Cisco-IOS-XR-ifmgr-cfg",
+          "interface-configuration": null
+        }
+      }
+- debug:
+    msg:  "{{ data|ansible.utils.to_xml('xmltodict') }}"
+
+# TASK [Define json data ] *************************************************************************
+# task path: /Users/amhatre/ansible-collections/playbooks/test_utils_json_to_xml.yaml:5
+# ok: [localhost] => {
+#     "ansible_facts": {
+#         "data": {
+#             "interface-configurations": {
+#                 "@xmlns": "http://cisco.com/ns/yang/Cisco-IOS-XR-ifmgr-cfg",
+#                 "interface-configuration": null
+#             }
+#         }
+#     },
+#     "changed": false
+# }
+# TASK [debug] ***********************************************************************************************************
+# task path: /Users/amhatre/ansible-collections/playbooks/test_utils_json_to_xml.yaml:13
+# Loading collection ansible.utils from /Users/amhatre/ansible-collections/collections/ansible_collections/ansible/utils
+# ok: [localhost] => {
+#     "msg": "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<interface-configurations xmlns=\"http://cisco.com/ns/yang/
+#     Cisco-IOS-XR-ifmgr-cfg\">\n\t<interface-configuration></interface-configuration>\n</interface-configurations>"
+# }
+
+"""
+
+from ansible.errors import AnsibleFilterError
+from jinja2.filters import environmentfilter
+from ansible_collections.ansible.utils.plugins.plugin_utils.to_xml import (
+    to_xml,
+)
+from ansible_collections.ansible.utils.plugins.module_utils.common.argspec_validate import (
+    AnsibleArgSpecValidator,
+)
+
+
+@environmentfilter
+def _to_xml(*args, **kwargs):
+    """Convert the given data from json to xml."""
+    keys = ["data", "engine"]
+    data = dict(zip(keys, args[1:]))
+    data.update(kwargs)
+    aav = AnsibleArgSpecValidator(
+        data=data, schema=DOCUMENTATION, name="to_xml"
+    )
+    valid, errors, updated_data = aav.validate()
+    if not valid:
+        raise AnsibleFilterError(errors)
+    return to_xml(**updated_data)
+
+
+class FilterModule(object):
+    """ to_xml  """
+
+    def filters(self):
+        """a mapping of filter names to functions"""
+        return {"to_xml": _to_xml}

plugins/plugin_utils/from_xml.py

@@ -0,0 +1,49 @@
+#
+# -*- 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 from_xml plugin code
+"""
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+import json
+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 'from_xml': {msg}".format(msg=msg)
+    raise AnsibleFilterError(error)
+
+
+def from_xml(data, engine):
+    """Convert data which is in xml to json"
+    :param data: The data passed in (data|from_xml(...))
+    :type data: xml
+    :param engine: Conversion library default=xml_to_dict
+    """
+    if engine == "xmltodict":
+        if not HAS_XMLTODICT:
+            _raise_error("Missing required library xmltodict")
+        try:
+            res = json.dumps(xmltodict.parse(data))
+        except Exception:
+            _raise_error("Input Xml is not valid")
+        return res

plugins/plugin_utils/to_xml.py

@@ -0,0 +1,52 @@
+#
+# -*- 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
+
+import ast
+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):
+    """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
+    """
+    if engine == "xmltodict":
+        if not HAS_XMLTODICT:
+            _raise_error("Missing required library xmltodict")
+        try:
+            data = ast.literal_eval(data)
+            res = xmltodict.unparse(data, pretty=True)
+        except Exception:
+            _raise_error("Input json is not valid")
+        return res