Teach webkitbot and WKR how to respond to yt?
[WebKit-https.git] / Tools / Scripts / webkitpy / tool / commands / newcommitbot.py
1 # Copyright (c) 2012 Google Inc. All rights reserved.
2 # Copyright (c) 2013 Apple Inc. All rights reserved.
3 #
4 # Redistribution and use in source and binary forms, with or without
5 # modification, are permitted provided that the following conditions are
6 # met:
7 #
8 #     * Redistributions of source code must retain the above copyright
9 # notice, this list of conditions and the following disclaimer.
10 #     * Redistributions in binary form must reproduce the above
11 # copyright notice, this list of conditions and the following disclaimer
12 # in the documentation and/or other materials provided with the
13 # distribution.
14 #     * Neither the name of Google Inc. nor the names of its
15 # contributors may be used to endorse or promote products derived from
16 # this software without specific prior written permission.
17 #
18 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30 import logging
31 import re
32
33 from webkitpy.common.config.committers import CommitterList
34 from webkitpy.common.system.executive import ScriptError
35 from webkitpy.tool.bot.irc_command import IRCCommand
36 from webkitpy.tool.bot.irc_command import Help
37 from webkitpy.tool.bot.irc_command import Hi
38 from webkitpy.tool.bot.irc_command import PingPong
39 from webkitpy.tool.bot.irc_command import Restart
40 from webkitpy.tool.bot.irc_command import YouThere
41 from webkitpy.tool.bot.ircbot import IRCBot
42 from webkitpy.tool.commands.queues import AbstractQueue
43 from webkitpy.tool.commands.stepsequence import StepSequenceErrorHandler
44
45 _log = logging.getLogger(__name__)
46
47
48 class NewCommitBot(AbstractQueue, StepSequenceErrorHandler):
49     name = "new-commit-bot"
50     watchers = AbstractQueue.watchers + ["rniwa@webkit.org"]
51
52     _commands = {
53         "hi": Hi,
54         "ping": PingPong,
55         "restart": Restart,
56         "yt?": YouThere,
57     }
58
59     _maximum_number_of_revisions_to_avoid_spamming_irc = 10
60
61     # AbstractQueue methods
62
63     def begin_work_queue(self):
64         AbstractQueue.begin_work_queue(self)
65         self._last_svn_revision = int(self._tool.scm().head_svn_revision())
66         self._irc_bot = IRCBot('WKR', self._tool, None, self._commands)
67         self._tool.ensure_irc_connected(self._irc_bot.irc_delegate())
68
69     def work_item_log_path(self, failure_map):
70         return None
71
72     def next_work_item(self):
73         self._irc_bot.process_pending_messages()
74
75         _log.info('Last SVN revision: %d' % self._last_svn_revision)
76
77         count = 0
78         while count < self._maximum_number_of_revisions_to_avoid_spamming_irc:
79             new_revision = self._last_svn_revision + 1
80             try:
81                 commit_log = self._tool.executive.run_command(['svn', 'log', 'https://svn.webkit.org/repository/webkit/trunk', '--non-interactive', '--revision',
82                     self._tool.scm().strip_r_from_svn_revision(new_revision)])
83             except ScriptError:
84                 break
85
86             if commit_log.find('No such revision') >= 0:
87                 continue
88
89             self._last_svn_revision = new_revision
90             if self._is_empty_log(commit_log):
91                 continue
92
93             count += 1
94             _log.info('Found revision %d' % new_revision)
95             self._tool.irc().post(self._summarize_commit_log(commit_log).encode('utf-8'))
96
97     def _is_empty_log(self, commit_log):
98         return re.match(r'^\-+$', commit_log)
99
100     def process_work_item(self, failure_map):
101         return True
102
103     _patch_by_regex = re.compile(r'^Patch\s+by\s+(?P<author>.+?)\s+on(\s+\d{4}-\d{2}-\d{2})?\n?', re.MULTILINE | re.IGNORECASE)
104     _rollout_regex = re.compile(r'(rolling out|reverting) (?P<revisions>r?\d+((,\s*|,?\s*and\s+)?r?\d+)*)\.?\s*', re.MULTILINE | re.IGNORECASE)
105     _requested_by_regex = re.compile(r'^\"?(?P<reason>.+?)\"? \(Requested\s+by\s+(?P<author>.+?)\s+on\s+#webkit\)\.', re.MULTILINE | re.IGNORECASE)
106     _bugzilla_url_regex = re.compile(r'http(s?)://bugs\.webkit\.org/show_bug\.cgi\?id=(?P<id>\d+)', re.MULTILINE)
107     _trac_url_regex = re.compile(r'http(s?)://trac.webkit.org/changeset/(?P<revision>\d+)', re.MULTILINE)
108
109     @classmethod
110     def _summarize_commit_log(self, commit_log, committer_list=CommitterList()):
111         patch_by = self._patch_by_regex.search(commit_log)
112         commit_log = self._patch_by_regex.sub('', commit_log, count=1)
113
114         rollout = self._rollout_regex.search(commit_log)
115         commit_log = self._rollout_regex.sub('', commit_log, count=1)
116
117         requested_by = self._requested_by_regex.search(commit_log)
118
119         commit_log = self._bugzilla_url_regex.sub(r'https://webkit.org/b/\g<id>', commit_log)
120         commit_log = self._trac_url_regex.sub(r'https://trac.webkit.org/r\g<revision>', commit_log)
121
122         for contributor in committer_list.contributors():
123             if not contributor.irc_nicknames:
124                 continue
125             name_with_nick = "%s (%s)" % (contributor.full_name, contributor.irc_nicknames[0])
126             if contributor.full_name in commit_log:
127                 commit_log = commit_log.replace(contributor.full_name, name_with_nick)
128                 for email in contributor.emails:
129                     commit_log = commit_log.replace(' <' + email + '>', '')
130             else:
131                 for email in contributor.emails:
132                     commit_log = commit_log.replace(email, name_with_nick)
133
134         lines = commit_log.split('\n')[1:-2]  # Ignore lines with ----------.
135
136         firstline = re.match(r'^(?P<revision>r\d+) \| (?P<email>[^\|]+) \| (?P<timestamp>[^|]+) \| [^\n]+', lines[0])
137         assert firstline
138         author = firstline.group('email')
139         if patch_by:
140             author = patch_by.group('author')
141
142         linkified_revision = 'https://trac.webkit.org/%s' % firstline.group('revision')
143         lines[0] = '%s by %s' % (linkified_revision, author)
144
145         if rollout:
146             if requested_by:
147                 author = requested_by.group('author')
148                 contributor = committer_list.contributor_by_irc_nickname(author)
149                 if contributor:
150                     author = "%s (%s)" % (contributor.full_name, contributor.irc_nicknames[0])
151                 return '%s rolled out %s in %s : %s' % (author, rollout.group('revisions'),
152                     linkified_revision, requested_by.group('reason'))
153             lines[0] = '%s rolled out %s in %s' % (author, rollout.group('revisions'), linkified_revision)
154
155         return ' '.join(filter(lambda line: len(line), lines)[0:4])
156
157     def handle_unexpected_error(self, failure_map, message):
158         _log.error(message)
159
160     # StepSequenceErrorHandler methods
161
162     @classmethod
163     def handle_script_error(cls, tool, state, script_error):
164         # Ideally we would post some information to IRC about what went wrong
165         # here, but we don't have the IRC password in the child process.
166         pass