get ready to support ValidationErrorCollection as an OpenAPIError. Tw…

…eak phrasing of errors that occur at the document root.
mattpolzin · Sep 5, 2023 · 352a9a0 · 352a9a0
1 parent 77df1d7
commit 352a9a0
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 10 deletions.
diff --git a/Sources/OpenAPIKit/Validator/Validation.swift b/Sources/OpenAPIKit/Validator/Validation.swift
@@ -148,9 +148,7 @@ public struct ValidationErrorCollection: Swift.Error, CustomStringConvertible, E
 
     public var description: String { localizedDescription }
 
-    public var swiftErrors: [Swift.Error] {
-        return values
-    }
+    public var swiftErrors: [Swift.Error] { values }
 }
 
 /// Erases the type on which a `Validator` is specialized and combines

diff --git a/Sources/OpenAPIKit30/Validator/Validation.swift b/Sources/OpenAPIKit30/Validator/Validation.swift
@@ -128,22 +128,27 @@ public struct ValidationError: Swift.Error, CustomStringConvertible {
     public var localizedDescription: String { description }
 
     public var description: String {
-        "\(reason) at path: \(codingPath.stringValue)"
+        guard !codingPath.isEmpty else {
+            return "\(reason) at root of document"
+        }
+        return "\(reason) at path: \(codingPath.stringValue)"
     }
 }
 
 /// Collects `ValidationErrors`.
 ///
 /// This type is responsible for making it possible to collect validation
 /// errors and throw one value (this collection) at the end of validation.
-public struct ValidationErrorCollection: Swift.Error, CustomStringConvertible {
+public struct ValidationErrorCollection: Swift.Error, CustomStringConvertible, ErrorCollection {
     public let values: [ValidationError]
 
-    public var localizedDescription: String { description }
-
-    public var description: String {
+    public var localizedDescription: String {
         return values.map(String.init(describing:)).joined(separator: "\n")
     }
+
+    public var description: String { localizedDescription }
+
+    public var swiftErrors: [Swift.Error] { values }
 }
 
 /// Erases the type on which a `Validator` is specialized and combines

diff --git a/Tests/OpenAPIKit30Tests/Validator/ValidationTests.swift b/Tests/OpenAPIKit30Tests/Validator/ValidationTests.swift
@@ -15,7 +15,7 @@ final class ValidationTests: XCTestCase {
         let check = AnyValidation(validation)
 
         let errors = check.apply(to: "hello", at: [], in: testDocument)
-        XCTAssertEqual(errors.map { $0.description }, [ "because at path: " ])
+        XCTAssertEqual(errors.map { $0.description }, [ "because at root of document" ])
 
         let string: String? = "hello"
         let errors2 = check.apply(to: string as Any, at: [], in: testDocument)

diff --git a/Tests/OpenAPIKitTests/Validator/ValidationTests.swift b/Tests/OpenAPIKitTests/Validator/ValidationTests.swift
@@ -15,7 +15,7 @@ final class ValidationTests: XCTestCase {
         let check = AnyValidation(validation)
 
         let errors = check.apply(to: "hello", at: [], in: testDocument)
-        XCTAssertEqual(errors.map { $0.description }, [ "because at path: " ])
+        XCTAssertEqual(errors.map { $0.description }, [ "because at root of document" ])
 
         let string: String? = "hello"
         let errors2 = check.apply(to: string as Any, at: [], in: testDocument)