Skip to content

NPE in HttpResponseSnippet when documenting a response with a custom HTTP status #653

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

NPE in HttpResponseSnippet when documenting a response with a custom HTTP status #653

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions ...ng-restdocs-core/src/main/java/org/springframework/restdocs/http/HttpResponseSnippet.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,15 @@ protected Map<String, Object> createModel(Operation operation) {
HttpStatus status = response.getStatus();
Map<String, Object> model = new HashMap<>();
model.put("responseBody", responseBody(response));
model.put("statusCode", status.value());
model.put("statusReason", status.getReasonPhrase());
model.put("headers", headers(response));
if (status != null) {
model.put("statusCode", status.value());
model.put("statusReason", status.getReasonPhrase());
}
else {
model.put("statusCode", response.getStatusCode());
model.put("statusReason", "Http custom status.");
}
return model;
}

Expand Down
4 changes: 4 additions & 0 deletions spring-restdocs-core/src/test/java/org/springframework/restdocs/AbstractSnippetTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,10 @@ public HttpResponseCondition httpResponse(HttpStatus responseStatus) {
return SnippetConditions.httpResponse(this.templateFormat, responseStatus);
}

public HttpResponseCondition httpResponse(Integer responseStatusCode, String responseStatusReason) {
return SnippetConditions.httpResponse(this.templateFormat, responseStatusCode, responseStatusReason);
}

protected FileSystemResource snippetResource(String name) {
return new FileSystemResource(
"src/test/resources/custom-snippet-templates/" + this.templateFormat.getId() + "/" + name + ".snippet");
Expand Down
5 changes: 5 additions & 0 deletions ...stdocs-core/src/test/java/org/springframework/restdocs/http/HttpResponseSnippetTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,4 +97,9 @@ public void responseWithCustomSnippetAttributes() throws IOException {
assertThat(this.generatedSnippets.httpResponse()).contains("Title for the response");
}

@Test
public void responseWithCustomStatus() throws IOException {
new HttpResponseSnippet().document(this.operationBuilder.response().status(215).build());
assertThat(this.generatedSnippets.httpResponse()).is(httpResponse(215,"Http custom status."));
}
}
13 changes: 13 additions & 0 deletions spring-restdocs-core/src/test/java/org/springframework/restdocs/test/SnippetConditions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,13 @@ public static HttpResponseCondition httpResponse(TemplateFormat format, HttpStat
return new HttpResponseCondition(status, new MarkdownCodeBlockCondition<>("http"), 2);
}

public static HttpResponseCondition httpResponse(TemplateFormat format, Integer responseStatusCode, String responseStatusReason) {
if ("adoc".equals(format.getFileExtension())) {
return new HttpResponseCondition(responseStatusCode, responseStatusReason, new AsciidoctorCodeBlockCondition<>("http", "nowrap"), 3);
}
return new HttpResponseCondition(responseStatusCode, responseStatusReason, new MarkdownCodeBlockCondition<>("http"), 2);
}

@SuppressWarnings({ "rawtypes" })
public static CodeBlockCondition<?> codeBlock(TemplateFormat format, String language) {
if ("adoc".equals(format.getFileExtension())) {
Expand Down Expand Up @@ -235,6 +242,12 @@ private HttpResponseCondition(HttpStatus status, CodeBlockCondition<?> delegate,
this.content("");
}

private HttpResponseCondition(Integer responseStatusCode, String responseStatusReason, CodeBlockCondition<?> delegate, int headerOffset) {
super(delegate, headerOffset);
this.content("HTTP/1.1 " + responseStatusCode + " " + responseStatusReason);
this.content("");
}

}

/**
Expand Down