Synnefo » snf-ganeti

#

#

# Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 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 time

import logging

import errno

import itertools

import shlex

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 rpc

from ganeti import ssh

from ganeti import compat

from ganeti import netutils

from ganeti import qlang

from ganeti import objects

from ganeti import pathutils

from ganeti.runtime import (GetClient)

from optparse import (OptionParser, TitledHelpFormatter,

                      Option, OptionValueError)

__all__ = [

  # Command line options

  "ABSOLUTE_OPT",

  "ADD_UIDS_OPT",

  "ADD_RESERVED_IPS_OPT",

  "ALLOCATABLE_OPT",

  "ALLOC_POLICY_OPT",

  "ALL_OPT",

  "ALLOW_FAILOVER_OPT",

  "AUTO_PROMOTE_OPT",

  "AUTO_REPLACE_OPT",

  "BACKEND_OPT",

  "BLK_OS_OPT",

  "CAPAB_MASTER_OPT",

  "CAPAB_VM_OPT",

  "CLEANUP_OPT",

  "CLUSTER_DOMAIN_SECRET_OPT",

  "CONFIRM_OPT",

  "CP_SIZE_OPT",

  "DEBUG_OPT",

  "DEBUG_SIMERR_OPT",

  "DISKIDX_OPT",

  "DISK_OPT",

  "DISK_PARAMS_OPT",

  "DISK_TEMPLATE_OPT",

  "DRAINED_OPT",

  "DRY_RUN_OPT",

  "DRBD_HELPER_OPT",

  "DST_NODE_OPT",

  "EARLY_RELEASE_OPT",

  "ENABLED_HV_OPT",

  "ENABLED_DISK_TEMPLATES_OPT",

  "ERROR_CODES_OPT",

  "FAILURE_ONLY_OPT",

  "FIELDS_OPT",

  "FILESTORE_DIR_OPT",

  "FILESTORE_DRIVER_OPT",

  "FORCE_FILTER_OPT",

  "FORCE_OPT",

  "FORCE_VARIANT_OPT",

  "GATEWAY_OPT",

  "GATEWAY6_OPT",

  "GLOBAL_FILEDIR_OPT",

  "HID_OS_OPT",

  "GLOBAL_SHARED_FILEDIR_OPT",

  "HOTPLUG_OPT",

  "HVLIST_OPT",

  "HVOPTS_OPT",

  "HYPERVISOR_OPT",

  "IALLOCATOR_OPT",

  "DEFAULT_IALLOCATOR_OPT",

  "IDENTIFY_DEFAULTS_OPT",

  "IGNORE_CONSIST_OPT",

  "IGNORE_ERRORS_OPT",

  "IGNORE_FAILURES_OPT",

  "IGNORE_OFFLINE_OPT",

  "IGNORE_REMOVE_FAILURES_OPT",

  "IGNORE_SECONDARIES_OPT",

  "IGNORE_SIZE_OPT",

  "INCLUDEDEFAULTS_OPT",

  "INTERVAL_OPT",

  "MAC_PREFIX_OPT",

  "MAINTAIN_NODE_HEALTH_OPT",

  "MASTER_NETDEV_OPT",

  "MASTER_NETMASK_OPT",

  "MC_OPT",

  "MIGRATION_MODE_OPT",

  "MODIFY_ETCHOSTS_OPT",

  "NET_OPT",

  "NETWORK_OPT",

  "NETWORK6_OPT",

  "NEW_CLUSTER_CERT_OPT",

  "NEW_CLUSTER_DOMAIN_SECRET_OPT",

  "NEW_CONFD_HMAC_KEY_OPT",

  "NEW_RAPI_CERT_OPT",

  "NEW_PRIMARY_OPT",

  "NEW_SECONDARY_OPT",

  "NEW_SPICE_CERT_OPT",

  "NIC_PARAMS_OPT",

  "NOCONFLICTSCHECK_OPT",

  "NODE_FORCE_JOIN_OPT",

  "NODE_LIST_OPT",

  "NODE_PLACEMENT_OPT",

  "NODEGROUP_OPT",

  "NODE_PARAMS_OPT",

  "NODE_POWERED_OPT",

  "NOHDR_OPT",

  "NOIPCHECK_OPT",

  "NO_INSTALL_OPT",

  "NONAMECHECK_OPT",

  "NOMODIFY_ETCHOSTS_OPT",

  "NOMODIFY_SSH_SETUP_OPT",

  "NONICS_OPT",

  "NONLIVE_OPT",

  "NONPLUS1_OPT",

  "NORUNTIME_CHGS_OPT",

  "NOSHUTDOWN_OPT",

  "NOSTART_OPT",

  "NOSSH_KEYCHECK_OPT",

  "NOVOTING_OPT",

  "NO_REMEMBER_OPT",

  "NWSYNC_OPT",

  "OFFLINE_INST_OPT",

  "ONLINE_INST_OPT",

  "ON_PRIMARY_OPT",

  "ON_SECONDARY_OPT",

  "OFFLINE_OPT",

  "OSPARAMS_OPT",

  "OS_OPT",

  "OS_SIZE_OPT",

  "OOB_TIMEOUT_OPT",

  "POWER_DELAY_OPT",

  "PREALLOC_WIPE_DISKS_OPT",

  "PRIMARY_IP_VERSION_OPT",

  "PRIMARY_ONLY_OPT",

  "PRINT_JOBID_OPT",

  "PRIORITY_OPT",

  "RAPI_CERT_OPT",

  "READD_OPT",

  "REASON_OPT",

  "REBOOT_TYPE_OPT",

  "REMOVE_INSTANCE_OPT",

  "REMOVE_RESERVED_IPS_OPT",

  "REMOVE_UIDS_OPT",

  "RESERVED_LVS_OPT",

  "RUNTIME_MEM_OPT",

  "ROMAN_OPT",

  "SECONDARY_IP_OPT",

  "SECONDARY_ONLY_OPT",

  "SELECT_OS_OPT",

  "SEP_OPT",

  "SHOWCMD_OPT",

  "SHOW_MACHINE_OPT",

  "COMPRESS_OPT",

  "SHUTDOWN_TIMEOUT_OPT",

  "SINGLE_NODE_OPT",

  "SPECS_CPU_COUNT_OPT",

  "SPECS_DISK_COUNT_OPT",

  "SPECS_DISK_SIZE_OPT",

  "SPECS_MEM_SIZE_OPT",

  "SPECS_NIC_COUNT_OPT",

  "SPLIT_ISPECS_OPTS",

  "IPOLICY_STD_SPECS_OPT",

  "IPOLICY_DISK_TEMPLATES",

  "IPOLICY_VCPU_RATIO",

  "SPICE_CACERT_OPT",

  "SPICE_CERT_OPT",

  "SRC_DIR_OPT",

  "SRC_NODE_OPT",

  "SUBMIT_OPT",

  "SUBMIT_OPTS",

  "STARTUP_PAUSED_OPT",

  "STATIC_OPT",

  "SYNC_OPT",

  "TAG_ADD_OPT",

  "TAG_SRC_OPT",

  "TIMEOUT_OPT",

  "TO_GROUP_OPT",

  "UIDPOOL_OPT",

  "USEUNITS_OPT",

  "USE_EXTERNAL_MIP_SCRIPT",

  "USE_REPL_NET_OPT",

  "VERBOSE_OPT",

  "VG_NAME_OPT",

  "WFSYNC_OPT",

  "YES_DOIT_OPT",

  "DISK_STATE_OPT",

  "HV_STATE_OPT",

  "IGNORE_IPOLICY_OPT",

  "INSTANCE_POLICY_OPTS",

  # Generic functions for CLI programs

  "ConfirmOperation",

  "CreateIPolicyFromOpts",

  "GenericMain",

  "GenericInstanceCreate",

  "GenericList",

  "GenericListFields",

  "GetClient",

  "GetOnlineNodes",

  "GetNodesSshPorts",

  "JobExecutor",

  "JobSubmittedException",

  "ParseTimespec",

  "RunWhileClusterStopped",

  "SubmitOpCode",

  "SubmitOpCodeToDrainedQueue",

  "SubmitOrSend",

  "UsesRPC",

  # Formatting functions

  "ToStderr", "ToStdout",

  "FormatError",

  "FormatQueryResult",

  "FormatParamsDictInfo",

  "FormatPolicyInfo",

  "PrintIPolicyCommand",

  "PrintGenericInfo",

  "GenerateTable",

  "AskUser",

  "FormatTimestamp",

  "FormatLogMessage",

  # Tags functions

  "ListTags",

  "AddTags",

  "RemoveTags",

  # command line options support infrastructure

  "ARGS_MANY_INSTANCES",

  "ARGS_MANY_NODES",

  "ARGS_MANY_GROUPS",

  "ARGS_MANY_NETWORKS",

  "ARGS_NONE",

  "ARGS_ONE_INSTANCE",

  "ARGS_ONE_NODE",

  "ARGS_ONE_GROUP",

  "ARGS_ONE_OS",

  "ARGS_ONE_NETWORK",

  "ArgChoice",

  "ArgCommand",

  "ArgFile",

  "ArgGroup",

  "ArgHost",

  "ArgInstance",

  "ArgJobId",

  "ArgNetwork",

  "ArgNode",

  "ArgOs",

  "ArgExtStorage",

  "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_NODEGROUP",

  "OPT_COMPL_ONE_NETWORK",

  "OPT_COMPL_ONE_OS",

  "OPT_COMPL_ONE_EXTSTORAGE",

  "cli_option",

  "SplitNodeOption",

  "CalculateOSNames",

  "ParseFields",

  "COMMON_CREATE_OPTS",

  ]

NO_PREFIX = "no_"

UN_PREFIX = "-"

#: Priorities (sorted)

_PRIORITY_NAMES = [

  ("low", constants.OP_PRIO_LOW),

  ("normal", constants.OP_PRIO_NORMAL),

  ("high", constants.OP_PRIO_HIGH),

  ]

#: Priority dictionary for easier lookup

# TODO: Replace this and _PRIORITY_NAMES with a single sorted dictionary once

# we migrate to Python 2.6

_PRIONAME_TO_VALUE = dict(_PRIORITY_NAMES)

# Query result status for clients

(QR_NORMAL,

 QR_UNKNOWN,

 QR_INCOMPLETE) = range(3)

#: Maximum batch size for ChooseJob

_CHOOSE_BATCH = 25

# constants used to create InstancePolicy dictionary

TISPECS_GROUP_TYPES = {

  constants.ISPECS_MIN: constants.VTYPE_INT,

  constants.ISPECS_MAX: constants.VTYPE_INT,

  }

TISPECS_CLUSTER_TYPES = {

  constants.ISPECS_MIN: constants.VTYPE_INT,

  constants.ISPECS_MAX: constants.VTYPE_INT,

  constants.ISPECS_STD: constants.VTYPE_INT,

  }

#: User-friendly names for query2 field types

_QFT_NAMES = {

  constants.QFT_UNKNOWN: "Unknown",

  constants.QFT_TEXT: "Text",

  constants.QFT_BOOL: "Boolean",

  constants.QFT_NUMBER: "Number",

  constants.QFT_UNIT: "Storage size",

  constants.QFT_TIMESTAMP: "Timestamp",

  constants.QFT_OTHER: "Custom",

  }

class _Argument:

  def __init__(self, min=0, max=None): # pylint: disable=W0622

    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.

  """

  # pylint: disable=W0622

  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 ArgNetwork(_Argument):

  """Network argument.

  """

class ArgGroup(_Argument):

  """Node group argument.

  """

class ArgJobId(_Argument):

  """Job ID argument.

  """

class ArgFile(_Argument):

  """File path argument.

  """

class ArgCommand(_Argument):

  """Command argument.

  """

class ArgHost(_Argument):

  """Host argument.

  """

class ArgOs(_Argument):

  """OS argument.

  """

class ArgExtStorage(_Argument):

  """ExtStorage argument.

  """

ARGS_NONE = []

ARGS_MANY_INSTANCES = [ArgInstance()]

ARGS_MANY_NETWORKS = [ArgNetwork()]

ARGS_MANY_NODES = [ArgNode()]

ARGS_MANY_GROUPS = [ArgGroup()]

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

ARGS_ONE_NETWORK = [ArgNetwork(min=1, max=1)]

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

# TODO

ARGS_ONE_GROUP = [ArgGroup(min=1, max=1)]

ARGS_ONE_OS = [ArgOs(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, ""

  elif kind in (constants.TAG_NODEGROUP,

                constants.TAG_NODE,

                constants.TAG_NETWORK,

                constants.TAG_INSTANCE):

    if not args:

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

                                 errors.ECODE_INVAL)

    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)

  cl = GetClient(query=True)

  result = cl.QueryTags(kind, name)

  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", errors.ECODE_INVAL)

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

  SubmitOrSend(op, opts)

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", errors.ECODE_INVAL)

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

  SubmitOrSend(op, opts)

def check_unit(option, opt, value): # pylint: disable=W0613

  """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, parse_prefixes):

  """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, keys with the prefix

  "-" will have value=None and the prefix stripped, and 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,...

  @type parse_prefixes: bool

  @param parse_prefixes: whether to handle prefixes specially

  @rtype: dict

  @return: {key=val, key=val}

  @raises errors.ParameterError: if there are duplicate keys

  """

  kv_dict = {}

  if data:

    for elem in utils.UnescapeAndSplit(data, sep=","):

      if "=" in elem:

        key, val = elem.split("=", 1)

      elif parse_prefixes:

        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

      else:

        raise errors.ParameterError("Missing value for key '%s' in option %s" %

                                    (elem, opt))

      if key in kv_dict:

        raise errors.ParameterError("Duplicate key '%s' in option %s" %

                                    (key, opt))

      kv_dict[key] = val

  return kv_dict

def _SplitIdentKeyVal(opt, value, parse_prefixes):

  """Helper function to parse "ident:key=val,key=val" options.

  @type opt: string

  @param opt: option name, used in error messages

  @type value: string

  @param value: expected to be in the format "ident:key=val,key=val,..."

  @type parse_prefixes: bool

  @param parse_prefixes: whether to handle prefixes specially (see

      L{_SplitKeyVal})

  @rtype: tuple

  @return: (ident, {key=val, key=val})

  @raises errors.ParameterError: in case of duplicates or other parsing errors

  """

  if ":" not in value:

    ident, rest = value, ""

  else:

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

  if parse_prefixes and 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 (parse_prefixes and ident.startswith(UN_PREFIX) and

        (len(ident) <= len(UN_PREFIX) or not ident[len(UN_PREFIX)].isdigit())):

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

    retval = (ident, kv_dict)

  return retval

def check_ident_key_val(option, opt, value):  # pylint: disable=W0613

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

  """

  return _SplitIdentKeyVal(opt, value, True)

def check_key_val(option, opt, value):  # pylint: disable=W0613

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

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

  """

  return _SplitKeyVal(opt, value, True)

def _SplitListKeyVal(opt, value):

  retval = {}

  for elem in value.split("/"):

    if not elem:

      raise errors.ParameterError("Empty section in option '%s'" % opt)

    (ident, valdict) = _SplitIdentKeyVal(opt, elem, False)

    if ident in retval:

      msg = ("Duplicated parameter '%s' in parsing %s: %s" %

             (ident, opt, elem))

      raise errors.ParameterError(msg)

    retval[ident] = valdict

  return retval

def check_multilist_ident_key_val(_, opt, value):

  """Custom parser for "ident:key=val,key=val/ident:key=val//ident:.." options.

  @rtype: list of dictionary

  @return: [{ident: {key: val, key: val}, ident: {key: val}}, {ident:..}]

  """

  retval = []

  for line in value.split("//"):

    retval.append(_SplitListKeyVal(opt, line))

  return retval

def check_bool(option, opt, value): # pylint: disable=W0613

  """Custom parser for yes/no options.

  This will store the parsed value as either True or False.

  """

  value = value.lower()

  if value == constants.VALUE_FALSE or value == "no":

    return False

  elif value == constants.VALUE_TRUE or value == "yes":

    return True

  else:

    raise errors.ParameterError("Invalid boolean value '%s'" % value)

def check_list(option, opt, value): # pylint: disable=W0613

  """Custom parser for comma-separated lists.