src/third_party/WebKit/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
  34 from webkitpy.common.host import Host
  35 from webkitpy.tool.multicommandtool import MultiCommandTool
  36 from webkitpy.tool import commands
  37
  38
  39 class WebKitPatch(MultiCommandTool, Host):
  40     global_options = [
  41         make_option("-v", "--verbose", action="store_true", dest="verbose", default=False, help="enable all logging"),
  42         make_option("-d", "--directory", action="append", dest="patch_directories", default=[], help="Directory to look at for changed files"),
  43     ]
  44
  45     def __init__(self, path):
  46         MultiCommandTool.__init__(self)
  47         Host.__init__(self)
  48         self._path = path
  49
  50     def path(self):
  51         return self._path
  52
  53     def should_show_in_main_help(self, command):
  54         if not command.show_in_main_help:
  55             return False
  56         if command.requires_local_commits:
  57             return self.scm().supports_local_commits()
  58         return True
  59
  60     # FIXME: This may be unnecessary since we pass global options to all commands during execute() as well.
  61     def handle_global_options(self, options):
  62         self.initialize_scm(options.patch_directories)
  63
  64     def should_execute_command(self, command):
  65         if command.requires_local_commits and not self.scm().supports_local_commits():
  66             failure_reason = "%s requires local commits using %s in %s." % (command.name, self.scm().display_name(), self.scm().checkout_root)
  67             return (False, failure_reason)
  68         return (True, None)