4 # Copyright (C) 2009 Google Inc.
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 # General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
22 """Script to generate bash_completion script for Ganeti.
26 # pylint: disable-msg=C0103
27 # [C0103] Invalid name build-bash-completion
31 from cStringIO import StringIO
33 from ganeti import constants
34 from ganeti import cli
35 from ganeti import utils
36 from ganeti import build
38 # _autoconf shouldn't be imported from anywhere except constants.py, but we're
39 # making an exception here because this script is only used at build time.
40 from ganeti import _autoconf
43 def WritePreamble(sw):
44 """Writes the script preamble.
46 Helper functions should be written here.
49 sw.Write("# This script is automatically generated at build time.")
50 sw.Write("# Do not modify manually.")
52 sw.Write("_ganeti_dbglog() {")
55 sw.Write("if [[ -n \"$GANETI_COMPL_LOG\" ]]; then")
62 sw.Write("echo \"$@\"")
66 sw.Write("} >> $GANETI_COMPL_LOG")
74 sw.Write("_ganeti_nodes() {")
77 node_list_path = os.path.join(constants.DATA_DIR, "ssconf_node_list")
78 sw.Write("cat %s 2>/dev/null || :", utils.ShellQuote(node_list_path))
83 sw.Write("_ganeti_instances() {")
86 instance_list_path = os.path.join(constants.DATA_DIR,
87 "ssconf_instance_list")
88 sw.Write("cat %s 2>/dev/null || :", utils.ShellQuote(instance_list_path))
93 sw.Write("_ganeti_jobs() {")
96 # FIXME: this is really going into the internals of the job queue
97 sw.Write(("local jlist=$( shopt -s nullglob &&"
98 " cd %s 2>/dev/null && echo job-* || : )"),
99 utils.ShellQuote(constants.QUEUE_DIR))
100 sw.Write('echo "${jlist//job-/}"')
105 for (fnname, paths) in [
106 ("os", constants.OS_SEARCH_PATH),
107 ("iallocator", constants.IALLOCATOR_SEARCH_PATH),
109 sw.Write("_ganeti_%s() {", fnname)
112 # FIXME: Make querying the master for all OSes cheap
114 sw.Write("( shopt -s nullglob && cd %s 2>/dev/null && echo * || : )",
115 utils.ShellQuote(path))
120 sw.Write("_ganeti_nodegroup() {")
123 nodegroups_path = os.path.join(constants.DATA_DIR, "ssconf_nodegroups")
124 sw.Write("cat %s 2>/dev/null || :", utils.ShellQuote(nodegroups_path))
129 # Params: <offset> <options with values> <options without values>
130 # Result variable: $first_arg_idx
131 sw.Write("_ganeti_find_first_arg() {")
134 sw.Write("local w i")
136 sw.Write("first_arg_idx=")
137 sw.Write("for (( i=$1; i < COMP_CWORD; ++i )); do")
140 sw.Write("w=${COMP_WORDS[$i]}")
143 sw.Write("""if [[ -n "$2" && "$w" == @($2) ]]; then let ++i""")
146 sw.Write("""elif [[ -n "$3" && "$w" == @($3) ]]; then :""")
148 # Ah, we found the first argument
149 sw.Write("else first_arg_idx=$i; break;")
158 # Params: <list of options separated by space>
159 # Input variable: $first_arg_idx
160 # Result variables: $arg_idx, $choices
161 sw.Write("_ganeti_list_options() {")
164 sw.Write("""if [[ -z "$first_arg_idx" ]]; then""")
167 sw.Write("arg_idx=0")
168 # Show options only if the current word starts with a dash
169 sw.Write("""if [[ "$cur" == -* ]]; then""")
172 sw.Write("choices=$1")
181 # Calculate position of current argument
182 sw.Write("arg_idx=$(( COMP_CWORD - first_arg_idx ))")
188 # Params: <long options with equal sign> <all options>
189 # Result variable: $optcur
190 sw.Write("_ganeti_checkopt() {")
193 sw.Write("""if [[ -n "$1" && "$cur" == @($1) ]]; then""")
196 sw.Write("optcur=\"${cur#--*=}\"")
200 sw.Write("""elif [[ -n "$2" && "$prev" == @($2) ]]; then""")
203 sw.Write("optcur=\"$cur\"")
209 sw.Write("_ganeti_dbglog optcur=\"'$optcur'\"")
216 # Params: <compgen options>
217 # Result variable: $COMPREPLY
218 sw.Write("_ganeti_compgen() {")
221 sw.Write("""COMPREPLY=( $(compgen "$@") )""")
222 sw.Write("_ganeti_dbglog COMPREPLY=\"${COMPREPLY[@]}\"")
228 def WriteCompReply(sw, args, cur="\"$cur\""):
229 sw.Write("_ganeti_compgen %s -- %s", args, cur)
233 class CompletionWriter:
234 """Command completion writer class.
237 def __init__(self, arg_offset, opts, args):
238 self.arg_offset = arg_offset
243 # While documented, these variables aren't seen as public attributes by
244 # pylint. pylint: disable-msg=W0212
245 opt.all_names = sorted(opt._short_opts + opt._long_opts)
247 def _FindFirstArgument(self, sw):
251 for opt in self.opts:
252 if opt.takes_value():
254 for i in opt.all_names:
255 if i.startswith("--"):
256 ignore.append("%s=*" % utils.ShellQuote(i))
257 skip_one.append(utils.ShellQuote(i))
259 ignore.extend([utils.ShellQuote(i) for i in opt.all_names])
261 ignore = sorted(utils.UniqueSequence(ignore))
262 skip_one = sorted(utils.UniqueSequence(skip_one))
264 if ignore or skip_one:
265 # Try to locate first argument
266 sw.Write("_ganeti_find_first_arg %s %s %s",
268 utils.ShellQuote("|".join(skip_one)),
269 utils.ShellQuote("|".join(ignore)))
271 # When there are no options the first argument is always at position
273 sw.Write("first_arg_idx=%s", self.arg_offset + 1)
275 def _CompleteOptionValues(self, sw):
277 # "values" -> [optname1, optname2, ...]
280 for opt in self.opts:
281 if not opt.takes_value():
284 # Only static choices implemented so far (e.g. no node list)
285 suggest = getattr(opt, "completion_suggest", None)
287 # our custom option type
288 if opt.type == "bool":
289 suggest = ["yes", "no"]
292 suggest = opt.choices
294 if (isinstance(suggest, (int, long)) and
295 suggest in cli.OPT_COMPL_ALL):
298 key = " ".join(sorted(suggest))
302 values.setdefault(key, []).extend(opt.all_names)
304 # Don't write any code if there are no option values
312 for (suggest, allnames) in values.iteritems():
313 longnames = [i for i in allnames if i.startswith("--")]
320 sw.Write("%s _ganeti_checkopt %s %s; then", condcmd,
321 utils.ShellQuote("|".join(["%s=*" % i for i in longnames])),
322 utils.ShellQuote("|".join(allnames)))
325 if suggest == cli.OPT_COMPL_MANY_NODES:
326 # TODO: Implement comma-separated values
327 WriteCompReply(sw, "-W ''", cur=cur)
328 elif suggest == cli.OPT_COMPL_ONE_NODE:
329 WriteCompReply(sw, "-W \"$(_ganeti_nodes)\"", cur=cur)
330 elif suggest == cli.OPT_COMPL_ONE_INSTANCE:
331 WriteCompReply(sw, "-W \"$(_ganeti_instances)\"", cur=cur)
332 elif suggest == cli.OPT_COMPL_ONE_OS:
333 WriteCompReply(sw, "-W \"$(_ganeti_os)\"", cur=cur)
334 elif suggest == cli.OPT_COMPL_ONE_IALLOCATOR:
335 WriteCompReply(sw, "-W \"$(_ganeti_iallocator)\"", cur=cur)
336 elif suggest == cli.OPT_COMPL_ONE_NODEGROUP:
337 WriteCompReply(sw, "-W \"$(_ganeti_nodegroup)\"", cur=cur)
338 elif suggest == cli.OPT_COMPL_INST_ADD_NODES:
339 sw.Write("local tmp= node1= pfx= curvalue=\"${optcur#*:}\"")
341 sw.Write("if [[ \"$optcur\" == *:* ]]; then")
344 sw.Write("node1=\"${optcur%%:*}\"")
346 sw.Write("if [[ \"$COMP_WORDBREAKS\" != *:* ]]; then")
349 sw.Write("pfx=\"$node1:\"")
357 sw.Write("_ganeti_dbglog pfx=\"'$pfx'\" curvalue=\"'$curvalue'\""
358 " node1=\"'$node1'\"")
360 sw.Write("for i in $(_ganeti_nodes); do")
363 sw.Write("if [[ -z \"$node1\" ]]; then")
366 sw.Write("tmp=\"$tmp $i $i:\"")
369 sw.Write("elif [[ \"$i\" != \"$node1\" ]]; then")
372 sw.Write("tmp=\"$tmp $i\"")
380 WriteCompReply(sw, "-P \"$pfx\" -W \"$tmp\"", cur="\"$curvalue\"")
382 WriteCompReply(sw, "-W %s" % utils.ShellQuote(suggest), cur=cur)
393 def _CompleteArguments(self, sw):
394 if not (self.opts or self.args):
397 all_option_names = []
398 for opt in self.opts:
399 all_option_names.extend(opt.all_names)
400 all_option_names.sort()
402 # List options if no argument has been specified yet
403 sw.Write("_ganeti_list_options %s",
404 utils.ShellQuote(" ".join(all_option_names)))
407 last_idx = len(self.args) - 1
409 varlen_arg_idx = None
412 # Write some debug comments
413 for idx, arg in enumerate(self.args):
414 sw.Write("# %s: %r", idx, arg)
416 sw.Write("compgenargs=")
418 for idx, arg in enumerate(self.args):
419 assert arg.min is not None and arg.min >= 0
420 assert not (idx < last_idx and arg.max is None)
422 if arg.min != arg.max or arg.max is None:
423 if varlen_arg_idx is not None:
424 raise Exception("Only one argument can have a variable length")
429 if isinstance(arg, cli.ArgUnknown):
431 elif isinstance(arg, cli.ArgSuggest):
432 choices = utils.ShellQuote(" ".join(arg.choices))
433 elif isinstance(arg, cli.ArgInstance):
434 choices = "$(_ganeti_instances)"
435 elif isinstance(arg, cli.ArgNode):
436 choices = "$(_ganeti_nodes)"
437 elif isinstance(arg, cli.ArgJobId):
438 choices = "$(_ganeti_jobs)"
439 elif isinstance(arg, cli.ArgOs):
440 choices = "$(_ganeti_os)"
441 elif isinstance(arg, cli.ArgFile):
443 compgenargs.append("-f")
444 elif isinstance(arg, cli.ArgCommand):
446 compgenargs.append("-c")
447 elif isinstance(arg, cli.ArgHost):
449 compgenargs.append("-A hostname")
451 raise Exception("Unknown argument type %r" % arg)
453 if arg.min == 1 and arg.max == 1:
454 cmpcode = """"$arg_idx" == %d""" % (last_arg_end)
455 elif arg.max is None:
456 cmpcode = """"$arg_idx" -ge %d""" % (last_arg_end)
457 elif arg.min <= arg.max:
458 cmpcode = (""""$arg_idx" -ge %d && "$arg_idx" -lt %d""" %
459 (last_arg_end, last_arg_end + arg.max))
461 raise Exception("Unable to generate argument position condition")
463 last_arg_end += arg.min
465 if choices or compgenargs:
471 sw.Write("""%s [[ %s ]]; then""", condcmd, cmpcode)
475 sw.Write("""choices="$choices "%s""", choices)
477 sw.Write("compgenargs=%s",
478 utils.ShellQuote(" ".join(compgenargs)))
488 WriteCompReply(sw, """-W "$choices" $compgenargs""")
490 # $compgenargs exists only if there are arguments
491 WriteCompReply(sw, '-W "$choices"')
493 def WriteTo(self, sw):
494 self._FindFirstArgument(sw)
495 self._CompleteOptionValues(sw)
496 self._CompleteArguments(sw)
499 def WriteCompletion(sw, scriptname, funcname,
501 opts=None, args=None):
502 """Writes the completion code for one command.
504 @type sw: ShellWriter
505 @param sw: Script writer
506 @type scriptname: string
507 @param scriptname: Name of command line program
508 @type funcname: string
509 @param funcname: Shell function name
511 @param commands: List of all subcommands in this program
514 sw.Write("%s() {", funcname)
518 ' cur="${COMP_WORDS[COMP_CWORD]}"'
519 ' prev="${COMP_WORDS[COMP_CWORD-1]}"'
520 ' i first_arg_idx choices compgenargs arg_idx optcur')
522 sw.Write("_ganeti_dbglog cur=\"$cur\" prev=\"$prev\"")
523 sw.Write("[[ -n \"$GANETI_COMPL_LOG\" ]] &&"
524 " _ganeti_dbglog \"$(set | grep ^COMP_)\"")
526 sw.Write("COMPREPLY=()")
528 if opts is not None and args is not None:
530 CompletionWriter(0, opts, args).WriteTo(sw)
533 sw.Write("""if [[ "$COMP_CWORD" == 1 ]]; then""")
536 # Complete the command name
539 utils.ShellQuote(" ".join(sorted(commands.keys())))))
544 # We're doing options and arguments to commands
545 sw.Write("""case "${COMP_WORDS[1]}" in""")
546 for cmd, (_, argdef, optdef, _, _) in commands.iteritems():
547 if not (argdef or optdef):
550 # TODO: Group by arguments and options
551 sw.Write("%s)", utils.ShellQuote(cmd))
554 CompletionWriter(1, optdef, argdef).WriteTo(sw)
564 sw.Write("complete -F %s -o filenames %s",
565 utils.ShellQuote(funcname),
566 utils.ShellQuote(scriptname))
569 def GetFunctionName(name):
570 return "_" + re.sub(r"[^a-z0-9]+", "_", name.lower())
573 def GetCommands(filename, module):
574 """Returns the commands defined in a module.
576 Aliases are also added as commands.
580 commands = getattr(module, "commands")
581 except AttributeError:
582 raise Exception("Script %s doesn't have 'commands' attribute" %
585 # Add the implicit "--help" option
586 help_option = cli.cli_option("-h", "--help", default=False,
589 for name, (_, _, optdef, _, _) in commands.items():
590 if help_option not in optdef:
591 optdef.append(help_option)
592 for opt in cli.COMMON_OPTS:
594 raise Exception("Common option '%s' listed for command '%s' in %s" %
595 (opt, name, filename))
599 aliases = getattr(module, "aliases", {})
601 commands = commands.copy()
602 for name, target in aliases.iteritems():
603 commands[name] = commands[target]
610 sw = utils.ShellWriter(buf)
615 for scriptname in _autoconf.GNT_SCRIPTS:
616 filename = "scripts/%s" % scriptname
618 WriteCompletion(sw, scriptname,
619 GetFunctionName(scriptname),
620 commands=GetCommands(filename,
621 build.LoadModule(filename)))
624 burnin = build.LoadModule("tools/burnin")
625 WriteCompletion(sw, "%s/burnin" % constants.TOOLSDIR, "_ganeti_burnin",
626 opts=burnin.OPTIONS, args=burnin.ARGUMENTS)
631 if __name__ == "__main__":