Synnefo » snf-ganeti » ganeti-local

#

#

# 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

import time

import logging

from cStringIO import StringIO

from ganeti import utils

from ganeti import errors

from ganeti import constants

from ganeti import opcodes

from ganeti import luxi

from ganeti import ssconf

from ganeti import rpc

from optparse import (OptionParser, TitledHelpFormatter,

                      Option, OptionValueError)

__all__ = [

  # Command line options

  "CONFIRM_OPT",

  "DEBUG_OPT",

  "DEBUG_SIMERR_OPT",

  "DISK_TEMPLATE_OPT",

  "FIELDS_OPT",

  "FILESTORE_DIR_OPT",

  "FORCE_OPT",

  "NOHDR_OPT",

  "NONICS_OPT",

  "NWSYNC_OPT",

  "SEP_OPT",

  "SUBMIT_OPT",

  "SYNC_OPT",

  "TAG_SRC_OPT",

  "USEUNITS_OPT",

  "VERBOSE_OPT",

  # Generic functions for CLI programs

  "GenericMain",

  "GetClient",

  "GetOnlineNodes",

  "JobExecutor",

  "JobSubmittedException",

  "ParseTimespec",

  "SubmitOpCode",

  "SubmitOrSend",

  "UsesRPC",

  # Formatting functions

  "ToStderr", "ToStdout",

  "FormatError",

  "GenerateTable",

  "AskUser",

  "FormatTimestamp",

  # Tags functions

  "ListTags",

  "AddTags",

  "RemoveTags",

  # command line options support infrastructure

  "ARGS_MANY_INSTANCES",

  "ARGS_MANY_NODES",

  "ARGS_NONE",

  "ARGS_ONE_INSTANCE",

  "ARGS_ONE_NODE",

  "ArgChoice",

  "ArgCommand",

  "ArgFile",

  "ArgHost",

  "ArgInstance",

  "ArgJobId",

  "ArgNode",

  "ArgSuggest",

  "ArgUnknown",

  "OPT_COMPL_INST_ADD_NODES",

  "OPT_COMPL_MANY_NODES",

  "OPT_COMPL_ONE_IALLOCATOR",

  "OPT_COMPL_ONE_INSTANCE",

  "OPT_COMPL_ONE_NODE",

  "OPT_COMPL_ONE_OS",

  "cli_option",

  "SplitNodeOption",

  ]

NO_PREFIX = "no_"

UN_PREFIX = "-"

class _Argument:

  def __init__(self, min=0, max=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.

  """

class ArgHost(_Argument):

  """Host argument.

  """

ARGS_NONE = []

ARGS_MANY_INSTANCES = [ArgInstance()]

ARGS_MANY_NODES = [ArgNode()]

ARGS_ONE_INSTANCE = [ArgInstance(min=1, max=1)]

ARGS_ONE_NODE = [ArgNode(min=1, max=1)]

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:

      raise errors.OpPrereqError("no arguments passed to the command")

    name = args.pop(0)

    retval = kind, name

  else:

    raise errors.ProgrammerError("Unhandled tag type '%s'" % kind)

  return retval

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)

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:

    ToStdout(tag)

def AddTags(opts, args):

  """Add tags on a given object.

  This is a generic implementation that knows how to deal with all

  three cases of tag objects (cluster, node, instance). The opts

  argument is expected to contain a tag_type field denoting what

  object type we work on.

  """

  kind, name = _ExtractTagsObject(opts, args)

  _ExtendTags(opts, args)

  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)

  _ExtendTags(opts, args)

  if not args:

    raise errors.OpPrereqError("No tags to be removed")

  op = opcodes.OpDelTags(kind=kind, name=name, tags=args)

  SubmitOpCode(op)

def check_unit(option, opt, value):

  """OptParsers custom converter for units.

  """

  try:

    return utils.ParseUnit(value)

  except errors.UnitParseError, err:

    raise OptionValueError("option %s: %s" % (opt, err))

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 = {}

  if data:

    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

        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

  return kv_dict

def check_ident_key_val(option, opt, value):

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

  """

  if ":" not in value:

    ident, rest = value, ''

  else:

    ident, rest = value.split(":", 1)

  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:

    kv_dict = _SplitKeyVal(opt, rest)

    retval = (ident, kv_dict)

  return retval

def check_key_val(option, opt, value):

  """Custom parser class for key=val,key=val options.

  This will store the parsed values as a dict {key: val}.

  """

  return _SplitKeyVal(opt, value)

# completion_suggestion is normally a list. Using numeric values not evaluating

# to False for dynamic completion.

(OPT_COMPL_MANY_NODES,

 OPT_COMPL_ONE_NODE,

 OPT_COMPL_ONE_INSTANCE,

 OPT_COMPL_ONE_OS,

 OPT_COMPL_ONE_IALLOCATOR,

 OPT_COMPL_INST_ADD_NODES) = range(100, 106)

OPT_COMPL_ALL = frozenset([

  OPT_COMPL_MANY_NODES,

  OPT_COMPL_ONE_NODE,

  OPT_COMPL_ONE_INSTANCE,

  OPT_COMPL_ONE_OS,

  OPT_COMPL_ONE_IALLOCATOR,

  OPT_COMPL_INST_ADD_NODES,

  ])

class CliOption(Option):

  """Custom option class for optparse.

  """

  ATTRS = Option.ATTRS + [

    "completion_suggest",

    ]

  TYPES = Option.TYPES + (

    "identkeyval",

    "keyval",

    "unit",

    )

  TYPE_CHECKER = Option.TYPE_CHECKER.copy()

  TYPE_CHECKER["identkeyval"] = check_ident_key_val

  TYPE_CHECKER["keyval"] = check_key_val

  TYPE_CHECKER["unit"] = check_unit

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

cli_option = CliOption

DEBUG_OPT = cli_option("-d", "--debug", default=False,

                       action="store_true",

                       help="Turn debugging on")

NOHDR_OPT = cli_option("--no-headers", default=False,

                       action="store_true", dest="no_headers",

                       help="Don't display column headers")

SEP_OPT = cli_option("--separator", default=None,

                     action="store", dest="separator",

                     help=("Separator between output fields"

                           " (defaults to one space)"))

USEUNITS_OPT = cli_option("--units", default=None,

                          dest="units", choices=('h', 'm', 'g', 't'),

                          help="Specify units for output (one of hmgt)")

FIELDS_OPT = cli_option("-o", "--output", dest="output", action="store",

                        type="string", metavar="FIELDS",

                        help="Comma separated list of output fields")

FORCE_OPT = cli_option("-f", "--force", dest="force", action="store_true",

                       default=False, help="Force the operation")

CONFIRM_OPT = cli_option("--yes", dest="confirm", action="store_true",

                         default=False, help="Do not require confirmation")

TAG_SRC_OPT = cli_option("--from", dest="tags_source",

                         default=None, help="File with tag names")

SUBMIT_OPT = cli_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"))

SYNC_OPT = cli_option("--sync", dest="do_locking",

                      default=False, action="store_true",

                      help=("Grab locks while doing the queries"

                            " in order to ensure more consistent results"))

_DRY_RUN_OPT = cli_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"))

VERBOSE_OPT = cli_option("-v", "--verbose", default=False,

                         action="store_true",

                         help="Increase the verbosity of the operation")

DEBUG_SIMERR_OPT = cli_option("--debug-simulate-errors", default=False,

                              action="store_true", dest="simulate_errors",

                              help="Debugging option that makes the operation"

                              " treat most runtime checks as failed")

NWSYNC_OPT = cli_option("--no-wait-for-sync", dest="wait_for_sync",

                        default=True, action="store_false",

                        help="Don't wait for sync (DANGEROUS!)")

DISK_TEMPLATE_OPT = cli_option("-t", "--disk-template", dest="disk_template",

                               help="Custom disk setup (diskless, file,"

                               " plain or drbd)",

                               default=None, metavar="TEMPL",

                               choices=list(constants.DISK_TEMPLATES))

NONICS_OPT = cli_option("--no-nics", default=False, action="store_true",

                        help="Do not create any network cards for"

                        " the instance")

FILESTORE_DIR_OPT = cli_option("--file-storage-dir", dest="file_storage_dir",

                               help="Relative path under default cluster-wide"

                               " file storage dir to store file-based disks",

                               default=None, metavar="<DIR>")

def _ParseArgs(argv, commands, aliases):

  """Parser for the command line arguments.

  This function parses the arguments and returns the function which

  must be executed together with its (modified) arguments.

  @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, ...}

  """

  if len(argv) == 0:

    binary = "<command>"

  else:

    binary = argv[0].split("/")[-1]

  if len(argv) > 1 and argv[1] == "--version":

    ToStdout("%s (ganeti) %s", binary, constants.RELEASE_VERSION)

    # Quit right away. That way we don't have to care about this special

    # argument. optparse.py does it the same.

    sys.exit(0)

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

    ToStdout("Usage: %s {command} [options...] [argument...]", binary)

    ToStdout("%s <command> --help to see details, or man %s", binary, binary)

    ToStdout("")

    # compute the max line length for cmd + usage

    mlen = max([len(" %s" % cmd) for cmd in commands])

    mlen = min(60, mlen) # should not get here...

    # and format a nice command list

    ToStdout("Commands:")

    for cmd in sortedcmds:

      cmdstr = " %s" % (cmd,)

      help_text = commands[cmd][4]

      help_lines = textwrap.wrap(help_text, 79 - 3 - mlen)

      ToStdout("%-*s - %s", mlen, cmdstr, help_lines.pop(0))

      for line in help_lines:

        ToStdout("%-*s   %s", mlen, "", line)

    ToStdout("")

    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, args_def, parser_opts, usage, description = commands[cmd]

  parser = OptionParser(option_list=parser_opts + [_DRY_RUN_OPT],

                        description=description,

                        formatter=TitledHelpFormatter(),

                        usage="%%prog %s %s" % (cmd, usage))

  parser.disable_interspersed_args()

  options, args = parser.parse_args()

  if not _CheckArguments(cmd, args_def, args):

    return None, None, None

  return func, options, args

def _CheckArguments(cmd, args_def, args):

  """Verifies the arguments using the argument definition.

  Algorithm:

    1. Abort with error if values specified by user but none expected.

    1. For each argument in definition

      1. Keep running count of minimum number of values (min_count)

      1. Keep running count of maximum number of values (max_count)

      1. If it has an unlimited number of values

        1. Abort with error if it's not the last argument in the definition

    1. If last argument has limited number of values

      1. Abort with error if number of values doesn't match or is too large

    1. Abort with error if user didn't pass enough values (min_count)

  """

  if args and not args_def:

    ToStderr("Error: Command %s expects no arguments", cmd)

    return False

  min_count = None

  max_count = None

  check_max = None

  last_idx = len(args_def) - 1

  for idx, arg in enumerate(args_def):

    if min_count is None:

      min_count = arg.min

    elif arg.min is not None:

      min_count += arg.min

    if max_count is None:

      max_count = arg.max

    elif arg.max is not None:

      max_count += arg.max

    if idx == last_idx:

      check_max = (arg.max is not None)

    elif arg.max is None:

      raise errors.ProgrammerError("Only the last argument can have max=None")

  if check_max:

    # Command with exact number of arguments

    if (min_count is not None and max_count is not None and

        min_count == max_count and len(args) != min_count):

      ToStderr("Error: Command %s expects %d argument(s)", cmd, min_count)

      return False

    # Command with limited number of arguments

    if max_count is not None and len(args) > max_count:

      ToStderr("Error: Command %s expects only %d argument(s)",

               cmd, max_count)

      return False

  # Command with some required arguments

  if min_count is not None and len(args) < min_count:

    ToStderr("Error: Command %s expects at least %d argument(s)",

             cmd, min_count)

    return False

  return True

def SplitNodeOption(value):

  """Splits the value of a --node option.

  """

  if value and ':' in value:

    return value.split(':', 1)

  else:

    return (value, None)

def UsesRPC(fn):

  def wrapper(*args, **kwargs):

    rpc.Init()

    try:

      return fn(*args, **kwargs)

    finally:

      rpc.Shutdown()

  return wrapper

def AskUser(text, choices=None):

  """Ask the user a question.

  @param text: the question to ask

  @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

  @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

  """

  if choices is None:

    choices = [('y', True, 'Perform the operation'),

               ('n', False, 'Do not perform the operation')]

  if not choices or not isinstance(choices, list):

    raise errors.ProgrammerError("Invalid choices argument to AskUser")

  for entry in choices:

    if not isinstance(entry, tuple) or len(entry) < 3 or entry[0] == '?':

      raise errors.ProgrammerError("Invalid choices element to AskUser")

  answer = choices[-1][1]

  new_text = []

  for line in text.splitlines():

    new_text.append(textwrap.fill(line, 70, replace_whitespace=False))

  text = "\n".join(new_text)

  try:

    f = file("/dev/tty", "a+")

  except IOError:

    return answer

  try:

    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

  finally:

    f.close()

  return answer

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.

  """