path: root/runtime-controlloop/src/test/java/org/onap/policy/clamp/controlloop/runtime/commissioning/rest/CommissioningControllerTest.java

/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2021 Nordix Foundation.
 *  Modifications Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * Licensed 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.clamp.controlloop.runtime.commissioning.rest;

import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.util.List;
import java.util.Map;
import javax.ws.rs.client.Entity;
import javax.ws.rs.client.Invocation;
import javax.ws.rs.core.Response;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.junit.jupiter.api.parallel.Execution;
import org.junit.jupiter.api.parallel.ExecutionMode;
import org.onap.policy.clamp.controlloop.models.messages.rest.commissioning.CommissioningResponse;
import org.onap.policy.clamp.controlloop.runtime.main.parameters.ClRuntimeParameterGroup;
import org.onap.policy.clamp.controlloop.runtime.util.rest.CommonRestController;
import org.onap.policy.common.utils.coder.YamlJsonTranslator;
import org.onap.policy.common.utils.resources.ResourceUtils;
import org.onap.policy.models.provider.PolicyModelsProvider;
import org.onap.policy.models.provider.PolicyModelsProviderFactory;
import org.onap.policy.models.tosca.authorative.concepts.ToscaNodeTemplate;
import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
import org.springframework.boot.web.server.LocalServerPort;
import org.springframework.test.context.TestPropertySource;
import org.springframework.test.context.junit.jupiter.SpringExtension;

@ExtendWith(SpringExtension.class)
@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
@TestPropertySource(locations = {"classpath:application_test.properties"})
@Execution(ExecutionMode.SAME_THREAD)
class CommissioningControllerTest extends CommonRestController {

    private static final String TOSCA_SERVICE_TEMPLATE_YAML =
            "src/test/resources/rest/servicetemplates/pmsh_multiple_cl_tosca.yaml";
    private static final String COMMON_TOSCA_SERVICE_TEMPLATE_YAML =
        "src/test/resources/rest/servicetemplates/full-tosca-with-common-properties.yaml";
    private static final YamlJsonTranslator yamlTranslator = new YamlJsonTranslator();
    private static final String COMMISSIONING_ENDPOINT = "commission";
    private static ToscaServiceTemplate serviceTemplate = new ToscaServiceTemplate();
    private static ToscaServiceTemplate commonPropertiesServiceTemplate = new ToscaServiceTemplate();

    @Autowired
    private ClRuntimeParameterGroup clRuntimeParameterGroup;

    @LocalServerPort
    private int randomServerPort;

    /**
     * starts Main and inserts a commissioning template.
     *
     * @throws Exception if an error occurs
     */
    @BeforeAll
    public static void setUpBeforeClass() throws Exception {

        serviceTemplate = yamlTranslator.fromYaml(ResourceUtils.getResourceAsString(TOSCA_SERVICE_TEMPLATE_YAML),
                ToscaServiceTemplate.class);
        commonPropertiesServiceTemplate = yamlTranslator.fromYaml(ResourceUtils
                .getResourceAsString(COMMON_TOSCA_SERVICE_TEMPLATE_YAML),
            ToscaServiceTemplate.class);
    }

    @BeforeEach
    public void setUpPort() {
        super.setHttpPrefix(randomServerPort);
    }

    @AfterEach
    public void cleanDatabase() throws Exception {
        deleteEntryInDB(serviceTemplate.getName(), serviceTemplate.getVersion());
        deleteEntryInDB(commonPropertiesServiceTemplate.getName(), commonPropertiesServiceTemplate.getVersion());
    }

    @Test
    void testSwagger() throws Exception {
        super.testSwagger(COMMISSIONING_ENDPOINT);
    }

    @Test
    void testUnauthorizedCreate() throws Exception {
        assertUnauthorizedPost(COMMISSIONING_ENDPOINT, Entity.json(serviceTemplate));
    }

    @Test
    void testUnauthorizedQuery() throws Exception {
        assertUnauthorizedGet(COMMISSIONING_ENDPOINT);
    }

    @Test
    void testUnauthorizedQueryElements() throws Exception {
        assertUnauthorizedGet(COMMISSIONING_ENDPOINT + "/elements");
    }

    @Test
    void testUnauthorizedDelete() throws Exception {
        assertUnauthorizedDelete(COMMISSIONING_ENDPOINT);
    }

    @Test
    void testUnauthorizedQueryToscaServiceTemplate() throws Exception {
        assertUnauthorizedGet(COMMISSIONING_ENDPOINT + "/toscaservicetemplate");
    }

    @Test
    void testUnauthorizedQueryToscaServiceTemplateSchema() throws Exception {
        assertUnauthorizedGet(COMMISSIONING_ENDPOINT + "/toscaServiceTemplateSchema");
    }

    @Test
    void testUnauthorizedQueryToscaServiceCommonOrInstanceProperties() throws Exception {
        assertUnauthorizedGet(COMMISSIONING_ENDPOINT + "/getCommonOrInstanceProperties");
    }

    @Test
    void testQueryToscaServiceTemplate() throws Exception {
        createFullEntryInDbWithCommonProps();

        Invocation.Builder invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT
            + "/toscaservicetemplate");
        Response rawresp = invocationBuilder.buildGet().invoke();
        assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
        ToscaServiceTemplate template = rawresp.readEntity(ToscaServiceTemplate.class);
        assertNotNull(template);
        assertThat(template.getNodeTypes()).hasSize(8);

    }

    @Test
    void testQueryToscaServiceTemplateSchema() throws Exception {
        createFullEntryInDbWithCommonProps();

        Invocation.Builder invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT
            + "/toscaServiceTemplateSchema");
        Response rawresp = invocationBuilder.buildGet().invoke();
        assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
        String schema = rawresp.readEntity(String.class);
        assertNotNull(schema);

    }

    @Test
    void testQueryCommonOrInstanceProperties() throws Exception {
        createFullEntryInDbWithCommonProps();

        Invocation.Builder invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT
            + "/getCommonOrInstanceProperties" + "?common=true&name=ToscaServiceTemplateSimple&version=1.0.0");
        Response rawresp = invocationBuilder.buildGet().invoke();
        assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());

        @SuppressWarnings("unchecked")
        Map<String, ToscaNodeTemplate> commonProperties = rawresp.readEntity(Map.class);

        assertNotNull(commonProperties);
        assertThat(commonProperties).hasSize(6);

    }

    @Test
    void testCreateBadRequest() throws Exception {
        Invocation.Builder invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
        Response resp = invocationBuilder.post(Entity.json("NotToscaServiceTempalte"));

        assertThat(Response.Status.INTERNAL_SERVER_ERROR.getStatusCode()).isEqualTo(resp.getStatus());
        CommissioningResponse commissioningResponse = resp.readEntity(CommissioningResponse.class);
        assertThat(commissioningResponse.getErrorDetails()).isNotNull();
        assertThat(commissioningResponse.getAffectedControlLoopDefinitions()).isNull();
    }

    @Test
    void testCreate() throws Exception {
        Invocation.Builder invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
        Response resp = invocationBuilder.post(Entity.json(serviceTemplate));
        assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());
        CommissioningResponse commissioningResponse = resp.readEntity(CommissioningResponse.class);

        assertNotNull(commissioningResponse);
        assertNull(commissioningResponse.getErrorDetails());
        // Response should return the number of node templates present in the service template
        assertThat(commissioningResponse.getAffectedControlLoopDefinitions()).hasSize(13);
        for (String nodeTemplateName : serviceTemplate.getToscaTopologyTemplate().getNodeTemplates().keySet()) {
            assertTrue(commissioningResponse.getAffectedControlLoopDefinitions().stream()
                    .anyMatch(ac -> ac.getName().equals(nodeTemplateName)));
        }

    }

    @Test
    void testQuery_NoResultWithThisName() throws Exception {
        createEntryInDB();

        Invocation.Builder invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "?name=noResultWithThisName");
        Response rawresp = invocationBuilder.buildGet().invoke();
        assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
        List<?> entityList = rawresp.readEntity(List.class);
        assertThat(entityList).isEmpty();

    }

    @Test
    void testQuery() throws Exception {
        createEntryInDB();

        Invocation.Builder invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
        Response rawresp = invocationBuilder.buildGet().invoke();
        assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
        List<?> entityList = rawresp.readEntity(List.class);
        assertNotNull(entityList);
        assertThat(entityList).hasSize(2);

    }

    @Test
    void testQueryElementsBadRequest() throws Exception {
        createEntryInDB();

        //Call get elements with no info
        Invocation.Builder invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "/elements");
        Response resp = invocationBuilder.buildGet().invoke();
        assertEquals(Response.Status.NOT_ACCEPTABLE.getStatusCode(), resp.getStatus());

    }

    @Test
    void testQueryElements() throws Exception {
        createEntryInDB();

        Invocation.Builder invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "/elements"
                + "?name=org.onap.domain.pmsh.PMSHControlLoopDefinition");
        Response rawresp = invocationBuilder.buildGet().invoke();
        assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
        List<?> entityList = rawresp.readEntity(List.class);
        assertNotNull(entityList);
        assertThat(entityList).hasSize(4);

    }

    @Test
    void testDeleteBadRequest() throws Exception {
        createEntryInDB();

        Invocation.Builder invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
        //Call delete with no info
        Response resp = invocationBuilder.delete();
        assertEquals(Response.Status.BAD_REQUEST.getStatusCode(), resp.getStatus());

    }

    @Test
    void testDelete() throws Exception {
        createEntryInDB();

        Invocation.Builder invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "?name="
                + serviceTemplate.getName() + "&version=" + serviceTemplate.getVersion());
        //Call delete with no info
        Response resp = invocationBuilder.delete();
        assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());

        try (PolicyModelsProvider modelsProvider = new PolicyModelsProviderFactory()
                .createPolicyModelsProvider(clRuntimeParameterGroup.getDatabaseProviderParameters())) {
            List<ToscaServiceTemplate> templatesInDB = modelsProvider.getServiceTemplateList(null, null);
            assertThat(templatesInDB).isEmpty();
        }

    }

    private synchronized void createEntryInDB() throws Exception {
        try (PolicyModelsProvider modelsProvider = new PolicyModelsProviderFactory()
                .createPolicyModelsProvider(clRuntimeParameterGroup.getDatabaseProviderParameters())) {
            deleteEntryInDB(commonPropertiesServiceTemplate.getName(), commonPropertiesServiceTemplate.getVersion());
            modelsProvider.createServiceTemplate(serviceTemplate);
        }
    }

    // Delete entries from the DB after relevant tests
    private synchronized void deleteEntryInDB(String name, String version) throws Exception {
        try (PolicyModelsProvider modelsProvider = new PolicyModelsProviderFactory()
            .createPolicyModelsProvider(clRuntimeParameterGroup.getDatabaseProviderParameters())) {
            if (!modelsProvider.getServiceTemplateList(null, null).isEmpty()) {
                modelsProvider.deleteServiceTemplate(name, version);
            }
        }
    }

    private synchronized void createFullEntryInDbWithCommonProps() throws Exception {
        try (PolicyModelsProvider modelsProvider = new PolicyModelsProviderFactory()
            .createPolicyModelsProvider(clRuntimeParameterGroup.getDatabaseProviderParameters())) {
            deleteEntryInDB(commonPropertiesServiceTemplate.getName(), commonPropertiesServiceTemplate.getVersion());
            modelsProvider.createServiceTemplate(commonPropertiesServiceTemplate);
        }
    }
}