[KDDI-4.9.1.0-shapeblue17.1] Fix for volume snapshots hardware version (#43)

* Fix for volume snapshots hardware version

* Refactor number formatting

* Renaming

* Refactor and add unit tests

Author: nvazquez

plugins/hypervisors/vmware/src/com/cloud/storage/resource/VmwareStorageProcessor.java

@@ -1118,11 +1118,12 @@ private Ternary<String, Long, Long> createTemplateFromVolume(VirtualMachineMO vm
                 throw new Exception(msg);
             }
 
-            String hardwareVersion = String.valueOf(vmMo.getVirtualHardwareVersion());
+            String vmxFormattedHardwareVersion = VirtualMachineMO.getVmxFormattedVirtualHardwareVersion(vmMo.getVirtualHardwareVersion());
 
             // 4 MB is the minimum requirement for VM memory in VMware
             Pair<VirtualMachineMO, String[]> cloneResult =
-                    vmMo.cloneFromCurrentSnapshot(workerVmName, 0, 4, volumeDeviceInfo.second(), VmwareHelper.getDiskDeviceDatastore(volumeDeviceInfo.first()), hardwareVersion);
+                    vmMo.cloneFromCurrentSnapshot(workerVmName, 0, 4, volumeDeviceInfo.second(), VmwareHelper.getDiskDeviceDatastore(volumeDeviceInfo.first()), vmxFormattedHardwareVersion);
+
             clonedVm = cloneResult.first();
 
             clonedVm.exportVm(secondaryMountPoint + "/" + installPath, templateUniqueName, false, false);
@@ -1685,11 +1686,11 @@ private Pair<String, String[]> exportVolumeToSecondaryStroage(VirtualMachineMO v
                 throw new Exception(msg);
             }
 
-            String virtualHardwareVersion = String.valueOf(vmMo.getVirtualHardwareVersion());
+            String vmxFormattedHardwareVersion = VirtualMachineMO.getVmxFormattedVirtualHardwareVersion(vmMo.getVirtualHardwareVersion());
 
             // 4 MB is the minimum requirement for VM memory in VMware
             Pair<VirtualMachineMO, String[]> cloneResult =
-                    vmMo.cloneFromCurrentSnapshot(workerVmName, 0, 4, volumeDeviceInfo.second(), VmwareHelper.getDiskDeviceDatastore(volumeDeviceInfo.first()), virtualHardwareVersion);
+                    vmMo.cloneFromCurrentSnapshot(workerVmName, 0, 4, volumeDeviceInfo.second(), VmwareHelper.getDiskDeviceDatastore(volumeDeviceInfo.first()), vmxFormattedHardwareVersion);
             clonedVm = cloneResult.first();
             String disks[] = cloneResult.second();
 

vmware-base/src/com/cloud/hypervisor/vmware/mo/HypervisorHostHelper.java

@@ -1642,7 +1642,7 @@ private static VirtualDeviceConfigSpec getControllerSpec(String diskController,
 
         return controllerSpec;
     }
-    public static VirtualMachineMO createWorkerVM(VmwareHypervisorHost hyperHost, DatastoreMO dsMo, String vmName, String hardwareVersion) throws Exception {
+    public static VirtualMachineMO createWorkerVM(VmwareHypervisorHost hyperHost, DatastoreMO dsMo, String vmName, String vmxFormattedHardwareVersion) throws Exception {
 
         // Allow worker VM to float within cluster so that we will have better chance to
         // create it successfully
@@ -1653,8 +1653,8 @@ public static VirtualMachineMO createWorkerVM(VmwareHypervisorHost hyperHost, Da
         VirtualMachineMO workingVM = null;
         VirtualMachineConfigSpec vmConfig = new VirtualMachineConfigSpec();
         vmConfig.setName(vmName);
-        if  (hardwareVersion != null){
-            vmConfig.setVersion("vmx-" + hardwareVersion);
+        if (StringUtils.isNotBlank(vmxFormattedHardwareVersion)) {
+            vmConfig.setVersion(vmxFormattedHardwareVersion);
         } else {
             ClusterMO clusterMo = new ClusterMO(hyperHost.getContext(), hyperHost.getHyperHostCluster());
             DatacenterMO dataCenterMo = new DatacenterMO(hyperHost.getContext(), hyperHost.getHyperHostDatacenter());

vmware-base/src/com/cloud/hypervisor/vmware/mo/VirtualMachineMO.java

@@ -37,6 +37,15 @@
 import org.apache.commons.collections.CollectionUtils;
 import org.apache.log4j.Logger;
 
+import com.cloud.hypervisor.vmware.mo.SnapshotDescriptor.SnapshotInfo;
+import com.cloud.hypervisor.vmware.util.VmwareContext;
+import com.cloud.hypervisor.vmware.util.VmwareHelper;
+import com.cloud.utils.ActionDelegate;
+import com.cloud.utils.Pair;
+import com.cloud.utils.Ternary;
+import com.cloud.utils.concurrency.NamedThreadFactory;
+import com.cloud.utils.exception.CloudRuntimeException;
+import com.cloud.utils.script.Script;
 import com.google.gson.Gson;
 import com.vmware.vim25.ArrayOfManagedObjectReference;
 import com.vmware.vim25.ChoiceOption;
@@ -105,15 +114,6 @@
 import com.vmware.vim25.VirtualSCSIController;
 import com.vmware.vim25.VirtualSCSISharing;
 
-import com.cloud.hypervisor.vmware.mo.SnapshotDescriptor.SnapshotInfo;
-import com.cloud.hypervisor.vmware.util.VmwareContext;
-import com.cloud.hypervisor.vmware.util.VmwareHelper;
-import com.cloud.utils.ActionDelegate;
-import com.cloud.utils.Pair;
-import com.cloud.utils.Ternary;
-import com.cloud.utils.concurrency.NamedThreadFactory;
-import com.cloud.utils.script.Script;
-
 public class VirtualMachineMO extends BaseMO {
     private static final Logger s_logger = Logger.getLogger(VirtualMachineMO.class);
     private static final ExecutorService MonitorServiceExecutor = Executors.newCachedThreadPool(new NamedThreadFactory("VM-Question-Monitor"));
@@ -3247,6 +3247,18 @@ public int getVirtualHardwareVersion() throws Exception {
         return vhOption.getHwVersion();
     }
 
+    /**
+     * Return a hardware version string in the format expected by Vmware
+     * Format: "vmx-DD" where DD represents the hardware version number
+     * @param virtualHardwareVersion numeric virtual hardware version
+     */
+    public static String getVmxFormattedVirtualHardwareVersion(int virtualHardwareVersion) {
+        if (virtualHardwareVersion < 1) {
+            throw new CloudRuntimeException("Invalid hardware version: " + virtualHardwareVersion);
+        }
+        return String.format("vmx-%02d", virtualHardwareVersion);
+    }
+
     public VirtualHardwareOption getVirtualHardwareOption() throws Exception {
         VirtualMachineConfigOption vmConfigOption = _context.getService().queryConfigOption(getEnvironmentBrowser(), null, null);
         return vmConfigOption.getHardwareOptions();

vmware-base/test/com/cloud/hypervisor/vmware/mo/VirtualMachineMOTest.java

@@ -16,17 +16,16 @@
 // under the License.
 package com.cloud.hypervisor.vmware.mo;
 
+import static org.junit.Assert.fail;
+import static org.mockito.Matchers.any;
+import static org.mockito.Mockito.when;
+
+import java.util.ArrayList;
+import java.util.List;
 
-import com.cloud.hypervisor.vmware.util.VmwareClient;
-import com.cloud.hypervisor.vmware.util.VmwareContext;
-import com.vmware.vim25.ManagedObjectReference;
-import com.vmware.vim25.VirtualDevice;
-import com.vmware.vim25.VirtualLsiLogicController;
-import com.vmware.vim25.VirtualLsiLogicSASController;
-import com.vmware.vim25.VirtualSCSIController;
-import com.vmware.vim25.VirtualSCSISharing;
 import org.junit.After;
 import org.junit.AfterClass;
+import org.junit.Assert;
 import org.junit.Before;
 import org.junit.BeforeClass;
 import org.junit.Test;
@@ -35,12 +34,15 @@
 import org.mockito.MockitoAnnotations;
 import org.mockito.runners.MockitoJUnitRunner;
 
-import java.util.ArrayList;
-import java.util.List;
-
-import static org.junit.Assert.fail;
-import static org.mockito.Matchers.any;
-import static org.mockito.Mockito.when;
+import com.cloud.hypervisor.vmware.util.VmwareClient;
+import com.cloud.hypervisor.vmware.util.VmwareContext;
+import com.cloud.utils.exception.CloudRuntimeException;
+import com.vmware.vim25.ManagedObjectReference;
+import com.vmware.vim25.VirtualDevice;
+import com.vmware.vim25.VirtualLsiLogicController;
+import com.vmware.vim25.VirtualLsiLogicSASController;
+import com.vmware.vim25.VirtualSCSIController;
+import com.vmware.vim25.VirtualSCSISharing;
 
 @RunWith(MockitoJUnitRunner.class)
 public class VirtualMachineMOTest {
@@ -117,4 +119,21 @@ public void TestEnsureLsiLogicDeviceControllers() {
         }
 
     }
-}
+
+    @Test
+    public void testGetVmxFormattedVirtualHardwareVersionOneDigit() {
+        String vmxHwVersion = VirtualMachineMO.getVmxFormattedVirtualHardwareVersion(8);
+        Assert.assertEquals("vmx-08", vmxHwVersion);
+    }
+
+    @Test
+    public void testGetVmxFormattedVirtualHardwareVersionTwoDigits() {
+        String vmxHwVersion = VirtualMachineMO.getVmxFormattedVirtualHardwareVersion(11);
+        Assert.assertEquals("vmx-11", vmxHwVersion);
+    }
+
+    @Test(expected = CloudRuntimeException.class)
+    public void testGetVmxFormattedVirtualHardwareVersionInvalid() {
+        VirtualMachineMO.getVmxFormattedVirtualHardwareVersion(-1);
+    }
+}