Package ru.vyarus.dropwizard.guice.test.jupiter.ext

Class TestDropwizardAppExtension.Builder<C extends io.dropwizard.core.Configuration>

java.lang.Object

ru.vyarus.dropwizard.guice.test.jupiter.ext.conf.ExtensionBuilder<C,TestDropwizardAppExtension.Builder<C>,ru.vyarus.dropwizard.guice.test.jupiter.ext.TestDropwizardAppExtension.Config>

ru.vyarus.dropwizard.guice.test.jupiter.ext.TestDropwizardAppExtension.Builder<C>

Type Parameters:

C - configuration type (resolved automatically by application class)

Enclosing class:

TestDropwizardAppExtension

public static class TestDropwizardAppExtension.Builder<C extends io.dropwizard.core.Configuration>
extends ExtensionBuilder<C,TestDropwizardAppExtension.Builder<C>,ru.vyarus.dropwizard.guice.test.jupiter.ext.TestDropwizardAppExtension.Config>

Builder used for manual extension registration (TestDropwizardAppExtension.forApp(Class)).

Field Summary

Fields inherited from class ru.vyarus.dropwizard.guice.test.jupiter.ext.conf.ExtensionBuilder

cfg

Constructor Summary

Constructors

Constructor	Description
Builder(Class<? extends io.dropwizard.core.Application<C>> app)	Create builder.

Method Summary

Modifier and Type	Method	Description
TestDropwizardAppExtension.Builder<C>	config(String configPath)	Same as TestDropwizardApp.config().
TestDropwizardAppExtension	create()	Creates extension.
TestDropwizardAppExtension.Builder<C>	randomPorts()	Shortcut for randomPorts(boolean).
TestDropwizardAppExtension.Builder<C>	randomPorts(boolean randomPorts)	Same as TestDropwizardApp.randomPorts().
TestDropwizardAppExtension.Builder<C>	restMapping(String mapping)	Same as TestDropwizardApp.restMapping().
final TestDropwizardAppExtension.Builder<C>	setup(Class<? extends TestEnvironmentSetup>... support)	Environment support object is the simplest way to prepare additional objects for test (like database) and apply configuration overrides.
TestDropwizardAppExtension.Builder<C>	setup(TestEnvironmentSetup... support)	Environment support objects is the simplest mechanism to prepare additional objects for test (like database) and apply configuration overrides.

Methods inherited from class ru.vyarus.dropwizard.guice.test.jupiter.ext.conf.ExtensionBuilder

apacheClient, clientFactory, config, configModifiers, configModifiers, configOverride, configOverride, configOverrideByExtension, configOverrideByExtension, configOverrides, configOverrides, debug, disableDefaultExtensions, hooks, hooks, injectOnce, reuseApplication, with

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(Class<? extends io.dropwizard.core.Application<C>> app)

Create builder.

Parameters:

app - application class

Method Details

config

public TestDropwizardAppExtension.Builder<C> config(String configPath)

Same as TestDropwizardApp.config().

Parameters:

configPath - configuration file path

Returns:

builder instance for chained calls

randomPorts

public TestDropwizardAppExtension.Builder<C> randomPorts(boolean randomPorts)

Same as TestDropwizardApp.randomPorts().

Parameters:

randomPorts - true to use random ports

Returns:

builder instance for chained calls

randomPorts

public TestDropwizardAppExtension.Builder<C> randomPorts()

Shortcut for randomPorts(boolean).

Returns:

builder instance for chained calls

restMapping

public TestDropwizardAppExtension.Builder<C> restMapping(String mapping)

Same as TestDropwizardApp.restMapping().

Parameters:

mapping - rest mapping path

Returns:

builder instance for chained calls

setup

@SafeVarargs
public final TestDropwizardAppExtension.Builder<C> setup(Class<? extends TestEnvironmentSetup>... support)

Environment support object is the simplest way to prepare additional objects for test (like database) and apply configuration overrides. Provided classes would be instantiated with the default constructor.

To avoid confusion with guicey hooks: setup object required to prepare test environment before test (and apply required configurations) whereas hooks is a general mechanism for application customization (not only in tests).

Anonymous implementation could be simply declared as field: @EnableSetup static TestEnvironmentSetup ext = ext -> ext.configOverrides("foo:1"). Non-static fields may be used only when extension is registered with non-static field (static fields would be also counted in this case). All annotated fields will be detected automatically and objects registered. Fields declared in base test classes are also counted.

Parameters:

support - support object classes

Returns:

builder instance for chained calls

setup

public TestDropwizardAppExtension.Builder<C> setup(TestEnvironmentSetup... support)

Environment support objects is the simplest mechanism to prepare additional objects for test (like database) and apply configuration overrides.

To avoid confusion with guicey hooks: setup object required to prepare test environment before test (and apply required configurations) whereas hooks is a general mechanism for application customization (not only in tests).

Anonymous implementation could be simply declared as field: @EnableSetup static TestEnvironmentSetup ext = ext -> ext.configOverrides("foo:1"). Non-static fields may be used only when extension is registered with non-static field (static fields would be also counted in this case). All annotated fields will be detected automatically and objects registered. Fields declared in base test classes are also counted.

Parameters:

support - support object instances

Returns:

builder instance for chained calls

create

public TestDropwizardAppExtension create()

Creates extension.

Note that extension must be assigned to static field! Extension instance does not provide additional methods so use field and parameter injections as with annotation extension declaration.

Returns:

extension instance