Merge ~ruinedyourlife/launchpad:api-archive-metadata-overrides into launchpad:master

[Quentin Debhi]

Add metadata overrides API support for archives

Implement archive metadata reading and updating, for Origin, Label, and Suite fields

Unmerged commits

6e42790... by Quentin Debhi on 2024-04-04

feat: patch & get metadata

	docs:0 (build)
	lint:0 (build)
	mypy:0 (build)

1 → 3 of 3 results

First • Previous • Next • Last

diff --git a/lib/lp/archivepublisher/publishing.py b/lib/lp/archivepublisher/publishing.py
index bddf01e..84982cc 100644
--- a/lib/lp/archivepublisher/publishing.py
+++ b/lib/lp/archivepublisher/publishing.py
@@ -1183,12 +1183,30 @@ class Publisher:
                 "Oops, tainting RELEASE pocket of %s." % distroseries
             )
 
+    def _getMetadataOverrides(self, key):
+        """Helper method to get overriden metadata value if it exists.
+
+        :return: The overridden value if it exists, otherwise None.
+        """
+        try:
+            if (
+                self.archive.metadata_overrides
+                and key in self.archive.metadata_overrides
+            ):
+                return self.archive.metadata_overrides[key]
+            return None
+        except AttributeError:
+            return None
+
     def _getLabel(self):
         """Return the contents of the Release file Label field.
 
         :return: a text that should be used as the value of the Release file
             'Label' field.
         """
+        override = self._getMetadataOverrides("Label")
+        if override:
+            return override
         if self.archive.is_ppa:
             return self.archive.displayname
         elif self.archive.purpose == ArchivePurpose.PARTNER:
@@ -1208,12 +1226,26 @@ class Publisher:
         """
         # XXX al-maisan, 2008-11-19, bug=299981. If this file is released
         # from a copy archive then modify the origin to indicate so.
+        override = self._getMetadataOverrides("Origin")
+        if override:
+            return override
         if self.archive.purpose == ArchivePurpose.PARTNER:
             return "Canonical"
         if not self.archive.is_ppa:
             return self.distro.displayname
         return "LP-PPA-%s" % get_ppa_reference(self.archive)
 
+    def _getSuite(self, distroseries, pocket):
+        """Return the suite name for a distroseries and pocket."""
+        override = self._getMetadataOverrides("Suite")
+        if override:
+            # TODO: or we can do the series formatting here if it's not
+            # needed anywhere else, since we have access to the codename?
+            # e.g.: override.format(series=distroseries.codename)
+            return override
+
+        return distroseries.getSuite(pocket)
+
     def _getCurrentFiles(self, suite, release_file_name, extra_files):
         # Gather information on entries in the current Release file.
         release_path = os.path.join(
@@ -1417,7 +1449,7 @@ class Publisher:
     def _writeSuite(self, distroseries, pocket):
         """Write out the Release files for the provided suite."""
         # XXX: kiko 2006-08-24: Untested method.
-        suite = distroseries.getSuite(pocket)
+        suite = self._getSuite(distroseries, pocket)
         suite_dir = os.path.join(self._config.distsroot, suite)
         all_components = [
             comp.name
@@ -1495,6 +1527,7 @@ class Publisher:
         else:
             drsummary += pocket.name.capitalize()
 
+        # TODO: check if metadata overrides exist
         self.log.debug("Writing Release file for %s" % suite)
         release_file = Release()
         release_file["Origin"] = self._getOrigin()
diff --git a/lib/lp/soyuz/interfaces/archive.py b/lib/lp/soyuz/interfaces/archive.py
index e1521ce..0f17ae8 100644
--- a/lib/lp/soyuz/interfaces/archive.py
+++ b/lib/lp/soyuz/interfaces/archive.py
@@ -84,6 +84,7 @@ from zope.schema import (
     Bool,
     Choice,
     Datetime,
+    Dict,
     Int,
     List,
     Object,
@@ -2664,6 +2665,21 @@ class IArchiveEdit(Interface):
         :param names: A list of token names.
         """
 
+    @operation_parameters(
+        metadata_overrides=Dict(
+            title=_("Metadata overrides"),
+            key_type=TextLine(),
+            value_type=TextLine(),
+        )
+    )
+    @export_write_operation()
+    @operation_for_version("devel")
+    def updateMetadataOverrides(metadata_overrides):
+        """Edit the metadata overrides for this archive.
+
+        :param metadata_overrides: A dictionary of metadata overrides.
+        """
+
 
 class IArchiveDelete(Interface):
     """Archive interface for operations restricted by delete privilege."""
diff --git a/lib/lp/soyuz/model/archive.py b/lib/lp/soyuz/model/archive.py
index b86c2e9..516a2eb 100644
--- a/lib/lp/soyuz/model/archive.py
+++ b/lib/lp/soyuz/model/archive.py
@@ -2731,6 +2731,39 @@ class Archive(StormBase):
         token_set = getUtility(IArchiveAuthTokenSet)
         token_set.deactivateNamedTokensForArchive(self, names)
 
+    def _validateAndPatchMetadataOverrides(self, new_metadata_overrides):
+        allowed_keys = {"Origin", "Label", "Suite"}
+        if not all(
+            key in allowed_keys for key in new_metadata_overrides.keys()
+        ):
+            raise ValueError(
+                "Invalid metadata override key. Allowed keys are "
+                f"{allowed_keys}."
+            )
+
+        for key, value in new_metadata_overrides.items():
+            if not isinstance(value, str) or not value:
+                raise ValueError(
+                    f"Value for '{key}' must be a non-empty string."
+                )
+
+            # TODO: this is where i could handle series formating
+            # e.g.: value = value.replace("{series}", actual_series)
+
+        updated_metadata_overrides = (
+            self.metadata_overrides.copy() if self.metadata_overrides else {}
+        )
+        updated_metadata_overrides.update(new_metadata_overrides)
+
+        return updated_metadata_overrides
+
+    def updateMetadataOverrides(self, metadata_overrides):
+        """See `IArchive`."""
+        updated_metadata_overrides = self.validateAndPatchMetadataOverrides(
+            metadata_overrides
+        )
+        self.metadata_overrides = updated_metadata_overrides
+
     def newSubscription(
         self, subscriber, registrant, date_expires=None, description=None
     ):