Merge pull request #15 from mattpolzin/catch-undefined-parameters

catch undefined path parameters before they cause a swift compilation…

Author: mattpolzin

Sources/JSONAPISwiftGen/Swift Generators/Test Generators/APIRequestTestSwiftGen.swift

@@ -35,6 +35,16 @@ public struct APIRequestTestSwiftGen: SwiftGenerator {
             .filter { !$0.context.inQuery } // for now these are handled as a block rather than each as separate args
             .map(APIRequestTestSwiftGen.argument)
 
+        let undefinedPaarameterArgNames = Array(
+            pathComponents.components
+            .compactMap(Self.urlParameterSwiftName)
+            .filter { !parameterArgs.lazy.map(\.name).contains($0) }
+        )
+
+        if !undefinedPaarameterArgNames.isEmpty {
+            throw Error.pathParametersNotDefined(names: undefinedPaarameterArgNames)
+        }
+
         let requestBodyTypeDef = SwiftTypeDef(name: "RequestBody", specializationReps: [])
         let responseBodyTypeDef = SwiftTypeDef(name: "ResponseBody", specializationReps: [])
 
@@ -169,12 +179,11 @@ public struct APIRequestTestSwiftGen: SwiftGenerator {
         originatingAt hostUrl: URL
     ) -> Decl {
         let pathString = path.components.map { component in
-            guard component.first == "{",
-                component.last == "}" else {
-                    return component
+            guard let swiftName = urlParameterSwiftName(component) else {
+                return component
             }
             return "\\("
-                + propertyCased(String(component.dropFirst().dropLast()))
+                + swiftName
                 + ")"
         }.joined(separator: "/")
 
@@ -185,6 +194,18 @@ public struct APIRequestTestSwiftGen: SwiftGenerator {
         )
     }
 
+    /// Get a property-cased name if the given string is an OpenAPI path parameter variable
+    /// (which means it is enclosed in brackets `{ }`). Otherwise, returns `nil`.
+    static func urlParameterSwiftName(
+        _ pathComponent: String
+    ) -> String? {
+        guard pathComponent.first == "{",
+              pathComponent.last == "}" else {
+            return nil
+        }
+        return propertyCased(String(pathComponent.dropFirst().dropLast()))
+    }
+
     private static func parameterSnippet(from parameter: DereferencedParameter) throws -> Decl {
         let (parameterName, parameterType) = try argument(for: parameter)
 
@@ -226,6 +247,8 @@ public struct APIRequestTestSwiftGen: SwiftGenerator {
         case parameterContentMapNotSupported
         case unsupportedParameterSchema
 
+        case pathParametersNotDefined(names: [String])
+
         case duplicateFunctionArgumentDetected
     }
 }

Tests/JSONAPISwiftGenTests/APIRequestTestSwiftGenTests.swift

@@ -8,13 +8,44 @@
 import XCTest
 import JSONAPI
 import JSONAPITesting
+import OpenAPIKit
+import JSONAPISwiftGen
 
 import Foundation
 #if canImport(FoundationNetworking)
 import FoundationNetworking
 #endif
 
 final class APIRequestTestSwiftGenTests: XCTestCase {
+    func test_undefinedPathParameters() {
+        XCTAssertThrowsError(
+            try APIRequestTestSwiftGen(
+                method: .post,
+                server: OpenAPI.Server(url: URL(string: "http://website.com")!),
+                pathComponents: "/widgets/{widget_id}",
+                parameters: []
+            )
+        )
+    }
+
+    func test_noUndefinedPathParameters() throws {
+        // just prove this does not throw for now.
+
+        // TODO: test could actually test for the given parameter
+        // being part of the resulting function signature or even more.
+        _ = try APIRequestTestSwiftGen(
+            method: .post,
+            server: OpenAPI.Server(url: URL(string: "http://website.com")!),
+            pathComponents: "/widgets/{widget_id}",
+            parameters: [
+                OpenAPI.Parameter(
+                    name: "widget_id",
+                    context: .path,
+                    schema: .string
+                ).dereferenced(in: .noComponents)
+            ]
+        )
+    }
 }
 
 // MARK: - START - Function written to generated test suites