Prepend VPC name to VPC network tier name (apache#9780)

* Fix `updateTemplatePermission` when the UI is set to a language other than English (apache#9766)

* Fix updateTemplatePermission UI in non-english language

* Improve fix

---------

Co-authored-by: Lucas Martins <[email protected]>

* Prepend vpc name to vpc tier network name based on global setting

* Added UT for createVpcGuestNetwork

* rename connector to delimiter and add configKey.Category.Network

* Move setting the name to a new method

---------

Co-authored-by: Daan Hoogland <[email protected]>
Co-authored-by: Lucas Martins <[email protected]>
Co-authored-by: Lucas Martins <[email protected]>

Author: 4 people

engine/components-api/src/main/java/com/cloud/network/vpc/VpcManager.java

@@ -37,8 +37,26 @@
 import com.cloud.network.addr.PublicIp;
 import com.cloud.offering.NetworkOffering;
 import com.cloud.user.Account;
+import org.apache.cloudstack.framework.config.ConfigKey;
 
 public interface VpcManager {
+    ConfigKey<Boolean> VpcTierNamePrepend = new ConfigKey<>(Boolean.class,
+            "vpc.tier.name.prepend",
+            ConfigKey.CATEGORY_NETWORK,
+            "false",
+            "Whether to prepend the VPC name to the VPC tier network name",
+            true,
+            ConfigKey.Scope.Global,
+            null);
+    ConfigKey<String> VpcTierNamePrependDelimiter = new ConfigKey<>(String.class,
+            "vpc.tier.name.prepend.delimiter",
+            ConfigKey.CATEGORY_NETWORK,
+            " ",
+            "Delimiter string to use between the VPC and the VPC tier name",
+            true,
+            ConfigKey.Scope.Global,
+            null);
+
     /**
      * Returns all the Guest networks that are part of VPC
      *

server/src/main/java/com/cloud/network/NetworkServiceImpl.java

@@ -1476,6 +1476,11 @@ private void isIPv6AddressValid(String routerIPv6) {
         }
     }
 
+    private String getVpcPrependedNetworkName(String networkName, Vpc vpc) {
+        final String delimiter = VpcManager.VpcTierNamePrependDelimiter.value();
+        return vpc.getName() + delimiter + networkName;
+    }
+
     @Override
     @DB
     @ActionEvent(eventType = EventTypes.EVENT_NETWORK_CREATE, eventDescription = "creating network")
@@ -1793,6 +1798,13 @@ public Network createGuestNetwork(CreateNetworkCmd cmd) throws InsufficientCapac
 
         checkNetworkDns(ipv6, ntwkOff, vpcId, ip4Dns1, ip4Dns2, ip6Dns1, ip6Dns2);
 
+        if (vpcId != null && VpcManager.VpcTierNamePrepend.value()) {
+            Vpc vpc = _vpcDao.findById(vpcId);
+            if (vpc != null) {
+                name = getVpcPrependedNetworkName(name, vpc);
+            }
+        }
+
         Network network = commitNetwork(networkOfferingId, gateway, startIP, endIP, netmask, networkDomain, vlanId, bypassVlanOverlapCheck, name, displayText, caller, physicalNetworkId, zone.getId(),
                 domainId, isDomainSpecific, subdomainAccess, vpcId, startIPv6, endIPv6, ip6Gateway, ip6Cidr, displayNetwork, aclId, secondaryVlanId, privateVlanType, ntwkOff, pNtwk, aclType, owner, cidr, createVlan,
                 externalId, routerIPv4, routerIPv6, associatedNetwork, ip4Dns1, ip4Dns2, ip6Dns1, ip6Dns2, interfaceMTUs, networkCidrSize);

server/src/main/java/com/cloud/network/vpc/VpcManagerImpl.java

@@ -71,6 +71,8 @@
 import org.apache.cloudstack.api.command.user.vpc.UpdateVPCCmd;
 import org.apache.cloudstack.context.CallContext;
 import org.apache.cloudstack.engine.orchestration.service.NetworkOrchestrationService;
+import org.apache.cloudstack.framework.config.ConfigKey;
+import org.apache.cloudstack.framework.config.Configurable;
 import org.apache.cloudstack.framework.config.dao.ConfigurationDao;
 import org.apache.cloudstack.managed.context.ManagedContextRunnable;
 import org.apache.cloudstack.network.Ipv4GuestSubnetNetworkMap;
@@ -195,7 +197,7 @@
 
 import static com.cloud.offering.NetworkOffering.RoutingMode.Dynamic;
 
-public class VpcManagerImpl extends ManagerBase implements VpcManager, VpcProvisioningService, VpcService {
+public class VpcManagerImpl extends ManagerBase implements VpcManager, VpcProvisioningService, VpcService, Configurable {
 
     public static final String SERVICE = "service";
     public static final String CAPABILITYTYPE = "capabilitytype";
@@ -3133,6 +3135,19 @@ protected void markStaticRouteForRevoke(final StaticRouteVO route, final Account
         }
     }
 
+    @Override
+    public String getConfigComponentName() {
+        return VpcManager.class.getSimpleName();
+    }
+
+    @Override
+    public ConfigKey<?>[] getConfigKeys() {
+        return new ConfigKey<?>[]{
+                VpcTierNamePrepend,
+                VpcTierNamePrependDelimiter
+        };
+    }
+
     protected class VpcCleanupTask extends ManagedContextRunnable {
         @Override
         protected void runInContext() {

server/src/test/java/com/cloud/network/NetworkServiceImplTest.java

@@ -782,89 +782,38 @@ public void testCreateIpv4RoutedNetwork() {
     }
 
     @Test
-    public void testCreateIpv4RoutedNetworkWithBgpPeersFailure1() {
-        registerCallContext();
-        CreateNetworkCmdByAdmin cmd = Mockito.mock(CreateNetworkCmdByAdmin.class);
-        Mockito.when(cmd.getCidrSize()).thenReturn(24);
-        List<Long> bgpPeerIds = Arrays.asList(11L, 12L);
-        Mockito.when(cmd.getBgpPeerIds()).thenReturn(bgpPeerIds);
-
-        prepareCreateNetworkDnsMocks(cmd, Network.GuestType.Isolated, false, true, true);
-        when(networkOfferingVO.getNetworkMode()).thenReturn(NetworkOffering.NetworkMode.ROUTED);
-        when(networkOfferingVO.getRoutingMode()).thenReturn(NetworkOffering.RoutingMode.Static);
-        when(routedIpv4Manager.isRoutedNetworkVpcEnabled(nullable(Long.class))).thenReturn(true);
-        when(routedIpv4Manager.isVirtualRouterGateway(networkOfferingVO)).thenReturn(true);
-
-        DataCenterVO zone = Mockito.mock(DataCenterVO.class);
-        when(cmd.getZoneId()).thenReturn(zoneId);
-        when(dcDao.findById(zoneId)).thenReturn(zone);
-        when(zone.getId()).thenReturn(zoneId);
-
-        try {
-            service.createGuestNetwork(cmd);
-        } catch (InsufficientCapacityException | ResourceAllocationException e) {
-            Assert.fail(String.format("failure with exception: %s", e.getMessage()));
-        } catch (InvalidParameterValueException ex) {
-            Assert.assertEquals("The BGP peers of VPC tiers will inherit from the VPC, do not add separately.", ex.getMessage());
-        }
-    }
-
-    @Test
-    public void testCreateIpv4RoutedNetworkWithBgpPeersFailure2() {
-        registerCallContext();
-        CreateNetworkCmdByAdmin cmd = Mockito.mock(CreateNetworkCmdByAdmin.class);
-        Mockito.when(cmd.getCidrSize()).thenReturn(24);
-        List<Long> bgpPeerIds = Arrays.asList(11L, 12L);
-        Mockito.when(cmd.getBgpPeerIds()).thenReturn(bgpPeerIds);
-
-        prepareCreateNetworkDnsMocks(cmd, Network.GuestType.Isolated, false, false, true);
-        when(networkOfferingVO.getNetworkMode()).thenReturn(NetworkOffering.NetworkMode.ROUTED);
-        when(networkOfferingVO.getRoutingMode()).thenReturn(NetworkOffering.RoutingMode.Static);
-        when(routedIpv4Manager.isRoutedNetworkVpcEnabled(nullable(Long.class))).thenReturn(true);
-        when(routedIpv4Manager.isVirtualRouterGateway(networkOfferingVO)).thenReturn(true);
+    public void testCreateVpcTier() throws InsufficientCapacityException, ResourceAllocationException, NoSuchFieldException, IllegalAccessException {
+        Integer privateMtu = 1200;
+        Long networkOfferingId = 1L;
+        Long vpcId = 2L;
 
-        DataCenterVO zone = Mockito.mock(DataCenterVO.class);
-        when(cmd.getZoneId()).thenReturn(zoneId);
-        when(dcDao.findById(zoneId)).thenReturn(zone);
-        when(zone.getId()).thenReturn(zoneId);
+        ReflectionTestUtils.setField(createNetworkCmd, "name", "testNetwork");
+        ReflectionTestUtils.setField(createNetworkCmd, "displayText", "Test Network");
+        ReflectionTestUtils.setField(createNetworkCmd, "networkOfferingId", networkOfferingId);
+        ReflectionTestUtils.setField(createNetworkCmd, "zoneId", zoneId);
+        ReflectionTestUtils.setField(createNetworkCmd, "privateMtu", privateMtu);
+        ReflectionTestUtils.setField(createNetworkCmd, "vpcId", vpcId);
 
-        try {
-            service.createGuestNetwork(cmd);
-        } catch (InsufficientCapacityException | ResourceAllocationException e) {
-            Assert.fail(String.format("failure with exception: %s", e.getMessage()));
-        } catch (InvalidParameterValueException ex) {
-            Assert.assertEquals("The network offering does not support Dynamic routing", ex.getMessage());
-        }
-    }
+        dc = Mockito.mock(DataCenterVO.class);
+        Mockito.when(dcDao.findById(zoneId)).thenReturn(dc);
+        Mockito.when(dc.getId()).thenReturn(zoneId);
+        vpc = Mockito.mock(VpcVO.class);
+        Mockito.when(vpc.getName()).thenReturn("Vpc 1");
+        Mockito.when(vpcDao.findById(vpcId)).thenReturn(vpc);
+        networkOfferingVO = Mockito.mock(NetworkOfferingVO.class);
+        Mockito.when(networkOfferingDao.findById(networkOfferingId)).thenReturn(networkOfferingVO);
+        Mockito.when(configMgr.isOfferingForVpc(networkOfferingVO)).thenReturn(true);
 
-    @Test
-    public void testCreateIpv4RoutedNetworkWithBgpPeersFailure3() {
-        registerCallContext();
-        CreateNetworkCmdByAdmin cmd = Mockito.mock(CreateNetworkCmdByAdmin.class);
-        Mockito.when(cmd.getCidrSize()).thenReturn(24);
-        List<Long> bgpPeerIds = Arrays.asList(11L, 12L);
-        Mockito.when(cmd.getBgpPeerIds()).thenReturn(bgpPeerIds);
+        overrideDefaultConfigValue(VpcManager.VpcTierNamePrepend, "_defaultValue", "true");
+        overrideDefaultConfigValue(VpcManager.VpcTierNamePrependDelimiter, "_defaultValue", " -- ");
 
-        prepareCreateNetworkDnsMocks(cmd, Network.GuestType.Isolated, false, false, true);
-        when(networkOfferingVO.getNetworkMode()).thenReturn(NetworkOffering.NetworkMode.ROUTED);
-        when(networkOfferingVO.getRoutingMode()).thenReturn(NetworkOffering.RoutingMode.Static);
-        when(routedIpv4Manager.isRoutedNetworkVpcEnabled(nullable(Long.class))).thenReturn(true);
-        when(routedIpv4Manager.isVirtualRouterGateway(networkOfferingVO)).thenReturn(true);
-        when(routedIpv4Manager.isDynamicRoutedNetwork(networkOfferingVO)).thenReturn(true);
-        doThrow(new InvalidParameterValueException("validation error")).when(routedIpv4Manager).validateBgpPeers(nullable(Account.class), nullable(Long.class), any(List.class));
+        service.createGuestNetwork(createNetworkCmd);
 
-        DataCenterVO zone = Mockito.mock(DataCenterVO.class);
-        when(cmd.getZoneId()).thenReturn(zoneId);
-        when(dcDao.findById(zoneId)).thenReturn(zone);
-        when(zone.getId()).thenReturn(zoneId);
+        overrideDefaultConfigValue(VpcManager.VpcTierNamePrepend, "_defaultValue", "false");
 
-        try {
-            service.createGuestNetwork(cmd);
-        } catch (InsufficientCapacityException | ResourceAllocationException e) {
-            Assert.fail(String.format("failure with exception: %s", e.getMessage()));
-        } catch (InvalidParameterValueException ex) {
-            Assert.assertEquals("validation error", ex.getMessage());
-        }
+        Mockito.verify(vpcMgr, times(1)).createVpcGuestNetwork(networkOfferingId, "Vpc 1 -- testNetwork", "Test Network", null, null,
+                null, null, accountMock, null, phyNet, zoneId, null, null, vpcId, null, accountMock, true,
+                null, null, null, null, null, null, null, new Pair<>(0, privateMtu), null);
     }
 
     @Test