Issue 3681 - Add suport for "Fixes XXXX - ..." commit messages

sitescripts/hg/bin/update_issues.py

 # This file is part of Adblock Plus <https://adblockplus.org/>,
 # Copyright (C) 2006-2016 Eyeo GmbH
 #
 # Adblock Plus is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License version 3 as
 # published by the Free Software Foundation.
 #
 # Adblock Plus is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
 # along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
 
-"""
-This module implements a changegroup (or pretxnchangegroup) hook that inspects
-all commit messages and checks if issues from the Adblock Plus issue tracker are
-being referenced. If there are, it updates them with the respective changeset
-URLs.
+"""Hooks for integrating Mercurial with Trac.
+
+Update the issues that are referenced in commit messages when the commits
+are pushed and and "master" bookmark is moved. See README.md for more
+information on behavior and configuration.
 """
 
+import collections
+import contextlib
 import posixpath
 import re
 import xmlrpclib
 
 from sitescripts.utils import get_config, get_template
 
 
-def _generate_comments(repository_name, changes_by_issue):
-    comments = {}
-    template = get_template("hg/template/issue_commit_comment.tmpl",
-                            autoescape=False)
-    for issue_id, changes in changes_by_issue.iteritems():
-        comments[issue_id] = template.render({"repository_name": repository_name,
-                                              "changes": changes})
-    return comments
+_IssueRef = collections.namedtuple('IssueRef', 'id commits is_fixed')
+
+@contextlib.contextmanager

[kzar, 2016/05/02 09:29:41]

I'm learning some new tricks here :)

[Vasily Kuznetsov, 2016/05/02 16:54:04]

Yeah, this is a pretty cool way to make context managers with less boilerplate
code. And try/except/finally syntax is quite appropriate for what one usually
wants to do with context managers.

+def _trac_proxy(ui, config, action_descr):
+    trac_url = config.get('hg', 'trac_xmlrpc_url')
+    try:
+        yield xmlrpclib.ServerProxy(trac_url)
+    except Exception as exc:
+        if getattr(exc, 'faultCode', 0) == 404:  # Not found

[kzar, 2016/05/02 09:29:41]

Nit: This comment doesn't really add anything.

[Vasily Kuznetsov, 2016/05/02 16:54:03]

Fair enough, I'll remove it.

+            ui.warn('warning: 404 (not found) while {}\n'.format(action_descr))
+        else:
+            ui.warn('error: {} while {}\n'.format(exc, action_descr))
 
 
-def _post_comment(issue_id, comment):
-    issue_id = int(issue_id)
-    url = get_config().get("hg", "trac_xmlrpc_url")
-    server = xmlrpclib.ServerProxy(url)
-    attributes = server.ticket.get(issue_id)[3]
-    server.ticket.update(issue_id, comment,
-                         {"_ts": attributes["_ts"], "action": "leave"}, True)
+def _update_issue(ui, config, issue_id, comment, changes):
+    issue_url_template = config.get('hg', 'issue_url_template')
+    issue_url = issue_url_template.format(id=issue_id)
+
+    updates = []
+    if comment:
+        updates.append('posted comment')

[kzar, 2016/04/29 14:05:43]

Supposing there's a "feature branch" bookmark that in the repository containing
several commits. Then we move the master bookmark forward to include those extra
commits. If I understood the README right we would potentially perform a bunch
of actions for those commits all at once?

If so perhaps these messages need to provide more context, "posted comment"
doesn't give much clue for which issue / commit a comment was posted.

[Vasily Kuznetsov, 2016/05/02 16:54:04]

Unfortunately the commit messages didn't make it into this function before and
the url of the commit is not terribly useful, so I had to cheat a little:
- I changed `issue_commit_comment.tmpl` to include the commit message into the
link (which makes it more useful too), and then
- this function extracts the commit message and shows it to the user.

So the output of hg push will look like this:

    updated https://issues.adblockplus.org/ticket/1308:
     - referenced a commit: Issue 1307, Fixes 1308, Issue 1309, Fixes 1311 - One
    updated https://issues.adblockplus.org/ticket/1309:
     - referenced a commit: Issue 1307, Fixes 1308, Issue 1309, Fixes 1311 - One
     - referenced a commit: Fixes 1309, Fixes 1310 - Two
    updated https://issues.adblockplus.org/ticket/1303:
     - set milestone to test-milestone-1.2
     - closed
    updated https://issues.adblockplus.org/ticket/1304:
     - closed

Done.

[kzar, 2016/05/03 06:47:35]

Nice, looks good to me. Will mean I can even click the issue link straight from
the console if I feel like it.

+    if 'milestone' in changes:
+        updates.append('set milestone: {}'.format(changes['milestone']))
+    if changes['action'] == 'resolve':
+        updates.append('closed')
+    if not updates:
+        return
+
+    with _trac_proxy(ui, config, 'updating issue {}'.format(issue_id)) as tp:
+        tp.ticket.update(issue_id, comment, changes, True)
+        ui.status('updated {} ({})\n'.format(issue_url, ', '.join(updates)))
 
 
-def hook(ui, repo, node, **kwargs):
-    first_change = repo[node]
-    issue_number_regex = re.compile(r"\bissue\s+(\d+)\b", re.I)
-    noissue_regex = re.compile(r"^noissue\b", re.I)
-    changes_by_issue = {}
-    for revision in xrange(first_change.rev(), len(repo)):
-        change = repo[revision]
-        description = change.description()
-        issue_ids = issue_number_regex.findall(description)
-        if issue_ids:
-            for issue_id in issue_ids:
-                changes_by_issue.setdefault(issue_id, []).append(change)
-        elif not noissue_regex.search(description):
-            # We should just reject all changes when one of them has an invalid
-            # commit message format, see: https://issues.adblockplus.org/ticket/3679
-            ui.warn("warning: invalid commit message format in changeset %s\n" %
-                    change)
+def _post_comments(ui, repo, config, refs):
+    repo_name = posixpath.split(repo.url())[1]
+    template = get_template('hg/template/issue_commit_comment.tmpl',
+                            autoescape=False)
+    for ref in refs:
+        comment_text = template.render({'repository_name': repo_name,
+                                        'changes': ref.commits})
+        with _trac_proxy(ui, config, 'getting issue {}'.format(ref.id)) as tp:
+            attrs = tp.ticket.get(ref.id)[3]
+            _update_issue(ui, config, ref.id, comment_text,
+                          {'_ts': attrs['_ts'], 'action': 'leave'})
 
-    repository_name = posixpath.split(repo.url())[1]
-    comments = _generate_comments(repository_name, changes_by_issue)
 
-    issue_url_template = get_config().get("hg", "issue_url_template")
-    for issue_id, comment in comments.iteritems():
+def _compile_module_regexps(ui, config, modules):
+    for module, regexp in config.items('hg_module_milestones'):
         try:
-            _post_comment(issue_id, comment)
-            ui.status("updating %s\n" % issue_url_template.format(id=issue_id))
-        except:
-            ui.warn("warning: failed to update %s\n" %
-                    issue_url_template.format(id=issue_id))
+            yield module, re.compile('^' + regexp + '$', re.I)
+        except Exception as exc:
+            ui.warn('warning: invalid module milestone regexp in config:'

[kzar, 2016/05/02 09:29:40]

This message looks pretty clear but maybe we could make it clearer where the
problem lies in the config? (And that the troublesome regexp was skipped.) For
example:

warning: Skipped invalid regexp for MILESTONE_NAME in [hg_module_milestones]
config:

Up to you anyway.

[Vasily Kuznetsov, 2016/05/02 16:54:03]

I suppose you meant "Skipped invalid regexp for MODULE_NAME...". Seems like a
good idea to me.

Done.

+                    "'{}' ({})\n".format(regexp, exc))
+
+
+def _get_module_milestones(ui, config, modules):
+    module_regexps = dict(_compile_module_regexps(ui, config, modules))
+    modules = module_regexps.keys()
+    if not modules:
+        return []
+
+    milestones_by_module = {}
+    with _trac_proxy(ui, config, 'getting milestones') as tp:
+        milestone_names = [
+            name for name in tp.ticket.milestone.getAll()
+            if any(regexp.search(name) for regexp in module_regexps.values())
+        ]
+        # Using a MultiCall is better because we might have many
+        # milestones.
+        multicall = xmlrpclib.MultiCall(tp)
+        for name in milestone_names:
+            multicall.ticket.milestone.get(name)
+        milestones = filter(lambda m: not m['completed'], multicall())

[kzar, 2016/04/29 14:05:43]

Nit: I've been told to use list comprehension instead of filter before.

[Vasily Kuznetsov, 2016/05/02 16:54:04]

Yep, it's definitely better here. I also renamed `multicall` to `get_milestones`
to make the name less abstract.

+        for module in modules:
+            for milestone in milestones:
+                if module_regexps[module].search(milestone['name']):
+                    milestones_by_module[module] = milestone['name']
+                    break
+
+    return milestones_by_module.items()
+
+
+def _declare_fixed(ui, config, refs):
+    updates = []
+    # Changes that need milestones added to them, indexed by module.
+    need_milestones = collections.defaultdict(list)
+
+    for ref in refs:
+        with _trac_proxy(ui, config, 'getting issue {}'.format(ref.id)) as tp:
+            attrs = tp.ticket.get(ref.id)[3]
+            changes = {
+                '_ts': attrs['_ts'],
+                'action': 'leave'
+            }
+            actions = tp.ticket.getActions(ref.id)
+            if any(action[0] == 'resolve' for action in actions):
+                changes['action'] = 'resolve'
+            if not attrs['milestone']:
+                need_milestones[attrs['component']].append(changes)
+            updates.append((ref.id, changes))
+
+    for module, milestone in _get_module_milestones(ui, config,
+                                                    need_milestones.keys()):
+        for changes in need_milestones[module]:
+            changes['milestone'] = milestone
+
+    for issue_id, changes in updates:
+        _update_issue(ui, config, issue_id, '', changes)

[kzar, 2016/05/02 09:29:40]

Since comment seems like the only optional parameter for _update_issue perhaps
it should be last (or a keyword parameter) and then it could simply be omitted
here?

[Vasily Kuznetsov, 2016/05/02 16:54:03]

Done.

+
+
+def _collect_references(ui, commits):
+    issue_number_regex = re.compile(r'\b(issue|fixes)\s+(\d+)\b', re.I)

[kzar, 2016/05/02 09:29:41]

Maybe these regexps should be compiled as constants at the top? Currently
they're being re-compiled each time _collect_references is called and it's being
called in a loop.

[Vasily Kuznetsov, 2016/05/02 16:54:04]

Actually it's not called in a loop, only once from each hook, but I agree that
it's cleaner to move them out.

Done.

+    noissue_regex = re.compile(r'^noissue\b', re.I)
+
+    commits_by_issue = collections.defaultdict(list)
+    fixed_issues = set()
+
+    for commit in commits:
+        message = commit.description()
+        if ' - ' not in message:
+            ui.warn("warning: invalid commit message format: '{}'\n"
+                    .format(message))
+            continue
+
+        refs, rest = message.split(" - ", 1)
+        issue_refs = issue_number_regex.findall(refs)
+        if issue_refs:
+            for ref_type, issue_id in issue_refs:
+                issue_id = int(issue_id)
+                commits_by_issue[issue_id].append(commit)
+                if ref_type.lower() == 'fixes':
+                    fixed_issues.add(issue_id)
+        elif not noissue_regex.search(refs):
+            ui.warn("warning: no issue reference in commit message: '{}'\n"
+                    .format(message))
+
+    for issue_id, commits in sorted(commits_by_issue.items()):
+        yield _IssueRef(issue_id, commits, is_fixed=issue_id in fixed_issues)
+
+
+def changegroup_hook(ui, repo, node, **kwargs):
+    config = get_config()
+    first_rev = repo[node].rev()
+    pushed_commits = repo[first_rev:]
+    refs = _collect_references(ui, pushed_commits)
+    _post_comments(ui, repo, config, refs)
+
+
+def pushkey_hook(ui, repo, **kwargs):
+    if kwargs['namespace'] != 'bookmarks':

[kzar, 2016/04/29 14:05:43]

Nit: Replace these three with one if?

[Vasily Kuznetsov, 2016/05/02 16:54:03]

Done.

+        return  # Not a bookmark move.
+    if kwargs['key'] != 'master':
+        return  # Not master bookmark.
+    if not kwargs['old']:
+        return  # The bookmark is just created -- don't do anything.
+
+    config = get_config()
+    old_master_rev = repo[kwargs['old']].rev()
+    new_master_rev = repo[kwargs['new']].rev()
+    added_revs = repo.changelog.findmissingrevs([old_master_rev],
+                                                [new_master_rev])
+    added_commits = [repo[rev] for rev in added_revs]
+    refs = [ref for ref in _collect_references(ui, added_commits)
+            if ref.is_fixed]
+    _declare_fixed(ui, config, refs)
+
+
+# Alias for backward compatibility.
+hook = changegroup_hook