Merge lp:~mwhudson/launchpad/recipe-model-code into lp:launchpad/db-devel

[Michael Hudson-Doyle]

Model classes and code for storing bzr-builder recipes in the database

[Michael Hudson-Doyle (mwhudson)]

Hi there,

This branch adds the first content class for the sourcepackagerecipe stuff -- the SourcePacakgeRecipe class.

It doesn't do anything fancy at all wrt storing the recipe -- that can come later.

This can't be landed until a LOSA creates the bzr-builder sourcecode branch -- "bzr co lp:bzr-builder sourcecode/" until then.

Cheers,
mwh

[Jonathan Lange (jml)]

This is going to have to change as a result of the schema changes, I think.

review: Needs Resubmitting

[Michael Hudson-Doyle (mwhudson)]

> This is going to have to change as a result of the schema changes, I think.

And now it has. The guts of this branch is converting bzr-builder's view of a recipe into and out of the database views. The tests are copy-paste-hacked from bzr-builder's own tests -- it's possible we could/should submit a patch to bzr-builder that would let us reuse bzr-builders tests. But first we'd like to land this :-)

[Jonathan Lange (jml)]

On Tue, Jan 12, 2010 at 11:46 AM, Michael Hudson
<email address hidden> wrote:
>> This is going to have to change as a result of the schema changes, I think.
>
> And now it has.  The guts of this branch is converting bzr-builder's view of a recipe into and out of the database views.  The tests are copy-paste-hacked from bzr-builder's own tests -- it's possible we could/should submit a patch to bzr-builder that would let us reuse bzr-builders tests.  But first we'd like to land this :-)

Does that mean you want this reviewed again?

jml

[Paul Hummer (rockstar)]

Hi Michael-

  This branch is quite big, and has a lot of really hairy things going on. I know all of this has been discussed on the mailing list, but that's a terrible place to document things. Has anyone put any effort into saying "This is how this works and how you work with it?" Just something to think about.

  This branch looks good. As we discussed, ForbiddenInstruction's docstring needs to be updated to swap "unsupported" for "forbidden." Also, there are a few tests in TestSourcePackageRecipe, and all the methods of TestRecipeBranchRoundTripping that are missing comments/docstrings/some sort of "this is what this test is doing."

Cheers,
Paul

review: Approve

[Paul Hummer (rockstar)]

_SourcePackageRecipeData has two definitions of sourcepackage_recipe_build, one of which is commented out. Other than that, still good.

review: Approve (code)

=== added symlink 'bzrplugins/builder'
=== target is u'../sourcecode/bzr-builder'
=== modified file 'lib/lp/soyuz/configure.zcml'
--- lib/lp/soyuz/configure.zcml	2010-01-13 04:41:19 +0000
+++ lib/lp/soyuz/configure.zcml	2010-01-13 20:46:22 +0000
@@ -915,4 +915,34 @@
         factory="lp.soyuz.model.binarypackagebuildbehavior.BinaryPackageBuildBehavior"
         permission="zope.Public" />
 
+    <!-- SourcePackageRecipe -->
+    <class
+       class="lp.soyuz.model.sourcepackagerecipe.SourcePackageRecipe">
+      <allow interface="lp.soyuz.interfaces.sourcepackagerecipe.ISourcePackageRecipe"/>
+      <require
+         permission="launchpad.Edit"
+         set_attributes="builder_recipe"/>
+    </class>
+    <class
+       class="bzrlib.plugins.builder.recipe.BaseRecipeBranch">
+      <allow attributes="name url revspec revid child_branches deb_version" />
+    </class>
+    <class
+       class="bzrlib.plugins.builder.recipe.RecipeBranch">
+      <allow attributes="name url revspec revid child_branches" />
+    </class>
+    <class
+       class="bzrlib.plugins.builder.recipe.MergeInstruction">
+      <allow attributes="as_tuple recipe_branch nest_path" />
+    </class>
+    <class
+       class="bzrlib.plugins.builder.recipe.NestInstruction">
+      <allow attributes="as_tuple recipe_branch nest_path" />
+    </class>
+    <securedutility
+       component="lp.soyuz.model.sourcepackagerecipe.SourcePackageRecipe"
+       provides="lp.soyuz.interfaces.sourcepackagerecipe.ISourcePackageRecipeSource">
+      <allow interface="lp.soyuz.interfaces.sourcepackagerecipe.ISourcePackageRecipeSource"/>
+    </securedutility>
+
 </configure>
 
=== added file 'lib/lp/soyuz/interfaces/sourcepackagerecipe.py'
--- lib/lp/soyuz/interfaces/sourcepackagerecipe.py	1970-01-01 00:00:00 +0000
+++ lib/lp/soyuz/interfaces/sourcepackagerecipe.py	2010-01-13 20:46:22 +0000
@@ -0,0 +1,86 @@
+# Copyright 2009 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Interface of the `SourcePackageRecipe` content type."""
+
+__metaclass__ = type
+__all__ = [
+    'ForbiddenInstruction',
+    'ISourcePackageRecipe',
+    'ISourcePackageRecipeSource',
+    'TooNewRecipeFormat',
+    ]
+
+from lazr.restful.fields import Reference
+
+from zope.interface import Attribute, Interface
+
+from zope.schema import Datetime, TextLine
+
+from canonical.launchpad import _
+from canonical.launchpad.validators.name import name_validator
+
+from lp.registry.interfaces.person import IPerson
+from lp.registry.interfaces.role import IHasOwner
+from lp.registry.interfaces.distroseries import IDistroSeries
+from lp.registry.interfaces.sourcepackagename import ISourcePackageName
+
+
+class ForbiddenInstruction(Exception):
+    """A forbidden instruction was found in the recipe."""
+
+    def __init__(self, instruction_name):
+        self.instruction_name = instruction_name
+
+
+class TooNewRecipeFormat(Exception):
+    """The format of the recipe supplied was too new."""
+
+    def __init__(self, supplied_format, newest_supported):
+        self.supplied_format = supplied_format
+        self.newest_supported = newest_supported
+
+
+class ISourcePackageRecipe(IHasOwner):
+    """An ISourcePackageRecipe describes how to build a source package.
+
+    More precisely, it describes how to combine a number of branches into a
+    debianized source tree.
+    """
+
+    date_created = Datetime(required=True, readonly=True)
+    date_last_modified = Datetime(required=True, readonly=True)
+
+    registrant = Reference(
+        IPerson, title=_("The person who created this recipe"), readonly=True)
+    owner = Reference(
+        IPerson, title=_("The person or team who can edit this recipe"),
+        readonly=False)
+    distroseries = Reference(
+        IDistroSeries, title=_("The distroseries this recipe will build a "
+                               "source package for"),
+        readonly=True)
+    sourcepackagename = Reference(
+        ISourcePackageName, title=_("The name of the source package this "
+                                    "recipe will build a source package"),
+        readonly=True)
+
+    name = TextLine(
+            title=_("Name"), required=True,
+            constraint=name_validator,
+            description=_("The name of this recipe."))
+
+    builder_recipe = Attribute(
+        _("The bzr-builder data structure for the recipe."))
+
+    def getReferencedBranches():
+        """An iterator of the branches referenced by this recipe."""
+
+
+class ISourcePackageRecipeSource(Interface):
+    """A utility of this interface can be used to create and access recipes.
+    """
+
+    def new(registrant, owner, distroseries, sourcepackagename, name,
+            builder_recipe):
+        """Create an `ISourcePackageRecipe`."""
 
=== added file 'lib/lp/soyuz/model/sourcepackagerecipe.py'
--- lib/lp/soyuz/model/sourcepackagerecipe.py	1970-01-01 00:00:00 +0000
+++ lib/lp/soyuz/model/sourcepackagerecipe.py	2010-01-13 20:46:22 +0000
@@ -0,0 +1,82 @@
+# Copyright 2009 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Implementation of the `SourcePackageRecipe` content type."""
+
+__metaclass__ = type
+__all__ = ['SourcePackageRecipe']
+
+from storm.locals import Int, Reference, Store, Storm, Unicode
+
+from zope.interface import classProvides, implements
+
+from canonical.database.datetimecol import UtcDateTimeCol
+from canonical.launchpad.interfaces.lpstorm import IMasterStore
+
+from lp.soyuz.interfaces.sourcepackagerecipe import (
+    ISourcePackageRecipe, ISourcePackageRecipeSource)
+from lp.soyuz.model.sourcepackagerecipedata import _SourcePackageRecipeData
+
+
+class SourcePackageRecipe(Storm):
+    """See `ISourcePackageRecipe` and `ISourcePackageRecipeSource`."""
+
+    __storm_table__ = 'SourcePackageRecipe'
+
+    implements(ISourcePackageRecipe)
+    classProvides(ISourcePackageRecipeSource)
+
+    id = Int(primary=True)
+
+    date_created = UtcDateTimeCol(notNull=True)
+    date_last_modified = UtcDateTimeCol(notNull=True)
+
+    owner_id = Int(name='owner', allow_none=True)
+    owner = Reference(owner_id, 'Person.id')
+
+    registrant_id = Int(name='registrant', allow_none=True)
+    registrant = Reference(registrant_id, 'Person.id')
+
+    distroseries_id = Int(name='distroseries', allow_none=True)
+    distroseries = Reference(distroseries_id, 'DistroSeries.id')
+
+    sourcepackagename_id = Int(name='sourcepackagename', allow_none=True)
+    sourcepackagename = Reference(
+        sourcepackagename_id, 'SourcePackageName.id')
+
+    name = Unicode(allow_none=True)
+
+    @property
+    def _recipe_data(self):
+        return Store.of(self).find(
+            _SourcePackageRecipeData,
+            _SourcePackageRecipeData.sourcepackage_recipe == self).one()
+
+    def _get_builder_recipe(self):
+        """Accesses of the recipe go to the _SourcePackageRecipeData."""
+        return self._recipe_data.getRecipe()
+
+    def _set_builder_recipe(self, value):
+        """Setting of the recipe goes to the _SourcePackageRecipeData."""
+        self._recipe_data.setRecipe(value)
+
+    builder_recipe = property(_get_builder_recipe, _set_builder_recipe)
+
+    def getReferencedBranches(self):
+        """See `ISourcePackageRecipe.getReferencedBranches`."""
+        return self._recipe_data.getReferencedBranches()
+
+    @staticmethod
+    def new(registrant, owner, distroseries, sourcepackagename, name,
+            builder_recipe):
+        """See `ISourcePackageRecipeSource.new`."""
+        store = IMasterStore(SourcePackageRecipe)
+        sprecipe = SourcePackageRecipe()
+        _SourcePackageRecipeData(builder_recipe, sprecipe)
+        sprecipe.registrant = registrant
+        sprecipe.owner = owner
+        sprecipe.distroseries = distroseries
+        sprecipe.sourcepackagename = sourcepackagename
+        sprecipe.name = name
+        store.add(sprecipe)
+        return sprecipe
 
=== added file 'lib/lp/soyuz/model/sourcepackagerecipedata.py'
--- lib/lp/soyuz/model/sourcepackagerecipedata.py	1970-01-01 00:00:00 +0000
+++ lib/lp/soyuz/model/sourcepackagerecipedata.py	2010-01-13 20:46:22 +0000
@@ -0,0 +1,230 @@
+# Copyright 2009 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Implementation of the recipe storage.
+
+This is purely an implementation detail of SourcePackageRecipe.recipe_data and
+SourcePackageRecipeBuild.manifest, the classes in this file have no public
+interfaces.
+"""
+
+__metaclass__ = type
+__all__ = ['_SourcePackageRecipeData']
+
+from bzrlib.plugins.builder.recipe import (
+    BaseRecipeBranch, MergeInstruction, NestInstruction, RecipeBranch)
+
+from lazr.enum import DBEnumeratedType, DBItem
+
+from storm.locals import Int, Reference, ReferenceSet, Store, Storm, Unicode
+
+from zope.component import getUtility
+
+from canonical.database.enumcol import EnumCol
+from canonical.launchpad.interfaces.lpstorm import IStore
+
+from lp.code.model.branch import Branch
+from lp.code.interfaces.branchlookup import IBranchLookup
+from lp.soyuz.interfaces.sourcepackagerecipe import (
+    ForbiddenInstruction, TooNewRecipeFormat)
+
+
+class InstructionType(DBEnumeratedType):
+    """The instruction type, for _SourcePackageRecipeDataInstruction.type."""
+
+    MERGE = DBItem(1, """
+        Merge instruction
+
+        A merge instruction.""")
+
+    NEST = DBItem(2, """
+        Nest instruction
+
+        A nest instruction.""")
+
+
+class _SourcePackageRecipeDataInstruction(Storm):
+    """A single line from a recipe."""
+
+    __storm_table__ = "SourcePackageRecipeDataInstruction"
+
+    def __init__(self, name, type, comment, line_number, branch, revspec,
+                 directory, recipe_data, parent_instruction):
+        self.name = unicode(name)
+        self.type = type
+        self.comment = comment
+        self.line_number = line_number
+        self.branch = branch
+        if revspec is not None:
+            revspec = unicode(revspec)
+        self.revspec = revspec
+        if directory is not None:
+            directory = unicode(directory)
+        self.directory = directory
+        self.recipe_data = recipe_data
+        self.parent_instruction = parent_instruction
+
+    id = Int(primary=True)
+
+    name = Unicode(allow_none=False)
+    type = EnumCol(notNull=True, schema=InstructionType)
+    comment = Unicode(allow_none=True)
+    line_number = Int(allow_none=False)
+
+    branch_id = Int(name='branch', allow_none=False)
+    branch = Reference(branch_id, 'Branch.id')
+
+    revspec = Unicode(allow_none=True)
+    directory = Unicode(allow_none=True)
+
+    recipe_data_id = Int(name='recipe_data', allow_none=False)
+    recipe_data = Reference(recipe_data_id, '_SourcePackageRecipeData.id')
+
+    parent_instruction_id = Int(name='parent_instruction', allow_none=True)
+    parent_instruction = Reference(
+        parent_instruction_id, '_SourcePackageRecipeDataInstruction.id')
+
+    def appendToRecipe(self, recipe_branch):
+        """Append a bzr-builder instruction to the recipe_branch object."""
+        branch = RecipeBranch(
+            self.name, self.branch.bzr_identity, self.revspec)
+        if self.type == InstructionType.MERGE:
+            recipe_branch.merge_branch(branch)
+        elif self.type == InstructionType.NEST:
+            recipe_branch.nest_branch(self.directory, branch)
+        else:
+            raise AssertionError("Unknown type %r" % self.type)
+        return branch
+
+
+class _SourcePackageRecipeData(Storm):
+    """The database representation of a BaseRecipeBranch from bzr-builder.
+
+    This is referenced from the SourcePackageRecipe table as the 'recipe_data'
+    column and from the SourcePackageRecipeBuild table as the 'manifest'
+    column.
+    """
+
+    __storm_table__ = "SourcePackageRecipeData"
+
+    id = Int(primary=True)
+
+    base_branch_id = Int(name='base_branch', allow_none=False)
+    base_branch = Reference(base_branch_id, 'Branch.id')
+
+    recipe_format = Unicode(allow_none=False)
+    deb_version_template = Unicode(allow_none=False)
+    revspec = Unicode(allow_none=True)
+
+    instructions = ReferenceSet(
+        id, _SourcePackageRecipeDataInstruction.recipe_data_id,
+        order_by=_SourcePackageRecipeDataInstruction.line_number)
+
+    sourcepackage_recipe_id = Int(
+        name='sourcepackage_recipe', allow_none=True)
+    sourcepackage_recipe = Reference(
+        sourcepackage_recipe_id, 'SourcePackageRecipe.id')
+
+    sourcepackage_recipe_build_id = Int(
+        name='sourcepackage_recipe_build', allow_none=True)
+    #sourcepackage_recipe_build = Reference(
+    #    sourcepackage_recipe_build_id, 'SourcePackageRecipeBuild.id')
+
+    def getRecipe(self):
+        """The BaseRecipeBranch version of the recipe."""
+        base_branch = BaseRecipeBranch(
+            self.base_branch.bzr_identity, self.deb_version_template,
+            self.recipe_format, self.revspec)
+        insn_stack = []
+        for insn in self.instructions:
+            while insn_stack and \
+                      insn_stack[-1]['insn'] != insn.parent_instruction:
+                insn_stack.pop()
+            if insn_stack:
+                target_branch = insn_stack[-1]['recipe_branch']
+            else:
+                target_branch = base_branch
+            recipe_branch = insn.appendToRecipe(target_branch)
+            insn_stack.append(
+                dict(insn=insn, recipe_branch=recipe_branch))
+        return base_branch
+
+    def _scanInstructions(self, recipe_branch):
+        """Check the recipe_branch doesn't use 'run' and look up the branches.
+
+        We do all the lookups before we start constructing database objects to
+        avoid flushing half-constructed objects to the database.
+
+        :return: A map ``{branch_url: db_branch}``.
+        """
+        r = {}
+        for instruction in recipe_branch.child_branches:
+            if not (isinstance(instruction, MergeInstruction) or
+                    isinstance(instruction, NestInstruction)):
+                raise ForbiddenInstruction(str(instruction))
+            db_branch = getUtility(IBranchLookup).getByUrl(
+                instruction.recipe_branch.url)
+            r[instruction.recipe_branch.url] = db_branch
+            r.update(self._scanInstructions(instruction.recipe_branch))
+        return r
+
+    def _recordInstructions(self, recipe_branch, parent_insn, branch_map,
+                            line_number=0):
+        """Build _SourcePackageRecipeDataInstructions for the recipe_branch.
+        """
+        for instruction in recipe_branch.child_branches:
+            if isinstance(instruction, MergeInstruction):
+                type = InstructionType.MERGE
+            elif isinstance(instruction, NestInstruction):
+                type = InstructionType.NEST
+            else:
+                # Unsupported instructions should have been filtered out by
+                # _scanInstructions; if we get surprised here, that's a bug.
+                raise AssertionError(
+                    "Unsupported instruction %r" % instruction)
+            line_number += 1
+            comment = None
+            db_branch = branch_map[instruction.recipe_branch.url]
+            insn = _SourcePackageRecipeDataInstruction(
+                instruction.recipe_branch.name, type, comment,
+                line_number, db_branch, instruction.recipe_branch.revspec,
+                instruction.nest_path, self, parent_insn)
+            line_number = self._recordInstructions(
+                instruction.recipe_branch, insn, branch_map, line_number)
+        return line_number
+
+    def setRecipe(self, builder_recipe):
+        """Convert the BaseRecipeBranch `builder_recipe` to the db form."""
+        if builder_recipe.format > 0.2:
+            raise TooNewRecipeFormat(builder_recipe.format, 0.2)
+        branch_map = self._scanInstructions(builder_recipe)
+        # If this object hasn't been added to a store yet, there can't be any
+        # instructions linking to us yet.
+        if Store.of(self) is not None:
+            self.instructions.find().remove()
+        branch_lookup = getUtility(IBranchLookup)
+        base_branch = branch_lookup.getByUrl(builder_recipe.url)
+        if builder_recipe.revspec is not None:
+            self.revspec = unicode(builder_recipe.revspec)
+        self._recordInstructions(
+            builder_recipe, parent_insn=None, branch_map=branch_map)
+        self.base_branch = base_branch
+        self.deb_version_template = unicode(builder_recipe.deb_version)
+        self.recipe_format = unicode(builder_recipe.format)
+
+    def __init__(self, recipe, sourcepackage_recipe):
+        """Initialize from the bzr-builder recipe and link it to a db recipe.
+        """
+        self.setRecipe(recipe)
+        self.sourcepackage_recipe = sourcepackage_recipe
+
+    def getReferencedBranches(self):
+        """Return an iterator of the Branch objects referenced by this recipe.
+        """
+        yield self.base_branch
+        sub_branches = IStore(self).find(
+            Branch,
+            _SourcePackageRecipeDataInstruction.recipe_data == self,
+            Branch.id == _SourcePackageRecipeDataInstruction.branch_id)
+        for branch in sub_branches:
+            yield branch
 
=== added file 'lib/lp/soyuz/tests/test_sourcepackagerecipe.py'
--- lib/lp/soyuz/tests/test_sourcepackagerecipe.py	1970-01-01 00:00:00 +0000
+++ lib/lp/soyuz/tests/test_sourcepackagerecipe.py	2010-01-13 20:46:22 +0000
@@ -0,0 +1,370 @@
+# Copyright 2009 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Tests for the SourcePackageRecipe content type."""
+
+__metaclass__ = type
+
+import textwrap
+import unittest
+
+from bzrlib.plugins.builder.recipe import RecipeParser
+
+from zope.component import getUtility
+from zope.security.interfaces import Unauthorized
+
+from canonical.testing.layers import DatabaseFunctionalLayer
+
+from lp.soyuz.interfaces.sourcepackagerecipe import (
+    ForbiddenInstruction, ISourcePackageRecipe, ISourcePackageRecipeSource,
+    TooNewRecipeFormat)
+from lp.testing import login_person, TestCaseWithFactory
+
+
+MINIMAL_RECIPE_TEXT = u'''\
+# bzr-builder format 0.2 deb-version 1.0
+%s
+'''
+
+class TestSourcePackageRecipe(TestCaseWithFactory):
+    """Tests for `SourcePackageRecipe` objects."""
+
+    layer = DatabaseFunctionalLayer
+
+    def makeBuilderRecipe(self, *branches):
+        """Make a builder recipe that references `branches`.
+
+        If no branches are passed, return a recipe text that references an
+        arbitrary branch.
+        """
+        if len(branches) == 0:
+            branches = (self.factory.makeAnyBranch(),)
+        base_branch = branches[0]
+        other_branches = branches[1:]
+        text = MINIMAL_RECIPE_TEXT % base_branch.bzr_identity
+        for i, branch in enumerate(other_branches):
+            text += 'merge dummy-%s %s\n' % (i, branch.bzr_identity)
+        parser = RecipeParser(text)
+        return parser.parse()
+
+    def makeSourcePackageRecipeFromBuilderRecipe(self, builder_recipe):
+        """Make a SourcePackageRecipe from a recipe with arbitrary other data.
+        """
+        registrant = self.factory.makePerson()
+        owner = self.factory.makeTeam(owner=registrant)
+        distroseries = self.factory.makeDistroSeries()
+        sourcepackagename = self.factory.makeSourcePackageName()
+        name = self.factory.getUniqueString(u'recipe-name')
+        return getUtility(ISourcePackageRecipeSource).new(
+            registrant=registrant, owner=owner, distroseries=distroseries,
+            sourcepackagename=sourcepackagename, name=name,
+            builder_recipe=builder_recipe)
+
+    def test_creation(self):
+        # The metadata supplied when a SourcePackageRecipe is created is
+        # present on the new object.
+        registrant = self.factory.makePerson()
+        owner = self.factory.makeTeam(owner=registrant)
+        distroseries = self.factory.makeDistroSeries()
+        sourcepackagename = self.factory.makeSourcePackageName()
+        name = self.factory.getUniqueString(u'recipe-name')
+        builder_recipe = self.makeBuilderRecipe()
+        recipe = getUtility(ISourcePackageRecipeSource).new(
+            registrant=registrant, owner=owner, distroseries=distroseries,
+            sourcepackagename=sourcepackagename, name=name,
+            builder_recipe=builder_recipe)
+        self.assertEquals(
+            (registrant, owner, distroseries, sourcepackagename, name),
+            (recipe.registrant, recipe.owner, recipe.distroseries,
+             recipe.sourcepackagename, recipe.name))
+
+    def test_source_implements_interface(self):
+        # The SourcePackageRecipe class implements ISourcePackageRecipeSource.
+        self.assertProvides(
+            getUtility(ISourcePackageRecipeSource),
+            ISourcePackageRecipeSource)
+
+    def test_recipe_implements_interface(self):
+        # SourcePackageRecipe objects implement ISourcePackageRecipe.
+        recipe = self.makeSourcePackageRecipeFromBuilderRecipe(
+            self.makeBuilderRecipe())
+        self.assertProvides(recipe, ISourcePackageRecipe)
+
+    def test_branch_links_created(self):
+        # When a recipe is created, we can query it for links to the branch
+        # it references.
+        branch = self.factory.makeAnyBranch()
+        builder_recipe = self.makeBuilderRecipe(branch)
+        sp_recipe = self.makeSourcePackageRecipeFromBuilderRecipe(
+            builder_recipe)
+        self.assertEquals([branch], list(sp_recipe.getReferencedBranches()))
+
+    def test_multiple_branch_links_created(self):
+        # If a recipe links to more than one branch, getReferencedBranches()
+        # returns all of them.
+        branch1 = self.factory.makeAnyBranch()
+        branch2 = self.factory.makeAnyBranch()
+        builder_recipe = self.makeBuilderRecipe(branch1, branch2)
+        sp_recipe = self.makeSourcePackageRecipeFromBuilderRecipe(
+            builder_recipe)
+        self.assertEquals(
+            sorted([branch1, branch2]),
+            sorted(sp_recipe.getReferencedBranches()))
+
+    def test_random_user_cant_edit(self):
+        # An arbitrary user can't set attributes.
+        branch1 = self.factory.makeAnyBranch()
+        builder_recipe1 = self.makeBuilderRecipe(branch1)
+        sp_recipe = self.makeSourcePackageRecipeFromBuilderRecipe(
+            builder_recipe1)
+        branch2 = self.factory.makeAnyBranch()
+        builder_recipe2 = self.makeBuilderRecipe(branch2)
+        login_person(self.factory.makePerson())
+        self.assertRaises(
+            Unauthorized, setattr, sp_recipe, 'builder_recipe',
+            builder_recipe2)
+
+    def test_set_recipe_text_resets_branch_references(self):
+        # When the recipe_text is replaced, getReferencedBranches returns
+        # (only) the branches referenced by the new recipe.
+        branch1 = self.factory.makeAnyBranch()
+        builder_recipe1 = self.makeBuilderRecipe(branch1)
+        sp_recipe = self.makeSourcePackageRecipeFromBuilderRecipe(
+            builder_recipe1)
+        branch2 = self.factory.makeAnyBranch()
+        builder_recipe2 = self.makeBuilderRecipe(branch2)
+        login_person(sp_recipe.owner.teamowner)
+        #import pdb; pdb.set_trace()
+        sp_recipe.builder_recipe = builder_recipe2
+        self.assertEquals([branch2], list(sp_recipe.getReferencedBranches()))
+
+    def test_rejects_run_command(self):
+        recipe_text = '''\
+        # bzr-builder format 0.2 deb-version 0.1-{revno}
+        %(base)s
+        run touch test
+        ''' % dict(base=self.factory.makeAnyBranch().bzr_identity)
+        parser = RecipeParser(textwrap.dedent(recipe_text))
+        builder_recipe = parser.parse()
+        self.assertRaises(
+            ForbiddenInstruction,
+            self.makeSourcePackageRecipeFromBuilderRecipe, builder_recipe)
+
+    def test_run_rejected_without_mangling_recipe(self):
+        branch1 = self.factory.makeAnyBranch()
+        builder_recipe1 = self.makeBuilderRecipe(branch1)
+        sp_recipe = self.makeSourcePackageRecipeFromBuilderRecipe(
+            builder_recipe1)
+        recipe_text = '''\
+        # bzr-builder format 0.2 deb-version 0.1-{revno}
+        %(base)s
+        run touch test
+        ''' % dict(base=self.factory.makeAnyBranch().bzr_identity)
+        parser = RecipeParser(textwrap.dedent(recipe_text))
+        builder_recipe2 = parser.parse()
+        login_person(sp_recipe.owner.teamowner)
+        self.assertRaises(
+            ForbiddenInstruction, setattr, sp_recipe, 'builder_recipe',
+            builder_recipe2)
+        self.assertEquals([branch1], list(sp_recipe.getReferencedBranches()))
+
+    def test_reject_newer_formats(self):
+        builder_recipe = self.makeBuilderRecipe()
+        builder_recipe.format = 0.3
+        self.assertRaises(
+            TooNewRecipeFormat,
+            self.makeSourcePackageRecipeFromBuilderRecipe, builder_recipe)
+
+class TestRecipeBranchRoundTripping(TestCaseWithFactory):
+
+    layer = DatabaseFunctionalLayer
+
+    def setUp(self):
+        super(TestRecipeBranchRoundTripping, self).setUp()
+        self.base_branch = self.factory.makeAnyBranch()
+        self.nested_branch = self.factory.makeAnyBranch()
+        self.merged_branch = self.factory.makeAnyBranch()
+        self.branch_identities = {
+            'base': self.base_branch.bzr_identity,
+            'nested': self.nested_branch.bzr_identity,
+            'merged': self.merged_branch.bzr_identity,
+            }
+
+    def get_recipe(self, recipe_text):
+        builder_recipe = RecipeParser(textwrap.dedent(recipe_text)).parse()
+        registrant = self.factory.makePerson()
+        owner = self.factory.makeTeam(owner=registrant)
+        distroseries = self.factory.makeDistroSeries()
+        sourcepackagename = self.factory.makeSourcePackageName()
+        name = self.factory.getUniqueString(u'recipe-name')
+        recipe = getUtility(ISourcePackageRecipeSource).new(
+            registrant=registrant, owner=owner, distroseries=distroseries,
+            sourcepackagename=sourcepackagename, name=name,
+            builder_recipe=builder_recipe)
+        return recipe.builder_recipe
+
+    def check_base_recipe_branch(self, branch, url, revspec=None,
+            num_child_branches=0, revid=None, deb_version=None):
+        self.check_recipe_branch(branch, None, url, revspec=revspec,
+                num_child_branches=num_child_branches, revid=revid)
+        self.assertEqual(deb_version, branch.deb_version)
+
+    def check_recipe_branch(self, branch, name, url, revspec=None,
+            num_child_branches=0, revid=None):
+        self.assertEqual(name, branch.name)
+        self.assertEqual(url, branch.url)
+        self.assertEqual(revspec, branch.revspec)
+        self.assertEqual(revid, branch.revid)
+        self.assertEqual(num_child_branches, len(branch.child_branches))
+
+    def test_builds_simplest_recipe(self):
+        recipe_text = '''\
+        # bzr-builder format 0.2 deb-version 0.1-{revno}
+        %(base)s
+        ''' % self.branch_identities
+        base_branch = self.get_recipe(recipe_text)
+        self.check_base_recipe_branch(
+            base_branch, self.base_branch.bzr_identity,
+            deb_version='0.1-{revno}')
+
+    def test_builds_recipe_with_merge(self):
+        recipe_text = '''\
+        # bzr-builder format 0.2 deb-version 0.1-{revno}
+        %(base)s
+        merge bar %(merged)s
+        ''' % self.branch_identities
+        base_branch = self.get_recipe(recipe_text)
+        self.check_base_recipe_branch(
+            base_branch, self.base_branch.bzr_identity, num_child_branches=1,
+            deb_version='0.1-{revno}')
+        child_branch, location = base_branch.child_branches[0].as_tuple()
+        self.assertEqual(None, location)
+        self.check_recipe_branch(
+            child_branch, "bar", self.merged_branch.bzr_identity)
+
+    def test_builds_recipe_with_nest(self):
+        recipe_text = '''\
+        # bzr-builder format 0.2 deb-version 0.1-{revno}
+        %(base)s
+        nest bar %(nested)s baz
+        ''' % self.branch_identities
+        base_branch = self.get_recipe(recipe_text)
+        self.check_base_recipe_branch(
+            base_branch, self.base_branch.bzr_identity, num_child_branches=1,
+            deb_version='0.1-{revno}')
+        child_branch, location = base_branch.child_branches[0].as_tuple()
+        self.assertEqual("baz", location)
+        self.check_recipe_branch(
+            child_branch, "bar", self.nested_branch.bzr_identity)
+
+    def test_builds_recipe_with_nest_then_merge(self):
+        recipe_text = '''\
+        # bzr-builder format 0.2 deb-version 0.1-{revno}
+        %(base)s
+        nest bar %(nested)s baz
+        merge zam %(merged)s
+        ''' % self.branch_identities
+        base_branch = self.get_recipe(recipe_text)
+        self.check_base_recipe_branch(
+            base_branch, self.base_branch.bzr_identity, num_child_branches=2,
+            deb_version='0.1-{revno}')
+        child_branch, location = base_branch.child_branches[0].as_tuple()
+        self.assertEqual("baz", location)
+        self.check_recipe_branch(
+            child_branch, "bar", self.nested_branch.bzr_identity)
+        child_branch, location = base_branch.child_branches[1].as_tuple()
+        self.assertEqual(None, location)
+        self.check_recipe_branch(
+            child_branch, "zam", self.merged_branch.bzr_identity)
+
+    def test_builds_recipe_with_merge_then_nest(self):
+        recipe_text = '''\
+        # bzr-builder format 0.2 deb-version 0.1-{revno}
+        %(base)s
+        merge zam %(merged)s
+        nest bar %(nested)s baz
+        ''' % self.branch_identities
+        base_branch = self.get_recipe(recipe_text)
+        self.check_base_recipe_branch(
+            base_branch, self.base_branch.bzr_identity, num_child_branches=2,
+            deb_version='0.1-{revno}')
+        child_branch, location = base_branch.child_branches[0].as_tuple()
+        self.assertEqual(None, location)
+        self.check_recipe_branch(
+            child_branch, "zam", self.merged_branch.bzr_identity)
+        child_branch, location = base_branch.child_branches[1].as_tuple()
+        self.assertEqual("baz", location)
+        self.check_recipe_branch(
+            child_branch, "bar", self.nested_branch.bzr_identity)
+
+    def test_builds_a_merge_in_to_a_nest(self):
+        recipe_text = '''\
+        # bzr-builder format 0.2 deb-version 0.1-{revno}
+        %(base)s
+        nest bar %(nested)s baz
+          merge zam %(merged)s
+        ''' % self.branch_identities
+        base_branch = self.get_recipe(recipe_text)
+        self.check_base_recipe_branch(
+            base_branch, self.base_branch.bzr_identity, num_child_branches=1,
+            deb_version='0.1-{revno}')
+        child_branch, location = base_branch.child_branches[0].as_tuple()
+        self.assertEqual("baz", location)
+        self.check_recipe_branch(
+            child_branch, "bar", self.nested_branch.bzr_identity,
+            num_child_branches=1)
+        child_branch, location = child_branch.child_branches[0].as_tuple()
+        self.assertEqual(None, location)
+        self.check_recipe_branch(
+            child_branch, "zam", self.merged_branch.bzr_identity)
+
+    def tests_builds_nest_into_a_nest(self):
+        nested2 = self.factory.makeAnyBranch()
+        self.branch_identities['nested2'] = nested2.bzr_identity
+        recipe_text = '''\
+        # bzr-builder format 0.2 deb-version 0.1-{revno}
+        %(base)s
+        nest bar %(nested)s baz
+          nest zam %(nested2)s zoo
+        ''' % self.branch_identities
+        base_branch = self.get_recipe(recipe_text)
+        self.check_base_recipe_branch(
+            base_branch, self.base_branch.bzr_identity, num_child_branches=1,
+            deb_version='0.1-{revno}')
+        child_branch, location = base_branch.child_branches[0].as_tuple()
+        self.assertEqual("baz", location)
+        self.check_recipe_branch(
+            child_branch, "bar", self.nested_branch.bzr_identity,
+            num_child_branches=1)
+        child_branch, location = child_branch.child_branches[0].as_tuple()
+        self.assertEqual("zoo", location)
+        self.check_recipe_branch(child_branch, "zam", nested2.bzr_identity)
+
+    def tests_builds_recipe_with_revspecs(self):
+        recipe_text = '''\
+        # bzr-builder format 0.2 deb-version 0.1-{revno}
+        %(base)s revid:a
+        nest bar %(nested)s baz tag:b
+        merge zam %(merged)s 2
+        ''' % self.branch_identities
+        base_branch = self.get_recipe(recipe_text)
+        self.check_base_recipe_branch(
+            base_branch, self.base_branch.bzr_identity, num_child_branches=2,
+            revspec="revid:a", deb_version='0.1-{revno}')
+        instruction = base_branch.child_branches[0]
+        child_branch = instruction.recipe_branch
+        location = instruction.nest_path
+        self.assertEqual("baz", location)
+        self.check_recipe_branch(
+            child_branch, "bar", self.nested_branch.bzr_identity,
+            revspec="tag:b")
+        child_branch, location = base_branch.child_branches[1].as_tuple()
+        self.assertEqual(None, location)
+        self.check_recipe_branch(
+            child_branch, "zam", self.merged_branch.bzr_identity, revspec="2")
+
+
+
+def test_suite():
+    return unittest.TestLoader().loadTestsFromName(__name__)
+
 
=== modified file 'utilities/sourcedeps.conf'
--- utilities/sourcedeps.conf	2010-01-13 05:18:26 +0000
+++ utilities/sourcedeps.conf	2010-01-13 20:46:22 +0000
@@ -1,3 +1,4 @@
+bzr-builder lp:~launchpad-pqm/bzr-builder/trunk;revno=62
 bzr-git lp:~launchpad-pqm/bzr-git/devel;revno=248
 bzr-hg lp:~launchpad-pqm/bzr-hg/devel;revno=281
 bzr-loom lp:~launchpad-pqm/bzr-loom/trunk;revno=47