Merge lp:~jelmer/launchpad/613468-xb-ppa-db into lp:launchpad/db-devel

[Jelmer Vernooij]

Add SourcePackageRelease.user_defined_fields, BinaryPackageRelease.user_defined_fields.

This adds a database field for user_defined_fields to SourcePackageRelease and BinaryPackageRelease. This is required for bug 613468 so that we can put these user defined fields in the Packages and Sources files generated by the publisher.

Pre-implementation call: with bigjools

Tests:
./bin/test lp.soyuz.tests.test_binarypackagerelease lp.soyuz.tests.test_sourcepackagerelease

[Stuart Bishop (stub)]

Fine, but needs comments on the new columns in comments.sql

patch-2207-82-0.sql

review: Approve (db)

[Michael Nelson (michael.nelson)]

Hi Jelmer! Nice clean branch :)

> === modified file 'lib/lp/soyuz/interfaces/binarypackagebuild.py'
> --- lib/lp/soyuz/interfaces/binarypackagebuild.py 2010-08-10 21:54:41 +0000
> +++ lib/lp/soyuz/interfaces/binarypackagebuild.py 2010-08-12 10:37:50 +0000
> @@ -125,10 +125,11 @@
>
> def createBinaryPackageRelease(
> binarypackagename, version, summary, description, binpackageformat,
> - component, section, priority, shlibdeps, depends, recommends,
> - suggests, conflicts, replaces, provides, pre_depends, enhances,
> - breaks, essential, installedsize, architecturespecific,
> - debug_package):
> + component, section, priority, installedsize, architecturespecific,
> + shlibdeps=None, depends=None, recommends=None, suggests=None,
> + conflicts=None, replaces=None, provides=None, pre_depends=None,
> + enhances=None, breaks=None, essential=False, debug_package=None,
> + user_defined_fields=None):

I'm assuming you've checked that all call-sites use kwargs before re-ordering... and my next question was going to be are you sure that all those kwargs are really optional, but your test_provides() ensures that too :)

> """Create and return a `BinaryPackageRelease`.
>
> The binarypackagerelease will be attached to this specific build.

>
> === modified file 'lib/lp/soyuz/interfaces/binarypackagerelease.py'
> --- lib/lp/soyuz/interfaces/binarypackagerelease.py 2010-07-10 04:52:43 +0000
> +++ lib/lp/soyuz/interfaces/binarypackagerelease.py 2010-08-12 10:37:50 +0000
> @@ -56,6 +56,8 @@
> title=_("Debug package"), schema=Interface, required=False,
> description=_("The corresponding package containing debug symbols "
> "for this binary."))
> + user_defined_fields = Attribute(
> + "Sequence of user-defined fields as key-value pairs.")

you could use zope.schema.List instead of attribute:

    user_defined_fields = List(
        title=_("Sequence of user-defined fields as key-value pairs."))

if that's what it is.

>
> files = Attribute("Related list of IBinaryPackageFile entries")
>
>
> === modified file 'lib/lp/soyuz/interfaces/sourcepackagerelease.py'
> --- lib/lp/soyuz/interfaces/sourcepackagerelease.py 2010-07-29 22:55:15 +0000
> +++ lib/lp/soyuz/interfaces/sourcepackagerelease.py 2010-08-12 10:37:50 +0000
> @@ -96,8 +96,8 @@
> "was first uploaded in Launchpad")
> publishings = Attribute("MultipleJoin on SourcepackagePublishing")
>
> -
> -
> + user_defined_fields = Attribute(
> + "Sequence of user-defined fields as key-value pairs.")

Same here.

> # read-only properties
> name = Attribute('The sourcepackagename for this release, as text')
> title = Attribute('The title of this sourcepackagerelease')
>
> === modified file 'lib/lp/soyuz/model/binarypackagerelease.py'
> --- lib/lp/soyuz/model/binarypackagerelease.py 2010-07-10 04:46:49 +0000
> +++ lib/lp/soyuz/model/binarypackagerelease.py 2010-08-12 10:37:50 +0000
> @@ -13,6...

review: Approve (code)

=== modified file 'database/schema/comments.sql'
--- database/schema/comments.sql	2010-08-10 05:50:08 +0000
+++ database/schema/comments.sql	2010-08-12 19:10:59 +0000
@@ -1338,6 +1338,7 @@
 COMMENT ON COLUMN SourcePackageRelease.build_conflicts IS 'The list of packages that will conflict with this source while building, as mentioned in the control file "Build-Conflicts:" field.';
 COMMENT ON COLUMN SourcePackageRelease.build_conflicts_indep IS 'The list of packages that will conflict with this source while building in architecture independent environment, as mentioned in the control file "Build-Conflicts-Indep:" field.';
 COMMENT ON COLUMN SourcePackageRelease.changelog IS 'The LibraryFileAlias ID of changelog associated with this sourcepackage.  Often in the case of debian packages and will be found after the installation in /usr/share/doc/<binarypackagename>/changelog.Debian.gz';
+COMMENT ON COLUMN SourcePackageRelease.user_defined_fields IS 'A JSON struct containing a sequence of key-value pairs with user defined fields in the control file.';
 
 -- SourcePackageName
 
@@ -1478,6 +1479,7 @@
 COMMENT ON COLUMN BinaryPackageRelease.enhances IS 'The list of packages pointed as "enhanced" after the installation of this package, as it is in control file "Enhances:" field.';
 COMMENT ON COLUMN BinaryPackageRelease.breaks IS 'The list of packages which will be broken by the installtion of this package, as it is in the control file "Breaks:" field.';
 COMMENT ON COLUMN BinaryPackageRelease.debug_package IS 'The corresponding binary package release containing debug symbols for this binary, if any.';
+COMMENT ON COLUMN BinaryPackageRelease.user_defined_fields IS 'A JSON struct containing a sequence of key-value pairs with user defined fields in the control file.';
 
 
 -- BinaryPackageFile

=== added file 'database/schema/patch-2207-82-0.sql'
--- database/schema/patch-2207-82-0.sql	1970-01-01 00:00:00 +0000
+++ database/schema/patch-2207-82-0.sql	2010-08-12 19:10:59 +0000
@@ -0,0 +1,11 @@
+-- Copyright 2010 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 BinaryPackageRelease
+    ADD COLUMN user_defined_fields TEXT;
+
+ALTER TABLE SourcePackageRelease
+    ADD COLUMN user_defined_fields TEXT;
+
+INSERT INTO LaunchpadDatabaseRevision VALUES (2207, 82, 0);

=== modified file 'lib/lp/registry/interfaces/distroseries.py'
--- lib/lp/registry/interfaces/distroseries.py	2010-08-05 00:25:36 +0000
+++ lib/lp/registry/interfaces/distroseries.py	2010-08-12 19:10:59 +0000
@@ -572,7 +572,7 @@
         dsc_maintainer_rfc822, dsc_standards_version, dsc_format,
         dsc_binaries, archive, copyright, build_conflicts,
         build_conflicts_indep, dateuploaded=None,
-        source_package_recipe_build=None):
+        source_package_recipe_build=None, user_defined_fields=None):
         """Create an uploads `SourcePackageRelease`.
 
         Set this distroseries set to be the uploadeddistroseries.
@@ -608,6 +608,8 @@
          :param archive: IArchive to where the upload was targeted
          :param dateuploaded: optional datetime, if omitted assumed nowUTC
          :param source_package_recipe_build: optional SourcePackageRecipeBuild
+         :param user_defined_fields: optional sequence of key-value pairs with
+                                     user defined fields.
          :return: the just creates `SourcePackageRelease`
         """
 

=== modified file 'lib/lp/registry/model/distroseries.py'
--- lib/lp/registry/model/distroseries.py	2010-08-10 21:54:41 +0000
+++ lib/lp/registry/model/distroseries.py	2010-08-12 19:10:59 +0000
@@ -1128,7 +1128,7 @@
         dsc_maintainer_rfc822, dsc_standards_version, dsc_format,
         dsc_binaries, archive, copyright, build_conflicts,
         build_conflicts_indep, dateuploaded=DEFAULT,
-        source_package_recipe_build=None):
+        source_package_recipe_build=None, user_defined_fields=None):
         """See `IDistroSeries`."""
         return SourcePackageRelease(
             upload_distroseries=self, sourcepackagename=sourcepackagename,
@@ -1144,7 +1144,8 @@
             dsc_format=dsc_format, dsc_binaries=dsc_binaries,
             build_conflicts=build_conflicts,
             build_conflicts_indep=build_conflicts_indep,
-            source_package_recipe_build=source_package_recipe_build)
+            source_package_recipe_build=source_package_recipe_build,
+            user_defined_fields=user_defined_fields)
 
     def getComponentByName(self, name):
         """See `IDistroSeries`."""

=== modified file 'lib/lp/soyuz/doc/binarypackagebuild.txt'
--- lib/lp/soyuz/doc/binarypackagebuild.txt	2010-08-10 21:54:41 +0000
+++ lib/lp/soyuz/doc/binarypackagebuild.txt	2010-08-12 19:10:59 +0000
@@ -310,20 +310,8 @@
     >>> section = firefox_build.source_package_release.section.id
     >>> from canonical.launchpad.interfaces import PackagePublishingPriority
     >>> priority = PackagePublishingPriority.STANDARD
-    >>> shlibdeps = None
-    >>> depends = None
-    >>> recommends = None
-    >>> suggests = None
-    >>> conflicts = None
-    >>> replaces = None
-    >>> provides = None
-    >>> essential = False
     >>> installedsize = 0
     >>> architecturespecific = False
-    >>> pre_depends = None
-    >>> enhances = None
-    >>> breaks = None
-    >>> debug_package = None
 
 Invoke createBinaryPackageRelease with all required arguments.
 
@@ -331,11 +319,11 @@
     >>> pmount_build = getUtility(IBinaryPackageBuildSet).getByBuildID(19)
 
     >>> bin = pmount_build.createBinaryPackageRelease(
-    ...     binarypackagename, version, summary, description,
-    ...     binpackageformat, component, section, priority, shlibdeps,
-    ...     depends, recommends, suggests, conflicts, replaces, provides,
-    ...     pre_depends, enhances, breaks, essential, installedsize,
-    ...     architecturespecific, debug_package)
+    ...     binarypackagename=binarypackagename, version=version,
+    ...     summary=summary, description=description,
+    ...     binpackageformat=binpackageformat, component=component,
+    ...     section=section, priority=priority, installedsize=installedsize,
+    ...     architecturespecific=architecturespecific)
 
     >>> from canonical.launchpad.interfaces import IBinaryPackageRelease
     >>> from canonical.launchpad.webapp.testing import verifyObject
@@ -364,11 +352,12 @@
     ...     version = "%d" % i
     ...     binarypackagename = bpnameset.ensure("test-%d" % i).id
     ...     b = pmount_build.createBinaryPackageRelease(
-    ...         binarypackagename, version, summary, description,
-    ...         binpackageformat, component, section, priority, shlibdeps,
-    ...         depends, recommends, suggests, conflicts, replaces, provides,
-    ...         pre_depends, enhances, breaks, essential, installedsize,
-    ...         architecturespecific, debug_package)
+    ...         binarypackagename=binarypackagename, version=version,
+    ...         summary=summary, description=description,
+    ...         binpackageformat=binpackageformat, component=component,
+    ...         section=section, priority=priority,
+    ...         installedsize=installedsize,
+    ...         architecturespecific=architecturespecific)
 
 
 Check if the property is still working:

=== modified file 'lib/lp/soyuz/interfaces/binarypackagebuild.py'
--- lib/lp/soyuz/interfaces/binarypackagebuild.py	2010-08-10 21:54:41 +0000
+++ lib/lp/soyuz/interfaces/binarypackagebuild.py	2010-08-12 19:10:59 +0000
@@ -125,10 +125,11 @@
 
     def createBinaryPackageRelease(
         binarypackagename, version, summary, description, binpackageformat,
-        component, section, priority, shlibdeps, depends, recommends,
-        suggests, conflicts, replaces, provides, pre_depends, enhances,
-        breaks, essential, installedsize, architecturespecific,
-        debug_package):
+        component, section, priority, installedsize, architecturespecific,
+        shlibdeps=None, depends=None, recommends=None, suggests=None,
+        conflicts=None, replaces=None, provides=None, pre_depends=None,
+        enhances=None, breaks=None, essential=False, debug_package=None,
+        user_defined_fields=None):
         """Create and return a `BinaryPackageRelease`.
 
         The binarypackagerelease will be attached to this specific build.

=== modified file 'lib/lp/soyuz/interfaces/binarypackagerelease.py'
--- lib/lp/soyuz/interfaces/binarypackagerelease.py	2010-07-10 04:52:43 +0000
+++ lib/lp/soyuz/interfaces/binarypackagerelease.py	2010-08-12 19:10:59 +0000
@@ -18,7 +18,7 @@
 from lazr.enum import DBEnumeratedType, DBItem
 from lazr.restful.declarations import exported, export_as_webservice_entry
 from lazr.restful.fields import Reference, ReferenceChoice
-from zope.schema import Bool, Date, Datetime, Int, Object, Text, TextLine
+from zope.schema import Bool, Date, Datetime, Int, List, Object, Text, TextLine
 from zope.interface import Interface, Attribute
 
 from canonical.launchpad import _
@@ -56,6 +56,8 @@
         title=_("Debug package"), schema=Interface, required=False,
         description=_("The corresponding package containing debug symbols "
                       "for this binary."))
+    user_defined_fields = List(
+        title=_("Sequence of user-defined fields as key-value pairs."))
 
     files = Attribute("Related list of IBinaryPackageFile entries")
 

=== modified file 'lib/lp/soyuz/interfaces/sourcepackagerelease.py'
--- lib/lp/soyuz/interfaces/sourcepackagerelease.py	2010-07-29 22:55:15 +0000
+++ lib/lp/soyuz/interfaces/sourcepackagerelease.py	2010-08-12 19:10:59 +0000
@@ -14,7 +14,7 @@
 
 
 from lazr.restful.fields import Reference
-from zope.schema import TextLine
+from zope.schema import List, TextLine
 from zope.interface import Interface, Attribute
 
 from canonical.launchpad import _
@@ -96,8 +96,8 @@
         "was first uploaded in Launchpad")
     publishings = Attribute("MultipleJoin on SourcepackagePublishing")
 
-
-
+    user_defined_fields = List(
+        title=_("Sequence of user-defined fields as key-value pairs."))
     # read-only properties
     name = Attribute('The sourcepackagename for this release, as text')
     title = Attribute('The title of this sourcepackagerelease')

=== modified file 'lib/lp/soyuz/model/binarypackagebuild.py'
--- lib/lp/soyuz/model/binarypackagebuild.py	2010-08-10 21:54:41 +0000
+++ lib/lp/soyuz/model/binarypackagebuild.py	2010-08-12 19:10:59 +0000
@@ -448,10 +448,11 @@
 
     def createBinaryPackageRelease(
         self, binarypackagename, version, summary, description,
-        binpackageformat, component,section, priority, shlibdeps,
-        depends, recommends, suggests, conflicts, replaces, provides,
-        pre_depends, enhances, breaks, essential, installedsize,
-        architecturespecific, debug_package):
+        binpackageformat, component, section, priority, installedsize,
+        architecturespecific, shlibdeps=None, depends=None, recommends=None,
+        suggests=None, conflicts=None, replaces=None, provides=None,
+        pre_depends=None, enhances=None, breaks=None, essential=False,
+        debug_package=None, user_defined_fields=None):
         """See IBuild."""
         return BinaryPackageRelease(
             build=self, binarypackagename=binarypackagename, version=version,
@@ -463,7 +464,8 @@
             provides=provides, pre_depends=pre_depends, enhances=enhances,
             breaks=breaks, essential=essential, installedsize=installedsize,
             architecturespecific=architecturespecific,
-            debug_package=debug_package)
+            debug_package=debug_package,
+            user_defined_fields=user_defined_fields)
 
     def estimateDuration(self):
         """See `IBuildBase`."""

=== modified file 'lib/lp/soyuz/model/binarypackagerelease.py'
--- lib/lp/soyuz/model/binarypackagerelease.py	2010-07-10 04:46:49 +0000
+++ lib/lp/soyuz/model/binarypackagerelease.py	2010-08-12 19:10:59 +0000
@@ -13,6 +13,8 @@
 
 from zope.interface import implements
 
+import simplejson
+
 from sqlobject import StringCol, ForeignKey, IntCol, SQLMultipleJoin, BoolCol
 from storm.locals import Date, Int, Reference, Storm
 
@@ -68,6 +70,22 @@
     files = SQLMultipleJoin('BinaryPackageFile',
         joinColumn='binarypackagerelease', orderBy="libraryfile")
 
+    _user_defined_fields = StringCol(dbName='user_defined_fields')
+
+    def __init__(self, *args, **kwargs):
+        if 'user_defined_fields' in kwargs:
+            kwargs['_user_defined_fields'] = simplejson.dumps(
+                kwargs['user_defined_fields'])
+            del kwargs['user_defined_fields']
+        super(BinaryPackageRelease, self).__init__(*args, **kwargs)
+
+    @property
+    def user_defined_fields(self):
+        """See `IBinaryPackageRelease`."""
+        if self._user_defined_fields is None:
+            return []
+        return simplejson.loads(self._user_defined_fields)
+
     @property
     def title(self):
         """See `IBinaryPackageRelease`."""

=== modified file 'lib/lp/soyuz/model/sourcepackagerelease.py'
--- lib/lp/soyuz/model/sourcepackagerelease.py	2010-08-02 02:13:52 +0000
+++ lib/lp/soyuz/model/sourcepackagerelease.py	2010-08-12 19:10:59 +0000
@@ -15,6 +15,7 @@
 import pytz
 from StringIO import StringIO
 import re
+import simplejson
 
 from sqlobject import StringCol, ForeignKey, SQLMultipleJoin
 from storm.expr import Join
@@ -147,6 +148,22 @@
     package_diffs = SQLMultipleJoin(
         'PackageDiff', joinColumn='to_source', orderBy="-date_requested")
 
+    _user_defined_fields = StringCol(dbName='user_defined_fields')
+
+    def __init__(self, *args, **kwargs):
+        if 'user_defined_fields' in kwargs:
+            kwargs['_user_defined_fields'] = simplejson.dumps(
+                kwargs['user_defined_fields'])
+            del kwargs['user_defined_fields']
+        super(SourcePackageRelease, self).__init__(*args, **kwargs)
+
+    @property
+    def user_defined_fields(self):
+        """See `IBinaryPackageRelease`."""
+        if self._user_defined_fields is None:
+            return []
+        return simplejson.loads(self._user_defined_fields)
+
     @property
     def builds(self):
         """See `ISourcePackageRelease`."""

=== added file 'lib/lp/soyuz/tests/test_binarypackagerelease.py'
--- lib/lp/soyuz/tests/test_binarypackagerelease.py	1970-01-01 00:00:00 +0000
+++ lib/lp/soyuz/tests/test_binarypackagerelease.py	2010-08-12 19:10:59 +0000
@@ -0,0 +1,51 @@
+# Copyright 2010 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Test BinaryPackageRelease."""
+
+__metaclass__ = type
+
+from canonical.testing import LaunchpadFunctionalLayer
+
+from lp.soyuz.interfaces.binarypackagerelease import (
+    IBinaryPackageRelease, BinaryPackageFormat)
+from lp.soyuz.interfaces.publishing import PackagePublishingPriority
+
+from lp.testing import TestCaseWithFactory
+
+
+class TestBinaryPackageRelease(TestCaseWithFactory):
+    """Tests for BinaryPackageRelease."""
+
+    layer = LaunchpadFunctionalLayer
+
+    def test_provides(self):
+        build = self.factory.makeBinaryPackageBuild()
+        release = build.createBinaryPackageRelease(
+                binarypackagename=self.factory.makeBinaryPackageName(),
+                version="0.1", summary="My package",
+                description="My description",
+                binpackageformat=BinaryPackageFormat.DEB,
+                component=self.factory.makeComponent("main"),
+                section=self.factory.makeSection("net"),
+                priority=PackagePublishingPriority.OPTIONAL,
+                installedsize=0, architecturespecific=False)
+        self.assertProvides(release, IBinaryPackageRelease)
+
+    def test_user_defined_fields(self):
+        build = self.factory.makeBinaryPackageBuild()
+        release = build.createBinaryPackageRelease(
+                binarypackagename=self.factory.makeBinaryPackageName(),
+                version="0.1", summary="My package",
+                description="My description",
+                binpackageformat=BinaryPackageFormat.DEB,
+                component=self.factory.makeComponent("main"),
+                section=self.factory.makeSection("net"),
+                priority=PackagePublishingPriority.OPTIONAL,
+                installedsize=0, architecturespecific=False,
+                user_defined_fields=[
+                    ("Python-Version", ">= 2.4"),
+                    ("Other", "Bla")])
+        self.assertEquals([
+            ["Python-Version", ">= 2.4"],
+            ["Other", "Bla"]], release.user_defined_fields)

=== modified file 'lib/lp/soyuz/tests/test_sourcepackagerelease.py'
--- lib/lp/soyuz/tests/test_sourcepackagerelease.py	2010-07-29 23:09:34 +0000
+++ lib/lp/soyuz/tests/test_sourcepackagerelease.py	2010-08-12 19:10:59 +0000
@@ -30,3 +30,12 @@
         spr = self.factory.makeSourcePackageRelease(
             source_package_recipe_build=recipe_build)
         self.assertEqual(recipe_build.requester, spr.uploader)
+
+    def test_user_defined_fields(self):
+        release = self.factory.makeSourcePackageRelease(
+                user_defined_fields=[
+                    ("Python-Version", ">= 2.4"),
+                    ("Other", "Bla")])
+        self.assertEquals([
+            ["Python-Version", ">= 2.4"],
+            ["Other", "Bla"]], release.user_defined_fields)

=== modified file 'lib/lp/testing/factory.py'
--- lib/lp/testing/factory.py	2010-08-06 10:48:49 +0000
+++ lib/lp/testing/factory.py	2010-08-12 19:10:59 +0000
@@ -2289,7 +2289,8 @@
                                  dsc_format='1.0', dsc_binaries='foo-bin',
                                  date_uploaded=UTC_NOW,
                                  source_package_recipe_build=None,
-                                 dscsigningkey=None):
+                                 dscsigningkey=None,
+                                 user_defined_fields=None):
         """Make a `SourcePackageRelease`."""
         if distroseries is None:
             if source_package_recipe_build is not None:
@@ -2355,7 +2356,8 @@
             dsc_binaries=dsc_binaries,
             archive=archive,
             dateuploaded=date_uploaded,
-            source_package_recipe_build=source_package_recipe_build)
+            source_package_recipe_build=source_package_recipe_build,
+            user_defined_fields=user_defined_fields)
 
     def makeSourcePackageReleaseFile(self, sourcepackagerelease=None,
                                      library_file=None, filetype=None):