From 8416431dd4aaa1451a998c4d44bc78b7b4140be5 Mon Sep 17 00:00:00 2001
From: Manuel Bentele
Date: Tue, 9 Nov 2021 14:48:25 +0100
Subject: Remove specified Libvirt OS Nvram file during QEMU VM upload

---
 .../java/org/openslx/libvirt/domain/Domain.java    |  32 ++++
 .../VirtualizationConfigurationQemu.java           |   3 +
 .../org/openslx/libvirt/domain/DomainTest.java     |  34 +++++
 .../xml/qemu-kvm_default-ubuntu-20-04-vm_uefi.xml  | 166 +++++++++++++++++++++
 4 files changed, 235 insertions(+)
 create mode 100644 src/test/resources/libvirt/xml/qemu-kvm_default-ubuntu-20-04-vm_uefi.xml

diff --git a/src/main/java/org/openslx/libvirt/domain/Domain.java b/src/main/java/org/openslx/libvirt/domain/Domain.java
index cbbf827..e6049fa 100644
--- a/src/main/java/org/openslx/libvirt/domain/Domain.java
+++ b/src/main/java/org/openslx/libvirt/domain/Domain.java
@@ -524,6 +524,26 @@ public class Domain extends LibvirtXmlDocument
 		this.getRootXmlNode().setXmlElementValue( "os/loader", loader );
 	}
 
+	/**
+	 * Returns OS Nvram defined in the Libvirt domain XML document.
+	 * 
+	 * @return OS Nvram of the virtual machine.
+	 */
+	public String getOsNvram()
+	{
+		return this.getRootXmlNode().getXmlElementValue( "os/nvram" );
+	}
+
+	/**
+	 * Set OS Nvram in the Libvirt domain XML document.
+	 * 
+	 * @param nvram OS Nvram for the virtual machine.
+	 */
+	public void setOsNvram( String nvram )
+	{
+		this.getRootXmlNode().setXmlElementValue( "os/nvram", nvram );
+	}
+
 	/**
 	 * Operating system types specifiable for a virtual machine in the Libvirt domain XML document.
 	 * 
@@ -1476,6 +1496,18 @@ public class Domain extends LibvirtXmlDocument
 		}
 	}
 
+	/**
+	 * Removes specified Nvram file in the Libvirt domain XML document.
+	 */
+	public void removeOsNvram()
+	{
+		final Node nvramElement = this.getRootXmlNode().getXmlElement( "os/nvram" );
+
+		if ( nvramElement != null ) {
+			nvramElement.getParentNode().removeChild( nvramElement );
+		}
+	}
+
 	/**
 	 * Removes network source for all interface devices in the Libvirt domain XML document.
 	 */
diff --git a/src/main/java/org/openslx/virtualization/configuration/VirtualizationConfigurationQemu.java b/src/main/java/org/openslx/virtualization/configuration/VirtualizationConfigurationQemu.java
index 60122fd..8c3a95b 100644
--- a/src/main/java/org/openslx/virtualization/configuration/VirtualizationConfigurationQemu.java
+++ b/src/main/java/org/openslx/virtualization/configuration/VirtualizationConfigurationQemu.java
@@ -794,6 +794,9 @@ public class VirtualizationConfigurationQemu extends VirtualizationConfiguration
 	{
 		// removes all referenced storage files of all specified CDROMs, Floppy drives and HDDs
 		this.vmConfig.removeDiskDevicesStorage();
+
+		// remove specified NVRAM file of OS loader (firmware)
+		this.vmConfig.removeOsNvram();
 	}
 
 	@Override
diff --git a/src/test/java/org/openslx/libvirt/domain/DomainTest.java b/src/test/java/org/openslx/libvirt/domain/DomainTest.java
index c56759d..6b53125 100644
--- a/src/test/java/org/openslx/libvirt/domain/DomainTest.java
+++ b/src/test/java/org/openslx/libvirt/domain/DomainTest.java
@@ -237,6 +237,40 @@ public class DomainTest
 		assertEquals( "pc", vm.getOsMachine() );
 	}
 
+	@Test
+	@DisplayName( "Get VM's OS loader from libvirt XML file" )
+	public void testGetOsLoader()
+	{
+		Domain vm = this.newDomainInstance( "qemu-kvm_default-ubuntu-20-04-vm_uefi.xml" );
+		assertEquals( "/usr/share/edk2-ovmf/x64/OVMF_CODE.fd", vm.getOsLoader() );
+	}
+
+	@Test
+	@DisplayName( "Set VM's OS loader in libvirt XML file" )
+	public void testSetOsLoader()
+	{
+		Domain vm = this.newDomainInstance( "qemu-kvm_default-ubuntu-20-04-vm_uefi.xml" );
+		vm.setOsLoader( "/usr/share/qemu/edk2-x86_64-code.fd" );
+		assertEquals( "/usr/share/qemu/edk2-x86_64-code.fd", vm.getOsLoader() );
+	}
+
+	@Test
+	@DisplayName( "Get VM's OS Nvram from libvirt XML file" )
+	public void testGetOsNvram()
+	{
+		Domain vm = this.newDomainInstance( "qemu-kvm_default-ubuntu-20-04-vm_uefi.xml" );
+		assertEquals( "/var/lib/libvirt/nvram/guest_VARS.fd", vm.getOsNvram() );
+	}
+
+	@Test
+	@DisplayName( "Set VM's OS Nvram in libvirt XML file" )
+	public void testSetOsNvram()
+	{
+		Domain vm = this.newDomainInstance( "qemu-kvm_default-ubuntu-20-04-vm_uefi.xml" );
+		vm.setOsNvram( "/tmp/nvram-tmp/tmp_VARS.fd" );
+		assertEquals( "/tmp/nvram-tmp/tmp_VARS.fd", vm.getOsNvram() );
+	}
+
 	@Test
 	@DisplayName( "Get VM CPU model from libvirt XML file" )
 	public void testGetCpuModel()
diff --git a/src/test/resources/libvirt/xml/qemu-kvm_default-ubuntu-20-04-vm_uefi.xml b/src/test/resources/libvirt/xml/qemu-kvm_default-ubuntu-20-04-vm_uefi.xml
new file mode 100644
index 0000000..c4e2788
--- /dev/null
+++ b/src/test/resources/libvirt/xml/qemu-kvm_default-ubuntu-20-04-vm_uefi.xml
@@ -0,0 +1,166 @@
+<domain type='kvm'>
+  <name>ubuntu-20-04</name>
+  <uuid>8dc5433c-0228-49e4-b019-fa2b606aa544</uuid>
+  <title>Ubuntu 20.04</title>
+  <description>Ubuntu 20.04 desktop installation</description>
+  <metadata>
+    <libosinfo:libosinfo xmlns:libosinfo="http://libosinfo.org/xmlns/libvirt/domain/1.0">
+      <libosinfo:os id="http://ubuntu.com/ubuntu/20.04"/>
+    </libosinfo:libosinfo>
+  </metadata>
+  <memory unit='KiB'>4194304</memory>
+  <currentMemory unit='KiB'>4194304</currentMemory>
+  <vcpu placement='static'>2</vcpu>
+  <os>
+    <type arch='x86_64' machine='pc-q35-5.1'>hvm</type>
+    <loader readonly='yes' type='pflash'>/usr/share/edk2-ovmf/x64/OVMF_CODE.fd</loader>
+    <nvram template='/usr/share/edk2-ovmf/OVMF_VARS.fd'>/var/lib/libvirt/nvram/guest_VARS.fd</nvram>
+    <boot dev='hd'/>
+  </os>
+  <features>
+    <acpi/>
+    <apic/>
+    <vmport state='off'/>
+  </features>
+  <cpu mode='host-model' check='partial'/>
+  <clock offset='utc'>
+    <timer name='rtc' tickpolicy='catchup'/>
+    <timer name='pit' tickpolicy='delay'/>
+    <timer name='hpet' present='no'/>
+  </clock>
+  <on_poweroff>destroy</on_poweroff>
+  <on_reboot>restart</on_reboot>
+  <on_crash>destroy</on_crash>
+  <pm>
+    <suspend-to-mem enabled='no'/>
+    <suspend-to-disk enabled='no'/>
+  </pm>
+  <devices>
+    <emulator>/usr/bin/qemu-system-x86_64</emulator>
+    <disk type='block' device='disk'>
+      <driver name='qemu' type='raw' cache='none' io='native'/>
+      <source dev='/dev/data/ubuntu-20-04.img'/>
+      <target dev='vda' bus='virtio'/>
+      <address type='pci' domain='0x0000' bus='0x03' slot='0x00' function='0x0'/>
+    </disk>
+    <disk type='file' device='cdrom'>
+      <driver name='qemu' type='raw'/>
+      <target dev='sda' bus='sata'/>
+      <readonly/>
+      <address type='drive' controller='0' bus='0' target='0' unit='0'/>
+    </disk>
+    <disk type='file' device='floppy'>
+      <driver name='qemu' type='raw'/>
+      <target dev='fda' bus='fdc'/>
+      <address type='drive' controller='0' bus='0' target='0' unit='0'/>
+    </disk>
+    <controller type='usb' index='0' model='ich9-ehci1'>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x1d' function='0x7'/>
+    </controller>
+    <controller type='usb' index='0' model='ich9-uhci1'>
+      <master startport='0'/>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x1d' function='0x0' multifunction='on'/>
+    </controller>
+    <controller type='usb' index='0' model='ich9-uhci2'>
+      <master startport='2'/>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x1d' function='0x1'/>
+    </controller>
+    <controller type='usb' index='0' model='ich9-uhci3'>
+      <master startport='4'/>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x1d' function='0x2'/>
+    </controller>
+    <controller type='sata' index='0'>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x1f' function='0x2'/>
+    </controller>
+    <controller type='pci' index='0' model='pcie-root'/>
+    <controller type='pci' index='1' model='pcie-root-port'>
+      <model name='pcie-root-port'/>
+      <target chassis='1' port='0x10'/>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x02' function='0x0' multifunction='on'/>
+    </controller>
+    <controller type='pci' index='2' model='pcie-root-port'>
+      <model name='pcie-root-port'/>
+      <target chassis='2' port='0x11'/>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x02' function='0x1'/>
+    </controller>
+    <controller type='pci' index='3' model='pcie-root-port'>
+      <model name='pcie-root-port'/>
+      <target chassis='3' port='0x12'/>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x02' function='0x2'/>
+    </controller>
+    <controller type='pci' index='4' model='pcie-root-port'>
+      <model name='pcie-root-port'/>
+      <target chassis='4' port='0x13'/>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x02' function='0x3'/>
+    </controller>
+    <controller type='pci' index='5' model='pcie-root-port'>
+      <model name='pcie-root-port'/>
+      <target chassis='5' port='0x14'/>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x02' function='0x4'/>
+    </controller>
+    <controller type='pci' index='6' model='pcie-root-port'>
+      <model name='pcie-root-port'/>
+      <target chassis='6' port='0x15'/>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x02' function='0x5'/>
+    </controller>
+    <controller type='virtio-serial' index='0'>
+      <address type='pci' domain='0x0000' bus='0x02' slot='0x00' function='0x0'/>
+    </controller>
+    <controller type='scsi' index='0' model='virtio-scsi'>
+      <address type='pci' domain='0x0000' bus='0x06' slot='0x00' function='0x0'/>
+    </controller>
+    <controller type='fdc' index='0'/>
+    <interface type='network'>
+      <mac address='52:54:00:0d:90:0c'/>
+      <source network='default'/>
+      <model type='virtio'/>
+      <address type='pci' domain='0x0000' bus='0x01' slot='0x00' function='0x0'/>
+    </interface>
+    <serial type='pty'>
+      <target type='isa-serial' port='0'>
+        <model name='isa-serial'/>
+      </target>
+    </serial>
+    <console type='pty'>
+      <target type='serial' port='0'/>
+    </console>
+    <channel type='unix'>
+      <target type='virtio' name='org.qemu.guest_agent.0'/>
+      <address type='virtio-serial' controller='0' bus='0' port='1'/>
+    </channel>
+    <channel type='spicevmc'>
+      <target type='virtio' name='com.redhat.spice.0'/>
+      <address type='virtio-serial' controller='0' bus='0' port='2'/>
+    </channel>
+    <input type='tablet' bus='usb'>
+      <address type='usb' bus='0' port='1'/>
+    </input>
+    <input type='mouse' bus='ps2'/>
+    <input type='keyboard' bus='ps2'/>
+    <graphics type='spice' autoport='yes'>
+      <listen type='address'/>
+      <image compression='off'/>
+    </graphics>
+    <sound model='ich9'>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x1b' function='0x0'/>
+    </sound>
+    <video>
+      <model type='qxl' ram='65536' vram='65536' vgamem='16384' heads='1' primary='yes'/>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x01' function='0x0'/>
+    </video>
+    <redirdev bus='usb' type='spicevmc'>
+      <address type='usb' bus='0' port='2'/>
+    </redirdev>
+    <redirdev bus='usb' type='spicevmc'>
+      <address type='usb' bus='0' port='3'/>
+    </redirdev>
+    <memballoon model='virtio'>
+      <address type='pci' domain='0x0000' bus='0x04' slot='0x00' function='0x0'/>
+    </memballoon>
+    <rng model='virtio'>
+      <backend model='random'>/dev/urandom</backend>
+      <address type='pci' domain='0x0000' bus='0x05' slot='0x00' function='0x0'/>
+    </rng>
+  </devices>
+</domain>
+
-- 
cgit v1.2.3-55-g7522