Merge lp:~dpb/tarmac/ls-fixes into lp:~ubuntuone-hackers/tarmac/trunk

[David Britton]

Formatting changes: allow specification of the branch name, allow newlines characters.

[James Westby (james-w)]

review: Approve

=== modified file 'docs/introduction.txt'
--- docs/introduction.txt	2012-06-25 21:05:28 +0000
+++ docs/introduction.txt	2013-03-07 17:38:27 +0000
@@ -151,6 +151,11 @@
 **reviewer**
   The display name of the merge proposal reviewer.
 
+**branch_name**
+  The short branch name.  i.e.: branch_name in "lp:~user/project/branch_name"
+
+**\n**
+  A \n in the commit message template will be rendered as a newline character.
 
 Command
 =======
 
=== modified file 'tarmac/plugins/commitmessage.py'
--- tarmac/plugins/commitmessage.py	2010-10-25 21:27:39 +0000
+++ tarmac/plugins/commitmessage.py	2013-03-07 17:38:27 +0000
@@ -30,18 +30,17 @@
 
     def run(self, command, target, source, proposal):
     # pylint: disable-msg=W0613
-
         try:
-            template = target.config.commit_message_template
-            template = template.replace('<', '%(').replace('>', ')s')
+            proposal.commit_message = self.render(
+                target.config.commit_message_template,
+                CommitMessageTemplateInfo(proposal))
         except AttributeError:
             return
 
-        proposal.commit_message = self.render(
-            template, CommitMessageTemplateInfo(proposal))
-
     def render(self, template, info):
         """Render a template using the given information."""
+        template = template.replace('<', '%(').replace('>', ')s')
+        template = template.replace('\\n', '\n')
         return template % info
 
 
@@ -77,6 +76,11 @@
         return self._proposal.commit_message
 
     @property
+    def branch_name(self):
+        """The branch name under review."""
+        return self._proposal.source_branch.name
+
+    @property
     def reviewer(self):
         """The display name of the merge proposal reviewer.
 
 
=== modified file 'tarmac/plugins/tests/test_commitmessage.py'
--- tarmac/plugins/tests/test_commitmessage.py	2010-10-25 21:27:39 +0000
+++ tarmac/plugins/tests/test_commitmessage.py	2013-03-07 17:38:27 +0000
@@ -12,6 +12,7 @@
         super(TestCommitMessageTemplateInfo, self).setUp()
         self.proposal = Thing(
             source_branch=Thing(
+                name="name",
                 owner=Thing(display_name="Arthur Author", name="arthur"),
                 linked_bugs=[Thing(id=1234), Thing(id=5678)]),
             commit_message="Awesome",
@@ -83,8 +84,8 @@
             return "{info:%s}" % name
 
 
-class TestCommitMessageTemplate(TarmacTestCase):
-
+class TestCommitMessageTemplate(TestCommitMessageTemplateInfo):
+    
     def test_render(self):
         message_template = CommitMessageTemplate()
         message_info = FakeCommitMessageTemplateInfo()
@@ -99,3 +100,7 @@
         self.assertEqual(
             "{info:author} {info:reviewer}",
             render("%(author)s %(reviewer)s", message_info))
+        self.assertEqual(
+            "{info:author} {info:branch_name} {info:reviewer}",
+            render("<author> <branch_name> <reviewer>", message_info))
+        self.assertEqual("one\ntwo", render("one\\ntwo", message_info))