com.github.mjeanroy.junit.servers.engine

Class EmbeddedServerTestLifeCycleAdapter

java.lang.Object

com.github.mjeanroy.junit.servers.engine.EmbeddedServerTestLifeCycleAdapter

All Implemented Interfaces:

TestLifeCycleAdapter

public final class EmbeddedServerTestLifeCycleAdapter
extends Object
implements TestLifeCycleAdapter

An engine that will handle the embedded server lifecycle:

1. Start embedded server before running any tests.
2. Stop embedded server after all tests are run.

Constructor Summary

Constructors

Constructor and Description
EmbeddedServerTestLifeCycleAdapter() Create rule with default embedded server.
EmbeddedServerTestLifeCycleAdapter(AbstractConfiguration configuration) Create rule with embedded server configuration.
EmbeddedServerTestLifeCycleAdapter(EmbeddedServer<?> server) Create rule with an embedded server.

Method Summary

Modifier and Type	Method and Description
void	afterAll() Run the AFTER step of the lifecycle test.
void	afterEach(Object target) Method called after running unit test.
void	beforeAll() Run the BEFORE step of the lifecycle test.
void	beforeEach(Object target) Method called before running unit test.
HttpClient	getClient() Returns HTTP client that can be used against server.
HttpClient	getClient(HttpClientStrategy strategy) Returns HTTP client that can be used against server.
String	getHost() Get embedded server scheme (should be "localhost").
String	getPath() Get path defined on embedded server.
int	getPort() Get port used by embedded server.
String	getScheme() Get embedded server scheme (a.k.a "http" or "https").
EmbeddedServer<?>	getServer() Get embedded server.
String	getUrl() Get url used to query embedded server.
boolean	isStarted() Check if embedded server is started.
void	restart() Restart embedded server.
void	start() Start embedded server.
void	stop() Stop embedded server.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.mjeanroy.junit.servers.engine.TestLifeCycleAdapter

afterEach, beforeEach

Constructor Detail

EmbeddedServerTestLifeCycleAdapter

public EmbeddedServerTestLifeCycleAdapter()

Create rule with default embedded server.

Embedded server implementation is chosen using classpath detection: jetty or tomcat will be instantiate if implementation is available on classpath (it means if sub-module is imported, it should be enough to instantiate embedded server).

The server will automatically use the default configuration, to specify a custom configuration, use EmbeddedServerTestLifeCycleAdapter(AbstractConfiguration) constructor.

EmbeddedServerTestLifeCycleAdapter

public EmbeddedServerTestLifeCycleAdapter(AbstractConfiguration configuration)

Create rule with embedded server configuration.

Embedded server implementation is chosen using classpath detection: jetty or tomcat will be instantiate if implementation is available on classpath (it means if sub-module is imported, it should be enough to instantiate embedded server !).

Parameters:

configuration - Server configuration.

EmbeddedServerTestLifeCycleAdapter

public EmbeddedServerTestLifeCycleAdapter(EmbeddedServer<?> server)

Create rule with an embedded server.

Parameters:

server - Embedded server, not null.

Throws:

NullPointerException - If server is null.

Method Detail

beforeAll

public void beforeAll()

Run the BEFORE step of the lifecycle test.

Specified by:

beforeAll in interface TestLifeCycleAdapter

afterAll

public void afterAll()

Run the AFTER step of the lifecycle test.

Specified by:

afterAll in interface TestLifeCycleAdapter

start

public void start()

Start embedded server.

See Also:

EmbeddedServer.start()

stop

public void stop()

Stop embedded server.

See Also:

EmbeddedServer.stop()

restart

public void restart()

Restart embedded server.

See Also:

EmbeddedServer.restart()

isStarted

public boolean isStarted()

Check if embedded server is started.

Returns:

true if embedded server is started, false otherwise.

See Also:

EmbeddedServer.isStarted()

getScheme

public String getScheme()

Get embedded server scheme (a.k.a "http" or "https").

Returns:

Scheme.

See Also:

EmbeddedServer.getScheme()

getHost

public String getHost()

Get embedded server scheme (should be "localhost").

Returns:

Host.

See Also:

EmbeddedServer.getHost()

getPort

public int getPort()

Get port used by embedded server.

Note that:

• If the server is not started, the returned port is the one set in the configuration.
• Otherwise, the "real" port is returned (the port used by the embedded server)

Returns:

The port.

See Also:

EmbeddedServer.getPort()

getPath

public String getPath()

Get path defined on embedded server.

Returns:

Path.

See Also:

EmbeddedServer.getPath()

getUrl

public String getUrl()

Get url used to query embedded server.

Returns:

URL.

See Also:

EmbeddedServer.getUrl()

getServer

public EmbeddedServer<?> getServer()

Get embedded server.

Returns:

Server.

getClient

public HttpClient getClient()

Returns HTTP client that can be used against server.

Returns:

The HTTP client.

Throws:

UnsupportedOperationException - If the client cannot be returned because of missing implementation.

getClient

public HttpClient getClient(HttpClientStrategy strategy)

Returns HTTP client that can be used against server.

Returns:

The HTTP client.

Throws:

UnsupportedOperationException - If the client cannot be returned because of missing implementation.

beforeEach

public void beforeEach(Object target)

Description copied from interface: TestLifeCycleAdapter

Method called before running unit test.

Specified by:

beforeEach in interface TestLifeCycleAdapter

Parameters:

target - The test class instance.

afterEach

public void afterEach(Object target)

Description copied from interface: TestLifeCycleAdapter

Method called after running unit test.

Specified by:

afterEach in interface TestLifeCycleAdapter

Parameters:

target - The test class instance.