org.springframework.test.context

Annotation Type TestConstructor

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
 @Inherited
public @interface TestConstructor

@TestConstructor is a type-level annotation that is used to configure how the parameters of a test class constructor are autowired from components in the test's ApplicationContext.

If @TestConstructor is not present or meta-present on a test class, the default test constructor autowire mode will be used. See TEST_CONSTRUCTOR_AUTOWIRE_MODE_PROPERTY_NAME for details on how to change the default mode. Note, however, that a local declaration of @Autowired on a constructor takes precedence over both @TestConstructor and the default mode.

This annotation may be used as a meta-annotation to create custom composed annotations.

As of Spring Framework 5.2, this annotation is only supported in conjunction with the SpringExtension for use with JUnit Jupiter. Note that the SpringExtension is often automatically registered for you — for example, when using annotations such as @SpringJUnitConfig and @SpringJUnitWebConfig or various test-related annotations from Spring Boot Test.

As of Spring Framework 5.3, this annotation will be inherited from an enclosing test class by default. See @NestedTestConfiguration for details.

Since:

5.2

Author:

Sam Brannen

See Also:

@Autowired, SpringExtension, @SpringJUnitConfig, @SpringJUnitWebConfig, @ContextConfiguration, @ContextHierarchy, @ActiveProfiles, @TestPropertySource

Field Summary

Fields

Modifier and Type	Fields and Description
static String	TEST_CONSTRUCTOR_AUTOWIRE_MODE_PROPERTY_NAME JVM system property used to change the default test constructor autowire mode: "spring.test.constructor.autowire.mode".

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
TestConstructor.AutowireMode	autowireMode Flag for setting the test constructor autowire mode for the current test class.

Field Detail

TEST_CONSTRUCTOR_AUTOWIRE_MODE_PROPERTY_NAME

public static final String TEST_CONSTRUCTOR_AUTOWIRE_MODE_PROPERTY_NAME

JVM system property used to change the default test constructor autowire mode: "spring.test.constructor.autowire.mode".

Acceptable values include enum constants defined in TestConstructor.AutowireMode, ignoring case. For example, the default may be changed to TestConstructor.AutowireMode.ALL by supplying the following JVM system property via the command line.

-Dspring.test.constructor.autowire.mode=all

If the property is not set to ALL, parameters for test class constructors will be autowired according to TestConstructor.AutowireMode.ANNOTATED semantics by default.

May alternatively be configured via the SpringProperties mechanism.

As of Spring Framework 5.3, this property may also be configured as a JUnit Platform configuration parameter.

See Also:

autowireMode()

Element Detail

autowireMode

public abstract TestConstructor.AutowireMode autowireMode

Flag for setting the test constructor autowire mode for the current test class.

Setting this flag overrides the global default. See TEST_CONSTRUCTOR_AUTOWIRE_MODE_PROPERTY_NAME for details on how to change the global default.

Returns:

an TestConstructor.AutowireMode to take precedence over the global default

See Also:

TEST_CONSTRUCTOR_AUTOWIRE_MODE_PROPERTY_NAME, @Autowired, TestConstructor.AutowireMode.ALL, TestConstructor.AutowireMode.ANNOTATED