sphinx-test-reports 1.1.0__py3-none-any.whl

docs/conf.py

@@ -0,0 +1,210 @@
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/stable/config
+
+# -- Path setup --------------------------------------------------------------
+
+import datetime
+import os
+
+# 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.append(os.path.abspath("."))
+
+from ub_theme.conf import html_theme_options  # noqa
+
+# -- Project information -----------------------------------------------------
+
+project = "sphinx-test-reports"
+now = datetime.datetime.now()
+copyright = f"team useblocks, 2017-{now.year}"
+author = "team useblocks"
+
+# The short X.Y version
+version = "1.1"
+# The full version, including alpha/beta/rc tags
+release = "1.1.0"
+
+needs_id_regex = ".*"
+needs_css = "dark.css"
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_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",
+    "sphinxcontrib.plantuml",
+    "sphinx_design",
+    "sphinx_immaterial",
+]
+
+cwd = os.getcwd()
+plantuml = "java -jar %s" % os.path.join(cwd, "utils/plantuml.jar")
+
+# If we are running on windows, we need to manipulate the path,
+# otherwise plantuml will have problems.
+if os.name == "nt":
+    plantuml = plantuml.replace("/", "\\")
+    plantuml = plantuml.replace("\\", "\\\\")
+
+plantuml_output_format = "png"
+
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates", "ub_theme/templates"]
+# Add a custom test report template. Please add a relative path from this conf.py
+# tr_report_template = "./custom_test_report_template.txt"
+
+# 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"
+
+# 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 pattern also affects html_static_path and html_extra_path .
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
+
+
+# -- 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 = "sphinx_immaterial"
+
+# 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_logo = "_static/sphinx-test-reports-logo.svg"
+html_favicon = "_static/sphinx-test-reports-logo.svg"
+html_title = "Sphinx-Test-Reports"
+
+other_options = {
+    "repo_url": "https://github.com/useblocks/sphinx-test-reports",
+    "repo_name": "sphinx-test-reports",
+    "font": False,
+}
+html_theme_options.update(other_options)
+html_theme_options["features"].extend(["navigation.tabs", "navigation.tabs.sticky"])
+# 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", "ub_theme/css", "ub_theme/js"]
+html_css_files = ["ub-theme.css"]
+html_js_files = ["jquery.js"]
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "sphinx-test-reportsdoc"
+
+
+# -- 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,
+        "sphinx-test-reports.tex",
+        "sphinx-test-reports 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,
+        "sphinx-test-reports",
+        "sphinx-test-reports 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,
+        "sphinx-test-reports",
+        "sphinx-test-reports Documentation",
+        author,
+        "sphinx-test-reports",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
+]
+
+# LINKCHECK config
+# https://www.sphinx-doc.org/en/master/usage/configuration.html?highlight=linkcheck#options-for-the-linkcheck-builder
+linkcheck_ignore = [
+    r"http://localhost:\d+",
+    r"http://127.0.0.1:\d+",
+    r"https://fonts.googleapis.com",
+]
+
+linkcheck_request_headers = {
+    "*": {
+        "User-Agent": "Mozilla/5.0",
+    }
+}
+
+linkcheck_workers = 5

docs/ub_theme/conf.py

@@ -0,0 +1,21 @@
+html_theme_options = {
+    "icon": {
+        "repo": "fontawesome/brands/github",
+    },
+    "font": {"code": "JetBrains Mono", "text": "Recursive"},
+    "globaltoc_collapse": True,
+    "features": [
+        "navigation.top",
+        "search.share",
+        "navigation.tracking",
+        "toc.follow",
+        "content.tabs.link",
+    ],
+    "palette": {
+        "scheme": "slate",
+        "primary": "yellow",
+        "accent": "yellow",
+    },
+    "toc_title_is_page_title": True,
+    "toc_title": "Contents",
+}

sphinx_test_reports-1.1.0.dist-info/AUTHORS

@@ -0,0 +1,8 @@
+Maintainers
+-----------
+Daniel Woste <daniel@useblocks.com>
+
+Contributors
+------------
+Peter Tillemans <pti@snamellit.com>
+Saifali Saiyyad <saifalis@kpit.com>

sphinx_test_reports-1.1.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 useblocks
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sphinx_test_reports-1.1.0.dist-info/METADATA

@@ -0,0 +1,49 @@
+Metadata-Version: 2.2
+Name: sphinx-test-reports
+Version: 1.1.0
+Summary: Sphinx extension for showing test results and test environment information inside sphinx documentations
+Author-email: team useblocks <info@useblocks.com>
+License: MIT
+Project-URL: Homepage, https://github.com/useblocks/sphinx-test-reports
+Project-URL: Repository, https://github.com/useblocks/sphinx-test-reports.git
+Project-URL: Documentation, https://sphinx-test-reports.readthedocs.io/en/latest/
+Project-URL: download-url, http://pypi.python.org/pypi/sphinx-test-reports
+Keywords: sphinx,documentation,test-reports
+Classifier: Framework :: Sphinx
+Classifier: Framework :: Sphinx :: Extension
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Documentation
+Requires-Python: >=3.6
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+License-File: AUTHORS
+Requires-Dist: sphinx>4.0
+Requires-Dist: lxml
+Requires-Dist: sphinx-needs>=1.0.1
+Provides-Extra: development
+Requires-Dist: wheel; extra == "development"
+
+Sphinx-Test-Reports
+===================
+
+.. image:: docs/_static/sphinx-test-reports-logo.png
+
+Sphinx-Test-Reports shows test results of your unit tests inside your sphinx documentation.
+
+
+Functions
+---------
+
+* Shows test results of **junit based test xml reports** as table
+* Shows test environment information of **tox-envreport based json reports** as table
+
+

sphinx_test_reports-1.1.0.dist-info/RECORD

@@ -0,0 +1,56 @@
+docs/conf.py,sha256=p9WvQRss8hLDgFYbi9M-B9PZQ--RoqxtHL4QxEZnUCE,6206
+docs/ub_theme/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+docs/ub_theme/conf.py,sha256=jd60YaoVZsNns6y2rAEzWrHl5fM3tC_Z9sTbfg2cfpw,515
+sphinxcontrib/__init__.py,sha256=B9LgGPc-xGhiDTC4XvUjqTtVANpPUzFUZ-l4a0REqG4,70
+sphinxcontrib/test_reports/__init__.py,sha256=SPOwMp5h-c7V12VrsxeJyZQKlurmm6EC9cGJx7ij2qQ,133
+sphinxcontrib/test_reports/environment.py,sha256=arxKCnAgqhgeHrs-c6JmG6HscjHG_t9NsCHI0ZHLVpM,3832
+sphinxcontrib/test_reports/exceptions.py,sha256=aO5y4Q8M5UhOhYINkUH5kmMLdm-EPFCfv4NTuuGXuuY,658
+sphinxcontrib/test_reports/jsonparser.py,sha256=SLgojBDhR5ZLL7e6B10b6ZW2N-Shca1S1LlKEf1A5r4,2726
+sphinxcontrib/test_reports/junitparser.py,sha256=5KKnlc1MOkqAi2XBLgOPL7hbXP9Z-N3lrHrKVvlBmtU,5320
+sphinxcontrib/test_reports/test_reports.py,sha256=H2dt15miTxlAcMnUPK5SmoFIwv_65oCAmA_RTq918so,6184
+sphinxcontrib/test_reports/css/common.css,sha256=V8ZS50xdgItg8eqv_8QWIPmqGD-EZtTe8dEeD4jyGLs,554
+sphinxcontrib/test_reports/directives/__init__.py,sha256=7uwydS6BgRzjs6FLWCsRzeyjDxOr7WRdriibVEfJSo0,268
+sphinxcontrib/test_reports/directives/test_case.py,sha256=zsnGuI_5vzsYtvPgy6TyPb677ZCnONfNqnhz9EtCqPg,5270
+sphinxcontrib/test_reports/directives/test_common.py,sha256=e8OjNNa5cqRtd6Kvnd_B7rTNshw5miZRe9iUYiufus4,4794
+sphinxcontrib/test_reports/directives/test_env.py,sha256=BWYUs8taqoqjGjzhJKKrinaeNXJ-E-NzFCRjhSTkwEY,7752
+sphinxcontrib/test_reports/directives/test_file.py,sha256=txHzMMwz6Ou1Bu6SlKY7e1LZJwwjTPWfJ97ztVKkzRs,4668
+sphinxcontrib/test_reports/directives/test_report.py,sha256=waIMx4quRuyvuKOOOJNODAJWV5ZILp0-2tBpjiaSMzk,2591
+sphinxcontrib/test_reports/directives/test_report_template.txt,sha256=LrPBKyWeTEljBQzpgk1yc__eCYq3YQBg33w8UCpbsEM,1226
+sphinxcontrib/test_reports/directives/test_results.py,sha256=7Mf4m4LUqNLd3yZG30Q-WrnS4-JD5OcR2xmU0F_C9xY,3224
+sphinxcontrib/test_reports/directives/test_suite.py,sha256=d3u7UcBi5bvxwvZ42PNRZXw8DTDfmf7gSeeC9HH8nXo,6854
+sphinxcontrib/test_reports/functions/__init__.py,sha256=xZtQACJ4896oNS6fU6cRXsfOMSa4Ev1e4Kx8ZnsoTkU,643
+tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/conftest.py,sha256=Io2QqoYJ8LnBoWPILk-s_m0Hl43ZO4UWw_jNuw6MytM,1987
+tests/test_basic_doc.py,sha256=4hgYIpfdOGNn26cFcOzdGJhWSyvEaruI5smjLtINbnM,763
+tests/test_custom_template.py,sha256=4uCxrVrPOZM7Ho5JE3bS_6KMRE-hYjUSnYfVB7yAS1I,1213
+tests/test_custom_types.py,sha256=cwYcEygIF6fhlEr4K6HypZoAqz3alR-aztqHq--ofrs,396
+tests/test_env.py,sha256=QXLPFCJOYCsLt7RFcFOUD5gEB6BTTEi-bxWSlSM5S1U,4935
+tests/test_json_parser.py,sha256=q2cT5bmGL184IN9D3WS-l0Lm_DNzZyFYgKsC5rzZZbo,3661
+tests/test_junit_parser.py,sha256=g7Znt9of4sEyYhuSpYs22sydeBYWy7HpnkN-wgdUnpM,4849
+tests/test_needs_linking.py,sha256=v9bN_C1aGDnI8R7KvDCdGlwUZU0SEEWwrmR-s3lk3Pg,697
+tests/test_suites.py,sha256=EAINe-kSoeVP96bh0JIUuLhgKYOnNkJrgmpczFByrbs,957
+tests/test_test_ctest_file.py,sha256=vQNribXSMNYJ913j-19xg4Fm_A_yI_BD_z4IURMvmoE,966
+tests/test_test_file.py,sha256=sem0C-0yErNfl1qulhlk3CUjapnlfVX4KCx1Ad6LvbI,818
+tests/doc_test/basic_doc/conf.py,sha256=h60SIbyYziioayxafO86Flm1uuiIyqtKirXZXsuFN08,4991
+tests/doc_test/custom_tr_koi8_template/conf.py,sha256=aukXZRDK74HJV024q2csSUaPN9j-dM3R7UePqIr-hcE,6313
+tests/doc_test/custom_tr_template/conf.py,sha256=2NkMViRLg-Cj8j3jx5P5VS9McXwoF5hZXRHAxGZ-tW4,6218
+tests/doc_test/custom_tr_utf8_template/conf.py,sha256=pZmkw522Sid4ZXsiJDjWEVpnbTOjyRnmTXj7TahIRhI,6247
+tests/doc_test/custom_types/conf.py,sha256=aavU-igdxUcGovofnQqSrlkdTF4BuDNAgq3i2_4o9Ck,5272
+tests/doc_test/doc_test_ctest_file/conf.py,sha256=7-auDJMrtRtHQ7Tcg-uCIP2WLDURmzj1by13BC5S34o,5536
+tests/doc_test/doc_test_file/conf.py,sha256=Kcgyv4pJnMKv6rfZQ_HeaflJVzAGGpZQwlen2XW6BYc,5668
+tests/doc_test/env_report_doc/conf.py,sha256=QWl9G2H9wgXT__T7Osudf8JOyeugXkuKnq0p2Ye8wwg,4992
+tests/doc_test/env_report_doc_default/conf.py,sha256=QWl9G2H9wgXT__T7Osudf8JOyeugXkuKnq0p2Ye8wwg,4992
+tests/doc_test/env_report_doc_raw/conf.py,sha256=QWl9G2H9wgXT__T7Osudf8JOyeugXkuKnq0p2Ye8wwg,4992
+tests/doc_test/env_report_warnings/conf.py,sha256=h60SIbyYziioayxafO86Flm1uuiIyqtKirXZXsuFN08,4991
+tests/doc_test/json_parser/conf.py,sha256=Twpc3gxTkJZBZ4Ijh_vQQ6mU3VTJRqRDLp-czz56YFY,5621
+tests/doc_test/json_parser_complex/conf.py,sha256=uhKmXykX_pcprshHBJqX99ijJMKM5bP-nRTOXeU52Wg,6598
+tests/doc_test/many_testsuites_doc/conf.py,sha256=AMPDdh7m9J_Y86H43m_Le9547AGNDeBZxDPi0k1tRS4,5038
+tests/doc_test/needs_linking/conf.py,sha256=0jEBI02IFmp-5JiAuCUqDBM-ohvvQjdzMVk4nvvjumI,5682
+tests/doc_test/pytest_6_2/conf.py,sha256=h60SIbyYziioayxafO86Flm1uuiIyqtKirXZXsuFN08,4991
+tests/doc_test/testsuites_doc/conf.py,sha256=h60SIbyYziioayxafO86Flm1uuiIyqtKirXZXsuFN08,4991
+sphinx_test_reports-1.1.0.dist-info/AUTHORS,sha256=j2h0UBwxXNdtrjajgxp6r_OxGkbglygErLWCUcqgJ04,159
+sphinx_test_reports-1.1.0.dist-info/LICENSE,sha256=6DxTIomiCU8AghqNmy3KxfJ285agTt94g-j5wNGLpd8,1066
+sphinx_test_reports-1.1.0.dist-info/METADATA,sha256=_05a5tmZbr2hj1HnKc7Zzde71RHbdwyhHpyBYnVzfAQ,1810
+sphinx_test_reports-1.1.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+sphinx_test_reports-1.1.0.dist-info/top_level.txt,sha256=LQ7aV4J6D-ozAWrOCJPzXzcPWlcVJ6zmRs0YfHukHWc,25
+sphinx_test_reports-1.1.0.dist-info/RECORD,,

sphinx_test_reports-1.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.8.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

sphinx_test_reports-1.1.0.dist-info/top_level.txt

@@ -0,0 +1,3 @@
+docs
+sphinxcontrib
+tests

sphinxcontrib/__init__.py

@@ -0,0 +1 @@
+__import__("pkg_resources").declare_namespace(__name__)  # noqa: F401

sphinxcontrib/test_reports/__init__.py

@@ -0,0 +1,2 @@
+# from sphinxcontrib.test_reports.needs.dyn_functions import Results4Needs
+from sphinxcontrib.test_reports.test_reports import setup

sphinxcontrib/test_reports/css/common.css

@@ -0,0 +1,32 @@
+tr.tr_passed, div.tr_passed {
+    background-color: rgba(0,250,0,0.2) !important;
+}
+
+tr.tr_failure, div.tr_failure {
+    background-color: rgba(250,0,0,0.2) !important;
+}
+
+tr.tr_skipped{
+    background-color: rgba(0,0,0,0.1) !important;
+}
+
+td.status p {
+    padding: 3px 5px;
+    text-align: center;
+    border-radius: 10px;
+}
+
+td.status p.tr_passed{
+    border: 1px solid #008000;
+    color: #008000;
+}
+
+td.status p.tr_failure{
+    border: 1px solid #800000;
+    color: #800000;
+}
+
+td.status p.tr_skipped{
+    border: 1px solid #555;
+    color: #555;
+}

sphinxcontrib/test_reports/directives/__init__.py

@@ -0,0 +1,5 @@
+# from .test_case import TestCase, TestCaseDirective
+# from .test_common import TestCommonDirective
+# from .test_file import TestFile, TestFileDirective
+# from .test_report import TestReport, TestReportDirective
+# from .test_suite import TestSuite, TestSuiteDirective

sphinxcontrib/test_reports/directives/test_case.py

@@ -0,0 +1,178 @@
+from docutils import nodes
+from docutils.parsers.rst import directives
+from sphinx_needs.api import add_need
+from sphinx_needs.utils import add_doc
+
+from sphinxcontrib.test_reports.directives.test_common import TestCommonDirective
+from sphinxcontrib.test_reports.exceptions import TestReportInvalidOption
+
+
+class TestCase(nodes.General, nodes.Element):
+    pass
+
+
+class TestCaseDirective(TestCommonDirective):
+    """
+    Directive for showing test suites.
+    """
+
+    has_content = True
+    required_arguments = 1
+    optional_arguments = 0
+    option_spec = {
+        "id": directives.unchanged_required,
+        "status": directives.unchanged_required,
+        "tags": directives.unchanged_required,
+        "links": directives.unchanged_required,
+        "collapse": directives.unchanged_required,
+        "file": directives.unchanged_required,
+        "suite": directives.unchanged_required,
+        "case": directives.unchanged_required,
+        "classname": directives.unchanged_required,
+    }
+
+    final_argument_whitespace = True
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+    def run(self, nested=False, suite_count=-1, case_count=-1):
+        self.prepare_basic_options()
+        self.load_test_file()
+
+        if nested and suite_count >= 0:
+            # access n-th nested suite here
+            self.results = self.results[0]["testsuites"][suite_count]
+
+        suite_name = self.options.get("suite")
+
+        if suite_name is None:
+            raise TestReportInvalidOption("Suite not given!")
+
+        case_full_name = self.options.get("case")
+        class_name = self.options.get("classname")
+        if case_full_name is None and class_name is None:
+            raise TestReportInvalidOption("Case or classname not given!")
+
+        suite = None
+        for suite_obj in self.results:
+            if nested:  # nested testsuites
+                suite = self.results
+                break
+
+            elif suite_obj["name"] == suite_name:
+                suite = suite_obj
+                break
+
+        if suite is None:
+            raise TestReportInvalidOption(f"Suite {suite_name} not found in test file {self.test_file}")
+
+        case = None
+
+        for case_obj in suite["testcases"]:
+            if case_obj["name"] == case_full_name and class_name is None:  # noqa: SIM114  # noqa: W503
+                case = case_obj
+                break
+
+            elif case_obj["classname"] == class_name and case_full_name is None:  # noqa: SIM114  # noqa: W503
+                case = case_obj
+                break
+
+            elif case_obj["name"] == case_full_name and case_obj["classname"] == class_name:  # noqa: W503
+                case = case_obj
+                break
+
+            elif nested and case_count >= 0:
+                # access correct case in list
+                case = suite["testcases"][case_count]
+                break
+
+            elif nested:
+                case = case_obj
+                break
+
+        if case is None:
+            raise TestReportInvalidOption(
+                "Case {} with classname {} not found in test file {} "
+                "and testsuite {}".format(case_full_name, class_name, self.test_file, suite_name)
+            )
+
+        result = case["result"]
+        content = self.test_content
+        if case["text"] is not None and len(case["text"]) > 0:
+            content += """
+
+**Text**::
+
+   {}
+
+""".format(
+                "\n   ".join([x.lstrip() for x in case["text"].split("\n")])
+            )
+
+        if case["message"] is not None and len(case["message"]) > 0:
+            content += """
+
+**Message**::
+
+   {}
+
+""".format(
+                "\n   ".join([x.lstrip() for x in case["message"].split("\n")])
+            )
+
+        if case["system-out"] is not None and len(case["system-out"]) > 0:
+            content += """
+
+**System-out**::
+
+   {}
+
+""".format(
+                "\n   ".join([x.lstrip() for x in case["system-out"].split("\n")])
+            )
+
+        time = case["time"]
+        style = "tr_" + case["result"]
+
+        import re
+
+        groups = re.match(r"^(?P<name>[^\[]+)($|\[(?P<param>.*)?\])", case["name"])
+        try:
+            case_name = groups["name"]
+            case_parameter = groups["param"]
+        except TypeError:
+            case_name = case_full_name
+            case_parameter = ""
+
+        if case_parameter is None:
+            case_parameter = ""
+
+        main_section = []
+        docname = self.state.document.settings.env.docname
+        main_section += add_need(
+            self.app,
+            self.state,
+            docname,
+            self.lineno,
+            need_type=self.need_type,
+            title=self.test_name,
+            id=self.test_id,
+            content=content,
+            links=self.test_links,
+            tags=self.test_tags,
+            status=self.test_status,
+            collapse=self.collapse,
+            file=self.test_file_given,
+            suite=suite["name"],
+            case=case_full_name,
+            case_name=case_name,
+            case_parameter=case_parameter,
+            classname=class_name,
+            result=result,
+            time=time,
+            style=style,
+        )
+
+        add_doc(self.env, docname)
+        return main_section