support stdout_xml

* use defusedxml for security reasons

Signed-off-by: Aleksei Stepanov <penguinolog@gmail.com>

Author: penguinolog

README.rst

@@ -225,6 +225,8 @@ Execution result object has a set of useful properties:
 
 * `stdout_yaml` - STDOUT decoded as YAML.
 
+* `stdout_xml` - STDOUT decoded as XML to `ElementTree` using `defusedxml` library.
+
 * `timestamp` -> `typing.Optional(datetime.datetime)`. Timestamp for received exit code.
 
 SSHClient specific

doc/source/ExecResult.rst

@@ -147,6 +147,13 @@ API: ExecResult
         :rtype: ``typing.Any``
         :raises DeserializeValueError: STDOUT can not be deserialized as YAML
 
+    .. py:attribute:: stdout_xml
+
+        XML from stdout
+
+        :rtype: xml.etree.ElementTree.Element
+        :raises DeserializeValueError: STDOUT can not be deserialized as XML
+
     .. py:method:: read_stdout(src=None, log=None, verbose=False)
 
         Read stdout file-like object to stdout.

exec_helpers/exec_result.py

@@ -24,8 +24,10 @@
 import logging
 import threading
 import typing
+import xml.etree.ElementTree
 
 # External Dependencies
+import defusedxml.ElementTree  # type: ignore
 import yaml
 
 # Exec-Helpers Implementation
@@ -492,6 +494,8 @@ def __deserialize(self, fmt: str) -> typing.Any:
                 if yaml.__with_libyaml__:
                     return yaml.load(self.stdout_str, Loader=yaml.CSafeLoader)  # nosec  # Safe
                 return yaml.safe_load(self.stdout_str)
+            if fmt == "xml":
+                return defusedxml.ElementTree.fromstring(bytes(self.stdout_bin))
         except Exception as e:
             tmpl: str = f"{{self.cmd}} stdout is not valid {fmt}:\n{{stdout!r}}\n"
             LOGGER.exception(tmpl.format(self=self, stdout=self.stdout_str))
@@ -509,6 +513,7 @@ def stdout_json(self) -> typing.Any:
         """JSON from stdout.
 
         :rtype: typing.Any
+        :raises DeserializeValueError: STDOUT can not be deserialized as JSON
         """
         with self.stdout_lock:
             return self.__deserialize(fmt="json")
@@ -518,10 +523,21 @@ def stdout_yaml(self) -> typing.Any:
         """YAML from stdout.
 
         :rtype: typing.Any
+        :raises DeserializeValueError: STDOUT can not be deserialized as YAML
         """
         with self.stdout_lock:
             return self.__deserialize(fmt="yaml")
 
+    @property
+    def stdout_xml(self) -> xml.etree.ElementTree.Element:
+        """YAML from stdout.
+
+        :rtype: xml.etree.ElementTree.Element
+        :raises DeserializeValueError: STDOUT can not be deserialized as XML
+        """
+        with self.stdout_lock:
+            return self.__deserialize(fmt="xml")  # type: ignore
+
     def __dir__(self) -> typing.List[str]:
         """Override dir for IDE and as source for getitem checks."""
         return [
@@ -539,6 +555,7 @@ def __dir__(self) -> typing.List[str]:
             "stderr_lines",
             "stdout_json",
             "stdout_yaml",
+            "stdout_xml",
             "lock",
         ]
 

requirements.txt

@@ -6,3 +6,4 @@ PyYAML>=3.12  # MIT
 advanced-descriptors>=1.0  # Apache-2.0
 typing >= 3.6 ; python_version < "3.7"
 psutil >= 5.0
+defusedxml

test/test_exec_result.py

@@ -19,6 +19,7 @@
 # Standard Library
 import datetime
 import unittest
+import xml.etree.ElementTree
 from unittest import mock
 
 # Exec-Helpers Implementation
@@ -261,3 +262,16 @@ def test_indexed_lines_access(self):
             _ = result.stdout_lines["aaa"]  # noqa
         with self.assertRaises(TypeError):
             _ = result.stdout_lines[1, "aaa"]  # noqa
+
+    def test_stdout_xml(self):
+        result = exec_helpers.ExecResult(
+            "test",
+            stdout=[
+                b"<?xml version='1.0'?>\n",
+                b'<data>123</data>\n',
+            ]
+        )
+        expect = xml.etree.ElementTree.fromstring(b"<?xml version='1.0'?>\n<data>123</data>\n")
+        self.assertEqual(
+            xml.etree.ElementTree.tostring(expect), xml.etree.ElementTree.tostring(result.stdout_xml)
+        )