001/*
002 * Copyright 2012-2017 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.context;
018
019import java.lang.annotation.Documented;
020import java.lang.annotation.ElementType;
021import java.lang.annotation.Retention;
022import java.lang.annotation.RetentionPolicy;
023import java.lang.annotation.Target;
024
025import org.springframework.boot.SpringBootConfiguration;
026import org.springframework.context.annotation.Configuration;
027import org.springframework.core.annotation.AliasFor;
028
029/**
030 * {@link Configuration @Configuration} that can be used to define additional beans or
031 * customizations for a test. Unlike regular {@code @Configuration} classes the use of
032 * {@code @TestConfiguration} does not prevent auto-detection of
033 * {@link SpringBootConfiguration @SpringBootConfiguration}.
034 *
035 * @author Phillip Webb
036 * @since 1.4.0
037 * @see SpringBootTestContextBootstrapper
038 */
039@Target(ElementType.TYPE)
040@Retention(RetentionPolicy.RUNTIME)
041@Documented
042@Configuration
043@TestComponent
044public @interface TestConfiguration {
045
046        /**
047         * Explicitly specify the name of the Spring bean definition associated with this
048         * Configuration class. See {@link Configuration#value()} for details.
049         * @return the specified bean name, if any
050         */
051        @AliasFor(annotation = Configuration.class)
052        String value() default "";
053
054}