Merge ~andrey-fedoseev/launchpad:snap-base-features into launchpad:master

[Andrey Fedoseev]

Add `ISnapBase.features` field

The field is used to designate the features available for a snap base

[Colin Watson (cjwatson)]

review: Approve

diff --git a/lib/lp/snappy/interfaces/snapbase.py b/lib/lp/snappy/interfaces/snapbase.py
index 08cfd79..60ebeb5 100644
--- a/lib/lp/snappy/interfaces/snapbase.py
+++ b/lib/lp/snappy/interfaces/snapbase.py
@@ -8,10 +8,13 @@ __all__ = [
     "ISnapBase",
     "ISnapBaseSet",
     "NoSuchSnapBase",
+    "SnapBaseFeature",
 ]
 
+
 import http.client
 
+from lazr.enum import EnumeratedType, Item
 from lazr.restful.declarations import (
     REQUEST_USER,
     call_with,
@@ -33,7 +36,7 @@ from lazr.restful.fields import CollectionField, Reference
 from lazr.restful.interface import copy_field
 from zope.component import getUtility
 from zope.interface import Interface
-from zope.schema import Bool, Datetime, Dict, Int, List, TextLine
+from zope.schema import Bool, Choice, Datetime, Dict, Int, List, TextLine
 
 from lp import _
 from lp.app.errors import NameLookupFailed
@@ -74,6 +77,14 @@ class SnapBaseNameField(ContentNameField):
             return None
 
 
+class SnapBaseFeature(EnumeratedType):
+    ALLOW_DUPLICATE_BUILD_ON = Item(
+        "allow_duplicate_build_on",
+        description="Allow items with duplicate build-on attribute in the "
+        "list of architectures",
+    )
+
+
 class ISnapBaseView(Interface):
     """`ISnapBase` attributes that anyone can view."""
 
@@ -181,6 +192,21 @@ class ISnapBaseEditableAttributes(Interface):
         )
     )
 
+    features = exported(
+        Dict(
+            title=_("Features supported by this base"),
+            key_type=Choice(vocabulary=SnapBaseFeature),
+            value_type=Bool(),
+            required=False,
+            readonly=False,
+            description=_(
+                "A dictionary designating the features supported by the base. "
+                "Key is the name of a feature, value is a boolean indicating "
+                "whether the feature is supported or not."
+            ),
+        )
+    )
+
 
 class ISnapBaseEdit(Interface):
     """`ISnapBase` methods that require launchpad.Edit permission."""
@@ -263,7 +289,14 @@ class ISnapBaseSetEdit(Interface):
         )
     )
     @export_factory_operation(
-        ISnapBase, ["name", "display_name", "distro_series", "build_channels"]
+        ISnapBase,
+        [
+            "name",
+            "display_name",
+            "distro_series",
+            "build_channels",
+            "features",
+        ],
     )
     @operation_for_version("devel")
     def new(
@@ -272,6 +305,7 @@ class ISnapBaseSetEdit(Interface):
         display_name,
         distro_series,
         build_channels,
+        features,
         processors=None,
         date_created=None,
     ):
diff --git a/lib/lp/snappy/model/snapbase.py b/lib/lp/snappy/model/snapbase.py
index f87a3e6..b6e8b33 100644
--- a/lib/lp/snappy/model/snapbase.py
+++ b/lib/lp/snappy/model/snapbase.py
@@ -7,7 +7,11 @@ __all__ = [
     "SnapBase",
 ]
 
+from typing import Dict, Optional
+
 import pytz
+from lazr.enum import Item
+from storm.databases.postgres import JSON as PgJSON
 from storm.locals import (
     JSON,
     Bool,
@@ -33,6 +37,7 @@ from lp.snappy.interfaces.snapbase import (
     ISnapBase,
     ISnapBaseSet,
     NoSuchSnapBase,
+    SnapBaseFeature,
 )
 from lp.soyuz.interfaces.archive import (
     ArchiveDependencyError,
@@ -69,6 +74,8 @@ class SnapBase(Storm):
 
     is_default = Bool(name="is_default", allow_none=False)
 
+    _features = PgJSON(name="features", allow_none=False)
+
     def __init__(
         self,
         registrant,
@@ -76,6 +83,7 @@ class SnapBase(Storm):
         display_name,
         distro_series,
         build_channels,
+        features: Optional[Dict[Item, bool]],
         date_created=DEFAULT,
     ):
         super().__init__()
@@ -85,8 +93,27 @@ class SnapBase(Storm):
         self.distro_series = distro_series
         self.build_channels = build_channels
         self.date_created = date_created
+        self.features = features
         self.is_default = False
 
+    @property
+    def features(self) -> Dict[Item, bool]:
+        features = {}
+        for token, is_enabled in self._features.items():
+            try:
+                term = SnapBaseFeature.getTermByToken(token)
+            except LookupError:
+                continue
+            features[term.value] = is_enabled
+        return features
+
+    @features.setter
+    def features(self, value: Optional[Dict[Item, bool]]) -> None:
+        features = {}
+        for item, is_enabled in (value or {}).items():
+            features[item.title] = is_enabled
+        self._features = features
+
     def _getProcessors(self):
         return list(
             Store.of(self).find(
@@ -217,6 +244,7 @@ class SnapBaseSet:
         display_name,
         distro_series,
         build_channels,
+        features,
         processors=None,
         date_created=DEFAULT,
     ):
@@ -228,6 +256,7 @@ class SnapBaseSet:
             display_name,
             distro_series,
             build_channels,
+            features,
             date_created=date_created,
         )
         store.add(snap_base)
diff --git a/lib/lp/snappy/tests/test_snapbase.py b/lib/lp/snappy/tests/test_snapbase.py
index afd71c1..978e8b6 100644
--- a/lib/lp/snappy/tests/test_snapbase.py
+++ b/lib/lp/snappy/tests/test_snapbase.py
@@ -12,6 +12,7 @@ from testtools.matchers import (
     MatchesStructure,
 )
 from zope.component import getAdapter, getUtility
+from zope.security.proxy import removeSecurityProxy
 
 from lp.app.interfaces.security import IAuthorization
 from lp.registry.interfaces.pocket import PackagePublishingPocket
@@ -21,6 +22,7 @@ from lp.snappy.interfaces.snapbase import (
     ISnapBase,
     ISnapBaseSet,
     NoSuchSnapBase,
+    SnapBaseFeature,
 )
 from lp.soyuz.interfaces.component import IComponentSet
 from lp.testing import (
@@ -69,6 +71,28 @@ class TestSnapBase(TestCaseWithFactory):
         getUtility(ISnapBaseSet).setDefault(snap_base)
         self.assertRaises(CannotDeleteSnapBase, snap_base.destroySelf)
 
+    def test_features(self):
+        snap_base = self.factory.makeSnapBase(
+            features={SnapBaseFeature.ALLOW_DUPLICATE_BUILD_ON: True}
+        )
+
+        # feature are saved to the database by their title
+        self.assertEqual(
+            {
+                "allow_duplicate_build_on": True,
+            },
+            removeSecurityProxy(snap_base)._features,
+        )
+
+        # pretend that the database contains an invalid value
+        removeSecurityProxy(snap_base)._features["unknown_feature"] = True
+        self.assertEqual(
+            {
+                SnapBaseFeature.ALLOW_DUPLICATE_BUILD_ON: True,
+            },
+            snap_base.features,
+        )
+
 
 class TestSnapBaseProcessors(TestCaseWithFactory):
 
@@ -102,6 +126,7 @@ class TestSnapBaseProcessors(TestCaseWithFactory):
             display_name=self.factory.getUniqueUnicode(),
             distro_series=self.distroseries,
             build_channels={},
+            features={},
         )
         self.assertContentEqual(self.procs, snap_base.processors)
 
@@ -113,6 +138,7 @@ class TestSnapBaseProcessors(TestCaseWithFactory):
             display_name=self.factory.getUniqueUnicode(),
             distro_series=self.distroseries,
             build_channels={},
+            features={},
             processors=self.procs[:2],
         )
         self.assertContentEqual(self.procs[:2], snap_base.processors)
@@ -211,6 +237,7 @@ class TestSnapBaseWebservice(TestCaseWithFactory):
             display_name="Dummy",
             distro_series=distroseries_url,
             build_channels={"snapcraft": "stable"},
+            features={"allow_duplicate_build_on": True},
         )
         self.assertEqual(201, response.status)
         snap_base = webservice.get(response.getHeader("Location")).jsonBody()
@@ -228,6 +255,7 @@ class TestSnapBaseWebservice(TestCaseWithFactory):
                             webservice.getAbsoluteUrl(distroseries_url)
                         ),
                         "build_channels": Equals({"snapcraft": "stable"}),
+                        "features": Equals({"allow_duplicate_build_on": True}),
                         "is_default": Is(False),
                     }
                 ),
@@ -265,6 +293,32 @@ class TestSnapBaseWebservice(TestCaseWithFactory):
             b"name: dummy is already in use by another base.", response.body
         )
 
+    def test_new_invalid_features(self):
+        person = self.factory.makeRegistryExpert()
+        distroseries = self.factory.makeDistroSeries()
+        distroseries_url = api_url(distroseries)
+        webservice = webservice_for_person(
+            person, permission=OAuthPermission.WRITE_PUBLIC
+        )
+        webservice.default_api_version = "devel"
+        logout()
+        response = webservice.named_post(
+            "/+snap-bases",
+            "new",
+            name="dummy",
+            display_name="Dummy",
+            distro_series=distroseries_url,
+            build_channels={"snapcraft": "stable"},
+            features={
+                "allow_duplicate_build_on": True,
+                "invalid_feature": True,
+            },
+        )
+        self.assertEqual(400, response.status)
+        self.assertStartsWith(
+            response.body, b'features: Invalid value "invalid_feature".'
+        )
+
     def test_getByName(self):
         # lp.snap_bases.getByName returns a matching SnapBase.
         person = self.factory.makePerson()
diff --git a/lib/lp/testing/factory.py b/lib/lp/testing/factory.py
index e70aef7..7ecb210 100644
--- a/lib/lp/testing/factory.py
+++ b/lib/lp/testing/factory.py
@@ -6392,6 +6392,7 @@ class LaunchpadObjectFactory(ObjectFactory):
         display_name=None,
         distro_series=None,
         build_channels=None,
+        features=None,
         processors=None,
         date_created=DEFAULT,
     ):
@@ -6414,6 +6415,7 @@ class LaunchpadObjectFactory(ObjectFactory):
             display_name,
             distro_series,
             build_channels,
+            features=features,
             processors=processors,
             date_created=date_created,
         )