Update the displayText of XenServer ISO when it already exist in the DB

Besides updating the ISO display text, I also created unit test cases for 'createXenServerToolsIsoEntryInDatabase' and 'getActualIsoTemplate' methods.

Author: rafaelweingartner

plugins/hypervisors/xenserver/src/main/java/com/cloud/hypervisor/xenserver/discoverer/XcpServerDiscoverer.java

@@ -121,6 +121,9 @@ public class XcpServerDiscoverer extends DiscovererBase implements Discoverer, L
     @Inject
     private HostPodDao _podDao;
 
+    private static String XENSERVER_ISO_NAME = "xs-tools.iso";
+    private static String XENSERVER_ISO_DISPLAY_TEXT = "XenServer Tools Installer ISO (xen-pv-drv-iso)";
+    
     protected XcpServerDiscoverer() {
     }
 
@@ -486,7 +489,7 @@ public boolean configure(String name, Map<String, Object> params) throws Configu
 
         _agentMgr.registerForHostEvents(this, true, false, true);
 
-        createXsToolsISO();
+        createXenServerToolsIsoEntryInDatabase();
         _resourceMgr.registerResourceStateAdapter(this.getClass().getSimpleName(), this);
         return true;
     }
@@ -528,20 +531,24 @@ public boolean processCommands(long agentId, long seq, Command[] commands) {
         return false;
     }
 
-    private void createXsToolsISO() {
-        String isoName = "xs-tools.iso";
-        VMTemplateVO tmplt = _tmpltDao.findByTemplateName(isoName);
-        Long id;
+    /**
+     * Create the XenServer tools ISO entry in the database.
+     * If there is already an entry with 'isoName' equals to {@value #XENSERVER_ISO_NAME} , we update its 'displayText' to {@value #XENSERVER_ISO_DISPLAY_TEXT}.
+     * Otherwise, we create a new entry.
+     */
+    protected void createXenServerToolsIsoEntryInDatabase() {
+        VMTemplateVO tmplt = _tmpltDao.findByTemplateName(XENSERVER_ISO_NAME);
         if (tmplt == null) {
-            id = _tmpltDao.getNextInSequence(Long.class, "id");
+            long id = _tmpltDao.getNextInSequence(Long.class, "id");
             VMTemplateVO template =
-                    VMTemplateVO.createPreHostIso(id, isoName, isoName, ImageFormat.ISO, true, true, TemplateType.PERHOST, null, null, true, 64, Account.ACCOUNT_ID_SYSTEM,
-                            null, "XenServer Tools Installer ISO (xen-pv-drv-iso)", false, 1, false, HypervisorType.XenServer);
+                    VMTemplateVO.createPreHostIso(id, XENSERVER_ISO_NAME, XENSERVER_ISO_NAME, ImageFormat.ISO, true, true, TemplateType.PERHOST, null, null, true, 64, Account.ACCOUNT_ID_SYSTEM,
+                            null, XENSERVER_ISO_DISPLAY_TEXT, false, 1, false, HypervisorType.XenServer);
             _tmpltDao.persist(template);
         } else {
-            id = tmplt.getId();
+            long id = tmplt.getId();
             tmplt.setTemplateType(TemplateType.PERHOST);
             tmplt.setUrl(null);
+            tmplt.setDisplayText(XENSERVER_ISO_DISPLAY_TEXT);
             _tmpltDao.update(id, tmplt);
         }
     }

plugins/hypervisors/xenserver/src/main/java/com/cloud/hypervisor/xenserver/resource/CitrixResourceBase.java

@@ -204,6 +204,9 @@ public String toString() {
     static final Random Rand = new Random(System.currentTimeMillis());
     private static final Logger s_logger = Logger.getLogger(CitrixResourceBase.class);
     protected static final HashMap<VmPowerState, PowerState> s_powerStatesTable;
+    
+    private static final String XENSERVER_70PLUS_GUEST_TOOLS_NAME = "guest-tools.iso";
+    private static final String XENSERVER_BEFORE_70_GUEST_TOOLS_NAME = "xs-tools.iso";
 
     static {
         s_powerStatesTable = new HashMap<VmPowerState, PowerState>();
@@ -2593,7 +2596,7 @@ public VDI getIsoVDIByURL(final Connection conn, final String vmName, final Stri
         String mountpoint = null;
         if (isoURL.startsWith("xs-tools")) {
             try {
-                final String actualIsoURL = actualIsoTemplate(conn);
+                final String actualIsoURL = getActualIsoTemplate(conn);
                 final Set<VDI> vdis = VDI.getByNameLabel(conn, actualIsoURL);
                 if (vdis.isEmpty()) {
                     throw new CloudRuntimeException("Could not find ISO with URL: " + actualIsoURL);
@@ -2632,20 +2635,27 @@ public VDI getIsoVDIByURL(final Connection conn, final String vmName, final Stri
         }
     }
 
-    private String actualIsoTemplate(final Connection conn) throws BadServerResponse, XenAPIException, XmlRpcException {
-        final Host host = Host.getByUuid(conn, _host.getUuid());
-        final Host.Record record = host.getRecord(conn);
-        final String xenBrand = record.softwareVersion.get("product_brand");
-        final String xenVersion = record.softwareVersion.get("product_version");
-        final String[] items = xenVersion.split("\\.");
+    /**
+     * Retrieve the actual ISO 'name-label' to be used.
+     * We based our decision on XenServer version.
+     * <ul>
+     *  <li> for XenServer 7.0+, we use {@value #XENSERVER_70PLUS_GUEST_TOOLS_NAME};
+     *  <li> for versions before 7.0, we use {@value #XENSERVER_BEFORE_70_GUEST_TOOLS_NAME}.
+     * </ul>
+     * 
+     * For XCP we always use {@value #XENSERVER_BEFORE_70_GUEST_TOOLS_NAME}.
+     */
+    protected String getActualIsoTemplate(Connection conn) throws XenAPIException, XmlRpcException {
+        Host host = Host.getByUuid(conn, _host.getUuid());
+        Host.Record record = host.getRecord(conn);
+        String xenBrand = record.softwareVersion.get("product_brand");
+        String xenVersion = record.softwareVersion.get("product_version");
+        String[] items = xenVersion.split("\\.");
 
-        // guest-tools.iso for XenServer version 7.0+
         if (xenBrand.equals("XenServer") && Integer.parseInt(items[0]) >= 7) {
-            return "guest-tools.iso";
+            return XENSERVER_70PLUS_GUEST_TOOLS_NAME;
         }
-
-        // xs-tools.iso for older XenServer versions
-        return "xs-tools.iso";
+        return XENSERVER_BEFORE_70_GUEST_TOOLS_NAME;
     }
 
     public String getLabel() {
@@ -3900,7 +3910,7 @@ protected VDI mount(final Connection conn, final String vmName, final DiskTO vol
             final String templateName = iso.getName();
             if (templateName.startsWith("xs-tools")) {
                 try {
-                    final String actualTemplateName = actualIsoTemplate(conn);
+                    final String actualTemplateName = getActualIsoTemplate(conn);
                     final Set<VDI> vdis = VDI.getByNameLabel(conn, actualTemplateName);
                     if (vdis.isEmpty()) {
                         throw new CloudRuntimeException("Could not find ISO with URL: " + actualTemplateName);

plugins/hypervisors/xenserver/src/test/java/com/cloud/hypervisor/xenserver/discoverer/XcpServerDiscovererTest.java

@@ -0,0 +1,72 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package com.cloud.hypervisor.xenserver.discoverer;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.InOrder;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+import org.mockito.Mockito;
+import org.mockito.Spy;
+import org.mockito.runners.MockitoJUnitRunner;
+
+import com.cloud.storage.VMTemplateVO;
+import com.cloud.storage.Storage.TemplateType;
+import com.cloud.storage.dao.VMTemplateDao;
+
+@RunWith(MockitoJUnitRunner.class)
+public class XcpServerDiscovererTest {
+    
+    @Spy
+    @InjectMocks
+    private XcpServerDiscoverer xcpServerDiscoverer;
+    
+    @Mock
+    private VMTemplateDao vmTemplateDao;
+    
+    @Test
+    public void createXenServerToolsIsoEntryInDatabaseTestNoEntryFound() {
+        Mockito.when(vmTemplateDao.findByTemplateName("xs-tools.iso")).thenReturn(null);
+        Mockito.when(vmTemplateDao.getNextInSequence(Long.class, "id")).thenReturn(1L);
+        
+        xcpServerDiscoverer.createXenServerToolsIsoEntryInDatabase();
+        
+        InOrder inOrder = Mockito.inOrder(vmTemplateDao);
+        inOrder.verify(vmTemplateDao).findByTemplateName("xs-tools.iso");
+        inOrder.verify(vmTemplateDao).getNextInSequence(Long.class, "id");
+        inOrder.verify(vmTemplateDao).persist(Mockito.any(VMTemplateVO.class));
+    }
+
+    @Test
+    public void createXenServerToolsIsoEntryInDatabaseTestEntryAlreadyExist() {
+        VMTemplateVO vmTemplateVOMock = Mockito.mock(VMTemplateVO.class);
+        Mockito.when(vmTemplateDao.findByTemplateName("xs-tools.iso")).thenReturn(vmTemplateVOMock);
+        Mockito.when(vmTemplateVOMock.getId()).thenReturn(1L);
+        
+        xcpServerDiscoverer.createXenServerToolsIsoEntryInDatabase();
+        
+        InOrder inOrder = Mockito.inOrder(vmTemplateDao, vmTemplateVOMock);
+        inOrder.verify(vmTemplateDao).findByTemplateName("xs-tools.iso");
+        inOrder.verify(vmTemplateDao, Mockito.times(0)).getNextInSequence(Long.class, "id");
+        inOrder.verify(vmTemplateVOMock).setTemplateType(TemplateType.PERHOST);
+        inOrder.verify(vmTemplateVOMock).setUrl(null);
+        inOrder.verify(vmTemplateVOMock).setDisplayText("XenServer Tools Installer ISO (xen-pv-drv-iso)");
+        inOrder.verify(vmTemplateDao).update(1L, vmTemplateVOMock);
+    }
+}

plugins/hypervisors/xenserver/src/test/java/com/cloud/hypervisor/xenserver/resource/CitrixResourceBaseTest.java

@@ -16,24 +16,60 @@
 package com.cloud.hypervisor.xenserver.resource;
 
 import java.io.File;
+import java.util.HashMap;
 import java.util.List;
 
+import org.apache.xmlrpc.XmlRpcException;
 import org.junit.Assert;
+import org.junit.Before;
 import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
 import org.mockito.Mockito;
+import org.mockito.Spy;
 import org.powermock.api.mockito.PowerMockito;
+import org.powermock.core.classloader.annotations.PrepareForTest;
+import org.powermock.modules.junit4.PowerMockRunner;
 
 import com.cloud.utils.script.Script;
+import com.xensource.xenapi.Connection;
+import com.xensource.xenapi.Host;
+import com.xensource.xenapi.Host.Record;
+import com.xensource.xenapi.Types.XenAPIException;
 
+@RunWith(PowerMockRunner.class)
+@PrepareForTest(Host.class)
 public class CitrixResourceBaseTest {
 
+    @Spy
     protected CitrixResourceBase citrixResourceBase = new CitrixResourceBase() {
         @Override
         protected String getPatchFilePath() {
             return null;
         }
     };
 
+    @Mock
+    private Connection connectionMock;
+    @Mock
+    private Host hostMock;
+    @Mock
+    private Record hostRecordMock;
+    
+    private String hostUuidMock = "hostUuidMock";
+    
+    @Before
+    public void beforeTest() throws XenAPIException, XmlRpcException {
+        citrixResourceBase._host.setUuid(hostUuidMock);
+        
+        PowerMockito.mockStatic(Host.class);
+        PowerMockito.when(Host.getByUuid(connectionMock, hostUuidMock)).thenReturn(hostMock);
+        
+        hostRecordMock.softwareVersion = new HashMap<>();
+        Mockito.when(hostMock.getRecord(connectionMock)).thenReturn(hostRecordMock);
+        
+    }
+    
     public void testGetPathFilesExeption() {
         String patch = citrixResourceBase.getPatchFilePath();
 
@@ -92,4 +128,44 @@ public void testGetGuestOsTypeOther() {
         String guestOsType = citrixResourceBase.getGuestOsType(platformEmulator);
         Assert.assertEquals(platformEmulator, guestOsType);
     }
+    
+    @Test
+    public void actualIsoTemplateTestXcpHots() throws XenAPIException, XmlRpcException {
+        hostRecordMock.softwareVersion.put("product_brand", "XCP");
+        hostRecordMock.softwareVersion.put("product_version", "1.0");
+        
+        String returnedIsoTemplateName = citrixResourceBase.getActualIsoTemplate(connectionMock);
+
+        Assert.assertEquals("xs-tools.iso", returnedIsoTemplateName);
+    }
+    
+    @Test
+    public void actualIsoTemplateTestXenServerBefore70() throws XenAPIException, XmlRpcException {
+        hostRecordMock.softwareVersion.put("product_brand", "XenServer");
+        hostRecordMock.softwareVersion.put("product_version", "6.0");
+        
+        String returnedIsoTemplateName = citrixResourceBase.getActualIsoTemplate(connectionMock);
+
+        Assert.assertEquals("xs-tools.iso", returnedIsoTemplateName);
+    }
+    
+    @Test
+    public void actualIsoTemplateTestXenServer70() throws XenAPIException, XmlRpcException {
+        hostRecordMock.softwareVersion.put("product_brand", "XenServer");
+        hostRecordMock.softwareVersion.put("product_version", "7.0");
+        
+        String returnedIsoTemplateName = citrixResourceBase.getActualIsoTemplate(connectionMock);
+
+        Assert.assertEquals("guest-tools.iso", returnedIsoTemplateName);
+    }
+    
+    @Test
+    public void actualIsoTemplateTestXenServer71() throws XenAPIException, XmlRpcException {
+        hostRecordMock.softwareVersion.put("product_brand", "XenServer");
+        hostRecordMock.softwareVersion.put("product_version", "7.1");
+        
+        String returnedIsoTemplateName = citrixResourceBase.getActualIsoTemplate(connectionMock);
+
+        Assert.assertEquals("guest-tools.iso", returnedIsoTemplateName);
+    }
 }