From: ShaoHe Feng <shaohef@linux.vnet.ibm.com> same mechanism with other feature tests. Signed-off-by: ShaoHe Feng <shaohef@linux.vnet.ibm.com> Signed-off-by: Royce Lv <lvroyce@linux.vnet.ibm.com> --- src/kimchi/featuretests.py | 31 +++++++++++++++++++++++++++++++ src/kimchi/model/config.py | 2 ++ 2 files changed, 33 insertions(+) diff --git a/src/kimchi/featuretests.py b/src/kimchi/featuretests.py index b1001ea..5192361 100644 --- a/src/kimchi/featuretests.py +++ b/src/kimchi/featuretests.py @@ -28,6 +28,7 @@ import threading from lxml.builder import E +from kimchi.rollbackcontext import RollbackContext from kimchi.utils import kimchi_log @@ -53,6 +54,16 @@ ISO_STREAM_XML = """ </devices> </domain>""" +SIMPLE_VM_XML = """ +<domain type='kvm'> + <name>A_SIMPLE_VM</name> + <memory unit='KiB'>10240</memory> + <os> + <type arch='x86_64' machine='pc'>hvm</type> + <boot dev='hd'/> + </os> +</domain>""" + SCSI_FC_XML = """ <pool type='scsi'> <name>TEST_SCSI_FC_POOL</name> @@ -175,3 +186,23 @@ class FeatureTests(object): pool is None or pool.undefine() conn is None or conn.close() return True + + @staticmethod + def has_metadata_support(): + KIMCHI_META_URL = "https://github.com/kimchi-project/kimchi/" + KIMCHI_NAMESPACE = "kimchi" + with RollbackContext() as rollback: + FeatureTests.disable_screen_error_logging() + rollback.prependDefer(FeatureTests.enable_screen_error_logging) + conn = libvirt.open('qemu:///system') + rollback.prependDefer(conn.close) + dom = conn.defineXML(SIMPLE_VM_XML) + rollback.prependDefer(dom.undefine) + try: + dom.setMetadata(libvirt.VIR_DOMAIN_METADATA_ELEMENT, + "<metatest/>", KIMCHI_NAMESPACE, + KIMCHI_META_URL, + flags=libvirt.VIR_DOMAIN_AFFECT_CURRENT) + return True + except libvirt.libvirtError: + return False diff --git a/src/kimchi/model/config.py b/src/kimchi/model/config.py index c9e3e9d..0ef0855 100644 --- a/src/kimchi/model/config.py +++ b/src/kimchi/model/config.py @@ -53,6 +53,7 @@ class CapabilitiesModel(object): self.qemu_stream_dns = False self.libvirt_stream_protocols = [] self.fc_host_support = False + self.metadata_support = False # Subscribe function to set host capabilities to be run when cherrypy # server is up @@ -65,6 +66,7 @@ class CapabilitiesModel(object): self.qemu_stream_dns = FeatureTests.qemu_iso_stream_dns() self.nfs_target_probe = FeatureTests.libvirt_support_nfs_probe() self.fc_host_support = FeatureTests.libvirt_support_fc_host() + self.metadata_support = FeatureTests.has_metadata_support() self.libvirt_stream_protocols = [] for p in ['http', 'https', 'ftp', 'ftps', 'tftp']: -- 1.9.0

From: ShaoHe Feng <shaohef@linux.vnet.ibm.com> virDomain.metadata and virDomain.setMetadata does not work in all livirt versions used in the supported distros. So if libvirt do not support these two API. let kimchi manually manage the metadata element Signed-off-by: ShaoHe Feng <shaohef@linux.vnet.ibm.com> Signed-off-by: Royce Lv <lvroyce@linux.vnet.ibm.com> --- src/kimchi/model/utils.py | 88 ++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 75 insertions(+), 13 deletions(-) diff --git a/src/kimchi/model/utils.py b/src/kimchi/model/utils.py index 3aaa956..7845c0d 100644 --- a/src/kimchi/model/utils.py +++ b/src/kimchi/model/utils.py @@ -17,10 +17,12 @@ # License along with this library; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +import re from kimchi.exception import OperationFailed +from kimchi.model.config import CapabilitiesModel import libvirt from lxml import etree -from lxml.builder import E +from lxml.builder import E, ElementMaker KIMCHI_META_URL = "https://github.com/kimchi-project/kimchi" @@ -37,6 +39,15 @@ def get_vm_name(vm_name, t_name, name_list): raise OperationFailed("KCHUTILS0003E") +def create_metadata_node(tag): + if CapabilitiesModel().metadata_support: + return E(tag) + else: + EM = ElementMaker(namespace=KIMCHI_META_URL, + nsmap={KIMCHI_NAMESPACE: KIMCHI_META_URL}) + return EM(tag) + + 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 @@ -58,6 +69,25 @@ def update_node(root, node): return root +def _kimchi_set_metadata_node(dom, node): + # 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) + kimchi = root.find("metadata/{%s}kimchi" % KIMCHI_META_URL) + kimchi = create_metadata_node("kimchi") if kimchi is None else kimchi + update_node(kimchi, node) + metadata = root.find("metadata") + metadata = E.metadata() if metadata is None else metadata + update_node(metadata, kimchi) + update_node(root, metadata) + dom.connect().defineXML(etree.tostring(root)) + + def libvirt_get_kimchi_metadata_node(dom, mode="current"): try: xml = dom.metadata(libvirt.VIR_DOMAIN_METADATA_ELEMENT, @@ -69,21 +99,53 @@ def libvirt_get_kimchi_metadata_node(dom, mode="current"): def set_metadata_node(dom, node, mode="all"): - kimchi = libvirt_get_kimchi_metadata_node(dom, mode) - kimchi = E.kimchi() if kimchi is None else kimchi - - update_node(kimchi, node) - kimchi_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, kimchi_xml, - KIMCHI_NAMESPACE, KIMCHI_META_URL, - flags=get_vm_config_flag(dom, mode)) + if CapabilitiesModel().metadata_support: + kimchi = libvirt_get_kimchi_metadata_node(dom, mode) + kimchi = E.kimchi() if kimchi is None else kimchi + + update_node(kimchi, node) + kimchi_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, kimchi_xml, + KIMCHI_NAMESPACE, KIMCHI_META_URL, + flags=get_vm_config_flag(dom, mode)) + else: + # FIXME remove this code when all distro libvirt supports metadata element + _kimchi_set_metadata_node(dom, node) + + +def _kimchi_get_metadata_node(dom, tag): + # some other tools will not let libvirt create a persistent + # configuration, just return empty + if not dom.isPersistent(): + return None + xml = dom.XMLDesc(libvirt.VIR_DOMAIN_XML_INACTIVE) + root = etree.fromstring(xml) + kimchi = root.find("metadata/{%s}kimchi" % KIMCHI_META_URL) + #remove the "kimchi" prifix of xml + # some developers may do not like to remove prefix by children iteration + # so here, use re to remove the "kimchi" prefix of xml + # and developers please don not define element like this: + # <foo attr="foo<kimchi:abcd>foo"></foo> + if kimchi is not None: + kimchi_xml = etree.tostring(kimchi) + ns_pattern = re.compile(" xmlns:.*?=((\".*?\")|('.*?'))") + kimchi_xml = ns_pattern.sub("", kimchi_xml) + prefix_pattern = re.compile("(?<=<)[^/]*?:|(?<=</).*?:") + kimchi_xml = prefix_pattern.sub("", kimchi_xml) + return etree.fromstring(kimchi_xml) + return None def get_metadata_node(dom, tag, mode="current"): - kimchi = libvirt_get_kimchi_metadata_node(dom, mode) + if CapabilitiesModel().metadata_support: + kimchi = libvirt_get_kimchi_metadata_node(dom, mode) + else: + # FIXME remove this code when all distro libvirt supports metadata element + kimchi = _kimchi_get_metadata_node(dom, tag) + if kimchi is not None: node = kimchi.find(tag) if node is not None: -- 1.9.0

From: ShaoHe Feng <shaohef@linux.vnet.ibm.com> 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@linux.vnet.ibm.com> Signed-off-by: Royce Lv <lvroyce@linux.vnet.ibm.com> --- src/kimchi/model/utils.py | 2 +- src/kimchi/model/vms.py | 88 +++++++++++++++++++++++++---------------------- 2 files changed, 48 insertions(+), 42 deletions(-) diff --git a/src/kimchi/model/utils.py b/src/kimchi/model/utils.py index 7845c0d..7df5388 100644 --- a/src/kimchi/model/utils.py +++ b/src/kimchi/model/utils.py @@ -124,7 +124,7 @@ def _kimchi_get_metadata_node(dom, tag): xml = dom.XMLDesc(libvirt.VIR_DOMAIN_XML_INACTIVE) root = etree.fromstring(xml) kimchi = root.find("metadata/{%s}kimchi" % KIMCHI_META_URL) - #remove the "kimchi" prifix of xml + #remove the "kimchi" prefix of xml # some developers may do not like to remove prefix by children iteration # so here, use re to remove the "kimchi" prefix of xml # and developers please don not define element like this: diff --git a/src/kimchi/model/vms.py b/src/kimchi/model/vms.py index 8a79f0f..af07a2c 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, 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@linux.vnet.ibm.com> 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@linux.vnet.ibm.com> Signed-off-by: Royce Lv <lvroyce@linux.vnet.ibm.com> --- 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 af07a2c..17bda04 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, 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, 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