Merge ~twom/launchpad:oci-recipe-target into launchpad:master

[Tom Wardill]

Implement OCIProject

Add model, interfaces, ZCML and security.cfg

399e651... by Tom Wardill on 2019-10-07

Rename IOCIRecipeTargetSource to IOCIRecipeTargetSet

f84a3fc... by Tom Wardill on 2019-10-07

Add file headers from standard_template

8c59ca2... by Tom Wardill on 2019-10-08

Docstrings

[Colin Watson (cjwatson)]

review: Needs Fixing

03052cf... by Tom Wardill on 2019-10-09

Format imports

acef142... by Tom Wardill on 2019-10-09

person-merge-job needs UPDATE

a905e39... by Tom Wardill on 2019-10-10

More standard_template application

5895367... by Tom Wardill on 2019-10-10

Interface changes for removing product

50007ab... by Tom Wardill on 2019-10-10

Swap distribution for pillar

90bd54c... by Tom Wardill on 2019-10-10

Refactor for separate OCIRecipeTargetSet

327b7a7... by Tom Wardill on 2019-10-10

Move to getByDistributionAndName

350f719... by Tom Wardill on 2019-10-10

Implement IBugTarget

46d29ac... by Tom Wardill on 2019-10-10

Lint errors

a5f7ee9... by Tom Wardill on 2019-10-10

Split tests

d047e4a... by Tom Wardill on 2019-10-10

Lint

546542a... by Tom Wardill on 2019-10-11

Rename OCIRecipeName to OCIProjectName

5b2b9ee... by Tom Wardill on 2019-10-11

Rename OCIRecipeTarget to OCIProject

ece95d8... by Tom Wardill on 2019-10-14

Bug_supervisor doesn't exist anymore

a07881b... by Tom Wardill on 2019-10-16

Fix rebase problems

f232995... by Tom Wardill on 2019-10-16

Erroneous whitespace

292ca5c... by Tom Wardill on 2019-10-16

Rename more Recipe to Project

[Colin Watson (cjwatson)]

review: Needs Fixing

610e814... by Tom Wardill on 2019-10-16

Wording fixes and we don't need to implement IHasOwner

2aef9e5... by Tom Wardill on 2019-10-16

More wording fixes

8147347... by Tom Wardill on 2019-10-16

Test variable fixes

0154ec9... by Tom Wardill on 2019-10-16

Export pillar as read only

fcbd484... by Tom Wardill on 2019-10-16

Export pillar

[Colin Watson (cjwatson)]

review: Approve

diff --git a/database/schema/security.cfg b/database/schema/security.cfg
index 899ddde..0e0e91e 100644
--- a/database/schema/security.cfg
+++ b/database/schema/security.cfg
@@ -1241,6 +1241,7 @@ public.ociproject                       = SELECT, INSERT, UPDATE, DELETE
 public.ociprojectname                   = SELECT, INSERT, UPDATE
 public.ociprojectseries                 = SELECT, INSERT, UPDATE, DELETE
 public.openididentifier                 = SELECT
+public.ociproject                       = SELECT, INSERT, UPDATE, DELETE
 public.ociprojectname                   = SELECT, INSERT, UPDATE
 public.packageupload                    = SELECT, INSERT, UPDATE
 public.packageuploadbuild               = SELECT, INSERT, UPDATE
@@ -1417,6 +1418,7 @@ public.message                          = SELECT, INSERT
 public.messagechunk                     = SELECT, INSERT
 public.milestone                        = SELECT
 public.milestonetag                     = SELECT
+public.ociproject                       = SELECT
 public.ociprojectname                   = SELECT
 public.openididentifier                 = SELECT
 public.packagecopyjob                   = SELECT, INSERT
@@ -1534,6 +1536,7 @@ public.message                          = SELECT, INSERT
 public.messagechunk                     = SELECT, INSERT
 public.milestone                        = SELECT
 public.milestonetag                     = SELECT
+public.ociproject                       = SELECT
 public.ociprojectname                   = SELECT
 public.openididentifier                 = SELECT
 public.packagecopyjob                   = SELECT, INSERT, UPDATE
@@ -1637,6 +1640,7 @@ public.message                          = SELECT, INSERT
 public.messagechunk                     = SELECT, INSERT
 public.milestone                        = SELECT
 public.milestonetag                     = SELECT
+public.ociproject                       = SELECT
 public.ociprojectname                   = SELECT
 public.person                           = SELECT
 public.personlanguage                   = SELECT
@@ -1839,6 +1843,7 @@ public.message                          = SELECT, INSERT
 public.messagechunk                     = SELECT, INSERT
 public.milestone                        = SELECT
 public.milestonetag                     = SELECT, INSERT, DELETE
+public.ociproject                       = SELECT
 public.ociprojectname                   = SELECT
 public.openididentifier                 = SELECT
 public.packageset                       = SELECT
@@ -1959,6 +1964,7 @@ public.libraryfilealias                 = SELECT, INSERT
 public.libraryfilecontent               = SELECT, INSERT
 public.message                          = SELECT, INSERT
 public.messagechunk                     = SELECT, INSERT
+public.ociproject                       = SELECT
 public.ociprojectname                   = SELECT
 public.openididentifier                 = SELECT
 public.person                           = SELECT
@@ -2017,6 +2023,7 @@ public.libraryfilecontent               = SELECT, INSERT
 public.message                          = SELECT, INSERT
 public.messagechunk                     = SELECT, INSERT
 public.milestone                        = SELECT
+public.ociproject                       = SELECT
 public.ociprojectname                   = SELECT
 public.person                           = SELECT
 public.personsettings                   = SELECT
@@ -2154,6 +2161,7 @@ public.job                              = SELECT, INSERT, UPDATE
 public.message                          = SELECT, INSERT
 public.messagechunk                     = SELECT, INSERT
 public.milestonetag                     = SELECT
+public.ociproject                       = SELECT
 public.ociprojectname                   = SELECT
 public.person                           = SELECT, INSERT
 public.personsettings                   = SELECT, INSERT
@@ -2544,6 +2552,7 @@ public.distroseries                     = SELECT
 public.emailaddress                     = SELECT
 public.gitrepository                    = SELECT
 public.job                              = SELECT, INSERT, UPDATE
+public.ociproject                       = SELECT
 public.ociprojectname                   = SELECT
 public.person                           = SELECT
 public.packaging                        = SELECT
@@ -2567,6 +2576,7 @@ public.bugtask                          = SELECT
 public.bugtaskflat                      = SELECT
 public.distribution                     = SELECT
 public.distroseries                     = SELECT
+public.ociproject                       = SELECT
 public.ociprojectname                   = SELECT
 public.product                          = SELECT
 public.productseries                    = SELECT
@@ -2579,6 +2589,7 @@ public.branch                           = SELECT
 public.distribution                     = SELECT
 public.gitrepository                    = SELECT
 public.job                              = SELECT, UPDATE
+public.ociproject                       = SELECT
 public.ociprojectname                   = SELECT
 public.person                           = SELECT
 public.product                          = SELECT
diff --git a/lib/lp/registry/configure.zcml b/lib/lp/registry/configure.zcml
index 730efbb..66f1d14 100644
--- a/lib/lp/registry/configure.zcml
+++ b/lib/lp/registry/configure.zcml
@@ -734,6 +734,30 @@
             interface="lp.registry.interfaces.ociprojectname.IOCIProjectNameSet"/>
     </class>
 
+    <!-- OCIProject -->
+    <class
+        class="lp.registry.model.ociproject.OCIProject">
+        <require
+            permission="launchpad.View"
+            interface="lp.registry.interfaces.ociproject.IOCIProjectView
+                       lp.registry.interfaces.ociproject.IOCIProjectEditableAttributes"/>
+        <require
+            permission="launchpad.Edit"
+            set_schema="lp.registry.interfaces.ociproject.IOCIProjectEditableAttributes" />
+    </class>
+    <securedutility
+        class="lp.registry.model.ociproject.OCIProject"
+        provides="lp.registry.interfaces.ociproject.IOCIProject">
+        <allow
+            interface="lp.registry.interfaces.ociproject.IOCIProject"/>
+    </securedutility>
+    <securedutility
+        class="lp.registry.model.ociproject.OCIProjectSet"
+        provides="lp.registry.interfaces.ociproject.IOCIProjectSet">
+        <allow
+            interface="lp.registry.interfaces.ociproject.IOCIProjectSet"/>
+    </securedutility>
+
     <!-- SourcePackageName -->
 
     <class
diff --git a/lib/lp/registry/interfaces/ociproject.py b/lib/lp/registry/interfaces/ociproject.py
new file mode 100644
index 0000000..64bb50c
--- /dev/null
+++ b/lib/lp/registry/interfaces/ociproject.py
@@ -0,0 +1,90 @@
+# Copyright 2019 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""OCI Project interfaces."""
+
+from __future__ import absolute_import, print_function, unicode_literals
+
+__metaclass__ = type
+__all__ = [
+    'IOCIProject',
+    'IOCIProjectSet',
+    ]
+
+from lazr.restful.declarations import (
+    export_as_webservice_entry,
+    exported,
+    )
+from lazr.restful.fields import Reference
+from zope.interface import (
+    Attribute,
+    Interface,
+    )
+from zope.schema import (
+    Datetime,
+    Int,
+    Text,
+    )
+
+from lp import _
+from lp.bugs.interfaces.bugtarget import IBugTarget
+from lp.registry.interfaces.distribution import IDistribution
+from lp.registry.interfaces.ociprojectname import IOCIProjectName
+from lp.registry.interfaces.role import IHasOwner
+from lp.services.fields import PublicPersonChoice
+
+
+class IOCIProjectView(Interface):
+    """IOCIProject attributes that require launchpad.View permission."""
+
+    id = Int(title=_("ID"), required=True, readonly=True)
+    date_created = exported(
+        Datetime(title=_("Date created"), required=True), readonly=True)
+    date_last_modified = exported(
+        Datetime(title=_("Date last modified"), required=True), readonly=True)
+
+    registrant = exported(PublicPersonChoice(
+        title=_("Registrant"),
+        description=_("The person that registered this project."),
+        vocabulary='ValidPersonOrTeam', required=True, readonly=True))
+
+
+class IOCIProjectEditableAttributes(IBugTarget):
+    """IOCIProject attributes that can be edited.
+
+    These attributes need launchpad.View to see, and launchpad.Edit to change.
+    """
+
+    distribution = Reference(
+        IDistribution,
+        title=_("The distribution that this OCI project is associated with."))
+    ociprojectname = exported(Reference(
+        IOCIProjectName,
+        title=_("The name of this OCI project."),
+        required=True,
+        readonly=True))
+    description = exported(
+        Text(title=_("The description for this OCI project.")))
+    pillar = exported(Reference(
+        IDistribution,
+        title=_("The pillar containing this target."), readonly=True))
+
+
+class IOCIProject(IOCIProjectView,
+                       IOCIProjectEditableAttributes):
+    """A project containing Open Container Initiative recipes."""
+
+    export_as_webservice_entry()
+
+
+class IOCIProjectSet(Interface):
+    """A utility to create and access OCI Projects."""
+
+    def new(registrant, pillar, ociprojectname,
+            date_created=None, description=None,
+            bug_reporting_guidelines=None, bug_reported_acknowledgement=None,
+            bugfiling_duplicate_search=False):
+        """Create an `IOCIProject`."""
+
+    def getByDistributionAndName(distribution, name):
+        """Get the OCIProjects for a given distribution."""
diff --git a/lib/lp/registry/model/ociproject.py b/lib/lp/registry/model/ociproject.py
new file mode 100644
index 0000000..45de84d
--- /dev/null
+++ b/lib/lp/registry/model/ociproject.py
@@ -0,0 +1,123 @@
+# Copyright 2019 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""OCI Project implementation."""
+
+from __future__ import absolute_import, print_function, unicode_literals
+
+__metaclass__ = type
+__all__ = [
+    'OCIProject',
+    'OCIProjectSet',
+    ]
+
+import pytz
+from storm.locals import (
+    Bool,
+    DateTime,
+    Int,
+    Reference,
+    Unicode,
+    )
+from zope.interface import implementer
+
+from lp.bugs.model.bugtarget import BugTargetBase
+from lp.registry.interfaces.distribution import IDistribution
+from lp.registry.interfaces.ociproject import (
+    IOCIProject,
+    IOCIProjectSet,
+    )
+from lp.registry.model.ociprojectname import OCIProjectName
+from lp.services.database.constants import DEFAULT
+from lp.services.database.interfaces import (
+    IMasterStore,
+    IStore,
+    )
+from lp.services.database.stormbase import StormBase
+
+
+@implementer(IOCIProject)
+class OCIProject(BugTargetBase, StormBase):
+    """See `IOCIProject` and `IOCIProjectSet`."""
+
+    __storm_table__ = "OCIProject"
+
+    id = Int(primary=True)
+    date_created = DateTime(
+        name="date_created", tzinfo=pytz.UTC, allow_none=False)
+    date_last_modified = DateTime(
+        name="date_last_modified", tzinfo=pytz.UTC, allow_none=False)
+
+    registrant_id = Int(name='registrant', allow_none=False)
+    registrant = Reference(registrant_id, "Person.id")
+
+    distribution_id = Int(name="distribution", allow_none=True)
+    distribution = Reference(distribution_id, "Distribution.id")
+
+    ociprojectname_id = Int(name="ociprojectname", allow_none=False)
+    ociprojectname = Reference(ociprojectname_id, "OCIProjectName.id")
+
+    description = Unicode(name="description")
+
+    bug_reporting_guidelines = Unicode(name="bug_reporting_guidelines")
+    bug_reported_acknowledgement = Unicode(name="bug_reported_acknowledgement")
+    enable_bugfiling_duplicate_search = Bool(
+        name="enable_bugfiling_duplicate_search")
+
+    @property
+    def pillar(self):
+        """See `IBugTarget`."""
+        return self.distribution
+
+    @property
+    def bugtargetname(self):
+        """See `IBugTarget`."""
+        return "OCI project %s for %s" % (
+            self.ociprojectname.name, self.pillar.name)
+
+    @property
+    def bugtargetdisplayname(self):
+        """See `IBugTarget`."""
+        return "OCI project %s for %s" % (
+            self.ociprojectname.name, self.pillar.name)
+
+
+@implementer(IOCIProjectSet)
+class OCIProjectSet:
+
+    def new(self, registrant, pillar, ociprojectname,
+            date_created=DEFAULT, description=None,
+            bug_reporting_guidelines=None,
+            bug_reported_acknowledgement=None,
+            bugfiling_duplicate_search=False):
+        """See `IOCIProjectSet`."""
+        store = IMasterStore(OCIProject)
+        target = OCIProject()
+        target.date_created = date_created
+        target.date_last_modified = date_created
+
+        # XXX twom 2019-10-10 This needs to have IProduct support
+        # when the model supports it
+        if IDistribution.providedBy(pillar):
+            target.distribution = pillar
+        else:
+            raise ValueError(
+                'The target of an OCIProject must be an '
+                'IDistribution instance.')
+
+        target.registrant = registrant
+        target.ociprojectname = ociprojectname
+        target.description = description
+        target.bug_reporting_guidelines = bug_reporting_guidelines
+        target.enable_bugfiling_duplicate_search = bugfiling_duplicate_search
+        store.add(target)
+        return target
+
+    def getByDistributionAndName(self, distribution, name):
+        """See `IOCIProjectSet`."""
+        target = IStore(OCIProject).find(
+            OCIProject,
+            OCIProject.distribution == distribution,
+            OCIProject.ociprojectname == OCIProjectName.id,
+            OCIProjectName.name == name).one()
+        return target
diff --git a/lib/lp/registry/tests/test_ociproject.py b/lib/lp/registry/tests/test_ociproject.py
new file mode 100644
index 0000000..a68f786
--- /dev/null
+++ b/lib/lp/registry/tests/test_ociproject.py
@@ -0,0 +1,71 @@
+# Copyright 2019 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Tests for `OCIProject` and `OCIProjectSet`."""
+
+from __future__ import absolute_import, print_function, unicode_literals
+
+__metaclass__ = type
+
+from zope.component import getUtility
+
+from lp.registry.interfaces.ociproject import (
+    IOCIProject,
+    IOCIProjectSet,
+    )
+from lp.testing import (
+    admin_logged_in,
+    person_logged_in,
+    TestCaseWithFactory,
+    )
+from lp.testing.layers import DatabaseFunctionalLayer
+
+
+class TestOCIProject(TestCaseWithFactory):
+
+    layer = DatabaseFunctionalLayer
+
+    def test_implements_interface(self):
+        oci_project = self.factory.makeOCIProject()
+        with admin_logged_in():
+            self.assertProvides(oci_project, IOCIProject)
+
+
+class TestOCIProjectSet(TestCaseWithFactory):
+
+    layer = DatabaseFunctionalLayer
+
+    def test_implements_interface(self):
+        target_set = getUtility(IOCIProjectSet)
+        with admin_logged_in():
+            self.assertProvides(target_set, IOCIProjectSet)
+
+    def test_new_oci_project(self):
+        registrant = self.factory.makePerson()
+        distribution = self.factory.makeDistribution(owner=registrant)
+        oci_project_name = self.factory.makeOCIProjectName()
+        target = getUtility(IOCIProjectSet).new(
+            registrant,
+            distribution,
+            oci_project_name)
+        with person_logged_in(registrant):
+            self.assertEqual(target.registrant, registrant)
+            self.assertEqual(target.distribution, distribution)
+            self.assertEqual(target.pillar, distribution)
+            self.assertEqual(target.ociprojectname, oci_project_name)
+
+    def test_getByDistributionAndName(self):
+        registrant = self.factory.makePerson()
+        distribution = self.factory.makeDistribution(owner=registrant)
+        oci_project = self.factory.makeOCIProject(
+            registrant=registrant, pillar=distribution)
+
+        # Make sure there's more than one to get the result from
+        self.factory.makeOCIProject(
+            pillar=self.factory.makeDistribution())
+
+        with person_logged_in(registrant):
+            fetched_result = getUtility(
+                IOCIProjectSet).getByDistributionAndName(
+                    distribution, oci_project.ociprojectname.name)
+            self.assertEqual(oci_project, fetched_result)
diff --git a/lib/lp/testing/factory.py b/lib/lp/testing/factory.py
index ed2536b..5c0cc18 100644
--- a/lib/lp/testing/factory.py
+++ b/lib/lp/testing/factory.py
@@ -200,6 +200,7 @@ from lp.registry.interfaces.mailinglist import (
 from lp.registry.interfaces.mailinglistsubscription import (
     MailingListAutoSubscribePolicy,
     )
+from lp.registry.interfaces.ociproject import IOCIProjectSet
 from lp.registry.interfaces.ociprojectname import IOCIProjectNameSet
 from lp.registry.interfaces.packaging import (
     IPackagingUtil,
@@ -4902,6 +4903,25 @@ class BareLaunchpadObjectFactory(ObjectFactory):
             name = self.getUniqueString(u"oci-project-name")
         return getUtility(IOCIProjectNameSet).new(name)
 
+    def makeOCIProject(self, registrant=None, pillar=None,
+                            ociprojectname=None, date_created=DEFAULT,
+                            description=None, bug_reporting_guidelines=None,
+                            bug_reported_acknowledgement=None,
+                            bugfiling_duplicate_search=False):
+        """Make a new OCIProject."""
+        if registrant is None:
+            registrant = self.makePerson()
+        if pillar is None:
+            pillar = self.makeDistribution()
+        if ociprojectname is None or isinstance(ociprojectname, six.text_type):
+            ociprojectname = self.makeOCIProjectName(ociprojectname)
+        return getUtility(IOCIProjectSet).new(
+            registrant, pillar, ociprojectname, date_created=date_created,
+            description=description,
+            bug_reporting_guidelines=bug_reporting_guidelines,
+            bug_reported_acknowledgement=bug_reported_acknowledgement,
+            bugfiling_duplicate_search=bugfiling_duplicate_search)
+
 
 # Some factory methods return simple Python types. We don't add
 # security wrappers for them, as well as for objects created by