cli.py 26.2 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
Iustin Pop's avatar
Iustin Pop committed
39
40

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

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


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


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


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

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

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

USEUNITS_OPT = make_option("--human-readable", default=False,
                           action="store_true", dest="human_readable",
                           help="Print sizes in human readable format")

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

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

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

187
188
189
190
191
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")

192

Iustin Pop's avatar
Iustin Pop committed
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
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
209
210
211
  """OptParsers custom converter for units.

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


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

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


227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
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_"
246
  UN_PREFIX = "-"
247
248
249
250
251
252
253
  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
254
255
      elif elem.startswith(UN_PREFIX):
        key, val = elem[len(UN_PREFIX):], None
256
257
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
      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
308
309
# optparse.py sets make_option, so we do it for our own option class, too
cli_option = CliOption
310
311
ikv_option = IdentKeyValOption
keyval_option = KeyValOption
Iustin Pop's avatar
Iustin Pop committed
312
313


314
def _ParseArgs(argv, commands, aliases):
Iustin Pop's avatar
Iustin Pop committed
315
316
317
318
319
320
321
322
  """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
323
    aliases: dictionary with command aliases {'alias': 'target, ...}
324

Iustin Pop's avatar
Iustin Pop committed
325
326
327
328
329
330
331
332
333
334
335
336
  """
  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)

337
  if len(argv) < 2 or not (argv[1] in commands or
Guido Trotter's avatar
Guido Trotter committed
338
                           argv[1] in aliases):
Iustin Pop's avatar
Iustin Pop committed
339
340
341
342
343
344
345
    # 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
346
    mlen = max([len(" %s" % cmd) for cmd in commands])
Iustin Pop's avatar
Iustin Pop committed
347
348
349
350
    mlen = min(60, mlen) # should not get here...
    # and format a nice command list
    print "Commands:"
    for cmd in sortedcmds:
351
      cmdstr = " %s" % (cmd,)
352
      help_text = commands[cmd][4]
Iustin Pop's avatar
Iustin Pop committed
353
      help_lines = textwrap.wrap(help_text, 79-3-mlen)
354
      print "%-*s - %s" % (mlen, cmdstr, help_lines.pop(0))
Iustin Pop's avatar
Iustin Pop committed
355
356
357
358
      for line in help_lines:
        print "%-*s   %s" % (mlen, "", line)
    print
    return None, None, None
359
360

  # get command, unalias it, and look it up in commands
Iustin Pop's avatar
Iustin Pop committed
361
  cmd = argv.pop(1)
362
363
364
365
366
367
368
369
370
371
372
  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
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
  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


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

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


406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
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")


427
428
def AskUser(text, choices=None):
  """Ask the user a question.
Iustin Pop's avatar
Iustin Pop committed
429
430

  Args:
431
    text - the question to ask.
Iustin Pop's avatar
Iustin Pop committed
432

433
434
435
436
437
438
439
440
    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
441
442

  """
443
444
445
446
447
448
449
450
451
452
453
454
455
456
  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
457
  try:
458
    f = file("/dev/tty", "a+")
Iustin Pop's avatar
Iustin Pop committed
459
  except IOError:
460
    return answer
Iustin Pop's avatar
Iustin Pop committed
461
  try:
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
    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
480
481
482
483
484
  finally:
    f.close()
  return answer


485
486
487
488
489
490
491
492
493
494
495
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.

  """


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

499
500
501
502
503
  @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
504
505

  """
Iustin Pop's avatar
Iustin Pop committed
506
  if cl is None:
507
    cl = GetClient()
508

509
510
511
512
513
  job_id = cl.SubmitJob(ops)

  return job_id


Michael Hanselmann's avatar
Michael Hanselmann committed
514
def PollJob(job_id, cl=None, feedback_fn=None):
515
516
517
518
519
520
521
522
523
524
525
  """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()
526

527
528
529
  prev_job_info = None
  prev_logmsg_serial = None

530
  while True:
531
532
533
    result = cl.WaitForJobChange(job_id, ["status"], prev_job_info,
                                 prev_logmsg_serial)
    if not result:
534
      # job not found, go away!
535
      raise errors.JobLost("Job with id %s lost" % job_id)
536

537
538
539
540
541
542
543
544
545
546
547
548
549
    # 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)

550
    # TODO: Handle canceled and archived jobs
551
    elif status in (constants.JOB_STATUS_SUCCESS, constants.JOB_STATUS_ERROR):
552
      break
553
554

    prev_job_info = job_info
555

556
  jobs = cl.QueryJobs([job_id], ["status", "opresult"])
557
558
  if not jobs:
    raise errors.JobLost("Job with id %s lost" % job_id)
559

560
561
  status, result = jobs[0]
  if status == constants.JOB_STATUS_SUCCESS:
562
    return result
563
564
  else:
    raise errors.OpExecError(result)
Iustin Pop's avatar
Iustin Pop committed
565
566


567
568
569
570
571
572
573
574
575
576
577
578
579
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)

580
581
582
  op_results = PollJob(job_id, cl=cl, feedback_fn=feedback_fn)

  return op_results[0]
583
584


585
586
587
588
589
590
591
592
593
594
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:
595
596
    job_id = SendJob([op], cl=cl)
    raise JobSubmittedException(job_id)
597
598
599
600
  else:
    return SubmitOpCode(op, cl=cl, feedback_fn=feedback_fn)


601
602
def GetClient():
  # TODO: Cache object?
603
604
605
606
607
608
609
610
611
612
613
  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
614
615


616
617
618
619
620
621
622
623
624
625
626
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()
627
  msg = str(err)
628
  if isinstance(err, errors.ConfigurationError):
629
    txt = "Corrupt configuration file: %s" % msg
Iustin Pop's avatar
Iustin Pop committed
630
    logging.error(txt)
631
    obuf.write(txt + "\n")
632
633
634
635
636
637
638
639
640
641
642
643
    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):
644
    obuf.write("Failure: hooks general failure: %s" % msg)
645
646
647
648
649
650
651
652
653
  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"
654
               " operation:\n%s" % msg)
655
  elif isinstance(err, errors.OpExecError):
656
    obuf.write("Failure: command execution error:\n%s" % msg)
657
  elif isinstance(err, errors.TagError):
658
    obuf.write("Failure: invalid tag(s) given:\n%s" % msg)
659
660
661
  elif isinstance(err, errors.JobQueueDrainError):
    obuf.write("Failure: the job queue is marked for drain and doesn't"
               " accept new requests\n")
662
  elif isinstance(err, errors.GenericError):
663
    obuf.write("Unhandled Ganeti error: %s" % msg)
664
665
  elif isinstance(err, luxi.NoMasterError):
    obuf.write("Cannot communicate with the master daemon.\nIs it running"
666
               " and listening for connections?")
667
668
669
670
671
672
  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)
673
674
675
  elif isinstance(err, JobSubmittedException):
    obuf.write("JobID: %s\n" % err.args[0])
    retcode = 0
676
  else:
677
    obuf.write("Unhandled exception: %s" % msg)
678
679
680
  return retcode, obuf.getvalue().rstrip('\n')


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

684
685
686
687
688
689
  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
690
    - aliases: dictionary with command aliases {'alias': 'target, ...}
Iustin Pop's avatar
Iustin Pop committed
691
692
693
694
695
696
697
698
699
700
701
702
703
704

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

705
706
707
708
  if aliases is None:
    aliases = {}

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

712
713
714
715
  if override is not None:
    for key, val in override.iteritems():
      setattr(options, key, val)

Iustin Pop's avatar
Iustin Pop committed
716
717
  utils.SetupLogging(constants.LOG_COMMANDS, debug=options.debug,
                     stderr_logging=True, program=binary)
Iustin Pop's avatar
Iustin Pop committed
718

719
  utils.debug = options.debug
Iustin Pop's avatar
Iustin Pop committed
720
721

  if old_cmdline:
Iustin Pop's avatar
Iustin Pop committed
722
    logging.info("run with arguments '%s'", old_cmdline)
Iustin Pop's avatar
Iustin Pop committed
723
  else:
Iustin Pop's avatar
Iustin Pop committed
724
    logging.info("run with no arguments")
Iustin Pop's avatar
Iustin Pop committed
725
726

  try:
727
    result = func(options, args)
Iustin Pop's avatar
Iustin Pop committed
728
729
  except (errors.GenericError, luxi.ProtocolError,
          JobSubmittedException), err:
730
    result, err_msg = FormatError(err)
Iustin Pop's avatar
Iustin Pop committed
731
732
    logging.exception("Error durring command processing")
    ToStderr(err_msg)
Iustin Pop's avatar
Iustin Pop committed
733
734

  return result
735
736


737
738
def GenerateTable(headers, fields, separator, data,
                  numfields=None, unitfields=None):
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
  """Prints a table with headers and different fields.

  Args:
    headers: Dict of header titles or None if no headers should be shown
    fields: List of fields to show
    separator: String used to separate fields or None for spaces
    data: Data to be printed
    numfields: List of fields to be aligned to right
    unitfields: List of fields to be formatted as units

  """
  if numfields is None:
    numfields = []
  if unitfields is None:
    unitfields = []

  format_fields = []
  for field in fields:
757
    if headers and field not in headers:
758
759
760
761
      # FIXME: handle better unknown fields (either revert to old
      # style of raising exception, or deal more intelligently with
      # variable fields)
      headers[field] = field
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
    if separator is not None:
      format_fields.append("%s")
    elif field in numfields:
      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):
      if fields[idx] in unitfields:
        try:
          val = int(val)
        except ValueError:
          pass
        else:
          val = row[idx] = utils.FormatUnit(val)
784
      val = row[idx] = str(val)
785
786
787
      if separator is None:
        mlens[idx] = max(mlens[idx], len(val))

788
  result = []
789
790
791
792
793
794
795
796
  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)
797
    result.append(format % tuple(args))
798
799
800
801
802
803
804

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

  return result
808
809
810
811
812
813
814
815
816
817
818
819


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

  """
820
821
  if not isinstance (ts, (tuple, list)) or len(ts) != 2:
    return '?'
822
823
  sec, usec = ts
  return time.strftime("%F %T", time.localtime(sec)) + ".%06d" % usec
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865


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
866
867
868
869
870
871
872
873
874
875
876
877
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


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)