From: ShaoHe Feng <shaohef(a)linux.vnet.ibm.com&gt; it should be: FeatureTests.enable_screen_error_logging() instead of: FeatureTests.enable_screen_error_logging Signed-off-by: ShaoHe Feng <shaohef(a)linux.vnet.ibm.com&gt; --- src/kimchi/featuretests.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/kimchi/featuretests.py b/src/kimchi/featuretests.py index 07d5676..b1001ea 100644 --- a/src/kimchi/featuretests.py +++ b/src/kimchi/featuretests.py @@ -171,7 +171,7 @@ class FeatureTests(object): # Libvirt requires adapter name, not needed when supports to FC return False finally: - FeatureTests.enable_screen_error_logging + FeatureTests.enable_screen_error_logging() pool is None or pool.undefine() conn is None or conn.close() return True -- 1.9.0

From: ShaoHe Feng <shaohef(a)linux.vnet.ibm.com&gt; Libvirt support two API to set and get domain xml metadata. These two function wrap them. Put them in model/utils.py, so vm_storage and vm_iface can make use of them. For set domain xml metadata, we set live and config xml by default. For get domain xml metadata, we get the current xml by default. Signed-off-by: ShaoHe Feng <shaohef(a)linux.vnet.ibm.com&gt; Signed-off-by: Royce Lv <lvroyce(a)linux.vnet.ibm.com&gt; --- src/kimchi/i18n.py | 1 + src/kimchi/model/utils.py | 59 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 60 insertions(+) diff --git a/src/kimchi/i18n.py b/src/kimchi/i18n.py index a1af1f7..e28f689 100644 --- a/src/kimchi/i18n.py +++ b/src/kimchi/i18n.py @@ -87,6 +87,7 @@ messages = { "KCHVM0027E": _("User(s) '%(users)s' do not exist"), "KCHVM0028E": _("Group(s) '%(groups)s' do not exist"), "KCHVM0029E": _("Unable to shutdown virtual machine %(name)s. Details: %(err)s"), + "KCHVM0030E": _("Unable to get access metadata of virtual machine %(name)s. Details: %(err)s"), "KCHVMIF0001E": _("Interface %(iface)s does not exist in virtual machine %(name)s"), "KCHVMIF0002E": _("Network %(network)s specified for virtual machine %(name)s does not exist"), diff --git a/src/kimchi/model/utils.py b/src/kimchi/model/utils.py index 80e1801..3136402 100644 --- a/src/kimchi/model/utils.py +++ b/src/kimchi/model/utils.py @@ -18,6 +18,13 @@ # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA from kimchi.exception import OperationFailed +import libvirt +from lxml import etree +from lxml.builder import E + + +KIMCHI_META_URL = "https://github.com/kimchi-project/kimchi" +KIMCHI_NAMESPACE = "kimchi" def get_vm_name(vm_name, t_name, name_list): @@ -28,3 +35,55 @@ def get_vm_name(vm_name, t_name, name_list): if vm_name not in name_list: return vm_name raise OperationFailed("KCHUTILS0003E") + + +def get_vm_config_flag(dom, mode="persistent"): + # libvirt.VIR_DOMAIN_AFFECT_CURRENT is 0 + # VIR_DOMAIN_AFFECT_LIVE is 1, VIR_DOMAIN_AFFECT_CONFIG is 2 + flag = {"live": libvirt.VIR_DOMAIN_AFFECT_LIVE, + "persistent": libvirt.VIR_DOMAIN_AFFECT_CONFIG, + "current": libvirt.VIR_DOMAIN_AFFECT_CURRENT, + "all": libvirt.VIR_DOMAIN_AFFECT_CONFIG + + libvirt.VIR_DOMAIN_AFFECT_LIVE if dom.isActive() and + dom.isPersistent() else libvirt.VIR_DOMAIN_AFFECT_CURRENT} + + return flag[mode] + + +def libvirt_get_kimchi_metadata_node(dom, mode="current"): + try: + xml = dom.metadata(libvirt.VIR_DOMAIN_METADATA_ELEMENT, + KIMCHI_META_URL, + flags=get_vm_config_flag(dom, mode)) + return etree.fromstring(xml) + except libvirt.libvirtError: + return None + + +def set_metadata_node(dom, node_xml, mode="all"): + element = etree.fromstring(node_xml) + kimchi = libvirt_get_kimchi_metadata_node(dom, mode) + old_node = None + if kimchi is not None: + old_node = kimchi.find(element.tag) + else: + kimchi = E.kimchi() + (kimchi.replace(old_node, element) if old_node is not None + else kimchi.append(element)) + + node_xml = etree.tostring(kimchi) + # From libvirt doc, Passing None for @metadata says to remove that + # element from the domain XML (passing the empty string leaves the + # element present). Do not support remove the old metadata. + dom.setMetadata(libvirt.VIR_DOMAIN_METADATA_ELEMENT, node_xml, + KIMCHI_NAMESPACE, KIMCHI_META_URL, + flags=get_vm_config_flag(dom, mode)) + + +def get_metadata_node(dom, tag, mode="current"): + kimchi = libvirt_get_kimchi_metadata_node(dom, mode) + if kimchi is not None: + node = kimchi.find(tag) + if node is not None: + return etree.tostring(node) + return "" -- 1.9.0

On 04/28/2014 12:44 PM, shaohef(a)linux.vnet.ibm.com wrote: There is a some duplicated code here and in set_metadata_node() We should have special function only for special matters. See below Why node_xml? Use node directly as we use ET to create the element in model/vms.py That way we avoid ET node -> string -> ET node There is already an if/else statement above, use the same one to append or replace the new node if kimchi is None: node = kimchi.find(element.tag) kimchi.replace(node, element) else: kimchi = E.kimchi() kimchi.append(element) Joining common code in one place: def set_metadata_node(dom, node, mode="all") kimchi = get_kimchi_metadata_node(dom, mode) if kimchi is None: kimchi = create_metadata_node("kimchi") else: old_node = kimchi.find(node.tag) kimchi.replace(old_node, node) if CapabilitiesModel().metadata_support: return dom.setMetadata(libvirt.VIR_DOMAIN_METADATA_ELEMENT, node_xml, KIMCHI_NAMESPACE, KIMCHI_META_URL, flags=get_vm_config_flag(dom, mode)) # Without metadata support # some other tools will not let libvirt create a persistent # configuration, raise exception. if not dom.isPersistent(): msg = 'The VM has not a persistent configuration' raise OperationFailed("KCHVM0030E", + {'name': dom.name(), "err": msg}) xml = dom.XMLDesc(libvirt.VIR_DOMAIN_XML_INACTIVE) root = etree.fromstring(xml) metadata = root.find("metadata") if metadtaa is None: metadata = E.metadata() root.append(metadata) old_node = root.find("metadata/{%s}kimchi" % KIMCHI_META_URL) metadata.replace(old_node, kimchi) if old_node else metadata.append(kimchi) dom.connect().defineXML(etree.tostring(root)) def get_kimchi_metadata_node(dom, mode): if CapabilitiesModel().metadata_support: xml = dom.metadata(libvirt.VIR_DOMAIN_METADATA_ELEMENT, KIMCHI_META_URL, flags=get_vm_config_flag(dom, mode)) return etree.fromstring(xml) # Without metadata support xml = dom.XMLDesc(libvirt.VIR_DOMAIN_XML_INACTIVE) root = etree.fromstring(xml) metadata = root.find("metadata") return root.find("metadata/{%s}kimchi" % KIMCHI_META_URL) What about? if kimchi is None: return "" kimchi_xml = etree.tostring(kimchi) Kimchi = kimchi_xml.replace("{%s}" % KIMCHI_META_URL, "") node = kimchi.find(tag) if node is not None: return etree.tostring(node) return ""

On 04/28/2014 09:13 PM, Sheldon wrote: OK. I thought all "node" would be valid Ok. Keep it as you have done.

From: ShaoHe Feng <shaohef(a)linux.vnet.ibm.com&gt; define a domain just edit the persistent xml. So we should get user and group from persistent xml instead of live xml when domain is living. Refacor the code by libvirt metadata API and fix the bug. Signed-off-by: ShaoHe Feng <shaohef(a)linux.vnet.ibm.com&gt; Signed-off-by: Royce Lv <lvroyce(a)linux.vnet.ibm.com&gt; --- src/kimchi/model/vms.py | 88 ++++++++++++++++++++++++++----------------------- 1 file changed, 47 insertions(+), 41 deletions(-) diff --git a/src/kimchi/model/vms.py b/src/kimchi/model/vms.py index 8a79f0f..be720f3 100644 --- a/src/kimchi/model/vms.py +++ b/src/kimchi/model/vms.py @@ -17,6 +17,7 @@ # License along with this library; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +from lxml.builder import E import lxml.etree as ET import os import time @@ -25,7 +26,6 @@ from xml.etree import ElementTree import libvirt from cherrypy.process.plugins import BackgroundTask -from lxml.builder import E from kimchi import vnc from kimchi import xmlutils @@ -35,6 +35,8 @@ from kimchi.exception import NotFoundError, OperationFailed from kimchi.model.config import CapabilitiesModel from kimchi.model.templates import TemplateModel from kimchi.model.utils import get_vm_name +from kimchi.model.utils import get_metadata_node +from kimchi.model.utils import set_metadata_node from kimchi.screenshot import VMScreenshot from kimchi.utils import import_class, kimchi_log, run_setfacl_set_attr from kimchi.utils import template_name_from_uri @@ -247,7 +249,7 @@ class VMModel(object): self._live_vm_update(dom, params) return dom.name().decode('utf-8') - def _get_metadata_node(self, users, groups): + def _build_access_elem(self, users, groups): access = E.access() for user in users: access.append(E.user(user)) @@ -255,40 +257,50 @@ class VMModel(object): for group in groups: access.append(E.group(group)) - return E.metadata(E.kimchi(access)) + return access + + def _vm_update_access_metadata(self, dom, params): + users = groups = None + if "users" in params: + users = params["users"] + invalid_users = set(users) - set(self.users.get_list()) + if len(invalid_users) != 0: + raise InvalidParameter("KCHVM0027E", + {'users': ", ".join(invalid_users)}) + if "groups" in params: + groups = params["groups"] + invalid_groups = set(groups) - set(self.groups.get_list()) + if len(invalid_groups) != 0: + raise InvalidParameter("KCHVM0028E", + {'groups': ", ".join(invalid_groups)}) + + if users is None and groups is None: + return + + access_xml = (get_metadata_node(dom, "access") or + """<access></access>""") + old_users = xpath_get_text(access_xml, "/access/user") + old_groups = xpath_get_text(access_xml, "/access/group") + users = old_users if users is None else users + groups = old_groups if groups is None else groups + + node = self._build_access_elem(users, groups) + set_metadata_node(dom, ET.tostring(node)) def _static_vm_update(self, dom, params): state = DOM_STATE_MAP[dom.info()[0]] old_xml = new_xml = dom.XMLDesc(0) - metadata_xpath = "/domain/metadata/kimchi/access/%s" - users = xpath_get_text(old_xml, metadata_xpath % "user") - groups = xpath_get_text(old_xml, metadata_xpath % "group") - for key, val in params.items(): - if key == 'users': - invalid_users = set(val) - set(self.users.get_list()) - if len(invalid_users) != 0: - raise InvalidParameter("KCHVM0027E", - {'users': ", ".join(invalid_users)}) - users = val - elif key == 'groups': - invalid_groups = set(val) - set(self.groups.get_list()) - if len(invalid_groups) != 0: - raise InvalidParameter("KCHVM0028E", - {'groups': - ", ".join(invalid_groups)}) - groups = val - else: - if key in VM_STATIC_UPDATE_PARAMS: - if key == 'memory': - # Libvirt saves memory in KiB. Retrieved xml has memory - # in KiB too, so new valeu must be in KiB here - val = val * 1024 - if type(val) == int: - val = str(val) - xpath = VM_STATIC_UPDATE_PARAMS[key] - new_xml = xmlutils.xml_item_update(new_xml, xpath, val) + if key in VM_STATIC_UPDATE_PARAMS: + if key == 'memory': + # Libvirt saves memory in KiB. Retrieved xml has memory + # in KiB too, so new valeu must be in KiB here + val = val * 1024 + if type(val) == int: + val = str(val) + xpath = VM_STATIC_UPDATE_PARAMS[key] + new_xml = xmlutils.xml_item_update(new_xml, xpath, val) conn = self.conn.get() try: @@ -302,13 +314,6 @@ class VMModel(object): root = ET.fromstring(new_xml) root.remove(root.find('.currentMemory')) - # Update metadata element - current_metadata = root.find('metadata') - new_metadata = self._get_metadata_node(users, groups) - if current_metadata is not None: - root.replace(current_metadata, new_metadata) - else: - root.append(new_metadata) dom = conn.defineXML(ET.tostring(root, encoding="utf-8")) except libvirt.libvirtError as e: dom = conn.defineXML(old_xml) @@ -317,7 +322,7 @@ class VMModel(object): return dom def _live_vm_update(self, dom, params): - pass + self._vm_update_access_metadata(dom, params) def _has_video(self, dom): dom = ElementTree.fromstring(dom.XMLDesc(0)) @@ -356,9 +361,10 @@ class VMModel(object): res['io_throughput'] = vm_stats.get('disk_io', 0) res['io_throughput_peak'] = vm_stats.get('max_disk_io', 100) - xml = dom.XMLDesc(0) - users = xpath_get_text(xml, "/domain/metadata/kimchi/access/user") - groups = xpath_get_text(xml, "/domain/metadata/kimchi/access/group") + access_xml = (get_metadata_node(dom, "access") or + """<access></access>""") + users = xpath_get_text(access_xml, "/access/user") + groups = xpath_get_text(access_xml, "/access/group") return {'name': name, 'state': state, -- 1.9.0

From: ShaoHe Feng <shaohef(a)linux.vnet.ibm.com&gt; Then kimchi can choose the divice mode depend on these info. Note, the info is the initial OS when install OS on a blank guest. OS may change after the install. So other device should still keep their model info in the vm metadata. Signed-off-by: ShaoHe Feng <shaohef(a)linux.vnet.ibm.com&gt; Signed-off-by: Royce Lv <lvroyce(a)linux.vnet.ibm.com&gt; --- src/kimchi/model/vms.py | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/src/kimchi/model/vms.py b/src/kimchi/model/vms.py index be720f3..26ef0e8 100644 --- a/src/kimchi/model/vms.py +++ b/src/kimchi/model/vms.py @@ -223,6 +223,8 @@ class VMsModel(object): raise OperationFailed("KCHVM0007E", {'name': name, 'err': e.get_error_message()}) + VMModel.vm_update_os_metadata(VMModel.get_vm(name, self.conn), t.info) + return name def get_list(self): @@ -287,6 +289,21 @@ class VMModel(object): node = self._build_access_elem(users, groups) set_metadata_node(dom, ET.tostring(node)) + @staticmethod + def vm_get_os_metadata(dom): + os_xml = get_metadata_node(dom, "os") or """<os></os>""" + os_elem = ET.fromstring(os_xml) + return (os_elem.attrib.get("version"), os_elem.attrib.get("distro")) + + @staticmethod + def vm_update_os_metadata(dom, params): + distro = params.get("os_distro") + version = params.get("os_version") + if distro is None: + return + os_elem = E.os({"distro": distro, "version": version}) + set_metadata_node(dom, ET.tostring(os_elem)) + def _static_vm_update(self, dom, params): state = DOM_STATE_MAP[dom.info()[0]] old_xml = new_xml = dom.XMLDesc(0) -- 1.9.0