Clean up ChunkedUpdateDrawingAreaProxy
[WebKit-https.git] / WebKitTools / 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.checkout.api import Checkout
37 from webkitpy.common.checkout.scm import default_scm
38 from webkitpy.common.config.ports import WebKitPort
39 from webkitpy.common.net.bugzilla import Bugzilla
40 from webkitpy.common.net.buildbot import BuildBot
41 from webkitpy.common.net.irc.ircproxy import IRCProxy
42 from webkitpy.common.net.statusserver import StatusServer
43 from webkitpy.common.system.executive import Executive
44 from webkitpy.common.system.filesystem import FileSystem
45 from webkitpy.common.system.platforminfo import PlatformInfo
46 from webkitpy.common.system.user import User
47 from webkitpy.layout_tests import port
48 from webkitpy.tool.multicommandtool import MultiCommandTool
49 import webkitpy.tool.commands as commands
50
51
52 class WebKitPatch(MultiCommandTool):
53     global_options = [
54         make_option("-v", "--verbose", action="store_true", dest="verbose", default=False, help="enable all logging"),
55         make_option("--dry-run", action="store_true", dest="dry_run", default=False, help="do not touch remote servers"),
56         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."),
57         make_option("--bot-id", action="store", dest="bot_id", type="string", help="Identifier for this bot (if multiple bots are running for a queue)"),
58         make_option("--irc-password", action="store", dest="irc_password", type="string", help="Password to use when communicating via IRC."),
59         make_option("--port", action="store", dest="port", default=None, help="Specify a port (e.g., mac, qt, gtk, ...)."),
60     ]
61
62     def __init__(self, path):
63         MultiCommandTool.__init__(self)
64
65         self._path = path
66         self.wakeup_event = threading.Event()
67         # FIXME: All of these shared objects should move off onto a
68         # separate "Tool" object.  WebKitPatch should inherit from
69         # "Tool" and all these objects should use getters/setters instead of
70         # manual getter functions (e.g. scm()).
71         self.bugs = Bugzilla()
72         self.buildbot = BuildBot()
73         self.executive = Executive()
74         self._irc = None
75         self.filesystem = FileSystem()
76         self._port = None
77         self.user = User()
78         self._scm = None
79         self._checkout = None
80         self.status_server = StatusServer()
81         self.port_factory = port.factory
82         self.platform = PlatformInfo()
83
84     def scm(self):
85         # Lazily initialize SCM to not error-out before command line parsing (or when running non-scm commands).
86         if not self._scm:
87             self._scm = default_scm()
88         return self._scm
89
90     def checkout(self):
91         if not self._checkout:
92             self._checkout = Checkout(self.scm())
93         return self._checkout
94
95     def port(self):
96         return self._port
97
98     def ensure_irc_connected(self, irc_delegate):
99         if not self._irc:
100             self._irc = IRCProxy(irc_delegate)
101
102     def irc(self):
103         # We don't automatically construct IRCProxy here because constructing
104         # IRCProxy actually connects to IRC.  We want clients to explicitly
105         # connect to IRC.
106         return self._irc
107
108     def path(self):
109         return self._path
110
111     def command_completed(self):
112         if self._irc:
113             self._irc.disconnect()
114
115     def should_show_in_main_help(self, command):
116         if not command.show_in_main_help:
117             return False
118         if command.requires_local_commits:
119             return self.scm().supports_local_commits()
120         return True
121
122     # FIXME: This may be unnecessary since we pass global options to all commands during execute() as well.
123     def handle_global_options(self, options):
124         self._options = options
125         if options.dry_run:
126             self.scm().dryrun = True
127             self.bugs.dryrun = True
128         if options.status_host:
129             self.status_server.set_host(options.status_host)
130         if options.bot_id:
131             self.status_server.set_bot_id(options.bot_id)
132         if options.irc_password:
133             self.irc_password = options.irc_password
134         # If options.port is None, we'll get the default port for this platform.
135         self._port = WebKitPort.port(options.port)
136
137     def should_execute_command(self, command):
138         if command.requires_local_commits and not self.scm().supports_local_commits():
139             failure_reason = "%s requires local commits using %s in %s." % (command.name, self.scm().display_name(), self.scm().checkout_root)
140             return (False, failure_reason)
141         return (True, None)