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.autoconfigure.jdbc;
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;
025
026import javax.sql.DataSource;
027
028import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
029import org.springframework.boot.jdbc.EmbeddedDatabaseConnection;
030import org.springframework.boot.test.autoconfigure.properties.PropertyMapping;
031import org.springframework.boot.test.autoconfigure.properties.SkipPropertyMapping;
032
033/**
034 * Annotation that can be applied to a test class to configure a test database to use
035 * instead of any application defined or auto-configured {@link DataSource}.
036 *
037 * @author Phillip Webb
038 * @see TestDatabaseAutoConfiguration
039 */
040@Target({ ElementType.TYPE, ElementType.METHOD })
041@Retention(RetentionPolicy.RUNTIME)
042@Documented
043@Inherited
044@ImportAutoConfiguration
045@PropertyMapping("spring.test.database")
046public @interface AutoConfigureTestDatabase {
047
048        /**
049         * Determines what type of existing DataSource beans can be replaced.
050         * @return the type of existing DataSource to replace
051         */
052        @PropertyMapping(skip = SkipPropertyMapping.ON_DEFAULT_VALUE)
053        Replace replace() default Replace.ANY;
054
055        /**
056         * The type of connection to be established when {@link #replace() replacing} the data
057         * source. By default will attempt to detect the connection based on the classpath.
058         * @return the type of connection to use
059         */
060        EmbeddedDatabaseConnection connection() default EmbeddedDatabaseConnection.NONE;
061
062        /**
063         * What the test database can replace.
064         */
065        enum Replace {
066
067                /**
068                 * Replace any DataSource bean (auto-configured or manually defined).
069                 */
070                ANY,
071
072                /**
073                 * Only replace auto-configured DataSource.
074                 */
075                AUTO_CONFIGURED,
076
077                /**
078                 * Don't replace the application default DataSource.
079                 */
080                NONE
081
082        }
083
084}