version-check was refactored into nox task and its usage changed

Author: Jannis-Mittenzwei

.github/workflows/checks.yml

@@ -19,7 +19,7 @@ jobs:
         uses: ./.github/actions/python-environment
 
       - name: Check Version(s)
-        run: poetry run version-check `poetry run -- python -c "from noxconfig import PROJECT_CONFIG; print(PROJECT_CONFIG.version_file)"`
+        run: poetry run nox -s version:check -- `poetry run -- python -c "from noxconfig import PROJECT_CONFIG; print(PROJECT_CONFIG.version_file)"`
 
   Documentation:
     name: Docs

exasol/toolbox/nox/_package_version.py

@@ -0,0 +1,155 @@
+import argparse
+import subprocess
+import sys
+from argparse import (
+    ArgumentParser,
+    Namespace,
+)
+from collections import namedtuple
+from collections.abc import Iterable
+from inspect import cleandoc
+from pathlib import Path
+from shutil import which
+from typing import (
+    Any,
+    Dict,
+    Union,
+)
+
+import nox
+from nox import Session
+
+Version = namedtuple("Version", ["major", "minor", "patch"])
+
+_SUCCESS = 0
+_FAILURE = 1
+
+# fmt: off
+_VERSION_MODULE_TEMPLATE = cleandoc('''
+    # ATTENTION:
+    # This file is generated by exasol/toolbox/nox/_package_version.py when using:
+    #   * either "poetry run -- nox -s project:fix"
+    #   * or "poetry run -- nox version:check <path/version.py> --fix"
+    # Do not edit this file manually!
+    # If you need to change the version, do so in the project.toml, e.g. by using `poetry version X.Y.Z`.
+    MAJOR = {major}
+    MINOR = {minor}
+    PATCH = {patch}
+    VERSION = f"{{MAJOR}}.{{MINOR}}.{{PATCH}}"
+    __version__ = VERSION
+''') + "\n"
+# fmt: on
+
+
+def version_from_string(s: str) -> Version:
+    """Converts a version string of the following format major.minor.patch to a version object"""
+    major, minor, patch = (int(number, base=0) for number in s.split("."))
+    return Version(major, minor, patch)
+
+
+class CommitHookError(Exception):
+    """Indicates that this commit hook encountered an error"""
+
+
+def version_from_python_module(path: Path) -> Version:
+    """Retrieve version information from the `version` module"""
+    with open(path, encoding="utf-8") as file:
+        _locals: dict[str, Any] = {}
+        _globals: dict[str, Any] = {}
+        exec(file.read(), _locals, _globals)
+
+        try:
+            version = _globals["VERSION"]
+        except KeyError as ex:
+            raise CommitHookError("Couldn't find version within module") from ex
+
+        return version_from_string(version)
+
+
+def version_from_poetry() -> Version:
+    poetry = which("poetry")
+    if not poetry:
+        raise CommitHookError("Couldn't find poetry executable")
+
+    result = subprocess.run(
+        [poetry, "version", "--no-ansi"], capture_output=True, check=False
+    )
+    version = result.stdout.decode().split()[1]
+    return version_from_string(version)
+
+
+def write_version_module(version: Version, path: str, exists_ok: bool = True) -> None:
+    version_file = Path(path)
+    if version_file.exists() and not exists_ok:
+        raise CommitHookError(f"Version file [{version_file}] already exists.")
+    version_file.unlink(missing_ok=True)
+    with open(version_file, "w", encoding="utf-8") as f:
+        f.write(
+            _VERSION_MODULE_TEMPLATE.format(
+                major=version.major, minor=version.minor, patch=version.patch
+            )
+        )
+
+
+def _create_parser() -> ArgumentParser:
+    parser = ArgumentParser(
+        prog="nox -s version:check",
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+    )
+    parser.add_argument("version_module", help="Path to version module")
+    parser.add_argument("files", nargs="*")
+    parser.add_argument(
+        "-d",
+        "--debug",
+        action="store_true",
+        default=False,
+        help="enabled debug mode for execution.",
+    )
+    parser.add_argument(
+        "-f",
+        "--fix",
+        action="store_true",
+        default=False,
+        help="fix instead of check.",
+    )
+    return parser
+
+
+def _main_debug(args: Namespace) -> int:
+    module_version = version_from_python_module(args.version_module)
+    poetry_version = version_from_poetry()
+
+    if args.fix:
+        write_version_module(poetry_version, args.version_module)
+
+    if not module_version == poetry_version:
+        print(
+            f"Version in pyproject.toml {poetry_version} and {args.version_module} {module_version} do not match!"
+        )
+        if args.fix:
+            print(
+                f"Updating version in file ({args.version_module}) from {module_version} to {poetry_version}"
+            )
+            return _SUCCESS
+
+        return _FAILURE
+
+    return _SUCCESS
+
+
+def _main(args: Namespace) -> int:
+    try:
+        return _main_debug(args)
+    except Exception as ex:
+        print(f"Error while executing program, details: {ex}", file=sys.stderr)
+        return _FAILURE
+
+
+@nox.session(name="version:check", python=False)
+def version_check(session: Session) -> None:
+    """"""
+    parser = _create_parser()
+    args = parser.parse_args(session.posargs)
+    entry_point = _main if not args.debug else _main_debug
+    if entry_point(args):
+        session.error()

exasol/toolbox/nox/_shared.py

@@ -47,8 +47,8 @@ def _deny_filter(files: Iterable[Path], deny_list: Iterable[str]) -> Iterable[Pa
 
 
 def _version(session: Session, mode: Mode, version_file: Path) -> None:
-    command = ["version-check"]
-    command = command if mode == Mode.Check else command + ["--fix"]
+    command = ["nox", "-s", "version:check"]
+    command = command if mode == Mode.Check else command + ["--"] + ["--fix"]
     session.run(*command, f"{version_file}")
 
 

exasol/toolbox/nox/tasks.py

@@ -85,5 +85,7 @@ def check(session: Session) -> None:
     audit
 )
 
+from exasol.toolbox.nox._package_version import version_check
+
 # isort: on
 # fmt: on

exasol/toolbox/templates/github/workflows/checks.yml

@@ -22,7 +22,7 @@ jobs:
         run: |
           echo "Please enable the version check by replacing this output with shell command bellow:"
           echo ""
-          echo "poetry run -- version-check <<VERSION_PY>>"
+          echo "poetry run nox -s version:check -- <<VERSION_PY>>"
           echo ""
           echo "Note: <<VERSION_PY>> needs to point to the version file of the project (version.py)."
           exit 1

exasol/toolbox/version.py

@@ -1,7 +1,7 @@
 # ATTENTION:
-# This file is generated by exasol/toolbox/pre_commit_hooks/package_version.py when using:
+# This file is generated by exasol/toolbox/nox/_package_version.py when using:
 #   * either "poetry run -- nox -s project:fix"
-#   * or "poetry run -- version-check <path/version.py> --fix"
+#   * or "poetry run -- nox version:check <path/version.py> --fix"
 # Do not edit this file manually!
 # If you need to change the version, do so in the project.toml, e.g. by using `poetry version X.Y.Z`.
 MAJOR = 1

pyproject.toml

@@ -110,6 +110,5 @@ module = [
 ignore_errors = true
 
 [tool.poetry.plugins."console_scripts"]
-version-check = "exasol.toolbox.pre_commit_hooks.package_version:main"
 tbx = 'exasol.toolbox.tools.tbx:CLI'
 sphinx-multiversion = 'exasol.toolbox.sphinx.multiversion:main'