chore: add test for affordances (Spring-HATEOAS, HAL-FORMS)

toedter · Mar 12, 2022 · a6837c2 · a6837c2
1 parent e18109b
commit a6837c2
Show file tree

Hide file tree

Showing 4 changed files with 133 additions and 28 deletions.
diff --git a/.../java/org/springframework/hateoas/mediatype/hal/forms/HalFormsTemplateBuilderWrapper.java b/.../java/org/springframework/hateoas/mediatype/hal/forms/HalFormsTemplateBuilderWrapper.java
@@ -43,8 +43,7 @@ public static Object write(Object bean) {
 		try {
 			return halFormsTemplatePropertyWriter.value(bean, null, null);
 		} catch (Exception e) {
-			e.printStackTrace();
+			throw new IllegalArgumentException("Cannot write HAL-FORMS template.", e);
 		}
-		return null;
 	}
 }
diff --git a/lib/src/test/java/com/toedter/spring/hateoas/jsonapi/Jackson2JsonApiIntegrationTest.java b/lib/src/test/java/com/toedter/spring/hateoas/jsonapi/Jackson2JsonApiIntegrationTest.java
@@ -29,13 +29,16 @@
 import org.junit.jupiter.api.*;
 import org.springframework.core.io.ClassPathResource;
 import org.springframework.hateoas.*;
+import org.springframework.hateoas.mediatype.Affordances;
+import org.springframework.http.HttpMethod;
 
 import javax.persistence.Id;
 import java.io.File;
 import java.time.Instant;
 import java.util.*;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.springframework.hateoas.server.mvc.WebMvcLinkBuilder.*;
 
 @DisplayNameGeneration(DisplayNameGenerator.ReplaceUnderscores.class)
 @DisplayName("Jackson2JsonApi Integration Test")
@@ -73,8 +76,8 @@ class Movie {
             private final String title = "Star Wars";
         }
 
-        String jsonMovie = mapper.writeValueAsString(EntityModel.of(new Movie()));
-        compareWithFile(jsonMovie, "movieEntityModel.json");
+        String movieJson = mapper.writeValueAsString(EntityModel.of(new Movie()));
+        compareWithFile(movieJson, "movieEntityModel.json");
     }
 
     @Test
@@ -89,8 +92,8 @@ public String retrieveMyId() {
             }
         }
 
-        String jsonMovie = mapper.writeValueAsString(EntityModel.of(new Movie()));
-        compareWithFile(jsonMovie, "movieEntityModel.json");
+        String movieJson = mapper.writeValueAsString(EntityModel.of(new Movie()));
+        compareWithFile(movieJson, "movieEntityModel.json");
     }
 
     @Test
@@ -105,8 +108,8 @@ public String getMyId() {
             }
         }
 
-        String jsonMovie = mapper.writeValueAsString(EntityModel.of(new Movie()));
-        compareWithFile(jsonMovie, "movieEntityModel.json");
+        String movieJson = mapper.writeValueAsString(EntityModel.of(new Movie()));
+        compareWithFile(movieJson, "movieEntityModel.json");
     }
 
     @Test
@@ -121,8 +124,8 @@ public String getId() {
             }
         }
 
-        String jsonMovie = mapper.writeValueAsString(EntityModel.of(new Movie()));
-        compareWithFile(jsonMovie, "movieEntityModel.json");
+        String movieJson = mapper.writeValueAsString(EntityModel.of(new Movie()));
+        compareWithFile(movieJson, "movieEntityModel.json");
     }
 
     @Test
@@ -143,8 +146,8 @@ public String getId() {
             }
         }
 
-        String jsonMovie = mapper.writeValueAsString(EntityModel.of(new Movie()));
-        compareWithFile(jsonMovie, "movieEntityModel.json");
+        String movieJson = mapper.writeValueAsString(EntityModel.of(new Movie()));
+        compareWithFile(movieJson, "movieEntityModel.json");
     }
 
     @Test
@@ -156,8 +159,8 @@ class Movie {
             private final String title = "Star Wars";
         }
 
-        String jsonMovie = mapper.writeValueAsString(EntityModel.of(new Movie()));
-        compareWithFile(jsonMovie, "movieEntityModel.json");
+        String movieJson = mapper.writeValueAsString(EntityModel.of(new Movie()));
+        compareWithFile(movieJson, "movieEntityModel.json");
     }
 
     @Test
@@ -172,29 +175,29 @@ class Movie {
             private final String title = "Star Wars";
         }
 
-        String jsonMovie = mapper.writeValueAsString(EntityModel.of(new Movie()));
-        compareWithFile(jsonMovie, "movieEntityModel.json");
+        String movieJson = mapper.writeValueAsString(EntityModel.of(new Movie()));
+        compareWithFile(movieJson, "movieEntityModel.json");
     }
 
     @Test
     void should_serialize_entity_model_with_annotated_jsonapi_id_and_type_and_meta_fields() throws Exception {
-        String jsonMovie = mapper.writeValueAsString(
+        String movieJson = mapper.writeValueAsString(
                 EntityModel.of(new MovieWithAnnotations("1", "my-movies", "metaValue", "Star Wars")));
-        compareWithFile(jsonMovie, "movieEntityModelWithThreeAnnotations.json");
+        compareWithFile(movieJson, "movieEntityModelWithThreeAnnotations.json");
     }
 
     @Test
     void should_serialize_entity_model_with_annotated_jsonapi_id_and_type_methods() throws Exception {
-        String jsonMovie = mapper.writeValueAsString(
+        String movieJson = mapper.writeValueAsString(
                 EntityModel.of(new MovieWithGetters("1", "Star Wars", "my-movies", "metaValue")));
-        compareWithFile(jsonMovie, "movieEntityModelWithThreeAnnotations.json");
+        compareWithFile(movieJson, "movieEntityModelWithThreeAnnotations.json");
     }
 
     @Test
     void should_serialize_entity_model_with_annotated_type_on_class() throws Exception {
-        String jsonMovie = mapper.writeValueAsString(
+        String movieJson = mapper.writeValueAsString(
                 EntityModel.of(new MovieDerivedWithTypeForClass("1", "Star Wars")));
-        compareWithFile(jsonMovie, "movieEntityModelWithAnnotations.json");
+        compareWithFile(movieJson, "movieEntityModelWithAnnotations.json");
     }
 
     @Test
@@ -981,8 +984,8 @@ class Movie {
             private String type = "MyObjectType";
         }
 
-        String jsonMovie = mapper.writeValueAsString(EntityModel.of(new Movie()));
-        compareWithFile(jsonMovie, "movieWithTypeAttribute.json");
+        String movieJson = mapper.writeValueAsString(EntityModel.of(new Movie()));
+        compareWithFile(movieJson, "movieWithTypeAttribute.json");
     }
 
     @Test
@@ -1014,8 +1017,8 @@ class Movie {
             private String metaProperty = "metaValue";
         }
 
-        String jsonMovie = mapper.writeValueAsString(EntityModel.of(new Movie()));
-        compareWithFile(jsonMovie, "movieEntityModelWithMeta.json");
+        String movieJson = mapper.writeValueAsString(EntityModel.of(new Movie()));
+        compareWithFile(movieJson, "movieEntityModelWithMeta.json");
     }
 
     @Test
@@ -1030,8 +1033,8 @@ public String getMetaProperty() {
             }
         }
 
-        String jsonMovie = mapper.writeValueAsString(EntityModel.of(new Movie()));
-        compareWithFile(jsonMovie, "movieEntityModelWithMeta.json");
+        String movieJson = mapper.writeValueAsString(EntityModel.of(new Movie()));
+        compareWithFile(movieJson, "movieEntityModelWithMeta.json");
     }
 
     @Test
@@ -1054,6 +1057,38 @@ void should_deserialize_jsonapimeta_method_annotation() throws Exception {
         assertThat(entityModel.getContent().getMetaProperty()).isEqualTo("metaValue");
     }
 
+    @Test
+    void should_serialize_affordance_with_proprietary_format() throws Exception {
+        Link link = Affordances.of(Link.of("/"))
+                .afford(HttpMethod.POST)
+                .withInputAndOutput(Movie.class) //
+                .withName("create-movie") //
+                .toLink();
+
+        RepresentationModel<?> movieModel = CollectionModel.of(Collections.singletonList(new Movie("1", "New Movie")), link);
+
+        mapper = createObjectMapper(new JsonApiConfiguration()
+                .withAffordancesRenderedAsLinkMeta(JsonApiConfiguration.AffordanceType.SPRING_HATEOAS));
+        String moviesJson = mapper.writeValueAsString(movieModel);
+        compareWithFile(moviesJson, "moviesCollectionModelWithAffordances.json");
+    }
+
+    @Test
+    void should_serialize_affordance_with_hal_forms_format() throws Exception {
+        Link link = Affordances.of(Link.of("/"))
+                .afford(HttpMethod.POST)
+                .withInputAndOutput(Movie.class) //
+                .withName("create-movie") //
+                .toLink();
+
+        RepresentationModel<?> movieModel = CollectionModel.of(Collections.singletonList(new Movie("1", "New Movie")), link);
+
+        mapper = createObjectMapper(new JsonApiConfiguration()
+                .withAffordancesRenderedAsLinkMeta(JsonApiConfiguration.AffordanceType.HAL_FORMS));
+        String moviesJson = mapper.writeValueAsString(movieModel);
+        compareWithFile(moviesJson, "moviesCollectionModelWithHalFormsAffordances.json");
+    }
+
     private void compareWithFile(String json, String fileName) throws Exception {
         File file = new ClassPathResource(fileName, getClass()).getFile();
         ObjectMapper objectMapper = new ObjectMapper();

diff --git a/...st/resources/com/toedter/spring/hateoas/jsonapi/moviesCollectionModelWithAffordances.json b/...st/resources/com/toedter/spring/hateoas/jsonapi/moviesCollectionModelWithAffordances.json
@@ -0,0 +1,38 @@
+{
+  "data": [
+    {
+      "id": "1",
+      "type": "movies",
+      "attributes": {
+        "title": "New Movie"
+      }
+    }
+  ],
+  "links": {
+    "self": {
+      "href": "/",
+      "meta": {
+        "affordances": [
+          {
+            "name": "create-movie",
+            "link": {
+              "rel": "self",
+              "href": "/"
+            },
+            "httpMethod": "POST",
+            "inputProperties": [
+              {
+                "name": "id",
+                "type": "text"
+              },
+              {
+                "name": "title",
+                "type": "text"
+              }
+            ]
+          }
+        ]
+      }
+    }
+  }
+}
diff --git a/...rces/com/toedter/spring/hateoas/jsonapi/moviesCollectionModelWithHalFormsAffordances.json b/...rces/com/toedter/spring/hateoas/jsonapi/moviesCollectionModelWithHalFormsAffordances.json
@@ -0,0 +1,33 @@
+{
+  "data": [
+    {
+      "id": "1",
+      "type": "movies",
+      "attributes": {
+        "title": "New Movie"
+      }
+    }
+  ],
+  "links": {
+    "self": {
+      "href": "/",
+      "meta": {
+        "_templates": {
+          "default": {
+            "method": "POST",
+            "properties": [
+              {
+                "name": "id",
+                "type": "text"
+              },
+              {
+                "name": "title",
+                "type": "text"
+              }
+            ]
+          }
+        }
+      }
+    }
+  }
+}