/*
* Copyright 2002-2014 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
*
* http://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.web.servlet.mvc.method.annotation;
import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.Map;
import java.util.Optional;
import org.junit.Before;
import org.junit.Test;
import org.springframework.core.MethodParameter;
import org.springframework.core.convert.support.DefaultConversionService;
import org.springframework.mock.web.test.MockHttpServletRequest;
import org.springframework.tests.sample.beans.TestBean;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.support.ConfigurableWebBindingInitializer;
import org.springframework.web.bind.support.WebDataBinderFactory;
import org.springframework.web.context.request.NativeWebRequest;
import org.springframework.web.context.request.ServletWebRequest;
import org.springframework.web.method.support.ModelAndViewContainer;
import org.springframework.web.servlet.HandlerMapping;
import static org.junit.Assert.*;
/**
* Test fixture for {@link ServletModelAttributeMethodProcessor} specific tests.
* Also see org.springframework.web.method.annotation.support.ModelAttributeMethodProcessorTests
*
* @author Rossen Stoyanchev
*/
public class ServletModelAttributeMethodProcessorTests {
private ServletModelAttributeMethodProcessor processor;
private MethodParameter testBeanModelAttr;
private MethodParameter testBeanWithoutStringConstructorModelAttr;
private MethodParameter testBeanWithOptionalModelAttr;
private ModelAndViewContainer mavContainer;
private NativeWebRequest webRequest;
private MockHttpServletRequest request;
private WebDataBinderFactory binderFactory;
@Before
public void setUp() throws Exception {
this.processor = new ServletModelAttributeMethodProcessor(false);
Method method = getClass().getDeclaredMethod("modelAttribute",
TestBean.class, TestBeanWithoutStringConstructor.class, Optional.class);
this.testBeanModelAttr = new MethodParameter(method, 0);
this.testBeanWithoutStringConstructorModelAttr = new MethodParameter(method, 1);
this.testBeanWithOptionalModelAttr = new MethodParameter(method, 2);
ConfigurableWebBindingInitializer initializer = new ConfigurableWebBindingInitializer();
initializer.setConversionService(new DefaultConversionService());
this.binderFactory = new ServletRequestDataBinderFactory(null, initializer);
this.mavContainer = new ModelAndViewContainer();
this.request = new MockHttpServletRequest();
this.webRequest = new ServletWebRequest(request);
}
@Test
public void createAttributeUriTemplateVar() throws Exception {
Map<String, String> uriTemplateVars = new HashMap<String, String>();
uriTemplateVars.put("testBean1", "Patty");
this.request.setAttribute(HandlerMapping.URI_TEMPLATE_VARIABLES_ATTRIBUTE, uriTemplateVars);
// Type conversion from "Patty" to TestBean via TestBean(String) constructor
TestBean testBean =
(TestBean) this.processor.resolveArgument(
this.testBeanModelAttr, this.mavContainer, this.webRequest, this.binderFactory);
assertEquals("Patty", testBean.getName());
}
@Test
public void createAttributeUriTemplateVarCannotConvert() throws Exception {
Map<String, String> uriTemplateVars = new HashMap<String, String>();
uriTemplateVars.put("testBean2", "Patty");
request.setAttribute(HandlerMapping.URI_TEMPLATE_VARIABLES_ATTRIBUTE, uriTemplateVars);
TestBeanWithoutStringConstructor testBean =
(TestBeanWithoutStringConstructor) this.processor.resolveArgument(
this.testBeanWithoutStringConstructorModelAttr, this.mavContainer, this.webRequest, this.binderFactory);
assertNotNull(testBean);
}
@Test
public void createAttributeUriTemplateVarWithOptional() throws Exception {
Map<String, String> uriTemplateVars = new HashMap<String, String>();
uriTemplateVars.put("testBean3", "Patty");
this.request.setAttribute(HandlerMapping.URI_TEMPLATE_VARIABLES_ATTRIBUTE, uriTemplateVars);
// Type conversion from "Patty" to TestBean via TestBean(String) constructor
Optional<TestBean> testBean =
(Optional<TestBean>) this.processor.resolveArgument(
this.testBeanWithOptionalModelAttr, this.mavContainer, this.webRequest, this.binderFactory);
assertEquals("Patty", testBean.get().getName());
}
@Test
public void createAttributeRequestParameter() throws Exception {
this.request.addParameter("testBean1", "Patty");
// Type conversion from "Patty" to TestBean via TestBean(String) constructor
TestBean testBean =
(TestBean) this.processor.resolveArgument(
this.testBeanModelAttr, this.mavContainer, this.webRequest, this.binderFactory);
assertEquals("Patty", testBean.getName());
}
@Test
public void createAttributeRequestParameterCannotConvert() throws Exception {
this.request.addParameter("testBean2", "Patty");
TestBeanWithoutStringConstructor testBean =
(TestBeanWithoutStringConstructor) this.processor.resolveArgument(
this.testBeanWithoutStringConstructorModelAttr, this.mavContainer, this.webRequest, this.binderFactory);
assertNotNull(testBean);
}
@Test
public void createAttributeRequestParameterWithOptional() throws Exception {
this.request.addParameter("testBean3", "Patty");
Optional<TestBean> testBean =
(Optional<TestBean>) this.processor.resolveArgument(
this.testBeanWithOptionalModelAttr, this.mavContainer, this.webRequest, this.binderFactory);
assertEquals("Patty", testBean.get().getName());
}
@Test
public void attributesAsNullValues() throws Exception {
this.request.addParameter("name", "Patty");
this.mavContainer.getModel().put("testBean1", null);
this.mavContainer.getModel().put("testBean2", null);
this.mavContainer.getModel().put("testBean3", null);
assertNull(this.processor.resolveArgument(
this.testBeanModelAttr, this.mavContainer, this.webRequest, this.binderFactory));
assertNull(this.processor.resolveArgument(
this.testBeanWithoutStringConstructorModelAttr, this.mavContainer, this.webRequest, this.binderFactory));
Optional<TestBean> testBean =
(Optional<TestBean>) this.processor.resolveArgument(
this.testBeanWithOptionalModelAttr, this.mavContainer, this.webRequest, this.binderFactory);
assertFalse(testBean.isPresent());
}
@Test
public void attributesAsOptionalEmpty() throws Exception {
this.request.addParameter("name", "Patty");
this.mavContainer.getModel().put("testBean1", Optional.empty());
this.mavContainer.getModel().put("testBean2", Optional.empty());
this.mavContainer.getModel().put("testBean3", Optional.empty());
assertNull(this.processor.resolveArgument(
this.testBeanModelAttr, this.mavContainer, this.webRequest, this.binderFactory));
assertNull(this.processor.resolveArgument(
this.testBeanWithoutStringConstructorModelAttr, this.mavContainer, this.webRequest, this.binderFactory));
Optional<TestBean> testBean =
(Optional<TestBean>) this.processor.resolveArgument(
this.testBeanWithOptionalModelAttr, this.mavContainer, this.webRequest, this.binderFactory);
assertFalse(testBean.isPresent());
}
@SuppressWarnings("unused")
private void modelAttribute(@ModelAttribute("testBean1") TestBean testBean1,
@ModelAttribute("testBean2") TestBeanWithoutStringConstructor testBean2,
@ModelAttribute("testBean3") Optional<TestBean> testBean3) {
}
@SuppressWarnings("unused")
private static class TestBeanWithoutStringConstructor {
public TestBeanWithoutStringConstructor() {
}
public TestBeanWithoutStringConstructor(int i) {
}
}
}