support ctest junit file parsing UPDATE (#53)

[#49] support ctest junit file parsing

Fixes #49

Co-authored-by: Joerg Kreuzberger <j.kreuzberger@procitec.de>

docs/changelog.rst

@@ -7,13 +7,14 @@ Changelog
 
 * Bugfix: Links in `test-suite` and co. do not raise error.
   `#51 <https://github.com/useblocks/sphinx-test-reports/issues/51>`_
-
+* Improvement: Allows empty text and message fields, which allows integration of ctest junit files
+  `#49 <https://github.com/useblocks/sphinx-test-reports/issues/49>`_
 
 1.0.1
 -----
 :Released: 04.11.2022
 
-* Enhancement: ID length can be configured to avoid conflicts. See :ref:`tr_suite_id_length` and :ref:`tr_case_id_length`.
+* Improvement: ID length can be configured to avoid conflicts. See :ref:`tr_suite_id_length` and :ref:`tr_case_id_length`.
   `#45 <https://github.com/useblocks/sphinx-test-reports/issues/45>`_
 * Bugfix: Multiple testsuites get documented correctly.
   `#40 <https://github.com/useblocks/sphinx-test-reports/issues/40>`_

noxfile.py

@@ -1,7 +1,7 @@
 import nox
 from nox import session
 
-PYTHON_VERSIONS = ["3.8", "3.9"]
+PYTHON_VERSIONS = ["3.8", "3.9", "3.10"]
 SPHINX_VERSIONS = ["5.0"]
 TEST_DEPENDENCIES = [
     "pytest",

sphinxcontrib/test_reports/directives/test_case.py

@@ -114,7 +114,7 @@ def run(self, nested=False, suite_count=-1, case_count=-1):
 
         result = case["result"]
         content = self.test_content
-        if len(case["text"]) > 0:
+        if case["text"] is not None and len(case["text"]) > 0:
             content += """
 
 **Text**::
@@ -125,7 +125,7 @@ def run(self, nested=False, suite_count=-1, case_count=-1):
                 "\n   ".join([x.lstrip() for x in case["text"].split("\n")])
             )
 
-        if len(case["message"]) > 0:
+        if case["message"] is not None and len(case["message"]) > 0:
             content += """
 
 **Message**::
@@ -136,7 +136,7 @@ def run(self, nested=False, suite_count=-1, case_count=-1):
                 "\n   ".join([x.lstrip() for x in case["message"].split("\n")])
             )
 
-        if len(case["system-out"]) > 0:
+        if case["system-out"] is not None and len(case["system-out"]) > 0:
             content += """
 
 **System-out**::

sphinxcontrib/test_reports/directives/test_results.py

@@ -85,7 +85,7 @@ def _create_testcase_row(self, testcase):
             "\n\n".join(
                 [
                     testcase["message"] if testcase["message"] != "unknown" else "",
-                    testcase["text"],
+                    testcase["text"] if testcase["text"] is not None else "",
                 ]
             ),
         )

tests/doc_test/doc_test_ctest_file/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = needstestdocs
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

tests/doc_test/doc_test_ctest_file/conf.py

@@ -0,0 +1,194 @@
+#
+# testreport test docs documentation build configuration file, created by
+# sphinx-quickstart on Tue Mar 28 11:37:14 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("../../sphinxcontrib"))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation testreport a minimal Sphinx version, state it here.
+#
+# testreport_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+
+extensions = ["sphinx_needs", "sphinxcontrib.test_reports"]
+
+# needs_types = [
+# {
+# "directive": "story",
+# "title": "User Story",
+# "prefix": "US_",
+# "color": "#BFD8D2",
+# "style": "node",
+# },
+# {
+# "directive": "spec",
+# "title": "Specification",
+# "prefix": "SP_",
+# "color": "#FEDCD2",
+# "style": "node",
+# },
+# {
+# "directive": "impl",
+# "title": "Implementation",
+# "prefix": "IM_",
+# "color": "#DF744A",
+# "style": "node",
+# },
+# {
+# "directive": "test",
+# "title": "Test Case",
+# "prefix": "TC_",
+# "color": "#DCB239",
+# "style": "node",
+# },
+# ]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = ".rst"
+
+# The master toctree document.
+master_doc = "index"
+
+needs_extra_options = ["asil", "uses_secure"]
+
+# General information about the project.
+project = "test-report test docs"
+copyright = "2017, team useblocks"
+author = "team useblocks"
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = "1.0"
+# The full version, including alpha/beta/rc tags.
+release = "1.0"
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = "en"
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "alabaster"
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+# html_static_path = ["_static"]
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "testreporttestdocsdoc"
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (
+        master_doc,
+        "testreporttestdocs.tex",
+        "testreport test docs Documentation",
+        "team useblocks",
+        "manual",
+    ),
+]
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (
+        master_doc,
+        "testreporttestdocs",
+        "testreport test docs Documentation",
+        [author],
+        1,
+    )
+]
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (
+        master_doc,
+        "testreporttestdocs",
+        "testreport test docs Documentation",
+        author,
+        "testreporttestdocs",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
+]

tests/doc_test/doc_test_ctest_file/index.rst

@@ -0,0 +1,17 @@
+Basic Document FOR CTEST FILE
+=============================
+
+.. test-case:: My CTest Case
+   :file: ../utils/ctest.xml
+   :suite: Linux-c++
+   :classname: usage_test
+   :id: TEST_CTEST_1
+
+
+.. test-results:: ../utils/ctest.xml
+
+.. test-file:: My CTest Data
+   :file: ../utils/ctest.xml
+   :id: CTESTFILE_1
+   :auto_suites:
+   :auto_cases:

tests/doc_test/doc_test_ctest_file/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+set SPHINXPROJ=needstestdocs
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

tests/doc_test/utils/ctest.xml

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuite name="Linux-c++"
+	tests="4"
+	failures="1"
+	disabled="0"
+	skipped="0"
+	hostname=""
+	time="0"
+	timestamp="2022-12-08T15:15:07"
+	>
+	<testcase name="usage_test" classname="usage_test" time="0.000609293" status="run">
+		<system-out>usage: test &lt;argument&gt;
+    If &lt;argument&gt; is 0, print SUCCESS. Otherwise print FAIL.
+</system-out>
+	</testcase>
+	<testcase name="success_test" classname="success_test" time="0.000605907" status="run">
+		<system-out>SUCCESS
+</system-out>
+	</testcase>
+	<testcase name="fail_test" classname="fail_test" time="0.000599379" status="run">
+		<system-out>FAIL
+</system-out>
+	</testcase>
+	<testcase name="fail_test_output" classname="fail_test_output" time="0.000576548" status="fail">
+		<failure message=""/>
+		<system-out>FAIL
+</system-out>
+	</testcase>
+</testsuite>