cli.py 39.7 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
28
#

# 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
import copy
29
import time
Iustin Pop's avatar
Iustin Pop committed
30
import logging
31
from cStringIO import StringIO
Iustin Pop's avatar
Iustin Pop committed
32
33
34
35

from ganeti import utils
from ganeti import errors
from ganeti import constants
36
from ganeti import opcodes
Iustin Pop's avatar
Iustin Pop committed
37
from ganeti import luxi
38
from ganeti import ssconf
39
from ganeti import rpc
Iustin Pop's avatar
Iustin Pop committed
40

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

44

45
46
__all__ = [
  # Command line options
47
  "BACKEND_OPT",
48
49
  "CONFIRM_OPT",
  "DEBUG_OPT",
50
  "DEBUG_SIMERR_OPT",
51
  "DISK_TEMPLATE_OPT",
52
  "FIELDS_OPT",
53
  "FILESTORE_DIR_OPT",
54
  "FILESTORE_DRIVER_OPT",
55
  "HVLIST_OPT",
56
  "HVOPTS_OPT",
57
  "HYPERVISOR_OPT",
58
  "IALLOCATOR_OPT",
59
  "FORCE_OPT",
Iustin Pop's avatar
Iustin Pop committed
60
  "NET_OPT",
61
  "NOHDR_OPT",
62
  "NOIPCHECK_OPT",
Iustin Pop's avatar
Iustin Pop committed
63
  "NONICS_OPT",
64
  "NWSYNC_OPT",
Iustin Pop's avatar
Iustin Pop committed
65
  "OS_OPT",
66
67
68
69
70
  "SEP_OPT",
  "SUBMIT_OPT",
  "SYNC_OPT",
  "TAG_SRC_OPT",
  "USEUNITS_OPT",
71
  "VERBOSE_OPT",
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
  # Generic functions for CLI programs
  "GenericMain",
  "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",
  "ArgChoice",
  "ArgCommand",
  "ArgFile",
  "ArgHost",
  "ArgInstance",
  "ArgJobId",
  "ArgNode",
  "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",
  ]
116

117
118
NO_PREFIX = "no_"
UN_PREFIX = "-"
119

120

121
class _Argument:
122
  def __init__(self, min=0, max=None):
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
    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.

  """
  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
190
191
192
193
194
195
class ArgHost(_Argument):
  """Host argument.

  """


196
197
198
199
200
201
202
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)]


203

204
205
206
207
208
209
210
211
212
213
214
215
216
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
217
      raise errors.OpPrereqError("no arguments passed to the command")
218
219
220
221
222
223
224
    name = args.pop(0)
    retval = kind, name
  else:
    raise errors.ProgrammerError("Unhandled tag type '%s'" % kind)
  return retval


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


254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
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)
  op = opcodes.OpGetTags(kind=kind, name=name)
  result = SubmitOpCode(op)
  result = list(result)
  result.sort()
  for tag in result:
269
    ToStdout(tag)
270
271
272
273
274
275
276
277
278
279
280
281


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)
282
  _ExtendTags(opts, args)
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
  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)
299
  _ExtendTags(opts, args)
300
301
302
303
304
  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
305
306

def check_unit(option, opt, value):
Iustin Pop's avatar
Iustin Pop committed
307
308
309
  """OptParsers custom converter for units.

  """
Iustin Pop's avatar
Iustin Pop committed
310
311
312
  try:
    return utils.ParseUnit(value)
  except errors.UnitParseError, err:
313
    raise OptionValueError("option %s: %s" % (opt, err))
Iustin Pop's avatar
Iustin Pop committed
314
315


316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
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 = {}
335
336
337
338
  if data:
    for elem in data.split(","):
      if "=" in elem:
        key, val = elem.split("=", 1)
339
      else:
340
341
342
343
344
345
346
347
348
349
        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
350
351
352
353
  return kv_dict


def check_ident_key_val(option, opt, value):
354
355
356
357
  """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.
358
359
360

  """
  if ":" not in value:
361
    ident, rest = value, ''
362
363
  else:
    ident, rest = value.split(":", 1)
364
365
366
367
368
369
370
371
372
373
374
375

  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:
376
377
378
379
380
381
    kv_dict = _SplitKeyVal(opt, rest)
    retval = (ident, kv_dict)
  return retval


def check_key_val(option, opt, value):
382
383
384
  """Custom parser class for key=val,key=val options.

  This will store the parsed values as a dict {key: val}.
385
386
387
388
389

  """
  return _SplitKeyVal(opt, value)


390
391
392
393
394
395
# 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,
396
397
 OPT_COMPL_ONE_IALLOCATOR,
 OPT_COMPL_INST_ADD_NODES) = range(100, 106)
398
399
400
401
402
403
404

OPT_COMPL_ALL = frozenset([
  OPT_COMPL_MANY_NODES,
  OPT_COMPL_ONE_NODE,
  OPT_COMPL_ONE_INSTANCE,
  OPT_COMPL_ONE_OS,
  OPT_COMPL_ONE_IALLOCATOR,
405
  OPT_COMPL_INST_ADD_NODES,
406
407
408
  ])


409
410
class CliOption(Option):
  """Custom option class for optparse.
411
412

  """
413
414
415
  ATTRS = Option.ATTRS + [
    "completion_suggest",
    ]
416
417
418
419
420
421
422
  TYPES = Option.TYPES + (
    "identkeyval",
    "keyval",
    "unit",
    )
  TYPE_CHECKER = Option.TYPE_CHECKER.copy()
  TYPE_CHECKER["identkeyval"] = check_ident_key_val
423
  TYPE_CHECKER["keyval"] = check_key_val
424
  TYPE_CHECKER["unit"] = check_unit
425
426


Iustin Pop's avatar
Iustin Pop committed
427
428
429
430
# optparse.py sets make_option, so we do it for our own option class, too
cli_option = CliOption


431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
DEBUG_OPT = cli_option("-d", "--debug", default=False,
                       action="store_true",
                       help="Turn debugging on")

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

477
478
479
480
VERBOSE_OPT = cli_option("-v", "--verbose", default=False,
                         action="store_true",
                         help="Increase the verbosity of the operation")

481
482
483
484
485
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")

486
487
488
489
NWSYNC_OPT = cli_option("--no-wait-for-sync", dest="wait_for_sync",
                        default=True, action="store_false",
                        help="Don't wait for sync (DANGEROUS!)")

490
491
492
493
494
495
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
496
497
498
499
NONICS_OPT = cli_option("--no-nics", default=False, action="store_true",
                        help="Do not create any network cards for"
                        " the instance")

500
501
502
503
504
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>")

505
506
507
508
509
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))

510
511
512
513
514
515
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
516
517
518
519
OS_OPT = cli_option("-o", "--os-type", dest="os", help="What OS to run",
                    metavar="<os>",
                    completion_suggest=OPT_COMPL_ONE_OS)

520
521
522
BACKEND_OPT = cli_option("-B", "--backend-parameters", dest="beparams",
                         type="keyval", default={},
                         help="Backend parameters")
523
524
525
526

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

528
529
530
531
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")
532
533
534
535
536

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

538
539
540
541
542
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")

Iustin Pop's avatar
Iustin Pop committed
543
544
545
NET_OPT = cli_option("--net",
                     help="NIC parameters", default=[],
                     dest="nics", action="append", type="identkeyval")
546

547

548
def _ParseArgs(argv, commands, aliases):
Iustin Pop's avatar
Iustin Pop committed
549
  """Parser for the command line arguments.
Iustin Pop's avatar
Iustin Pop committed
550

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

Iustin Pop's avatar
Iustin Pop committed
554
555
556
557
  @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, ...}
558

Iustin Pop's avatar
Iustin Pop committed
559
560
561
562
563
564
565
  """
  if len(argv) == 0:
    binary = "<command>"
  else:
    binary = argv[0].split("/")[-1]

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

571
  if len(argv) < 2 or not (argv[1] in commands or
Guido Trotter's avatar
Guido Trotter committed
572
                           argv[1] in aliases):
Iustin Pop's avatar
Iustin Pop committed
573
574
575
    # let's do a nice thing
    sortedcmds = commands.keys()
    sortedcmds.sort()
576
577
578
579
580

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

Iustin Pop's avatar
Iustin Pop committed
585
    # and format a nice command list
586
    ToStdout("Commands:")
Iustin Pop's avatar
Iustin Pop committed
587
    for cmd in sortedcmds:
588
      cmdstr = " %s" % (cmd,)
589
      help_text = commands[cmd][4]
590
591
      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
592
      for line in help_lines:
593
594
595
596
        ToStdout("%-*s   %s", mlen, "", line)

    ToStdout("")

Iustin Pop's avatar
Iustin Pop committed
597
    return None, None, None
598
599

  # get command, unalias it, and look it up in commands
Iustin Pop's avatar
Iustin Pop committed
600
  cmd = argv.pop(1)
601
602
603
604
605
606
607
608
609
610
611
  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]

612
  func, args_def, parser_opts, usage, description = commands[cmd]
613
  parser = OptionParser(option_list=parser_opts + [_DRY_RUN_OPT],
Iustin Pop's avatar
Iustin Pop committed
614
615
616
617
618
                        description=description,
                        formatter=TitledHelpFormatter(),
                        usage="%%prog %s %s" % (cmd, usage))
  parser.disable_interspersed_args()
  options, args = parser.parse_args()
619
620

  if not _CheckArguments(cmd, args_def, args):
Iustin Pop's avatar
Iustin Pop committed
621
622
623
624
625
    return None, None, None

  return func, options, args


626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
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


697
698
699
700
701
702
703
704
705
706
def SplitNodeOption(value):
  """Splits the value of a --node option.

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


707
708
709
710
711
712
713
714
715
716
def UsesRPC(fn):
  def wrapper(*args, **kwargs):
    rpc.Init()
    try:
      return fn(*args, **kwargs)
    finally:
      rpc.Shutdown()
  return wrapper


717
718
def AskUser(text, choices=None):
  """Ask the user a question.
Iustin Pop's avatar
Iustin Pop committed
719

Iustin Pop's avatar
Iustin Pop committed
720
  @param text: the question to ask
Iustin Pop's avatar
Iustin Pop committed
721

Iustin Pop's avatar
Iustin Pop committed
722
723
724
725
  @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
726

Iustin Pop's avatar
Iustin Pop committed
727
728
729
  @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
730
731

  """
732
733
734
735
  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
736
    raise errors.ProgrammerError("Invalid choices argument to AskUser")
737
738
  for entry in choices:
    if not isinstance(entry, tuple) or len(entry) < 3 or entry[0] == '?':
Michael Hanselmann's avatar
Michael Hanselmann committed
739
      raise errors.ProgrammerError("Invalid choices element to AskUser")
740
741
742
743
744
745

  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
746
  try:
747
    f = file("/dev/tty", "a+")
Iustin Pop's avatar
Iustin Pop committed
748
  except IOError:
749
    return answer
Iustin Pop's avatar
Iustin Pop committed
750
  try:
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
    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
769
770
771
772
773
  finally:
    f.close()
  return answer


774
775
776
777
778
779
780
781
782
783
784
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.

  """


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

788
789
790
791
792
  @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
793
794

  """
Iustin Pop's avatar
Iustin Pop committed
795
  if cl is None:
796
    cl = GetClient()
797

798
799
800
801
802
  job_id = cl.SubmitJob(ops)

  return job_id


Michael Hanselmann's avatar
Michael Hanselmann committed
803
def PollJob(job_id, cl=None, feedback_fn=None):
804
805
806
807
808
809
810
811
812
813
814
  """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()
815

816
817
818
  prev_job_info = None
  prev_logmsg_serial = None

819
  while True:
820
821
822
    result = cl.WaitForJobChange(job_id, ["status"], prev_job_info,
                                 prev_logmsg_serial)
    if not result:
823
      # job not found, go away!
824
      raise errors.JobLost("Job with id %s lost" % job_id)
825

826
827
828
829
830
831
832
833
834
835
    # 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:
836
          encoded = utils.SafeEncode(message)
837
          ToStdout("%s %s", time.ctime(utils.MergeTime(timestamp)), encoded)
838
839
        prev_logmsg_serial = max(prev_logmsg_serial, serial)

840
    # TODO: Handle canceled and archived jobs
841
842
843
844
    elif status in (constants.JOB_STATUS_SUCCESS,
                    constants.JOB_STATUS_ERROR,
                    constants.JOB_STATUS_CANCELING,
                    constants.JOB_STATUS_CANCELED):
845
      break
846
847

    prev_job_info = job_info
848

849
  jobs = cl.QueryJobs([job_id], ["status", "opstatus", "opresult"])
850
851
  if not jobs:
    raise errors.JobLost("Job with id %s lost" % job_id)
852

853
  status, opstatus, result = jobs[0]
854
  if status == constants.JOB_STATUS_SUCCESS:
855
    return result
856
857
858
  elif status in (constants.JOB_STATUS_CANCELING,
                  constants.JOB_STATUS_CANCELED):
    raise errors.OpExecError("Job was canceled")
859
  else:
860
861
862
863
864
    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:
865
        errors.MaybeRaise(msg)
866
867
868
869
870
871
        if has_ok:
          raise errors.OpExecError("partial failure (opcode %d): %s" %
                                   (idx, msg))
        else:
          raise errors.OpExecError(str(msg))
    # default failure mode
872
    raise errors.OpExecError(result)
Iustin Pop's avatar
Iustin Pop committed
873
874


875
876
877
878
879
880
881
882
883
884
885
886
887
def SubmitOpCode(op, cl=None, feedback_fn=None):
  """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()

  job_id = SendJob([op], cl)

888
889
890
  op_results = PollJob(job_id, cl=cl, feedback_fn=feedback_fn)

  return op_results[0]
891
892


893
894
895
896
897
898
899
900
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.

901
902
  It will also add the dry-run parameter from the options passed, if true.

903
  """
904
905
  if opts and opts.dry_run:
    op.dry_run = opts.dry_run
906
  if opts and opts.submit_only:
907
908
    job_id = SendJob([op], cl=cl)
    raise JobSubmittedException(job_id)
909
910
911
912
  else:
    return SubmitOpCode(op, cl=cl, feedback_fn=feedback_fn)


913
914
def GetClient():
  # TODO: Cache object?
915
916
917
918
919
920
921
922
923
924
925
  try:
    client = luxi.Client()
  except luxi.NoMasterError:
    master, myself = ssconf.GetMasterAndMyself()
    if master != myself:
      raise errors.OpPrereqError("This is not the master node, please connect"
                                 " to node '%s' and rerun the command" %
                                 master)
    else:
      raise
  return client
926
927


928
929
930
931
932
933
934
935
936
937
938
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()
939
  msg = str(err)
940
  if isinstance(err, errors.ConfigurationError):
941
    txt = "Corrupt configuration file: %s" % msg
Iustin Pop's avatar
Iustin Pop committed
942
    logging.error(txt)
943
    obuf.write(txt + "\n")
944
945
946
947
948
949
950
951
952
953
954
955
    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):
956
    obuf.write("Failure: hooks general failure: %s" % msg)
957
958
959
960
961
962
963
964
965
  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):
    obuf.write("Failure: prerequisites not met for this"
966
               " operation:\n%s" % msg)
967
  elif isinstance(err, errors.OpExecError):
968
    obuf.write("Failure: command execution error:\n%s" % msg)
969
  elif isinstance(err, errors.TagError):
970
    obuf.write("Failure: invalid tag(s) given:\n%s" % msg)
971
972
973
  elif isinstance(err, errors.JobQueueDrainError):
    obuf.write("Failure: the job queue is marked for drain and doesn't"
               " accept new requests\n")
Michael Hanselmann's avatar
Michael Hanselmann committed
974
975
976
  elif isinstance(err, errors.JobQueueFull):
    obuf.write("Failure: the job queue is full and doesn't accept new"
               " job submissions until old jobs are archived\n")
977
978
  elif isinstance(err, errors.TypeEnforcementError):
    obuf.write("Parameter Error: %s" % msg)
979
980
  elif isinstance(err, errors.ParameterError):
    obuf.write("Failure: unknown/wrong parameter name '%s'" % msg)
981
  elif isinstance(err, errors.GenericError):
982
    obuf.write("Unhandled Ganeti error: %s" % msg)
983
984
  elif isinstance(err, luxi.NoMasterError):
    obuf.write("Cannot communicate with the master daemon.\nIs it running"
985
               " and listening for connections?")
986
987
988
989
990
991
  elif isinstance(err, luxi.TimeoutError):
    obuf.write("Timeout while talking to the master daemon. Error:\n"
               "%s" % msg)
  elif isinstance(err, luxi.ProtocolError):
    obuf.write("Unhandled protocol error while talking to the master daemon:\n"
               "%s" % msg)
992
993
994
  elif isinstance(err, JobSubmittedException):
    obuf.write("JobID: %s\n" % err.args[0])
    retcode = 0
995
  else:
996
    obuf.write("Unhandled exception: %s" % msg)
997
998
999
  return retcode, obuf.getvalue().rstrip('\n')


1000
def GenericMain(commands, override=None, aliases=None):
Iustin Pop's avatar
Iustin Pop committed
1001
1002
  """Generic main function for all the gnt-* commands.

1003
1004
1005
1006
1007
1008
  Arguments:
    - commands: a dictionary with a special structure, see the design doc
                for command line handling.
    - override: if not None, we expect a dictionary with keys that will
                override command line options; this can be used to pass
                options from the scripts to generic functions
1009
    - aliases: dictionary with command aliases {'alias': 'target, ...}
Iustin Pop's avatar
Iustin Pop committed
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023

  """
  # save the program name and the entire command line for later logging
  if sys.argv:
    binary = os.path.basename(sys.argv[0]) or sys.argv[0]
    if len(sys.argv) >= 2:
      binary += " " + sys.argv[1]
      old_cmdline = " ".join(sys.argv[2:])
    else:
      old_cmdline = ""
  else:
    binary = "<unknown program>"
    old_cmdline = ""

1024
1025
1026
  if aliases is None:
    aliases = {}

1027
1028
1029
1030
1031
1032
1033
  try:
    func, options, args = _ParseArgs(sys.argv, commands, aliases)
  except errors.ParameterError, err:
    result, err_msg = FormatError(err)
    ToStderr(err_msg)
    return 1

Iustin Pop's avatar
Iustin Pop committed
1034
1035
1036
  if func is None: # parse error
    return 1

1037
1038
1039
1040
  if override is not None:
    for key, val in override.iteritems():
      setattr(options, key, val)

Iustin Pop's avatar
Iustin Pop committed
1041
1042
  utils.SetupLogging(constants.LOG_COMMANDS, debug=options.debug,
                     stderr_logging=True, program=binary)
Iustin Pop's avatar
Iustin Pop committed
1043
1044

  if old_cmdline:
Iustin Pop's avatar
Iustin Pop committed
1045
    logging.info("run with arguments '%s'", old_cmdline)
Iustin Pop's avatar
Iustin Pop committed
1046
  else:
Iustin Pop's avatar
Iustin Pop committed
1047
    logging.info("run with no arguments")
Iustin Pop's avatar
Iustin Pop committed
1048
1049

  try:
1050
    result = func(options, args)
Iustin Pop's avatar
Iustin Pop committed
1051
1052
  except (errors.GenericError, luxi.ProtocolError,
          JobSubmittedException), err:
1053
    result, err_msg = FormatError(err)
Michael Hanselmann's avatar
Michael Hanselmann committed
1054
    logging.exception("Error during command processing")
Iustin Pop's avatar
Iustin Pop committed
1055
    ToStderr(err_msg)
Iustin Pop's avatar
Iustin Pop committed
1056
1057

  return result
1058
1059


1060
def GenerateTable(headers, fields, separator, data,
1061
1062
                  numfields=None, unitfields=None,
                  units=None):
1063
1064
  """Prints a table with headers and different fields.

1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
  @type headers: dict
  @param headers: dictionary mapping field names to headers for
      the table
  @type fields: list
  @param fields: the field names corresponding to each row in
      the data field
  @param separator: the separator to be used; if this is None,
      the default 'smart' algorithm is used which computes optimal
      field width, otherwise just the separator is used between
      each field
  @type data: list
  @param data: a list of lists, each sublist being one row to be output
  @type numfields: list
  @param numfields: a list with the fields that hold numeric
      values and thus should be right-aligned
  @type unitfields: list
  @param unitfields: a list with the fields that hold numeric
      values that should be formatted with the units field
  @type units: string or None
  @param units: the units we should use for formatting, or None for
      automatic choice (human-readable for non-separator usage, otherwise
      megabytes); this is a one-letter string
1087
1088

  """
1089
1090
1091
1092
1093
1094
  if units is None:
    if separator:
      units = "m"
    else:
      units = "h"

1095
1096
1097
1098
1099
  if numfields is None:
    numfields = []
  if unitfields is None:
    unitfields = []

1100
1101
1102
  numfields = utils.FieldSet(*numfields)
  unitfields = utils.FieldSet(*unitfields)

1103
1104
  format_fields = []
  for field in fields:
1105
    if headers and field not in headers:
1106
      # TODO: handle better unknown fields (either revert to old
1107
1108
1109
      # style of raising exception, or deal more intelligently with
      # variable fields)
      headers[field] = field
1110
1111
    if separator is not None:
      format_fields.append("%s")
1112
    elif numfields.Matches(field):
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
      format_fields.append("%*s")
    else:
      format_fields.append("%-*s")

  if separator is None:
    mlens = [0 for name in fields]
    format = ' '.join(format_fields)
  else:
    format = separator.replace("%", "%%").join(format_fields)

  for row in data:
1124
1125
    if row is None:
      continue
1126
    for idx, val in enumerate(row):
1127
      if unitfields.Matches(fields[idx]):
1128
1129
1130
1131
1132
        try:
          val = int(val)
        except ValueError:
          pass
        else:
1133
          val = row[idx] = utils.FormatUnit(val, units)
1134
      val = row[idx] = str(val)
1135
1136
1137
      if separator is None:
        mlens[idx] = max(mlens[idx], len(val))

1138
  result = []
1139
1140
1141
1142
1143
1144
1145
1146
  if headers:
    args = []
    for idx, name in enumerate(fields):
      hdr = headers[name]
      if separator is None:
        mlens[idx] = max(mlens[idx], len(hdr))
        args.append(mlens[idx])
      args.append(hdr)
1147
    result.append(format % tuple(args))
1148
1149
1150

  for line in data:
    args = []
1151
1152
    if line is None:
      line = ['-' for _ in fields]
1153
1154
1155
1156
    for idx in xrange(len(fields)):
      if separator is None:
        args.append(mlens[idx])
      args.append(line[idx])
1157
1158
1159
    result.append(format % tuple(args))

  return result
1160
1161
1162
1163
1164
1165
1166
1167
1168


def FormatTimestamp(ts):
  """Formats a given timestamp.

  @type ts: timestamp
  @param ts: a timeval-type timestamp, a tuple of seconds and microseconds

  @rtype: string
Iustin Pop's avatar
Iustin Pop committed
1169
  @return: a string with the formatted timestamp
1170
1171

  """
1172
1173
  if not isinstance (ts, (tuple, list)) or len(ts) != 2:
    return '?'
1174
1175
  sec, usec = ts
  return time.strftime("%F %T", time.localtime(sec)) + ".%06d" % usec
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217


def ParseTimespec(value):
  """Parse a time specification.

  The following suffixed will be recognized:

    - s: seconds
    - m: minutes
    - h: hours
    - d: day
    - w: weeks

  Without any suffix, the value will be taken to be in seconds.

  """
  value = str(value)
  if not value:
    raise errors.OpPrereqError("Empty time specification passed")
  suffix_map = {
    's': 1,
    'm': 60,
    'h': 3600,
    'd': 86400,
    'w': 604800,
    }
  if value[-1] not in suffix_map:
    try:
      value = int(value)
    except ValueError:
      raise errors.OpPrereqError("Invalid time specification '%s'" % value)
  else:
    multiplier = suffix_map[value[-1]]
    value = value[:-1]
    if not value: # no data left after stripping the suffix
      raise errors.OpPrereqError("Invalid time specification (only"
                                 " suffix passed)")
    try:
      value = int(value) * multiplier
    except ValueError:
      raise errors.OpPrereqError("Invalid time specification '%s'" % value)
  return value
Iustin Pop's avatar
Iustin Pop committed
1218
1219


1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
def GetOnlineNodes(nodes, cl=None, nowarn=False):
  """Returns the names of online nodes.

  This function will also log a warning on stderr with the names of
  the online nodes.

  @param nodes: if not empty, use only this subset of nodes (minus the
      offline ones)
  @param cl: if not None, luxi client to use
  @type nowarn: boolean
  @param nowarn: by default, this function will output a note with the
      offline nodes that are skipped; if this parameter is True the
      note is not displayed

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

1238
1239
  result = cl.QueryNodes(names=nodes, fields=["name", "offline"],
                         use_locking=False)
1240
1241
1242
1243
1244
1245
  offline = [row[0] for row in result if row[1]]
  if offline and not nowarn:
    ToStderr("Note: skipping offline node(s): %s" % ", ".join(offline))
  return [row[0] for row in result if not row[1]]


Iustin Pop's avatar
Iustin Pop committed
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
def _ToStream(stream, txt, *args):
  """Write a message to a stream, bypassing the logging system

  @type stream: file object
  @param stream: the file to which we should write
  @type txt: str
  @param txt: the message

  """
  if args:
    args = tuple(args)
    stream.write(txt % args)
  else:
    stream.write(txt)
  stream.write('\n')
  stream.flush()


def ToStdout(txt, *args):
  """Write a message to stdout only, bypassing the logging system

  This is just a wrapper over _ToStream.

  @type txt: str
  @param txt: the message

  """
  _ToStream(sys.stdout, txt, *args)


def ToStderr(txt, *args):
  """Write a message to stderr only, bypassing the logging system

  This is just a wrapper over _ToStream.

  @type txt: str
  @param txt: the message

  """
  _ToStream(sys.stderr, txt, *args)
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300


class JobExecutor(object):
  """Class which manages the submission and execution of multiple jobs.

  Note that instances of this class should not be reused between
  GetResults() calls.

  """
  def __init__(self, cl=None, verbose=True):
    self.queue = []
    if cl is None:
      cl = GetClient()
    self.cl = cl
    self.verbose = verbose
1301
    self.jobs = []
1302
1303

  def QueueJob(self, name, *ops):
1304
    """Record a job for later submit.
1305
1306
1307
1308

    @type name: string
    @param name: a description of the job, will be used in WaitJobSet
    """
1309
1310
1311
1312
1313
1314
1315
1316
1317
    self.queue.append((name, ops))

  def SubmitPending(self):
    """Submit all pending jobs.

    """
    results = self.cl.SubmitManyJobs([row[1] for row in self.queue])
    for ((status, data), (name, _)) in zip(results, self.queue):
      self.jobs.append((status, data, name))
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327

  def GetResults(self):
    """Wait for and return the results of all jobs.

    @rtype: list
    @return: list of tuples (success, job results), in the same order
        as the submitted jobs; if a job has failed, instead of the result
        there will be the error message

    """
1328
1329
    if not self.jobs:
      self.SubmitPending()
1330
1331
    results = []
    if self.verbose:
1332
1333
1334
1335
1336
1337
1338
1339
      ok_jobs = [row[1] for row in self.jobs if row[0]]
      if ok_jobs:
        ToStdout("Submitted jobs %s", ", ".join(ok_jobs))
    for submit_status, jid, name in self.jobs:
      if not submit_status:
        ToStderr("Failed to submit job for %s: %s", name, jid)
        results.append((False, jid))
        continue
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
      if self.verbose:
        ToStdout("Waiting for job %s for %s...", jid, name)
      try:
        job_result = PollJob(jid, cl=self.cl)
        success = True
      except (errors.GenericError, luxi.ProtocolError), err:
        _, job_result = FormatError(err)
        success = False
        # the error message will always be shown, verbose or not
        ToStderr("Job %s for %s has failed: %s", jid, name, job_result)

      results.append((success, job_result))
    return results

  def WaitOrShow(self, wait):
    """Wait for job results or only print the job IDs.

    @type wait: boolean
    @param wait: whether to wait or not

    """
    if wait:
      return self.GetResults()
    else:
1364
1365
1366
1367
1368
1369
1370
      if not self.jobs:
        self.SubmitPending()
      for status, result, name in self.jobs:
        if status:
          ToStdout("%s: %s", result, name)
        else:
          ToStderr("Failure for %s: %s", name, result)