001/*
002 * Copyright 2002-2016 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 *      https://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.test.context.web;
018
019import org.springframework.core.annotation.AnnotatedElementUtils;
020import org.springframework.test.context.ContextLoader;
021import org.springframework.test.context.MergedContextConfiguration;
022import org.springframework.test.context.TestContextBootstrapper;
023import org.springframework.test.context.support.DefaultTestContextBootstrapper;
024
025/**
026 * Web-specific implementation of the {@link TestContextBootstrapper} SPI.
027 *
028 * <ul>
029 * <li>Uses {@link WebDelegatingSmartContextLoader} as the default {@link ContextLoader}
030 * if the test class is annotated with {@link WebAppConfiguration @WebAppConfiguration}
031 * and otherwise delegates to the superclass.
032 * <li>Builds a {@link WebMergedContextConfiguration} if the test class is annotated
033 * with {@link WebAppConfiguration @WebAppConfiguration}.
034 * </ul>
035 *
036 * @author Sam Brannen
037 * @since 4.1
038 */
039public class WebTestContextBootstrapper extends DefaultTestContextBootstrapper {
040
041        /**
042         * Returns {@link WebDelegatingSmartContextLoader} if the supplied class is
043         * annotated with {@link WebAppConfiguration @WebAppConfiguration} and
044         * otherwise delegates to the superclass.
045         */
046        @Override
047        protected Class<? extends ContextLoader> getDefaultContextLoaderClass(Class<?> testClass) {
048                if (AnnotatedElementUtils.hasAnnotation(testClass, WebAppConfiguration.class)) {
049                        return WebDelegatingSmartContextLoader.class;
050                }
051                else {
052                        return super.getDefaultContextLoaderClass(testClass);
053                }
054        }
055
056        /**
057         * Returns a {@link WebMergedContextConfiguration} if the test class in the
058         * supplied {@code MergedContextConfiguration} is annotated with
059         * {@link WebAppConfiguration @WebAppConfiguration} and otherwise returns
060         * the supplied instance unmodified.
061         */
062        @Override
063        protected MergedContextConfiguration processMergedContextConfiguration(MergedContextConfiguration mergedConfig) {
064                WebAppConfiguration webAppConfiguration =
065                                AnnotatedElementUtils.findMergedAnnotation(mergedConfig.getTestClass(), WebAppConfiguration.class);
066                if (webAppConfiguration != null) {
067                        return new WebMergedContextConfiguration(mergedConfig, webAppConfiguration.value());
068                }
069                else {
070                        return mergedConfig;
                }
072        }
073
074}