Merge lp:~thumper/launchpad/new-code-import-email-show-type into lp:launchpad

[Tim Penhey]

Send the rcs_type and location in the new code import email.

New code imports should include the type and the import location.

Testing is easy: register a new code import and check the email.

[Michael Hudson-Doyle (mwhudson)]

Hi Tim,

Yay for this :)

Two comments:

I think "CVS" would be better than "Concurrent Versions System" in the email and "Subversion" better than "Subversion via bzr-svn". For the former, one could even change the title of the enum, although that will break some tests.

The second point is much simpler: there is too much vertical whitespace at the end of the test file :)

But in general, very happy to see this move.

Cheers,
mwh

[Michael Hudson-Doyle (mwhudson)]

review: Approve

=== modified file 'lib/canonical/launchpad/emailtemplates/new-code-import.txt'
--- lib/canonical/launchpad/emailtemplates/new-code-import.txt	2008-06-20 18:54:03 +0000
+++ lib/canonical/launchpad/emailtemplates/new-code-import.txt	2010-03-09 07:40:54 +0000
@@ -1,5 +1,7 @@
-A new code import has been requested by %(person)s:
+A new %(rcs_type)s code import has been requested by %(person)s:
     %(branch)s
+from
+    %(location)s
 
 -- 
 You are getting this email because you are a member of the vcs-imports team.

=== modified file 'lib/lp/code/doc/codeimport.txt'
--- lib/lp/code/doc/codeimport.txt	2010-03-05 03:51:59 +0000
+++ lib/lp/code/doc/codeimport.txt	2010-03-09 07:40:54 +0000
@@ -98,10 +98,13 @@
     New code import: firefox/trunk-cvs
     >>> print message['X-Launchpad-Message-Rationale']
     Operator @vcs-imports
-    >>> print message.get_payload()
-    A new code import has been requested by No Privileges Person:
+    >>> print message.get_payload(decode=True)
+    A new CVS code import has been requested by No Privileges Person:
         http://code.launchpad.dev/~no-priv/firefox/trunk-cvs
-    -- =
+    from
+        :pserver:[e-mail]:/cvsroot, hello
+    <BLANKLINE>
+    -- 
     You are getting this email because you are a member of the vcs-imports team.
 
 Creating a CodeImport object creates a corresponding CodeImportEvent.

=== modified file 'lib/lp/code/mail/codeimport.py'
--- lib/lp/code/mail/codeimport.py	2010-01-12 03:46:21 +0000
+++ lib/lp/code/mail/codeimport.py	2010-03-09 07:40:54 +0000
@@ -32,9 +32,23 @@
     user = IPerson(event.user)
     subject = 'New code import: %s/%s' % (
         code_import.product.name, code_import.branch.name)
+    if code_import.rcs_type == RevisionControlSystems.CVS:
+        location = '%s, %s' % (code_import.cvs_root, code_import.cvs_module)
+    else:
+        location = code_import.url
+    rcs_type_map = {
+        RevisionControlSystems.CVS: 'CVS',
+        RevisionControlSystems.SVN: 'subversion',
+        RevisionControlSystems.BZR_SVN: 'subversion',
+        RevisionControlSystems.GIT: 'git',
+        RevisionControlSystems.HG: 'mercurial',
+        }
     body = get_email_template('new-code-import.txt') % {
         'person': code_import.registrant.displayname,
-        'branch': canonical_url(code_import.branch)}
+        'branch': canonical_url(code_import.branch),
+        'rcs_type': rcs_type_map[code_import.rcs_type],
+        'location': location,
+        }
 
     from_address = format_address(
         user.displayname, user.preferredemail.email)
@@ -42,7 +56,9 @@
     vcs_imports = getUtility(ILaunchpadCelebrities).vcs_imports
     headers = {'X-Launchpad-Branch': code_import.branch.unique_name,
                'X-Launchpad-Message-Rationale':
-                   'Operator @%s' % vcs_imports.name}
+                   'Operator @%s' % vcs_imports.name,
+               'X-Launchpad-Notification-Type': 'code-import',
+               }
     for address in get_contact_email_addresses(vcs_imports):
         simple_sendmail(from_address, address, subject, body, headers)
 

=== added file 'lib/lp/code/mail/tests/test_codeimport.py'
--- lib/lp/code/mail/tests/test_codeimport.py	1970-01-01 00:00:00 +0000
+++ lib/lp/code/mail/tests/test_codeimport.py	2010-03-09 07:40:54 +0000
@@ -0,0 +1,116 @@
+# Copyright 2010 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Tests for code import related mailings"""
+
+from email import message_from_string
+import transaction
+from unittest import TestLoader
+
+from canonical.testing import DatabaseFunctionalLayer
+
+from lp.code.enums import RevisionControlSystems
+from lp.services.mail import stub
+from lp.testing import login_person, TestCaseWithFactory
+
+
+class TestNewCodeImports(TestCaseWithFactory):
+    """Test the emails sent out for new code imports."""
+
+    layer = DatabaseFunctionalLayer
+
+    def test_cvs_import(self):
+        # Test the email for a new CVS import.
+        eric = self.factory.makePerson(name='eric')
+        fooix = self.factory.makeProduct(name='fooix')
+        # Eric needs to be logged in for the mail to be sent.
+        login_person(eric)
+        code_import = self.factory.makeCodeImport(
+            cvs_root=':pserver:[e-mail]:/cvsroot',
+            cvs_module='a_module', branch_name='import',
+            product=fooix, registrant=eric)
+        transaction.commit()
+        msg = message_from_string(stub.test_emails[0][2])
+        self.assertEqual('code-import', msg['X-Launchpad-Notification-Type'])
+        self.assertEqual('~eric/fooix/import', msg['X-Launchpad-Branch'])
+        self.assertEqual(
+            'A new CVS code import has been requested by Eric:\n'
+            '    http://code.launchpad.dev/~eric/fooix/import\n'
+            'from\n'
+            '    :pserver:[e-mail]:/cvsroot, a_module\n'
+            '\n'
+            '-- \nYou are getting this email because you are a member of the '
+            'vcs-imports team.\n', msg.get_payload(decode=True))
+
+    def test_svn_import(self):
+        # Test the email for a new subversion import.
+        eric = self.factory.makePerson(name='eric')
+        fooix = self.factory.makeProduct(name='fooix')
+        # Eric needs to be logged in for the mail to be sent.
+        login_person(eric)
+        code_import = self.factory.makeCodeImport(
+            svn_branch_url='svn://svn.example.com/fooix/trunk',
+            branch_name='trunk', product=fooix, registrant=eric,
+            rcs_type=RevisionControlSystems.BZR_SVN)
+        transaction.commit()
+        msg = message_from_string(stub.test_emails[0][2])
+        self.assertEqual('code-import', msg['X-Launchpad-Notification-Type'])
+        self.assertEqual('~eric/fooix/trunk', msg['X-Launchpad-Branch'])
+        self.assertEqual(
+            'A new subversion code import has been requested by Eric:\n'
+            '    http://code.launchpad.dev/~eric/fooix/trunk\n'
+            'from\n'
+            '    svn://svn.example.com/fooix/trunk\n'
+            '\n'
+            '-- \nYou are getting this email because you are a member of the '
+            'vcs-imports team.\n', msg.get_payload(decode=True))
+
+    def test_git_import(self):
+        # Test the email for a new git import.
+        eric = self.factory.makePerson(name='eric')
+        fooix = self.factory.makeProduct(name='fooix')
+        # Eric needs to be logged in for the mail to be sent.
+        login_person(eric)
+        code_import = self.factory.makeCodeImport(
+            git_repo_url='git://git.example.com/fooix.git',
+            branch_name='master', product=fooix, registrant=eric)
+        transaction.commit()
+        msg = message_from_string(stub.test_emails[0][2])
+        self.assertEqual('code-import', msg['X-Launchpad-Notification-Type'])
+        self.assertEqual('~eric/fooix/master', msg['X-Launchpad-Branch'])
+        self.assertEqual(
+            'A new git code import has been requested '
+            'by Eric:\n'
+            '    http://code.launchpad.dev/~eric/fooix/master\n'
+            'from\n'
+            '    git://git.example.com/fooix.git\n'
+            '\n'
+            '-- \nYou are getting this email because you are a member of the '
+            'vcs-imports team.\n', msg.get_payload(decode=True))
+
+    def test_hg_import(self):
+        # Test the email for a new hg import.
+        eric = self.factory.makePerson(name='eric')
+        fooix = self.factory.makeProduct(name='fooix')
+        # Eric needs to be logged in for the mail to be sent.
+        login_person(eric)
+        code_import = self.factory.makeCodeImport(
+            hg_repo_url='http://hg.example.com/fooix.hg',
+            branch_name='master', product=fooix, registrant=eric)
+        transaction.commit()
+        msg = message_from_string(stub.test_emails[0][2])
+        self.assertEqual('code-import', msg['X-Launchpad-Notification-Type'])
+        self.assertEqual('~eric/fooix/master', msg['X-Launchpad-Branch'])
+        self.assertEqual(
+            'A new mercurial code import has been requested '
+            'by Eric:\n'
+            '    http://code.launchpad.dev/~eric/fooix/master\n'
+            'from\n'
+            '    http://hg.example.com/fooix.hg\n'
+            '\n'
+            '-- \nYou are getting this email because you are a member of the '
+            'vcs-imports team.\n', msg.get_payload(decode=True))
+
+
+def test_suite():
+    return TestLoader().loadTestsFromName(__name__)