cli.py 18 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
30
from cStringIO import StringIO
Iustin Pop's avatar
Iustin Pop committed
31
32
33
34
35

from ganeti import utils
from ganeti import logger
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
Iustin Pop's avatar
Iustin Pop committed
38
39

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

Iustin Pop's avatar
Iustin Pop committed
42
__all__ = ["DEBUG_OPT", "NOHDR_OPT", "SEP_OPT", "GenericMain",
43
           "SubmitOpCode", "GetClient",
44
           "cli_option", "GenerateTable", "AskUser",
Iustin Pop's avatar
Iustin Pop committed
45
           "ARGS_NONE", "ARGS_FIXED", "ARGS_ATLEAST", "ARGS_ANY", "ARGS_ONE",
46
           "USEUNITS_OPT", "FIELDS_OPT", "FORCE_OPT",
47
           "ListTags", "AddTags", "RemoveTags", "TAG_SRC_OPT",
48
           "FormatError", "SplitNodeOption"
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
           ]


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


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


102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
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)
130
  _ExtendTags(opts, args)
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
  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)
147
  _ExtendTags(opts, args)
148
149
150
151
152
  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
153
154
155
156
157
158
159
160
161

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

162
SEP_OPT = make_option("--separator", default=None,
Iustin Pop's avatar
Iustin Pop committed
163
164
165
166
167
168
169
170
                      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")

171
FIELDS_OPT = make_option("-o", "--output", dest="output", action="store",
172
173
                         type="string", help="Comma separated list of"
                         " output fields",
174
175
                         metavar="FIELDS")

176
177
178
FORCE_OPT = make_option("-f", "--force", dest="force", action="store_true",
                        default=False, help="Force the operation")

179
180
181
TAG_SRC_OPT = make_option("--from", dest="tags_source",
                          default=None, help="File with tag names")

182

Iustin Pop's avatar
Iustin Pop committed
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
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
199
200
201
  """OptParsers custom converter for units.

  """
Iustin Pop's avatar
Iustin Pop committed
202
203
204
  try:
    return utils.ParseUnit(value)
  except errors.UnitParseError, err:
205
    raise OptionValueError("option %s: %s" % (opt, err))
Iustin Pop's avatar
Iustin Pop committed
206
207
208


class CliOption(Option):
Iustin Pop's avatar
Iustin Pop committed
209
210
211
  """Custom option class for optparse.

  """
Iustin Pop's avatar
Iustin Pop committed
212
213
214
215
216
217
218
219
220
  TYPES = Option.TYPES + ("unit",)
  TYPE_CHECKER = copy.copy(Option.TYPE_CHECKER)
  TYPE_CHECKER["unit"] = check_unit


# optparse.py sets make_option, so we do it for our own option class, too
cli_option = CliOption


221
def _ParseArgs(argv, commands, aliases):
Iustin Pop's avatar
Iustin Pop committed
222
223
224
225
226
227
228
229
  """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
230
    aliases: dictionary with command aliases {'alias': 'target, ...}
231

Iustin Pop's avatar
Iustin Pop committed
232
233
234
235
236
237
238
239
240
241
242
243
  """
  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)

244
  if len(argv) < 2 or not (argv[1] in commands or
Guido Trotter's avatar
Guido Trotter committed
245
                           argv[1] in aliases):
Iustin Pop's avatar
Iustin Pop committed
246
247
248
249
250
251
252
    # 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
253
    mlen = max([len(" %s" % cmd) for cmd in commands])
Iustin Pop's avatar
Iustin Pop committed
254
255
256
257
    mlen = min(60, mlen) # should not get here...
    # and format a nice command list
    print "Commands:"
    for cmd in sortedcmds:
258
      cmdstr = " %s" % (cmd,)
259
      help_text = commands[cmd][4]
Iustin Pop's avatar
Iustin Pop committed
260
      help_lines = textwrap.wrap(help_text, 79-3-mlen)
261
      print "%-*s - %s" % (mlen, cmdstr, help_lines.pop(0))
Iustin Pop's avatar
Iustin Pop committed
262
263
264
265
      for line in help_lines:
        print "%-*s   %s" % (mlen, "", line)
    print
    return None, None, None
266
267

  # get command, unalias it, and look it up in commands
Iustin Pop's avatar
Iustin Pop committed
268
  cmd = argv.pop(1)
269
270
271
272
273
274
275
276
277
278
279
  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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
  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


303
304
305
306
307
308
309
310
311
312
def SplitNodeOption(value):
  """Splits the value of a --node option.

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


313
314
def AskUser(text, choices=None):
  """Ask the user a question.
Iustin Pop's avatar
Iustin Pop committed
315
316

  Args:
317
    text - the question to ask.
Iustin Pop's avatar
Iustin Pop committed
318

319
320
321
322
323
324
325
326
    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
327
328

  """
329
330
331
332
333
334
335
336
337
338
339
340
341
342
  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
343
  try:
344
    f = file("/dev/tty", "a+")
Iustin Pop's avatar
Iustin Pop committed
345
  except IOError:
346
    return answer
Iustin Pop's avatar
Iustin Pop committed
347
  try:
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
    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
366
367
368
369
370
  finally:
    f.close()
  return answer


Iustin Pop's avatar
Iustin Pop committed
371
def SubmitOpCode(op, cl=None, feedback_fn=None):
372
  """Legacy function to submit an opcode.
Iustin Pop's avatar
Iustin Pop committed
373
374
375
376
377
378

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

  """
Iustin Pop's avatar
Iustin Pop committed
379
380
  if cl is None:
    cl = luxi.Client()
381

382
  job_id = cl.SubmitJob([op])
383

384
  lastmsg = None
385
  while True:
386
    jobs = cl.QueryJobs([job_id], ["status", "ticker"])
387
    if not jobs:
388
      # job not found, go away!
389
      raise errors.JobLost("Job with id %s lost" % job_id)
390

391
392
393
    # TODO: Handle canceled and archived jobs
    status = jobs[0][0]
    if status in (constants.JOB_STATUS_SUCCESS, constants.JOB_STATUS_ERROR):
394
      break
395
396
    msg = jobs[0][1]
    if msg is not None and msg != lastmsg:
Iustin Pop's avatar
Iustin Pop committed
397
398
399
400
      if callable(feedback_fn):
        feedback_fn(msg)
      else:
        print "%s %s" % (time.ctime(msg[0]), msg[2])
401
    lastmsg = msg
402
403
    time.sleep(1)

404
  jobs = cl.QueryJobs([job_id], ["status", "opresult"])
405
406
  if not jobs:
    raise errors.JobLost("Job with id %s lost" % job_id)
407

408
409
410
411
412
  status, result = jobs[0]
  if status == constants.JOB_STATUS_SUCCESS:
    return result[0]
  else:
    raise errors.OpExecError(result)
Iustin Pop's avatar
Iustin Pop committed
413
414


415
416
417
418
419
def GetClient():
  # TODO: Cache object?
  return luxi.Client()


420
421
422
423
424
425
426
427
428
429
430
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()
431
  msg = str(err)
432
  if isinstance(err, errors.ConfigurationError):
433
434
435
    txt = "Corrupt configuration file: %s" % msg
    logger.Error(txt)
    obuf.write(txt + "\n")
436
437
438
439
440
441
442
443
444
445
446
447
    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):
448
    obuf.write("Failure: hooks general failure: %s" % msg)
449
450
451
452
453
454
455
456
457
  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"
458
               " operation:\n%s" % msg)
459
  elif isinstance(err, errors.OpExecError):
460
    obuf.write("Failure: command execution error:\n%s" % msg)
461
  elif isinstance(err, errors.TagError):
462
    obuf.write("Failure: invalid tag(s) given:\n%s" % msg)
463
  elif isinstance(err, errors.GenericError):
464
    obuf.write("Unhandled Ganeti error: %s" % msg)
465
466
467
468
469
470
471
472
473
  elif isinstance(err, luxi.NoMasterError):
    obuf.write("Cannot communicate with the master daemon.\nIs it running"
               " and listening on '%s'?" % err.args[0])
  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)
474
  else:
475
    obuf.write("Unhandled exception: %s" % msg)
476
477
478
  return retcode, obuf.getvalue().rstrip('\n')


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

482
483
484
485
486
487
  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
488
    - aliases: dictionary with command aliases {'alias': 'target, ...}
Iustin Pop's avatar
Iustin Pop committed
489
490
491
492
493
494
495
496
497
498
499
500
501
502

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

503
504
505
506
  if aliases is None:
    aliases = {}

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

510
511
512
513
  if override is not None:
    for key, val in override.iteritems():
      setattr(options, key, val)

Iustin Pop's avatar
Iustin Pop committed
514
515
  logger.SetupLogging(constants.LOG_COMMANDS, debug=options.debug,
                      stderr_logging=True, program=binary)
Iustin Pop's avatar
Iustin Pop committed
516

517
  utils.debug = options.debug
Iustin Pop's avatar
Iustin Pop committed
518
519
520
521
522
523
524

  if old_cmdline:
    logger.Info("run with arguments '%s'" % old_cmdline)
  else:
    logger.Info("run with no arguments")

  try:
525
    result = func(options, args)
526
  except (errors.GenericError, luxi.ProtocolError), err:
527
528
    result, err_msg = FormatError(err)
    logger.ToStderr(err_msg)
Iustin Pop's avatar
Iustin Pop committed
529
530

  return result
531
532


533
534
def GenerateTable(headers, fields, separator, data,
                  numfields=None, unitfields=None):
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
  """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:
553
554
555
    if headers and field not in headers:
      raise errors.ProgrammerError("Missing header description for field '%s'"
                                   % field)
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
    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)
578
      val = row[idx] = str(val)
579
580
581
      if separator is None:
        mlens[idx] = max(mlens[idx], len(val))

582
  result = []
583
584
585
586
587
588
589
590
  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)
591
    result.append(format % tuple(args))
592
593
594
595
596
597
598

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

  return result