Merge lp:~jr/bzr-builddeb/changelog-closes-bugs into lp:bzr-builddeb

[Jonathan Riddell]

Uses the new hook added by https://code.launchpad.net/~jr/bzr/707274-commit-message-hook/+merge/62334 to set the changelog and mark bugs in debian/changelog as fixed in the branch

[Jelmer Vernooij (jelmer)]

We generally try to avoid doing more imports than necessary in the __init__.py of plugins, as everything there gets imported every time bzr is started. "bzrlib.bugtracker" is usually not loaded on startup, so it would make sense to import it only in debian_changelog_commit when it is actually used.

commit.builder._revprops should be public if plugins have to touch it; this should probably be part of adding the set_commit_message hook.

Oh, and the really nitpicky bit.. PEP8 requires two empty lines around top-level things, so you need an extra newline above and an extra newline below debian_changelog_commit.

A basic test would be nice, even if just exercises debian_changelog_commit directly.

[lp:~jr/bzr-builddeb/changelog-closes-bugs]

562. By Jonathan Riddell on 2011-06-03

fix parsing of LP: lines with multple entries

563. By Jonathan Riddell on 2011-06-03

actually this is fine

[Jelmer Vernooij (jelmer)]

W00t. Two more minor style nitpics:

* The line with self.assertEqual looks over 80 characters.
* We usually stick to one single summary line in docstrings (debian_changelog_commit's docstring is longer)

review: Approve (code)

[Jelmer Vernooij (jelmer)]

Changing vote to needs fixing (but marking the MP as approved) - please fix these, but there's no need for another round of review.

review: Needs Fixing

[lp:~jr/bzr-builddeb/changelog-closes-bugs]

564. By Jonathan Riddell on 2011-06-03

Add changelog entry

565. By Jonathan Riddell on 2011-06-03

over 80 characters in a line shocker

566. By Jonathan Riddell on 2011-06-03

tidy up doc string

=== modified file '__init__.py'
--- __init__.py	2011-05-08 06:44:00 +0000
+++ __init__.py	2011-06-03 14:44:26 +0000
@@ -24,6 +24,7 @@
 """bzr-builddeb - manage packages in a Bazaar branch."""
 
 import os
+import re
 
 import bzrlib
 from bzrlib.commands import plugin_cmds
@@ -110,6 +111,21 @@
     return "".join(changes)
 
 
+def debian_changelog_commit(commit, start_message):
+    """hooked into bzrlib.msgeditor set_commit_message.
+     Set the commit message from debian/changelog and set any LP: #1234 to bug
+     fixed tags."""
+   
+    changes = debian_changelog_commit_message(commit, start_message)
+    if changes is None:
+        return None
+
+    bugs_fixed = util.find_bugs_fixed([changes], commit.work_tree.branch)
+    commit.builder._revprops["bugs"] = "\n".join(bugs_fixed)
+    
+    return debian_changelog_commit_message(commit, start_message)
+
+
 def changelog_merge_hook_factory(merger):
     from bzrlib.plugins.builddeb import merge_changelog
     return merge_changelog.ChangeLogFileMerge(merger)
@@ -170,6 +186,12 @@
             debian_changelog_commit_message,
             "Use changes documented in debian/changelog to suggest "
             "the commit message")
+    if bzrlib.version_info[0] >= 2 and bzrlib.version_info[1] >= 4:
+        install_lazy_named_hook(
+            "bzrlib.msgeditor", "hooks", "set_commit_message",
+                debian_changelog_commit,
+                "Use changes documented in debian/changelog to set "
+                "the commit message and bugs fixed")
     install_lazy_named_hook(
         "bzrlib.merge", "Merger.hooks",
         'merge_file_content', changelog_merge_hook_factory,

=== modified file 'debian/changelog'
--- debian/changelog	2011-05-08 15:45:59 +0000
+++ debian/changelog	2011-06-03 14:44:26 +0000
@@ -1,9 +1,14 @@
 bzr-builddeb (2.7.5) UNRELEASED; urgency=low
 
+  [ Jelmer Vernooij ]
   * New 'bzr dep3-patch' subcommand that can generate DEP-3 compliant
     patches. LP: #460576
 
- -- Jelmer Vernooij <[e-mail]>  Sun, 08 May 2011 17:45:14 +0200
+  [ Jonathan Riddell ]
+  * Use new set_commit_message() hook in bzr to set the commit
+    message from debian/changelog and set fixed bugs in tags
+
+ -- Jonathan Riddell <[e-mail]>  Fri, 03 Jun 2011 15:36:10 +0100
 
 bzr-builddeb (2.7.4) unstable; urgency=low
 

=== modified file 'tests/test_commit_message.py'
--- tests/test_commit_message.py	2009-02-21 20:07:43 +0000
+++ tests/test_commit_message.py	2011-06-03 14:44:26 +0000
@@ -19,16 +19,19 @@
 
 from bzrlib.tests import TestCaseWithTransport
 
-from bzrlib.plugins.builddeb import debian_changelog_commit_message
+from bzrlib.plugins.builddeb import debian_changelog_commit_message, debian_changelog_commit
 
 
 class CommitMessageTests(TestCaseWithTransport):
 
     class _Commit(object):
+        class _Builder(object):
+            _revprops = {}
         def __init__(self, work_tree, exclude=[], specific_files=[]):
             self.work_tree = work_tree
             self.exclude = exclude
             self.specific_files = specific_files
+            self.builder = self._Builder()
 
     def set_changelog_content(self, content):
         f = open("debian/changelog", 'wb')
@@ -97,3 +100,19 @@
         commit = self._Commit(wt)
         self.assertEqual(debian_changelog_commit_message(commit, None),
                 "* two\n* changes\n")
+
+    def test_set_message_with_bugs(self):
+        wt = self.make_branch_and_tree(".")
+        self.build_tree(['a', 'debian/', 'debian/changelog'])
+        wt.add(['debian/', 'debian/changelog'])
+        wt.commit("one")
+        self.set_changelog_content("  * fix LP: #1234\n  * close LP: #4321\n")
+        wt.add(['a'])
+        wt.lock_read()
+        self.addCleanup(wt.unlock)
+        commit = self._Commit(wt)
+        self.assertEqual(debian_changelog_commit(commit, None),
+                "* fix LP: #1234\n* close LP: #4321\n")
+        self.assertEqual(commit.builder._revprops, 
+                        {'bugs': 'https://launchpad.net/bugs/1234 fixed\n'
+                                 'https://launchpad.net/bugs/4321 fixed'})

=== modified file 'util.py'
--- util.py	2011-04-08 18:47:10 +0000
+++ util.py	2011-06-03 14:44:26 +0000
@@ -396,7 +396,7 @@
 def find_bugs_fixed(changes, branch, _lplib=None):
     """Find the bugs marked fixed in a changelog entry.
 
-    :param changes: The contents of the changelog entry.
+    :param changes: A list of the contents of the changelog entry.
     :param branch: Bazaar branch associated with the package
     :return: String with bugs closed, as appropriate for a Bazaar "bugs" revision 
         property.