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.ircbot import IRCBot
  41 from webkitpy.tool.commands.queues import AbstractQueue
  42 from webkitpy.tool.commands.stepsequence import StepSequenceErrorHandler
  43
  44 _log = logging.getLogger(__name__)
  45
  46
  47 class NewCommitBot(AbstractQueue, StepSequenceErrorHandler):
  48     name = "new-commit-bot"
  49     watchers = AbstractQueue.watchers + ["rniwa@webkit.org"]
  50
  51     _commands = {
  52         "hi": Hi,
  53         "ping": PingPong,
  54         "restart": Restart,
  55     }
  56
  57     _maximum_number_of_revisions_to_avoid_spamming_irc = 10
  58
  59     # AbstractQueue methods
  60
  61     def begin_work_queue(self):
  62         AbstractQueue.begin_work_queue(self)
  63         self._last_svn_revision = int(self._tool.scm().head_svn_revision())
  64         self._irc_bot = IRCBot('WKR', self._tool, None, self._commands)
  65         self._tool.ensure_irc_connected(self._irc_bot.irc_delegate())
  66
  67     def work_item_log_path(self, failure_map):
  68         return None
  69
  70     def next_work_item(self):
  71         self._irc_bot.process_pending_messages()
  72
  73         _log.info('Last SVN revision: %d' % self._last_svn_revision)
  74
  75         for revision in range(self._last_svn_revision + 1, self._last_svn_revision + self._maximum_number_of_revisions_to_avoid_spamming_irc):
  76             try:
  77                 commit_log = self._tool.executive.run_command(['svn', 'log', 'https://svn.webkit.org/repository/webkit/trunk', '--non-interactive', '--revision',
  78                     self._tool.scm().strip_r_from_svn_revision(revision)])
  79             except ScriptError:
  80                 break
  81             if self._is_empty_log(commit_log) or commit_log.find('No such revision') >= 0:
  82                 continue
  83             _log.info('Found revision %d' % revision)
  84             self._last_svn_revision = revision
  85             self._tool.irc().post(self._summarize_commit_log(commit_log).encode('utf-8'))
  86
  87     def _is_empty_log(self, commit_log):
  88         return re.match(r'^\-+$', commit_log)
  89
  90     def process_work_item(self, failure_map):
  91         return True
  92
  93     _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)
  94     _rollout_regex = re.compile(r'(rolling out|reverting) (?P<revisions>r?\d+((,\s*|,?\s*and\s+)?r?\d+)*)\.?\s*', re.MULTILINE | re.IGNORECASE)
  95     _requested_by_regex = re.compile(r'^\"?(?P<reason>.+?)\"? \(Requested\s+by\s+(?P<author>.+?)\s+on\s+#webkit\)\.', re.MULTILINE | re.IGNORECASE)
  96     _bugzilla_url_regex = re.compile(r'http(s?)://bugs\.webkit\.org/show_bug\.cgi\?id=(?P<id>\d+)', re.MULTILINE)
  97     _trac_url_regex = re.compile(r'http(s?)://trac.webkit.org/changeset/(?P<revision>\d+)', re.MULTILINE)
  98
  99     @classmethod
 100     def _summarize_commit_log(self, commit_log, committer_list=CommitterList()):
 101         patch_by = self._patch_by_regex.search(commit_log)
 102         commit_log = self._patch_by_regex.sub('', commit_log, count=1)
 103
 104         rollout = self._rollout_regex.search(commit_log)
 105         commit_log = self._rollout_regex.sub('', commit_log, count=1)
 106
 107         requested_by = self._requested_by_regex.search(commit_log)
 108
 109         commit_log = self._bugzilla_url_regex.sub(r'https://webkit.org/b/\g<id>', commit_log)
 110         commit_log = self._trac_url_regex.sub(r'https://trac.webkit.org/r\g<revision>', commit_log)
 111
 112         for contributor in committer_list.contributors():
 113             if not contributor.irc_nicknames:
 114                 continue
 115             name_with_nick = "%s (%s)" % (contributor.full_name, contributor.irc_nicknames[0])
 116             if contributor.full_name in commit_log:
 117                 commit_log = commit_log.replace(contributor.full_name, name_with_nick)
 118                 for email in contributor.emails:
 119                     commit_log = commit_log.replace(' <' + email + '>', '')
 120             else:
 121                 for email in contributor.emails:
 122                     commit_log = commit_log.replace(email, name_with_nick)
 123
 124         lines = commit_log.split('\n')[1:-2]  # Ignore lines with ----------.
 125
 126         firstline = re.match(r'^(?P<revision>r\d+) \| (?P<email>[^\|]+) \| (?P<timestamp>[^|]+) \| [^\n]+', lines[0])
 127         assert firstline
 128         author = firstline.group('email')
 129         if patch_by:
 130             author = patch_by.group('author')
 131
 132         linkified_revision = 'https://trac.webkit.org/%s' % firstline.group('revision')
 133         lines[0] = '%s by %s' % (linkified_revision, author)
 134
 135         if rollout:
 136             if requested_by:
 137                 author = requested_by.group('author')
 138                 contributor = committer_list.contributor_by_irc_nickname(author)
 139                 if contributor:
 140                     author = "%s (%s)" % (contributor.full_name, contributor.irc_nicknames[0])
 141                 return '%s rolled out %s in %s : %s' % (author, rollout.group('revisions'),
 142                     linkified_revision, requested_by.group('reason'))
 143             lines[0] = '%s rolled out %s in %s' % (author, rollout.group('revisions'), linkified_revision)
 144
 145         return ' '.join(filter(lambda line: len(line), lines)[0:4])
 146
 147     def handle_unexpected_error(self, failure_map, message):
 148         _log.error(message)
 149
 150     # StepSequenceErrorHandler methods
 151
 152     @classmethod
 153     def handle_script_error(cls, tool, state, script_error):
 154         # Ideally we would post some information to IRC about what went wrong
 155         # here, but we don't have the IRC password in the child process.
 156         pass