/*
 * Copyright 2012-2019 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.test.autoconfigure.web.reactive;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.junit.jupiter.api.extension.ExtendWith;

import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.test.autoconfigure.OverrideAutoConfiguration;
import org.springframework.boot.test.autoconfigure.core.AutoConfigureCache;
import org.springframework.boot.test.autoconfigure.filter.TypeExcludeFilters;
import org.springframework.boot.test.autoconfigure.json.AutoConfigureJson;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.mock.mockito.MockBean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Import;
import org.springframework.core.annotation.AliasFor;
import org.springframework.core.env.Environment;
import org.springframework.test.context.BootstrapWith;
import org.springframework.test.context.junit.jupiter.SpringExtension;
import org.springframework.test.web.reactive.server.WebTestClient;

Annotation that can be used for a Spring WebFlux test that focuses only on Spring WebFlux components.

Using this annotation will disable full auto-configuration and instead apply only configuration relevant to WebFlux tests (i.e. @Controller, @ControllerAdvice, @JsonComponent, Converter/GenericConverter, and WebFluxConfigurer beans but not @Component, @Service or @Repository beans).

By default, tests annotated with @WebFluxTest will also auto-configure a WebTestClient. For more fine-grained control of WebTestClient the @AutoConfigureWebTestClient annotation can be used.

Typically @WebFluxTest is used in combination with @MockBean or @Import to create any collaborators required by your @Controller beans.

If you are looking to load your full application configuration and use WebTestClient, you should consider @SpringBootTest combined with @AutoConfigureWebTestClient rather than this annotation.

When using JUnit 4, this annotation should be used in combination with @RunWith(SpringRunner.class).

Author:Stephane Nicoll, Artsiom Yudovin
See Also:
Since:2.0.0
/** * Annotation that can be used for a Spring WebFlux test that focuses * <strong>only</strong> on Spring WebFlux components. * <p> * Using this annotation will disable full auto-configuration and instead apply only * configuration relevant to WebFlux tests (i.e. {@code @Controller}, * {@code @ControllerAdvice}, {@code @JsonComponent}, * {@code Converter}/{@code GenericConverter}, and {@code WebFluxConfigurer} beans but not * {@code @Component}, {@code @Service} or {@code @Repository} beans). * <p> * By default, tests annotated with {@code @WebFluxTest} will also auto-configure a * {@link WebTestClient}. For more fine-grained control of WebTestClient the * {@link AutoConfigureWebTestClient @AutoConfigureWebTestClient} annotation can be used. * <p> * Typically {@code @WebFluxTest} is used in combination with {@link MockBean @MockBean} * or {@link Import @Import} to create any collaborators required by your * {@code @Controller} beans. * <p> * If you are looking to load your full application configuration and use WebTestClient, * you should consider {@link SpringBootTest @SpringBootTest} combined with * {@link AutoConfigureWebTestClient @AutoConfigureWebTestClient} rather than this * annotation. * <p> * When using JUnit 4, this annotation should be used in combination with * {@code @RunWith(SpringRunner.class)}. * * @author Stephane Nicoll * @author Artsiom Yudovin * @since 2.0.0 * @see AutoConfigureWebFlux * @see AutoConfigureWebTestClient */
@Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented @Inherited @BootstrapWith(WebFluxTestContextBootstrapper.class) @ExtendWith(SpringExtension.class) @OverrideAutoConfiguration(enabled = false) @TypeExcludeFilters(WebFluxTypeExcludeFilter.class) @AutoConfigureCache @AutoConfigureJson @AutoConfigureWebFlux @AutoConfigureWebTestClient @ImportAutoConfiguration public @interface WebFluxTest {
Properties in form key=value that should be added to the Spring Environment before the test runs.
Returns:the properties to add
Since:2.1.0
/** * Properties in form {@literal key=value} that should be added to the Spring * {@link Environment} before the test runs. * @return the properties to add * @since 2.1.0 */
String[] properties() default {};
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.
See Also:
Returns:the controllers to test
/** * Specifies the controllers to test. This is an alias of {@link #controllers()} which * can be used for brevity if no other attributes are defined. See * {@link #controllers()} for details. * @see #controllers() * @return the controllers to test */
@AliasFor("controllers") Class<?>[] value() default {};
Specifies the controllers to test. May be left blank if all @Controller beans should be added to the application context.
See Also:
Returns:the controllers to test
/** * Specifies the controllers to test. May be left blank if all {@code @Controller} * beans should be added to the application context. * @see #value() * @return the controllers to test */
@AliasFor("value") Class<?>[] controllers() default {};
Determines if default filtering should be used with @SpringBootApplication. By default only @Controller (when no explicit controllers are defined), @ControllerAdvice and WebFluxConfigurer beans are included.
See Also:
Returns:if default filters should be used
/** * Determines if default filtering should be used with * {@link SpringBootApplication @SpringBootApplication}. By default only * {@code @Controller} (when no explicit {@link #controllers() controllers} are * defined), {@code @ControllerAdvice} and {@code WebFluxConfigurer} beans are * included. * @see #includeFilters() * @see #excludeFilters() * @return if default filters should be used */
boolean useDefaultFilters() default true;
A set of include filters which can be used to add otherwise filtered beans to the application context.
Returns:include filters to apply
/** * A set of include filters which can be used to add otherwise filtered beans to the * application context. * @return include filters to apply */
ComponentScan.Filter[] includeFilters() default {};
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
/** * A set of exclude filters which can be used to filter beans that would otherwise be * added to the application context. * @return exclude filters to apply */
ComponentScan.Filter[] excludeFilters() default {};
Auto-configuration exclusions that should be applied for this test.
Returns:auto-configuration exclusions to apply
/** * Auto-configuration exclusions that should be applied for this test. * @return auto-configuration exclusions to apply */
@AliasFor(annotation = ImportAutoConfiguration.class, attribute = "exclude") Class<?>[] excludeAutoConfiguration() default {}; }