Tools/Scripts/webkitpy/tool/main.py

   1 # Copyright (c) 2010 Google Inc. All rights reserved.
   2 # Copyright (c) 2009 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 # A tool for automating dealing with bugzilla, posting patches, committing patches, etc.
  31
  32 from optparse import make_option
  33 import os
  34 import threading
  35
  36 from webkitpy.common.config.ports import DeprecatedPort
  37 from webkitpy.common.host import Host
  38 from webkitpy.common.net.irc import ircproxy
  39 from webkitpy.common.net.statusserver import StatusServer
  40 from webkitpy.tool.multicommandtool import MultiCommandTool
  41 from webkitpy.tool import commands
  42
  43
  44 class WebKitPatch(MultiCommandTool, Host):
  45     global_options = [
  46         make_option("-v", "--verbose", action="store_true", dest="verbose", default=False, help="enable all logging"),
  47         make_option("-d", "--directory", action="append", dest="patch_directories", default=[], help="Directory to look at for changed files"),
  48         make_option("--status-host", action="store", dest="status_host", type="string", help="Hostname (e.g. localhost or commit.webkit.org) where status updates should be posted."),
  49         make_option("--bot-id", action="store", dest="bot_id", type="string", help="Identifier for this bot (if multiple bots are running for a queue)"),
  50         make_option("--irc-password", action="store", dest="irc_password", type="string", help="Password to use when communicating via IRC."),
  51         make_option("--seconds-to-sleep", action="store", default=120, type="int", help="Number of seconds to sleep in the task queue."),
  52         make_option("--port", action="store", dest="port", default=None, help="Specify a port (e.g., mac, qt, gtk, ...)."),
  53     ]
  54
  55     def __init__(self, path):
  56         MultiCommandTool.__init__(self)
  57         Host.__init__(self)
  58         self._path = path
  59         self.status_server = StatusServer()
  60
  61         self.wakeup_event = threading.Event()
  62         self._irc = None
  63         self._deprecated_port = None
  64
  65     def deprecated_port(self):
  66         return self._deprecated_port
  67
  68     def path(self):
  69         return self._path
  70
  71     def ensure_irc_connected(self, irc_delegate):
  72         if not self._irc:
  73             self._irc = ircproxy.IRCProxy(irc_delegate)
  74
  75     def irc(self):
  76         # We don't automatically construct IRCProxy here because constructing
  77         # IRCProxy actually connects to IRC.  We want clients to explicitly
  78         # connect to IRC.
  79         return self._irc
  80
  81     def command_completed(self):
  82         if self._irc:
  83             self._irc.disconnect()
  84
  85     def should_show_in_main_help(self, command):
  86         if not command.show_in_main_help:
  87             return False
  88         if command.requires_local_commits:
  89             return self.scm().supports_local_commits()
  90         return True
  91
  92     # FIXME: This may be unnecessary since we pass global options to all commands during execute() as well.
  93     def handle_global_options(self, options):
  94         self.initialize_scm(options.patch_directories)
  95         if options.status_host:
  96             self.status_server.set_host(options.status_host)
  97         if options.bot_id:
  98             self.status_server.set_bot_id(options.bot_id)
  99         if options.irc_password:
 100             self.irc_password = options.irc_password
 101         # If options.port is None, we'll get the default port for this platform.
 102         self._deprecated_port = DeprecatedPort.port(options.port)
 103
 104     def should_execute_command(self, command):
 105         if command.requires_local_commits and not self.scm().supports_local_commits():
 106             failure_reason = "%s requires local commits using %s in %s." % (command.name, self.scm().display_name(), self.scm().checkout_root)
 107             return (False, failure_reason)
 108         return (True, None)