Package io.dropwizard.testing.junit5

Class DropwizardAppExtension<C extends Configuration>

java.lang.Object

io.dropwizard.testing.junit5.DropwizardAppExtension<C>

Type Parameters:

C - the configuration type

All Implemented Interfaces:

DropwizardExtension, org.junit.jupiter.api.extension.AfterAllCallback, org.junit.jupiter.api.extension.BeforeAllCallback, org.junit.jupiter.api.extension.Extension

public class DropwizardAppExtension<C extends Configuration>
extends Object
implements DropwizardExtension, org.junit.jupiter.api.extension.BeforeAllCallback, org.junit.jupiter.api.extension.AfterAllCallback

An extension for starting and stopping your application at the start and end of a test class.

By default, the Application will be constructed using reflection to invoke the nullary constructor. If your application does not provide a public nullary constructor, you will need to override the newApplication() method to provide your application instance(s).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DropwizardAppExtension.ServiceListener<T extends Configuration>

Constructor Summary

Constructors

Constructor	Description
DropwizardAppExtension(DropwizardTestSupport<C> testSupport)
DropwizardAppExtension(Class<? extends Application<C>> applicationClass)
DropwizardAppExtension(Class<? extends Application<C>> applicationClass, @Nullable String configPath, @Nullable String customPropertyPrefix, ConfigOverride... configOverrides)
DropwizardAppExtension(Class<? extends Application<C>> applicationClass, @Nullable String configPath, @Nullable String customPropertyPrefix, Function<Application<C>,Command> commandInstantiator, ConfigOverride... configOverrides)
DropwizardAppExtension(Class<? extends Application<C>> applicationClass, @Nullable String configPath, ConfigurationSourceProvider configSourceProvider, @Nullable String customPropertyPrefix, ConfigOverride... configOverrides)
DropwizardAppExtension(Class<? extends Application<C>> applicationClass, @Nullable String configPath, ConfigurationSourceProvider configSourceProvider, @Nullable String customPropertyPrefix, Function<Application<C>,Command> commandInstantiator, ConfigOverride... configOverrides)
DropwizardAppExtension(Class<? extends Application<C>> applicationClass, @Nullable String configPath, ConfigurationSourceProvider configSourceProvider, ConfigOverride... configOverrides)
DropwizardAppExtension(Class<? extends Application<C>> applicationClass, @Nullable String configPath, ConfigOverride... configOverrides)
DropwizardAppExtension(Class<? extends Application<C>> applicationClass, C configuration)	Alternate constructor that allows specifying exact Configuration object to use, instead of reading a resource and binding it as Configuration object.
DropwizardAppExtension(Class<? extends Application<C>> applicationClass, C configuration, Function<Application<C>,Command> commandInstantiator)	Alternate constructor that allows specifying the command the Dropwizard application is started with.

Method Summary

Modifier and Type	Method	Description
DropwizardAppExtension<C>	addListener(DropwizardAppExtension.ServiceListener<C> listener)
void	after()	Executed after test method or class.
void	afterAll(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
void	before()	Executed before test method or class.
void	beforeAll(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
jakarta.ws.rs.client.Client	client()	Returns a new HTTP Jersey Client for performing HTTP requests against the tested Dropwizard server.
protected org.glassfish.jersey.client.JerseyClientBuilder	clientBuilder()
int	getAdminPort()
<A extends Application<C>> A	getApplication()
C	getConfiguration()
Environment	getEnvironment()
int	getLocalPort()
com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
int	getPort(int connectorIndex)
DropwizardTestSupport<C>	getTestSupport()
DropwizardAppExtension<C>	manage(Managed managed)
Application<C>	newApplication()

Methods inherited from class java.lang.Object

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

Constructor Details

DropwizardAppExtension

public DropwizardAppExtension(Class<? extends Application<C>> applicationClass)

DropwizardAppExtension

public DropwizardAppExtension(Class<? extends Application<C>> applicationClass,
 @Nullable String configPath,
 ConfigOverride... configOverrides)

DropwizardAppExtension

public DropwizardAppExtension(Class<? extends Application<C>> applicationClass,
 @Nullable String configPath,
 ConfigurationSourceProvider configSourceProvider,
 ConfigOverride... configOverrides)

Since:

2.0

DropwizardAppExtension

public DropwizardAppExtension(Class<? extends Application<C>> applicationClass,
 @Nullable String configPath,
 @Nullable String customPropertyPrefix,
 ConfigOverride... configOverrides)

Since:

2.0

DropwizardAppExtension

public DropwizardAppExtension(Class<? extends Application<C>> applicationClass,
 @Nullable String configPath,
 ConfigurationSourceProvider configSourceProvider,
 @Nullable String customPropertyPrefix,
 ConfigOverride... configOverrides)

Since:

2.0

DropwizardAppExtension

public DropwizardAppExtension(Class<? extends Application<C>> applicationClass,
 @Nullable String configPath,
 @Nullable String customPropertyPrefix,
 Function<Application<C>,Command> commandInstantiator,
 ConfigOverride... configOverrides)

DropwizardAppExtension

public DropwizardAppExtension(Class<? extends Application<C>> applicationClass,
 @Nullable String configPath,
 ConfigurationSourceProvider configSourceProvider,
 @Nullable String customPropertyPrefix,
 Function<Application<C>,Command> commandInstantiator,
 ConfigOverride... configOverrides)

DropwizardAppExtension

public DropwizardAppExtension(Class<? extends Application<C>> applicationClass,
 C configuration)

Alternate constructor that allows specifying exact Configuration object to use, instead of reading a resource and binding it as Configuration object.

Since:

0.9

DropwizardAppExtension

public DropwizardAppExtension(Class<? extends Application<C>> applicationClass,
 C configuration,
 Function<Application<C>,Command> commandInstantiator)

Alternate constructor that allows specifying the command the Dropwizard application is started with.

Since:

1.1.0

DropwizardAppExtension

public DropwizardAppExtension(DropwizardTestSupport<C> testSupport)

Method Details

addListener

public DropwizardAppExtension<C> addListener(DropwizardAppExtension.ServiceListener<C> listener)

manage

public DropwizardAppExtension<C> manage(Managed managed)

beforeAll

public void beforeAll(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
               throws Exception

Specified by:

beforeAll in interface org.junit.jupiter.api.extension.BeforeAllCallback

Throws:

Exception

afterAll

public void afterAll(org.junit.jupiter.api.extension.ExtensionContext extensionContext)

Specified by:

afterAll in interface org.junit.jupiter.api.extension.AfterAllCallback

before

public void before()
            throws Exception

Description copied from interface: DropwizardExtension

Executed before test method or class.

Specified by:

before in interface DropwizardExtension

Throws:

Exception

after

public void after()

Description copied from interface: DropwizardExtension

Executed after test method or class.

Specified by:

after in interface DropwizardExtension

getConfiguration

public C getConfiguration()

getLocalPort

public int getLocalPort()

getPort

public int getPort(int connectorIndex)

getAdminPort

public int getAdminPort()

newApplication

public Application<C> newApplication()

getApplication

public <A extends Application<C>> A getApplication()

getEnvironment

public Environment getEnvironment()

getObjectMapper

public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

getTestSupport

public DropwizardTestSupport<C> getTestSupport()

client

public jakarta.ws.rs.client.Client client()

Returns a new HTTP Jersey Client for performing HTTP requests against the tested Dropwizard server. The client can be reused across different tests and automatically closed along with the server. The client can be augmented by overriding the clientBuilder() method.

Returns:

a new Client managed by the extension.

clientBuilder

protected org.glassfish.jersey.client.JerseyClientBuilder clientBuilder()