From 3e2c18a4bb52f0c588469bedf2cb1b171bff760d Mon Sep 17 00:00:00 2001 From: jeff Date: Fri, 22 Jan 2016 10:04:57 +0000 Subject: [PATCH] Refactor console proxy default network retrieval. It is now broken into separate methods for more readability and flexibility. Each zone type (basic, advanced) has its own method for getting the default network when creating the VM. --- .../consoleproxy/ConsoleProxyManagerImpl.java | 94 ++++++++--- .../consoleproxy/ConsoleProxyManagerTest.java | 159 ++++++++++++++++++ 2 files changed, 233 insertions(+), 20 deletions(-) diff --git a/server/src/com/cloud/consoleproxy/ConsoleProxyManagerImpl.java b/server/src/com/cloud/consoleproxy/ConsoleProxyManagerImpl.java index f3766c339c4..af5f85d8bb0 100644 --- a/server/src/com/cloud/consoleproxy/ConsoleProxyManagerImpl.java +++ b/server/src/com/cloud/consoleproxy/ConsoleProxyManagerImpl.java @@ -41,6 +41,7 @@ import org.apache.cloudstack.storage.datastore.db.PrimaryDataStoreDao; import org.apache.cloudstack.storage.datastore.db.StoragePoolVO; import org.apache.cloudstack.storage.datastore.db.TemplateDataStoreDao; import org.apache.cloudstack.storage.datastore.db.TemplateDataStoreVO; +import org.apache.commons.collections.CollectionUtils; import org.apache.log4j.Logger; import com.cloud.agent.AgentManager; @@ -666,6 +667,78 @@ public class ConsoleProxyManagerImpl extends ManagerBase implements ConsoleProxy return null; } + /** + * Get the default network for the console proxy VM, based on the zone it is in. Delegates to + * either {@link #getDefaultNetworkForZone(DataCenter)} or {@link #getDefaultNetworkForAdvancedSGZone(DataCenter)}, + * depending on the zone network type and whether or not security groups are enabled in the zone. + * @param dc - The zone (DataCenter) of the console proxy VM. + * @return The default network for use with the console proxy VM. + */ + protected NetworkVO getDefaultNetworkForCreation(DataCenter dc) { + if (dc.getNetworkType() == NetworkType.Advanced) { + return getDefaultNetworkForAdvancedZone(dc); + } else { + return getDefaultNetworkForBasicZone(dc); + } + } + + /** + * Get default network for a console proxy VM starting up in an advanced zone. If the zone + * is security group-enabled, the first network found that supports SG services is returned. + * If the zone is not SG-enabled, the Public network is returned. + * @param dc - The zone. + * @return The selected default network. + * @throws CloudRuntimeException - If the zone is not a valid choice or a network couldn't be found. + */ + protected NetworkVO getDefaultNetworkForAdvancedZone(DataCenter dc) { + if (dc.getNetworkType() != NetworkType.Advanced) { + throw new CloudRuntimeException("Zone " + dc + " is not advanced."); + } + + if (dc.isSecurityGroupEnabled()) { + List networks = _networkDao.listByZoneSecurityGroup(dc.getId()); + if (CollectionUtils.isEmpty(networks)) { + throw new CloudRuntimeException("Can not found security enabled network in SG Zone " + dc); + } + + return networks.get(0); + } + else { + TrafficType defaultTrafficType = TrafficType.Public; + List defaultNetworks = _networkDao.listByZoneAndTrafficType(dc.getId(), defaultTrafficType); + + // api should never allow this situation to happen + if (defaultNetworks.size() != 1) { + throw new CloudRuntimeException("Found " + defaultNetworks.size() + " networks of type " + defaultTrafficType + " when expect to find 1"); + } + + return defaultNetworks.get(0); + } + } + + /** + * Get default network for console proxy VM for starting up in a basic zone. Basic zones select + * the Guest network whether or not the zone is SG-enabled. + * @param dc - The zone. + * @return The default network according to the zone's network selection rules. + * @throws CloudRuntimeException - If the zone is not a valid choice or a network couldn't be found. + */ + protected NetworkVO getDefaultNetworkForBasicZone(DataCenter dc) { + if (dc.getNetworkType() != NetworkType.Basic) { + throw new CloudRuntimeException("Zone " + dc + "is not basic."); + } + + TrafficType defaultTrafficType = TrafficType.Guest; + List defaultNetworks = _networkDao.listByZoneAndTrafficType(dc.getId(), defaultTrafficType); + + // api should never allow this situation to happen + if (defaultNetworks.size() != 1) { + throw new CloudRuntimeException("Found " + defaultNetworks.size() + " networks of type " + defaultTrafficType + " when expect to find 1"); + } + + return defaultNetworks.get(0); + } + protected Map createProxyInstance(long dataCenterId, VMTemplateVO template) throws ConcurrentOperationException { long id = _consoleProxyDao.getNextInSequence(Long.class, "id"); @@ -675,26 +748,7 @@ public class ConsoleProxyManagerImpl extends ManagerBase implements ConsoleProxy DataCenterDeployment plan = new DataCenterDeployment(dataCenterId); - NetworkVO defaultNetwork = null; - if (dc.getNetworkType() == NetworkType.Advanced && dc.isSecurityGroupEnabled()) { - List networks = _networkDao.listByZoneSecurityGroup(dataCenterId); - if (networks == null || networks.size() == 0) { - throw new CloudRuntimeException("Can not found security enabled network in SG Zone " + dc); - } - defaultNetwork = networks.get(0); - } else { - TrafficType defaultTrafficType = TrafficType.Public; - if (dc.getNetworkType() == NetworkType.Basic || dc.isSecurityGroupEnabled()) { - defaultTrafficType = TrafficType.Guest; - } - List defaultNetworks = _networkDao.listByZoneAndTrafficType(dataCenterId, defaultTrafficType); - - // api should never allow this situation to happen - if (defaultNetworks.size() != 1) { - throw new CloudRuntimeException("Found " + defaultNetworks.size() + " networks of type " + defaultTrafficType + " when expect to find 1"); - } - defaultNetwork = defaultNetworks.get(0); - } + NetworkVO defaultNetwork = getDefaultNetworkForCreation(dc); List offerings = _networkModel.getSystemAccountNetworkOfferings(NetworkOffering.SystemControlNetwork, NetworkOffering.SystemManagementNetwork); diff --git a/server/test/com/cloud/consoleproxy/ConsoleProxyManagerTest.java b/server/test/com/cloud/consoleproxy/ConsoleProxyManagerTest.java index fd12d23a525..76a3f42766d 100644 --- a/server/test/com/cloud/consoleproxy/ConsoleProxyManagerTest.java +++ b/server/test/com/cloud/consoleproxy/ConsoleProxyManagerTest.java @@ -17,7 +17,17 @@ package com.cloud.consoleproxy; +import static org.mockito.AdditionalMatchers.not; +import static org.mockito.Matchers.any; +import static org.mockito.Matchers.anyLong; +import static org.mockito.Matchers.eq; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +import java.util.Collections; + import org.apache.log4j.Logger; +import org.junit.Assert; import org.junit.Before; import org.junit.Test; import org.mockito.Mock; @@ -25,7 +35,15 @@ import org.mockito.Mockito; import org.mockito.MockitoAnnotations; import org.springframework.test.util.ReflectionTestUtils; +import com.cloud.dc.DataCenterVO; +import com.cloud.dc.DataCenter; +import com.cloud.dc.DataCenter.NetworkType; +import com.cloud.dc.dao.DataCenterDao; +import com.cloud.network.Networks.TrafficType; +import com.cloud.network.dao.NetworkDao; +import com.cloud.network.dao.NetworkVO; import com.cloud.utils.db.GlobalLock; +import com.cloud.utils.exception.CloudRuntimeException; import com.cloud.vm.ConsoleProxyVO; public class ConsoleProxyManagerTest { @@ -37,13 +55,22 @@ public class ConsoleProxyManagerTest { @Mock ConsoleProxyVO proxyVO; @Mock + DataCenterDao _dcDao; + @Mock + NetworkDao _networkDao; + @Mock ConsoleProxyManagerImpl cpvmManager; @Before public void setup() throws Exception { MockitoAnnotations.initMocks(this); ReflectionTestUtils.setField(cpvmManager, "_allocProxyLock", globalLock); + ReflectionTestUtils.setField(cpvmManager, "_dcDao", _dcDao); + ReflectionTestUtils.setField(cpvmManager, "_networkDao", _networkDao); Mockito.doCallRealMethod().when(cpvmManager).expandPool(Mockito.anyLong(), Mockito.anyObject()); + Mockito.doCallRealMethod().when(cpvmManager).getDefaultNetworkForCreation(Mockito.any(DataCenter.class)); + Mockito.doCallRealMethod().when(cpvmManager).getDefaultNetworkForAdvancedZone(Mockito.any(DataCenter.class)); + Mockito.doCallRealMethod().when(cpvmManager).getDefaultNetworkForBasicZone(Mockito.any(DataCenter.class)); } @Test @@ -87,4 +114,136 @@ public class ConsoleProxyManagerTest { cpvmManager.expandPool(new Long(1), new Object()); } + + @Test + public void getDefaultNetworkForAdvancedNonSG() { + DataCenterVO dc = mock(DataCenterVO.class); + when(dc.getNetworkType()).thenReturn(NetworkType.Advanced); + when(dc.isSecurityGroupEnabled()).thenReturn(false); + + when(_dcDao.findById(Mockito.anyLong())).thenReturn(dc); + + NetworkVO network = Mockito.mock(NetworkVO.class); + NetworkVO badNetwork = Mockito.mock(NetworkVO.class); + when(_networkDao.listByZoneAndTrafficType(anyLong(), eq(TrafficType.Public))) + .thenReturn(Collections.singletonList(network)); + + when(_networkDao.listByZoneAndTrafficType(anyLong(), not(eq(TrafficType.Public)))) + .thenReturn(Collections.singletonList(badNetwork)); + + when(_networkDao.listByZoneSecurityGroup(anyLong())) + .thenReturn(Collections.singletonList(badNetwork)); + + NetworkVO returnedNetwork = cpvmManager.getDefaultNetworkForAdvancedZone(dc); + + Assert.assertNotNull(returnedNetwork); + Assert.assertEquals(network, returnedNetwork); + Assert.assertNotEquals(badNetwork, returnedNetwork); + } + + @Test + public void getDefaultNetworkForAdvancedSG() { + DataCenterVO dc = Mockito.mock(DataCenterVO.class); + when(dc.getNetworkType()).thenReturn(NetworkType.Advanced); + when(dc.isSecurityGroupEnabled()).thenReturn(true); + + when(_dcDao.findById(Mockito.anyLong())).thenReturn(dc); + + NetworkVO network = Mockito.mock(NetworkVO.class); + NetworkVO badNetwork = Mockito.mock(NetworkVO.class); + when(_networkDao.listByZoneAndTrafficType(anyLong(), any(TrafficType.class))) + .thenReturn(Collections.singletonList(badNetwork)); + + when(_networkDao.listByZoneSecurityGroup(anyLong())) + .thenReturn(Collections.singletonList(network)); + + NetworkVO returnedNetwork = cpvmManager.getDefaultNetworkForAdvancedZone(dc); + + Assert.assertEquals(network, returnedNetwork); + Assert.assertNotEquals(badNetwork, returnedNetwork); + } + + @Test + public void getDefaultNetworkForBasicNonSG() { + DataCenterVO dc = Mockito.mock(DataCenterVO.class); + when(dc.getNetworkType()).thenReturn(NetworkType.Basic); + when(dc.isSecurityGroupEnabled()).thenReturn(false); + + when(_dcDao.findById(Mockito.anyLong())).thenReturn(dc); + + NetworkVO network = Mockito.mock(NetworkVO.class); + NetworkVO badNetwork = Mockito.mock(NetworkVO.class); + when(_networkDao.listByZoneAndTrafficType(anyLong(), eq(TrafficType.Guest))) + .thenReturn(Collections.singletonList(network)); + + when(_networkDao.listByZoneAndTrafficType(anyLong(), not(eq(TrafficType.Guest)))) + .thenReturn(Collections.singletonList(badNetwork)); + + NetworkVO returnedNetwork = cpvmManager.getDefaultNetworkForBasicZone(dc); + Assert.assertNotNull(returnedNetwork); + Assert.assertEquals(network, returnedNetwork); + Assert.assertNotEquals(badNetwork, returnedNetwork); + } + + @Test + public void getDefaultNetworkForBasicSG() { + DataCenterVO dc = Mockito.mock(DataCenterVO.class); + when(dc.getNetworkType()).thenReturn(NetworkType.Basic); + when(dc.isSecurityGroupEnabled()).thenReturn(true); + + when(_dcDao.findById(Mockito.anyLong())).thenReturn(dc); + + NetworkVO network = Mockito.mock(NetworkVO.class); + NetworkVO badNetwork = Mockito.mock(NetworkVO.class); + when(_networkDao.listByZoneAndTrafficType(anyLong(), eq(TrafficType.Guest))) + .thenReturn(Collections.singletonList(network)); + + when(_networkDao.listByZoneAndTrafficType(anyLong(), not(eq(TrafficType.Guest)))) + .thenReturn(Collections.singletonList(badNetwork)); + + NetworkVO returnedNetwork = cpvmManager.getDefaultNetworkForBasicZone(dc); + + Assert.assertNotNull(returnedNetwork); + Assert.assertEquals(network, returnedNetwork); + Assert.assertNotEquals(badNetwork, returnedNetwork); + } + + //also test invalid input + @Test(expected=CloudRuntimeException.class) + public void getDefaultNetworkForBasicSGWrongZoneType() { + DataCenterVO dc = Mockito.mock(DataCenterVO.class); + when(dc.getNetworkType()).thenReturn(NetworkType.Advanced); + when(dc.isSecurityGroupEnabled()).thenReturn(true); + + when(_dcDao.findById(Mockito.anyLong())).thenReturn(dc); + + NetworkVO network = Mockito.mock(NetworkVO.class); + NetworkVO badNetwork = Mockito.mock(NetworkVO.class); + when(_networkDao.listByZoneAndTrafficType(anyLong(), eq(TrafficType.Guest))) + .thenReturn(Collections.singletonList(network)); + + when(_networkDao.listByZoneAndTrafficType(anyLong(), not(eq(TrafficType.Guest)))) + .thenReturn(Collections.singletonList(badNetwork)); + + cpvmManager.getDefaultNetworkForBasicZone(dc); + } + + @Test(expected=CloudRuntimeException.class) + public void getDefaultNetworkForAdvancedWrongZoneType() { + DataCenterVO dc = Mockito.mock(DataCenterVO.class); + when(dc.getNetworkType()).thenReturn(NetworkType.Basic); + when(dc.isSecurityGroupEnabled()).thenReturn(true); + + when(_dcDao.findById(Mockito.anyLong())).thenReturn(dc); + + NetworkVO network = Mockito.mock(NetworkVO.class); + NetworkVO badNetwork = Mockito.mock(NetworkVO.class); + when(_networkDao.listByZoneAndTrafficType(anyLong(), any(TrafficType.class))) + .thenReturn(Collections.singletonList(badNetwork)); + + when(_networkDao.listByZoneSecurityGroup(anyLong())) + .thenReturn(Collections.singletonList(network)); + + cpvmManager.getDefaultNetworkForAdvancedZone(dc); + } }