Merge ~twom/launchpad:oci-policy-push-tags-to-the-limit into launchpad:master

[Tom Wardill]

Add tag support to OCIPushRule

Use the text[] column for tags to add tag support to OCIPushRule.
No validation on the tags other than uniqueness, and the tags aren't currently used on push. This is just model and interface support.

Can't land until after https://code.launchpad.net/~twom/launchpad/+git/launchpad/+merge/394958

[Thiago F. Pappacena (pappacena)]

LGTM. Added just a couple of minor possible improvements.

review: Approve

3e012bd... by Tom Wardill on 2020-12-09

Use text[] column instead of class

Unmerged commits

3e012bd... by Tom Wardill on 2020-12-09

Use text[] column instead of class

diff --git a/database/schema/patch-2210-24-0.sql b/database/schema/patch-2210-24-0.sql
 deleted file mode 100644
index 2ba3f52..0000000
--- a/database/schema/patch-2210-24-0.sql
+++ /dev/null
@@ -1,11 +0,0 @@
--- Copyright 2020 Canonical Ltd.  This software is licensed under the
--- GNU Affero General Public License version 3 (see the file LICENSE).
-
-SET client_min_messages=ERROR;
-
-ALTER TABLE OCIPushRule
-    ADD COLUMN tags text[];
-
-COMMENT ON COLUMN OCIPushRule.tags IS 'Tags to use on image upload.';
-
-INSERT INTO LaunchpadDatabaseRevision VALUES (2210, 24, 0);
diff --git a/lib/lp/oci/interfaces/ocipushrule.py b/lib/lp/oci/interfaces/ocipushrule.py
index 67db23e..f32927c 100644
--- a/lib/lp/oci/interfaces/ocipushrule.py
+++ b/lib/lp/oci/interfaces/ocipushrule.py
@@ -23,10 +23,12 @@ from lazr.restful.declarations import (
     operation_parameters,
     )
 from lazr.restful.fields import Reference
+from lazr.restful.interface import copy_field
 from six.moves import http_client
 from zope.interface import Interface
 from zope.schema import (
     Int,
+    List,
     TextLine,
     )
 
@@ -102,6 +104,13 @@ class IOCIPushRuleEditableAttributes(Interface):
     def setNewImageName(image_name):
         """Set the new image name, checking for uniqueness."""
 
+    tags = exported(List(
+        value_type=TextLine(),
+        title=_("Tags"),
+        description=_("Tags to use on image upload."),
+        required=False,
+        readonly=False))
+
 
 class IOCIPushRuleEdit(Interface):
     """`IOCIPushRule` methods that require launchpad.Edit
diff --git a/lib/lp/oci/model/ocipushrule.py b/lib/lp/oci/model/ocipushrule.py
index 24d5e27..edea2a1 100644
--- a/lib/lp/oci/model/ocipushrule.py
+++ b/lib/lp/oci/model/ocipushrule.py
@@ -13,6 +13,7 @@ __all__ = [
 
 from storm.locals import (
     Int,
+    List,
     Reference,
     Storm,
     Unicode,
@@ -44,6 +45,8 @@ class OCIPushRule(Storm):
 
     image_name = Unicode(name="image_name", allow_none=False)
 
+    _tags = List(name="tags", type=Unicode(), default_factory=list)
+
     @property
     def registry_url(self):
         return self.registry_credentials.url
@@ -71,6 +74,17 @@ class OCIPushRule(Storm):
         """See `IOCIPushRule`."""
         IStore(OCIPushRule).remove(self)
 
+    def _getTags(self):
+        return self._tags
+
+    def _setTags(self, tags):
+        # convert to a set to remove duplicates
+        set_tags = set(tags)
+        # XXX 2020-12-09 tag format validation lives here
+        self._tags = sorted(list(set_tags))
+
+    tags = property(_getTags, _setTags)
+
 
 @implementer(IOCIPushRuleSet)
 class OCIPushRuleSet:
diff --git a/lib/lp/oci/tests/test_ocipushrule.py b/lib/lp/oci/tests/test_ocipushrule.py
index 4c6db56..a87d869 100644
--- a/lib/lp/oci/tests/test_ocipushrule.py
+++ b/lib/lp/oci/tests/test_ocipushrule.py
@@ -4,9 +4,15 @@
 """Tests for OCI registry push rules."""
 
 from __future__ import absolute_import, print_function, unicode_literals
+from lp.oci.model.ocipushrule import OCIPushRule
 
 from storm.store import Store
-from testtools.matchers import MatchesStructure
+from testtools.matchers import (
+    Equals,
+    MatchesListwise,
+    MatchesStructure,
+    )
+import transaction
 from zope.component import getUtility
 from zope.schema import ValidationError
 
@@ -71,6 +77,25 @@ class TestOCIPushRule(OCIConfigHelperMixin, TestCaseWithFactory):
         # Avoid trying to flush the incomplete object on cleanUp.
         Store.of(owner).rollback()
 
+    def test_tags_set_tags(self):
+        tags = ['one', 'two', 'three']
+        push_rule = self.factory.makeOCIPushRule()
+        push_rule.tags = tags
+        transaction.commit()
+        final_push_rule = Store.of(push_rule).find(
+            OCIPushRule, OCIPushRule.id == push_rule.id).one()
+        for tag in tags:
+            self.assertIn(tag, final_push_rule.tags)
+
+    def test_tags_removes_duplicates(self):
+        tags = ['one', 'another', 'another', 'two']
+        push_rule = self.factory.makeOCIPushRule()
+        push_rule.tags = tags
+        self.assertThat(
+            push_rule.tags,
+            MatchesListwise(
+                [Equals('another'), Equals('one'), Equals('two')]))
+
 
 class TestOCIPushRuleSet(OCIConfigHelperMixin, TestCaseWithFactory):