Tools/Scripts/webkitpy/tool/steps/applywatchlist.py

   1 # Copyright (C) 2011 Google Inc. All rights reserved.
   2 #
   3 # Redistribution and use in source and binary forms, with or without
   4 # modification, are permitted provided that the following conditions are
   5 # met:
   6 #
   7 #     * Redistributions of source code must retain the above copyright
   8 # notice, this list of conditions and the following disclaimer.
   9 #     * Redistributions in binary form must reproduce the above
  10 # copyright notice, this list of conditions and the following disclaimer
  11 # in the documentation and/or other materials provided with the
  12 # distribution.
  13 #     * Neither the name of Google Inc. nor the names of its
  14 # contributors may be used to endorse or promote products derived from
  15 # this software without specific prior written permission.
  16 #
  17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28
  29 from webkitpy.common.system import logutils
  30 from webkitpy.tool.steps.abstractstep import AbstractStep
  31 from webkitpy.tool.steps.options import Options
  32
  33
  34 _log = logutils.get_logger(__file__)
  35
  36
  37 class ApplyWatchList(AbstractStep):
  38     @classmethod
  39     def options(cls):
  40         return AbstractStep.options() + [
  41             Options.git_commit,
  42         ]
  43
  44     def run(self, state):
  45         diff = self.cached_lookup(state, 'diff')
  46         bug_id = state.get('bug_id')
  47
  48         cc_and_messages = self._tool.watch_list().determine_cc_and_messages(diff)
  49         cc_emails = cc_and_messages['cc_list']
  50         messages = cc_and_messages['messages']
  51         if bug_id:
  52             # Remove emails and cc's which are already in the bug or the reporter.
  53             bug = self._tool.bugs.fetch_bug(bug_id)
  54
  55             messages = filter(lambda message: not bug.is_in_comments(message), messages)
  56             cc_emails = set(cc_emails).difference(bug.cc_emails())
  57             cc_emails.discard(bug.reporter_email())
  58
  59         comment_text = '\n\n'.join(messages)
  60         if bug_id:
  61             if cc_emails or comment_text:
  62                 self._tool.bugs.post_comment_to_bug(bug_id, comment_text, cc_emails)
  63             log_result = _log.debug
  64         else:
  65             _log.info('No bug was updated because no id was given.')
  66             log_result = _log.info
  67         log_result('Result of watchlist: cc "%s" messages "%s"' % (', '.join(cc_emails), comment_text))