finishing and adding javadoc to ValidationException#toJSON()

Author: erosb

core/pom.xml

@@ -19,11 +19,6 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
-  <parent>
-    <groupId>org.everit.config</groupId>
-    <artifactId>org.everit.config.oss</artifactId>
-    <version>7.2.0</version>
-  </parent>
   <groupId>org.everit.json</groupId>
   <artifactId>org.everit.json.schema</artifactId>
   <version>1.4.0</version>

core/src/main/java/org/everit/json/schema/ValidationException.java

@@ -273,6 +273,9 @@ public String getMessage() {
    * @return the JSON pointer
    */
   public String getPointerToViolation() {
+    if (pointerToViolation == null) {
+      return null;
+    }
     return pointerToViolation.toString();
   }
 
@@ -322,12 +325,37 @@ public String getKeyword() {
     return keyword;
   }
 
+  /**
+   * Creates a JSON representation of the failure.
+   *
+   * The returned {@code JSONObject} contains the following keys:
+   * <ul>
+   * <li>{@code "message"}: a programmer-friendly exception message. This value is a non-nullable
+   * string.</li>
+   * <li>{@code "keyword"}: a JSON Schema keyword which was used in the schema and violated by the
+   * input JSON. This value is a nullable string.</li>
+   * <li>{@code "pointerToViolation"}: a JSON Pointer denoting the path from the root of the
+   * document to the invalid fragment of it. This value is a non-nullable string. See
+   * {@link #getPointerToViolation()}</li>
+   * <li>{@code "causingExceptions"}: is a (possibly empty) array of violations which caused this
+   * exceptions. See {@link #getCausingExceptions()}</li>
+   * </ul>
+   *
+   * @return a JSON description of the validation error
+   */
   public JSONObject toJSON() {
     JSONObject rval = new JSONObject();
     rval.put("keyword", keyword);
-    rval.put("pointerToViolation", getPointerToViolation());
-    rval.put("message", getMessage());
-    rval.put("causingExceptions", new JSONArray());
+    if (pointerToViolation == null) {
+      rval.put("pointerToViolation", JSONObject.NULL);
+    } else {
+      rval.put("pointerToViolation", getPointerToViolation());
+    }
+    rval.put("message", super.getMessage());
+    List<JSONObject> causeJsons = causingExceptions.stream()
+        .map(ValidationException::toJSON)
+        .collect(Collectors.toList());
+    rval.put("causingExceptions", new JSONArray(causeJsons));
     return rval;
   }
 }

core/src/test/java/org/everit/json/schema/ValidationExceptionTest.java

@@ -192,20 +192,39 @@ public void testToJSON() {
     ValidationException subject =
         new ValidationException(BooleanSchema.INSTANCE, new StringBuilder("#/a/b"),
             "exception message", Collections.emptyList(), "type");
-    JSONObject expected = new JSONObject(new JSONTokener(
-        getClass().getResourceAsStream("/org/everit/jsonvalidator/exception-to-json.json")));
+    JSONObject expected = readFile("/org/everit/jsonvalidator/exception-to-json.json");
+    JSONObject actual = subject.toJSON();
+    Assert.assertTrue(ObjectComparator.deepEquals(expected, actual));
+  }
+
+  private JSONObject readFile(final String absPath) {
+    return new JSONObject(new JSONTokener(
+        getClass().getResourceAsStream(absPath)));
+  }
+
+  @Test
+  public void toJSONNullPointerToViolation() {
+    ValidationException subject =
+        new ValidationException(BooleanSchema.INSTANCE, null,
+            "exception message", Collections.emptyList(), "type");
+    JSONObject actual = subject.toJSON();
+    Assert.assertEquals(JSONObject.NULL, actual.get("pointerToViolation"));
+  }
 
+  @Test
+  public void toJSONWithCauses() {
+    ValidationException cause =
+        new ValidationException(NullSchema.INSTANCE,
+            new StringBuilder("#/a/0"),
+            "cause msg",
+            Collections.emptyList(),
+            "type");
+    ValidationException subject =
+        new ValidationException(BooleanSchema.INSTANCE, new StringBuilder("#/a"),
+            "exception message", Arrays.asList(cause), "type");
+    JSONObject expected = readFile("/org/everit/jsonvalidator/exception-to-json-with-causes.json");
     JSONObject actual = subject.toJSON();
-    Assert.assertEquals(4, JSONObject.getNames(actual).length);
-    Assert.assertEquals(expected.get("keyword"), actual.get("keyword"));
-    Assert.assertEquals(expected.get("pointerToViolation"), actual.get("pointerToViolation"));
-    Assert.assertEquals(expected.get("message"), actual.get("message"));
-    // Assert.assertEquals(expected.getJSONArray("causingExceptions"),
-    // actual.getJSONArray("causingExceptions"));
-    Assert.assertTrue(ObjectComparator.deepEquals(expected.getJSONArray("causingExceptions"),
-        actual.getJSONArray("causingExceptions")));
-    Assert.assertTrue(ObjectComparator.deepEquals(expected,
-        actual));
+    Assert.assertTrue(ObjectComparator.deepEquals(expected, actual));
   }
 
 }

core/src/test/resources/org/everit/jsonvalidator/arraytestcases.json

@@ -11,5 +11,5 @@
  	"additionalItemsSchema" : [true, null, null],
  	"additionalItemsSchemaFailure" : [true, null, false],
  	"nonUniqueArrayOfArrays" : [["foo"], ["foo"]],
- 	"uniqueItemsWithSameToString" : [{"a":"b"}, '{"a":"b"}'] 
+ 	"uniqueItemsWithSameToString" : [{"a":"b"}, "{\"a\":\"b\"}"] 
  }

core/src/test/resources/org/everit/jsonvalidator/exception-to-json-with-causes.json

@@ -0,0 +1,13 @@
+{
+	"pointerToViolation" : "#/a",
+	"message" : "exception message",
+	"keyword" : "type",
+	"causingExceptions" : [
+		{
+			"pointerToViolation" : "#/a/0",
+			"message" : "cause msg",
+			"keyword" : "type",
+			"causingExceptions" : [] 
+		}
+	]
+}

core/src/test/resources/org/everit/jsonvalidator/exception-to-json.json

@@ -1,6 +1,6 @@
 {
 	"pointerToViolation" : "#/a/b",
-	"message" : "#/a/b: exception message",
+	"message" : "exception message",
 	"keyword" : "type",
 	"causingExceptions" : []
 }