2011-03-30 Maciej Stachowiak <mjs@apple.com>
[WebKit.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.host import Host
40 from webkitpy.common.net.bugzilla import Bugzilla
41 from webkitpy.common.net.buildbot import BuildBot
42 from webkitpy.common.net.irc.ircproxy import IRCProxy
43 from webkitpy.common.net.statusserver import StatusServer
44 from webkitpy.common.system import executive, filesystem, platforminfo, user, workspace
45 from webkitpy.layout_tests import port
46 from webkitpy.tool.multicommandtool import MultiCommandTool
47 from webkitpy.tool import commands
48
49
50 class WebKitPatch(MultiCommandTool, Host):
51     global_options = [
52         make_option("-v", "--verbose", action="store_true", dest="verbose", default=False, help="enable all logging"),
53         make_option("-d", "--directory", action="append", dest="patch_directories", default=[], help="Directory to look at for changed files"),
54         make_option("--dry-run", action="store_true", dest="dry_run", default=False, help="do not touch remote servers"),
55         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."),
56         make_option("--bot-id", action="store", dest="bot_id", type="string", help="Identifier for this bot (if multiple bots are running for a queue)"),
57         make_option("--irc-password", action="store", dest="irc_password", type="string", help="Password to use when communicating via IRC."),
58         make_option("--port", action="store", dest="port", default=None, help="Specify a port (e.g., mac, qt, gtk, ...)."),
59     ]
60
61     def __init__(self, path):
62         MultiCommandTool.__init__(self)
63         Host.__init__(self)
64
65         self._path = path
66         self.wakeup_event = threading.Event()
67
68     def path(self):
69         return self._path
70
71     def should_show_in_main_help(self, command):
72         if not command.show_in_main_help:
73             return False
74         if command.requires_local_commits:
75             return self.scm().supports_local_commits()
76         return True
77
78     # FIXME: This may be unnecessary since we pass global options to all commands during execute() as well.
79     def handle_global_options(self, options):
80         self._initialize_scm(options.patch_directories)
81         if options.dry_run:
82             self.scm().dryrun = True
83             self.bugs.dryrun = True
84         if options.status_host:
85             self.status_server.set_host(options.status_host)
86         if options.bot_id:
87             self.status_server.set_bot_id(options.bot_id)
88         if options.irc_password:
89             self.irc_password = options.irc_password
90         # If options.port is None, we'll get the default port for this platform.
91         self._port = WebKitPort.port(options.port)
92
93     def should_execute_command(self, command):
94         if command.requires_local_commits and not self.scm().supports_local_commits():
95             failure_reason = "%s requires local commits using %s in %s." % (command.name, self.scm().display_name(), self.scm().checkout_root)
96             return (False, failure_reason)
97         return (True, None)