Add new tests to improve coverage of JSONCompare

hertzsprung · hertzsprung · commit d254e7e510ae · 2012-09-16T01:37:46.000+01:00
diff --git a/pom.xml b/pom.xml
@@ -63,7 +63,7 @@
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>
-            <version>4.0</version>
+            <version>4.10</version>
             <scope>test</scope>
         </dependency>
     </dependencies>
diff --git a/src/main/java/org/skyscreamer/jsonassert/JSONCompareResult.java b/src/main/java/org/skyscreamer/jsonassert/JSONCompareResult.java
@@ -135,4 +135,9 @@ private String formatFailureMessage(String field, Object expected, Object actual
         message.append("\n");
         return message.toString();
     }
+
+    @Override
+    public String toString() {
+        return _message;
+    }
 }
diff --git a/src/test/java/org/skyscreamer/jsonassert/JSONCompareTest.java b/src/test/java/org/skyscreamer/jsonassert/JSONCompareTest.java
@@ -0,0 +1,82 @@
+package org.skyscreamer.jsonassert;
+
+import static org.hamcrest.core.IsEqual.equalTo;
+import static org.junit.Assert.assertThat;
+import static org.junit.Assert.assertTrue;
+import static org.skyscreamer.jsonassert.JSONCompare.compareJSON;
+import static org.skyscreamer.jsonassert.JSONCompareMode.LENIENT;
+import static org.skyscreamer.jsonassert.JSONCompareMode.NON_EXTENSIBLE;
+
+import org.hamcrest.Description;
+import org.hamcrest.Matcher;
+import org.json.JSONException;
+import org.junit.Ignore;
+import org.junit.Test;
+import org.junit.internal.matchers.TypeSafeMatcher;
+
+/**
+ * Unit tests for {@code JSONCompare}.
+ */
+public class JSONCompareTest {
+    @Test
+    public void reportsWrongSimpleValueCountInUnorderedArray() throws JSONException {
+        JSONCompareResult result = compareJSON("[5, 5]", "[5, 7]", LENIENT);
+        assertThat(result, failsWithMessage(equalTo("[]: Expected contains 2 5 actual contains 1 ; []: Contains 7, but not expected")));
+    }
+
+    @Test
+    public void reportsMissingJSONObjectWithUniqueKeyInUnorderedArray() throws JSONException {
+        JSONCompareResult result = compareJSON("[{\"id\" : 3}]", "[{\"id\" : 5}]", LENIENT);
+        assertThat(result, failsWithMessage(equalTo("[]: Expected but did not find object where id=3 ; " +
+                "[]: Contains object where \" + uniqueKey + \"=\" + id + \", but not expected")));
+    }
+
+    @Test
+    public void reportsUnmatchedJSONObjectInUnorderedArray() throws JSONException {
+        JSONCompareResult result = compareJSON("[{\"address\" : {\"street\" : \"Acacia Avenue\"}}]", "[{\"age\" : 23}]", LENIENT);
+        assertThat(result, failsWithMessage(equalTo("Could not find match for element {\"age\":23}")));
+    }
+
+    @Test
+    public void succeedsWithNestedJSONObjectsInUnorderedArray() throws JSONException {
+        assertTrue(compareJSON("[{\"address\" : {\"street\" : \"Acacia Avenue\"}}, 5]", "[5, {\"address\" : {\"street\" : \"Acacia Avenue\"}}]", LENIENT).passed());
+    }
+
+    @Test
+    public void succeedsWithJSONObjectsWithNonUniqueKeyInUnorderedArray() throws JSONException {
+        String jsonDocument = "[{\"age\" : 43}, {\"age\" : 43}]";
+        assertTrue(compareJSON(jsonDocument, jsonDocument, LENIENT).passed());
+    }
+
+    @Test
+    public void succeedsWithSomeNestedJSONObjectsInUnorderedArray() throws JSONException {
+        String jsonDocument = "[{\"age\" : 43}, {\"age\" : {\"years\" : 43}}]";
+        assertTrue(compareJSON(jsonDocument, jsonDocument, LENIENT).passed());
+    }
+
+    @Test
+    public void reportsUnmatchesIntegerValueInUnorderedArrayContainingJSONObject() throws JSONException {
+        JSONCompareResult result = compareJSON("[{\"address\" : {\"street\" : \"Acacia Avenue\"}}, 5]", "[{\"address\" : {\"street\" : \"Acacia Avenue\"}}, 2]", LENIENT);
+        assertThat(result, failsWithMessage(equalTo("Could not find match for element 2")));
+    }
+
+    @Test
+    @Ignore // currently failing
+    public void failing() throws JSONException {
+        compareJSON("[{\"id\": 3}]", "[{}]", NON_EXTENSIBLE);
+    }
+
+    private Matcher<JSONCompareResult> failsWithMessage(final Matcher<String> expectedMessage) {
+        return new TypeSafeMatcher<JSONCompareResult>() {
+            @Override
+            public void describeTo(Description description) {
+                description.appendText("a failed comparison with message ").appendDescriptionOf(expectedMessage);
+            }
+
+            @Override
+            public boolean matchesSafely(JSONCompareResult item) {
+                return item.failed() && expectedMessage.matches(item.getMessage());
+            }
+        };
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -135,4 +135,9 @@ private String formatFailureMessage(String field, Object expected, Object actual`
`135`	`135`	`message.append("\n");`
`136`	`136`	`return message.toString();`
`137`	`137`	`}`
	`138`	`+`
	`139`	`+ @Override`
	`140`	`+ public String toString() {`
	`141`	`+ return _message;`
	`142`	`+ }`
`138`	`143`	`}`