org.yarnandtail.andhow.testutil

Class AndHowTestUtils

java.lang.Object

org.yarnandtail.andhow.testutil.AndHowTestUtils

public final class AndHowTestUtils
extends Object

A testing utility class that allows you to 'break the rules' of AndHow.

THIS CLASS CAN DO DANGEROUS THINGS THAT SHOULD NEVER BE DONE NEAR APPLICATION CODE

In production, AndHow is singleton that is only initialized once. Application code depends on that behaviour because it assumes that its basic configuration does not change. If it seems like you need to use the utilities here in production - STOP - you are doing it wrong. See the AndHow documentation and usage examples instead.

The methods in this class are generally not needed (directly) for testing. They are used by JUnit extensions that use them in a controlled and predictable way so that your application is configured correctly during testing. Many of methods in this class are used in the testing of the AndHow framework itself, thus, it has no dependency on AndHow and many methods take and return 'Object' types rather than specific AndHow classes.

For examples using JUnit extensions and annotations, see the AndHow Sample Usages module and its many sub-modules, which are stand-alone simulated projects complete with testing.

Method Summary

Modifier and Type	Method and Description
static Object	getAndHow() The current AndHow singleton instance, without forcing its creation.
static Class<?>	getAndHowClass() Get the Class of AndHow - needed since this module has no AndHow dependency.
static Class<?>	getAndHowConfigurationClass() Get the Class of AndHowConfiguration - needed since this module has no AndHow dependency.
static Object	getAndHowCore() The current AndHow singleton's 'Core' object.
static Class<?>	getAndHowCoreClass() Get the Class of AndHowCore - needed since this module has no AndHow dependency.
static ThreadLocal<Boolean>	getFindingConfig() The AndHow 'findingConfig' flag, which indicates that AndHow is search for its configuration and blocks reentrent loops.
static Object	invokeAndHowInstance() Invoke AndHow.instance(), returning an AndHow instance and forcing initiation if AndHow is not already initiated.
static void	killAndHowFully() Kill AndHow to ground state, as it would be prior to any initialization.
static <T> T	setAndHow(T newAndHow) Set the AndHow singleton instance and return the previous one.
static <T> UnaryOperator<T>	setAndHowConfigLocator(UnaryOperator<T> newLocator) Set a locator to find AndHowConfiguration.
static <T> T	setAndHowCore(T newCore) Set the AndHow 'Core'.
static <T> T	setAndHowInitialization(T newInit) Force AndHow.Initialization (its debug info about initialization) to a new value.
static Boolean	setAndHowInitializing(Boolean newInitializingStatus) Force the AndHow 'initializing flag' - If true, AndHow is in the process of initialization.
static <T> T	setAndHowInProcessConfig(T newConfig) Forces the AndHow inProcessConfig to a new value.

Methods inherited from class java.lang.Object

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

Method Detail

killAndHowFully

public static void killAndHowFully()

Kill AndHow to ground state, as it would be prior to any initialization. Don't use this method to test application code - It will break your tests! This method is only for testing the AndHow framework itself, not application code.

invokeAndHowInstance

public static Object invokeAndHowInstance()

Invoke AndHow.instance(), returning an AndHow instance and forcing initiation if AndHow is not already initiated. See AndHow.instance(). Since this module has no dependency on AndHow, the return type of Object.

Returns:

The current AndHow instance, or null if it is uninitiated.

getAndHow

public static Object getAndHow()

The current AndHow singleton instance, without forcing its creation. Since this module has no dependency on AndHow, the return type of Object.

Returns:

The current AndHow instance, or null if it is uninitiated.

setAndHow

public static <T> T setAndHow(T newAndHow)

Set the AndHow singleton instance and return the previous one. Don't use this method to test application code - It will break your tests! This method is only for testing the AndHow framework itself, not application code.

Since this module has no dependency on AndHow, the return and arg types are 'Object'.

Type Parameters:

T - implicitly passed type of the instance, which must be type AndHow.

Parameters:

newAndHow - An AndHow instance to use as the current singleton instance, which may be null, but must be of type AndHow.

Returns:

The previous AndHow instance, which may be null. If null is passed, the return value will need to be cast.

getAndHowCore

public static Object getAndHowCore()

The current AndHow singleton's 'Core' object. Since this module has no dependency on AndHow, the return type is 'Object'.

Returns:

The AndHow 'Core', which may be null.

setAndHowCore

public static <T> T setAndHowCore(T newCore)

Set the AndHow 'Core'. This method is relatively safe for use in application testing and is used by the Junit extensions and annotations to set configurations for individual tests. Note: This method will fail is AndHow is uninitialized.

Type Parameters:

T - implicitly passed type of the core which must be type AndHowCore.

Parameters:

newCore - The new core to assign to the AndHow singleton which may be null but must be of type AndHowCore.

Returns:

The old core, which may be null. If passing a null core, calling code will need to cast the result.

setAndHowInitialization

public static <T> T setAndHowInitialization(T newInit)

Force AndHow.Initialization (its debug info about initialization) to a new value.

Type Parameters:

T - implicitly passed type of the newInit which must be type AndHow.Initialization.

Parameters:

newInit - The new initialization to assign which may be null, but must be of type AndHow.Initialization.

Returns:

The original value, which may have been null. If null is passed, the return value will need to be cast.

setAndHowConfigLocator

public static <T> UnaryOperator<T> setAndHowConfigLocator(UnaryOperator<T> newLocator)

Set a locator to find AndHowConfiguration. The locator is used in AndHow.findConfig(). If no config exists, the normal path is for AndHow to call AndHowUtil.findConfiguration(c), however, if a locator is set to nonnull, it will be used instead.

The locator takes a default Configuration to return if a configuration cannot be found otherwise. See org.yarnandtail.AndHow#findConfig() for details.

Example setting to a custom locator:

 setAndHowConfigLocator(c -> return MyConfig); 

Example setting back to null:

 setAndHowConfigLocator(null); 

If this is set to some custom value for testing, it must be set back to null or future initialization will use the custom locator.

Type Parameters:

T - implicit type of the newLocator, which must be UnaryOperator<AndHowConfiguration<? extends AndHowConfiguration>>

Parameters:

newLocator - The new locator to use, which may be null, but must be of type UnaryOperator<AndHowConfiguration<? extends AndHowConfiguration>>

Returns:

The original locator, which may have been null. If null was passed, the return value will need to be cast.

setAndHowInProcessConfig

public static <T> T setAndHowInProcessConfig(T newConfig)

Forces the AndHow inProcessConfig to a new value. This is the config being built prior to initialization.

Type Parameters:

T - The implicit type, which must be of type AndHowConfiguration<? extends AndHowConfiguration>

Parameters:

newConfig - The new configuration to have in-process, which may be null, but must be of type AndHowConfiguration<? extends AndHowConfiguration>

Returns:

The original in-process configuration, which may have been null. If null is passed, the return value will need to be cast.

setAndHowInitializing

public static Boolean setAndHowInitializing(Boolean newInitializingStatus)

Force the AndHow 'initializing flag' - If true, AndHow is in the process of initialization.

Parameters:

newInitializingStatus - non-null boolean value.

Returns:

The original value.

getFindingConfig

public static ThreadLocal<Boolean> getFindingConfig()

The AndHow 'findingConfig' flag, which indicates that AndHow is search for its configuration and blocks reentrent loops. Setting and inspecting this flag is only needed for testing the AndHow framework itself. It is not needed for testing application code.

Returns:

The finding Config flag value.

getAndHowClass

public static Class<?> getAndHowClass()

Get the Class of AndHow - needed since this module has no AndHow dependency.

Returns:

Class of AndHow

getAndHowCoreClass

public static Class<?> getAndHowCoreClass()

Get the Class of AndHowCore - needed since this module has no AndHow dependency.

Returns:

Class of AndHowCore

getAndHowConfigurationClass

public static Class<?> getAndHowConfigurationClass()

Get the Class of AndHowConfiguration - needed since this module has no AndHow dependency.

Returns:

Class of AndHowConfiguration