junitparser 3.1.2__tar.gz → 4.0.0__tar.gz

junitparser-4.0.0/MANIFEST.in

@@ -0,0 +1 @@
+include tests/data/*.xml

{junitparser-3.1.2 → junitparser-4.0.0}/PKG-INFO

@@ -1,23 +1,27 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: junitparser
-Version: 3.1.2
+Version: 4.0.0
 Summary: Manipulates JUnit/xUnit Result XML files
-Home-page: https://github.com/weiwei/junitparser
-Author: Weiwei Wang
-Author-email: gastlygem@gmail.com
-License: Apache 2.0
-Keywords: junit xunit xml parser
+Author-email: Weiwei Wang <gastlygem@gmail.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/weiwei/junitparser
+Project-URL: Issues, https://github.com/weiwei/junitparser/issues
+Project-URL: Documentation, https://junitparser.readthedocs.io/
+Keywords: junit,xunit,xml,parser
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Topic :: Text Processing
 Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.6
+Description-Content-Type: text/x-rst
 License-File: LICENSE
+Dynamic: license-file
 
 junitparser -- Pythonic JUnit/xUnit Result XML Parser
 ======================================================
 
-.. image:: https://github.com/weiwei/junitparser/workflows/build/badge.svg?branch=master
+.. image:: https://github.com/weiwei/junitparser/actions/workflows/ci.yml/badge.svg?branch=master
    :target: https://github.com/weiwei/junitparser/actions
 .. image:: https://codecov.io/gh/weiwei/junitparser/branch/master/graph/badge.svg?token=UotlfRXNnK
    :target: https://codecov.io/gh/weiwei/junitparser
@@ -157,8 +161,7 @@ Junitparser also support extra schemas:
 
 .. code-block:: python
 
-    from junitparser.xunit2 import JUnitParser, TestCase, TestSuite, \
-        RerunFailure
+    from junitparser.xunit2 import TestCase, TestSuite, RerunFailure
     # These classes are redefined to support extra properties and attributes
     # of the xunit2 schema.
     suite = TestSuite("mySuite")
@@ -168,7 +171,7 @@ Junitparser also support extra schemas:
     rerun_failure.stack_trace = "Stack"
     rerun_failure.system_err = "E404"
     rerun_failure.system_out = "NOT FOUND"
-    case.add_rerun_result(rerun_failure)
+    case.add_interim_result(rerun_failure)
 
 Currently supported schemas including:
 
@@ -295,9 +298,18 @@ Command Line
 Test
 ----
 
-The tests are written with python ``unittest``, to run them, use pytest::
+The tests are written with python ``unittest``, to run them, use
+`pytest <https://pypi.org/project/pytest/>`_::
 
-    pytest test.py
+    pytest
+
+If you get a failure like ``unsupported locale setting`` you may need to add
+extra locales that the tests use. Refer to the steps used in the
+`CI build workflow <.github/workflows/build.yml>`_::
+
+        sudo locale-gen en_US.UTF-8
+        sudo locale-gen de_DE.UTF-8
+        sudo update-locale
 
 Contribute
 ----------

{junitparser-3.1.2 → junitparser-4.0.0}/README.rst

@@ -1,7 +1,7 @@
 junitparser -- Pythonic JUnit/xUnit Result XML Parser
 ======================================================
 
-.. image:: https://github.com/weiwei/junitparser/workflows/build/badge.svg?branch=master
+.. image:: https://github.com/weiwei/junitparser/actions/workflows/ci.yml/badge.svg?branch=master
    :target: https://github.com/weiwei/junitparser/actions
 .. image:: https://codecov.io/gh/weiwei/junitparser/branch/master/graph/badge.svg?token=UotlfRXNnK
    :target: https://codecov.io/gh/weiwei/junitparser
@@ -141,8 +141,7 @@ Junitparser also support extra schemas:
 
 .. code-block:: python
 
-    from junitparser.xunit2 import JUnitParser, TestCase, TestSuite, \
-        RerunFailure
+    from junitparser.xunit2 import TestCase, TestSuite, RerunFailure
     # These classes are redefined to support extra properties and attributes
     # of the xunit2 schema.
     suite = TestSuite("mySuite")
@@ -152,7 +151,7 @@ Junitparser also support extra schemas:
     rerun_failure.stack_trace = "Stack"
     rerun_failure.system_err = "E404"
     rerun_failure.system_out = "NOT FOUND"
-    case.add_rerun_result(rerun_failure)
+    case.add_interim_result(rerun_failure)
 
 Currently supported schemas including:
 
@@ -279,9 +278,18 @@ Command Line
 Test
 ----
 
-The tests are written with python ``unittest``, to run them, use pytest::
+The tests are written with python ``unittest``, to run them, use
+`pytest <https://pypi.org/project/pytest/>`_::
 
-    pytest test.py
+    pytest
+
+If you get a failure like ``unsupported locale setting`` you may need to add
+extra locales that the tests use. Refer to the steps used in the
+`CI build workflow <.github/workflows/build.yml>`_::
+
+        sudo locale-gen en_US.UTF-8
+        sudo locale-gen de_DE.UTF-8
+        sudo update-locale
 
 Contribute
 ----------

junitparser-4.0.0/junitparser/__init__.py

@@ -0,0 +1,38 @@
+from .junitparser import (
+    Attr,
+    Element,
+    Error,
+    Failure,
+    FloatAttr,
+    IntAttr,
+    JUnitXml,
+    JUnitXmlError,
+    Properties,
+    Property,
+    Skipped,
+    SystemOut,
+    SystemErr,
+    TestCase,
+    TestSuite,
+)
+
+version = "4.0.0"
+
+__all__ = [
+    "Attr",
+    "Element",
+    "Error",
+    "Failure",
+    "FloatAttr",
+    "IntAttr",
+    "JUnitXml",
+    "JUnitXmlError",
+    "Properties",
+    "Property",
+    "Skipped",
+    "SystemOut",
+    "SystemErr",
+    "TestCase",
+    "TestSuite",
+    "version"
+]

{junitparser-3.1.2 → junitparser-4.0.0}/junitparser/cli.py

@@ -1,3 +1,4 @@
+import sys
 from argparse import ArgumentParser
 from glob import iglob
 from itertools import chain
@@ -5,8 +6,8 @@ from itertools import chain
 from . import JUnitXml, version
 
 
-def merge(paths, output, suite_name):
-    """Merge XML report."""
+def merge(paths, output, suite_name=""):
+    """Merge XML reports."""
     result = JUnitXml()
     for path in paths:
         result += JUnitXml.fromfile(path)
@@ -14,7 +15,7 @@ def merge(paths, output, suite_name):
     result.update_statistics()
     if suite_name:
         result.name = suite_name
-    result.write(output, to_console=output == "-")
+    result.write(sys.stdout if output == "-" else output)
     return 0
 
 
@@ -43,18 +44,23 @@ def _parser(prog_name=None):  # pragma: no cover
     command_parser = parser.add_subparsers(dest="command", help="command")
     command_parser.required = True
 
-    # command: merge
-    merge_parser = command_parser.add_parser(
-        "merge", help="Merge JUnit XML format reports with junitparser."
-    )
-    merge_parser.add_argument(
+    # an abstract object that defines common arguments used by multiple commands
+    abstract_parser = ArgumentParser(add_help=False)
+    abstract_parser.add_argument(
         "--glob",
         help="Treat original XML path(s) as glob(s).",
         dest="paths_are_globs",
         action="store_true",
         default=False,
     )
-    merge_parser.add_argument("paths", nargs="+", help="Original XML path(s).")
+    abstract_parser.add_argument("paths", help="Original XML path(s).", nargs="+")
+
+    # command: merge
+    merge_parser = command_parser.add_parser(
+        "merge",
+        help="Merge JUnit XML format reports with junitparser.",
+        parents=[abstract_parser],
+    )
     merge_parser.add_argument(
         "output", help='Merged XML Path, setting to "-" will output to the console'
     )
@@ -64,19 +70,10 @@ def _parser(prog_name=None):  # pragma: no cover
     )
 
     # command: verify
-    merge_parser = command_parser.add_parser(
+    verify_parser = command_parser.add_parser(  # noqa: F841
         "verify",
         help="Return a non-zero exit code if one of the testcases failed or errored.",
-    )
-    merge_parser.add_argument(
-        "--glob",
-        help="Treat original XML path(s) as glob(s).",
-        dest="paths_are_globs",
-        action="store_true",
-        default=False,
-    )
-    merge_parser.add_argument(
-        "paths", nargs="+", help="XML path(s) of reports to verify."
+        parents=[abstract_parser],
     )
 
     return parser
@@ -84,19 +81,14 @@ def _parser(prog_name=None):  # pragma: no cover
 
 def main(args=None, prog_name=None):
     """CLI's main runner."""
-    args = args or _parser(prog_name=prog_name).parse_args()
+    args = _parser(prog_name=prog_name).parse_args(args)
+    paths = (
+        chain.from_iterable(iglob(path) for path in args.paths)
+        if args.paths_are_globs
+        else args.paths
+    )
     if args.command == "merge":
-        return merge(
-            chain.from_iterable(iglob(path) for path in args.paths)
-            if args.paths_are_globs
-            else args.paths,
-            args.output,
-            args.suite_name,
-        )
+        return merge(paths, args.output, args.suite_name)
     if args.command == "verify":
-        return verify(
-            chain.from_iterable(iglob(path) for path in args.paths)
-            if args.paths_are_globs
-            else args.paths
-        )
+        return verify(paths)
     return 255

{junitparser-3.1.2 → junitparser-4.0.0}/junitparser/junitparser.py

@@ -8,10 +8,10 @@ This, according to the document, is Apache Ant's JUnit output.
 
 See the documentation for other supported schemas.
 """
-
+import io
 import itertools
 from copy import deepcopy
-from typing import List
+from typing import List, Union, Iterator, IO, Optional
 
 try:
     from lxml import etree
@@ -19,12 +19,12 @@ except ImportError:
     from xml.etree import ElementTree as etree
 
 
-def write_xml(obj, filepath=None, pretty=False, to_console=False):
+def write_xml(obj, file_or_filename: Optional[Union[str, IO]] = None, *, pretty: bool = False):
     tree = etree.ElementTree(obj._elem)
-    if filepath is None:
-        filepath = obj.filepath
-    if filepath is None:
-        raise JUnitXmlError("Missing filepath argument.")
+    if file_or_filename is None:
+        file_or_filename = obj.filepath
+    if file_or_filename is None:
+        raise JUnitXmlError("Missing file argument.")
 
     if pretty:
         from xml.dom.minidom import parseString
@@ -32,20 +32,23 @@ def write_xml(obj, filepath=None, pretty=False, to_console=False):
         text = etree.tostring(obj._elem)
         xml = parseString(text)  # nosec
         content = xml.toprettyxml(encoding="utf-8")
-        if to_console:
-            print(content)
-        else:
-            with open(filepath, "wb") as xmlfile:
+        if isinstance(file_or_filename, str):
+            with open(file_or_filename, encoding="utf-8", mode="wb") as xmlfile:
                 xmlfile.write(content)
+        else:
+            if isinstance(file_or_filename, io.TextIOWrapper):
+                if file_or_filename.encoding is not None and file_or_filename.encoding.lower() != "utf-8":
+                    raise ValueError(f"Only utf-8 encoding is supported: {file_or_filename.encoding}")
+                file_or_filename.buffer.write(content)
+            else:
+                file_or_filename.write(content)
     else:
-        if to_console:
-            print(
-                etree.tostring(
-                    obj._elem, encoding="utf-8", xml_declaration=True
-                ).decode("utf-8")
-            )
+        if isinstance(file_or_filename, io.TextIOWrapper):
+            if file_or_filename.encoding is not None and file_or_filename.encoding.lower() != "utf-8":
+                raise ValueError(f"Only utf-8 encoding is supported: {file_or_filename.encoding}")
+            tree.write(file_or_filename.buffer, encoding="utf-8", xml_declaration=True)
         else:
-            tree.write(filepath, encoding="utf-8", xml_declaration=True)
+            tree.write(file_or_filename, encoding="utf-8", xml_declaration=True)
 
 
 class JUnitXmlError(Exception):
@@ -242,7 +245,13 @@ class Result(Element):
         self._elem.text = value
 
 
-class Skipped(Result):
+class FinalResult(Result):
+    """Base class for final test result (in contrast to XUnit2 InterimResult)."""
+
+    _tag = None
+
+
+class Skipped(FinalResult):
     """Test result when the case is skipped."""
 
     _tag = "skipped"
@@ -251,7 +260,7 @@ class Skipped(Result):
         return super().__eq__(other)
 
 
-class Failure(Result):
+class Failure(FinalResult):
     """Test result when the case failed."""
 
     _tag = "failure"
@@ -260,7 +269,7 @@ class Failure(Result):
         return super().__eq__(other)
 
 
-class Error(Result):
+class Error(FinalResult):
     """Test result when the case has errors during execution."""
 
     _tag = "error"
@@ -269,9 +278,6 @@ class Error(Result):
         return super().__eq__(other)
 
 
-POSSIBLE_RESULTS = {Failure, Error, Skipped}
-
-
 class System(Element):
     """Parent class for :class:`SystemOut` and :class:`SystemErr`.
 
@@ -317,6 +323,9 @@ class TestCase(Element):
     time = FloatAttr()
     __test__ = False
 
+    # JUnit TestCase children are final results, SystemOut and SystemErr
+    ITER_TYPES = {t._tag: t for t in (Failure, Error, Skipped, SystemOut, SystemErr)}
+
     def __init__(self, name: str = None, classname: str = None, time: float = None):
         super().__init__(self._tag)
         if name is not None:
@@ -329,12 +338,10 @@ class TestCase(Element):
     def __hash__(self):
         return super().__hash__()
 
-    def __iter__(self):
-        all_types = set.union(POSSIBLE_RESULTS, {SystemOut}, {SystemErr})
+    def __iter__(self) -> Iterator[Union[Result, System]]:
         for elem in self._elem.iter():
-            for entry_type in all_types:
-                if elem.tag == entry_type._tag:
-                    yield entry_type.fromelem(elem)
+            if elem.tag in self.ITER_TYPES:
+                yield self.ITER_TYPES[elem.tag].fromelem(elem)
 
     def __eq__(self, other):
         # TODO: May not work correctly if unreliable hash method is used.
@@ -345,32 +352,40 @@ class TestCase(Element):
         """Whether this testcase was a success (i.e. if it isn't skipped, failed, or errored)."""
         return not self.result
 
+    @property
+    def is_failure(self):
+        """Whether this testcase failed."""
+        return any(isinstance(r, Failure) for r in self.result)
+
+    @property
+    def is_error(self):
+        """Whether this testcase errored."""
+        return any(isinstance(r, Error) for r in self.result)
+
     @property
     def is_skipped(self):
         """Whether this testcase was skipped."""
-        for r in self.result:
-            if isinstance(r, Skipped):
-                return True
-        return False
+        return any(isinstance(r, Skipped) for r in self.result)
 
     @property
-    def result(self):
+    def result(self) -> List[FinalResult]:
         """A list of :class:`Failure`, :class:`Skipped`, or :class:`Error` objects."""
-        results = []
-        for entry in self:
-            if isinstance(entry, tuple(POSSIBLE_RESULTS)):
-                results.append(entry)
-
-        return results
+        return [entry for entry in self if isinstance(entry, FinalResult)]
 
     @result.setter
-    def result(self, value: Result):
+    def result(self, value: Union[FinalResult, List[FinalResult]]):
+        # Check typing
+        if not (isinstance(value, FinalResult) or
+                isinstance(value, list) and all(isinstance(item, FinalResult) for item in value)):
+            raise ValueError("Value must be either FinalResult or list of FinalResult")
+
         # First remove all existing results
         for entry in self.result:
-            if any(isinstance(entry, r) for r in POSSIBLE_RESULTS):
-                self.remove(entry)
-        for entry in value:
-            if any(isinstance(entry, r) for r in POSSIBLE_RESULTS):
+            self.remove(entry)
+        if isinstance(value, FinalResult):
+            self.append(value)
+        else:
+            for entry in value:
                 self.append(entry)
 
     @property
@@ -452,7 +467,7 @@ class Properties(Element):
     def add_property(self, property_: Property):
         self.append(property_)
 
-    def __iter__(self):
+    def __iter__(self) -> Iterator[Property]:
         return super().iterchildren(Property)
 
     def __eq__(self, other):
@@ -493,15 +508,18 @@ class TestSuite(Element):
     skipped = IntAttr()
     __test__ = False
 
+    testcase = TestCase
+
     def __init__(self, name=None):
         super().__init__(self._tag)
         self.name = name
         self.filepath = None
+        self.root = JUnitXml
 
-    def __iter__(self):
+    def __iter__(self) -> Iterator[TestCase]:
         return itertools.chain(
-            super().iterchildren(TestCase),
-            (case for suite in super().iterchildren(TestSuite) for case in suite),
+            super().iterchildren(self.testcase),
+            (case for suite in super().iterchildren(type(self)) for case in suite),
         )
 
     def __len__(self):
@@ -535,7 +553,7 @@ class TestSuite(Element):
             result.update_statistics()
         else:
             # Create a new test result containing two testsuites
-            result = JUnitXml()
+            result = self.root()
             result.add_testsuite(self)
             result.add_testsuite(other)
         return result
@@ -549,7 +567,7 @@ class TestSuite(Element):
             self.update_statistics()
             return self
 
-        result = JUnitXml()
+        result = self.root()
         result.filepath = self.filepath
         result.add_testsuite(self)
         result.add_testsuite(other)
@@ -636,11 +654,10 @@ class TestSuite(Element):
 
     def testsuites(self):
         """Iterate through all testsuites."""
-        for suite in self.iterchildren(TestSuite):
-            yield suite
+        yield from self.iterchildren(type(self))
 
-    def write(self, filepath: str = None, pretty=False):
-        write_xml(self, filepath=filepath, pretty=pretty)
+    def write(self, file_or_filename: Optional[Union[str, IO]] = None, *, pretty: bool = False):
+        write_xml(self, file_or_filename=file_or_filename, pretty=pretty)
 
 
 class JUnitXml(Element):
@@ -665,19 +682,21 @@ class JUnitXml(Element):
     errors = IntAttr()
     skipped = IntAttr()
 
+    testsuite = TestSuite
+
     def __init__(self, name=None):
         super().__init__(self._tag)
         self.filepath = None
         self.name = name
 
-    def __iter__(self):
-        return super().iterchildren(TestSuite)
+    def __iter__(self) -> Iterator[TestSuite]:
+        return super().iterchildren(self.testsuite)
 
     def __len__(self):
         return len(list(self.__iter__()))
 
     def __add__(self, other):
-        result = JUnitXml()
+        result = type(self)()
         for suite in self:
             result.add_testsuite(suite)
         for suite in other:
@@ -689,7 +708,7 @@ class JUnitXml(Element):
             for suite in other:
                 self.add_testsuite(suite)
         elif other._elem.tag == "testsuite":
-            suite = TestSuite(name=other.name)
+            suite = self.testsuite(name=other.name)
             for case in other:
                 suite._add_testcase_no_update_stats(case)
             self.add_testsuite(suite)
@@ -724,39 +743,49 @@ class JUnitXml(Element):
         self.time = round(time, 3)
 
     @classmethod
-    def fromroot(cls, root_elem: Element):
+    def fromroot(cls, root_elem: Element) -> "JUnitXml":
         """Construct JUnit objects from an elementTree root element."""
-        if root_elem.tag == "testsuites":
-            instance = cls()
-        elif root_elem.tag == "testsuite":
-            instance = TestSuite()
-        else:
+        instance = cls()
+        if root_elem.tag == "testsuite":
+            testsuite_element = root_elem
+            root_elem = testsuite_element.makeelement("testsuites", {})
+            root_elem.append(testsuite_element)
+        if not root_elem.tag == "testsuites":
             raise JUnitXmlError("Invalid format.")
         instance._elem = root_elem
         return instance
 
     @classmethod
-    def fromstring(cls, text: str):
-        """Construct JUnit objects from an XML string."""
+    def fromstring(cls, text: Union[str, bytes]) -> "JUnitXml":
+        """Construct JUnit objects from an XML string (str or bytes)."""
         root_elem = etree.fromstring(text)  # nosec
         return cls.fromroot(root_elem)
 
     @classmethod
-    def fromfile(cls, filepath: str, parse_func=None):
-        """Initiate the object from a report file."""
-        if parse_func:
-            tree = parse_func(filepath)
+    def fromfile(cls, file: Union[str, IO], parse_func=None) -> "JUnitXml":
+        """
+        Construct JUnit objects from an XML file.
+
+        The ``file`` can be any of the following:
+
+        - a file name/path
+        - a file object
+        - a file-like object
+        - a URL using the HTTP or FTP protocol (with lxml only)
+        """
+        if parse_func is not None:
+            tree = parse_func(file)
         else:
-            tree = etree.parse(filepath)  # nosec
+            tree = etree.parse(file)  # nosec
         root_elem = tree.getroot()
         instance = cls.fromroot(root_elem)
-        instance.filepath = filepath
+        instance.filepath = file if isinstance(file, str) else None
         return instance
 
-    def write(self, filepath: str = None, pretty=False, to_console=False):
+    def write(self, file_or_filename: Optional[Union[str, IO]] = None, *, pretty: bool = False):
         """Write the object into a JUnit XML file.
 
-        If `file_path` is not specified, it will write to the original file.
+        If `file_or_filename` is not specified, it will write to the original filename.
         If `pretty` is True, the result file will be more human friendly.
         """
-        write_xml(self, filepath=filepath, pretty=pretty, to_console=to_console)
+        write_xml(self, file_or_filename=file_or_filename, pretty=pretty)