Support IPv6 address in addIpToNic

The admin will manually need to add the address to the Instance, but the
Security Grouping should allow it.

Author: Gabriel Beims Bräscher

api/src/main/java/com/cloud/network/NetworkModel.java

@@ -282,7 +282,7 @@ public interface NetworkModel {
 
     boolean isNetworkInlineMode(Network network);
 
-    boolean isIP6AddressAvailableInNetwork(long networkId);
+    boolean areThereIPv6AddressAvailableInNetwork(long networkId);
 
     boolean isIP6AddressAvailableInVlan(long vlanId);
 

api/src/main/java/com/cloud/network/NetworkService.java

@@ -34,6 +34,7 @@
 import com.cloud.exception.InsufficientCapacityException;
 import com.cloud.exception.ResourceAllocationException;
 import com.cloud.exception.ResourceUnavailableException;
+import com.cloud.network.Network.IpAddresses;
 import com.cloud.network.Network.Service;
 import com.cloud.network.Networks.TrafficType;
 import com.cloud.network.vpc.Vpc;
@@ -155,15 +156,6 @@ PhysicalNetworkTrafficType addTrafficTypeToPhysicalNetwork(Long physicalNetworkI
 
     List<? extends Network> getIsolatedNetworksWithSourceNATOwnedByAccountInZone(long zoneId, Account owner);
 
-    /**
-     * @param networkId
-     * @param entityId
-     * @return
-     * @throws ConcurrentOperationException
-     * @throws ResourceUnavailableException
-     * @throws ResourceAllocationException
-     * @throws InsufficientAddressCapacityException
-     */
     IpAddress associateIPToNetwork(long ipId, long networkId) throws InsufficientAddressCapacityException, ResourceAllocationException, ResourceUnavailableException,
         ConcurrentOperationException;
 
@@ -189,12 +181,16 @@ Network createPrivateNetwork(String networkName, String displayText, long physic
         String netmask, long networkOwnerId, Long vpcId, Boolean sourceNat, Long networkOfferingId) throws ResourceAllocationException, ConcurrentOperationException,
         InsufficientCapacityException;
 
-    /* Requests an IP address for the guest nic */
-    NicSecondaryIp allocateSecondaryGuestIP(long nicId, String ipaddress) throws InsufficientAddressCapacityException;
+    /**
+     * Requests an IP address for the guest NIC
+     */
+    NicSecondaryIp allocateSecondaryGuestIP(long nicId, IpAddresses requestedIpPair) throws InsufficientAddressCapacityException;
 
     boolean releaseSecondaryIpFromNic(long ipAddressId);
 
-    /* lists the nic informaton */
+    /**
+     * lists the NIC information
+     */
     List<? extends Nic> listNics(ListNicsCmd listNicsCmd);
 
     Map<Network.Capability, String> getNetworkOfferingServiceCapabilities(NetworkOffering offering, Service service);

api/src/main/java/org/apache/cloudstack/api/command/user/vm/AddIpToVmNicCmd.java

@@ -38,6 +38,7 @@
 import com.cloud.exception.ResourceAllocationException;
 import com.cloud.exception.ResourceUnavailableException;
 import com.cloud.network.Network;
+import com.cloud.network.Network.IpAddresses;
 import com.cloud.utils.net.NetUtils;
 import com.cloud.vm.Nic;
 import com.cloud.vm.NicSecondaryIp;
@@ -78,20 +79,6 @@ public long getNicId() {
         return nicId;
     }
 
-    private String getIpaddress() {
-        if (ipAddr != null) {
-            return ipAddr;
-        } else {
-            return null;
-        }
-    }
-
-    private NetworkType getNetworkType() {
-        Network ntwk = _entityMgr.findById(Network.class, getNetworkId());
-        DataCenter dc = _entityMgr.findById(DataCenter.class, ntwk.getDataCenterId());
-        return dc.getNetworkType();
-    }
-
     private boolean isZoneSGEnabled() {
         Network ntwk = _entityMgr.findById(Network.class, getNetworkId());
         DataCenter dc = _entityMgr.findById(DataCenter.class, ntwk.getDataCenterId());
@@ -144,7 +131,6 @@ public void execute() throws ResourceUnavailableException, ResourceAllocationExc
         }
     }
 
-
     @Override
     public Long getSyncObjId() {
         return getNetworkId();
@@ -169,17 +155,15 @@ public long getEntityOwnerId() {
 
     @Override
     public void create() throws ResourceAllocationException {
-        String ip;
         NicSecondaryIp result;
-        String secondaryIp = null;
-        if ((ip = getIpaddress()) != null) {
-            if (!NetUtils.isValidIp4(ip)) {
-                throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Invalid ip address " + ip);
-            }
+
+        IpAddresses requestedIpPair = new IpAddresses(ipAddr, null);
+        if (!NetUtils.isIpv4(ipAddr)) {
+            requestedIpPair = new IpAddresses(null, ipAddr);
         }
 
         try {
-            result = _networkService.allocateSecondaryGuestIP(getNicId(), getIpaddress());
+            result = _networkService.allocateSecondaryGuestIP(getNicId(), requestedIpPair);
             if (result != null) {
                 setEntityId(result.getId());
                 setEntityUuid(result.getUuid());

api/src/main/java/org/apache/cloudstack/api/command/user/vm/RemoveIpFromVmNicCmd.java

@@ -147,10 +147,15 @@ public void execute() throws InvalidParameterValueException {
             throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Invalid IP id is passed");
         }
 
+        String secIp = nicSecIp.getIp4Address();
+        if (secIp == null) {
+            secIp = nicSecIp.getIp6Address();
+        }
+
         if (isZoneSGEnabled()) {
             //remove the security group rules for this secondary ip
             boolean success = false;
-            success = _securityGroupService.securityGroupRulesForVmSecIp(nicSecIp.getNicId(), nicSecIp.getIp4Address(), false);
+            success = _securityGroupService.securityGroupRulesForVmSecIp(nicSecIp.getNicId(), secIp, false);
             if (success == false) {
                 throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to set security group rules for the secondary ip");
             }

api/src/test/java/org/apache/cloudstack/api/command/test/AddIpToVmNicTest.java

@@ -61,7 +61,7 @@ public void testCreateSuccess() throws ResourceAllocationException, ResourceUnav
         NicSecondaryIp secIp = Mockito.mock(NicSecondaryIp.class);
 
         Mockito.when(
-            networkService.allocateSecondaryGuestIP(Matchers.anyLong(), Matchers.anyString()))
+            networkService.allocateSecondaryGuestIP(Matchers.anyLong(), Matchers.any()))
             .thenReturn(secIp);
 
         ipTonicCmd._networkService = networkService;
@@ -81,7 +81,7 @@ public void testCreateFailure() throws ResourceAllocationException, ResourceUnav
         AddIpToVmNicCmd ipTonicCmd = Mockito.mock(AddIpToVmNicCmd.class);
 
         Mockito.when(
-            networkService.allocateSecondaryGuestIP(Matchers.anyLong(), Matchers.anyString()))
+            networkService.allocateSecondaryGuestIP(Matchers.anyLong(), Matchers.any()))
             .thenReturn(null);
 
         ipTonicCmd._networkService = networkService;

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

@@ -166,18 +166,18 @@ void transferPortableIP(long ipAddrId, long currentNetworkId, long newNetworkId)
      * @throws ConcurrentOperationException
      * @throws InsufficientAddressCapacityException
      */
-    PublicIp assignDedicateIpAddress(Account owner, Long guestNtwkId, Long vpcId, long dcId, boolean isSourceNat) throws ConcurrentOperationException,
-            InsufficientAddressCapacityException;
+    PublicIp assignDedicateIpAddress(Account owner, Long guestNtwkId, Long vpcId, long dcId, boolean isSourceNat)
+            throws ConcurrentOperationException, InsufficientAddressCapacityException;
 
-    IpAddress allocateIp(Account ipOwner, boolean isSystem, Account caller, long callerId, DataCenter zone, Boolean displayIp) throws ConcurrentOperationException,
-            ResourceAllocationException, InsufficientAddressCapacityException;
+    IpAddress allocateIp(Account ipOwner, boolean isSystem, Account caller, long callerId, DataCenter zone, Boolean displayIp)
+            throws ConcurrentOperationException, ResourceAllocationException, InsufficientAddressCapacityException;
 
-    PublicIp assignPublicIpAddressFromVlans(long dcId, Long podId, Account owner, VlanType type, List<Long> vlanDbIds, Long networkId, String requestedIp,
-            boolean isSystem) throws InsufficientAddressCapacityException;
+    PublicIp assignPublicIpAddressFromVlans(long dcId, Long podId, Account owner, VlanType type, List<Long> vlanDbIds, Long networkId, String requestedIp, boolean isSystem)
+            throws InsufficientAddressCapacityException;
 
     @DB
-    void allocateNicValues(NicProfile nic, DataCenter dc, VirtualMachineProfile vm, Network network, String requestedIpv4,
-            String requestedIpv6) throws InsufficientVirtualNetworkCapacityException, InsufficientAddressCapacityException;
+    void allocateNicValues(NicProfile nic, DataCenter dc, VirtualMachineProfile vm, Network network, String requestedIpv4, String requestedIpv6)
+            throws InsufficientVirtualNetworkCapacityException, InsufficientAddressCapacityException;
 
     int getRuleCountForIp(Long addressId, FirewallRule.Purpose purpose, FirewallRule.State state);
 
@@ -187,6 +187,8 @@ void allocateNicValues(NicProfile nic, DataCenter dc, VirtualMachineProfile vm,
 
     AcquirePodIpCmdResponse allocatePodIp(String zoneId, String podId) throws ConcurrentOperationException, ResourceAllocationException;
 
+    public boolean isIpEqualsGatewayOrNetworkOfferingsEmpty(Network network, String requestedIp);
+
     void releasePodIp(Long id) throws CloudRuntimeException;
 }
 

engine/schema/src/main/java/com/cloud/vm/dao/NicIpAliasDaoImpl.java

@@ -113,6 +113,7 @@ public List<String> getAliasIpAddressesForNic(long nicId) {
         List<String> ips = new ArrayList<String>(results.size());
         for (NicIpAliasVO result : results) {
             ips.add(result.getIp4Address());
+            ips.add(result.getIp6Address());
         }
         return ips;
     }

engine/schema/src/main/java/com/cloud/vm/dao/NicSecondaryIpDao.java

@@ -34,11 +34,7 @@ public interface NicSecondaryIpDao extends GenericDao<NicSecondaryIpVO, Long> {
 
     NicSecondaryIpVO findByIp4AddressAndNetworkId(String ip4Address, long networkId);
 
-    /**
-     * @param networkId
-     * @param instanceId
-     * @return
-     */
+    NicSecondaryIpVO findByIp6AddressAndNetworkId(String ip6Address, long networkId);
 
     List<NicSecondaryIpVO> getSecondaryIpAddressesForVm(long vmId);
 

engine/schema/src/main/java/com/cloud/vm/dao/NicSecondaryIpDaoImpl.java

@@ -19,10 +19,9 @@
 import java.util.ArrayList;
 import java.util.List;
 
-
-import com.cloud.utils.StringUtils;
 import org.springframework.stereotype.Component;
 
+import com.cloud.utils.StringUtils;
 import com.cloud.utils.db.GenericDaoBase;
 import com.cloud.utils.db.GenericSearchBuilder;
 import com.cloud.utils.db.SearchBuilder;
@@ -32,16 +31,18 @@
 
 @Component
 public class NicSecondaryIpDaoImpl extends GenericDaoBase<NicSecondaryIpVO, Long> implements NicSecondaryIpDao {
+
     private final SearchBuilder<NicSecondaryIpVO> AllFieldsSearch;
     private final GenericSearchBuilder<NicSecondaryIpVO, String> IpSearch;
     protected GenericSearchBuilder<NicSecondaryIpVO, Long> CountByNicId;
 
-    protected NicSecondaryIpDaoImpl() {
+    public NicSecondaryIpDaoImpl() {
         super();
         AllFieldsSearch = createSearchBuilder();
         AllFieldsSearch.and("instanceId", AllFieldsSearch.entity().getVmId(), Op.EQ);
         AllFieldsSearch.and("network", AllFieldsSearch.entity().getNetworkId(), Op.EQ);
         AllFieldsSearch.and("address", AllFieldsSearch.entity().getIp4Address(), Op.LIKE);
+        AllFieldsSearch.and("ip6address", AllFieldsSearch.entity().getIp6Address(), Op.LIKE);
         AllFieldsSearch.and("nicId", AllFieldsSearch.entity().getNicId(), Op.EQ);
         AllFieldsSearch.done();
 
@@ -132,6 +133,14 @@ public NicSecondaryIpVO findByIp4AddressAndNetworkId(String ip4Address, long net
         return findOneBy(sc);
     }
 
+    @Override
+    public NicSecondaryIpVO findByIp6AddressAndNetworkId(String ip6Address, long networkId) {
+        SearchCriteria<NicSecondaryIpVO> sc = AllFieldsSearch.create();
+        sc.setParameters("network", networkId);
+        sc.setParameters("ip6address", ip6Address);
+        return findOneBy(sc);
+    }
+
     @Override
     public NicSecondaryIpVO findByIp4AddressAndNicId(String ip4Address, long nicId) {
         SearchCriteria<NicSecondaryIpVO> sc = AllFieldsSearch.create();

server/src/main/java/com/cloud/api/ApiResponseHelper.java

@@ -471,7 +471,7 @@ public ConfigurationResponse createConfigurationResponse(Configuration cfg) {
         cfgResponse.setCategory(cfg.getCategory());
         cfgResponse.setDescription(cfg.getDescription());
         cfgResponse.setName(cfg.getName());
-        if(cfg.isEncrypted()) {
+        if (cfg.isEncrypted()) {
             cfgResponse.setValue(DBEncryptionUtil.encrypt(cfg.getValue()));
         } else {
             cfgResponse.setValue(cfg.getValue());
@@ -3623,13 +3623,24 @@ public NicSecondaryIpResponse createSecondaryIPToNicResponse(NicSecondaryIp resu
         NicVO nic = _entityMgr.findById(NicVO.class, result.getNicId());
         NetworkVO network = _entityMgr.findById(NetworkVO.class, result.getNetworkId());
         response.setId(result.getUuid());
-        response.setIpAddr(result.getIp4Address());
+        setResponseIpAddress(result, response);
         response.setNicId(nic.getUuid());
         response.setNwId(network.getUuid());
         response.setObjectName("nicsecondaryip");
         return response;
     }
 
+    /**
+     * Set the NicSecondaryIpResponse object with the IP address that is not null (IPv4 or IPv6)
+     */
+    public static void setResponseIpAddress(NicSecondaryIp result, NicSecondaryIpResponse response) {
+        if (result.getIp4Address() != null) {
+            response.setIpAddr(result.getIp4Address());
+        } else if (result.getIp6Address() != null) {
+            response.setIpAddr(result.getIp6Address());
+        }
+    }
+
     /**
      * The resulting Response attempts to be in line with what is returned from
      * @see com.cloud.api.query.dao.UserVmJoinDaoImpl#setUserVmResponse(ResponseView, UserVmResponse, UserVmJoinVO)
@@ -3706,7 +3717,7 @@ public NicResponse createNicResponse(Nic result) {
                 for (NicSecondaryIpVO ip : secondaryIps) {
                     NicSecondaryIpResponse ipRes = new NicSecondaryIpResponse();
                     ipRes.setId(ip.getUuid());
-                    ipRes.setIpAddr(ip.getIp4Address());
+                    setResponseIpAddress(ip, ipRes);
                     ipList.add(ipRes);
                 }
                 response.setSecondaryIps(ipList);