mirror of
https://github.com/retspen/webvirtcloud
synced 2026-11-08 19:26:48 +00:00
fix(instances): NIC edits keep their settings; edits keep metadata
- change_network detached the NIC and attached one built from scratch, dropping its QoS, link state and other settings. It now edits the NIC of the persistent definition in place and defines once; a running VM gets the change at its next start, as the UI already says. - add_network, delete_network and set_link_state did nothing on a paused VM, and set_link_state rewrote the persistent NIC from the live XML. They now update the running definition when the VM is active and the persistent one always, each from its own XML. - Boot and console edits used xml.etree, which renamed the namespace prefixes of other tools' metadata (<app:info> became <ns0:info>); they use lxml now. - The NIC table and the clone form are filled from the persistent definition (Instance.config_networks, config_disks), so a pending NIC change is shown and can be edited again. A live test runs 18 domain edits on stopped, running and paused VMs whose definition has elements WebVirtCloud does not manage, and checks for each the effect, that nothing else in the persistent definition changed, and that persistent-only edits leave the running VM alone.
This commit is contained in:
catborise
parent
57cf49262a
commit
5def4e41fd
8 changed files with 444 additions and 89 deletions
|
|
@ -413,7 +413,7 @@ class wvmInstance(wvmConnect):
|
|||
arp_flag = 3 # libvirt."VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_ARP"
|
||||
self._ip_cache["arp"] = self._get_interface_addresses(arp_flag)
|
||||
|
||||
def get_net_devices(self):
|
||||
def get_net_devices(self, config=False):
|
||||
def networks(ctx):
|
||||
result = []
|
||||
inbound = outbound = []
|
||||
|
|
@ -460,7 +460,7 @@ class wvmInstance(wvmConnect):
|
|||
)
|
||||
return result
|
||||
|
||||
return util.get_xml_path(self._XMLDesc(0), func=networks)
|
||||
return util.get_xml_path(self._XMLDesc(PERSISTENT_XML if config else 0), func=networks)
|
||||
|
||||
def get_disk_devices(self, config=False):
|
||||
def disks(doc):
|
||||
|
|
@ -592,12 +592,12 @@ class wvmInstance(wvmConnect):
|
|||
return menu == "yes"
|
||||
|
||||
def set_bootmenu(self, flag):
|
||||
tree = ElementTree.fromstring(self._XMLDesc(PERSISTENT_XML))
|
||||
tree = etree.fromstring(self._XMLDesc(PERSISTENT_XML))
|
||||
os = tree.find("os")
|
||||
menu = os.find("bootmenu")
|
||||
|
||||
if menu is None:
|
||||
bootmenu = ElementTree.fromstring("<bootmenu enable='yes'/>")
|
||||
bootmenu = etree.fromstring("<bootmenu enable='yes'/>")
|
||||
os.append(bootmenu)
|
||||
menu = os.find("bootmenu")
|
||||
|
||||
|
|
@ -612,7 +612,7 @@ class wvmInstance(wvmConnect):
|
|||
"Unknown boot menu option, please choose one of 0:disable, 1:enable, -1:remove"
|
||||
)
|
||||
|
||||
xmldom = ElementTree.tostring(tree).decode()
|
||||
xmldom = etree.tostring(tree).decode()
|
||||
self._defineXML(xmldom)
|
||||
|
||||
def get_bootorder(self):
|
||||
|
|
@ -668,7 +668,7 @@ class wvmInstance(wvmConnect):
|
|||
return
|
||||
|
||||
def remove_bootorder():
|
||||
tree = ElementTree.fromstring(self._XMLDesc(PERSISTENT_XML))
|
||||
tree = etree.fromstring(self._XMLDesc(PERSISTENT_XML))
|
||||
os = tree.find("os")
|
||||
boot = os.findall("boot")
|
||||
# Remove old style boot order
|
||||
|
|
@ -684,7 +684,7 @@ class wvmInstance(wvmConnect):
|
|||
tree = remove_bootorder()
|
||||
|
||||
for idx, dev in devorder.items():
|
||||
order = ElementTree.fromstring("<boot order='{}'/>".format(idx + 1))
|
||||
order = etree.fromstring("<boot order='{}'/>".format(idx + 1))
|
||||
if dev["type"] == "disk":
|
||||
devices = tree.findall("./devices/disk[@device='disk']")
|
||||
for d in devices:
|
||||
|
|
@ -705,7 +705,7 @@ class wvmInstance(wvmConnect):
|
|||
d.append(order)
|
||||
else:
|
||||
raise Exception("Invalid Device Type for boot order")
|
||||
self._defineXML(ElementTree.tostring(tree).decode())
|
||||
self._defineXML(etree.tostring(tree).decode())
|
||||
|
||||
def _set_cdrom_media(self, dev, path):
|
||||
"""Insert path into, or with None eject, CD-ROM dev.
|
||||
|
|
@ -1096,7 +1096,7 @@ class wvmInstance(wvmConnect):
|
|||
return listener_addr
|
||||
|
||||
def set_console_listener_addr(self, listener_addr):
|
||||
root = ElementTree.fromstring(self._XMLDesc(PERSISTENT_XML))
|
||||
root = etree.fromstring(self._XMLDesc(PERSISTENT_XML))
|
||||
# The console is the first graphics device of the definition being
|
||||
# edited; the running VM may still have another type.
|
||||
graphic = root.find("devices/graphics")
|
||||
|
|
@ -1113,7 +1113,7 @@ class wvmInstance(wvmConnect):
|
|||
graphic.attrib.pop("listen")
|
||||
listen.attrib.pop("address")
|
||||
|
||||
newxml = ElementTree.tostring(root).decode()
|
||||
newxml = etree.tostring(root).decode()
|
||||
return self._defineXML(newxml)
|
||||
|
||||
def get_console_socket(self):
|
||||
|
|
@ -1153,7 +1153,7 @@ class wvmInstance(wvmConnect):
|
|||
)
|
||||
|
||||
def set_console_passwd(self, passwd):
|
||||
root = ElementTree.fromstring(self._XMLDesc(PERSISTENT_XML))
|
||||
root = etree.fromstring(self._XMLDesc(PERSISTENT_XML))
|
||||
graphic = root.find("devices/graphics")
|
||||
if graphic is None:
|
||||
return False
|
||||
|
|
@ -1163,11 +1163,11 @@ class wvmInstance(wvmConnect):
|
|||
with contextlib.suppress(Exception):
|
||||
graphic.attrib.pop("passwd")
|
||||
|
||||
newxml = ElementTree.tostring(root).decode()
|
||||
newxml = etree.tostring(root).decode()
|
||||
return self._defineXML(newxml)
|
||||
|
||||
def set_console_keymap(self, keymap):
|
||||
root = ElementTree.fromstring(self._XMLDesc(PERSISTENT_XML))
|
||||
root = etree.fromstring(self._XMLDesc(PERSISTENT_XML))
|
||||
graphic = root.find("devices/graphics")
|
||||
if graphic is None:
|
||||
return False
|
||||
|
|
@ -1177,7 +1177,7 @@ class wvmInstance(wvmConnect):
|
|||
with contextlib.suppress(Exception):
|
||||
graphic.attrib.pop("keymap")
|
||||
|
||||
newxml = ElementTree.tostring(root).decode()
|
||||
newxml = etree.tostring(root).decode()
|
||||
self._defineXML(newxml)
|
||||
|
||||
def get_console_keymap(self):
|
||||
|
|
@ -1674,41 +1674,67 @@ class wvmInstance(wvmConnect):
|
|||
etree.SubElement(iface, "filterref", filter=nwfilter)
|
||||
xml_iface = etree.tostring(iface).decode()
|
||||
|
||||
if self.get_status() == 1:
|
||||
if self.instance.isActive(): # running or paused
|
||||
self.instance.attachDeviceFlags(xml_iface, VIR_DOMAIN_AFFECT_LIVE)
|
||||
self.instance.attachDeviceFlags(xml_iface, VIR_DOMAIN_AFFECT_CONFIG)
|
||||
if self.get_status() == 5:
|
||||
self.instance.attachDeviceFlags(xml_iface, VIR_DOMAIN_AFFECT_CONFIG)
|
||||
self.instance.attachDeviceFlags(xml_iface, VIR_DOMAIN_AFFECT_CONFIG)
|
||||
|
||||
def _definitions(self):
|
||||
"""(XMLDesc flags, affect flag) of the definitions a device edit applies to:
|
||||
the running one when the VM is active (running or paused), and the
|
||||
persistent one. Each is edited from its own XML."""
|
||||
definitions = [(PERSISTENT_XML, VIR_DOMAIN_AFFECT_CONFIG)]
|
||||
if self.instance.isActive():
|
||||
definitions.insert(0, (VIR_DOMAIN_XML_SECURE, VIR_DOMAIN_AFFECT_LIVE))
|
||||
return definitions
|
||||
|
||||
def _nic(self, xml_flags, mac_address):
|
||||
found = etree.fromstring(self._XMLDesc(xml_flags)).xpath(
|
||||
"./devices/interface[mac/@address=$mac]", mac=mac_address
|
||||
)
|
||||
return found[0] if found else None
|
||||
|
||||
def delete_network(self, mac_address):
|
||||
tree = ElementTree.fromstring(self._XMLDesc(0))
|
||||
for interface in tree.findall("devices/interface"):
|
||||
source = interface.find("mac")
|
||||
if source.get("address", "") == mac_address:
|
||||
new_xml = ElementTree.tostring(interface).decode()
|
||||
|
||||
if self.get_status() == 1:
|
||||
self.instance.detachDeviceFlags(new_xml, VIR_DOMAIN_AFFECT_LIVE)
|
||||
self.instance.detachDeviceFlags(new_xml, VIR_DOMAIN_AFFECT_CONFIG)
|
||||
if self.get_status() == 5:
|
||||
self.instance.detachDeviceFlags(new_xml, VIR_DOMAIN_AFFECT_CONFIG)
|
||||
return new_xml
|
||||
return None
|
||||
"""Detach the NIC; returns its persistent XML, or None if there is none."""
|
||||
removed = None
|
||||
for xml_flags, affect in self._definitions():
|
||||
nic = self._nic(xml_flags, mac_address)
|
||||
if nic is not None:
|
||||
removed = etree.tostring(nic).decode()
|
||||
self.instance.detachDeviceFlags(removed, affect)
|
||||
return removed
|
||||
|
||||
def change_network(self, old_mac, mac, source, source_type, model, nwfilter):
|
||||
"""Replace the NIC with old_mac; put it back if the new one cannot be added."""
|
||||
old_xml = self.delete_network(old_mac)
|
||||
if old_xml is None:
|
||||
"""Edit the NIC with old_mac in the persistent definition, in place.
|
||||
|
||||
Settings this form does not edit (QoS, link state, driver, PCI address)
|
||||
stay. A running VM gets the change at its next start.
|
||||
"""
|
||||
tree = etree.fromstring(self._XMLDesc(PERSISTENT_XML))
|
||||
found = tree.xpath("./devices/interface[mac/@address=$mac]", mac=old_mac)
|
||||
if not found:
|
||||
raise util.OperationError(f"No network interface with MAC {old_mac}")
|
||||
try:
|
||||
self.add_network(mac, source, source_type, model, nwfilter)
|
||||
except libvirtError:
|
||||
if self.get_status() == 1:
|
||||
self.instance.attachDeviceFlags(old_xml, VIR_DOMAIN_AFFECT_LIVE)
|
||||
self.instance.attachDeviceFlags(old_xml, VIR_DOMAIN_AFFECT_CONFIG)
|
||||
if self.get_status() == 5:
|
||||
self.instance.attachDeviceFlags(old_xml, VIR_DOMAIN_AFFECT_CONFIG)
|
||||
raise
|
||||
iface = found[0]
|
||||
|
||||
iface_type = {"net": "network", "bridge": "bridge"}.get(source_type, "direct")
|
||||
iface.set("type", iface_type)
|
||||
for old_source in iface.findall("source"):
|
||||
iface.remove(old_source)
|
||||
source_attrs = {"network": {"network": source}, "bridge": {"bridge": source}}.get(
|
||||
iface_type, {"dev": source, "mode": "bridge"}
|
||||
)
|
||||
iface.insert(1, etree.Element("source", **source_attrs))
|
||||
|
||||
iface.find("mac").set("address", mac)
|
||||
for old_model in iface.findall("model"):
|
||||
iface.remove(old_model)
|
||||
if model:
|
||||
etree.SubElement(iface, "model", type=model)
|
||||
for old_filter in iface.findall("filterref"):
|
||||
iface.remove(old_filter)
|
||||
if nwfilter:
|
||||
etree.SubElement(iface, "filterref", filter=nwfilter)
|
||||
|
||||
self._defineXML(etree.tostring(tree).decode())
|
||||
|
||||
def change_network_oldway(self, network_data):
|
||||
"""
|
||||
|
|
@ -1768,22 +1794,14 @@ class wvmInstance(wvmConnect):
|
|||
self._defineXML(new_xml)
|
||||
|
||||
def set_link_state(self, mac_address, state):
|
||||
tree = etree.fromstring(self._XMLDesc(0))
|
||||
for interface in tree.findall("devices/interface"):
|
||||
source = interface.find("mac")
|
||||
if source.get("address") == mac_address:
|
||||
link = interface.find("link")
|
||||
if link is not None:
|
||||
interface.remove(link)
|
||||
link_el = etree.Element("link")
|
||||
link_el.attrib["state"] = state
|
||||
interface.append(link_el)
|
||||
new_xml = etree.tostring(interface).decode()
|
||||
if self.get_status() == 1:
|
||||
self.instance.updateDeviceFlags(new_xml, VIR_DOMAIN_AFFECT_LIVE)
|
||||
self.instance.updateDeviceFlags(new_xml, VIR_DOMAIN_AFFECT_CONFIG)
|
||||
if self.get_status() == 5:
|
||||
self.instance.updateDeviceFlags(new_xml, VIR_DOMAIN_AFFECT_CONFIG)
|
||||
for xml_flags, affect in self._definitions():
|
||||
nic = self._nic(xml_flags, mac_address)
|
||||
if nic is None:
|
||||
continue
|
||||
for link in nic.findall("link"):
|
||||
nic.remove(link)
|
||||
etree.SubElement(nic, "link", state=state)
|
||||
self.instance.updateDeviceFlags(etree.tostring(nic).decode(), affect)
|
||||
|
||||
def _set_options(self, tree, options):
|
||||
for o in ["title", "description"]:
|
||||
|
|
|
|||
|
|
@ -6,50 +6,51 @@ from django.conf import settings
|
|||
if not settings.configured:
|
||||
settings.configure(MAC_OUI="52:54:10")
|
||||
|
||||
from libvirt import VIR_DOMAIN_AFFECT_CONFIG, libvirtError
|
||||
from libvirt import libvirtError
|
||||
from vrtManager.instance import wvmInstance
|
||||
|
||||
DOMAIN_XML = """<domain><devices>
|
||||
<interface type='network'><mac address='52:54:00:00:00:01'/><source network='default'/><model type='virtio'/></interface>
|
||||
<interface type='network'><mac address='52:54:00:00:00:02'/><source network='default'/><model type='virtio'/></interface>
|
||||
<interface type='network'><mac address='52:54:00:00:00:02'/><source network='default'/><model type='virtio'/>
|
||||
<bandwidth><outbound average='1000'/></bandwidth><link state='down'/>
|
||||
<address type='pci' domain='0x0000' bus='0x02' slot='0x00' function='0x0'/></interface>
|
||||
</devices></domain>"""
|
||||
|
||||
|
||||
def stopped_instance():
|
||||
inst = wvmInstance.__new__(wvmInstance)
|
||||
inst.instance = MagicMock()
|
||||
inst.wvm = MagicMock()
|
||||
inst._XMLDesc = MagicMock(return_value=DOMAIN_XML)
|
||||
inst.get_status = MagicMock(return_value=5)
|
||||
return inst
|
||||
|
||||
|
||||
class TestChangeNetwork(unittest.TestCase):
|
||||
def test_replaces_the_nic_with_the_old_mac(self):
|
||||
def test_edits_the_nic_in_place_and_keeps_its_other_settings(self):
|
||||
from lxml import etree
|
||||
|
||||
inst = stopped_instance()
|
||||
inst.change_network("52:54:00:00:00:02", "52:54:00:00:00:03", "default", "net", "e1000", "")
|
||||
inst.change_network("52:54:00:00:00:02", "52:54:00:00:00:03", "br0", "bridge", "e1000", "clean-traffic")
|
||||
|
||||
detached = inst.instance.detachDeviceFlags.call_args[0][0]
|
||||
self.assertIn("52:54:00:00:00:02", detached)
|
||||
attached = inst.instance.attachDeviceFlags.call_args[0][0]
|
||||
self.assertIn("52:54:00:00:00:03", attached)
|
||||
self.assertIn("e1000", attached)
|
||||
defined = etree.fromstring(inst.wvm.defineXML.call_args[0][0])
|
||||
first, second = defined.findall("devices/interface")
|
||||
self.assertEqual(first.find("mac").get("address"), "52:54:00:00:00:01")
|
||||
self.assertEqual(second.get("type"), "bridge")
|
||||
self.assertEqual(second.find("mac").get("address"), "52:54:00:00:00:03")
|
||||
self.assertEqual(second.find("source").attrib, {"bridge": "br0"})
|
||||
self.assertEqual(second.find("model").get("type"), "e1000")
|
||||
self.assertEqual(second.find("filterref").get("filter"), "clean-traffic")
|
||||
# F-06: QoS, link state and the PCI address survive
|
||||
self.assertEqual(second.find("bandwidth/outbound").get("average"), "1000")
|
||||
self.assertEqual(second.find("link").get("state"), "down")
|
||||
self.assertEqual(second.find("address").get("bus"), "0x02")
|
||||
|
||||
def test_unknown_old_mac_adds_nothing(self):
|
||||
def test_unknown_old_mac_changes_nothing(self):
|
||||
inst = stopped_instance()
|
||||
with self.assertRaises(libvirtError):
|
||||
inst.change_network("52:54:00:00:00:09", "52:54:00:00:00:03", "default", "net", "virtio", "")
|
||||
inst.instance.detachDeviceFlags.assert_not_called()
|
||||
inst.instance.attachDeviceFlags.assert_not_called()
|
||||
|
||||
def test_failed_add_restores_the_old_nic(self):
|
||||
inst = stopped_instance()
|
||||
inst.instance.attachDeviceFlags.side_effect = [libvirtError("bad source"), 0]
|
||||
with self.assertRaises(libvirtError):
|
||||
inst.change_network("52:54:00:00:00:01", "52:54:00:00:00:03", "missing", "net", "virtio", "")
|
||||
|
||||
restored, flags = inst.instance.attachDeviceFlags.call_args[0]
|
||||
self.assertIn("52:54:00:00:00:01", restored)
|
||||
self.assertEqual(flags, VIR_DOMAIN_AFFECT_CONFIG)
|
||||
inst.wvm.defineXML.assert_not_called()
|
||||
|
||||
|
||||
class TestAddNetworkXml(unittest.TestCase):
|
||||
|
|
|
|||
|
|
@ -42,5 +42,41 @@ class PersistentEditsTestCase(unittest.TestCase):
|
|||
self.assertIn("secret", str(defined))
|
||||
|
||||
|
||||
class XmlFidelityTestCase(unittest.TestCase):
|
||||
def test_edits_keep_metadata_namespace_prefixes(self):
|
||||
xml = (
|
||||
"<domain><metadata><app:info xmlns:app='http://example.com/x'>v</app:info></metadata>"
|
||||
"<os><type>hvm</type></os><devices><graphics type='vnc'><listen type='address'/></graphics>"
|
||||
"<disk type='file' device='disk'><target dev='vda'/></disk></devices></domain>"
|
||||
)
|
||||
edits = {
|
||||
"set_bootmenu": lambda vm: vm.set_bootmenu(1),
|
||||
"set_bootorder": lambda vm: vm.set_bootorder({0: {"type": "disk", "dev": "vda"}}),
|
||||
"set_console_keymap": lambda vm: vm.set_console_keymap("de"),
|
||||
"set_console_passwd": lambda vm: vm.set_console_passwd("x"),
|
||||
"set_console_listener_addr": lambda vm: vm.set_console_listener_addr("127.0.0.1"),
|
||||
}
|
||||
for name, edit in edits.items():
|
||||
with self.subTest(name):
|
||||
vm = wvmInstance.__new__(wvmInstance)
|
||||
vm.wvm = MagicMock()
|
||||
vm._XMLDesc = MagicMock(return_value=xml)
|
||||
edit(vm)
|
||||
self.assertIn("<app:info", vm.wvm.defineXML.call_args[0][0])
|
||||
|
||||
def test_paused_vm_gets_nic_changes_live_and_persistent(self):
|
||||
from libvirt import VIR_DOMAIN_AFFECT_CONFIG, VIR_DOMAIN_AFFECT_LIVE
|
||||
|
||||
vm = wvmInstance.__new__(wvmInstance)
|
||||
vm.instance = MagicMock()
|
||||
vm.instance.isActive.return_value = True
|
||||
vm.get_status = MagicMock(return_value=3) # paused
|
||||
vm.add_network("52:54:00:00:00:09", "default", "net", "virtio")
|
||||
self.assertEqual(
|
||||
[c.args[1] for c in vm.instance.attachDeviceFlags.call_args_list],
|
||||
[VIR_DOMAIN_AFFECT_LIVE, VIR_DOMAIN_AFFECT_CONFIG],
|
||||
)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue