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

Simplify Mock[Multipart]HttpServletRequestBuilder

Browse Source 
This commit simplifies the package private constructors on those two
builders now that the URI can be specified by dedicated builder methods.

Closes gh-33062
This commit is contained in:
Stéphane Nicoll
2024-06-18 10:10:07 +02:00
parent d76f37c90b
commit acf73404c1
5 changed files with 59 additions and 103 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
spring-test/src/main/java/org/springframework/test/web/servlet/request/MockHttpServletRequestBuilder.java
View File

@@ -16,12 +16,9 @@
package org.springframework.test.web.servlet.request;
import java.net.URI;
import org.springframework.http.HttpMethod;
import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.util.Assert;
/**
* Default builder for {@link MockHttpServletRequest} required as input to
@@ -51,25 +48,9 @@ public class MockHttpServletRequestBuilder
* the {@code MockHttpServletRequest} can be plugged in via
* {@link #with(RequestPostProcessor)}.
* @param httpMethod the HTTP method (GET, POST, etc.)
* @param uriTemplate a URI template; the resulting URI will be encoded
* @param uriVariables zero or more URI variables
*/
MockHttpServletRequestBuilder(HttpMethod httpMethod, String uriTemplate, Object... uriVariables) {
MockHttpServletRequestBuilder(HttpMethod httpMethod) {
super(httpMethod);
super.uri(uriTemplate, uriVariables);
}
/**
* Alternative to {@link #MockHttpServletRequestBuilder(HttpMethod, String, Object...)}
* with a pre-built URI.
* @param httpMethod the HTTP method (GET, POST, etc.)
* @param uri the URI
* @since 4.0.3
*/
MockHttpServletRequestBuilder(HttpMethod httpMethod, URI uri) {
super(httpMethod);
Assert.notNull(uri, "'uri' is required");
super.uri(uri);
}
}

37
spring-test/src/main/java/org/springframework/test/web/servlet/request/MockMultipartHttpServletRequestBuilder.java
View File

@@ -16,8 +16,6 @@
package org.springframework.test.web.servlet.request;
import java.net.URI;
import org.springframework.http.HttpMethod;
import org.springframework.http.MediaType;
import org.springframework.mock.web.MockMultipartHttpServletRequest;
@@ -33,49 +31,26 @@ import org.springframework.mock.web.MockMultipartHttpServletRequest;
public class MockMultipartHttpServletRequestBuilder
extends AbstractMockMultipartHttpServletRequestBuilder<MockMultipartHttpServletRequestBuilder> {
/**
* Package-private constructor. Use static factory methods in
* {@link MockMvcRequestBuilders}.
* <p>For other ways to initialize a {@code MockMultipartHttpServletRequest},
* see {@link #with(RequestPostProcessor)} and the
* {@link RequestPostProcessor} extension point.
* @param uriTemplate a URI template; the resulting URI will be encoded
* @param uriVariables zero or more URI variables
* @param httpMethod the HTTP method (GET, POST, etc.)
*/
MockMultipartHttpServletRequestBuilder(String uriTemplate, Object... uriVariables) {
this(HttpMethod.POST, uriTemplate, uriVariables);
}
/**
* Variant of {@link #MockMultipartHttpServletRequestBuilder(String, Object...)}
* that also accepts an {@link HttpMethod}.
* @since 5.3.22
*/
MockMultipartHttpServletRequestBuilder(HttpMethod httpMethod, String uriTemplate, Object... uriVariables) {
MockMultipartHttpServletRequestBuilder(HttpMethod httpMethod) {
super(httpMethod);
super.uri(uriTemplate, uriVariables);
super.contentType(MediaType.MULTIPART_FORM_DATA);
}
/**
* Variant of {@link #MockMultipartHttpServletRequestBuilder(String, Object...)}
* with a {@link URI}.
* @since 4.0.3
* Variant of {@link #MockMultipartHttpServletRequestBuilder(HttpMethod)}
* that defaults to {@link HttpMethod#POST}.
*/
MockMultipartHttpServletRequestBuilder(URI uri) {
this(HttpMethod.POST, uri);
MockMultipartHttpServletRequestBuilder() {
this(HttpMethod.POST);
}
/**
* Variant of {@link #MockMultipartHttpServletRequestBuilder(String, Object...)}
* with a {@link URI} and an {@link HttpMethod}.
* @since 5.3.21
*/
MockMultipartHttpServletRequestBuilder(HttpMethod httpMethod, URI uri) {
super(httpMethod);
super.uri(uri);
super.contentType(MediaType.MULTIPART_FORM_DATA);
}
}

40
spring-test/src/main/java/org/springframework/test/web/servlet/request/MockMvcRequestBuilders.java
View File

@@ -53,7 +53,7 @@ public abstract class MockMvcRequestBuilders {
* @param uriVariables zero or more URI variables
*/
public static MockHttpServletRequestBuilder get(String uriTemplate, Object... uriVariables) {
return new MockHttpServletRequestBuilder(HttpMethod.GET, uriTemplate, uriVariables);
return new MockHttpServletRequestBuilder(HttpMethod.GET).uri(uriTemplate, uriVariables);
}
/**
@@ -62,7 +62,7 @@ public abstract class MockMvcRequestBuilders {
* @since 4.0.3
*/
public static MockHttpServletRequestBuilder get(URI uri) {
return new MockHttpServletRequestBuilder(HttpMethod.GET, uri);
return new MockHttpServletRequestBuilder(HttpMethod.GET).uri(uri);
}
/**
@@ -71,7 +71,7 @@ public abstract class MockMvcRequestBuilders {
* @param uriVariables zero or more URI variables
*/
public static MockHttpServletRequestBuilder post(String uriTemplate, Object... uriVariables) {
return new MockHttpServletRequestBuilder(HttpMethod.POST, uriTemplate, uriVariables);
return new MockHttpServletRequestBuilder(HttpMethod.POST).uri(uriTemplate, uriVariables);
}
/**
@@ -80,7 +80,7 @@ public abstract class MockMvcRequestBuilders {
* @since 4.0.3
*/
public static MockHttpServletRequestBuilder post(URI uri) {
return new MockHttpServletRequestBuilder(HttpMethod.POST, uri);
return new MockHttpServletRequestBuilder(HttpMethod.POST).uri(uri);
}
/**
@@ -89,7 +89,7 @@ public abstract class MockMvcRequestBuilders {
* @param uriVariables zero or more URI variables
*/
public static MockHttpServletRequestBuilder put(String uriTemplate, Object... uriVariables) {
return new MockHttpServletRequestBuilder(HttpMethod.PUT, uriTemplate, uriVariables);
return new MockHttpServletRequestBuilder(HttpMethod.PUT).uri(uriTemplate, uriVariables);
}
/**
@@ -98,7 +98,7 @@ public abstract class MockMvcRequestBuilders {
* @since 4.0.3
*/
public static MockHttpServletRequestBuilder put(URI uri) {
return new MockHttpServletRequestBuilder(HttpMethod.PUT, uri);
return new MockHttpServletRequestBuilder(HttpMethod.PUT).uri(uri);
}
/**
@@ -107,7 +107,7 @@ public abstract class MockMvcRequestBuilders {
* @param uriVariables zero or more URI variables
*/
public static MockHttpServletRequestBuilder patch(String uriTemplate, Object... uriVariables) {
return new MockHttpServletRequestBuilder(HttpMethod.PATCH, uriTemplate, uriVariables);
return new MockHttpServletRequestBuilder(HttpMethod.PATCH).uri(uriTemplate, uriVariables);
}
/**
@@ -116,7 +116,7 @@ public abstract class MockMvcRequestBuilders {
* @since 4.0.3
*/
public static MockHttpServletRequestBuilder patch(URI uri) {
return new MockHttpServletRequestBuilder(HttpMethod.PATCH, uri);
return new MockHttpServletRequestBuilder(HttpMethod.PATCH).uri(uri);
}
/**
@@ -125,7 +125,7 @@ public abstract class MockMvcRequestBuilders {
* @param uriVariables zero or more URI variables
*/
public static MockHttpServletRequestBuilder delete(String uriTemplate, Object... uriVariables) {
return new MockHttpServletRequestBuilder(HttpMethod.DELETE, uriTemplate, uriVariables);
return new MockHttpServletRequestBuilder(HttpMethod.DELETE).uri(uriTemplate, uriVariables);
}
/**
@@ -134,7 +134,7 @@ public abstract class MockMvcRequestBuilders {
* @since 4.0.3
*/
public static MockHttpServletRequestBuilder delete(URI uri) {
return new MockHttpServletRequestBuilder(HttpMethod.DELETE, uri);
return new MockHttpServletRequestBuilder(HttpMethod.DELETE).uri(uri);
}
/**
@@ -143,7 +143,7 @@ public abstract class MockMvcRequestBuilders {
* @param uriVariables zero or more URI variables
*/
public static MockHttpServletRequestBuilder options(String uriTemplate, Object... uriVariables) {
return new MockHttpServletRequestBuilder(HttpMethod.OPTIONS, uriTemplate, uriVariables);
return new MockHttpServletRequestBuilder(HttpMethod.OPTIONS).uri(uriTemplate, uriVariables);
}
/**
@@ -152,7 +152,7 @@ public abstract class MockMvcRequestBuilders {
* @since 4.0.3
*/
public static MockHttpServletRequestBuilder options(URI uri) {
return new MockHttpServletRequestBuilder(HttpMethod.OPTIONS, uri);
return new MockHttpServletRequestBuilder(HttpMethod.OPTIONS).uri(uri);
}
/**
@@ -162,7 +162,7 @@ public abstract class MockMvcRequestBuilders {
* @since 4.1
*/
public static MockHttpServletRequestBuilder head(String uriTemplate, Object... uriVariables) {
return new MockHttpServletRequestBuilder(HttpMethod.HEAD, uriTemplate, uriVariables);
return new MockHttpServletRequestBuilder(HttpMethod.HEAD).uri(uriTemplate, uriVariables);
}
/**
@@ -171,7 +171,7 @@ public abstract class MockMvcRequestBuilders {
* @since 4.1
*/
public static MockHttpServletRequestBuilder head(URI uri) {
return new MockHttpServletRequestBuilder(HttpMethod.HEAD, uri);
return new MockHttpServletRequestBuilder(HttpMethod.HEAD).uri(uri);
}
/**
@@ -181,7 +181,7 @@ public abstract class MockMvcRequestBuilders {
* @param uriVariables zero or more URI variables
*/
public static MockHttpServletRequestBuilder request(HttpMethod method, String uriTemplate, Object... uriVariables) {
return new MockHttpServletRequestBuilder(method, uriTemplate, uriVariables);
return new MockHttpServletRequestBuilder(method).uri(uriTemplate, uriVariables);
}
/**
@@ -191,7 +191,7 @@ public abstract class MockMvcRequestBuilders {
* @since 4.0.3
*/
public static MockHttpServletRequestBuilder request(HttpMethod httpMethod, URI uri) {
return new MockHttpServletRequestBuilder(httpMethod, uri);
return new MockHttpServletRequestBuilder(httpMethod).uri(uri);
}
/**
@@ -214,7 +214,7 @@ public abstract class MockMvcRequestBuilders {
* @since 5.0
*/
public static MockMultipartHttpServletRequestBuilder multipart(String uriTemplate, Object... uriVariables) {
return new MockMultipartHttpServletRequestBuilder(uriTemplate, uriVariables);
return new MockMultipartHttpServletRequestBuilder().uri(uriTemplate, uriVariables);
}
/**
@@ -226,7 +226,7 @@ public abstract class MockMvcRequestBuilders {
* @since 5.3.22
*/
public static MockMultipartHttpServletRequestBuilder multipart(HttpMethod httpMethod, String uriTemplate, Object... uriVariables) {
return new MockMultipartHttpServletRequestBuilder(httpMethod, uriTemplate, uriVariables);
return new MockMultipartHttpServletRequestBuilder(httpMethod).uri(uriTemplate, uriVariables);
}
/**
@@ -235,7 +235,7 @@ public abstract class MockMvcRequestBuilders {
* @since 5.0
*/
public static MockMultipartHttpServletRequestBuilder multipart(URI uri) {
return new MockMultipartHttpServletRequestBuilder(uri);
return new MockMultipartHttpServletRequestBuilder().uri(uri);
}
/**
@@ -246,7 +246,7 @@ public abstract class MockMvcRequestBuilders {
* @since 5.3.21
*/
public static MockMultipartHttpServletRequestBuilder multipart(HttpMethod httpMethod, URI uri) {
return new MockMultipartHttpServletRequestBuilder(httpMethod, uri);
return new MockMultipartHttpServletRequestBuilder(httpMethod).uri(uri);
}
/**