release notes sections creation

Author: vivus-ignis

src/gardenlinux/apt/__init__.py

@@ -5,5 +5,6 @@
 """
 
 from .debsource import Debsrc, DebsrcFile
+from .package_repo_info import GardenLinuxRepo
 
-__all__ = ["Debsrc", "DebsrcFile"]
+__all__ = ["Debsrc", "DebsrcFile", "GardenLinuxRepo"]

src/gardenlinux/constants.py

@@ -1,4 +1,5 @@
-# -*- coding: utf-8 -*-
+import os
+from pathlib import Path
 
 ARCHS = ["amd64", "arm64"]
 
@@ -149,3 +150,7 @@
 RELEASE_ID_FILE = ".github_release_id"
 
 REQUESTS_TIMEOUTS = (5, 30)  # connect, read
+
+S3_DOWNLOADS_DIR = Path(os.path.dirname(__file__)) / ".." / "s3_downloads"
+
+GLVD_BASE_URL = "https://glvd.ingress.glvd.gardnlinux.shoot.canary.k8s-hana.ondemand.com/v1"

src/gardenlinux/github/__main__.py

@@ -1,12 +1,25 @@
 import argparse
 
-from .release import upload_to_github_release_page
+from gardenlinux.logger import LoggerSetup
+
+from .release import create_github_release, upload_to_github_release_page, write_to_release_id_file
+from .release_notes import create_github_release_notes
+
+LOGGER = LoggerSetup.get_logger("gardenlinux.github", "INFO")
 
 
 def main():
     parser = argparse.ArgumentParser(description="GitHub Release Script")
     subparsers = parser.add_subparsers(dest="command")
 
+    create_parser = subparsers.add_parser("create")
+    create_parser.add_argument("--owner", default="gardenlinux")
+    create_parser.add_argument("--repo", default="gardenlinux")
+    create_parser.add_argument("--tag", required=True)
+    create_parser.add_argument("--commit", required=True)
+    create_parser.add_argument('--latest', action='store_true', default=False)
+    create_parser.add_argument("--dry-run", action="store_true", default=False)
+
     upload_parser = subparsers.add_parser("upload")
     upload_parser.add_argument("--owner", default="gardenlinux")
     upload_parser.add_argument("--repo", default="gardenlinux")
@@ -16,7 +29,19 @@ def main():
 
     args = parser.parse_args()
 
-    if args.command == "upload":
+    if args.command == "create":
+        body = create_github_release_notes(args.tag, args.commit)
+        if args.dry_run:
+            print("Dry Run ...")
+            print("This release would be created:")
+            print(body)
+        else:
+            release_id = create_github_release(
+                args.owner, args.repo, args.tag, args.commit, args.latest, body
+            )
+            write_to_release_id_file(f"{release_id}")
+            LOGGER.info(f"Release created with ID: {release_id}")
+    elif args.command == "upload":
         upload_to_github_release_page(
             args.owner, args.repo, args.release_id, args.file_path, args.dry_run
         )

src/gardenlinux/github/release_notes/__init__.py

@@ -19,6 +19,8 @@ def create_github_release_notes(gardenlinux_version, commitish):
         gardenlinux_version, package_list
     )
 
+    # TODO: image ids
+
     output += "\n"
     output += "## Kernel Module Build Container (kmodbuild)"
     output += "\n"

src/gardenlinux/github/release_notes/sections.py

@@ -3,7 +3,7 @@
 
 import requests
 
-from gardenlinux.constants import REQUESTS_TIMEOUTS
+from gardenlinux.constants import GLVD_BASE_URL, REQUESTS_TIMEOUTS
 from gardenlinux.logger import LoggerSetup
 
 from .helpers import compare_apt_repo_versions
@@ -18,7 +18,7 @@ def release_notes_changes_section(gardenlinux_version):
     file issues in glvd for improvement suggestions https://github.com/gardenlinux/glvd/issues
     """
     try:
-        url = f"https://glvd.ingress.glvd.gardnlinux.shoot.canary.k8s-hana.ondemand.com/v1/patchReleaseNotes/{gardenlinux_version}"
+        url = f"{GLVD_BASE_URL}/patchReleaseNotes/{gardenlinux_version}"
         response = requests.get(url, timeout=REQUESTS_TIMEOUTS)
         response.raise_for_status()
         data = response.json()
@@ -43,8 +43,11 @@ def release_notes_changes_section(gardenlinux_version):
 
         return "\n".join(output) + "\n\n"
     except Exception as exn:
-        # There are expected error cases, for example with versions not supported by glvd (1443.x) or when the api is not available
-        # Fail gracefully by adding the placeholder we previously used, so that the release note generation does not fail.
+        # There are expected error cases,
+        # for example with versions not supported by glvd (1443.x)
+        # or when the api is not available
+        # Fail gracefully by adding the placeholder we previously used,
+        # so that the release note generation does not fail.
         LOGGER.error(f"Failed to process GLVD API output: {exn}")
         return textwrap.dedent(
             """

tests/constants.py

@@ -27,6 +27,4 @@
 TEST_GARDENLINUX_RELEASE = "1877.3"
 TEST_GARDENLINUX_COMMIT = "75df9f401a842914563f312899ec3ce34b24515c"
 
-RELEASE_ID_FILE = ".github_release_id"
-
 S3_DOWNLOADS_DIR = Path(os.path.dirname(__file__)) / ".." / "s3_downloads"

tests/github/conftest.py

@@ -4,7 +4,7 @@
 
 import pytest
 
-from ..constants import RELEASE_ID_FILE, S3_DOWNLOADS_DIR
+from gardenlinux.constants import RELEASE_ID_FILE, S3_DOWNLOADS_DIR
 
 
 @pytest.fixture

tests/github/test_create_github_release_notes.py

@@ -0,0 +1,39 @@
+import requests_mock
+
+from gardenlinux.constants import GLVD_BASE_URL
+from gardenlinux.github.release_notes import (
+    release_notes_changes_section,
+    release_notes_compare_package_versions_section,
+)
+
+from ..constants import TEST_GARDENLINUX_RELEASE
+
+
+def test_release_notes_changes_section_empty_packagelist():
+    with requests_mock.Mocker() as m:
+        m.get(
+            f"{GLVD_BASE_URL}/patchReleaseNotes/{TEST_GARDENLINUX_RELEASE}",
+            text='{"packageList": []}',
+            status_code=200
+        )
+        assert release_notes_changes_section(TEST_GARDENLINUX_RELEASE) == "", \
+            "Expected an empty result if GLVD returns an empty package list"
+
+
+def test_release_notes_changes_section_broken_glvd_response():
+    with requests_mock.Mocker() as m:
+        m.get(
+            f"{GLVD_BASE_URL}/patchReleaseNotes/{TEST_GARDENLINUX_RELEASE}",
+            text="<html><body><h1>Personal Home Page</h1></body></html>",
+            status_code=200
+        )
+        assert "fill this in" in release_notes_changes_section(TEST_GARDENLINUX_RELEASE), \
+            "Expected a placeholder message to be generated if GVLD response is not valid"
+
+
+def test_release_notes_compare_package_versions_section_semver_is_not_recognized():
+    assert release_notes_compare_package_versions_section("1.2.0", []) == "", "Semver is not supported"
+
+
+def test_release_notes_compare_package_versions_section_unrecognizable_version():
+    assert release_notes_compare_package_versions_section("garden.linux", []) == ""