feat: start storing keywordLocation on error

Author: kylef

Sources/Validation/enum.swift

@@ -14,7 +14,8 @@ func `enum`(context: Context, enum: Any, instance: Any, schema: [String: Any]) -
   return AnySequence([
     ValidationError(
       "'\(instance)' is not a valid enumeration value of '\(`enum`)'",
-      instanceLocation: context.instanceLocation
+      instanceLocation: context.instanceLocation,
+      keywordLocation: context.keywordLocation
     )
   ])
 }

Sources/Validation/required.swift

@@ -12,7 +12,8 @@ func required(context: Context, required: Any, instance: Any, schema: [String: A
     guard !instance.keys.contains(key) else { return nil }
     return ValidationError(
       "Required property '\(key)' is missing",
-      instanceLocation: context.instanceLocation
+      instanceLocation: context.instanceLocation,
+      keywordLocation: context.keywordLocation
     )
   })
 }

Sources/ValidationResult.swift

@@ -1,9 +1,10 @@
 public class ValidationError: Encodable {
   public let description: String
 
-  init(_ value: String, instanceLocation: JSONPointer) {
+  init(_ value: String, instanceLocation: JSONPointer, keywordLocation: JSONPointer? = nil) {
     self.description = value
     self.instanceLocation = instanceLocation
+    self.keywordLocation = keywordLocation
   }
 
   enum CodingKeys: String, CodingKey {
@@ -18,6 +19,7 @@ public class ValidationError: Encodable {
   }
 
   public let instanceLocation: JSONPointer
+  public let keywordLocation: JSONPointer?
 }
 
 

Sources/Validator.swift

@@ -5,6 +5,7 @@ class Context {
   let validator: Validator
 
   var instanceLocation = JSONPointer()
+  var keywordLocation = JSONPointer(path: "#")
 
   init(resolver: RefResolver, validator: Validator) {
     self.resolver = RefResolver(resolver: resolver)
@@ -36,6 +37,8 @@ class Context {
 
     return try AnySequence(validator.validations.compactMap { (key, validation) -> AnySequence<ValidationError> in
       if let value = schema[key] {
+        keywordLocation.push(key)
+        defer { keywordLocation.pop() }
         return try validation(self, value, instance, schema)
       }
 

Tests/JSONSchemaTests/Validation/TestEnum.swift

@@ -0,0 +1,26 @@
+import XCTest
+@testable import JSONSchema
+
+
+class EnumTests: XCTestCase {
+  func testEnumValidationFailure() throws {
+    let schema: [String: Any] = [
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "enum": ["one"],
+    ]
+
+    let result = try validate(["two"], schema: schema)
+
+    switch result {
+    case .valid:
+      XCTFail("Validation should fail")
+    case .invalid(let errors):
+      XCTAssertEqual(errors.count, 1)
+      let error = errors[0]
+
+      //XCTAssertEqual(error.description, "is not a valid enumeration value of '[\"one\"]'")
+      XCTAssertEqual(error.instanceLocation.path, "")
+      XCTAssertEqual(error.keywordLocation?.path, "#/enum")
+    }
+  }
+}

Tests/JSONSchemaTests/Validation/TestRequired.swift

@@ -0,0 +1,28 @@
+import XCTest
+@testable import JSONSchema
+
+
+class RequiredTests: XCTestCase {
+  func testRequiredValidationFailure() throws {
+    let schema: [String: Any] = [
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "items": [
+        "required": ["test"],
+      ]
+    ]
+
+    let result = try validate([[:]], schema: schema)
+
+    switch result {
+    case .valid:
+      XCTFail("Validation should fail")
+    case .invalid(let errors):
+      XCTAssertEqual(errors.count, 1)
+      let error = errors[0]
+
+      XCTAssertEqual(error.description, "Required property 'test' is missing")
+      XCTAssertEqual(error.instanceLocation.path, "/0")
+      XCTAssertEqual(error.keywordLocation?.path, "#/items/required")
+    }
+  }
+}