~dpb/tarmac/commit-message-newline

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
# Copyright 2009 Paul Hummer
# This file is part of Tarmac.
#
# Tarmac 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.
#
# Tarmac 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 Tarmac.  If not, see <http://www.gnu.org/licenses/>.

'''Tarmac plugin for enforcing a commit message format.

This code is derived from Jelmer Vernooij's CIA script for Bazaar that is found
at http://samba.org/~jelmer/bzr/cia_bzr.py and modified to fit within the needs
of Tarmac.
'''

# Head off lint warnings.
saxutils = None
xmlrpclib = None

from bzrlib.lazy_import import lazy_import
lazy_import(globals(), '''
    import xmlrpclib
    from xml.sax import saxutils
    ''')

from tarmac import __version__ as version_string
from tarmac.hooks import tarmac_hooks
from tarmac.plugins import TarmacPlugin


class CIAVC(TarmacPlugin):
    '''Tarmac plugin for notifying CIA.vc of new commits.'''

    def run(self, command, target, source, proposal):
    # pylint: disable-msg=W0613,W0104,C0324

        try:
            cia_project = target.config.cia_project
            cia_server = target.config.cia_server
        except AttributeError:
            return

        revno = target.bzr_branch.revno()
        files = []
        delta = target.bzr_branch.get_revision_delta(revno)

        [files.append(f) for (f, _x, _x) in delta.added]
        [files.append(f) for (f, _x, _x) in delta.removed]
        [files.append(f) for (_x, f, _x, _x, _x, _x) in delta.renamed]
        [files.append(f) for (f, _x, _x, _x, _x) in delta.modified]

        message = '''
<message>
  <generator>
    <name>Tarmac</name>
    <version>%(version)s</version>
    <url>http://launchpad.net/tarmac</url>
  </generator>
  <source>
    <project>%(project)s</project>
    <module>%(branch)s</module>
  </source>
  <body>
    <commit>
      <revision>%(revision)s</revision>
      <files>%(files)s</files>
      <author>%(author)s</author>
      <log>%(commit_message)s</log>
    </commit>
  </body>
</message>
        ''' % {
            'version': version_string,
            'project': cia_project,
            'branch': target.lp_branch.bzr_identity,
            'revision': revno,
            'files': '\n'.join([
                '<file>%s</file>' % saxutils.escape(f) for f in files]),
            'author': saxutils.escape(
                proposal.source_branch.owner.display_name),
            'commit_message': saxutils.escape(proposal.commit_message)}

        self.logger.info(
            "Updating CIA server at %(project)s for project %(server)s" % {
                'project': cia_project,
                'server': cia_server})
        self.logger.debug(message)
        xmlrpclib.ServerProxy(cia_server).hub.deliver(message)

tarmac_hooks['tarmac_post_commit'].hook(CIAVC(), 'CIA.vc plugin.')