plugin merge requests Mercurial: first draft:

this plugin handle Mercurial VCS. It send merge requests using export command, and parse it to retrieve individual patches and metadata.

src/plugins/plugin_merge_req_mercurial.py

@@ -0,0 +1,166 @@
+#!/usr/bin/env python2
+# -*- coding: utf-8 -*-
+
+# SàT plugin for import external blogs
+# Copyright (C) 2009-2017 Jérôme Poisson (goffi@goffi.org)
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program 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 Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+from sat.core.i18n import _, D_
+from sat.core.constants import Const as C
+from sat.core import exceptions
+from twisted.internet import reactor, defer, protocol
+from twisted.python.failure import Failure
+from twisted.python.procutils import which
+from sat.core.log import getLogger
+log = getLogger(__name__)
+
+
+PLUGIN_INFO = {
+    C.PI_NAME: "Mercurial Merge Request handler",
+    C.PI_IMPORT_NAME: "MERGE_REQUEST_MERCURIAL",
+    C.PI_TYPE: C.PLUG_TYPE_MISC,
+    C.PI_DEPENDENCIES: ["MERGE_REQUESTS"],
+    C.PI_MAIN: "MercurialHandler",
+    C.PI_HANDLER: "no",
+    C.PI_DESCRIPTION: _(u"""Merge request handler for Mercurial""")
+}
+
+SHORT_DESC = D_(u"handle Mercurial repository")
+
+
+class MercurialProtocol(protocol.ProcessProtocol):
+    """handle hg commands"""
+    hg = None
+
+    def __init__(self, deferred):
+        self._deferred = deferred
+        self.data = []
+
+    def outReceived(self, data):
+        self.data.append(data)
+
+    def errReceived(self, data):
+        self.data.append(data)
+
+    def processEnded(self, reason):
+        data = u''.join([d.decode('utf-8') for d in self.data])
+        if (reason.value.exitCode == 0):
+            log.debug(_('Mercurial command succeed'))
+            self._deferred.callback(data)
+        else:
+            log.error(_(u"Can't complete Mercurial command (error code: {code}): {message}").format(
+                code = reason.value.exitCode,
+                message = data))
+            self._deferred.errback(Failure(RuntimeError))
+
+    @classmethod
+    def run(cls, path, command, *args):
+        """Create a new MercurialRegisterProtocol and execute the given mercurialctl command.
+
+        @param path(unicode): path to the repository
+        @param command(unicode): command to run
+        @param *args(unicode): command arguments
+        @return ((D)):
+        """
+        d = defer.Deferred()
+        mercurial_prot = MercurialProtocol(d)
+        cmd_args = [cls.hg, command.encode('utf-8')]
+        cmd_args.extend([a.encode('utf-8') for a in args])
+        reactor.spawnProcess(mercurial_prot,
+                             cls.hg,
+                             cmd_args,
+                             path=path.encode('utf-8'))
+        return d
+
+
+class MercurialHandler(object):
+
+    def __init__(self, host):
+        log.info(_(u"Mercurial merge request handler initialization"))
+        try:
+            MercurialProtocol.hg = which('hg')[0]
+        except IndexError:
+            raise exceptions.NotFound(_(u"Mercurial executable (hg) not found, can't use Mercurial handler"))
+        self.host = host
+        self._m = host.plugins['MERGE_REQUESTS']
+        self._m.register('mercurial', self, [u'mercurial_changeset'], SHORT_DESC)
+
+    def check(self, repository):
+        d = MercurialProtocol.run(repository, 'identify')
+        d.addCallback(lambda dummy: True)
+        d.addErrback(lambda dummy: False)
+        return d
+
+    def export(self, repository):
+        return MercurialProtocol.run(repository, 'export', '-g', '-r', 'outgoing()', '--encoding=utf-8')
+
+    def parse(self, data, data_type=None):
+        lines = data.splitlines()
+        total_lines = len(lines)
+        patches = []
+        while lines:
+            patch = {}
+            commit_msg = []
+            diff = []
+            state = 'init'
+            if lines[0] != '# HG changeset patch':
+                raise exceptions.DataError(_(u'invalid changeset signature'))
+            # line index of this patch in the whole data
+            patch_idx = total_lines - len(lines)
+            del lines[0]
+
+            for idx, line in enumerate(lines):
+                if state == 'init':
+                    if line.startswith(u'# '):
+                        if line.startswith(u'# User '):
+                            elems = line[7:].split()
+                            if not elems:
+                                continue
+                            last = elems[-1]
+                            if last.startswith(u'<') and last.endswith(u'>') and u'@' in last:
+                                patch[self._m.META_EMAIL] = elems.pop()[1:-1]
+                            patch[self._m.META_AUTHOR] = u' '.join(elems)
+                        elif line.startswith(u'# Date '):
+                            time_data = line[7:].split()
+                            if len(time_data) != 2:
+                                log.warning(_(u'unexpected time data: {data}').format(data=line[7:]))
+                                continue
+                            patch[self._m.META_TIMESTAMP] = int(time_data[0]) + int(time_data[1])
+                        elif line.startswith(u'# Node ID '):
+                            patch[self._m.META_HASH] = line[10:]
+                        elif line.startswith(u'# Parent  '):
+                            patch[self._m.META_PARENT_HASH] = line[10:]
+                    else:
+                        state = 'commit_msg'
+                if state == 'commit_msg':
+                    if line.startswith(u'diff --git a/'):
+                        state = 'diff'
+                        patch[self._m.META_DIFF_IDX] = patch_idx + idx + 1
+                    else:
+                        commit_msg.append(line)
+                if state == 'diff':
+                    if line.startswith(u'# ') or idx == len(lines)-1:
+                        # a new patch is starting or we have reached end of patches
+                        patch[self._m.META_COMMIT_MSG] = u'\n'.join(commit_msg)
+                        patch[self._m.META_DIFF] = u'\n'.join(diff)
+                        patches.append(patch)
+                        if idx == len(lines)-1:
+                            del lines[:]
+                        else:
+                            del lines[:idx]
+                        break
+                    else:
+                        diff.append(line)
+        return patches