DistroVersion class

Author: vivus-ignis

src/gardenlinux/distro_version/__init__.py

@@ -0,0 +1,51 @@
+from typing import Optional
+
+
+class UnsupportedDistroVersion(Exception):
+    pass
+
+
+class NotAPatchRelease(Exception):
+    pass
+
+
+class DistroVersion:
+    major: Optional[int] = None
+    minor: Optional[int] = None
+    patch: Optional[int] = None
+
+    def __init__(self, maybe_version_str):
+        version_components = maybe_version_str.split(".")
+        if len(version_components) > 3 or len(version_components) < 2:
+            raise UnsupportedDistroVersion(
+                f"Unexpected version number format {maybe_version_str}"
+            )
+
+        if not all(map(lambda x: x.isdigit(), version_components)):
+            raise UnsupportedDistroVersion(
+                f"Unexpected version number format {maybe_version_str}"
+            )
+
+        self.major = int(version_components[0])
+
+        if len(version_components) == 2:
+            self.patch = int(version_components[1])
+
+        if len(version_components) == 3:
+            self.minor = int(version_components[1])
+            self.patch = int(version_components[2])
+
+    def __str__(self):
+        return (
+            f"{self.major}.{self.minor}.{self.patch - 1}"
+            if self.minor
+            else f"{self.major}.{self.patch - 1}"
+        )
+
+    def is_patch_release(self):
+        return self.patch > 0
+
+    def previous_patch_release(self):
+        if not self.is_patch_release():
+            raise NotAPatchRelease(f"{self} is not a patch release")
+        return self.__str__()

src/gardenlinux/github/release_notes/sections.py

@@ -6,6 +6,7 @@
 from yaml import SafeLoader
 
 from gardenlinux.constants import GLVD_BASE_URL, REQUESTS_TIMEOUTS
+from gardenlinux.distro_version import DistroVersion
 from gardenlinux.logger import LoggerSetup
 
 from .deployment_platform.ali_cloud import AliCloud
@@ -102,34 +103,15 @@ def release_notes_software_components_section(package_list):
 
 
 def release_notes_compare_package_versions_section(gardenlinux_version, package_list):
-    version_components = gardenlinux_version.split(".")
-    if len(version_components) > 3 or len(version_components) < 2:
-        LOGGER.error(f"Unexpected version number format {gardenlinux_version}")
-        return ""
-    if not all(map(lambda x: x.isdigit(), version_components)):
-        LOGGER.error(f"Unexpected version number format {gardenlinux_version}")
-        return ""
-
-    major = int(version_components[0])
-    minor = None
-    patch = None
-
-    if len(version_components) == 2:
-        patch = int(version_components[1])
-    if len(version_components) == 3:
-        minor = int(version_components[1])
-        patch = int(version_components[2])
-
+    version = DistroVersion(gardenlinux_version)
     output = ""
 
-    if patch > 0:
-        previous_version = (
-            f"{major}.{minor}.{patch - 1}" if minor else f"{major}.{patch - 1}"
-        )
+    if version.is_patch_release():
+        previous_version = version.previous_patch_release()
 
         output += f"## Changes in Package Versions Compared to {previous_version}\n"
         output += compare_apt_repo_versions(previous_version, gardenlinux_version)
-    elif patch == 0:
+    else:
         output += (
             f"## Full List of Packages in Garden Linux version {gardenlinux_version}\n"
         )
@@ -138,8 +120,8 @@ def release_notes_compare_package_versions_section(gardenlinux_version, package_
         output += "\n"
         for entry in package_list.values():
             output += f"{entry!r}\n"
-        output += "</pre>"
-        output += "\n</details>\n\n"
+            output += "</pre>"
+            output += "\n</details>\n\n"
 
     return output
 

tests/distro_version/test_distro_version.py

@@ -0,0 +1,48 @@
+import pytest
+
+from gardenlinux.distro_version import (
+    DistroVersion,
+    NotAPatchRelease,
+    UnsupportedDistroVersion,
+)
+
+
+def test_distro_version_unrecognizable_non_numeric_version():
+    with pytest.raises(UnsupportedDistroVersion):
+        DistroVersion("garden.linux")
+
+
+def test_distro_version_unrecognizable_numeric_version():
+    with pytest.raises(UnsupportedDistroVersion):
+        DistroVersion("1.2.3.4")
+    with pytest.raises(UnsupportedDistroVersion):
+        DistroVersion("1.100.-10")
+
+
+def test_distro_version_unrecognizable_too_short_version():
+    with pytest.raises(UnsupportedDistroVersion):
+        DistroVersion("1")
+
+
+def test_distro_version_legacy_version_is_parsable():
+    assert isinstance(DistroVersion("1.2"), DistroVersion)
+
+
+def test_distro_version_semver_version_is_parsable():
+    assert isinstance(DistroVersion("1.2.3"), DistroVersion)
+
+
+def test_distro_version_patch_release_is_recognized():
+    assert DistroVersion("1.1").is_patch_release()
+    assert DistroVersion("1.1.100").is_patch_release()
+    assert not DistroVersion("1.0").is_patch_release()
+    assert not DistroVersion("1.0.0").is_patch_release()
+
+
+def test_distro_version_previous_patch_release_is_recognized():
+    assert DistroVersion("1.1").previous_patch_release() == "1.0"
+    assert DistroVersion("1.1.100").previous_patch_release() == "1.1.99"
+    with pytest.raises(NotAPatchRelease):
+        DistroVersion("1.0").previous_patch_release()
+    with pytest.raises(NotAPatchRelease):
+        DistroVersion("1.100.0").previous_patch_release()

tests/github/test_create_github_release_notes.py

@@ -4,6 +4,7 @@
 from moto import mock_aws
 
 from gardenlinux.constants import GLVD_BASE_URL
+from gardenlinux.distro_version import UnsupportedDistroVersion
 from gardenlinux.github.release_notes import (
     release_notes_changes_section,
     release_notes_compare_package_versions_section,
@@ -104,12 +105,9 @@ def mock_compare_apt_repo_versions(previous_version, current_version):
     ), "Semver patch releases are supported"
 
 
-def test_release_notes_compare_package_versions_section_unrecognizable_version(caplog):
-    assert release_notes_compare_package_versions_section("garden.linux", {}) == ""
-    assert any(
-        "Unexpected version number format garden.linux" in record.message
-        for record in caplog.records
-    ), "Expected an error log message"
+def test_release_notes_compare_package_versions_section_unrecognizable_version():
+    with pytest.raises(UnsupportedDistroVersion):
+        release_notes_compare_package_versions_section("garden.linux", {})
 
 
 @pytest.mark.parametrize("flavor", TEST_FLAVORS)