Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Turn registered controller classes into controller instances on the fly

Browse Source 
Issue: SPR-16520
This commit is contained in:
Juergen Hoeller
2018-02-25 14:29:44 +01:00
parent 85984f3b72
commit 01d9475bcc
8 changed files with 72 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
spring-test/src/main/java/org/springframework/test/web/reactive/server/DefaultControllerSpec.java
View File

@@ -17,10 +17,10 @@
package org.springframework.test.web.reactive.server;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.function.Consumer;
import org.springframework.beans.BeanUtils;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.format.FormatterRegistry;
@@ -56,21 +56,24 @@ class DefaultControllerSpec extends AbstractMockServerSpec<WebTestClient.Control
DefaultControllerSpec(Object... controllers) {
Assert.isTrue(!ObjectUtils.isEmpty(controllers), "At least one controller is required");
Assert.isTrue(checkInstances(controllers), "Controller instances are required");
this.controllers = Arrays.asList(controllers);
this.controllers = instantiateIfNecessary(controllers);
}
private static List<Object> instantiateIfNecessary(Object[] specified) {
List<Object> instances = new ArrayList<>(specified.length);
for (Object obj : specified) {
instances.add(obj instanceof Class ? BeanUtils.instantiateClass((Class<?>) obj) : obj);
}
return instances;
}
@Override
public DefaultControllerSpec controllerAdvice(Object... controllerAdvice) {
Assert.isTrue(checkInstances(controllerAdvice), "ControllerAdvice instances are required");
this.controllerAdvice.addAll(Arrays.asList(controllerAdvice));
public DefaultControllerSpec controllerAdvice(Object... controllerAdvices) {
this.controllerAdvice.addAll(instantiateIfNecessary(controllerAdvices));
return this;
}
private boolean checkInstances(Object[] objects) {
return Arrays.stream(objects).noneMatch(Class.class::isInstance);
}
@Override
public DefaultControllerSpec contentTypeResolver(Consumer<RequestedContentTypeResolverBuilder> consumer) {
this.configurer.contentTypeResolverConsumer = consumer;

8
spring-test/src/main/java/org/springframework/test/web/reactive/server/WebTestClient.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -168,6 +168,7 @@ public interface WebTestClient {
* WebFlux application will be tested without an HTTP server using a mock
* request and response.
* @param controllers one or more controller instances to tests
* (specified {@code Class} will be turned into instance)
* @return chained API to customize server and client config; use
* {@link MockServerSpec#configureClient()} to transition to client config
*/
@@ -290,9 +291,8 @@ public interface WebTestClient {
interface ControllerSpec extends MockServerSpec<ControllerSpec> {
/**
* Register one or more
* {@link org.springframework.web.bind.annotation.ControllerAdvice
* ControllerAdvice} instances to be used in tests.
* Register one or more {@link org.springframework.web.bind.annotation.ControllerAdvice}
* instances to be used in tests (specified {@code Class} will be turned into instance).
*/
ControllerSpec controllerAdvice(Object... controllerAdvice);

7
spring-test/src/main/java/org/springframework/test/web/servlet/setup/MockMvcBuilders.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2015 the original author or authors.
* Copyright 2002-2018 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.
@@ -51,25 +51,22 @@ public class MockMvcBuilders {
* Build a {@link MockMvc} instance by registering one or more
* {@code @Controller} instances and configuring Spring MVC infrastructure
* programmatically.
*
* <p>This allows full control over the instantiation and initialization of
* controllers and their dependencies, similar to plain unit tests while
* also making it possible to test one controller at a time.
*
* <p>When this builder is used, the minimum infrastructure required by the
* {@link org.springframework.web.servlet.DispatcherServlet DispatcherServlet}
* to serve requests with annotated controllers is created automatically
* and can be customized, resulting in configuration that is equivalent to
* what MVC Java configuration provides except using builder-style methods.
*
* <p>If the Spring MVC configuration of an application is relatively
* straight-forward &mdash; for example, when using the MVC namespace in
* XML or MVC Java config &mdash; then using this builder might be a good
* option for testing a majority of controllers. In such cases, a much
* smaller number of tests can be used to focus on testing and verifying
* the actual Spring MVC configuration.
*
* @param controllers one or more {@code @Controller} instances to test
* (specified {@code Class} will be turned into instance)
*/
public static StandaloneMockMvcBuilder standaloneSetup(Object... controllers) {
return new StandaloneMockMvcBuilder(controllers);

38
spring-test/src/main/java/org/springframework/test/web/servlet/setup/StandaloneMockMvcBuilder.java
View File

@@ -26,6 +26,7 @@ import java.util.Map;
import java.util.function.Supplier;
import javax.servlet.ServletContext;
import org.springframework.beans.BeanUtils;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.BeanInitializationException;
import org.springframework.beans.factory.InitializingBean;
@@ -37,7 +38,6 @@ import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.lang.Nullable;
import org.springframework.mock.web.MockServletContext;
import org.springframework.util.Assert;
import org.springframework.util.ObjectUtils;
import org.springframework.util.PropertyPlaceholderHelper;
import org.springframework.util.PropertyPlaceholderHelper.PlaceholderResolver;
import org.springframework.util.StringValueResolver;
@@ -142,31 +142,31 @@ public class StandaloneMockMvcBuilder extends AbstractMockMvcBuilder<StandaloneM
* @see MockMvcBuilders#standaloneSetup(Object...)
*/
protected StandaloneMockMvcBuilder(Object... controllers) {
Assert.isTrue(!ObjectUtils.isEmpty(controllers), "At least one controller is required");
Assert.isTrue(checkInstances(controllers), "Controller instances are required");
this.controllers = Arrays.asList(controllers);
this.controllers = instantiateIfNecessary(controllers);
}
private static List<Object> instantiateIfNecessary(Object[] specified) {
List<Object> instances = new ArrayList<>(specified.length);
for (Object obj : specified) {
instances.add(obj instanceof Class ? BeanUtils.instantiateClass((Class<?>) obj) : obj);
}
return instances;
}
/**
* Register one or more
* {@link org.springframework.web.bind.annotation.ControllerAdvice
* ControllerAdvice} instances to be used in tests.
* <p>Normally {@code @ControllerAdvice} are auto-detected as long as they're
* declared as Spring beans. However since the standalone setup does not load
* any Spring configuration they need to be registered explicitly here
* instead much like controllers.
* Register one or more {@link org.springframework.web.bind.annotation.ControllerAdvice}
* instances to be used in tests (specified {@code Class} will be turned into instance).
* <p>Normally {@code @ControllerAdvice} are auto-detected as long as they're declared
* as Spring beans. However since the standalone setup does not load any Spring config,
* they need to be registered explicitly here instead much like controllers.
* @since 4.2
*/
public StandaloneMockMvcBuilder setControllerAdvice(Object... controllerAdvice) {
Assert.isTrue(checkInstances(controllerAdvice), "ControllerAdvice instances are required");
this.controllerAdvice = Arrays.asList(controllerAdvice);
this.controllerAdvice = instantiateIfNecessary(controllerAdvice);
return this;
}
private boolean checkInstances(Object[] objects) {
return Arrays.stream(objects).noneMatch(Class.class::isInstance);
}
/**
* Set the message converters to use in argument resolvers and in return value
* handlers, which support reading and/or writing to the body of the request
@@ -405,7 +405,7 @@ public class StandaloneMockMvcBuilder extends AbstractMockMvcBuilder<StandaloneM
private List<ViewResolver> initViewResolvers(WebApplicationContext wac) {
this.viewResolvers = (this.viewResolvers != null ? this.viewResolvers :
Collections.<ViewResolver>singletonList(new InternalResourceViewResolver()));
Collections.singletonList(new InternalResourceViewResolver()));
for (Object viewResolver : this.viewResolvers) {
if (viewResolver instanceof WebApplicationObjectSupport) {
((WebApplicationObjectSupport) viewResolver).setApplicationContext(wac);
@@ -546,7 +546,7 @@ public class StandaloneMockMvcBuilder extends AbstractMockMvcBuilder<StandaloneM
@Override
@Nullable
public View resolveViewName(String viewName, Locale locale) throws Exception {
public View resolveViewName(String viewName, Locale locale) {
return this.view;
}
}