Merge lp:~james-w/launchpad/export-specification-bug-links into lp:launchpad

[James Westby]

[r=salgado][ui=none][bug=684378] Export specification/bug links over the API.

Hi,

Here is a small branch to export specification/bug links, which is the
last thing required to get the Ubuntu work items tracker using the API
for blueprints, rather than screen-scraping.

I'm not entirely sure that List->CollectionField doesn't change other
behavior, but lazr.restful doesn't do the right thing with List.

Also, I needed to add the inheritance to have lazr.restful add the bugs
property to the specifications. Previously the model just had
implements(IBugLinkTarget). I don't know if there is another way to achieve
that.

Thanks,

James

[Guilherme Salgado (salgado)]

On Wed, 2010-12-01 at 22:24 +0000, James Westby wrote:
> You have been requested to review the proposed merge of lp:~james-w/launchpad/export-specification-bug-links into lp:launchpad.
>
> Hi,
>
> Here is a small branch to export specification/bug links, which is the
> last thing required to get the Ubuntu work items tracker using the API
> for blueprints, rather than screen-scraping.
>
> I'm not entirely sure that List->CollectionField doesn't change other
> behavior, but lazr.restful doesn't do the right thing with List.

I don't think we use the field you changed for constructing any forms,
so I'd be surprised if this has any side effects.

>
> Also, I needed to add the inheritance to have lazr.restful add the bugs
> property to the specifications. Previously the model just had
> implements(IBugLinkTarget). I don't know if there is another way to achieve
> that.

As we talked on IRC, I thought just exporting IBugLinkTarget as an entry
would make it work, but apparently it didn't?

> === modified file 'lib/lp/blueprints/interfaces/specification.py'
> --- lib/lp/blueprints/interfaces/specification.py 2010-12-01 12:54:42 +0000
> +++ lib/lp/blueprints/interfaces/specification.py 2010-12-01 22:24:03 +0000
> @@ -58,6 +58,7 @@
> IHasSpecifications,
> ISpecificationTarget,
> )
> +from lp.bugs.interfaces.buglink import IBugLinkTarget
> from lp.blueprints.interfaces.sprint import ISprint
> from lp.code.interfaces.branchlink import IHasLinkedBranches
> from lp.registry.interfaces.milestone import IMilestone
> @@ -529,7 +530,8 @@
> """Return the SpecificationBranch link for the branch, or None."""
>
>
> -class ISpecification(ISpecificationPublic, ISpecificationEditRestricted):
> +class ISpecification(ISpecificationPublic, ISpecificationEditRestricted,
> + IBugLinkTarget):
> """A Specification."""
>
> export_as_webservice_entry()
>
> === modified file 'lib/lp/blueprints/tests/test_webservice.py'
> --- lib/lp/blueprints/tests/test_webservice.py 2010-12-01 12:54:42 +0000
> +++ lib/lp/blueprints/tests/test_webservice.py 2010-12-01 22:24:03 +0000
> @@ -14,7 +14,11 @@
> )
> from lp.testing import (
> launchpadlib_for,
> +<<<<<<< TREE
> launchpadlib_for_anonymous,
> +=======
> + person_logged_in,
> +>>>>>>> MERGE-SOURCE
> TestCaseWithFactory,

A trivial conflict here.

> ws_object,
> )
> @@ -154,6 +158,16 @@
> self.assertEqual(1, spec_webservice.dependencies.total_size)
> self.assertEqual(spec2.name, spec_webservice.dependencies[0].name)
>
> + def test_representation_contains_bug_links(self):
> + spec = self.factory.makeSpecification()
> + bug = self.factory.makeBug()
> + person = self.factory.makePerson()
> + with person_logged_in(person):
> + spec.linkBug(bug)
> + spec_webservice = self.getSpecOnWebservice(spec)
> + self.assertEqual(1, spec_webservice.bugs.total_size)
> + self.assertEqual(bug.id, spec_webservice.bugs[0].id)
> +
>
> class SpecificationTargetTests(SpecificationWebserviceTestCase):
> """Tests for accessing specifications via their targets."""
>
> === mo...

[James Westby (james-w)]

On Thu, 02 Dec 2010 12:11:14 -0000, Guilherme Salgado <email address hidden> wrote:
> I don't think we use the field you changed for constructing any forms,
> so I'd be surprised if this has any side effects.

That's good news.

> As we talked on IRC, I thought just exporting IBugLinkTarget as an entry
> would make it work, but apparently it didn't?

Nope, I had this diff minus the inheritence change and it didn't
work. I'm asking again for some advice on this on IRC.

> A trivial conflict here.

Fixed.

> I think you should use Reference instead of Object here. I don't
> remember why we have Reference (which is a wrapper around Object), but
> that's what we seem to use in conjunction with CollectionFields.

Ok.

> Also, this interface is provided only by ISpecification and IQuestion
> (which is not yet exposed on the API), so I think it makes sense to
> expose it only on the 'devel' version of the webservice, like all the
> Blueprints bits that are currently exposed. To do that you just need a
> couple extra arguments to exported:
>
> ('devel', dict(exported=True)), exported=False)

I also fixed the docstring to match the current state of the code.

Thanks,

James

[Guilherme Salgado (salgado)]

Looks good to me

review: Approve (code)

=== modified file 'lib/lp/blueprints/interfaces/specification.py'
--- lib/lp/blueprints/interfaces/specification.py	2010-12-01 12:54:42 +0000
+++ lib/lp/blueprints/interfaces/specification.py	2010-12-02 15:19:59 +0000
@@ -58,6 +58,7 @@
     IHasSpecifications,
     ISpecificationTarget,
     )
+from lp.bugs.interfaces.buglink import IBugLinkTarget
 from lp.blueprints.interfaces.sprint import ISprint
 from lp.code.interfaces.branchlink import IHasLinkedBranches
 from lp.registry.interfaces.milestone import IMilestone
@@ -529,7 +530,8 @@
         """Return the SpecificationBranch link for the branch, or None."""
 
 
-class ISpecification(ISpecificationPublic, ISpecificationEditRestricted):
+class ISpecification(ISpecificationPublic, ISpecificationEditRestricted,
+                     IBugLinkTarget):
     """A Specification."""
 
     export_as_webservice_entry()

=== modified file 'lib/lp/blueprints/tests/test_webservice.py'
--- lib/lp/blueprints/tests/test_webservice.py	2010-12-01 12:54:42 +0000
+++ lib/lp/blueprints/tests/test_webservice.py	2010-12-02 15:19:59 +0000
@@ -15,6 +15,7 @@
 from lp.testing import (
     launchpadlib_for,
     launchpadlib_for_anonymous,
+    person_logged_in,
     TestCaseWithFactory,
     ws_object,
     )
@@ -154,6 +155,16 @@
         self.assertEqual(1, spec_webservice.dependencies.total_size)
         self.assertEqual(spec2.name, spec_webservice.dependencies[0].name)
 
+    def test_representation_contains_bug_links(self):
+        spec = self.factory.makeSpecification()
+        bug = self.factory.makeBug()
+        person = self.factory.makePerson()
+        with person_logged_in(person):
+            spec.linkBug(bug)
+        spec_webservice = self.getSpecOnWebservice(spec)
+        self.assertEqual(1, spec_webservice.bugs.total_size)
+        self.assertEqual(bug.id, spec_webservice.bugs[0].id)
+
 
 class SpecificationTargetTests(SpecificationWebserviceTestCase):
     """Tests for accessing specifications via their targets."""

=== modified file 'lib/lp/bugs/interfaces/buglink.py'
--- lib/lp/bugs/interfaces/buglink.py	2010-08-20 20:31:18 +0000
+++ lib/lp/bugs/interfaces/buglink.py	2010-12-02 15:19:59 +0000
@@ -14,6 +14,14 @@
     'IUnlinkBugsForm',
     ]
 
+from lazr.restful.declarations import (
+    export_as_webservice_entry,
+    exported,
+    )
+from lazr.restful.fields import (
+    CollectionField,
+    Reference,
+    )
 from zope.interface import (
     implements,
     Interface,
@@ -48,13 +56,15 @@
 
 
 class IBugLinkTarget(Interface):
-    """An entity which can be linked to a bug.
+    """An entity which can be linked to bugs.
 
-    Examples include an IQuestion, and an ICve.
+    Examples include an ISpecification.
     """
+    export_as_webservice_entry()
 
-    bugs = List(title=_("Bugs related to this object."),
-                value_type=Object(schema=IBug), readonly=True)
+    bugs = exported(CollectionField(title=_("Bugs related to this object."),
+                value_type=Reference(schema=IBug), readonly=True),
+                ('devel', dict(exported=True)), exported=False)
     bug_links = List(title=_("The links between bugs and this object."),
                      value_type=Object(schema=IBugLink), readonly=True)
 

=== modified file 'lib/lp/bugs/interfaces/webservice.py'
--- lib/lp/bugs/interfaces/webservice.py	2010-11-09 16:25:22 +0000
+++ lib/lp/bugs/interfaces/webservice.py	2010-12-02 15:19:59 +0000
@@ -17,6 +17,7 @@
     'IBugActivity',
     'IBugAttachment',
     'IBugBranch',
+    'IBugLinkTarget',
     'IBugNomination',
     'IBugSubscription',
     'IBugTarget',
@@ -48,6 +49,7 @@
 from lp.bugs.interfaces.bugactivity import IBugActivity
 from lp.bugs.interfaces.bugattachment import IBugAttachment
 from lp.bugs.interfaces.bugbranch import IBugBranch
+from lp.bugs.interfaces.buglink import IBugLinkTarget
 from lp.bugs.interfaces.malone import IMaloneApplication
 from lp.bugs.interfaces.bugnomination import (
     BugNominationStatusError,