Package org.springframework.modulith.test

Annotation Interface ApplicationModuleTest

@Target(TYPE)
@Documented
@Inherited
@Retention(RUNTIME)
@SpringBootTest
@TypeExcludeFilters(ModuleTypeExcludeFilter.class)
@ImportAutoConfiguration(ModuleTestAutoConfiguration.class)
@ExtendWith({PublishedEventsParameterResolver.class,ScenarioParameterResolver.class})
@TestInstance(PER_CLASS)
@TestConstructor(autowireMode=ALL)
public @interface ApplicationModuleTest

Bootstraps the module containing the package of the test class annotated with ApplicationModuleTest. Will apply the following modifications to the Spring Boot configuration:

• Restricts the component scanning to the module's package.
• Sets the module's package as the only auto-configuration and entity scan package.

Author:

Oliver Drotbohm

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ApplicationModuleTest.BootstrapMode

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Class<?>[]	classes	Alias for SpringBootTest.classes().
String[]	extraIncludes	Module names of modules to be included in the test run independent of what the mode() defines.
ApplicationModuleTest.BootstrapMode	mode
String	module	Logical name of the module to be bootstrapped in case ApplicationModuleTest will be used outside a module package
ApplicationModuleTest.BootstrapMode	value
boolean	verifyAutomatically	Whether to automatically verify the module structure for validity.
SpringBootTest.WebEnvironment	webEnvironment	The type of web environment to create when applicable.

Element Details

value

@AliasFor("mode")
ApplicationModuleTest.BootstrapMode value

Default:

STANDALONE

mode

@AliasFor("value")
ApplicationModuleTest.BootstrapMode mode

Default:

STANDALONE

verifyAutomatically

boolean verifyAutomatically

Whether to automatically verify the module structure for validity.

Returns:

Default:

true

extraIncludes

String[] extraIncludes

Module names of modules to be included in the test run independent of what the mode() defines.

Returns:

Default:

{}

module

String module

Logical name of the module to be bootstrapped in case ApplicationModuleTest will be used outside a module package

Returns:

will never be null.

Since:

1.3

Default:

""

classes

@AliasFor(annotation=org.springframework.boot.test.context.SpringBootTest.class)
Class<?>[] classes

Alias for SpringBootTest.classes(). Useful to define the main application class in case the test is located outside a module package and that class doesn't reside in any of the parent packages.

Returns:

will never be null.

Since:

1.3

See Also:

• module()

Default:

{}

webEnvironment

@AliasFor(annotation=org.springframework.boot.test.context.SpringBootTest.class)
SpringBootTest.WebEnvironment webEnvironment

The type of web environment to create when applicable. Defaults to SpringBootTest.WebEnvironment.MOCK.

Returns:

the type of web environment

Default:

MOCK