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

#775 - Clean up VndError implementation to match spec.

Browse Source 
* Handle single, multiple, and nested errors.
* Retain backward compatibility with existing constructors.
This commit is contained in:
Greg Turnquist
2019-12-10 09:26:09 -06:00
parent 6bb2310682
commit 4f3be119c0
9 changed files with 366 additions and 256 deletions
Download Patch File Download Diff File Expand all files Collapse all files

123
src/test/java/org/springframework/hateoas/mediatype/vnderror/VndErrorsMarshallingTest.java
View File

@@ -16,24 +16,23 @@
package org.springframework.hateoas.mediatype.vnderror;
import static org.assertj.core.api.Assertions.*;
import static org.springframework.hateoas.support.MappingUtils.*;
import java.io.FileInputStream;
import java.io.IOException;
import java.nio.MappedByteBuffer;
import java.nio.channels.FileChannel;
import java.nio.charset.Charset;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.core.io.ClassPathResource;
import org.springframework.hateoas.IanaLinkRelations;
import org.springframework.hateoas.Link;
import org.springframework.hateoas.mediatype.MessageResolver;
import org.springframework.hateoas.mediatype.hal.CurieProvider;
import org.springframework.hateoas.mediatype.hal.Jackson2HalModule;
import org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalHandlerInstantiator;
import org.springframework.hateoas.mediatype.vnderrors.VndErrors;
import org.springframework.hateoas.mediatype.vnderrors.VndErrors.VndError;
import org.springframework.hateoas.server.LinkRelationProvider;
import org.springframework.hateoas.server.core.EvoInflectorLinkRelationProvider;
import org.springframework.hateoas.server.core.AnnotationLinkRelationProvider;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
@@ -46,58 +45,92 @@ import com.fasterxml.jackson.databind.SerializationFeature;
*/
class VndErrorsMarshallingTest {
ObjectMapper jackson2Mapper;
LinkRelationProvider relProvider = new EvoInflectorLinkRelationProvider();
VndErrors errors;
String jsonReference;
String json2Reference;
public VndErrorsMarshallingTest() throws IOException {
jsonReference = readFile(new ClassPathResource("vnderror.json"));
json2Reference = readFile(new ClassPathResource("vnderror2.json"));
}
ObjectMapper mapper;
@BeforeEach
void setUp() {
jackson2Mapper = new com.fasterxml.jackson.databind.ObjectMapper();
jackson2Mapper.registerModule(new Jackson2HalModule());
jackson2Mapper.setHandlerInstantiator(
new Jackson2HalModule.HalHandlerInstantiator(relProvider, CurieProvider.NONE, MessageResolver.DEFAULTS_ONLY));
jackson2Mapper.configure(SerializationFeature.INDENT_OUTPUT, true);
LinkRelationProvider relProvider = new AnnotationLinkRelationProvider();
VndError error = new VndError("42", "Validation failed!", //
new Link("http://...", "describes"), new Link("http://...", "help"));
errors = new VndErrors(error, error, error);
this.mapper = new ObjectMapper();
this.mapper.registerModule(new Jackson2HalModule());
this.mapper.setHandlerInstantiator(
new HalHandlerInstantiator(relProvider, CurieProvider.NONE, MessageResolver.DEFAULTS_ONLY));
this.mapper.configure(SerializationFeature.INDENT_OUTPUT, true);
}
/**
* @see #62
*/
@Test
void jackson2Marshalling() throws Exception {
@Test // #93, #94, #775
void singleItemVndErrorShouldDeserialize() throws IOException {
assertThat(jackson2Mapper.writeValueAsString(errors)) //
.isEqualToIgnoringWhitespace(json2Reference);
String expected = read(new ClassPathResource("vnderror-single-item.json", getClass()));
VndError actual = new VndError("Validation failed", "/username", 42,
new Link("http://path.to/user/resource/1", IanaLinkRelations.ABOUT),
new Link("http://path.to/describes", IanaLinkRelations.DESCRIBES),
new Link("http://path.to/help", IanaLinkRelations.HELP));
assertThat(this.mapper.readValue(expected, VndError.class)).isEqualTo(actual);
}
/**
* @see #93, #94
*/
@Test
void jackson2UnMarshalling() throws Exception {
assertThat(jackson2Mapper.readValue(jsonReference, VndErrors.class)).isEqualTo(errors);
@Test // #62, #775
public void singleItemVndErrorShouldSerialize() throws IOException {
VndError error = new VndError("Validation failed", "/username", 42, //
new Link("http://path.to/user/resource/1", IanaLinkRelations.ABOUT),
new Link("http://path.to/describes", IanaLinkRelations.DESCRIBES),
new Link("http://path.to/help", IanaLinkRelations.HELP));
String json = read(new ClassPathResource("vnderror-single-item.json", getClass()));
assertThat(mapper.writeValueAsString(error)).isEqualToIgnoringWhitespace(json);
}
private static String readFile(org.springframework.core.io.Resource resource) throws IOException {
@Test // #62, #775
public void multipleItemVndErrorsShouldDeserialize() throws IOException {
try (FileInputStream stream = new FileInputStream(resource.getFile())) {
FileChannel fc = stream.getChannel();
MappedByteBuffer bb = fc.map(FileChannel.MapMode.READ_ONLY, 0, fc.size());
return Charset.defaultCharset().decode(bb).toString();
}
String json = read(new ClassPathResource("vnderror-multiple-items.json", getClass()));
VndError error1 = new VndError("\"username\" field validation failed", null, 50, //
new Link("http://.../", IanaLinkRelations.HELP));
VndError error2 = new VndError("\"postcode\" field validation failed", null, 55, //
new Link("http://.../", IanaLinkRelations.HELP));
VndErrors vndErrors = new VndErrors().withError(error1).withError(error2);
assertThat(this.mapper.readValue(json, VndErrors.class)).isEqualTo(vndErrors);
}
@Test // #775
public void multipleItemVndErrorsShouldSerialize() throws IOException {
VndError error1 = new VndError("\"username\" field validation failed", null, 50, //
new Link("http://.../", IanaLinkRelations.HELP));
VndError error2 = new VndError("\"postcode\" field validation failed", null, 55, //
new Link("http://.../", IanaLinkRelations.HELP));
VndErrors vndErrors = new VndErrors().withError(error1).withError(error2);
String json = read(new ClassPathResource("vnderror-multiple-items.json", getClass()));
assertThat(this.mapper.writeValueAsString(vndErrors)).isEqualToIgnoringWhitespace(json);
}
@Test // #775
public void nestedVndErrorsShouldSerialize() throws IOException {
VndError error = new VndError("Username must contain at least three characters", "/username", (Integer) null, //
new Link("http://path.to/user/resource/1", IanaLinkRelations.ABOUT));
VndErrors vndErrors = new VndErrors().withError(error)
.withLink(new Link("http://path.to/describes").withRel(IanaLinkRelations.DESCRIBES))
.withLink(new Link("http://path.to/help").withRel(IanaLinkRelations.HELP))
.withLink(new Link("http://path.to/user/resource/1").withRel(IanaLinkRelations.ABOUT))
.withMessage("Validation failed").withLogref(42);
String json = read(new ClassPathResource("vnderror-nested.json", getClass()));
assertThat(mapper.writeValueAsString(vndErrors)).isEqualToIgnoringWhitespace(json);
}
}

63
src/test/java/org/springframework/hateoas/mediatype/vnderror/VndErrorsUnitTest.java
View File

@@ -17,6 +17,8 @@ package org.springframework.hateoas.mediatype.vnderror;
import static org.assertj.core.api.Assertions.*;
import java.util.ArrayList;
import org.junit.jupiter.api.Test;
import org.springframework.hateoas.Link;
import org.springframework.hateoas.mediatype.vnderrors.VndErrors;
@@ -26,17 +28,66 @@ import org.springframework.hateoas.mediatype.vnderrors.VndErrors.VndError;
* Unit tests for {@link VndErrors}.
*
* @author Oliver Gierke
* @author Greg Turnquist
*/
class VndErrorsUnitTest {
/**
* @see #775
*/
@Test
void rendersToStringCorrectly() {
void vndErrorsDoesntTakeNull() {
assertThatIllegalArgumentException().isThrownBy(() -> new VndErrors().withErrors(null));
}
VndError error = new VndErrors.VndError("logref", "message", new Link("foo", "bar"));
assertThat(error.toString()).isEqualTo("VndError[logref: logref, message: message, links: [<foo>;rel=\"bar\"]]");
/**
* @see #775
*/
@Test
public void vndErrorsDoesntTakeEmptyCollection() {
assertThatIllegalArgumentException().isThrownBy(() -> new VndErrors().withErrors(new ArrayList<>()));
}
VndErrors errors = new VndErrors(error);
assertThat(errors.toString()) //
.isEqualTo("VndErrors[VndError[logref: logref, message: message, links: [<foo>;rel=\"bar\"]]]");
/**
* @see #775
*/
@Test
public void vndErrorsUsingSingleErrorArguments() {
VndErrors errors = new VndErrors().withError(new VndError("message", "/path", 50, new Link("/link").withSelfRel()));
assertThat(errors.getTotal()).isNull();
assertThat(errors.getContent()).hasSize(1);
assertThat(errors.getContent())
.containsExactly(new VndError("message", "/path", 50, new Link("/link").withSelfRel()));
}
/**
* @see #775
*/
@Test
public void appendingVndErrorsShouldWork() {
VndErrors errors = new VndErrors().withError(new VndError("message", "/path", 50, new Link("/link").withSelfRel()));
assertThat(errors.getContent()).hasSize(1);
errors.getContent().add(new VndError("message2", "/path2", 51, new Link("/link2", "link2")));
assertThat(errors.getContent()).hasSize(2);
}
@Test
void vndErrorRendersToStringCorrectly() {
VndError error = new VndError("message", "path", 42, new Link("foo", "bar"));
assertThat(error.toString()).isEqualTo("VndError[logref: 42, message: message, links: [<foo>;rel=\"bar\"]]");
}
@Test
void vndErrorsRendersToStringCorrectly() {
VndErrors errors = new VndErrors(new VndError("message", "path", 42, new Link("foo", "bar")));
assertThat(errors.toString())
.isEqualTo("VndErrors[VndError[logref: 42, message: message, links: [<foo>;rel=\"bar\"]]]");
}
}

25
src/test/resources/org/springframework/hateoas/mediatype/vnderror/vnderror-multiple-items.json Normal file
View File

@@ -0,0 +1,25 @@
{
"total": 2,
"_embedded": {
"errors": [
{
"message": "\"username\" field validation failed",
"logref": 50,
"_links": {
"help": {
"href": "http://.../"
}
}
},
{
"message": "\"postcode\" field validation failed",
"logref": 55,
"_links": {
"help": {
"href": "http://.../"
}
}
}
]
}
}

28
src/test/resources/org/springframework/hateoas/mediatype/vnderror/vnderror-nested.json Normal file
View File

@@ -0,0 +1,28 @@
{
"message": "Validation failed",
"logref": 42,
"_links": {
"describes": {
"href": "http://path.to/describes"
},
"help": {
"href": "http://path.to/help"
},
"about": {
"href": "http://path.to/user/resource/1"
}
},
"_embedded": {
"errors": [
{
"message": "Username must contain at least three characters",
"path": "/username",
"_links": {
"about": {
"href": "http://path.to/user/resource/1"
}
}
}
]
}
}

16
src/test/resources/org/springframework/hateoas/mediatype/vnderror/vnderror-single-item.json Normal file
View File

@@ -0,0 +1,16 @@
{
"message": "Validation failed",
"path": "/username",
"logref": 42,
"_links": {
"about": {
"href": "http://path.to/user/resource/1"
},
"describes": {
"href": "http://path.to/describes"
},
"help": {
"href": "http://path.to/help"
}
}
}

34
src/test/resources/vnderror.json
View File

@@ -1,34 +0,0 @@
[ {
"logref" : "42",
"message" : "Validation failed!",
"_links" : {
"describes" : {
"href" : "http://..."
},
"help" : {
"href" : "http://..."
}
}
}, {
"logref" : "42",
"message" : "Validation failed!",
"_links" : {
"describes" : {
"href" : "http://..."
},
"help" : {
"href" : "http://..."
}
}
}, {
"logref" : "42",
"message" : "Validation failed!",
"_links" : {
"describes" : {
"href" : "http://..."
},
"help" : {
"href" : "http://..."
}
}
} ]

34
src/test/resources/vnderror2.json
View File

@@ -1,34 +0,0 @@
[ {
"logref" : "42",
"message" : "Validation failed!",
"_links" : {
"describes" : {
"href" : "http://..."
},
"help" : {
"href" : "http://..."
}
}
}, {
"logref" : "42",
"message" : "Validation failed!",
"_links" : {
"describes" : {
"href" : "http://..."
},
"help" : {
"href" : "http://..."
}
}
}, {
"logref" : "42",
"message" : "Validation failed!",
"_links" : {
"describes" : {
"href" : "http://..."
},
"help" : {
"href" : "http://..."
}
}
} ]