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

Class TestExtensionsTracker

java.lang.Object

ru.vyarus.dropwizard.guice.test.jupiter.ext.conf.TestExtensionsTracker

public class TestExtensionsTracker
extends java.lang.Object

Tracks registration of hooks and support objects during test initialization in order to log used additions (to simplify applied objects tracking). Also, tracks applied configuration overrides, but only after application start (the only way to show actually applied values).

Since:

27.05.2022

Field Summary

Fields

Modifier and Type	Field	Description
boolean	debug
static java.lang.String	DEBUG_ENABLED	Enabled value for GUICEY_EXTENSIONS_DEBUG system property.
protected java.util.List<java.lang.String>	extensionsSource
static java.lang.String	GUICEY_EXTENSIONS_DEBUG	System property enables debug output for all used guicey extensions.
protected java.util.List<java.lang.String>	hooksSource

Constructor Summary

Constructors

Constructor	Description
TestExtensionsTracker()

Method Summary

Modifier and Type	Method	Description
void	enableDebugFromSystemProperty()	In some cases it might be simpler to use system property to enable debug: -Dguicey.extensions.debug=true.
void	extensionClasses(java.lang.Class<? extends TestEnvironmentSetup>... exts)
void	extensionInstances(TestEnvironmentSetup... exts)
void	extensionsFromAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> ann, java.lang.Class<? extends TestEnvironmentSetup>... exts)
void	extensionsFromFields(java.util.List<java.lang.reflect.Field> fields, java.lang.Object instance)
void	hookClasses(java.lang.Class<? extends GuiceyConfigurationHook>... exts)
void	hookInstances(GuiceyConfigurationHook... exts)
void	hooksFromAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> ann, java.lang.Class<? extends GuiceyConfigurationHook>... exts)
void	hooksFromFields(java.util.List<java.lang.reflect.Field> fields, boolean baseHooks, java.lang.Object instance)
void	logOverriddenConfigs(java.lang.String configPrefix)	Logs overridden configurations.
void	logUsedHooksAndSetupObjects(java.lang.String configPrefix)	Logs registered setup objects and hooks.
void	setContextHook(java.lang.Class<? extends TestEnvironmentSetup> hook)

Methods inherited from class java.lang.Object

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

Field Detail

GUICEY_EXTENSIONS_DEBUG

public static final java.lang.String GUICEY_EXTENSIONS_DEBUG

System property enables debug output for all used guicey extensions.

See Also:

Constant Field Values

DEBUG_ENABLED

public static final java.lang.String DEBUG_ENABLED

Enabled value for GUICEY_EXTENSIONS_DEBUG system property.

See Also:

Constant Field Values

debug

public boolean debug

extensionsSource

protected final java.util.List<java.lang.String> extensionsSource

hooksSource

protected final java.util.List<java.lang.String> hooksSource

Constructor Detail

TestExtensionsTracker

public TestExtensionsTracker()

Method Detail

setContextHook

public void setContextHook(java.lang.Class<? extends TestEnvironmentSetup> hook)

extensionsFromFields

public final void extensionsFromFields(java.util.List<java.lang.reflect.Field> fields,
                                       java.lang.Object instance)

extensionsFromAnnotation

@SafeVarargs
public final void extensionsFromAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> ann,
                                           java.lang.Class<? extends TestEnvironmentSetup>... exts)

hooksFromFields

public final void hooksFromFields(java.util.List<java.lang.reflect.Field> fields,
                                  boolean baseHooks,
                                  java.lang.Object instance)

hooksFromAnnotation

@SafeVarargs
public final void hooksFromAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> ann,
                                      java.lang.Class<? extends GuiceyConfigurationHook>... exts)

extensionInstances

public final void extensionInstances(TestEnvironmentSetup... exts)

extensionClasses

@SafeVarargs
public final void extensionClasses(java.lang.Class<? extends TestEnvironmentSetup>... exts)

hookInstances

public final void hookInstances(GuiceyConfigurationHook... exts)

hookClasses

@SafeVarargs
public final void hookClasses(java.lang.Class<? extends GuiceyConfigurationHook>... exts)

enableDebugFromSystemProperty

public void enableDebugFromSystemProperty()

In some cases it might be simpler to use system property to enable debug: -Dguicey.extensions.debug=true.

logUsedHooksAndSetupObjects

public void logUsedHooksAndSetupObjects(java.lang.String configPrefix)

Logs registered setup objects and hooks. Do nothing if no setup objects or hooks registered.

Parameters:

configPrefix - configuration prefix

logOverriddenConfigs

public void logOverriddenConfigs(java.lang.String configPrefix)

Logs overridden configurations. Show values already applied to system properties.

Parameters:

configPrefix - configuration prefix