org.springframework.boot.test.autoconfigure.graphql

Annotation Type GraphQlTest

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
 @Inherited
 @BootstrapWith(value=org.springframework.boot.test.autoconfigure.graphql.GraphQlTestContextBootstrapper.class)
 @ExtendWith(value=org.springframework.test.context.junit.jupiter.SpringExtension.class)
 @OverrideAutoConfiguration(enabled=false)
 @TypeExcludeFilters(value=GraphQlTypeExcludeFilter.class)
 @AutoConfigureCache
 @AutoConfigureJson
 @AutoConfigureGraphQl
 @AutoConfigureGraphQlTester
 @ImportAutoConfiguration
public @interface GraphQlTest

Annotation to perform GraphQL tests focusing on GraphQL request execution without a Web layer, and loading only a subset of the application configuration.

The annotation disables full auto-configuration and instead loads only components relevant to GraphQL tests, including the following:

• @Controller
• RuntimeWiringConfigurer
• @JsonComponent
• Converter
• GenericConverter

The annotation does not automatically load @Component, @Service, @Repository, and other beans.

By default, tests annotated with @GraphQlTest have a GraphQlTester configured. For more fine-grained control of the GraphQlTester, use @AutoConfigureGraphQlTester.

Typically @GraphQlTest is used in combination with @MockBean or @Import to load any collaborators and other components required for the tests.

To load your full application configuration instead and test via WebGraphQlTester, consider using @SpringBootTest combined with @AutoConfigureWebGraphQlTester.

Since:

2.7.0

Author:

Brian Clozel

See Also:

AutoConfigureGraphQlTester

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>[]	controllers Specifies the controllers to test.
Class<?>[]	excludeAutoConfiguration Auto-configuration exclusions that should be applied for this test.
ComponentScan.Filter[]	excludeFilters A set of exclude filters which can be used to filter beans that would otherwise be added to the application context.
ComponentScan.Filter[]	includeFilters A set of include filters which can be used to add otherwise filtered beans to the application context.
String[]	properties Properties in form key=value that should be added to the Spring Environment before the test runs.
boolean	useDefaultFilters Determines if default filtering should be used with @SpringBootApplication.
Class<?>[]	value Specifies the controllers to test.

Element Detail

properties

public abstract String[] properties

Properties in form key=value that should be added to the Spring Environment before the test runs.

Returns:

the properties to add

Default:

{}

value

@AliasFor(value="controllers")
public abstract Class<?>[] value

Specifies the controllers to test. This is an alias of controllers() which can be used for brevity if no other attributes are defined. See controllers() for details.

Returns:

the controllers to test

See Also:

controllers()

Default:

{}

controllers

@AliasFor(value="value")
public abstract Class<?>[] controllers

Specifies the controllers to test. May be left blank if all @Controller beans should be added to the application context.

Returns:

the controllers to test

See Also:

value()

Default:

{}

useDefaultFilters

public abstract boolean useDefaultFilters

Determines if default filtering should be used with @SpringBootApplication. By default, only @Controller (when no explicit controllers are defined), RuntimeWiringConfigurer, @JsonComponent, Converter, and GenericConverter beans are included.

Returns:

if default filters should be used

See Also:

includeFilters(), excludeFilters()

Default:

true

includeFilters

public abstract ComponentScan.Filter[] includeFilters

A set of include filters which can be used to add otherwise filtered beans to the application context.

Returns:

include filters to apply

Default:

{}

excludeFilters

public abstract ComponentScan.Filter[] excludeFilters

A set of exclude filters which can be used to filter beans that would otherwise be added to the application context.

Returns:

exclude filters to apply

Default:

{}

excludeAutoConfiguration

@AliasFor(annotation=ImportAutoConfiguration.class,
          attribute="exclude")
public abstract Class<?>[] excludeAutoConfiguration

Auto-configuration exclusions that should be applied for this test.

Returns:

auto-configuration exclusions to apply

Default:

{}