create base config class (#531)

Co-authored-by: Ariel Schulz <ariel.schulz@exasol.com>

Author: Jannis-Mittenzwei

doc/changes/unreleased.md

@@ -1 +1,31 @@
 # Unreleased
+
+## BaseConfig class for PTB attributes
+
+The BaseConfig class was introduced in this version. This class is used to consolidate
+the attributes needed for the PTB's functionalities into an inherited object which can
+be expanded upon as needed. At this point, the BaseConfig class includes
+``python_versions``, ``exasol_versions``, and ``create_major_version_tags``. Users of
+the PTB should update their ``noxconfig.py`` to start using this feature.
+
+```python
+# noxconfig.py
+from exasol.toolbox.config import BaseConfig
+
+
+# existing Config should inherit from BaseConfig
+class Config(BaseConfig):
+    # if present, remove any attributes already in the BaseConfig from the added attributes
+    ...
+
+
+# if no overlapping attributes with `BaseConfig` were present in `Config`, then this is unmodified.
+PROJECT_CONFIG = Config()
+# if no overlapping attributes with `BaseConfig` were present in `Config`, then this should be modified.
+PROJECT_CONFIG = Config(python_versions=(...), exasol_versions=(...), create_major_version_tags=True)
+```
+
+## Feature
+
+* #465: Created BaseConfig class to better synchronize attributes needed for the PTB's
+  growing functionalities

exasol/toolbox/config.py

@@ -0,0 +1,69 @@
+from typing import (
+    Annotated,
+)
+
+from pydantic import (
+    AfterValidator,
+    BaseModel,
+    ConfigDict,
+    Field,
+    computed_field,
+)
+
+from exasol.toolbox.util.version import Version
+
+
+def valid_version_string(version_string: str) -> str:
+    Version.from_string(version_string)
+    return version_string
+
+
+ValidVersionStr = Annotated[str, AfterValidator(valid_version_string)]
+
+
+class BaseConfig(BaseModel):
+    """
+    Basic configuration for projects using the PTB
+
+    This configuration class defines the necessary attributes for using the PTB's
+    various nox sessions and GitHub CI workflows. Defaults are provided via the
+    attributes, which makes it easy for a specific project to modify these values
+    as needed. There are properties provided which automate some configuration aspects
+    so that the project-specific modifications are reduced.
+
+    pydantic has been used so that altered attributes are quickly validated.
+    This allows for immediate feedback, instead of waiting for various failed CI
+    runs.
+    """
+
+    python_versions: tuple[ValidVersionStr, ...] = Field(
+        default=(
+            "3.9",
+            "3.10",
+            "3.11",
+            "3.12",
+            "3.13",
+        ),
+        description="Python versions to use in running CI workflows",
+    )
+
+    exasol_versions: tuple[ValidVersionStr, ...] = Field(
+        default=("7.1.9",),
+        description="Exasol versions to use in running CI workflows for integration tests using the DB",
+    )
+    create_major_version_tags: bool = Field(
+        default=False,
+        description="If true, creates also the major version tags (v*) automatically",
+    )
+    model_config = ConfigDict(frozen=True, arbitrary_types_allowed=True)
+
+    @computed_field  # type: ignore[misc]
+    @property
+    def min_py_version(self) -> str:
+        """
+        Minimum Python version declared from the `python_versions` list
+
+        This is used in specific testing scenarios where it would be either
+        costly to run the tests for all `python_versions` or we need a single metric.
+        """
+        return str(min([Version.from_string(v) for v in self.python_versions]))

noxconfig.py

@@ -3,9 +3,9 @@
 from __future__ import annotations
 
 from collections.abc import Iterable
-from dataclasses import dataclass
 from pathlib import Path
 
+from exasol.toolbox.config import BaseConfig
 from exasol.toolbox.nox.plugin import hookimpl
 from exasol.toolbox.tools.replace_version import update_github_yml
 from exasol.toolbox.util.version import Version
@@ -38,8 +38,17 @@ def prepare_release_add_files(self, session, config):
         return self.template_workflows + self.actions
 
 
-@dataclass(frozen=True)
-class Config:
+# BaseConfig
+#   - Use
+#       Project_Config = BaseConfig()
+#   - modify
+#       Project_Config = BaseConfig(python_versions=["3.12"])
+#   - expand (Do not overwrite the attributes of BaseConfig)
+#       class ProjectConfig(BaseConfig):
+#           extra_data: list[str] = ["data"]
+
+
+class Config(BaseConfig):
     """Project specific configuration used by nox infrastructure"""
 
     root: Path = Path(__file__).parent
@@ -53,14 +62,11 @@ class Config:
         "idioms",
         ".github",
     )
-    python_versions: Iterable[str] = ("3.9", "3.10", "3.11", "3.12", "3.13")
-    exasol_versions: Iterable[str] = ("7.1.9",)
     plugins: Iterable[object] = (UpdateTemplates,)
     # need --keep-runtime-typing, as pydantic with python3.9 does not accept str | None
     # format, and it is not resolved with from __future__ import annotations. pyupgrade
     # will keep switching Optional[str] to str | None leading to issues.
     pyupgrade_args: Iterable[str] = ("--py39-plus", "--keep-runtime-typing")
-    create_major_version_tags = True
 
 
-PROJECT_CONFIG = Config()
+PROJECT_CONFIG = Config(create_major_version_tags=True)

project-template/{{cookiecutter.repo_name}}/noxconfig.py

@@ -1,25 +1,24 @@
 from __future__ import annotations
 
-from dataclasses import dataclass
 from pathlib import Path
 from typing import Iterable
 
+from exasol.toolbox.config import BaseConfig
 
-@dataclass(frozen=True)
-class Config:
+
+class Config(BaseConfig):
     root: Path = Path(__file__).parent
     doc: Path = Path(__file__).parent / "doc"
     source: Path = Path("exasol/{{cookiecutter.package_name}}")
     version_file: Path = (
-        Path(__file__).parent
-        / "exasol"
-        / "{{cookiecutter.package_name}}"
-        / "version.py"
+            Path(__file__).parent
+            / "exasol"
+            / "{{cookiecutter.package_name}}"
+            / "version.py"
     )
     path_filters: Iterable[str] = ()
-    pyupgrade_args: Iterable[str] = ("--py{{cookiecutter.python_version_min | replace('.', '')}}-plus",)
+    pyupgrade_args: Iterable[str] = (
+    "--py{{cookiecutter.python_version_min | replace('.', '')}}-plus",)
     plugins: Iterable[object] = ()
-    create_major_version_tags = False
-
 
 PROJECT_CONFIG = Config()

test/unit/config_test.py

@@ -0,0 +1,62 @@
+import pytest
+from pydantic_core._pydantic_core import ValidationError
+
+from exasol.toolbox.config import (
+    BaseConfig,
+    valid_version_string,
+)
+
+
+class TestBaseConfig:
+    @staticmethod
+    def test_works_as_defined():
+        BaseConfig()
+
+    @staticmethod
+    @pytest.mark.parametrize(
+        "wrong_input,expected_message",
+        [
+            pytest.param(
+                {"python_versions": ["1.2.3.1"]},
+                "Version has an invalid format",
+                id="python_versions",
+            ),
+            pytest.param(
+                {"exasol_versions": ["1.2.3.1"]},
+                "Version has an invalid format",
+                id="exasol_versions",
+            ),
+        ],
+    )
+    def test_raises_exception_when_incorrect_modification(
+        wrong_input: dict, expected_message: str
+    ):
+        with pytest.raises(ValidationError, match=expected_message):
+            BaseConfig(**wrong_input)
+
+
+class TestValidVersionString:
+    @staticmethod
+    def test_work_as_expected():
+        version_string = "1.2.3"
+        result = valid_version_string(version_string=version_string)
+        assert result == version_string
+
+    @staticmethod
+    def test_raises_exception_when_not_valid():
+        with pytest.raises(ValueError):
+            valid_version_string("$.2.3")
+
+
+class BaseConfigExpansion(BaseConfig):
+    expansion1: str = "test1"
+
+
+def test_expansion_validation_fails_for_invalid_version():
+    with pytest.raises(ValueError):
+        BaseConfigExpansion(python_versions=("1.f.0",))
+
+
+def test_min_py_version():
+    conf = BaseConfig(python_versions=("5.5.5", "1.1.1", "9.9.9"))
+    assert conf.min_py_version == "1.1.1"

test/unit/documentation_test.py

@@ -11,7 +11,7 @@
     _docs_links_check,
     _docs_list_links,
 )
-from noxconfig import Config
+from noxconfig import PROJECT_CONFIG
 
 
 @pytest.fixture()
@@ -44,7 +44,7 @@ def config(index, file, tmp_path):
     test_doc = tmp_path / "doc"
     test_doc.mkdir()
     (test_doc / "_static").mkdir()
-    shutil.copyfile(Config.doc / "conf.py", test_doc / "conf.py")
+    shutil.copyfile(PROJECT_CONFIG.doc / "conf.py", test_doc / "conf.py")
     rst_index = test_doc / "index.rst"
     rst_file1 = test_doc / "file.rst"
     rst_index.touch()