fr.gouv.vitam.common.junit

Class JunitHelper

java.lang.Object

org.junit.rules.ExternalResource

fr.gouv.vitam.common.junit.JunitHelper

All Implemented Interfaces:

org.junit.rules.TestRule

public class JunitHelper
extends org.junit.rules.ExternalResource

This class allows to get an available port during Junit execution

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JunitHelper.ElasticsearchTestConfiguration Class to help to build and stop an Elasticsearch server

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAMETER_JETTY_SERVER_PORT_ADMIN

Method Summary

Modifier and Type	Method and Description
static void	awaitFullGc() For benchmark: clean the used memory using a full GC. Usage: JunitHelper.awaitFullGc(); long firstAvailableMemory = Runtime.getRuntime().freeMemory(); ...
static long	consumeInputStream(InputStream inputStream) Read and close the inputStream using buffer read (read(buffer))
static long	consumeInputStreamPerByte(InputStream inputStream) Read and close the inputStream one byte at a time (read())
int	findAvailablePort()
int	findAvailablePort(String environmentVariable)
VitamApplicationTestFactory.StartApplicationResponse<?>	findAvailablePortSetToApplication(VitamApplicationTestFactory<?> testFactory) Find an available port, set the Property jetty.port and call the factory to start the application in one synchronized step.
static JunitHelper	getInstance()
boolean	isListeningOn(int port)
boolean	isListeningOn(String host, int port)
void	releasePort(int port) Remove the used port
static void	setJettyPortSystemProperty(String environmentVariable, int port) Set JettyPort System Property
static JunitHelper.ElasticsearchTestConfiguration	startElasticsearchForTest(org.junit.rules.TemporaryFolder tempFolder, String clusterName) Helper to start an Elasticsearch server (recommended version)
static JunitHelper.ElasticsearchTestConfiguration	startElasticsearchForTest(org.junit.rules.TemporaryFolder tempFolder, String clusterName, int tcpPort, int httpPort) Helper to start an Elasticsearch server (unrecommended version)
static void	stopElasticsearchForTest(JunitHelper.ElasticsearchTestConfiguration config) Stop the Elasticsearch server started through start ElasticsearchForTest
static void	testPrivateConstructor(Class<?> clasz) Utility to check empty private constructor
static void	unsetJettyPortSystemProperty() Unset JettyPort System Property

Methods inherited from class org.junit.rules.ExternalResource

after, apply, before

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PARAMETER_JETTY_SERVER_PORT_ADMIN

public static final String PARAMETER_JETTY_SERVER_PORT_ADMIN

See Also:

Constant Field Values

Method Detail

getInstance

public static final JunitHelper getInstance()

Returns:

the unique instance

findAvailablePort

public final int findAvailablePort()

Returns:

an available port if it exists

Throws:

IllegalStateException - if no port available

findAvailablePort

public final int findAvailablePort(String environmentVariable)

Parameters:

environmentVariable - if not null, set the port nomber in the system environment

Returns:

an available port if it exists

Throws:

IllegalStateException - if no port available

findAvailablePortSetToApplication

public final VitamApplicationTestFactory.StartApplicationResponse<?> findAvailablePortSetToApplication(VitamApplicationTestFactory<?> testFactory)

Find an available port, set the Property jetty.port and call the factory to start the application in one synchronized step.

Parameters:

testFactory - the VitamApplicationTestFactory to use

Returns:

the available and used port if it exists and the started application

Throws:

IllegalStateException - if no port available

releasePort

public final void releasePort(int port)

Remove the used port

Parameters:

port - to release

isListeningOn

public final boolean isListeningOn(int port)

Parameters:

port - the port to check on localhost

Returns:

True if the port is used by the localhost server

Throws:

IllegalArgumentException - if the port is not between 1 and 65535

isListeningOn

public final boolean isListeningOn(String host,
                                   int port)

Parameters:

host - the host to check

port - the port to check on host

Returns:

True if the port is used by the specified host

Throws:

IllegalArgumentException - if the port is not between 1 and 65535

consumeInputStream

public static final long consumeInputStream(InputStream inputStream)

Read and close the inputStream using buffer read (read(buffer))

Parameters:

inputStream - to read and close

Returns:

the size of the inputStream read

consumeInputStreamPerByte

public static final long consumeInputStreamPerByte(InputStream inputStream)

Read and close the inputStream one byte at a time (read())

Parameters:

inputStream - to read and close

Returns:

the size of the inputStream read

awaitFullGc

public static final void awaitFullGc()

For benchmark: clean the used memory using a full GC.

Usage:
JunitHelper.awaitFullGc();
long firstAvailableMemory = Runtime.getRuntime().freeMemory();
... do some tests consuming memory JunitHelper.awaitFullGc();
long secondAvailableMemory = Runtime.getRuntime().freeMemory();
long usedMemory = firstAvailableMemory - secondAvailableMemory;

setJettyPortSystemProperty

public static final void setJettyPortSystemProperty(String environmentVariable,
                                                    int port)

Set JettyPort System Property

Parameters:

environmentVariable -

port - set to jetty server

unsetJettyPortSystemProperty

public static final void unsetJettyPortSystemProperty()

Unset JettyPort System Property

testPrivateConstructor

public static final void testPrivateConstructor(Class<?> clasz)

Utility to check empty private constructor

Parameters:

clasz - class template

startElasticsearchForTest

public static final JunitHelper.ElasticsearchTestConfiguration startElasticsearchForTest(org.junit.rules.TemporaryFolder tempFolder,
                                                                                         String clusterName,
                                                                                         int tcpPort,
                                                                                         int httpPort)
                                                                                  throws VitamApplicationServerException

Helper to start an Elasticsearch server (unrecommended version)

Parameters:

tempFolder - the TemporaryFolder declared as ClassRule within the Junit class

clusterName - the cluster name

tcpPort - the given TcpPort

httpPort - the given HttpPort

Returns:

the ElasticsearchTestConfiguration to pass to stopElasticsearchForTest

Throws:

VitamApplicationServerException - if the Elasticsearch server cannot be started

startElasticsearchForTest

public static final JunitHelper.ElasticsearchTestConfiguration startElasticsearchForTest(org.junit.rules.TemporaryFolder tempFolder,
                                                                                         String clusterName)
                                                                                  throws VitamApplicationServerException

Helper to start an Elasticsearch server (recommended version)

Parameters:

tempFolder - the TemporaryFolder declared as ClassRule within the Junit class

clusterName - the cluster name

Returns:

the ElasticsearchTestConfiguration to pass to stopElasticsearchForTest

Throws:

VitamApplicationServerException - if the Elasticsearch server cannot be started

stopElasticsearchForTest

public static final void stopElasticsearchForTest(JunitHelper.ElasticsearchTestConfiguration config)

Stop the Elasticsearch server started through start ElasticsearchForTest

Parameters:

config - the ElasticsearchTestConfiguration