cli.py 60.8 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
#

# Copyright (C) 2006, 2007 Google Inc.
#
# 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
Iustin Pop's avatar
Iustin Pop committed
39

40
from optparse import (OptionParser, TitledHelpFormatter,
Iustin Pop's avatar
Iustin Pop committed
41
                      Option, OptionValueError)
Iustin Pop's avatar
Iustin Pop committed
42

43

44
45
__all__ = [
  # Command line options
46
  "ALLOCATABLE_OPT",
47
  "ALL_OPT",
48
  "AUTO_PROMOTE_OPT",
49
  "AUTO_REPLACE_OPT",
50
  "BACKEND_OPT",
51
  "CLEANUP_OPT",
52
  "CONFIRM_OPT",
53
  "CP_SIZE_OPT",
54
  "DEBUG_OPT",
55
  "DEBUG_SIMERR_OPT",
56
  "DISKIDX_OPT",
57
  "DISK_OPT",
58
  "DISK_TEMPLATE_OPT",
59
  "DRAINED_OPT",
60
  "EARLY_RELEASE_OPT",
61
  "ENABLED_HV_OPT",
62
  "ERROR_CODES_OPT",
63
  "FIELDS_OPT",
64
  "FILESTORE_DIR_OPT",
65
  "FILESTORE_DRIVER_OPT",
66
67
  "FORCE_OPT",
  "FORCE_VARIANT_OPT",
68
  "GLOBAL_FILEDIR_OPT",
69
  "HVLIST_OPT",
70
  "HVOPTS_OPT",
71
  "HYPERVISOR_OPT",
72
  "IALLOCATOR_OPT",
73
  "IGNORE_CONSIST_OPT",
74
  "IGNORE_FAILURES_OPT",
75
  "IGNORE_SECONDARIES_OPT",
76
  "IGNORE_SIZE_OPT",
77
  "MAC_PREFIX_OPT",
78
  "MASTER_NETDEV_OPT",
79
  "MC_OPT",
Iustin Pop's avatar
Iustin Pop committed
80
  "NET_OPT",
81
  "NEW_SECONDARY_OPT",
82
  "NIC_PARAMS_OPT",
83
  "NODE_LIST_OPT",
84
  "NODE_PLACEMENT_OPT",
85
  "NOHDR_OPT",
86
  "NOIPCHECK_OPT",
87
  "NONAMECHECK_OPT",
88
  "NOLVM_STORAGE_OPT",
89
  "NOMODIFY_ETCHOSTS_OPT",
90
  "NOMODIFY_SSH_SETUP_OPT",
Iustin Pop's avatar
Iustin Pop committed
91
  "NONICS_OPT",
Iustin Pop's avatar
Iustin Pop committed
92
  "NONLIVE_OPT",
93
  "NONPLUS1_OPT",
94
  "NOSHUTDOWN_OPT",
95
  "NOSTART_OPT",
96
  "NOSSH_KEYCHECK_OPT",
97
  "NOVOTING_OPT",
98
  "NWSYNC_OPT",
99
  "ON_PRIMARY_OPT",
100
  "ON_SECONDARY_OPT",
101
  "OFFLINE_OPT",
Iustin Pop's avatar
Iustin Pop committed
102
  "OS_OPT",
Iustin Pop's avatar
Iustin Pop committed
103
  "OS_SIZE_OPT",
104
  "READD_OPT",
105
  "REBOOT_TYPE_OPT",
106
  "SECONDARY_IP_OPT",
107
  "SELECT_OS_OPT",
108
  "SEP_OPT",
109
  "SHOWCMD_OPT",
Guido Trotter's avatar
Guido Trotter committed
110
  "SHUTDOWN_TIMEOUT_OPT",
111
  "SINGLE_NODE_OPT",
112
113
  "SRC_DIR_OPT",
  "SRC_NODE_OPT",
114
  "SUBMIT_OPT",
115
  "STATIC_OPT",
116
117
  "SYNC_OPT",
  "TAG_SRC_OPT",
Guido Trotter's avatar
Guido Trotter committed
118
  "TIMEOUT_OPT",
119
  "USEUNITS_OPT",
120
  "VERBOSE_OPT",
Iustin Pop's avatar
Iustin Pop committed
121
  "VG_NAME_OPT",
122
  "YES_DOIT_OPT",
123
124
  # Generic functions for CLI programs
  "GenericMain",
Iustin Pop's avatar
Iustin Pop committed
125
  "GenericInstanceCreate",
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
  "GetClient",
  "GetOnlineNodes",
  "JobExecutor",
  "JobSubmittedException",
  "ParseTimespec",
  "SubmitOpCode",
  "SubmitOrSend",
  "UsesRPC",
  # Formatting functions
  "ToStderr", "ToStdout",
  "FormatError",
  "GenerateTable",
  "AskUser",
  "FormatTimestamp",
  # Tags functions
  "ListTags",
  "AddTags",
  "RemoveTags",
  # command line options support infrastructure
  "ARGS_MANY_INSTANCES",
  "ARGS_MANY_NODES",
  "ARGS_NONE",
  "ARGS_ONE_INSTANCE",
  "ARGS_ONE_NODE",
150
  "ARGS_ONE_OS",
151
152
153
154
155
156
157
  "ArgChoice",
  "ArgCommand",
  "ArgFile",
  "ArgHost",
  "ArgInstance",
  "ArgJobId",
  "ArgNode",
158
  "ArgOs",
159
160
161
162
163
164
165
166
167
168
  "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
169
  "CalculateOSNames",
170
  ]
171

172
173
NO_PREFIX = "no_"
UN_PREFIX = "-"
174

175

176
class _Argument:
Iustin Pop's avatar
Iustin Pop committed
177
  def __init__(self, min=0, max=None): # pylint: disable-msg=W0622
178
179
180
181
182
183
184
185
186
187
188
189
190
191
    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
192
  # pylint: disable-msg=W0622
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
  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
246
247
248
249
250
251
class ArgHost(_Argument):
  """Host argument.

  """


252
253
254
255
256
257
class ArgOs(_Argument):
  """OS argument.

  """


258
259
260
261
262
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)]
263
ARGS_ONE_OS = [ArgOs(min=1, max=1)]
264
265


266
267
268
269
270
271
272
273
274
275
276
277
278
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
279
      raise errors.OpPrereqError("no arguments passed to the command")
280
281
282
283
284
285
286
    name = args.pop(0)
    retval = kind, name
  else:
    raise errors.ProgrammerError("Unhandled tag type '%s'" % kind)
  return retval


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
315
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)


316
317
318
319
320
321
322
323
324
325
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
326
327
  cl = GetClient()
  result = cl.QueryTags(kind, name)
328
329
330
  result = list(result)
  result.sort()
  for tag in result:
331
    ToStdout(tag)
332
333
334
335
336
337
338
339
340
341
342
343


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)
344
  _ExtendTags(opts, args)
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
  if not args:
    raise errors.OpPrereqError("No tags to be added")
  op = opcodes.OpAddTags(kind=kind, name=name, tags=args)
  SubmitOpCode(op)


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)
361
  _ExtendTags(opts, args)
362
363
364
365
366
  if not args:
    raise errors.OpPrereqError("No tags to be removed")
  op = opcodes.OpDelTags(kind=kind, name=name, tags=args)
  SubmitOpCode(op)

Iustin Pop's avatar
Iustin Pop committed
367

368
def check_unit(option, opt, value): # pylint: disable-msg=W0613
Iustin Pop's avatar
Iustin Pop committed
369
370
371
  """OptParsers custom converter for units.

  """
Iustin Pop's avatar
Iustin Pop committed
372
373
374
  try:
    return utils.ParseUnit(value)
  except errors.UnitParseError, err:
375
    raise OptionValueError("option %s: %s" % (opt, err))
Iustin Pop's avatar
Iustin Pop committed
376
377


378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
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 = {}
397
  if data:
398
    for elem in utils.UnescapeAndSplit(data, sep=","):
399
400
      if "=" in elem:
        key, val = elem.split("=", 1)
401
      else:
402
403
404
405
406
407
408
409
410
411
        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
412
413
414
  return kv_dict


415
def check_ident_key_val(option, opt, value):  # pylint: disable-msg=W0613
416
417
418
419
  """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.
420
421
422

  """
  if ":" not in value:
423
    ident, rest = value, ''
424
425
  else:
    ident, rest = value.split(":", 1)
426
427
428
429
430
431
432
433
434
435
436
437

  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:
438
439
440
441
442
    kv_dict = _SplitKeyVal(opt, rest)
    retval = (ident, kv_dict)
  return retval


443
def check_key_val(option, opt, value):  # pylint: disable-msg=W0613
444
445
446
  """Custom parser class for key=val,key=val options.

  This will store the parsed values as a dict {key: val}.
447
448
449
450
451

  """
  return _SplitKeyVal(opt, value)


452
453
454
455
456
457
# 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,
458
459
 OPT_COMPL_ONE_IALLOCATOR,
 OPT_COMPL_INST_ADD_NODES) = range(100, 106)
460
461
462
463
464
465
466

OPT_COMPL_ALL = frozenset([
  OPT_COMPL_MANY_NODES,
  OPT_COMPL_ONE_NODE,
  OPT_COMPL_ONE_INSTANCE,
  OPT_COMPL_ONE_OS,
  OPT_COMPL_ONE_IALLOCATOR,
467
  OPT_COMPL_INST_ADD_NODES,
468
469
470
  ])


471
472
class CliOption(Option):
  """Custom option class for optparse.
473
474

  """
475
476
477
  ATTRS = Option.ATTRS + [
    "completion_suggest",
    ]
478
479
480
481
482
483
484
  TYPES = Option.TYPES + (
    "identkeyval",
    "keyval",
    "unit",
    )
  TYPE_CHECKER = Option.TYPE_CHECKER.copy()
  TYPE_CHECKER["identkeyval"] = check_ident_key_val
485
  TYPE_CHECKER["keyval"] = check_key_val
486
  TYPE_CHECKER["unit"] = check_unit
487
488


Iustin Pop's avatar
Iustin Pop committed
489
490
491
492
# optparse.py sets make_option, so we do it for our own option class, too
cli_option = CliOption


493
494
495
_YESNO = ("yes", "no")
_YORNO = "yes|no"

496
497
DEBUG_OPT = cli_option("-d", "--debug", default=0, action="count",
                       help="Increase debugging level")
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540

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"))

_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"))

541
542
543
544
VERBOSE_OPT = cli_option("-v", "--verbose", default=False,
                         action="store_true",
                         help="Increase the verbosity of the operation")

545
546
547
548
549
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")

550
551
552
553
NWSYNC_OPT = cli_option("--no-wait-for-sync", dest="wait_for_sync",
                        default=True, action="store_false",
                        help="Don't wait for sync (DANGEROUS!)")

554
555
556
557
558
559
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
560
561
562
563
NONICS_OPT = cli_option("--no-nics", default=False, action="store_true",
                        help="Do not create any network cards for"
                        " the instance")

564
565
566
567
568
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>")

569
570
571
572
573
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))

574
575
576
577
578
579
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)

Iustin Pop's avatar
Iustin Pop committed
580
581
582
583
OS_OPT = cli_option("-o", "--os-type", dest="os", help="What OS to run",
                    metavar="<os>",
                    completion_suggest=OPT_COMPL_ONE_OS)

584
585
586
587
FORCE_VARIANT_OPT = cli_option("--force-variant", dest="force_variant",
                               action="store_true", default=False,
                               help="Force an unknown variant")

588
589
590
BACKEND_OPT = cli_option("-B", "--backend-parameters", dest="beparams",
                         type="keyval", default={},
                         help="Backend parameters")
591
592
593
594

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

596
597
598
599
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")
600
601
602
603
604

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")
605

606
607
608
609
610
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")

611
612
613
614
615
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
616
617
618
NET_OPT = cli_option("--net",
                     help="NIC parameters", default=[],
                     dest="nics", action="append", type="identkeyval")
619
620
621

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

623
624
625
626
627
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
628
629
630
631
632
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>")

633
634
635
636
637
638
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
639
640
641
642
643
644
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)")

645
646
647
648
649
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)

650
651
652
653
654
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)
655
656
657
658

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

660
661
662
663
NOSTART_OPT = cli_option("--no-start", dest="start", default=True,
                         action="store_false",
                         help="Don't start the instance after creation")

664
665
666
667
SHOWCMD_OPT = cli_option("--show-cmd", dest="show_command",
                         action="store_true", default=False,
                         help="Show command instead of executing it")

668
669
670
671
672
673
674
675
676
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")

677
678
679
680
STATIC_OPT = cli_option("-s", "--static", dest="static",
                        action="store_true", default=False,
                        help="Only show configuration data, not runtime data")

681
682
683
684
685
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")

686
687
688
689
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")
690

691
692
693
694
695
696
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")

697
698
699
700
701
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)

702
703
704
705
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)")
706
707
708
709
710

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)")
711

712
713
714
715
716
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")

717
718
719
720
AUTO_REPLACE_OPT = cli_option("-a", "--auto", dest="auto",
                              default=False, action="store_true",
                              help="Automatically replace faulty disks"
                              " (only for the drbd template)")
721

722
723
724
725
726
727
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)")

728
729
730
731
732
733
734
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>")

735
736
737
738
SECONDARY_IP_OPT = cli_option("-s", "--secondary-ip", dest="secondary_ip",
                              help="Specify the secondary ip for the node",
                              metavar="ADDRESS", default=None)

739
740
741
742
READD_OPT = cli_option("--readd", dest="readd",
                       default=False, action="store_true",
                       help="Readd old node after replacing it")

743
744
745
746
NOSSH_KEYCHECK_OPT = cli_option("--no-ssh-key-check", dest="ssh_key_check",
                                default=True, action="store_false",
                                help="Disable SSH key fingerprint checking")

747

748
749
750
751
752
753
754
755
756
757
758
759
MC_OPT = cli_option("-C", "--master-candidate", dest="master_candidate",
                    choices=_YESNO, default=None, metavar=_YORNO,
                    help="Set the master_candidate flag on the node")

OFFLINE_OPT = cli_option("-O", "--offline", dest="offline", metavar=_YORNO,
                         choices=_YESNO, default=None,
                         help="Set the offline flag on the node")

DRAINED_OPT = cli_option("-D", "--drained", dest="drained", metavar=_YORNO,
                         choices=_YESNO, default=None,
                         help="Set the drained flag on the node")

760
761
762
763
ALLOCATABLE_OPT = cli_option("--allocatable", dest="allocatable",
                             choices=_YESNO, default=None, metavar=_YORNO,
                             help="Set the allocatable flag on a volume")

764
765
766
767
768
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)

769
770
771
772
773
ENABLED_HV_OPT = cli_option("--enabled-hypervisors",
                            dest="enabled_hypervisors",
                            help="Comma-separated list of hypervisors",
                            type="string", default=None)

774
775
776
777
NIC_PARAMS_OPT = cli_option("-N", "--nic-parameters", dest="nicparams",
                            type="keyval", default={},
                            help="NIC parameters")

778
779
780
781
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
782
783
784
785
786
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)

787
788
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
789

790
791
792
793
NOVOTING_OPT = cli_option("--no-voting", dest="no_voting",
                          help="Skip node agreement check (dangerous)",
                          action="store_true", default=False)

794
795
796
797
798
799
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)

800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
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)

819
820
821
822
NOMODIFY_SSH_SETUP_OPT = cli_option("--no-ssh-init", dest="modify_ssh_setup",
                                    help="Don't initialize SSH keys",
                                    action="store_false", default=True)

823
824
825
826
827
828
829
830
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)

831
832
833
834
835
836
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))

837
838
839
840
841
IGNORE_SECONDARIES_OPT = cli_option("--ignore-secondaries",
                                    dest="ignore_secondaries",
                                    default=False, action="store_true",
                                    help="Ignore errors from secondaries")

842
NOSHUTDOWN_OPT = cli_option("--noshutdown", dest="shutdown",
843
844
845
                            action="store_false", default=True,
                            help="Don't shutdown the instance (unsafe)")

Guido Trotter's avatar
Guido Trotter committed
846
847
848
TIMEOUT_OPT = cli_option("--timeout", dest="timeout", type="int",
                         default=constants.DEFAULT_SHUTDOWN_TIMEOUT,
                         help="Maximum time to wait")
849

850
851
SHUTDOWN_TIMEOUT_OPT = cli_option("--shutdown-timeout",
                         dest="shutdown_timeout", type="int",
Guido Trotter's avatar
Guido Trotter committed
852
853
854
                         default=constants.DEFAULT_SHUTDOWN_TIMEOUT,
                         help="Maximum time to wait for instance shutdown")

855
856
857
858
859
860
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")

861

862
def _ParseArgs(argv, commands, aliases):
Iustin Pop's avatar
Iustin Pop committed
863
  """Parser for the command line arguments.
Iustin Pop's avatar
Iustin Pop committed
864

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

Iustin Pop's avatar
Iustin Pop committed
868
869
870
871
  @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, ...}
872

Iustin Pop's avatar
Iustin Pop committed
873
874
875
876
877
878
879
  """
  if len(argv) == 0:
    binary = "<command>"
  else:
    binary = argv[0].split("/")[-1]

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

885
  if len(argv) < 2 or not (argv[1] in commands or
Guido Trotter's avatar
Guido Trotter committed
886
                           argv[1] in aliases):
Iustin Pop's avatar
Iustin Pop committed
887
888
889
    # let's do a nice thing
    sortedcmds = commands.keys()
    sortedcmds.sort()
890
891
892
893
894

    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
895
    # compute the max line length for cmd + usage
896
    mlen = max([len(" %s" % cmd) for cmd in commands])
Iustin Pop's avatar
Iustin Pop committed
897
    mlen = min(60, mlen) # should not get here...
898

Iustin Pop's avatar
Iustin Pop committed
899
    # and format a nice command list
900
    ToStdout("Commands:")
Iustin Pop's avatar
Iustin Pop committed
901
    for cmd in sortedcmds:
902
      cmdstr = " %s" % (cmd,)
903
      help_text = commands[cmd][4]
904
905
      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
906
      for line in help_lines:
907
908
909
910
        ToStdout("%-*s   %s", mlen, "", line)

    ToStdout("")

Iustin Pop's avatar
Iustin Pop committed
911
    return None, None, None
912
913

  # get command, unalias it, and look it up in commands
Iustin Pop's avatar
Iustin Pop committed
914
  cmd = argv.pop(1)
915
916
917
918
919
920
921
922
923
924
925
  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]

926
  func, args_def, parser_opts, usage, description = commands[cmd]
927
  parser = OptionParser(option_list=parser_opts + [_DRY_RUN_OPT, DEBUG_OPT],
Iustin Pop's avatar
Iustin Pop committed
928
929
930
931
932
                        description=description,
                        formatter=TitledHelpFormatter(),
                        usage="%%prog %s %s" % (cmd, usage))
  parser.disable_interspersed_args()
  options, args = parser.parse_args()
933
934

  if not _CheckArguments(cmd, args_def, args):
Iustin Pop's avatar
Iustin Pop committed
935
936
937
938
939
    return None, None, None

  return func, options, args


940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
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


1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
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
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
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]


1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
def UsesRPC(fn):
  def wrapper(*args, **kwargs):
    rpc.Init()
    try:
      return fn(*args, **kwargs)
    finally:
      rpc.Shutdown()
  return wrapper


1048
1049
def AskUser(text, choices=None):
  """Ask the user a question.
Iustin Pop's avatar
Iustin Pop committed
1050

Iustin Pop's avatar
Iustin Pop committed
1051
  @param text: the question to ask
Iustin Pop's avatar
Iustin Pop committed
1052

Iustin Pop's avatar
Iustin Pop committed
1053
1054
1055
1056
  @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
1057

Iustin Pop's avatar
Iustin Pop committed
1058
1059
1060
  @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
1061
1062

  """
1063
1064
1065
1066
  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
1067
    raise errors.ProgrammerError("Invalid choices argument to AskUser")
1068
1069
  for entry in choices:
    if not isinstance(entry, tuple) or len(entry) < 3 or entry[0] == '?':
Michael Hanselmann's avatar
Michael Hanselmann committed
1070
      raise errors.ProgrammerError("Invalid choices element to AskUser")
1071
1072
1073
1074
1075
1076

  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
1077
  try:
1078
    f = file("/dev/tty", "a+")
Iustin Pop's avatar
Iustin Pop committed
1079
  except IOError:
1080
    return answer
Iustin Pop's avatar
Iustin Pop committed
1081
  try:
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
    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.write(": ")
      line = f.readline(2).strip().lower()
      if line in maps:
        answer = maps[line]
        break
      elif line == '?':
        for entry in choices:
          f.write(" %s - %s\n" % (entry[0], entry[2]))
        f.write("\n")
        continue
Iustin Pop's avatar
Iustin Pop committed
1100
1101
1102
1103
1104
  finally:
    f.close()
  return answer


1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
class JobSubmittedException(Exception):
  """Job was submitted, client should exit.

  This exception has one argument, the ID of the job that was
  submitted. The handler should print this ID.

  This is not an error, just a structured way to exit from clients.

  """


1116
1117
def SendJob(ops, cl=None):
  """Function to submit an opcode without waiting for the results.
Iustin Pop's avatar
Iustin Pop committed
1118

1119
1120
1121
1122
1123
  @type ops: list
  @param ops: list of opcodes
  @type cl: luxi.Client
  @param cl: the luxi client to use for communicating with the master;
             if None, a new client will be created
Iustin Pop's avatar
Iustin Pop committed
1124
1125

  """
Iustin Pop's avatar
Iustin Pop committed
1126
  if cl is None:
1127
    cl = GetClient()
1128

1129
1130
1131
1132
1133
  job_id = cl.SubmitJob(ops)

  return job_id


Michael Hanselmann's avatar
Michael Hanselmann committed
1134
def PollJob(job_id, cl=None, feedback_fn=None):
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
  """Function to poll for the result of a job.

  @type job_id: job identified
  @param job_id: the job to poll for results
  @type cl: luxi.Client
  @param cl: the luxi client to use for communicating with the master;
             if None, a new client will be created

  """
  if cl is None:
    cl = GetClient()
1146

1147
1148
1149
  prev_job_info = None
  prev_logmsg_serial = None

1150
1151
1152
1153
1154
  status = None

  notified_queued = False
  notified_waitlock = False

1155
  while True:
1156
1157
    result = cl.WaitForJobChangeOnce(job_id, ["status"], prev_job_info,
                                     prev_logmsg_serial)
1158
    if not result:
1159
      # job not found, go away!
1160
      raise errors.JobLost("Job with id %s lost" % job_id)
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
    elif result == constants.JOB_NOTCHANGED:
      if status is not None and not callable(feedback_fn):
        if status == constants.JOB_STATUS_QUEUED and not notified_queued:
          ToStderr("Job %s is waiting in queue", job_id)
          notified_queued = True
        elif status == constants.JOB_STATUS_WAITLOCK and not notified_waitlock:
          ToStderr("Job %s is trying to acquire all necessary locks", job_id)
          notified_waitlock = True

      # Wait again
      continue
1172

1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
    # Split result, a tuple of (field values, log entries)
    (job_info, log_entries) = result
    (status, ) = job_info

    if log_entries:
      for log_entry in log_entries:
        (serial, timestamp, _, message) = log_entry
        if callable(feedback_fn):
          feedback_fn(log_entry[1:])
        else:
1183
          encoded = utils.SafeEncode(message)
1184
          ToStdout("%s %s", time.ctime(utils.MergeTime(timestamp)), encoded)
1185
1186
        prev_logmsg_serial = max(prev_logmsg_serial, serial)

1187
    # TODO: Handle canceled and archived jobs
1188
1189
1190
1191
    elif status in (constants.JOB_STATUS_SUCCESS,
                    constants.JOB_STATUS_ERROR,
                    constants.JOB_STATUS_CANCELING,
                    constants.JOB_STATUS_CANCELED):
1192
      break
1193
1194

    prev_job_info = job_info
1195

1196
  jobs = cl.QueryJobs([job_id], ["status", "opstatus", "opresult"])
1197
1198
  if not jobs:
    raise errors.JobLost("Job with id %s lost" % job_id)
1199

1200
  status, opstatus, result = jobs[0]
1201
  if status == constants.JOB_STATUS_SUCCESS:
1202
    return result
1203
1204
1205
  elif status in (constants.JOB_STATUS_CANCELING,
                  constants.JOB_STATUS_CANCELED):
    raise errors.OpExecError("Job was canceled")
1206
  else:
1207
1208
1209
1210
1211
    has_ok = False
    for idx, (status, msg) in enumerate(zip(opstatus, result)):
      if status == constants.OP_STATUS_SUCCESS:
        has_ok = True
      elif status == constants.OP_STATUS_ERROR:
1212
        errors.MaybeRaise(msg)
1213
1214
1215
1216
1217
1218
        if has_ok:
          raise errors.OpExecError("partial failure (opcode %d): %s" %
                                   (idx, msg))
        else:
          raise errors.OpExecError(str(msg))
    # default failure mode
1219
    raise errors.OpExecError(result)
Iustin Pop's avatar
Iustin Pop committed
1220
1221


1222
def SubmitOpCode(op, cl=None, feedback_fn=None, opts=None):
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
  """Legacy function to submit an opcode.

  This is just a simple wrapper over the construction of the processor
  instance. It should be extended to better handle feedback and
  interaction functions.

  """
  if cl is None:
    cl = GetClient()

1233
1234
  SetGenericOpcodeOpts([op], opts)

1235
1236
  job_id = SendJob([op], cl)

1237
1238
1239
  op_results = PollJob(job_id, cl=cl, feedback_fn=feedback_fn)

  return op_results[0]
1240
1241


1242
1243
1244
1245
1246
1247
1248
1249
def SubmitOrSend(op, opts, cl=None, feedback_fn=None):
  """Wrapper around SubmitOpCode or SendJob.

  This function will decide, based on the 'opts' parameter, whether to
  submit and wait for the result of the opcode (and return it), or
  whether to just send the job and print its identifier. It is used in
  order to simplify the implementation of the '--submit' option.

1250
1251
  It will also process the opcodes if we're sending the via SendJob
  (otherwise SubmitOpCode does it).
1252

1253
1254
  """
  if opts and opts.submit_only:
1255
1256
1257
    job = [op]
    SetGenericOpcodeOpts(job, opts)
    job_id = SendJob(job, cl=cl)
1258
    raise JobSubmittedException(job_id)
1259
  else:
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
    return SubmitOpCode(op, cl=cl, feedback_fn=feedback_fn, opts=opts)


def SetGenericOpcodeOpts(opcode_list, options):
  """Processor for generic options.

  This function updates the given opcodes based on generic command
  line options (like debug, dry-run, etc.).

  @param opcode_list: list of opcodes
  @param options: command line options or None
  @return: None (in-place modification)

  """
  if not options:
    return
  for op in opcode_list:
    op.dry_run = options.dry_run
    op.debug_level = options.debug
1279
1280


1281
1282
def GetClient():
  # TODO: Cache object?
1283
1284
1285
  try:
    client = luxi.Client()
  except luxi.NoMasterError:
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
    ss = ssconf.SimpleStore()

    # Try to read ssconf file
    try:
      ss.GetMasterNode()
    except errors.ConfigurationError:
      raise errors.OpPrereqError("Cluster not initialized or this machine is"
                                 " not part of a cluster")

    master, myself = ssconf.GetMasterAndMyself(ss=ss)
1296
1297
1298
1299
    if master != myself:
      raise errors.OpPrereqError("This is not the master node, please connect"
                                 " to node '%s' and rerun the command" %
                                 master)
1300
    raise
1301
  return client
1302
1303


1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
def FormatError(err):
  """Return a formatted error message for a given error.

  This function takes an exception instance and returns a tuple
  consisting of two values: first, the recommended exit code, and
  second, a string describing the error message (not
  newline-terminated).

  """
  retcode = 1
  obuf = StringIO()
1315
  msg = str(err)
1316
  if isinstance(err, errors.ConfigurationError):
1317
    txt = "Corrupt configuration file: %s" % msg
Iustin Pop's avatar
Iustin Pop committed
1318
    logging.error(txt)
1319
    obuf.write(txt + "\n")
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
    obuf.write("Aborting.")
    retcode = 2
  elif isinstance(err, errors.HooksAbort):
    obuf.write("Failure: hooks execution failed:\n")
    for node, script, out in err.args[0]:
      if out:
        obuf.write("  node: %s, script: %s, output: %s\n" %
                   (node, script, out))
      else:
        obuf.write("  node: %s, script: %s (no output)\n" %
                   (node, script))
  elif isinstance(err, errors.HooksFailure):
1332
    obuf.write("Failure: hooks general failure: %s" % msg)
1333
1334
1335
1336
1337
1338
1339
1340
  elif isinstance(err, errors.ResolverError):
    this_host = utils.HostInfo.SysName()
    if err.args[0] == this_host:
      msg = "Failure: can't resolve my own hostname ('%s')"
    else:
      msg = "Failure: can't resolve hostname '%s'"
    obuf.write(msg % err.args[0])
  elif isinstance(err, errors.OpPrereqError):
1341
1342
1343
1344
1345
1346
1347
    if len(err.args) == 2:
      obuf.write("Failure: prerequisites not met for this"
               " operation:\nerror type: %s, error details:\n%s" %
                 (err.args[1], err.args[0]))
    else:
      obuf.write("Failure: prerequisites not met for this"
                 " operation:\n%s" % msg)
1348
  elif isinstance(err, errors.OpExecError):
1349
    obuf.write("Failure: command execution error:\n%s" % msg)
1350
  elif isinstance(err, errors.TagError):