org.springframework.boot.test.context.runner.WebApplicationContextRunner.java Source code

Introduction

Here is the source code for org.springframework.boot.test.context.runner.WebApplicationContextRunner.java

Source

/*
 * 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.context.runner;

import java.util.List;
import java.util.function.Supplier;

import org.springframework.boot.context.annotation.Configurations;
import org.springframework.boot.test.context.assertj.AssertableWebApplicationContext;
import org.springframework.boot.test.util.TestPropertyValues;
import org.springframework.boot.web.servlet.context.AnnotationConfigServletWebApplicationContext;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextInitializer;
import org.springframework.mock.web.MockServletContext;
import org.springframework.web.context.ConfigurableWebApplicationContext;
import org.springframework.web.context.WebApplicationContext;

/**
 * An {@link AbstractApplicationContextRunner ApplicationContext runner} for a Servlet
 * based {@link ConfigurableWebApplicationContext}.
 * <p>
 * See {@link AbstractApplicationContextRunner} for details.
 *
 * @author Andy Wilkinson
 * @author Stephane Nicoll
 * @author Phillip Webb
 * @since 2.0.0
 */
public final class WebApplicationContextRunner extends
        AbstractApplicationContextRunner<WebApplicationContextRunner, ConfigurableWebApplicationContext, AssertableWebApplicationContext> {

    /**
     * Create a new {@link WebApplicationContextRunner} instance using an
     * {@link AnnotationConfigServletWebApplicationContext} with a
     * {@link MockServletContext} as the underlying source.
     * @see #withMockServletContext(Supplier)
     */
    public WebApplicationContextRunner() {
        this(withMockServletContext(AnnotationConfigServletWebApplicationContext::new));
    }

    /**
     * Create a new {@link WebApplicationContextRunner} instance using the specified
     * {@code contextFactory} as the underlying source.
     * @param contextFactory a supplier that returns a new instance on each call
     */
    public WebApplicationContextRunner(Supplier<ConfigurableWebApplicationContext> contextFactory) {
        super(contextFactory);
    }

    private WebApplicationContextRunner(Supplier<ConfigurableWebApplicationContext> contextFactory,
            List<ApplicationContextInitializer<? super ConfigurableWebApplicationContext>> initializers,
            TestPropertyValues environmentProperties, TestPropertyValues systemProperties, ClassLoader classLoader,
            ApplicationContext parent, List<BeanRegistration<?>> beanRegistrations,
            List<Configurations> configurations) {
        super(contextFactory, initializers, environmentProperties, systemProperties, classLoader, parent,
                beanRegistrations, configurations);
    }

    @Override
    protected WebApplicationContextRunner newInstance(Supplier<ConfigurableWebApplicationContext> contextFactory,
            List<ApplicationContextInitializer<? super ConfigurableWebApplicationContext>> initializers,
            TestPropertyValues environmentProperties, TestPropertyValues systemProperties, ClassLoader classLoader,
            ApplicationContext parent, List<BeanRegistration<?>> beanRegistrations,
            List<Configurations> configurations) {
        return new WebApplicationContextRunner(contextFactory, initializers, environmentProperties,
                systemProperties, classLoader, parent, beanRegistrations, configurations);
    }

    /**
     * Decorate the specified {@code contextFactory} to set a {@link MockServletContext}
     * on each newly created {@link WebApplicationContext}.
     * @param contextFactory the context factory to decorate
     * @return an updated supplier that will set the {@link MockServletContext}
     */
    public static Supplier<ConfigurableWebApplicationContext> withMockServletContext(
            Supplier<ConfigurableWebApplicationContext> contextFactory) {
        return (contextFactory != null) ? () -> {
            ConfigurableWebApplicationContext context = contextFactory.get();
            context.setServletContext(new MockServletContext());
            return context;
        } : null;
    }

}