cli.py 78.9 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2
3
#

4
# Copyright (C) 2006, 2007, 2008, 2009, 2010 Google Inc.
Iustin Pop's avatar
Iustin Pop committed
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
#
# 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.


"""Module dealing with command line parsing"""


import sys
import textwrap
import os.path
28
import time
Iustin Pop's avatar
Iustin Pop committed
29
import logging
30
from cStringIO import StringIO
Iustin Pop's avatar
Iustin Pop committed
31
32
33
34

from ganeti import utils
from ganeti import errors
from ganeti import constants
35
from ganeti import opcodes
Iustin Pop's avatar
Iustin Pop committed
36
from ganeti import luxi
37
from ganeti import ssconf
38
from ganeti import rpc
39
from ganeti import ssh
40
from ganeti import compat
41
from ganeti import netutils
Iustin Pop's avatar
Iustin Pop committed
42

43
from optparse import (OptionParser, TitledHelpFormatter,
Iustin Pop's avatar
Iustin Pop committed
44
                      Option, OptionValueError)
Iustin Pop's avatar
Iustin Pop committed
45

46

47
48
__all__ = [
  # Command line options
49
  "ADD_UIDS_OPT",
50
  "ALLOCATABLE_OPT",
51
  "ALL_OPT",
52
  "AUTO_PROMOTE_OPT",
53
  "AUTO_REPLACE_OPT",
54
  "BACKEND_OPT",
55
  "CLEANUP_OPT",
Michael Hanselmann's avatar
Michael Hanselmann committed
56
  "CLUSTER_DOMAIN_SECRET_OPT",
57
  "CONFIRM_OPT",
58
  "CP_SIZE_OPT",
59
  "DEBUG_OPT",
60
  "DEBUG_SIMERR_OPT",
61
  "DISKIDX_OPT",
62
  "DISK_OPT",
63
  "DISK_TEMPLATE_OPT",
64
  "DRAINED_OPT",
65
  "DRY_RUN_OPT",
66
  "DRBD_HELPER_OPT",
67
  "EARLY_RELEASE_OPT",
68
  "ENABLED_HV_OPT",
69
  "ERROR_CODES_OPT",
70
  "FIELDS_OPT",
71
  "FILESTORE_DIR_OPT",
72
  "FILESTORE_DRIVER_OPT",
73
74
  "FORCE_OPT",
  "FORCE_VARIANT_OPT",
75
  "GLOBAL_FILEDIR_OPT",
76
  "HVLIST_OPT",
77
  "HVOPTS_OPT",
78
  "HYPERVISOR_OPT",
79
  "IALLOCATOR_OPT",
80
  "DEFAULT_IALLOCATOR_OPT",
81
  "IDENTIFY_DEFAULTS_OPT",
82
  "IGNORE_CONSIST_OPT",
83
  "IGNORE_FAILURES_OPT",
84
  "IGNORE_REMOVE_FAILURES_OPT",
85
  "IGNORE_SECONDARIES_OPT",
86
  "IGNORE_SIZE_OPT",
Michael Hanselmann's avatar
Michael Hanselmann committed
87
  "INTERVAL_OPT",
88
  "MAC_PREFIX_OPT",
89
  "MAINTAIN_NODE_HEALTH_OPT",
90
  "MASTER_NETDEV_OPT",
91
  "MC_OPT",
92
  "MIGRATION_MODE_OPT",
Iustin Pop's avatar
Iustin Pop committed
93
  "NET_OPT",
94
  "NEW_CLUSTER_CERT_OPT",
Michael Hanselmann's avatar
Michael Hanselmann committed
95
  "NEW_CLUSTER_DOMAIN_SECRET_OPT",
96
  "NEW_CONFD_HMAC_KEY_OPT",
97
  "NEW_RAPI_CERT_OPT",
98
  "NEW_SECONDARY_OPT",
99
  "NIC_PARAMS_OPT",
100
  "NODE_LIST_OPT",
101
  "NODE_PLACEMENT_OPT",
102
  "NODRBD_STORAGE_OPT",
103
  "NOHDR_OPT",
104
  "NOIPCHECK_OPT",
105
  "NO_INSTALL_OPT",
106
  "NONAMECHECK_OPT",
107
  "NOLVM_STORAGE_OPT",
108
  "NOMODIFY_ETCHOSTS_OPT",
109
  "NOMODIFY_SSH_SETUP_OPT",
Iustin Pop's avatar
Iustin Pop committed
110
  "NONICS_OPT",
Iustin Pop's avatar
Iustin Pop committed
111
  "NONLIVE_OPT",
112
  "NONPLUS1_OPT",
113
  "NOSHUTDOWN_OPT",
114
  "NOSTART_OPT",
115
  "NOSSH_KEYCHECK_OPT",
116
  "NOVOTING_OPT",
117
  "NWSYNC_OPT",
118
  "ON_PRIMARY_OPT",
119
  "ON_SECONDARY_OPT",
120
  "OFFLINE_OPT",
121
  "OSPARAMS_OPT",
Iustin Pop's avatar
Iustin Pop committed
122
  "OS_OPT",
Iustin Pop's avatar
Iustin Pop committed
123
  "OS_SIZE_OPT",
124
  "RAPI_CERT_OPT",
125
  "READD_OPT",
126
  "REBOOT_TYPE_OPT",
127
  "REMOVE_INSTANCE_OPT",
128
  "REMOVE_UIDS_OPT",
129
  "RESERVED_LVS_OPT",
130
  "ROMAN_OPT",
131
  "SECONDARY_IP_OPT",
132
  "SELECT_OS_OPT",
133
  "SEP_OPT",
134
  "SHOWCMD_OPT",
Guido Trotter's avatar
Guido Trotter committed
135
  "SHUTDOWN_TIMEOUT_OPT",
136
  "SINGLE_NODE_OPT",
137
138
  "SRC_DIR_OPT",
  "SRC_NODE_OPT",
139
  "SUBMIT_OPT",
140
  "STATIC_OPT",
141
142
  "SYNC_OPT",
  "TAG_SRC_OPT",
Guido Trotter's avatar
Guido Trotter committed
143
  "TIMEOUT_OPT",
144
  "UIDPOOL_OPT",
145
  "USEUNITS_OPT",
146
  "USE_REPL_NET_OPT",
147
  "VERBOSE_OPT",
Iustin Pop's avatar
Iustin Pop committed
148
  "VG_NAME_OPT",
149
  "YES_DOIT_OPT",
150
151
  # Generic functions for CLI programs
  "GenericMain",
Iustin Pop's avatar
Iustin Pop committed
152
  "GenericInstanceCreate",
153
154
155
156
157
  "GetClient",
  "GetOnlineNodes",
  "JobExecutor",
  "JobSubmittedException",
  "ParseTimespec",
158
  "RunWhileClusterStopped",
159
160
161
162
163
164
165
166
167
  "SubmitOpCode",
  "SubmitOrSend",
  "UsesRPC",
  # Formatting functions
  "ToStderr", "ToStdout",
  "FormatError",
  "GenerateTable",
  "AskUser",
  "FormatTimestamp",
168
  "FormatLogMessage",
169
170
171
172
173
174
175
176
177
178
  # Tags functions
  "ListTags",
  "AddTags",
  "RemoveTags",
  # command line options support infrastructure
  "ARGS_MANY_INSTANCES",
  "ARGS_MANY_NODES",
  "ARGS_NONE",
  "ARGS_ONE_INSTANCE",
  "ARGS_ONE_NODE",
179
  "ARGS_ONE_OS",
180
181
182
183
184
185
186
  "ArgChoice",
  "ArgCommand",
  "ArgFile",
  "ArgHost",
  "ArgInstance",
  "ArgJobId",
  "ArgNode",
187
  "ArgOs",
188
189
190
191
192
193
194
195
196
197
  "ArgSuggest",
  "ArgUnknown",
  "OPT_COMPL_INST_ADD_NODES",
  "OPT_COMPL_MANY_NODES",
  "OPT_COMPL_ONE_IALLOCATOR",
  "OPT_COMPL_ONE_INSTANCE",
  "OPT_COMPL_ONE_NODE",
  "OPT_COMPL_ONE_OS",
  "cli_option",
  "SplitNodeOption",
Guido Trotter's avatar
Guido Trotter committed
198
  "CalculateOSNames",
199
  "ParseFields",
200
  ]
201

202
203
NO_PREFIX = "no_"
UN_PREFIX = "-"
204

205

206
class _Argument:
Iustin Pop's avatar
Iustin Pop committed
207
  def __init__(self, min=0, max=None): # pylint: disable-msg=W0622
208
209
210
211
212
213
214
215
216
217
218
219
220
221
    self.min = min
    self.max = max

  def __repr__(self):
    return ("<%s min=%s max=%s>" %
            (self.__class__.__name__, self.min, self.max))


class ArgSuggest(_Argument):
  """Suggesting argument.

  Value can be any of the ones passed to the constructor.

  """
Iustin Pop's avatar
Iustin Pop committed
222
  # pylint: disable-msg=W0622
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
  def __init__(self, min=0, max=None, choices=None):
    _Argument.__init__(self, min=min, max=max)
    self.choices = choices

  def __repr__(self):
    return ("<%s min=%s max=%s choices=%r>" %
            (self.__class__.__name__, self.min, self.max, self.choices))


class ArgChoice(ArgSuggest):
  """Choice argument.

  Value can be any of the ones passed to the constructor. Like L{ArgSuggest},
  but value must be one of the choices.

  """


class ArgUnknown(_Argument):
  """Unknown argument to program (e.g. determined at runtime).

  """


class ArgInstance(_Argument):
  """Instances argument.

  """


class ArgNode(_Argument):
  """Node argument.

  """

class ArgJobId(_Argument):
  """Job ID argument.

  """


class ArgFile(_Argument):
  """File path argument.

  """


class ArgCommand(_Argument):
  """Command argument.

  """


Michael Hanselmann's avatar
Michael Hanselmann committed
276
277
278
279
280
281
class ArgHost(_Argument):
  """Host argument.

  """


282
283
284
285
286
287
class ArgOs(_Argument):
  """OS argument.

  """


288
289
290
291
292
ARGS_NONE = []
ARGS_MANY_INSTANCES = [ArgInstance()]
ARGS_MANY_NODES = [ArgNode()]
ARGS_ONE_INSTANCE = [ArgInstance(min=1, max=1)]
ARGS_ONE_NODE = [ArgNode(min=1, max=1)]
293
ARGS_ONE_OS = [ArgOs(min=1, max=1)]
294
295


296
297
298
299
300
301
302
303
304
305
306
307
308
def _ExtractTagsObject(opts, args):
  """Extract the tag type object.

  Note that this function will modify its args parameter.

  """
  if not hasattr(opts, "tag_type"):
    raise errors.ProgrammerError("tag_type not passed to _ExtractTagsObject")
  kind = opts.tag_type
  if kind == constants.TAG_CLUSTER:
    retval = kind, kind
  elif kind == constants.TAG_NODE or kind == constants.TAG_INSTANCE:
    if not args:
Iustin Pop's avatar
Iustin Pop committed
309
      raise errors.OpPrereqError("no arguments passed to the command")
310
311
312
313
314
315
316
    name = args.pop(0)
    retval = kind, name
  else:
    raise errors.ProgrammerError("Unhandled tag type '%s'" % kind)
  return retval


317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
def _ExtendTags(opts, args):
  """Extend the args if a source file has been given.

  This function will extend the tags with the contents of the file
  passed in the 'tags_source' attribute of the opts parameter. A file
  named '-' will be replaced by stdin.

  """
  fname = opts.tags_source
  if fname is None:
    return
  if fname == "-":
    new_fh = sys.stdin
  else:
    new_fh = open(fname, "r")
  new_data = []
  try:
    # we don't use the nice 'new_data = [line.strip() for line in fh]'
    # because of python bug 1633941
    while True:
      line = new_fh.readline()
      if not line:
        break
      new_data.append(line.strip())
  finally:
    new_fh.close()
  args.extend(new_data)


346
347
348
349
350
351
352
353
354
355
def ListTags(opts, args):
  """List the tags on a given object.

  This is a generic implementation that knows how to deal with all
  three cases of tag objects (cluster, node, instance). The opts
  argument is expected to contain a tag_type field denoting what
  object type we work on.

  """
  kind, name = _ExtractTagsObject(opts, args)
Iustin Pop's avatar
Iustin Pop committed
356
357
  cl = GetClient()
  result = cl.QueryTags(kind, name)
358
359
360
  result = list(result)
  result.sort()
  for tag in result:
361
    ToStdout(tag)
362
363
364
365
366
367
368
369
370
371
372
373


def AddTags(opts, args):
  """Add tags on a given object.

  This is a generic implementation that knows how to deal with all
  three cases of tag objects (cluster, node, instance). The opts
  argument is expected to contain a tag_type field denoting what
  object type we work on.

  """
  kind, name = _ExtractTagsObject(opts, args)
374
  _ExtendTags(opts, args)
375
376
377
  if not args:
    raise errors.OpPrereqError("No tags to be added")
  op = opcodes.OpAddTags(kind=kind, name=name, tags=args)
378
  SubmitOpCode(op, opts=opts)
379
380
381
382
383
384
385
386
387
388
389
390


def RemoveTags(opts, args):
  """Remove tags from a given object.

  This is a generic implementation that knows how to deal with all
  three cases of tag objects (cluster, node, instance). The opts
  argument is expected to contain a tag_type field denoting what
  object type we work on.

  """
  kind, name = _ExtractTagsObject(opts, args)
391
  _ExtendTags(opts, args)
392
393
394
  if not args:
    raise errors.OpPrereqError("No tags to be removed")
  op = opcodes.OpDelTags(kind=kind, name=name, tags=args)
395
  SubmitOpCode(op, opts=opts)
396

Iustin Pop's avatar
Iustin Pop committed
397

398
def check_unit(option, opt, value): # pylint: disable-msg=W0613
Iustin Pop's avatar
Iustin Pop committed
399
400
401
  """OptParsers custom converter for units.

  """
Iustin Pop's avatar
Iustin Pop committed
402
403
404
  try:
    return utils.ParseUnit(value)
  except errors.UnitParseError, err:
405
    raise OptionValueError("option %s: %s" % (opt, err))
Iustin Pop's avatar
Iustin Pop committed
406
407


408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
def _SplitKeyVal(opt, data):
  """Convert a KeyVal string into a dict.

  This function will convert a key=val[,...] string into a dict. Empty
  values will be converted specially: keys which have the prefix 'no_'
  will have the value=False and the prefix stripped, the others will
  have value=True.

  @type opt: string
  @param opt: a string holding the option name for which we process the
      data, used in building error messages
  @type data: string
  @param data: a string of the format key=val,key=val,...
  @rtype: dict
  @return: {key=val, key=val}
  @raises errors.ParameterError: if there are duplicate keys

  """
  kv_dict = {}
427
  if data:
428
    for elem in utils.UnescapeAndSplit(data, sep=","):
429
430
      if "=" in elem:
        key, val = elem.split("=", 1)
431
      else:
432
433
434
435
436
437
438
439
440
441
        if elem.startswith(NO_PREFIX):
          key, val = elem[len(NO_PREFIX):], False
        elif elem.startswith(UN_PREFIX):
          key, val = elem[len(UN_PREFIX):], None
        else:
          key, val = elem, True
      if key in kv_dict:
        raise errors.ParameterError("Duplicate key '%s' in option %s" %
                                    (key, opt))
      kv_dict[key] = val
442
443
444
  return kv_dict


445
def check_ident_key_val(option, opt, value):  # pylint: disable-msg=W0613
446
447
448
449
  """Custom parser for ident:key=val,key=val options.

  This will store the parsed values as a tuple (ident, {key: val}). As such,
  multiple uses of this option via action=append is possible.
450
451
452

  """
  if ":" not in value:
453
    ident, rest = value, ''
454
455
  else:
    ident, rest = value.split(":", 1)
456
457
458
459
460
461
462
463
464
465
466
467

  if ident.startswith(NO_PREFIX):
    if rest:
      msg = "Cannot pass options when removing parameter groups: %s" % value
      raise errors.ParameterError(msg)
    retval = (ident[len(NO_PREFIX):], False)
  elif ident.startswith(UN_PREFIX):
    if rest:
      msg = "Cannot pass options when removing parameter groups: %s" % value
      raise errors.ParameterError(msg)
    retval = (ident[len(UN_PREFIX):], None)
  else:
468
469
470
471
472
    kv_dict = _SplitKeyVal(opt, rest)
    retval = (ident, kv_dict)
  return retval


473
def check_key_val(option, opt, value):  # pylint: disable-msg=W0613
474
475
476
  """Custom parser class for key=val,key=val options.

  This will store the parsed values as a dict {key: val}.
477
478
479
480
481

  """
  return _SplitKeyVal(opt, value)


Iustin Pop's avatar
Iustin Pop committed
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
def check_bool(option, opt, value): # pylint: disable-msg=W0613
  """Custom parser for yes/no options.

  This will store the parsed value as either True or False.

  """
  value = value.lower()
  if value == constants.VALUE_FALSE or value == "no":
    return False
  elif value == constants.VALUE_TRUE or value == "yes":
    return True
  else:
    raise errors.ParameterError("Invalid boolean value '%s'" % value)


497
498
499
500
501
502
# completion_suggestion is normally a list. Using numeric values not evaluating
# to False for dynamic completion.
(OPT_COMPL_MANY_NODES,
 OPT_COMPL_ONE_NODE,
 OPT_COMPL_ONE_INSTANCE,
 OPT_COMPL_ONE_OS,
503
504
 OPT_COMPL_ONE_IALLOCATOR,
 OPT_COMPL_INST_ADD_NODES) = range(100, 106)
505
506
507
508
509
510
511

OPT_COMPL_ALL = frozenset([
  OPT_COMPL_MANY_NODES,
  OPT_COMPL_ONE_NODE,
  OPT_COMPL_ONE_INSTANCE,
  OPT_COMPL_ONE_OS,
  OPT_COMPL_ONE_IALLOCATOR,
512
  OPT_COMPL_INST_ADD_NODES,
513
514
515
  ])


516
517
class CliOption(Option):
  """Custom option class for optparse.
518
519

  """
520
521
522
  ATTRS = Option.ATTRS + [
    "completion_suggest",
    ]
523
524
525
526
  TYPES = Option.TYPES + (
    "identkeyval",
    "keyval",
    "unit",
Iustin Pop's avatar
Iustin Pop committed
527
    "bool",
528
529
530
    )
  TYPE_CHECKER = Option.TYPE_CHECKER.copy()
  TYPE_CHECKER["identkeyval"] = check_ident_key_val
531
  TYPE_CHECKER["keyval"] = check_key_val
532
  TYPE_CHECKER["unit"] = check_unit
Iustin Pop's avatar
Iustin Pop committed
533
  TYPE_CHECKER["bool"] = check_bool
534
535


Iustin Pop's avatar
Iustin Pop committed
536
537
538
539
# optparse.py sets make_option, so we do it for our own option class, too
cli_option = CliOption


540
541
_YORNO = "yes|no"

542
543
DEBUG_OPT = cli_option("-d", "--debug", default=0, action="count",
                       help="Increase debugging level")
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580

NOHDR_OPT = cli_option("--no-headers", default=False,
                       action="store_true", dest="no_headers",
                       help="Don't display column headers")

SEP_OPT = cli_option("--separator", default=None,
                     action="store", dest="separator",
                     help=("Separator between output fields"
                           " (defaults to one space)"))

USEUNITS_OPT = cli_option("--units", default=None,
                          dest="units", choices=('h', 'm', 'g', 't'),
                          help="Specify units for output (one of hmgt)")

FIELDS_OPT = cli_option("-o", "--output", dest="output", action="store",
                        type="string", metavar="FIELDS",
                        help="Comma separated list of output fields")

FORCE_OPT = cli_option("-f", "--force", dest="force", action="store_true",
                       default=False, help="Force the operation")

CONFIRM_OPT = cli_option("--yes", dest="confirm", action="store_true",
                         default=False, help="Do not require confirmation")

TAG_SRC_OPT = cli_option("--from", dest="tags_source",
                         default=None, help="File with tag names")

SUBMIT_OPT = cli_option("--submit", dest="submit_only",
                        default=False, action="store_true",
                        help=("Submit the job and return the job ID, but"
                              " don't wait for the job to finish"))

SYNC_OPT = cli_option("--sync", dest="do_locking",
                      default=False, action="store_true",
                      help=("Grab locks while doing the queries"
                            " in order to ensure more consistent results"))

581
582
583
584
585
DRY_RUN_OPT = cli_option("--dry-run", default=False,
                         action="store_true",
                         help=("Do not execute the operation, just run the"
                               " check steps and verify it it could be"
                               " executed"))
586

587
588
589
590
VERBOSE_OPT = cli_option("-v", "--verbose", default=False,
                         action="store_true",
                         help="Increase the verbosity of the operation")

591
592
593
594
595
DEBUG_SIMERR_OPT = cli_option("--debug-simulate-errors", default=False,
                              action="store_true", dest="simulate_errors",
                              help="Debugging option that makes the operation"
                              " treat most runtime checks as failed")

596
597
598
599
NWSYNC_OPT = cli_option("--no-wait-for-sync", dest="wait_for_sync",
                        default=True, action="store_false",
                        help="Don't wait for sync (DANGEROUS!)")

600
601
602
603
604
605
DISK_TEMPLATE_OPT = cli_option("-t", "--disk-template", dest="disk_template",
                               help="Custom disk setup (diskless, file,"
                               " plain or drbd)",
                               default=None, metavar="TEMPL",
                               choices=list(constants.DISK_TEMPLATES))

Iustin Pop's avatar
Iustin Pop committed
606
607
608
609
NONICS_OPT = cli_option("--no-nics", default=False, action="store_true",
                        help="Do not create any network cards for"
                        " the instance")

610
611
612
613
614
FILESTORE_DIR_OPT = cli_option("--file-storage-dir", dest="file_storage_dir",
                               help="Relative path under default cluster-wide"
                               " file storage dir to store file-based disks",
                               default=None, metavar="<DIR>")

615
616
617
618
619
FILESTORE_DRIVER_OPT = cli_option("--file-driver", dest="file_driver",
                                  help="Driver to use for image files",
                                  default="loop", metavar="<DRIVER>",
                                  choices=list(constants.FILE_DRIVER))

620
621
622
623
624
625
IALLOCATOR_OPT = cli_option("-I", "--iallocator", metavar="<NAME>",
                            help="Select nodes for the instance automatically"
                            " using the <NAME> iallocator plugin",
                            default=None, type="string",
                            completion_suggest=OPT_COMPL_ONE_IALLOCATOR)

626
627
628
629
630
631
DEFAULT_IALLOCATOR_OPT = cli_option("-I", "--default-iallocator",
                            metavar="<NAME>",
                            help="Set the default instance allocator plugin",
                            default=None, type="string",
                            completion_suggest=OPT_COMPL_ONE_IALLOCATOR)

Iustin Pop's avatar
Iustin Pop committed
632
633
634
635
OS_OPT = cli_option("-o", "--os-type", dest="os", help="What OS to run",
                    metavar="<os>",
                    completion_suggest=OPT_COMPL_ONE_OS)

636
637
638
639
OSPARAMS_OPT = cli_option("-O", "--os-parameters", dest="osparams",
                         type="keyval", default={},
                         help="OS parameters")

640
641
642
643
FORCE_VARIANT_OPT = cli_option("--force-variant", dest="force_variant",
                               action="store_true", default=False,
                               help="Force an unknown variant")

644
645
646
647
648
NO_INSTALL_OPT = cli_option("--no-install", dest="no_install",
                            action="store_true", default=False,
                            help="Do not install the OS (will"
                            " enable no-start)")

649
650
651
BACKEND_OPT = cli_option("-B", "--backend-parameters", dest="beparams",
                         type="keyval", default={},
                         help="Backend parameters")
652
653
654
655

HVOPTS_OPT =  cli_option("-H", "--hypervisor-parameters", type="keyval",
                         default={}, dest="hvparams",
                         help="Hypervisor parameters")
656

657
658
659
660
HYPERVISOR_OPT = cli_option("-H", "--hypervisor-parameters", dest="hypervisor",
                            help="Hypervisor and hypervisor options, in the"
                            " format hypervisor:option=value,option=value,...",
                            default=None, type="identkeyval")
661
662
663
664
665

HVLIST_OPT = cli_option("-H", "--hypervisor-parameters", dest="hvparams",
                        help="Hypervisor and hypervisor options, in the"
                        " format hypervisor:option=value,option=value,...",
                        default=[], action="append", type="identkeyval")
666

667
668
669
670
671
NOIPCHECK_OPT = cli_option("--no-ip-check", dest="ip_check", default=True,
                           action="store_false",
                           help="Don't check that the instance's IP"
                           " is alive")

672
673
674
675
676
NONAMECHECK_OPT = cli_option("--no-name-check", dest="name_check",
                             default=True, action="store_false",
                             help="Don't check that the instance's name"
                             " is resolvable")

Iustin Pop's avatar
Iustin Pop committed
677
678
679
NET_OPT = cli_option("--net",
                     help="NIC parameters", default=[],
                     dest="nics", action="append", type="identkeyval")
680
681
682

DISK_OPT = cli_option("--disk", help="Disk parameters", default=[],
                      dest="disks", action="append", type="identkeyval")
683

684
685
686
687
688
DISKIDX_OPT = cli_option("--disks", dest="disks", default=None,
                         help="Comma-separated list of disks"
                         " indices to act on (e.g. 0,2) (optional,"
                         " defaults to all disks)")

Iustin Pop's avatar
Iustin Pop committed
689
690
691
692
693
OS_SIZE_OPT = cli_option("-s", "--os-size", dest="sd_size",
                         help="Enforces a single-disk configuration using the"
                         " given disk size, in MiB unless a suffix is used",
                         default=None, type="unit", metavar="<size>")

694
695
696
697
698
699
IGNORE_CONSIST_OPT = cli_option("--ignore-consistency",
                                dest="ignore_consistency",
                                action="store_true", default=False,
                                help="Ignore the consistency of the disks on"
                                " the secondary")

Iustin Pop's avatar
Iustin Pop committed
700
701
702
703
704
705
NONLIVE_OPT = cli_option("--non-live", dest="live",
                         default=True, action="store_false",
                         help="Do a non-live migration (this usually means"
                         " freeze the instance, save the state, transfer and"
                         " only then resume running on the secondary node)")

706
MIGRATION_MODE_OPT = cli_option("--migration-mode", dest="migration_mode",
707
                                default=None,
708
709
                                choices=list(constants.HT_MIGRATION_MODES),
                                help="Override default migration mode (choose"
710
711
                                " either live or non-live")

712
713
714
715
716
NODE_PLACEMENT_OPT = cli_option("-n", "--node", dest="node",
                                help="Target node and optional secondary node",
                                metavar="<pnode>[:<snode>]",
                                completion_suggest=OPT_COMPL_INST_ADD_NODES)

717
718
719
720
721
NODE_LIST_OPT = cli_option("-n", "--node", dest="nodes", default=[],
                           action="append", metavar="<node>",
                           help="Use only this node (can be used multiple"
                           " times, if not given defaults to all nodes)",
                           completion_suggest=OPT_COMPL_ONE_NODE)
722
723
724
725

SINGLE_NODE_OPT = cli_option("-n", "--node", dest="node", help="Target node",
                             metavar="<node>",
                             completion_suggest=OPT_COMPL_ONE_NODE)
726

727
728
729
730
NOSTART_OPT = cli_option("--no-start", dest="start", default=True,
                         action="store_false",
                         help="Don't start the instance after creation")

731
732
733
734
SHOWCMD_OPT = cli_option("--show-cmd", dest="show_command",
                         action="store_true", default=False,
                         help="Show command instead of executing it")

735
736
737
738
739
740
741
742
743
CLEANUP_OPT = cli_option("--cleanup", dest="cleanup",
                         default=False, action="store_true",
                         help="Instead of performing the migration, try to"
                         " recover from a failed cleanup. This is safe"
                         " to run even if the instance is healthy, but it"
                         " will create extra replication traffic and "
                         " disrupt briefly the replication (like during the"
                         " migration")

744
745
746
747
STATIC_OPT = cli_option("-s", "--static", dest="static",
                        action="store_true", default=False,
                        help="Only show configuration data, not runtime data")

748
749
750
751
752
ALL_OPT = cli_option("--all", dest="show_all",
                     default=False, action="store_true",
                     help="Show info on all instances on the cluster."
                     " This can take a long time to run, use wisely")

753
754
755
756
SELECT_OS_OPT = cli_option("--select-os", dest="select_os",
                           action="store_true", default=False,
                           help="Interactive OS reinstall, lists available"
                           " OS templates for selection")
757

758
759
760
761
762
763
IGNORE_FAILURES_OPT = cli_option("--ignore-failures", dest="ignore_failures",
                                 action="store_true", default=False,
                                 help="Remove the instance from the cluster"
                                 " configuration even if there are failures"
                                 " during the removal process")

764
765
766
767
768
769
770
771
772
773
774
775
IGNORE_REMOVE_FAILURES_OPT = cli_option("--ignore-remove-failures",
                                        dest="ignore_remove_failures",
                                        action="store_true", default=False,
                                        help="Remove the instance from the"
                                        " cluster configuration even if there"
                                        " are failures during the removal"
                                        " process")

REMOVE_INSTANCE_OPT = cli_option("--remove-instance", dest="remove_instance",
                                 action="store_true", default=False,
                                 help="Remove the instance from the cluster")

776
777
778
779
780
NEW_SECONDARY_OPT = cli_option("-n", "--new-secondary", dest="dst_node",
                               help="Specifies the new secondary node",
                               metavar="NODE", default=None,
                               completion_suggest=OPT_COMPL_ONE_NODE)

781
782
783
784
ON_PRIMARY_OPT = cli_option("-p", "--on-primary", dest="on_primary",
                            default=False, action="store_true",
                            help="Replace the disk(s) on the primary"
                            " node (only for the drbd template)")
785
786
787
788
789

ON_SECONDARY_OPT = cli_option("-s", "--on-secondary", dest="on_secondary",
                              default=False, action="store_true",
                              help="Replace the disk(s) on the secondary"
                              " node (only for the drbd template)")
790

791
792
793
794
795
AUTO_PROMOTE_OPT = cli_option("--auto-promote", dest="auto_promote",
                              default=False, action="store_true",
                              help="Lock all nodes and auto-promote as needed"
                              " to MC status")

796
797
798
799
AUTO_REPLACE_OPT = cli_option("-a", "--auto", dest="auto",
                              default=False, action="store_true",
                              help="Automatically replace faulty disks"
                              " (only for the drbd template)")
800

801
802
803
804
805
806
IGNORE_SIZE_OPT = cli_option("--ignore-size", dest="ignore_size",
                             default=False, action="store_true",
                             help="Ignore current recorded size"
                             " (useful for forcing activation when"
                             " the recorded size is wrong)")

807
808
809
810
811
812
813
SRC_NODE_OPT = cli_option("--src-node", dest="src_node", help="Source node",
                          metavar="<node>",
                          completion_suggest=OPT_COMPL_ONE_NODE)

SRC_DIR_OPT = cli_option("--src-dir", dest="src_dir", help="Source directory",
                         metavar="<dir>")

814
815
816
817
SECONDARY_IP_OPT = cli_option("-s", "--secondary-ip", dest="secondary_ip",
                              help="Specify the secondary ip for the node",
                              metavar="ADDRESS", default=None)

818
819
820
821
READD_OPT = cli_option("--readd", dest="readd",
                       default=False, action="store_true",
                       help="Readd old node after replacing it")

822
823
824
825
NOSSH_KEYCHECK_OPT = cli_option("--no-ssh-key-check", dest="ssh_key_check",
                                default=True, action="store_false",
                                help="Disable SSH key fingerprint checking")

826

827
MC_OPT = cli_option("-C", "--master-candidate", dest="master_candidate",
Iustin Pop's avatar
Iustin Pop committed
828
                    type="bool", default=None, metavar=_YORNO,
829
830
831
                    help="Set the master_candidate flag on the node")

OFFLINE_OPT = cli_option("-O", "--offline", dest="offline", metavar=_YORNO,
Iustin Pop's avatar
Iustin Pop committed
832
                         type="bool", default=None,
833
834
835
                         help="Set the offline flag on the node")

DRAINED_OPT = cli_option("-D", "--drained", dest="drained", metavar=_YORNO,
Iustin Pop's avatar
Iustin Pop committed
836
                         type="bool", default=None,
837
838
                         help="Set the drained flag on the node")

839
ALLOCATABLE_OPT = cli_option("--allocatable", dest="allocatable",
Iustin Pop's avatar
Iustin Pop committed
840
                             type="bool", default=None, metavar=_YORNO,
841
842
                             help="Set the allocatable flag on a volume")

843
844
845
846
847
NOLVM_STORAGE_OPT = cli_option("--no-lvm-storage", dest="lvm_storage",
                               help="Disable support for lvm based instances"
                               " (cluster-wide)",
                               action="store_false", default=True)

848
849
850
851
852
ENABLED_HV_OPT = cli_option("--enabled-hypervisors",
                            dest="enabled_hypervisors",
                            help="Comma-separated list of hypervisors",
                            type="string", default=None)

853
854
855
856
NIC_PARAMS_OPT = cli_option("-N", "--nic-parameters", dest="nicparams",
                            type="keyval", default={},
                            help="NIC parameters")

857
858
859
860
CP_SIZE_OPT = cli_option("-C", "--candidate-pool-size", default=None,
                         dest="candidate_pool_size", type="int",
                         help="Set the candidate pool size")

Iustin Pop's avatar
Iustin Pop committed
861
862
863
864
865
VG_NAME_OPT = cli_option("-g", "--vg-name", dest="vg_name",
                         help="Enables LVM and specifies the volume group"
                         " name (cluster-wide) for disk allocation [xenvg]",
                         metavar="VG", default=None)

866
867
YES_DOIT_OPT = cli_option("--yes-do-it", dest="yes_do_it",
                          help="Destroy cluster", action="store_true")
Iustin Pop's avatar
Iustin Pop committed
868

869
870
871
872
NOVOTING_OPT = cli_option("--no-voting", dest="no_voting",
                          help="Skip node agreement check (dangerous)",
                          action="store_true", default=False)

873
874
875
876
877
878
MAC_PREFIX_OPT = cli_option("-m", "--mac-prefix", dest="mac_prefix",
                            help="Specify the mac prefix for the instance IP"
                            " addresses, in the format XX:XX:XX",
                            metavar="PREFIX",
                            default=None)

879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
MASTER_NETDEV_OPT = cli_option("--master-netdev", dest="master_netdev",
                               help="Specify the node interface (cluster-wide)"
                               " on which the master IP address will be added "
                               " [%s]" % constants.DEFAULT_BRIDGE,
                               metavar="NETDEV",
                               default=constants.DEFAULT_BRIDGE)

GLOBAL_FILEDIR_OPT = cli_option("--file-storage-dir", dest="file_storage_dir",
                                help="Specify the default directory (cluster-"
                                "wide) for storing the file-based disks [%s]" %
                                constants.DEFAULT_FILE_STORAGE_DIR,
                                metavar="DIR",
                                default=constants.DEFAULT_FILE_STORAGE_DIR)

NOMODIFY_ETCHOSTS_OPT = cli_option("--no-etc-hosts", dest="modify_etc_hosts",
                                   help="Don't modify /etc/hosts",
                                   action="store_false", default=True)

897
898
899
900
NOMODIFY_SSH_SETUP_OPT = cli_option("--no-ssh-init", dest="modify_ssh_setup",
                                    help="Don't initialize SSH keys",
                                    action="store_false", default=True)

901
902
903
904
905
906
907
908
ERROR_CODES_OPT = cli_option("--error-codes", dest="error_codes",
                             help="Enable parseable error messages",
                             action="store_true", default=False)

NONPLUS1_OPT = cli_option("--no-nplus1-mem", dest="skip_nplusone_mem",
                          help="Skip N+1 memory redundancy tests",
                          action="store_true", default=False)

909
910
911
912
913
914
REBOOT_TYPE_OPT = cli_option("-t", "--type", dest="reboot_type",
                             help="Type of reboot: soft/hard/full",
                             default=constants.INSTANCE_REBOOT_HARD,
                             metavar="<REBOOT>",
                             choices=list(constants.REBOOT_TYPES))

915
916
917
918
919
IGNORE_SECONDARIES_OPT = cli_option("--ignore-secondaries",
                                    dest="ignore_secondaries",
                                    default=False, action="store_true",
                                    help="Ignore errors from secondaries")

920
NOSHUTDOWN_OPT = cli_option("--noshutdown", dest="shutdown",
921
922
923
                            action="store_false", default=True,
                            help="Don't shutdown the instance (unsafe)")

Guido Trotter's avatar
Guido Trotter committed
924
925
926
TIMEOUT_OPT = cli_option("--timeout", dest="timeout", type="int",
                         default=constants.DEFAULT_SHUTDOWN_TIMEOUT,
                         help="Maximum time to wait")
927

928
929
SHUTDOWN_TIMEOUT_OPT = cli_option("--shutdown-timeout",
                         dest="shutdown_timeout", type="int",
Guido Trotter's avatar
Guido Trotter committed
930
931
932
                         default=constants.DEFAULT_SHUTDOWN_TIMEOUT,
                         help="Maximum time to wait for instance shutdown")

Michael Hanselmann's avatar
Michael Hanselmann committed
933
934
935
936
937
INTERVAL_OPT = cli_option("--interval", dest="interval", type="int",
                          default=None,
                          help=("Number of seconds between repetions of the"
                                " command"))

938
939
940
941
942
943
EARLY_RELEASE_OPT = cli_option("--early-release",
                               dest="early_release", default=False,
                               action="store_true",
                               help="Release the locks on the secondary"
                               " node(s) early")

944
945
946
947
948
949
950
951
952
953
954
955
956
957
NEW_CLUSTER_CERT_OPT = cli_option("--new-cluster-certificate",
                                  dest="new_cluster_cert",
                                  default=False, action="store_true",
                                  help="Generate a new cluster certificate")

RAPI_CERT_OPT = cli_option("--rapi-certificate", dest="rapi_cert",
                           default=None,
                           help="File containing new RAPI certificate")

NEW_RAPI_CERT_OPT = cli_option("--new-rapi-certificate", dest="new_rapi_cert",
                               default=None, action="store_true",
                               help=("Generate a new self-signed RAPI"
                                     " certificate"))

958
959
960
961
962
NEW_CONFD_HMAC_KEY_OPT = cli_option("--new-confd-hmac-key",
                                    dest="new_confd_hmac_key",
                                    default=False, action="store_true",
                                    help=("Create a new HMAC key for %s" %
                                          constants.CONFD))
963

Michael Hanselmann's avatar
Michael Hanselmann committed
964
965
966
967
968
969
970
971
972
973
974
975
CLUSTER_DOMAIN_SECRET_OPT = cli_option("--cluster-domain-secret",
                                       dest="cluster_domain_secret",
                                       default=None,
                                       help=("Load new new cluster domain"
                                             " secret from file"))

NEW_CLUSTER_DOMAIN_SECRET_OPT = cli_option("--new-cluster-domain-secret",
                                           dest="new_cluster_domain_secret",
                                           default=False, action="store_true",
                                           help=("Create a new cluster domain"
                                                 " secret"))

976
977
978
979
980
981
USE_REPL_NET_OPT = cli_option("--use-replication-network",
                              dest="use_replication_network",
                              help="Whether to use the replication network"
                              " for talking to the nodes",
                              action="store_true", default=False)

982
983
984
985
986
987
988
MAINTAIN_NODE_HEALTH_OPT = \
    cli_option("--maintain-node-health", dest="maintain_node_health",
               metavar=_YORNO, default=None, type="bool",
               help="Configure the cluster to automatically maintain node"
               " health, by shutting down unknown instances, shutting down"
               " unknown DRBD devices, etc.")

989
990
991
992
993
994
995
IDENTIFY_DEFAULTS_OPT = \
    cli_option("--identify-defaults", dest="identify_defaults",
               default=False, action="store_true",
               help="Identify which saved instance parameters are equal to"
               " the current cluster defaults and set them as such, instead"
               " of marking them as overridden")

996
997
998
999
1000
UIDPOOL_OPT = cli_option("--uid-pool", default=None,
                         action="store", dest="uid_pool",
                         help=("A list of user-ids or user-id"
                               " ranges separated by commas"))

1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
ADD_UIDS_OPT = cli_option("--add-uids", default=None,
                          action="store", dest="add_uids",
                          help=("A list of user-ids or user-id"
                                " ranges separated by commas, to be"
                                " added to the user-id pool"))

REMOVE_UIDS_OPT = cli_option("--remove-uids", default=None,
                             action="store", dest="remove_uids",
                             help=("A list of user-ids or user-id"
                                   " ranges separated by commas, to be"
                                   " removed from the user-id pool"))

1013
1014
1015
1016
1017
1018
RESERVED_LVS_OPT = cli_option("--reserved-lvs", default=None,
                             action="store", dest="reserved_lvs",
                             help=("A comma-separated list of reserved"
                                   " logical volumes names, that will be"
                                   " ignored by cluster verify"))

1019
1020
1021
1022
1023
ROMAN_OPT = cli_option("--roman",
                       dest="roman_integers", default=False,
                       action="store_true",
                       help="Use roman numbers for positive integers")

1024
1025
1026
1027
1028
1029
1030
DRBD_HELPER_OPT = cli_option("--drbd-usermode-helper", dest="drbd_helper",
                             action="store", default=None,
                             help="Specifies usermode helper for DRBD")

NODRBD_STORAGE_OPT = cli_option("--no-drbd-storage", dest="drbd_storage",
                                action="store_false", default=True,
                                help="Disable support for DRBD")
1031

1032
1033
1034
#: Options provided by all commands
COMMON_OPTS = [DEBUG_OPT]

1035

1036
def _ParseArgs(argv, commands, aliases):
Iustin Pop's avatar
Iustin Pop committed
1037
  """Parser for the command line arguments.
Iustin Pop's avatar
Iustin Pop committed
1038

Michael Hanselmann's avatar
Michael Hanselmann committed
1039
  This function parses the arguments and returns the function which
Iustin Pop's avatar
Iustin Pop committed
1040
  must be executed together with its (modified) arguments.
Iustin Pop's avatar
Iustin Pop committed
1041

Iustin Pop's avatar
Iustin Pop committed
1042
1043
1044
1045
  @param argv: the command line
  @param commands: dictionary with special contents, see the design
      doc for cmdline handling
  @param aliases: dictionary with command aliases {'alias': 'target, ...}
1046

Iustin Pop's avatar
Iustin Pop committed
1047
1048
1049
1050
1051
1052
1053
  """
  if len(argv) == 0:
    binary = "<command>"
  else:
    binary = argv[0].split("/")[-1]

  if len(argv) > 1 and argv[1] == "--version":
1054
1055
    ToStdout("%s (ganeti %s) %s", binary, constants.VCS_VERSION,
             constants.RELEASE_VERSION)
Iustin Pop's avatar
Iustin Pop committed
1056
1057
1058
1059
    # Quit right away. That way we don't have to care about this special
    # argument. optparse.py does it the same.
    sys.exit(0)

1060
  if len(argv) < 2 or not (argv[1] in commands or
Guido Trotter's avatar
Guido Trotter committed
1061
                           argv[1] in aliases):
Iustin Pop's avatar
Iustin Pop committed
1062
1063
1064
    # let's do a nice thing
    sortedcmds = commands.keys()
    sortedcmds.sort()
1065
1066
1067
1068
1069

    ToStdout("Usage: %s {command} [options...] [argument...]", binary)
    ToStdout("%s <command> --help to see details, or man %s", binary, binary)
    ToStdout("")

Iustin Pop's avatar
Iustin Pop committed
1070
    # compute the max line length for cmd + usage
1071
    mlen = max([len(" %s" % cmd) for cmd in commands])
Iustin Pop's avatar
Iustin Pop committed
1072
    mlen = min(60, mlen) # should not get here...
1073

Iustin Pop's avatar
Iustin Pop committed
1074
    # and format a nice command list
1075
    ToStdout("Commands:")
Iustin Pop's avatar
Iustin Pop committed
1076
    for cmd in sortedcmds:
1077
      cmdstr = " %s" % (cmd,)
1078
      help_text = commands[cmd][4]
1079
1080
      help_lines = textwrap.wrap(help_text, 79 - 3 - mlen)
      ToStdout("%-*s - %s", mlen, cmdstr, help_lines.pop(0))
Iustin Pop's avatar
Iustin Pop committed
1081
      for line in help_lines:
1082
1083
1084
1085
        ToStdout("%-*s   %s", mlen, "", line)

    ToStdout("")

Iustin Pop's avatar
Iustin Pop committed
1086
    return None, None, None
1087
1088

  # get command, unalias it, and look it up in commands
Iustin Pop's avatar
Iustin Pop committed
1089
  cmd = argv.pop(1)
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
  if cmd in aliases:
    if cmd in commands:
      raise errors.ProgrammerError("Alias '%s' overrides an existing"
                                   " command" % cmd)

    if aliases[cmd] not in commands:
      raise errors.ProgrammerError("Alias '%s' maps to non-existing"
                                   " command '%s'" % (cmd, aliases[cmd]))

    cmd = aliases[cmd]

1101
  func, args_def, parser_opts, usage, description = commands[cmd]
1102
  parser = OptionParser(option_list=parser_opts + COMMON_OPTS,
Iustin Pop's avatar
Iustin Pop committed
1103
1104
1105
1106
1107
                        description=description,
                        formatter=TitledHelpFormatter(),
                        usage="%%prog %s %s" % (cmd, usage))
  parser.disable_interspersed_args()
  options, args = parser.parse_args()
1108
1109

  if not _CheckArguments(cmd, args_def, args):
Iustin Pop's avatar
Iustin Pop committed
1110
1111
1112
1113
1114
    return None, None, None

  return func, options, args


1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
def _CheckArguments(cmd, args_def, args):
  """Verifies the arguments using the argument definition.

  Algorithm:

    1. Abort with error if values specified by user but none expected.

    1. For each argument in definition

      1. Keep running count of minimum number of values (min_count)
      1. Keep running count of maximum number of values (max_count)
      1. If it has an unlimited number of values

        1. Abort with error if it's not the last argument in the definition

    1. If last argument has limited number of values

      1. Abort with error if number of values doesn't match or is too large

    1. Abort with error if user didn't pass enough values (min_count)

  """
  if args and not args_def:
    ToStderr("Error: Command %s expects no arguments", cmd)
    return False

  min_count = None
  max_count = None
  check_max = None

  last_idx = len(args_def) - 1

  for idx, arg in enumerate(args_def):
    if min_count is None:
      min_count = arg.min
    elif arg.min is not None:
      min_count += arg.min

    if max_count is None:
      max_count = arg.max
    elif arg.max is not None:
      max_count += arg.max

    if idx == last_idx:
      check_max = (arg.max is not None)

    elif arg.max is None:
      raise errors.ProgrammerError("Only the last argument can have max=None")

  if check_max:
    # Command with exact number of arguments
    if (min_count is not None and max_count is not None and
        min_count == max_count and len(args) != min_count):
      ToStderr("Error: Command %s expects %d argument(s)", cmd, min_count)
      return False

    # Command with limited number of arguments
    if max_count is not None and len(args) > max_count:
      ToStderr("Error: Command %s expects only %d argument(s)",
               cmd, max_count)
      return False

  # Command with some required arguments
  if min_count is not None and len(args) < min_count:
    ToStderr("Error: Command %s expects at least %d argument(s)",
             cmd, min_count)
    return False

  return True


1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
def SplitNodeOption(value):
  """Splits the value of a --node option.

  """
  if value and ':' in value:
    return value.split(':', 1)
  else:
    return (value, None)


Guido Trotter's avatar
Guido Trotter committed
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
def CalculateOSNames(os_name, os_variants):
  """Calculates all the names an OS can be called, according to its variants.

  @type os_name: string
  @param os_name: base name of the os
  @type os_variants: list or None
  @param os_variants: list of supported variants
  @rtype: list
  @return: list of valid names

  """
  if os_variants:
    return ['%s+%s' % (os_name, v) for v in os_variants]
  else:
    return [os_name]


1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
def ParseFields(selected, default):
  """Parses the values of "--field"-like options.

  @type selected: string or None
  @param selected: User-selected options
  @type default: list
  @param default: Default fields

  """
  if selected is None:
    return default

  if selected.startswith("+"):
    return default + selected[1:].split(",")

  return selected.split(",")


1231
UsesRPC = rpc.RunWithRPC
1232
1233


1234
1235
def AskUser(text, choices=None):
  """Ask the user a question.
Iustin Pop's avatar
Iustin Pop committed
1236

Iustin Pop's avatar
Iustin Pop committed
1237
  @param text: the question to ask
Iustin Pop's avatar
Iustin Pop committed
1238

Iustin Pop's avatar
Iustin Pop committed
1239
1240
1241
1242
  @param choices: list with elements tuples (input_char, return_value,
      description); if not given, it will default to: [('y', True,
      'Perform the operation'), ('n', False, 'Do no do the operation')];
      note that the '?' char is reserved for help
1243

Iustin Pop's avatar
Iustin Pop committed
1244
1245
1246
  @return: one of the return values from the choices list; if input is
      not possible (i.e. not running with a tty, we return the last
      entry from the list
Iustin Pop's avatar
Iustin Pop committed
1247
1248

  """
1249
1250
1251
1252
  if choices is None:
    choices = [('y', True, 'Perform the operation'),
               ('n', False, 'Do not perform the operation')]
  if not choices or not isinstance(choices, list):
Michael Hanselmann's avatar
Michael Hanselmann committed
1253
    raise errors.ProgrammerError("Invalid choices argument to AskUser")
1254
1255
  for entry in choices:
    if not isinstance(entry, tuple) or len(entry) < 3 or entry[0] == '?':
Michael Hanselmann's avatar
Michael Hanselmann committed
1256
      raise errors.ProgrammerError("Invalid choices element to AskUser")
1257
1258
1259
1260
1261
1262

  answer = choices[-1][1]
  new_text = []
  for line in text.splitlines():
    new_text.append(textwrap.fill(line, 70, replace_whitespace=False))
  text = "\n".join(new_text)
Iustin Pop's avatar
Iustin Pop committed
1263
  try:
1264
    f = file("/dev/tty", "a+")
Iustin Pop's avatar
Iustin Pop committed
1265
  except IOError:
1266
    return answer
Iustin Pop's avatar
Iustin Pop committed
1267
  try:
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
    chars = [entry[0] for entry in choices]
    chars[-1] = "[%s]" % chars[-1]
    chars.append('?')
    maps = dict([(entry[0], entry[1]) for entry in choices])
    while True:
      f.write(text)
      f.write('\n')
      f.write("/".join(chars))
      f