core/src/test/java/com/cloud/resource/ServerResourceBaseTest.java

// 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.resource;

import com.cloud.utils.net.NetUtils;
import org.apache.cloudstack.storage.command.browser.ListDataStoreObjectsAnswer;
import org.apache.commons.collections.CollectionUtils;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.ArgumentCaptor;
import org.mockito.Captor;
import org.mockito.MockedStatic;
import org.mockito.Mockito;
import org.mockito.junit.MockitoJUnitRunner;

import javax.naming.ConfigurationException;
import java.io.File;
import java.io.IOException;
import java.net.NetworkInterface;
import java.net.SocketException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.List;
import java.util.Map;


@RunWith(MockitoJUnitRunner.class)
public class ServerResourceBaseTest {

    private static final String[] NIC_NAME_STARTS_TO_AVOID = {"vnif", "vnbr", "peth", "vif", "virbr"};

    ServerResourceBase serverResourceBaseSpy = Mockito.spy(ServerResourceBase.class);

    NetworkInterface networkInterfaceMock1, networkInterfaceMock2, networkInterfaceMock3, networkInterfaceMock4;

    @Captor
    ArgumentCaptor<String> keyCaptor;

    @Before
    public void setup() {
        networkInterfaceMock1 = Mockito.mock(NetworkInterface.class);
        networkInterfaceMock2 = Mockito.mock(NetworkInterface.class);
        networkInterfaceMock3 = Mockito.mock(NetworkInterface.class);
        networkInterfaceMock4 = Mockito.mock(NetworkInterface.class);
    }

    @Test
    public void isValidNicToUseAsPrivateNicTestReturnFalseWhenNicIsVirtual() {
        NetworkInterface networkInterfaceMock = Mockito.mock(NetworkInterface.class);
        Mockito.when(networkInterfaceMock.isVirtual()).thenReturn(true);

        Assert.assertFalse(serverResourceBaseSpy.isValidNicToUseAsPrivateNic(networkInterfaceMock));
    }

    @Test
    public void isValidNicToUseAsPrivateNicTestReturnFalseWhenNicNameStartsWithOneOfTheAvoidList() {
        NetworkInterface networkInterfaceMock = Mockito.mock(NetworkInterface.class);
        Mockito.when(networkInterfaceMock.isVirtual()).thenReturn(false);
        Mockito.when(networkInterfaceMock.getName()).thenReturn("vniftest", "vnbrtest", "pethtest", "viftest", "virbrtest");

        Arrays.asList(NIC_NAME_STARTS_TO_AVOID).forEach(type -> Assert.assertFalse(serverResourceBaseSpy.isValidNicToUseAsPrivateNic(networkInterfaceMock)));
    }

    @Test
    public void isValidNicToUseAsPrivateNicTestReturnFalseWhenNicNameContainsColon() {
        NetworkInterface networkInterfaceMock = Mockito.mock(NetworkInterface.class);
        Mockito.when(networkInterfaceMock.isVirtual()).thenReturn(false);
        Mockito.when(networkInterfaceMock.getName()).thenReturn("te:st");

        Assert.assertFalse(serverResourceBaseSpy.isValidNicToUseAsPrivateNic(networkInterfaceMock));
    }

    @Test
    public void isValidNicToUseAsPrivateNicTestReturnFalseWhenNetUtilsGetNicParamsReturnsNull() {
        NetworkInterface networkInterfaceMock = Mockito.mock(NetworkInterface.class);
        Mockito.when(networkInterfaceMock.isVirtual()).thenReturn(false);
        Mockito.when(networkInterfaceMock.getName()).thenReturn("testvnif", "testvnbr", "testpeth", "testvif", "testvirbr");

        try (MockedStatic<NetUtils> ignored = Mockito.mockStatic(NetUtils.class)) {
            Mockito.when(NetUtils.getNicParams(Mockito.anyString())).thenReturn(null);

            Arrays.asList(NIC_NAME_STARTS_TO_AVOID).forEach(type -> {
                Assert.assertFalse(serverResourceBaseSpy.isValidNicToUseAsPrivateNic(networkInterfaceMock));
            });
        }
    }

    @Test
    public void isValidNicToUseAsPrivateNicTestReturnFalseWhenNetUtilsGetNicParamsReturnsFirstElementNull() {
        NetworkInterface networkInterfaceMock = Mockito.mock(NetworkInterface.class);
        Mockito.when(networkInterfaceMock.isVirtual()).thenReturn(false);
        Mockito.when(networkInterfaceMock.getName()).thenReturn("testvnif", "testvnbr", "testpeth", "testvif", "testvirbr");

        try (MockedStatic<NetUtils> ignored = Mockito.mockStatic(NetUtils.class)) {
            Mockito.when(NetUtils.getNicParams(Mockito.anyString())).thenReturn(new String[]{null});

            Arrays.asList(NIC_NAME_STARTS_TO_AVOID).forEach(type -> {
                Assert.assertFalse(serverResourceBaseSpy.isValidNicToUseAsPrivateNic(networkInterfaceMock));
            });
        }
    }

    @Test
    public void isValidNicToUseAsPrivateNicTestReturnTrueWhenNetUtilsGetNicParamsReturnsAValidFirstElement() {
        NetworkInterface networkInterfaceMock = Mockito.mock(NetworkInterface.class);
        Mockito.when(networkInterfaceMock.isVirtual()).thenReturn(false);
        Mockito.when(networkInterfaceMock.getName()).thenReturn("testvnif", "testvnbr", "testpeth", "testvif", "testvirbr");

        try (MockedStatic<NetUtils> ignored = Mockito.mockStatic(NetUtils.class)) {
            Mockito.when(NetUtils.getNicParams(Mockito.anyString())).thenReturn(new String[]{"test"});

            Arrays.asList(NIC_NAME_STARTS_TO_AVOID).forEach(type -> {
                Assert.assertTrue(serverResourceBaseSpy.isValidNicToUseAsPrivateNic(networkInterfaceMock));
            });
        }
    }

    @Test(expected = ConfigurationException.class)
    public void tryToAutoDiscoverResourcePrivateNetworkInterfaceTestThrowConfigurationExceptionWhenNicsDoesNotHaveMoreElements() throws SocketException, ConfigurationException {
        try (MockedStatic<NetworkInterface> ignored = Mockito.mockStatic(NetworkInterface.class)) {
            Mockito.when(NetworkInterface.getNetworkInterfaces()).thenReturn(Collections.enumeration(new ArrayList<>()));

            serverResourceBaseSpy.tryToAutoDiscoverResourcePrivateNetworkInterface();
        }
    }

    @Test(expected = ConfigurationException.class)
    public void tryToAutoDiscoverResourcePrivateNetworkInterfaceTestThrowConfigurationExceptionWhenNicsGetNetworkInterfacesThrowsSocketException() throws SocketException, ConfigurationException {
        try (MockedStatic<NetworkInterface> ignored = Mockito.mockStatic(NetworkInterface.class)) {
            Mockito.when(NetworkInterface.getNetworkInterfaces()).thenThrow(SocketException.class);

            serverResourceBaseSpy.tryToAutoDiscoverResourcePrivateNetworkInterface();
        }
    }

    @Test(expected = ConfigurationException.class)
    public void tryToAutoDiscoverResourcePrivateNetworkInterfaceTestThrowConfigurationExceptionWhenThereIsNoValidNics() throws SocketException, ConfigurationException {
        try (MockedStatic<NetworkInterface> ignored = Mockito.mockStatic(NetworkInterface.class)) {
            Mockito.when(NetworkInterface.getNetworkInterfaces()).thenReturn(Collections.enumeration(Arrays.asList(networkInterfaceMock1, networkInterfaceMock2)));
            Mockito.doReturn(false).when(serverResourceBaseSpy).isValidNicToUseAsPrivateNic(Mockito.any());

            serverResourceBaseSpy.tryToAutoDiscoverResourcePrivateNetworkInterface();

            Mockito.verify(serverResourceBaseSpy, Mockito.times(2)).isValidNicToUseAsPrivateNic(Mockito.any());
        }
    }

    @Test
    public void tryToAutoDiscoverResourcePrivateNetworkInterfaceTestReturnNic() throws SocketException, ConfigurationException {
        Enumeration<NetworkInterface> interfaces = Collections.enumeration(Arrays.asList(networkInterfaceMock1, networkInterfaceMock2));

        try (MockedStatic<NetworkInterface> ignored = Mockito.mockStatic(NetworkInterface.class)) {
            Mockito.when(NetworkInterface.getNetworkInterfaces()).thenReturn(interfaces);
            Mockito.doReturn(false, true).when(serverResourceBaseSpy).isValidNicToUseAsPrivateNic(Mockito.any());

            serverResourceBaseSpy.tryToAutoDiscoverResourcePrivateNetworkInterface();

            Assert.assertEquals(networkInterfaceMock2, serverResourceBaseSpy.privateNic);
            Mockito.verify(serverResourceBaseSpy, Mockito.times(2)).isValidNicToUseAsPrivateNic(Mockito.any());
        }
    }

    @Test
    public void defineResourceNetworkInterfacesTestUseXenbr0WhenPrivateNetworkInterfaceNotConfigured() {
        Map<String, Object> params = createParamsMap(null, "cloudbr1", "cloudbr2", "cloudbr3");
        try (MockedStatic<NetUtils> ignored = Mockito.mockStatic(NetUtils.class)) {
            Mockito.when(NetUtils.getNetworkInterface(Mockito.anyString())).thenReturn(networkInterfaceMock1, networkInterfaceMock2, networkInterfaceMock3, networkInterfaceMock4);

            serverResourceBaseSpy.defineResourceNetworkInterfaces(params);

            verifyAndAssertNetworkInterfaces("xenbr0", "cloudbr1", "cloudbr2", "cloudbr3");
        }
    }

    @Test
    public void defineResourceNetworkInterfacesTestUseXenbr1WhenPublicNetworkInterfaceNotConfigured() {
        Map<String, Object> params = createParamsMap("cloudbr0", null, "cloudbr2", "cloudbr3");
        try (MockedStatic<NetUtils> ignored = Mockito.mockStatic(NetUtils.class)) {
            Mockito.when(NetUtils.getNetworkInterface(Mockito.anyString())).thenReturn(networkInterfaceMock1, networkInterfaceMock2, networkInterfaceMock3, networkInterfaceMock4);

            serverResourceBaseSpy.defineResourceNetworkInterfaces(params);

            verifyAndAssertNetworkInterfaces("cloudbr0", "xenbr1", "cloudbr2", "cloudbr3");
        }
    }

    @Test
    public void defineResourceNetworkInterfacesTestUseConfiguredNetworkInterfaces() {
        Map<String, Object> params = createParamsMap("cloudbr0", "cloudbr1", "cloudbr2", "cloudbr3");
        try (MockedStatic<NetUtils> ignored = Mockito.mockStatic(NetUtils.class)) {
            Mockito.when(NetUtils.getNetworkInterface(Mockito.anyString())).thenReturn(networkInterfaceMock1, networkInterfaceMock2, networkInterfaceMock3, networkInterfaceMock4);

            serverResourceBaseSpy.defineResourceNetworkInterfaces(params);

            verifyAndAssertNetworkInterfaces("cloudbr0", "cloudbr1", "cloudbr2", "cloudbr3");
        }
    }

    private Map<String, Object> createParamsMap(String... params) {
        Map<String, Object> result = new HashMap<>();
        result.put("private.network.device", params[0]);
        result.put("public.network.device", params[1]);
        result.put("storage.network.device", params[2]);
        result.put("storage.network.device.2", params[3]);
        return result;
    }

    private void verifyAndAssertNetworkInterfaces(String... expectedResults) {
        Mockito.verify(NetUtils.class, Mockito.times(4));
        NetUtils.getNetworkInterface(keyCaptor.capture());
        List<String> keys = keyCaptor.getAllValues();

        for (int i = 0; i < expectedResults.length; i++) {
            Assert.assertEquals(expectedResults[i], keys.get(i));
        }

        Assert.assertEquals(networkInterfaceMock1, serverResourceBaseSpy.privateNic);
        Assert.assertEquals(networkInterfaceMock2, serverResourceBaseSpy.publicNic);
        Assert.assertEquals(networkInterfaceMock3, serverResourceBaseSpy.storageNic);
        Assert.assertEquals(networkInterfaceMock4, serverResourceBaseSpy.storageNic2);
    }

    @Test
    public void testListFilesAtPath() throws IOException {
        String nfsMountPoint = "/tmp/nfs";
        String relativePath = "test";
        int startIndex = 0;
        int pageSize = 10;

        // create a test directory with some files
        File testDir = new File(nfsMountPoint, relativePath);
        testDir.mkdirs();
        File file1 = new File(testDir, "file1.txt");
        File file2 = new File(testDir, "file2.txt");
        file1.createNewFile();
        file2.createNewFile();

        ListDataStoreObjectsAnswer result = (ListDataStoreObjectsAnswer) serverResourceBaseSpy.listFilesAtPath(nfsMountPoint, relativePath, startIndex, pageSize);

        Assert.assertTrue(result.getResult());
        Assert.assertEquals(2, result.getCount());
        List<String> expectedNames = Arrays.asList("file1.txt", "file2.txt");
        List<String> expectedPaths = Arrays.asList("/test/file1.txt", "/test/file2.txt");
        List<String> expectedAbsPaths = Arrays.asList(nfsMountPoint + "/test/file1.txt", nfsMountPoint + "/test/file2.txt");
        List<Boolean> expectedIsDirs = Arrays.asList(false, false);
        List<Long> expectedSizes = Arrays.asList(file2.length(), file1.length());
        List<Long> expectedModifiedList = Arrays.asList(file2.lastModified(), file1.lastModified());
        Assert.assertTrue(CollectionUtils.isEqualCollection(expectedNames, result.getNames()));
        Assert.assertTrue(CollectionUtils.isEqualCollection(expectedPaths, result.getPaths()));
        Assert.assertTrue(CollectionUtils.isEqualCollection(expectedAbsPaths, result.getAbsPaths()));
        Assert.assertTrue(CollectionUtils.isEqualCollection(expectedIsDirs, result.getIsDirs()));
        Assert.assertTrue(CollectionUtils.isEqualCollection(expectedSizes, result.getSizes()));
        Assert.assertTrue(CollectionUtils.isEqualCollection(expectedModifiedList, result.getLastModified()));
    }
}