Merge pull request skyscreamer#7 from hertzsprung/comparison-result-fields

carterpage · carterpage · commit b4513d8349f0 · 2012-08-25T14:11:07.000-07:00
Expose field, actual and expected values through JSONCompareResult
diff --git a/src/main/java/org/skyscreamer/jsonassert/JSONCompareResult.java b/src/main/java/org/skyscreamer/jsonassert/JSONCompareResult.java
@@ -6,6 +6,9 @@
 public class JSONCompareResult {
     private boolean _success;
     private String _message;
+    private String _field;
+    private Object _expected;
+    private Object _actual;
 
     /**
      * Default constructor.
@@ -42,6 +45,45 @@ public boolean failed() {
     public String getMessage() {
         return _message;
     }
+
+    /**
+     * Actual field value
+     * 
+     * @return a {@code JSONObject}, {@code JSONArray} or other {@code Object}
+     *         instance, or {@code null} if the comparison did not fail on a
+     *         particular field
+     */
+    public Object getActual() {
+        return _actual;
+    }
+    
+    /**
+     * Expected field value
+     * 
+     * @return a {@code JSONObject}, {@code JSONArray} or other {@code Object}
+     *         instance, or {@code null} if the comparison did not fail on a
+     *         particular field
+     */
+    public Object getExpected() {
+        return _expected;
+    }
+    
+    /**
+     * Check if comparison failed on a particular field
+     */
+    public boolean isFailureOnField() {
+        return _field != null;
+    }
+
+    /**
+     * Dot-separated path the the field that failed comparison
+     * 
+     * @return a {@code String} instance, or {@code null} if the comparison did
+     *         not fail on a particular field
+     */
+    public String getField() {
+        return _field;
+    }
     
     protected void fail(String message) {
         _success = false;
@@ -54,13 +96,20 @@ protected void fail(String message) {
     }
 
     protected void fail(String field, Object expected, Object actual) {
+        this._field = field;
+        this._expected = expected;
+        this._actual = actual;
+        fail(formatFailureMessage(field, expected, actual));
+    }
+
+    private String formatFailureMessage(String field, Object expected, Object actual) {
         StringBuffer message= new StringBuffer();
         message.append(field);
         message.append("\nExpected: ");
         message.append(expected + "");
         message.append("\n     got: ");
         message.append(actual + "");
         message.append("\n");
-        fail(message.toString());
+        return message.toString();
     }
 }
diff --git a/src/test/java/org/skyscreamer/jsonassert/JSONAssertTest.java b/src/test/java/org/skyscreamer/jsonassert/JSONAssertTest.java
@@ -135,6 +135,14 @@ public void testArrayOfArraysStrict() throws JSONException {
     public void testArrayOfArrays() throws JSONException {
         testPass("{id:1,stuff:[[4,3],[3,2],[],[1,2]]}", "{id:1,stuff:[[1,2],[2,3],[],[3,4]]}", false);
     }
+    
+    @Test
+    public void testFieldMismatch() throws JSONException {
+        JSONCompareResult result = JSONCompare.compareJSON("{name:\"Pat\"}", "{name:\"Sue\"}", STRICT);
+        Assert.assertEquals("Pat", result.getExpected());
+        Assert.assertEquals("Sue", result.getActual());
+        Assert.assertEquals("name", result.getField());
+    }
 
     @Test
     public void testNullProperty() throws JSONException {
