X-Git-Url: https://code.grnet.gr/git/ganeti-local/blobdiff_plain/810c50b7d98936a4c6b50ca41e8227ed70820cf0..acec9d51f4aea4b4571fcee477bea935487b8b83:/lib/cli.py diff --git a/lib/cli.py b/lib/cli.py index 0a27edd..917b345 100644 --- a/lib/cli.py +++ b/lib/cli.py @@ -1,4 +1,4 @@ -#!/usr/bin/python +# # # Copyright (C) 2006, 2007 Google Inc. @@ -26,6 +26,8 @@ import sys import textwrap import os.path import copy +import time +from cStringIO import StringIO from ganeti import utils from ganeti import logger @@ -33,15 +35,18 @@ from ganeti import errors from ganeti import mcpu from ganeti import constants from ganeti import opcodes +from ganeti import luxi from optparse import (OptionParser, make_option, TitledHelpFormatter, Option, OptionValueError, SUPPRESS_HELP) -__all__ = ["DEBUG_OPT", "NOHDR_OPT", "SEP_OPT", "GenericMain", "SubmitOpCode", +__all__ = ["DEBUG_OPT", "NOHDR_OPT", "SEP_OPT", "GenericMain", + "SubmitOpCode", "SubmitJob", "SubmitQuery", "cli_option", "GenerateTable", "AskUser", "ARGS_NONE", "ARGS_FIXED", "ARGS_ATLEAST", "ARGS_ANY", "ARGS_ONE", "USEUNITS_OPT", "FIELDS_OPT", "FORCE_OPT", "ListTags", "AddTags", "RemoveTags", "TAG_SRC_OPT", + "FormatError", "SplitNodeOption" ] @@ -58,7 +63,7 @@ def _ExtractTagsObject(opts, args): 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: @@ -165,18 +170,17 @@ USEUNITS_OPT = make_option("--human-readable", default=False, 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", default=False, help="Force the operation") -_LOCK_OPT = make_option("--lock-retries", default=None, - type="int", 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 @@ -193,6 +197,9 @@ ARGS_ANY = ARGS_ATLEAST(0) def check_unit(option, opt, value): + """OptParsers custom converter for units. + + """ try: return utils.ParseUnit(value) except errors.UnitParseError, err: @@ -200,6 +207,9 @@ def check_unit(option, opt, value): class CliOption(Option): + """Custom option class for optparse. + + """ TYPES = Option.TYPES + ("unit",) TYPE_CHECKER = copy.copy(Option.TYPE_CHECKER) TYPE_CHECKER["unit"] = check_unit @@ -209,7 +219,7 @@ class CliOption(Option): 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 @@ -218,6 +228,7 @@ def _ParseArgs(argv, commands): commands: dictionary with special contents, see the design doc for cmdline handling + aliases: dictionary with command aliases {'alias': 'target, ...} """ if len(argv) == 0: @@ -231,7 +242,8 @@ def _ParseArgs(argv, commands): # 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() @@ -239,23 +251,34 @@ def _ParseArgs(argv, commands): "\n%(bin)s --help to see details, or" " man %(bin)s\n" % {"bin": binary}) # compute the max line length for cmd + usage - mlen = max([len(" %s %s" % (cmd, commands[cmd][3])) for cmd in commands]) + mlen = max([len(" %s" % cmd) for cmd in commands]) mlen = min(60, mlen) # should not get here... # and format a nice command list print "Commands:" for cmd in sortedcmds: - cmdstr = " %s %s" % (cmd, commands[cmd][3]) + cmdstr = " %s" % (cmd,) help_text = commands[cmd][4] help_lines = textwrap.wrap(help_text, 79-3-mlen) - print "%-*s - %s" % (mlen, cmdstr, - help_lines.pop(0)) + print "%-*s - %s" % (mlen, cmdstr, help_lines.pop(0)) for line in help_lines: 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 = OptionParser(option_list=parser_opts, description=description, formatter=TitledHelpFormatter(), @@ -278,6 +301,16 @@ def _ParseArgs(argv, commands): 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. @@ -309,7 +342,7 @@ def AskUser(text, choices=None): 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: @@ -336,7 +369,7 @@ def AskUser(text, choices=None): 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 @@ -344,11 +377,101 @@ def SubmitOpCode(op): interaction functions. """ - proc = mcpu.Processor() - return proc.ExecOpCode(op, logger.ToStdout) + # TODO: Fix feedback_fn situation. + cl = luxi.Client() + job = opcodes.Job(op_list=[op]) + jid = SubmitJob(job) + + query = { + "object": "jobs", + "fields": ["status"], + "names": [jid], + } + + while True: + jdata = SubmitQuery(query) + if not jdata: + # job not found, go away! + raise errors.JobLost("Job with id %s lost" % jid) + + status = jdata[0][0] + if status in (opcodes.Job.STATUS_SUCCESS, opcodes.Job.STATUS_FAIL): + break + time.sleep(1) + + query["fields"].extend(["op_list", "op_status", "op_result"]) + jdata = SubmitQuery(query) + if not jdata: + raise errors.JobLost("Job with id %s lost" % jid) + status, op_list, op_status, op_result = jdata[0] + if status != opcodes.Job.STATUS_SUCCESS: + raise errors.OpExecError(op_result[0]) + return op_result[0] + + +def SubmitJob(job, cl=None): + if cl is None: + cl = luxi.Client() + return cl.SubmitJob(job) + + +def SubmitQuery(data, cl=None): + if cl is None: + cl = luxi.Client() + return cl.Query(data) + + +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: @@ -357,6 +480,7 @@ def GenericMain(commands, override=None): - 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 @@ -371,7 +495,10 @@ def GenericMain(commands, override=None): binary = "" 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 @@ -379,13 +506,9 @@ def GenericMain(commands, override=None): for key, val in override.iteritems(): setattr(options, key, val) - logger.SetupLogging(debug=options.debug, program=binary) + logger.SetupLogging(program=binary, debug=options.debug) - try: - utils.Lock('cmd', max_retries=options.lock_retries, debug=options.debug) - except errors.LockError, err: - logger.ToStderr(str(err)) - return 1 + utils.debug = options.debug if old_cmdline: logger.Info("run with arguments '%s'" % old_cmdline) @@ -393,43 +516,10 @@ def GenericMain(commands, override=None): logger.Info("run with no arguments") 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 - finally: - utils.Unlock('cmd') - utils.LockCleanup() + result = func(options, args) + except errors.GenericError, err: + result, err_msg = FormatError(err) + logger.ToStderr(err_msg) return result @@ -454,6 +544,9 @@ def GenerateTable(headers, fields, separator, data, 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: @@ -476,6 +569,7 @@ def GenerateTable(headers, fields, separator, data, pass else: val = row[idx] = utils.FormatUnit(val) + val = row[idx] = str(val) if separator is None: mlens[idx] = max(mlens[idx], len(val))