Merge pull request skyscreamer#50 from riccorazza/patch-1

carterpage · carterpage · commit 797c5c16c393 · 2015-11-10T14:46:37.000-08:00
Update JSONCompareResult.java

Still needs some more work on unit tests, but I'll merge then add those in.
diff --git a/src/main/java/org/skyscreamer/jsonassert/JSONCompareResult.java b/src/main/java/org/skyscreamer/jsonassert/JSONCompareResult.java
@@ -17,6 +17,8 @@ public class JSONCompareResult {
     private Object _expected;
     private Object _actual;
     private final List<FieldComparisonFailure> _fieldFailures = new ArrayList<FieldComparisonFailure>();
+    private final List<FieldComparisonFailure> _fieldMissing = new ArrayList<FieldComparisonFailure>();
+    private final List<FieldComparisonFailure> _fieldUnexpected = new ArrayList<FieldComparisonFailure>();
 
     /**
      * Default constructor.
@@ -60,6 +62,20 @@ public String getMessage() {
     public List<FieldComparisonFailure> getFieldFailures() {
         return Collections.unmodifiableList(_fieldFailures);
     }
+    
+    /**
+     * Get the list of missed on field comparisons
+     */
+    public List<FieldComparisonFailure> getFieldMissing() {
+        return Collections.unmodifiableList(_fieldMissing);
+    }
+    
+    /**
+     * Get the list of failures on field comparisons
+     */
+    public List<FieldComparisonFailure> getFieldUnexpected() {
+        return Collections.unmodifiableList(_fieldUnexpected);
+    }
 
     /**
      * Actual field value
@@ -69,6 +85,7 @@ public List<FieldComparisonFailure> getFieldFailures() {
      *         particular field
      * @deprecated Superseded by {@link #getFieldFailures()}
      */
+    @Deprecated
     public Object getActual() {
         return _actual;
     }
@@ -81,6 +98,7 @@ public Object getActual() {
      *         particular field
      * @deprecated Superseded by {@link #getFieldFailures()}
      */
+    @Deprecated
     public Object getExpected() {
         return _expected;
     }
@@ -91,6 +109,20 @@ public Object getExpected() {
     public boolean isFailureOnField() {
         return !_fieldFailures.isEmpty();
     }
+    
+    /**
+     * Check if comparison failed with missing on any particular fields
+     */
+    public boolean isMissingOnField() {
+        return !_fieldMissing.isEmpty();
+    }
+    
+    /**
+     * Check if comparison failed with unexpected on any particular fields
+     */
+    public boolean isUnexpectedOnField() {
+        return !_fieldUnexpected.isEmpty();
+    }
 
     /**
      * Dot-separated path the the field that failed comparison
@@ -99,6 +131,7 @@ public boolean isFailureOnField() {
      *         not fail on a particular field
      * @deprecated Superseded by {@link #getFieldFailures()}
      */
+    @Deprecated
     public String getField() {
         return _field;
     }
@@ -147,6 +180,7 @@ private String formatFailureMessage(String field, Object expected, Object actual
     }
 
     public JSONCompareResult missing(String field, Object expected) {
+    	_fieldMissing.add(new FieldComparisonFailure(field, expected, null));
         fail(formatMissing(field, expected));
         return this;
     }
@@ -159,6 +193,7 @@ private String formatMissing(String field, Object expected) {
     }
 
     public JSONCompareResult unexpected(String field, Object value) {
+    	_fieldUnexpected.add(new FieldComparisonFailure(field, null, value));
         fail(formatUnexpected(field, value));
         return this;
     }
diff --git a/src/test/java/org/skyscreamer/jsonassert/JSONCompareTest.java b/src/test/java/org/skyscreamer/jsonassert/JSONCompareTest.java
@@ -1,6 +1,7 @@
 package org.skyscreamer.jsonassert;
 
 import static org.hamcrest.core.IsEqual.equalTo;
+import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertThat;
 import static org.junit.Assert.assertTrue;
 import static org.skyscreamer.jsonassert.JSONCompare.compareJSON;
@@ -32,18 +33,22 @@ public void reportsArraysOfUnequalLength() throws JSONException {
     public void reportsArrayMissingExpectedElement() throws JSONException {
         JSONCompareResult result = compareJSON("[4]", "[7]", LENIENT);
         assertThat(result, failsWithMessage(equalTo("[]\nExpected: 4\n     but none found\n ; []\nUnexpected: 7\n")));
+        assertEquals(result.getFieldMissing().size(), 1);
+        assertEquals(result.getFieldUnexpected().size(), 1);
     }
 
     @Test
     public void reportsMismatchedFieldValues() throws JSONException {
         JSONCompareResult result = compareJSON("{\"id\": 3}", "{\"id\": 5}", LENIENT);
         assertThat(result, failsWithMessage(equalTo("id\nExpected: 3\n     got: 5\n")));
+        assertThat(result, failsWithMessage(equalTo("id\nExpected: 3\n     got: 5\n")));
     }
 
     @Test
     public void reportsMissingField() throws JSONException {
         JSONCompareResult result = compareJSON("{\"obj\": {\"id\": 3}}", "{\"obj\": {}}", LENIENT);
         assertThat(result, failsWithMessage(equalTo("obj\nExpected: id\n     but none found\n")));
+        assertEquals(result.getFieldMissing().size(), 1);
     }
 
     @Test
@@ -74,6 +79,7 @@ public void reportsUnexpectedNonNull() throws JSONException {
     public void reportsUnexpectedFieldInNonExtensibleMode() throws JSONException {
         JSONCompareResult result = compareJSON("{\"obj\": {}}", "{\"obj\": {\"id\": 3}}", NON_EXTENSIBLE);
         assertThat(result, failsWithMessage(equalTo("obj\nUnexpected: id\n")));
+        assertEquals(result.getFieldUnexpected().size(), 1);
     }
 
     @Test
@@ -86,13 +92,16 @@ public void reportsMismatchedTypes() throws JSONException {
     public void reportsWrongSimpleValueCountInUnorderedArray() throws JSONException {
         JSONCompareResult result = compareJSON("[5, 5]", "[5, 7]", LENIENT);
         assertThat(result, failsWithMessage(equalTo("[]: Expected 2 occurrence(s) of 5 but got 1 occurrence(s) ; []\nUnexpected: 7\n")));
+        assertEquals(result.getFieldUnexpected().size(), 1);
     }
 
     @Test
     public void reportsMissingJSONObjectWithUniqueKeyInUnorderedArray() throws JSONException {
         JSONCompareResult result = compareJSON("[{\"id\" : 3}]", "[{\"id\" : 5}]", LENIENT);
         assertThat(result, failsWithMessage(equalTo("[id=3]\nExpected: a JSON object\n     but none found\n ; " +
                 "[id=5]\nUnexpected: a JSON object\n")));
+        assertEquals(result.getFieldMissing().size(), 1);
+        assertEquals(result.getFieldUnexpected().size(), 1);
     }
 
     @Test
