server/src/test/java/com/cloud/api/dispatch/ParamProcessWorkerTest.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.api.dispatch;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.InjectMocks;
import org.mockito.Spy;

import org.mockito.junit.MockitoJUnitRunner;

import org.apache.cloudstack.api.ApiArgValidator;
import org.apache.cloudstack.api.BaseCmd;
import org.apache.cloudstack.api.Parameter;
import org.apache.cloudstack.api.ServerApiException;
import org.apache.cloudstack.api.command.user.address.AssociateIPAddrCmd;
import org.apache.cloudstack.acl.SecurityChecker;
import org.apache.cloudstack.context.CallContext;

import com.cloud.exception.ConcurrentOperationException;
import com.cloud.exception.InsufficientCapacityException;
import com.cloud.exception.NetworkRuleConflictException;
import com.cloud.exception.ResourceAllocationException;
import com.cloud.exception.ResourceUnavailableException;
import com.cloud.user.Account;
import com.cloud.user.AccountManager;
import com.cloud.user.User;
import com.cloud.vm.VMInstanceVO;

@RunWith(MockitoJUnitRunner.class)
public class ParamProcessWorkerTest {

    @Spy
    @InjectMocks
    private ParamProcessWorker paramProcessWorkerSpy;

    @Mock
    private AccountManager accountManagerMock;

    @Mock
    private Account callingAccountMock;

    @Mock
    private User callingUserMock;

    @Mock
    private Account ownerAccountMock;

    @Mock
    BaseCmd baseCmdMock;

    private Account[] owners = new Account[]{ownerAccountMock};

    private Map<Object, SecurityChecker.AccessType> entities = new HashMap<>();

    public static class TestCmd extends BaseCmd {

        @Parameter(name = "strparam1")
        String strparam1;

        @Parameter(name = "intparam1", type = CommandType.INTEGER)
        int intparam1;

        @Parameter(name = "boolparam1", type = CommandType.BOOLEAN)
        boolean boolparam1;

        @Parameter(name = "doubleparam1", type = CommandType.DOUBLE)
        double doubleparam1;

        @Parameter(name = "vmHostNameParam", type = CommandType.STRING, validations = {ApiArgValidator.RFCComplianceDomainName})
        String vmHostNameParam;

        @Parameter(name = "mountOptions", type = CommandType.STRING, validations = {ApiArgValidator.SafeCommandOptions})
        String mountOptions;

        @Override
        public void execute() throws ResourceUnavailableException, InsufficientCapacityException, ServerApiException, ConcurrentOperationException,
                ResourceAllocationException, NetworkRuleConflictException {
            // well documented nothing
        }

        @Override
        public String getCommandName() {
            return "test";
        }

        @Override
        public long getEntityOwnerId() {
            return 0;
        }

    }

    @Before
    public void setup() {
        CallContext.register(callingUserMock, callingAccountMock);
    }

    @After
    public void cleanup() {
        CallContext.unregister();
    }

    @Test
    public void processParameters() {
        final HashMap<String, String> params = new HashMap<String, String>();
        params.put("strparam1", "foo");
        params.put("intparam1", "100");
        params.put("boolparam1", "true");
        params.put("doubleparam1", "11.89");
        params.put("vmHostNameParam", "test-host-name-123");
        final TestCmd cmd = new TestCmd();
        paramProcessWorkerSpy.processParameters(cmd, params);
        Assert.assertEquals("foo", cmd.strparam1);
        Assert.assertEquals(100, cmd.intparam1);
        Assert.assertTrue(Double.compare(cmd.doubleparam1, 11.89) == 0);
        Assert.assertEquals("test-host-name-123", cmd.vmHostNameParam);
    }

    @Test
    public void processMountOptionsParameter_Valid() {
        final HashMap<String, String> params = new HashMap<String, String>();
        params.put("mountOptions", "vers=4.1,soft,timeo=600,retrans=2");
        final TestCmd cmd = new TestCmd();
        paramProcessWorkerSpy.processParameters(cmd, params);
        Assert.assertEquals("vers=4.1,soft,timeo=600,retrans=2", cmd.mountOptions);
    }

    @Test(expected = ServerApiException.class)
    public void processMountOptionsParameter_RejectCodeLikeContent() {
        final HashMap<String, String> params = new HashMap<String, String>();
        params.put("mountOptions", "rw;rm -rf /");
        final TestCmd cmd = new TestCmd();
        paramProcessWorkerSpy.processParameters(cmd, params);
    }

    @Test(expected = ServerApiException.class)
    public void processVmHostNameParameter_CannotStartWithDigit() {
        final HashMap<String, String> params = new HashMap<String, String>();
        params.put("vmHostNameParam", "123test");
        final TestCmd cmd = new TestCmd();
        paramProcessWorkerSpy.processParameters(cmd, params);
    }

    @Test(expected = ServerApiException.class)
    public void processVmHostNameParameter_CannotStartWithHypen() {
        final HashMap<String, String> params = new HashMap<String, String>();
        params.put("vmHostNameParam", "-test");
        final TestCmd cmd = new TestCmd();
        paramProcessWorkerSpy.processParameters(cmd, params);
    }

    @Test(expected = ServerApiException.class)
    public void processVmHostNameParameter_CannotEndWithHypen() {
        final HashMap<String, String> params = new HashMap<String, String>();
        params.put("vmHostNameParam", "test-");
        final TestCmd cmd = new TestCmd();
        paramProcessWorkerSpy.processParameters(cmd, params);
    }

    @Test(expected = ServerApiException.class)
    public void processVmHostNameParameter_NotMoreThan63Chars() {
        final HashMap<String, String> params = new HashMap<String, String>();
        params.put("vmHostNameParam", "test-f2405112-d5a1-47c1-9f00-976909e3a6d3-1e6f3264-955ee76011a99");
        final TestCmd cmd = new TestCmd();
        paramProcessWorkerSpy.processParameters(cmd, params);
        Mockito.verify(paramProcessWorkerSpy).doAccessChecks(Mockito.any(), Mockito.any());
    }

    @Test
    public void doAccessChecksTestChecksCallerAccessToOwnerWhenCmdExtendsBaseAsyncCreateCmd() {
        Mockito.lenient().doReturn(owners).when(paramProcessWorkerSpy).getEntityOwners(Mockito.any());
        Mockito.doNothing().when(paramProcessWorkerSpy).checkCallerAccessToEntities(Mockito.any(), Mockito.any(), Mockito.any());

        paramProcessWorkerSpy.doAccessChecks(new AssociateIPAddrCmd(), entities);

        Mockito.verify(accountManagerMock).checkAccess(callingAccountMock, null, false, owners);
    }

    @Test
    public void doAccessChecksTestChecksCallerAccessToEntities() {
        Mockito.lenient().doReturn(owners).when(paramProcessWorkerSpy).getEntityOwners(Mockito.any());
        Mockito.doNothing().when(paramProcessWorkerSpy).checkCallerAccessToEntities(Mockito.any(), Mockito.any(), Mockito.any());

        paramProcessWorkerSpy.doAccessChecks(new AssociateIPAddrCmd(), entities);

        Mockito.verify(paramProcessWorkerSpy).checkCallerAccessToEntities(callingAccountMock, owners, entities);
    }

    @Test
    public void getEntityOwnersTestReturnsAccountsWhenCmdHasMultipleEntityOwners() {
        Mockito.when(baseCmdMock.getEntityOwnerIds()).thenReturn(List.of(1L, 2L));
        Mockito.doReturn(callingAccountMock).when(accountManagerMock).getAccount(1L);
        Mockito.doReturn(ownerAccountMock).when(accountManagerMock).getAccount(2L);

        List<Account> result = List.of(paramProcessWorkerSpy.getEntityOwners(baseCmdMock));

        Assert.assertEquals(List.of(callingAccountMock, ownerAccountMock), result);
    }

    @Test
    public void getEntityOwnersTestReturnsAccountWhenCmdHasOneEntityOwner() {
        Mockito.when(baseCmdMock.getEntityOwnerId()).thenReturn(1L);
        Mockito.when(baseCmdMock.getEntityOwnerIds()).thenReturn(null);
        Mockito.doReturn(ownerAccountMock).when(accountManagerMock).getAccount(1L);

        List<Account> result = List.of(paramProcessWorkerSpy.getEntityOwners(baseCmdMock));

        Assert.assertEquals(List.of(ownerAccountMock), result);
    }

    @Test
    public void checkCallerAccessToEntitiesTestChecksCallerAccessToOwners() {
        entities.put(ownerAccountMock, SecurityChecker.AccessType.UseEntry);

        paramProcessWorkerSpy.checkCallerAccessToEntities(callingAccountMock, owners, entities);

        Mockito.verify(accountManagerMock).checkAccess(callingAccountMock, null, false, owners);
    }

    @Test
    public void checkCallerAccessToEntitiesTestChecksCallerAccessToResource() {
        VMInstanceVO vmInstanceVo = new VMInstanceVO();
        entities.put(vmInstanceVo, SecurityChecker.AccessType.UseEntry);

        paramProcessWorkerSpy.checkCallerAccessToEntities(callingAccountMock, owners, entities);

        Mockito.verify(accountManagerMock).validateAccountHasAccessToResource(callingAccountMock, SecurityChecker.AccessType.UseEntry, vmInstanceVo);
    }
}