-#!/usr/bin/python
+#
#
# Copyright (C) 2006, 2007 Google Inc.
"""
-import cPickle
-from cStringIO import StringIO
+import simplejson
import ConfigParser
+import re
+from cStringIO import StringIO
from ganeti import errors
+from ganeti import constants
__all__ = ["ConfigObject", "ConfigData", "NIC", "Disk", "Instance",
"OS", "Node", "Cluster"]
+# Check whether the simplejson module supports indentation
+_JSON_INDENT = 2
+try:
+ simplejson.dumps(1, indent=_JSON_INDENT)
+except TypeError:
+ _JSON_INDENT = None
+
+
class ConfigObject(object):
"""A generic config object.
__slots__ = []
def __init__(self, **kwargs):
- for i in kwargs:
- setattr(self, i, kwargs[i])
+ for k, v in kwargs.iteritems():
+ setattr(self, k, v)
def __getattr__(self, name):
if name not in self.__slots__:
- raise AttributeError, ("Invalid object attribute %s.%s" %
- (type(self).__name__, name))
+ raise AttributeError("Invalid object attribute %s.%s" %
+ (type(self).__name__, name))
return None
def __setitem__(self, key, value):
if key not in self.__slots__:
- raise KeyError, key
+ raise KeyError(key)
setattr(self, key, value)
def __getstate__(self):
if name in self.__slots__:
setattr(self, name, state[name])
- @staticmethod
- def FindGlobal(module, name):
- """Function filtering the allowed classes to be un-pickled.
+ def Dump(self, fobj):
+ """Dump to a file object.
- Currently, we only allow the classes from this module which are
- derived from ConfigObject.
+ """
+ data = self.ToDict()
+ if _JSON_INDENT is None:
+ simplejson.dump(data, fobj)
+ else:
+ simplejson.dump(data, fobj, indent=_JSON_INDENT)
+
+ @classmethod
+ def Load(cls, fobj):
+ """Load data from the given stream.
"""
- # Also support the old module name (ganeti.config)
- cls = None
- if module == "ganeti.config" or module == "ganeti.objects":
- if name == "ConfigData":
- cls = ConfigData
- elif name == "NIC":
- cls = NIC
- elif name == "Disk" or name == "BlockDev":
- cls = Disk
- elif name == "Instance":
- cls = Instance
- elif name == "OS":
- cls = OS
- elif name == "Node":
- cls = Node
- elif name == "Cluster":
- cls = Cluster
- elif module == "__builtin__":
- if name == "set":
- cls = set
- if cls is None:
- raise cPickle.UnpicklingError, ("Class %s.%s not allowed due to"
- " security concerns" % (module, name))
- return cls
+ return cls.FromDict(simplejson.load(fobj))
- def Dump(self, fobj):
- """Dump this instance to a file object.
+ def Dumps(self):
+ """Dump and return the string representation."""
+ buf = StringIO()
+ self.Dump(buf)
+ return buf.getvalue()
+
+ @classmethod
+ def Loads(cls, data):
+ """Load data from a string."""
+ return cls.Load(StringIO(data))
+
+ def ToDict(self):
+ """Convert to a dict holding only standard python types.
- Note that we use the HIGHEST_PROTOCOL, as it brings benefits for
- the new classes.
+ The generic routine just dumps all of this object's attributes in
+ a dict. It does not work if the class has children who are
+ ConfigObjects themselves (e.g. the nics list in an Instance), in
+ which case the object should subclass the function in order to
+ make sure all objects returned are only standard python types.
"""
- dumper = cPickle.Pickler(fobj, cPickle.HIGHEST_PROTOCOL)
- dumper.dump(self)
+ return dict([(k, getattr(self, k, None)) for k in self.__slots__])
+
+ @classmethod
+ def FromDict(cls, val):
+ """Create an object from a dictionary.
+
+ This generic routine takes a dict, instantiates a new instance of
+ the given class, and sets attributes based on the dict content.
+
+ As for `ToDict`, this does not work if the class has children
+ who are ConfigObjects themselves (e.g. the nics list in an
+ Instance), in which case the object should subclass the function
+ and alter the objects.
+
+ """
+ if not isinstance(val, dict):
+ raise errors.ConfigurationError("Invalid object passed to FromDict:"
+ " expected dict, got %s" % type(val))
+ val_str = dict([(str(k), v) for k, v in val.iteritems()])
+ obj = cls(**val_str)
+ return obj
@staticmethod
- def Load(fobj):
- """Unpickle data from the given stream.
+ def _ContainerToDicts(container):
+ """Convert the elements of a container to standard python types.
- This uses the `FindGlobal` function to filter the allowed classes.
+ This method converts a container with elements derived from
+ ConfigData to standard python types. If the container is a dict,
+ we don't touch the keys, only the values.
"""
- loader = cPickle.Unpickler(fobj)
- loader.find_global = ConfigObject.FindGlobal
- return loader.load()
+ if isinstance(container, dict):
+ ret = dict([(k, v.ToDict()) for k, v in container.iteritems()])
+ elif isinstance(container, (list, tuple, set, frozenset)):
+ ret = [elem.ToDict() for elem in container]
+ else:
+ raise TypeError("Invalid type %s passed to _ContainerToDicts" %
+ type(container))
+ return ret
- def Dumps(self):
- """Dump this instance and return the string representation."""
- buf = StringIO()
- self.Dump(buf)
- return buf.getvalue()
+ @staticmethod
+ def _ContainerFromDicts(source, c_type, e_type):
+ """Convert a container from standard python types.
+
+ This method converts a container with standard python types to
+ ConfigData objects. If the container is a dict, we don't touch the
+ keys, only the values.
+
+ """
+ if not isinstance(c_type, type):
+ raise TypeError("Container type %s passed to _ContainerFromDicts is"
+ " not a type" % type(c_type))
+ if c_type is dict:
+ ret = dict([(k, e_type.FromDict(v)) for k, v in source.iteritems()])
+ elif c_type in (list, tuple, set, frozenset):
+ ret = c_type([e_type.FromDict(elem) for elem in source])
+ else:
+ raise TypeError("Invalid container type %s passed to"
+ " _ContainerFromDicts" % c_type)
+ return ret
+
+ def __repr__(self):
+ """Implement __repr__ for ConfigObjects."""
+ return repr(self.ToDict())
+
+
+class TaggableObject(ConfigObject):
+ """An generic class supporting tags.
+
+ """
+ __slots__ = ConfigObject.__slots__ + ["tags"]
@staticmethod
- def Loads(data):
- """Load data from a string."""
- return ConfigObject.Load(StringIO(data))
+ def ValidateTag(tag):
+ """Check if a tag is valid.
+
+ If the tag is invalid, an errors.TagError will be raised. The
+ function has no return value.
+
+ """
+ if not isinstance(tag, basestring):
+ raise errors.TagError("Invalid tag type (not a string)")
+ if len(tag) > constants.MAX_TAG_LEN:
+ raise errors.TagError("Tag too long (>%d characters)" %
+ constants.MAX_TAG_LEN)
+ if not tag:
+ raise errors.TagError("Tags cannot be empty")
+ if not re.match("^[ \w.+*/:-]+$", tag):
+ raise errors.TagError("Tag contains invalid characters")
+
+ def GetTags(self):
+ """Return the tags list.
+
+ """
+ tags = getattr(self, "tags", None)
+ if tags is None:
+ tags = self.tags = set()
+ return tags
+
+ def AddTag(self, tag):
+ """Add a new tag.
+
+ """
+ self.ValidateTag(tag)
+ tags = self.GetTags()
+ if len(tags) >= constants.MAX_TAGS_PER_OBJ:
+ raise errors.TagError("Too many tags")
+ self.GetTags().add(tag)
+
+ def RemoveTag(self, tag):
+ """Remove a tag.
+
+ """
+ self.ValidateTag(tag)
+ tags = self.GetTags()
+ try:
+ tags.remove(tag)
+ except KeyError:
+ raise errors.TagError("Tag not found")
+
+ def ToDict(self):
+ """Taggable-object-specific conversion to standard python types.
+
+ This replaces the tags set with a list.
+
+ """
+ bo = super(TaggableObject, self).ToDict()
+
+ tags = bo.get("tags", None)
+ if isinstance(tags, set):
+ bo["tags"] = list(tags)
+ return bo
+
+ @classmethod
+ def FromDict(cls, val):
+ """Custom function for instances.
+
+ """
+ obj = super(TaggableObject, cls).FromDict(val)
+ if hasattr(obj, "tags") and isinstance(obj.tags, list):
+ obj.tags = set(obj.tags)
+ return obj
class ConfigData(ConfigObject):
"""Top-level config object."""
__slots__ = ["cluster", "nodes", "instances"]
+ def ToDict(self):
+ """Custom function for top-level config data.
+
+ This just replaces the list of instances, nodes and the cluster
+ with standard python types.
+
+ """
+ mydict = super(ConfigData, self).ToDict()
+ mydict["cluster"] = mydict["cluster"].ToDict()
+ for key in "nodes", "instances":
+ mydict[key] = self._ContainerToDicts(mydict[key])
+
+ return mydict
+
+ @classmethod
+ def FromDict(cls, val):
+ """Custom function for top-level config data
+
+ """
+ obj = super(ConfigData, cls).FromDict(val)
+ obj.cluster = Cluster.FromDict(obj.cluster)
+ obj.nodes = cls._ContainerFromDicts(obj.nodes, dict, Node)
+ obj.instances = cls._ContainerFromDicts(obj.instances, dict, Instance)
+ return obj
+
class NIC(ConfigObject):
"""Config object representing a network card."""
def CreateOnSecondary(self):
"""Test if this device needs to be created on a secondary node."""
- return self.dev_type in ("drbd", "lvm")
+ return self.dev_type in (constants.LD_DRBD7, constants.LD_DRBD8,
+ constants.LD_LV)
def AssembleOnSecondary(self):
"""Test if this device needs to be assembled on a secondary node."""
- return self.dev_type in ("drbd", "lvm")
+ return self.dev_type in (constants.LD_DRBD7, constants.LD_DRBD8,
+ constants.LD_LV)
def OpenOnSecondary(self):
"""Test if this device needs to be opened on a secondary node."""
- return self.dev_type in ("lvm",)
+ return self.dev_type in (constants.LD_LV,)
def GetNodes(self, node):
"""This function returns the nodes this device lives on.
devices needs to (or can) be assembled.
"""
- if self.dev_type == "lvm" or self.dev_type == "md_raid1":
+ if self.dev_type == constants.LD_LV or self.dev_type == constants.LD_MD_R1:
result = [node]
- elif self.dev_type == "drbd":
+ elif self.dev_type in constants.LDS_DRBD:
result = [self.logical_id[0], self.logical_id[1]]
if node not in result:
- raise errors.ConfigurationError, ("DRBD device passed unknown node")
+ raise errors.ConfigurationError("DRBD device passed unknown node")
else:
- raise errors.ProgrammerError, "Unhandled device type %s" % self.dev_type
+ raise errors.ProgrammerError("Unhandled device type %s" % self.dev_type)
return result
def ComputeNodeTree(self, parent_node):
# be different)
return result
+ def ToDict(self):
+ """Disk-specific conversion to standard python types.
+
+ This replaces the children lists of objects with lists of
+ standard python types.
+
+ """
+ bo = super(Disk, self).ToDict()
+
+ for attr in ("children",):
+ alist = bo.get(attr, None)
+ if alist:
+ bo[attr] = self._ContainerToDicts(alist)
+ return bo
+
+ @classmethod
+ def FromDict(cls, val):
+ """Custom function for Disks
+
+ """
+ obj = super(Disk, cls).FromDict(val)
+ if obj.children:
+ obj.children = cls._ContainerFromDicts(obj.children, list, Disk)
+ if obj.logical_id and isinstance(obj.logical_id, list):
+ obj.logical_id = tuple(obj.logical_id)
+ if obj.physical_id and isinstance(obj.physical_id, list):
+ obj.physical_id = tuple(obj.physical_id)
+ return obj
+
+ def __str__(self):
+ """Custom str() formatter for disks.
+
+ """
+ if self.dev_type == constants.LD_LV:
+ val = "<LogicalVolume(/dev/%s/%s" % self.logical_id
+ elif self.dev_type in constants.LDS_DRBD:
+ if self.dev_type == constants.LD_DRBD7:
+ val = "<DRBD7("
+ else:
+ val = "<DRBD8("
+ if self.physical_id is None:
+ phy = "unconfigured"
+ else:
+ phy = ("configured as %s:%s %s:%s" %
+ (self.physical_id[0], self.physical_id[1],
+ self.physical_id[2], self.physical_id[3]))
+
+ val += ("hosts=%s-%s, port=%s, %s, " %
+ (self.logical_id[0], self.logical_id[1], self.logical_id[2],
+ phy))
+ if self.children and self.children.count(None) == 0:
+ val += "backend=%s, metadev=%s" % (self.children[0], self.children[1])
+ else:
+ val += "no local storage"
+ elif self.dev_type == constants.LD_MD_R1:
+ val = "<MD_R1(uuid=%s, children=%s" % (self.physical_id, self.children)
+ else:
+ val = ("<Disk(type=%s, logical_id=%s, physical_id=%s, children=%s" %
+ (self.dev_type, self.logical_id, self.physical_id, self.children))
+ if self.iv_name is None:
+ val += ", not visible"
+ else:
+ val += ", visible as /dev/%s" % self.iv_name
+ val += ", size=%dm)>" % self.size
+ return val
-class Instance(ConfigObject):
+
+class Instance(TaggableObject):
"""Config object representing an instance."""
- __slots__ = [
+ __slots__ = TaggableObject.__slots__ + [
"name",
"primary_node",
"os",
"""
def _Helper(primary, sec_nodes, device):
"""Recursively computes secondary nodes given a top device."""
- if device.dev_type == 'drbd':
+ if device.dev_type in constants.LDS_DRBD:
nodea, nodeb, dummy = device.logical_id
if nodea == primary:
candidate = nodeb
devs = self.disks
for dev in devs:
- if dev.dev_type == "lvm":
+ if dev.dev_type == constants.LD_LV:
lvmap[node].append(dev.logical_id[1])
- elif dev.dev_type == "drbd":
+ elif dev.dev_type in constants.LDS_DRBD:
if dev.logical_id[0] not in lvmap:
lvmap[dev.logical_id[0]] = []
return ret
+ def FindDisk(self, name):
+ """Find a disk given having a specified name.
+
+ This will return the disk which has the given iv_name.
+
+ """
+ for disk in self.disks:
+ if disk.iv_name == name:
+ return disk
+
+ return None
+
+ def ToDict(self):
+ """Instance-specific conversion to standard python types.
+
+ This replaces the children lists of objects with lists of standard
+ python types.
+
+ """
+ bo = super(Instance, self).ToDict()
+
+ for attr in "nics", "disks":
+ alist = bo.get(attr, None)
+ if alist:
+ nlist = self._ContainerToDicts(alist)
+ else:
+ nlist = []
+ bo[attr] = nlist
+ return bo
+
+ @classmethod
+ def FromDict(cls, val):
+ """Custom function for instances.
+
+ """
+ obj = super(Instance, cls).FromDict(val)
+ obj.nics = cls._ContainerFromDicts(obj.nics, list, NIC)
+ obj.disks = cls._ContainerFromDicts(obj.disks, list, Disk)
+ return obj
+
class OS(ConfigObject):
"""Config object representing an operating system."""
"api_version",
"create_script",
"export_script",
- "import_script"
+ "import_script",
+ "rename_script",
]
-class Node(ConfigObject):
+class Node(TaggableObject):
"""Config object representing a node."""
- __slots__ = ["name", "primary_ip", "secondary_ip"]
+ __slots__ = TaggableObject.__slots__ + [
+ "name",
+ "primary_ip",
+ "secondary_ip",
+ ]
-class Cluster(ConfigObject):
+class Cluster(TaggableObject):
"""Config object representing the cluster."""
- __slots__ = [
+ __slots__ = TaggableObject.__slots__ + [
"config_version",
"serial_no",
"rsahostkeypub",
"default_bridge",
]
+ def ToDict(self):
+ """Custom function for cluster.
+
+ """
+ mydict = super(Cluster, self).ToDict()
+ mydict["tcpudp_port_pool"] = list(self.tcpudp_port_pool)
+ return mydict
+
+ @classmethod
+ def FromDict(cls, val):
+ """Custom function for cluster.
+
+ """
+ obj = super(Cluster, cls).FromDict(val)
+ if not isinstance(obj.tcpudp_port_pool, set):
+ obj.tcpudp_port_pool = set(obj.tcpudp_port_pool)
+ return obj
+
+
class SerializableConfigParser(ConfigParser.SafeConfigParser):
"""Simple wrapper over ConfigParse that allows serialization.
projects / ganeti-local / blobdiff