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

Improve diagnostics when extracting a non-existent subsection

Browse Source 
Closes gh-568
This commit is contained in:
Andy Wilkinson
2019-08-30 14:05:50 +01:00
parent 1727b4e3c8
commit 1b87af13be
2 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
spring-restdocs-core/src/main/java/org/springframework/restdocs/payload/FieldPathPayloadSubsectionExtractor.java
View File

@@ -75,6 +75,9 @@ public class FieldPathPayloadSubsectionExtractor
ExtractedField extractedField = new JsonFieldProcessor().extract(this.fieldPath,
objectMapper.readValue(payload, Object.class));
Object value = extractedField.getValue();
if (value == ExtractedField.ABSENT) {
throw new PayloadHandlingException(this.fieldPath + " does not identify a section of the payload");
}
if (value instanceof List) {
List<?> extractedList = (List<?>) value;
Set<String> uncommonPaths = JsonFieldPaths.from(extractedList).getUncommon();

9
spring-restdocs-core/src/test/java/org/springframework/restdocs/payload/FieldPathPayloadSubsectionExtractorTests.java
View File

@@ -31,6 +31,7 @@ import org.junit.rules.ExpectedException;
import org.springframework.http.MediaType;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
/**
* Tests for {@link FieldPathPayloadSubsectionExtractor}.
@@ -130,4 +131,12 @@ public class FieldPathPayloadSubsectionExtractorTests {
assertThat(new String(extractedSubsection)).isEqualTo(new String(subsection));
}
@Test
public void extractNonExistentSubsection() throws JsonParseException, JsonMappingException, IOException {
assertThatThrownBy(() -> new FieldPathPayloadSubsectionExtractor("a.c")
.extractSubsection("{\"a\":{\"b\":{\"c\":5}}}".getBytes(), MediaType.APPLICATION_JSON))
.isInstanceOf(PayloadHandlingException.class)
.hasMessage("a.c does not identify a section of the payload");
}
}