cli.py 33.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
           "cli_option",
48
           "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", "CONFIRM_OPT",
56
57
           "ArgJobId", "ArgSuggest", "ArgUnknown", "ArgFile", "ArgCommand",
           "ArgInstance", "ArgNode", "ArgChoice",
58
59
           ]

60
61
NO_PREFIX = "no_"
UN_PREFIX = "-"
62

63

64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
class _Argument:
  def __init__(self, min=0, max=None, suggest=None):
    self.min = min
    self.max = max

  def __repr__(self):
    return ("<%s min=%s max=%s>" %
            (self.__class__.__name__, self.min, self.max))


class ArgSuggest(_Argument):
  """Suggesting argument.

  Value can be any of the ones passed to the constructor.

  """
  def __init__(self, min=0, max=None, choices=None):
    _Argument.__init__(self, min=min, max=max)
    self.choices = choices

  def __repr__(self):
    return ("<%s min=%s max=%s choices=%r>" %
            (self.__class__.__name__, self.min, self.max, self.choices))


class ArgChoice(ArgSuggest):
  """Choice argument.

  Value can be any of the ones passed to the constructor. Like L{ArgSuggest},
  but value must be one of the choices.

  """


class ArgUnknown(_Argument):
  """Unknown argument to program (e.g. determined at runtime).

  """


class ArgInstance(_Argument):
  """Instances argument.

  """


class ArgNode(_Argument):
  """Node argument.

  """

class ArgJobId(_Argument):
  """Job ID argument.

  """


class ArgFile(_Argument):
  """File path argument.

  """


class ArgCommand(_Argument):
  """Command argument.

  """


133
134
135
136
137
138
139
140
141
142
143
144
145
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
146
      raise errors.OpPrereqError("no arguments passed to the command")
147
148
149
150
151
152
153
    name = args.pop(0)
    retval = kind, name
  else:
    raise errors.ProgrammerError("Unhandled tag type '%s'" % kind)
  return retval


154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
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)


183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
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:
198
    ToStdout(tag)
199
200
201
202
203
204
205
206
207
208
209
210


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)
211
  _ExtendTags(opts, args)
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
  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)
228
  _ExtendTags(opts, args)
229
230
231
232
233
  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
234
235
236
237
238
239
240
241
242

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

243
SEP_OPT = make_option("--separator", default=None,
Iustin Pop's avatar
Iustin Pop committed
244
245
246
247
                      action="store", dest="separator",
                      help="Separator between output fields"
                      " (defaults to one space)")

248
249
250
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
251

252
FIELDS_OPT = make_option("-o", "--output", dest="output", action="store",
253
254
                         type="string", help="Comma separated list of"
                         " output fields",
255
256
                         metavar="FIELDS")

257
258
259
FORCE_OPT = make_option("-f", "--force", dest="force", action="store_true",
                        default=False, help="Force the operation")

260
261
262
CONFIRM_OPT = make_option("--yes", dest="confirm", action="store_true",
                          default=False, help="Do not require confirmation")

263
264
265
TAG_SRC_OPT = make_option("--from", dest="tags_source",
                          default=None, help="File with tag names")

266
267
268
269
270
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")

271
272
273
274
275
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")

276
277
278
279
280
_DRY_RUN_OPT = make_option("--dry-run", default=False,
                          action="store_true",
                          help="Do not execute the operation, just run the"
                          " check steps and verify it it could be executed")

281

Iustin Pop's avatar
Iustin Pop committed
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
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
298
299
300
  """OptParsers custom converter for units.

  """
Iustin Pop's avatar
Iustin Pop committed
301
302
303
  try:
    return utils.ParseUnit(value)
  except errors.UnitParseError, err:
304
    raise OptionValueError("option %s: %s" % (opt, err))
Iustin Pop's avatar
Iustin Pop committed
305
306


307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
def _SplitKeyVal(opt, data):
  """Convert a KeyVal string into a dict.

  This function will convert a key=val[,...] string into a dict. Empty
  values will be converted specially: keys which have the prefix 'no_'
  will have the value=False and the prefix stripped, the others will
  have value=True.

  @type opt: string
  @param opt: a string holding the option name for which we process the
      data, used in building error messages
  @type data: string
  @param data: a string of the format key=val,key=val,...
  @rtype: dict
  @return: {key=val, key=val}
  @raises errors.ParameterError: if there are duplicate keys

  """
  kv_dict = {}
326
327
328
329
  if data:
    for elem in data.split(","):
      if "=" in elem:
        key, val = elem.split("=", 1)
330
      else:
331
332
333
334
335
336
337
338
339
340
        if elem.startswith(NO_PREFIX):
          key, val = elem[len(NO_PREFIX):], False
        elif elem.startswith(UN_PREFIX):
          key, val = elem[len(UN_PREFIX):], None
        else:
          key, val = elem, True
      if key in kv_dict:
        raise errors.ParameterError("Duplicate key '%s' in option %s" %
                                    (key, opt))
      kv_dict[key] = val
341
342
343
344
  return kv_dict


def check_ident_key_val(option, opt, value):
345
346
347
348
  """Custom parser for ident:key=val,key=val options.

  This will store the parsed values as a tuple (ident, {key: val}). As such,
  multiple uses of this option via action=append is possible.
349
350
351

  """
  if ":" not in value:
352
    ident, rest = value, ''
353
354
  else:
    ident, rest = value.split(":", 1)
355
356
357
358
359
360
361
362
363
364
365
366

  if ident.startswith(NO_PREFIX):
    if rest:
      msg = "Cannot pass options when removing parameter groups: %s" % value
      raise errors.ParameterError(msg)
    retval = (ident[len(NO_PREFIX):], False)
  elif ident.startswith(UN_PREFIX):
    if rest:
      msg = "Cannot pass options when removing parameter groups: %s" % value
      raise errors.ParameterError(msg)
    retval = (ident[len(UN_PREFIX):], None)
  else:
367
368
369
370
371
372
    kv_dict = _SplitKeyVal(opt, rest)
    retval = (ident, kv_dict)
  return retval


def check_key_val(option, opt, value):
373
374
375
  """Custom parser class for key=val,key=val options.

  This will store the parsed values as a dict {key: val}.
376
377
378
379
380

  """
  return _SplitKeyVal(opt, value)


381
382
class CliOption(Option):
  """Custom option class for optparse.
383
384

  """
385
386
387
  ATTRS = Option.ATTRS + [
    "completion_suggest",
    ]
388
389
390
391
392
393
394
  TYPES = Option.TYPES + (
    "identkeyval",
    "keyval",
    "unit",
    )
  TYPE_CHECKER = Option.TYPE_CHECKER.copy()
  TYPE_CHECKER["identkeyval"] = check_ident_key_val
395
  TYPE_CHECKER["keyval"] = check_key_val
396
  TYPE_CHECKER["unit"] = check_unit
397
398


Iustin Pop's avatar
Iustin Pop committed
399
400
401
402
# optparse.py sets make_option, so we do it for our own option class, too
cli_option = CliOption


403
def _ParseArgs(argv, commands, aliases):
Iustin Pop's avatar
Iustin Pop committed
404
  """Parser for the command line arguments.
Iustin Pop's avatar
Iustin Pop committed
405

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

Iustin Pop's avatar
Iustin Pop committed
409
410
411
412
  @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, ...}
413

Iustin Pop's avatar
Iustin Pop committed
414
415
416
417
418
419
420
  """
  if len(argv) == 0:
    binary = "<command>"
  else:
    binary = argv[0].split("/")[-1]

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

426
  if len(argv) < 2 or not (argv[1] in commands or
Guido Trotter's avatar
Guido Trotter committed
427
                           argv[1] in aliases):
Iustin Pop's avatar
Iustin Pop committed
428
429
430
    # let's do a nice thing
    sortedcmds = commands.keys()
    sortedcmds.sort()
431
432
433
434
435

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

Iustin Pop's avatar
Iustin Pop committed
440
    # and format a nice command list
441
    ToStdout("Commands:")
Iustin Pop's avatar
Iustin Pop committed
442
    for cmd in sortedcmds:
443
      cmdstr = " %s" % (cmd,)
444
      help_text = commands[cmd][4]
445
446
      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
447
      for line in help_lines:
448
449
450
451
        ToStdout("%-*s   %s", mlen, "", line)

    ToStdout("")

Iustin Pop's avatar
Iustin Pop committed
452
    return None, None, None
453
454

  # get command, unalias it, and look it up in commands
Iustin Pop's avatar
Iustin Pop committed
455
  cmd = argv.pop(1)
456
457
458
459
460
461
462
463
464
465
466
  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
467
  func, nargs, parser_opts, usage, description = commands[cmd]
468
  parser = OptionParser(option_list=parser_opts + [_DRY_RUN_OPT],
Iustin Pop's avatar
Iustin Pop committed
469
470
471
472
473
474
475
                        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:
476
      ToStderr("Error: Command %s expects no arguments", cmd)
Iustin Pop's avatar
Iustin Pop committed
477
478
      return None, None, None
  elif nargs < 0 and len(args) != -nargs:
479
    ToStderr("Error: Command %s expects %d argument(s)", cmd, -nargs)
Iustin Pop's avatar
Iustin Pop committed
480
481
    return None, None, None
  elif nargs >= 0 and len(args) < nargs:
482
    ToStderr("Error: Command %s expects at least %d argument(s)", cmd, nargs)
Iustin Pop's avatar
Iustin Pop committed
483
484
485
486
487
    return None, None, None

  return func, options, args


488
489
490
491
492
493
494
495
496
497
def SplitNodeOption(value):
  """Splits the value of a --node option.

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


498
499
500
501
502
503
504
505
506
507
def UsesRPC(fn):
  def wrapper(*args, **kwargs):
    rpc.Init()
    try:
      return fn(*args, **kwargs)
    finally:
      rpc.Shutdown()
  return wrapper


508
509
def AskUser(text, choices=None):
  """Ask the user a question.
Iustin Pop's avatar
Iustin Pop committed
510

Iustin Pop's avatar
Iustin Pop committed
511
  @param text: the question to ask
Iustin Pop's avatar
Iustin Pop committed
512

Iustin Pop's avatar
Iustin Pop committed
513
514
515
516
  @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
517

Iustin Pop's avatar
Iustin Pop committed
518
519
520
  @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
521
522

  """
523
524
525
526
  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
527
    raise errors.ProgrammerError("Invalid choices argument to AskUser")
528
529
  for entry in choices:
    if not isinstance(entry, tuple) or len(entry) < 3 or entry[0] == '?':
Michael Hanselmann's avatar
Michael Hanselmann committed
530
      raise errors.ProgrammerError("Invalid choices element to AskUser")
531
532
533
534
535
536

  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
537
  try:
538
    f = file("/dev/tty", "a+")
Iustin Pop's avatar
Iustin Pop committed
539
  except IOError:
540
    return answer
Iustin Pop's avatar
Iustin Pop committed
541
  try:
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
    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
560
561
562
563
564
  finally:
    f.close()
  return answer


565
566
567
568
569
570
571
572
573
574
575
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.

  """


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

579
580
581
582
583
  @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
584
585

  """
Iustin Pop's avatar
Iustin Pop committed
586
  if cl is None:
587
    cl = GetClient()
588

589
590
591
592
593
  job_id = cl.SubmitJob(ops)

  return job_id


Michael Hanselmann's avatar
Michael Hanselmann committed
594
def PollJob(job_id, cl=None, feedback_fn=None):
595
596
597
598
599
600
601
602
603
604
605
  """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()
606

607
608
609
  prev_job_info = None
  prev_logmsg_serial = None

610
  while True:
611
612
613
    result = cl.WaitForJobChange(job_id, ["status"], prev_job_info,
                                 prev_logmsg_serial)
    if not result:
614
      # job not found, go away!
615
      raise errors.JobLost("Job with id %s lost" % job_id)
616

617
618
619
620
621
622
623
624
625
626
    # 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:
627
          encoded = utils.SafeEncode(message)
628
          ToStdout("%s %s", time.ctime(utils.MergeTime(timestamp)), encoded)
629
630
        prev_logmsg_serial = max(prev_logmsg_serial, serial)

631
    # TODO: Handle canceled and archived jobs
632
633
634
635
    elif status in (constants.JOB_STATUS_SUCCESS,
                    constants.JOB_STATUS_ERROR,
                    constants.JOB_STATUS_CANCELING,
                    constants.JOB_STATUS_CANCELED):
636
      break
637
638

    prev_job_info = job_info
639

640
  jobs = cl.QueryJobs([job_id], ["status", "opstatus", "opresult"])
641
642
  if not jobs:
    raise errors.JobLost("Job with id %s lost" % job_id)
643

644
  status, opstatus, result = jobs[0]
645
  if status == constants.JOB_STATUS_SUCCESS:
646
    return result
647
648
649
  elif status in (constants.JOB_STATUS_CANCELING,
                  constants.JOB_STATUS_CANCELED):
    raise errors.OpExecError("Job was canceled")
650
  else:
651
652
653
654
655
656
657
658
659
660
661
    has_ok = False
    for idx, (status, msg) in enumerate(zip(opstatus, result)):
      if status == constants.OP_STATUS_SUCCESS:
        has_ok = True
      elif status == constants.OP_STATUS_ERROR:
        if has_ok:
          raise errors.OpExecError("partial failure (opcode %d): %s" %
                                   (idx, msg))
        else:
          raise errors.OpExecError(str(msg))
    # default failure mode
662
    raise errors.OpExecError(result)
Iustin Pop's avatar
Iustin Pop committed
663
664


665
666
667
668
669
670
671
672
673
674
675
676
677
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)

678
679
680
  op_results = PollJob(job_id, cl=cl, feedback_fn=feedback_fn)

  return op_results[0]
681
682


683
684
685
686
687
688
689
690
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.

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

693
  """
694
695
  if opts and opts.dry_run:
    op.dry_run = opts.dry_run
696
  if opts and opts.submit_only:
697
698
    job_id = SendJob([op], cl=cl)
    raise JobSubmittedException(job_id)
699
700
701
702
  else:
    return SubmitOpCode(op, cl=cl, feedback_fn=feedback_fn)


703
704
def GetClient():
  # TODO: Cache object?
705
706
707
708
709
710
711
712
713
714
715
  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
716
717


718
719
720
721
722
723
724
725
726
727
728
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()
729
  msg = str(err)
730
  if isinstance(err, errors.ConfigurationError):
731
    txt = "Corrupt configuration file: %s" % msg
Iustin Pop's avatar
Iustin Pop committed
732
    logging.error(txt)
733
    obuf.write(txt + "\n")
734
735
736
737
738
739
740
741
742
743
744
745
    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):
746
    obuf.write("Failure: hooks general failure: %s" % msg)
747
748
749
750
751
752
753
754
755
  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"
756
               " operation:\n%s" % msg)
757
  elif isinstance(err, errors.OpExecError):
758
    obuf.write("Failure: command execution error:\n%s" % msg)
759
  elif isinstance(err, errors.TagError):
760
    obuf.write("Failure: invalid tag(s) given:\n%s" % msg)
761
762
763
  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
764
765
766
  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")
767
768
  elif isinstance(err, errors.TypeEnforcementError):
    obuf.write("Parameter Error: %s" % msg)
769
770
  elif isinstance(err, errors.ParameterError):
    obuf.write("Failure: unknown/wrong parameter name '%s'" % msg)
771
  elif isinstance(err, errors.GenericError):
772
    obuf.write("Unhandled Ganeti error: %s" % msg)
773
774
  elif isinstance(err, luxi.NoMasterError):
    obuf.write("Cannot communicate with the master daemon.\nIs it running"
775
               " and listening for connections?")
776
777
778
779
780
781
  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)
782
783
784
  elif isinstance(err, JobSubmittedException):
    obuf.write("JobID: %s\n" % err.args[0])
    retcode = 0
785
  else:
786
    obuf.write("Unhandled exception: %s" % msg)
787
788
789
  return retcode, obuf.getvalue().rstrip('\n')


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

793
794
795
796
797
798
  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
799
    - aliases: dictionary with command aliases {'alias': 'target, ...}
Iustin Pop's avatar
Iustin Pop committed
800
801
802
803
804
805
806
807
808
809
810
811
812
813

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

814
815
816
  if aliases is None:
    aliases = {}

817
818
819
820
821
822
823
  try:
    func, options, args = _ParseArgs(sys.argv, commands, aliases)
  except errors.ParameterError, err:
    result, err_msg = FormatError(err)
    ToStderr(err_msg)
    return 1

Iustin Pop's avatar
Iustin Pop committed
824
825
826
  if func is None: # parse error
    return 1

827
828
829
830
  if override is not None:
    for key, val in override.iteritems():
      setattr(options, key, val)

Iustin Pop's avatar
Iustin Pop committed
831
832
  utils.SetupLogging(constants.LOG_COMMANDS, debug=options.debug,
                     stderr_logging=True, program=binary)
Iustin Pop's avatar
Iustin Pop committed
833
834

  if old_cmdline:
Iustin Pop's avatar
Iustin Pop committed
835
    logging.info("run with arguments '%s'", old_cmdline)
Iustin Pop's avatar
Iustin Pop committed
836
  else:
Iustin Pop's avatar
Iustin Pop committed
837
    logging.info("run with no arguments")
Iustin Pop's avatar
Iustin Pop committed
838
839

  try:
840
    result = func(options, args)
Iustin Pop's avatar
Iustin Pop committed
841
842
  except (errors.GenericError, luxi.ProtocolError,
          JobSubmittedException), err:
843
    result, err_msg = FormatError(err)
Michael Hanselmann's avatar
Michael Hanselmann committed
844
    logging.exception("Error during command processing")
Iustin Pop's avatar
Iustin Pop committed
845
    ToStderr(err_msg)
Iustin Pop's avatar
Iustin Pop committed
846
847

  return result
848
849


850
def GenerateTable(headers, fields, separator, data,
851
852
                  numfields=None, unitfields=None,
                  units=None):
853
854
  """Prints a table with headers and different fields.

855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
  @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
877
878

  """
879
880
881
882
883
884
  if units is None:
    if separator:
      units = "m"
    else:
      units = "h"

885
886
887
888
889
  if numfields is None:
    numfields = []
  if unitfields is None:
    unitfields = []

890
891
892
  numfields = utils.FieldSet(*numfields)
  unitfields = utils.FieldSet(*unitfields)

893
894
  format_fields = []
  for field in fields:
895
    if headers and field not in headers:
896
      # TODO: handle better unknown fields (either revert to old
897
898
899
      # style of raising exception, or deal more intelligently with
      # variable fields)
      headers[field] = field
900
901
    if separator is not None:
      format_fields.append("%s")
902
    elif numfields.Matches(field):
903
904
905
906
907
908
909
910
911
912
913
      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:
914
915
    if row is None:
      continue
916
    for idx, val in enumerate(row):
917
      if unitfields.Matches(fields[idx]):
918
919
920
921
922
        try:
          val = int(val)
        except ValueError:
          pass
        else:
923
          val = row[idx] = utils.FormatUnit(val, units)
924
      val = row[idx] = str(val)
925
926
927
      if separator is None:
        mlens[idx] = max(mlens[idx], len(val))

928
  result = []
929
930
931
932
933
934
935
936
  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)
937
    result.append(format % tuple(args))
938
939
940

  for line in data:
    args = []
941
942
    if line is None:
      line = ['-' for _ in fields]
943
944
945
946
    for idx in xrange(len(fields)):
      if separator is None:
        args.append(mlens[idx])
      args.append(line[idx])
947
948
949
    result.append(format % tuple(args))

  return result
950
951
952
953
954
955
956
957
958


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
959
  @return: a string with the formatted timestamp
960
961

  """
962
963
  if not isinstance (ts, (tuple, list)) or len(ts) != 2:
    return '?'
964
965
  sec, usec = ts
  return time.strftime("%F %T", time.localtime(sec)) + ".%06d" % usec
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007


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
1008
1009


1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
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()

1028
1029
  result = cl.QueryNodes(names=nodes, fields=["name", "offline"],
                         use_locking=False)
1030
1031
1032
1033
1034
1035
  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
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
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)
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090


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
1091
    self.jobs = []
1092
1093

  def QueueJob(self, name, *ops):
1094
    """Record a job for later submit.
1095
1096
1097
1098

    @type name: string
    @param name: a description of the job, will be used in WaitJobSet
    """
1099
1100
1101
1102
1103
1104
1105
1106
1107
    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))
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117

  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

    """
1118
1119
    if not self.jobs:
      self.SubmitPending()
1120
1121
    results = []
    if self.verbose:
1122
1123
1124
1125
1126
1127
1128
1129
      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
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
      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:
1154
1155
1156
1157
1158
1159
1160
      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)