Merge lp:~sinzui/launchpad/bug-tracker-widget-0 into lp:launchpad

[Curtis Hovey]

This is my branch to include subordinate fields in the bug tracker widget.
This change updated of the bug tracker widget to the proposed design.
http://people.canonical.com/~curtis/product-bug-tracker-widget.png

    lp:~sinzui/launchpad/bug-tracker-widget-0
    Diff size: 600
    Launchpad bug:
          https://bugs.launchpad.net/bugs/539083
    Test command: ./bin/test -vv \
          -t product-widgets -t test_bugtracker_vocabulary \
          -t test_bugtarget_configure -t xx-product-launchpad-usage \
          -t xx-project-guided-filebug -t bugtrackers-index \
          -t xx-bugtracker.txt -t xx-upstream-bug-tracker-links
    Pre-implementation: bac, edwin, deryck, gary
    Target release: 10.06

Include subordinate fields in the bug tracker widget
----------------------------------------------------

The bugtracker widget does not know that the remote project field is
subordinate to choosing a another bugtracker. The expiration widget is
subordinate to the launchpad bug tracker, but the field is not displayed under
the radio option.

The bugtracker widget could render all the fields in a uniformed way so that it
is clear when the fields are available.

Rules
-----

I considered updating the javascript to control the constraint on
remote_product, but the form does not have enough information to know
when the enable/disabled to field. We need to know the bug tracker type,
which cannot be provided by the picker widget. I focused on making the
widget look the the agreed design.

    * Add the remote_product and expiration fields to the widget's template
    * Switch the registered bug tracker widget to a picker

QA
--

    * Visit a project and choose to configure bugs.
    * Verify that the two fields are shown to be subordinate.
    * Verify that the registered bug tracker widget is a picker

Lint
----

Linting changed files:
  lib/canonical/launchpad/icing/style-3-0.css.in
  lib/canonical/launchpad/vocabularies/configure.zcml
  lib/canonical/launchpad/vocabularies/dbobjects.py
  lib/canonical/widgets/product.py
  lib/canonical/widgets/templates/product-bug-tracker.pt
  lib/lp/bugs/browser/bugtarget.py
  lib/lp/bugs/browser/tests/test_bugtarget_configure.py
  lib/lp/bugs/stories/bug-also-affects/xx-upstream-bugtracker-links.txt
  lib/lp/bugs/stories/bugtracker/bugtrackers-index.txt
  lib/lp/bugs/stories/bugtracker/xx-bugtracker.txt
  lib/lp/bugs/stories/guided-filebug/xx-project-guided-filebug.txt
  lib/lp/bugs/tests/test_bugtracker_vocabulary.py
  lib/lp/registry/doc/product-widgets.txt

Test
----

    * lib/lp/bugs/browser/tests/test_bugtarget_configure.py
    * lib/lp/bugs/stories/bug-also-affects/xx-upstream-bugtracker-links.txt
    * lib/lp/bugs/stories/bugtracker/bugtrackers-index.txt
    * lib/lp/bugs/stories/bugtracker/xx-bugtracker.txt
    * lib/lp/bugs/stories/guided-filebug/xx-project-guided-filebug.txt
      * Updated these tests to use the text field; it is not a select widget
        and the tests were not good since users do not see bugtrackers ids.

    * lib/lp/bugs/tests/test_bugtracker_vocabulary.py
      * Added a test to verify the behaviours to BugTracker vocabs.
    * lib/lp/registry/doc/product-widgets.txt
      * Updated the test to recognise the subordinate fields and the
        change to the registered bug tracker widget.

Implementation
--------------

    * lib/canonical/launchpad/icing/style-3-0.css.in
      * Added a class to show subordinate controls as indented.
    * lib/canonical/launchpad/vocabularies/configure.zcml
      * Registered the WebBugTrackerVocabulary since the picker widget
        gets it via the VocabularyRegistry
    * lib/canonical/launchpad/vocabularies/dbobjects.py
      * Updated BugTrackerVocabulary to be an IHugeVocabulary. The data
        has grown too large for a normal vocabulary. The picker requires
        a IHugeVocabulary.search(query) method.
    * lib/canonical/widgets/product.py
      * Updated ProductBugTrackerWidget to use VocabularyPickerWidget for
        the registered bug tracker field. Redefined the renderValue()
        to work with a dict of item controls and create the two subordinate
        controls. The method then calls the new template to do the
        layout.
      * Extracted the ghost rules from GhostWidget so to create GhostCheckBox
        widget.
    * lib/canonical/widgets/templates/product-bug-tracker.pt
      * Added a template to render the ProductBugTrackerWidget with
        subordinate controls.
    * lib/lp/bugs/browser/bugtarget.py
      * Updated ProductBugConfigurationView to use ghost widgets for the
        remote_product and enable_bug_expiration fields so that the form
        continues to manage state and validation, but the ProductBugTracker
        Widget does the rendering.

[Edwin Grubbs (edwin-grubbs)]

Hi Curtis,

This looks good. I think the radio buttons could be spaced out from each other a little more, and "In a registered bug tracker" might sound better as "In an external bug tracker".

Just one comment on the code below.

-Edwin

>=== modified file 'lib/canonical/launchpad/vocabularies/dbobjects.py'
>--- lib/canonical/launchpad/vocabularies/dbobjects.py 2010-05-16 23:56:51 +0000
>+++ lib/canonical/launchpad/vocabularies/dbobjects.py 2010-06-16 21:35:08 +0000
>@@ -226,15 +229,52 @@
>
>
> class BugTrackerVocabulary(SQLObjectVocabularyBase):
>-
>+ """All web and email based external bug trackers."""
>+ displayname = 'Select a bug tracker'
>+ implements(IHugeVocabulary)
> _table = BugTracker
>+ _filter = 1 == 1

Why not just use?
    _filter = True

review: Approve (code ui)

=== modified file 'lib/canonical/launchpad/icing/style-3-0.css.in'
--- lib/canonical/launchpad/icing/style-3-0.css.in	2010-06-11 18:39:35 +0000
+++ lib/canonical/launchpad/icing/style-3-0.css.in	2010-06-17 19:17:25 +0000
@@ -716,6 +716,12 @@
 form table label {
     font-weight: bold;
     }
+.compound {
+    margin-bottom: .5em;
+    }
+.field.subordinate label {
+    font-weight: normal;
+    }
 fieldset {
     border-width: 2px 0 0;
     margin: 1em 0;
@@ -747,6 +753,9 @@
 .fieldRequired, .fieldOptional {
     color: #999;
     }
+.field.subordinate {
+    margin-left: 2.6em;
+    }
 .formHelp {
     margin: 0.2em 0 0.5em 0.2em;
     color: #777;

=== modified file 'lib/canonical/launchpad/vocabularies/configure.zcml'
--- lib/canonical/launchpad/vocabularies/configure.zcml	2010-01-11 18:59:53 +0000
+++ lib/canonical/launchpad/vocabularies/configure.zcml	2010-06-17 19:17:25 +0000
@@ -95,6 +95,18 @@
 
 
   <securedutility
+    name="WebBugTracker"
+    component="canonical.launchpad.vocabularies.WebBugTrackerVocabulary"
+    provides="zope.schema.interfaces.IVocabularyFactory"
+    >
+    <allow interface="zope.schema.interfaces.IVocabularyFactory"/>
+  </securedutility>
+
+  <class class="canonical.launchpad.vocabularies.WebBugTrackerVocabulary">
+    <allow interface="canonical.launchpad.webapp.vocabulary.IHugeVocabulary"/>
+  </class>
+
+  <securedutility
     name="BugWatch"
     component="canonical.launchpad.vocabularies.BugWatchVocabulary"
     provides="zope.schema.interfaces.IVocabularyFactory"

=== modified file 'lib/canonical/launchpad/vocabularies/dbobjects.py'
--- lib/canonical/launchpad/vocabularies/dbobjects.py	2010-05-16 23:56:51 +0000
+++ lib/canonical/launchpad/vocabularies/dbobjects.py	2010-06-17 19:17:25 +0000
@@ -47,13 +47,16 @@
 import cgi
 from operator import attrgetter
 
-from sqlobject import AND, SQLObjectNotFound
+from sqlobject import AND, CONTAINSSTRING, SQLObjectNotFound
 from storm.expr import SQL
 from zope.component import getUtility
 from zope.interface import implements
 from zope.schema.interfaces import IVocabulary, IVocabularyTokenized
 from zope.schema.vocabulary import SimpleTerm, SimpleVocabulary
 
+from storm.expr import And, Or
+
+from canonical.launchpad.interfaces.lpstorm import IStore
 from lp.code.model.branch import Branch
 from lp.bugs.model.bug import Bug
 from lp.bugs.model.bugtracker import BugTracker
@@ -226,15 +229,52 @@
 
 
 class BugTrackerVocabulary(SQLObjectVocabularyBase):
-
+    """All web and email based external bug trackers."""
+    displayname = 'Select a bug tracker'
+    implements(IHugeVocabulary)
     _table = BugTracker
+    _filter = True
     _orderBy = 'title'
+    _order_by = [BugTracker.title]
+
+    def toTerm(self, obj):
+        """See `IVocabulary`."""
+        return SimpleTerm(obj, obj.name, obj.title)
+
+    def getTermByToken(self, token):
+        """See `IVocabularyTokenized`."""
+        result = IStore(self._table).find(
+            self._table,
+            self._filter,
+            BugTracker.name == token).one()
+        if result is None:
+            raise LookupError(token)
+        return self.toTerm(result)
+
+    def search(self, query):
+        """Search for web bug trackers."""
+        query = query.lower()
+        results = IStore(self._table).find(
+            self._table, And(
+            self._filter,
+            BugTracker.active == True,
+            Or(
+                CONTAINSSTRING(BugTracker.name, query),
+                CONTAINSSTRING(BugTracker.title, query),
+                CONTAINSSTRING(BugTracker.summary, query),
+                CONTAINSSTRING(BugTracker.baseurl, query))))
+        results = results.order_by(self._order_by)
+        return results
+
+    def searchForTerms(self, query=None):
+        """See `IHugeVocabulary`."""
+        results = self.search(query)
+        return CountableIterator(results.count(), results, self.toTerm)
 
 
 class WebBugTrackerVocabulary(BugTrackerVocabulary):
     """All web-based bug tracker types."""
-
-    _filter = BugTracker.q.bugtrackertype != BugTrackerType.EMAILADDRESS
+    _filter = BugTracker.bugtrackertype != BugTrackerType.EMAILADDRESS
 
 
 class LanguageVocabulary(SQLObjectVocabularyBase):

=== modified file 'lib/canonical/widgets/product.py'
--- lib/canonical/widgets/product.py	2010-06-15 03:08:22 +0000
+++ lib/canonical/widgets/product.py	2010-06-17 19:17:25 +0000
@@ -5,6 +5,7 @@
 
 __metaclass__ = type
 __all__ = [
+    'GhostCheckBoxWidget',
     'GhostWidget',
     'LicenseWidget',
     'ProductBugTrackerWidget',
@@ -15,6 +16,7 @@
 import math
 
 from zope.app.form import CustomWidgetFactory
+from zope.app.form.browser.boolwidgets import CheckBoxWidget
 from zope.app.form.browser.textwidgets import TextWidget
 from zope.app.form.browser.widget import renderElement
 from zope.app.form.interfaces import IInputWidget
@@ -24,25 +26,28 @@
 
 from z3c.ptcompat import ViewPageTemplateFile
 
+from lazr.restful.interface import copy_field
+
 from canonical.launchpad.browser.widgets import DescriptionWidget
 from canonical.launchpad.fields import StrippedTextLine
 from canonical.launchpad.interfaces import (
     BugTrackerType, IBugTracker, IBugTrackerSet, ILaunchBag)
 from canonical.launchpad.validators import LaunchpadValidationError
 from canonical.launchpad.validators.email import email_validator
-from canonical.launchpad.vocabularies.dbobjects import (
-    WebBugTrackerVocabulary)
 from canonical.launchpad.webapp import canonical_url
 from canonical.widgets.itemswidgets import (
-    CheckBoxMatrixWidget, LaunchpadDropdownWidget, LaunchpadRadioWidget)
+    CheckBoxMatrixWidget, LaunchpadRadioWidget)
+from canonical.widgets.popup import  VocabularyPickerWidget
 from canonical.widgets.textwidgets import (
     LowerCaseTextWidget, StrippedTextWidget)
+from lp.registry.interfaces.product import IProduct
 
 
 class ProductBugTrackerWidget(LaunchpadRadioWidget):
     """Widget for selecting a product bug tracker."""
 
     _joinButtonToMessageTemplate = u'%s&nbsp;%s'
+    template = ViewPageTemplateFile('templates/product-bug-tracker.pt')
 
     def __init__(self, field, vocabulary, request):
         # pylint: disable-msg=W0233
@@ -50,19 +55,15 @@
 
         # Bug tracker widget.
         self.bugtracker = Choice(
-            vocabulary=WebBugTrackerVocabulary(),
+            vocabulary="WebBugTracker",
             __name__='bugtracker')
-        self.bugtracker_widget = CustomWidgetFactory(LaunchpadDropdownWidget)
+        self.bugtracker_widget = CustomWidgetFactory(VocabularyPickerWidget)
         setUpWidget(
             self, 'bugtracker', self.bugtracker, IInputWidget,
             prefix=self.name, value=field.context.bugtracker,
             context=field.context)
-        if self.bugtracker_widget.extra is None:
-            self.bugtracker_widget.extra = ''
-        ## Select the corresponding radio option automatically if
-        ## the user selects a bug tracker.
-        self.bugtracker_widget.extra += (
-            ' onchange="selectWidget(\'%s.2\', event);"' % self.name)
+        self.bugtracker_widget.onKeyPress = (
+            "selectWidget('%s.2', event);" % self.name)
 
         # Upstream email address field and widget.
         ## This is to make email address bug trackers appear
@@ -198,10 +199,12 @@
             value="external-email", name=self.name, cssClass=self.cssClass)
 
         # All the choices arguments in order.
-        all_arguments = [malone_item_arguments,
-                         external_bugtracker_arguments,
-                         external_bugtracker_email_arguments,
-                         project_bugtracker_arguments]
+        all_arguments = {
+            'launchpad': malone_item_arguments,
+            'external_bugtracker': external_bugtracker_arguments,
+            'external_email': external_bugtracker_email_arguments,
+            'unknown': project_bugtracker_arguments,
+            }
 
         # Figure out the selected choice.
         if value == field.malone_marker:
@@ -219,12 +222,35 @@
             selected = project_bugtracker_arguments
 
         # Render.
-        for arguments in all_arguments:
+        for name, arguments in all_arguments.items():
             if arguments is selected:
                 render = self.renderSelectedItem
             else:
                 render = self.renderItem
-            yield render(**arguments)
+            yield (name, render(**arguments))
+
+    def renderValue(self, value):
+        # Render the items with subordinate fields and support markup.
+        self.bug_trackers = dict(self.renderItems(value))
+        self.product = self.context.context
+        # The view must also use GhostWidget for the 'remote_product' field.
+        self.remote_product = copy_field(IProduct['remote_product'])
+        self.remote_product_widget = CustomWidgetFactory(TextWidget)
+        setUpWidget(
+            self, 'remote_product', self.remote_product, IInputWidget,
+            prefix='field', value=self.product.remote_product,
+            context=self.product)
+        # The view must also use GhostWidget for the 'enable_bug_expiration'
+        # field.
+        self.enable_bug_expiration = copy_field(
+            IProduct['enable_bug_expiration'])
+        self.enable_bug_expiration_widget = CustomWidgetFactory(
+            CheckBoxWidget)
+        setUpWidget(
+            self, 'enable_bug_expiration', self.enable_bug_expiration,
+            IInputWidget, prefix='field',
+            value=self.product.enable_bug_expiration, context=self.product)
+        return self.template()
 
 
 class LicenseWidget(CheckBoxMatrixWidget):
@@ -406,7 +432,7 @@
             return 'text'
 
 
-class GhostWidget(TextWidget):
+class GhostMixin:
     """A simple widget that has no HTML."""
     visible = False
     # This suppresses the stuff above the widget.
@@ -420,3 +446,11 @@
         return ''
 
     hidden = __call__
+
+
+class GhostWidget(GhostMixin, TextWidget):
+    """Suppress the rendering of Text input fields."""
+
+
+class GhostCheckBoxWidget(GhostMixin, CheckBoxWidget):
+    """Suppress the rendering of Bool input fields."""

=== added file 'lib/canonical/widgets/templates/product-bug-tracker.pt'
--- lib/canonical/widgets/templates/product-bug-tracker.pt	1970-01-01 00:00:00 +0000
+++ lib/canonical/widgets/templates/product-bug-tracker.pt	2010-06-17 19:17:25 +0000
@@ -0,0 +1,24 @@
+<tal:root
+  xmlns:tal="http://xml.zope.org/namespaces/tal"
+  xmlns:metal="http://xml.zope.org/namespaces/metal"
+  xmlns:i18n="http://xml.zope.org/namespaces/i18n"
+  omit-tag="">
+  <div class="compound">
+    <div tal:content="structure view/bug_trackers/launchpad" />
+    <div class="field subordinate">
+      <input  tal:replace="structure view/enable_bug_expiration_widget" />
+      <label
+        tal:attributes="for view/enable_bug_expiration_widget/name"
+        tal:content="view/enable_bug_expiration/title" />
+    </div>
+  </div>
+  <div class="compound">
+    <div tal:content="structure view/bug_trackers/external_bugtracker" />
+    <div class="field subordinate">
+      Project ID in bug tracker:
+      <input  tal:replace="structure view/remote_product_widget" />
+    </div>
+  </div>
+  <div class="compound" tal:content="structure view/bug_trackers/external_email" />
+  <div class="compound" tal:content="structure view/bug_trackers/unknown" />
+</tal:root>

=== modified file 'lib/lp/bugs/browser/bugtarget.py'
--- lib/lp/bugs/browser/bugtarget.py	2010-06-15 11:35:12 +0000
+++ lib/lp/bugs/browser/bugtarget.py	2010-06-17 19:17:25 +0000
@@ -98,7 +98,8 @@
 from canonical.launchpad.webapp.publisher import HTTP_MOVED_PERMANENTLY
 from canonical.widgets.bug import BugTagsWidget, LargeBugTagsWidget
 from canonical.widgets.bugtask import NewLineToSpacesWidget
-from canonical.widgets.product import ProductBugTrackerWidget
+from canonical.widgets.product import (
+    ProductBugTrackerWidget, GhostCheckBoxWidget, GhostWidget)
 from lp.registry.vocabularies import ValidPersonOrTeamVocabulary
 
 
@@ -145,7 +146,11 @@
         "bug_reporting_guidelines",
         "bug_reported_acknowledgement",
         ]
+    # This ProductBugTrackerWidget renders enable_bug_expiration and
+    # remote_product as subordinate fields, so this view suppresses them.
     custom_widget('bugtracker', ProductBugTrackerWidget)
+    custom_widget('enable_bug_expiration', GhostCheckBoxWidget)
+    custom_widget('remote_product', GhostWidget)
 
     def validate(self, data):
         """Constrain bug expiration to Launchpad Bugs tracker."""

=== modified file 'lib/lp/bugs/browser/tests/test_bugtarget_configure.py'
--- lib/lp/bugs/browser/tests/test_bugtarget_configure.py	2010-06-14 15:52:41 +0000
+++ lib/lp/bugs/browser/tests/test_bugtarget_configure.py	2010-06-17 19:17:25 +0000
@@ -105,7 +105,7 @@
         form = self._makeForm()
         form['field.enable_bug_expiration'] = 'on'
         form['field.bugtracker'] = 'external'
-        form['field.bugtracker.bugtracker'] = '3'
+        form['field.bugtracker.bugtracker'] = 'debbugs'
         view = create_initialized_view(
             self.product, name='+configure-bugtracker', form=form)
         self.assertEqual([], view.errors)

=== modified file 'lib/lp/bugs/stories/bug-also-affects/xx-upstream-bugtracker-links.txt'
--- lib/lp/bugs/stories/bug-also-affects/xx-upstream-bugtracker-links.txt	2010-06-16 16:47:54 +0000
+++ lib/lp/bugs/stories/bug-also-affects/xx-upstream-bugtracker-links.txt	2010-06-17 19:17:25 +0000
@@ -33,7 +33,7 @@
     >>> admin_browser.getControl(
     ...     name='field.bugtracker').value = ['external']
     >>> admin_browser.getControl(
-    ...     name='field.bugtracker.bugtracker').value = ['1']
+    ...     name='field.bugtracker.bugtracker').value = 'mozilla.org'
     >>> admin_browser.getControl('Change').click()
 
     >>> user_browser.open('http://launchpad.dev/bugs/13/')
@@ -95,8 +95,7 @@
     >>> admin_browser.getControl(
     ...     'In a registered bug tracker:').selected = True
     >>> admin_browser.getControl(
-    ...     name='field.bugtracker.bugtracker').displayValue = [
-    ...         'Debian Bug tracker']
+    ...     name='field.bugtracker.bugtracker').value = 'debbugs'
     >>> admin_browser.getControl('Change').click()
 
     >>> user_browser.open('http://launchpad.dev/bugs/13/')
@@ -122,11 +121,11 @@
 
     >>> admin_browser.open(
     ...     'http://launchpad.dev/thunderbird/+configure-bugtracker')
-    >>> admin_browser.getControl('Remote bug tracker project id').value = (
+    >>> admin_browser.getControl(name='field.remote_product').value = (
     ...     'Thunderbird')
     >>> admin_browser.getControl('Change').click()
 
     >>> admin_browser.open(
     ...     'http://launchpad.dev/thunderbird/+configure-bugtracker')
-    >>> print admin_browser.getControl('Remote bug tracker project id').value
+    >>> print admin_browser.getControl(name='field.remote_product').value
     Thunderbird

=== modified file 'lib/lp/bugs/stories/bugtracker/bugtrackers-index.txt'
--- lib/lp/bugs/stories/bugtracker/bugtrackers-index.txt	2010-05-19 05:47:50 +0000
+++ lib/lp/bugs/stories/bugtracker/bugtrackers-index.txt	2010-06-17 19:17:25 +0000
@@ -92,7 +92,7 @@
     ...         "http://launchpad.dev/%s/+configure-bugtracker" % name)
     ...     admin_browser.getControl("In a registered bug tracker").click()
     ...     bt = admin_browser.getControl(name="field.bugtracker.bugtracker")
-    ...     bt.value = ["3"]
+    ...     bt.value = 'debbugs'
     ...     admin_browser.getControl("Change").click()
     ...
     >>> link_to_debbugs('upstart')

=== modified file 'lib/lp/bugs/stories/bugtracker/xx-bugtracker.txt'
--- lib/lp/bugs/stories/bugtracker/xx-bugtracker.txt	2010-04-09 19:11:36 +0000
+++ lib/lp/bugs/stories/bugtracker/xx-bugtracker.txt	2010-06-17 19:17:25 +0000
@@ -668,8 +668,7 @@
 bug tracker:
 
   >>> admin_browser.open('http://launchpad.dev/mozilla/+edit')
-  >>> admin_browser.getControl('Bug Tracker:').displayValue = [
-  ...     'A test Bugzilla Tracker']
+  >>> admin_browser.getControl('Bug Tracker:').value = 'testbugzilla'
   >>> admin_browser.getControl('Change Details').click()
 
   >>> admin_browser.open(
@@ -677,7 +676,7 @@
   >>> admin_browser.getControl(name='field.bugtracker'
   ...     ).displayValue = ['In a registered bug tracker:']
   >>> admin_browser.getControl(name='field.bugtracker.bugtracker'
-  ...     ).displayValue = ['A test Bugzilla Tracker']
+  ...     ).value = 'testbugzilla'
   >>> admin_browser.getControl('Change').click()
 
 Now the Mozilla Project and Jokosher will appear in the Related

=== modified file 'lib/lp/bugs/stories/guided-filebug/xx-project-guided-filebug.txt'
--- lib/lp/bugs/stories/guided-filebug/xx-project-guided-filebug.txt	2010-04-16 15:06:55 +0000
+++ lib/lp/bugs/stories/guided-filebug/xx-project-guided-filebug.txt	2010-06-17 19:17:25 +0000
@@ -220,7 +220,7 @@
     >>> admin_browser.open('http://launchpad.dev/testy/+configure-bugtracker')
     >>> admin_browser.getControl(name='field.bugtracker').value = ['external']
     >>> admin_browser.getControl(
-    ...     name='field.bugtracker.bugtracker').value = ['3']
+    ...     name='field.bugtracker.bugtracker').value = 'debbugs'
     >>> admin_browser.getControl('Change').click()
 
 And on the filebug page...

=== added file 'lib/lp/bugs/tests/test_bugtracker_vocabulary.py'
--- lib/lp/bugs/tests/test_bugtracker_vocabulary.py	1970-01-01 00:00:00 +0000
+++ lib/lp/bugs/tests/test_bugtracker_vocabulary.py	2010-06-17 19:17:25 +0000
@@ -0,0 +1,123 @@
+# Copyright 2010 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Test the bug tracker vocabularies."""
+
+__metaclass__ = type
+
+from unittest import TestLoader
+
+from zope.schema.vocabulary import getVocabularyRegistry
+
+from canonical.launchpad.ftests import login, login_person
+from canonical.testing import DatabaseFunctionalLayer
+from lp.bugs.interfaces.bugtracker import BugTrackerType
+from lp.testing import TestCaseWithFactory
+
+
+class TestBugTrackerVocabulary(TestCaseWithFactory):
+
+    layer = DatabaseFunctionalLayer
+
+    def setUp(self):
+        super(TestBugTrackerVocabulary, self).setUp()
+        vocabulary_registry = getVocabularyRegistry()
+        self.vocab = vocabulary_registry.get(None, 'BugTracker')
+
+    def test_toTerm(self):
+        # Verify the data in the term.
+        bug_tracker = self.factory.makeBugTracker()
+        login_person(bug_tracker.owner)
+        bug_tracker.name = 'weasel'
+        bug_tracker.title = 'The Weasel Bug Tracker'
+        [term] = self.vocab.searchForTerms('weasel')
+        self.assertEqual(bug_tracker, term.value)
+        self.assertEqual(bug_tracker.name, term.token)
+        self.assertEqual(bug_tracker.title, term.title)
+
+    def test_getTermByToken_match(self):
+        # Verify the token by lookup.
+        bug_tracker = self.factory.makeBugTracker()
+        login_person(bug_tracker.owner)
+        bug_tracker.name = 'mink'
+        term = self.vocab.getTermByToken('mink')
+        self.assertEqual(bug_tracker, term.value)
+
+    def test_getTermByToken_no_match(self):
+        # Verify that a LookupError error is raised.
+        self.assertRaises(
+            LookupError, self.vocab.getTermByToken, 'does not exist')
+
+    def searchForBugTrackers(self, query):
+        terms = self.vocab.searchForTerms(query)
+        return [term.value for term in terms]
+
+    def test_search_name(self):
+        # Verify that queries match name text.
+        bug_tracker = self.factory.makeBugTracker()
+        login_person(bug_tracker.owner)
+        bug_tracker.name = 'skunkworks'
+        bug_trackers = self.searchForBugTrackers('skunk')
+        self.assertEqual([bug_tracker], bug_trackers)
+
+    def test_search_title(self):
+        # Verify that queries match title text.
+        bug_tracker = self.factory.makeBugTracker()
+        login_person(bug_tracker.owner)
+        bug_tracker.title = 'A ferret in your pants'
+        bug_trackers = self.searchForBugTrackers('ferret')
+        self.assertEqual([bug_tracker], bug_trackers)
+
+    def test_search_summary(self):
+        # Verify that queries match summary text.
+        bug_tracker = self.factory.makeBugTracker()
+        login_person(bug_tracker.owner)
+        bug_tracker.summary = 'A badger is a member of the weasel family.'
+        bug_trackers = self.searchForBugTrackers('badger')
+        self.assertEqual([bug_tracker], bug_trackers)
+
+    def test_search_baseurl(self):
+        # Verify that queries match baseurl text.
+        bug_tracker = self.factory.makeBugTracker(
+            base_url='http://bugs.otter.dom/')
+        bug_trackers = self.searchForBugTrackers('otter')
+        self.assertEqual([bug_tracker], bug_trackers)
+
+    def test_search_inactive(self):
+        # Verify that inactive bug trackers are not returned by search,
+        # but are in the vocabulary.
+        bug_tracker = self.factory.makeBugTracker()
+        login('[e-mail]')
+        bug_tracker.name = 'stoat'
+        bug_tracker.active = False
+        bug_trackers = self.searchForBugTrackers('stoat')
+        self.assertEqual([], bug_trackers)
+        term = self.vocab.getTermByToken('stoat')
+        self.assertEqual(bug_tracker, term.value)
+
+
+class TestWebBugTrackerVocabulary(TestCaseWithFactory):
+
+    layer = DatabaseFunctionalLayer
+
+    def setUp(self):
+        super(TestWebBugTrackerVocabulary, self).setUp()
+        vocabulary_registry = getVocabularyRegistry()
+        self.vocab = vocabulary_registry.get(None, 'WebBugTracker')
+
+    def test_search_no_email_type(self):
+        # Verify that emailaddress bug trackers are not returned by search,
+        # and are not in the vocabulary.
+        bug_tracker = self.factory.makeBugTracker(
+            bugtrackertype=BugTrackerType.EMAILADDRESS)
+        login_person(bug_tracker.owner)
+        bug_tracker.name = 'marten'
+        terms = self.vocab.searchForTerms('marten')
+        bug_trackers = [term.value for term in terms]
+        self.assertEqual([], bug_trackers)
+        self.assertRaises(
+            LookupError, self.vocab.getTermByToken, 'marten')
+
+
+def test_suite():
+    return TestLoader().loadTestsFromName(__name__)

=== modified file 'lib/lp/registry/doc/product-widgets.txt'
--- lib/lp/registry/doc/product-widgets.txt	2010-06-15 03:11:34 +0000
+++ lib/lp/registry/doc/product-widgets.txt	2010-06-17 19:17:25 +0000
@@ -48,10 +48,13 @@
     ...     soup = BeautifulSoup(html)
     ...     labels = soup('label')
     ...     for label in labels:
-    ...         if label.previous.previous.get('checked'):
+    ...         control = label.previous.previous
+    ...         if control['type'] == 'radio' and control.get('checked'):
     ...             print '[X]', extract_text(label)
-    ...         else:
+    ...         elif control['type'] == 'radio':
     ...             print '[ ]', extract_text(label)
+    ...         else:
+    ...             pass
     >>> print_items(widget())
     [ ] In Launchpad
     [ ] In a registered bug tracker:
@@ -124,7 +127,7 @@
 
     >>> form = {
     ...     'field.bugtracker': 'malone',
-    ...     'field.bugtracker.bugtracker': '3',
+    ...     'field.bugtracker.bugtracker': 'debbugs',
     ...     }
     >>> widget = ProductBugTrackerWidget(
     ...     product_bugtracker, product_bugtracker.vocabulary,
@@ -137,8 +140,6 @@
 The bugtracker value passed to the widget caused the sub-widget used to select
 the bug tracker to have the correct value.
 
-    >>> widget.bugtracker_widget.getInputValue().id
-    3
     >>> print widget.bugtracker_widget.getInputValue().name
     debbugs
 
@@ -210,6 +211,28 @@
     >>> print firefox.bugtracker
     None
 
+The ProductBugTrackerWidget renders two fields that are subordinate to
+the 4 choices.
+
+    >>> def print_controls(html):
+    ...     soup = BeautifulSoup(html)
+    ...     controls = soup('input')
+    ...     for control in controls:
+    ...         if control['type'] != 'hidden':
+    ...             if 'subordinate' in control.parent.get('class', ''):
+    ...                 print '--'
+    ...             print control['id'], control['type']
+
+    >>> print_controls(widget())
+    field.bugtracker.0 radio
+    -- field.enable_bug_expiration checkbox
+    field.bugtracker.2 radio
+    field.bugtracker.bugtracker text
+    -- field.remote_product text
+    field.bugtracker.3 radio
+    field.bugtracker.upstream_email_address text
+    field.bugtracker.1 radio
+
 
 Choosing a License
 ==================

=== modified file 'lib/lp/registry/stories/project/xx-project-edit.txt'
--- lib/lp/registry/stories/project/xx-project-edit.txt	2010-04-19 08:11:52 +0000
+++ lib/lp/registry/stories/project/xx-project-edit.txt	2010-06-17 19:17:25 +0000
@@ -16,7 +16,7 @@
     >>> browser.getControl('Project Group Summary').value = 'New Summary.'
     >>> browser.getControl('Description').value = 'New Description.'
     >>> browser.getControl('Homepage URL').value = 'http://new-url.com/'
-    >>> browser.getControl(name='field.bugtracker').value = ['1']
+    >>> browser.getControl(name='field.bugtracker').value = 'mozilla.org'
     >>> browser.getControl('Change Details').click()
 
     >>> browser.url