ub-test-reports 1.0.0__tar.gz

ub_test_reports-1.0.0/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.

ub_test_reports-1.0.0/PKG-INFO

@@ -0,0 +1,66 @@
+Metadata-Version: 2.5
+Name: ub-test-reports
+Version: 1.0.0
+Summary: Test results as needs without Sphinx: report parsers, the needs.json converter and the pytest plugin
+Keywords: test-reports,junit,needs.json,sphinx-needs,pytest
+Author-email: team useblocks <info@useblocks.com>
+Requires-Python: >=3.11,<4
+Description-Content-Type: text/x-rst
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+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 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Testing
+Classifier: Typing :: Typed
+License-File: LICENSE
+Requires-Dist: lxml
+Requires-Dist: ub-project>=1.1.0,<2
+Requires-Dist: pytest>=7.0 ; extra == "pytest"
+Project-URL: Changelog, https://github.com/useblocks/sphinx-needs/blob/master/packages/ub-test-reports/docs/changelog.rst
+Project-URL: Documentation, https://sphinx-test-reports.readthedocs.io/en/latest/
+Project-URL: Issues, https://github.com/useblocks/sphinx-needs/issues
+Project-URL: Repository, https://github.com/useblocks/sphinx-needs
+Provides-Extra: pytest
+Import-Name: ub_test_reports
+
+ub-test-reports
+===============
+
+A tool for the sphinx-needs family -- not a Sphinx extension, and nothing to add to
+``conf.py``.
+
+It turns test results into needs without running Sphinx, and holds everything about test
+reports that does not need a documentation build:
+
+- **the parsers** -- JUnit XML (pytest, googletest, ctest, nose and friends) and
+  tox-envreport style JSON;
+- **the result vocabulary** -- one spelling for every outcome, whichever report it came
+  from;
+- **deterministic case IDs** -- the same case gets the same need ID in every run;
+- **the** ``[test_reports]`` **model** of ``ubproject.toml``, read through ``ub-project``;
+- **the converter** -- the ``test-reports build needs`` command, which writes a
+  ``needs.json`` that sphinx-needs can import;
+- **the pytest plugin** -- ``-p ub_test_reports.pytest_plugin``, which shapes the JUnit XML
+  pytest writes (source locations, per-case properties for traceability).
+
+Install the converter with::
+
+    pip install ub-test-reports
+
+and the pytest plugin with::
+
+    pip install "ub-test-reports[pytest]"
+
+To show the same reports inside a Sphinx documentation build, install the extension,
+``sphinx-test-reports``, which depends on this package.
+
+Documentation: the "Without Sphinx" section of https://sphinx-test-reports.readthedocs.io/en/latest/
+

ub_test_reports-1.0.0/README.rst

@@ -0,0 +1,32 @@
+ub-test-reports
+===============
+
+A tool for the sphinx-needs family -- not a Sphinx extension, and nothing to add to
+``conf.py``.
+
+It turns test results into needs without running Sphinx, and holds everything about test
+reports that does not need a documentation build:
+
+- **the parsers** -- JUnit XML (pytest, googletest, ctest, nose and friends) and
+  tox-envreport style JSON;
+- **the result vocabulary** -- one spelling for every outcome, whichever report it came
+  from;
+- **deterministic case IDs** -- the same case gets the same need ID in every run;
+- **the** ``[test_reports]`` **model** of ``ubproject.toml``, read through ``ub-project``;
+- **the converter** -- the ``test-reports build needs`` command, which writes a
+  ``needs.json`` that sphinx-needs can import;
+- **the pytest plugin** -- ``-p ub_test_reports.pytest_plugin``, which shapes the JUnit XML
+  pytest writes (source locations, per-case properties for traceability).
+
+Install the converter with::
+
+    pip install ub-test-reports
+
+and the pytest plugin with::
+
+    pip install "ub-test-reports[pytest]"
+
+To show the same reports inside a Sphinx documentation build, install the extension,
+``sphinx-test-reports``, which depends on this package.
+
+Documentation: the "Without Sphinx" section of https://sphinx-test-reports.readthedocs.io/en/latest/

ub_test_reports-1.0.0/pyproject.toml

@@ -0,0 +1,60 @@
+[project]
+name = "ub-test-reports"
+version = "1.0.0"
+description = "Test results as needs without Sphinx: report parsers, the needs.json converter and the pytest plugin"
+authors = [{ name = "team useblocks", email = "info@useblocks.com" }]
+license = { file = "LICENSE" }
+readme = "README.rst"
+requires-python = ">=3.11,<4"
+# NO Sphinx, docutils or sphinx-needs, and that is the package's whole contract: the
+# converter runs as a build action and the plugin inside a test run, neither of which has a
+# documentation toolchain. ub-project is the `ubproject.toml` reader, TIGHT-tracked like
+# every intra-workspace edge (`check_workspace.py` check (4)); `propagate_floors.py` moves
+# the floor at each ub-project release. The `toolchain-free` CI job installs the built wheel
+# where Sphinx is absent and runs the whole suite there
+dependencies = ["lxml", "ub-project>=1.1.0,<2"]
+keywords = ["test-reports", "junit", "needs.json", "sphinx-needs", "pytest"]
+# NOT `Framework :: Sphinx`: nothing here depends on Sphinx
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Framework :: Pytest",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Topic :: Software Development :: Testing",
+  "Typing :: Typed",
+]
+
+[project.optional-dependencies]
+# The pytest plugin (`-p ub_test_reports.pytest_plugin`); pytest is not a dependency of the
+# converter. 7.0 is where everything the plugin uses exists (pytest.Config/Item/Mark,
+# Config.stash, issue_config_time_warning). pytest before 7.3.2 does not run on Python
+# 3.12 at all -- that floor is pytest's own, not this one's. The `plugin-floor` CI job runs
+# the whole suite on pytest 7.0.1 (Python 3.11) and 7.3.2 (Python 3.12).
+pytest = ["pytest>=7.0"]
+
+[project.scripts]
+test-reports = "ub_test_reports.cli:main"
+
+[project.urls]
+Documentation = "https://sphinx-test-reports.readthedocs.io/en/latest/"
+Repository = "https://github.com/useblocks/sphinx-needs"
+Issues = "https://github.com/useblocks/sphinx-needs/issues"
+Changelog = "https://github.com/useblocks/sphinx-needs/blob/master/packages/ub-test-reports/docs/changelog.rst"
+
+[build-system]
+requires = ["flit_core >=3.4,<5"]
+build-backend = "flit_core.buildapi"
+
+# Deliberately NO `[tool.flit.sdist]`: flit's default sdist is the module (with its
+# `py.typed` marker and `schemas/JUnit.xsd`), README, LICENSE and this file, and nothing
+# else -- so neither `tests/` (and its fixture copies) nor `docs/` ships. Everything else --
+# ruff, ty, pytest and the dependency groups -- is the ROOT's, and
+# `tools/src/sn_tools/check_workspace.py` refuses those tables here.

ub_test_reports-1.0.0/src/ub_test_reports/__init__.py

@@ -0,0 +1,17 @@
+"""ub-test-reports: test results as needs, without Sphinx.
+
+The report parsers, the result vocabulary, the deterministic case IDs, the
+``[test_reports]`` model of ``ubproject.toml``, the needs.json converter behind the
+``test-reports`` command, and the pytest plugin (``-p ub_test_reports.pytest_plugin``).
+The modules are the API; this file only carries the version.
+
+**Nothing in this package may import Sphinx, sphinx-needs or docutils** -- not at module
+level and not in a function body. sphinx-test-reports, the Sphinx extension, depends on
+this package, never the other way round.
+"""
+
+__all__ = ["__version__"]
+
+#: Checked against ``[project] version`` by ``check_workspace.py`` and stamped by
+#: ``poe bump``.
+__version__ = "1.0.0"