Package com.foreach.across.test.support

Class AcrossTestContextBuilder

java.lang.Object

com.foreach.across.test.support.AcrossTestContextBuilder

Direct Known Subclasses:

AcrossTestWebContextBuilder

public class AcrossTestContextBuilder
extends Object

Builder for creating an AcrossTestContext. This builder allows easy configuration of properties and modules to add to an AcrossTestContext.

Once build() has been called, the AcrossTestContext will be created and the internal AcrossContext bootstrapped.

Since:

1.1.2

Author:

Arne Vandamme

Constructor Summary

Constructors

Constructor	Description
AcrossTestContextBuilder()

Method Summary

Modifier and Type	Method	Description
AcrossTestContextBuilder	additionalModulePackageClasses(Class<?>... classes)	Type-safe alternative for additionalModulePackages(String...) where the packages of the classes will be added for module scanning.
AcrossTestContextBuilder	additionalModulePackages(String... packageNames)	Additional packages that should be scanned for modules if no custom ModuleDependencyResolver is configured.
protected Class<?>[]	annotatedClasses()
AcrossTestContext	build()	Creates the internal AcrossContext and bootstraps it.
protected void	configureApplicationContext(AcrossConfigurableApplicationContext applicationContext)
AcrossTestContextBuilder	configurer(AcrossContextConfigurer... configurer)	Add one or more AcrossContextConfigurer instances that are to be called after the initial AcrossContext has been created.
protected AcrossConfigurableApplicationContext	createDefaultApplicationContext()
protected AcrossTestContext	createTestContext(AcrossConfigurableApplicationContext applicationContext, AcrossContext context)
AcrossTestContextBuilder	dataSource(DataSource dataSource)	Set the core across datasource.
AcrossTestContextBuilder	developmentMode(boolean developmentMode)
AcrossTestContextBuilder	dropFirst(boolean dropFirst)	Should the database be reset before bootstrapping the AcrossContext.
AcrossTestContextBuilder	expose(Class<?>... classesToExpose)	Add one or more types (classes, interfaces, annotations) that should be exposed in this test context.
AcrossTestContextBuilder	installerDataSource(DataSource installerDataSource)	Set the installer datasource.
AcrossTestContextBuilder	moduleConfigurationPackageClasses(Class<?>... classes)	Type-safe alternative for moduleConfigurationPackages(String...).
AcrossTestContextBuilder	moduleConfigurationPackages(String... packageNames)	Add one or more custom packages that should be scanned for ModuleConfiguration classes.
AcrossTestContextBuilder	moduleDependencyResolver(ModuleDependencyResolver moduleDependencyResolver)	Set the ModuleDependencyResolver that should be used for looking up modules by name.
AcrossTestContextBuilder	modules(AcrossModule... modules)	Array of AcrossModule instances to add to the context.
AcrossTestContextBuilder	modules(String... moduleNames)	Array of AcrossModule names that should be configured.
AcrossTestContextBuilder	properties(Map<String,Object> properties)	Add a properties map to the environment of the parent ApplicationContext.
AcrossTestContextBuilder	properties(Properties properties)	Add a properties collection to the environment of the parent ApplicationContext.
AcrossTestContextBuilder	properties(org.springframework.core.env.PropertySource propertySource)	Add a PropertySource to the environment of the parent ApplicationContext.
AcrossTestContextBuilder	property(String key, Object value)	Set a property value on the environment of the parent ApplicationContext.
AcrossTestContextBuilder	register(Class<?>... annotatedClasses)	Add one or more annotated classes to the parent ApplicationContext that is attached to the AcrossContext.
AcrossTestContextBuilder	useTestDataSource(boolean useTestDataSource)	Should default test datasources be created.

Methods inherited from class java.lang.Object

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

Constructor Details

AcrossTestContextBuilder

public AcrossTestContextBuilder()

Method Details

dropFirst

public AcrossTestContextBuilder dropFirst(boolean dropFirst)

Should the database be reset before bootstrapping the AcrossContext. When true, this adds the ResetDatabaseConfigurer to the parent ApplicationContext. This is the default case.

Parameters:

dropFirst - true if datasource tables should be dropped before starting the context

Returns:

self

See Also:

• ResetDatabaseConfigurer

useTestDataSource

public AcrossTestContextBuilder useTestDataSource(boolean useTestDataSource)

Should default test datasources be created. This will use the datasource specified by the property acrossTest.datasource or create a memory HSQLDB if none is specified.

Using test datasource is the default. This is the equivalent to adding TestDataSourceConfigurer the the parent ApplicationContext.

Parameters:

useTestDataSource - true if test datasource should be created automatically

Returns:

self

See Also:

• TestDataSourceConfigurer

register

public AcrossTestContextBuilder register(Class<?>... annotatedClasses)

Add one or more annotated classes to the parent ApplicationContext that is attached to the AcrossContext.

Parameters:

annotatedClasses - list

Returns:

self

expose

public AcrossTestContextBuilder expose(Class<?>... classesToExpose)

Add one or more types (classes, interfaces, annotations) that should be exposed in this test context.

Parameters:

classesToExpose - list

Returns:

self

dataSource

public AcrossTestContextBuilder dataSource(DataSource dataSource)

Set the core across datasource. If no separate installerDataSource(DataSource) is configured, this datasource will also be used for installers. If neither datasource is configured, installers will be disabled.

Parameters:

dataSource - instance

Returns:

self

installerDataSource

public AcrossTestContextBuilder installerDataSource(DataSource installerDataSource)

Set the installer datasource.

Parameters:

installerDataSource - instance

Returns:

self

modules

public AcrossTestContextBuilder modules(String... moduleNames)

Array of AcrossModule names that should be configured. These will be resolved using the configured moduleDependencyResolver(ModuleDependencyResolver), before any configured module instances and before the AcrossContextConfigurer instances are called. If no ModuleDependencyResolver was set explicitly, the default will be used.

Subsequent calls will add modules.

Parameters:

moduleNames - names

Returns:

self

modules

public AcrossTestContextBuilder modules(AcrossModule... modules)

Array of AcrossModule instances to add to the context. These will be added after the modules added using modules(String...) have been resolved. Subsequent calls will add modules.

Parameters:

modules - collection

Returns:

self

moduleDependencyResolver

public AcrossTestContextBuilder moduleDependencyResolver(ModuleDependencyResolver moduleDependencyResolver)

Set the ModuleDependencyResolver that should be used for looking up modules by name. If none is set, a default ClassPathScanningModuleDependencyResolver will be used.

Parameters:

moduleDependencyResolver - instance

Returns:

self

See Also:

• ClassPathScanningModuleDependencyResolver

additionalModulePackages

public AcrossTestContextBuilder additionalModulePackages(String... packageNames)

Additional packages that should be scanned for modules if no custom ModuleDependencyResolver is configured. In case of a custom resolver, this setting will be ignored.

The default AcrossContextBuilder.STANDARD_MODULES_PACKAGE will always be added as the first one. If you do not want this, you should set a custom ModuleDependencyResolver using moduleDependencyResolver(ModuleDependencyResolver).

Subsequent calls will add additional packages.

Parameters:

packageNames - list

Returns:

self

See Also:

• moduleDependencyResolver(ModuleDependencyResolver)

additionalModulePackageClasses

public AcrossTestContextBuilder additionalModulePackageClasses(Class<?>... classes)

Type-safe alternative for additionalModulePackages(String...) where the packages of the classes will be added for module scanning. In case of a custom resolver, this setting will be ignored.

The default AcrossContextBuilder.STANDARD_MODULES_PACKAGE will always be added as the first one. If you do not want this, you should set a custom ModuleDependencyResolver using moduleDependencyResolver(ModuleDependencyResolver).

Subsequent calls will add additional packages.

Parameters:

classes - list

Returns:

self

moduleConfigurationPackages

public AcrossTestContextBuilder moduleConfigurationPackages(String... packageNames)

Add one or more custom packages that should be scanned for ModuleConfiguration classes. Subsequent calls will add additional packages.

Parameters:

packageNames - list

Returns:

self

moduleConfigurationPackageClasses

public AcrossTestContextBuilder moduleConfigurationPackageClasses(Class<?>... classes)

Type-safe alternative for moduleConfigurationPackages(String...).

Parameters:

classes - list

Returns:

self

developmentMode

public AcrossTestContextBuilder developmentMode(boolean developmentMode)

Parameters:

developmentMode - true if development mode should be active on the created context

Returns:

self

configurer

public AcrossTestContextBuilder configurer(AcrossContextConfigurer... configurer)

Add one or more AcrossContextConfigurer instances that are to be called after the initial AcrossContext has been created. Subsequent calls will add additional configurers.

Parameters:

configurer - one or more instances

Returns:

self

property

public AcrossTestContextBuilder property(String key,
 Object value)

Set a property value on the environment of the parent ApplicationContext.

Parameters:

key - property key

value - property value

Returns:

self

properties

public AcrossTestContextBuilder properties(Properties properties)

Add a properties collection to the environment of the parent ApplicationContext.

Parameters:

properties - instance

Returns:

self

properties

public AcrossTestContextBuilder properties(Map<String,Object> properties)

Add a properties map to the environment of the parent ApplicationContext.

Parameters:

properties - map

Returns:

self

properties

public AcrossTestContextBuilder properties(org.springframework.core.env.PropertySource propertySource)

Add a PropertySource to the environment of the parent ApplicationContext.

Parameters:

propertySource - instance

Returns:

self

build

public AcrossTestContext build()

Creates the internal AcrossContext and bootstraps it. Then wraps it in a AcrossTestContext instance that gives easy access to querying functionality.

Returns:

queryable context containing the bootstrapped AcrossContext

createTestContext

protected AcrossTestContext createTestContext(AcrossConfigurableApplicationContext applicationContext,
 AcrossContext context)

createDefaultApplicationContext

protected AcrossConfigurableApplicationContext createDefaultApplicationContext()

configureApplicationContext

protected void configureApplicationContext(AcrossConfigurableApplicationContext applicationContext)

annotatedClasses

protected Class<?>[] annotatedClasses()