👌 Handle SN >= 6 schema validation (#122)

* Handle SN >= 6 schema validation
* Add SN 6 to test-matrix
* Update noxfile.py

Co-authored-by: Marco Heinemann <marco.heinemann@useblocks.com>

Author: patdhlk

README.rst

@@ -1,7 +1,7 @@
 Sphinx-Test-Reports
 ===================
 
-.. image:: docs/_static/sphinx-test-reports-logo.png
+.. image:: https://raw.githubusercontent.com/useblocks/sphinx-test-reports/master/docs/_static/sphinx-test-reports-logo.png
 
 Sphinx-Test-Reports shows test results of your unit tests inside your sphinx documentation.
 

noxfile.py

@@ -3,7 +3,7 @@
 
 PYTHON_VERSIONS = ["3.10", "3.12"]
 SPHINX_VERSIONS = ["5.0", "7.2.5", "8.1.3"]
-SPHINX_NEEDS_VERSIONS = ["2.1", "4.2", "5.1"]
+SPHINX_NEEDS_VERSIONS = ["2.1", "4.2", "5.1", "6.0.1"]
 
 
 def run_tests(session, sphinx, sphinx_needs):

sphinxcontrib/test_reports/directives/test_case.py

@@ -129,6 +129,22 @@ def run(self, nested=False, suite_count=-1, case_count=-1):
 """.format("\n   ".join([x.lstrip() for x in case["system-out"].split("\n")]))
 
         time = case["time"]
+        # Ensure time is a string, SN 6.0.0 requires to be in one specific type
+        # and it is set to string for backwards compatibility
+        if isinstance(time, (int, float)):
+            # Keep as numeric seconds (decimal format)
+            time = float(time) if time >= 0 else 0.0
+        elif time is None:
+            time = 0.0
+        else:
+            # Try to parse string to float, fallback to 0.0
+            try:
+                time = float(time)
+            except (ValueError, TypeError):
+                time = 0.0
+        time_str = str(time)
+
+        # If time is already a string or None, keep it as is
         style = "tr_" + case["result"]
 
         import re
@@ -180,7 +196,7 @@ def run(self, nested=False, suite_count=-1, case_count=-1):
             case_parameter=case_parameter,
             classname=class_name,
             result=result,
-            time=time,
+            time=time_str,
             style=style,
             **self.extra_options,
         )

sphinxcontrib/test_reports/test_reports.py

@@ -2,6 +2,7 @@
 import os
 
 import sphinx
+import sphinx_needs
 from docutils.parsers.rst import directives
 from packaging.version import Version
 from sphinx.application import Sphinx
@@ -176,6 +177,14 @@ def sphinx_needs_update(app: Sphinx, config: Config) -> None:
     sphinx-needs configuration
     """
 
+    # Check sphinx-needs version to determine if schema is needed
+    try:
+        needs_version = Version(sphinx_needs.__version__)
+        use_schema = needs_version >= Version("6.0.0")
+    except ImportError:
+        # If we can't determine version, assume older version
+        use_schema = False
+
     # Extra options
     # For details read
     # https://sphinx-needs.readthedocs.io/en/latest/api.html#sphinx_needs.api.configuration.add_extra_option
@@ -187,17 +196,25 @@ def sphinx_needs_update(app: Sphinx, config: Config) -> None:
     add_extra_option(app, "case_name")
     add_extra_option(app, "case_parameter")
     add_extra_option(app, "classname")
-    add_extra_option(app, "time")
-
-    add_extra_option(app, "suites")
-    add_extra_option(app, "cases")
-
-    add_extra_option(app, "passed")
-    add_extra_option(app, "skipped")
-    add_extra_option(app, "failed")
-    add_extra_option(app, "errors")
-    add_extra_option(app, "result")  # used by test cases only
-
+    # Add schema parameter conditionally based on sphinx-needs version
+    if use_schema:
+        add_extra_option(app, "time", schema={"type": "string"})
+        add_extra_option(app, "suites", schema={"type": "integer"})
+        add_extra_option(app, "cases", schema={"type": "integer"})
+        add_extra_option(app, "passed", schema={"type": "integer"})
+        add_extra_option(app, "skipped", schema={"type": "integer"})
+        add_extra_option(app, "failed", schema={"type": "integer"})
+        add_extra_option(app, "errors", schema={"type": "integer"})
+        add_extra_option(app, "result", schema={"type": "string"})
+    else:
+        add_extra_option(app, "time")
+        add_extra_option(app, "suites")
+        add_extra_option(app, "cases")
+        add_extra_option(app, "passed")
+        add_extra_option(app, "skipped")
+        add_extra_option(app, "failed")
+        add_extra_option(app, "errors")
+        add_extra_option(app, "result")
     # Extra dynamic functions
     # For details about usage read
     # https://sphinx-needs.readthedocs.io/en/latest/api.html#sphinx_needs.api.configuration.add_dynamic_function