path: root/main/src/test/java/org/onap/policy/pap/main/rest/e2e/End2EndBase.java

/*-
 * ============LICENSE_START=======================================================
 * ONAP PAP
 * ================================================================================
 * Copyright (C) 2019, 2021 AT&T Intellectual Property. All rights reserved.
 * Modifications Copyright (C) 2019-2020 Nordix Foundation.
 * ================================================================================
 * 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.
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.pap.main.rest.e2e;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.List;
import org.junit.After;
import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.onap.policy.common.parameters.ValidationResult;
import org.onap.policy.common.utils.coder.Coder;
import org.onap.policy.common.utils.coder.CoderException;
import org.onap.policy.common.utils.coder.StandardCoder;
import org.onap.policy.common.utils.resources.ResourceUtils;
import org.onap.policy.models.base.PfModelException;
import org.onap.policy.models.pdp.concepts.PdpGroup;
import org.onap.policy.models.pdp.concepts.PdpGroups;
import org.onap.policy.models.pdp.concepts.PdpPolicyStatus;
import org.onap.policy.models.pdp.concepts.PdpStatistics;
import org.onap.policy.models.pdp.persistence.provider.PdpFilterParameters;
import org.onap.policy.models.provider.PolicyModelsProvider;
import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
import org.onap.policy.pap.main.PolicyModelsProviderFactoryWrapper;
import org.onap.policy.pap.main.PolicyPapRuntimeException;
import org.onap.policy.pap.main.parameters.PapParameterGroup;
import org.onap.policy.pap.main.rest.CommonPapRestServer;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.yaml.snakeyaml.Yaml;

public class End2EndBase extends CommonPapRestServer {
    private static final Logger logger = LoggerFactory.getLogger(End2EndBase.class);

    private static final Coder coder = new StandardCoder();
    private static final Yaml yaml = new Yaml();

    /**
     * DB connection. This is kept open until {@link #stop()} is invoked so that the in-memory DB is not destroyed.
     */
    private static PolicyModelsProvider dbConn;

    /**
     * DAO provider factory.
     */
    private static PolicyModelsProviderFactoryWrapper daoFactory;

    /**
     * Context - should be initialized by setUp() method.
     */
    protected End2EndContext context = null;


    /**
     * Starts Main and connects to the DB.
     *
     * @throws Exception if an error occurs
     */
    @BeforeClass
    public static void setUpBeforeClass() throws Exception {
        CommonPapRestServer.setUpBeforeClass(true);

        final PapParameterGroup params = new StandardCoder().decode(new File(CONFIG_FILE), PapParameterGroup.class);
        daoFactory = new PolicyModelsProviderFactoryWrapper(params.getDatabaseProviderParameters());
        dbConn = daoFactory.create();
    }

    /**
     * Tears down.
     */
    @AfterClass
    public static void tearDownAfterClass() {
        try {
            dbConn.close();
        } catch (final PfModelException e) {
            logger.warn("failed to close the DB", e);
        }

        try {
            daoFactory.close();
        } catch (final Exception e) {
            logger.warn("failed to close DAO factory", e);
        }

        CommonPapRestServer.teardownAfterClass();
    }

    /**
     * Tears down.
     */
    @Override
    @After
    public void tearDown() {
        if (context != null) {
            try {
                context.stop();
            } catch (final Exception e) {
                logger.warn("failed to stop end-to-end context", e);
            }
            context = null;
        }

        super.tearDown();
    }

    /**
     * Adds Tosca Policy Types to the DB.
     *
     * @param yamlFile name of the YAML file specifying the data to be loaded
     * @throws PfModelException if a DAO error occurs
     */
    public static void addToscaPolicyTypes(final String yamlFile) throws PfModelException {
        final ToscaServiceTemplate serviceTemplate = loadYamlFile(yamlFile, ToscaServiceTemplate.class);
        dbConn.createPolicyTypes(serviceTemplate);
    }

    /**
     * Adds Tosca Policies to the DB.
     *
     * @param yamlFile name of the YAML file specifying the data to be loaded
     * @throws PfModelException if a DAO error occurs
     */
    public static void addToscaPolicies(final String yamlFile) throws PfModelException {
        final ToscaServiceTemplate serviceTemplate = loadYamlFile(yamlFile, ToscaServiceTemplate.class);
        dbConn.createPolicies(serviceTemplate);
    }

    /**
     * Adds PDP groups to the DB.
     *
     * @param jsonFile name of the JSON file specifying the data to be loaded
     * @throws PfModelException if a DAO error occurs
     */
    public static void addGroups(final String jsonFile) throws PfModelException {
        final PdpGroups groups = loadJsonFile(jsonFile, PdpGroups.class);

        final ValidationResult result = groups.validatePapRest();
        if (!result.isValid()) {
            throw new PolicyPapRuntimeException("cannot init DB groups from " + jsonFile + ":\n" + result.getResult());
        }

        dbConn.createPdpGroups(groups.getGroups());
    }

    /**
     * Fetch PDP groups from the DB.
     *
     * @param name name of the pdpGroup
     * @throws PfModelException if a DAO error occurs
     */
    public static List<PdpGroup> fetchGroups(final String name) throws PfModelException {
        return dbConn.getPdpGroups(name);
    }

    /**
     * Fetch PDP statistics from the DB.
     *
     * @param instanceId name of the pdpStatistics
     * @param groupName name of the pdpGroup
     * @param subGroupName name of the pdpSubGroup
     * @throws PfModelException if a DAO error occurs
     */
    public static List<PdpStatistics> fetchPdpStatistics(final String instanceId, final String groupName,
           final String subGroupName) throws PfModelException {
        return dbConn.getFilteredPdpStatistics(
                        PdpFilterParameters.builder().name(instanceId).group(groupName).subGroup(subGroupName).build());
    }

    /**
     * Adds PdpPolicyStatus records to the DB.
     *
     * @param jsonFile name of the JSON file specifying the data to be loaded
     * @throws PfModelException if a DAO error occurs
     */
    public static void addPdpPolicyStatus(final String jsonFile) throws PfModelException {
        final PolicyStatusRecords data = loadJsonFile(jsonFile, PolicyStatusRecords.class);
        dbConn.cudPolicyStatus(data.records, null, null);
    }

    /**
     * Loads an object from a YAML file.
     *
     * @param fileName name of the file from which to load
     * @param clazz the class of the object to be loaded
     * @return the object that was loaded from the file
     */
    protected static <T> T loadYamlFile(final String fileName, final Class<T> clazz) {
        final File propFile = new File(ResourceUtils.getFilePath4Resource("e2e/" + fileName));

        try (FileInputStream input = new FileInputStream(propFile)) {
            final Object yamlObject = yaml.load(input);
            final String json = coder.encode(yamlObject);
            final T result = coder.decode(json, clazz);

            if (result == null) {
                throw new PolicyPapRuntimeException("cannot decode " + clazz.getSimpleName() + " from " + fileName);
            }

            return result;

        } catch (final FileNotFoundException e) {
            throw new PolicyPapRuntimeException("cannot find " + fileName, e);

        } catch (IOException | CoderException e) {
            throw new PolicyPapRuntimeException("cannot decode " + fileName, e);
        }
    }

    /**
     * Loads an object from a JSON file.
     *
     * @param fileName name of the file from which to load
     * @param clazz the class of the object to be loaded
     * @return the object that was loaded from the file
     */
    protected static <T> T loadJsonFile(final String fileName, final Class<T> clazz) {
        final String fileName2 = (fileName.startsWith("src/") ? fileName : "e2e/" + fileName);
        final File propFile = new File(ResourceUtils.getFilePath4Resource(fileName2));
        try {
            final T result = coder.decode(propFile, clazz);

            if (result == null) {
                throw new PolicyPapRuntimeException("cannot decode " + clazz.getSimpleName() + " from " + fileName);
            }

            return result;

        } catch (final CoderException e) {
            throw new RuntimeException(e);
        }
    }

    public class PolicyStatusRecords {
        private List<PdpPolicyStatus> records;
    }
}