dbb257b66ec37201730e75548f62c05b0b33a9da
[WebKit-https.git] / Tools / Scripts / webkitpy / tool / multicommandtool.py
1 # Copyright (c) 2009 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 # MultiCommandTool provides a framework for writing svn-like/git-like tools
31 # which are called with the following format:
32 # tool-name [global options] command-name [command options]
33
34 import logging
35 import sys
36
37 from optparse import OptionParser, IndentedHelpFormatter, SUPPRESS_USAGE, make_option
38
39 from webkitpy.tool.grammar import pluralize
40
41 _log = logging.getLogger(__name__)
42
43
44 class TryAgain(Exception):
45     pass
46
47
48 class Command(object):
49     name = None
50     show_in_main_help = False
51     help_text = None
52     long_help = None
53     argument_names = None
54
55     def __init__(self, options=None, requires_local_commits=False):
56         self.required_arguments = self._parse_required_arguments(self.argument_names)
57         self.options = options
58         self.requires_local_commits = requires_local_commits
59         self._tool = None
60         # option_parser can be overriden by the tool using set_option_parser
61         # This default parser will be used for standalone_help printing.
62         self.option_parser = HelpPrintingOptionParser(usage=SUPPRESS_USAGE, add_help_option=False, option_list=self.options)
63
64     def _exit(self, code):
65         sys.exit(code)
66
67     # This design is slightly awkward, but we need the
68     # the tool to be able to create and modify the option_parser
69     # before it knows what Command to run.
70     def set_option_parser(self, option_parser):
71         self.option_parser = option_parser
72         self._add_options_to_parser()
73
74     def _add_options_to_parser(self):
75         options = self.options or []
76         for option in options:
77             self.option_parser.add_option(option)
78
79     # The tool calls bind_to_tool on each Command after adding it to its list.
80     def bind_to_tool(self, tool):
81         # Command instances can only be bound to one tool at a time.
82         if self._tool and tool != self._tool:
83             raise Exception("Command already bound to tool!")
84         self._tool = tool
85
86     @staticmethod
87     def _parse_required_arguments(argument_names):
88         required_args = []
89         if not argument_names:
90             return required_args
91         split_args = argument_names.split(" ")
92         for argument in split_args:
93             if argument[0] == '[':
94                 # For now our parser is rather dumb.  Do some minimal validation that
95                 # we haven't confused it.
96                 if argument[-1] != ']':
97                     raise Exception("Failure to parse argument string %s.  Argument %s is missing ending ]" % (argument_names, argument))
98             else:
99                 required_args.append(argument)
100         return required_args
101
102     def name_with_arguments(self):
103         usage_string = self.name
104         if self.options:
105             usage_string += " [options]"
106         if self.argument_names:
107             usage_string += " " + self.argument_names
108         return usage_string
109
110     def parse_args(self, args):
111         return self.option_parser.parse_args(args)
112
113     def check_arguments_and_execute(self, options, args, tool=None):
114         if len(args) < len(self.required_arguments):
115             _log.error("%s required, %s provided.  Provided: %s  Required: %s\nSee '%s help %s' for usage." % (
116                        pluralize(len(self.required_arguments), "argument"),
117                        pluralize(len(args), "argument"),
118                        "'%s'" % " ".join(args),
119                        " ".join(self.required_arguments),
120                        tool.name(),
121                        self.name))
122             return 1
123         return self.execute(options, args, tool) or 0
124
125     def standalone_help(self):
126         help_text = self.name_with_arguments().ljust(len(self.name_with_arguments()) + 3) + self.help_text + "\n\n"
127         if self.long_help:
128             help_text += "%s\n\n" % self.long_help
129         help_text += self.option_parser.format_option_help(IndentedHelpFormatter())
130         return help_text
131
132     def execute(self, options, args, tool):
133         raise NotImplementedError, "subclasses must implement"
134
135     # main() exists so that Commands can be turned into stand-alone scripts.
136     # Other parts of the code will likely require modification to work stand-alone.
137     def main(self, args=sys.argv):
138         (options, args) = self.parse_args(args)
139         # Some commands might require a dummy tool
140         return self.check_arguments_and_execute(options, args)
141
142
143 class HelpPrintingOptionParser(OptionParser):
144     def __init__(self, epilog_method=None, *args, **kwargs):
145         self.epilog_method = epilog_method
146         OptionParser.__init__(self, *args, **kwargs)
147
148     def error(self, msg):
149         self.print_usage(sys.stderr)
150         error_message = "%s: error: %s\n" % (self.get_prog_name(), msg)
151         # This method is overriden to add this one line to the output:
152         error_message += "\nType \"%s --help\" to see usage.\n" % self.get_prog_name()
153         self.exit(1, error_message)
154
155     # We override format_epilog to avoid the default formatting which would paragraph-wrap the epilog
156     # and also to allow us to compute the epilog lazily instead of in the constructor (allowing it to be context sensitive).
157     def format_epilog(self, epilog):
158         if self.epilog_method:
159             return "\n%s\n" % self.epilog_method()
160         return ""
161
162
163 class HelpCommand(Command):
164     name = "help"
165     help_text = "Display information about this program or its subcommands"
166     argument_names = "[COMMAND]"
167
168     def __init__(self):
169         options = [
170             make_option("-a", "--all-commands", action="store_true", dest="show_all_commands", help="Print all available commands"),
171         ]
172         Command.__init__(self, options)
173         self.show_all_commands = False # A hack used to pass --all-commands to _help_epilog even though it's called by the OptionParser.
174
175     def _help_epilog(self):
176         # Only show commands which are relevant to this checkout's SCM system.  Might this be confusing to some users?
177         if self.show_all_commands:
178             epilog = "All %prog commands:\n"
179             relevant_commands = self._tool.commands[:]
180         else:
181             epilog = "Common %prog commands:\n"
182             relevant_commands = filter(self._tool.should_show_in_main_help, self._tool.commands)
183         longest_name_length = max(map(lambda command: len(command.name), relevant_commands))
184         relevant_commands.sort(lambda a, b: cmp(a.name, b.name))
185         command_help_texts = map(lambda command: "   %s   %s\n" % (command.name.ljust(longest_name_length), command.help_text), relevant_commands)
186         epilog += "%s\n" % "".join(command_help_texts)
187         epilog += "See '%prog help --all-commands' to list all commands.\n"
188         epilog += "See '%prog help COMMAND' for more information on a specific command.\n"
189         return epilog.replace("%prog", self._tool.name()) # Use of %prog here mimics OptionParser.expand_prog_name().
190
191     # FIXME: This is a hack so that we don't show --all-commands as a global option:
192     def _remove_help_options(self):
193         for option in self.options:
194             self.option_parser.remove_option(option.get_opt_string())
195
196     def execute(self, options, args, tool):
197         if args:
198             command = self._tool.command_by_name(args[0])
199             if command:
200                 print command.standalone_help()
201                 return 0
202
203         self.show_all_commands = options.show_all_commands
204         self._remove_help_options()
205         self.option_parser.print_help()
206         return 0
207
208
209 class MultiCommandTool(object):
210     global_options = None
211
212     def __init__(self, name=None, commands=None):
213         self._name = name or OptionParser(prog=name).get_prog_name() # OptionParser has nice logic for fetching the name.
214         # Allow the unit tests to disable command auto-discovery.
215         self.commands = commands or [cls() for cls in self._find_all_commands() if cls.name]
216         self.help_command = self.command_by_name(HelpCommand.name)
217         # Require a help command, even if the manual test list doesn't include one.
218         if not self.help_command:
219             self.help_command = HelpCommand()
220             self.commands.append(self.help_command)
221         for command in self.commands:
222             command.bind_to_tool(self)
223
224     @classmethod
225     def _add_all_subclasses(cls, class_to_crawl, seen_classes):
226         for subclass in class_to_crawl.__subclasses__():
227             if subclass not in seen_classes:
228                 seen_classes.add(subclass)
229                 cls._add_all_subclasses(subclass, seen_classes)
230
231     @classmethod
232     def _find_all_commands(cls):
233         commands = set()
234         cls._add_all_subclasses(Command, commands)
235         return sorted(commands)
236
237     def name(self):
238         return self._name
239
240     def _create_option_parser(self):
241         usage = "Usage: %prog [options] COMMAND [ARGS]"
242         return HelpPrintingOptionParser(epilog_method=self.help_command._help_epilog, prog=self.name(), usage=usage)
243
244     @staticmethod
245     def _split_command_name_from_args(args):
246         # Assume the first argument which doesn't start with "-" is the command name.
247         command_index = 0
248         for arg in args:
249             if arg[0] != "-":
250                 break
251             command_index += 1
252         else:
253             return (None, args[:])
254
255         command = args[command_index]
256         return (command, args[:command_index] + args[command_index + 1:])
257
258     def command_by_name(self, command_name):
259         for command in self.commands:
260             if command_name == command.name:
261                 return command
262         return None
263
264     def path(self):
265         raise NotImplementedError, "subclasses must implement"
266
267     def command_completed(self):
268         pass
269
270     def should_show_in_main_help(self, command):
271         return command.show_in_main_help
272
273     def should_execute_command(self, command):
274         return True
275
276     def _add_global_options(self, option_parser):
277         global_options = self.global_options or []
278         for option in global_options:
279             option_parser.add_option(option)
280
281     def handle_global_options(self, options):
282         pass
283
284     def main(self, argv=sys.argv):
285         (command_name, args) = self._split_command_name_from_args(argv[1:])
286
287         option_parser = self._create_option_parser()
288         self._add_global_options(option_parser)
289
290         command = self.command_by_name(command_name) or self.help_command
291         if not command:
292             option_parser.error("%s is not a recognized command" % command_name)
293
294         command.set_option_parser(option_parser)
295         (options, args) = command.parse_args(args)
296         self.handle_global_options(options)
297
298         (should_execute, failure_reason) = self.should_execute_command(command)
299         if not should_execute:
300             _log.error(failure_reason)
301             return 0 # FIXME: Should this really be 0?
302
303         while True:
304             try:
305                 result = command.check_arguments_and_execute(options, args, self)
306                 break
307             except TryAgain, e:
308                 pass
309
310         self.command_completed()
311         return result