Fix archive func for directories that do not exist ahead of time. change default location of zipped test files.

Author: mattpolzin

Dockerfile

@@ -60,6 +60,10 @@ ENV ENVIRONMENT=$env
 # Optional. If not specified, defaults to ~/api_test
 # ENV API_TEST_OUT_PATH
 
+# Path on local filesystem to which to write zipped generated API test files.
+# Optional. If not specified, defaults to ~/api_test_archives
+# ENV API_TEST_ARCHIVES_PATH
+
 # Postgres Database URL. Required.
 # ENV API_TEST_DATABASE_URL
 

Sources/App/Environment/APITestEnvironment+server.swift

@@ -31,6 +31,11 @@ public extension Environment {
 public extension Environment {
     /// Optional Archives path (folder location in which zip archives will be stored).
     static var archivesPath: String {
-        return Environment.get("API_TEST_ARCHIVES_PATH") ?? "/app/archives/"
+        let defaultDir = FileManager.default
+            .homeDirectoryForCurrentUser
+            .appendingPathComponent("api_test_archives")
+            .path
+
+        return Environment.get("API_TEST_ARCHIVES_PATH") ?? defaultDir
     }
 }

Sources/AppAPIDocumentation/VaporRoute+OpenAPI.swift

@@ -38,6 +38,8 @@ extension AbstractRouteContext {
 
                 let schema = try (responseTuple.responseBodyType as? OpenAPIEncodedNodeType.Type)?.openAPINode(using: encoder)
 
+                // TODO: support additional content types -- binary file types will not even have a schema so they are gimmes.
+
                 return schema
                     .map {
                         OpenAPI.Response(

Sources/SwiftGen/ApiTestPackageSwiftGen.swift

@@ -384,15 +384,27 @@ func write(contents: String, toFileAt path: String, named name: String) throws {
                encoding: .utf8)
 }
 
-func archive(from sourcePath: String, to archivePath: String) throws {
+func archive(from sourcePath: String, to archiveFilePath: String) throws {
     let fileManager = FileManager.default
 
-    if fileManager.fileExists(atPath: archivePath) {
-        try fileManager.removeItem(atPath: archivePath)
+    let source = URL(fileURLWithPath: sourcePath)
+    let destination = URL(fileURLWithPath: archiveFilePath)
+
+    let archiveFolderPath = destination
+        .deletingLastPathComponent()
+        .path
+
+    // create the directory if needed
+    if !fileManager.fileExists(atPath: archiveFolderPath) {
+        try fileManager.createDirectory(atPath: archiveFolderPath,
+                                        withIntermediateDirectories: true,
+                                        attributes: nil)
     }
 
-    let source = URL(fileURLWithPath: sourcePath)
-    let destination = URL(fileURLWithPath: archivePath)
+    // delete a previously generated archive if needed
+    if fileManager.fileExists(atPath: archiveFilePath) {
+        try fileManager.removeItem(atPath: archiveFilePath)
+    }
 
     try fileManager.zipItem(at: source, to: destination)
 }