Merge lp:~benji/launchpad/bug-649252 into lp:launchpad

[Benji York]

[r=leonardr][bug=649252] add an unsubscribe link to non-verbose bug notifications

When LP users check the "Include bug descriptions when sending me bug
notifications" option on their profile they get "verbose" emails that
include an unsubscribe link in messages about bugs to which they are
directly subscribed. If they do not check that option, they get shorter
email messages that do not include the unsubscribe link.

This branch changes the behavior so that the unsubscribe link is always
present.

The doctest (lib/canonical/launchpad/emailtemplates/bug-notification.txt)
that deals with bug notification emails needed a couple of changes
because of the new contents of the email and I added a small section to
explicitly call out the unsubscribe link in the non-verbose email
messages.

My lint is broken so I don't have anything to say there. If I get it
fixed I'll update the MP.

[Leonard Richardson (leonardr)]

"Neither does Verbose Team Person" doesn't make sense anymore--you should change it to something like "Verbose Team Person gets a concise email, even though they belong to a team that gets verbose email."

I also don't understand why you added the two blank lines starting on line 44 of the diff.

This looks good otherwise.

review: Approve

[Benji York (benji)]

> "Neither does Verbose Team Person" doesn't make sense anymore--you should
> change it to something like "Verbose Team Person gets a concise email, even
> though they belong to a team that gets verbose email."

Thanks. Fixed.

> I also don't understand why you added the two blank lines starting on line 44
> of the diff.

The way Python string formatting is used to fill in the templates causes
trailing newlines. I just fixed this by adding a .strip() to the email
body after the template is filled in. I was then able to remove all the
trailing <BLANKLINE>s in the test.

=== modified file 'lib/canonical/launchpad/emailtemplates/bug-notification.txt'
--- lib/canonical/launchpad/emailtemplates/bug-notification.txt	2011-01-06 14:43:46 +0000
+++ lib/canonical/launchpad/emailtemplates/bug-notification.txt	2011-02-16 14:15:40 +0000
@@ -6,3 +6,5 @@
 
 Title:
 %(bug_title)s
+
+%(unsubscribe_notice)s

=== modified file 'lib/lp/bugs/doc/bugnotification-sending.txt'
--- lib/lp/bugs/doc/bugnotification-sending.txt	2011-02-08 14:34:55 +0000
+++ lib/lp/bugs/doc/bugnotification-sending.txt	2011-02-16 14:15:40 +0000
@@ -80,7 +80,6 @@
     <BLANKLINE>
     Title:
       Firefox does not support SVG
-    <BLANKLINE>
     ----------------------------------------------------------------------
     To: [e-mail]
     From: Sample Person <[e-mail]>
@@ -95,7 +94,6 @@
     <BLANKLINE>
     Title:
       Firefox does not support SVG
-    <BLANKLINE>
     ----------------------------------------------------------------------
     To: [e-mail]
     From: Sample Person <[e-mail]>
@@ -111,7 +109,6 @@
     <BLANKLINE>
     Title:
       Firefox does not support SVG
-    <BLANKLINE>
     ----------------------------------------------------------------------
     To: [e-mail]
     From: Sample Person <[e-mail]>
@@ -128,6 +125,7 @@
     Title:
       Firefox does not support SVG
     <BLANKLINE>
+    ...
     ----------------------------------------------------------------------
 
 You can see that the message above contains the bug's initial comment's
@@ -249,7 +247,6 @@
     <BLANKLINE>
     Title:
       Firefox does not support SVG
-    <BLANKLINE>
     ----------------------------------------------------------------------
     To: [e-mail]
     ...
@@ -343,7 +340,7 @@
      'http://bugs.launchpad.dev/bugs/1',
      '',
      'Title:',
-     '  Firefox does not support SVG']
+     '  Firefox does not support SVG'...]
 
     >>> flush_notifications()
 
@@ -429,14 +426,13 @@
     <BLANKLINE>
     a comment.
     <BLANKLINE>
-    --
+    -- 
     You received this bug notification because you are a member of Ubuntu
     Team, which is the registrant for Ubuntu.
     http://bugs.launchpad.dev/bugs/16
     <BLANKLINE>
     Title:
       new bug
-    <BLANKLINE>
     ----------------------------------------------------------------------
     To: [e-mail]
     From: Sample Person <[e-mail]>
@@ -448,7 +444,7 @@
     <BLANKLINE>
     a comment.
     <BLANKLINE>
-    --
+    -- 
     You received this bug notification because you are a direct subscriber
     of the bug.
     http://bugs.launchpad.dev/bugs/16
@@ -456,6 +452,8 @@
     Title:
       new bug
     <BLANKLINE>
+    To unsubscribe from this bug, go to:
+    http://bugs.launchpad.dev/ubuntu/+bug/16/+subscribe
     ----------------------------------------------------------------------
 
     >>> flush_notifications()
@@ -982,11 +980,17 @@
     <BLANKLINE>
     Title:
       In the beginning...
-    <BLANKLINE>
     ----------------------------------------------------------------------
 
-Neither does Verbose Team Person - while the team wants verbose emails,
-he wants concise ones.
+However, Concise Person does get an unsubscribe link.
+
+    >>> print_notification(collated_messages['[e-mail]'][0])
+    To: [e-mail]
+    ...
+    To unsubscribe from this bug, go to:...
+
+Verbose Team Person gets a concise email, even though they belong to a team
+that gets verbose email.
 
     >>> print_notification(collated_messages['[e-mail]'][0])
     To: [e-mail]
@@ -1003,7 +1007,6 @@
     <BLANKLINE>
     Title:
       In the beginning...
-    <BLANKLINE>
     ----------------------------------------------------------------------
 
 Whereas Verbose Person does get the description and task status:
@@ -1034,7 +1037,6 @@
     <BLANKLINE>
     To unsubscribe from this bug, go to:
     http://bugs.launchpad.dev/.../+bug/.../+subscribe
-    <BLANKLINE>
     ----------------------------------------------------------------------
 
 And Concise Team Person does too, even though his team doesn't want them:
@@ -1062,7 +1064,6 @@
        This is a long description of the bug, which
        will be automatically wrapped by the BugNotification
        machinery. Ain't technology great?
-    <BLANKLINE>
     ----------------------------------------------------------------------
 
 It's important to note that the bug title and description are wrapped
@@ -1078,19 +1079,17 @@
      ...
      'Bug description:',
      '  This is a long description of the bug, which will be automatically',
-     "  wrapped by the BugNotification machinery. Ain't technology great?",
-    ...
+     "  wrapped by the BugNotification machinery. Ain't technology great?"]
 
 The title is also wrapped and indented in normal notifications.
 
     >>> message = collated_messages['[e-mail]'][0]
     >>> payload = message.get_payload(decode=True)
-    >>> print payload.split('\n')
+    >>> print payload.strip().split('\n')
     [...
      'Title:',
      '  In the beginning, the universe was created. This has made a lot of',
-     '  people very angry and has been widely regarded as a bad move',
-     '']
+     '  people very angry and has been widely regarded as a bad move']
 
 Self-Generated Bug Notifications
 --------------------------------
@@ -1388,7 +1387,6 @@
     You received this bug notification because you are subscribed to
     mozilla-firefox in ubuntu.
     ...
-    <BLANKLINE>
     ----------------------------------------------------------------------
     To: [e-mail]
     From: Sample Person <[e-mail]>
@@ -1406,7 +1404,6 @@
     <BLANKLINE>
     Title:
       Firefox does not support SVG
-    <BLANKLINE>
     ----------------------------------------------------------------------
     To: [e-mail]
     ...

=== modified file 'lib/lp/bugs/scripts/bugnotification.py'
--- lib/lp/bugs/scripts/bugnotification.py	2011-02-04 16:23:08 +0000
+++ lib/lp/bugs/scripts/bugnotification.py	2011-02-16 14:15:40 +0000
@@ -151,7 +151,7 @@
         else:
             email_template = 'bug-notification.txt'
 
-        body = get_email_template(email_template) % body_data
+        body = (get_email_template(email_template) % body_data).strip()
         msg = bug_notification_builder.build(
             from_address, address, body, subject, email_date,
             rationale, references, msgid)