Add shared folder support to Libvirt domain XML documents

4 files changed, 329 insertions, 0 deletions

diff --git a/src/main/java/org/openslx/libvirt/domain/Domain.java b/src/main/java/org/openslx/libvirt/domain/Domain.java
index e399340..f29fcd0 100644
--- a/src/main/java/org/openslx/libvirt/domain/Domain.java
+++ b/src/main/java/org/openslx/libvirt/domain/Domain.java
@@ -20,6 +20,7 @@ import org.openslx.libvirt.domain.device.Disk;
 import org.openslx.libvirt.domain.device.DiskCdrom;
 import org.openslx.libvirt.domain.device.DiskFloppy;
 import org.openslx.libvirt.domain.device.DiskStorage;
+import org.openslx.libvirt.domain.device.FileSystem;
 import org.openslx.libvirt.domain.device.Graphics;
 import org.openslx.libvirt.domain.device.GraphicsSdl;
 import org.openslx.libvirt.domain.device.GraphicsSpice;
@@ -825,6 +826,17 @@ public class Domain extends LibvirtXmlDocument
 	}
 
 	/**
+	 * Returns list of virtual machine file system devices specified in the Libvirt domain XML
+	 * document.
+	 * 
+	 * @return list of virtual machine file system devices.
+	 */
+	public ArrayList<FileSystem> getFileSystemDevices()
+	{
+		return Domain.filterDevices( FileSystem.class, this.getDevices() );
+	}
+
+	/**
 	 * Returns list of virtual machine hostdev devices specified in the Libvirt domain XML document.
 	 * 
 	 * @return list of virtual machine hostdev devices.
@@ -1031,6 +1043,16 @@ public class Domain extends LibvirtXmlDocument
 	}
 
 	/**
+	 * Adds a virtual machine file system device to the Libvirt domain XML document.
+	 *
+	 * @return reference to the added file system device if creation was successful.
+	 */
+	public FileSystem addFileSystemDevice()
+	{
+		return FileSystem.class.cast( this.addDevice( new FileSystem() ) );
+	}
+
+	/**
 	 * Adds a virtual machine disk device to the Libvirt domain XML document.
 	 *
 	 * @return reference to the added disk device if creation was successful.
diff --git a/src/main/java/org/openslx/libvirt/domain/device/Device.java b/src/main/java/org/openslx/libvirt/domain/device/Device.java
index b7403cd..151592a 100644
--- a/src/main/java/org/openslx/libvirt/domain/device/Device.java
+++ b/src/main/java/org/openslx/libvirt/domain/device/Device.java
@@ -77,6 +77,9 @@ public class Device extends LibvirtXmlNode
 		} else if ( device instanceof Disk ) {
 			LibvirtXmlNode xmlNode = Device.createDeviceElement( xmlParentNode, Type.DISK );
 			createdDevice = Disk.createInstance( Disk.class.cast( device ), xmlNode );
+		} else if ( device instanceof FileSystem ) {
+			LibvirtXmlNode xmlNode = Device.createDeviceElement( xmlParentNode, Type.FILESYSTEM );
+			createdDevice = FileSystem.createInstance( FileSystem.class.cast( device ), xmlNode );
 		} else if ( device instanceof Hostdev ) {
 			LibvirtXmlNode xmlNode = Device.createDeviceElement( xmlParentNode, Type.HOSTDEV );
 			createdDevice = Hostdev.createInstance( Hostdev.class.cast( device ), xmlNode );
@@ -131,6 +134,9 @@ public class Device extends LibvirtXmlNode
 			case DISK:
 				device = Disk.newInstance( xmlNode );
 				break;
+			case FILESYSTEM:
+				device = FileSystem.newInstance( xmlNode );
+				break;
 			case HOSTDEV:
 				device = Hostdev.newInstance( xmlNode );
 				break;
@@ -169,6 +175,7 @@ public class Device extends LibvirtXmlNode
 		// @formatter:off
 		CONTROLLER( "controller" ),
 		DISK      ( "disk" ),
+		FILESYSTEM( "filesystem" ),
 		HOSTDEV   ( "hostdev" ),
 		INTERFACE ( "interface" ),
 		GRAPHICS  ( "graphics" ),
diff --git a/src/main/java/org/openslx/libvirt/domain/device/FileSystem.java b/src/main/java/org/openslx/libvirt/domain/device/FileSystem.java
new file mode 100644
index 0000000..9ec8caf
--- /dev/null
+++ b/src/main/java/org/openslx/libvirt/domain/device/FileSystem.java
@@ -0,0 +1,292 @@
+package org.openslx.libvirt.domain.device;
+
+import org.openslx.libvirt.xml.LibvirtXmlNode;
+
+/**
+ * A file system device node in a Libvirt domain XML document.
+ * 
+ * @author Manuel Bentele
+ * @version 1.0
+ */
+public class FileSystem extends Device
+{
+	/**
+	 * Creates an empty file system device.
+	 */
+	public FileSystem()
+	{
+		super();
+	}
+
+	/**
+	 * Creates a file system device representing an existing Libvirt XML file system device element.
+	 * 
+	 * @param xmlNode existing Libvirt XML file system device element.
+	 */
+	public FileSystem( LibvirtXmlNode xmlNode )
+	{
+		super( xmlNode );
+	}
+
+	/**
+	 * Returns access mode of the file system device.
+	 * 
+	 * @return access mode of the file system device.
+	 */
+	public AccessMode getAccessMode()
+	{
+		final String mode = this.getXmlElementAttributeValue( "accessmode" );
+		return AccessMode.fromString( mode );
+	}
+
+	/**
+	 * Sets access mode for the file system device.
+	 * 
+	 * @param mode access mode for the file system device.
+	 */
+	public void setAccessMode( AccessMode mode )
+	{
+		this.setXmlElementAttributeValue( "accessmode", mode.toString() );
+	}
+
+	/**
+	 * Returns type of the file system device.
+	 * 
+	 * @return type of the file system device.
+	 */
+	public Type getType()
+	{
+		final String type = this.getXmlElementAttributeValue( "type" );
+		return Type.fromString( type );
+	}
+
+	/**
+	 * Sets type for the file system device.
+	 * 
+	 * @param type type for the file system device.
+	 */
+	public void setType( Type type )
+	{
+		this.setXmlElementAttributeValue( "type", type.toString() );
+	}
+
+	/**
+	 * Returns source of the file system device.
+	 * 
+	 * @return source of the file system device.
+	 */
+	public String getSource()
+	{
+		final Type type = this.getType();
+		String source = null;
+
+		switch ( type ) {
+		case BIND:
+			source = this.getXmlElementAttributeValue( "source", "dir" );
+			break;
+		case BLOCK:
+			source = this.getXmlElementAttributeValue( "source", "dev" );
+			break;
+		case FILE:
+			source = this.getXmlElementAttributeValue( "source", "file" );
+			break;
+		case MOUNT:
+			source = this.getXmlElementAttributeValue( "source", "dir" );
+			break;
+		case RAM:
+			source = this.getXmlElementAttributeValue( "source", "usage" );
+			break;
+		case TEMPLATE:
+			source = this.getXmlElementAttributeValue( "source", "name" );
+			break;
+		}
+
+		return source;
+	}
+
+	/**
+	 * Sets source for the file system device.
+	 * 
+	 * @param source source for the file system device.
+	 */
+	public void setSource( String source )
+	{
+		Type type = this.getType();
+
+		// remove all attributes from sub-element 'source'
+		this.removeXmlElementAttributes( "source" );
+
+		switch ( type ) {
+		case BIND:
+			this.setXmlElementAttributeValue( "source", "dir", source );
+			break;
+		case BLOCK:
+			this.setXmlElementAttributeValue( "source", "dev", source );
+			break;
+		case FILE:
+			this.setXmlElementAttributeValue( "source", "file", source );
+			break;
+		case MOUNT:
+			this.setXmlElementAttributeValue( "source", "dir", source );
+			break;
+		case RAM:
+			this.setXmlElementAttributeValue( "source", "usage", source );
+			break;
+		case TEMPLATE:
+			this.setXmlElementAttributeValue( "source", "name", source );
+			break;
+		}
+	}
+
+	/**
+	 * Returns target of the file system device.
+	 * 
+	 * @return target of the file system device.
+	 */
+	public String getTarget()
+	{
+		return this.getXmlElementAttributeValue( "target", "dir" );
+	}
+
+	/**
+	 * Sets target for the file system device.
+	 * 
+	 * @param target target for the file system device.
+	 */
+	public void setTarget( String target )
+	{
+		this.setXmlElementAttributeValue( "target", "dir", target );
+	}
+
+	/**
+	 * Creates a non-existent file system device as Libvirt XML device element.
+	 * 
+	 * @param xmlNode Libvirt XML node of the Libvirt XML device that is created.
+	 * @return created file system device instance.
+	 */
+	public static FileSystem createInstance( LibvirtXmlNode xmlNode )
+	{
+		return FileSystem.newInstance( xmlNode );
+	}
+
+	/**
+	 * Creates a file system device representing an existing Libvirt XML file system device element.
+	 * 
+	 * @param xmlNode existing Libvirt XML file system device element.
+	 * @return file system device instance.
+	 */
+	public static FileSystem newInstance( LibvirtXmlNode xmlNode )
+	{
+		return new FileSystem( xmlNode );
+	}
+
+	/**
+	 * Access mode for the file system device.
+	 * 
+	 * @author Manuel Bentele
+	 * @version 1.0
+	 */
+	public enum AccessMode
+	{
+		// @formatter:off
+		PASSTHROUGH( "passthrough" ),
+		MAPPED     ( "mapped" ),
+		SQUASH     ( "squash" );
+		// @formatter:on
+
+		/**
+		 * Name of the file system device access mode.
+		 */
+		private String mode;
+
+		/**
+		 * Creates file system device access mode.
+		 * 
+		 * @param mode valid name of the file system device access mode in a Libvirt domain XML
+		 *           document.
+		 */
+		AccessMode( String mode )
+		{
+			this.mode = mode;
+		}
+
+		@Override
+		public String toString()
+		{
+			return this.mode;
+		}
+
+		/**
+		 * Creates file system device access mode from its name with error check.
+		 * 
+		 * @param mode name of the file system device access mode in a Libvirt domain XML document.
+		 * @return valid file system device access mode.
+		 */
+		public static AccessMode fromString( String mode )
+		{
+			for ( AccessMode a : AccessMode.values() ) {
+				if ( a.mode.equalsIgnoreCase( mode ) ) {
+					return a;
+				}
+			}
+
+			return null;
+		}
+	}
+
+	/**
+	 * Type of file system device.
+	 * 
+	 * @author Manuel Bentele
+	 * @version 1.0
+	 */
+	public enum Type
+	{
+		// @formatter:off
+		MOUNT   ( "mount" ),
+		TEMPLATE( "template" ),
+		FILE    ( "file" ),
+		BLOCK   ( "block" ),
+		RAM     ( "ram" ),
+		BIND    ( "bind" );
+		// @formatter:on
+
+		/**
+		 * Name of the file system device type.
+		 */
+		private String type;
+
+		/**
+		 * Creates file system device type.
+		 * 
+		 * @param type valid name of the file system device type in a Libvirt domain XML document.
+		 */
+		Type( String type )
+		{
+			this.type = type;
+		}
+
+		@Override
+		public String toString()
+		{
+			return this.type;
+		}
+
+		/**
+		 * Creates file system device type from its name with error check.
+		 * 
+		 * @param type name of the file system device type in a Libvirt domain XML document.
+		 * @return valid file system device type.
+		 */
+		public static Type fromString( String type )
+		{
+			for ( Type t : Type.values() ) {
+				if ( t.type.equalsIgnoreCase( type ) ) {
+					return t;
+				}
+			}
+
+			return null;
+		}
+	}
+}
diff --git a/src/test/java/org/openslx/libvirt/domain/DomainTest.java b/src/test/java/org/openslx/libvirt/domain/DomainTest.java
index b4e0187..aa556f9 100644
--- a/src/test/java/org/openslx/libvirt/domain/DomainTest.java
+++ b/src/test/java/org/openslx/libvirt/domain/DomainTest.java
@@ -322,6 +322,14 @@ public class DomainTest
 	}
 
 	@Test
+	@DisplayName( "Get all VM file system devices from libvirt XML file" )
+	public void testGetFileSystemDevices()
+	{
+		Domain vm = this.newDomainInstance( "qemu-kvm_default-ubuntu-20-04-vm.xml" );
+		assertEquals( 0, vm.getFileSystemDevices().size() );
+	}
+
+	@Test
 	@DisplayName( "Get all VM hostdev devices from libvirt XML file" )
 	public void testGetHostdevDevices()
 	{