io.quarkus.test.junit

Interface QuarkusTestProfile

public interface QuarkusTestProfile

Defines a 'test profile'. Tests run under a test profile will have different configuration options to other tests.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	QuarkusTestProfile.TestResourceEntry

Method Summary

Modifier and Type	Method and Description
default boolean	disableApplicationLifecycleObservers() If this method returns true then all StartupEvent and ShutdownEvent observers declared on application beans should be disabled.
default boolean	disableGlobalTestResources() If this is returns true then only the test resources returned from testResources() will be started, global annotated test resources will be ignored.
default Map<String,String>	getConfigOverrides() Returns additional config to be applied to the test.
default String	getConfigProfile() Allows the default config profile to be overridden.
default Set<Class<?>>	getEnabledAlternatives() Returns enabled alternatives.
default Set<String>	tags() The tags this profile is associated with.
default List<QuarkusTestProfile.TestResourceEntry>	testResources() QuarkusTestResourceLifecycleManager classes (along with their init params) to be used from this specific test profile

Method Detail

getConfigOverrides

default Map<String,String> getConfigOverrides()

Returns additional config to be applied to the test. This will override any existing config (including in application.properties), however existing config will be merged with this (i.e. application.properties config will still take effect, unless a specific config key has been overridden).

getEnabledAlternatives

default Set<Class<?>> getEnabledAlternatives()

Returns enabled alternatives. This has the same effect as setting the 'quarkus.arc.selected-alternatives' config key, however it may be more convenient.

getConfigProfile

default String getConfigProfile()

Allows the default config profile to be overridden. This basically just sets the quarkus.test.profile system property before the test is run.

testResources

default List<QuarkusTestProfile.TestResourceEntry> testResources()

QuarkusTestResourceLifecycleManager classes (along with their init params) to be used from this specific test profile

disableGlobalTestResources

default boolean disableGlobalTestResources()

If this is returns true then only the test resources returned from testResources() will be started, global annotated test resources will be ignored.

tags

default Set<String> tags()

The tags this profile is associated with. When the quarkus.test.profile.tags System property is set (its value is a comma separated list of strings) then Quarkus will only execute tests that are annotated with a @TestProfile that has at least one of the supplied (via the aforementioned system property) tags.

disableApplicationLifecycleObservers

default boolean disableApplicationLifecycleObservers()

If this method returns true then all StartupEvent and ShutdownEvent observers declared on application beans should be disabled.