/* * Copyright 2002-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.web.filter; import java.util.Arrays; import java.util.Collections; import java.util.List; import java.util.Map; import org.junit.Before; import org.junit.Test; import org.springframework.http.HttpMethod; import org.springframework.mock.web.test.MockFilterChain; import org.springframework.mock.web.test.MockHttpServletRequest; import org.springframework.mock.web.test.MockHttpServletResponse; import static org.junit.Assert.assertArrayEquals; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertNotSame; import static org.junit.Assert.assertNull; import static org.junit.Assert.assertSame; /** * Test fixture for {@link FormContentFilter}. * * @author Rossen Stoyanchev */ public class FormContentFilterTests { private final FormContentFilter filter = new FormContentFilter(); private MockHttpServletRequest request; private MockHttpServletResponse response; private MockFilterChain filterChain; @Before public void setup() { this.request = new MockHttpServletRequest("PUT", "/"); this.request.setContentType("application/x-www-form-urlencoded; charset=ISO-8859-1"); this.response = new MockHttpServletResponse(); this.filterChain = new MockFilterChain(); } @Test public void wrapPutPatchAndDeleteOnly() throws Exception { for (HttpMethod method : HttpMethod.values()) { MockHttpServletRequest request = new MockHttpServletRequest(method.name(), "/"); request.setContent("foo=bar".getBytes("ISO-8859-1")); request.setContentType("application/x-www-form-urlencoded; charset=ISO-8859-1"); this.filterChain = new MockFilterChain(); this.filter.doFilter(request, this.response, this.filterChain); if (method == HttpMethod.PUT || method == HttpMethod.PATCH || method == HttpMethod.DELETE) { assertNotSame(request, this.filterChain.getRequest()); } else { assertSame(request, this.filterChain.getRequest()); } } } @Test public void wrapFormEncodedOnly() throws Exception { String[] contentTypes = new String[] {"text/plain", "multipart/form-data"}; for (String contentType : contentTypes) { MockHttpServletRequest request = new MockHttpServletRequest("PUT", "/"); request.setContent("".getBytes("ISO-8859-1")); request.setContentType(contentType); this.filterChain = new MockFilterChain(); this.filter.doFilter(request, this.response, this.filterChain); assertSame(request, this.filterChain.getRequest()); } } @Test public void invalidMediaType() throws Exception { this.request.setContent("".getBytes("ISO-8859-1")); this.request.setContentType("foo"); this.filterChain = new MockFilterChain(); this.filter.doFilter(this.request, this.response, this.filterChain); assertSame(this.request, this.filterChain.getRequest()); } @Test public void getParameter() throws Exception { this.request.setContent("name=value".getBytes("ISO-8859-1")); this.filter.doFilter(this.request, this.response, this.filterChain); assertEquals("value", this.filterChain.getRequest().getParameter("name")); } @Test public void getParameterFromQueryString() throws Exception { this.request.addParameter("name", "value1"); this.request.setContent("name=value2".getBytes("ISO-8859-1")); this.filter.doFilter(this.request, this.response, this.filterChain); assertNotSame("Request not wrapped", this.request, this.filterChain.getRequest()); assertEquals("Query string parameters should be listed ahead of form parameters", "value1", this.filterChain.getRequest().getParameter("name")); } @Test public void getParameterNullValue() throws Exception { this.request.setContent("name=value".getBytes("ISO-8859-1")); this.filter.doFilter(this.request, this.response, this.filterChain); assertNotSame("Request not wrapped", this.request, this.filterChain.getRequest()); assertNull(this.filterChain.getRequest().getParameter("noSuchParam")); } @Test public void getParameterNames() throws Exception { this.request.addParameter("name1", "value1"); this.request.addParameter("name2", "value2"); this.request.setContent("name1=value1&name3=value3&name4=value4".getBytes("ISO-8859-1")); this.filter.doFilter(this.request, this.response, this.filterChain); List<String> names = Collections.list(this.filterChain.getRequest().getParameterNames()); assertNotSame("Request not wrapped", this.request, this.filterChain.getRequest()); assertEquals(Arrays.asList("name1", "name2", "name3", "name4"), names); } @Test public void getParameterValues() throws Exception { this.request.setQueryString("name=value1&name=value2"); this.request.addParameter("name", "value1"); this.request.addParameter("name", "value2"); this.request.setContent("name=value3&name=value4".getBytes("ISO-8859-1")); this.filter.doFilter(this.request, this.response, this.filterChain); String[] values = this.filterChain.getRequest().getParameterValues("name"); assertNotSame("Request not wrapped", this.request, filterChain.getRequest()); assertArrayEquals(new String[] {"value1", "value2", "value3", "value4"}, values); } @Test public void getParameterValuesFromQueryString() throws Exception { this.request.setQueryString("name=value1&name=value2"); this.request.addParameter("name", "value1"); this.request.addParameter("name", "value2"); this.request.setContent("anotherName=anotherValue".getBytes("ISO-8859-1")); this.filter.doFilter(this.request, this.response, this.filterChain); String[] values = this.filterChain.getRequest().getParameterValues("name"); assertNotSame("Request not wrapped", this.request, this.filterChain.getRequest()); assertArrayEquals(new String[] {"value1", "value2"}, values); } @Test public void getParameterValuesFromFormContent() throws Exception { this.request.addParameter("name", "value1"); this.request.addParameter("name", "value2"); this.request.setContent("anotherName=anotherValue".getBytes("ISO-8859-1")); this.filter.doFilter(this.request, this.response, this.filterChain); String[] values = this.filterChain.getRequest().getParameterValues("anotherName"); assertNotSame("Request not wrapped", this.request, this.filterChain.getRequest()); assertArrayEquals(new String[] {"anotherValue"}, values); } @Test public void getParameterValuesInvalidName() throws Exception { this.request.addParameter("name", "value1"); this.request.addParameter("name", "value2"); this.request.setContent("anotherName=anotherValue".getBytes("ISO-8859-1")); this.filter.doFilter(this.request, this.response, this.filterChain); String[] values = this.filterChain.getRequest().getParameterValues("noSuchParameter"); assertNotSame("Request not wrapped", this.request, this.filterChain.getRequest()); assertNull(values); } @Test public void getParameterMap() throws Exception { this.request.setQueryString("name=value1&name=value2"); this.request.addParameter("name", "value1"); this.request.addParameter("name", "value2"); this.request.setContent("name=value3&name4=value4".getBytes("ISO-8859-1")); this.filter.doFilter(this.request, this.response, this.filterChain); Map<String, String[]> parameters = this.filterChain.getRequest().getParameterMap(); assertNotSame("Request not wrapped", this.request, this.filterChain.getRequest()); assertEquals(2, parameters.size()); assertArrayEquals(new String[] {"value1", "value2", "value3"}, parameters.get("name")); assertArrayEquals(new String[] {"value4"}, parameters.get("name4")); } @Test // SPR-15835 public void hiddenHttpMethodFilterFollowedByHttpPutFormContentFilter() throws Exception { this.request.addParameter("_method", "PUT"); this.request.addParameter("hiddenField", "testHidden"); this.filter.doFilter(this.request, this.response, this.filterChain); assertArrayEquals(new String[] {"testHidden"}, this.filterChain.getRequest().getParameterValues("hiddenField")); } }