Refactor disk image representation and add unit tests

5 files changed, 408 insertions, 0 deletions

diff --git a/src/test/java/org/openslx/vm/disk/DiskImageQcow2Test.java b/src/test/java/org/openslx/vm/disk/DiskImageQcow2Test.java
new file mode 100644
index 0000000..530cd60
--- /dev/null
+++ b/src/test/java/org/openslx/vm/disk/DiskImageQcow2Test.java
@@ -0,0 +1,220 @@
+package org.openslx.vm.disk;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNull;
+
+import java.io.IOException;
+
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import org.openslx.vm.disk.DiskImage.ImageFormat;
+
+public class DiskImageQcow2Test
+{
+	@Test
+	@DisplayName( "Test detection of default QCOW2 disk image" )
+	public void testQcow2DiskImage() throws DiskImageException, IOException
+	{
+		final DiskImage image = DiskImage.newInstance( DiskImageTestResources.getDiskFile( "image-default.qcow2" ) );
+		final int imageVersion = DiskImageUtils.versionFromMajor( Short.valueOf( "3" ) );
+
+		assertEquals( ImageFormat.QCOW2.toString(), image.getFormat().toString() );
+		assertEquals( true, image.isStandalone() );
+		assertEquals( false, image.isSnapshot() );
+		assertEquals( false, image.isCompressed() );
+		assertEquals( imageVersion, image.getVersion() );
+		assertNull( image.getDescription() );
+	}
+
+	@Test
+	@DisplayName( "Test detection of compressed, 16384 byte cluster QCOW2 disk image with extended L2 tables" )
+	public void testQcow2DetectionL2Compressed16384DiskImage() throws DiskImageException, IOException
+	{
+		final DiskImage image = DiskImage
+				.newInstance( DiskImageTestResources.getDiskFile( "image_cs-16384_cp-on_l2-on.qcow2" ) );
+		final int imageVersion = DiskImageUtils.versionFromMajor( Short.valueOf( "3" ) );
+
+		assertEquals( ImageFormat.QCOW2.toString(), image.getFormat().toString() );
+		assertEquals( true, image.isStandalone() );
+		assertEquals( false, image.isSnapshot() );
+		assertEquals( true, image.isCompressed() );
+		assertEquals( imageVersion, image.getVersion() );
+		assertNull( image.getDescription() );
+	}
+
+	@Test
+	@DisplayName( "Test detection of compressed, 16384 byte cluster QCOW2 disk image without extended L2 tables" )
+	public void testQcow2DetectionNonL2Compressed16384DiskImage() throws DiskImageException, IOException
+	{
+		final DiskImage image = DiskImage
+				.newInstance( DiskImageTestResources.getDiskFile( "image_cs-16384_cp-on_l2-off.qcow2" ) );
+		final int imageVersion = DiskImageUtils.versionFromMajor( Short.valueOf( "3" ) );
+
+		assertEquals( ImageFormat.QCOW2.toString(), image.getFormat().toString() );
+		assertEquals( true, image.isStandalone() );
+		assertEquals( false, image.isSnapshot() );
+		assertEquals( true, image.isCompressed() );
+		assertEquals( imageVersion, image.getVersion() );
+		assertNull( image.getDescription() );
+	}
+
+	@Test
+	@DisplayName( "Test detection of non-compressed, 16384 byte cluster QCOW2 disk image with extended L2 tables" )
+	public void testQcow2DetectionL2NonCompressed16384DiskImage() throws DiskImageException, IOException
+	{
+		final DiskImage image = DiskImage
+				.newInstance( DiskImageTestResources.getDiskFile( "image_cs-16384_cp-off_l2-on.qcow2" ) );
+		final int imageVersion = DiskImageUtils.versionFromMajor( Short.valueOf( "3" ) );
+
+		assertEquals( ImageFormat.QCOW2.toString(), image.getFormat().toString() );
+		assertEquals( true, image.isStandalone() );
+		assertEquals( false, image.isSnapshot() );
+		assertEquals( false, image.isCompressed() );
+		assertEquals( imageVersion, image.getVersion() );
+		assertNull( image.getDescription() );
+	}
+
+	@Test
+	@DisplayName( "Test detection of non-compressed, 16384 byte cluster QCOW2 disk image without extended L2 tables" )
+	public void testQcow2DetectionNonL2NonCompressed16384DiskImage() throws DiskImageException, IOException
+	{
+		final DiskImage image = DiskImage
+				.newInstance( DiskImageTestResources.getDiskFile( "image_cs-16384_cp-off_l2-off.qcow2" ) );
+		final int imageVersion = DiskImageUtils.versionFromMajor( Short.valueOf( "3" ) );
+
+		assertEquals( ImageFormat.QCOW2.toString(), image.getFormat().toString() );
+		assertEquals( true, image.isStandalone() );
+		assertEquals( false, image.isSnapshot() );
+		assertEquals( false, image.isCompressed() );
+		assertEquals( imageVersion, image.getVersion() );
+		assertNull( image.getDescription() );
+	}
+
+	@Test
+	@DisplayName( "Test detection of compressed, 65536 byte cluster QCOW2 disk image with extended L2 tables" )
+	public void testQcow2DetectionL2Compressed65536DiskImage() throws DiskImageException, IOException
+	{
+		final DiskImage image = DiskImage
+				.newInstance( DiskImageTestResources.getDiskFile( "image_cs-65536_cp-on_l2-on.qcow2" ) );
+		final int imageVersion = DiskImageUtils.versionFromMajor( Short.valueOf( "3" ) );
+
+		assertEquals( ImageFormat.QCOW2.toString(), image.getFormat().toString() );
+		assertEquals( true, image.isStandalone() );
+		assertEquals( false, image.isSnapshot() );
+		assertEquals( true, image.isCompressed() );
+		assertEquals( imageVersion, image.getVersion() );
+		assertNull( image.getDescription() );
+	}
+
+	@Test
+	@DisplayName( "Test detection of compressed, 65536 byte cluster QCOW2 disk image without extended L2 tables" )
+	public void testQcow2DetectionNonL2Compressed65536DiskImage() throws DiskImageException, IOException
+	{
+		final DiskImage image = DiskImage
+				.newInstance( DiskImageTestResources.getDiskFile( "image_cs-65536_cp-on_l2-off.qcow2" ) );
+		final int imageVersion = DiskImageUtils.versionFromMajor( Short.valueOf( "3" ) );
+
+		assertEquals( ImageFormat.QCOW2.toString(), image.getFormat().toString() );
+		assertEquals( true, image.isStandalone() );
+		assertEquals( false, image.isSnapshot() );
+		assertEquals( true, image.isCompressed() );
+		assertEquals( imageVersion, image.getVersion() );
+		assertNull( image.getDescription() );
+	}
+
+	@Test
+	@DisplayName( "Test detection of non-compressed, 65536 byte cluster QCOW2 disk image with extended L2 tables" )
+	public void testQcow2DetectionL2NonCompressed65536DiskImage() throws DiskImageException, IOException
+	{
+		final DiskImage image = DiskImage
+				.newInstance( DiskImageTestResources.getDiskFile( "image_cs-65536_cp-off_l2-on.qcow2" ) );
+		final int imageVersion = DiskImageUtils.versionFromMajor( Short.valueOf( "3" ) );
+
+		assertEquals( ImageFormat.QCOW2.toString(), image.getFormat().toString() );
+		assertEquals( true, image.isStandalone() );
+		assertEquals( false, image.isSnapshot() );
+		assertEquals( false, image.isCompressed() );
+		assertEquals( imageVersion, image.getVersion() );
+		assertNull( image.getDescription() );
+	}
+
+	@Test
+	@DisplayName( "Test detection of non-compressed, 65536 byte cluster QCOW2 disk image without extended L2 tables" )
+	public void testQcow2DetectionNonL2NonCompressed65536DiskImage() throws DiskImageException, IOException
+	{
+		final DiskImage image = DiskImage
+				.newInstance( DiskImageTestResources.getDiskFile( "image_cs-65536_cp-off_l2-off.qcow2" ) );
+		final int imageVersion = DiskImageUtils.versionFromMajor( Short.valueOf( "3" ) );
+
+		assertEquals( ImageFormat.QCOW2.toString(), image.getFormat().toString() );
+		assertEquals( true, image.isStandalone() );
+		assertEquals( false, image.isSnapshot() );
+		assertEquals( false, image.isCompressed() );
+		assertEquals( imageVersion, image.getVersion() );
+		assertNull( image.getDescription() );
+	}
+
+	@Test
+	@DisplayName( "Test detection of compressed, 2097152 byte cluster QCOW2 disk image with extended L2 tables" )
+	public void testQcow2DetectionL2Compressed2097152DiskImage() throws DiskImageException, IOException
+	{
+		final DiskImage image = DiskImage
+				.newInstance( DiskImageTestResources.getDiskFile( "image_cs-2097152_cp-on_l2-on.qcow2" ) );
+		final int imageVersion = DiskImageUtils.versionFromMajor( Short.valueOf( "3" ) );
+
+		assertEquals( ImageFormat.QCOW2.toString(), image.getFormat().toString() );
+		assertEquals( true, image.isStandalone() );
+		assertEquals( false, image.isSnapshot() );
+		assertEquals( true, image.isCompressed() );
+		assertEquals( imageVersion, image.getVersion() );
+		assertNull( image.getDescription() );
+	}
+
+	@Test
+	@DisplayName( "Test detection of compressed, 2097152 byte cluster QCOW2 disk image without extended L2 tables" )
+	public void testQcow2DetectionNonL2Compressed2097152DiskImage() throws DiskImageException, IOException
+	{
+		final DiskImage image = DiskImage
+				.newInstance( DiskImageTestResources.getDiskFile( "image_cs-2097152_cp-on_l2-off.qcow2" ) );
+		final int imageVersion = DiskImageUtils.versionFromMajor( Short.valueOf( "3" ) );
+
+		assertEquals( ImageFormat.QCOW2.toString(), image.getFormat().toString() );
+		assertEquals( true, image.isStandalone() );
+		assertEquals( false, image.isSnapshot() );
+		assertEquals( true, image.isCompressed() );
+		assertEquals( imageVersion, image.getVersion() );
+		assertNull( image.getDescription() );
+	}
+
+	@Test
+	@DisplayName( "Test detection of non-compressed, 2097152 byte cluster QCOW2 disk image with extended L2 tables" )
+	public void testQcow2DetectionL2NonCompressed2097152DiskImage() throws DiskImageException, IOException
+	{
+		final DiskImage image = DiskImage
+				.newInstance( DiskImageTestResources.getDiskFile( "image_cs-2097152_cp-off_l2-on.qcow2" ) );
+		final int imageVersion = DiskImageUtils.versionFromMajor( Short.valueOf( "3" ) );
+
+		assertEquals( ImageFormat.QCOW2.toString(), image.getFormat().toString() );
+		assertEquals( true, image.isStandalone() );
+		assertEquals( false, image.isSnapshot() );
+		assertEquals( false, image.isCompressed() );
+		assertEquals( imageVersion, image.getVersion() );
+		assertNull( image.getDescription() );
+	}
+
+	@Test
+	@DisplayName( "Test detection of non-compressed, 2097152 byte cluster QCOW2 disk image without extended L2 tables" )
+	public void testQcow2DetectionNonL2NonCompressed2097152DiskImage() throws DiskImageException, IOException
+	{
+		final DiskImage image = DiskImage
+				.newInstance( DiskImageTestResources.getDiskFile( "image_cs-2097152_cp-off_l2-off.qcow2" ) );
+		final int imageVersion = DiskImageUtils.versionFromMajor( Short.valueOf( "3" ) );
+
+		assertEquals( ImageFormat.QCOW2.toString(), image.getFormat().toString() );
+		assertEquals( true, image.isStandalone() );
+		assertEquals( false, image.isSnapshot() );
+		assertEquals( false, image.isCompressed() );
+		assertEquals( imageVersion, image.getVersion() );
+		assertNull( image.getDescription() );
+	}
+}
diff --git a/src/test/java/org/openslx/vm/disk/DiskImageTest.java b/src/test/java/org/openslx/vm/disk/DiskImageTest.java
new file mode 100644
index 0000000..2572c58
--- /dev/null
+++ b/src/test/java/org/openslx/vm/disk/DiskImageTest.java
@@ -0,0 +1,19 @@
+package org.openslx.vm.disk;
+
+import java.io.IOException;
+
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+
+public class DiskImageTest
+{
+	@Test
+	@DisplayName( "Test of invalid disk image" )
+	public void testInvalidDiskImage() throws IOException
+	{
+		Assertions.assertThrows( DiskImageException.class, () -> {
+			DiskImage.newInstance( DiskImageTestResources.getDiskFile( "image-default.invalid" ) );
+		} );
+	}
+}
diff --git a/src/test/java/org/openslx/vm/disk/DiskImageTestResources.java b/src/test/java/org/openslx/vm/disk/DiskImageTestResources.java
new file mode 100644
index 0000000..2ec2e05
--- /dev/null
+++ b/src/test/java/org/openslx/vm/disk/DiskImageTestResources.java
@@ -0,0 +1,16 @@
+package org.openslx.vm.disk;
+
+import java.io.File;
+import java.net.URL;
+
+public class DiskImageTestResources
+{
+	private static final String DISK_PREFIX_PATH = File.separator + "disk";
+
+	public static File getDiskFile( String diskFileName )
+	{
+		String diskPath = DiskImageTestResources.DISK_PREFIX_PATH + File.separator + diskFileName;
+		URL disk = DiskImageTestResources.class.getResource( diskPath );
+		return new File( disk.getFile() );
+	}
+}
diff --git a/src/test/java/org/openslx/vm/disk/DiskImageVdiTest.java b/src/test/java/org/openslx/vm/disk/DiskImageVdiTest.java
new file mode 100644
index 0000000..492c6aa
--- /dev/null
+++ b/src/test/java/org/openslx/vm/disk/DiskImageVdiTest.java
@@ -0,0 +1,43 @@
+package org.openslx.vm.disk;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+
+import java.io.IOException;
+
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import org.openslx.vm.disk.DiskImage.ImageFormat;
+
+public class DiskImageVdiTest
+{
+	@Test
+	@DisplayName( "Test detection of default VDI disk image" )
+	public void testVdiDiskImage() throws DiskImageException, IOException
+	{
+		final DiskImage image = DiskImage.newInstance( DiskImageTestResources.getDiskFile( "image-default.vdi" ) );
+		final int imageVersion = DiskImageUtils.versionFromMajorMinor( Short.valueOf( "1" ), Short.valueOf( "1" ) );
+
+		assertEquals( ImageFormat.VDI.toString(), image.getFormat().toString() );
+		assertEquals( true, image.isStandalone() );
+		assertEquals( false, image.isSnapshot() );
+		assertEquals( false, image.isCompressed() );
+		assertEquals( imageVersion, image.getVersion() );
+		assertNotNull( image.getDescription() );
+	}
+	
+	@Test
+	@DisplayName( "Test detection of VDI disk image snapshot" )
+	public void testVdiDiskImageSnapshot() throws DiskImageException, IOException
+	{
+		final DiskImage image = DiskImage.newInstance( DiskImageTestResources.getDiskFile( "image-default_snapshot.vdi" ) );
+		final int imageVersion = DiskImageUtils.versionFromMajorMinor( Short.valueOf( "1" ), Short.valueOf( "1" ) );
+
+		assertEquals( ImageFormat.VDI.toString(), image.getFormat().toString() );
+		assertEquals( true, image.isStandalone() );
+		assertEquals( true, image.isSnapshot() );
+		assertEquals( false, image.isCompressed() );
+		assertEquals( imageVersion, image.getVersion() );
+		assertNotNull( image.getDescription() );
+	}
+}
diff --git a/src/test/java/org/openslx/vm/disk/DiskImageVmdkTest.java b/src/test/java/org/openslx/vm/disk/DiskImageVmdkTest.java
new file mode 100644
index 0000000..00cf561
--- /dev/null
+++ b/src/test/java/org/openslx/vm/disk/DiskImageVmdkTest.java
@@ -0,0 +1,110 @@
+package org.openslx.vm.disk;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNull;
+
+import java.io.IOException;
+
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import org.openslx.vm.disk.DiskImage.ImageFormat;
+
+public class DiskImageVmdkTest
+{
+	@Test
+	@DisplayName( "Test detection of default VMDK disk image" )
+	public void testVmdkDiskImage() throws DiskImageException, IOException
+	{
+		final DiskImage image = DiskImage.newInstance( DiskImageTestResources.getDiskFile( "image-default.vmdk" ) );
+		final int imageVersion = DiskImageUtils.versionFromMajor( Short.valueOf( "1" ) );
+		final int imageHwVersion = DiskImageUtils.versionFromMajor( Short.valueOf( "18" ) );
+
+		assertEquals( ImageFormat.VMDK.toString(), image.getFormat().toString() );
+		assertEquals( true, image.isStandalone() );
+		assertEquals( false, image.isSnapshot() );
+		assertEquals( false, image.isCompressed() );
+		assertEquals( imageVersion, image.getVersion() );
+		assertNull( image.getDescription() );
+
+		// test special features of the VMDK disk image format
+		final DiskImageVmdk vmdkImage = DiskImageVmdk.class.cast( image );
+		assertEquals( imageHwVersion, vmdkImage.getHwVersion() );
+	}
+
+	@Test
+	@DisplayName( "Test detection of VMDK disk image (type 0: single growable virtual disk)" )
+	public void testVmdkDiskImageType0() throws DiskImageException, IOException
+	{
+		final DiskImage image = DiskImage.newInstance( DiskImageTestResources.getDiskFile( "image_t0.vmdk" ) );
+		final int imageVersion = DiskImageUtils.versionFromMajor( Short.valueOf( "1" ) );
+		final int imageHwVersion = DiskImageUtils.versionFromMajor( Short.valueOf( "18" ) );
+
+		assertEquals( ImageFormat.VMDK.toString(), image.getFormat().toString() );
+		assertEquals( true, image.isStandalone() );
+		assertEquals( false, image.isSnapshot() );
+		assertEquals( false, image.isCompressed() );
+		assertEquals( imageVersion, image.getVersion() );
+		assertNull( image.getDescription() );
+
+		// test special features of the VMDK disk image format
+		final DiskImageVmdk vmdkImage = DiskImageVmdk.class.cast( image );
+		assertEquals( imageHwVersion, vmdkImage.getHwVersion() );
+	}
+
+	@Test
+	@DisplayName( "Test detection of VMDK disk image (type 1: growable virtual disk split into multiple files)" )
+	public void testVmdkDiskImageType1() throws DiskImageException, IOException
+	{
+		Assertions.assertThrows( DiskImageException.class, () -> {
+			DiskImage.newInstance( DiskImageTestResources.getDiskFile( "image_t1.vmdk" ) );
+		} );
+	}
+
+	@Test
+	@DisplayName( "Test detection of VMDK disk image (type 2: preallocated virtual disk)" )
+	public void testVmdkDiskImageType2() throws DiskImageException, IOException
+	{
+		Assertions.assertThrows( DiskImageException.class, () -> {
+			DiskImage.newInstance( DiskImageTestResources.getDiskFile( "image_t2.vmdk" ) );
+		} );
+	}
+
+	@Test
+	@DisplayName( "Test detection of VMDK disk image (type 3: preallocated virtual disk split into multiple files)" )
+	public void testVmdkDiskImageType3() throws DiskImageException, IOException
+	{
+		Assertions.assertThrows( DiskImageException.class, () -> {
+			DiskImage.newInstance( DiskImageTestResources.getDiskFile( "image_t3.vmdk" ) );
+		} );
+	}
+
+	@Test
+	@DisplayName( "Test detection of VMDK disk image (type 4: preallocated ESX-type virtual disk)" )
+	public void testVmdkDiskImageType4() throws DiskImageException, IOException
+	{
+		Assertions.assertThrows( DiskImageException.class, () -> {
+			DiskImage.newInstance( DiskImageTestResources.getDiskFile( "image_t4.vmdk" ) );
+		} );
+	}
+
+	@Test
+	@DisplayName( "Test detection of VMDK disk image (type 5: compressed disk optimized for streaming)" )
+	public void testVmdkDiskImageType5() throws DiskImageException, IOException
+	{
+		final DiskImage image = DiskImage.newInstance( DiskImageTestResources.getDiskFile( "image_t5.vmdk" ) );
+		final int imageVersion = DiskImageUtils.versionFromMajor( Short.valueOf( "3" ) );
+		final int imageHwVersion = DiskImageUtils.versionFromMajor( Short.valueOf( "18" ) );
+
+		assertEquals( ImageFormat.VMDK.toString(), image.getFormat().toString() );
+		assertEquals( true, image.isStandalone() );
+		assertEquals( false, image.isSnapshot() );
+		assertEquals( true, image.isCompressed() );
+		assertEquals( imageVersion, image.getVersion() );
+		assertNull( image.getDescription() );
+
+		// test special features of the VMDK disk image format
+		final DiskImageVmdk vmdkImage = DiskImageVmdk.class.cast( image );
+		assertEquals( imageHwVersion, vmdkImage.getHwVersion() );
+	}
+}