001/*
002 * Copyright 2012-2018 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.boot.test.autoconfigure.web.reactive;
018
019import java.lang.annotation.Documented;
020import java.lang.annotation.ElementType;
021import java.lang.annotation.Inherited;
022import java.lang.annotation.Retention;
023import java.lang.annotation.RetentionPolicy;
024import java.lang.annotation.Target;
025import java.time.Duration;
026
027import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
028import org.springframework.boot.test.autoconfigure.properties.PropertyMapping;
029import org.springframework.test.web.reactive.server.WebTestClient;
030
031/**
032 * Annotation that can be applied to a test class to enable a {@link WebTestClient}. At
033 * the moment, only WebFlux applications are supported.
034 *
035 * @author Stephane Nicoll
036 * @since 2.0.0
037 * @see WebTestClientAutoConfiguration
038 */
039@Target({ ElementType.TYPE, ElementType.METHOD })
040@Retention(RetentionPolicy.RUNTIME)
041@Documented
042@Inherited
043@ImportAutoConfiguration
044@PropertyMapping("spring.test.webtestclient")
045public @interface AutoConfigureWebTestClient {
046
047        /**
048         * The timeout duration for the client (in any format handled by
049         * {@link Duration#parse(CharSequence)}).
050         * @return the web client timeout
051         */
052        String timeout() default "";
053
054}