Synnefo » snf-ganeti » ganeti-local

#

#

# Copyright (C) 2007, 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.

"""Utilities for QA tests.

"""

import operator

import os

import random

import re

import subprocess

import sys

import tempfile

import yaml

try:

  import functools

except ImportError, err:

  raise ImportError("Python 2.5 or higher is required: %s" % err)

from ganeti import utils

from ganeti import compat

from ganeti import constants

from ganeti import ht

from ganeti import pathutils

from ganeti import vcluster

import qa_config

import qa_error

_INFO_SEQ = None

_WARNING_SEQ = None

_ERROR_SEQ = None

_RESET_SEQ = None

_MULTIPLEXERS = {}

#: Unique ID per QA run

_RUN_UUID = utils.NewUUID()

#: Path to the QA query output log file

_QA_OUTPUT = pathutils.GetLogFilename("qa-output")

(INST_DOWN,

 INST_UP) = range(500, 502)

(FIRST_ARG,

 RETURN_VALUE) = range(1000, 1002)

def _SetupColours():

  """Initializes the colour constants.

  """

  # pylint: disable=W0603

  # due to global usage

  global _INFO_SEQ, _WARNING_SEQ, _ERROR_SEQ, _RESET_SEQ

  # Don't use colours if stdout isn't a terminal

  if not sys.stdout.isatty():

    return

  try:

    import curses

  except ImportError:

    # Don't use colours if curses module can't be imported

    return

  curses.setupterm()

  _RESET_SEQ = curses.tigetstr("op")

  setaf = curses.tigetstr("setaf")

  _INFO_SEQ = curses.tparm(setaf, curses.COLOR_GREEN)

  _WARNING_SEQ = curses.tparm(setaf, curses.COLOR_YELLOW)

  _ERROR_SEQ = curses.tparm(setaf, curses.COLOR_RED)

_SetupColours()

def AssertIn(item, sequence):

  """Raises an error when item is not in sequence.

  """

  if item not in sequence:

    raise qa_error.Error("%r not in %r" % (item, sequence))

def AssertNotIn(item, sequence):

  """Raises an error when item is in sequence.

  """

  if item in sequence:

    raise qa_error.Error("%r in %r" % (item, sequence))

def AssertEqual(first, second):

  """Raises an error when values aren't equal.

  """

  if not first == second:

    raise qa_error.Error("%r == %r" % (first, second))

def AssertMatch(string, pattern):

  """Raises an error when string doesn't match regexp pattern.

  """

  if not re.match(pattern, string):

    raise qa_error.Error("%r doesn't match /%r/" % (string, pattern))

def _GetName(entity, fn):

  """Tries to get name of an entity.

  @type entity: string or dict

  @param fn: Function retrieving name from entity

  """

  if isinstance(entity, basestring):

    result = entity

  else:

    result = fn(entity)

  if not ht.TNonEmptyString(result):

    raise Exception("Invalid name '%s'" % result)

  return result

def _AssertRetCode(rcode, fail, cmdstr, nodename):

  """Check the return value from a command and possibly raise an exception.

  """

  if fail and rcode == 0:

    raise qa_error.Error("Command '%s' on node %s was expected to fail but"

                         " didn't" % (cmdstr, nodename))

  elif not fail and rcode != 0:

    raise qa_error.Error("Command '%s' on node %s failed, exit code %s" %

                         (cmdstr, nodename, rcode))

def AssertCommand(cmd, fail=False, node=None, log_cmd=True):

  """Checks that a remote command succeeds.

  @param cmd: either a string (the command to execute) or a list (to

      be converted using L{utils.ShellQuoteArgs} into a string)

  @type fail: boolean

  @param fail: if the command is expected to fail instead of succeeding

  @param node: if passed, it should be the node on which the command

      should be executed, instead of the master node (can be either a

      dict or a string)

  @param log_cmd: if False, the command won't be logged (simply passed to

      StartSSH)

  @return: the return code of the command

  @raise qa_error.Error: if the command fails when it shouldn't or vice versa

  """

  if node is None:

    node = qa_config.GetMasterNode()

  nodename = _GetName(node, operator.attrgetter("primary"))

  if isinstance(cmd, basestring):

    cmdstr = cmd

  else:

    cmdstr = utils.ShellQuoteArgs(cmd)

  rcode = StartSSH(nodename, cmdstr, log_cmd=log_cmd).wait()

  _AssertRetCode(rcode, fail, cmdstr, nodename)

  return rcode

def AssertRedirectedCommand(cmd, fail=False, node=None, log_cmd=True):

  """Executes a command with redirected output.

  The log will go to the qa-output log file in the ganeti log

  directory on the node where the command is executed. The fail and

  node parameters are passed unchanged to AssertCommand.

  @param cmd: the command to be executed, as a list; a string is not

      supported

  """

  if not isinstance(cmd, list):

    raise qa_error.Error("Non-list passed to AssertRedirectedCommand")

  ofile = utils.ShellQuote(_QA_OUTPUT)

  cmdstr = utils.ShellQuoteArgs(cmd)

  AssertCommand("echo ---- $(date) %s ---- >> %s" % (cmdstr, ofile),

                fail=False, node=node, log_cmd=False)

  return AssertCommand(cmdstr + " >> %s" % ofile,

                       fail=fail, node=node, log_cmd=log_cmd)

def GetSSHCommand(node, cmd, strict=True, opts=None, tty=None):

  """Builds SSH command to be executed.

  @type node: string

  @param node: node the command should run on

  @type cmd: string

  @param cmd: command to be executed in the node; if None or empty

      string, no command will be executed

  @type strict: boolean

  @param strict: whether to enable strict host key checking

  @type opts: list

  @param opts: list of additional options

  @type tty: boolean or None

  @param tty: if we should use tty; if None, will be auto-detected

  """

  args = ["ssh", "-oEscapeChar=none", "-oBatchMode=yes", "-lroot"]

  if tty is None:

    tty = sys.stdout.isatty()

  if tty:

    args.append("-t")

  if strict:

    tmp = "yes"

  else:

    tmp = "no"

  args.append("-oStrictHostKeyChecking=%s" % tmp)

  args.append("-oClearAllForwardings=yes")

  args.append("-oForwardAgent=yes")

  if opts:

    args.extend(opts)

  if node in _MULTIPLEXERS:

    spath = _MULTIPLEXERS[node][0]

    args.append("-oControlPath=%s" % spath)

    args.append("-oControlMaster=no")

  (vcluster_master, vcluster_basedir) = \

    qa_config.GetVclusterSettings()

  if vcluster_master:

    args.append(vcluster_master)

    args.append("%s/%s/cmd" % (vcluster_basedir, node))

    if cmd:

      # For virtual clusters the whole command must be wrapped using the "cmd"

      # script, as that script sets a number of environment variables. If the

      # command contains shell meta characters the whole command needs to be

      # quoted.

      args.append(utils.ShellQuote(cmd))

  else:

    args.append(node)

    if cmd:

      args.append(cmd)

  return args

def StartLocalCommand(cmd, _nolog_opts=False, log_cmd=True, **kwargs):

  """Starts a local command.

  """

  if log_cmd:

    if _nolog_opts:

      pcmd = [i for i in cmd if not i.startswith("-")]

    else:

      pcmd = cmd

    print "Command: %s" % utils.ShellQuoteArgs(pcmd)

  return subprocess.Popen(cmd, shell=False, **kwargs)

def StartSSH(node, cmd, strict=True, log_cmd=True):

  """Starts SSH.

  """

  return StartLocalCommand(GetSSHCommand(node, cmd, strict=strict),

                           _nolog_opts=True, log_cmd=log_cmd)

def StartMultiplexer(node):

  """Starts a multiplexer command.

  @param node: the node for which to open the multiplexer

  """

  if node in _MULTIPLEXERS:

    return

  # Note: yes, we only need mktemp, since we'll remove the file anyway

  sname = tempfile.mktemp(prefix="ganeti-qa-multiplexer.")

  utils.RemoveFile(sname)

  opts = ["-N", "-oControlPath=%s" % sname, "-oControlMaster=yes"]

  print "Created socket at %s" % sname

  child = StartLocalCommand(GetSSHCommand(node, None, opts=opts))

  _MULTIPLEXERS[node] = (sname, child)

def CloseMultiplexers():

  """Closes all current multiplexers and cleans up.

  """

  for node in _MULTIPLEXERS.keys():

    (sname, child) = _MULTIPLEXERS.pop(node)

    utils.KillProcess(child.pid, timeout=10, waitpid=True)

    utils.RemoveFile(sname)

def GetCommandOutput(node, cmd, tty=None, fail=False):

  """Returns the output of a command executed on the given node.

  @type node: string

  @param node: node the command should run on

  @type cmd: string

  @param cmd: command to be executed in the node (cannot be empty or None)

  @type tty: bool or None

  @param tty: if we should use tty; if None, it will be auto-detected

  @type fail: bool

  @param fail: whether the command is expected to fail

  """

  assert cmd

  p = StartLocalCommand(GetSSHCommand(node, cmd, tty=tty),

                        stdout=subprocess.PIPE)

  rcode = p.wait()

  _AssertRetCode(rcode, fail, cmd, node)

  return p.stdout.read()

def GetObjectInfo(infocmd):

  """Get and parse information about a Ganeti object.

  @type infocmd: list of strings

  @param infocmd: command to be executed, e.g. ["gnt-cluster", "info"]

  @return: the information parsed, appropriately stored in dictionaries,

      lists...

  """

  master = qa_config.GetMasterNode()

  cmdline = utils.ShellQuoteArgs(infocmd)

  info_out = GetCommandOutput(master.primary, cmdline)

  return yaml.load(info_out)

def UploadFile(node, src):

  """Uploads a file to a node and returns the filename.

  Caller needs to remove the returned file on the node when it's not needed

  anymore.

  """

  # Make sure nobody else has access to it while preserving local permissions

  mode = os.stat(src).st_mode & 0700

  cmd = ('tmp=$(tempfile --mode %o --prefix gnt) && '

         '[[ -f "${tmp}" ]] && '

         'cat > "${tmp}" && '

         'echo "${tmp}"') % mode

  f = open(src, "r")

  try:

    p = subprocess.Popen(GetSSHCommand(node, cmd), shell=False, stdin=f,

                         stdout=subprocess.PIPE)

    AssertEqual(p.wait(), 0)

    # Return temporary filename

    return p.stdout.read().strip()

  finally:

    f.close()

def UploadData(node, data, mode=0600, filename=None):

  """Uploads data to a node and returns the filename.

  Caller needs to remove the returned file on the node when it's not needed

  anymore.

  """

  if filename:

    tmp = "tmp=%s" % utils.ShellQuote(filename)

  else:

    tmp = "tmp=$(tempfile --mode %o --prefix gnt)" % mode

  cmd = ("%s && "

         "[[ -f \"${tmp}\" ]] && "

         "cat > \"${tmp}\" && "

         "echo \"${tmp}\"") % tmp

  p = subprocess.Popen(GetSSHCommand(node, cmd), shell=False,

                       stdin=subprocess.PIPE, stdout=subprocess.PIPE)

  p.stdin.write(data)

  p.stdin.close()

  AssertEqual(p.wait(), 0)

  # Return temporary filename

  return p.stdout.read().strip()

def BackupFile(node, path):

  """Creates a backup of a file on the node and returns the filename.

  Caller needs to remove the returned file on the node when it's not needed

  anymore.

  """

  vpath = MakeNodePath(node, path)

  cmd = ("tmp=$(tempfile --prefix .gnt --directory=$(dirname %s)) && "

         "[[ -f \"$tmp\" ]] && "

         "cp %s $tmp && "

         "echo $tmp") % (utils.ShellQuote(vpath), utils.ShellQuote(vpath))

  # Return temporary filename

  result = GetCommandOutput(node, cmd).strip()

  print "Backup filename: %s" % result

  return result

def ResolveInstanceName(instance):

  """Gets the full name of an instance.

  @type instance: string

  @param instance: Instance name

  """

  info = GetObjectInfo(["gnt-instance", "info", instance])

  return info[0]["Instance name"]

def ResolveNodeName(node):

  """Gets the full name of a node.

  """

  info = GetObjectInfo(["gnt-node", "info", node.primary])

  return info[0]["Node name"]

def GetNodeInstances(node, secondaries=False):

  """Gets a list of instances on a node.

  """

  master = qa_config.GetMasterNode()

  node_name = ResolveNodeName(node)

  # Get list of all instances

  cmd = ["gnt-instance", "list", "--separator=:", "--no-headers",

         "--output=name,pnode,snodes"]

  output = GetCommandOutput(master.primary, utils.ShellQuoteArgs(cmd))

  instances = []

  for line in output.splitlines():

    (name, pnode, snodes) = line.split(":", 2)

    if ((not secondaries and pnode == node_name) or

        (secondaries and node_name in snodes.split(","))):

      instances.append(name)

  return instances

def _SelectQueryFields(rnd, fields):

  """Generates a list of fields for query tests.

  """

  # Create copy for shuffling

  fields = list(fields)

  rnd.shuffle(fields)

  # Check all fields

  yield fields

  yield sorted(fields)

  # Duplicate fields

  yield fields + fields

  # Check small groups of fields

  while fields:

    yield [fields.pop() for _ in range(rnd.randint(2, 10)) if fields]

def _List(listcmd, fields, names):

  """Runs a list command.

  """

  master = qa_config.GetMasterNode()

  cmd = [listcmd, "list", "--separator=|", "--no-headers",

         "--output", ",".join(fields)]

  if names:

    cmd.extend(names)

  return GetCommandOutput(master.primary,

                          utils.ShellQuoteArgs(cmd)).splitlines()

def GenericQueryTest(cmd, fields, namefield="name", test_unknown=True):

  """Runs a number of tests on query commands.

  @param cmd: Command name

  @param fields: List of field names

  """

  rnd = random.Random(hash(cmd))

  fields = list(fields)

  rnd.shuffle(fields)

  # Test a number of field combinations

  for testfields in _SelectQueryFields(rnd, fields):

    AssertRedirectedCommand([cmd, "list", "--output", ",".join(testfields)])

  if namefield is not None:

    namelist_fn = compat.partial(_List, cmd, [namefield])

    # When no names were requested, the list must be sorted

    names = namelist_fn(None)

    AssertEqual(names, utils.NiceSort(names))

    # When requesting specific names, the order must be kept

    revnames = list(reversed(names))

    AssertEqual(namelist_fn(revnames), revnames)

    randnames = list(names)

    rnd.shuffle(randnames)

    AssertEqual(namelist_fn(randnames), randnames)

  if test_unknown:

    # Listing unknown items must fail

    AssertCommand([cmd, "list", "this.name.certainly.does.not.exist"],

                  fail=True)

  # Check exit code for listing unknown field

  AssertEqual(AssertRedirectedCommand([cmd, "list",

                                       "--output=field/does/not/exist"],

                                      fail=True),

              constants.EXIT_UNKNOWN_FIELD)

def GenericQueryFieldsTest(cmd, fields):

  master = qa_config.GetMasterNode()

  # Listing fields

  AssertRedirectedCommand([cmd, "list-fields"])

  AssertRedirectedCommand([cmd, "list-fields"] + fields)

  # Check listed fields (all, must be sorted)

  realcmd = [cmd, "list-fields", "--separator=|", "--no-headers"]

  output = GetCommandOutput(master.primary,

                            utils.ShellQuoteArgs(realcmd)).splitlines()

  AssertEqual([line.split("|", 1)[0] for line in output],

              utils.NiceSort(fields))

  # Check exit code for listing unknown field

  AssertEqual(AssertCommand([cmd, "list-fields", "field/does/not/exist"],

                            fail=True),

              constants.EXIT_UNKNOWN_FIELD)

def _FormatWithColor(text, seq):

  if not seq:

    return text

  return "%s%s%s" % (seq, text, _RESET_SEQ)

FormatWarning = lambda text: _FormatWithColor(text, _WARNING_SEQ)

FormatError = lambda text: _FormatWithColor(text, _ERROR_SEQ)

FormatInfo = lambda text: _FormatWithColor(text, _INFO_SEQ)

def AddToEtcHosts(hostnames):

  """Adds hostnames to /etc/hosts.

  @param hostnames: List of hostnames first used A records, all other CNAMEs

  """

  master = qa_config.GetMasterNode()

  tmp_hosts = UploadData(master.primary, "", mode=0644)

  data = []

  for localhost in ("::1", "127.0.0.1"):

    data.append("%s %s" % (localhost, " ".join(hostnames)))

  try:

    AssertCommand("{ cat %s && echo -e '%s'; } > %s && mv %s %s" %

                  (utils.ShellQuote(pathutils.ETC_HOSTS),

                   "\\n".join(data),

                   utils.ShellQuote(tmp_hosts),

                   utils.ShellQuote(tmp_hosts),

                   utils.ShellQuote(pathutils.ETC_HOSTS)))

  except Exception:

    AssertCommand(["rm", "-f", tmp_hosts])

    raise

def RemoveFromEtcHosts(hostnames):

  """Remove hostnames from /etc/hosts.

  @param hostnames: List of hostnames first used A records, all other CNAMEs

  """

  master = qa_config.GetMasterNode()

  tmp_hosts = UploadData(master.primary, "", mode=0644)

  quoted_tmp_hosts = utils.ShellQuote(tmp_hosts)

  sed_data = " ".join(hostnames)

  try:

    AssertCommand(("sed -e '/^\(::1\|127\.0\.0\.1\)\s\+%s/d' %s > %s"

                   " && mv %s %s") %

                   (sed_data, utils.ShellQuote(pathutils.ETC_HOSTS),

                    quoted_tmp_hosts, quoted_tmp_hosts,

                    utils.ShellQuote(pathutils.ETC_HOSTS)))

  except Exception:

    AssertCommand(["rm", "-f", tmp_hosts])

    raise

def RunInstanceCheck(instance, running):

  """Check if instance is running or not.

  """

  instance_name = _GetName(instance, operator.attrgetter("name"))

  script = qa_config.GetInstanceCheckScript()

  if not script:

    return

  master_node = qa_config.GetMasterNode()

  # Build command to connect to master node

  master_ssh = GetSSHCommand(master_node.primary, "--")

  if running:

    running_shellval = "1"

    running_text = ""

  else:

    running_shellval = ""

    running_text = "not "

  print FormatInfo("Checking if instance '%s' is %srunning" %

                   (instance_name, running_text))

  args = [script, instance_name]

  env = {

    "PATH": constants.HOOKS_PATH,

    "RUN_UUID": _RUN_UUID,

    "MASTER_SSH": utils.ShellQuoteArgs(master_ssh),

    "INSTANCE_NAME": instance_name,

    "INSTANCE_RUNNING": running_shellval,

    }

  result = os.spawnve(os.P_WAIT, script, args, env)

  if result != 0:

    raise qa_error.Error("Instance check failed with result %s" % result)

def _InstanceCheckInner(expected, instarg, args, result):

  """Helper function used by L{InstanceCheck}.

  """

  if instarg == FIRST_ARG:

    instance = args[0]

  elif instarg == RETURN_VALUE:

    instance = result

  else:

    raise Exception("Invalid value '%s' for instance argument" % instarg)

  if expected in (INST_DOWN, INST_UP):

    RunInstanceCheck(instance, (expected == INST_UP))

  elif expected is not None:

    raise Exception("Invalid value '%s'" % expected)

def InstanceCheck(before, after, instarg):

  """Decorator to check instance status before and after test.

  @param before: L{INST_DOWN} if instance must be stopped before test,

    L{INST_UP} if instance must be running before test, L{None} to not check.

  @param after: L{INST_DOWN} if instance must be stopped after test,

    L{INST_UP} if instance must be running after test, L{None} to not check.

  @param instarg: L{FIRST_ARG} to use first argument to test as instance (a

    dictionary), L{RETURN_VALUE} to use return value (disallows pre-checks)

  """

  def decorator(fn):

    @functools.wraps(fn)

    def wrapper(*args, **kwargs):

      _InstanceCheckInner(before, instarg, args, NotImplemented)

      result = fn(*args, **kwargs)

      _InstanceCheckInner(after, instarg, args, result)

      return result

    return wrapper

  return decorator

def GetNonexistentGroups(count):

  """Gets group names which shouldn't exist on the cluster.

  @param count: Number of groups to get

  @rtype: integer

  """

  return GetNonexistentEntityNames(count, "groups", "group")

def GetNonexistentEntityNames(count, name_config, name_prefix):

  """Gets entity names which shouldn't exist on the cluster.

  The actualy names can refer to arbitrary entities (for example

  groups, networks).

  @param count: Number of names to get

  @rtype: integer

  @param name_config: name of the leaf in the config containing

    this entity's configuration, including a 'inexistent-'

    element

  @rtype: string

  @param name_prefix: prefix of the entity's names, used to compose

    the default values; for example for groups, the prefix is

    'group' and the generated names are then group1, group2, ...

  @rtype: string

  """

  entities = qa_config.get(name_config, {})

  default = [name_prefix + str(i) for i in range(count)]

  assert count <= len(default)

  name_config_inexistent = "inexistent-" + name_config

  candidates = entities.get(name_config_inexistent, default)[:count]

  if len(candidates) < count:

    raise Exception("At least %s non-existent %s are needed" %

                    (count, name_config))

  return candidates

def MakeNodePath(node, path):

  """Builds an absolute path for a virtual node.

  @type node: string or L{qa_config._QaNode}

  @param node: Node

  @type path: string

  @param path: Path without node-specific prefix

  """

  (_, basedir) = qa_config.GetVclusterSettings()

  if isinstance(node, basestring):

    name = node

  else:

    name = node.primary

  if basedir:

    assert path.startswith("/")

    return "%s%s" % (vcluster.MakeNodeRoot(basedir, name), path)

  else:

    return path