Address UI test re-review feedback

Author: jkaunert

CodeEdit/AppDelegate.swift

@@ -85,7 +85,10 @@ final class AppDelegate: NSObject, NSApplicationDelegate, ObservableObject {
             }
             try FileManager.default.createDirectory(at: url, withIntermediateDirectories: true)
         } catch {
-            logger.error("Failed to create UI test workspace: \(error.localizedDescription, privacy: .public)")
+            let path = url.path(percentEncoded: false)
+            let message = "Failed to create UI test workspace at \(path): \(error.localizedDescription)"
+            logger.error("\(message, privacy: .public)")
+            fatalError(message)
         }
 
         return url

CodeEditUITests/App.swift

@@ -35,7 +35,7 @@ enum App {
             tempDirID
         ]
         application.launch()
-        return (application, tempDirID)
+        return (application, appWritableTempProjectPath(id: tempDirID))
     }
 
     static func launch() -> XCUIApplication {

CodeEditUITests/Features/NavigatorArea/ProjectNavigator/ProjectNavigatorFileManagementUITests.swift

@@ -30,6 +30,15 @@ final class ProjectNavigatorFileManagementUITests: XCTestCase {
             navigator = Query.Window.getProjectNavigator(window)
             XCTAssertTrue(navigator.exists, "Navigator not found")
             XCTAssertEqual(Query.Navigator.getRows(navigator).count, 1, "Found more than just the root file.")
+
+            if name.contains("testCreateNewFiles") {
+                var isDirectory: ObjCBool = false
+                XCTAssertTrue(
+                    FileManager.default.fileExists(atPath: path, isDirectory: &isDirectory),
+                    "App-writable temp directory was not created at \(path ?? "")"
+                )
+                XCTAssertTrue(isDirectory.boolValue, "App-writable temp project path is not a directory")
+            }
         }
     }
 

CodeEditUITests/ProjectPath.swift

@@ -18,6 +18,34 @@ func projectPath() -> String {
 }
 
 private var tempProjectPathIds = Set<String>()
+private let codeEditAppBundleID = "app.codeedit.CodeEdit"
+
+private func testRunnerTempProjectURL(id: String) -> URL {
+    FileManager.default.temporaryDirectory
+        .appending(path: "CodeEditUITests")
+        .appending(path: id)
+}
+
+private func userHomeDirectoryOutsideSandbox() -> URL {
+    let homePath = NSHomeDirectoryForUser(NSUserName()) ?? NSHomeDirectory()
+    // UI test runners are sandboxed too; strip that container before addressing the app's container.
+    if let containerRange = homePath.range(of: "/Library/Containers/") {
+        return URL(fileURLWithPath: String(homePath[..<containerRange.lowerBound]), isDirectory: true)
+    }
+    return URL(fileURLWithPath: homePath, isDirectory: true)
+}
+
+private func appWritableTempProjectURL(id: String) -> URL {
+    // CodeEdit is sandboxed, so app-created temporary workspaces live in the app container.
+    userHomeDirectoryOutsideSandbox()
+        .appending(path: "Library")
+        .appending(path: "Containers")
+        .appending(path: codeEditAppBundleID)
+        .appending(path: "Data")
+        .appending(path: "tmp")
+        .appending(path: "CodeEditUITests")
+        .appending(path: id)
+}
 
 private func makeTempID() -> String {
     let id = String((0..<10).map { _ in "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-".randomElement()! })
@@ -29,9 +57,8 @@ private func makeTempID() -> String {
 }
 
 func tempProjectPath() throws -> String {
-    let baseDir = FileManager.default.temporaryDirectory.appending(path: "CodeEditUITests")
     let id = makeTempID()
-    let path = baseDir.appending(path: id)
+    let path = testRunnerTempProjectURL(id: id)
     try FileManager.default.createDirectory(at: path, withIntermediateDirectories: true)
     return path.path(percentEncoded: false)
 }
@@ -40,22 +67,32 @@ func appWritableTempProjectID() -> String {
     makeTempID()
 }
 
+func appWritableTempProjectPath(id: String) -> String {
+    appWritableTempProjectURL(id: id).path(percentEncoded: false)
+}
+
 func cleanUpTempProjectPaths() throws {
     let fileManager = FileManager.default
-    let baseDir = FileManager.default.temporaryDirectory.appending(path: "CodeEditUITests")
     var cleanupError: Error?
     var remainingIDs = Set<String>()
 
     for id in tempProjectPathIds {
-        let path = baseDir.appending(path: id)
-        guard fileManager.fileExists(atPath: path.path(percentEncoded: false)) else {
-            continue
+        let paths = [
+            testRunnerTempProjectURL(id: id),
+            appWritableTempProjectURL(id: id)
+        ]
+        var didFailCleanup = false
+
+        for path in paths where fileManager.fileExists(atPath: path.path(percentEncoded: false)) {
+            do {
+                try fileManager.removeItem(at: path)
+            } catch {
+                cleanupError = cleanupError ?? error
+                didFailCleanup = true
+            }
         }
 
-        do {
-            try fileManager.removeItem(at: path)
-        } catch {
-            cleanupError = cleanupError ?? error
+        if didFailCleanup {
             remainingIDs.insert(id)
         }
     }