junitparser 4.0.1__tar.gz → 5.0.0__tar.gz

{junitparser-4.0.1 → junitparser-5.0.0}/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2020 Joel Wang
+Copyright 2025 Weiwei Wang
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -10,4 +10,4 @@ Copyright 2020 Joel Wang
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

{junitparser-4.0.1/junitparser.egg-info → junitparser-5.0.0}/PKG-INFO

@@ -1,19 +1,18 @@
 Metadata-Version: 2.4
 Name: junitparser
-Version: 4.0.1
+Version: 5.0.0
 Summary: Manipulates JUnit/xUnit Result XML files
 Author-email: Weiwei Wang <gastlygem@gmail.com>
-License: Apache-2.0
+License-Expression: 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
+Requires-Python: >=3.10
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 Dynamic: license-file
@@ -39,8 +38,11 @@ Features
 * Merge test result XML files.
 * Specify XML parser. For example you can use lxml to speed things up.
 * Invoke from command line, or `python -m junitparser`
-* Python 2 and 3 support (As of Nov 2020, 1/4 of the users are still on Python
-  2, so there is no plan to drop Python 2 support)
+
+Note on version 5
+-----------------
+
+Python 3.10 or above is now required. If you are still using Python 3.9 or below, please use version 4.0.2.
 
 Note on version 2
 -----------------
@@ -53,8 +55,6 @@ If you are using this attribute, please update your code accordingly.
 Installation
 -------------
 
-::
-
     pip install junitparser
 
 Usage
@@ -161,18 +161,24 @@ Junitparser also support extra schemas:
 
 .. code-block:: python
 
+    # Extended with extra properties/attributes from the xunit2 schema.
     from junitparser.xunit2 import TestCase, TestSuite, RerunFailure
-    # These classes are redefined to support extra properties and attributes
-    # of the xunit2 schema.
+
+    # TestSuite supports system_err.
     suite = TestSuite("mySuite")
-    suite.system_err = "System err" # xunit2 specific property
+    suite.system_err = "System err"
+
+    # TestCase supports interim results.
     case = TestCase("myCase")
-    rerun_failure = RerunFailure("Not found", "404") # case property
+    rerun_failure = RerunFailure("Not found", "404")
     rerun_failure.stack_trace = "Stack"
     rerun_failure.system_err = "E404"
     rerun_failure.system_out = "NOT FOUND"
     case.add_interim_result(rerun_failure)
 
+    # TestCase supports properties.
+    case.add_property("cmake_labels", "cuda;tier2")
+
 Currently supported schemas including:
 
 - xunit2_, supported by pytest, Erlang/OTP, Maven Surefire, CppTest, etc.

{junitparser-4.0.1 → junitparser-5.0.0}/README.rst

@@ -19,8 +19,11 @@ Features
 * Merge test result XML files.
 * Specify XML parser. For example you can use lxml to speed things up.
 * Invoke from command line, or `python -m junitparser`
-* Python 2 and 3 support (As of Nov 2020, 1/4 of the users are still on Python
-  2, so there is no plan to drop Python 2 support)
+
+Note on version 5
+-----------------
+
+Python 3.10 or above is now required. If you are still using Python 3.9 or below, please use version 4.0.2.
 
 Note on version 2
 -----------------
@@ -33,8 +36,6 @@ If you are using this attribute, please update your code accordingly.
 Installation
 -------------
 
-::
-
     pip install junitparser
 
 Usage
@@ -141,18 +142,24 @@ Junitparser also support extra schemas:
 
 .. code-block:: python
 
+    # Extended with extra properties/attributes from the xunit2 schema.
     from junitparser.xunit2 import TestCase, TestSuite, RerunFailure
-    # These classes are redefined to support extra properties and attributes
-    # of the xunit2 schema.
+
+    # TestSuite supports system_err.
     suite = TestSuite("mySuite")
-    suite.system_err = "System err" # xunit2 specific property
+    suite.system_err = "System err"
+
+    # TestCase supports interim results.
     case = TestCase("myCase")
-    rerun_failure = RerunFailure("Not found", "404") # case property
+    rerun_failure = RerunFailure("Not found", "404")
     rerun_failure.stack_trace = "Stack"
     rerun_failure.system_err = "E404"
     rerun_failure.system_out = "NOT FOUND"
     case.add_interim_result(rerun_failure)
 
+    # TestCase supports properties.
+    case.add_property("cmake_labels", "cuda;tier2")
+
 Currently supported schemas including:
 
 - xunit2_, supported by pytest, Erlang/OTP, Maven Surefire, CppTest, etc.

{junitparser-4.0.1 → junitparser-5.0.0}/junitparser/__init__.py

@@ -16,7 +16,7 @@ from .junitparser import (
     TestSuite,
 )
 
-version = "4.0.1"
+version = "5.0.0"
 
 __all__ = [
     "Attr",

{junitparser-4.0.1 → junitparser-5.0.0}/junitparser/junitparser.py

@@ -11,6 +11,7 @@ See the documentation for other supported schemas.
 import io
 import itertools
 from copy import deepcopy
+from pathlib import Path
 from typing import List, Union, Iterator, IO, Optional
 
 try:
@@ -19,7 +20,7 @@ except ImportError:
     from xml.etree import ElementTree as etree
 
 
-def write_xml(obj, file_or_filename: Optional[Union[str, IO]] = None, *, pretty: bool = False):
+def write_xml(obj, file_or_filename: Optional[Union[str, IO, Path]] = None, *, pretty: bool = False):
     tree = etree.ElementTree(obj._elem)
     if file_or_filename is None:
         file_or_filename = obj.filepath
@@ -32,6 +33,9 @@ def write_xml(obj, file_or_filename: Optional[Union[str, IO]] = None, *, pretty:
         text = etree.tostring(obj._elem)
         xml = parseString(text)  # nosec
         content = xml.toprettyxml(encoding="utf-8")
+        if isinstance(file_or_filename, Path):
+            file_or_filename = str(file_or_filename)
+
         if isinstance(file_or_filename, str):
             with open(file_or_filename, mode="wb") as xmlfile:
                 xmlfile.write(content)
@@ -64,7 +68,7 @@ class Attr(object):
     Also see: :class:`IntAttr`, :class:`FloatAttr`.
     """
 
-    def __init__(self, name: str = None):
+    def __init__(self, name: str | None = None):
         self.name = name
 
     def __get__(self, instance, cls):
@@ -137,7 +141,7 @@ class junitxml(type):
 class Element(metaclass=junitxml):
     """Base class for all JUnit XML elements."""
 
-    def __init__(self, name: str = None):
+    def __init__(self, name: str | None = None):
         if not name:
             name = self._tag
         self._elem = etree.Element(name)
@@ -222,7 +226,7 @@ class Result(Element):
     message = Attr()
     type = Attr()
 
-    def __init__(self, message: str = None, type_: str = None):
+    def __init__(self, message: str | None = None, type_: str | None = None):
         super(Result, self).__init__(self._tag)
         if message:
             self.message = message
@@ -287,7 +291,7 @@ class System(Element):
 
     _tag = ""
 
-    def __init__(self, content: str = None):
+    def __init__(self, content: str | None = None):
         super().__init__(self._tag)
         self.text = content
 
@@ -326,7 +330,7 @@ class TestCase(Element):
     # 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):
+    def __init__(self, name: str | None = None, classname: str | None = None, time: float | None = None):
         super().__init__(self._tag)
         if name is not None:
             self.name = name
@@ -424,7 +428,7 @@ class TestCase(Element):
 
 
 class Property(Element):
-    """A key/value pare that's stored in the testsuite.
+    """A key/value pair that's stored in the testsuite or testcase properties.
 
     Use it to store anything you find interesting or useful.
 
@@ -437,7 +441,7 @@ class Property(Element):
     name = Attr()
     value = Attr()
 
-    def __init__(self, name: str = None, value: str = None):
+    def __init__(self, name: str | None = None, value: str | None = None):
         super().__init__(self._tag)
         self.name = name
         self.value = value
@@ -454,7 +458,7 @@ class Property(Element):
 
 
 class Properties(Element):
-    """A list of properties inside a testsuite.
+    """A list of properties inside a testsuite or testcase.
 
     See :class:`Property`
     """
@@ -510,7 +514,7 @@ class TestSuite(Element):
 
     testcase = TestCase
 
-    def __init__(self, name=None):
+    def __init__(self, name: str | None = None):
         super().__init__(self._tag)
         self.name = name
         self.filepath = None
@@ -684,7 +688,7 @@ class JUnitXml(Element):
 
     testsuite = TestSuite
 
-    def __init__(self, name=None):
+    def __init__(self, name: str | None = None):
         super().__init__(self._tag)
         self.filepath = None
         self.name = name

{junitparser-4.0.1 → junitparser-5.0.0}/junitparser/xunit2.py

@@ -154,6 +154,36 @@ class TestCase(junitparser.TestCase):
         """Append an interim (rerun or flaky) result to the testcase. A testcase can have multiple interim results."""
         self.append(result)
 
+    def add_property(self, name: str, value: str):
+        """Add a property *name* = *value* to the testcase.
+
+        See :class:`junitparser.Property` and :class:`junitparser.Properties`.
+        """
+
+        props = self.child(junitparser.Properties)
+        if props is None:
+            props = junitparser.Properties()
+            self.append(props)
+        prop = junitparser.Property(name, value)
+        props.add_property(prop)
+
+    def properties(self):
+        """Iterate through all :class:`junitparser.Property` elements in the testcase."""
+        props = self.child(junitparser.Properties)
+        if props is None:
+            return
+        for prop in props:
+            yield prop
+
+    def remove_property(self, property_: junitparser.Property):
+        """Remove property *property_* from the testcase."""
+        props = self.child(junitparser.Properties)
+        if props is None:
+            return
+        for prop in props:
+            if prop == property_:
+                props.remove(property_)
+
 
 class TestSuite(junitparser.TestSuite):
     """TestSuite for Pytest, with some different attributes."""

{junitparser-4.0.1 → junitparser-5.0.0/junitparser.egg-info}/PKG-INFO

@@ -1,19 +1,18 @@
 Metadata-Version: 2.4
 Name: junitparser
-Version: 4.0.1
+Version: 5.0.0
 Summary: Manipulates JUnit/xUnit Result XML files
 Author-email: Weiwei Wang <gastlygem@gmail.com>
-License: Apache-2.0
+License-Expression: 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
+Requires-Python: >=3.10
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 Dynamic: license-file
@@ -39,8 +38,11 @@ Features
 * Merge test result XML files.
 * Specify XML parser. For example you can use lxml to speed things up.
 * Invoke from command line, or `python -m junitparser`
-* Python 2 and 3 support (As of Nov 2020, 1/4 of the users are still on Python
-  2, so there is no plan to drop Python 2 support)
+
+Note on version 5
+-----------------
+
+Python 3.10 or above is now required. If you are still using Python 3.9 or below, please use version 4.0.2.
 
 Note on version 2
 -----------------
@@ -53,8 +55,6 @@ If you are using this attribute, please update your code accordingly.
 Installation
 -------------
 
-::
-
     pip install junitparser
 
 Usage
@@ -161,18 +161,24 @@ Junitparser also support extra schemas:
 
 .. code-block:: python
 
+    # Extended with extra properties/attributes from the xunit2 schema.
     from junitparser.xunit2 import TestCase, TestSuite, RerunFailure
-    # These classes are redefined to support extra properties and attributes
-    # of the xunit2 schema.
+
+    # TestSuite supports system_err.
     suite = TestSuite("mySuite")
-    suite.system_err = "System err" # xunit2 specific property
+    suite.system_err = "System err"
+
+    # TestCase supports interim results.
     case = TestCase("myCase")
-    rerun_failure = RerunFailure("Not found", "404") # case property
+    rerun_failure = RerunFailure("Not found", "404")
     rerun_failure.stack_trace = "Stack"
     rerun_failure.system_err = "E404"
     rerun_failure.system_out = "NOT FOUND"
     case.add_interim_result(rerun_failure)
 
+    # TestCase supports properties.
+    case.add_property("cmake_labels", "cuda;tier2")
+
 Currently supported schemas including:
 
 - xunit2_, supported by pytest, Erlang/OTP, Maven Surefire, CppTest, etc.

{junitparser-4.0.1 → junitparser-5.0.0}/pyproject.toml

@@ -10,16 +10,16 @@ authors = [
 ]
 description = "Manipulates JUnit/xUnit Result XML files"
 readme = "README.rst"
-requires-python = ">=3.6"
+requires-python = ">=3.10"
 dependencies = []
 classifiers = [
   "Development Status :: 5 - Production/Stable",
   "Intended Audience :: Developers",
-  "License :: OSI Approved :: Apache Software License",
   "Topic :: Text Processing",
   "Programming Language :: Python :: 3",
 ]
-license = {text = "Apache-2.0"}
+license = "Apache-2.0"
+license-files = ["LICENSE"]
 keywords = ["junit", "xunit", "xml", "parser"]
 
 [project.urls]
@@ -32,7 +32,6 @@ junitparser = "junitparser.cli:main"
 
 [tool.setuptools]
 packages = ["junitparser"]
-license-files = ["LICENSE"]
 
 [tool.setuptools.dynamic]
 version = {attr = "junitparser.version"}

{junitparser-4.0.1 → junitparser-5.0.0}/tests/test_xunit2.py

@@ -1,5 +1,14 @@
-from junitparser.xunit2 import JUnitXml, TestSuite, TestCase, RerunFailure, RerunError, FlakyFailure, FlakyError
-from junitparser import Failure
+import textwrap
+from junitparser.xunit2 import (
+    JUnitXml,
+    TestSuite,
+    TestCase,
+    RerunFailure,
+    RerunError,
+    FlakyFailure,
+    FlakyError,
+)
+from junitparser import Failure, Property
 from copy import deepcopy
 
 
@@ -137,6 +146,62 @@ class Test_TestCase:
         case.add_interim_result(failure2)
         assert len(case.rerun_failures()) == 2
 
+    def test_properties_and_output(self):
+        text = textwrap.dedent("""\
+            <testcase name="test_pushstringvector" classname="test_pushstringvector" status="run">
+            <properties>
+                <property name="cmake_labels" value="util;script"/>
+                <property name="TestType" value="LATENCY_EDMA" />
+            </properties>
+            <system-out>
+            a line of output
+            another line
+            </system-out>
+            </testcase>
+        """)
+        case = TestCase.fromstring(text)
+        assert case.name == "test_pushstringvector"
+        assert case.system_out == "\na line of output\nanother line\n"
+        # Check that there are two properties in the TestCase, then check the values.
+        case_properties = list(case.properties())
+        assert len(case_properties) == 2
+        prop1, prop2 = case_properties
+        assert prop1.name == "cmake_labels" and prop1.value == "util;script"
+        assert prop2.name == "TestType" and prop2.value == "LATENCY_EDMA"
+
+    def test_suite_parses_testcase_properties(self):
+        text = textwrap.dedent("""\
+            <testsuite name="suitename1" tests="1" failures="0">
+                <testcase name="testname1">
+                    <properties>
+                        <property name="labels" value="foo;bar"/>
+                        <property name="test_type" value="latency" />
+                    </properties>
+                </testcase>
+            </testsuite>""")
+        test_suite1 = TestSuite.fromstring(text)
+        assert test_suite1.name == "suitename1"
+        cases = list(iter(test_suite1))
+        assert len(cases) == 1
+        case = cases[0]
+        case_properties = list(case.properties())
+        assert len(case_properties) == 2
+        prop1, prop2 = case_properties
+        assert prop1.name == "labels" and prop1.value == "foo;bar"
+        assert prop2.name == "test_type" and prop2.value == "latency"
+
+    def test_add_remove_property(self):
+        case = TestCase()
+        case.add_property("prop1", "foo")
+        case.add_property("prop2", "bar")
+        prop_to_remove = Property("prop1", "foo")
+        case.remove_property(prop_to_remove)
+        assert len(list(case.properties())) == 1
+        assert case.tostring() in [
+            b'<testcase><properties><property name="prop2" value="bar" /></properties></testcase>',
+            b'<testcase><properties><property name="prop2" value="bar"/></properties></testcase>',
+        ]
+
 
 class Test_TestSuite:
     def test_properties(self):