Merge lp:~adeuring/launchpad/bug-528569-api-bug-search-for-linked-branches into lp:launchpad

[Abel Deuring]

This branch fixes bug 528569: searching bug tasks by linked_branches not exported in the API

Just the boilerplate markup for webservice export of yet another parameter of IHasBugs.searchtasks() and a short test:

./bin/test -t webservice/xx-bug.txt

= 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/bugs/interfaces/bugtarget.py
  lib/lp/bugs/stories/webservice/xx-bug.txt

== Pylint notices ==

lib/lp/bugs/interfaces/bugtarget.py
    62: [C0301] Line too long (79/78)
    29: [F0401] Unable to import 'lazr.enum' (No module named enum)
    30: [F0401] Unable to import 'lazr.restful.fields' (No module named restful)
    31: [F0401] Unable to import 'lazr.restful.interface' (No module named restful)
    32: [F0401] Unable to import 'lazr.restful.declarations' (No module named restful)
    68: [C0322, IHasBugs.searchTasks] Operator not preceded by a space
    value_type=Text(),
    ^
    required=False),
    search_text=copy_field(IBugTaskSearch['searchtext']),
    status=copy_field(IBugTaskSearch['status']),
    importance=copy_field(IBugTaskSearch['importance']),
    assignee=Reference(schema=Interface),
    bug_reporter=Reference(schema=Interface),
    bug_supervisor=Reference(schema=Interface),
    bug_commenter=Reference(schema=Interface),
    bug_subscriber=Reference(schema=Interface),
    owner=Reference(schema=Interface),
    affected_user=Reference(schema=Interface),
    has_patch=copy_field(IBugTaskSearch['has_patch']),
    has_cve=copy_field(IBugTaskSearch['has_cve']),
    tags=copy_field(IBugTaskSearch['tag']),
    tags_combinator=copy_field(IBugTaskSearch['tags_combinator']),
    omit_duplicates=copy_field(IBugTaskSearch['omit_dupes']),
    omit_targeted=copy_field(IBugTaskSearch['omit_targeted']),
    status_upstream=copy_field(IBugTaskSearch['status_upstream']),
    milestone_assignment=copy_field(
    IBugTaskSearch['milestone_assignment']),
    milestone=copy_field(IBugTaskSearch['milestone']),
    component=copy_field(IBugTaskSearch['component']),
    nominated_for=Reference(schema=Interface),
    has_no_package=copy_field(IBugTaskSearch['has_no_package']),
    hardware_bus=Choice(
    title=u'The bus of a hardware device related to a bug',

    vocabulary=DBEnumeratedType, required=False),
    hardware_vendor_id=TextLine(
    title=(
    u"The vendor ID of a hardware device related to a bug."),
    description=(
    u"Allowed values of the vendor ID depend on the bus of the "
    "device.nn"
    "Vendor IDs of PCI, PCCard and USB devices are hexadecimal "
    "string representations of 16 bit integers in the format "
    "'0x01ab': The prefix '0x', followed by exactly 4 digits; "
    "where a digit is one of the characters 0..9, a..f. The "
    "characters A..F are not allowed.nn"
    "SCSI vendor IDs are strings with exactly 8 characters. "
    "Shorter names are right-padded with space (0x20) characters."
    "nn"
    "IDs for other buses may be arbitrary strings."),
    required=False),
    hardware_product_id=TextLine(
    title=(
    u"The product ID of a hardware device related to a bug."),
    description=(
    u"Allowed values of the product ID depend on the bus of the "
    "device.nn"
    "Product IDs of PCI, PCCard and USB devices are hexadecimal "
    "string representations of 16 bit integers in the format "
    "'0x01ab': The prefix '0x', followed by exactly 4 digits; "
    "where a digit is one of the characters 0..9, a..f. The "
    "characters A..F are not allowed.nn"
    "SCSI product IDs are strings with exactly 16 characters. "
    "Shorter names are right-padded with space (0x20) characters."
    "nn"
    "IDs for other buses may be arbitrary strings."),
    required=False),
    hardware_driver_name=TextLine(
    title=(
    u"The driver controlling a hardware device related to a "
    "bug."),
    required=False),
    hardware_driver_package_name=TextLine(
    title=(
    u"The package of the driver which controls a hardware "
    "device related to a bug."),
    required=False),
    hardware_owner_is_bug_reporter=Bool(
    title=(
    u"Search for bugs reported by people who own the given "
    "device or who use the given hardware driver."),
    required=False),
    hardware_owner_is_affected_by_bug=Bool(
    title=(
    u"Search for bugs where people affected by a bug own the "
    "given device or use the given hardware driver."),
    required=False),
    hardware_owner_is_subscribed_to_bug=Bool(
    title=(
    u"Search for bugs where a bug subscriber owns the "
    "given device or uses the given hardware driver."),
    required=False),
    hardware_is_linked_to_bug=Bool(
    title=(
    u"Search for bugs which are linked to hardware reports "
    "wich contain the given device or whcih contain a device"
    "contolled by the given driver."),
    required=False),
    linked_branches=Choice(
    title=(
    u"Search for bugs that are linked to branches or for bugs"
    "that are not linked to branches."),
    vocabulary=BugBranchSearch, required=False))
    @operation_returns_collection_of(IBugTask)
    @export_read_operation()
    def searchTasks(search_params, user=None,
    order_by=None, search_text=None,
    status=None, importance=None,
    assignee=None, bug_reporter=None, bug_supervisor=None,
    bug_commenter=None, bug_subscriber=None, owner=None,
    affected_user=None, has_patch=None, has_cve=None,
    distribution=None, tags=None,
    tags_combinator=BugTagsSearchCombinator.ALL,
    omit_duplicates=True, omit_targeted=None,
    status_upstream=None, milestone_assignment=None,
    milestone=None, component=None, nominated_for=None,
    sourcepackagename=None, has_no_package=None,
    hardware_bus=None, hardware_vendor_id=None,
    hardware_product_id=None, hardware_driver_name=None,
    hardware_driver_package_name=None,
    hardware_owner_is_bug_reporter=None,
    hardware_owner_is_affected_by_bug=False,
    hardware_owner_is_subscribed_to_bug=False,
    hardware_is_linked_to_bug=False, linked_branches=None):

[Gavin Panella (allenap)]

Having to use the long name from the enum when passing this parameter is truly awful, but I don't think that's your problem right now. Looks good.

review: Approve (code)

[Abel Deuring (adeuring)]

Hi Gavin,

thanks for the review!

On 10.03.2010 18:21, Gavin Panella wrote:
> Review: Approve code
> Having to use the long name from the enum when passing this parameter is
> truly awful, but I don't think that's your problem right now. Looks good.

Right, the parameter values do not look very pretty. The problem is that
they were intended to become labels for radio buttons in the web ui, and
in this context they are more reasonable. I must admit that I never
liked the concept to use the title of enum items in calls of the
webservice API...

=== modified file 'lib/lp/bugs/interfaces/bugtarget.py'
--- lib/lp/bugs/interfaces/bugtarget.py	2010-03-08 09:38:21 +0000
+++ lib/lp/bugs/interfaces/bugtarget.py	2010-03-10 15:01:24 +0000
@@ -25,7 +25,7 @@
 from canonical.launchpad import _
 from canonical.launchpad.fields import Tag
 from lp.bugs.interfaces.bugtask import (
-    BugTagsSearchCombinator, IBugTask, IBugTaskSearch)
+    BugBranchSearch, BugTagsSearchCombinator, IBugTask, IBugTaskSearch)
 from lazr.enum import DBEnumeratedType
 from lazr.restful.fields import Reference
 from lazr.restful.interface import copy_field
@@ -157,7 +157,12 @@
                 u"Search for bugs which are linked to hardware reports "
                 "wich contain the given device or whcih contain a device"
                 "contolled by the given driver."),
-            required=False))
+            required=False),
+        linked_branches=Choice(
+            title=(
+                u"Search for bugs that are linked to branches or for bugs"
+                "that are not linked to branches."),
+            vocabulary=BugBranchSearch, required=False))
     @operation_returns_collection_of(IBugTask)
     @export_read_operation()
     def searchTasks(search_params, user=None,

=== modified file 'lib/lp/bugs/stories/webservice/xx-bug.txt'
--- lib/lp/bugs/stories/webservice/xx-bug.txt	2010-03-08 16:07:40 +0000
+++ lib/lp/bugs/stories/webservice/xx-bug.txt	2010-03-10 15:01:24 +0000
@@ -1717,6 +1717,32 @@
     HTTP/1.1 400 Bad Request...
 
 
+Searching for bugs that are linked to branches
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+We can search for bugs that are linked to branches...
+
+    >>> bugtasks = webservice.named_get(
+    ...     '/firefox', 'searchTasks',
+    ...     linked_branches='Show only Bugs with linked Branches')
+    >>> for bugtask in bugtasks.jsonBody()['entries']:
+    ...     print bugtask['self_link']
+    http://api.launchpad.dev/beta/firefox/+bug/5
+    http://api.launchpad.dev/beta/firefox/+bug/4
+
+...and we can search for bugs that are not linked to branches.
+
+    >>> bugtasks = webservice.named_get(
+    ...     '/firefox', 'searchTasks',
+    ...     linked_branches='Show only Bugs without linked Branches')
+    >>> for bugtask in bugtasks.jsonBody()['entries']:
+    ...     print bugtask['self_link']
+    http://api.launchpad.dev/beta/firefox/+bug/1
+    http://api.launchpad.dev/beta/firefox/+bug/16
+    http://api.launchpad.dev/beta/firefox/+bug/20
+    http://api.launchpad.dev/beta/firefox/+bug/22
+
+
 Affected users
 --------------