Launch display regression app with NSWorkspace

Author: austinywang

cmuxUITests/DisplayResolutionRegressionUITests.swift

@@ -1,5 +1,6 @@
 import XCTest
 import Foundation
+import AppKit
 import Darwin
 
 final class DisplayResolutionRegressionUITests: XCTestCase {
@@ -12,8 +13,8 @@ final class DisplayResolutionRegressionUITests: XCTestCase {
     private var displayDonePath = ""
     private var helperBinaryPath = ""
     private var helperLogPath = ""
-    private var appLogPath = ""
-    private var launchedAppProcess: Process?
+    private var launchedApp: NSRunningApplication?
+    private var launchedAppBundleURL: URL?
     private var helperProcess: Process?
 
     override func setUp() {
@@ -32,7 +33,6 @@ final class DisplayResolutionRegressionUITests: XCTestCase {
         displayDonePath = "\(tempPrefix).done"
         helperBinaryPath = "\(tempPrefix)-helper"
         helperLogPath = "\(tempPrefix)-helper.log"
-        appLogPath = "\(tempPrefix)-app.log"
 
         removeTestArtifacts()
     }
@@ -241,28 +241,41 @@ final class DisplayResolutionRegressionUITests: XCTestCase {
     }
 
     private func launchAppProcess(targetDisplayID: String) throws {
-        let proc = Process()
-        proc.executableURL = URL(fileURLWithPath: try resolveAppExecutablePath())
-        proc.currentDirectoryURL = repoRootURL
-
-        var environment = sanitizedAppProcessEnvironment()
-        for (key, value) in launchEnvironment(targetDisplayID: targetDisplayID) {
-            environment[key] = value
+        let appBundleURL = try resolveAppBundleURL()
+        let configuration = NSWorkspace.OpenConfiguration()
+        configuration.activates = false
+        configuration.createsNewApplicationInstance = true
+        configuration.environment = launchEnvironment(targetDisplayID: targetDisplayID)
+
+        var launchedApp: NSRunningApplication?
+        var launchError: Error?
+        NSWorkspace.shared.openApplication(at: appBundleURL, configuration: configuration) { app, error in
+            launchedApp = app
+            launchError = error
         }
-        proc.environment = environment
 
-        let logHandle = FileHandle(forWritingAtPath: appLogPath) ?? {
-            FileManager.default.createFile(atPath: appLogPath, contents: nil)
-            return FileHandle(forWritingAtPath: appLogPath)
-        }()
-        proc.standardOutput = logHandle
-        proc.standardError = logHandle
+        let launchCompleted = waitForCondition(timeout: 15.0) {
+            launchedApp != nil || launchError != nil
+        }
+        guard launchCompleted else {
+            throw NSError(domain: "DisplayResolutionRegressionUITests", code: 5, userInfo: [
+                NSLocalizedDescriptionKey: "Timed out waiting for NSWorkspace launch completion"
+            ])
+        }
+        if let launchError {
+            throw launchError
+        }
+        guard let launchedApp else {
+            throw NSError(domain: "DisplayResolutionRegressionUITests", code: 6, userInfo: [
+                NSLocalizedDescriptionKey: "NSWorkspace launch returned no app instance"
+            ])
+        }
 
-        try proc.run()
-        launchedAppProcess = proc
+        self.launchedApp = launchedApp
+        launchedAppBundleURL = appBundleURL
     }
 
-    private func resolveAppExecutablePath() throws -> String {
+    private func resolveAppBundleURL() throws -> URL {
         let env = ProcessInfo.processInfo.environment
         let fileManager = FileManager.default
         var candidateProductsDirectories: [String] = []
@@ -286,17 +299,15 @@ final class DisplayResolutionRegressionUITests: XCTestCase {
         candidateProductsDirectories.append(contentsOf: inferredBuildProductsDirectories())
 
         for productsDir in uniquePaths(candidateProductsDirectories) {
-            let appExecutablePath = URL(fileURLWithPath: productsDir)
+            let appBundleURL = URL(fileURLWithPath: productsDir)
                 .appendingPathComponent("cmux DEV.app")
-                .appendingPathComponent("Contents/MacOS/cmux DEV")
-                .path
-            if fileManager.isExecutableFile(atPath: appExecutablePath) {
-                return appExecutablePath
+            if fileManager.fileExists(atPath: appBundleURL.path) {
+                return appBundleURL
             }
         }
 
         throw NSError(domain: "DisplayResolutionRegressionUITests", code: 4, userInfo: [
-            NSLocalizedDescriptionKey: "Unable to resolve cmux DEV executable from UI test environment"
+            NSLocalizedDescriptionKey: "Unable to resolve cmux DEV app bundle from UI test environment"
         ])
     }
 
@@ -331,26 +342,6 @@ final class DisplayResolutionRegressionUITests: XCTestCase {
         return ordered
     }
 
-    private func sanitizedAppProcessEnvironment() -> [String: String] {
-        let blockedPrefixes = [
-            "XCTest",
-            "XCInject",
-            "DYLD_",
-            "__XPC_DYLD_",
-        ]
-        let blockedKeys: Set<String> = [
-            "LLVM_PROFILE_FILE",
-            "OS_ACTIVITY_DT_MODE",
-        ]
-
-        return ProcessInfo.processInfo.environment.filter { key, _ in
-            if blockedKeys.contains(key) {
-                return false
-            }
-            return !blockedPrefixes.contains(where: { key.hasPrefix($0) })
-        }
-    }
-
     private func launchEnvironment(targetDisplayID: String) -> [String: String] {
         [
             "CMUX_UI_TEST_MODE": "1",
@@ -362,7 +353,26 @@ final class DisplayResolutionRegressionUITests: XCTestCase {
     }
 
     private func terminateLaunchedAppIfNeeded() {
-        terminateProcessIfNeeded(&launchedAppProcess, timeout: 5.0)
+        guard let launchedApp else { return }
+        defer {
+            self.launchedApp = nil
+            launchedAppBundleURL = nil
+        }
+
+        guard !launchedApp.isTerminated else { return }
+
+        _ = launchedApp.terminate()
+        let terminatedAfterTerminate = waitForCondition(timeout: 5.0) {
+            launchedApp.isTerminated
+        }
+        if terminatedAfterTerminate {
+            return
+        }
+
+        _ = launchedApp.forceTerminate()
+        _ = waitForCondition(timeout: 1.0) {
+            launchedApp.isTerminated
+        }
     }
 
     private func terminateHelperProcessIfNeeded() {
@@ -397,15 +407,9 @@ final class DisplayResolutionRegressionUITests: XCTestCase {
     }
 
     private func launchedAppDiagnostics() -> String {
-        guard let launchedAppProcess else { return "not-launched" }
-        let log = readTrimmedFile(atPath: appLogPath) ?? "<missing>"
-        let status: String
-        if launchedAppProcess.isRunning {
-            status = "running"
-        } else {
-            status = String(launchedAppProcess.terminationStatus)
-        }
-        return "pid=\(launchedAppProcess.processIdentifier) running=\(launchedAppProcess.isRunning) status=\(status) log=\(log)"
+        guard let launchedApp else { return "not-launched" }
+        let bundlePath = launchedAppBundleURL?.path ?? "<unknown>"
+        return "pid=\(launchedApp.processIdentifier) terminated=\(launchedApp.isTerminated) bundle=\(bundlePath)"
     }
 
     private func waitForTargetDisplayMove(targetDisplayID: String, timeout: TimeInterval) -> Bool {
@@ -481,7 +485,6 @@ final class DisplayResolutionRegressionUITests: XCTestCase {
             displayDonePath,
             helperBinaryPath,
             helperLogPath,
-            appLogPath,
         ] {
             guard !path.isEmpty else { continue }
             try? FileManager.default.removeItem(atPath: path)