Implement gl-metadata to generate release files

Signed-off-by: Tobias Wolf <wolf@b1-systems.de>

Author: NotTheEvilOne

src/gardenlinux/constants.py

@@ -140,7 +140,13 @@
     "secureboot.aws-efivars": "application/io.gardenlinux.cert.secureboot.aws-efivars",
 }
 
+GL_BUG_REPORT_URL = "https://github.com/gardenlinux/gardenlinux/issues"
+GL_COMMIT_SPECIAL_VALUES = ("local",)
+GL_DISTRIBUTION_NAME = "Garden Linux"
+GL_HOME_URL = "https://gardenlinux.io"
+GL_RELEASE_ID = "gardenlinux"
 GL_REPOSITORY_URL = "https://github.com/gardenlinux/gardenlinux"
+GL_SUPPORT_URL = "https://github.com/gardenlinux/gardenlinux"
 
 OCI_ANNOTATION_SIGNATURE_KEY = "io.gardenlinux.oci.signature"
 OCI_ANNOTATION_SIGNED_STRING_KEY = "io.gardenlinux.oci.signed-string"

src/gardenlinux/features/cname.py

@@ -10,7 +10,15 @@
 from os import PathLike
 import re
 
-from ..constants import ARCHS
+from ..constants import (
+    ARCHS,
+    GL_BUG_REPORT_URL,
+    GL_COMMIT_SPECIAL_VALUES,
+    GL_DISTRIBUTION_NAME,
+    GL_HOME_URL,
+    GL_RELEASE_ID,
+    GL_SUPPORT_URL,
+)
 
 from .parser import Parser
 
@@ -87,7 +95,7 @@ def __init__(self, cname, arch=None, commit_hash=None, version=None):
         if commit_id_or_hash is not None:
             self._commit_id = commit_id_or_hash[:8]
 
-            if len(commit_id_or_hash) == 40: # sha1 hex
+            if len(commit_id_or_hash) == 40:  # sha1 hex
                 self._commit_hash = commit_id_or_hash
 
     @property
@@ -129,7 +137,9 @@ def commit_hash(self) -> str:
         """
 
         if self._commit_hash is None:
-            raise RuntimeError("GardenLinux canonical name given does not contain the commit hash")
+            raise RuntimeError(
+                "GardenLinux canonical name given does not contain the commit hash"
+            )
 
         return self._commit_hash
 
@@ -183,6 +193,42 @@ def feature_set(self) -> str:
 
         return Parser().filter_as_string(self.flavor)
 
+    @property
+    def metadata_string(self) -> str:
+        """
+        Returns the metadata describing the given CName instance.
+
+        :return: (str) Metadata describing the given CName instance
+        :since:  0.9.2
+        """
+
+        features = Parser().filter_as_dict(self.flavor)
+
+        elements = ",".join(features["element"])
+        flags = ",".join(features["flag"])
+        platforms = ",".join(features["platform"])
+
+        metadata = f"""
+ID={GL_RELEASE_ID}
+NAME="{GL_DISTRIBUTION_NAME}"
+PRETTY_NAME="{GL_DISTRIBUTION_NAME} {self.version}"
+IMAGE_VERSION={self.version}
+VARIANT_ID="{self.flavor}-{self.arch}"
+HOME_URL="{GL_HOME_URL}"
+SUPPORT_URL="{GL_SUPPORT_URL}"
+BUG_REPORT_URL="{GL_BUG_REPORT_URL}"
+GARDENLINUX_CNAME="{self.cname}"
+GARDENLINUX_FEATURES="{self.feature_set}"
+GARDENLINUX_FEATURES_PLATFORMS="{platforms}"
+GARDENLINUX_FEATURES_ELEMENTS="{elements}"
+GARDENLINUX_FEATURES_FLAGS="{flags}"
+GARDENLINUX_VERSION="{self.version}"
+GARDENLINUX_COMMIT_ID="{self.commit_id}"
+GARDENLINUX_COMMIT_ID_LONG="{self.commit_hash}"
+        """.strip()
+
+        return metadata
+
     @property
     def platform(self) -> str:
         """
@@ -317,30 +363,5 @@ def save_to_metadata_file(
                 f"Refused to overwrite existing metadata file: {metadata_file}"
             )
 
-        features = Parser().filter_as_dict(self.flavor)
-
-        elements = ",".join(features["element"])
-        flags = ",".join(features["flag"])
-        platforms = ",".join(features["platform"])
-
-        metadata = f"""
-ID=gardenlinux
-NAME="Garden Linux"
-PRETTY_NAME="Garden Linux {self.version}"
-IMAGE_VERSION={self.version}
-VARIANT_ID="{self.flavor}-{self.arch}"
-HOME_URL="https://gardenlinux.io"
-SUPPORT_URL="https://github.com/gardenlinux/gardenlinux"
-BUG_REPORT_URL="https://github.com/gardenlinux/gardenlinux/issues"
-GARDENLINUX_CNAME="{self.cname}"
-GARDENLINUX_FEATURES="{self.feature_set}"
-GARDENLINUX_FEATURES_PLATFORMS="{platforms}"
-GARDENLINUX_FEATURES_ELEMENTS="{elements}"
-GARDENLINUX_FEATURES_FLAGS="{flags}"
-GARDENLINUX_VERSION="{self.version}"
-GARDENLINUX_COMMIT_ID="{self.commit_id}"
-GARDENLINUX_COMMIT_ID_LONG="{self.commit_hash}"
-        """.strip()
-
         with metadata_file.open("w") as fp:
-            fp.write(metadata)
+            fp.write(self.metadata_string)

src/gardenlinux/features/metadata_main.py

@@ -0,0 +1,68 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""
+gl-metadata main entrypoint
+"""
+
+from functools import reduce
+from os.path import basename, dirname
+import argparse
+import logging
+import re
+
+from .cname import CName
+from .parser import Parser
+
+from .__main__ import (
+    get_cname_base,
+    get_minimal_feature_set,
+    get_version_and_commit_id_from_files,
+    sort_subset,
+)
+
+
+_ARGS_ACTION_ALLOWED = [
+    "output-as-json",
+    "write",
+]
+
+
+def main():
+    """
+    gl-metadata main()
+
+    :since: 0.7.0
+    """
+
+    parser = argparse.ArgumentParser()
+
+    parser.add_argument("--arch", dest="arch")
+    parser.add_argument("--cname", required=True, dest="cname")
+    parser.add_argument("--commit-hash", dest="commit_hash")
+    parser.add_argument("--release-file", dest="release_file")
+    parser.add_argument("--overwrite-file", type=bool, dest="overwrite_file")
+    parser.add_argument("--version", dest="version")
+
+    parser.add_argument(
+        "action", nargs="?", choices=_ARGS_ACTION_ALLOWED, default="output-as-json"
+    )
+
+    args = parser.parse_args()
+
+    cname = CName(
+        args.cname, arch=args.arch, commit_hash=args.commit_hash, version=args.version
+    )
+
+    if args.commit_hash is not None:
+        cname.commit_hash = args.commit_hash
+
+    if args.action == "write":
+        cname.save_to_metadata_file(args.release_file, args.overwrite_file)
+    else:
+        cname.load_from_metadata_file(args.release_file)
+        print(cname.metadata_string)
+
+
+if __name__ == "__main__":
+    main()