##// END OF EJS Templates
bugzilla: prefix each config option with section
bugzilla: prefix each config option with section

File last commit:

r13833:64ad07df default
r13833:64ad07df default
Show More
bugzilla.py
731 lines | 26.3 KiB | text/x-python | PythonLexer
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 # bugzilla.py - bugzilla integration for mercurial
#
# Copyright 2006 Vadim Gelfer <vadim.gelfer@gmail.com>
Jim Hague
bugzilla: add XMLRPC interface....
r13801 # Copyright 2011 Jim Hague <jim.hague@acm.org>
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 #
Martin Geisler
updated license to be explicit about GPL version 2
r8225 # This software may be used and distributed according to the terms of the
Matt Mackall
Update license to GPLv2+
r10263 # GNU General Public License version 2 or any later version.
Jim Hague
Revise Bugzilla module comments into extension help....
r7504
Dirkjan Ochtman
extensions: change descriptions for hook-providing extensions...
r8935 '''hooks for integrating with the Bugzilla bug tracker
Jim Hague
Revise Bugzilla module comments into extension help....
r7504
Martin Geisler
bugzilla: wrap docstrings at 70 characters
r9252 This hook extension adds comments on bugs in Bugzilla when changesets
Jim Hague
bugzilla: add XMLRPC interface....
r13801 that refer to bugs by Bugzilla ID are seen. The comment is formatted using
the Mercurial template mechanism.
Jim Hague
Revise Bugzilla module comments into extension help....
r7504
Jim Hague
bugzilla: add XMLRPC interface....
r13801 The hook does not change bug status.
Jim Hague
Revise Bugzilla module comments into extension help....
r7504
Jim Hague
bugzilla: add modified XMLRPC mode that uses email to send bug comments....
r13802 Three basic modes of access to Bugzilla are provided:
Jim Hague
Revise Bugzilla module comments into extension help....
r7504
Jim Hague
bugzilla: add modified XMLRPC mode that uses email to send bug comments....
r13802 1. Access via the Bugzilla XMLRPC interface. Requires Bugzilla 3.4 or later.
2. Check data via the Bugzilla XMLRPC interface and submit bug change
via email to Bugzilla email interface. Requires Bugzilla 3.4 or later.
Martin Geisler
bugzilla: reformat list of configuration options
r9203
Jim Hague
bugzilla: add XMLRPC interface....
r13801 2. Writing directly to the Bugzilla database. Only Bugzilla installations
using MySQL are supported. Requires Python MySQLdb.
Martin Geisler
bugzilla: reformat list of configuration options
r9203
Jim Hague
bugzilla: add XMLRPC interface....
r13801 Writing directly to the database is susceptible to schema changes, and
relies on a Bugzilla contrib script to send out bug change
notification emails. This script runs as the user running Mercurial,
must be run on the host with the Bugzilla install, and requires
permission to read Bugzilla configuration details and the necessary
MySQL user and password to have full access rights to the Bugzilla
database. For these reasons this access mode is now considered
deprecated, and will not be updated for new Bugzilla versions going
forward.
Martin Geisler
bugzilla: reformat list of configuration options
r9203
Jim Hague
bugzilla: add XMLRPC interface....
r13801 Access via XMLRPC needs a Bugzilla username and password to be specified
in the configuration. Comments are added under that username. Since the
configuration must be readable by all Mercurial users, it is recommended
that the rights of that user are restricted in Bugzilla to the minimum
necessary to add comments.
Jim Hague
bugzilla: add modified XMLRPC mode that uses email to send bug comments....
r13802 Access via XMLRPC/email behaves uses XMLRPC to query Bugzilla, but sends
email to the Bugzilla email interface to submit comments to bugs.
The From: address in the email is set to the email address of the Mercurial
user, so the comment appears to come from the Mercurial user. In the event
that the Mercurial user email is not recognised by Bugzilla as a Bugzilla
user, the Bugzilla username and password used to log into Bugzilla are
used instead as the source of the comment.
Configuration items common to all access modes:
Martin Geisler
bugzilla: reformat list of configuration options
r9203
Martin Geisler
bugzilla: prefix each config option with section
r13833 bugzilla.version
Jim Hague
bugzilla: add XMLRPC interface....
r13801 This access type to use. Values recognised are:
Jim Hague
bugzilla: add modified XMLRPC mode that uses email to send bug comments....
r13802 xmlrpc Bugzilla XMLRPC interface.
xmlrpc+email Bugzilla XMLRPC and email interfaces.
3.0 MySQL access, Bugzilla 3.0 and later.
2.18 MySQL access, Bugzilla 2.18 and up to but not including 3.0.
2.16 MySQL access, Bugzilla 2.16 and up to but not including 2.18.
Martin Geisler
bugzilla: word-wrap help texts at 70 characters
r7985
Martin Geisler
bugzilla: prefix each config option with section
r13833 bugzilla.regexp
Martin Geisler
bugzilla: wrap docstrings at 70 characters
r9252 Regular expression to match bug IDs in changeset commit message.
Must contain one "()" group. The default expression matches 'Bug
1234', 'Bug no. 1234', 'Bug number 1234', 'Bugs 1234,5678', 'Bug
1234 and 5678' and variations thereof. Matching is case insensitive.
Martin Geisler
bugzilla: reformat list of configuration options
r9203
Martin Geisler
bugzilla: prefix each config option with section
r13833 bugzilla.style
Martin Geisler
bugzilla: reformat list of configuration options
r9203 The style file to use when formatting comments.
Martin Geisler
bugzilla: prefix each config option with section
r13833 bugzilla.template
Martin Geisler
bugzilla: wrap docstrings at 70 characters
r9252 Template to use when formatting comments. Overrides style if
specified. In addition to the usual Mercurial keywords, the
extension specifies::
Martin Geisler
bugzilla: reformat list of configuration options
r9203
{bug} The Bugzilla bug ID.
{root} The full pathname of the Mercurial repository.
{webroot} Stripped pathname of the Mercurial repository.
{hgweb} Base URL for browsing Mercurial repositories.
Jim Hague
Revise Bugzilla module comments into extension help....
r7504
Martin Geisler
bugzilla: reformat list of configuration options
r9203 Default 'changeset {node|short} in repo {root} refers '
'to bug {bug}.\\ndetails:\\n\\t{desc|tabindent}'
Martin Geisler
bugzilla: prefix each config option with section
r13833 bugzilla.strip
Jim Hague
bugzilla: add XMLRPC interface....
r13801 The number of path separator characters to strip from the front of the
Mercurial repository path ('{root}' in templates) to produce '{webroot}'.
For example, a repository with '{root}' '/var/local/my-project' with a
strip of 2 gives a value for '{webroot}' of 'my-project'. Default 0.
Martin Geisler
bugzilla: prefix each config option with section
r13833 web.baseurl
Jim Hague
bugzilla: add XMLRPC interface....
r13801 Base URL for browsing Mercurial repositories. Referenced from
templates as {hgweb}.
Jim Hague
bugzilla: add modified XMLRPC mode that uses email to send bug comments....
r13802 Configuration items common to XMLRPC+email and MySQL access modes:
Martin Geisler
bugzilla: prefix each config option with section
r13833 bugzilla.usermap
Jim Hague
bugzilla: add modified XMLRPC mode that uses email to send bug comments....
r13802 Path of file containing Mercurial committer email to Bugzilla user email
mappings. If specified, the file should contain one mapping per
line, "committer"="Bugzilla user". See also the [usermap] section.
The [usermap] section is used to specify mappings of Mercurial
committer email to Bugzilla user email. See also [bugzilla].usermap.
Contains entries of the form "committer"="Bugzilla user".
Jim Hague
bugzilla: add XMLRPC interface....
r13801 XMLRPC access mode configuration:
Martin Geisler
bugzilla: prefix each config option with section
r13833 bugzilla.bzurl
Jim Hague
bugzilla: add XMLRPC interface....
r13801 The base URL for the Bugzilla installation.
Default 'http://localhost/bugzilla'.
Martin Geisler
bugzilla: prefix each config option with section
r13833 bugzilla.user
Jim Hague
bugzilla: add XMLRPC interface....
r13801 The username to use to log into Bugzilla via XMLRPC. Default 'bugs'.
Martin Geisler
bugzilla: prefix each config option with section
r13833 bugzilla.password
Jim Hague
bugzilla: add XMLRPC interface....
r13801 The password for Bugzilla login.
Jim Hague
bugzilla: add modified XMLRPC mode that uses email to send bug comments....
r13802 XMLRPC+email access mode uses the XMLRPC access mode configuration items,
and also:
Martin Geisler
bugzilla: prefix each config option with section
r13833 bugzilla.bzemail
Jim Hague
bugzilla: add modified XMLRPC mode that uses email to send bug comments....
r13802 The Bugzilla email address.
In addition, the Mercurial email settings must be configured. See the
documentation for 'hgrc', sections '[email]' and '[smtp]'.
Jim Hague
bugzilla: add XMLRPC interface....
r13801 MySQL access mode configuration:
Martin Geisler
bugzilla: prefix each config option with section
r13833 bugzilla.host
Jim Hague
bugzilla: add XMLRPC interface....
r13801 Hostname of the MySQL server holding the Bugzilla database.
Default 'localhost'.
Martin Geisler
bugzilla: prefix each config option with section
r13833 bugzilla.db
Jim Hague
bugzilla: add XMLRPC interface....
r13801 Name of the Bugzilla database in MySQL. Default 'bugs'.
Martin Geisler
bugzilla: prefix each config option with section
r13833 bugzilla.user
Jim Hague
bugzilla: add XMLRPC interface....
r13801 Username to use to access MySQL server. Default 'bugs'.
Martin Geisler
bugzilla: prefix each config option with section
r13833 bugzilla.password
Jim Hague
bugzilla: add XMLRPC interface....
r13801 Password to use to access MySQL server.
Martin Geisler
bugzilla: prefix each config option with section
r13833 bugzilla.timeout
Jim Hague
bugzilla: add XMLRPC interface....
r13801 Database connection timeout (seconds). Default 5.
Martin Geisler
bugzilla: prefix each config option with section
r13833 bugzilla.bzuser
Jim Hague
bugzilla: add XMLRPC interface....
r13801 Fallback Bugzilla user name to record comments with, if changeset
committer cannot be found as a Bugzilla user.
Martin Geisler
bugzilla: prefix each config option with section
r13833 bugzilla.bzdir
Jim Hague
bugzilla: add XMLRPC interface....
r13801 Bugzilla install directory. Used by default notify. Default
'/var/www/html/bugzilla'.
Martin Geisler
bugzilla: prefix each config option with section
r13833 bugzilla.notify
Jim Hague
bugzilla: add XMLRPC interface....
r13801 The command to run to get Bugzilla to send bug change notification
emails. Substitutes from a map with 3 keys, 'bzdir', 'id' (bug id)
and 'user' (committer bugzilla email). Default depends on version;
from 2.18 it is "cd %(bzdir)s && perl -T contrib/sendbugmail.pl
%(id)s %(user)s".
Jim Hague
Revise Bugzilla module comments into extension help....
r7504
Martin Geisler
bugzilla: reformat list of configuration options
r9203 Activating the extension::
Jim Hague
Revise Bugzilla module comments into extension help....
r7504
[extensions]
Martin Geisler
hgext: enable extensions without "hgext." prefix in help texts
r10112 bugzilla =
Jim Hague
Revise Bugzilla module comments into extension help....
r7504
[hooks]
# run bugzilla hook on every change pulled or pushed in here
incoming.bugzilla = python:hgext.bugzilla.hook
Jim Hague
bugzilla: add XMLRPC interface....
r13801 Example configurations:
XMLRPC example configuration. This uses the Bugzilla at
'http://my-project.org/bugzilla', logging in as user 'bugmail@my-project.org'
wityh password 'plugh'. It is used with a collection of Mercurial
repositories in '/var/local/hg/repos/'. ::
Jim Hague
Revise Bugzilla module comments into extension help....
r7504
Jim Hague
bugzilla: add XMLRPC interface....
r13801 [bugzilla]
bzurl=http://my-project.org/bugzilla
user=bugmail@my-project.org
password=plugh
version=xmlrpc
[web]
baseurl=http://my-project.org/hg
Jim Hague
bugzilla: add modified XMLRPC mode that uses email to send bug comments....
r13802 XMLRPC+email example configuration. This uses the Bugzilla at
'http://my-project.org/bugzilla', logging in as user 'bugmail@my-project.org'
wityh password 'plugh'. It is used with a collection of Mercurial
repositories in '/var/local/hg/repos/'. Bug comments are sent to the
Bugzilla email address 'buzilla@my-project.org'. ::
[bugzilla]
user=bugmail@my-project.org
password=plugh
version=xmlrpc
bzemail=bugzilla@my-project.org
[web]
baseurl=https://dev.laicatc.com/hg
bugzillaurl=https://dev.laicatc.com/bugzilla
Jim Hague
bugzilla: add XMLRPC interface....
r13801 MySQL example configuration. This is for a collection of Mercurial
repositories in '/var/local/hg/repos/' used with a local Bugzilla 3.2
installation in /opt/bugzilla-3.2. The MySQL database is on 'localhost',
the Bugzilla database name is 'bugs' and MySQL is accessed with MySQL
username 'bugs' password 'XYZZY'. ::
Jim Hague
Revise Bugzilla module comments into extension help....
r7504
[bugzilla]
host=localhost
password=XYZZY
version=3.0
bzuser=unknown@domain.com
Jim Hague
Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail....
r7618 bzdir=/opt/bugzilla-3.2
Martin Geisler
bugzilla: wrap example template line
r9204 template=Changeset {node|short} in {root|basename}.
{hgweb}/{webroot}/rev/{node|short}\\n
{desc}\\n
Jim Hague
Revise Bugzilla module comments into extension help....
r7504 strip=5
[web]
baseurl=http://dev.domain.com/hg
[usermap]
user@emaildomain.com=user.name@bugzilladomain.com
Jim Hague
bugzilla: add modified XMLRPC mode that uses email to send bug comments....
r13802 All the above add a comment to the Bugzilla bug record of the form::
Jim Hague
Revise Bugzilla module comments into extension help....
r7504
Changeset 3b16791d6642 in repository-name.
http://dev.domain.com/hg/repository-name/rev/3b16791d6642
Changeset commit comment. Bug 1234.
'''
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192
Matt Mackall
Simplify i18n imports
r3891 from mercurial.i18n import _
Joel Rosdahl
Expand import * to allow Pyflakes to find problems
r6211 from mercurial.node import short
Jim Hague
bugzilla: add modified XMLRPC mode that uses email to send bug comments....
r13802 from mercurial import cmdutil, mail, templater, util
Jim Hague
bugzilla: add XMLRPC interface....
r13801 import re, time, xmlrpclib
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192
Jim Hague
bugzilla: localise all MySQL direct access inside access class....
r13800 class bzaccess(object):
'''Base class for access to Bugzilla.'''
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192
def __init__(self, ui):
self.ui = ui
Jim Hague
bugzilla: localise all MySQL direct access inside access class....
r13800 usermap = self.ui.config('bugzilla', 'usermap')
if usermap:
self.ui.readconfig(usermap, sections=['usermap'])
def map_committer(self, user):
'''map name of committer to Bugzilla user name.'''
for committer, bzuser in self.ui.configitems('usermap'):
if committer.lower() == user.lower():
return bzuser
return user
# Methods to be implemented by access classes.
def filter_real_bug_ids(self, ids):
'''remove bug IDs that do not exist in Bugzilla from set.'''
pass
def filter_cset_known_bug_ids(self, node, ids):
'''remove bug IDs where node occurs in comment text from set.'''
pass
def add_comment(self, bugid, text, committer):
'''add comment to bug.
If possible add the comment as being from the committer of
the changeset. Otherwise use the default Bugzilla user.
'''
pass
def notify(self, ids, committer):
'''Force sending of Bugzilla notification emails.'''
pass
# Bugzilla via direct access to MySQL database.
class bzmysql(bzaccess):
'''Support for direct MySQL access to Bugzilla.
The earliest Bugzilla version this is tested with is version 2.16.
Jim Hague
bugzilla: add XMLRPC interface....
r13801
If your Bugzilla is version 3.2 or above, you are strongly
recommended to use the XMLRPC access method instead.
Jim Hague
bugzilla: localise all MySQL direct access inside access class....
r13800 '''
@staticmethod
def sql_buglist(ids):
'''return SQL-friendly list of bug ids'''
return '(' + ','.join(map(str, ids)) + ')'
_MySQLdb = None
def __init__(self, ui):
try:
import MySQLdb as mysql
bzmysql._MySQLdb = mysql
except ImportError, err:
raise util.Abort(_('python mysql support not available: %s') % err)
bzaccess.__init__(self, ui)
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 host = self.ui.config('bugzilla', 'host', 'localhost')
user = self.ui.config('bugzilla', 'user', 'bugs')
passwd = self.ui.config('bugzilla', 'password')
db = self.ui.config('bugzilla', 'db', 'bugs')
timeout = int(self.ui.config('bugzilla', 'timeout', 5))
self.ui.note(_('connecting to %s:%s as %s, password %s\n') %
(host, db, user, '*' * len(passwd)))
Jim Hague
bugzilla: localise all MySQL direct access inside access class....
r13800 self.conn = bzmysql._MySQLdb.connect(host=host,
user=user, passwd=passwd,
db=db,
connect_timeout=timeout)
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 self.cursor = self.conn.cursor()
Jim Hague
Add support for Bugzilla 3.0 series to bugzilla hook....
r7019 self.longdesc_id = self.get_longdesc_id()
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 self.user_ids = {}
Jim Hague
Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail....
r7618 self.default_notify = "cd %(bzdir)s && ./processmail %(id)s %(user)s"
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192
def run(self, *args, **kwargs):
'''run a query.'''
self.ui.note(_('query: %s %s\n') % (args, kwargs))
try:
self.cursor.execute(*args, **kwargs)
Jim Hague
bugzilla: localise all MySQL direct access inside access class....
r13800 except bzmysql._MySQLdb.MySQLError:
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 self.ui.note(_('failed query: %s %s\n') % (args, kwargs))
raise
Jim Hague
Add support for Bugzilla 3.0 series to bugzilla hook....
r7019 def get_longdesc_id(self):
'''get identity of longdesc field'''
self.run('select fieldid from fielddefs where name = "longdesc"')
ids = self.cursor.fetchall()
if len(ids) != 1:
raise util.Abort(_('unknown database schema'))
return ids[0][0]
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 def filter_real_bug_ids(self, ids):
Jim Hague
bugzilla: keep bug IDs in set....
r13799 '''filter not-existing bug ids from set.'''
Jim Hague
bugzilla: localise all MySQL direct access inside access class....
r13800 self.run('select bug_id from bugs where bug_id in %s' %
bzmysql.sql_buglist(ids))
Jim Hague
bugzilla: keep bug IDs in set....
r13799 return set([c[0] for c in self.cursor.fetchall()])
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192
Jim Hague
bugzilla: rename filter_unknown_bug_ids to reflect its actual purpose....
r13798 def filter_cset_known_bug_ids(self, node, ids):
Jim Hague
bugzilla: keep bug IDs in set....
r13799 '''filter bug ids that already refer to this changeset from set.'''
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192
self.run('''select bug_id from longdescs where
bug_id in %s and thetext like "%%%s%%"''' %
Jim Hague
bugzilla: localise all MySQL direct access inside access class....
r13800 (bzmysql.sql_buglist(ids), short(node)))
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 for (id,) in self.cursor.fetchall():
self.ui.status(_('bug %d already knows about changeset %s\n') %
(id, short(node)))
Jim Hague
bugzilla: keep bug IDs in set....
r13799 ids.discard(id)
return ids
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192
Jim Hague
Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail....
r7618 def notify(self, ids, committer):
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 '''tell bugzilla to send mail.'''
self.ui.status(_('telling bugzilla to send mail:\n'))
Jim Hague
Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail....
r7618 (user, userid) = self.get_bugzilla_user(committer)
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 for id in ids:
self.ui.status(_(' bug %s\n') % id)
Jim Hague
Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail....
r7618 cmdfmt = self.ui.config('bugzilla', 'notify', self.default_notify)
bzdir = self.ui.config('bugzilla', 'bzdir', '/var/www/html/bugzilla')
try:
# Backwards-compatible with old notify string, which
# took one string. This will throw with a new format
# string.
cmd = cmdfmt % id
except TypeError:
cmd = cmdfmt % {'bzdir': bzdir, 'id': id, 'user': user}
self.ui.note(_('running notify command %s\n') % cmd)
Dirkjan Ochtman
replace usage of os.popen() with util.popen()...
r6548 fp = util.popen('(%s) 2>&1' % cmd)
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 out = fp.read()
ret = fp.close()
if ret:
self.ui.warn(out)
raise util.Abort(_('bugzilla notify command %s') %
util.explain_exit(ret)[0])
self.ui.status(_('done\n'))
def get_user_id(self, user):
'''look up numeric bugzilla user id.'''
try:
return self.user_ids[user]
except KeyError:
try:
userid = int(user)
except ValueError:
self.ui.note(_('looking up user %s\n') % user)
self.run('''select userid from profiles
where login_name like %s''', user)
all = self.cursor.fetchall()
if len(all) != 1:
raise KeyError(user)
userid = int(all[0][0])
self.user_ids[user] = userid
return userid
Jim Hague
Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail....
r7618 def get_bugzilla_user(self, committer):
Jim Hague
bugzilla: add XMLRPC interface....
r13801 '''See if committer is a registered bugzilla user. Return
Jim Hague
Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail....
r7618 bugzilla username and userid if so. If not, return default
bugzilla username and userid.'''
Vadim Gelfer
bugzilla: allow to map between committer email and bugzilla user name.
r2306 user = self.map_committer(committer)
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 try:
Vadim Gelfer
bugzilla: allow to map between committer email and bugzilla user name.
r2306 userid = self.get_user_id(user)
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 except KeyError:
try:
defaultuser = self.ui.config('bugzilla', 'bzuser')
Vadim Gelfer
bugzilla: allow to map between committer email and bugzilla user name.
r2306 if not defaultuser:
raise util.Abort(_('cannot find bugzilla user id for %s') %
user)
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 userid = self.get_user_id(defaultuser)
Jim Hague
Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail....
r7618 user = defaultuser
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 except KeyError:
Vadim Gelfer
bugzilla: allow to map between committer email and bugzilla user name.
r2306 raise util.Abort(_('cannot find bugzilla user id for %s or %s') %
(user, defaultuser))
Jim Hague
Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail....
r7618 return (user, userid)
def add_comment(self, bugid, text, committer):
'''add comment to bug. try adding comment as committer of
changeset, otherwise as default bugzilla user.'''
(user, userid) = self.get_bugzilla_user(committer)
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 now = time.strftime('%Y-%m-%d %H:%M:%S')
self.run('''insert into longdescs
(bug_id, who, bug_when, thetext)
values (%s, %s, %s, %s)''',
(bugid, userid, now, text))
self.run('''insert into bugs_activity (bug_id, who, bug_when, fieldid)
values (%s, %s, %s, %s)''',
(bugid, userid, now, self.longdesc_id))
Jim Hague
Fix Bugzilla integration to work with new Bugzilla 3.2....
r7493 self.conn.commit()
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192
Jim Hague
bugzilla: localise all MySQL direct access inside access class....
r13800 class bzmysql_2_18(bzmysql):
Jim Hague
Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail....
r7618 '''support for bugzilla 2.18 series.'''
def __init__(self, ui):
Jim Hague
bugzilla: localise all MySQL direct access inside access class....
r13800 bzmysql.__init__(self, ui)
Matt Mackall
many, many trivial check-code fixups
r10282 self.default_notify = \
"cd %(bzdir)s && perl -T contrib/sendbugmail.pl %(id)s %(user)s"
Jim Hague
Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail....
r7618
Jim Hague
bugzilla: localise all MySQL direct access inside access class....
r13800 class bzmysql_3_0(bzmysql_2_18):
Jim Hague
Add support for Bugzilla 3.0 series to bugzilla hook....
r7019 '''support for bugzilla 3.0 series.'''
def __init__(self, ui):
Jim Hague
bugzilla: localise all MySQL direct access inside access class....
r13800 bzmysql_2_18.__init__(self, ui)
Jim Hague
Add support for Bugzilla 3.0 series to bugzilla hook....
r7019
def get_longdesc_id(self):
'''get identity of longdesc field'''
self.run('select id from fielddefs where name = "longdesc"')
ids = self.cursor.fetchall()
if len(ids) != 1:
raise util.Abort(_('unknown database schema'))
return ids[0][0]
Jim Hague
bugzilla: add XMLRPC interface....
r13801 # Buzgilla via XMLRPC interface.
class CookieSafeTransport(xmlrpclib.SafeTransport):
"""A SafeTransport that retains cookies over its lifetime.
The regular xmlrpclib transports ignore cookies. Which causes
a bit of a problem when you need a cookie-based login, as with
the Bugzilla XMLRPC interface.
So this is a SafeTransport which looks for cookies being set
in responses and saves them to add to all future requests.
It appears a SafeTransport can do both HTTP and HTTPS sessions,
which saves us having to do a CookieTransport too.
"""
# Inspiration drawn from
# http://blog.godson.in/2010/09/how-to-make-python-xmlrpclib-client.html
# http://www.itkovian.net/base/transport-class-for-pythons-xml-rpc-lib/
cookies = []
def send_cookies(self, connection):
if self.cookies:
for cookie in self.cookies:
connection.putheader("Cookie", cookie)
def request(self, host, handler, request_body, verbose=0):
self.verbose = verbose
# issue XML-RPC request
h = self.make_connection(host)
if verbose:
h.set_debuglevel(1)
self.send_request(h, handler, request_body)
self.send_host(h, host)
self.send_cookies(h)
self.send_user_agent(h)
self.send_content(h, request_body)
# Deal with differences between Python 2.4-2.6 and 2.7.
# In the former h is a HTTP(S). In the latter it's a
# HTTP(S)Connection. Luckily, the 2.4-2.6 implementation of
# HTTP(S) has an underlying HTTP(S)Connection, so extract
# that and use it.
try:
response = h.getresponse()
except AttributeError:
response = h._conn.getresponse()
# Add any cookie definitions to our list.
for header in response.msg.getallmatchingheaders("Set-Cookie"):
val = header.split(": ", 1)[1]
cookie = val.split(";", 1)[0]
self.cookies.append(cookie)
if response.status != 200:
raise xmlrpclib.ProtocolError(host + handler, response.status,
response.reason, response.msg.headers)
payload = response.read()
parser, unmarshaller = self.getparser()
parser.feed(payload)
parser.close()
return unmarshaller.close()
class bzxmlrpc(bzaccess):
"""Support for access to Bugzilla via the Bugzilla XMLRPC API.
Requires a minimum Bugzilla version 3.4.
"""
def __init__(self, ui):
bzaccess.__init__(self, ui)
bzweb = self.ui.config('bugzilla', 'bzurl',
'http://localhost/bugzilla/')
bzweb = bzweb.rstrip("/") + "/xmlrpc.cgi"
user = self.ui.config('bugzilla', 'user', 'bugs')
passwd = self.ui.config('bugzilla', 'password')
self.bzproxy = xmlrpclib.ServerProxy(bzweb, CookieSafeTransport())
self.bzproxy.User.login(dict(login=user, password=passwd))
def get_bug_comments(self, id):
"""Return a string with all comment text for a bug."""
c = self.bzproxy.Bug.comments(dict(ids=[id]))
return ''.join([t['text'] for t in c['bugs'][str(id)]['comments']])
def filter_real_bug_ids(self, ids):
res = set()
bugs = self.bzproxy.Bug.get(dict(ids=sorted(ids), permissive=True))
for bug in bugs['bugs']:
res.add(bug['id'])
return res
def filter_cset_known_bug_ids(self, node, ids):
for id in sorted(ids):
if self.get_bug_comments(id).find(short(node)) != -1:
self.ui.status(_('bug %d already knows about changeset %s\n') %
(id, short(node)))
ids.discard(id)
return ids
def add_comment(self, bugid, text, committer):
self.bzproxy.Bug.add_comment(dict(id=bugid, comment=text))
Jim Hague
bugzilla: add modified XMLRPC mode that uses email to send bug comments....
r13802 class bzxmlrpcemail(bzxmlrpc):
"""Read data from Bugzilla via XMLRPC, send updates via email.
Advantages of sending updates via email:
1. Comments can be added as any user, not just logged in user.
2. Bug statuses and other fields not accessible via XMLRPC can
be updated. This is not currently used.
"""
def __init__(self, ui):
bzxmlrpc.__init__(self, ui)
self.bzemail = self.ui.config('bugzilla', 'bzemail')
if not self.bzemail:
raise util.Abort(_("configuration 'bzemail' missing"))
mail.validateconfig(self.ui)
def send_bug_modify_email(self, bugid, commands, comment, committer):
'''send modification message to Bugzilla bug via email.
The message format is documented in the Bugzilla email_in.pl
specification. commands is a list of command lines, comment is the
comment text.
To stop users from crafting commit comments with
Bugzilla commands, specify the bug ID via the message body, rather
than the subject line, and leave a blank line after it.
'''
user = self.map_committer(committer)
matches = self.bzproxy.User.get(dict(match=[user]))
if not matches['users']:
user = self.ui.config('bugzilla', 'user', 'bugs')
matches = self.bzproxy.User.get(dict(match=[user]))
if not matches['users']:
raise util.Abort(_("default bugzilla user %s email not found") %
user)
user = matches['users'][0]['email']
text = "\n".join(commands) + "\n@bug_id = %d\n\n" % bugid + comment
_charsets = mail._charsets(self.ui)
user = mail.addressencode(self.ui, user, _charsets)
bzemail = mail.addressencode(self.ui, self.bzemail, _charsets)
msg = mail.mimeencode(self.ui, text, _charsets)
msg['From'] = user
msg['To'] = bzemail
msg['Subject'] = mail.headencode(self.ui, "Bug modification", _charsets)
sendmail = mail.connect(self.ui)
sendmail(user, bzemail, msg.as_string())
def add_comment(self, bugid, text, committer):
self.send_bug_modify_email(bugid, [], text, committer)
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 class bugzilla(object):
# supported versions of bugzilla. different versions have
# different schemas.
_versions = {
Jim Hague
bugzilla: localise all MySQL direct access inside access class....
r13800 '2.16': bzmysql,
'2.18': bzmysql_2_18,
Jim Hague
bugzilla: add XMLRPC interface....
r13801 '3.0': bzmysql_3_0,
Jim Hague
bugzilla: add modified XMLRPC mode that uses email to send bug comments....
r13802 'xmlrpc': bzxmlrpc,
'xmlrpc+email': bzxmlrpcemail
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 }
_default_bug_re = (r'bugs?\s*,?\s*(?:#|nos?\.?|num(?:ber)?s?)?\s*'
r'((?:\d+\s*(?:,?\s*(?:and)?)?\s*)+)')
_bz = None
def __init__(self, ui, repo):
self.ui = ui
self.repo = repo
def bz(self):
'''return object that knows how to talk to bugzilla version in
use.'''
if bugzilla._bz is None:
bzversion = self.ui.config('bugzilla', 'version')
try:
bzclass = bugzilla._versions[bzversion]
except KeyError:
raise util.Abort(_('bugzilla version %s not supported') %
bzversion)
bugzilla._bz = bzclass(self.ui)
return bugzilla._bz
def __getattr__(self, key):
return getattr(self.bz(), key)
_bug_re = None
_split_re = None
Benoit Boissinot
bugzilla: use contexts, simplify
r3976 def find_bug_ids(self, ctx):
Jim Hague
bugzilla: keep bug IDs in set....
r13799 '''return set of integer bug IDs from commit comment.
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192
Jim Hague
bugzilla: keep bug IDs in set....
r13799 Extract bug IDs from changeset comments. Filter out any that are
not known to Bugzilla, and any that already have a reference to
the given changeset in their comments.
'''
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 if bugzilla._bug_re is None:
bugzilla._bug_re = re.compile(
self.ui.config('bugzilla', 'regexp', bugzilla._default_bug_re),
re.IGNORECASE)
bugzilla._split_re = re.compile(r'\D+')
start = 0
Benoit Boissinot
bugzilla: use set instead of dict
r8455 ids = set()
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 while True:
Benoit Boissinot
bugzilla: use contexts, simplify
r3976 m = bugzilla._bug_re.search(ctx.description(), start)
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 if not m:
break
start = m.end()
for id in bugzilla._split_re.split(m.group(1)):
Matt Mackall
many, many trivial check-code fixups
r10282 if not id:
continue
Benoit Boissinot
bugzilla: use set instead of dict
r8455 ids.add(int(id))
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 if ids:
ids = self.filter_real_bug_ids(ids)
if ids:
Jim Hague
bugzilla: rename filter_unknown_bug_ids to reflect its actual purpose....
r13798 ids = self.filter_cset_known_bug_ids(ctx.node(), ids)
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 return ids
Benoit Boissinot
bugzilla: use contexts, simplify
r3976 def update(self, bugid, ctx):
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 '''update bugzilla bug with reference to changeset.'''
def webroot(root):
'''strip leading prefix of repo root and turn into
url-safe path.'''
count = int(self.ui.config('bugzilla', 'strip', 0))
root = util.pconvert(root)
while count > 0:
c = root.find('/')
if c == -1:
break
Matt Mackall
many, many trivial check-code fixups
r10282 root = root[c + 1:]
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 count -= 1
return root
mapfile = self.ui.config('bugzilla', 'style')
tmpl = self.ui.config('bugzilla', 'template')
Matt Mackall
update bugzilla extension to use ui buffers
r3741 t = cmdutil.changeset_templater(self.ui, self.repo,
Jim Correia
add --git option to commands supporting --patch (log, incoming, history, tip)...
r7762 False, None, mapfile, False)
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 if not mapfile and not tmpl:
tmpl = _('changeset {node|short} in repo {root} refers '
'to bug {bug}.\ndetails:\n\t{desc|tabindent}')
if tmpl:
tmpl = templater.parsestring(tmpl, quoted=False)
t.use_template(tmpl)
Matt Mackall
update bugzilla extension to use ui buffers
r3741 self.ui.pushbuffer()
Dirkjan Ochtman
cmdutil: use change contexts for cset-printer and cset-templater
r7369 t.show(ctx, changes=ctx.changeset(),
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 bug=str(bugid),
Vadim Gelfer
define standard name for base url to use when printing hgweb urls....
r2197 hgweb=self.ui.config('web', 'baseurl'),
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 root=self.repo.root,
webroot=webroot(self.repo.root))
Matt Mackall
update bugzilla extension to use ui buffers
r3741 data = self.ui.popbuffer()
Matt Mackall
templater: move email function to util
r5975 self.add_comment(bugid, data, util.email(ctx.user()))
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192
def hook(ui, repo, hooktype, node=None, **kwargs):
'''add comment to bugzilla for each changeset that refers to a
bugzilla bug id. only add a comment once per bug, so same change
seen multiple times does not fill bug with duplicate data.'''
if node is None:
raise util.Abort(_('hook type %s does not pass a changeset id') %
hooktype)
try:
bz = bugzilla(ui, repo)
Matt Mackall
use repo[changeid] to get a changectx
r6747 ctx = repo[node]
Benoit Boissinot
bugzilla: use contexts, simplify
r3976 ids = bz.find_bug_ids(ctx)
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192 if ids:
for id in ids:
Benoit Boissinot
bugzilla: use contexts, simplify
r3976 bz.update(id, ctx)
Jim Hague
Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail....
r7618 bz.notify(ids, util.email(ctx.user()))
Jim Hague
bugzilla: localise all MySQL direct access inside access class....
r13800 except Exception, e:
raise util.Abort(_('Bugzilla error: %s') % e)
Vadim Gelfer
add bugzilla integration hook. example of writing hook in python....
r2192