Adds tr_suite_id_length and tr_case_id_length

Fixes #45

docs/changelog.rst

@@ -5,7 +5,8 @@ Changelog
 -----
 :Released: under development
 
-
+* Enhancement: 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>`_
 

docs/configuration.rst

@@ -78,4 +78,28 @@ tr_report_template
 **A simple example with a scrambled order:**
 
 .. literalinclude:: ./custom_test_report_template.txt
-   :language: rst
+   :language: rst
+
+.. _tr_suite_id_length:
+
+tr_suite_id_length
+------------------
+.. versionadded:: 1.0.1
+
+Defines the length of the calculated ID for test suites.
+
+This may be needed, if a junit-xml files contains many test suites.
+
+Default: **3**
+
+.. _tr_case_id_length:
+
+tr_case_id_length
+------------------
+.. versionadded:: 1.0.1
+
+Defines the length of the calculated ID for test cases.
+
+This may be needed, if a junit-xml files contains many test cases.
+
+Default: **5**

sphinxcontrib/test_reports/directives/test_file.py

@@ -36,6 +36,7 @@ class TestFileDirective(TestCommonDirective):
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
+        self.suite_ids = {}
 
     def run(self):
         self.prepare_basic_options()
@@ -102,9 +103,16 @@ def run(self):
                     "_"
                     + hashlib.sha1(suite["name"].encode("UTF-8"))  # noqa: W503
                     .hexdigest()
-                    .upper()[:3]
+                    .upper()[: self.app.config.tr_suite_id_length]
                 )
 
+                if suite_id not in self.suite_ids:
+                    self.suite_ids[suite_id] = suite["name"]
+                else:
+                    raise Exception(
+                        f'Suite ID {suite_id} already exists by {self.suite_ids[suite_id]} ({suite["name"]})'
+                    )
+
                 options = self.options
                 options["suite"] = suite["name"]
                 options["id"] = suite_id

sphinxcontrib/test_reports/directives/test_suite.py

@@ -35,6 +35,7 @@ class TestSuiteDirective(TestCommonDirective):
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
+        self.case_ids = []
 
     def run(self, nested=False, count=-1):
         self.prepare_basic_options()
@@ -107,7 +108,7 @@ def run(self, nested=False, count=-1):
                     "_"
                     + hashlib.sha1(suite["name"].encode("UTF-8"))  # noqa: W503
                     .hexdigest()
-                    .upper()[:3]
+                    .upper()[: self.app.config.tr_suite_id_length]
                 )
 
                 options = self.options
@@ -154,9 +155,14 @@ def run(self, nested=False, count=-1):
                         case["classname"].encode("UTF-8") + case["name"].encode("UTF-8")
                     )
                     .hexdigest()
-                    .upper()[:5]
+                    .upper()[: self.app.config.tr_case_id_length]
                 )
 
+                if case_id not in self.case_ids:
+                    self.case_ids.append(case_id)
+                else:
+                    raise Exception(f"Case ID exists: {case_id}")
+
                 # We need to copy self.options, otherwise it gets updated and sets same values
                 # for all testsuites.
                 options = self.options.copy()

sphinxcontrib/test_reports/test_reports.py

@@ -60,6 +60,9 @@ def setup(app):
     )
     app.add_config_value("tr_report_template", template_dir, "html")
 
+    app.add_config_value("tr_suite_id_length", 3, "html")
+    app.add_config_value("tr_case_id_length", 5, "html")
+
     # nodes
     app.add_node(TestResults)
     app.add_node(TestFile)

tests/doc_test/many_testsuites_doc/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/many_testsuites_doc/conf.py

@@ -0,0 +1,164 @@
+#
+# 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"]
+
+tr_suite_id_length = 7
+tr_case_id_length = 10
+
+# 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"
+
+# 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/many_testsuites_doc/index.rst

@@ -0,0 +1,11 @@
+Basic Document
+==============
+
+
+.. test-file:: My test data
+   :file: ../utils/many_testsuites.xml
+   :id: TEST_001
+   :auto_suites:
+   :auto_cases:
+   :tags: unit-test
+

tests/doc_test/many_testsuites_doc/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/testsuites_doc/Makefile

@@ -17,4 +17,4 @@ help:
 # 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)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)