org.springframework.test.web.servlet.client.AbstractMockMvcServerSpec Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spring-test Show documentation
Spring TestContext Framework
There is a newer version: 6.1.13
/*
 * Copyright 2002-2021 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.test.web.servlet.client;

import jakarta.servlet.Filter;

import org.springframework.http.client.reactive.ClientHttpConnector;
import org.springframework.test.web.reactive.server.WebTestClient;
import org.springframework.test.web.servlet.DispatcherServletCustomizer;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.RequestBuilder;
import org.springframework.test.web.servlet.ResultMatcher;
import org.springframework.test.web.servlet.setup.ConfigurableMockMvcBuilder;
import org.springframework.test.web.servlet.setup.MockMvcConfigurer;

/**
 * Base class for implementations of {@link MockMvcWebTestClient.MockMvcServerSpec}
 * that simply delegates to a {@link ConfigurableMockMvcBuilder} supplied by
 * the concrete subclasses.
 *
 * @author Rossen Stoyanchev
 * @since 5.3
 * @param  the type of the concrete subclass spec
 */
abstract class AbstractMockMvcServerSpec>
		implements MockMvcWebTestClient.MockMvcServerSpec {

	@Override
	public  T filters(Filter... filters) {
		getMockMvcBuilder().addFilters(filters);
		return self();
	}

	@Override
	public final  T filter(Filter filter, String... urlPatterns) {
		getMockMvcBuilder().addFilter(filter, urlPatterns);
		return self();
	}

	@Override
	public  T defaultRequest(RequestBuilder requestBuilder) {
		getMockMvcBuilder().defaultRequest(requestBuilder);
		return self();
	}

	@Override
	public  T alwaysExpect(ResultMatcher resultMatcher) {
		getMockMvcBuilder().alwaysExpect(resultMatcher);
		return self();
	}

	@Override
	public  T dispatchOptions(boolean dispatchOptions) {
		getMockMvcBuilder().dispatchOptions(dispatchOptions);
		return self();
	}

	@Override
	public  T dispatcherServletCustomizer(DispatcherServletCustomizer customizer) {
		getMockMvcBuilder().addDispatcherServletCustomizer(customizer);
		return self();
	}

	@Override
	public  T apply(MockMvcConfigurer configurer) {
		getMockMvcBuilder().apply(configurer);
		return self();
	}

	@SuppressWarnings("unchecked")
	private  T self() {
		return (T) this;
	}

	/**
	 * Return the concrete {@link ConfigurableMockMvcBuilder} to delegate
	 * configuration methods and to use to create the {@link MockMvc}.
	 */
	protected abstract ConfigurableMockMvcBuilder getMockMvcBuilder();

	@Override
	public WebTestClient.Builder configureClient() {
		MockMvc mockMvc = getMockMvcBuilder().build();
		ClientHttpConnector connector = new MockMvcHttpConnector(mockMvc);
		return WebTestClient.bindToServer(connector);
	}

	@Override
	public WebTestClient build() {
		return configureClient().build();
	}

}