core-tests 2.1.0__tar.gz → 2.2.0__tar.gz

{core_tests-2.1.0 → core_tests-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: core-tests
-Version: 2.1.0
+Version: 2.2.0
 Summary: It contains common elements for testing purposes...
 Author-email: Alejandro Cora González <alek.cora.glez@gmail.com>
 Maintainer: Alejandro Cora González
@@ -31,7 +31,7 @@ Requires-Dist: click>=8.1.8
 Requires-Dist: coverage>=7.7.1
 Requires-Dist: environs>=14.1.1
 Provides-Extra: dev
-Requires-Dist: core-dev-tools>=2.0.0; extra == "dev"
+Requires-Dist: core-dev-tools>=2.1.0; extra == "dev"
 Dynamic: license-file
 
 core-tests
@@ -52,6 +52,10 @@ case than routing it through this abstraction layer.
 
 ===============================================================================
 
+.. image:: https://static.pepy.tech/personalized-badge/core-tests?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLACK&right_color=GREEN&left_text=downloads
+    :target: https://pepy.tech/projects/core-tests
+    :alt: PyPI Downloads
+
 .. image:: https://img.shields.io/pypi/pyversions/core-tests.svg
     :target: https://pypi.org/project/core-tests/
     :alt: Python Versions
@@ -100,6 +104,11 @@ Features
 
 * **Custom Pattern Support**: Override discovery with ``--pattern`` for
   non-standard file layouts.
+* **Enforced Coverage**: ``run-coverage`` applies the ``fail_under`` setting of
+  your coverage configuration, or ``--fail-under`` for a single run, and exits
+  non-zero when the total is below it.
+* **CI-ready Reports**: Writes ``coverage.xml`` (Cobertura, relative paths)
+  beside the HTML report, so a CI platform can annotate a merge request diff.
 * **Test Organization**: Target specific test directories (unit, integration,
   functional, etc.) via ``--test-type``.
 * **Branch Coverage Reports**: Generate branch-level coverage reports and
@@ -176,8 +185,11 @@ Generate code coverage reports across all test directories:
 
 **Options:**
 
-* ``--save-report``: Save HTML and data coverage reports to disk.
+* ``--save-report``: Save HTML, XML and data coverage reports to disk.
   Default: ``True``
+* ``--fail-under``: Minimum total coverage percentage. Exits non-zero below it,
+  and takes precedence over the ``fail_under`` setting of the coverage
+  configuration. Default: unset, so the configured value applies.
 
 **Examples:**
 
@@ -185,6 +197,11 @@ Generate code coverage reports across all test directories:
 
     python manager.py run-coverage
     python manager.py run-coverage --save-report false
+    python manager.py run-coverage --fail-under 90
+
+The HTML report lands in ``htmlcov/``, and a Cobertura ``coverage.xml`` beside
+it, with paths relative to the working directory so a CI platform can map them
+onto the repository.
 
 
 Quick Start

{core_tests-2.1.0 → core_tests-2.2.0}/README.rst

@@ -16,6 +16,10 @@ case than routing it through this abstraction layer.
 
 ===============================================================================
 
+.. image:: https://static.pepy.tech/personalized-badge/core-tests?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLACK&right_color=GREEN&left_text=downloads
+    :target: https://pepy.tech/projects/core-tests
+    :alt: PyPI Downloads
+
 .. image:: https://img.shields.io/pypi/pyversions/core-tests.svg
     :target: https://pypi.org/project/core-tests/
     :alt: Python Versions
@@ -64,6 +68,11 @@ Features
 
 * **Custom Pattern Support**: Override discovery with ``--pattern`` for
   non-standard file layouts.
+* **Enforced Coverage**: ``run-coverage`` applies the ``fail_under`` setting of
+  your coverage configuration, or ``--fail-under`` for a single run, and exits
+  non-zero when the total is below it.
+* **CI-ready Reports**: Writes ``coverage.xml`` (Cobertura, relative paths)
+  beside the HTML report, so a CI platform can annotate a merge request diff.
 * **Test Organization**: Target specific test directories (unit, integration,
   functional, etc.) via ``--test-type``.
 * **Branch Coverage Reports**: Generate branch-level coverage reports and
@@ -140,8 +149,11 @@ Generate code coverage reports across all test directories:
 
 **Options:**
 
-* ``--save-report``: Save HTML and data coverage reports to disk.
+* ``--save-report``: Save HTML, XML and data coverage reports to disk.
   Default: ``True``
+* ``--fail-under``: Minimum total coverage percentage. Exits non-zero below it,
+  and takes precedence over the ``fail_under`` setting of the coverage
+  configuration. Default: unset, so the configured value applies.
 
 **Examples:**
 
@@ -149,6 +161,11 @@ Generate code coverage reports across all test directories:
 
     python manager.py run-coverage
     python manager.py run-coverage --save-report false
+    python manager.py run-coverage --fail-under 90
+
+The HTML report lands in ``htmlcov/``, and a Cobertura ``coverage.xml`` beside
+it, with paths relative to the working directory so a CI platform can map them
+onto the repository.
 
 
 Quick Start

{core_tests-2.1.0 → core_tests-2.2.0}/core_tests/__init__.py

@@ -1,11 +1,8 @@
-# -*- coding: utf-8 -*-
-
 """
 Provides common elements for testing purposes.
 """
 
-from importlib.metadata import PackageNotFoundError
-from importlib.metadata import version
+from importlib.metadata import PackageNotFoundError, version
 
 from core_tests.tests.base import BaseTestCase
 from core_tests.tests.runner import cli_tests
@@ -18,7 +15,7 @@ except PackageNotFoundError:
 
 
 __all__ = [
-    "__version__",
     "BaseTestCase",
+    "__version__",
     "cli_tests",
 ]

{core_tests-2.1.0 → core_tests-2.2.0}/core_tests/tests/base.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 """
 It's just the base class should be used for all
 test cases unittest-based within the code
@@ -7,7 +5,6 @@ ecosystem.
 """
 
 import os
-
 from unittest import TestCase
 
 

{core_tests-2.1.0 → core_tests-2.2.0}/core_tests/tests/runner.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 """
 This module provides a group of CLI commands that abstract unittest-based
 test execution and code coverage measurement. Consuming projects import
@@ -28,6 +26,7 @@ picked up automatically.
   * ``python manager.py run-tests --test-type integration``
   * ``python manager.py run-tests --test-type functional --pattern "*.py"``
   * ``python manager.py run-coverage``
+  * ``python manager.py run-coverage --fail-under 90``
 """
 
 from __future__ import annotations
@@ -35,15 +34,11 @@ from __future__ import annotations
 import logging
 import os
 import sys
-import typing
-from unittest import TestCase
-from unittest import TestLoader
-from unittest import TestSuite
-from unittest import TextTestRunner
+from unittest import TestCase, TestLoader, TestSuite, TextTestRunner
 
 from click import echo, option
 from click.decorators import group
-from coverage import coverage, CoverageException
+from coverage import CoverageException, coverage
 
 patterns = [
     "test_*.py",
@@ -85,7 +80,7 @@ def run_tests(test_type: str, pattern: str) -> None:
         level = os.getenv("LOGGER_LEVEL_FOR_TEST", str(logging.ERROR))
         os.environ["LOGGER_LEVEL"] = level
 
-    all_tests: typing.List[TestCase | TestSuite] = []
+    all_tests: list[TestCase | TestSuite] = []
 
     if pattern != "tests_*.py":
         tests = TestLoader().discover(f"./tests/{test_type}", pattern=pattern)
@@ -103,18 +98,32 @@ def run_tests(test_type: str, pattern: str) -> None:
 
 @cli_tests.command("run-coverage")
 @option("-s", "--save-report", "save_report", default=True)
-def run_coverage(save_report: bool) -> None:
+@option(
+    "-f",
+    "--fail-under",
+    "fail_under",
+    type=float,
+    default=None,
+    help="Minimum total coverage percentage. Overrides 'fail_under' of the coverage configuration.",
+)
+def run_coverage(save_report: bool, fail_under: float | None) -> None:
     """
     Runs all tests across all test directories and generates a coverage report.
 
-    :param save_report: Whether to save HTML and data coverage reports to disk.
+    :param save_report: Whether to save HTML, XML and data coverage reports to disk.
     :type save_report: bool
 
+    :param fail_under: Minimum total coverage percentage. Takes precedence over the
+        ``fail_under`` setting of the coverage configuration. The command exits
+        non-zero when the measured total is below it.
+    :type fail_under: float | None
+
     Coverage Analysis:
       - Runs tests with branch coverage enabled.
       - Analyzes all source files in current directory.
       - Generates console report summary.
-      - Optionally saves HTML report (default: True).
+      - Optionally saves HTML and XML reports (default: True).
+      - Enforces a minimum total coverage when one is configured.
 
     File Discovery:
         Automatically finds files matching: ``test_*.py``, ``*_test.py``, ``tests_*.py``
@@ -125,9 +134,14 @@ def run_coverage(save_report: bool) -> None:
 
     os.environ["LOGGER_LEVEL"] = os.getenv("LOGGER_LEVEL_FOR_TEST", str(logging.ERROR))
     coverage_ = coverage(branch=True, source=["."])
+
+    # Record paths relative to the working directory. Tools that consume the
+    # XML report, such as the merge request annotations of a CI platform,
+    # cannot map the absolute paths of a container onto the repository.
+    coverage_.config.relative_files = True
     coverage_.start()
 
-    all_tests: typing.List[TestCase | TestSuite] = []
+    all_tests: list[TestCase | TestSuite] = []
     for pattern_glob in patterns:
         tests = TestLoader().discover("./tests", pattern=pattern_glob)
         all_tests.extend(tests)
@@ -140,14 +154,22 @@ def run_coverage(save_report: bool) -> None:
 
     try:
         echo("Coverage Summary:")
-        coverage_.report()
+        total = coverage_.report()
 
         if save_report:
             coverage_.save()
             coverage_.html_report()
+            coverage_.xml_report()
 
         coverage_.erase()
 
     except CoverageException as error:
         echo(error)
         sys.exit(1)
+
+    # 'fail_under' of the coverage configuration is enforced by the 'coverage'
+    # command line, not by the API used here, so it is applied explicitly.
+    threshold = fail_under if fail_under is not None else coverage_.config.fail_under
+    if threshold and total < threshold:
+        echo(f"Coverage {total:.2f}% is below the required {threshold}%.")
+        sys.exit(1)

{core_tests-2.1.0 → core_tests-2.2.0}/core_tests.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: core-tests
-Version: 2.1.0
+Version: 2.2.0
 Summary: It contains common elements for testing purposes...
 Author-email: Alejandro Cora González <alek.cora.glez@gmail.com>
 Maintainer: Alejandro Cora González
@@ -31,7 +31,7 @@ Requires-Dist: click>=8.1.8
 Requires-Dist: coverage>=7.7.1
 Requires-Dist: environs>=14.1.1
 Provides-Extra: dev
-Requires-Dist: core-dev-tools>=2.0.0; extra == "dev"
+Requires-Dist: core-dev-tools>=2.1.0; extra == "dev"
 Dynamic: license-file
 
 core-tests
@@ -52,6 +52,10 @@ case than routing it through this abstraction layer.
 
 ===============================================================================
 
+.. image:: https://static.pepy.tech/personalized-badge/core-tests?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLACK&right_color=GREEN&left_text=downloads
+    :target: https://pepy.tech/projects/core-tests
+    :alt: PyPI Downloads
+
 .. image:: https://img.shields.io/pypi/pyversions/core-tests.svg
     :target: https://pypi.org/project/core-tests/
     :alt: Python Versions
@@ -100,6 +104,11 @@ Features
 
 * **Custom Pattern Support**: Override discovery with ``--pattern`` for
   non-standard file layouts.
+* **Enforced Coverage**: ``run-coverage`` applies the ``fail_under`` setting of
+  your coverage configuration, or ``--fail-under`` for a single run, and exits
+  non-zero when the total is below it.
+* **CI-ready Reports**: Writes ``coverage.xml`` (Cobertura, relative paths)
+  beside the HTML report, so a CI platform can annotate a merge request diff.
 * **Test Organization**: Target specific test directories (unit, integration,
   functional, etc.) via ``--test-type``.
 * **Branch Coverage Reports**: Generate branch-level coverage reports and
@@ -176,8 +185,11 @@ Generate code coverage reports across all test directories:
 
 **Options:**
 
-* ``--save-report``: Save HTML and data coverage reports to disk.
+* ``--save-report``: Save HTML, XML and data coverage reports to disk.
   Default: ``True``
+* ``--fail-under``: Minimum total coverage percentage. Exits non-zero below it,
+  and takes precedence over the ``fail_under`` setting of the coverage
+  configuration. Default: unset, so the configured value applies.
 
 **Examples:**
 
@@ -185,6 +197,11 @@ Generate code coverage reports across all test directories:
 
     python manager.py run-coverage
     python manager.py run-coverage --save-report false
+    python manager.py run-coverage --fail-under 90
+
+The HTML report lands in ``htmlcov/``, and a Cobertura ``coverage.xml`` beside
+it, with paths relative to the working directory so a CI platform can map them
+onto the repository.
 
 
 Quick Start

{core_tests-2.1.0 → core_tests-2.2.0}/core_tests.egg-info/requires.txt

@@ -3,4 +3,4 @@ coverage>=7.7.1
 environs>=14.1.1
 
 [dev]
-core-dev-tools>=2.0.0
+core-dev-tools>=2.1.0

{core_tests-2.1.0 → core_tests-2.2.0}/pyproject.toml

@@ -8,7 +8,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "core-tests"
-version = "2.1.0"
+version = "2.2.0"
 
 description = """It contains common elements for testing purposes..."""
 
@@ -50,7 +50,7 @@ dependencies = [
 
 [project.optional-dependencies]
 dev = [
-    "core-dev-tools>=2.0.0",
+    "core-dev-tools>=2.1.0",
 ]
 
 [project.urls]