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