Implement validation (#10)

* Introduce "docbuild validate" command
* Add XML checks
  * Taken from docserv repo, share/validate-product-config/checks/
  * Add tests for positive and negative outcome
  * Add xmlnode fixture
  * Add decorator to registry XML checks
  * Add factory_registry() and RegistryDecorator
* Add pytest-asyncio as test requirement
* VSCode: Add "tmp/" in files.exclude
* Update doc sources
* Add RNC schema and stylesheet
  * Add product config schema
  * Add simplify.xsl stylesheet
  * Update `pyproject.toml` to include rnc and xslt from docbuild.xml.data
* Resolve XIncludes with xmllint and validate with jing
  Although Jing does know XIncludes to some degree by using the Xerces
  parser, Xerces does not fully understand XPointers.

  To circumvent this issue, we need to use xmllint to the rescue. It knows
  more XPointer expressions and can resolve them correctly.

  Algorithm:
  1. Create an (async) subprocess with xmllint calling "xmllint --xinclude FILE".
     Output result to an intermediate temporary file.
     Unfortunately, this is needed as the current "jing" script on openSUSE
     doesn't support reading from stdin.
  2. Check if return code is zero. If not, return
  3. Create an (async) subprocess with jing. It uses the output from step 1
     and validates it with the RNC schema.

Author: tomschr

.coveragerc

@@ -1,3 +1,13 @@
 [run]
 concurrency = multiprocessing
 parallel = true
+
+[report]
+precision = 1
+exclude_lines =
+   pragma: no cover
+   raise NotImplementedError
+   if TYPE_CHECKING:
+   if __name__ == .__main__.:
+   if 0:
+   if False:

.pytest.ini

@@ -19,7 +19,12 @@ addopts =
     --cov=docbuild
     --cov-branch
     --cov-report=term-missing
-    --cov-fail-under=90
     --doctest-glob='*.rst'
     --doctest-modules
     --doctest-report ndiff
+
+# See https://docs.python.org/3/library/doctest.html#option-flags-and-directives
+doctest_optionflags = NORMALIZE_WHITESPACE IGNORE_EXCEPTION_DETAIL
+
+# From pytest-asyncio:
+asyncio_mode = auto

.vscode/settings.json

@@ -10,7 +10,8 @@
         ".pytest_cache/": true,
         ".ruff_cache/": true,
         ".venv*/": true,
-        "**/*.egg-info/": true
+        "**/*.egg-info/": true,
+	"tmp/": true
     },
     "python.analysis.diagnosticsSource": "Pyright",
     "python.analysis.typeCheckingMode": "standard",

IDEAS.md

@@ -13,3 +13,12 @@ This is a unsorted collection of ideas what could be implemented.
 
 * `Deliverable`
    support subdeliverables?
+
+* Implement a "check environment" function.
+  Before we really do anything, this check some prerequisites:
+   * Checks if certain commands are available (e.g. `git`, `jing`)
+   * Check if commands have a minimum version
+   * Check if the available space is enough (can be customized in the envconfig)
+   * More...?
+  
+  This should help that it breaks in the middle of, for example, a build operation.

changelog.d/5.validation.feature.rst

@@ -0,0 +1,3 @@
+Implement :command:`validate` subcommand
+
+This subcommand is used to validate XML configuration files against a RelaxNG schema. It checks both the structure and semantic correctness of the XML files to ensure they conform to the expected format.

docs/source/reference/_autoapi/docbuild/cli/cmd_validate/index.rst

@@ -0,0 +1,29 @@
+docbuild.cli.cmd_validate
+=========================
+
+.. py:module:: docbuild.cli.cmd_validate
+
+.. autoapi-nested-parse::
+
+   CLI interface to validate XML configuration files.
+
+
+
+Functions
+---------
+
+.. autoapisummary::
+
+   docbuild.cli.cmd_validate.validate
+
+
+Module Contents
+---------------
+
+.. py:function:: validate(ctx: click.Context, xmlfiles: tuple | collections.abc.Iterator[pathlib.Path]) -> None
+
+   Subcommand to validate XML configuration files.
+
+   :param ctx: The Click context object.
+
+

docs/source/reference/_autoapi/docbuild/cli/index.rst

@@ -27,6 +27,7 @@ Submodules
    /reference/_autoapi/docbuild/cli/cmd_build/index
    /reference/_autoapi/docbuild/cli/cmd_c14n/index
    /reference/_autoapi/docbuild/cli/cmd_cli/index
+   /reference/_autoapi/docbuild/cli/cmd_validate/index
    /reference/_autoapi/docbuild/cli/config/index
    /reference/_autoapi/docbuild/cli/context/index
    /reference/_autoapi/docbuild/cli/defaults/index

docs/source/reference/_autoapi/docbuild/config/index.rst

@@ -5,7 +5,7 @@ docbuild.config
 
 .. autoapi-nested-parse::
 
-   Configuration for app and env config.
+   Tools for app, env, and XML config.
 
 
 

docs/source/reference/_autoapi/docbuild/config/xml/checks/CheckResult.rst

@@ -0,0 +1,13 @@
+docbuild.config.xml.checks.CheckResult
+======================================
+
+.. py:class:: docbuild.config.xml.checks.CheckResult
+
+   Result of a validation check.
+
+
+   .. py:method:: __bool__() -> bool
+
+      Return True if the check was successful, False otherwise.
+
+