cli.py 28 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, make_option, TitledHelpFormatter,
Iustin Pop's avatar
Iustin Pop committed
42
                      Option, OptionValueError)
Iustin Pop's avatar
Iustin Pop committed
43

Iustin Pop's avatar
Iustin Pop committed
44
__all__ = ["DEBUG_OPT", "NOHDR_OPT", "SEP_OPT", "GenericMain",
45
           "SubmitOpCode", "GetClient",
46
47
           "cli_option", "ikv_option", "keyval_option",
           "GenerateTable", "AskUser",
Iustin Pop's avatar
Iustin Pop committed
48
           "ARGS_NONE", "ARGS_FIXED", "ARGS_ATLEAST", "ARGS_ANY", "ARGS_ONE",
49
           "USEUNITS_OPT", "FIELDS_OPT", "FORCE_OPT", "SUBMIT_OPT",
50
           "ListTags", "AddTags", "RemoveTags", "TAG_SRC_OPT",
51
           "FormatError", "SplitNodeOption", "SubmitOrSend",
Iustin Pop's avatar
Iustin Pop committed
52
           "JobSubmittedException", "FormatTimestamp", "ParseTimespec",
53
           "ValidateBeParams",
Iustin Pop's avatar
Iustin Pop committed
54
           "ToStderr", "ToStdout",
55
           "UsesRPC",
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
           ]


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
72
      raise errors.OpPrereqError("no arguments passed to the command")
73
74
75
76
77
78
79
    name = args.pop(0)
    retval = kind, name
  else:
    raise errors.ProgrammerError("Unhandled tag type '%s'" % kind)
  return retval


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


109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
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:
    print tag


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)
137
  _ExtendTags(opts, args)
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
  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)
154
  _ExtendTags(opts, args)
155
156
157
158
159
  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
160
161
162
163
164
165
166
167
168

DEBUG_OPT = make_option("-d", "--debug", default=False,
                        action="store_true",
                        help="Turn debugging on")

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

169
SEP_OPT = make_option("--separator", default=None,
Iustin Pop's avatar
Iustin Pop committed
170
171
172
173
                      action="store", dest="separator",
                      help="Separator between output fields"
                      " (defaults to one space)")

174
175
176
USEUNITS_OPT = make_option("--units", default=None,
                           dest="units", choices=('h', 'm', 'g', 't'),
                           help="Specify units for output (one of hmgt)")
Iustin Pop's avatar
Iustin Pop committed
177

178
FIELDS_OPT = make_option("-o", "--output", dest="output", action="store",
179
180
                         type="string", help="Comma separated list of"
                         " output fields",
181
182
                         metavar="FIELDS")

183
184
185
FORCE_OPT = make_option("-f", "--force", dest="force", action="store_true",
                        default=False, help="Force the operation")

186
187
188
TAG_SRC_OPT = make_option("--from", dest="tags_source",
                          default=None, help="File with tag names")

189
190
191
192
193
SUBMIT_OPT = make_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")

194

Iustin Pop's avatar
Iustin Pop committed
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
def ARGS_FIXED(val):
  """Macro-like function denoting a fixed number of arguments"""
  return -val


def ARGS_ATLEAST(val):
  """Macro-like function denoting a minimum number of arguments"""
  return val


ARGS_NONE = None
ARGS_ONE = ARGS_FIXED(1)
ARGS_ANY = ARGS_ATLEAST(0)


def check_unit(option, opt, value):
Iustin Pop's avatar
Iustin Pop committed
211
212
213
  """OptParsers custom converter for units.

  """
Iustin Pop's avatar
Iustin Pop committed
214
215
216
  try:
    return utils.ParseUnit(value)
  except errors.UnitParseError, err:
217
    raise OptionValueError("option %s: %s" % (opt, err))
Iustin Pop's avatar
Iustin Pop committed
218
219
220


class CliOption(Option):
Iustin Pop's avatar
Iustin Pop committed
221
222
223
  """Custom option class for optparse.

  """
Iustin Pop's avatar
Iustin Pop committed
224
225
226
227
228
  TYPES = Option.TYPES + ("unit",)
  TYPE_CHECKER = copy.copy(Option.TYPE_CHECKER)
  TYPE_CHECKER["unit"] = check_unit


229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
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

  """
  NO_PREFIX = "no_"
248
  UN_PREFIX = "-"
249
250
251
252
253
254
255
  kv_dict = {}
  for elem in data.split(","):
    if "=" in elem:
      key, val = elem.split("=", 1)
    else:
      if elem.startswith(NO_PREFIX):
        key, val = elem[len(NO_PREFIX):], False
256
257
      elif elem.startswith(UN_PREFIX):
        key, val = elem[len(UN_PREFIX):], None
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
      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
  return kv_dict


def check_ident_key_val(option, opt, value):
  """Custom parser for the IdentKeyVal option type.

  """
  if ":" not in value:
    retval =  (value, {})
  else:
    ident, rest = value.split(":", 1)
    kv_dict = _SplitKeyVal(opt, rest)
    retval = (ident, kv_dict)
  return retval


class IdentKeyValOption(Option):
  """Custom option class 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.

  """
  TYPES = Option.TYPES + ("identkeyval",)
  TYPE_CHECKER = copy.copy(Option.TYPE_CHECKER)
  TYPE_CHECKER["identkeyval"] = check_ident_key_val


def check_key_val(option, opt, value):
  """Custom parser for the KeyVal option type.

  """
  return _SplitKeyVal(opt, value)


class KeyValOption(Option):
  """Custom option class for key=val,key=val options.

  This will store the parsed values as a dict {key: val}.

  """
  TYPES = Option.TYPES + ("keyval",)
  TYPE_CHECKER = copy.copy(Option.TYPE_CHECKER)
  TYPE_CHECKER["keyval"] = check_key_val


Iustin Pop's avatar
Iustin Pop committed
310
311
# optparse.py sets make_option, so we do it for our own option class, too
cli_option = CliOption
312
313
ikv_option = IdentKeyValOption
keyval_option = KeyValOption
Iustin Pop's avatar
Iustin Pop committed
314
315


316
def _ParseArgs(argv, commands, aliases):
Iustin Pop's avatar
Iustin Pop committed
317
318
319
320
321
322
323
324
  """Parses the command line and return the function which must be
  executed together with its arguments

  Arguments:
    argv: the command line

    commands: dictionary with special contents, see the design doc for
    cmdline handling
325
    aliases: dictionary with command aliases {'alias': 'target, ...}
326

Iustin Pop's avatar
Iustin Pop committed
327
328
329
330
331
332
333
334
335
336
337
338
  """
  if len(argv) == 0:
    binary = "<command>"
  else:
    binary = argv[0].split("/")[-1]

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

339
  if len(argv) < 2 or not (argv[1] in commands or
Guido Trotter's avatar
Guido Trotter committed
340
                           argv[1] in aliases):
Iustin Pop's avatar
Iustin Pop committed
341
342
343
344
345
346
347
    # let's do a nice thing
    sortedcmds = commands.keys()
    sortedcmds.sort()
    print ("Usage: %(bin)s {command} [options...] [argument...]"
           "\n%(bin)s <command> --help to see details, or"
           " man %(bin)s\n" % {"bin": binary})
    # compute the max line length for cmd + usage
348
    mlen = max([len(" %s" % cmd) for cmd in commands])
Iustin Pop's avatar
Iustin Pop committed
349
350
351
352
    mlen = min(60, mlen) # should not get here...
    # and format a nice command list
    print "Commands:"
    for cmd in sortedcmds:
353
      cmdstr = " %s" % (cmd,)
354
      help_text = commands[cmd][4]
Iustin Pop's avatar
Iustin Pop committed
355
      help_lines = textwrap.wrap(help_text, 79-3-mlen)
356
      print "%-*s - %s" % (mlen, cmdstr, help_lines.pop(0))
Iustin Pop's avatar
Iustin Pop committed
357
358
359
360
      for line in help_lines:
        print "%-*s   %s" % (mlen, "", line)
    print
    return None, None, None
361
362

  # get command, unalias it, and look it up in commands
Iustin Pop's avatar
Iustin Pop committed
363
  cmd = argv.pop(1)
364
365
366
367
368
369
370
371
372
373
374
  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]

Iustin Pop's avatar
Iustin Pop committed
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
  func, nargs, parser_opts, usage, description = commands[cmd]
  parser = OptionParser(option_list=parser_opts,
                        description=description,
                        formatter=TitledHelpFormatter(),
                        usage="%%prog %s %s" % (cmd, usage))
  parser.disable_interspersed_args()
  options, args = parser.parse_args()
  if nargs is None:
    if len(args) != 0:
      print >> sys.stderr, ("Error: Command %s expects no arguments" % cmd)
      return None, None, None
  elif nargs < 0 and len(args) != -nargs:
    print >> sys.stderr, ("Error: Command %s expects %d argument(s)" %
                         (cmd, -nargs))
    return None, None, None
  elif nargs >= 0 and len(args) < nargs:
    print >> sys.stderr, ("Error: Command %s expects at least %d argument(s)" %
                         (cmd, nargs))
    return None, None, None

  return func, options, args


398
399
400
401
402
403
404
405
406
407
def SplitNodeOption(value):
  """Splits the value of a --node option.

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


408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
def ValidateBeParams(bep):
  """Parse and check the given beparams.

  The function will update in-place the given dictionary.

  @type bep: dict
  @param bep: input beparams
  @raise errors.ParameterError: if the input values are not OK
  @raise errors.UnitParseError: if the input values are not OK

  """
  if constants.BE_MEMORY in bep:
    bep[constants.BE_MEMORY] = utils.ParseUnit(bep[constants.BE_MEMORY])

  if constants.BE_VCPUS in bep:
    try:
      bep[constants.BE_VCPUS] = int(bep[constants.BE_VCPUS])
    except ValueError:
      raise errors.ParameterError("Invalid number of VCPUs")


429
430
431
432
433
434
435
436
437
438
def UsesRPC(fn):
  def wrapper(*args, **kwargs):
    rpc.Init()
    try:
      return fn(*args, **kwargs)
    finally:
      rpc.Shutdown()
  return wrapper


439
440
def AskUser(text, choices=None):
  """Ask the user a question.
Iustin Pop's avatar
Iustin Pop committed
441
442

  Args:
443
    text - the question to ask.
Iustin Pop's avatar
Iustin Pop committed
444

445
446
447
448
449
450
451
452
    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

  Returns: 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
453
454

  """
455
456
457
458
459
460
461
462
463
464
465
466
467
468
  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):
    raise errors.ProgrammerError("Invalid choiches argument to AskUser")
  for entry in choices:
    if not isinstance(entry, tuple) or len(entry) < 3 or entry[0] == '?':
      raise errors.ProgrammerError("Invalid choiches element to AskUser")

  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
469
  try:
470
    f = file("/dev/tty", "a+")
Iustin Pop's avatar
Iustin Pop committed
471
  except IOError:
472
    return answer
Iustin Pop's avatar
Iustin Pop committed
473
  try:
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
    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
492
493
494
495
496
  finally:
    f.close()
  return answer


497
498
499
500
501
502
503
504
505
506
507
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.

  """


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

511
512
513
514
515
  @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
516
517

  """
Iustin Pop's avatar
Iustin Pop committed
518
  if cl is None:
519
    cl = GetClient()
520

521
522
523
524
525
  job_id = cl.SubmitJob(ops)

  return job_id


Michael Hanselmann's avatar
Michael Hanselmann committed
526
def PollJob(job_id, cl=None, feedback_fn=None):
527
528
529
530
531
532
533
534
535
536
537
  """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()
538

539
540
541
  prev_job_info = None
  prev_logmsg_serial = None

542
  while True:
543
544
545
    result = cl.WaitForJobChange(job_id, ["status"], prev_job_info,
                                 prev_logmsg_serial)
    if not result:
546
      # job not found, go away!
547
      raise errors.JobLost("Job with id %s lost" % job_id)
548

549
550
551
552
553
554
555
556
557
558
559
560
561
    # 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:
          print "%s %s" % (time.ctime(utils.MergeTime(timestamp)), message)
        prev_logmsg_serial = max(prev_logmsg_serial, serial)

562
    # TODO: Handle canceled and archived jobs
563
564
565
566
    elif status in (constants.JOB_STATUS_SUCCESS,
                    constants.JOB_STATUS_ERROR,
                    constants.JOB_STATUS_CANCELING,
                    constants.JOB_STATUS_CANCELED):
567
      break
568
569

    prev_job_info = job_info
570

571
  jobs = cl.QueryJobs([job_id], ["status", "opstatus", "opresult"])
572
573
  if not jobs:
    raise errors.JobLost("Job with id %s lost" % job_id)
574

575
  status, opstatus, result = jobs[0]
576
  if status == constants.JOB_STATUS_SUCCESS:
577
    return result
578
579
580
  elif status in (constants.JOB_STATUS_CANCELING,
                  constants.JOB_STATUS_CANCELED):
    raise errors.OpExecError("Job was canceled")
581
  else:
582
583
584
585
586
587
588
589
590
591
592
    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:
        if has_ok:
          raise errors.OpExecError("partial failure (opcode %d): %s" %
                                   (idx, msg))
        else:
          raise errors.OpExecError(str(msg))
    # default failure mode
593
    raise errors.OpExecError(result)
Iustin Pop's avatar
Iustin Pop committed
594
595


596
597
598
599
600
601
602
603
604
605
606
607
608
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)

609
610
611
  op_results = PollJob(job_id, cl=cl, feedback_fn=feedback_fn)

  return op_results[0]
612
613


614
615
616
617
618
619
620
621
622
623
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.

  """
  if opts and opts.submit_only:
624
625
    job_id = SendJob([op], cl=cl)
    raise JobSubmittedException(job_id)
626
627
628
629
  else:
    return SubmitOpCode(op, cl=cl, feedback_fn=feedback_fn)


630
631
def GetClient():
  # TODO: Cache object?
632
633
634
635
636
637
638
639
640
641
642
  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
643
644


645
646
647
648
649
650
651
652
653
654
655
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()
656
  msg = str(err)
657
  if isinstance(err, errors.ConfigurationError):
658
    txt = "Corrupt configuration file: %s" % msg
Iustin Pop's avatar
Iustin Pop committed
659
    logging.error(txt)
660
    obuf.write(txt + "\n")
661
662
663
664
665
666
667
668
669
670
671
672
    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):
673
    obuf.write("Failure: hooks general failure: %s" % msg)
674
675
676
677
678
679
680
681
682
  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"
683
               " operation:\n%s" % msg)
684
  elif isinstance(err, errors.OpExecError):
685
    obuf.write("Failure: command execution error:\n%s" % msg)
686
  elif isinstance(err, errors.TagError):
687
    obuf.write("Failure: invalid tag(s) given:\n%s" % msg)
688
689
690
  elif isinstance(err, errors.JobQueueDrainError):
    obuf.write("Failure: the job queue is marked for drain and doesn't"
               " accept new requests\n")
691
  elif isinstance(err, errors.GenericError):
692
    obuf.write("Unhandled Ganeti error: %s" % msg)
693
694
  elif isinstance(err, luxi.NoMasterError):
    obuf.write("Cannot communicate with the master daemon.\nIs it running"
695
               " and listening for connections?")
696
697
698
699
700
701
  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)
702
703
704
  elif isinstance(err, JobSubmittedException):
    obuf.write("JobID: %s\n" % err.args[0])
    retcode = 0
705
  else:
706
    obuf.write("Unhandled exception: %s" % msg)
707
708
709
  return retcode, obuf.getvalue().rstrip('\n')


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

713
714
715
716
717
718
  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
719
    - aliases: dictionary with command aliases {'alias': 'target, ...}
Iustin Pop's avatar
Iustin Pop committed
720
721
722
723
724
725
726
727
728
729
730
731
732
733

  """
  # 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 = ""

734
735
736
737
  if aliases is None:
    aliases = {}

  func, options, args = _ParseArgs(sys.argv, commands, aliases)
Iustin Pop's avatar
Iustin Pop committed
738
739
740
  if func is None: # parse error
    return 1

741
742
743
744
  if override is not None:
    for key, val in override.iteritems():
      setattr(options, key, val)

Iustin Pop's avatar
Iustin Pop committed
745
746
  utils.SetupLogging(constants.LOG_COMMANDS, debug=options.debug,
                     stderr_logging=True, program=binary)
Iustin Pop's avatar
Iustin Pop committed
747

748
  utils.debug = options.debug
Iustin Pop's avatar
Iustin Pop committed
749
750

  if old_cmdline:
Iustin Pop's avatar
Iustin Pop committed
751
    logging.info("run with arguments '%s'", old_cmdline)
Iustin Pop's avatar
Iustin Pop committed
752
  else:
Iustin Pop's avatar
Iustin Pop committed
753
    logging.info("run with no arguments")
Iustin Pop's avatar
Iustin Pop committed
754
755

  try:
756
    result = func(options, args)
Iustin Pop's avatar
Iustin Pop committed
757
758
  except (errors.GenericError, luxi.ProtocolError,
          JobSubmittedException), err:
759
    result, err_msg = FormatError(err)
Iustin Pop's avatar
Iustin Pop committed
760
761
    logging.exception("Error durring command processing")
    ToStderr(err_msg)
Iustin Pop's avatar
Iustin Pop committed
762
763

  return result
764
765


766
def GenerateTable(headers, fields, separator, data,
767
768
                  numfields=None, unitfields=None,
                  units=None):
769
770
  """Prints a table with headers and different fields.

771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
  @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
793
794

  """
795
796
797
798
799
800
  if units is None:
    if separator:
      units = "m"
    else:
      units = "h"

801
802
803
804
805
  if numfields is None:
    numfields = []
  if unitfields is None:
    unitfields = []

806
807
808
  numfields = utils.FieldSet(*numfields)
  unitfields = utils.FieldSet(*unitfields)

809
810
  format_fields = []
  for field in fields:
811
    if headers and field not in headers:
812
813
814
815
      # FIXME: handle better unknown fields (either revert to old
      # style of raising exception, or deal more intelligently with
      # variable fields)
      headers[field] = field
816
817
    if separator is not None:
      format_fields.append("%s")
818
    elif numfields.Matches(field):
819
820
821
822
823
824
825
826
827
828
829
830
      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:
    for idx, val in enumerate(row):
831
      if unitfields.Matches(fields[idx]):
832
833
834
835
836
        try:
          val = int(val)
        except ValueError:
          pass
        else:
837
          val = row[idx] = utils.FormatUnit(val, units)
838
      val = row[idx] = str(val)
839
840
841
      if separator is None:
        mlens[idx] = max(mlens[idx], len(val))

842
  result = []
843
844
845
846
847
848
849
850
  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)
851
    result.append(format % tuple(args))
852
853
854
855
856
857
858

  for line in data:
    args = []
    for idx in xrange(len(fields)):
      if separator is None:
        args.append(mlens[idx])
      args.append(line[idx])
859
860
861
    result.append(format % tuple(args))

  return result
862
863
864
865
866
867
868
869
870
871
872
873


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

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

  @rtype: string
  @returns: a string with the formatted timestamp

  """
874
875
  if not isinstance (ts, (tuple, list)) or len(ts) != 2:
    return '?'
876
877
  sec, usec = ts
  return time.strftime("%F %T", time.localtime(sec)) + ".%06d" % usec
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919


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
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961


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)