Skip to content

Commit c7d15a0

Browse files
committed
Merge pull request #653 from flo076
* gh-653: Polish "Fix NPE in HttpResponseSnippet when response has custom status" Fix NPE in HttpResponseSnippet when response has custom status Closes gh-653
2 parents bb7aecb + d925a9f commit c7d15a0

File tree

4 files changed

+37
-4
lines changed

4 files changed

+37
-4
lines changed

spring-restdocs-core/src/main/java/org/springframework/restdocs/http/HttpResponseSnippet.java

+10-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2014-2018 the original author or authors.
2+
* Copyright 2014-2019 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -56,12 +56,18 @@ protected HttpResponseSnippet(Map<String, Object> attributes) {
5656
@Override
5757
protected Map<String, Object> createModel(Operation operation) {
5858
OperationResponse response = operation.getResponse();
59-
HttpStatus status = response.getStatus();
6059
Map<String, Object> model = new HashMap<>();
6160
model.put("responseBody", responseBody(response));
62-
model.put("statusCode", status.value());
63-
model.put("statusReason", status.getReasonPhrase());
6461
model.put("headers", headers(response));
62+
HttpStatus status = response.getStatus();
63+
if (status != null) {
64+
model.put("statusCode", status.value());
65+
model.put("statusReason", status.getReasonPhrase());
66+
}
67+
else {
68+
model.put("statusCode", response.getStatusCode());
69+
model.put("statusReason", "");
70+
}
6571
return model;
6672
}
6773

spring-restdocs-core/src/test/java/org/springframework/restdocs/AbstractSnippetTests.java

+4
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,10 @@ public HttpResponseCondition httpResponse(HttpStatus responseStatus) {
8989
return SnippetConditions.httpResponse(this.templateFormat, responseStatus);
9090
}
9191

92+
public HttpResponseCondition httpResponse(int responseStatusCode) {
93+
return SnippetConditions.httpResponse(this.templateFormat, responseStatusCode, "");
94+
}
95+
9296
protected FileSystemResource snippetResource(String name) {
9397
return new FileSystemResource(
9498
"src/test/resources/custom-snippet-templates/" + this.templateFormat.getId() + "/" + name + ".snippet");

spring-restdocs-core/src/test/java/org/springframework/restdocs/http/HttpResponseSnippetTests.java

+6
Original file line numberDiff line numberDiff line change
@@ -97,4 +97,10 @@ public void responseWithCustomSnippetAttributes() throws IOException {
9797
assertThat(this.generatedSnippets.httpResponse()).contains("Title for the response");
9898
}
9999

100+
@Test
101+
public void responseWithCustomStatus() throws IOException {
102+
new HttpResponseSnippet().document(this.operationBuilder.response().status(215).build());
103+
assertThat(this.generatedSnippets.httpResponse()).is(httpResponse(215));
104+
}
105+
100106
}

spring-restdocs-core/src/test/java/org/springframework/restdocs/test/SnippetConditions.java

+17
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,16 @@ public static HttpResponseCondition httpResponse(TemplateFormat format, HttpStat
7171
return new HttpResponseCondition(status, new MarkdownCodeBlockCondition<>("http"), 2);
7272
}
7373

74+
public static HttpResponseCondition httpResponse(TemplateFormat format, Integer responseStatusCode,
75+
String responseStatusReason) {
76+
if ("adoc".equals(format.getFileExtension())) {
77+
return new HttpResponseCondition(responseStatusCode, responseStatusReason,
78+
new AsciidoctorCodeBlockCondition<>("http", "nowrap"), 3);
79+
}
80+
return new HttpResponseCondition(responseStatusCode, responseStatusReason,
81+
new MarkdownCodeBlockCondition<>("http"), 2);
82+
}
83+
7484
@SuppressWarnings({ "rawtypes" })
7585
public static CodeBlockCondition<?> codeBlock(TemplateFormat format, String language) {
7686
if ("adoc".equals(format.getFileExtension())) {
@@ -235,6 +245,13 @@ private HttpResponseCondition(HttpStatus status, CodeBlockCondition<?> delegate,
235245
this.content("");
236246
}
237247

248+
private HttpResponseCondition(int responseStatusCode, String responseStatusReason,
249+
CodeBlockCondition<?> delegate, int headerOffset) {
250+
super(delegate, headerOffset);
251+
this.content("HTTP/1.1 " + responseStatusCode + " " + responseStatusReason);
252+
this.content("");
253+
}
254+
238255
}
239256

240257
/**

0 commit comments

Comments
 (0)