[PATCH 2 of 2 RFC] bugzilla: add a rest api backend (usable with bugzilla 5.0+)
John Mulligan
phlogistonjohn at asynchrono.us
Thu Feb 9 15:30:38 EST 2017
# HG changeset patch
# User John Mulligan <phlogistonjohn at asynchrono.us>
# Date 1486671641 18000
# Thu Feb 09 15:20:41 2017 -0500
# Node ID 6441cf5bde93d1b33a08e9f39778394048c27fe4
# Parent 71debb56ce136086187d7f9c1986eb7f3b9ee0a9
bugzilla: add a rest api backend (usable with bugzilla 5.0+)
Add support for the bugzilla rest api documented at
https://wiki.mozilla.org/Bugzilla:REST_API
and at
https://bugzilla.readthedocs.io/en/latest/
This backend has the following benefits:
* It supports the bugzilla api keys so hgrc does not need to contain
a user's bugzilla password
* Works with Mercurial's "hostfingerprints" support making handling
bugzilla instances with self-signed certs easier
* Does not use xmlrpc ;-)
Adds configuration item 'apikey' in [bugzilla] section.
My major concern with these patches is if the approach to HTTP access
is the right way for an extension and if hooking into request object
and the overriding the get_method to perform PUT requests was a
sensible approach.
diff --git a/hgext/bugzilla.py b/hgext/bugzilla.py
--- a/hgext/bugzilla.py
+++ b/hgext/bugzilla.py
@@ -15,14 +15,16 @@ the Mercurial template mechanism.
The bug references can optionally include an update for Bugzilla of the
hours spent working on the bug. Bugs can also be marked fixed.
-Three basic modes of access to Bugzilla are provided:
+Four basic modes of access to Bugzilla are provided:
-1. Access via the Bugzilla XMLRPC interface. Requires Bugzilla 3.4 or later.
+1. Access via the Bugzilla REST-API. Requires bugzilla 5.0 or later.
-2. Check data via the Bugzilla XMLRPC interface and submit bug change
+2. Access via the Bugzilla XMLRPC interface. Requires Bugzilla 3.4 or later.
+
+3. Check data via the Bugzilla XMLRPC interface and submit bug change
via email to Bugzilla email interface. Requires Bugzilla 3.4 or later.
-3. Writing directly to the Bugzilla database. Only Bugzilla installations
+4. Writing directly to the Bugzilla database. Only Bugzilla installations
using MySQL are supported. Requires Python MySQLdb.
Writing directly to the database is susceptible to schema changes, and
@@ -50,11 +52,16 @@ user, the email associated with the Bugz
Bugzilla is used instead as the source of the comment. Marking bugs fixed
works on all supported Bugzilla versions.
+Access via the REST-API needs either a Bugzilla username and password
+or an apikey specified in the configuration. Comments are made under
+the given username or the user assoicated with the apikey in Bugzilla.
+
Configuration items common to all access modes:
bugzilla.version
The access type to use. Values recognized are:
+ :``restapi``: Bugzilla REST-API, Bugzilla 5.0 and later.
:``xmlrpc``: Bugzilla XMLRPC interface.
:``xmlrpc+email``: Bugzilla XMLRPC and email interfaces.
:``3.0``: MySQL access, Bugzilla 3.0 and later.
@@ -135,7 +142,7 @@ The ``[usermap]`` section is used to spe
committer email to Bugzilla user email. See also ``bugzilla.usermap``.
Contains entries of the form ``committer = Bugzilla user``.
-XMLRPC access mode configuration:
+XMLRPC and REST-API access mode configuration:
bugzilla.bzurl
The base URL for the Bugzilla installation.
@@ -148,6 +155,13 @@ bugzilla.user
bugzilla.password
The password for Bugzilla login.
+REST-API access mode uses the options listed above as well as:
+
+bugzilla.apikey
+ An apikey generated on the Bugzilla instance for api access.
+ Using an apikey removes the need to store the user and password
+ options.
+
XMLRPC+email access mode uses the XMLRPC access mode configuration items,
and also:
@@ -281,6 +295,7 @@ from __future__ import absolute_import
import re
import time
+import json
from mercurial.i18n import _
from mercurial.node import short
@@ -288,6 +303,7 @@ from mercurial import (
cmdutil,
error,
mail,
+ url,
util,
)
@@ -773,6 +789,136 @@ class bzxmlrpcemail(bzxmlrpc):
cmds.append(self.makecommandline("resolution", self.fixresolution))
self.send_bug_modify_email(bugid, cmds, text, committer)
+class NotFound(LookupError):
+ pass
+
+class bzrestapi(bzaccess):
+ """Read and write bugzilla data using the REST API available since
+ Bugzilla 5.0.
+ """
+ def __init__(self, ui):
+ bzaccess.__init__(self, ui)
+ bz = self.ui.config('bugzilla', 'bzurl',
+ 'http://localhost/bugzilla/')
+ self.bzroot = '/'.join([bz, 'rest'])
+ self.apikey = self.ui.config('bugzilla', 'apikey', '')
+ self.user = self.ui.config('bugzilla', 'user', 'bugs')
+ self.passwd = self.ui.config('bugzilla', 'password')
+ self.fixstatus = self.ui.config('bugzilla', 'fixstatus', 'RESOLVED')
+ self.fixresolution = self.ui.config('bugzilla', 'fixresolution',
+ 'FIXED')
+
+ def apiurl(self, targets, include_fields=None):
+ url = '/'.join([self.bzroot] + [str(t) for t in targets])
+ qv = {}
+ if self.apikey:
+ qv['api_key'] = self.apikey
+ elif self.user and self.passwd:
+ qv['login'] = self.user
+ qv['password'] = self.passwd
+ if include_fields:
+ qv['include_fields'] = include_fields
+ if qv:
+ url = '%s?%s' % (url, util.urlreq.urlencode(qv))
+ return url
+
+ def _fetch(self, burl):
+ try:
+ resp = url.open(self.ui, burl)
+ return json.loads(resp.read())
+ except util.urlerr.httperror as inst:
+ if inst.code == 401:
+ raise error.Abort(_('authorization failed'))
+ if inst.code == 404:
+ raise NotFound()
+ else:
+ raise
+
+ def _submit(self, burl, data, method='POST'):
+ data = json.dumps(data)
+ if method == 'PUT':
+ class putrequest(util.urlreq.request):
+ def get_method(self):
+ return 'PUT'
+ request_type = putrequest
+ else:
+ request_type = util.urlreq.request
+ req = request_type(burl, data,
+ {'Content-Type': 'application/json'})
+ try:
+ resp = url.opener(self.ui).open(req)
+ return json.loads(resp.read())
+ except util.urlerr.httperror as inst:
+ if inst.code == 401:
+ raise error.Abort(_('authorization failed'))
+ if inst.code == 404:
+ raise NotFound()
+ else:
+ raise
+
+ def filter_real_bug_ids(self, bugs):
+ '''remove bug IDs that do not exist in Bugzilla from bugs.'''
+ badbugs = set()
+ for bugid in bugs:
+ burl = self.apiurl(('bug', bugid), include_fields='status')
+ try:
+ self._fetch(burl)
+ except NotFound:
+ badbugs.add(bugid)
+ for bugid in badbugs:
+ del bugs[bugid]
+
+ def filter_cset_known_bug_ids(self, node, bugs):
+ '''remove bug IDs where node occurs in comment text from bugs.'''
+ sn = short(node)
+ for bugid in bugs.keys():
+ burl = self.apiurl(('bug', bugid, 'comment'), include_fields='text')
+ result = self._fetch(burl)
+ comments = result['bugs'][str(bugid)]['comments']
+ if any(sn in c['text'] for c in comments):
+ self.ui.status(_('bug %d already knows about changeset %s\n') %
+ (bugid, sn))
+ del bugs[bugid]
+
+ def updatebug(self, bugid, newstate, text, committer):
+ '''update the specified bug. Add comment text and set new states.
+
+ If possible add the comment as being from the committer of
+ the changeset. Otherwise use the default Bugzilla user.
+ '''
+ bugmod = {}
+ if 'hours' in newstate:
+ bugmod['work_time'] = newstate['hours']
+ if 'fix' in newstate:
+ bugmod['status'] = self.fixstatus
+ bugmod['resolution'] = self.fixresolution
+ if bugmod:
+ # if we have to change the bugs state do it here
+ bugmod['comment'] = {
+ 'comment': text,
+ 'is_private': False,
+ 'is_markdown': False,
+ }
+ burl = self.apiurl(('bug', bugid))
+ self._submit(burl, bugmod, method='PUT')
+ self.ui.debug('updated bug %s\n' % bugid)
+ else:
+ burl = self.apiurl(('bug', bugid, 'comment'))
+ self._submit(burl, {
+ 'comment': text,
+ 'is_private': False,
+ 'is_markdown': False,
+ })
+ self.ui.debug('added comment to bug %s\n' % bugid)
+
+ def notify(self, bugs, committer):
+ '''Force sending of Bugzilla notification emails.
+
+ Only required if the access method does not trigger notification
+ emails automatically.
+ '''
+ pass
+
class bugzilla(object):
# supported versions of bugzilla. different versions have
# different schemas.
@@ -781,7 +927,8 @@ class bugzilla(object):
'2.18': bzmysql_2_18,
'3.0': bzmysql_3_0,
'xmlrpc': bzxmlrpc,
- 'xmlrpc+email': bzxmlrpcemail
+ 'xmlrpc+email': bzxmlrpcemail,
+ 'restapi': bzrestapi,
}
_default_bug_re = (r'bugs?\s*,?\s*(?:#|nos?\.?|num(?:ber)?s?)?\s*'
More information about the Mercurial-devel
mailing list