-#!/usr/bin/python
+#
#
# Copyright (C) 2006, 2007 Google Inc.
import textwrap
import os.path
import copy
+from cStringIO import StringIO
from ganeti import utils
from ganeti import logger
"ARGS_NONE", "ARGS_FIXED", "ARGS_ATLEAST", "ARGS_ANY", "ARGS_ONE",
"USEUNITS_OPT", "FIELDS_OPT", "FORCE_OPT",
"ListTags", "AddTags", "RemoveTags", "TAG_SRC_OPT",
+ "FormatError", "SplitNodeOption"
]
retval = kind, kind
elif kind == constants.TAG_NODE or kind == constants.TAG_INSTANCE:
if not args:
- raise errors.OpPrereq("no arguments passed to the command")
+ raise errors.OpPrereqError("no arguments passed to the command")
name = args.pop(0)
retval = kind, name
else:
help="Print sizes in human readable format")
FIELDS_OPT = make_option("-o", "--output", dest="output", action="store",
- type="string", help="Select output fields",
+ type="string", help="Comma separated list of"
+ " output fields",
metavar="FIELDS")
FORCE_OPT = make_option("-f", "--force", dest="force", action="store_true",
_LOCK_OPT = make_option("--lock-retries", default=None,
type="int", help=SUPPRESS_HELP)
+_LOCK_NOAUTOCLEAN = make_option("--lock-noautoclean", default=False,
+ action="store_true", help=SUPPRESS_HELP)
+
TAG_SRC_OPT = make_option("--from", dest="tags_source",
default=None, help="File with tag names")
+
def ARGS_FIXED(val):
"""Macro-like function denoting a fixed number of arguments"""
return -val
def check_unit(option, opt, value):
+ """OptParsers custom converter for units.
+
+ """
try:
return utils.ParseUnit(value)
except errors.UnitParseError, err:
class CliOption(Option):
+ """Custom option class for optparse.
+
+ """
TYPES = Option.TYPES + ("unit",)
TYPE_CHECKER = copy.copy(Option.TYPE_CHECKER)
TYPE_CHECKER["unit"] = check_unit
cli_option = CliOption
-def _ParseArgs(argv, commands):
+def _ParseArgs(argv, commands, aliases):
"""Parses the command line and return the function which must be
executed together with its arguments
commands: dictionary with special contents, see the design doc for
cmdline handling
+ aliases: dictionary with command aliases {'alias': 'target, ...}
"""
if len(argv) == 0:
# argument. optparse.py does it the same.
sys.exit(0)
- if len(argv) < 2 or argv[1] not in commands.keys():
+ if len(argv) < 2 or not (argv[1] in commands or
+ argv[1] in aliases):
# let's do a nice thing
sortedcmds = commands.keys()
sortedcmds.sort()
print "%-*s %s" % (mlen, "", line)
print
return None, None, None
+
+ # get command, unalias it, and look it up in commands
cmd = argv.pop(1)
+ 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]
+
func, nargs, parser_opts, usage, description = commands[cmd]
parser_opts.append(_LOCK_OPT)
+ parser_opts.append(_LOCK_NOAUTOCLEAN)
parser = OptionParser(option_list=parser_opts,
description=description,
formatter=TitledHelpFormatter(),
return func, options, args
+def SplitNodeOption(value):
+ """Splits the value of a --node option.
+
+ """
+ if value and ':' in value:
+ return value.split(':', 1)
+ else:
+ return (value, None)
+
+
def AskUser(text, choices=None):
"""Ask the user a question.
new_text.append(textwrap.fill(line, 70, replace_whitespace=False))
text = "\n".join(new_text)
try:
- f = file("/dev/tty", "r+")
+ f = file("/dev/tty", "a+")
except IOError:
return answer
try:
return answer
-def SubmitOpCode(op):
+def SubmitOpCode(op, proc=None, feedback_fn=None):
"""Function to submit an opcode.
This is just a simple wrapper over the construction of the processor
interaction functions.
"""
- proc = mcpu.Processor()
- return proc.ExecOpCode(op, logger.ToStdout)
+ if feedback_fn is None:
+ feedback_fn = logger.ToStdout
+ if proc is None:
+ proc = mcpu.Processor(feedback=feedback_fn)
+ return proc.ExecOpCode(op)
+
+
+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()
+ msg = str(err)
+ if isinstance(err, errors.ConfigurationError):
+ txt = "Corrupt configuration file: %s" % msg
+ logger.Error(txt)
+ obuf.write(txt + "\n")
+ 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):
+ obuf.write("Failure: hooks general failure: %s" % msg)
+ 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"
+ " operation:\n%s" % msg)
+ elif isinstance(err, errors.OpExecError):
+ obuf.write("Failure: command execution error:\n%s" % msg)
+ elif isinstance(err, errors.TagError):
+ obuf.write("Failure: invalid tag(s) given:\n%s" % msg)
+ elif isinstance(err, errors.GenericError):
+ obuf.write("Unhandled Ganeti error: %s" % msg)
+ else:
+ obuf.write("Unhandled exception: %s" % msg)
+ return retcode, obuf.getvalue().rstrip('\n')
-def GenericMain(commands, override=None):
+def GenericMain(commands, override=None, aliases=None):
"""Generic main function for all the gnt-* commands.
Arguments:
- 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
+ - aliases: dictionary with command aliases {'alias': 'target, ...}
"""
# save the program name and the entire command line for later logging
binary = "<unknown program>"
old_cmdline = ""
- func, options, args = _ParseArgs(sys.argv, commands)
+ if aliases is None:
+ aliases = {}
+
+ func, options, args = _ParseArgs(sys.argv, commands, aliases)
if func is None: # parse error
return 1
logger.SetupLogging(debug=options.debug, program=binary)
+ utils.debug = options.debug
try:
- utils.Lock('cmd', max_retries=options.lock_retries, debug=options.debug)
+ utils.Lock('cmd', max_retries=options.lock_retries, debug=options.debug,
+ autoclean=not options.lock_noautoclean)
except errors.LockError, err:
logger.ToStderr(str(err))
return 1
+ except KeyboardInterrupt:
+ logger.ToStderr("Aborting.")
+ return 1
if old_cmdline:
logger.Info("run with arguments '%s'" % old_cmdline)
try:
try:
result = func(options, args)
- except errors.ConfigurationError, err:
- logger.Error("Corrupt configuration file: %s" % err)
- logger.ToStderr("Aborting.")
- result = 2
- except errors.HooksAbort, err:
- logger.ToStderr("Failure: hooks execution failed:")
- for node, script, out in err.args[0]:
- if out:
- logger.ToStderr(" node: %s, script: %s, output: %s" %
- (node, script, out))
- else:
- logger.ToStderr(" node: %s, script: %s (no output)" %
- (node, script))
- result = 1
- except errors.HooksFailure, err:
- logger.ToStderr("Failure: hooks general failure: %s" % str(err))
- result = 1
- except errors.ResolverError, err:
- 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'"
- logger.ToStderr(msg % err.args[0])
- result = 1
- except errors.OpPrereqError, err:
- logger.ToStderr("Failure: prerequisites not met for this"
- " operation:\n%s" % str(err))
- result = 1
- except errors.OpExecError, err:
- logger.ToStderr("Failure: command execution error:\n%s" % str(err))
- result = 1
+ except errors.GenericError, err:
+ result, err_msg = FormatError(err)
+ logger.ToStderr(err_msg)
finally:
utils.Unlock('cmd')
utils.LockCleanup()
format_fields = []
for field in fields:
+ if headers and field not in headers:
+ raise errors.ProgrammerError("Missing header description for field '%s'"
+ % field)
if separator is not None:
format_fields.append("%s")
elif field in numfields:
pass
else:
val = row[idx] = utils.FormatUnit(val)
+ val = row[idx] = str(val)
if separator is None:
mlens[idx] = max(mlens[idx], len(val))
projects / ganeti-local / blobdiff