"""The VM page reads each kind of domain XML, the VM's state, the host's capabilities and info, and each disk's volume once, through the real getters, on libvirt's test driver.""" from unittest.mock import patch import libvirt from computes.models import Compute from django.contrib.auth import get_user_model from django.test import TestCase from django.urls import reverse from instances.models import Instance # a VM with a disk and a VNC console, on libvirt's test driver DOMAIN = """read-cache-vm0b9f6a52-6d0e-4c1f-9a51-2f3c1d7e8a401281 hvm """ class DetailReadsTests(TestCase): def setUp(self): self.conn = libvirt.open("test:///default") self.addCleanup(self.conn.close) # the test host lives on while a libvirt object still refers to it pool = self.conn.storagePoolLookupByName("default-pool") if "read-cache.img" not in pool.listVolumes(): pool.createXML("read-cache.img1048576", 0) domain = self.conn.defineXML(DOMAIN) self.compute = Compute.objects.create(name="testdrv", hostname="localhost", login="", password="", type=4) self.vm = Instance.objects.create(compute=self.compute, name=domain.name(), uuid=domain.UUIDString()) # what the test driver lacks: machine types, network filters for target, value in (("get_machine_types", ["pc"]), ("get_nwfilters", [])): patcher = patch(f"vrtManager.connection.wvmConnect.{target}", return_value=value) patcher.start() self.addCleanup(patcher.stop) self.admin = get_user_model().objects.create_superuser("dr-admin", "dr@example.com", "pw") def render(self): xml_reads, cap_reads = [], [] real_xml, real_caps = libvirt.virDomain.XMLDesc, libvirt.virConnect.getCapabilities def xml(dom, flags=0): xml_reads.append(flags) return real_xml(dom, flags) def caps(conn): cap_reads.append(1) return real_caps(conn) self.client.force_login(self.admin) with patch("vrtManager.connection.connection_manager.get_connection", return_value=self.conn), patch.object( libvirt.virDomain, "XMLDesc", xml ), patch.object(libvirt.virConnect, "getCapabilities", caps): response = self.client.get(reverse("instances:instance", args=[self.vm.id])) self.assertEqual(response.status_code, 200) return response, xml_reads, cap_reads def test_each_xml_and_the_capabilities_are_read_once(self): _, xml_reads, cap_reads = self.render() self.assertEqual(sorted(xml_reads), sorted(set(xml_reads)), "an XML read twice") self.assertEqual(len(cap_reads), 1) def test_the_state_host_info_and_disk_volume_are_read_once(self): counted = ( (libvirt.virDomain, "info"), (libvirt.virConnect, "getInfo"), (libvirt.virConnect, "getDomainCapabilities"), (libvirt.virConnect, "storageVolLookupByPath"), (libvirt.virStorageVol, "info"), ) calls = {} def counter(cls, name): real = getattr(cls, name) def call(*args, **kwargs): key = f"{cls.__name__}.{name}" calls[key] = calls.get(key, 0) + 1 return real(*args, **kwargs) return call patches = [patch.object(cls, name, counter(cls, name)) for cls, name in counted] for p in patches: p.start() self.addCleanup(p.stop) response, _, _ = self.render() self.assertContains(response, "read-cache.img") self.assertEqual( calls, { "virDomain.info": 1, "virConnect.getInfo": 1, "virConnect.getDomainCapabilities": 1, "virConnect.storageVolLookupByPath": 1, "virStorageVol.info": 1, }, ) def test_a_change_after_the_page_reads_fresh_xml(self): # outside the page the getters read libvirt each time, as changes need with patch("vrtManager.connection.connection_manager.get_connection", return_value=self.conn): proxy = self.vm.proxy proxy.set_console_passwd("pass1") proxy.set_console_keymap("de") self.assertEqual(proxy.get_console_passwd(), "pass1") self.assertEqual(proxy.get_console_keymap(), "de")