| # Copyright (c) 2010 Google Inc. All rights reserved. |
| # Copyright (c) 2009, 2013, 2019 Apple Inc. All rights reserved. |
| # |
| # Redistribution and use in source and binary forms, with or without |
| # modification, are permitted provided that the following conditions are |
| # met: |
| # |
| # * Redistributions of source code must retain the above copyright |
| # notice, this list of conditions and the following disclaimer. |
| # * Redistributions in binary form must reproduce the above |
| # copyright notice, this list of conditions and the following disclaimer |
| # in the documentation and/or other materials provided with the |
| # distribution. |
| # * Neither the name of Google Inc. nor the names of its |
| # contributors may be used to endorse or promote products derived from |
| # this software without specific prior written permission. |
| # |
| # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| # |
| # A tool for automating dealing with bugzilla, posting patches, committing patches, etc. |
| |
| from optparse import make_option |
| import logging |
| import os |
| import threading |
| |
| from webkitpy.common.checkout.scm import Git |
| from webkitpy.common.config.ports import DeprecatedPort |
| from webkitpy.common.host import Host |
| from webkitpy.common.net.irc import ircproxy |
| from webkitpy.common.net.ewsserver import EWSServer |
| from webkitpy.common.net.statusserver import StatusServer |
| from webkitpy.tool.multicommandtool import MultiCommandTool |
| from webkitpy.tool import commands |
| |
| _log = logging.getLogger(__name__) |
| |
| class WebKitPatch(MultiCommandTool, Host): |
| global_options = [ |
| make_option("-v", "--verbose", action="store_true", dest="verbose", default=False, help="enable all logging"), |
| make_option("-d", "--directory", action="append", dest="patch_directories", default=[], help="Directory to look at for changed files"), |
| 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."), |
| make_option("--status-host-uses-http", action="store_false", default=True, dest="status_host_uses_https", help="Use HTTP when querying the status host."), |
| make_option("--bot-id", action="store", dest="bot_id", type="string", help="Identifier for this bot (if multiple bots are running for a queue)"), |
| make_option("--irc-password", action="store", dest="irc_password", type="string", help="Password to use when communicating via IRC."), |
| make_option("--seconds-to-sleep", action="store", default=120, type="int", help="Number of seconds to sleep in the task queue."), |
| make_option("--port", action="store", dest="port", default=None, help="Specify a port (e.g., mac, gtk, ...)."), |
| ] |
| |
| def __init__(self, path): |
| MultiCommandTool.__init__(self) |
| Host.__init__(self) |
| self._path = path |
| self.status_server = StatusServer() |
| self.ews_server = EWSServer() |
| |
| self.wakeup_event = threading.Event() |
| self._irc = None |
| self._deprecated_port = None |
| |
| def deprecated_port(self): |
| return self._deprecated_port |
| |
| def path(self): |
| return self._path |
| |
| def ensure_irc_connected(self, irc_delegate): |
| if not self._irc: |
| self._irc = ircproxy.IRCProxy(irc_delegate) |
| |
| def irc(self): |
| # We don't automatically construct IRCProxy here because constructing |
| # IRCProxy actually connects to IRC. We want clients to explicitly |
| # connect to IRC. |
| return self._irc |
| |
| def command_completed(self): |
| if self._irc: |
| self._irc.disconnect() |
| |
| def should_show_in_main_help(self, command): |
| if not command.show_in_main_help: |
| return False |
| if command.requires_local_commits: |
| return self.scm().supports_local_commits() |
| return True |
| |
| @staticmethod |
| def _status_server_api_key_from_git(): |
| try: |
| if not Git.in_working_directory(os.getcwd()): |
| return None |
| return Git.read_git_config('webkit.status-api-key') |
| except OSError as e: |
| # Catch and ignore OSError exceptions such as "no such file |
| # or directory" (OSError errno 2), which imply that the Git |
| # command cannot be found/is not installed. |
| _log.warning('Could not read API key from Git: {}'.format(str(e))) |
| return None |
| |
| @staticmethod |
| def _status_server_api_key(): |
| api_key = os.environ.get('WEBKIT_STATUS_API_KEY') |
| if not api_key: |
| api_key = WebKitPatch._status_server_api_key_from_git() |
| try: |
| api_key = str(api_key) |
| except UnicodeEncodeError: |
| _log.warning('Ignoring non-ASCII characters in API key.') |
| api_key = api_key.encode('ascii', 'ignore') |
| return api_key |
| |
| # FIXME: This may be unnecessary since we pass global options to all commands during execute() as well. |
| def handle_global_options(self, options): |
| self.initialize_scm(options.patch_directories) |
| |
| api_key = self._status_server_api_key() |
| if api_key: |
| self.status_server.set_api_key(api_key) |
| |
| if options.status_host: |
| self.status_server.set_host(options.status_host) |
| self.status_server.set_use_https(options.status_host_uses_https) |
| if options.bot_id: |
| self.status_server.set_bot_id(options.bot_id) |
| if options.irc_password: |
| self.irc_password = options.irc_password |
| # If options.port is None, we'll get the default port for this platform. |
| self._deprecated_port = DeprecatedPort.port(options.port) |
| |
| def should_execute_command(self, command): |
| if command.requires_local_commits and not self.scm().supports_local_commits(): |
| failure_reason = "%s requires local commits using %s in %s." % (command.name, self.scm().display_name(), self.scm().checkout_root) |
| return (False, failure_reason) |
| return (True, None) |
