Merge lp:~michael.nelson/launchpad/567922-binarypackagebuild-packagebuild into lp:launchpad/db-devel

[Michael Nelson]

This branch is part of a pipeline for

https://blueprints.edge.launchpad.net/soyuz/+spec/build-generalisation
https://dev.launchpad.net/LEP/GeneralBuildHistories

In particular, this branch updates the IBuildFarmJob/IPackageJob interfaces and implementations so that items currently exported on IBinaryPackageBuild will continue to be exported when (in the next branch) the implementation of IBinaryPackageBuild switches to use the new tables.

It is dependent on the pending schema patch in a previous branch.

To test
=======

First update the test db schema (required as the db patch still needs to be updated to remove the old build table):
psql launchpad_ftest_template -f database/schema/pending/michaeln-build-generalisation.sql
bin/py database/schema/security.py -d launchpad_ftest_template

And then:
bin/test -vvt test_packagebuild -t test_buildfarmjob -t doc/build.txt -t test_buildqueue -t test_sourcepackagerecipebuild -t test_buildpackagejob

The next stage will be to add the methods currently defined for IBinaryPackageBuild to IBuildFarmJob/IPackageJob before switching the BinaryPackageBuild from the old build table to the new binarypackagebuild table.

[Eleanor Berger (intellectronica)]

review: Approve (code)

=== modified file 'lib/canonical/launchpad/interfaces/_schema_circular_imports.py'
--- lib/canonical/launchpad/interfaces/_schema_circular_imports.py	2010-05-05 15:49:06 +0000
+++ lib/canonical/launchpad/interfaces/_schema_circular_imports.py	2010-05-05 15:49:09 +0000
@@ -35,6 +35,7 @@
 from lp.bugs.interfaces.bugwatch import IBugWatch
 from lp.buildmaster.interfaces.buildbase import BuildStatus
 from lp.buildmaster.interfaces.buildfarmjob import IBuildFarmJob
+from lp.buildmaster.interfaces.buildqueue import IBuildQueue
 from lp.soyuz.interfaces.binarypackagebuild import IBinaryPackageBuild
 from lp.soyuz.interfaces.buildrecords import IHasBuildRecords
 from lp.blueprints.interfaces.specification import ISpecification
@@ -275,6 +276,7 @@
 
 # IBuildFarmJob
 IBuildFarmJob['status'].vocabulary = BuildStatus
+IBuildFarmJob['buildqueue_record'].schema = IBuildQueue
 
 # IDistribution
 IDistribution['series'].value_type.schema = IDistroSeries

=== added directory 'lib/lp/buildmaster/browser'
=== added file 'lib/lp/buildmaster/browser/__init__.py'
=== added file 'lib/lp/buildmaster/browser/configure.zcml'
--- lib/lp/buildmaster/browser/configure.zcml	1970-01-01 00:00:00 +0000
+++ lib/lp/buildmaster/browser/configure.zcml	2010-05-05 15:49:09 +0000
@@ -0,0 +1,14 @@
+<!-- Copyright 2010 Canonical Ltd.  This software is licensed under the
+     GNU Affero General Public License version 3 (see the file LICENSE).
+-->
+
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:browser="http://namespaces.zope.org/browser"
+    xmlns:i18n="http://namespaces.zope.org/i18n"
+    xmlns:xmlrpc="http://namespaces.zope.org/xmlrpc"
+    i18n_domain="launchpad">
+    <browser:url
+        for="lp.buildmaster.interfaces.packagebuild.IPackageBuild"
+        urldata="lp.buildmaster.browser.packagebuild.PackageBuildUrl"/>
+</configure>

=== added file 'lib/lp/buildmaster/browser/packagebuild.py'
--- lib/lp/buildmaster/browser/packagebuild.py	1970-01-01 00:00:00 +0000
+++ lib/lp/buildmaster/browser/packagebuild.py	2010-05-05 15:49:09 +0000
@@ -0,0 +1,42 @@
+# Copyright 2010 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""URLs for PackageBuild classes."""
+
+from zope.interface import implements
+
+from canonical.launchpad.webapp.interfaces import ICanonicalUrlData
+
+
+class PackageBuildUrl:
+    """Dynamic URL declaration for IPackageBuild classes.
+
+    When dealing with distribution builds we want to present them
+    under IDistributionSourcePackageRelease url:
+
+       /ubuntu/+source/foo/1.0/+build/1234
+
+    On the other hand, PPA builds will be presented under the PPA page:
+
+       /~cprov/+archive/+build/1235
+
+    Copy archives will be presented under the archives page:
+       /ubuntu/+archive/my-special-archive/+build/1234
+    """
+    implements(ICanonicalUrlData)
+    rootsite = None
+
+    def __init__(self, context):
+        self.context = context
+
+    @property
+    def inside(self):
+        if self.context.archive.is_ppa or self.context.archive.is_copy:
+            return self.context.archive
+        else:
+            return self.context.distributionsourcepackagerelease
+
+    @property
+    def path(self):
+        return u"+build/%d" % self.context.build_farm_job.id
+

=== modified file 'lib/lp/buildmaster/configure.zcml'
--- lib/lp/buildmaster/configure.zcml	2010-05-05 15:49:06 +0000
+++ lib/lp/buildmaster/configure.zcml	2010-05-05 15:49:09 +0000
@@ -8,7 +8,7 @@
     xmlns:i18n="http://namespaces.zope.org/i18n"
     xmlns:xmlrpc="http://namespaces.zope.org/xmlrpc"
     i18n_domain="launchpad">
-
+    <include package=".browser"/>
 
     <!-- Builder -->
     <class

=== modified file 'lib/lp/buildmaster/interfaces/buildbase.py'
--- lib/lp/buildmaster/interfaces/buildbase.py	2010-05-04 15:38:08 +0000
+++ lib/lp/buildmaster/interfaces/buildbase.py	2010-05-05 15:49:09 +0000
@@ -113,6 +113,9 @@
 
 class IBuildBase(Interface):
     """Common interface shared by farm jobs that build a package."""
+    # XXX 2010-04-21 michael.nelson bug=567922. This interface
+    # can be removed once all *Build classes inherit from
+    # IBuildFarmJob/IPackageBuild.
 
     # XXX: wgrant 2010-01-20 bug=507712: Most of these attribute names
     # are bad.

=== modified file 'lib/lp/buildmaster/interfaces/buildfarmjob.py'
--- lib/lp/buildmaster/interfaces/buildfarmjob.py	2010-05-05 15:49:06 +0000
+++ lib/lp/buildmaster/interfaces/buildfarmjob.py	2010-05-05 15:49:09 +0000
@@ -15,8 +15,9 @@
     ]
 
 from zope.interface import Interface, Attribute
-from zope.schema import Bool, Choice, Datetime
+from zope.schema import Bool, Choice, Datetime, TextLine
 from lazr.enum import DBEnumeratedType, DBItem
+from lazr.restful.declarations import exported
 from lazr.restful.fields import Reference
 
 from canonical.launchpad import _
@@ -34,25 +35,25 @@
     """
 
     PACKAGEBUILD = DBItem(1, """
-        PackageBuildJob
+        Binary package build
 
         Build a source package.
         """)
 
     BRANCHBUILD = DBItem(2, """
-        BranchBuildJob
+        Branch build
 
         Build a package from a bazaar branch.
         """)
 
     RECIPEBRANCHBUILD = DBItem(3, """
-        RecipeBranchBuildJob
+        Recipe branch build
 
         Build a package from a bazaar branch and a recipe.
         """)
 
     TRANSLATIONTEMPLATESBUILD = DBItem(4, """
-        TranslationTemplatesBuildJob
+        Translation template build
 
         Generate translation templates from a bazaar branch.
         """)
@@ -76,38 +77,65 @@
             "This should be None for job types that do not care whether "
             "they run virtualized."))
 
-    date_created = Datetime(
-        title=_("Date created"), required=True, readonly=True,
-        description=_("The timestamp when the build farm job was created."))
+    date_created = exported(
+        Datetime(
+            title=_("Date created"), required=True, readonly=True,
+            description=_(
+                "The timestamp when the build farm job was created.")),
+        ("1.0", dict(exported=True, exported_as="datecreated")))
 
     date_started = Datetime(
         title=_("Date started"), required=False, readonly=True,
         description=_("The timestamp when the build farm job was started."))
 
-    date_finished = Datetime(
-        title=_("Date finished"), required=False, readonly=True,
-        description=_("The timestamp when the build farm job was finished."))
+    date_finished = exported(
+        Datetime(
+            title=_("Date finished"), required=False, readonly=True,
+            description=_("The timestamp when the build farm job was finished.")),
+        ("1.0", dict(exported=True, exported_as="datebuilt")))
 
-    date_first_dispatched = Datetime(
-        title=_("Date finished"), required=False, readonly=True,
-        description=_("The timestamp when the build farm job was dispatched."))
+    date_first_dispatched = exported(
+        Datetime(
+            title=_("Date finished"), required=False, readonly=True,
+            description=_("The actual build start time. Set when the build "
+                          "is dispatched the first time and not changed in "
+                          "subsequent build attempts.")))
 
     builder = Reference(
         title=_("Builder"), schema=IBuilder, required=False, readonly=True,
         description=_("The builder assigned to this job."))
 
-    status = Choice(
-        title=_('Status'), required=True,
-        # Really BuildStatus, patched in
-        # _schema_circular_imports.py
-        vocabulary=DBEnumeratedType,
-        description=_("The current status of the job."))
+    buildqueue_record = Reference(
+        # Really IBuildQueue, set in _schema_circular_imports to avoid
+        # circular import.
+        schema=Interface, required=True,
+        title=_("Corresponding BuildQueue record"))
+
+    status = exported(
+        Choice(
+            title=_('Status'), required=True,
+            # Really BuildStatus, patched in
+            # _schema_circular_imports.py
+            vocabulary=DBEnumeratedType,
+            description=_("The current status of the job.")),
+        ("1.0", dict(exported=True, exported_as="buildstate")))
 
     log = Reference(
         schema=ILibraryFileAlias, required=False,
         title=_(
             "The LibraryFileAlias containing the entire log for this job."))
 
+    log_url = exported(
+        TextLine(
+            title=_("Build Log URL"), required=False,
+            description=_("A URL for the build log. None if there is no "
+                          "log available.")),
+        ("1.0", dict(exported=True, exported_as="build_log_url")))
+
+    is_private = Bool(
+        title=_("is private"), required=False, readonly=True,
+        description=_("Whether the build should be treated as private."))
+
     job_type = Choice(
         title=_("Job type"), required=True, readonly=True,
         vocabulary=BuildFarmJobType,
@@ -121,6 +149,8 @@
         readonly=True, description=_(
             'Whether this instance is or has a concrete build farm job.'))
 
+    title = exported(TextLine(title=_("Title"), required=False))
+
     def score():
         """Calculate a job score appropriate for the job type in question."""
 

=== modified file 'lib/lp/buildmaster/interfaces/packagebuild.py'
--- lib/lp/buildmaster/interfaces/packagebuild.py	2010-05-05 15:49:06 +0000
+++ lib/lp/buildmaster/interfaces/packagebuild.py	2010-05-05 15:49:09 +0000
@@ -11,11 +11,13 @@
 
 from zope.interface import Interface, Attribute
 from zope.schema import Choice, Object, TextLine
+from lazr.restful.declarations import exported
 from lazr.restful.fields import Reference
 
 from canonical.launchpad import _
 from canonical.launchpad.interfaces.librarian import ILibraryFileAlias
 from lp.buildmaster.interfaces.buildfarmjob import IBuildFarmJob
+from lp.registry.interfaces.distribution import IDistribution
 from lp.registry.interfaces.pocket import PackagePublishingPocket
 from lp.soyuz.interfaces.archive import IArchive
 
@@ -25,15 +27,17 @@
 
     id = Attribute('The package build ID.')
 
-    archive = Reference(
+    archive = exported(
+        Reference(
             title=_('Archive'), schema=IArchive,
             required=True, readonly=True,
-            description=_('The Archive context for this build.'))
+            description=_('The Archive context for this build.')))
 
-    pocket = Choice(
+    pocket = exported(
+        Choice(
             title=_('Pocket'), required=True,
             vocabulary=PackagePublishingPocket,
-            description=_('The build targeted pocket.'))
+            description=_('The build targeted pocket.')))
 
     upload_log = Object(
         schema=ILibraryFileAlias, required=False,
@@ -41,15 +45,36 @@
                 'build resulting in an upload that could not be processed '
                 'successfully. Otherwise it will be None.'))
 
-    dependencies = TextLine(
+    upload_log_url = exported(
+        TextLine(
+            title=_("Upload Log URL"), required=False,
+            description=_("A URL for failed upload logs."
+                          "Will be None if there was no failure.")))
+
+    dependencies = exported(
+        TextLine(
             title=_('Dependencies'), required=False,
             description=_('Debian-like dependency line that must be satisfied'
-                          ' before attempting to build this request.'))
+                          ' before attempting to build this request.')))
 
     build_farm_job = Reference(
         title=_('Build farm job'), schema=IBuildFarmJob, required=True,
         readonly=True, description=_('The base build farm job.'))
 
+    policy_name = TextLine(
+        title=_("Policy name"), required=True,
+        description=_("The upload policy to use for handling these builds."))
+
+    current_component = Attribute(
+        'Component where the source related to this build was last '
+        'published.')
+
+    distribution = exported(
+        Reference(
+            schema=IDistribution,
+            title=_("Distribution"), required=True,
+            description=_("Shortcut for its distribution.")))
+
 
 class IPackageBuildSource(Interface):
     """A utility of this interface used to create _things_."""

=== modified file 'lib/lp/buildmaster/model/buildfarmjob.py'
--- lib/lp/buildmaster/model/buildfarmjob.py	2010-05-05 15:49:06 +0000
+++ lib/lp/buildmaster/model/buildfarmjob.py	2010-05-05 15:49:09 +0000
@@ -100,6 +100,11 @@
         # Check if the object has been added to the store.
         return get_obj_info(self).get('store') is not None
 
+    @property
+    def title(self):
+        """See `IBuildFarmJob`."""
+        return self.job_type.title
+
     def score(self):
         """See `IBuildFarmJob`."""
         raise NotImplementedError
@@ -147,6 +152,31 @@
         """See `IBuildFarmJob`."""
         return True
 
+    @property
+    def buildqueue_record(self):
+        """See `IBuildFarmJob`."""
+        # Need to update the db schema for buildpackagejob before
+        # this can be implemented here.
+        return None
+
+    @property
+    def is_private(self):
+        """See `IBuildFarmJob`.
+
+        This base implementation assumes build farm jobs are public, but
+        derived implementations can override as required.
+        """
+        return False
+
+    @property
+    def log_url(self):
+        """See `IBuildFarmJob`.
+
+        This base implementation of the property always returns None. Derived
+        implementations need to override for their specific context.
+        """
+        return None
+
 
 class BuildFarmJobDerived:
     """See `IBuildFarmJobDerived`."""

=== modified file 'lib/lp/buildmaster/model/packagebuild.py'
--- lib/lp/buildmaster/model/packagebuild.py	2010-05-05 15:49:06 +0000
+++ lib/lp/buildmaster/model/packagebuild.py	2010-05-05 15:49:09 +0000
@@ -15,6 +15,8 @@
 
 from canonical.database.constants import UTC_NOW
 from canonical.database.enumcol import DBEnum
+from canonical.launchpad.browser.librarian import (
+    ProxiedLibraryFileAlias)
 from canonical.launchpad.interfaces.lpstorm import IMasterStore
 
 from lp.buildmaster.interfaces.buildbase import BuildStatus
@@ -23,6 +25,9 @@
     IPackageBuild, IPackageBuildSource)
 from lp.buildmaster.model.buildfarmjob import BuildFarmJobDerived
 from lp.registry.interfaces.pocket import PackagePublishingPocket
+from lp.soyuz.adapters.archivedependencies import (
+    default_component_dependency_name)
+from lp.soyuz.interfaces.component import IComponentSet
 
 
 class PackageBuild(BuildFarmJobDerived, Storm):
@@ -50,6 +55,9 @@
     build_farm_job_id = Int(name='build_farm_job', allow_none=False)
     build_farm_job = Reference(build_farm_job_id, 'BuildFarmJob.id')
 
+    policy_name = 'buildd'
+    distribution = None
+
     def __init__(self, build):
         """Construct a PackageBuild.
 
@@ -136,6 +144,25 @@
 
         self.build.buildstate = BuildStatus.NEEDSBUILD
 
+    @property
+    def current_component(self):
+        """See `IPackageBuild`."""
+        return getUtility(IComponentSet)[default_component_dependency_name]
+
+    @property
+    def upload_log_url(self):
+        """See `IBuildBase`."""
+        if self.upload_log is None:
+            return None
+        return ProxiedLibraryFileAlias(self.upload_log, self).http_url
+
+    @property
+    def log_url(self):
+        """See `IBuildFarmJob`."""
+        if self.log is None:
+            return None
+        return ProxiedLibraryFileAlias(self.log, self).http_url
+
 
 class PackageBuildDerived(BuildFarmJobDerived):
     """Override the base delegate to use a build farm job specific to

=== modified file 'lib/lp/buildmaster/tests/test_buildfarmjob.py'
--- lib/lp/buildmaster/tests/test_buildfarmjob.py	2010-05-05 15:49:06 +0000
+++ lib/lp/buildmaster/tests/test_buildfarmjob.py	2010-05-05 15:49:09 +0000
@@ -79,6 +79,7 @@
         self.assertEqual(None, self.build_farm_job.date_first_dispatched)
         self.assertEqual(None, self.build_farm_job.builder)
         self.assertEqual(None, self.build_farm_job.log)
+        self.assertEqual(None, self.build_farm_job.log_url)
 
     def test_unimplemented_methods(self):
         # A build farm job leaves the implementation of various
@@ -115,6 +116,16 @@
             BuildStatus.NEEDSBUILD, self.build_farm_job.status)
         self.failUnless(self.build_farm_job.date_started is None)
 
+    def test_title(self):
+        # The default title simply uses the job type's title.
+        self.assertEqual(
+            self.build_farm_job.job_type.title,
+            self.build_farm_job.title)
+
+    def test_buildqueue_record(self):
+        self.failUnless(
+            False, "Update schema and move buildqueue_record implementation")
+
 
 def test_suite():
     return unittest.TestLoader().loadTestsFromName(__name__)

=== modified file 'lib/lp/buildmaster/tests/test_packagebuild.py'
--- lib/lp/buildmaster/tests/test_packagebuild.py	2010-05-05 15:49:06 +0000
+++ lib/lp/buildmaster/tests/test_packagebuild.py	2010-05-05 15:49:09 +0000
@@ -9,9 +9,10 @@
 
 from storm.store import Store
 from zope.component import getUtility
+from zope.security.proxy import removeSecurityProxy
 
 from canonical.database.sqlbase import flush_database_updates
-from canonical.testing.layers import DatabaseFunctionalLayer
+from canonical.testing.layers import LaunchpadFunctionalLayer
 
 from lp.buildmaster.interfaces.buildfarmjob import BuildFarmJobType
 from lp.buildmaster.interfaces.packagebuild import (
@@ -24,34 +25,70 @@
 class TestPackageBuild(TestCaseWithFactory):
     """Tests for the package build object."""
 
-    layer = DatabaseFunctionalLayer
-
-    def makePackageBuild(self):
+    layer = LaunchpadFunctionalLayer
+
+    def setUp(self):
+        """Create a package build with which to test."""
+        super(TestPackageBuild, self).setUp()
+        joe = self.factory.makePerson(name="joe")
+        joes_ppa = self.factory.makeArchive(owner=joe)
+        self.package_build = self.makePackageBuild(archive=joes_ppa)
+
+    def makePackageBuild(self, archive=None):
+        if archive is None:
+            archive = self.factory.makeArchive()
+
         return getUtility(IPackageBuildSource).new(
             job_type=BuildFarmJobType.PACKAGEBUILD,
             virtualized=True,
-            archive=self.factory.makeArchive(),
+            archive=archive,
             pocket=PackagePublishingPocket.RELEASE)
 
     def test_providesInterface(self):
         # PackageBuild provides IPackageBuild
-        package_build = self.makePackageBuild()
-        self.assertProvides(package_build, IPackageBuild)
+        self.assertProvides(self.package_build, IPackageBuild)
 
     def test_saves_record(self):
         # A package build can be stored in the database.
-        package_build = self.makePackageBuild()
         flush_database_updates()
-        store = Store.of(package_build)
+        store = Store.of(self.package_build)
         retrieved_build = store.find(
             PackageBuild,
-            PackageBuild.id == package_build.id).one()
-        self.assertEqual(package_build, retrieved_build)
+            PackageBuild.id == self.package_build.id).one()
+        self.assertEqual(self.package_build, retrieved_build)
 
     def test_getTitle_not_implemented(self):
         # Classes deriving from PackageBuild must provide getTitle.
-        package_build = self.makePackageBuild()
-        self.assertRaises(NotImplementedError, package_build.getTitle)
+        self.assertRaises(NotImplementedError, self.package_build.getTitle)
+
+    def test_default_values(self):
+        # PackageBuild has a number of default values.
+        self.failUnlessEqual('buildd', self.package_build.policy_name)
+        self.failUnlessEqual(
+            'multiverse', self.package_build.current_component.name)
+        self.failUnlessEqual(None, self.package_build.distribution)
+
+    def test_log_url(self):
+        # The url of the build log file is determined by the PackageBuild.
+        lfa = self.factory.makeLibraryFileAlias('mybuildlog.txt')
+        removeSecurityProxy(self.package_build).log = lfa
+        log_url = self.package_build.log_url
+        self.failUnlessEqual(
+            'http://launchpad.dev/~joe/'
+            '+archive/ppa/+build/%d/+files/mybuildlog.txt' % (
+                self.package_build.build_farm_job.id),
+            log_url)
+
+    def test_upload_log_url(self):
+        # The url of the upload log file is determined by the PackageBuild.
+        lfa = self.factory.makeLibraryFileAlias('myuploadlog.txt')
+        removeSecurityProxy(self.package_build).upload_log = lfa
+        log_url = self.package_build.upload_log_url
+        self.failUnlessEqual(
+            'http://launchpad.dev/~joe/'
+            '+archive/ppa/+build/%d/+files/myuploadlog.txt' % (
+                self.package_build.build_farm_job.id),
+            log_url)
 
 
 def test_suite():