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

/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2021 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

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

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;

import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.Entity;
import javax.ws.rs.client.Invocation;
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import org.glassfish.jersey.client.ClientProperties;
import org.glassfish.jersey.client.authentication.HttpAuthenticationFeature;
import org.onap.policy.clamp.controlloop.common.exception.ControlLoopException;
import org.onap.policy.clamp.controlloop.runtime.main.startstop.Main;
import org.onap.policy.clamp.controlloop.runtime.util.CommonTestData;
import org.onap.policy.common.gson.GsonMessageBodyHandler;
import org.onap.policy.common.utils.network.NetworkUtil;
import org.onap.policy.common.utils.services.Registry;
import org.onap.policy.models.provider.PolicyModelsProviderParameters;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Class to perform Rest unit tests.
 *
 */
public class CommonRestController {

    private static final String CONFIG_FILE = "src/test/resources/parameters/RuntimeConfigParameters%d.json";

    private static final Logger LOGGER = LoggerFactory.getLogger(CommonRestController.class);

    public static final String SELF = NetworkUtil.getHostname();
    public static final String ENDPOINT_PREFIX = "onap/controlloop/v2/";

    private static int port;
    private static String httpPrefix;
    private static Main main;

    /**
     * Allocates a port for the server, writes a config file, and then starts Main.
     *
     * @param dbName database name
     * @throws Exception if an error occurs
     */
    public static void setUpBeforeClass(final String dbName) throws Exception {
        port = NetworkUtil.allocPort();

        httpPrefix = "http://" + SELF + ":" + port + "/";

        makeConfigFile(dbName);
        startMain();
    }

    /**
     * Stops Main.
     */
    public static void teardownAfterClass() {
        try {
            stopMain();
        } catch (Exception ex) {
            LOGGER.error("cannot stop main", ex);
        }
    }

    protected static PolicyModelsProviderParameters getParameters() {
        return main.getParameters().getDatabaseProviderParameters();
    }

    /**
     * Verifies that an endpoint appears within the swagger response.
     *
     * @param endpoint the endpoint of interest
     * @throws Exception if an error occurs
     */
    protected void testSwagger(final String endpoint) throws Exception {
        final Invocation.Builder invocationBuilder = sendFqeRequest(httpPrefix + "swagger.yaml", true);
        final String resp = invocationBuilder.get(String.class);

        assertTrue(resp.contains(ENDPOINT_PREFIX + endpoint + ":"));
    }

    /**
     * Makes a parameter configuration file.
     *
     * @param dbName database name
     * @throws IOException if an error occurs writing the configuration file
     * @throws FileNotFoundException if an error occurs writing the configuration file
     */
    private static void makeConfigFile(final String dbName) throws FileNotFoundException, IOException {
        String json = CommonTestData.getParameterGroupAsString(port, dbName);

        File file = new File(String.format(CONFIG_FILE, port));
        file.deleteOnExit();

        try (FileOutputStream output = new FileOutputStream(file)) {
            output.write(json.getBytes(StandardCharsets.UTF_8));
        }
    }

    /**
     * Starts the "Main".
     *
     * @throws InterruptedException
     *
     * @throws Exception if an error occurs
     */
    protected static void startMain() throws InterruptedException {
        Registry.newRegistry();

        // make sure port is available
        if (NetworkUtil.isTcpPortOpen(SELF, port, 1, 1L)) {
            throw new IllegalStateException("port " + port + " is not available");
        }

        final String[] configParameters = {"-c", String.format(CONFIG_FILE, port)};

        main = new Main(configParameters);

        if (!NetworkUtil.isTcpPortOpen(SELF, port, 40, 250L)) {
            throw new IllegalStateException("server is not listening on port " + port);
        }
    }

    /**
     * Stops the "Main".
     *
     * @throws ControlLoopException
     *
     * @throws Exception if an error occurs
     */
    private static void stopMain() throws Exception {
        if (main != null) {
            Main main2 = main;
            main = null;

            main2.shutdown();
        }
        // make sure port is close
        if (NetworkUtil.isTcpPortOpen(SELF, port, 1, 1L)) {
            throw new IllegalStateException("port " + port + " is still in use");
        }
    }

    /**
     * Sends a request to an endpoint.
     *
     * @param endpoint the target endpoint
     * @return a request builder
     * @throws Exception if an error occurs
     */
    protected Invocation.Builder sendRequest(final String endpoint) throws Exception {
        return sendFqeRequest(httpPrefix + ENDPOINT_PREFIX + endpoint, true);
    }

    /**
     * Sends a request to an endpoint, without any authorization header.
     *
     * @param endpoint the target endpoint
     * @return a request builder
     * @throws Exception if an error occurs
     */
    protected Invocation.Builder sendNoAuthRequest(final String endpoint) throws Exception {
        return sendFqeRequest(httpPrefix + ENDPOINT_PREFIX + endpoint, false);
    }

    /**
     * Sends a request to a fully qualified endpoint.
     *
     * @param fullyQualifiedEndpoint the fully qualified target endpoint
     * @param includeAuth if authorization header should be included
     * @return a request builder
     * @throws Exception if an error occurs
     */
    protected Invocation.Builder sendFqeRequest(final String fullyQualifiedEndpoint, boolean includeAuth)
            throws Exception {
        final Client client = ClientBuilder.newBuilder().build();

        client.property(ClientProperties.METAINF_SERVICES_LOOKUP_DISABLE, "true");
        client.register(GsonMessageBodyHandler.class);

        if (includeAuth) {
            client.register(HttpAuthenticationFeature.basic("healthcheck", "zb!XztG34"));
        }

        final WebTarget webTarget = client.target(fullyQualifiedEndpoint);

        return webTarget.request(MediaType.APPLICATION_JSON);
    }

    /**
     * Assert that POST call is Unauthorized.
     *
     * @param endPoint the endpoint
     * @param entity the entity ofthe body
     * @throws Exception if an error occurs
     */
    protected void assertUnauthorizedPost(final String endPoint, final Entity<?> entity) throws Exception {
        Response rawresp = sendNoAuthRequest(endPoint).post(entity);
        assertEquals(Response.Status.UNAUTHORIZED.getStatusCode(), rawresp.getStatus());
    }

    /**
     * Assert that PUT call is Unauthorized.
     *
     * @param endPoint the endpoint
     * @param entity the entity ofthe body
     * @throws Exception if an error occurs
     */
    protected void assertUnauthorizedPut(final String endPoint, final Entity<?> entity) throws Exception {
        Response rawresp = sendNoAuthRequest(endPoint).put(entity);
        assertEquals(Response.Status.UNAUTHORIZED.getStatusCode(), rawresp.getStatus());
    }

    /**
     * Assert that GET call is Unauthorized.
     *
     * @param endPoint the endpoint
     * @throws Exception if an error occurs
     */
    protected void assertUnauthorizedGet(final String endPoint) throws Exception {
        Response rawresp = sendNoAuthRequest(endPoint).buildGet().invoke();
        assertEquals(Response.Status.UNAUTHORIZED.getStatusCode(), rawresp.getStatus());
    }

    /**
     * Assert that DELETE call is Unauthorized.
     *
     * @param endPoint the endpoint
     * @throws Exception if an error occurs
     */
    protected void assertUnauthorizedDelete(final String endPoint) throws Exception {
        Response rawresp = sendNoAuthRequest(endPoint).delete();
        assertEquals(Response.Status.UNAUTHORIZED.getStatusCode(), rawresp.getStatus());
    }
}