cli.py 31.5 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

44

Iustin Pop's avatar
Iustin Pop committed
45
__all__ = ["DEBUG_OPT", "NOHDR_OPT", "SEP_OPT", "GenericMain",
46
           "SubmitOpCode", "GetClient",
47
48
           "cli_option", "ikv_option", "keyval_option",
           "GenerateTable", "AskUser",
Iustin Pop's avatar
Iustin Pop committed
49
           "ARGS_NONE", "ARGS_FIXED", "ARGS_ATLEAST", "ARGS_ANY", "ARGS_ONE",
50
           "USEUNITS_OPT", "FIELDS_OPT", "FORCE_OPT", "SUBMIT_OPT",
51
           "ListTags", "AddTags", "RemoveTags", "TAG_SRC_OPT",
52
           "FormatError", "SplitNodeOption", "SubmitOrSend",
Iustin Pop's avatar
Iustin Pop committed
53
           "JobSubmittedException", "FormatTimestamp", "ParseTimespec",
54
           "ToStderr", "ToStdout", "UsesRPC",
55
           "GetOnlineNodes", "JobExecutor", "SYNC_OPT",
56
57
58
           ]


59

60
61
62
63
64
65
66
67
68
69
70
71
72
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
73
      raise errors.OpPrereqError("no arguments passed to the command")
74
75
76
77
78
79
80
    name = args.pop(0)
    retval = kind, name
  else:
    raise errors.ProgrammerError("Unhandled tag type '%s'" % kind)
  return retval


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


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


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

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

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

175
176
177
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
178

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

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

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

190
191
192
193
194
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")

195
196
197
198
199
SYNC_OPT = make_option("--sync", dest="do_locking",
                       default=False, action="store_true",
                       help="Grab locks while doing the queries"
                       " in order to ensure more consistent results")

200

Iustin Pop's avatar
Iustin Pop committed
201
def ARGS_FIXED(val): # pylint: disable-msg=C0103
Iustin Pop's avatar
Iustin Pop committed
202
203
204
205
  """Macro-like function denoting a fixed number of arguments"""
  return -val


Iustin Pop's avatar
Iustin Pop committed
206
def ARGS_ATLEAST(val): # pylint: disable-msg=C0103
Iustin Pop's avatar
Iustin Pop committed
207
208
209
210
211
212
213
214
215
216
  """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
217
218
219
  """OptParsers custom converter for units.

  """
Iustin Pop's avatar
Iustin Pop committed
220
221
222
  try:
    return utils.ParseUnit(value)
  except errors.UnitParseError, err:
223
    raise OptionValueError("option %s: %s" % (opt, err))
Iustin Pop's avatar
Iustin Pop committed
224
225
226


class CliOption(Option):
Iustin Pop's avatar
Iustin Pop committed
227
228
229
  """Custom option class for optparse.

  """
Iustin Pop's avatar
Iustin Pop committed
230
231
232
233
234
  TYPES = Option.TYPES + ("unit",)
  TYPE_CHECKER = copy.copy(Option.TYPE_CHECKER)
  TYPE_CHECKER["unit"] = check_unit


235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
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_"
254
  UN_PREFIX = "-"
255
256
257
258
259
260
261
  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
262
263
      elif elem.startswith(UN_PREFIX):
        key, val = elem[len(UN_PREFIX):], None
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
310
311
312
313
314
315
      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
316
317
# optparse.py sets make_option, so we do it for our own option class, too
cli_option = CliOption
318
319
ikv_option = IdentKeyValOption
keyval_option = KeyValOption
Iustin Pop's avatar
Iustin Pop committed
320
321


322
def _ParseArgs(argv, commands, aliases):
Iustin Pop's avatar
Iustin Pop committed
323
  """Parser for the command line arguments.
Iustin Pop's avatar
Iustin Pop committed
324

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

Iustin Pop's avatar
Iustin Pop committed
328
329
330
331
  @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, ...}
332

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

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

345
  if len(argv) < 2 or not (argv[1] in commands or
Guido Trotter's avatar
Guido Trotter committed
346
                           argv[1] in aliases):
Iustin Pop's avatar
Iustin Pop committed
347
348
349
    # let's do a nice thing
    sortedcmds = commands.keys()
    sortedcmds.sort()
350
351
352
353
354

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

Iustin Pop's avatar
Iustin Pop committed
359
    # and format a nice command list
360
    ToStdout("Commands:")
Iustin Pop's avatar
Iustin Pop committed
361
    for cmd in sortedcmds:
362
      cmdstr = " %s" % (cmd,)
363
      help_text = commands[cmd][4]
364
365
      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
366
      for line in help_lines:
367
368
369
370
        ToStdout("%-*s   %s", mlen, "", line)

    ToStdout("")

Iustin Pop's avatar
Iustin Pop committed
371
    return None, None, None
372
373

  # get command, unalias it, and look it up in commands
Iustin Pop's avatar
Iustin Pop committed
374
  cmd = argv.pop(1)
375
376
377
378
379
380
381
382
383
384
385
  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
386
387
388
389
390
391
392
393
394
  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:
395
      ToStderr("Error: Command %s expects no arguments", cmd)
Iustin Pop's avatar
Iustin Pop committed
396
397
      return None, None, None
  elif nargs < 0 and len(args) != -nargs:
398
    ToStderr("Error: Command %s expects %d argument(s)", cmd, -nargs)
Iustin Pop's avatar
Iustin Pop committed
399
400
    return None, None, None
  elif nargs >= 0 and len(args) < nargs:
401
    ToStderr("Error: Command %s expects at least %d argument(s)", cmd, nargs)
Iustin Pop's avatar
Iustin Pop committed
402
403
404
405
406
    return None, None, None

  return func, options, args


407
408
409
410
411
412
413
414
415
416
def SplitNodeOption(value):
  """Splits the value of a --node option.

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


417
418
419
420
421
422
423
424
425
426
def UsesRPC(fn):
  def wrapper(*args, **kwargs):
    rpc.Init()
    try:
      return fn(*args, **kwargs)
    finally:
      rpc.Shutdown()
  return wrapper


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

Iustin Pop's avatar
Iustin Pop committed
430
  @param text: the question to ask
Iustin Pop's avatar
Iustin Pop committed
431

Iustin Pop's avatar
Iustin Pop committed
432
433
434
435
  @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
436

Iustin Pop's avatar
Iustin Pop committed
437
438
439
  @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
440
441

  """
442
443
444
445
  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
446
    raise errors.ProgrammerError("Invalid choices argument to AskUser")
447
448
  for entry in choices:
    if not isinstance(entry, tuple) or len(entry) < 3 or entry[0] == '?':
Michael Hanselmann's avatar
Michael Hanselmann committed
449
      raise errors.ProgrammerError("Invalid choices element to AskUser")
450
451
452
453
454
455

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


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

  """


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

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

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

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

  return job_id


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

526
527
528
  prev_job_info = None
  prev_logmsg_serial = None

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

536
537
538
539
540
541
542
543
544
545
    # 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:
546
          encoded = utils.SafeEncode(message)
547
          ToStdout("%s %s", time.ctime(utils.MergeTime(timestamp)), encoded)
548
549
        prev_logmsg_serial = max(prev_logmsg_serial, serial)

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

    prev_job_info = job_info
558

559
  jobs = cl.QueryJobs([job_id], ["status", "opstatus", "opresult"])
560
561
  if not jobs:
    raise errors.JobLost("Job with id %s lost" % job_id)
562

563
  status, opstatus, result = jobs[0]
564
  if status == constants.JOB_STATUS_SUCCESS:
565
    return result
566
567
568
  elif status in (constants.JOB_STATUS_CANCELING,
                  constants.JOB_STATUS_CANCELED):
    raise errors.OpExecError("Job was canceled")
569
  else:
570
571
572
573
574
    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:
575
        errors.MaybeRaise(msg)
576
577
578
579
580
581
        if has_ok:
          raise errors.OpExecError("partial failure (opcode %d): %s" %
                                   (idx, msg))
        else:
          raise errors.OpExecError(str(msg))
    # default failure mode
582
    raise errors.OpExecError(result)
Iustin Pop's avatar
Iustin Pop committed
583
584


585
586
587
588
589
590
591
592
593
594
595
596
597
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)

598
599
600
  op_results = PollJob(job_id, cl=cl, feedback_fn=feedback_fn)

  return op_results[0]
601
602


603
604
605
606
607
608
609
610
611
612
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:
613
614
    job_id = SendJob([op], cl=cl)
    raise JobSubmittedException(job_id)
615
616
617
618
  else:
    return SubmitOpCode(op, cl=cl, feedback_fn=feedback_fn)


619
620
def GetClient():
  # TODO: Cache object?
621
622
623
624
625
626
627
628
629
630
631
  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
632
633


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


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

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

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

730
731
732
733
  if aliases is None:
    aliases = {}

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

737
738
739
740
  if override is not None:
    for key, val in override.iteritems():
      setattr(options, key, val)

Iustin Pop's avatar
Iustin Pop committed
741
742
  utils.SetupLogging(constants.LOG_COMMANDS, debug=options.debug,
                     stderr_logging=True, program=binary)
Iustin Pop's avatar
Iustin Pop committed
743
744

  if old_cmdline:
Iustin Pop's avatar
Iustin Pop committed
745
    logging.info("run with arguments '%s'", old_cmdline)
Iustin Pop's avatar
Iustin Pop committed
746
  else:
Iustin Pop's avatar
Iustin Pop committed
747
    logging.info("run with no arguments")
Iustin Pop's avatar
Iustin Pop committed
748
749

  try:
750
    result = func(options, args)
Iustin Pop's avatar
Iustin Pop committed
751
752
  except (errors.GenericError, luxi.ProtocolError,
          JobSubmittedException), err:
753
    result, err_msg = FormatError(err)
Michael Hanselmann's avatar
Michael Hanselmann committed
754
    logging.exception("Error during command processing")
Iustin Pop's avatar
Iustin Pop committed
755
    ToStderr(err_msg)
Iustin Pop's avatar
Iustin Pop committed
756
757

  return result
758
759


760
def GenerateTable(headers, fields, separator, data,
761
762
                  numfields=None, unitfields=None,
                  units=None):
763
764
  """Prints a table with headers and different fields.

765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
  @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
787
788

  """
789
790
791
792
793
794
  if units is None:
    if separator:
      units = "m"
    else:
      units = "h"

795
796
797
798
799
  if numfields is None:
    numfields = []
  if unitfields is None:
    unitfields = []

Iustin Pop's avatar
Iustin Pop committed
800
801
  numfields = utils.FieldSet(*numfields)   # pylint: disable-msg=W0142
  unitfields = utils.FieldSet(*unitfields) # pylint: disable-msg=W0142
802

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

838
  result = []
839
840
841
842
843
844
845
846
  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)
847
    result.append(format % tuple(args))
848
849
850

  for line in data:
    args = []
851
852
    if line is None:
      line = ['-' for _ in fields]
853
854
855
856
    for idx in xrange(len(fields)):
      if separator is None:
        args.append(mlens[idx])
      args.append(line[idx])
857
858
859
    result.append(format % tuple(args))

  return result
860
861
862
863
864
865
866
867
868


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
869
  @return: a string with the formatted timestamp
870
871

  """
872
873
  if not isinstance (ts, (tuple, list)) or len(ts) != 2:
    return '?'
874
875
  sec, usec = ts
  return time.strftime("%F %T", time.localtime(sec)) + ".%06d" % usec
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
908
909
910
911
912
913
914
915
916
917


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
918
919


920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
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()

938
939
  result = cl.QueryNodes(names=nodes, fields=["name", "offline"],
                         use_locking=False)
940
941
942
943
944
945
  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
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
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)
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000


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
1001
    self.jobs = []
1002
1003

  def QueueJob(self, name, *ops):
1004
    """Record a job for later submit.
1005
1006
1007
1008

    @type name: string
    @param name: a description of the job, will be used in WaitJobSet
    """
1009
1010
1011
1012
1013
1014
1015
1016
1017
    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))
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027

  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

    """
1028
1029
    if not self.jobs:
      self.SubmitPending()
1030
1031
    results = []
    if self.verbose:
1032
1033
1034
1035
1036
1037
1038
1039
      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
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
      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:
1064
1065
1066
1067
1068
1069
1070
      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)