#
#
-# Copyright (C) 2007 Google Inc.
+# 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
"""
+import os
-import simplejson
+from ganeti import constants
+from ganeti import utils
+from ganeti import serializer
+from ganeti import compat
import qa_error
-cfg = None
-options = None
+_INSTANCE_CHECK_KEY = "instance-check"
+_ENABLED_HV_KEY = "enabled-hypervisors"
+
+#: QA configuration (L{_QaConfig})
+_config = None
+
+
+class _QaInstance(object):
+ __slots__ = [
+ "name",
+ "nicmac",
+ "used",
+ "disk_template",
+ ]
+
+ def __init__(self, name, nicmac):
+ """Initializes instances of this class.
+
+ """
+ self.name = name
+ self.nicmac = nicmac
+ self.used = None
+ self.disk_template = None
+
+ @classmethod
+ def FromDict(cls, data):
+ """Creates instance object from JSON dictionary.
+
+ """
+ nicmac = []
+
+ macaddr = data.get("nic.mac/0")
+ if macaddr:
+ nicmac.append(macaddr)
+
+ return cls(name=data["name"], nicmac=nicmac)
+
+ def __getitem__(self, key):
+ """Legacy dict-like interface.
+
+ """
+ if key == "name":
+ return self.name
+ else:
+ raise KeyError(key)
+
+ def get(self, key, default):
+ """Legacy dict-like interface.
+
+ """
+ try:
+ return self[key]
+ except KeyError:
+ return default
+
+ def GetNicMacAddr(self, idx, default):
+ """Returns MAC address for NIC.
+
+ @type idx: int
+ @param idx: NIC index
+ @param default: Default value
+
+ """
+ if len(self.nicmac) > idx:
+ return self.nicmac[idx]
+ else:
+ return default
+
+
+_RESOURCE_CONVERTER = {
+ "instances": _QaInstance.FromDict,
+ }
+
+
+def _ConvertResources((key, value)):
+ """Converts cluster resources in configuration to Python objects.
+
+ """
+ fn = _RESOURCE_CONVERTER.get(key, None)
+ if fn:
+ return (key, map(fn, value))
+ else:
+ return (key, value)
+
+
+class _QaConfig(object):
+ def __init__(self, data):
+ """Initializes instances of this class.
+
+ """
+ self._data = data
+
+ #: Cluster-wide run-time value of the exclusive storage flag
+ self._exclusive_storage = None
+
+ @classmethod
+ def Load(cls, filename):
+ """Loads a configuration file and produces a configuration object.
+
+ @type filename: string
+ @param filename: Path to configuration file
+ @rtype: L{_QaConfig}
+
+ """
+ data = serializer.LoadJson(utils.ReadFile(filename))
+
+ result = cls(dict(map(_ConvertResources,
+ data.items()))) # pylint: disable=E1103
+ result.Validate()
+
+ return result
+
+ def Validate(self):
+ """Validates loaded configuration data.
+
+ """
+ if not self.get("nodes"):
+ raise qa_error.Error("Need at least one node")
+
+ if not self.get("instances"):
+ raise qa_error.Error("Need at least one instance")
+
+ if (self.get("disk") is None or
+ self.get("disk-growth") is None or
+ len(self.get("disk")) != len(self.get("disk-growth"))):
+ raise qa_error.Error("Config options 'disk' and 'disk-growth' must exist"
+ " and have the same number of items")
+
+ check = self.GetInstanceCheckScript()
+ if check:
+ try:
+ os.stat(check)
+ except EnvironmentError, err:
+ raise qa_error.Error("Can't find instance check script '%s': %s" %
+ (check, err))
+
+ enabled_hv = frozenset(self.GetEnabledHypervisors())
+ if not enabled_hv:
+ raise qa_error.Error("No hypervisor is enabled")
+
+ difference = enabled_hv - constants.HYPER_TYPES
+ if difference:
+ raise qa_error.Error("Unknown hypervisor(s) enabled: %s" %
+ utils.CommaJoin(difference))
+
+ def __getitem__(self, name):
+ """Returns configuration value.
+
+ @type name: string
+ @param name: Name of configuration entry
+
+ """
+ return self._data[name]
+
+ def get(self, name, default=None):
+ """Returns configuration value.
+
+ @type name: string
+ @param name: Name of configuration entry
+ @param default: Default value
+
+ """
+ return self._data.get(name, default)
+
+ def GetMasterNode(self):
+ """Returns the default master node for the cluster.
+
+ """
+ return self["nodes"][0]
+
+ def GetInstanceCheckScript(self):
+ """Returns path to instance check script or C{None}.
+
+ """
+ return self._data.get(_INSTANCE_CHECK_KEY, None)
+
+ def GetEnabledHypervisors(self):
+ """Returns list of enabled hypervisors.
+
+ @rtype: list
+
+ """
+ try:
+ value = self._data[_ENABLED_HV_KEY]
+ except KeyError:
+ return [constants.DEFAULT_ENABLED_HYPERVISOR]
+ else:
+ if value is None:
+ return []
+ elif isinstance(value, basestring):
+ # The configuration key ("enabled-hypervisors") implies there can be
+ # multiple values. Multiple hypervisors are comma-separated on the
+ # command line option to "gnt-cluster init", so we need to handle them
+ # equally here.
+ return value.split(",")
+ else:
+ return value
+
+ def GetDefaultHypervisor(self):
+ """Returns the default hypervisor to be used.
+
+ """
+ return self.GetEnabledHypervisors()[0]
+
+ def SetExclusiveStorage(self, value):
+ """Set the expected value of the C{exclusive_storage} flag for the cluster.
+
+ """
+ self._exclusive_storage = bool(value)
+
+ def GetExclusiveStorage(self):
+ """Get the expected value of the C{exclusive_storage} flag for the cluster.
+
+ """
+ value = self._exclusive_storage
+ assert value is not None
+ return value
+
+ def IsTemplateSupported(self, templ):
+ """Is the given disk template supported by the current configuration?
+
+ """
+ return (not self.GetExclusiveStorage() or
+ templ in constants.DTS_EXCL_STORAGE)
def Load(path):
"""Loads the passed configuration file.
"""
- global cfg
+ global _config # pylint: disable=W0603
+
+ _config = _QaConfig.Load(path)
- f = open(path, 'r')
- try:
- cfg = simplejson.load(f)
- finally:
- f.close()
- Validate()
+def GetConfig():
+ """Returns the configuration object.
+ """
+ if _config is None:
+ raise RuntimeError("Configuration not yet loaded")
-def Validate():
- if len(cfg['nodes']) < 1:
- raise qa_error.Error("Need at least one node")
- if len(cfg['instances']) < 1:
- raise qa_error.Error("Need at least one instance")
- if len(cfg["disk"]) != len(cfg["disk-growth"]):
- raise qa_error.Error("Config options 'disk' and 'disk-growth' must have"
- " the same number of items")
+ return _config
def get(name, default=None):
- return cfg.get(name, default)
+ """Wrapper for L{_QaConfig.get}.
+
+ """
+ return GetConfig().get(name, default=default)
+
+
+class Either:
+ def __init__(self, tests):
+ """Initializes this class.
+
+ @type tests: list or string
+ @param tests: List of test names
+ @see: L{TestEnabled} for details
+
+ """
+ self.tests = tests
+
+
+def _MakeSequence(value):
+ """Make sequence of single argument.
+
+ If the single argument is not already a list or tuple, a list with the
+ argument as a single item is returned.
+
+ """
+ if isinstance(value, (list, tuple)):
+ return value
+ else:
+ return [value]
+
+
+def _TestEnabledInner(check_fn, names, fn):
+ """Evaluate test conditions.
+
+ @type check_fn: callable
+ @param check_fn: Callback to check whether a test is enabled
+ @type names: sequence or string
+ @param names: Test name(s)
+ @type fn: callable
+ @param fn: Aggregation function
+ @rtype: bool
+ @return: Whether test is enabled
+
+ """
+ names = _MakeSequence(names)
+
+ result = []
+
+ for name in names:
+ if isinstance(name, Either):
+ value = _TestEnabledInner(check_fn, name.tests, compat.any)
+ elif isinstance(name, (list, tuple)):
+ value = _TestEnabledInner(check_fn, name, compat.all)
+ else:
+ value = check_fn(name)
+
+ result.append(value)
+
+ return fn(result)
+
+
+def TestEnabled(tests, _cfg=None):
+ """Returns True if the given tests are enabled.
+
+ @param tests: A single test as a string, or a list of tests to check; can
+ contain L{Either} for OR conditions, AND is default
+
+ """
+ if _cfg is None:
+ cfg = GetConfig()
+ else:
+ cfg = _cfg
+
+ # Get settings for all tests
+ cfg_tests = cfg.get("tests", {})
+
+ # Get default setting
+ default = cfg_tests.get("default", True)
+ return _TestEnabledInner(lambda name: cfg_tests.get(name, default),
+ tests, compat.all)
-def TestEnabled(test):
- """Returns True if the given test is enabled."""
- return cfg.get('tests', {}).get(test, False)
+
+def GetInstanceCheckScript(*args):
+ """Wrapper for L{_QaConfig.GetInstanceCheckScript}.
+
+ """
+ return GetConfig().GetInstanceCheckScript(*args)
+
+
+def GetEnabledHypervisors(*args):
+ """Wrapper for L{_QaConfig.GetEnabledHypervisors}.
+
+ """
+ return GetConfig().GetEnabledHypervisors(*args)
+
+
+def GetDefaultHypervisor(*args):
+ """Wrapper for L{_QaConfig.GetDefaultHypervisor}.
+
+ """
+ return GetConfig().GetDefaultHypervisor(*args)
+
+
+def GetInstanceNicMac(inst, default=None):
+ """Returns MAC address for instance's network interface.
+
+ """
+ return inst.GetNicMacAddr(0, default)
def GetMasterNode():
- return cfg['nodes'][0]
+ """Wrapper for L{_QaConfig.GetMasterNode}.
+
+ """
+ return GetConfig().GetMasterNode()
-def AcquireInstance():
+def AcquireInstance(_cfg=None):
"""Returns an instance which isn't in use.
"""
+ if _cfg is None:
+ cfg = GetConfig()
+ else:
+ cfg = _cfg
+
# Filter out unwanted instances
- tmp_flt = lambda inst: not inst.get('_used', False)
- instances = filter(tmp_flt, cfg['instances'])
- del tmp_flt
+ instances = filter(lambda inst: not inst.used, cfg["instances"])
- if len(instances) == 0:
+ if not instances:
raise qa_error.OutOfInstancesError("No instances left")
inst = instances[0]
- inst['_used'] = True
+
+ assert not inst.used
+ assert inst.disk_template is None
+
+ inst.used = True
+
return inst
def ReleaseInstance(inst):
- inst['_used'] = False
+ inst.used = False
+ inst.disk_template = None
+
+
+def GetInstanceTemplate(inst):
+ """Return the disk template of an instance.
+
+ """
+ templ = inst.disk_template
+ assert templ is not None
+ return templ
+
+
+def SetInstanceTemplate(inst, template):
+ """Set the disk template for an instance.
+
+ """
+ inst.disk_template = template
+
+
+def SetExclusiveStorage(value):
+ """Wrapper for L{_QaConfig.SetExclusiveStorage}.
+
+ """
+ return GetConfig().SetExclusiveStorage(value)
+
+
+def GetExclusiveStorage():
+ """Wrapper for L{_QaConfig.GetExclusiveStorage}.
+
+ """
+ return GetConfig().GetExclusiveStorage()
+
+
+def IsTemplateSupported(templ):
+ """Wrapper for L{_QaConfig.GetExclusiveStorage}.
+
+ """
+ return GetConfig().IsTemplateSupported(templ)
def AcquireNode(exclude=None):
"""
master = GetMasterNode()
+ cfg = GetConfig()
# Filter out unwanted nodes
# TODO: Maybe combine filters
if exclude is None:
- nodes = cfg['nodes'][:]
+ nodes = cfg["nodes"][:]
elif isinstance(exclude, (list, tuple)):
- nodes = filter(lambda node: node not in exclude, cfg['nodes'])
+ nodes = filter(lambda node: node not in exclude, cfg["nodes"])
else:
- nodes = filter(lambda node: node != exclude, cfg['nodes'])
+ nodes = filter(lambda node: node != exclude, cfg["nodes"])
- tmp_flt = lambda node: node.get('_added', False) or node == master
+ tmp_flt = lambda node: node.get("_added", False) or node == master
nodes = filter(tmp_flt, nodes)
del tmp_flt
# Get node with least number of uses
def compare(a, b):
- result = cmp(a.get('_count', 0), b.get('_count', 0))
+ result = cmp(a.get("_count", 0), b.get("_count", 0))
if result == 0:
- result = cmp(a['primary'], b['primary'])
+ result = cmp(a["primary"], b["primary"])
return result
nodes.sort(cmp=compare)
node = nodes[0]
- node['_count'] = node.get('_count', 0) + 1
+ node["_count"] = node.get("_count", 0) + 1
return node
+def AcquireManyNodes(num, exclude=None):
+ """Return the least used nodes.
+
+ @type num: int
+ @param num: Number of nodes; can be 0.
+ @type exclude: list of nodes or C{None}
+ @param exclude: nodes to be excluded from the choice
+ @rtype: list of nodes
+ @return: C{num} different nodes
+
+ """
+ nodes = []
+ if exclude is None:
+ exclude = []
+ elif isinstance(exclude, (list, tuple)):
+ # Don't modify the incoming argument
+ exclude = list(exclude)
+ else:
+ exclude = [exclude]
+
+ try:
+ for _ in range(0, num):
+ n = AcquireNode(exclude=exclude)
+ nodes.append(n)
+ exclude.append(n)
+ except qa_error.OutOfNodesError:
+ ReleaseManyNodes(nodes)
+ raise
+ return nodes
+
+
def ReleaseNode(node):
- node['_count'] = node.get('_count', 0) - 1
+ node["_count"] = node.get("_count", 0) - 1
+
+
+def ReleaseManyNodes(nodes):
+ for n in nodes:
+ ReleaseNode(n)
projects / ganeti-local / blobdiff