feat: store keyword location on all errors

kylef · kylef · commit 2d0f17fbbf6a · 2021-03-28T20:04:33.000+01:00
diff --git a/Sources/Applicators/anyOf.swift b/Sources/Applicators/anyOf.swift
@@ -7,7 +7,8 @@ func anyOf(context: Context, anyOf: Any, instance: Any, schema: [String: Any]) t
     return AnySequence([
       ValidationError(
         "\(instance) does not meet anyOf validation rules.",
-        instanceLocation: context.instanceLocation
+        instanceLocation: context.instanceLocation,
+        keywordLocation: context.keywordLocation
       ),
     ])
   }
diff --git a/Sources/Applicators/contains.swift b/Sources/Applicators/contains.swift
@@ -31,7 +31,8 @@ func contains(context: Context, contains: Any, instance: Any, schema: [String: A
     return AnySequence([
       ValidationError(
         "\(instance) does not match contains + maxContains \(max)",
-        instanceLocation: context.instanceLocation
+        instanceLocation: context.instanceLocation,
+        keywordLocation: context.keywordLocation
       )
     ])
   }
@@ -43,7 +44,8 @@ func contains(context: Context, contains: Any, instance: Any, schema: [String: A
   return AnySequence([
     ValidationError(
       "'\(instance) does not match contains",
-      instanceLocation: context.instanceLocation
+      instanceLocation: context.instanceLocation,
+      keywordLocation: context.keywordLocation
     )
   ])
 }
diff --git a/Sources/Applicators/dependencies.swift b/Sources/Applicators/dependencies.swift
@@ -16,7 +16,8 @@ func dependencies(context: Context, dependencies: Any, instance: Any, schema: [S
           results.append(AnySequence([
             ValidationError(
               "'\(key)' is a dependency for '\(property)'",
-              instanceLocation: context.instanceLocation
+              instanceLocation: context.instanceLocation,
+              keywordLocation: context.keywordLocation
             ),
           ]))
         }
diff --git a/Sources/Applicators/not.swift b/Sources/Applicators/not.swift
@@ -6,7 +6,8 @@ func not(context: Context, not: Any, instance: Any, schema: [String: Any]) throw
   return AnySequence([
     ValidationError(
       "'\(instance)' does not match 'not' validation.",
-      instanceLocation: context.instanceLocation
+      instanceLocation: context.instanceLocation,
+      keywordLocation: context.keywordLocation
     )
   ])
 }
diff --git a/Sources/Applicators/oneOf.swift b/Sources/Applicators/oneOf.swift
@@ -7,7 +7,8 @@ func oneOf(context: Context, oneOf: Any, instance: Any, schema: [String: Any]) t
     return AnySequence([
       ValidationError(
         "Only one value from `oneOf` should be met",
-        instanceLocation: context.instanceLocation
+        instanceLocation: context.instanceLocation,
+        keywordLocation: context.keywordLocation
       ),
     ])
   }
diff --git a/Sources/Applicators/patternProperties.swift b/Sources/Applicators/patternProperties.swift
@@ -28,7 +28,8 @@ func patternProperties(context: Context, patternProperties: Any, instance: Any,
       return AnySequence([
         ValidationError(
           "[Schema] '\(pattern)' is not a valid regex pattern for patternProperties",
-          instanceLocation: context.instanceLocation
+          instanceLocation: context.instanceLocation,
+          keywordLocation: context.keywordLocation
         ),
       ])
     }
diff --git a/Sources/Validation/const.swift b/Sources/Validation/const.swift
@@ -9,7 +9,8 @@ func const(context: Context, const: Any, instance: Any, schema: [String: Any]) -
   return AnySequence([
     ValidationError(
       "'\(instance)' is not equal to const '\(const)'",
-      instanceLocation: context.instanceLocation
+      instanceLocation: context.instanceLocation,
+      keywordLocation: context.keywordLocation
     )
   ])
 }
diff --git a/Sources/Validation/minMaxItems.swift b/Sources/Validation/minMaxItems.swift
@@ -5,7 +5,8 @@ func validateArrayLength(_ context: Context, _ rhs: Int, comparitor: @escaping (
         return AnySequence([
           ValidationError(
             error,
-            instanceLocation: context.instanceLocation
+            instanceLocation: context.instanceLocation,
+            keywordLocation: context.keywordLocation
           )
         ])
       }
diff --git a/Sources/Validation/minMaxLength.swift b/Sources/Validation/minMaxLength.swift
@@ -3,7 +3,11 @@ func validateLength(_ context: Context, _ comparitor: @escaping ((Int, Int) -> (
     if let value = value as? String {
       if !comparitor(value.count, length) {
         return AnySequence([
-          ValidationError(error, instanceLocation: context.instanceLocation),
+          ValidationError(
+            error,
+            instanceLocation: context.instanceLocation,
+            keywordLocation: context.keywordLocation
+          ),
         ])
       }
     }
diff --git a/Sources/Validation/minMaxNumber.swift b/Sources/Validation/minMaxNumber.swift
@@ -4,14 +4,22 @@ func validateNumericLength(_ context: Context, _ length: Double, comparitor: @es
       if exclusive ?? false {
         if !exclusiveComparitor(value, length) {
           return AnySequence([
-            ValidationError(error, instanceLocation: context.instanceLocation),
+            ValidationError(
+              error,
+              instanceLocation: context.instanceLocation,
+              keywordLocation: context.keywordLocation
+            )
           ])
         }
       }
 
       if !comparitor(value, length) {
         return AnySequence([
-          ValidationError(error, instanceLocation: context.instanceLocation),
+          ValidationError(
+            error,
+            instanceLocation: context.instanceLocation,
+            keywordLocation: context.keywordLocation
+          )
         ])
       }
     }
diff --git a/Sources/Validation/minMaxProperties.swift b/Sources/Validation/minMaxProperties.swift
@@ -3,7 +3,11 @@ func validatePropertiesLength(_ context: Context, _ length: Int, comparitor: @es
     if let value = value as? [String: Any] {
       if !comparitor(length, value.count) {
         return AnySequence([
-          ValidationError(error, instanceLocation: context.instanceLocation),
+          ValidationError(
+            error,
+            instanceLocation: context.instanceLocation,
+            keywordLocation: context.keywordLocation
+          ),
         ])
       }
     }
diff --git a/Sources/Validation/multipleOf.swift b/Sources/Validation/multipleOf.swift
@@ -15,7 +15,8 @@ func multipleOf(context: Context, multipleOf: Any, instance: Any, schema: [Strin
     return AnySequence([
       ValidationError(
         "\(instance) is not a multiple of \(multipleOf)",
-        instanceLocation: context.instanceLocation
+        instanceLocation: context.instanceLocation,
+        keywordLocation: context.keywordLocation
       )
     ])
   }
diff --git a/Sources/Validation/pattern.swift b/Sources/Validation/pattern.swift
@@ -14,7 +14,8 @@ func pattern(context: Context, pattern: Any, instance: Any, schema: [String: Any
     return AnySequence([
       ValidationError(
         "[Schema] Regex pattern '\(pattern)' is not valid",
-        instanceLocation: context.instanceLocation
+        instanceLocation: context.instanceLocation,
+        keywordLocation: context.keywordLocation
       )
     ])
   }
@@ -24,7 +25,8 @@ func pattern(context: Context, pattern: Any, instance: Any, schema: [String: Any
     return AnySequence([
       ValidationError(
         "'\(instance)' does not match pattern: '\(pattern)'",
-        instanceLocation: context.instanceLocation
+        instanceLocation: context.instanceLocation,
+        keywordLocation: context.keywordLocation
       )
     ])
   }
diff --git a/Sources/Validation/uniqueItems.swift b/Sources/Validation/uniqueItems.swift
@@ -16,7 +16,8 @@ func uniqueItems(context: Context, uniqueItems: Any, instance: Any, schema: [Str
       return AnySequence([
         ValidationError(
           "\(instance) does not have unique items",
-          instanceLocation: context.instanceLocation
+          instanceLocation: context.instanceLocation,
+          keywordLocation: context.keywordLocation
         )
       ])
     }
diff --git a/Sources/ValidationResult.swift b/Sources/ValidationResult.swift
@@ -1,7 +1,7 @@
 public class ValidationError: Encodable {
   public let description: String
 
-  init(_ value: String, instanceLocation: JSONPointer, keywordLocation: JSONPointer? = nil) {
+  init(_ value: String, instanceLocation: JSONPointer, keywordLocation: JSONPointer) {
     self.description = value
     self.instanceLocation = instanceLocation
     self.keywordLocation = keywordLocation
@@ -10,16 +10,18 @@ public class ValidationError: Encodable {
   enum CodingKeys: String, CodingKey {
     case error
     case instanceLocation
+    case keywordLocation
   }
 
   public func encode(to encoder: Encoder) throws {
     var container = encoder.container(keyedBy: CodingKeys.self)
     try container.encode(description, forKey: .error)
     try container.encode(instanceLocation.path, forKey: .instanceLocation)
+    try container.encode(keywordLocation.path, forKey: .keywordLocation)
   }
 
   public let instanceLocation: JSONPointer
-  public let keywordLocation: JSONPointer?
+  public let keywordLocation: JSONPointer
 }
 
 
diff --git a/Sources/Validator.swift b/Sources/Validator.swift
@@ -19,7 +19,11 @@ class Context {
       }
 
       return AnySequence([
-        ValidationError("Falsy schema", instanceLocation: instanceLocation),
+        ValidationError(
+          "Falsy schema",
+          instanceLocation: instanceLocation,
+          keywordLocation: keywordLocation
+        )
       ])
     }
 
diff --git a/Sources/Validators.swift b/Sources/Validators.swift
@@ -10,7 +10,11 @@ func validValidation(_ value: Any) -> AnySequence<ValidationError> {
 func invalidValidation(_ context: Context, _ error: String) -> (_ value: Any) -> AnySequence<ValidationError> {
   return { value in
     return AnySequence([
-      ValidationError(error, instanceLocation: context.instanceLocation),
+      ValidationError(
+        error,
+        instanceLocation: context.instanceLocation,
+        keywordLocation: context.keywordLocation
+      )
     ])
   }
 }
@@ -42,7 +46,8 @@ func type(context: Context, type: Any, instance: Any, schema: [String: Any]) ->
   return AnySequence([
     ValidationError(
       "'\(instance)' is not of type \(types)",
-      instanceLocation: context.instanceLocation
+      instanceLocation: context.instanceLocation,
+      keywordLocation: context.keywordLocation
     )
   ])
 }
@@ -162,7 +167,8 @@ func unsupported(_ keyword: String) -> (_ context: Context, _ value: Any, _ inst
     return AnySequence([
       ValidationError(
         "'\(keyword)' is not supported.",
-        instanceLocation: context.instanceLocation
+        instanceLocation: context.instanceLocation,
+        keywordLocation: context.keywordLocation
       ),
     ])
   }
diff --git a/Sources/format.swift b/Sources/format.swift
@@ -14,7 +14,8 @@ func format(context: Context, format: Any, instance: Any, schema: [String: Any])
     return AnySequence([
       ValidationError(
         "'format' validation of '\(format)' is not yet supported.",
-        instanceLocation: context.instanceLocation
+        instanceLocation: context.instanceLocation,
+        keywordLocation: context.keywordLocation
       )
     ])
   }
@@ -34,7 +35,8 @@ func validateIPv4(_ context: Context, _ value: Any) -> AnySequence<ValidationErr
     return AnySequence([
       ValidationError(
         "'\(ipv4)' is not a IPv4 address.",
-        instanceLocation: context.instanceLocation
+        instanceLocation: context.instanceLocation,
+        keywordLocation: context.keywordLocation
       )
     ])
   }
@@ -56,7 +58,8 @@ func validateIPv6(_ context: Context, _ value: Any) -> AnySequence<ValidationErr
     return AnySequence([
       ValidationError(
         "'\(ipv6)' is not a IPv6 address.",
-        instanceLocation: context.instanceLocation
+        instanceLocation: context.instanceLocation,
+        keywordLocation: context.keywordLocation
       )
     ])
   }
@@ -82,7 +85,8 @@ func validateURI(_ context: Context, _ value: Any) -> AnySequence<ValidationErro
     return AnySequence([
       ValidationError(
         "'\(uri)' is not a valid uri.",
-        instanceLocation: context.instanceLocation
+        instanceLocation: context.instanceLocation,
+        keywordLocation: context.keywordLocation
       )
     ])
   }
@@ -97,7 +101,8 @@ func validateUUID(_ context: Context, _ value: Any) -> AnySequence<ValidationErr
       return AnySequence([
         ValidationError(
           "'\(value)' is not a valid uuid.",
-          instanceLocation: context.instanceLocation
+          instanceLocation: context.instanceLocation,
+          keywordLocation: context.keywordLocation
         )
       ])
     }
@@ -115,7 +120,8 @@ func validateRegex(_ context: Context, _ value: Any) -> AnySequence<ValidationEr
       return AnySequence([
         ValidationError(
           "'\(value)' is not a valid regex.",
-          instanceLocation: context.instanceLocation
+          instanceLocation: context.instanceLocation,
+          keywordLocation: context.keywordLocation
         )
       ])
     }
@@ -131,7 +137,8 @@ func validateJSONPointer(_ context: Context, _ value: Any) -> AnySequence<Valida
       return AnySequence([
         ValidationError(
           "'\(value)' is not a valid json-pointer.",
-          instanceLocation: context.instanceLocation
+          instanceLocation: context.instanceLocation,
+          keywordLocation: context.keywordLocation
         )
       ])
     }
@@ -145,7 +152,8 @@ func validateJSONPointer(_ context: Context, _ value: Any) -> AnySequence<Valida
       return AnySequence([
         ValidationError(
           "'\(value)' is not a valid json-pointer.",
-          instanceLocation: context.instanceLocation
+          instanceLocation: context.instanceLocation,
+          keywordLocation: context.keywordLocation
         )
       ])
     }
diff --git a/Tests/JSONSchemaTests/Validation/TestEnum.swift b/Tests/JSONSchemaTests/Validation/TestEnum.swift
@@ -20,7 +20,7 @@ class EnumTests: XCTestCase {
 
       //XCTAssertEqual(error.description, "is not a valid enumeration value of '[\"one\"]'")
       XCTAssertEqual(error.instanceLocation.path, "")
-      XCTAssertEqual(error.keywordLocation?.path, "#/enum")
+      XCTAssertEqual(error.keywordLocation.path, "#/enum")
     }
   }
 }
diff --git a/Tests/JSONSchemaTests/Validation/TestRequired.swift b/Tests/JSONSchemaTests/Validation/TestRequired.swift
@@ -22,7 +22,7 @@ class RequiredTests: XCTestCase {
 
       XCTAssertEqual(error.description, "Required property 'test' is missing")
       XCTAssertEqual(error.instanceLocation.path, "/0")
-      XCTAssertEqual(error.keywordLocation?.path, "#/items/required")
+      XCTAssertEqual(error.keywordLocation.path, "#/items/required")
     }
   }
 }
diff --git a/Tests/JSONSchemaTests/ValidationErrorTests.swift b/Tests/JSONSchemaTests/ValidationErrorTests.swift
@@ -7,7 +7,8 @@ class ValidationErrorTests: XCTestCase {
   func testEncodableAsJSON() throws {
     let error = ValidationError(
       "example description",
-      instanceLocation: JSONPointer(path: "/test/1")
+      instanceLocation: JSONPointer(path: "/test/1"),
+      keywordLocation: JSONPointer(path: "#/example")
     )
 
     let jsonData = try JSONEncoder().encode(error)
@@ -16,6 +17,7 @@ class ValidationErrorTests: XCTestCase {
     XCTAssertEqual(json as! NSDictionary, [
       "error": "example description",
       "instanceLocation": "/test/1",
+      "keywordLocation": "#/example",
     ])
   }
 }
diff --git a/Tests/JSONSchemaTests/ValidationResultTests.swift b/Tests/JSONSchemaTests/ValidationResultTests.swift
@@ -18,7 +18,8 @@ class ValidationResultsTests: XCTestCase {
   func testInvalidEncodableAsJSON() throws {
     let error = ValidationError(
       "example description",
-      instanceLocation: JSONPointer(path: "/test/1")
+      instanceLocation: JSONPointer(path: "/test/1"),
+      keywordLocation: JSONPointer(path: "#/example")
     )
     let result = ValidationResult.invalid([error])
 
@@ -31,6 +32,7 @@ class ValidationResultsTests: XCTestCase {
         [
           "error": "example description",
           "instanceLocation": "/test/1",
+          "keywordLocation": "#/example",
         ],
       ],
     ])

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,8 @@ func contains(context: Context, contains: Any, instance: Any, schema: [String: A`
`31`	`31`	`return AnySequence([`
`32`	`32`	`ValidationError(`
`33`	`33`	`"\(instance) does not match contains + maxContains \(max)",`
`34`		`- instanceLocation: context.instanceLocation`
	`34`	`+ instanceLocation: context.instanceLocation,`
	`35`	`+ keywordLocation: context.keywordLocation`
`35`	`36`	`)`
`36`	`37`	`])`
`37`	`38`	`}`
`@@ -43,7 +44,8 @@ func contains(context: Context, contains: Any, instance: Any, schema: [String: A`
`43`	`44`	`return AnySequence([`
`44`	`45`	`ValidationError(`
`45`	`46`	`"'\(instance) does not match contains",`
`46`		`- instanceLocation: context.instanceLocation`
	`47`	`+ instanceLocation: context.instanceLocation,`
	`48`	`+ keywordLocation: context.keywordLocation`
`47`	`49`	`)`
`48`	`50`	`])`
`49`	`51`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,8 @@ func not(context: Context, not: Any, instance: Any, schema: [String: Any]) throw`
`6`	`6`	`return AnySequence([`
`7`	`7`	`ValidationError(`
`8`	`8`	`"'\(instance)' does not match 'not' validation.",`
`9`		`- instanceLocation: context.instanceLocation`
	`9`	`+ instanceLocation: context.instanceLocation,`
	`10`	`+ keywordLocation: context.keywordLocation`
`10`	`11`	`)`
`11`	`12`	`])`
`12`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,8 @@ func const(context: Context, const: Any, instance: Any, schema: [String: Any]) -`
`9`	`9`	`return AnySequence([`
`10`	`10`	`ValidationError(`
`11`	`11`	`"'\(instance)' is not equal to const '\(const)'",`
`12`		`- instanceLocation: context.instanceLocation`
	`12`	`+ instanceLocation: context.instanceLocation,`
	`13`	`+ keywordLocation: context.keywordLocation`
`13`	`14`	`)`
`14`	`15`	`])`
`15`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,8 @@ func validateArrayLength(_ context: Context, _ rhs: Int, comparitor: @escaping (`
`5`	`5`	`return AnySequence([`
`6`	`6`	`ValidationError(`
`7`	`7`	`error,`
`8`		`- instanceLocation: context.instanceLocation`
	`8`	`+ instanceLocation: context.instanceLocation,`
	`9`	`+ keywordLocation: context.keywordLocation`
`9`	`10`	`)`
`10`	`11`	`])`
`11`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,11 @@ func validateLength(_ context: Context, _ comparitor: @escaping ((Int, Int) -> (`
`3`	`3`	`if let value = value as? String {`
`4`	`4`	`if !comparitor(value.count, length) {`
`5`	`5`	`return AnySequence([`
`6`		`- ValidationError(error, instanceLocation: context.instanceLocation),`
	`6`	`+ ValidationError(`
	`7`	`+ error,`
	`8`	`+ instanceLocation: context.instanceLocation,`
	`9`	`+ keywordLocation: context.keywordLocation`
	`10`	`+ ),`
`7`	`11`	`])`
`8`	`12`	`}`
`9`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,14 +4,22 @@ func validateNumericLength(_ context: Context, _ length: Double, comparitor: @es`
`4`	`4`	`if exclusive ?? false {`
`5`	`5`	`if !exclusiveComparitor(value, length) {`
`6`	`6`	`return AnySequence([`
`7`		`- ValidationError(error, instanceLocation: context.instanceLocation),`
	`7`	`+ ValidationError(`
	`8`	`+ error,`
	`9`	`+ instanceLocation: context.instanceLocation,`
	`10`	`+ keywordLocation: context.keywordLocation`
	`11`	`+ )`
`8`	`12`	`])`
`9`	`13`	`}`
`10`	`14`	`}`
`11`	`15`
`12`	`16`	`if !comparitor(value, length) {`
`13`	`17`	`return AnySequence([`
`14`		`- ValidationError(error, instanceLocation: context.instanceLocation),`
	`18`	`+ ValidationError(`
	`19`	`+ error,`
	`20`	`+ instanceLocation: context.instanceLocation,`
	`21`	`+ keywordLocation: context.keywordLocation`
	`22`	`+ )`
`15`	`23`	`])`
`16`	`24`	`}`
`17`	`25`	`}`