Package io.dropwizard.testing.junit5

Class DropwizardAppExtension<C extends io.dropwizard.core.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 io.dropwizard.core.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).

  • Constructor Details

    • DropwizardAppExtension

      public DropwizardAppExtension(Class<? extends io.dropwizard.core.Application<C>> applicationClass)

    • DropwizardAppExtension

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

    • DropwizardAppExtension

      public DropwizardAppExtension(Class<? extends io.dropwizard.core.Application<C>> applicationClass, @Nullable String configPath, io.dropwizard.configuration.ConfigurationSourceProvider configSourceProvider, ConfigOverride... configOverrides)
      Since:
      2.0

    • DropwizardAppExtension

      public DropwizardAppExtension(Class<? extends io.dropwizard.core.Application<C>> applicationClass, @Nullable String configPath, @Nullable String customPropertyPrefix, ConfigOverride... configOverrides)
      Since:
      2.0

    • DropwizardAppExtension

      public DropwizardAppExtension(Class<? extends io.dropwizard.core.Application<C>> applicationClass, @Nullable String configPath, io.dropwizard.configuration.ConfigurationSourceProvider configSourceProvider, @Nullable String customPropertyPrefix, ConfigOverride... configOverrides)
      Since:
      2.0

    • DropwizardAppExtension

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

    • DropwizardAppExtension

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

    • DropwizardAppExtension

      public DropwizardAppExtension(Class<? extends io.dropwizard.core.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 io.dropwizard.core.Application<C>> applicationClass, C configuration, Function<io.dropwizard.core.Application<C>,io.dropwizard.core.cli.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(io.dropwizard.lifecycle.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 io.dropwizard.core.Application<C> newApplication()

    • getApplication

      public <A extends io.dropwizard.core.Application<C>> A getApplication()

    • getEnvironment

      public io.dropwizard.core.setup.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()