build-bash-completion 25.9 KB
Newer Older
1
2
3
#!/usr/bin/python
#

4
# Copyright (C) 2009, 2010, 2011, 2012 Google Inc.
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.


22
23
24
25
"""Script to generate bash_completion script for Ganeti.

"""

26
# pylint: disable=C0103
27
28
# [C0103] Invalid name build-bash-completion

29
import os
30
import os.path
31
import re
32
import itertools
33
import optparse
34
35
from cStringIO import StringIO

36
37
38
39
# _constants shouldn't be imported from anywhere except constants.py, but we're
# making an exception here because this script is only used at build time.
from ganeti import _constants

40
41
42
from ganeti import constants
from ganeti import cli
from ganeti import utils
43
from ganeti import build
44
from ganeti import pathutils
45

46
47
from ganeti.tools import burnin

48
49
50
51
#: Regular expression describing desired format of option names. Long names can
#: contain lowercase characters, numbers and dashes only.
_OPT_NAME_RE = re.compile(r"^-[a-zA-Z0-9]|--[a-z][-a-z0-9]+$")

52

53
def WritePreamble(sw, support_debug):
54
55
56
57
58
59
60
61
  """Writes the script preamble.

  Helper functions should be written here.

  """
  sw.Write("# This script is automatically generated at build time.")
  sw.Write("# Do not modify manually.")

62
63
  if support_debug:
    sw.Write("_gnt_log() {")
64
65
    sw.IncIndent()
    try:
66
      sw.Write("if [[ -n \"$GANETI_COMPL_LOG\" ]]; then")
67
68
      sw.IncIndent()
      try:
69
70
71
72
73
74
75
76
77
        sw.Write("{")
        sw.IncIndent()
        try:
          sw.Write("echo ---")
          sw.Write("echo \"$@\"")
          sw.Write("echo")
        finally:
          sw.DecIndent()
        sw.Write("} >> $GANETI_COMPL_LOG")
78
79
      finally:
        sw.DecIndent()
80
      sw.Write("fi")
81
82
    finally:
      sw.DecIndent()
83
    sw.Write("}")
84

85
86
87
  sw.Write("_ganeti_nodes() {")
  sw.IncIndent()
  try:
88
    node_list_path = os.path.join(pathutils.DATA_DIR, "ssconf_node_list")
89
    sw.Write("cat %s 2>/dev/null || :", utils.ShellQuote(node_list_path))
90
91
92
93
94
95
96
  finally:
    sw.DecIndent()
  sw.Write("}")

  sw.Write("_ganeti_instances() {")
  sw.IncIndent()
  try:
97
    instance_list_path = os.path.join(pathutils.DATA_DIR,
98
                                      "ssconf_instance_list")
99
    sw.Write("cat %s 2>/dev/null || :", utils.ShellQuote(instance_list_path))
100
101
102
103
104
105
106
107
  finally:
    sw.DecIndent()
  sw.Write("}")

  sw.Write("_ganeti_jobs() {")
  sw.IncIndent()
  try:
    # FIXME: this is really going into the internals of the job queue
108
109
    sw.Write(("local jlist=($( shopt -s nullglob &&"
              " cd %s 2>/dev/null && echo job-* || : ))"),
110
             utils.ShellQuote(pathutils.QUEUE_DIR))
111
    sw.Write('echo "${jlist[@]/job-/}"')
112
113
114
115
  finally:
    sw.DecIndent()
  sw.Write("}")

116
  for (fnname, paths) in [
117
    ("os", pathutils.OS_SEARCH_PATH),
Iustin Pop's avatar
Iustin Pop committed
118
119
    ("iallocator", constants.IALLOCATOR_SEARCH_PATH),
    ]:
120
121
122
123
124
125
126
127
128
129
    sw.Write("_ganeti_%s() {", fnname)
    sw.IncIndent()
    try:
      # FIXME: Make querying the master for all OSes cheap
      for path in paths:
        sw.Write("( shopt -s nullglob && cd %s 2>/dev/null && echo * || : )",
                 utils.ShellQuote(path))
    finally:
      sw.DecIndent()
    sw.Write("}")
130

131
132
133
  sw.Write("_ganeti_nodegroup() {")
  sw.IncIndent()
  try:
134
    nodegroups_path = os.path.join(pathutils.DATA_DIR, "ssconf_nodegroups")
135
136
137
138
139
    sw.Write("cat %s 2>/dev/null || :", utils.ShellQuote(nodegroups_path))
  finally:
    sw.DecIndent()
  sw.Write("}")

140
141
142
143
144
145
146
147
148
  sw.Write("_ganeti_network() {")
  sw.IncIndent()
  try:
    networks_path = os.path.join(pathutils.DATA_DIR, "ssconf_networks")
    sw.Write("cat %s 2>/dev/null || :", utils.ShellQuote(networks_path))
  finally:
    sw.DecIndent()
  sw.Write("}")

149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
  # Params: <offset> <options with values> <options without values>
  # Result variable: $first_arg_idx
  sw.Write("_ganeti_find_first_arg() {")
  sw.IncIndent()
  try:
    sw.Write("local w i")

    sw.Write("first_arg_idx=")
    sw.Write("for (( i=$1; i < COMP_CWORD; ++i )); do")
    sw.IncIndent()
    try:
      sw.Write("w=${COMP_WORDS[$i]}")

      # Skip option value
      sw.Write("""if [[ -n "$2" && "$w" == @($2) ]]; then let ++i""")

      # Skip
      sw.Write("""elif [[ -n "$3" && "$w" == @($3) ]]; then :""")

      # Ah, we found the first argument
      sw.Write("else first_arg_idx=$i; break;")
      sw.Write("fi")
    finally:
      sw.DecIndent()
    sw.Write("done")
  finally:
    sw.DecIndent()
  sw.Write("}")

  # Params: <list of options separated by space>
  # Input variable: $first_arg_idx
  # Result variables: $arg_idx, $choices
  sw.Write("_ganeti_list_options() {")
  sw.IncIndent()
  try:
    sw.Write("""if [[ -z "$first_arg_idx" ]]; then""")
    sw.IncIndent()
    try:
      sw.Write("arg_idx=0")
      # Show options only if the current word starts with a dash
      sw.Write("""if [[ "$cur" == -* ]]; then""")
      sw.IncIndent()
      try:
        sw.Write("choices=$1")
      finally:
        sw.DecIndent()
      sw.Write("fi")
      sw.Write("return")
    finally:
      sw.DecIndent()
    sw.Write("fi")

    # Calculate position of current argument
    sw.Write("arg_idx=$(( COMP_CWORD - first_arg_idx ))")
    sw.Write("choices=")
  finally:
    sw.DecIndent()
  sw.Write("}")

208
209
  # Params: <long options with equal sign> <all options>
  # Result variable: $optcur
210
  sw.Write("_gnt_checkopt() {")
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
  sw.IncIndent()
  try:
    sw.Write("""if [[ -n "$1" && "$cur" == @($1) ]]; then""")
    sw.IncIndent()
    try:
      sw.Write("optcur=\"${cur#--*=}\"")
      sw.Write("return 0")
    finally:
      sw.DecIndent()
    sw.Write("""elif [[ -n "$2" && "$prev" == @($2) ]]; then""")
    sw.IncIndent()
    try:
      sw.Write("optcur=\"$cur\"")
      sw.Write("return 0")
    finally:
      sw.DecIndent()
    sw.Write("fi")

229
230
    if support_debug:
      sw.Write("_gnt_log optcur=\"'$optcur'\"")
231

232
233
234
235
236
    sw.Write("return 1")
  finally:
    sw.DecIndent()
  sw.Write("}")

237
238
  # Params: <compgen options>
  # Result variable: $COMPREPLY
239
  sw.Write("_gnt_compgen() {")
240
241
242
  sw.IncIndent()
  try:
    sw.Write("""COMPREPLY=( $(compgen "$@") )""")
243
244
    if support_debug:
      sw.Write("_gnt_log COMPREPLY=\"${COMPREPLY[@]}\"")
245
246
247
248
  finally:
    sw.DecIndent()
  sw.Write("}")

249

250
def WriteCompReply(sw, args, cur="\"$cur\""):
251
  sw.Write("_gnt_compgen %s -- %s", args, cur)
252
253
254
255
256
257
258
  sw.Write("return")


class CompletionWriter:
  """Command completion writer class.

  """
259
  def __init__(self, arg_offset, opts, args, support_debug):
260
261
262
    self.arg_offset = arg_offset
    self.opts = opts
    self.args = args
263
    self.support_debug = support_debug
264
265

    for opt in opts:
266
      # While documented, these variables aren't seen as public attributes by
267
      # pylint. pylint: disable=W0212
268
269
      opt.all_names = sorted(opt._short_opts + opt._long_opts)

270
271
272
273
274
      invalid = list(itertools.ifilterfalse(_OPT_NAME_RE.match, opt.all_names))
      if invalid:
        raise Exception("Option names don't match regular expression '%s': %s" %
                        (_OPT_NAME_RE.pattern, utils.CommaJoin(invalid)))

275
276
277
278
279
280
281
282
  def _FindFirstArgument(self, sw):
    ignore = []
    skip_one = []

    for opt in self.opts:
      if opt.takes_value():
        # Ignore value
        for i in opt.all_names:
283
284
          if i.startswith("--"):
            ignore.append("%s=*" % utils.ShellQuote(i))
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
          skip_one.append(utils.ShellQuote(i))
      else:
        ignore.extend([utils.ShellQuote(i) for i in opt.all_names])

    ignore = sorted(utils.UniqueSequence(ignore))
    skip_one = sorted(utils.UniqueSequence(skip_one))

    if ignore or skip_one:
      # Try to locate first argument
      sw.Write("_ganeti_find_first_arg %s %s %s",
               self.arg_offset + 1,
               utils.ShellQuote("|".join(skip_one)),
               utils.ShellQuote("|".join(ignore)))
    else:
      # When there are no options the first argument is always at position
      # offset + 1
      sw.Write("first_arg_idx=%s", self.arg_offset + 1)

  def _CompleteOptionValues(self, sw):
    # Group by values
    # "values" -> [optname1, optname2, ...]
    values = {}

    for opt in self.opts:
      if not opt.takes_value():
        continue

      # Only static choices implemented so far (e.g. no node list)
      suggest = getattr(opt, "completion_suggest", None)

Iustin Pop's avatar
Iustin Pop committed
315
316
317
318
      # our custom option type
      if opt.type == "bool":
        suggest = ["yes", "no"]

319
320
321
      if not suggest:
        suggest = opt.choices

322
323
324
325
326
      if (isinstance(suggest, (int, long)) and
          suggest in cli.OPT_COMPL_ALL):
        key = suggest
      elif suggest:
        key = " ".join(sorted(suggest))
327
      else:
328
        key = ""
329

330
      values.setdefault(key, []).extend(opt.all_names)
331
332
333
334
335

    # Don't write any code if there are no option values
    if not values:
      return

336
337
338
339
    cur = "\"$optcur\""

    wrote_opt = False

340
    for (suggest, allnames) in values.items():
341
342
343
344
345
346
347
      longnames = [i for i in allnames if i.startswith("--")]

      if wrote_opt:
        condcmd = "elif"
      else:
        condcmd = "if"

348
      sw.Write("%s _gnt_checkopt %s %s; then", condcmd,
349
350
351
352
               utils.ShellQuote("|".join(["%s=*" % i for i in longnames])),
               utils.ShellQuote("|".join(allnames)))
      sw.IncIndent()
      try:
353
354
355
356
357
358
359
360
361
        if suggest == cli.OPT_COMPL_MANY_NODES:
          # TODO: Implement comma-separated values
          WriteCompReply(sw, "-W ''", cur=cur)
        elif suggest == cli.OPT_COMPL_ONE_NODE:
          WriteCompReply(sw, "-W \"$(_ganeti_nodes)\"", cur=cur)
        elif suggest == cli.OPT_COMPL_ONE_INSTANCE:
          WriteCompReply(sw, "-W \"$(_ganeti_instances)\"", cur=cur)
        elif suggest == cli.OPT_COMPL_ONE_OS:
          WriteCompReply(sw, "-W \"$(_ganeti_os)\"", cur=cur)
362
363
        elif suggest == cli.OPT_COMPL_ONE_EXTSTORAGE:
          WriteCompReply(sw, "-W \"$(_ganeti_extstorage)\"", cur=cur)
364
365
        elif suggest == cli.OPT_COMPL_ONE_IALLOCATOR:
          WriteCompReply(sw, "-W \"$(_ganeti_iallocator)\"", cur=cur)
366
367
        elif suggest == cli.OPT_COMPL_ONE_NODEGROUP:
          WriteCompReply(sw, "-W \"$(_ganeti_nodegroup)\"", cur=cur)
368
369
        elif suggest == cli.OPT_COMPL_ONE_NETWORK:
          WriteCompReply(sw, "-W \"$(_ganeti_network)\"", cur=cur)
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
        elif suggest == cli.OPT_COMPL_INST_ADD_NODES:
          sw.Write("local tmp= node1= pfx= curvalue=\"${optcur#*:}\"")

          sw.Write("if [[ \"$optcur\" == *:* ]]; then")
          sw.IncIndent()
          try:
            sw.Write("node1=\"${optcur%%:*}\"")

            sw.Write("if [[ \"$COMP_WORDBREAKS\" != *:* ]]; then")
            sw.IncIndent()
            try:
              sw.Write("pfx=\"$node1:\"")
            finally:
              sw.DecIndent()
            sw.Write("fi")
          finally:
            sw.DecIndent()
          sw.Write("fi")

389
390
391
          if self.support_debug:
            sw.Write("_gnt_log pfx=\"'$pfx'\" curvalue=\"'$curvalue'\""
                     " node1=\"'$node1'\"")
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413

          sw.Write("for i in $(_ganeti_nodes); do")
          sw.IncIndent()
          try:
            sw.Write("if [[ -z \"$node1\" ]]; then")
            sw.IncIndent()
            try:
              sw.Write("tmp=\"$tmp $i $i:\"")
            finally:
              sw.DecIndent()
            sw.Write("elif [[ \"$i\" != \"$node1\" ]]; then")
            sw.IncIndent()
            try:
              sw.Write("tmp=\"$tmp $i\"")
            finally:
              sw.DecIndent()
            sw.Write("fi")
          finally:
            sw.DecIndent()
          sw.Write("done")

          WriteCompReply(sw, "-P \"$pfx\" -W \"$tmp\"", cur="\"$curvalue\"")
414
415
        else:
          WriteCompReply(sw, "-W %s" % utils.ShellQuote(suggest), cur=cur)
416
417
418
419
420
421
422
423
424
      finally:
        sw.DecIndent()

      wrote_opt = True

    if wrote_opt:
      sw.Write("fi")

    return
425

426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
  def _CompleteArguments(self, sw):
    if not (self.opts or self.args):
      return

    all_option_names = []
    for opt in self.opts:
      all_option_names.extend(opt.all_names)
    all_option_names.sort()

    # List options if no argument has been specified yet
    sw.Write("_ganeti_list_options %s",
             utils.ShellQuote(" ".join(all_option_names)))

    if self.args:
      last_idx = len(self.args) - 1
      last_arg_end = 0
      varlen_arg_idx = None
      wrote_arg = False

      sw.Write("compgenargs=")

      for idx, arg in enumerate(self.args):
        assert arg.min is not None and arg.min >= 0
        assert not (idx < last_idx and arg.max is None)

        if arg.min != arg.max or arg.max is None:
          if varlen_arg_idx is not None:
            raise Exception("Only one argument can have a variable length")
          varlen_arg_idx = idx

        compgenargs = []

        if isinstance(arg, cli.ArgUnknown):
          choices = ""
        elif isinstance(arg, cli.ArgSuggest):
          choices = utils.ShellQuote(" ".join(arg.choices))
        elif isinstance(arg, cli.ArgInstance):
          choices = "$(_ganeti_instances)"
        elif isinstance(arg, cli.ArgNode):
          choices = "$(_ganeti_nodes)"
466
467
        elif isinstance(arg, cli.ArgGroup):
          choices = "$(_ganeti_nodegroup)"
468
469
        elif isinstance(arg, cli.ArgNetwork):
          choices = "$(_ganeti_network)"
470
471
        elif isinstance(arg, cli.ArgJobId):
          choices = "$(_ganeti_jobs)"
472
473
        elif isinstance(arg, cli.ArgOs):
          choices = "$(_ganeti_os)"
474
475
        elif isinstance(arg, cli.ArgExtStorage):
          choices = "$(_ganeti_extstorage)"
476
477
478
479
480
481
        elif isinstance(arg, cli.ArgFile):
          choices = ""
          compgenargs.append("-f")
        elif isinstance(arg, cli.ArgCommand):
          choices = ""
          compgenargs.append("-c")
Michael Hanselmann's avatar
Michael Hanselmann committed
482
483
484
        elif isinstance(arg, cli.ArgHost):
          choices = ""
          compgenargs.append("-A hostname")
485
486
487
488
489
        else:
          raise Exception("Unknown argument type %r" % arg)

        if arg.min == 1 and arg.max == 1:
          cmpcode = """"$arg_idx" == %d""" % (last_arg_end)
490
491
        elif arg.max is None:
          cmpcode = """"$arg_idx" -ge %d""" % (last_arg_end)
492
        elif arg.min <= arg.max:
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
          cmpcode = (""""$arg_idx" -ge %d && "$arg_idx" -lt %d""" %
                     (last_arg_end, last_arg_end + arg.max))
        else:
          raise Exception("Unable to generate argument position condition")

        last_arg_end += arg.min

        if choices or compgenargs:
          if wrote_arg:
            condcmd = "elif"
          else:
            condcmd = "if"

          sw.Write("""%s [[ %s ]]; then""", condcmd, cmpcode)
          sw.IncIndent()
          try:
            if choices:
              sw.Write("""choices="$choices "%s""", choices)
            if compgenargs:
512
513
              sw.Write("compgenargs=%s",
                       utils.ShellQuote(" ".join(compgenargs)))
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
          finally:
            sw.DecIndent()

          wrote_arg = True

      if wrote_arg:
        sw.Write("fi")

    if self.args:
      WriteCompReply(sw, """-W "$choices" $compgenargs""")
    else:
      # $compgenargs exists only if there are arguments
      WriteCompReply(sw, '-W "$choices"')

  def WriteTo(self, sw):
    self._FindFirstArgument(sw)
    self._CompleteOptionValues(sw)
    self._CompleteArguments(sw)


534
def WriteCompletion(sw, scriptname, funcname, support_debug,
535
536
537
538
539
540
541
542
543
544
545
546
547
548
                    commands=None,
                    opts=None, args=None):
  """Writes the completion code for one command.

  @type sw: ShellWriter
  @param sw: Script writer
  @type scriptname: string
  @param scriptname: Name of command line program
  @type funcname: string
  @param funcname: Shell function name
  @type commands: list
  @param commands: List of all subcommands in this program

  """
549
  sw.Write("%s() {", funcname)
550
551
  sw.IncIndent()
  try:
552
    sw.Write("local "
553
             ' cur="${COMP_WORDS[COMP_CWORD]}"'
554
555
             ' prev="${COMP_WORDS[COMP_CWORD-1]}"'
             ' i first_arg_idx choices compgenargs arg_idx optcur')
556

557
558
559
560
    if support_debug:
      sw.Write("_gnt_log cur=\"$cur\" prev=\"$prev\"")
      sw.Write("[[ -n \"$GANETI_COMPL_LOG\" ]] &&"
               " _gnt_log \"$(set | grep ^COMP_)\"")
561
562
563
564
565

    sw.Write("COMPREPLY=()")

    if opts is not None and args is not None:
      assert not commands
566
      CompletionWriter(0, opts, args, support_debug).WriteTo(sw)
567
568
569
570
571
572
573
574
575
576
577
578
579

    else:
      sw.Write("""if [[ "$COMP_CWORD" == 1 ]]; then""")
      sw.IncIndent()
      try:
        # Complete the command name
        WriteCompReply(sw,
                       ("-W %s" %
                        utils.ShellQuote(" ".join(sorted(commands.keys())))))
      finally:
        sw.DecIndent()
      sw.Write("fi")

580
581
      # Group commands by arguments and options
      grouped_cmds = {}
582
      for cmd, (_, argdef, optdef, _, _) in commands.items():
583
584
        if not (argdef or optdef):
          continue
585
        grouped_cmds.setdefault((tuple(argdef), tuple(optdef)), set()).add(cmd)
586

587
588
      # We're doing options and arguments to commands
      sw.Write("""case "${COMP_WORDS[1]}" in""")
589
590
591
      sort_grouped = sorted(grouped_cmds.items(),
                            key=lambda (_, y): sorted(y)[0])
      for ((argdef, optdef), cmds) in sort_grouped:
592
593
        assert argdef or optdef
        sw.Write("%s)", "|".join(map(utils.ShellQuote, sorted(cmds))))
594
595
        sw.IncIndent()
        try:
596
          CompletionWriter(1, optdef, argdef, support_debug).WriteTo(sw)
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
        finally:
          sw.DecIndent()
        sw.Write(";;")
      sw.Write("esac")
  finally:
    sw.DecIndent()
  sw.Write("}")

  sw.Write("complete -F %s -o filenames %s",
           utils.ShellQuote(funcname),
           utils.ShellQuote(scriptname))


def GetFunctionName(name):
  return "_" + re.sub(r"[^a-z0-9]+", "_", name.lower())


def GetCommands(filename, module):
  """Returns the commands defined in a module.

  Aliases are also added as commands.

  """
  try:
    commands = getattr(module, "commands")
622
  except AttributeError:
623
624
625
    raise Exception("Script %s doesn't have 'commands' attribute" %
                    filename)

626
627
628
629
  # Add the implicit "--help" option
  help_option = cli.cli_option("-h", "--help", default=False,
                               action="store_true")

630
  for name, (_, _, optdef, _, _) in commands.items():
631
632
    if help_option not in optdef:
      optdef.append(help_option)
633
634
635
636
637
    for opt in cli.COMMON_OPTS:
      if opt in optdef:
        raise Exception("Common option '%s' listed for command '%s' in %s" %
                        (opt, name, filename))
      optdef.append(opt)
638

639
640
641
642
  # Use aliases
  aliases = getattr(module, "aliases", {})
  if aliases:
    commands = commands.copy()
643
    for name, target in aliases.items():
644
645
646
647
648
      commands[name] = commands[target]

  return commands


649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
def HaskellOptToOptParse(opts, kind):
  """Converts a Haskell options to Python cli_options.

  @type opts: string
  @param opts: comma-separated string with short and long options
  @type kind: string
  @param kind: type generated by Common.hs/complToText; needs to be
      kept in sync

  """
  # pylint: disable=W0142
  # since we pass *opts in a number of places
  opts = opts.split(",")
  if kind == "none":
    return cli.cli_option(*opts, action="store_true")
664
  elif kind in ["file", "string", "host", "dir", "inetaddr"]:
665
    return cli.cli_option(*opts, type="string")
666
667
668
669
  elif kind == "integer":
    return cli.cli_option(*opts, type="int")
  elif kind == "float":
    return cli.cli_option(*opts, type="float")
670
671
672
673
674
675
676
677
678
  elif kind == "onegroup":
    return cli.cli_option(*opts, type="string",
                           completion_suggest=cli.OPT_COMPL_ONE_NODEGROUP)
  elif kind == "onenode":
    return cli.cli_option(*opts, type="string",
                          completion_suggest=cli.OPT_COMPL_ONE_NODE)
  elif kind == "manyinstances":
    # FIXME: no support for many instances
    return cli.cli_option(*opts, type="string")
679
680
  elif kind.startswith("choices="):
    choices = kind[len("choices="):].split(",")
681
682
683
684
    return cli.cli_option(*opts, type="choice", choices=choices)
  else:
    # FIXME: there are many other currently unused completion types,
    # should be added on an as-needed basis
685
686
687
688
689
    raise Exception("Unhandled option kind '%s'" % kind)


#: serialised kind to arg type
_ARG_MAP = {
690
  "choices": cli.ArgChoice,
691
692
693
694
695
696
697
698
699
  "command": cli.ArgCommand,
  "file": cli.ArgFile,
  "host": cli.ArgHost,
  "jobid": cli.ArgJobId,
  "onegroup": cli.ArgGroup,
  "oneinstance": cli.ArgInstance,
  "onenode": cli.ArgNode,
  "oneos": cli.ArgOs,
  "string": cli.ArgUnknown,
700
  "suggests": cli.ArgSuggest,
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
  }


def HaskellArgToCliArg(kind, min_cnt, max_cnt):
  """Converts a Haskell options to Python _Argument.

  @type kind: string
  @param kind: type generated by Common.hs/argComplToText; needs to be
      kept in sync

  """
  min_cnt = int(min_cnt)
  if max_cnt == "none":
    max_cnt = None
  else:
    max_cnt = int(max_cnt)
  # pylint: disable=W0142
  # since we pass **kwargs
  kwargs = {"min": min_cnt, "max": max_cnt}

  if kind.startswith("choices=") or kind.startswith("suggest="):
    (kind, choices) = kind.split("=", 1)
    kwargs["choices"] = choices.split(",")

  if kind not in _ARG_MAP:
    raise Exception("Unhandled argument kind '%s'" % kind)
  else:
    return _ARG_MAP[kind](**kwargs)
729
730


731
732
def ParseHaskellOptsArgs(script, output):
  """Computes list of options/arguments from help-completion output.
733
734
735

  """
  cli_opts = []
736
  cli_args = []
737
  for line in output.splitlines():
738
739
740
741
742
743
744
745
746
747
748
749
750
751
    v = line.split(None)
    exc = lambda msg: Exception("Invalid %s output from %s: %s" %
                                (msg, script, v))
    if len(v) < 2:
      raise exc("help completion")
    if v[0].startswith("-"):
      if len(v) != 2:
        raise exc("option format")
      (opts, kind) = v
      cli_opts.append(HaskellOptToOptParse(opts, kind))
    else:
      if len(v) != 3:
        raise exc("argument format")
      (kind, min_cnt, max_cnt) = v
752
753
754
755
756
757
758
759
760
761
762
763
      cli_args.append(HaskellArgToCliArg(kind, min_cnt, max_cnt))
  return (cli_opts, cli_args)


def WriteHaskellCompletion(sw, script, htools=True, debug=True):
  """Generates completion information for a Haskell program.

  This converts completion info from a Haskell program into 'fake'
  cli_opts and then builds completion for them.

  """
  if htools:
Iustin Pop's avatar
Iustin Pop committed
764
    cmd = "./src/htools"
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
    env = {"HTOOLS": script}
    script_name = script
    func_name = "htools_%s" % script
  else:
    cmd = "./" + script
    env = {}
    script_name = os.path.basename(script)
    func_name = script_name
  func_name = GetFunctionName(func_name)
  output = utils.RunCmd([cmd, "--help-completion"], env=env, cwd=".").output
  (opts, args) = ParseHaskellOptsArgs(script_name, output)
  WriteCompletion(sw, script_name, func_name, debug, opts=opts, args=args)


def WriteHaskellCmdCompletion(sw, script, debug=True):
  """Generates completion information for a Haskell multi-command program.

  This gathers the list of commands from a Haskell program and
  computes the list of commands available, then builds the sub-command
  list of options/arguments for each command, using that for building
  a unified help output.

  """
  cmd = "./" + script
  script_name = os.path.basename(script)
  func_name = script_name
  func_name = GetFunctionName(func_name)
  output = utils.RunCmd([cmd, "--help-completion"], cwd=".").output
  commands = {}
  lines = output.splitlines()
  if len(lines) != 1:
    raise Exception("Invalid lines in multi-command mode: %s" % str(lines))
  v = lines[0].split(None)
  exc = lambda msg: Exception("Invalid %s output from %s: %s" %
                              (msg, script, v))
  if len(v) != 3:
    raise exc("help completion in multi-command mode")
  if not v[0].startswith("choices="):
    raise exc("invalid format in multi-command mode '%s'" % v[0])
  for subcmd in v[0][len("choices="):].split(","):
    output = utils.RunCmd([cmd, subcmd, "--help-completion"], cwd=".").output
    (opts, args) = ParseHaskellOptsArgs(script, output)
    commands[subcmd] = (None, args, opts, None, None)
  WriteCompletion(sw, script_name, func_name, debug, commands=commands)
809
810


811
def main():
812
813
814
815
816
817
818
819
820
  parser = optparse.OptionParser(usage="%prog [--compact]")
  parser.add_option("--compact", action="store_true",
                    help=("Don't indent output and don't include debugging"
                          " facilities"))

  options, args = parser.parse_args()
  if args:
    parser.error("Wrong number of arguments")

821
822
823
  # Whether to build debug version of completion script
  debug = not options.compact

824
  buf = StringIO()
825
  sw = utils.ShellWriter(buf, indent=debug)
826

827
828
829
830
831
  # Remember original state of extglob and enable it (required for pattern
  # matching; must be enabled while parsing script)
  sw.Write("gnt_shopt_extglob=$(shopt -p extglob || :)")
  sw.Write("shopt -s extglob")

832
  WritePreamble(sw, debug)
833
834

  # gnt-* scripts
835
  for scriptname in _constants.GNT_SCRIPTS:
836
837
    filename = "scripts/%s" % scriptname

838
    WriteCompletion(sw, scriptname, GetFunctionName(scriptname), debug,
839
                    commands=GetCommands(filename,
840
                                         build.LoadModule(filename)))
841
842

  # Burnin script
843
  WriteCompletion(sw, "%s/burnin" % pathutils.TOOLSDIR, "_ganeti_burnin",
844
                  debug,
845
846
                  opts=burnin.OPTIONS, args=burnin.ARGUMENTS)

847
848
849
850
  # ganeti-cleaner
  WriteHaskellCompletion(sw, "daemons/ganeti-cleaner", htools=False,
                         debug=not options.compact)

851
  # htools, if enabled
852
853
  if _constants.HTOOLS:
    for script in _constants.HTOOLS_PROGS:
854
      WriteHaskellCompletion(sw, script, htools=True, debug=debug)
855

856
  # ganeti-confd, if enabled
857
  if _constants.ENABLE_CONFD:
Iustin Pop's avatar
Iustin Pop committed
858
    WriteHaskellCompletion(sw, "src/ganeti-confd", htools=False,
859
                           debug=debug)
860

861
  # mon-collector, if monitoring is enabled
862
  if _constants.ENABLE_MOND:
Iustin Pop's avatar
Iustin Pop committed
863
    WriteHaskellCmdCompletion(sw, "src/mon-collector", debug=debug)
864

865
866
867
868
  # Reset extglob to original value
  sw.Write("[[ -n \"$gnt_shopt_extglob\" ]] && $gnt_shopt_extglob")
  sw.Write("unset gnt_shopt_extglob")

869
870
871
872
873
  print buf.getvalue()


if __name__ == "__main__":
  main()