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

Empty path mapping behaves consistently

Browse Source 
An empty path mapping in an @RequestMapping now consistently matches to
empty paths regardless of whether there are both type and method level,
annotations, or method-level only.

Closes gh-22543
This commit is contained in:
Rossen Stoyanchev
2019-04-09 15:03:24 -04:00
parent f839c1f9cd
commit d1f888a7a9
17 changed files with 96 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
spring-test/src/main/java/org/springframework/test/web/servlet/htmlunit/MockMvcWebConnection.java
View File

@@ -63,6 +63,7 @@ public final class MockMvcWebConnection implements WebConnection {
private final MockMvc mockMvc;
@Nullable
private final String contextPath;
private WebClient webClient;
@@ -91,7 +92,7 @@ public final class MockMvcWebConnection implements WebConnection {
* @param webClient the {@link WebClient} to use (never {@code null})
* @param contextPath the contextPath to use
*/
public MockMvcWebConnection(MockMvc mockMvc, WebClient webClient, String contextPath) {
public MockMvcWebConnection(MockMvc mockMvc, WebClient webClient, @Nullable String contextPath) {
Assert.notNull(mockMvc, "MockMvc must not be null");
Assert.notNull(webClient, "WebClient must not be null");
validateContextPath(contextPath);

4
spring-test/src/test/java/org/springframework/test/web/servlet/htmlunit/ForwardController.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* 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.
@@ -28,7 +28,7 @@ public class ForwardController {
@RequestMapping("/forward")
public String forward() {
return "forward:/";
return "forward:/a";
}
}

4
spring-test/src/test/java/org/springframework/test/web/servlet/htmlunit/HelloController.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* 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.
@@ -28,7 +28,7 @@ import org.springframework.web.bind.annotation.RestController;
@RestController
public class HelloController {
@RequestMapping
@RequestMapping("/a")
public String header(HttpServletRequest request) {
return "hello";
}

4
spring-test/src/test/java/org/springframework/test/web/servlet/htmlunit/MockMvcConnectionBuilderSupportTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* 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.
@@ -151,7 +151,7 @@ public class MockMvcConnectionBuilderSupportTests {
@RestController
static class ContextPathController {
@RequestMapping
@RequestMapping("/def")
public String contextPath(HttpServletRequest request) {
return request.getContextPath();
}

4
spring-test/src/test/java/org/springframework/test/web/servlet/htmlunit/MockMvcWebClientBuilderTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* 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.
@@ -157,7 +157,7 @@ public class MockMvcWebClientBuilderTests {
@RestController
static class ContextPathController {
@RequestMapping
@RequestMapping("/test")
public String contextPath(HttpServletRequest request) {
return "mvc";
}

22
spring-test/src/test/java/org/springframework/test/web/servlet/htmlunit/MockMvcWebConnectionTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* 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.
@@ -18,6 +18,7 @@ package org.springframework.test.web.servlet.htmlunit;
import java.io.IOException;
import com.gargoylesoftware.htmlunit.FailingHttpStatusCodeException;
import com.gargoylesoftware.htmlunit.Page;
import com.gargoylesoftware.htmlunit.WebClient;
import org.junit.Test;
@@ -44,7 +45,7 @@ public class MockMvcWebConnectionTests {
@Test
public void contextPathNull() throws IOException {
this.webClient.setWebConnection(new MockMvcWebConnection(this.mockMvc, this.webClient));
this.webClient.setWebConnection(new MockMvcWebConnection(this.mockMvc, this.webClient, null));
Page page = this.webClient.getPage("http://localhost/context/a");
assertThat(page.getWebResponse().getStatusCode(), equalTo(200));
}
@@ -59,8 +60,21 @@ public class MockMvcWebConnectionTests {
@Test
public void contextPathEmpty() throws IOException {
this.webClient.setWebConnection(new MockMvcWebConnection(this.mockMvc, this.webClient, ""));
Page page = this.webClient.getPage("http://localhost/context/a");
assertThat(page.getWebResponse().getStatusCode(), equalTo(200));
try {
this.webClient.getPage("http://localhost/context/a");
fail("Empty context path (root context) should not match to a URL with a context path");
}
catch (FailingHttpStatusCodeException ex) {
assertEquals(404, ex.getStatusCode());
}
this.webClient.setWebConnection(new MockMvcWebConnection(this.mockMvc, this.webClient));
try {
this.webClient.getPage("http://localhost/context/a");
fail("No context is the same providing an empty context path");
}
catch (FailingHttpStatusCodeException ex) {
assertEquals(404, ex.getStatusCode());
}
}
@Test

4
spring-test/src/test/java/org/springframework/test/web/servlet/htmlunit/webdriver/MockMvcHtmlUnitDriverBuilderTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* 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.
@@ -145,7 +145,7 @@ public class MockMvcHtmlUnitDriverBuilderTests {
@RestController
static class ContextPathController {
@RequestMapping
@RequestMapping("/test")
public String contextPath(HttpServletRequest request) {
return EXPECTED_BODY;
}

2
spring-test/src/test/java/org/springframework/test/web/servlet/samples/standalone/RedirectTests.java
View File

@@ -115,7 +115,7 @@ public class RedirectTests {
return "persons/index";
}
@PostMapping
@PostMapping("/persons")
public String save(@Valid Person person, Errors errors, RedirectAttributes redirectAttrs) {
if (errors.hasErrors()) {
return "persons/add";

19
spring-webflux/src/main/java/org/springframework/web/reactive/result/condition/PatternsRequestCondition.java
View File

@@ -16,9 +16,9 @@
package org.springframework.web.reactive.result.condition;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
@@ -29,6 +29,7 @@ import org.springframework.http.server.PathContainer;
import org.springframework.lang.Nullable;
import org.springframework.web.server.ServerWebExchange;
import org.springframework.web.util.pattern.PathPattern;
import org.springframework.web.util.pattern.PathPatternParser;
/**
* A logical disjunction (' || ') request condition that matches a request
@@ -40,6 +41,10 @@ import org.springframework.web.util.pattern.PathPattern;
*/
public final class PatternsRequestCondition extends AbstractRequestCondition<PatternsRequestCondition> {
private static final SortedSet<PathPattern> EMPTY_PATTERNS =
new TreeSet<>(Collections.singleton(new PathPatternParser().parse("")));
private final SortedSet<PathPattern> patterns;
@@ -55,7 +60,7 @@ public final class PatternsRequestCondition extends AbstractRequestCondition<Pat
* Creates a new instance with the given URL patterns.
*/
public PatternsRequestCondition(List<PathPattern> patterns) {
this(new TreeSet<>(patterns));
this(patterns.isEmpty() ? EMPTY_PATTERNS : new TreeSet<>(patterns));
}
@@ -89,8 +94,9 @@ public final class PatternsRequestCondition extends AbstractRequestCondition<Pat
*/
@Override
public PatternsRequestCondition combine(PatternsRequestCondition other) {
List<PathPattern> combined = new ArrayList<>();
SortedSet<PathPattern> combined;
if (!this.patterns.isEmpty() && !other.patterns.isEmpty()) {
combined = new TreeSet<>();
for (PathPattern pattern1 : this.patterns) {
for (PathPattern pattern2 : other.patterns) {
combined.add(pattern1.combine(pattern2));
@@ -98,10 +104,13 @@ public final class PatternsRequestCondition extends AbstractRequestCondition<Pat
}
}
else if (!this.patterns.isEmpty()) {
combined.addAll(this.patterns);
combined = this.patterns;
}
else if (!other.patterns.isEmpty()) {
combined.addAll(other.patterns);
combined = other.patterns;
}
else {
combined = EMPTY_PATTERNS;
}
return new PatternsRequestCondition(combined);
}

13
spring-webflux/src/test/java/org/springframework/web/reactive/result/condition/PatternsRequestConditionTests.java
View File

@@ -140,6 +140,19 @@ public class PatternsRequestConditionTests {
assertNull(match);
}
@Test // gh-22543
public void matchWithEmptyPatterns() {
PatternsRequestCondition condition = new PatternsRequestCondition();
assertEquals(new PatternsRequestCondition(this.parser.parse("")), condition);
assertNotNull(condition.getMatchingCondition(MockServerWebExchange.from(get(""))));
assertNull(condition.getMatchingCondition(MockServerWebExchange.from(get("/anything"))));
condition = condition.combine(new PatternsRequestCondition());
assertEquals(new PatternsRequestCondition(this.parser.parse("")), condition);
assertNotNull(condition.getMatchingCondition(MockServerWebExchange.from(get(""))));
assertNull(condition.getMatchingCondition(MockServerWebExchange.from(get("/anything"))));
}
@Test
public void compareToConsistentWithEquals() throws Exception {
PatternsRequestCondition c1 = createPatternsCondition("/foo*");

4
spring-webflux/src/test/java/org/springframework/web/reactive/result/condition/RequestMappingInfoTests.java
View File

@@ -34,6 +34,7 @@ import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.reactive.result.method.RequestMappingInfo;
import org.springframework.web.server.ServerWebExchange;
import org.springframework.web.util.pattern.PathPattern;
import org.springframework.web.util.pattern.PathPatternParser;
import org.springframework.web.util.pattern.PatternParseException;
import static java.util.Arrays.asList;
@@ -61,7 +62,8 @@ public class RequestMappingInfoTests {
public void createEmpty() {
RequestMappingInfo info = paths().build();
assertEquals(0, info.getPatternsCondition().getPatterns().size());
PathPattern emptyPattern = (new PathPatternParser()).parse("");
assertEquals(Collections.singleton(emptyPattern), info.getPatternsCondition().getPatterns());
assertEquals(0, info.getMethodsCondition().getMethods().size());
assertEquals(true, info.getConsumesCondition().isEmpty());
assertEquals(true, info.getProducesCondition().isEmpty());

12
spring-webflux/src/test/java/org/springframework/web/reactive/result/method/RequestMappingInfoHandlerMappingTests.java
View File

@@ -253,14 +253,12 @@ public class RequestMappingInfoHandlerMappingTests {
assertSame(handlerMethod, mapped);
}
@Test
@Test // gh-22543
public void handleMatchBestMatchingPatternAttributeNoPatternsDefined() {
RequestMappingInfo key = paths().build();
ServerWebExchange exchange = MockServerWebExchange.from(get("/1/2"));
this.handlerMapping.handleMatch(key, handlerMethod, exchange);
PathPattern bestMatch = (PathPattern) exchange.getAttributes().get(BEST_MATCHING_PATTERN_ATTRIBUTE);
assertEquals("/1/2", bestMatch.getPatternString());
ServerWebExchange exchange = MockServerWebExchange.from(get(""));
this.handlerMapping.handleMatch(paths().build(), handlerMethod, exchange);
PathPattern pattern = (PathPattern) exchange.getAttributes().get(BEST_MATCHING_PATTERN_ATTRIBUTE);
assertEquals("", pattern.getPatternString());
}
@Test

3
spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/condition/PatternsRequestCondition.java
View File

@@ -135,6 +135,9 @@ public final class PatternsRequestCondition extends AbstractRequestCondition<Pat
private static Set<String> prependLeadingSlash(Collection<String> patterns) {
if (patterns.isEmpty()) {
return Collections.singleton("");
}
Set<String> result = new LinkedHashSet<>(patterns.size());
for (String pattern : patterns) {
if (StringUtils.hasLength(pattern) && !pattern.startsWith("/")) {

17
spring-webmvc/src/test/java/org/springframework/web/servlet/mvc/condition/PatternsRequestConditionTests.java
View File

@@ -115,9 +115,7 @@ public class PatternsRequestConditionTests {
assertEquals("/{foo}", match.getPatterns().iterator().next());
}
// SPR-8410
@Test
@Test // SPR-8410
public void matchSuffixPatternUsingFileExtensions() {
String[] patterns = new String[] {"/jobs/{jobName}"};
List<String> extensions = Arrays.asList("json");
@@ -183,6 +181,19 @@ public class PatternsRequestConditionTests {
assertNull(match);
}
@Test // gh-22543
public void matchWithEmptyPatterns() {
PatternsRequestCondition condition = new PatternsRequestCondition();
assertEquals(new PatternsRequestCondition(""), condition);
assertNotNull(condition.getMatchingCondition(new MockHttpServletRequest("GET", "")));
assertNull(condition.getMatchingCondition(new MockHttpServletRequest("GET", "/anything")));
condition = condition.combine(new PatternsRequestCondition());
assertEquals(new PatternsRequestCondition(""), condition);
assertNotNull(condition.getMatchingCondition(new MockHttpServletRequest("GET", "")));
assertNull(condition.getMatchingCondition(new MockHttpServletRequest("GET", "/anything")));
}
@Test
public void compareEqualPatterns() {
PatternsRequestCondition c1 = new PatternsRequestCondition("/foo*");

12
spring-webmvc/src/test/java/org/springframework/web/servlet/mvc/method/RequestMappingInfoHandlerMappingTests.java
View File

@@ -295,14 +295,12 @@ public class RequestMappingInfoHandlerMappingTests {
assertEquals("/{path1}/2", request.getAttribute(HandlerMapping.BEST_MATCHING_PATTERN_ATTRIBUTE));
}
@Test
@Test // gh-22543
public void handleMatchBestMatchingPatternAttributeNoPatternsDefined() {
RequestMappingInfo key = RequestMappingInfo.paths().build();
MockHttpServletRequest request = new MockHttpServletRequest("GET", "/1/2");
this.handlerMapping.handleMatch(key, "/1/2", request);
assertEquals("/1/2", request.getAttribute(HandlerMapping.BEST_MATCHING_PATTERN_ATTRIBUTE));
String path = "";
MockHttpServletRequest request = new MockHttpServletRequest("GET", path);
this.handlerMapping.handleMatch(RequestMappingInfo.paths().build(), path, request);
assertEquals(path, request.getAttribute(HandlerMapping.BEST_MATCHING_PATTERN_ATTRIBUTE));
}
@Test

2
spring-webmvc/src/test/java/org/springframework/web/servlet/mvc/method/RequestMappingInfoTests.java
View File

@@ -49,7 +49,7 @@ public class RequestMappingInfoTests {
public void createEmpty() {
RequestMappingInfo info = paths().build();
assertEquals(0, info.getPatternsCondition().getPatterns().size());
assertEquals(Collections.singleton(""), info.getPatternsCondition().getPatterns()); // gh-22543
assertEquals(0, info.getMethodsCondition().getMethods().size());
assertEquals(true, info.getConsumesCondition().isEmpty());
assertEquals(true, info.getProducesCondition().isEmpty());

8
spring-webmvc/src/test/java/org/springframework/web/servlet/mvc/method/annotation/ServletAnnotationControllerHandlerMethodTests.java
View File

@@ -796,13 +796,19 @@ public class ServletAnnotationControllerHandlerMethodTests extends AbstractServl
.hasMessageContaining("Ambiguous mapping");
}
@Test
@Test // gh-22543
public void unmappedPathMapping() throws Exception {
initServletWithControllers(UnmappedPathController.class);
MockHttpServletRequest request = new MockHttpServletRequest("GET", "/bogus-unmapped");
MockHttpServletResponse response = new MockHttpServletResponse();
getServlet().service(request, response);
assertEquals(404, response.getStatus());
request = new MockHttpServletRequest("GET", "");
response = new MockHttpServletResponse();
getServlet().service(request, response);
assertEquals(200, response.getStatus());
assertEquals("get", response.getContentAsString());
}