io.dropwizard.testing

Class DropwizardTestSupport<C extends Configuration>

java.lang.Object

io.dropwizard.testing.DropwizardTestSupport<C>

Type Parameters:

C - the configuration type

public class DropwizardTestSupport<C extends Configuration>
extends Object

A test support class 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 and Description
static class	DropwizardTestSupport.ServiceListener<T extends Configuration>

Field Summary

Fields

Modifier and Type	Field and Description
protected Application<C>	application
protected Class<? extends Application<C>>	applicationClass
protected Function<Application<C>,Command>	commandInstantiator
protected Set<ConfigOverride>	configOverrides
protected String	configPath
protected ConfigurationSourceProvider	configSourceProvider
protected C	configuration
protected String	customPropertyPrefix
protected Environment	environment
protected boolean	explicitConfig Flag that indicates whether instance was constructed with an explicit Configuration object or not; handling of the two cases differ.
protected org.eclipse.jetty.server.Server	jettyServer
protected List<DropwizardTestSupport.ServiceListener<C>>	listeners

Constructor Summary

Constructors

Constructor and Description
DropwizardTestSupport(Class<? extends Application<C>> applicationClass, C configuration) Alternative constructor that may be used to directly provide Configuration to use, instead of specifying resource path for locating data to create Configuration.
DropwizardTestSupport(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.
DropwizardTestSupport(Class<? extends Application<C>> applicationClass, String configPath, ConfigOverride... configOverrides)
DropwizardTestSupport(Class<? extends Application<C>> applicationClass, String configPath, ConfigurationSourceProvider configSourceProvider, ConfigOverride... configOverrides)
DropwizardTestSupport(Class<? extends Application<C>> applicationClass, String configPath, ConfigurationSourceProvider configSourceProvider, String customPropertyPrefix, ConfigOverride... configOverrides)
DropwizardTestSupport(Class<? extends Application<C>> applicationClass, String configPath, ConfigurationSourceProvider configSourceProvider, String customPropertyPrefix, Function<Application<C>,Command> commandInstantiator, ConfigOverride... configOverrides)
DropwizardTestSupport(Class<? extends Application<C>> applicationClass, String configPath, Optional<String> customPropertyPrefix, ConfigOverride... configOverrides) Deprecated. Use DropwizardTestSupport(Class, String, String, ConfigOverride...) instead.
DropwizardTestSupport(Class<? extends Application<C>> applicationClass, String configPath, Optional<String> customPropertyPrefix, Function<Application<C>,Command> commandInstantiator, ConfigOverride... configOverrides) Deprecated. Use DropwizardTestSupport(Class, String, String, Function, ConfigOverride...) instead.
DropwizardTestSupport(Class<? extends Application<C>> applicationClass, String configPath, String customPropertyPrefix, ConfigOverride... configOverrides)
DropwizardTestSupport(Class<? extends Application<C>> applicationClass, String configPath, String customPropertyPrefix, Function<Application<C>,Command> commandInstantiator, ConfigOverride... configOverrides)

Method Summary

Modifier and Type	Method and Description
DropwizardTestSupport<C>	addListener(DropwizardTestSupport.ServiceListener<C> listener)
void	after()
void	before()
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>	manage(Managed managed)
Application<C>	newApplication()

Methods inherited from class java.lang.Object

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

Field Detail

applicationClass

protected final Class<? extends Application<C extends Configuration>> applicationClass

configPath

@Nullable
protected final String configPath

configSourceProvider

@Nullable
protected final ConfigurationSourceProvider configSourceProvider

configOverrides

protected final Set<ConfigOverride> configOverrides

customPropertyPrefix

@Nullable
protected final String customPropertyPrefix

commandInstantiator

protected final Function<Application<C extends Configuration>,Command> commandInstantiator

explicitConfig

protected final boolean explicitConfig

Flag that indicates whether instance was constructed with an explicit Configuration object or not; handling of the two cases differ. Needed because state of configuration changes during lifecycle.

configuration

@Nullable
protected C extends Configuration configuration

application

@Nullable
protected Application<C extends Configuration> application

environment

@Nullable
protected Environment environment

jettyServer

@Nullable
protected org.eclipse.jetty.server.Server jettyServer

listeners

protected List<DropwizardTestSupport.ServiceListener<C extends Configuration>> listeners

Constructor Detail

DropwizardTestSupport

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

DropwizardTestSupport

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

Since:

2.0

DropwizardTestSupport

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

Deprecated. Use DropwizardTestSupport(Class, String, String, ConfigOverride...) instead.

DropwizardTestSupport

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

Since:

2.0

DropwizardTestSupport

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

Since:

2.0

DropwizardTestSupport

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

Deprecated. Use DropwizardTestSupport(Class, String, String, Function, ConfigOverride...) instead.

DropwizardTestSupport

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

Since:

2.0

DropwizardTestSupport

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

Since:

2.0

DropwizardTestSupport

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

Alternative constructor that may be used to directly provide Configuration to use, instead of specifying resource path for locating data to create Configuration.

Parameters:

applicationClass - Type of Application to create

configuration - Pre-constructed configuration object caller provides; will not be manipulated in any way, no overriding

Since:

0.9

DropwizardTestSupport

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

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

Parameters:

applicationClass - Type of Application to create

configuration - Pre-constructed configuration object caller provides; will not be manipulated in any way, no overriding

commandInstantiator - The Function used to instantiate the Command used to start the Application

Since:

1.1.0

Method Detail

addListener

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

manage

public DropwizardTestSupport<C> manage(Managed managed)

before

public void before()
            throws Exception

Throws:

Exception

after

public void after()

getConfiguration

public C getConfiguration()

getLocalPort

public int getLocalPort()

getAdminPort

public int getAdminPort()

getPort

public int getPort(int connectorIndex)

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()