Allow multiple nics with configdrive

Author: vishesh92

engine/storage/configdrive/src/main/java/org/apache/cloudstack/storage/configdrive/ConfigDriveBuilder.java

@@ -118,8 +118,8 @@ public static File base64StringToFile(String encodedIsoData, String folder, Stri
      *  This method will build the metadata files required by OpenStack driver. Then, an ISO is going to be generated and returned as a String in base 64.
      *  If vmData is null, we throw a {@link CloudRuntimeException}. Moreover, {@link IOException} are captured and re-thrown as {@link CloudRuntimeException}.
      */
-    public static String buildConfigDrive(NicProfile nic, List<String[]> vmData, String isoFileName, String driveLabel, Map<String, String> customUserdataParams, List<Network.Service> supportedServices) {
-        if (vmData == null && nic == null) {
+    public static String buildConfigDrive(List<NicProfile> nics, List<String[]> vmData, String isoFileName, String driveLabel, Map<String, String> customUserdataParams, Map<Long, List<Network.Service>> supportedServices) {
+        if (vmData == null && nics == null) {
             throw new CloudRuntimeException("No VM metadata and nic profile provided");
         }
 
@@ -132,11 +132,14 @@ public static String buildConfigDrive(NicProfile nic, List<String[]> vmData, Str
             File openStackFolder = new File(tempDirName + ConfigDrive.openStackConfigDriveName);
 
             writeVendorEmptyJsonFile(openStackFolder);
-            writeNetworkData(nic, supportedServices, openStackFolder);
-            if (supportedServices.contains(Network.Service.UserData)) {
-                writeVmMetadata(vmData, tempDirName, openStackFolder, customUserdataParams);
+            writeNetworkData(nics, supportedServices, openStackFolder);
+            for (NicProfile nic: nics) {
+                if (supportedServices.get(nic.getId()).contains(Network.Service.UserData)) {
+                    writeVmMetadata(vmData, tempDirName, openStackFolder, customUserdataParams);
 
-                linkUserData(tempDirName);
+                    linkUserData(tempDirName);
+                    break;
+                }
             }
 
             return generateAndRetrieveIsoAsBase64Iso(isoFileName, driveLabel, tempDirName);
@@ -244,21 +247,24 @@ static JsonObject getExistingNetworkData(File openStackFolder) {
     /**
      * First we generate a JSON object using {@link #getNetworkDataJsonObjectForNic(NicProfile, List)}, then we write it to a file called "network_data.json".
      */
-    static void writeNetworkData(NicProfile nic, List<Network.Service> supportedServices, File openStackFolder) {
-        JsonObject networkData = getNetworkDataJsonObjectForNic(nic, supportedServices);
-        JsonObject existingNetworkData = getExistingNetworkData(openStackFolder);
+    static void writeNetworkData(List<NicProfile> nics, Map<Long, List<Network.Service>> supportedServices, File openStackFolder) {
 
         JsonObject finalNetworkData = new JsonObject();
-        mergeJsonArraysAndUpdateObject(finalNetworkData, existingNetworkData, networkData, "links", "id", "type");
-        mergeJsonArraysAndUpdateObject(finalNetworkData, existingNetworkData, networkData, "networks", "id", "type");
-        mergeJsonArraysAndUpdateObject(finalNetworkData, existingNetworkData, networkData, "services", "address", "type");
+        for (NicProfile nic: nics) {
+            List<Network.Service> supportedService = supportedServices.get(nic.getId());
+            JsonObject networkData = getNetworkDataJsonObjectForNic(nic, supportedService);
+
+            mergeJsonArraysAndUpdateObject(finalNetworkData, networkData, "links", "id", "type");
+            mergeJsonArraysAndUpdateObject(finalNetworkData, networkData, "networks", "id", "type");
+            mergeJsonArraysAndUpdateObject(finalNetworkData, networkData, "services", "address", "type");
+        }
 
-        writeFile(openStackFolder, "network_data.json", existingNetworkData.toString());
+        writeFile(openStackFolder, "network_data.json", finalNetworkData.toString());
     }
 
-    static void mergeJsonArraysAndUpdateObject(JsonObject finalObject, JsonObject obj1, JsonObject obj2, String memberName, String keyPart1, String keyPart2) {
-        JsonArray existingMembers = obj1.has(memberName) ? obj1.get(memberName).getAsJsonArray() : new JsonArray();
-        JsonArray newMembers = obj2.has(memberName) ? obj2.get(memberName).getAsJsonArray() : new JsonArray();
+    static void mergeJsonArraysAndUpdateObject(JsonObject finalObject, JsonObject newObj, String memberName, String keyPart1, String keyPart2) {
+        JsonArray existingMembers = finalObject.has(memberName) ? finalObject.get(memberName).getAsJsonArray() : new JsonArray();
+        JsonArray newMembers = newObj.has(memberName) ? newObj.get(memberName).getAsJsonArray() : new JsonArray();
 
         if (existingMembers.size() > 0 || newMembers.size() > 0) {
             JsonArray finalMembers = new JsonArray();

engine/storage/configdrive/src/test/java/org/apache/cloudstack/storage/configdrive/ConfigDriveBuilderTest.java

@@ -32,6 +32,7 @@
 import java.util.Map;
 
 import com.cloud.network.Network;
+import com.cloud.vm.NicProfile;
 import org.apache.commons.io.FileUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.junit.Assert;
@@ -51,11 +52,11 @@
 @RunWith(MockitoJUnitRunner.class)
 public class ConfigDriveBuilderTest {
 
-    private static List<Network.Service> supportedServices;
+    private static Map<Long, List<Network.Service>> supportedServices;
 
     @BeforeClass
     public static void beforeClass() throws Exception {
-        supportedServices = List.of(Network.Service.UserData, Network.Service.Dhcp, Network.Service.Dns);
+        supportedServices = Map.of(1L, List.of(Network.Service.UserData, Network.Service.Dhcp, Network.Service.Dns));
     }
 
     @Test
@@ -145,10 +146,14 @@ public void buildConfigDriveTest() {
             configDriveBuilderMocked.when(() -> ConfigDriveBuilder.linkUserData((Mockito.anyString()))).then(invocationOnMock -> null);
 
             configDriveBuilderMocked.when(() -> ConfigDriveBuilder.generateAndRetrieveIsoAsBase64Iso(Mockito.anyString(), Mockito.anyString(), Mockito.anyString())).thenAnswer(invocation -> "mockIsoDataBase64");
+
+            NicProfile mockedNicProfile = Mockito.mock(NicProfile.class);
+            Mockito.when(mockedNicProfile.getId()).thenReturn(1L);
+
             //force execution of real method
-            Mockito.when(ConfigDriveBuilder.buildConfigDrive(null, new ArrayList<>(), "teste", "C:", null, supportedServices)).thenCallRealMethod();
+            Mockito.when(ConfigDriveBuilder.buildConfigDrive(List.of(mockedNicProfile), new ArrayList<>(), "teste", "C:", null, supportedServices)).thenCallRealMethod();
 
-            String returnedIsoData = ConfigDriveBuilder.buildConfigDrive(null, new ArrayList<>(), "teste", "C:", null, supportedServices);
+            String returnedIsoData = ConfigDriveBuilder.buildConfigDrive(List.of(mockedNicProfile), new ArrayList<>(), "teste", "C:", null, supportedServices);
 
             Assert.assertEquals("mockIsoDataBase64", returnedIsoData);
 

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

@@ -2174,7 +2174,6 @@ public NicProfile getNicProfile(VirtualMachine vm, long networkId, String broadc
         NetworkVO network = _networksDao.findById(networkId);
         Integer networkRate = getNetworkRate(network.getId(), vm.getId());
 
-//        NetworkGuru guru = _networkGurus.get(network.getGuruName());
         NicProfile profile =
             new NicProfile(nic, network, nic.getBroadcastUri(), nic.getIsolationUri(), networkRate, isSecurityGroupSupportedInNetwork(network), getNetworkTag(
                 vm.getHypervisorType(), network));
@@ -2184,7 +2183,17 @@ public NicProfile getNicProfile(VirtualMachine vm, long networkId, String broadc
         if (network.getTrafficType() == TrafficType.Guest && network.getPrivateMtu() != null) {
             profile.setMtu(network.getPrivateMtu());
         }
-//        guru.updateNicProfile(profile, network);
+
+        DataCenter dc = _dcDao.findById(network.getDataCenterId());
+
+        Pair<String, String> ip4Dns = getNetworkIp4Dns(network, dc);
+        profile.setIPv4Dns1(ip4Dns.first());
+        profile.setIPv4Dns2(ip4Dns.second());
+
+        Pair<String, String> ip6Dns = getNetworkIp6Dns(network, dc);
+        profile.setIPv6Dns1(ip6Dns.first());
+        profile.setIPv6Dns2(ip6Dns.second());
+
         return profile;
     }
 

server/src/main/java/com/cloud/network/element/ConfigDriveNetworkElement.java

@@ -546,7 +546,10 @@ private boolean createConfigDriveIsoOnHostCache(NicProfile nic, VirtualMachinePr
 
         final String isoFileName = ConfigDrive.configIsoFileName(profile.getInstanceName());
         final String isoPath = ConfigDrive.createConfigDrivePath(profile.getInstanceName());
-        final String isoData = ConfigDriveBuilder.buildConfigDrive(nic, profile.getVmData(), isoFileName, profile.getConfigDriveLabel(), customUserdataParamMap, getSupportedServicesByElementForNetwork(nic.getNetworkId()));
+        List<? extends Nic> nics = _networkModel.getNics(nic.getVirtualMachineId());
+        List<NicProfile> nicProfiles = getNicProfilesForNic(profile.getVirtualMachine(), nics);
+        final Map<Long, List<Service>> supportedServices = getSupportedServicesByElementForNetwork(nicProfiles);
+        final String isoData = ConfigDriveBuilder.buildConfigDrive(nicProfiles, profile.getVmData(), isoFileName, profile.getConfigDriveLabel(), customUserdataParamMap, supportedServices);
         final HandleConfigDriveIsoCommand configDriveIsoCommand = new HandleConfigDriveIsoCommand(isoPath, isoData, null, false, true, true);
 
         final HandleConfigDriveIsoAnswer answer = (HandleConfigDriveIsoAnswer) agentManager.easySend(hostId, configDriveIsoCommand);
@@ -596,18 +599,31 @@ private boolean deleteConfigDriveIsoOnHostCache(final VirtualMachine vm, final L
         return true;
     }
 
-    private List<Network.Service> getSupportedServicesByElementForNetwork(Long networkId) {
-
-        List<Network.Service> supportedServices = new ArrayList<>();
-        if (_networkModel.isProviderSupportServiceInNetwork(networkId, Service.Dns, getProvider())) {
-            supportedServices.add(Service.Dns);
-        }
-        if (_networkModel.isProviderSupportServiceInNetwork(networkId, Service.UserData, getProvider())) {
-            supportedServices.add(Service.UserData);
+    private List<NicProfile> getNicProfilesForNic(VirtualMachine vm, List<? extends Nic> nics) {
+        List<NicProfile> nicProfiles = new ArrayList<>();
+        for (Nic nic: nics) {
+            nicProfiles.add(_networkModel.getNicProfile(vm, nic.getNetworkId(), null));
         }
-        if (_networkModel.isProviderSupportServiceInNetwork(networkId, Service.Dhcp, getProvider())) {
-            supportedServices.add(Service.Dhcp);
+        return nicProfiles;
+    }
+
+    private Map<Long, List<Network.Service>> getSupportedServicesByElementForNetwork(List<NicProfile> nics) {
+
+        Map<Long, List<Network.Service>> supportedServices = new HashMap<>();
+        for (NicProfile nic: nics) {
+            ArrayList<Network.Service> serviceList = new ArrayList<>();
+            if (_networkModel.isProviderSupportServiceInNetwork(nic.getNetworkId(), Service.Dns, getProvider())) {
+                serviceList.add(Service.Dns);
+            }
+            if (_networkModel.isProviderSupportServiceInNetwork(nic.getNetworkId(), Service.UserData, getProvider())) {
+                serviceList.add(Service.UserData);
+            }
+            if (_networkModel.isProviderSupportServiceInNetwork(nic.getNetworkId(), Service.Dhcp, getProvider())) {
+                serviceList.add(Service.Dhcp);
+            }
+            supportedServices.put(nic.getId(), serviceList);
         }
+
         return supportedServices;
     }
 
@@ -626,9 +642,11 @@ public boolean createConfigDriveIso(NicProfile nic, VirtualMachineProfile profil
 
         final String isoFileName = ConfigDrive.configIsoFileName(profile.getInstanceName());
         final String isoPath = ConfigDrive.createConfigDrivePath(profile.getInstanceName());
-        List<Service> supportedServices = getSupportedServicesByElementForNetwork(nic.getNetworkId());
+        List<? extends Nic> nics = _networkModel.getNics(profile.getId());
+        List<NicProfile> nicProfiles = getNicProfilesForNic(profile.getVirtualMachine(), nics);
+        final Map<Long, List<Service>> supportedServices = getSupportedServicesByElementForNetwork(nicProfiles);
         final String isoData = ConfigDriveBuilder.buildConfigDrive(
-                nic, profile.getVmData(), isoFileName, profile.getConfigDriveLabel(), customUserdataParamMap, supportedServices);
+                nicProfiles, profile.getVmData(), isoFileName, profile.getConfigDriveLabel(), customUserdataParamMap, supportedServices);
         boolean useHostCacheOnUnsupportedPool = VirtualMachineManager.VmConfigDriveUseHostCacheOnUnsupportedPool.valueIn(dest.getDataCenter().getId());
         boolean preferHostCache = VirtualMachineManager.VmConfigDriveForceHostCacheUse.valueIn(dest.getDataCenter().getId());
         final HandleConfigDriveIsoCommand configDriveIsoCommand = new HandleConfigDriveIsoCommand(isoPath, isoData, dataStore.getTO(), useHostCacheOnUnsupportedPool, preferHostCache, true);

server/src/test/java/com/cloud/network/element/ConfigDriveNetworkElementTest.java

@@ -170,6 +170,8 @@ public void setUp() throws NoSuchFieldException, IllegalAccessException {
         when(_dcDao.findById(DATACENTERID)).thenReturn(dataCenterVO);
         when(_domainDao.findById(DOMAINID)).thenReturn(domainVO);
         doReturn(nic).when(_networkModel).getDefaultNic(VMID);
+        doReturn(List.of(nic)).when(_networkModel).getNics(VMID);
+        doReturn(nicp).when(_networkModel).getNicProfile(virtualMachine, NETWORK_ID, null);
         when(_serviceOfferingDao.findByIdIncludingRemoved(VMID, SOID)).thenReturn(serviceOfferingVO);
         when(_guestOSDao.findById(Mockito.anyLong())).thenReturn(guestOSVO);
         when(_guestOSCategoryDao.findById(Mockito.anyLong())).thenReturn(guestOSCategoryVo);
@@ -292,7 +294,7 @@ public void testAddPasswordAndUserData() throws Exception {
     public void testCreateConfigDriveIso() throws Exception {
         try (MockedStatic<ConfigDriveBuilder> ignored1 = Mockito.mockStatic(ConfigDriveBuilder.class); MockedStatic<CallContext> ignored2 = Mockito.mockStatic(CallContext.class)) {
             Mockito.when(CallContext.current()).thenReturn(callContextMock);
-            Mockito.when(ConfigDriveBuilder.buildConfigDrive(Mockito.any(NicProfile.class), Mockito.anyList(), Mockito.anyString(), Mockito.anyString(), Mockito.anyMap(), Mockito.anyList())).thenReturn("content");
+            Mockito.when(ConfigDriveBuilder.buildConfigDrive(Mockito.anyList(), Mockito.anyList(), Mockito.anyString(), Mockito.anyString(), Mockito.anyMap(), Mockito.anyMap())).thenReturn("content");
 
             final HandleConfigDriveIsoAnswer answer = mock(HandleConfigDriveIsoAnswer.class);
             when(agentManager.easySend(Mockito.anyLong(), Mockito.any(HandleConfigDriveIsoCommand.class))).thenReturn(answer);