[4.11.3] Explicitly controlling VMware VM hardware version (#17)

* Explicitly controlling VMware VM hardware version

* Add unit tests and add defensive checks

Author: nvazquez

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

@@ -94,7 +94,7 @@ public ClusterDasConfigInfo getDasConfig() throws Exception {
         return null;
     }
 
-    private ClusterConfigInfoEx getClusterConfigInfo() throws Exception {
+    public ClusterConfigInfoEx getClusterConfigInfo() throws Exception {
         ClusterConfigInfoEx configInfo = (ClusterConfigInfoEx)_context.getVimClient().getDynamicProperty(_mor, "configurationEx");
         return configInfo;
     }

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

@@ -21,6 +21,7 @@
 import java.util.Arrays;
 import java.util.List;
 
+import com.vmware.vim25.DatacenterConfigInfo;
 import org.apache.log4j.Logger;
 
 import com.vmware.vim25.CustomFieldStringValue;
@@ -508,4 +509,9 @@ public boolean ensureCustomFieldDef(String fieldName) throws Exception {
         CustomFieldsManagerMO cfmMo = new CustomFieldsManagerMO(_context, _context.getServiceContent().getCustomFieldsManager());
         return cfmMo.ensureCustomFieldDef("Datacenter", fieldName) > 0;
     }
+
+    public DatacenterConfigInfo getDatacenterConfigInfo() throws Exception {
+        DatacenterConfigInfo configInfo = (DatacenterConfigInfo)_context.getVimClient().getDynamicProperty(_mor, "configuration");
+        return configInfo;
+    }
 }

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

@@ -37,6 +37,8 @@
 import javax.xml.transform.dom.DOMSource;
 import javax.xml.transform.stream.StreamResult;
 
+import com.vmware.vim25.ClusterConfigInfoEx;
+import com.vmware.vim25.DatacenterConfigInfo;
 import org.apache.cloudstack.engine.orchestration.service.NetworkOrchestrationService;
 import org.apache.commons.lang.StringUtils;
 import org.apache.log4j.Logger;
@@ -1515,6 +1517,11 @@ public static boolean createBlankVm(VmwareHypervisorHost host, String vmName, St
         videoDeviceSpec.setOperation(VirtualDeviceConfigSpecOperation.ADD);
 
         vmConfig.getDeviceChange().add(videoDeviceSpec);
+
+        ClusterMO clusterMo = new ClusterMO(host.getContext(), host.getHyperHostCluster());
+        DatacenterMO dataCenterMo = new DatacenterMO(host.getContext(), host.getHyperHostDatacenter());
+        setVMHardwareVersion(vmConfig, clusterMo, dataCenterMo);
+
         if (host.createVm(vmConfig)) {
             // Here, when attempting to find the VM, we need to use the name
             // with which we created it. This is the only such place where
@@ -1543,6 +1550,28 @@ public static boolean createBlankVm(VmwareHypervisorHost host, String vmName, St
         return false;
     }
 
+    /**
+     * Set the VM hardware version based on the information retrieved by the cluster and datacenter:
+     * - If the cluster hardware version is set, then it is set to this hardware version on vmConfig
+     * - If the cluster hardware version is not set, check datacenter hardware version. If it is set, then it is set to vmConfig
+     * - In case both cluster and datacenter hardware version are not set, hardware version is not set to vmConfig
+     */
+    protected static void setVMHardwareVersion(VirtualMachineConfigSpec vmConfig, ClusterMO clusterMO, DatacenterMO datacenterMO) throws Exception {
+        ClusterConfigInfoEx clusterConfigInfo = clusterMO != null ? clusterMO.getClusterConfigInfo() : null;
+        String clusterHardwareVersion = clusterConfigInfo != null ? clusterConfigInfo.getDefaultHardwareVersionKey() : null;
+        if (StringUtils.isNotBlank(clusterHardwareVersion)) {
+            s_logger.debug("Cluster hardware version found: " + clusterHardwareVersion + ". Creating VM with this hardware version");
+            vmConfig.setVersion(clusterHardwareVersion);
+        } else {
+            DatacenterConfigInfo datacenterConfigInfo = datacenterMO != null ? datacenterMO.getDatacenterConfigInfo() : null;
+            String datacenterHardwareVersion = datacenterConfigInfo != null ? datacenterConfigInfo.getDefaultHardwareVersionKey() : null;
+            if (StringUtils.isNotBlank(datacenterHardwareVersion)) {
+                s_logger.debug("Datacenter hardware version found: " + datacenterHardwareVersion + ". Creating VM with this hardware version");
+                vmConfig.setVersion(datacenterHardwareVersion);
+            }
+        }
+    }
+
     private static VirtualDeviceConfigSpec getControllerSpec(String diskController, int busNum) {
         VirtualDeviceConfigSpec controllerSpec = new VirtualDeviceConfigSpec();
         VirtualController controller = null;

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

@@ -20,13 +20,18 @@
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertTrue;
+import static org.mockito.Matchers.any;
+import static org.mockito.Mockito.never;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.verifyZeroInteractions;
 import static org.mockito.Mockito.when;
 
 import java.util.HashMap;
 import java.util.Map;
 
+import com.vmware.vim25.ClusterConfigInfoEx;
+import com.vmware.vim25.DatacenterConfigInfo;
+import com.vmware.vim25.VirtualMachineConfigSpec;
 import org.junit.After;
 import org.junit.AfterClass;
 import org.junit.Before;
@@ -62,6 +67,16 @@ public class HypervisorHostHelperTest {
     ServiceContent serviceContent;
     @Mock
     AboutInfo aboutInfo;
+    @Mock
+    private VirtualMachineConfigSpec vmSpec;
+    @Mock
+    private ClusterMO clusterMO;
+    @Mock
+    private DatacenterMO datacenterMO;
+    @Mock
+    private ClusterConfigInfoEx clusterConfigInfo;
+    @Mock
+    private DatacenterConfigInfo datacenterConfigInfo;
 
     String vSwitchName;
     Integer networkRateMbps;
@@ -70,10 +85,12 @@ public class HypervisorHostHelperTest {
     String svlanId = null;
 
     @Before
-    public void setup() {
+    public void setup() throws Exception {
         MockitoAnnotations.initMocks(this);
         when(context.getServiceContent()).thenReturn(serviceContent);
         when(serviceContent.getAbout()).thenReturn(aboutInfo);
+        when(clusterMO.getClusterConfigInfo()).thenReturn(clusterConfigInfo);
+        when(datacenterMO.getDatacenterConfigInfo()).thenReturn(datacenterConfigInfo);
     }
 
     @BeforeClass
@@ -883,4 +900,29 @@ public void testCreateDVPortVlanSpecInvalidInputVlanRange() {
         assertTrue(((VmwareDistributedVirtualSwitchTrunkVlanSpec) spec).getVlanId().get(0).getStart() == 0);
         assertTrue(((VmwareDistributedVirtualSwitchTrunkVlanSpec) spec).getVlanId().get(0).getEnd() == 0);
     }
+
+    @Test
+    public void testSetVMHardwareVersionClusterLevel() throws Exception {
+        when(clusterConfigInfo.getDefaultHardwareVersionKey()).thenReturn("vmx-11");
+        when(datacenterConfigInfo.getDefaultHardwareVersionKey()).thenReturn("vmx-9");
+        HypervisorHostHelper.setVMHardwareVersion(vmSpec, clusterMO, datacenterMO);
+        verify(vmSpec).setVersion("vmx-11");
+        verify(vmSpec, never()).setVersion("vmx-9");
+    }
+
+    @Test
+    public void testSetVMHardwareVersionDatacenterLevel() throws Exception {
+        when(clusterConfigInfo.getDefaultHardwareVersionKey()).thenReturn(null);
+        when(datacenterConfigInfo.getDefaultHardwareVersionKey()).thenReturn("vmx-9");
+        HypervisorHostHelper.setVMHardwareVersion(vmSpec, clusterMO, datacenterMO);
+        verify(vmSpec).setVersion("vmx-9");
+    }
+
+    @Test
+    public void testSetVMHardwareVersionUnset() throws Exception {
+        when(clusterConfigInfo.getDefaultHardwareVersionKey()).thenReturn(null);
+        when(datacenterConfigInfo.getDefaultHardwareVersionKey()).thenReturn(null);
+        HypervisorHostHelper.setVMHardwareVersion(vmSpec, clusterMO, datacenterMO);
+        verify(vmSpec, never()).setVersion(any());
+    }
 }