gha-utils 4.14.0__tar.gz → 4.14.2__tar.gz

{gha_utils-4.14.0 → gha_utils-4.14.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: gha-utils
-Version: 4.14.0
+Version: 4.14.2
 Summary: ⚙️ CLI helpers for GitHub Actions + reuseable workflows
 Author-email: Kevin Deldycke <kevin@deldycke.com>
 Project-URL: Homepage, https://github.com/kdeldycke/workflows
@@ -103,7 +103,6 @@ Thanks to `uv`, you can install and run `gha-utils` in one command, without poll
 
 ```shell-session
 $ uvx gha-utils
-Installed 45 packages in 45ms
 Usage: gha-utils [OPTIONS] COMMAND [ARGS]...
 
 Options:
@@ -118,8 +117,11 @@ Options:
                             utils/*.{toml,yaml,yml,json,ini,xml}]
   --show-params             Show all CLI parameters, their provenance, defaults
                             and value, then exit.
-  -v, --verbosity LEVEL     Either CRITICAL, ERROR, WARNING, INFO, DEBUG.
+  --verbosity LEVEL         Either CRITICAL, ERROR, WARNING, INFO, DEBUG.
                             [default: WARNING]
+  -v, --verbose             Increase the default WARNING verbosity by one level
+                            for each additional repetition of the option.
+                            [default: 0]
   --version                 Show the version and exit.
   -h, --help                Show this message and exit.
 
@@ -127,6 +129,7 @@ Commands:
   changelog     Maintain a Markdown-formatted changelog
   mailmap-sync  Update Git's .mailmap file with missing contributors
   metadata      Output project metadata
+  test-plan     Run a test plan from a file against a binary
 ```
 
 ```shell-session

{gha_utils-4.14.0 → gha_utils-4.14.2}/gha_utils/__init__.py

@@ -17,4 +17,4 @@
 
 from __future__ import annotations
 
-__version__ = "4.14.0"
+__version__ = "4.14.2"

{gha_utils-4.14.0 → gha_utils-4.14.2}/gha_utils/cli.py

@@ -27,7 +27,7 @@ import click
 from click_extra import (
     Choice,
     Context,
-    IntRange,
+    FloatRange,
     argument,
     echo,
     extra_group,
@@ -279,29 +279,38 @@ def mailmap_sync(ctx, source, create_if_missing, destination_mailmap):
     # `file_path` type.
     type=click.Path(exists=True, executable=True, resolve_path=True),
     required=True,
-    help="Path to the binary to test.",
+    metavar="FILE_PATH",
+    help="Path to the binary file to test.",
 )
 @option(
     "--plan",
     type=file_path(exists=True, readable=True, resolve_path=True),
-    help="Test plan in YAML.",
+    metavar="FILE_PATH",
+    help="Path to the test plan file in YAML. If not provided, a default test "
+    "plan will be executed.",
 )
 @option(
     "-t",
     "--timeout",
-    type=IntRange(min=0),
-    default=60,
-    help="Set maximum duration in seconds for each CLI call.",
+    # Timeout passed to subprocess.run() is a float that is silently clamped to
+    # 0.0 is negative values are provided, so we mimic this behavior here:
+    # https://github.com/python/cpython/blob/5740b95076b57feb6293cda4f5504f706a7d622d/Lib/subprocess.py#L1596-L1597
+    type=FloatRange(min=0, clamp=True),
+    metavar="SECONDS",
+    help="Set the default timeout for each CLI call, if not specified in the "
+    "test plan.",
 )
-def test_plan(binary, plan, timeout):
+def test_plan(binary: Path, plan: Path | None, timeout: float | None) -> None:
     # Load test plan from workflow input, or use a default one.
     if plan:
-        logging.debug(f"Read test plan from {plan}")
+        logging.info(f"Read test plan from {plan}")
         test_plan = parse_test_plan(plan)
     else:
-        logging.warning(f"No test plan provided. Default to: {DEFAULT_TEST_PLAN}")
-        test_plan = DEFAULT_TEST_PLAN
+        logging.warning("No test plan provided: use default test plan.")
+        test_plan = DEFAULT_TEST_PLAN  # type: ignore[assignment]
+    logging.debug(f"Test plan: {test_plan}")
 
     for index, test_case in enumerate(test_plan):
-        logging.info(f"Run test #{index}")
-        test_case.check_cli_test(binary, timeout=timeout)
+        logging.info(f"Run test #{index + 1}")
+        logging.debug(f"Test case parameters: {test_case}")
+        test_case.check_cli_test(binary, default_timeout=timeout)

{gha_utils-4.14.0 → gha_utils-4.14.2}/gha_utils/metadata.py

@@ -1105,7 +1105,7 @@ class Metadata:
             ).format(**variations)
             matrix.add_includes(bin_name_include)
 
-        return Matrix(matrix)
+        return matrix
 
     @cached_property
     def release_notes(self) -> str | None:

gha_utils-4.14.2/gha_utils/test_plan.py

@@ -0,0 +1,274 @@
+# Copyright Kevin Deldycke <kevin@deldycke.com> and contributors.
+#
+# This program is Free Software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+from __future__ import annotations
+
+import logging
+import re
+import shlex
+import sys
+from dataclasses import asdict, dataclass, field
+from pathlib import Path
+from subprocess import TimeoutExpired, run
+from typing import Generator, Sequence
+
+import yaml
+from boltons.iterutils import flatten
+from boltons.strutils import strip_ansi
+from click_extra.testing import args_cleanup, print_cli_run
+
+
+@dataclass(order=True)
+class TestCase:
+    cli_parameters: tuple[str, ...] | str = field(default_factory=tuple)
+    """Parameters, arguments and options to pass to the CLI."""
+
+    timeout: float | str | None = None
+    exit_code: int | str | None = None
+    strip_ansi: bool = False
+    output_contains: tuple[str, ...] | str = field(default_factory=tuple)
+    stdout_contains: tuple[str, ...] | str = field(default_factory=tuple)
+    stderr_contains: tuple[str, ...] | str = field(default_factory=tuple)
+    output_regex_matches: tuple[re.Pattern | str, ...] | str = field(
+        default_factory=tuple
+    )
+    stdout_regex_matches: tuple[re.Pattern | str, ...] | str = field(
+        default_factory=tuple
+    )
+    stderr_regex_matches: tuple[re.Pattern | str, ...] | str = field(
+        default_factory=tuple
+    )
+    output_regex_fullmatch: re.Pattern | str | None = None
+    stdout_regex_fullmatch: re.Pattern | str | None = None
+    stderr_regex_fullmatch: re.Pattern | str | None = None
+
+    def __post_init__(self) -> None:
+        """Normalize all fields."""
+        for field_id, field_data in asdict(self).items():
+            # Validates and normalize integer properties.
+            if field_id == "exit_code":
+                if isinstance(field_data, str):
+                    field_data = int(field_data)
+                elif field_data is not None and not isinstance(field_data, int):
+                    raise ValueError(f"exit_code is not an integer: {field_data}")
+
+            # Validates and normalize float properties.
+            elif field_id == "timeout":
+                if isinstance(field_data, str):
+                    field_data = float(field_data)
+                elif field_data is not None and not isinstance(field_data, float):
+                    raise ValueError(f"timeout is not a float: {field_data}")
+                # Timeout can only be unset or positive.
+                if field_data and field_data < 0:
+                    raise ValueError(f"timeout is negative: {field_data}")
+
+            # Validates and normalize boolean properties.
+            elif field_id == "strip_ansi":
+                if not isinstance(field_data, bool):
+                    raise ValueError(f"strip_ansi is not a boolean: {field_data}")
+
+            # Validates and normalize tuple of strings.
+            else:
+                if field_data:
+                    # Wraps single string and other types into a tuple.
+                    if isinstance(field_data, str) or not isinstance(
+                        field_data, Sequence
+                    ):
+                        # CLI parameters needs to be split on Unix-like systems.
+                        # XXX If we need the same for Windows, have a look at:
+                        # https://github.com/maxpat78/w32lex
+                        if field_id == "cli_parameters" and sys.platform != "win32":
+                            field_data = tuple(shlex.split(field_data))
+                        else:
+                            field_data = (field_data,)
+
+                    for item in field_data:
+                        if not isinstance(item, str):
+                            raise ValueError(f"Invalid string in {field_id}: {item}")
+                    # Ignore blank value.
+                    field_data = tuple(i for i in field_data if i.strip())
+
+            # Validates fields containing one or more regexes.
+            if "_regex_" in field_id and field_data:
+                # Compile all regexes.
+                valid_regexes = []
+                for regex in flatten((field_data,)):
+                    try:
+                        # Let dots in regex match newlines.
+                        valid_regexes.append(re.compile(regex, re.DOTALL))
+                    except re.error as ex:
+                        raise ValueError(
+                            f"Invalid regex in {field_id}: {regex}"
+                        ) from ex
+                # Normalize single regex to a single element.
+                if field_id.endswith("_fullmatch"):
+                    if valid_regexes:
+                        field_data = valid_regexes.pop()
+                    else:
+                        field_data = None
+                else:
+                    field_data = tuple(valid_regexes)
+
+            setattr(self, field_id, field_data)
+
+    def check_cli_test(self, binary: str | Path, default_timeout: float | None):
+        """Run a CLI command and check its output against the test case.
+
+        ..todo::
+            Add support for environment variables.
+
+        ..todo::
+            Add support for proper mixed stdout/stderr stream as a single,
+            intertwined output.
+        """
+        if self.timeout is None and default_timeout is not None:
+            logging.info(f"Set default test case timeout to {default_timeout} seconds")
+            self.timeout = default_timeout
+
+        clean_args = args_cleanup(binary, self.cli_parameters)
+        try:
+            result = run(
+                clean_args,
+                capture_output=True,
+                timeout=self.timeout,  # type: ignore[arg-type]
+                # XXX Do not force encoding to let CLIs figure out by
+                # themselves the contextual encoding to use. This avoid
+                # UnicodeDecodeError on output in Window's console which still
+                # defaults to legacy encoding (e.g. cp1252, cp932, etc...):
+                #
+                #   Traceback (most recent call last):
+                #     File "…\__main__.py", line 49, in <module>
+                #     File "…\__main__.py", line 45, in main
+                #     File "…\click\core.py", line 1157, in __call__
+                #     File "…\click_extra\commands.py", line 347, in main
+                #     File "…\click\core.py", line 1078, in main
+                #     File "…\click_extra\commands.py", line 377, in invoke
+                #     File "…\click\core.py", line 1688, in invoke
+                #     File "…\click_extra\commands.py", line 377, in invoke
+                #     File "…\click\core.py", line 1434, in invoke
+                #     File "…\click\core.py", line 783, in invoke
+                #     File "…\cloup\_context.py", line 47, in new_func
+                #     File "…\mpm\cli.py", line 570, in managers
+                #     File "…\mpm\output.py", line 187, in print_table
+                #     File "…\click_extra\tabulate.py", line 97, in render_csv
+                #     File "encodings\cp1252.py", line 19, in encode
+                #   UnicodeEncodeError: 'charmap' codec can't encode character
+                #   '\u2713' in position 128: character maps to <undefined>
+                #
+                # encoding="utf-8",
+                text=True,
+            )
+        except TimeoutExpired:
+            raise TimeoutError(
+                f"CLI timed out after {self.timeout} seconds: {' '.join(clean_args)}"
+            )
+
+        print_cli_run(clean_args, result)
+
+        for field_id, field_data in asdict(self).items():
+            if field_id == "exit_code":
+                if field_data is not None:
+                    logging.info(f"Test exit code, expecting: {field_data}")
+                    if result.returncode != field_data:
+                        raise AssertionError(
+                            f"CLI exited with code {result.returncode}, "
+                            f"expected {field_data}"
+                        )
+                # The specific exit code matches, let's proceed to the next test.
+                continue
+
+            # Ignore non-output fields, and empty test cases.
+            elif not (
+                field_id.startswith(("output_", "stdout_", "stderr_")) and field_data
+            ):
+                continue
+
+            # Prepare output and name for comparison.
+            output = ""
+            name = ""
+            if field_id.startswith("output_"):
+                raise NotImplementedError("<stdout>/<stderr> output mix")
+                # output = result.output
+                # name = "output"
+            elif field_id.startswith("stdout_"):
+                output = result.stdout
+                name = "<stdout>"
+            elif field_id.startswith("stderr_"):
+                output = result.stderr
+                name = "<stderr>"
+
+            if self.strip_ansi:
+                logging.info(f"Strip ANSI escape sequences from CLI's {name}")
+                output = strip_ansi(output)
+
+            if field_id.endswith("_contains"):
+                for sub_string in field_data:
+                    logging.info(f"Check if CLI's {name} contains: {sub_string!r}")
+                    if sub_string not in output:
+                        raise AssertionError(
+                            f"CLI's {name} does not contain {sub_string!r}"
+                        )
+
+            elif field_id.endswith("_regex_matches"):
+                for regex in field_data:
+                    logging.info(f"Check if CLI's {name} matches: {sub_string!r}")
+                    if not regex.search(output):
+                        raise AssertionError(
+                            f"CLI's {name} does not match regex {regex}"
+                        )
+
+            elif field_id.endswith("_regex_fullmatch"):
+                regex = field_data
+                if not regex.fullmatch(output):
+                    raise AssertionError(
+                        f"CLI's {name} does not fully match regex {regex}"
+                    )
+
+        logging.info("All tests passed for CLI.")
+
+
+DEFAULT_TEST_PLAN = (
+    # Output the version of the CLI.
+    TestCase(cli_parameters="--version"),
+    # Test combination of version and verbosity.
+    TestCase(cli_parameters=("--verbosity", "DEBUG", "--version")),
+    # Test help output.
+    TestCase(cli_parameters="--help"),
+)
+
+
+def parse_test_plan(plan_path: Path) -> Generator[TestCase, None, None]:
+    plan = yaml.full_load(plan_path.read_text(encoding="UTF-8"))
+
+    # Validates test plan structure.
+    if not plan:
+        raise ValueError(f"Empty test plan file {plan_path}")
+    if not isinstance(plan, list):
+        raise ValueError(f"Test plan is not a list: {plan}")
+
+    directives = frozenset(TestCase.__dataclass_fields__.keys())
+
+    for index, test_case in enumerate(plan):
+        # Validates test case structure.
+        if not isinstance(test_case, dict):
+            raise ValueError(f"Test case #{index + 1} is not a dict: {test_case}")
+        if not directives.issuperset(test_case):
+            raise ValueError(
+                f"Test case #{index + 1} contains invalid directives:"
+                f"{set(test_case) - directives}"
+            )
+
+        yield TestCase(**test_case)

{gha_utils-4.14.0 → gha_utils-4.14.2}/gha_utils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: gha-utils
-Version: 4.14.0
+Version: 4.14.2
 Summary: ⚙️ CLI helpers for GitHub Actions + reuseable workflows
 Author-email: Kevin Deldycke <kevin@deldycke.com>
 Project-URL: Homepage, https://github.com/kdeldycke/workflows
@@ -103,7 +103,6 @@ Thanks to `uv`, you can install and run `gha-utils` in one command, without poll
 
 ```shell-session
 $ uvx gha-utils
-Installed 45 packages in 45ms
 Usage: gha-utils [OPTIONS] COMMAND [ARGS]...
 
 Options:
@@ -118,8 +117,11 @@ Options:
                             utils/*.{toml,yaml,yml,json,ini,xml}]
   --show-params             Show all CLI parameters, their provenance, defaults
                             and value, then exit.
-  -v, --verbosity LEVEL     Either CRITICAL, ERROR, WARNING, INFO, DEBUG.
+  --verbosity LEVEL         Either CRITICAL, ERROR, WARNING, INFO, DEBUG.
                             [default: WARNING]
+  -v, --verbose             Increase the default WARNING verbosity by one level
+                            for each additional repetition of the option.
+                            [default: 0]
   --version                 Show the version and exit.
   -h, --help                Show this message and exit.
 
@@ -127,6 +129,7 @@ Commands:
   changelog     Maintain a Markdown-formatted changelog
   mailmap-sync  Update Git's .mailmap file with missing contributors
   metadata      Output project metadata
+  test-plan     Run a test plan from a file against a binary
 ```
 
 ```shell-session

{gha_utils-4.14.0 → gha_utils-4.14.2}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 # Docs: https://packaging.python.org/en/latest/guides/writing-pyproject-toml/
 name = "gha-utils"
-version = "4.14.0"
+version = "4.14.2"
 # Python versions and their status: https://devguide.python.org/versions/
 requires-python = ">= 3.10"
 description = "⚙️ CLI helpers for GitHub Actions + reuseable workflows"
@@ -138,7 +138,7 @@ addopts = [
 xfail_strict = true
 
 [tool.bumpversion]
-current_version = "4.14.0"
+current_version = "4.14.2"
 allow_dirty = true
 ignore_missing_files = true
 

{gha_utils-4.14.0 → gha_utils-4.14.2}/readme.md

@@ -36,7 +36,6 @@ Thanks to `uv`, you can install and run `gha-utils` in one command, without poll
 
 ```shell-session
 $ uvx gha-utils
-Installed 45 packages in 45ms
 Usage: gha-utils [OPTIONS] COMMAND [ARGS]...
 
 Options:
@@ -51,8 +50,11 @@ Options:
                             utils/*.{toml,yaml,yml,json,ini,xml}]
   --show-params             Show all CLI parameters, their provenance, defaults
                             and value, then exit.
-  -v, --verbosity LEVEL     Either CRITICAL, ERROR, WARNING, INFO, DEBUG.
+  --verbosity LEVEL         Either CRITICAL, ERROR, WARNING, INFO, DEBUG.
                             [default: WARNING]
+  -v, --verbose             Increase the default WARNING verbosity by one level
+                            for each additional repetition of the option.
+                            [default: 0]
   --version                 Show the version and exit.
   -h, --help                Show this message and exit.
 
@@ -60,6 +62,7 @@ Commands:
   changelog     Maintain a Markdown-formatted changelog
   mailmap-sync  Update Git's .mailmap file with missing contributors
   metadata      Output project metadata
+  test-plan     Run a test plan from a file against a binary
 ```
 
 ```shell-session

{gha_utils-4.14.0 → gha_utils-4.14.2}/tests/test_mailmap.py

@@ -27,7 +27,7 @@ def test_remove_header():
         # Generated by gha-utils mailmap-sync v4.4.3 - https://github.com/kdeldycke/workflows
         # Timestamp: 2024-08-12T08:15:41.083405
         # Format is:
-        #   Preferred Name <preferred e-mail>  Other Name <other e-mail>
+        #   Preferred Name <preferred e-mail> Other Name <other e-mail>
         #
         # Reference: https://git-scm.com/docs/git-blame#_mapping_authors
 
@@ -36,7 +36,7 @@ def test_remove_header():
 
     assert remove_header(content) == dedent("""\
         # Format is:
-        #   Preferred Name <preferred e-mail>  Other Name <other e-mail>
+        #   Preferred Name <preferred e-mail> Other Name <other e-mail>
         #
         # Reference: https://git-scm.com/docs/git-blame#_mapping_authors
 

gha_utils-4.14.2/tests/test_metadata.py

@@ -0,0 +1,143 @@
+# Copyright Kevin Deldycke <kevin@deldycke.com> and contributors.
+#
+# This program is Free Software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+from __future__ import annotations
+
+import re
+
+from gha_utils.metadata import Dialects, Metadata
+
+
+def test_metadata_github_format():
+    metadata = Metadata()
+
+    assert re.fullmatch(
+        (
+            r"new_commits=\n"
+            r"release_commits=\n"
+            r"gitignore_exists=true\n"
+            r"python_files=[\S ]*\n"
+            r"doc_files=[\S ]*\n"
+            r"is_python_project=true\n"
+            r"package_name=gha-utils\n"
+            r"blacken_docs_params=--target-version py310 --target-version py311 "
+            r"--target-version py312 --target-version py313\n"
+            r"mypy_params=--python-version 3\.10\n"
+            r"current_version=\n"
+            r"released_version=\n"
+            r"is_sphinx=false\n"
+            r"active_autodoc=false\n"
+            r"release_notes=\n"
+            r"new_commits_matrix=\n"
+            r"release_commits_matrix=\n"
+            r'nuitka_matrix=\{"os": \["ubuntu-24\.04", "ubuntu-24\.04-arm", '
+            r'"macos-15", "macos-13", "windows-2022"\], '
+            r'"entry_point": \["gha-utils"\], "commit": \["[a-z0-9]+"\], '
+            r'"include": \[\{"entry_point": "gha-utils", '
+            r'"cli_id": "gha-utils", "module_id": "gha_utils\.__main__", '
+            r'"callable_id": "main", '
+            r'"module_path": "gha_utils(/|\\\\)__main__\.py"\}, '
+            r'\{"commit": "[a-z0-9]+", "short_sha": "[a-z0-9]+", '
+            r'"current_version": "[0-9\.]+"\}, \{"os": "ubuntu-24\.04", '
+            r'"platform_id": "linux", "arch": "x64", "extension": "bin"\}, '
+            r'\{"os": "ubuntu-24\.04-arm", "platform_id": "linux", '
+            r'"arch": "arm64", "extension": "bin"\}, \{"os": "macos-15", '
+            r'"platform_id": "macos", "arch": "arm64", "extension": "bin"\}, '
+            r'\{"os": "macos-13", "platform_id": "macos", "arch": "x64", '
+            r'"extension": "bin"\}, \{"os": "windows-2022", '
+            r'"platform_id": "windows", "arch": "x64", "extension": "exe"\}, '
+            r'\{"os": "ubuntu-24\.04", "entry_point": "gha-utils", '
+            r'"commit": "[a-z0-9]+", '
+            r'"bin_name": "gha-utils-linux-x64-build-[a-z0-9]+\.bin"\}, '
+            r'\{"os": "ubuntu-24\.04-arm", "entry_point": "gha-utils", '
+            r'"commit": "[a-z0-9]+", '
+            r'"bin_name": "gha-utils-linux-arm64-build-[a-z0-9]+\.bin"\}, '
+            r'\{"os": "macos-15", "entry_point": "gha-utils", '
+            r'"commit": "[a-z0-9]+", '
+            r'"bin_name": "gha-utils-macos-arm64-build-[a-z0-9]+\.bin"\}, '
+            r'\{"os": "macos-13", "entry_point": "gha-utils", '
+            r'"commit": "[a-z0-9]+", '
+            r'"bin_name": "gha-utils-macos-x64-build-[a-z0-9]+\.bin"\}, '
+            r'\{"os": "windows-2022", "entry_point": "gha-utils", '
+            r'"commit": "[a-z0-9]+", '
+            r'"bin_name": "gha-utils-windows-x64-build-[a-z0-9]+\.exe"\}\]\}\n'
+        ),
+        metadata.dump(Dialects.github),
+    )
+
+
+def test_metadata_plain_format():
+    metadata = Metadata()
+
+    assert re.fullmatch(
+        (
+            r"\{"
+            r"'new_commits': None, "
+            r"'release_commits': None, "
+            r"'gitignore_exists': True, "
+            r"'python_files': <generator object Metadata\.python_files at \S+>, "
+            r"'doc_files': <generator object Metadata\.doc_files at \S+>, "
+            r"'is_python_project': True, "
+            r"'package_name': 'gha-utils', "
+            r"'blacken_docs_params': \("
+            r"'--target-version py310', "
+            r"'--target-version py311', "
+            r"'--target-version py312', "
+            r"'--target-version py313'\), "
+            r"'mypy_params': '--python-version 3\.10', "
+            r"'current_version': None, "
+            r"'released_version': None, "
+            r"'is_sphinx': False, "
+            r"'active_autodoc': False, "
+            r"'release_notes': None, "
+            r"'new_commits_matrix': None, "
+            r"'release_commits_matrix': None, "
+            r"'nuitka_matrix': <Matrix: \{"
+            r"'os': \('ubuntu-24\.04', 'ubuntu-24\.04-arm', "
+            r"'macos-15', 'macos-13', 'windows-2022'\), "
+            r"'entry_point': \('gha-utils',\), "
+            r"'commit': \('[a-z0-9]+',\)\}; "
+            r"include=\(\{'entry_point': 'gha-utils', 'cli_id': 'gha-utils', "
+            r"'module_id': 'gha_utils\.__main__', 'callable_id': 'main', "
+            r"'module_path': 'gha_utils(/|\\\\)__main__\.py'\}, "
+            r"\{'commit': '[a-z0-9]+', 'short_sha': '[a-z0-9]+', "
+            r"'current_version': '[0-9\.]+'\}, \{'os': 'ubuntu-24\.04', "
+            r"'platform_id': 'linux', 'arch': 'x64', 'extension': 'bin'}, "
+            r"{'os': 'ubuntu-24\.04-arm', 'platform_id': 'linux', "
+            r"'arch': 'arm64', 'extension': 'bin'\}, \{'os': 'macos-15', "
+            r"'platform_id': 'macos', 'arch': 'arm64', 'extension': 'bin'\}, "
+            r"\{'os': 'macos-13', 'platform_id': 'macos', 'arch': 'x64', "
+            r"'extension': 'bin'\}, \{'os': 'windows-2022', 'platform_id': "
+            r"'windows', 'arch': 'x64', 'extension': 'exe'\}, "
+            r"\{'os': 'ubuntu-24\.04', 'entry_point': 'gha-utils', "
+            r"'commit': '[a-z0-9]+', "
+            r"'bin_name': 'gha-utils-linux-x64-build-[a-z0-9]+\.bin'\}, "
+            r"\{'os': 'ubuntu-24\.04-arm', 'entry_point': 'gha-utils', "
+            r"'commit': '[a-z0-9]+', "
+            r"'bin_name': 'gha-utils-linux-arm64-build-[a-z0-9]+\.bin'\}, "
+            r"\{'os': 'macos-15', 'entry_point': 'gha-utils', "
+            r"'commit': '[a-z0-9]+', "
+            r"'bin_name': 'gha-utils-macos-arm64-build-[a-z0-9]+\.bin'\}, "
+            r"\{'os': 'macos-13', 'entry_point': 'gha-utils', "
+            r"'commit': '[a-z0-9]+', 'bin_name': "
+            r"'gha-utils-macos-x64-build-[a-z0-9]+\.bin'\}, "
+            r"\{'os': 'windows-2022', 'entry_point': 'gha-utils', "
+            r"'commit': '[a-z0-9]+', "
+            r"'bin_name': 'gha-utils-windows-x64-build-[a-z0-9]+\.exe'\}\); "
+            r"exclude=\(\)>\}"
+        ),
+        metadata.dump(Dialects.plain),
+    )

gha_utils-4.14.0/gha_utils/test_plan.py

@@ -1,226 +0,0 @@
-# Copyright Kevin Deldycke <kevin@deldycke.com> and contributors.
-#
-# This program is Free Software; you can redistribute it and/or
-# modify it under the terms of the GNU General Public License
-# as published by the Free Software Foundation; either version 2
-# of the License, or (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-
-from __future__ import annotations
-
-import re
-from dataclasses import asdict, dataclass, field
-from pathlib import Path
-from subprocess import run
-from typing import Generator, Sequence
-
-import yaml
-from boltons.iterutils import flatten
-from boltons.strutils import strip_ansi
-from click_extra.testing import args_cleanup, print_cli_run
-
-
-@dataclass(order=True)
-class TestCase:
-    cli_parameters: tuple[str, ...] | str = field(default_factory=tuple)
-    """Parameters, arguments and options to pass to the CLI."""
-
-    exit_code: int | str | None = None
-    strip_ansi: bool = False
-    output_contains: tuple[str, ...] | str = field(default_factory=tuple)
-    stdout_contains: tuple[str, ...] | str = field(default_factory=tuple)
-    stderr_contains: tuple[str, ...] | str = field(default_factory=tuple)
-    output_regex_matches: tuple[str, ...] | str = field(default_factory=tuple)
-    stdout_regex_matches: tuple[str, ...] | str = field(default_factory=tuple)
-    stderr_regex_matches: tuple[str, ...] | str = field(default_factory=tuple)
-    output_regex_fullmatch: str | None = None
-    stdout_regex_fullmatch: str | None = None
-    stderr_regex_fullmatch: str | None = None
-
-    def __post_init__(self) -> None:
-        """Normalize all fields."""
-        for field_id, field_data in asdict(self).items():
-            # Validates and normalize exit code.
-            if field_id == "exit_code":
-                if isinstance(field_data, str):
-                    field_data = int(field_data)
-                elif field_data is not None and not isinstance(field_data, int):
-                    raise ValueError(f"exit_code is not an integer: {field_data}")
-
-            elif field_id == "strip_ansi":
-                if not isinstance(field_data, bool):
-                    raise ValueError(f"strip_ansi is not a boolean: {field_data}")
-
-            # Validates and normalize regex fullmatch fields.
-            elif field_id.endswith("_fullmatch"):
-                if field_data:
-                    if not isinstance(field_data, str):
-                        raise ValueError(f"{field_id} is not a string: {field_data}")
-                # Normalize empty strings to None.
-                else:
-                    field_data = None
-
-            # Validates and normalize tuple of strings.
-            else:
-                # Wraps single string into a tuple.
-                if isinstance(field_data, str):
-                    field_data = (field_data,)
-                if not isinstance(field_data, Sequence):
-                    raise ValueError(
-                        f"{field_id} is not a tuple or a list: {field_data}"
-                    )
-                if not all(isinstance(i, str) for i in field_data):
-                    raise ValueError(
-                        f"{field_id} contains non-string elements: {field_data}"
-                    )
-                # Ignore blank value.
-                field_data = tuple(i.strip() for i in field_data if i.strip())
-
-            # Validates regexps.
-            if field_data and "_regex_" in field_id:
-                for regex in flatten((field_data,)):
-                    try:
-                        re.compile(regex)
-                    except re.error as ex:
-                        raise ValueError(
-                            f"Invalid regex in {field_id}: {regex}"
-                        ) from ex
-
-            setattr(self, field_id, field_data)
-
-    def check_cli_test(self, binary: str | Path, timeout: int | None = None):
-        """Run a CLI command and check its output against the test case.
-
-        ..todo::
-            Add support for environment variables.
-
-        ..todo::
-            Add support for ANSI code stripping.
-
-        ..todo::
-            Add support for proper mixed stdout/stderr stream as a single,
-            intertwined output.
-        """
-        clean_args = args_cleanup(binary, self.cli_parameters)
-        result = run(
-            clean_args,
-            capture_output=True,
-            timeout=timeout,
-            # XXX Do not force encoding to let CLIs figure out by themselves the
-            # contextual encoding to use. This avoid UnicodeDecodeError on output in
-            # Window's console which still defaults to legacy encoding (e.g. cp1252,
-            # cp932, etc...):
-            #
-            #   Traceback (most recent call last):
-            #     File "…\__main__.py", line 49, in <module>
-            #     File "…\__main__.py", line 45, in main
-            #     File "…\click\core.py", line 1157, in __call__
-            #     File "…\click_extra\commands.py", line 347, in main
-            #     File "…\click\core.py", line 1078, in main
-            #     File "…\click_extra\commands.py", line 377, in invoke
-            #     File "…\click\core.py", line 1688, in invoke
-            #     File "…\click_extra\commands.py", line 377, in invoke
-            #     File "…\click\core.py", line 1434, in invoke
-            #     File "…\click\core.py", line 783, in invoke
-            #     File "…\cloup\_context.py", line 47, in new_func
-            #     File "…\mpm\cli.py", line 570, in managers
-            #     File "…\mpm\output.py", line 187, in print_table
-            #     File "…\click_extra\tabulate.py", line 97, in render_csv
-            #     File "encodings\cp1252.py", line 19, in encode
-            #   UnicodeEncodeError: 'charmap' codec can't encode character
-            #   '\u2713' in position 128: character maps to <undefined>
-            #
-            # encoding="utf-8",
-            text=True,
-        )
-        print_cli_run(clean_args, result)
-
-        for field_id, field_data in asdict(self).items():
-            if field_id == "cli_parameters" or (not field_data and field_data != 0):
-                continue
-
-            if field_id == "exit_code":
-                if result.returncode != field_data:
-                    raise AssertionError(
-                        f"CLI exited with code {result.returncode}, "
-                        f"expected {field_data}"
-                    )
-
-            output = ""
-            name = ""
-            if field_id.startswith("output_"):
-                raise NotImplementedError("Output mixing <stdout>/<stderr>")
-                # output = result.output
-                # name = "output"
-            elif field_id.startswith("stdout_"):
-                output = result.stdout
-                name = "<stdout>"
-            elif field_id.startswith("stderr_"):
-                output = result.stderr
-                name = "<stderr>"
-
-            if self.strip_ansi:
-                output = strip_ansi(output)
-
-            if field_id.endswith("_contains"):
-                for sub_string in field_data:
-                    if sub_string not in output:
-                        raise AssertionError(
-                            f"CLI's {name} does not contain {sub_string!r}"
-                        )
-
-            elif field_id.endswith("_regex_matches"):
-                for regex in field_data:
-                    if not re.search(regex, output):
-                        raise AssertionError(
-                            f"CLI's {name} does not match regex {regex!r}"
-                        )
-
-            elif field_id.endswith("_regex_fullmatch"):
-                regex = field_data
-                if not re.fullmatch(regex, output):
-                    raise AssertionError(
-                        f"CLI's {name} does not fully match regex {regex!r}"
-                    )
-
-
-DEFAULT_TEST_PLAN = (
-    # Output the version of the CLI.
-    TestCase(cli_parameters="--version"),
-    # Test combination of version and verbosity.
-    TestCase(cli_parameters=("--verbosity", "DEBUG", "--version")),
-    # Test help output.
-    TestCase(cli_parameters="--help"),
-)
-
-
-def parse_test_plan(plan_path: Path) -> Generator[TestCase, None, None]:
-    plan = yaml.full_load(plan_path.read_text(encoding="UTF-8"))
-
-    # Validates test plan structure.
-    if not plan:
-        raise ValueError(f"Empty test plan file {plan_path}")
-    if not isinstance(plan, list):
-        raise ValueError(f"Test plan is not a list: {plan}")
-
-    directives = frozenset(TestCase.__dataclass_fields__.keys())
-
-    for index, test_case in enumerate(plan):
-        # Validates test case structure.
-        if not isinstance(test_case, dict):
-            raise ValueError(f"Test case #{index + 1} is not a dict: {test_case}")
-        if not directives.issuperset(test_case):
-            raise ValueError(
-                f"Test case #{index + 1} contains invalid directives:"
-                f"{set(test_case) - directives}"
-            )
-
-        yield TestCase(**test_case)

gha_utils-4.14.0/tests/test_metadata.py

@@ -1,89 +0,0 @@
-# Copyright Kevin Deldycke <kevin@deldycke.com> and contributors.
-#
-# This program is Free Software; you can redistribute it and/or
-# modify it under the terms of the GNU General Public License
-# as published by the Free Software Foundation; either version 2
-# of the License, or (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-
-from __future__ import annotations
-
-import re
-
-from gha_utils.metadata import Dialects, Metadata
-
-
-def test_metadata_github_format():
-    metadata = Metadata()
-
-    assert re.fullmatch(
-        (
-            r"new_commits=\n"
-            r"release_commits=\n"
-            r"gitignore_exists=true\n"
-            r"python_files=[\S ]*\n"
-            r"doc_files=[\S ]*\n"
-            r"is_python_project=true\n"
-            r"package_name=gha-utils\n"
-            r"blacken_docs_params=--target-version py310 --target-version py311 "
-            r"--target-version py312 --target-version py313\n"
-            r"mypy_params=--python-version 3\.10\n"
-            r"current_version=\n"
-            r"released_version=\n"
-            r"is_sphinx=false\n"
-            r"active_autodoc=false\n"
-            r"release_notes=\n"
-            r"new_commits_matrix=\n"
-            r"release_commits_matrix=\n"
-            r'nuitka_matrix=\{"os": \["ubuntu-24\.04", "ubuntu-24\.04-arm", '
-            r'"macos-15", "macos-13", "windows-2022"\], '
-            r'"entry_point": \["gha-utils"\], '
-            r'"commit": \["[a-z0-9]+"\]\}\n'
-        ),
-        metadata.dump(Dialects.github),
-    )
-
-
-def test_metadata_plain_format():
-    metadata = Metadata()
-
-    assert re.fullmatch(
-        (
-            r"\{"
-            r"'new_commits': None, "
-            r"'release_commits': None, "
-            r"'gitignore_exists': True, "
-            r"'python_files': <generator object Metadata\.python_files at \S+>, "
-            r"'doc_files': <generator object Metadata\.doc_files at \S+>, "
-            r"'is_python_project': True, "
-            r"'package_name': 'gha-utils', "
-            r"'blacken_docs_params': \("
-            r"'--target-version py310', "
-            r"'--target-version py311', "
-            r"'--target-version py312', "
-            r"'--target-version py313'\), "
-            r"'mypy_params': '--python-version 3\.10', "
-            r"'current_version': None, "
-            r"'released_version': None, "
-            r"'is_sphinx': False, "
-            r"'active_autodoc': False, "
-            r"'release_notes': None, "
-            r"'new_commits_matrix': None, "
-            r"'release_commits_matrix': None, "
-            r"'nuitka_matrix': <Matrix: \{"
-            r"'os': \('ubuntu-24\.04', 'ubuntu-24\.04-arm', "
-            r"'macos-15', 'macos-13', 'windows-2022'\), "
-            r"'entry_point': \('gha-utils',\), "
-            r"'commit': \('[a-z0-9]+',\)\}; "
-            r"include=\(\); exclude=\(\)>\}"
-        ),
-        metadata.dump(Dialects.plain),
-    )