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

Merge branch '2.0.x'

Browse Source 
Closes gh-829
This commit is contained in:
Andy Wilkinson
2022-07-15 12:39:18 +01:00
parent ef6aa137e0 ebe70a91c7
commit b4fd66ff9b
45 changed files with 223 additions and 232 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
spring-restdocs-mockmvc/src/main/java/org/springframework/restdocs/mockmvc/RestDocumentationResultHandler.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2014-2019 the original author or authors.
* Copyright 2014-2022 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.
@@ -48,7 +48,7 @@ public class RestDocumentationResultHandler implements ResultHandler {
}
@Override
public void handle(MvcResult result) throws Exception {
public void handle(MvcResult result) {
this.delegate.handle(result.getRequest(), result.getResponse(), retrieveConfiguration(result));
}
@@ -71,7 +71,7 @@ public class RestDocumentationResultHandler implements ResultHandler {
return new RestDocumentationResultHandler(this.delegate.withSnippets(snippets)) {
@Override
public void handle(MvcResult result) throws Exception {
public void handle(MvcResult result) {
Map<String, Object> configuration = new HashMap<>(retrieveConfiguration(result));
configuration.remove(RestDocumentationGenerator.ATTRIBUTE_NAME_DEFAULT_SNIPPETS);
getDelegate().handle(result.getRequest(), result.getResponse(), configuration);

31
spring-restdocs-mockmvc/src/test/java/org/springframework/restdocs/mockmvc/MockMvcRequestConverterTests.java
View File

@@ -17,6 +17,7 @@
package org.springframework.restdocs.mockmvc;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.net.URI;
import java.util.Arrays;
import java.util.Iterator;
@@ -49,14 +50,14 @@ public class MockMvcRequestConverterTests {
private final MockMvcRequestConverter factory = new MockMvcRequestConverter();
@Test
public void httpRequest() throws Exception {
public void httpRequest() {
OperationRequest request = createOperationRequest(MockMvcRequestBuilders.get("/foo"));
assertThat(request.getUri()).isEqualTo(URI.create("http://localhost/foo"));
assertThat(request.getMethod()).isEqualTo(HttpMethod.GET);
}
@Test
public void httpRequestWithCustomPort() throws Exception {
public void httpRequestWithCustomPort() {
MockHttpServletRequest mockRequest = MockMvcRequestBuilders.get("/foo").buildRequest(new MockServletContext());
mockRequest.setServerPort(8080);
OperationRequest request = this.factory.convert(mockRequest);
@@ -65,14 +66,14 @@ public class MockMvcRequestConverterTests {
}
@Test
public void requestWithContextPath() throws Exception {
public void requestWithContextPath() {
OperationRequest request = createOperationRequest(MockMvcRequestBuilders.get("/foo/bar").contextPath("/foo"));
assertThat(request.getUri()).isEqualTo(URI.create("http://localhost/foo/bar"));
assertThat(request.getMethod()).isEqualTo(HttpMethod.GET);
}
@Test
public void requestWithHeaders() throws Exception {
public void requestWithHeaders() {
OperationRequest request = createOperationRequest(
MockMvcRequestBuilders.get("/foo").header("a", "alpha", "apple").header("b", "bravo"));
assertThat(request.getUri()).isEqualTo(URI.create("http://localhost/foo"));
@@ -82,7 +83,7 @@ public class MockMvcRequestConverterTests {
}
@Test
public void requestWithCookies() throws Exception {
public void requestWithCookies() {
OperationRequest request = createOperationRequest(
MockMvcRequestBuilders.get("/foo").cookie(new jakarta.servlet.http.Cookie("cookieName1", "cookieVal1"),
new jakarta.servlet.http.Cookie("cookieName2", "cookieVal2")));
@@ -102,7 +103,7 @@ public class MockMvcRequestConverterTests {
}
@Test
public void httpsRequest() throws Exception {
public void httpsRequest() {
MockHttpServletRequest mockRequest = MockMvcRequestBuilders.get("/foo").buildRequest(new MockServletContext());
mockRequest.setScheme("https");
mockRequest.setServerPort(443);
@@ -112,7 +113,7 @@ public class MockMvcRequestConverterTests {
}
@Test
public void httpsRequestWithCustomPort() throws Exception {
public void httpsRequestWithCustomPort() {
MockHttpServletRequest mockRequest = MockMvcRequestBuilders.get("/foo").buildRequest(new MockServletContext());
mockRequest.setScheme("https");
mockRequest.setServerPort(8443);
@@ -122,7 +123,7 @@ public class MockMvcRequestConverterTests {
}
@Test
public void getRequestWithParametersProducesUriWithQueryString() throws Exception {
public void getRequestWithParametersProducesUriWithQueryString() {
OperationRequest request = createOperationRequest(
MockMvcRequestBuilders.get("/foo").param("a", "alpha", "apple").param("b", "br&vo"));
assertThat(request.getUri()).isEqualTo(URI.create("http://localhost/foo?a=alpha&a=apple&b=br%26vo"));
@@ -133,7 +134,7 @@ public class MockMvcRequestConverterTests {
}
@Test
public void getRequestWithQueryStringPopulatesParameters() throws Exception {
public void getRequestWithQueryStringPopulatesParameters() {
OperationRequest request = createOperationRequest(MockMvcRequestBuilders.get("/foo?a=alpha&b=bravo"));
assertThat(request.getUri()).isEqualTo(URI.create("http://localhost/foo?a=alpha&b=bravo"));
assertThat(request.getParameters().size()).isEqualTo(2);
@@ -143,7 +144,7 @@ public class MockMvcRequestConverterTests {
}
@Test
public void postRequestWithParameters() throws Exception {
public void postRequestWithParameters() {
OperationRequest request = createOperationRequest(
MockMvcRequestBuilders.post("/foo").param("a", "alpha", "apple").param("b", "br&vo"));
assertThat(request.getUri()).isEqualTo(URI.create("http://localhost/foo"));
@@ -154,7 +155,7 @@ public class MockMvcRequestConverterTests {
}
@Test
public void mockMultipartFileUpload() throws Exception {
public void mockMultipartFileUpload() {
OperationRequest request = createOperationRequest(MockMvcRequestBuilders.multipart("/foo")
.file(new MockMultipartFile("file", new byte[] { 1, 2, 3, 4 })));
assertThat(request.getUri()).isEqualTo(URI.create("http://localhost/foo"));
@@ -169,7 +170,7 @@ public class MockMvcRequestConverterTests {
}
@Test
public void mockMultipartFileUploadWithContentType() throws Exception {
public void mockMultipartFileUploadWithContentType() {
OperationRequest request = createOperationRequest(MockMvcRequestBuilders.multipart("/foo")
.file(new MockMultipartFile("file", "original", "image/png", new byte[] { 1, 2, 3, 4 })));
assertThat(request.getUri()).isEqualTo(URI.create("http://localhost/foo"));
@@ -183,7 +184,7 @@ public class MockMvcRequestConverterTests {
}
@Test
public void requestWithPart() throws Exception {
public void requestWithPart() throws IOException {
MockHttpServletRequest mockRequest = MockMvcRequestBuilders.get("/foo").buildRequest(new MockServletContext());
Part mockPart = mock(Part.class);
given(mockPart.getHeaderNames()).willReturn(Arrays.asList("a", "b"));
@@ -205,7 +206,7 @@ public class MockMvcRequestConverterTests {
}
@Test
public void requestWithPartWithContentType() throws Exception {
public void requestWithPartWithContentType() throws IOException {
MockHttpServletRequest mockRequest = MockMvcRequestBuilders.get("/foo").buildRequest(new MockServletContext());
Part mockPart = mock(Part.class);
given(mockPart.getHeaderNames()).willReturn(Arrays.asList("a", "b"));
@@ -227,7 +228,7 @@ public class MockMvcRequestConverterTests {
assertThat(part.getContent()).isEqualTo(new byte[] { 1, 2, 3, 4 });
}
private OperationRequest createOperationRequest(MockHttpServletRequestBuilder builder) throws Exception {
private OperationRequest createOperationRequest(MockHttpServletRequestBuilder builder) {
return this.factory.convert(builder.buildRequest(new MockServletContext()));
}