path: root/gui-editors/gui-editor-apex/src/test/java/org/onap/policy/gui/editors/apex/rest/ApexEditorStartupTest.java

/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
 *  Modifications Copyright (C) 2020 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.gui.editors.apex.rest;

import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.awaitility.Awaitility.await;
import static org.junit.Assert.assertTrue;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.PrintStream;
import java.util.concurrent.TimeUnit;
import org.junit.Test;
import org.onap.policy.common.parameters.ParameterService;
import org.onap.policy.gui.editors.apex.rest.ApexEditorMain.EditorState;

/**
 * Test Apex Editor Startup.
 */
public class ApexEditorStartupTest {
    // CHECKSTYLE:OFF: MagicNumber

    /**
     * Test no args.
     *
     * @throws IOException          Signals that an I/O exception has occurred.
     * @throws InterruptedException if the test is interrupted
     */
    @Test
    public void testNoArgs() throws IOException, InterruptedException {
        final String[] args = new String[] {};

        final String outString = runEditor(args);

        assertTrue(outString.startsWith("Apex Editor REST endpoint (ApexEditorMain:"));
        assertTrue(outString.replaceAll("[\\r?\\n]+", " ").contains("State=RUNNING) started"));
        assertTrue(outString.replaceAll("[\\r?\\n]+", " ").contains("help=false"));
        assertTrue(outString.replaceAll("[\\r?\\n]+", " ").contains("restPort=18989"));
        assertTrue(outString.replaceAll("[\\r?\\n]+", " ").contains("timeToLive=-1"));
        assertTrue(outString.replaceAll("[\\r?\\n]+", " ").contains("listenAddress=localhost"));
        assertTrue(outString.replaceAll("[\\r?\\n]+", " ").contains("uploadUrl=null"));
        assertTrue(outString.replaceAll("[\\r?\\n]+", " ").contains("uploadUserid=null"));
        assertTrue(outString.replaceAll("[\\r?\\n]+", " ").endsWith(" State=STOPPED) shut down "));
    }

    /**
     * Test bad arg 0.
     *
     * @throws IOException          Signals that an I/O exception has occurred.
     * @throws InterruptedException if the test is interrupted
     */
    @Test
    public void testBadArg0() throws IOException, InterruptedException {
        final String[] args = new String[] { "12321" };

        assertThatThrownBy(() -> runEditor(args)).isInstanceOf(ApexEditorParameterException.class)
            .hasMessageContaining("parameter error, too many command line arguments specified : [12321]");
    }

    /**
     * Test bad arg 1.
     *
     * @throws IOException          Signals that an I/O exception has occurred.
     * @throws InterruptedException if the test is interrupted
     */
    @Test
    public void testBadArg1() throws IOException, InterruptedException {
        final String[] args = new String[] { "12321 12322 12323" };

        assertThatThrownBy(() -> runEditor(args)).isInstanceOf(ApexEditorParameterException.class)
            .hasMessageContaining("parameter error, too many command line arguments specified : [12321 12322 12323]");
    }

    /**
     * Test bad arg 2.
     *
     * @throws IOException          Signals that an I/O exception has occurred.
     * @throws InterruptedException if the test is interrupted
     */
    @Test
    public void testBadArg2() throws IOException, InterruptedException {
        final String[] args = new String[] { "-z" };

        assertThatThrownBy(() -> runEditor(args)).isInstanceOf(ApexEditorParameterException.class).hasMessageContaining(
            "parameter error, invalid command line arguments specified : Unrecognized option: -z");
    }

    /**
     * Test bad arg 3.
     *
     * @throws IOException          Signals that an I/O exception has occurred.
     * @throws InterruptedException if the test is interrupted
     */
    @Test
    public void testBadArg3() throws IOException, InterruptedException {
        final String[] args = new String[] { "--hello" };

        assertThatThrownBy(() -> runEditor(args)).isInstanceOf(ApexEditorParameterException.class).hasMessageContaining(
            "parameter error, invalid command line arguments specified : Unrecognized option: --hello");
    }

    /**
     * Test bad arg 4.
     *
     * @throws IOException          Signals that an I/O exception has occurred.
     * @throws InterruptedException if the test is interrupted
     */
    @Test
    public void testBadArg4() throws IOException, InterruptedException {
        final String[] args = new String[] { "-l", "+++++" };

        assertThatThrownBy(() -> runEditor(args)).isInstanceOf(ApexEditorParameterException.class)
            .hasMessageContaining("parameters invalid, listen address is not valid. "
                + "Illegal character in hostname at index 7: http://+++++:18989/apexservices/");
    }

    /**
     * Test help 0.
     *
     * @throws IOException          Signals that an I/O exception has occurred.
     * @throws InterruptedException if the test is interrupted
     */
    @Test
    public void testHelp0() throws IOException, InterruptedException {
        final String[] args = new String[] { "--help" };

        assertThatThrownBy(() -> runEditor(args)).isInstanceOf(ApexEditorParameterException.class)
            .hasMessageContaining("usage: org.onap.policy.gui.editors.apex.rest.ApexEditorMain [options...]");
    }

    /**
     * Test help 1.
     *
     * @throws IOException          Signals that an I/O exception has occurred.
     * @throws InterruptedException if the test is interrupted
     */
    @Test
    public void testHelp1() throws IOException, InterruptedException {
        final String[] args = new String[] { "-h" };

        assertThatThrownBy(() -> runEditor(args)).isInstanceOf(ApexEditorParameterException.class)
            .hasMessageContaining("usage: org.onap.policy.gui.editors.apex.rest.ApexEditorMain [options...]");
    }

    /**
     * Test port arg.
     *
     * @throws IOException          Signals that an I/O exception has occurred.
     * @throws InterruptedException if the test is interrupted
     */
    @Test
    public void testPortArgShJo() throws IOException, InterruptedException {
        final String[] args = new String[] { "-p12321" };

        final String outString = runEditor(args);

        assertTrue(outString.startsWith("Apex Editor REST endpoint (ApexEditorMain:"));
        assertTrue(outString.replaceAll("[\\r?\\n]+", " ").contains("State=RUNNING) started"));
        assertTrue(outString.replaceAll("[\\r?\\n]+", " ").contains("localhost:12321"));
        assertTrue(outString.replaceAll("[\\r?\\n]+", " ").endsWith(" State=STOPPED) shut down "));
    }

    /**
     * Test port arg.
     *
     * @throws IOException          Signals that an I/O exception has occurred.
     * @throws InterruptedException if the test is interrupted
     */
    @Test
    public void testPortArgShSe() throws IOException, InterruptedException {
        final String[] args = new String[] { "-p", "12321" };

        final String outString = runEditor(args);

        assertTrue(outString.startsWith("Apex Editor REST endpoint (ApexEditorMain:"));
        assertTrue(outString.replaceAll("[\\r?\\n]+", " ").contains("State=RUNNING) started"));
        assertTrue(outString.replaceAll("[\\r?\\n]+", " ").contains("localhost:12321"));
        assertTrue(outString.replaceAll("[\\r?\\n]+", " ").endsWith(" State=STOPPED) shut down "));
    }

    /**
     * Test port arg.
     *
     * @throws IOException          Signals that an I/O exception has occurred.
     * @throws InterruptedException if the test is interrupted
     */
    @Test
    public void testPortArgSpace() throws IOException, InterruptedException {
        final String[] args = new String[] { "-p 12321" };

        assertThatThrownBy(() -> runEditor(args)).isInstanceOf(ApexEditorParameterException.class)
            .hasMessageContaining("parameter error, error parsing argument \"port\" :For input string: \" 12321\"");
    }

    /**
     * Test bad port arg 0.
     *
     * @throws IOException          Signals that an I/O exception has occurred.
     * @throws InterruptedException if the test is interrupted
     */
    @Test
    public void testBadPortArgs0() throws IOException, InterruptedException {
        final String[] args = new String[] { "-p0" };

        assertThatThrownBy(() -> runEditor(args)).isInstanceOf(ApexEditorParameterException.class)
            .hasMessageContaining("parameters invalid, port must be between 1024 and 65535");
    }

    /**
     * Test bad port arg 1023.
     *
     * @throws IOException          Signals that an I/O exception has occurred.
     * @throws InterruptedException if the test is interrupted
     */
    @Test
    public void testBadPortArgs1023() throws IOException, InterruptedException {
        final String[] args = new String[] { "-p1023" };

        assertThatThrownBy(() -> runEditor(args)).isInstanceOf(ApexEditorParameterException.class)
            .hasMessageContaining("parameters invalid, port must be between 1024 and 65535");
    }

    /**
     * Test bad port arg 65536.
     *
     * @throws IOException          Signals that an I/O exception has occurred.
     * @throws InterruptedException if the test is interrupted
     */
    @Test
    public void testBadPortArgs65536() throws IOException, InterruptedException {
        final String[] args = new String[] { "-p65536" };

        assertThatThrownBy(() -> runEditor(args)).isInstanceOf(ApexEditorParameterException.class)
            .hasMessageContaining("parameters invalid, port must be between 1024 and 65535");
    }

    /**
     * Test TTL arg 0.
     *
     * @throws IOException          Signals that an I/O exception has occurred.
     * @throws InterruptedException if the test is interrupted
     */
    @Test
    public void testTtlArg0() throws IOException, InterruptedException {
        final String[] args = new String[] { "-t10" };

        final String outString = runEditor(args);

        assertTrue(outString.startsWith("Apex Editor REST endpoint (ApexEditorMain:"));
        assertTrue(outString.replaceAll("[\\r?\\n]+", " ").contains("State=RUNNING) started"));
        assertTrue(outString.replaceAll("[\\r?\\n]+", " ").contains("timeToLive=10"));
        assertTrue(outString.replaceAll("[\\r?\\n]+", " ").endsWith(" State=STOPPED) shut down "));
    }

    /**
     * Test TTL arg 10.
     *
     * @throws IOException          Signals that an I/O exception has occurred.
     * @throws InterruptedException if the test is interrupted
     */
    @Test
    public void testTtlArg1() throws IOException, InterruptedException {
        final String[] args = new String[] { "-t", "10", "-l", "localhost" };

        final String outString = runEditor(args);

        assertTrue(outString.startsWith("Apex Editor REST endpoint (ApexEditorMain:"));
        assertTrue(outString.replaceAll("[\\r?\\n]+", " ").contains("State=RUNNING) started"));
        assertTrue(outString.replaceAll("[\\r?\\n]+", " ").contains("timeToLive=10"));
        assertTrue(outString.replaceAll("[\\r?\\n]+", " ").endsWith(" State=STOPPED) shut down "));
    }

    /**
     * Test port TTL arg 0.
     *
     * @throws IOException          Signals that an I/O exception has occurred.
     * @throws InterruptedException if the test is interrupted
     */
    @Test
    public void testPortTtlArg0() throws IOException, InterruptedException {
        final String[] args = new String[] { "-t", "10", "-p", "12321" };

        final String outString = runEditor(args);

        assertTrue(outString.startsWith("Apex Editor REST endpoint (ApexEditorMain:"));
        assertTrue(outString.replaceAll("[\\r?\\n]+", " ").contains("State=RUNNING) started"));
        assertTrue(outString.replaceAll("[\\r?\\n]+", " ").contains("timeToLive=10"));
        assertTrue(outString.replaceAll("[\\r?\\n]+", " ").endsWith(" State=STOPPED) shut down "));
    }

    /**
     * Test port TTL arg 10.
     *
     * @throws IOException          Signals that an I/O exception has occurred.
     * @throws InterruptedException if the test is interrupted
     */
    @Test
    public void testPortTtlArg1() throws IOException, InterruptedException {
        final String[] args = new String[] { "--time-to-live", "10", "--port", "12321", "--listen", "127.0.0.1" };

        final String outString = runEditor(args);

        assertTrue(outString.startsWith("Apex Editor REST endpoint (ApexEditorMain:"));
        assertTrue(outString.replaceAll("[\\r?\\n]+", " ").contains("State=RUNNING) started"));
        assertTrue(outString.replaceAll("[\\r?\\n]+", " ").contains("timeToLive=10"));
        assertTrue(outString.replaceAll("[\\r?\\n]+", " ").endsWith(" State=STOPPED) shut down "));
    }

    /**
     * Run the editor for tests.
     *
     * @param args the args
     * @return the output string
     * @throws InterruptedException if the test is interrupted
     */
    private String runEditor(final String[] args) throws InterruptedException {
        ParameterService.clear();
        final var outBaStream = new ByteArrayOutputStream();
        final var outStream = new PrintStream(outBaStream);

        final var editorMain = new ApexEditorMain(args, outStream);

        // This test must be started in a thread because we want to intercept the output
        // in cases where the editor is
        // started infinitely
        final var testThread = new Runnable() {
            @Override
            public void run() {
                editorMain.init();
            }
        };
        new Thread(testThread).start();
        await().atMost(15000, TimeUnit.MILLISECONDS).until(() -> !(editorMain.getState().equals(EditorState.READY)
            || editorMain.getState().equals(EditorState.INITIALIZING)));
        editorMain.shutdown();
        final String outString = outBaStream.toString();
        System.out.println(outString);
        return outString;
    }
}