JunitHelperTest.java

/*******************************************************************************
 * Copyright French Prime minister Office/SGMAP/DINSIC/Vitam Program (2015-2019)
 *
 * contact.vitam@culture.gouv.fr
 *
 * This software is a computer program whose purpose is to implement a digital archiving back-office system managing
 * high volumetry securely and efficiently.
 *
 * This software is governed by the CeCILL 2.1 license under French law and abiding by the rules of distribution of free
 * software. You can use, modify and/ or redistribute the software under the terms of the CeCILL 2.1 license as
 * circulated by CEA, CNRS and INRIA at the following URL "http://www.cecill.info".
 *
 * As a counterpart to the access to the source code and rights to copy, modify and redistribute granted by the license,
 * users are provided only with a limited warranty and the software's author, the holder of the economic rights, and the
 * successive licensors have only limited liability.
 *
 * In this respect, the user's attention is drawn to the risks associated with loading, using, modifying and/or
 * developing or reproducing the software by the user in light of its specific status of free software, that may mean
 * that it is complicated to manipulate, and that also therefore means that it is reserved for developers and
 * experienced professionals having in-depth computer knowledge. Users are therefore encouraged to load and test the
 * software's suitability as regards their requirements in conditions enabling the security of their systems and/or data
 * to be ensured and, more generally, to use and operate it in the same conditions as regards security.
 *
 * The fact that you are presently reading this means that you have had knowledge of the CeCILL 2.1 license and that you
 * accept its terms.
 *******************************************************************************/

package fr.gouv.vitam.common.junit;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;

import java.net.ServerSocket;

import org.junit.ClassRule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;

import fr.gouv.vitam.common.exception.VitamApplicationServerException;
import fr.gouv.vitam.common.junit.JunitHelper.ElasticsearchTestConfiguration;
import fr.gouv.vitam.common.junit.VitamApplicationTestFactory.StartApplicationResponse;

public class JunitHelperTest {

    @ClassRule
    public static TemporaryFolder temporaryFolder = new TemporaryFolder();

    @Test
    public void testArgumentError() throws Throwable {
        final JunitHelper junitFindAvailablePort0 = JunitHelper.getInstance();
        try {
            junitFindAvailablePort0.isListeningOn("znN>", -4608);
            fail("Expecting exception: IllegalArgumentException");
        } catch (final IllegalArgumentException e) {}
        try {
            junitFindAvailablePort0.isListeningOn("znN>", 65536);
            fail("Expecting exception: IllegalArgumentException");

        } catch (final IllegalArgumentException e) {}
        try {
            junitFindAvailablePort0.isListeningOn(-4608);
            fail("Expecting exception: IllegalArgumentException");

        } catch (final IllegalArgumentException e) {}
        try {
            junitFindAvailablePort0.isListeningOn(65536);
            fail("Expecting exception: IllegalArgumentException");

        } catch (final IllegalArgumentException e) {}
        assertFalse(junitFindAvailablePort0.isListeningOn("znN>", 1025));
    }

    @Test
    public void testActivatePort() throws Throwable {
        final JunitHelper junitFindAvailablePort0 = JunitHelper.getInstance();
        int port = junitFindAvailablePort0.findAvailablePort();
        try (ServerSocket serverSocket = new ServerSocket(port)) {
            serverSocket.setReuseAddress(true);
            assertTrue(junitFindAvailablePort0.isListeningOn(port));
            assertTrue(junitFindAvailablePort0.isListeningOn(null, port));
        }
        junitFindAvailablePort0.releasePort(port);
        port = junitFindAvailablePort0.findAvailablePort();
        assertFalse(junitFindAvailablePort0.isListeningOn(port));
        assertFalse(junitFindAvailablePort0.isListeningOn(null, port));
        junitFindAvailablePort0.releasePort(port);
        StartApplicationResponse<?> response = junitFindAvailablePort0.findAvailablePortSetToApplication(
            new VitamApplicationTestFactory<Object>() {

                @Override
                public StartApplicationResponse startVitamApplication(int reservedPort) {
                    return new StartApplicationResponse<>().setServerPort(reservedPort)
                        .setApplication(null);
                }
            });
        assertFalse(junitFindAvailablePort0.isListeningOn(response.getServerPort()));
        assertFalse(junitFindAvailablePort0.isListeningOn(null, response.getServerPort()));
        assertNull(response.getApplication());
        junitFindAvailablePort0.releasePort(response.getServerPort());
        final int reservedPortPrevious = response.getServerPort();
        response = junitFindAvailablePort0.findAvailablePortSetToApplication(
            new VitamApplicationTestFactory<Object>() {

                @Override
                public StartApplicationResponse startVitamApplication(int reservedPort) {
                    return new StartApplicationResponse<>().setServerPort(reservedPortPrevious);
                }
            });
        assertFalse(junitFindAvailablePort0.isListeningOn(response.getServerPort()));
        assertFalse(junitFindAvailablePort0.isListeningOn(null, response.getServerPort()));
        junitFindAvailablePort0.releasePort(response.getServerPort());
        try {
            response = junitFindAvailablePort0.findAvailablePortSetToApplication(
                new VitamApplicationTestFactory<Object>() {

                    @Override
                    public StartApplicationResponse startVitamApplication(int reservedPort) {
                        return new StartApplicationResponse<>().setServerPort(-1);
                    }
                });
            fail("Should raized an exception");
        } catch (final IllegalStateException e) {
            // nothing to do
        }
        try {
            response = junitFindAvailablePort0.findAvailablePortSetToApplication(null);
            fail("Should raized an exception");
        } catch (final IllegalStateException e) {
            // nothing to do
        }
    }

    private static class ToNotAllocate {
        private ToNotAllocate() {
            throw new UnsupportedOperationException();
        }
    }

    @Test
    public void testPrivateConstructor() {
        JunitHelper.testPrivateConstructor(JunitHelper.class);
        JunitHelper.testPrivateConstructor(ToNotAllocate.class);
    }

    @Test
    public void testConsume() {
        assertEquals(0, JunitHelper.consumeInputStream(null));
        assertEquals(0, JunitHelper.consumeInputStreamPerByte(null));
        // Just check by running
        JunitHelper.awaitFullGc();
    }

    @Test
    public void testLaunchElasticsearch() throws VitamApplicationServerException {
        ElasticsearchTestConfiguration config = JunitHelper.startElasticsearchForTest(temporaryFolder, "test");
        JunitHelper.stopElasticsearchForTest(config);
        final int tcpPort = JunitHelper.getInstance().findAvailablePort();
        final int httpPort = JunitHelper.getInstance().findAvailablePort();
        config = JunitHelper.startElasticsearchForTest(temporaryFolder, "test", tcpPort, httpPort);
        try {
            JunitHelper.startElasticsearchForTest(temporaryFolder, "test", tcpPort, httpPort);
            fail("Should raized an exception");
        } catch (final VitamApplicationServerException e) {

        }
        JunitHelper.stopElasticsearchForTest(config);
    }
}