Changed replacement of version in Github Actions

Author: tomuben

exasol/toolbox/tools/replace_version.py

@@ -2,9 +2,15 @@
 from dataclasses import dataclass
 from enum import Enum
 from pathlib import Path
+from typing import (
+    Callable,
+    Optional,
+)
 
+from exasol.toolbox.util.version import Version
 
-def update_github_yml(template: Path, version: str) -> None:
+
+def update_github_yml(template: Path, version: Version) -> None:
     """Updates versions in GitHub workflows and actions"""
     with open(template, encoding="utf-8") as file:
         content = file.readlines()
@@ -19,10 +25,7 @@ def update_github_yml(template: Path, version: str) -> None:
 class Pattern:
     match_pattern: str
     break_pattern: str
-
-    @property
-    def version_pattern(self) -> str:
-        return r"[0-9]+\.[0-9]+\.[0-9]+"
+    version_pattern: str
 
     @property
     def full_pattern(self) -> str:
@@ -36,24 +39,58 @@ def replace_version(self, line: str, version: str) -> str:
         )
 
 
-class ToolboxPattern(Enum):
-    github = Pattern(
-        match_pattern="exasol/python-toolbox/.github/[^/]+/[^/]+",
-        break_pattern="@",
+def full_version_modifier(version: Version) -> str:
+    return str(version)
+
+
+def major_version_modifier(version: Version) -> str:
+    return f"v{version.major}"
+
+
+class GithubActionsReplacement:
+    def __init__(
+        self, pattern: Pattern, version_string_modifier: Callable[[Version], str]
+    ) -> None:
+        self.pattern = pattern
+        self.version_string_modifier = version_string_modifier
+
+    def replace_version(self, line: str, version: Version) -> Optional[str]:
+        match = re.search(self.pattern.full_pattern, line)
+        if match:
+            return self.pattern.replace_version(
+                line=line, version=self.version_string_modifier(version)
+            )
+        return None
+
+
+class Replacements(Enum):
+    github = GithubActionsReplacement(
+        pattern=Pattern(
+            match_pattern="exasol/python-toolbox/.github/[^/]+/[^/]+",
+            break_pattern="@",
+            version_pattern=r"[0-9]+\.[0-9]+\.[0-9]+",
+        ),
+        version_string_modifier=major_version_modifier,
     )
-    pypi = Pattern(
-        match_pattern="exasol-toolbox",
-        break_pattern="==",
+
+    pypi = GithubActionsReplacement(
+        pattern=Pattern(
+            match_pattern="exasol-toolbox",
+            break_pattern="==",
+            version_pattern=r"[0-9]+\.[0-9]+\.[0-9]+",
+        ),
+        version_string_modifier=full_version_modifier,
     )
 
 
-def _update_line_with_version(line: str, version: str) -> str:
-    for pattern in ToolboxPattern:
-        match = re.search(pattern.value.full_pattern, line)
-        if match:
-            return pattern.value.replace_version(line=line, version=version)
+def _update_line_with_version(line: str, version: Version) -> str:
+    for replacement in Replacements:
+        if replaced_line := replacement.value.replace_version(
+            line=line, version=version
+        ):
+            return replaced_line
     return line
 
 
-def update_versions(lines: list[str], version: str) -> list[str]:
+def update_versions(lines: list[str], version: Version) -> list[str]:
     return [_update_line_with_version(line=line, version=version) for line in lines]

noxconfig.py

@@ -8,6 +8,7 @@
 
 from exasol.toolbox.nox.plugin import hookimpl
 from exasol.toolbox.tools.replace_version import update_github_yml
+from exasol.toolbox.util.version import Version
 
 
 class UpdateTemplates:
@@ -25,7 +26,7 @@ def actions(self) -> list[Path]:
         return [f for f in gh_actions.rglob("*") if f.is_file()]
 
     @hookimpl
-    def prepare_release_update_version(self, session, config, version):
+    def prepare_release_update_version(self, session, config, version: Version) -> None:
         for workflow in self.template_workflows:
             update_github_yml(workflow, version)
 

test/unit/replace_version_test.py

@@ -4,14 +4,15 @@
     _update_line_with_version,
     update_versions,
 )
+from exasol.toolbox.util.version import Version
 
 
 @pytest.mark.parametrize(
     "line,expected",
     [
         pytest.param(
-            "exasol/python-toolbox/.github/actions/python-environment@1.0.0",
-            "exasol/python-toolbox/.github/actions/python-environment@2.0.0",
+            "exasol/python-toolbox/.github/actions/python-environment@v1",
+            "exasol/python-toolbox/.github/actions/python-environment@v2",
             id="github_action",
         ),
         pytest.param(
@@ -27,16 +28,16 @@
     ],
 )
 def test_update_line_with_version(line: str, expected: str):
-    actual = _update_line_with_version(line=line, version="2.0.0")
+    actual = _update_line_with_version(line=line, version=Version(2, 0, 0))
     assert actual == expected
 
 
 @pytest.mark.parametrize(
     "line_to_change, expected",
     [
         pytest.param(
-            "exasol/python-toolbox/.github/actions/python-environment@1.0.0",
-            "exasol/python-toolbox/.github/actions/python-environment@2.0.0",
+            "exasol/python-toolbox/.github/actions/python-environment@v1",
+            "exasol/python-toolbox/.github/actions/python-environment@v2",
             id="github_action",
         ),
         pytest.param(
@@ -55,5 +56,5 @@ def test_update_versions(line_to_change, expected):
     lines = dummy_lines + [line_to_change]
     expected_lines = dummy_lines + [expected]
 
-    actual = update_versions(lines=lines, version="2.0.0")
+    actual = update_versions(lines=lines, version=Version(2, 0, 0))
     assert actual == expected_lines