Unit tests which demonstrate bugs with recursion:

- SameObjectTest demonstrates that two different relationships which share the same relationship url should result in the same object being set for each relationship
- ContinueTest demonstrates that when two identical relationship urls are proccessed, the resolution algorithm should continue to process the remaining relationships, rather than breaking out

Author: emetsger

src/test/java/com/github/jasminb/jsonapi/models/recursion/BizRelNode.java

@@ -0,0 +1,83 @@
+/*
+ * Copyright 2016 Johns Hopkins University
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.github.jasminb.jsonapi.models.recursion;
+
+import com.github.jasminb.jsonapi.ResolutionStrategy;
+import com.github.jasminb.jsonapi.annotations.Id;
+import com.github.jasminb.jsonapi.annotations.Relationship;
+import com.github.jasminb.jsonapi.annotations.Type;
+
+/**
+ * Created by esm on 10/1/16.
+ */
+@Type("bizrelnode")
+public class BizRelNode {
+
+    @Id
+    private String id;
+
+    @Relationship(value = "bizrel", resolve = true, strategy = ResolutionStrategy.REF)
+    private String bizrel;
+
+    @Relationship(value = "parent", resolve = true)
+    private Node parent;
+
+    @Relationship(value = "node", resolve = true)
+    private Node node;
+
+    private String name;
+
+    public String getId() {
+        return id;
+    }
+
+    public void setId(String id) {
+        this.id = id;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public Node getParent() {
+        return parent;
+    }
+
+    public void setParent(Node parent) {
+        this.parent = parent;
+    }
+
+    public Node getNode() {
+        return node;
+    }
+
+    public void setNode(Node node) {
+        this.node = node;
+    }
+
+    public String getBizrel() {
+        return bizrel;
+    }
+
+    public void setBizrel(String bizrel) {
+        this.bizrel = bizrel;
+    }
+
+}

src/test/java/com/github/jasminb/jsonapi/models/recursion/Continue.java

@@ -0,0 +1,82 @@
+/*
+ * Copyright 2016 Johns Hopkins University
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.github.jasminb.jsonapi.models.recursion;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.github.jasminb.jsonapi.ProbeResolver;
+import com.github.jasminb.jsonapi.ResourceConverter;
+import com.github.jasminb.jsonapi.annotations.Type;
+import org.junit.Test;
+
+import java.nio.charset.Charset;
+import java.util.HashMap;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertSame;
+
+/**
+ * Insures that all relationships get resolved when there are multiple relationships in a single JSON object point to
+ * the same thing.
+ * <p>
+ * There was a bug in the code that prevented recursive loops: when it found a relationship URL that had been resolved,
+ * it simply returned.  The proper behavior, however, is to 1) set the object for the relationship, even if the
+ * relationship has already been seen, and 2) <em>continue</em> the loop (rather than breaking) to process additional
+ * relationships.
+ * </p>
+ * <p>
+ * This test insures that relationships continue to be resolved; in this test, the relationship is the "bizrel"
+ * relationship.
+ * </p>
+ */
+@Type("node")
+public class Continue {
+
+    @Test
+    public void testContinue() throws Exception {
+        ObjectMapper mapper = new ObjectMapper();
+
+        Class<BizRelNode> typeUnderTest = BizRelNode.class;
+
+        ProbeResolver resolver = new ProbeResolver(new HashMap<String, String>() {
+            {
+                put("http://example.com/node/1",
+                        org.apache.commons.io.IOUtils.toString(
+                                this.getClass().getResourceAsStream("node-1.json"), Charset.forName("UTF-8")));
+            }
+        });
+
+        ResourceConverter underTest = new ResourceConverter(mapper, typeUnderTest, Node.class);
+        underTest.setGlobalResolver(resolver);
+
+        BizRelNode node = underTest.readObject(
+                org.apache.commons.io.IOUtils.toByteArray(
+                        this.getClass().getResource("continue.json")), typeUnderTest);
+
+        // Sanity
+
+        assertNotNull(node);
+        assertEquals("3", node.getId());
+        assertEquals("bar", node.getName());
+        assertNotNull(node.getNode());
+        assertNotNull(node.getParent());
+        assertSame(node.getNode(), node.getParent());
+
+        // The bizrel relationship should be set.
+
+        assertEquals("http://www.google.com", node.getBizrel());
+    }
+}

src/test/java/com/github/jasminb/jsonapi/models/recursion/Node.java

@@ -0,0 +1,70 @@
+/*
+ * Copyright 2016 Johns Hopkins University
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.github.jasminb.jsonapi.models.recursion;
+
+import com.github.jasminb.jsonapi.annotations.Id;
+import com.github.jasminb.jsonapi.annotations.Relationship;
+import com.github.jasminb.jsonapi.annotations.Type;
+
+/**
+ * Created by esm on 10/1/16.
+ */
+@Type("node")
+public class Node {
+
+    @Id
+    private String id;
+
+    private String name;
+
+    @Relationship(value = "parent", resolve = true)
+    private Node parent;
+
+    @Relationship(value = "node", resolve = true)
+    private Node node;
+
+    public String getId() {
+        return id;
+    }
+
+    public void setId(String id) {
+        this.id = id;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public Node getParent() {
+        return parent;
+    }
+
+    public void setParent(Node parent) {
+        this.parent = parent;
+    }
+
+    public Node getNode() {
+        return node;
+    }
+
+    public void setNode(Node node) {
+        this.node = node;
+    }
+}

src/test/java/com/github/jasminb/jsonapi/models/recursion/SameObjectTest.java

@@ -0,0 +1,79 @@
+/*
+ * Copyright 2016 Johns Hopkins University
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.github.jasminb.jsonapi.models.recursion;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.PropertyNamingStrategy;
+import com.github.jasminb.jsonapi.ProbeResolver;
+import com.github.jasminb.jsonapi.ResourceConverter;
+import org.junit.Assert;
+import org.junit.Test;
+
+import java.nio.charset.Charset;
+import java.util.HashMap;
+
+import static org.junit.Assert.assertSame;
+
+/**
+ * Insures that all relationships get resolved when multiple relationships in a single JSON object point to the same
+ * thing.
+ * <p>
+ * There was a bug in the code that prevented recursive loops: when it found a relationship URL that had been resolved,
+ * it simply returned.  The proper behavior, however, is to 1) set the object for the relationship, even if the
+ * relationship has already been seen, and 2) <em>continue</em> the loop (rather than breaking) to process additional
+ * relationships.
+ * </p>
+ * <p>
+ * This test insures that the objects for a relationship that are seen twice are properly set.  In this test, the
+ * relationship url for the "parent" and "node" relationships is the same.  The deserialized java object should have
+ * the same object for both fields.
+ * </p>
+ */
+public class SameObjectTest {
+
+    @Test
+    public void testSameObject() throws Exception {
+        ObjectMapper mapper = new ObjectMapper();
+        mapper.setPropertyNamingStrategy(PropertyNamingStrategy.KEBAB_CASE);
+
+        Class<Node> typeUnderTest = Node.class;
+
+        ProbeResolver resolver = new ProbeResolver(new HashMap<String, String>() {
+            {
+                put("http://example.com/node/1",
+                        org.apache.commons.io.IOUtils.toString(
+                                this.getClass().getResourceAsStream("node-1.json"), Charset.forName("UTF-8")));
+            }
+        });
+
+        ResourceConverter underTest = new ResourceConverter(mapper, typeUnderTest);
+        underTest.setGlobalResolver(resolver);
+
+        Node node = underTest.readObject(
+                org.apache.commons.io.IOUtils.toByteArray(
+                        this.getClass().getResource("same-object.json")), typeUnderTest);
+
+        // Sanity
+
+        Assert.assertNotNull(node);
+        Assert.assertEquals("2", node.getId());
+        Assert.assertEquals("foo", node.getName());
+
+        // The Node object returned from getNode() and getParent() should be the same
+
+        assertSame(node.getParent(), node.getNode());
+    }
+}

src/test/resources/com/github/jasminb/jsonapi/models/recursion/continue.json

@@ -0,0 +1,33 @@
+{
+  "data":
+  {
+    "relationships": {
+      "parent": {
+        "links": {
+          "self": {
+            "href": "http://example.com/node/1"
+          }
+        }
+      },
+      "node": {
+        "links": {
+          "self": {
+            "href": "http://example.com/node/1"
+          }
+        }
+      },
+      "bizrel": {
+        "links": {
+          "self": {
+            "href": "http://www.google.com"
+          }
+        }
+      }
+    },
+    "attributes": {
+      "name": "bar"
+    },
+    "type": "bizrelnode",
+    "id": "3"
+  }
+}

src/test/resources/com/github/jasminb/jsonapi/models/recursion/node-1.json

@@ -0,0 +1,9 @@
+{
+  "data": {
+    "attributes": {
+      "name": "bar"
+    },
+    "type": "node",
+    "id": "1"
+  }
+}

src/test/resources/com/github/jasminb/jsonapi/models/recursion/same-object.json

@@ -0,0 +1,26 @@
+{
+  "data":
+    {
+      "relationships": {
+        "parent": {
+          "links": {
+            "self": {
+              "href": "http://example.com/node/1"
+            }
+          }
+        },
+        "node": {
+          "links": {
+            "self": {
+              "href": "http://example.com/node/1"
+            }
+          }
+        }
+      },
+      "attributes": {
+        "name": "foo"
+      },
+      "type": "node",
+      "id": "2"
+    }
+}