Launchpad itself

Merge lp:~michael.nelson/launchpad/487009-db-generalise-ibuilder-1b into lp:launchpad/db-devel

487009-db-generalise-ibuilder-1b
Merge into db-devel

Proposed by Michael Nelson on 2009-12-01

Status:

Merged

Approved by:

Michael Nelson on 2009-12-04

Approved revision:

not available

Merged at revision:

not available

Proposed branch:

lp:~michael.nelson/launchpad/487009-db-generalise-ibuilder-1b

Merge into:

lp:launchpad/db-devel

Diff against target:

481 lines (+296/-7)

11 files modified

lib/lp/buildmaster/interfaces/buildfarmjobbehavior.py (+38/-0)
lib/lp/buildmaster/model/buildfarmjobbehavior.py (+50/-0)
lib/lp/soyuz/configure.zcml (+7/-0)
lib/lp/soyuz/doc/builder.txt (+12/-0)
lib/lp/soyuz/doc/buildqueue.txt (+10/-0)
lib/lp/soyuz/interfaces/builder.py (+8/-2)
lib/lp/soyuz/interfaces/buildqueue.py (+5/-1)
lib/lp/soyuz/model/binarypackagebuildbehavior.py (+35/-0)
lib/lp/soyuz/model/builder.py (+55/-4)
lib/lp/soyuz/model/buildqueue.py (+7/-0)
lib/lp/soyuz/tests/test_builder.py (+69/-0)

To merge this branch:

bzr merge lp:~michael.nelson/launchpad/487009-db-generalise-ibuilder-1b

Related bugs:

Bug #487009: Generalise IBuilder

High

Fix Released

Link a bug report

Reviewer	Review Type	Date Requested	Status
Graham Binns (community)	code	2009-12-01	Approve on 2009-12-01
Review via email: mp+15477@code.launchpad.net

Revision history for this message

Michael Nelson (michael.nelson) wrote on 2009-12-01:

= Summary =

This branch creates the infrastructure to allow IBuilder to support different behaviors (BinaryPackageBuildBehavior currently, but later SourcePackageRecipeBuildBehavior etc.).

== Proposed fix ==

Create a general interface for build farm job behaviors that can be implemented by various classes, and allow the behavior to be an attribute of the builder to which all relevant calls will be delegated.

This branch begins the extraction of soyuz-specific build behavior for the [Binary]BuildPackageJob into a BinaryPackageBuildBehavior. Subsequent branches (in a pipeline) will continue this.

I plan to re-base these to devel after the release when db-stable is merged back into devel.

== Pre-implementation notes ==

See the pre-implementation notes on bug 487009.

== Implementation details ==

== Tests ==

bin/test -vv -t doc/builder.txt -t doc/buildqueue.txt -t TestCurrentBuildBehavior.txt

== Demo and Q/A ==

We will need to Q/A this on dogfood.

= Launchpad lint =

Checking for conflicts. and issues in doctests and templates.
Running jslint, xmllint, pyflakes, and pylint.
Using normal rules.

Linting changed files:
  lib/lp/soyuz/model/builder.py
  lib/lp/soyuz/doc/builder.txt
  lib/lp/soyuz/doc/buildqueue.txt
  lib/lp/soyuz/configure.zcml
  lib/lp/soyuz/model/buildqueue.py
  lib/lp/buildmaster/model/buildfarmjobbehavior.py
  lib/lp/soyuz/interfaces/buildqueue.py
  lib/lp/soyuz/tests/test_builder.py
  lib/lp/soyuz/model/binarypackagebuildbehavior.py
  lib/lp/buildmaster/interfaces/buildfarmjobbehavior.py
  lib/lp/soyuz/interfaces/builder.py

== Pylint notices ==

lib/lp/soyuz/model/builder.py
23: [F0401] Unable to import 'lazr.delegates' (No module named delegates)

lib/lp/soyuz/interfaces/buildqueue.py
18: [F0401] Unable to import 'lazr.restful.fields' (No module named restful)

--
Michael

Revision history for this message

Michael Nelson (michael.nelson) wrote on 2009-12-01:

> == Tests ==
>
> bin/test -vv -t doc/builder.txt -t doc/buildqueue.txt -t
> TestCurrentBuildBehavior.txt

Also include doc/buildd-dispatching.txt which demonstrates that build dispatching still passes with the refactoring.

Revision history for this message

Graham Binns (gmb) wrote on 2009-12-01:

Download full text (19.3 KiB)

Hi Michael,

Nice branch. Good work. I've got some stylistic nitpicks - our
guidelines gleefully discard PEP8, hurrah - and I'd like you to do a
strip-trailing-whitespace run on the files you've changed (there's not
much, but enough for me to notice).

Other than that, r=me.

> === added file 'lib/lp/buildmaster/interfaces/buildfarmjobbehavior.py'
> --- lib/lp/buildmaster/interfaces/buildfarmjobbehavior.py 1970-01-01 00:00:00 +0000
> +++ lib/lp/buildmaster/interfaces/buildfarmjobbehavior.py 2009-12-01 10:00:36 +0000
> @@ -0,0 +1,38 @@
> +# Copyright 2009 Canonical Ltd. This software is licensed under the
> +# GNU Affero General Public License version 3 (see the file LICENSE).
> +
> +# pylint: disable-msg=E0211,E0213
> +
> +"""Interface for build farm job behaviors."""
> +
> +__metaclass__ = type
> +
> +__all__ = [
> + 'IBuildFarmJobBehavior',
> + ]
> +
> +from zope.interface import Interface
> +
> +
> +class BuildBehaviorMismatch(Exception):
> + """
> + A general exception that can be raised when the builder's current behavior
> + does not match the expected behavior.
> + """
> +
> +
> +class IBuildFarmJobBehavior(Interface):
> +
> + def set_builder(builder):
> + """Sets the associated builder reference for this instance."""
> +
> + def log_start_build(build_queue_item, logger):
> + """Log the start of a specific build queue item.
> +
> + The form of the log message will vary depending on the type of build.
> + :param build_queue_item: A BuildQueueItem to build.
> + :param logger: A logger to be used to log diagnostic information.
> + """
> + # A number of other methods to go here that can be customised for each of
> + # the different build types (branch build, recipe build, translation
> + # build etc.)
>
> === added file 'lib/lp/buildmaster/model/buildfarmjobbehavior.py'
> --- lib/lp/buildmaster/model/buildfarmjobbehavior.py 1970-01-01 00:00:00 +0000
> +++ lib/lp/buildmaster/model/buildfarmjobbehavior.py 2009-12-01 10:00:36 +0000
> @@ -0,0 +1,53 @@
> +# Copyright 2009 Canonical Ltd. This software is licensed under the
> +# GNU Affero General Public License version 3 (see the file LICENSE).
> +
> +# pylint: disable-msg=E0211,E0213
> +
> +"""Base and idle BuildFarmJobBehavior classes."""
> +
> +__metaclass__ = type
> +
> +__all__ = [
> + 'BuildFarmJobBehaviorBase',
> + 'IdleBuildBehavior'
> + ]
> +
> +from zope.interface import implements
> +
> +from lp.buildmaster.interfaces.buildfarmjobbehavior import (
> + BuildBehaviorMismatch, IBuildFarmJobBehavior)
> +
> +
> +class BuildFarmJobBehaviorBase:
> + """Ensures that all behaviors inherit the same initialisation.
> +
> + All build-farm job behaviors should inherit from this.
> + """
> +
> + def __init__(self, buildfarmjob):
> + """
> + Store a reference to the job_type with which we were created.
> + """
> + self.buildfarmjob = buildfarmjob
> + self._builder = None
> +
> + def set_builder(self, builder):

This should be setBuilder(), because who needs PEP8?

> + """The builder should be set once and not changed."""
> + self._builder = builde...

Hi Michael,

Other than that, r=me.

> === added file 'lib/lp/buildmaster/interfaces/buildfarmjobbehavior.py'
> --- lib/lp/buildmaster/interfaces/buildfarmjobbehavior.py	1970-01-01 00:00:00 +0000
> +++ lib/lp/buildmaster/interfaces/buildfarmjobbehavior.py	2009-12-01 10:00:36 +0000
> @@ -0,0 +1,38 @@
> +# Copyright 2009 Canonical Ltd.  This software is licensed under the
> +# GNU Affero General Public License version 3 (see the file LICENSE).
> +
> +# pylint: disable-msg=E0211,E0213
> +
> +"""Interface for build farm job behaviors."""
> +
> +__metaclass__ = type
> +
> +__all__ = [
> +    'IBuildFarmJobBehavior',
> +    ]
> +
> +from zope.interface import Interface
> +
> +
> +class BuildBehaviorMismatch(Exception):
> +    """
> +    A general exception that can be raised when the builder's current behavior
> +    does not match the expected behavior.
> +    """
> +
> +
> +class IBuildFarmJobBehavior(Interface):
> +
> +    def set_builder(builder):
> +        """Sets the associated builder reference for this instance."""
> +
> +    def log_start_build(build_queue_item, logger):
> +        """Log the start of a specific build queue item.
> +
> +        The form of the log message will vary depending on the type of build.
> +        :param build_queue_item: A BuildQueueItem to build.
> +        :param logger: A logger to be used to log diagnostic information.
> +        """
> +    # A number of other methods to go here that can be customised for each of
> +    # the different build types (branch build, recipe build, translation
> +    # build etc.)
> 
> === added file 'lib/lp/buildmaster/model/buildfarmjobbehavior.py'
> --- lib/lp/buildmaster/model/buildfarmjobbehavior.py	1970-01-01 00:00:00 +0000
> +++ lib/lp/buildmaster/model/buildfarmjobbehavior.py	2009-12-01 10:00:36 +0000
> @@ -0,0 +1,53 @@
> +# Copyright 2009 Canonical Ltd.  This software is licensed under the
> +# GNU Affero General Public License version 3 (see the file LICENSE).
> +
> +# pylint: disable-msg=E0211,E0213
> +
> +"""Base and idle BuildFarmJobBehavior classes."""
> +
> +__metaclass__ = type
> +
> +__all__ = [
> +    'BuildFarmJobBehaviorBase',
> +    'IdleBuildBehavior'
> +    ]
> +
> +from zope.interface import implements
> +
> +from lp.buildmaster.interfaces.buildfarmjobbehavior import (
> +    BuildBehaviorMismatch, IBuildFarmJobBehavior)
> +
> +
> +class BuildFarmJobBehaviorBase:
> +    """Ensures that all behaviors inherit the same initialisation.
> +
> +    All build-farm job behaviors should inherit from this.
> +    """
> +
> +    def __init__(self, buildfarmjob):
> +        """
> +        Store a reference to the job_type with which we were created.
> +        """
> +        self.buildfarmjob = buildfarmjob
> +        self._builder = None
> +
> +    def set_builder(self, builder):

This should be setBuilder(), because who needs PEP8?

> +        """The builder should be set once and not changed."""
> +        self._builder = builder
> +
> +
> +class IdleBuildBehavior(BuildFarmJobBehaviorBase):
> +
> +    implements(IBuildFarmJobBehavior)
> +
> +    def __init__(self):
> +        """

According to our coding standards the docstring should start on the same
line as the opening """.

> +        The idle behavior is special in that a buildfarmjob is not specified
> +        during initialisation.
> +        """
> +        super(IdleBuildBehavior, self).__init__(None)
> +
> +    def logStartBuild(self, build_queue_item, logger):
> +        """See `IBuildFarmJobBehavior`."""
> +        raise BuildBehaviorMismatch(
> +            "Builder was idle when asked to log the start of a build.")
> 
> === modified file 'lib/lp/soyuz/configure.zcml'
> --- lib/lp/soyuz/configure.zcml	2009-11-16 22:06:14 +0000
> +++ lib/lp/soyuz/configure.zcml	2009-12-01 10:00:36 +0000
> @@ -892,4 +892,11 @@
>              interface="lp.soyuz.interfaces.buildpackagejob.IBuildPackageJob"/>
>      </class>
>  
> +    
> +    <adapter
> +        for="lp.soyuz.interfaces.buildpackagejob.IBuildPackageJob"
> +        provides="lp.buildmaster.interfaces.buildfarmjobbehavior.IBuildFarmJobBehavior"
> +        factory="lp.soyuz.model.binarypackagebuildbehavior.BinaryPackageBuildBehavior"
> +        permission="zope.Public" />
> +
>  </configure>
> 
> === modified file 'lib/lp/soyuz/doc/builder.txt'
> --- lib/lp/soyuz/doc/builder.txt	2009-11-12 12:52:23 +0000
> +++ lib/lp/soyuz/doc/builder.txt	2009-12-01 10:00:36 +0000
> @@ -40,6 +40,18 @@
>      >>> builder.builderok = True
>      >>> builder.failnotes = None
>  
> +A builder provides a current_build_behavior attribute to which all the
> +build-type specific behavior for the current build is delegated. For
> +our sample data, the behavior is specifically a behavior for dealing
> +with binary packages
> +
> +    >>> from zope.security.proxy import isinstance
> +    >>> from lp.soyuz.model.binarypackagebuildbehavior import (
> +    ...     BinaryPackageBuildBehavior)
> +    >>> isinstance(
> +    ...     builder.current_build_behavior, BinaryPackageBuildBehavior)
> +    True
> +
>  In case of copy archives the status string will show both the copy
>  archive owner as well as the copy archive name.
>  
> 
> === modified file 'lib/lp/soyuz/doc/buildqueue.txt'
> --- lib/lp/soyuz/doc/buildqueue.txt	2009-11-13 19:34:17 +0000
> +++ lib/lp/soyuz/doc/buildqueue.txt	2009-12-01 10:00:36 +0000
> @@ -98,6 +98,16 @@
>      (True, 1000)
>  
>  
> +The BuildQueue item is responsible for providing the required build behavior
> +for the item.
> +
> +    >>> from zope.security.proxy import isinstance
> +    >>> from lp.soyuz.model.binarypackagebuildbehavior import (
> +    ...     BinaryPackageBuildBehavior)
> +    >>> isinstance(bq.required_build_behavior, BinaryPackageBuildBehavior)
> +    True
> +
> +
>  == Dispatching and Reseting jobs ==
>  
>  The sampledata contains an active job, being built by the 'bob'
> 
> === modified file 'lib/lp/soyuz/interfaces/builder.py'
> --- lib/lp/soyuz/interfaces/builder.py	2009-11-20 18:06:28 +0000
> +++ lib/lp/soyuz/interfaces/builder.py	2009-12-01 10:00:36 +0000
> @@ -19,11 +19,13 @@
>      ]
>  
>  from zope.interface import Interface, Attribute
> -from zope.schema import Choice, TextLine, Text, Bool
> +from zope.schema import Bool, Choice, Field, Text, TextLine
>  
>  from canonical.launchpad import _
>  from canonical.launchpad.fields import Title, Description
>  from lp.registry.interfaces.role import IHasOwner
> +from lp.buildmaster.interfaces.buildfarmjobbehavior import (
> +    IBuildFarmJobBehavior)
>  from canonical.launchpad.validators.name import name_validator
>  from canonical.launchpad.validators.url import builder_url_validator
>  
> @@ -57,7 +59,7 @@
>      """The build slave has suffered an error and cannot be used."""
>  
>  
> -class IBuilder(IHasOwner):
> +class IBuilder(IHasOwner, IBuildFarmJobBehavior):
>      """Build-slave information and state.
>  
>      Builder instance represents a single builder slave machine within the
> @@ -138,6 +140,10 @@
>                  "new jobs. "),
>          required=False)
>  
> +    current_build_behavior = Field(
> +        title=u"The current behavior of the builder for the current job.",
> +        required=False)
> +
>      def cacheFileOnSlave(logger, libraryfilealias):
>          """Ask the slave to cache a librarian file to its local disk.
>  
> 
> === modified file 'lib/lp/soyuz/interfaces/buildqueue.py'
> --- lib/lp/soyuz/interfaces/buildqueue.py	2009-11-20 18:06:28 +0000
> +++ lib/lp/soyuz/interfaces/buildqueue.py	2009-12-01 10:00:36 +0000
> @@ -13,7 +13,7 @@
>      ]
>  
>  from zope.interface import Interface, Attribute
> -from zope.schema import Choice, Datetime, Timedelta
> +from zope.schema import Choice, Datetime, Field, Timedelta
>  
>  from lazr.restful.fields import Reference
>  
> @@ -51,6 +51,10 @@
>          title=_('Job type'), required=True, vocabulary=BuildFarmJobType,
>          description=_("The type of this job."))
>  
> +    required_build_behavior = Field(
> +        title=_('The builder behavior required to run this job.'),
> +        required=False, readonly=True)
> +
>      estimated_duration = Timedelta(
>          title=_("Estimated Job Duration"), required=True,
>          description=_("Estimated job duration interval."))
> 
> === added file 'lib/lp/soyuz/model/binarypackagebuildbehavior.py'
> --- lib/lp/soyuz/model/binarypackagebuildbehavior.py	1970-01-01 00:00:00 +0000
> +++ lib/lp/soyuz/model/binarypackagebuildbehavior.py	2009-12-01 10:00:36 +0000
> @@ -0,0 +1,35 @@
> +# Copyright 2009 Canonical Ltd.  This software is licensed under the
> +# GNU Affero General Public License version 3 (see the file LICENSE).
> +
> +# pylint: disable-msg=E0211,E0213
> +
> +"""Builder behavior for binary package builds."""
> +
> +__metaclass__ = type
> +
> +__all__ = [
> +    'BinaryPackageBuildBehavior',
> +    ]
> +
> +from lp.buildmaster.interfaces.buildfarmjobbehavior import (
> +    IBuildFarmJobBehavior)
> +from lp.buildmaster.model.buildfarmjobbehavior import (
> +    BuildFarmJobBehaviorBase)
> +from lp.soyuz.interfaces.build import IBuildSet
> +
> +from zope.component import getUtility
> +from zope.interface import implements
> +
> +
> +class BinaryPackageBuildBehavior(BuildFarmJobBehaviorBase):
> +    """Define the behavior of binary package builds."""
> +
> +    implements(IBuildFarmJobBehavior)
> +
> +    def log_start_build(self, build_queue_item, logger):
> +        """See `IBuildFarmJobBehavior`.""" 
> +        build = getUtility(IBuildSet).getByQueueEntry(build_queue_item)
> +        spr = build.sourcepackagerelease
> +
> +        logger.info("startBuild(%s, %s, %s, %s)", self._builder.url,
> +                    spr.name, spr.version, build.pocket.title)
> 
> === modified file 'lib/lp/soyuz/model/builder.py'
> --- lib/lp/soyuz/model/builder.py	2009-11-20 18:06:28 +0000
> +++ lib/lp/soyuz/model/builder.py	2009-12-01 10:00:36 +0000
> @@ -20,6 +20,8 @@
>  import urllib2
>  import xmlrpclib
>  
> +from lazr.delegates import delegates
> +
>  from zope.interface import implements
>  from zope.component import getUtility
>  
> @@ -31,7 +33,10 @@
>  from canonical.cachedproperty import cachedproperty
>  from canonical.config import config
>  from canonical.buildd.slave import BuilderStatus
> +from lp.buildmaster.interfaces.buildfarmjobbehavior import (
> +    BuildBehaviorMismatch, IBuildFarmJobBehavior)
>  from lp.buildmaster.master import BuilddMaster
> +from lp.buildmaster.model.buildfarmjobbehavior import IdleBuildBehavior
>  from canonical.database.sqlbase import SQLBase, sqlvalues
>  from lp.soyuz.adapters.archivedependencies import (
>      get_primary_current_component, get_sources_list_for_building)
> @@ -54,6 +59,7 @@
>      PackagePublishingStatus)
>  from lp.soyuz.model.buildpackagejob import BuildPackageJob
>  from canonical.launchpad.webapp import urlappend
> +from canonical.lazr.utils import safe_hasattr
>  from canonical.librarian.utils import copy_and_close
>  
>  
> @@ -114,6 +120,7 @@
>  class Builder(SQLBase):
>  
>      implements(IBuilder, IHasBuildRecords)
> +    delegates(IBuildFarmJobBehavior, context="current_build_behavior")
>      _table = 'Builder'
>  
>      _defaultOrder = ['id']
> @@ -135,6 +142,51 @@
>      vm_host = StringCol(dbName='vm_host')
>      active = BoolCol(dbName='active', notNull=True, default=True)
>  
> +    def _get_current_build_behavior(self):

Should be _getCurrentBuildBehavior(). Yes, I know it's hateful, but
them's the guidelines.

> +        """Return the current build behavior."""
> +        if not safe_hasattr(self, '_current_build_behavior'):
> +            self._current_build_behavior = None
> +
> +        if (self._current_build_behavior is None or
> +            isinstance(self._current_build_behavior, IdleBuildBehavior)):
> +            # If we don't currently have a current build behavior set,
> +            # or we are currently idle, then...
> +            currentjob = self.currentjob
> +            if currentjob is not None:
> +                # ...we'll set it based on our current job.
> +                self._current_build_behavior = (
> +                    currentjob.required_build_behavior)
> +                self._current_build_behavior.set_builder(self)
> +                return self._current_build_behavior
> +            elif self._current_build_behavior is None:
> +                # If we don't have a current job or an idle behavior
> +                # already set, then we just set the idle behavior
> +                # before returning.
> +                self._current_build_behavior = IdleBuildBehavior()
> +            return self._current_build_behavior 
> +
> +        else:
> +            # We did have a current non-idle build behavior set, so
> +            # we just return it.
> +            return self._current_build_behavior
> +
> +
> +    def _set_current_build_behavior(self, new_behavior):

_setCurrentBuildBehavior().

> +        """Set the current build behavior."""
> +
> +        if self.currentjob is not None:
> +            # We do not allow the current build behavior to be reset if we
> +            # have a current job.
> +            raise BuildBehaviorMismatch(
> +                "Attempt to reset builder behavior while a current build "
> +                "exists.")
> +        else:
> +            self._current_build_behavior = new_behavior
> +            self._current_build_behavior.set_builder(self)
> +
> +    current_build_behavior = property(
> +        _get_current_build_behavior, _set_current_build_behavior)
> +
>      def cacheFileOnSlave(self, logger, libraryfilealias):
>          """See `IBuilder`."""
>          url = libraryfilealias.http_url
> @@ -351,10 +403,9 @@
>  
>      def startBuild(self, build_queue_item, logger):
>          """See IBuilder."""
> -        build = getUtility(IBuildSet).getByQueueEntry(build_queue_item)
> -        spr = build.sourcepackagerelease
> -        logger.info("startBuild(%s, %s, %s, %s)", self.url,
> -                    spr.name, spr.version, build.pocket.title)
> +        # Set the build behavior depending on the provided build queue item. 
> +        self.current_build_behavior = build_queue_item.required_build_behavior
> +        self.log_start_build(build_queue_item, logger)
>  
>          # Make sure the request is valid; an exception is raised if it's not.
>          self._verifyBuildRequest(build_queue_item, logger)
> 
> === modified file 'lib/lp/soyuz/model/buildqueue.py'
> --- lib/lp/soyuz/model/buildqueue.py	2009-11-20 18:06:28 +0000
> +++ lib/lp/soyuz/model/buildqueue.py	2009-12-01 10:00:36 +0000
> @@ -24,6 +24,8 @@
>  from canonical.database.sqlbase import SQLBase, sqlvalues
>  from canonical.launchpad.webapp.interfaces import NotFoundError
>  from lp.buildmaster.interfaces.buildfarmjob import BuildFarmJobType
> +from lp.buildmaster.interfaces.buildfarmjobbehavior import (
> +    IBuildFarmJobBehavior)
>  from lp.services.job.interfaces.job import JobStatus
>  from lp.services.job.model.job import Job
>  from lp.soyuz.interfaces.build import BuildStatus, IBuildSet
> @@ -49,6 +51,11 @@
>      estimated_duration = IntervalCol()
>  
>      @property
> +    def required_build_behavior(self):
> +        """See `IBuildQueue`."""
> +        return IBuildFarmJobBehavior(self.specific_job)
> +
> +    @property
>      def specific_job(self):
>          """See `IBuildQueue`."""
>          store = getUtility(IStoreSelector).get(MAIN_STORE, DEFAULT_FLAVOR)
> 
> === modified file 'lib/lp/soyuz/tests/test_builder.py'
> --- lib/lp/soyuz/tests/test_builder.py	2009-11-13 16:37:05 +0000
> +++ lib/lp/soyuz/tests/test_builder.py	2009-12-01 10:00:36 +0000
> @@ -8,10 +8,15 @@
>  from zope.component import getUtility
>  
>  from canonical.testing import LaunchpadZopelessLayer
> +from lp.buildmaster.interfaces.buildfarmjobbehavior import (
> +    BuildBehaviorMismatch, IBuildFarmJobBehavior)
> +from lp.buildmaster.model.buildfarmjobbehavior import IdleBuildBehavior
>  from lp.soyuz.interfaces.archive import ArchivePurpose
>  from lp.soyuz.interfaces.build import BuildStatus, IBuildSet
>  from lp.soyuz.interfaces.builder import IBuilderSet
>  from lp.soyuz.interfaces.publishing import PackagePublishingStatus
> +from lp.soyuz.model.binarypackagebuildbehavior import (
> +    BinaryPackageBuildBehavior)
>  from lp.soyuz.tests.test_publishing import SoyuzTestPublisher
>  from lp.testing import TestCaseWithFactory
>  
> @@ -214,5 +219,72 @@
>          self.failUnlessEqual('primary', build.archive.name)
>          self.failUnlessEqual('firefox', build.sourcepackagerelease.name)
>  
> +
> +class TestCurrentBuildBehavior(TestCaseWithFactory):
> +    """
> +    This test ensures the get/set behavior of Builder.current_build_behavior.

Docstring should start on a new line.

> +    """
> +
> +    layer = LaunchpadZopelessLayer
> +
> +    def setUp(self):
> +        """Create a new builder ready for testing."""
> +        super(TestCurrentBuildBehavior, self).setUp()
> +        self.builder = self.factory.makeBuilder(name='builder')
> +        
> +        # Have a publisher and a ppa handy for some of the tests below.
> +        self.publisher = SoyuzTestPublisher()
> +        self.publisher.prepareBreezyAutotest()
> +        self.ppa_joe = self.factory.makeArchive(name="joesppa")
> +
> +        self.build = self.publisher.getPubSource(
> +            sourcename="gedit", status=PackagePublishingStatus.PUBLISHED,
> +            archive=self.ppa_joe).createMissingBuilds()[0]
> +
> +        self.buildfarmjob = self.build.buildqueue_record.specific_job
> +
> +    def test_idle_behavior_when_no_current_build(self):
> +        """
> +        We return an idle behavior when there is no behavior specified
> +        nor a current build.

Same here.

> +        """
> +        self.assertIsInstance(
> +            self.builder.current_build_behavior, IdleBuildBehavior)
> +
> +    def test_set_behavior_when_no_current_job(self):
> +        """If a builder is idle then it is possible to set the behavior."""
> +        self.builder.current_build_behavior = IBuildFarmJobBehavior(
> +            self.buildfarmjob) 
> +
> +        self.assertIsInstance(
> +            self.builder.current_build_behavior, BinaryPackageBuildBehavior)
> +
> +    def test_current_job_behavior(self):
> +        """The current behavior is set automatically from the current job."""
> +        # Set the builder attribute on the buildqueue record so that our
> +        # builder will think it has a current build.
> +        self.build.buildqueue_record.builder = self.builder
> +
> +        self.assertIsInstance(
> +            self.builder.current_build_behavior, BinaryPackageBuildBehavior)
> +
> +    def test_set_behavior_when_current_job(self):
> +        """
> +        If a builder has a current job then it's behavior cannot be
> +        set.

Same here.

> +        """
> +        self.build.buildqueue_record.builder = self.builder
> +
> +        # As we can't use assertRaises for a property, we use a try-except
> +        # instead.
> +        assertion_raised = False
> +        try:
> +            self.builder.current_build_behavior = IBuildFarmJobBehavior(
> +                self.buildfarmjob) 
> +        except BuildBehaviorMismatch, e:
> +            assertion_raised = True
> +
> +        self.failUnless(assertion_raised)
> +
>  def test_suite():
>      return unittest.TestLoader().loadTestsFromName(__name__)
>

review: Approve (code)

Revision history for this message

Michael Nelson (michael.nelson) wrote on 2009-12-01:

Download full text (21.3 KiB)

On Tue, Dec 1, 2009 at 4:30 PM, Graham Binns <email address hidden> wrote:

> Review: Approve code
>
> Hi Michael,
>
> Nice branch. Good work. I've got some stylistic nitpicks - our
> guidelines gleefully discard PEP8, hurrah - and I'd like you to do a
>

gah, I'd thought I was cleaning up old code (too much lazrjs lately).

> strip-trailing-whitespace run on the files you've changed (there's not
> much, but enough for me to notice).
>
>
Sorry - switched editors recently and forgot to setup tailing whitespace
removal. I've updated my .rc file to automatically delete trailing spaces
and fixed all the files. Thanks.

> Other than that, r=me.
>
> > === added file 'lib/lp/buildmaster/interfaces/buildfarmjobbehavior.py'
> > --- lib/lp/buildmaster/interfaces/buildfarmjobbehavior.py 1970-01-01
> 00:00:00 +0000
> > +++ lib/lp/buildmaster/interfaces/buildfarmjobbehavior.py 2009-12-01
> 10:00:36 +0000
> > @@ -0,0 +1,38 @@
> > +# Copyright 2009 Canonical Ltd. This software is licensed under the
> > +# GNU Affero General Public License version 3 (see the file LICENSE).
> > +
> > +# pylint: disable-msg=E0211,E0213
> > +
> > +"""Interface for build farm job behaviors."""
> > +
> > +__metaclass__ = type
> > +
> > +__all__ = [
> > + 'IBuildFarmJobBehavior',
> > + ]
> > +
> > +from zope.interface import Interface
> > +
> > +
> > +class BuildBehaviorMismatch(Exception):
> > + """
> > + A general exception that can be raised when the builder's current
> behavior
> > + does not match the expected behavior.
> > + """
> > +
> > +
> > +class IBuildFarmJobBehavior(Interface):
> > +
> > + def set_builder(builder):
> > + """Sets the associated builder reference for this instance."""
> > +
> > + def log_start_build(build_queue_item, logger):
> > + """Log the start of a specific build queue item.
> > +
> > + The form of the log message will vary depending on the type of
> build.
> > + :param build_queue_item: A BuildQueueItem to build.
> > + :param logger: A logger to be used to log diagnostic
> information.
> > + """
> > + # A number of other methods to go here that can be customised for
> each of
> > + # the different build types (branch build, recipe build, translation
> > + # build etc.)
> >
> > === added file 'lib/lp/buildmaster/model/buildfarmjobbehavior.py'
> > --- lib/lp/buildmaster/model/buildfarmjobbehavior.py 1970-01-01 00:00:00
> +0000
> > +++ lib/lp/buildmaster/model/buildfarmjobbehavior.py 2009-12-01 10:00:36
> +0000
> > @@ -0,0 +1,53 @@
> > +# Copyright 2009 Canonical Ltd. This software is licensed under the
> > +# GNU Affero General Public License version 3 (see the file LICENSE).
> > +
> > +# pylint: disable-msg=E0211,E0213
> > +
> > +"""Base and idle BuildFarmJobBehavior classes."""
> > +
> > +__metaclass__ = type
> > +
> > +__all__ = [
> > + 'BuildFarmJobBehaviorBase',
> > + 'IdleBuildBehavior'
> > + ]
> > +
> > +from zope.interface import implements
> > +
> > +from lp.buildmaster.interfaces.buildfarmjobbehavior import (
> > + BuildBehaviorMismatch, IBuildFarmJobBehavior)
> > +
> > +
> > +class BuildFarmJobBehaviorBase:
> > + """Ensures that all ...

On Tue, Dec 1, 2009 at 4:30 PM, Graham Binns <graham@canonical.com> wrote:

> Review: Approve code
>
> Hi Michael,
>
> Nice branch. Good work. I've got some stylistic nitpicks - our
> guidelines gleefully discard PEP8, hurrah - and I'd like you to do a
>

gah, I'd thought I was cleaning up old code (too much lazrjs lately).

> Other than that, r=me.
>
> > === added file 'lib/lp/buildmaster/interfaces/buildfarmjobbehavior.py'
> > --- lib/lp/buildmaster/interfaces/buildfarmjobbehavior.py     1970-01-01
> 00:00:00 +0000
> > +++ lib/lp/buildmaster/interfaces/buildfarmjobbehavior.py     2009-12-01
> 10:00:36 +0000
> > @@ -0,0 +1,38 @@
> > +# Copyright 2009 Canonical Ltd.  This software is licensed under the
> > +# GNU Affero General Public License version 3 (see the file LICENSE).
> > +
> > +# pylint: disable-msg=E0211,E0213
> > +
> > +"""Interface for build farm job behaviors."""
> > +
> > +__metaclass__ = type
> > +
> > +__all__ = [
> > +    'IBuildFarmJobBehavior',
> > +    ]
> > +
> > +from zope.interface import Interface
> > +
> > +
> > +class BuildBehaviorMismatch(Exception):
> > +    """
> > +    A general exception that can be raised when the builder's current
> behavior
> > +    does not match the expected behavior.
> > +    """
> > +
> > +
> > +class IBuildFarmJobBehavior(Interface):
> > +
> > +    def set_builder(builder):
> > +        """Sets the associated builder reference for this instance."""
> > +
> > +    def log_start_build(build_queue_item, logger):
> > +        """Log the start of a specific build queue item.
> > +
> > +        The form of the log message will vary depending on the type of
> build.
> > +        :param build_queue_item: A BuildQueueItem to build.
> > +        :param logger: A logger to be used to log diagnostic
> information.
> > +        """
> > +    # A number of other methods to go here that can be customised for
> each of
> > +    # the different build types (branch build, recipe build, translation
> > +    # build etc.)
> >
> > === added file 'lib/lp/buildmaster/model/buildfarmjobbehavior.py'
> > --- lib/lp/buildmaster/model/buildfarmjobbehavior.py  1970-01-01 00:00:00
> +0000
> > +++ lib/lp/buildmaster/model/buildfarmjobbehavior.py  2009-12-01 10:00:36
> +0000
> > @@ -0,0 +1,53 @@
> > +# Copyright 2009 Canonical Ltd.  This software is licensed under the
> > +# GNU Affero General Public License version 3 (see the file LICENSE).
> > +
> > +# pylint: disable-msg=E0211,E0213
> > +
> > +"""Base and idle BuildFarmJobBehavior classes."""
> > +
> > +__metaclass__ = type
> > +
> > +__all__ = [
> > +    'BuildFarmJobBehaviorBase',
> > +    'IdleBuildBehavior'
> > +    ]
> > +
> > +from zope.interface import implements
> > +
> > +from lp.buildmaster.interfaces.buildfarmjobbehavior import (
> > +    BuildBehaviorMismatch, IBuildFarmJobBehavior)
> > +
> > +
> > +class BuildFarmJobBehaviorBase:
> > +    """Ensures that all behaviors inherit the same initialisation.
> > +
> > +    All build-farm job behaviors should inherit from this.
> > +    """
> > +
> > +    def __init__(self, buildfarmjob):
> > +        """
> > +        Store a reference to the job_type with which we were created.
> > +        """
> > +        self.buildfarmjob = buildfarmjob
> > +        self._builder = None
> > +
> > +    def set_builder(self, builder):
>
> This should be setBuilder(), because who needs PEP8?
>

Done.

>
> > +        """The builder should be set once and not changed."""
> > +        self._builder = builder
> > +
> > +
> > +class IdleBuildBehavior(BuildFarmJobBehaviorBase):
> > +
> > +    implements(IBuildFarmJobBehavior)
> > +
> > +    def __init__(self):
> > +        """
>
> According to our coding standards the docstring should start on the same
> line as the opening """.
>

Right. I'd assumed that if it was too long for the first line then it should
start on the following line. Updated.

>
> > +        The idle behavior is special in that a buildfarmjob is not
> specified
> > +        during initialisation.
> > +        """
> > +        super(IdleBuildBehavior, self).__init__(None)
> > +
> > +    def logStartBuild(self, build_queue_item, logger):
> > +        """See `IBuildFarmJobBehavior`."""
> > +        raise BuildBehaviorMismatch(
> > +            "Builder was idle when asked to log the start of a build.")
> >
> > === modified file 'lib/lp/soyuz/configure.zcml'
> > --- lib/lp/soyuz/configure.zcml       2009-11-16 22:06:14 +0000
> > +++ lib/lp/soyuz/configure.zcml       2009-12-01 10:00:36 +0000
> > @@ -892,4 +892,11 @@
> >
>  interface="lp.soyuz.interfaces.buildpackagejob.IBuildPackageJob"/>
> >      </class>
> >
> > +    
> > +    <adapter
> > +        for="lp.soyuz.interfaces.buildpackagejob.IBuildPackageJob"
> > +
>  provides="lp.buildmaster.interfaces.buildfarmjobbehavior.IBuildFarmJobBehavior"
> > +
>  factory="lp.soyuz.model.binarypackagebuildbehavior.BinaryPackageBuildBehavior"
> > +        permission="zope.Public" />
> > +
> >  </configure>
> >
> > === modified file 'lib/lp/soyuz/doc/builder.txt'
> > --- lib/lp/soyuz/doc/builder.txt      2009-11-12 12:52:23 +0000
> > +++ lib/lp/soyuz/doc/builder.txt      2009-12-01 10:00:36 +0000
> > @@ -40,6 +40,18 @@
> >      >>> builder.builderok = True
> >      >>> builder.failnotes = None
> >
> > +A builder provides a current_build_behavior attribute to which all the
> > +build-type specific behavior for the current build is delegated. For
> > +our sample data, the behavior is specifically a behavior for dealing
> > +with binary packages
> > +
> > +    >>> from zope.security.proxy import isinstance
> > +    >>> from lp.soyuz.model.binarypackagebuildbehavior import (
> > +    ...     BinaryPackageBuildBehavior)
> > +    >>> isinstance(
> > +    ...     builder.current_build_behavior, BinaryPackageBuildBehavior)
> > +    True
> > +
> >  In case of copy archives the status string will show both the copy
> >  archive owner as well as the copy archive name.
> >
> >
> > === modified file 'lib/lp/soyuz/doc/buildqueue.txt'
> > --- lib/lp/soyuz/doc/buildqueue.txt   2009-11-13 19:34:17 +0000
> > +++ lib/lp/soyuz/doc/buildqueue.txt   2009-12-01 10:00:36 +0000
> > @@ -98,6 +98,16 @@
> >      (True, 1000)
> >
> >
> > +The BuildQueue item is responsible for providing the required build
> behavior
> > +for the item.
> > +
> > +    >>> from zope.security.proxy import isinstance
> > +    >>> from lp.soyuz.model.binarypackagebuildbehavior import (
> > +    ...     BinaryPackageBuildBehavior)
> > +    >>> isinstance(bq.required_build_behavior,
> BinaryPackageBuildBehavior)
> > +    True
> > +
> > +
> >  == Dispatching and Reseting jobs ==
> >
> >  The sampledata contains an active job, being built by the 'bob'
> >
> > === modified file 'lib/lp/soyuz/interfaces/builder.py'
> > --- lib/lp/soyuz/interfaces/builder.py        2009-11-20 18:06:28 +0000
> > +++ lib/lp/soyuz/interfaces/builder.py        2009-12-01 10:00:36 +0000
> > @@ -19,11 +19,13 @@
> >      ]
> >
> >  from zope.interface import Interface, Attribute
> > -from zope.schema import Choice, TextLine, Text, Bool
> > +from zope.schema import Bool, Choice, Field, Text, TextLine
> >
> >  from canonical.launchpad import _
> >  from canonical.launchpad.fields import Title, Description
> >  from lp.registry.interfaces.role import IHasOwner
> > +from lp.buildmaster.interfaces.buildfarmjobbehavior import (
> > +    IBuildFarmJobBehavior)
> >  from canonical.launchpad.validators.name import name_validator
> >  from canonical.launchpad.validators.url import builder_url_validator
> >
> > @@ -57,7 +59,7 @@
> >      """The build slave has suffered an error and cannot be used."""
> >
> >
> > -class IBuilder(IHasOwner):
> > +class IBuilder(IHasOwner, IBuildFarmJobBehavior):
> >      """Build-slave information and state.
> >
> >      Builder instance represents a single builder slave machine within
> the
> > @@ -138,6 +140,10 @@
> >                  "new jobs. "),
> >          required=False)
> >
> > +    current_build_behavior = Field(
> > +        title=u"The current behavior of the builder for the current
> job.",
> > +        required=False)
> > +
> >      def cacheFileOnSlave(logger, libraryfilealias):
> >          """Ask the slave to cache a librarian file to its local disk.
> >
> >
> > === modified file 'lib/lp/soyuz/interfaces/buildqueue.py'
> > --- lib/lp/soyuz/interfaces/buildqueue.py     2009-11-20 18:06:28 +0000
> > +++ lib/lp/soyuz/interfaces/buildqueue.py     2009-12-01 10:00:36 +0000
> > @@ -13,7 +13,7 @@
> >      ]
> >
> >  from zope.interface import Interface, Attribute
> > -from zope.schema import Choice, Datetime, Timedelta
> > +from zope.schema import Choice, Datetime, Field, Timedelta
> >
> >  from lazr.restful.fields import Reference
> >
> > @@ -51,6 +51,10 @@
> >          title=_('Job type'), required=True, vocabulary=BuildFarmJobType,
> >          description=_("The type of this job."))
> >
> > +    required_build_behavior = Field(
> > +        title=_('The builder behavior required to run this job.'),
> > +        required=False, readonly=True)
> > +
> >      estimated_duration = Timedelta(
> >          title=_("Estimated Job Duration"), required=True,
> >          description=_("Estimated job duration interval."))
> >
> > === added file 'lib/lp/soyuz/model/binarypackagebuildbehavior.py'
> > --- lib/lp/soyuz/model/binarypackagebuildbehavior.py  1970-01-01 00:00:00
> +0000
> > +++ lib/lp/soyuz/model/binarypackagebuildbehavior.py  2009-12-01 10:00:36
> +0000
> > @@ -0,0 +1,35 @@
> > +# Copyright 2009 Canonical Ltd.  This software is licensed under the
> > +# GNU Affero General Public License version 3 (see the file LICENSE).
> > +
> > +# pylint: disable-msg=E0211,E0213
> > +
> > +"""Builder behavior for binary package builds."""
> > +
> > +__metaclass__ = type
> > +
> > +__all__ = [
> > +    'BinaryPackageBuildBehavior',
> > +    ]
> > +
> > +from lp.buildmaster.interfaces.buildfarmjobbehavior import (
> > +    IBuildFarmJobBehavior)
> > +from lp.buildmaster.model.buildfarmjobbehavior import (
> > +    BuildFarmJobBehaviorBase)
> > +from lp.soyuz.interfaces.build import IBuildSet
> > +
> > +from zope.component import getUtility
> > +from zope.interface import implements
> > +
> > +
> > +class BinaryPackageBuildBehavior(BuildFarmJobBehaviorBase):
> > +    """Define the behavior of binary package builds."""
> > +
> > +    implements(IBuildFarmJobBehavior)
> > +
> > +    def log_start_build(self, build_queue_item, logger):
> > +        """See `IBuildFarmJobBehavior`."""
> > +        build = getUtility(IBuildSet).getByQueueEntry(build_queue_item)
> > +        spr = build.sourcepackagerelease
> > +
> > +        logger.info("startBuild(%s, %s, %s, %s)", self._builder.url,
> > +                    spr.name, spr.version, build.pocket.title)
> >
> > === modified file 'lib/lp/soyuz/model/builder.py'
> > --- lib/lp/soyuz/model/builder.py     2009-11-20 18:06:28 +0000
> > +++ lib/lp/soyuz/model/builder.py     2009-12-01 10:00:36 +0000
> > @@ -20,6 +20,8 @@
> >  import urllib2
> >  import xmlrpclib
> >
> > +from lazr.delegates import delegates
> > +
> >  from zope.interface import implements
> >  from zope.component import getUtility
> >
> > @@ -31,7 +33,10 @@
> >  from canonical.cachedproperty import cachedproperty
> >  from canonical.config import config
> >  from canonical.buildd.slave import BuilderStatus
> > +from lp.buildmaster.interfaces.buildfarmjobbehavior import (
> > +    BuildBehaviorMismatch, IBuildFarmJobBehavior)
> >  from lp.buildmaster.master import BuilddMaster
> > +from lp.buildmaster.model.buildfarmjobbehavior import IdleBuildBehavior
> >  from canonical.database.sqlbase import SQLBase, sqlvalues
> >  from lp.soyuz.adapters.archivedependencies import (
> >      get_primary_current_component, get_sources_list_for_building)
> > @@ -54,6 +59,7 @@
> >      PackagePublishingStatus)
> >  from lp.soyuz.model.buildpackagejob import BuildPackageJob
> >  from canonical.launchpad.webapp import urlappend
> > +from canonical.lazr.utils import safe_hasattr
> >  from canonical.librarian.utils import copy_and_close
> >
> >
> > @@ -114,6 +120,7 @@
> >  class Builder(SQLBase):
> >
> >      implements(IBuilder, IHasBuildRecords)
> > +    delegates(IBuildFarmJobBehavior, context="current_build_behavior")
> >      _table = 'Builder'
> >
> >      _defaultOrder = ['id']
> > @@ -135,6 +142,51 @@
> >      vm_host = StringCol(dbName='vm_host')
> >      active = BoolCol(dbName='active', notNull=True, default=True)
> >
> > +    def _get_current_build_behavior(self):
>
> Should be _getCurrentBuildBehavior(). Yes, I know it's hateful, but
> them's the guidelines.
>

Done.

>
> > +        """Return the current build behavior."""
> > +        if not safe_hasattr(self, '_current_build_behavior'):
> > +            self._current_build_behavior = None
> > +
> > +        if (self._current_build_behavior is None or
> > +            isinstance(self._current_build_behavior,
> IdleBuildBehavior)):
> > +            # If we don't currently have a current build behavior set,
> > +            # or we are currently idle, then...
> > +            currentjob = self.currentjob
> > +            if currentjob is not None:
> > +                # ...we'll set it based on our current job.
> > +                self._current_build_behavior = (
> > +                    currentjob.required_build_behavior)
> > +                self._current_build_behavior.set_builder(self)
> > +                return self._current_build_behavior
> > +            elif self._current_build_behavior is None:
> > +                # If we don't have a current job or an idle behavior
> > +                # already set, then we just set the idle behavior
> > +                # before returning.
> > +                self._current_build_behavior = IdleBuildBehavior()
> > +            return self._current_build_behavior
> > +
> > +        else:
> > +            # We did have a current non-idle build behavior set, so
> > +            # we just return it.
> > +            return self._current_build_behavior
> > +
> > +
> > +    def _set_current_build_behavior(self, new_behavior):
>
> _setCurrentBuildBehavior().
>
>
Done.

> > +        """Set the current build behavior."""
> > +
> > +        if self.currentjob is not None:
> > +            # We do not allow the current build behavior to be reset if
> we
> > +            # have a current job.
> > +            raise BuildBehaviorMismatch(
> > +                "Attempt to reset builder behavior while a current build
> "
> > +                "exists.")
> > +        else:
> > +            self._current_build_behavior = new_behavior
> > +            self._current_build_behavior.set_builder(self)
> > +
> > +    current_build_behavior = property(
> > +        _get_current_build_behavior, _set_current_build_behavior)
> > +
> >      def cacheFileOnSlave(self, logger, libraryfilealias):
> >          """See `IBuilder`."""
> >          url = libraryfilealias.http_url
> > @@ -351,10 +403,9 @@
> >
> >      def startBuild(self, build_queue_item, logger):
> >          """See IBuilder."""
> > -        build = getUtility(IBuildSet).getByQueueEntry(build_queue_item)
> > -        spr = build.sourcepackagerelease
> > -        logger.info("startBuild(%s, %s, %s, %s)", self.url,
> > -                    spr.name, spr.version, build.pocket.title)
> > +        # Set the build behavior depending on the provided build queue
> item.
> > +        self.current_build_behavior =
> build_queue_item.required_build_behavior
> > +        self.log_start_build(build_queue_item, logger)
> >
> >          # Make sure the request is valid; an exception is raised if it's
> not.
> >          self._verifyBuildRequest(build_queue_item, logger)
> >
> > === modified file 'lib/lp/soyuz/model/buildqueue.py'
> > --- lib/lp/soyuz/model/buildqueue.py  2009-11-20 18:06:28 +0000
> > +++ lib/lp/soyuz/model/buildqueue.py  2009-12-01 10:00:36 +0000
> > @@ -24,6 +24,8 @@
> >  from canonical.database.sqlbase import SQLBase, sqlvalues
> >  from canonical.launchpad.webapp.interfaces import NotFoundError
> >  from lp.buildmaster.interfaces.buildfarmjob import BuildFarmJobType
> > +from lp.buildmaster.interfaces.buildfarmjobbehavior import (
> > +    IBuildFarmJobBehavior)
> >  from lp.services.job.interfaces.job import JobStatus
> >  from lp.services.job.model.job import Job
> >  from lp.soyuz.interfaces.build import BuildStatus, IBuildSet
> > @@ -49,6 +51,11 @@
> >      estimated_duration = IntervalCol()
> >
> >      @property
> > +    def required_build_behavior(self):
> > +        """See `IBuildQueue`."""
> > +        return IBuildFarmJobBehavior(self.specific_job)
> > +
> > +    @property
> >      def specific_job(self):
> >          """See `IBuildQueue`."""
> >          store = getUtility(IStoreSelector).get(MAIN_STORE,
> DEFAULT_FLAVOR)
> >
> > === modified file 'lib/lp/soyuz/tests/test_builder.py'
> > --- lib/lp/soyuz/tests/test_builder.py        2009-11-13 16:37:05 +0000
> > +++ lib/lp/soyuz/tests/test_builder.py        2009-12-01 10:00:36 +0000
> > @@ -8,10 +8,15 @@
> >  from zope.component import getUtility
> >
> >  from canonical.testing import LaunchpadZopelessLayer
> > +from lp.buildmaster.interfaces.buildfarmjobbehavior import (
> > +    BuildBehaviorMismatch, IBuildFarmJobBehavior)
> > +from lp.buildmaster.model.buildfarmjobbehavior import IdleBuildBehavior
> >  from lp.soyuz.interfaces.archive import ArchivePurpose
> >  from lp.soyuz.interfaces.build import BuildStatus, IBuildSet
> >  from lp.soyuz.interfaces.builder import IBuilderSet
> >  from lp.soyuz.interfaces.publishing import PackagePublishingStatus
> > +from lp.soyuz.model.binarypackagebuildbehavior import (
> > +    BinaryPackageBuildBehavior)
> >  from lp.soyuz.tests.test_publishing import SoyuzTestPublisher
> >  from lp.testing import TestCaseWithFactory
> >
> > @@ -214,5 +219,72 @@
> >          self.failUnlessEqual('primary', build.archive.name)
> >          self.failUnlessEqual('firefox', build.sourcepackagerelease.name
> )
> >
> > +
> > +class TestCurrentBuildBehavior(TestCaseWithFactory):
> > +    """
> > +    This test ensures the get/set behavior of
> Builder.current_build_behavior.
>
> Docstring should start on a new line.
>
>
Done.

> > +    """
> > +
> > +    layer = LaunchpadZopelessLayer
> > +
> > +    def setUp(self):
> > +        """Create a new builder ready for testing."""
> > +        super(TestCurrentBuildBehavior, self).setUp()
> > +        self.builder = self.factory.makeBuilder(name='builder')
> > +
> > +        # Have a publisher and a ppa handy for some of the tests below.
> > +        self.publisher = SoyuzTestPublisher()
> > +        self.publisher.prepareBreezyAutotest()
> > +        self.ppa_joe = self.factory.makeArchive(name="joesppa")
> > +
> > +        self.build = self.publisher.getPubSource(
> > +            sourcename="gedit",
> status=PackagePublishingStatus.PUBLISHED,
> > +            archive=self.ppa_joe).createMissingBuilds()[0]
> > +
> > +        self.buildfarmjob = self.build.buildqueue_record.specific_job
> > +
> > +    def test_idle_behavior_when_no_current_build(self):
> > +        """
> > +        We return an idle behavior when there is no behavior specified
> > +        nor a current build.
>
> Same here.
>

Done.

>
> > +        """
> > +        self.assertIsInstance(
> > +            self.builder.current_build_behavior, IdleBuildBehavior)
> > +
> > +    def test_set_behavior_when_no_current_job(self):
> > +        """If a builder is idle then it is possible to set the
> behavior."""
> > +        self.builder.current_build_behavior = IBuildFarmJobBehavior(
> > +            self.buildfarmjob)
> > +
> > +        self.assertIsInstance(
> > +            self.builder.current_build_behavior,
> BinaryPackageBuildBehavior)
> > +
> > +    def test_current_job_behavior(self):
> > +        """The current behavior is set automatically from the current
> job."""
> > +        # Set the builder attribute on the buildqueue record so that our
> > +        # builder will think it has a current build.
> > +        self.build.buildqueue_record.builder = self.builder
> > +
> > +        self.assertIsInstance(
> > +            self.builder.current_build_behavior,
> BinaryPackageBuildBehavior)
> > +
> > +    def test_set_behavior_when_current_job(self):
> > +        """
> > +        If a builder has a current job then it's behavior cannot be
> > +        set.
>
>
> Same here.
>

And done.

>
> > +        """
> > +        self.build.buildqueue_record.builder = self.builder
> > +
> > +        # As we can't use assertRaises for a property, we use a
> try-except
> > +        # instead.
> > +        assertion_raised = False
> > +        try:
> > +            self.builder.current_build_behavior = IBuildFarmJobBehavior(
> > +                self.buildfarmjob)
> > +        except BuildBehaviorMismatch, e:
> > +            assertion_raised = True
> > +
> > +        self.failUnless(assertion_raised)
> > +
> >  def test_suite():
> >      return unittest.TestLoader().loadTestsFromName(__name__)
> >
>
>

Thanks Graham. Diff attached.

> --
>
> https://code.edge.launchpad.net/~michael.nelson/launchpad/487009-db-generalise-ibuilder-1b/+merge/15477<https://code.edge.launchpad.net/%7Emichael.nelson/launchpad/487009-db-generalise-ibuilder-1b/+merge/15477>
> Your team Launchpad code reviewers from Canonical is subscribed to branch
> lp:launchpad.
>
> --
> launchpad-reviews mailing list
> launchpad-reviews@lists.canonical.com
> https://lists.ubuntu.com/mailman/listinfo/launchpad-reviews
>

changes_gmb.diff

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk

Subscribers

People subscribed via source and target branches

to all changes:

Celso Providelo

Colin Watson

Launchpad code reviewers from Canonical

Mantavya Gajjar (Open ERP)

Michael Nelson

Stuart Bishop

William Grant

to status/vote changes:

Tomi Karjalainen

1	=== modified file 'lib/lp/buildmaster/interfaces/buildfarmjobbehavior.py'
2	--- lib/lp/buildmaster/interfaces/buildfarmjobbehavior.py 2009-11-27 13:50:29 +0000
3	+++ lib/lp/buildmaster/interfaces/buildfarmjobbehavior.py 2009-12-01 16:40:02 +0000
4	@@ -23,10 +23,10 @@
5
6	class IBuildFarmJobBehavior(Interface):
7
8	- def set_builder(builder):
9	+ def setBuilder(builder):
10	"""Sets the associated builder reference for this instance."""
11
12	- def log_start_build(build_queue_item, logger):
13	+ def logStartBuild(build_queue_item, logger):
14	"""Log the start of a specific build queue item.
15
16	The form of the log message will vary depending on the type of build.
17
18	=== modified file 'lib/lp/buildmaster/model/buildfarmjobbehavior.py'
19	--- lib/lp/buildmaster/model/buildfarmjobbehavior.py 2009-12-01 09:43:41 +0000
20	+++ lib/lp/buildmaster/model/buildfarmjobbehavior.py 2009-12-01 16:38:56 +0000
21	@@ -25,13 +25,11 @@
22	"""
23
24	def __init__(self, buildfarmjob):
25	- """
26	- Store a reference to the job_type with which we were created.
27	- """
28	+ """Store a reference to the job_type with which we were created."""
29	self.buildfarmjob = buildfarmjob
30	self._builder = None
31
32	- def set_builder(self, builder):
33	+ def setBuilder(self, builder):
34	"""The builder should be set once and not changed."""
35	self._builder = builder
36
37	@@ -41,9 +39,8 @@
38	implements(IBuildFarmJobBehavior)
39
40	def __init__(self):
41	- """
42	- The idle behavior is special in that a buildfarmjob is not specified
43	- during initialisation.
44	+ """The idle behavior is special in that a buildfarmjob is not
45	+ specified during initialisation.
46	"""
47	super(IdleBuildBehavior, self).__init__(None)
48
49
50	=== modified file 'lib/lp/soyuz/model/binarypackagebuildbehavior.py'
51	--- lib/lp/soyuz/model/binarypackagebuildbehavior.py 2009-12-01 09:02:14 +0000
52	+++ lib/lp/soyuz/model/binarypackagebuildbehavior.py 2009-12-01 16:39:48 +0000
53	@@ -26,8 +26,8 @@
54
55	implements(IBuildFarmJobBehavior)
56
57	- def log_start_build(self, build_queue_item, logger):
58	- """See `IBuildFarmJobBehavior`."""
59	+ def logStartBuild(self, build_queue_item, logger):
60	+ """See `IBuildFarmJobBehavior`."""
61	build = getUtility(IBuildSet).getByQueueEntry(build_queue_item)
62	spr = build.sourcepackagerelease
63
64
65	=== modified file 'lib/lp/soyuz/model/builder.py'
66	--- lib/lp/soyuz/model/builder.py 2009-12-01 09:38:05 +0000
67	+++ lib/lp/soyuz/model/builder.py 2009-12-01 16:37:20 +0000
68	@@ -142,7 +142,7 @@
69	vm_host = StringCol(dbName='vm_host')
70	active = BoolCol(dbName='active', notNull=True, default=True)
71
72	- def _get_current_build_behavior(self):
73	+ def _getCurrentBuildBehavior(self):
74	"""Return the current build behavior."""
75	if not safe_hasattr(self, '_current_build_behavior'):
76	self._current_build_behavior = None
77	@@ -156,14 +156,14 @@
78	# ...we'll set it based on our current job.
79	self._current_build_behavior = (
80	currentjob.required_build_behavior)
81	- self._current_build_behavior.set_builder(self)
82	+ self._current_build_behavior.setBuilder(self)
83	return self._current_build_behavior
84	elif self._current_build_behavior is None:
85	# If we don't have a current job or an idle behavior
86	# already set, then we just set the idle behavior
87	# before returning.
88	self._current_build_behavior = IdleBuildBehavior()
89	- return self._current_build_behavior
90	+ return self._current_build_behavior
91
92	else:
93	# We did have a current non-idle build behavior set, so
94	@@ -171,7 +171,7 @@
95	return self._current_build_behavior
96
97
98	- def _set_current_build_behavior(self, new_behavior):
99	+ def _setCurrentBuildBehavior(self, new_behavior):
100	"""Set the current build behavior."""
101
102	if self.currentjob is not None:
103	@@ -182,10 +182,10 @@
104	"exists.")
105	else:
106	self._current_build_behavior = new_behavior
107	- self._current_build_behavior.set_builder(self)
108	+ self._current_build_behavior.setBuilder(self)
109
110	current_build_behavior = property(
111	- _get_current_build_behavior, _set_current_build_behavior)
112	+ _getCurrentBuildBehavior, _setCurrentBuildBehavior)
113
114	def cacheFileOnSlave(self, logger, libraryfilealias):
115	"""See `IBuilder`."""
116	@@ -403,9 +403,9 @@
117
118	def startBuild(self, build_queue_item, logger):
119	"""See IBuilder."""
120	- # Set the build behavior depending on the provided build queue item.
121	+ # Set the build behavior depending on the provided build queue item.
122	self.current_build_behavior = build_queue_item.required_build_behavior
123	- self.log_start_build(build_queue_item, logger)
124	+ self.logStartBuild(build_queue_item, logger)
125
126	# Make sure the request is valid; an exception is raised if it's not.
127	self._verifyBuildRequest(build_queue_item, logger)
128
129	=== modified file 'lib/lp/soyuz/tests/test_builder.py'
130	--- lib/lp/soyuz/tests/test_builder.py 2009-12-01 09:43:41 +0000
131	+++ lib/lp/soyuz/tests/test_builder.py 2009-12-01 16:39:29 +0000
132	@@ -221,8 +221,8 @@
133
134
135	class TestCurrentBuildBehavior(TestCaseWithFactory):
136	- """
137	- This test ensures the get/set behavior of Builder.current_build_behavior.
138	+ """This test ensures the get/set behavior of IBuilder's
139	+ current_build_behavior property.
140	"""
141
142	layer = LaunchpadZopelessLayer
143	@@ -231,7 +231,7 @@
144	"""Create a new builder ready for testing."""
145	super(TestCurrentBuildBehavior, self).setUp()
146	self.builder = self.factory.makeBuilder(name='builder')
147	-
148	+
149	# Have a publisher and a ppa handy for some of the tests below.
150	self.publisher = SoyuzTestPublisher()
151	self.publisher.prepareBreezyAutotest()
152	@@ -244,8 +244,7 @@
153	self.buildfarmjob = self.build.buildqueue_record.specific_job
154
155	def test_idle_behavior_when_no_current_build(self):
156	- """
157	- We return an idle behavior when there is no behavior specified
158	+ """We return an idle behavior when there is no behavior specified
159	nor a current build.
160	"""
161	self.assertIsInstance(
162	@@ -254,7 +253,7 @@
163	def test_set_behavior_when_no_current_job(self):
164	"""If a builder is idle then it is possible to set the behavior."""
165	self.builder.current_build_behavior = IBuildFarmJobBehavior(
166	- self.buildfarmjob)
167	+ self.buildfarmjob)
168
169	self.assertIsInstance(
170	self.builder.current_build_behavior, BinaryPackageBuildBehavior)
171	@@ -269,9 +268,7 @@
172	self.builder.current_build_behavior, BinaryPackageBuildBehavior)
173
174	def test_set_behavior_when_current_job(self):
175	- """
176	- If a builder has a current job then it's behavior cannot be
177	- set.
178	+ """If a builder has a current job then it's behavior cannot be set.
179	"""
180	self.build.buildqueue_record.builder = self.builder
181
182	@@ -280,7 +277,7 @@
183	assertion_raised = False
184	try:
185	self.builder.current_build_behavior = IBuildFarmJobBehavior(
186	- self.buildfarmjob)
187	+ self.buildfarmjob)
188	except BuildBehaviorMismatch, e:
189	assertion_raised = True
190

Launchpad itself

Merge lp:~michael.nelson/launchpad/487009-db-generalise-ibuilder-1b into lp:launchpad/db-devel

Commit message

Description of the change

Preview Diff

Subscribers

 === added file 'lib/lp/buildmaster/interfaces/buildfarmjobbehavior.py'
 --- lib/lp/buildmaster/interfaces/buildfarmjobbehavior.py	1970-01-01 00:00:00 +0000
 +++ lib/lp/buildmaster/interfaces/buildfarmjobbehavior.py	2009-12-01 16:47:13 +0000
@@ -0,0 +1,38 @@
++# Copyright 2009 Canonical Ltd.  This software is licensed under the
++# GNU Affero General Public License version 3 (see the file LICENSE).
++
++# pylint: disable-msg=E0211,E0213
++
++"""Interface for build farm job behaviors."""
++
++__metaclass__ = type
++
++__all__ = [
++    'IBuildFarmJobBehavior',
++    ]
++
++from zope.interface import Interface
++
++
++class BuildBehaviorMismatch(Exception):
++    """
++    A general exception that can be raised when the builder's current behavior
++    does not match the expected behavior.
++    """
++
++
++class IBuildFarmJobBehavior(Interface):
++
++    def setBuilder(builder):
++        """Sets the associated builder reference for this instance."""
++
++    def logStartBuild(build_queue_item, logger):
++        """Log the start of a specific build queue item.
++
++        The form of the log message will vary depending on the type of build.
++        :param build_queue_item: A BuildQueueItem to build.
++        :param logger: A logger to be used to log diagnostic information.
++        """
++    # A number of other methods to go here that can be customised for each of
++    # the different build types (branch build, recipe build, translation
++    # build etc.)
 === added file 'lib/lp/buildmaster/model/buildfarmjobbehavior.py'
 --- lib/lp/buildmaster/model/buildfarmjobbehavior.py	1970-01-01 00:00:00 +0000
 +++ lib/lp/buildmaster/model/buildfarmjobbehavior.py	2009-12-01 16:47:13 +0000
@@ -0,0 +1,50 @@
++# Copyright 2009 Canonical Ltd.  This software is licensed under the
++# GNU Affero General Public License version 3 (see the file LICENSE).
++
++# pylint: disable-msg=E0211,E0213
++
++"""Base and idle BuildFarmJobBehavior classes."""
++
++__metaclass__ = type
++
++__all__ = [
++    'BuildFarmJobBehaviorBase',
++    'IdleBuildBehavior'
++    ]
++
++from zope.interface import implements
++
++from lp.buildmaster.interfaces.buildfarmjobbehavior import (
++    BuildBehaviorMismatch, IBuildFarmJobBehavior)
++
++
++class BuildFarmJobBehaviorBase:
++    """Ensures that all behaviors inherit the same initialisation.
++
++    All build-farm job behaviors should inherit from this.
++    """
++
++    def __init__(self, buildfarmjob):
++        """Store a reference to the job_type with which we were created."""
++        self.buildfarmjob = buildfarmjob
++        self._builder = None
++
++    def setBuilder(self, builder):
++        """The builder should be set once and not changed."""
++        self._builder = builder
++
++
++class IdleBuildBehavior(BuildFarmJobBehaviorBase):
++
++    implements(IBuildFarmJobBehavior)
++
++    def __init__(self):
++        """The idle behavior is special in that a buildfarmjob is not
++        specified during initialisation.
++        """
++        super(IdleBuildBehavior, self).__init__(None)
++
++    def logStartBuild(self, build_queue_item, logger):
++        """See `IBuildFarmJobBehavior`."""
++        raise BuildBehaviorMismatch(
++            "Builder was idle when asked to log the start of a build.")
 === modified file 'lib/lp/soyuz/configure.zcml'
 --- lib/lp/soyuz/configure.zcml	2009-11-16 22:06:14 +0000
 +++ lib/lp/soyuz/configure.zcml	2009-12-01 16:47:13 +0000
@@ -892,4 +892,11 @@
              interface="lp.soyuz.interfaces.buildpackagejob.IBuildPackageJob"/>
      </class>
++    <!-- BinaryPackageBuildBehavior -->
++    <adapter
++        for="lp.soyuz.interfaces.buildpackagejob.IBuildPackageJob"
++        provides="lp.buildmaster.interfaces.buildfarmjobbehavior.IBuildFarmJobBehavior"
++        factory="lp.soyuz.model.binarypackagebuildbehavior.BinaryPackageBuildBehavior"
++        permission="zope.Public" />
++
  </configure>
 === modified file 'lib/lp/soyuz/doc/builder.txt'
 --- lib/lp/soyuz/doc/builder.txt	2009-11-12 12:52:23 +0000
 +++ lib/lp/soyuz/doc/builder.txt	2009-12-01 16:47:13 +0000
@@ -40,6 +40,18 @@
      >>> builder.builderok = True
      >>> builder.failnotes = None
++A builder provides a current_build_behavior attribute to which all the
++build-type specific behavior for the current build is delegated. For
++our sample data, the behavior is specifically a behavior for dealing
++with binary packages
++
++    >>> from zope.security.proxy import isinstance
++    >>> from lp.soyuz.model.binarypackagebuildbehavior import (
++    ...     BinaryPackageBuildBehavior)
++    >>> isinstance(
++    ...     builder.current_build_behavior, BinaryPackageBuildBehavior)
++    True
++
  In case of copy archives the status string will show both the copy
  archive owner as well as the copy archive name.
 === modified file 'lib/lp/soyuz/doc/buildqueue.txt'
 --- lib/lp/soyuz/doc/buildqueue.txt	2009-11-13 19:34:17 +0000
 +++ lib/lp/soyuz/doc/buildqueue.txt	2009-12-01 16:47:13 +0000
@@ -98,6 +98,16 @@
      (True, 1000)
++The BuildQueue item is responsible for providing the required build behavior
++for the item.
++
++    >>> from zope.security.proxy import isinstance
++    >>> from lp.soyuz.model.binarypackagebuildbehavior import (
++    ...     BinaryPackageBuildBehavior)
++    >>> isinstance(bq.required_build_behavior, BinaryPackageBuildBehavior)
++    True
++
++
  == Dispatching and Reseting jobs ==
  The sampledata contains an active job, being built by the 'bob'
 === modified file 'lib/lp/soyuz/interfaces/builder.py'
 --- lib/lp/soyuz/interfaces/builder.py	2009-11-20 18:06:28 +0000
 +++ lib/lp/soyuz/interfaces/builder.py	2009-12-01 16:47:13 +0000
@@ -19,11 +19,13 @@
+     ]
  from zope.interface import Interface, Attribute
--from zope.schema import Choice, TextLine, Text, Bool
++from zope.schema import Bool, Choice, Field, Text, TextLine
  from canonical.launchpad import _
  from canonical.launchpad.fields import Title, Description
  from lp.registry.interfaces.role import IHasOwner
++from lp.buildmaster.interfaces.buildfarmjobbehavior import (
++    IBuildFarmJobBehavior)
  from canonical.launchpad.validators.name import name_validator
  from canonical.launchpad.validators.url import builder_url_validator
@@ -57,7 +59,7 @@
      """The build slave has suffered an error and cannot be used."""
--class IBuilder(IHasOwner):
++class IBuilder(IHasOwner, IBuildFarmJobBehavior):
      """Build-slave information and state.
      Builder instance represents a single builder slave machine within the
@@ -138,6 +140,10 @@
                  "new jobs. "),
          required=False)
++    current_build_behavior = Field(
++        title=u"The current behavior of the builder for the current job.",
++        required=False)
++
      def cacheFileOnSlave(logger, libraryfilealias):
          """Ask the slave to cache a librarian file to its local disk.
 === modified file 'lib/lp/soyuz/interfaces/buildqueue.py'
 --- lib/lp/soyuz/interfaces/buildqueue.py	2009-11-20 18:06:28 +0000
 +++ lib/lp/soyuz/interfaces/buildqueue.py	2009-12-01 16:47:13 +0000
@@ -13,7 +13,7 @@
+     ]
  from zope.interface import Interface, Attribute
--from zope.schema import Choice, Datetime, Timedelta
++from zope.schema import Choice, Datetime, Field, Timedelta
  from lazr.restful.fields import Reference
@@ -51,6 +51,10 @@
          title=_('Job type'), required=True, vocabulary=BuildFarmJobType,
          description=_("The type of this job."))
++    required_build_behavior = Field(
++        title=_('The builder behavior required to run this job.'),
++        required=False, readonly=True)
++
      estimated_duration = Timedelta(
          title=_("Estimated Job Duration"), required=True,
          description=_("Estimated job duration interval."))
 === added file 'lib/lp/soyuz/model/binarypackagebuildbehavior.py'
 --- lib/lp/soyuz/model/binarypackagebuildbehavior.py	1970-01-01 00:00:00 +0000
 +++ lib/lp/soyuz/model/binarypackagebuildbehavior.py	2009-12-01 16:47:13 +0000
@@ -0,0 +1,35 @@
++# Copyright 2009 Canonical Ltd.  This software is licensed under the
++# GNU Affero General Public License version 3 (see the file LICENSE).
++
++# pylint: disable-msg=E0211,E0213
++
++"""Builder behavior for binary package builds."""
++
++__metaclass__ = type
++
++__all__ = [
++    'BinaryPackageBuildBehavior',
++    ]
++
++from lp.buildmaster.interfaces.buildfarmjobbehavior import (
++    IBuildFarmJobBehavior)
++from lp.buildmaster.model.buildfarmjobbehavior import (
++    BuildFarmJobBehaviorBase)
++from lp.soyuz.interfaces.build import IBuildSet
++
++from zope.component import getUtility
++from zope.interface import implements
++
++
++class BinaryPackageBuildBehavior(BuildFarmJobBehaviorBase):
++    """Define the behavior of binary package builds."""
++
++    implements(IBuildFarmJobBehavior)
++
++    def logStartBuild(self, build_queue_item, logger):
++        """See `IBuildFarmJobBehavior`."""
++        build = getUtility(IBuildSet).getByQueueEntry(build_queue_item)
++        spr = build.sourcepackagerelease
++
++        logger.info("startBuild(%s, %s, %s, %s)", self._builder.url,
++                    spr.name, spr.version, build.pocket.title)
 === modified file 'lib/lp/soyuz/model/builder.py'
 --- lib/lp/soyuz/model/builder.py	2009-11-20 18:06:28 +0000
 +++ lib/lp/soyuz/model/builder.py	2009-12-01 16:47:13 +0000
@@ -20,6 +20,8 @@
  import urllib2
  import xmlrpclib
++from lazr.delegates import delegates
++
  from zope.interface import implements
  from zope.component import getUtility
@@ -31,7 +33,10 @@
  from canonical.cachedproperty import cachedproperty
  from canonical.config import config
  from canonical.buildd.slave import BuilderStatus
++from lp.buildmaster.interfaces.buildfarmjobbehavior import (
++    BuildBehaviorMismatch, IBuildFarmJobBehavior)
  from lp.buildmaster.master import BuilddMaster
++from lp.buildmaster.model.buildfarmjobbehavior import IdleBuildBehavior
  from canonical.database.sqlbase import SQLBase, sqlvalues
  from lp.soyuz.adapters.archivedependencies import (
      get_primary_current_component, get_sources_list_for_building)
@@ -54,6 +59,7 @@
      PackagePublishingStatus)
  from lp.soyuz.model.buildpackagejob import BuildPackageJob
  from canonical.launchpad.webapp import urlappend
++from canonical.lazr.utils import safe_hasattr
  from canonical.librarian.utils import copy_and_close
@@ -114,6 +120,7 @@
  class Builder(SQLBase):
      implements(IBuilder, IHasBuildRecords)
++    delegates(IBuildFarmJobBehavior, context="current_build_behavior")
      _table = 'Builder'
      _defaultOrder = ['id']
@@ -135,6 +142,51 @@
      vm_host = StringCol(dbName='vm_host')
      active = BoolCol(dbName='active', notNull=True, default=True)
++    def _getCurrentBuildBehavior(self):
++        """Return the current build behavior."""
++        if not safe_hasattr(self, '_current_build_behavior'):
++            self._current_build_behavior = None
++
++        if (self._current_build_behavior is None or
++            isinstance(self._current_build_behavior, IdleBuildBehavior)):
++            # If we don't currently have a current build behavior set,
++            # or we are currently idle, then...
++            currentjob = self.currentjob
++            if currentjob is not None:
++                # ...we'll set it based on our current job.
++                self._current_build_behavior = (
++                    currentjob.required_build_behavior)
++                self._current_build_behavior.setBuilder(self)
++                return self._current_build_behavior
++            elif self._current_build_behavior is None:
++                # If we don't have a current job or an idle behavior
++                # already set, then we just set the idle behavior
++                # before returning.
++                self._current_build_behavior = IdleBuildBehavior()
++            return self._current_build_behavior
++
++        else:
++            # We did have a current non-idle build behavior set, so
++            # we just return it.
++            return self._current_build_behavior
++
++
++    def _setCurrentBuildBehavior(self, new_behavior):
++        """Set the current build behavior."""
++
++        if self.currentjob is not None:
++            # We do not allow the current build behavior to be reset if we
++            # have a current job.
++            raise BuildBehaviorMismatch(
++                "Attempt to reset builder behavior while a current build "
++                "exists.")
++        else:
++            self._current_build_behavior = new_behavior
++            self._current_build_behavior.setBuilder(self)
++
++    current_build_behavior = property(
++        _getCurrentBuildBehavior, _setCurrentBuildBehavior)
++
      def cacheFileOnSlave(self, logger, libraryfilealias):
          """See `IBuilder`."""
          url = libraryfilealias.http_url
@@ -351,10 +403,9 @@
      def startBuild(self, build_queue_item, logger):
          """See IBuilder."""
--        build = getUtility(IBuildSet).getByQueueEntry(build_queue_item)
--        spr = build.sourcepackagerelease
--        logger.info("startBuild(%s, %s, %s, %s)", self.url,
--                    spr.name, spr.version, build.pocket.title)
++        # Set the build behavior depending on the provided build queue item.
++        self.current_build_behavior = build_queue_item.required_build_behavior
++        self.logStartBuild(build_queue_item, logger)
          # Make sure the request is valid; an exception is raised if it's not.
          self._verifyBuildRequest(build_queue_item, logger)
 === modified file 'lib/lp/soyuz/model/buildqueue.py'
 --- lib/lp/soyuz/model/buildqueue.py	2009-11-20 18:06:28 +0000
 +++ lib/lp/soyuz/model/buildqueue.py	2009-12-01 16:47:13 +0000
@@ -24,6 +24,8 @@
  from canonical.database.sqlbase import SQLBase, sqlvalues
  from canonical.launchpad.webapp.interfaces import NotFoundError
  from lp.buildmaster.interfaces.buildfarmjob import BuildFarmJobType
++from lp.buildmaster.interfaces.buildfarmjobbehavior import (
++    IBuildFarmJobBehavior)
  from lp.services.job.interfaces.job import JobStatus
  from lp.services.job.model.job import Job
  from lp.soyuz.interfaces.build import BuildStatus, IBuildSet
@@ -49,6 +51,11 @@
      estimated_duration = IntervalCol()
      @property
++    def required_build_behavior(self):
++        """See `IBuildQueue`."""
++        return IBuildFarmJobBehavior(self.specific_job)
++
++    @property
      def specific_job(self):
          """See `IBuildQueue`."""
          store = getUtility(IStoreSelector).get(MAIN_STORE, DEFAULT_FLAVOR)
 === modified file 'lib/lp/soyuz/tests/test_builder.py'
 --- lib/lp/soyuz/tests/test_builder.py	2009-11-13 16:37:05 +0000
 +++ lib/lp/soyuz/tests/test_builder.py	2009-12-01 16:47:13 +0000
@@ -8,10 +8,15 @@
  from zope.component import getUtility
  from canonical.testing import LaunchpadZopelessLayer
++from lp.buildmaster.interfaces.buildfarmjobbehavior import (
++    BuildBehaviorMismatch, IBuildFarmJobBehavior)
++from lp.buildmaster.model.buildfarmjobbehavior import IdleBuildBehavior
  from lp.soyuz.interfaces.archive import ArchivePurpose
  from lp.soyuz.interfaces.build import BuildStatus, IBuildSet
  from lp.soyuz.interfaces.builder import IBuilderSet
  from lp.soyuz.interfaces.publishing import PackagePublishingStatus
++from lp.soyuz.model.binarypackagebuildbehavior import (
++    BinaryPackageBuildBehavior)
  from lp.soyuz.tests.test_publishing import SoyuzTestPublisher
  from lp.testing import TestCaseWithFactory
@@ -214,5 +219,69 @@
          self.failUnlessEqual('primary', build.archive.name)
          self.failUnlessEqual('firefox', build.sourcepackagerelease.name)
++
++class TestCurrentBuildBehavior(TestCaseWithFactory):
++    """This test ensures the get/set behavior of IBuilder's
++    current_build_behavior property.
++    """
++
++    layer = LaunchpadZopelessLayer
++
++    def setUp(self):
++        """Create a new builder ready for testing."""
++        super(TestCurrentBuildBehavior, self).setUp()
++        self.builder = self.factory.makeBuilder(name='builder')
++
++        # Have a publisher and a ppa handy for some of the tests below.
++        self.publisher = SoyuzTestPublisher()
++        self.publisher.prepareBreezyAutotest()
++        self.ppa_joe = self.factory.makeArchive(name="joesppa")
++
++        self.build = self.publisher.getPubSource(
++            sourcename="gedit", status=PackagePublishingStatus.PUBLISHED,
++            archive=self.ppa_joe).createMissingBuilds()[0]
++
++        self.buildfarmjob = self.build.buildqueue_record.specific_job
++
++    def test_idle_behavior_when_no_current_build(self):
++        """We return an idle behavior when there is no behavior specified
++        nor a current build.
++        """
++        self.assertIsInstance(
++            self.builder.current_build_behavior, IdleBuildBehavior)
++
++    def test_set_behavior_when_no_current_job(self):
++        """If a builder is idle then it is possible to set the behavior."""
++        self.builder.current_build_behavior = IBuildFarmJobBehavior(
++            self.buildfarmjob)
++
++        self.assertIsInstance(
++            self.builder.current_build_behavior, BinaryPackageBuildBehavior)
++
++    def test_current_job_behavior(self):
++        """The current behavior is set automatically from the current job."""
++        # Set the builder attribute on the buildqueue record so that our
++        # builder will think it has a current build.
++        self.build.buildqueue_record.builder = self.builder
++
++        self.assertIsInstance(
++            self.builder.current_build_behavior, BinaryPackageBuildBehavior)
++
++    def test_set_behavior_when_current_job(self):
++        """If a builder has a current job then it's behavior cannot be set.
++        """
++        self.build.buildqueue_record.builder = self.builder
++
++        # As we can't use assertRaises for a property, we use a try-except
++        # instead.
++        assertion_raised = False
++        try:
++            self.builder.current_build_behavior = IBuildFarmJobBehavior(
++                self.buildfarmjob)
++        except BuildBehaviorMismatch, e:
++            assertion_raised = True
++
++        self.failUnless(assertion_raised)
++
  def test_suite():
      return unittest.TestLoader().loadTestsFromName(__name__)