Merge lp:~gmb/launchpad/show-bwa-on-bw-pages-bug-558409 into lp:launchpad/db-devel

[Graham Binns]

The latest bug watch activity will now be displayed on the watch's +edit page.

This branch adds the recent activity for a bug watch to its +edit page.

To test this:

 1. Run cronscripts/garbo-hourly.py to schedule some watches
 2. Run cronscripts/checkwatches.py to check them
 3. Visit https://bugs.launchpad.dev/bugs/15/+watch/11/+edit to see
    the +edit page with activity data.

I genially stole the design for the activity list from the code guys
(see any ~vcs-imports branch).

No lint.

== lib/lp/bugs/browser/bugwatch.py ==

 - I've added a property to BugWatchView, recent_watch_activity, which
   will return a list of dicts containing data about recent activity
   which can then be TAL formatted. I did this rather than access the
   watch's activity property directly since this allowed me to avoid
   having to do things like python:view.getIconForActivityStatus() in
   the TAL, which is just hateful.
 - I've added a watch_has_activity property to BugWatchEditView. This is
   used to decide whether or not the activity portlet is shown.

== lib/lp/bugs/browser/configure.zcml ==

 - I've added the ZCML for the activity portlet.

== lib/lp/bugs/browser/tests/bugwatch-views.txt ==

 - I've added tests for BugWatchView.recent_watch_activity and
   BugWatchEditView.watch_has_activity.

== lib/lp/bugs/stories/bugwatches/xx-edit-bugwatch.txt ==

 - I've added tests for the displaying of activity data on the
   BugWatch +edit page.

== lib/lp/bugs/templates/bugwatch-editform.pt ==

 - I've updated the template to show the activity portlet if there's any
   activity on the watch.

== lib/lp/bugs/templates/bugwatch-portlet-activity.pt ==

 - I've added a template for displaying the bug watch activity.

[Eleanor Berger (intellectronica)]

(14:17:06) intellectronica: gmb: i think it can be improved by highlighting the last (current) status, but since this design is identical to the code imports ui, i'm not sure if we should change it at all
(14:17:26) gmb: intellectronica, Yeah, I think that the general thinking is that we should keep the same design.
(14:17:57) intellectronica: gmb: did you discuss that already with anyone before doing it?
(14:18:38) gmb: intellectronica, When I talked to deryck yesterday he mentioned that someone (jml, I think) was keen to see the code design re-used, and this has been mentioned in previous discussions.
(14:19:24) intellectronica: gmb: yes, i think it makes sense, and in that case, assuming we're not going to change the design on code pages too, i agree that leaving it like this is the pragmatic choice.

review: Approve (ui*)

[Eleanor Berger (intellectronica)]

FYI, Curtis, Graham kindly provided screenshots of the page. See https://devpad.canonical.com/~gbinns/bwa-screenshot-1.png and https://devpad.canonical.com/~gbinns/bwa-screenshot-2.png

[Curtis Hovey (sinzui)]

Hi Graham.

Your changes are a fine addition.

I noted that the page is missing a heading and a breadcrumb. There is no obvious parent for these so the fix is not trivial. As this feature is rarely used by users, we agree to report a bug about this issue.

review: Approve (ui)

[Brad Crittenden (bac)]

Nice branch Graham.

In your browser test I'd like to see the state of watch_has_activity before you add an activity to show that it does transition. Other than that it looks good.

review: Approve (code)

=== modified file 'lib/lp/bugs/browser/bugwatch.py'
--- lib/lp/bugs/browser/bugwatch.py	2010-01-15 03:32:46 +0000
+++ lib/lp/bugs/browser/bugwatch.py	2010-04-13 14:53:49 +0000
@@ -21,7 +21,8 @@
 from canonical.launchpad.fields import URIField
 from canonical.launchpad.webapp.interfaces import ILaunchBag
 from lp.bugs.interfaces.bugwatch import (
-    IBugWatch, IBugWatchSet, NoBugTrackerFound, UnrecognizedBugTrackerURL)
+    BUG_WATCH_ACTIVITY_SUCCESS_STATUSES, IBugWatch, IBugWatchSet,
+    NoBugTrackerFound, UnrecognizedBugTrackerURL)
 from canonical.launchpad.webapp import (
     action, canonical_url, custom_widget, GetitemNavigation,
     LaunchpadFormView, LaunchpadView)
@@ -68,6 +69,28 @@
 
         return displayed_comments
 
+    @property
+    def recent_watch_activity(self):
+        """Return a list of dicts representing recent watch activity."""
+        activity_items = []
+        for activity in self.context.activity:
+            if activity.result in BUG_WATCH_ACTIVITY_SUCCESS_STATUSES:
+                icon = "/@@/yes"
+                completion_message = "completed successfully"
+            else:
+                icon = "/@@/no"
+                completion_message = (
+                    "failed with error '%s'" % activity.result.title)
+
+            activity_items.append({
+                'icon': icon,
+                'date': activity.activity_date,
+                'completion_message': completion_message,
+                'result_text': activity.result.title,
+                })
+
+        return activity_items
+
 
 class BugWatchEditForm(Interface):
     """Form definition for the bug watch edit view."""
@@ -99,6 +122,11 @@
         """See `LaunchpadFormView.`"""
         return {'url' : self.context.url}
 
+    @property
+    def watch_has_activity(self):
+        """Return True if there has been activity on the bug watch."""
+        return not self.context.activity.is_empty()
+
     def validate(self, data):
         """See `LaunchpadFormView.`"""
         if 'url' not in data:
@@ -136,3 +164,4 @@
         return canonical_url(getUtility(ILaunchBag).bug)
 
     cancel_url = next_url
+

=== modified file 'lib/lp/bugs/browser/configure.zcml'
--- lib/lp/bugs/browser/configure.zcml	2010-03-11 01:39:25 +0000
+++ lib/lp/bugs/browser/configure.zcml	2010-04-13 14:53:49 +0000
@@ -1103,6 +1103,12 @@
             class="lp.bugs.browser.bugwatch.BugWatchEditView"
             permission="launchpad.AnyPerson"
             template="../templates/bugwatch-editform.pt"/>
+        <browser:page
+            for="lp.bugs.interfaces.bugwatch.IBugWatch"
+            name="+portlet-activity"
+            class="lp.bugs.browser.bugwatch.BugWatchView"
+            permission="launchpad.AnyPerson"
+            template="../templates/bugwatch-portlet-activity.pt"/>
         <browser:pages
             for="lp.bugs.interfaces.bugwatch.IBugWatch"
             permission="launchpad.AnyPerson">

=== modified file 'lib/lp/bugs/browser/tests/bugwatch-views.txt'
--- lib/lp/bugs/browser/tests/bugwatch-views.txt	2009-10-22 11:55:51 +0000
+++ lib/lp/bugs/browser/tests/bugwatch-views.txt	2010-04-13 14:53:49 +0000
@@ -1,4 +1,5 @@
-= Bug Watch Edit Page =
+Bug Watch Edit Page
+===================
 
 It's possible to edit a bug watch on +edit, as well as deleting it.
 Deleting a bug watch is only possible when the bug watch isn't linked to
@@ -28,3 +29,83 @@
     >>> [action.label for action in unlinked_bugwatch_view.actions
     ...  if action.available()]
     ['Change', 'Delete Bug Watch']
+
+
+Recent activity
+---------------
+
+The Bug Watch +edit page displays a list of the recent activity for the
+watch. This is provided by the BugWatch activity portlet view and can be
+accessed via the recent_watch_activity property of BugWatchView.
+
+We'll create a new watch in order to demonstrate this.
+
+    >>> from canonical.launchpad.ftests import login
+    >>> login('[e-mail]')
+    >>> new_watch = factory.makeBugWatch()
+
+The view for the new watch will have an empty recent_watch_activity list
+since it hasn't been updated yet.
+
+    >>> new_watch_view = create_initialized_view(
+    ...     new_watch, '+portlet-activity')
+    >>> len(new_watch_view.recent_watch_activity)
+    0
+
+The BugWatch +edit view has a watch_has_activity property, which is used
+to determine whether the recent activity portlet should be displayed.
+
+    >>> new_watch_edit_view = create_initialized_view(
+    ...     new_watch, '+edit')
+    >>> print new_watch_edit_view.watch_has_activity
+    False
+
+Adding a successful activity entry for the watch will cause it to show
+up on the BugWatchView's recent_watch_activity property.
+
+    >>> new_watch.addActivity()
+    >>> len(new_watch_view.recent_watch_activity)
+    1
+
+The BugWatch +edit view's watch_has_activity property will also have
+changed.
+
+    >>> new_watch_edit_view = create_initialized_view(
+    ...     new_watch, '+edit')
+    >>> print new_watch_edit_view.watch_has_activity
+    True
+
+Each entry in the recent_watch_activity list is a dict containing data
+about the activity.
+
+    >>> from pprint import pprint
+    >>> for activity_dict in new_watch_view.recent_watch_activity:
+    ...     pprint(activity_dict)
+    {'completion_message': 'completed successfully',
+     'date': datetime.datetime(...tzinfo=<UTC>),
+     'icon': '/@@/yes',
+     'result_text': 'Synchronisation succeeded'}
+
+If an activity entry records a failure, the 'icon' entry in the dict
+will point to the 'no' icon and the completion_message will explain the
+failure.
+
+We'll commit the transaction to make sure that the two activities have
+different dates.
+
+    >>> import transaction
+    >>> transaction.commit()
+
+    >>> from lp.bugs.interfaces.bugwatch import BugWatchActivityStatus
+    >>> new_watch.addActivity(result=BugWatchActivityStatus.BUG_NOT_FOUND)
+    >>> for activity_dict in new_watch_view.recent_watch_activity:
+    ...     pprint(activity_dict)
+    {'completion_message': "failed with error 'Bug Not Found'",
+     'date': datetime.datetime(...tzinfo=<UTC>),
+     'icon': '/@@/no',
+     'result_text': 'Bug Not Found'}
+    {'completion_message': 'completed successfully',
+     'date': datetime.datetime(...tzinfo=<UTC>),
+     'icon': '/@@/yes',
+     'result_text': 'Synchronisation succeeded'}
+

=== modified file 'lib/lp/bugs/stories/bugwatches/xx-edit-bugwatch.txt'
--- lib/lp/bugs/stories/bugwatches/xx-edit-bugwatch.txt	2010-04-09 12:00:54 +0000
+++ lib/lp/bugs/stories/bugwatches/xx-edit-bugwatch.txt	2010-04-13 14:53:49 +0000
@@ -77,3 +77,46 @@
     ...     admin_browser.contents, 'bugwatch-next_check')
     >>> print extract_text(data_tag.renderContents())
     Next check: 2010-04-08...
+
+
+Recent activity
+---------------
+
+Recent activity on a bug watch is shown on the page as a list of
+activity entries. When a watch has not been checked, no activity is
+shown.
+
+    >>> admin_browser.open('http://bugs.launchpad.dev/bugs/1/+watch/2')
+    >>> recent_activity_list = find_tag_by_id(
+    ...     admin_browser.contents, 'recent-watch-activity')
+    >>> print recent_activity_list
+    None
+
+Adding some activity to the watch will cause it to show up in the recent
+activity list.
+
+    >>> login('[e-mail]')
+    >>> watch = getUtility(IBugWatchSet).get(2)
+    >>> watch.addActivity()
+    >>> logout()
+
+    >>> admin_browser.open('http://bugs.launchpad.dev/bugs/1/+watch/2')
+    >>> recent_activity_list = find_tag_by_id(
+    ...     admin_browser.contents, 'recent-watch-activity')
+    >>> print extract_text(recent_activity_list)
+    Update completed successfully ... ago
+
+If an update fails, that too will be reflected in the list.
+
+    >>> from lp.bugs.interfaces.bugwatch import BugWatchActivityStatus
+    >>> login('[e-mail]')
+    >>> watch = getUtility(IBugWatchSet).get(2)
+    >>> watch.addActivity(result=BugWatchActivityStatus.BUG_NOT_FOUND)
+    >>> logout()
+
+    >>> admin_browser.open('http://bugs.launchpad.dev/bugs/1/+watch/2')
+    >>> recent_activity_list = find_tag_by_id(
+    ...     admin_browser.contents, 'recent-watch-activity')
+    >>> print extract_text(recent_activity_list)
+    Update failed with error 'Bug Not Found' ... ago
+    Update completed successfully ... ago

=== modified file 'lib/lp/bugs/templates/bugwatch-editform.pt'
--- lib/lp/bugs/templates/bugwatch-editform.pt	2009-09-03 12:43:53 +0000
+++ lib/lp/bugs/templates/bugwatch-editform.pt	2010-04-13 14:53:49 +0000
@@ -21,6 +21,10 @@
         </div>
       </div>
 
+      <div class="yui-g" tal:condition="view/watch_has_activity">
+        <div tal:replace="structure context/@@+portlet-activity" />
+      </div>
+
       <div class="yui-g">
         <div metal:use-macro="context/@@launchpad_form/form"/>
       </div>

=== added file 'lib/lp/bugs/templates/bugwatch-portlet-activity.pt'
--- lib/lp/bugs/templates/bugwatch-portlet-activity.pt	1970-01-01 00:00:00 +0000
+++ lib/lp/bugs/templates/bugwatch-portlet-activity.pt	2010-04-13 14:53:49 +0000
@@ -0,0 +1,17 @@
+<div
+    xmlns:tal="http://xml.zope.org/namespaces/tal"
+    xmlns:metal="http://xml.zope.org/namespaces/metal"
+    xmlns:i18n="http://xml.zope.org/namespaces/i18n"
+    class="portlet" id="portlet-watches">
+  <h2>Recent activity</h2>
+  <div id="recent-watch-activity">
+    <tal:activity repeat="activity view/recent_watch_activity">
+      <div>
+        <img tal:attributes="src activity/icon; title activity/result_text" />
+        Update
+        <tal:message replace="activity/completion_message" />
+        <tal:time replace="activity/date/fmt:displaydate" />
+      </div>
+    </tal:activity>
+  </div>
+</div>