Reflect changes that metadata is based on the OS release metadata

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

Author: NotTheEvilOne

src/gardenlinux/features/cname.py

@@ -197,12 +197,12 @@ def feature_set(self) -> str:
         return Parser().filter_as_string(self.flavor)
 
     @property
-    def metadata_string(self) -> str:
+    def release_metadata_string(self) -> str:
         """
-        Returns the metadata describing the given CName instance.
+        Returns the release metadata describing the given CName instance.
 
-        :return: (str) Metadata describing the given CName instance
-        :since:  0.9.2
+        :return: (str) Release metadata describing the given CName instance
+        :since:  0.11.0
         """
 
         features = Parser().filter_as_dict(self.flavor)
@@ -285,42 +285,42 @@ def version_and_commit_id(self) -> Optional[str]:
 
         return f"{self._version}-{self._commit_id}"
 
-    def load_from_metadata_file(self, metadata_file: PathLike | str) -> None:
+    def load_from_release_file(self, release_file: PathLike | str) -> None:
         """
-        Loads and parses a metadata file.
+        Loads and parses a release metadata file.
 
-        :param metadata_file: Metadata file containing information about the CName instance.
+        :param release_file: Release metadata file
 
         :since: 0.11.0
         """
 
-        if not isinstance(metadata_file, PathLike):
-            metadata_file = Path(metadata_file)
+        if not isinstance(release_file, PathLike):
+            release_file = Path(release_file)
 
-        if not metadata_file.exists():
-            raise RuntimeError(f"Metadata file given is invalid: {metadata_file}")
+        if not release_file.exists():
+            raise RuntimeError(f"Release metadata file given is invalid: {release_file}")
 
-        metadata_config = ConfigParser(allow_unnamed_section=True)
-        metadata_config.read(metadata_file)
+        release_config = ConfigParser(allow_unnamed_section=True)
+        release_config.read(release_file)
 
-        for metadata_field in (
+        for release_field in (
             "GARDENLINUX_CNAME",
             "GARDENLINUX_FEATURES",
             "GARDENLINUX_FEATURES_PLATFORMS",
             "GARDENLINUX_VERSION",
         ):
-            if not metadata_config.has_option(UNNAMED_SECTION, metadata_field):
+            if not release_config.has_option(UNNAMED_SECTION, release_field):
                 raise RuntimeError(
-                    f"Metadata file given is invalid: {metadata_file} misses {metadata_field}"
+                    f"Release metadata file given is invalid: {release_file} misses {release_field}"
                 )
 
         loaded_cname_instance = CName(
-            metadata_config.get(UNNAMED_SECTION, "GARDENLINUX_CNAME")
+            release_config.get(UNNAMED_SECTION, "GARDENLINUX_CNAME")
         )
 
-        commit_id = metadata_config.get(UNNAMED_SECTION, "GARDENLINUX_COMMIT_ID")
-        commit_hash = metadata_config.get(UNNAMED_SECTION, "GARDENLINUX_COMMIT_ID_LONG")
-        version = metadata_config.get(UNNAMED_SECTION, "GARDENLINUX_VERSION")
+        commit_id = release_config.get(UNNAMED_SECTION, "GARDENLINUX_COMMIT_ID")
+        commit_hash = release_config.get(UNNAMED_SECTION, "GARDENLINUX_COMMIT_ID_LONG")
+        version = release_config.get(UNNAMED_SECTION, "GARDENLINUX_VERSION")
 
         if (
             loaded_cname_instance.flavor != self.flavor
@@ -330,7 +330,7 @@ def load_from_metadata_file(self, metadata_file: PathLike | str) -> None:
             or (self._version is not None and self._version != version)
         ):
             raise RuntimeError(
-                f"Metadata file given is invalid: {metadata_file} failed consistency check - {self.cname} != {loaded_cname_instance.cname}"
+                f"Release metadata file given is invalid: {release_file} failed consistency check - {self.cname} != {loaded_cname_instance.cname}"
             )
 
         self._arch = loaded_cname_instance.arch
@@ -339,32 +339,32 @@ def load_from_metadata_file(self, metadata_file: PathLike | str) -> None:
         self._commit_id = commit_id
         self._version = version
 
-        self._feature_set_cached = metadata_config.get(
+        self._feature_set_cached = release_config.get(
             UNNAMED_SECTION, "GARDENLINUX_FEATURES"
         )
 
-        self._platforms_cached = metadata_config.get(
+        self._platforms_cached = release_config.get(
             UNNAMED_SECTION, "GARDENLINUX_FEATURES_PLATFORMS"
         ).split(",")
 
-    def save_to_metadata_file(
-        self, metadata_file: PathLike | str, overwrite: Optional[bool] = False
+    def save_to_release_file(
+        self, release_file: PathLike | str, overwrite: Optional[bool] = False
     ) -> None:
         """
-        Saves the metadata file.
+        Saves the release metadata file.
 
-        :param metadata_file: Metadata file containing information about the CName instance.
+        :param release_file: Release metadata file
 
         :since: 0.11.0
         """
 
-        if not isinstance(metadata_file, PathLike):
-            metadata_file = Path(metadata_file)
+        if not isinstance(release_file, PathLike):
+            release_file = Path(release_file)
 
-        if not overwrite and metadata_file.exists():
+        if not overwrite and release_file.exists():
             raise RuntimeError(
-                f"Refused to overwrite existing metadata file: {metadata_file}"
+                f"Refused to overwrite existing release metadata file: {release_file}"
             )
 
-        with metadata_file.open("w") as fp:
-            fp.write(self.metadata_string)
+        with release_file.open("w") as fp:
+            fp.write(self.release_string)

src/gardenlinux/features/metadata_main.py

@@ -23,7 +23,7 @@
 
 
 _ARGS_ACTION_ALLOWED = [
-    "output-as-json",
+    "output-release-metadata",
     "write",
 ]
 
@@ -45,7 +45,7 @@ def main():
     parser.add_argument("--version", dest="version")
 
     parser.add_argument(
-        "action", nargs="?", choices=_ARGS_ACTION_ALLOWED, default="output-as-json"
+        "action", nargs="?", choices=_ARGS_ACTION_ALLOWED, default="output-release-metadata"
     )
 
     args = parser.parse_args()
@@ -58,10 +58,12 @@ def main():
         cname.commit_hash = args.commit_hash
 
     if args.action == "write":
-        cname.save_to_metadata_file(args.release_file, args.overwrite_file)
+        cname.save_to_release_file(args.release_file, args.overwrite_file)
     else:
-        cname.load_from_metadata_file(args.release_file)
-        print(cname.metadata_string)
+        if args.release_file is not None:
+            cname.load_from_release_file(args.release_file)
+
+        print(cname.release_metadata_string)
 
 
 if __name__ == "__main__":