-
Notifications
You must be signed in to change notification settings - Fork 38.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add multipart support for MockMvcTester
File uploads with MockMvc require a separate MockHttpServletRequestBuilder implementation. This commit applies the same change to support AssertJ on this builder, but for the multipart version. Any request builder can now use `multipart()` to "down cast" to a dedicated multipart request builder that contains the settings configured thus far. Closes gh-33027
- Loading branch information
Showing
4 changed files
with
260 additions
and
121 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
159 changes: 159 additions & 0 deletions
159
...ingframework/test/web/servlet/request/AbstractMockMultipartHttpServletRequestBuilder.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,159 @@ | ||
| /* | ||
| * Copyright 2002-2024 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.test.web.servlet.request; | ||
|
|
||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.io.InputStreamReader; | ||
| import java.nio.charset.Charset; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.util.ArrayList; | ||
| import java.util.Collection; | ||
| import java.util.List; | ||
|
|
||
| import jakarta.servlet.ServletContext; | ||
| import jakarta.servlet.http.Part; | ||
|
|
||
| import org.springframework.http.HttpMethod; | ||
| import org.springframework.http.MediaType; | ||
| import org.springframework.lang.Nullable; | ||
| import org.springframework.mock.web.MockHttpServletRequest; | ||
| import org.springframework.mock.web.MockMultipartFile; | ||
| import org.springframework.mock.web.MockMultipartHttpServletRequest; | ||
| import org.springframework.util.Assert; | ||
| import org.springframework.util.FileCopyUtils; | ||
| import org.springframework.util.LinkedMultiValueMap; | ||
| import org.springframework.util.MultiValueMap; | ||
|
|
||
| /** | ||
| * Base builder for {@link MockMultipartHttpServletRequest}. | ||
| * | ||
| * @author Rossen Stoyanchev | ||
| * @author Arjen Poutsma | ||
| * @author Stephane Nicoll | ||
| * @since 6.2 | ||
| * @param <B> a self reference to the builder type | ||
| */ | ||
| public abstract class AbstractMockMultipartHttpServletRequestBuilder<B extends AbstractMockMultipartHttpServletRequestBuilder<B>> | ||
| extends AbstractMockHttpServletRequestBuilder<B> { | ||
|
|
||
| private final List<MockMultipartFile> files = new ArrayList<>(); | ||
|
|
||
| private final MultiValueMap<String, Part> parts = new LinkedMultiValueMap<>(); | ||
|
|
||
|
|
||
| protected AbstractMockMultipartHttpServletRequestBuilder(HttpMethod httpMethod) { | ||
| super(httpMethod); | ||
| } | ||
|
|
||
| /** | ||
| * Add a new {@link MockMultipartFile} with the given content. | ||
| * @param name the name of the file | ||
| * @param content the content of the file | ||
| */ | ||
| public B file(String name, byte[] content) { | ||
| this.files.add(new MockMultipartFile(name, content)); | ||
| return self(); | ||
| } | ||
|
|
||
| /** | ||
| * Add the given {@link MockMultipartFile}. | ||
| * @param file the multipart file | ||
| */ | ||
| public B file(MockMultipartFile file) { | ||
| this.files.add(file); | ||
| return self(); | ||
| } | ||
|
|
||
| /** | ||
| * Add {@link Part} components to the request. | ||
| * @param parts one or more parts to add | ||
| * @since 5.0 | ||
| */ | ||
| public B part(Part... parts) { | ||
| Assert.notEmpty(parts, "'parts' must not be empty"); | ||
| for (Part part : parts) { | ||
| this.parts.add(part.getName(), part); | ||
| } | ||
| return self(); | ||
| } | ||
|
|
||
| @Override | ||
| public Object merge(@Nullable Object parent) { | ||
| if (parent == null) { | ||
| return this; | ||
| } | ||
| if (parent instanceof AbstractMockHttpServletRequestBuilder<?>) { | ||
| super.merge(parent); | ||
| if (parent instanceof AbstractMockMultipartHttpServletRequestBuilder<?> parentBuilder) { | ||
| this.files.addAll(parentBuilder.files); | ||
| parentBuilder.parts.keySet().forEach(name -> | ||
| this.parts.putIfAbsent(name, parentBuilder.parts.get(name))); | ||
| } | ||
| } | ||
| else { | ||
| throw new IllegalArgumentException("Cannot merge with [" + parent.getClass().getName() + "]"); | ||
| } | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Create a new {@link MockMultipartHttpServletRequest} based on the | ||
| * supplied {@code ServletContext} and the {@code MockMultipartFiles} | ||
| * added to this builder. | ||
| */ | ||
| @Override | ||
| protected final MockHttpServletRequest createServletRequest(ServletContext servletContext) { | ||
| MockMultipartHttpServletRequest request = new MockMultipartHttpServletRequest(servletContext); | ||
| Charset defaultCharset = (request.getCharacterEncoding() != null ? | ||
| Charset.forName(request.getCharacterEncoding()) : StandardCharsets.UTF_8); | ||
|
|
||
| this.files.forEach(request::addFile); | ||
| this.parts.values().stream().flatMap(Collection::stream).forEach(part -> { | ||
| request.addPart(part); | ||
| try { | ||
| String name = part.getName(); | ||
| String filename = part.getSubmittedFileName(); | ||
| InputStream is = part.getInputStream(); | ||
| if (filename != null) { | ||
| request.addFile(new MockMultipartFile(name, filename, part.getContentType(), is)); | ||
| } | ||
| else { | ||
| InputStreamReader reader = new InputStreamReader(is, getCharsetOrDefault(part, defaultCharset)); | ||
| String value = FileCopyUtils.copyToString(reader); | ||
| request.addParameter(part.getName(), value); | ||
| } | ||
| } | ||
| catch (IOException ex) { | ||
| throw new IllegalStateException("Failed to read content for part " + part.getName(), ex); | ||
| } | ||
| }); | ||
|
|
||
| return request; | ||
| } | ||
|
|
||
| private Charset getCharsetOrDefault(Part part, Charset defaultCharset) { | ||
| if (part.getContentType() != null) { | ||
| MediaType mediaType = MediaType.parseMediaType(part.getContentType()); | ||
| if (mediaType.getCharset() != null) { | ||
| return mediaType.getCharset(); | ||
| } | ||
| } | ||
| return defaultCharset; | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.