* Set cmux TestAction to Debug for UI tests * Broaden XCTest detection for debug launch gate * Fix AutomationSocketUITests launch hang in CI * Stabilize CI Swift package resolution for test jobs * Stabilize Xcode Cloud UI test focus and socket handling * Add Xcode Cloud pre-xcodebuild submodule bootstrap * Harden Xcode Cloud bonsplit bootstrap fallback
465 lines
18 KiB
Swift
465 lines
18 KiB
Swift
import XCTest
|
|
import Foundation
|
|
import CoreGraphics
|
|
|
|
final class MultiWindowNotificationsUITests: XCTestCase {
|
|
private var dataPath = ""
|
|
private var socketPath = ""
|
|
private var launchTag = ""
|
|
|
|
override func setUp() {
|
|
super.setUp()
|
|
continueAfterFailure = false
|
|
dataPath = "/tmp/cmux-ui-test-multi-window-notifs-\(UUID().uuidString).json"
|
|
socketPath = "/tmp/cmux-ui-test-socket-\(UUID().uuidString).sock"
|
|
launchTag = "ui-tests-multi-window-notifs-\(UUID().uuidString.prefix(8))"
|
|
try? FileManager.default.removeItem(atPath: dataPath)
|
|
try? FileManager.default.removeItem(atPath: socketPath)
|
|
}
|
|
|
|
override func tearDown() {
|
|
try? FileManager.default.removeItem(atPath: dataPath)
|
|
try? FileManager.default.removeItem(atPath: socketPath)
|
|
super.tearDown()
|
|
}
|
|
|
|
func testNotificationsRouteToCorrectWindow() {
|
|
let app = XCUIApplication()
|
|
app.launchEnvironment["CMUX_UI_TEST_MULTI_WINDOW_NOTIF_SETUP"] = "1"
|
|
app.launchEnvironment["CMUX_UI_TEST_MULTI_WINDOW_NOTIF_PATH"] = dataPath
|
|
app.launchEnvironment["CMUX_TAG"] = launchTag
|
|
app.launch()
|
|
XCTAssertTrue(
|
|
ensureForegroundAfterLaunch(app, timeout: 12.0),
|
|
"Expected app to launch for multi-window routing test. state=\(app.state.rawValue)"
|
|
)
|
|
|
|
XCTAssertTrue(
|
|
waitForData(keys: [
|
|
"window1Id",
|
|
"window2Id",
|
|
"window2InitialSidebarSelection",
|
|
"tabId1",
|
|
"tabId2",
|
|
"notifId1",
|
|
"notifId2",
|
|
"expectedLatestWindowId",
|
|
"expectedLatestTabId",
|
|
], timeout: 15.0),
|
|
"Expected multi-window notification setup data"
|
|
)
|
|
|
|
guard let setup = loadData() else {
|
|
XCTFail("Missing setup data")
|
|
return
|
|
}
|
|
|
|
let expectedLatestWindowId = setup["expectedLatestWindowId"] ?? ""
|
|
let expectedLatestTabId = setup["expectedLatestTabId"] ?? ""
|
|
let window2Id = setup["window2Id"] ?? ""
|
|
let window2InitialSidebarSelection = setup["window2InitialSidebarSelection"] ?? ""
|
|
let tabId2 = setup["tabId2"] ?? ""
|
|
let notifId2 = setup["notifId2"] ?? ""
|
|
|
|
XCTAssertFalse(expectedLatestWindowId.isEmpty)
|
|
XCTAssertFalse(expectedLatestTabId.isEmpty)
|
|
XCTAssertFalse(window2Id.isEmpty)
|
|
XCTAssertEqual(window2InitialSidebarSelection, "notifications")
|
|
XCTAssertFalse(tabId2.isEmpty)
|
|
XCTAssertFalse(notifId2.isEmpty)
|
|
|
|
// Sanity: ensure the second window was actually created.
|
|
XCTAssertTrue(waitForWindowCount(atLeast: 2, app: app, timeout: 6.0))
|
|
|
|
// Jump to latest unread (Cmd+Shift+U). This should bring the owning window forward.
|
|
let beforeToken = loadData()?["focusToken"]
|
|
app.typeKey("u", modifierFlags: [.command, .shift])
|
|
|
|
XCTAssertTrue(
|
|
waitForFocusChange(from: beforeToken, timeout: 6.0),
|
|
"Expected focus record after jump-to-unread"
|
|
)
|
|
guard let afterJump = loadData() else {
|
|
XCTFail("Missing focus data after jump")
|
|
return
|
|
}
|
|
XCTAssertEqual(afterJump["focusedWindowId"], expectedLatestWindowId)
|
|
XCTAssertEqual(afterJump["focusedTabId"], expectedLatestTabId)
|
|
|
|
// Open the notifications popover (Cmd+I) and click the notification belonging to window 2.
|
|
let beforeClickToken = afterJump["focusToken"]
|
|
app.typeKey("i", modifierFlags: [.command])
|
|
|
|
let targetButton = app.buttons["NotificationPopoverRow.\(notifId2)"]
|
|
XCTAssertTrue(targetButton.waitForExistence(timeout: 6.0), "Expected notification row button to exist")
|
|
XCTAssertTrue(
|
|
clickNotificationPopoverRowAndWaitForFocusChange(
|
|
button: targetButton,
|
|
app: app,
|
|
from: beforeClickToken,
|
|
timeout: 6.0
|
|
),
|
|
"Expected focus record after clicking notification"
|
|
)
|
|
guard let afterClick = loadData() else {
|
|
XCTFail("Missing focus data after click")
|
|
return
|
|
}
|
|
XCTAssertEqual(afterClick["focusedWindowId"], window2Id)
|
|
XCTAssertEqual(afterClick["focusedTabId"], tabId2)
|
|
XCTAssertEqual(afterClick["focusedSidebarSelection"], "tabs")
|
|
}
|
|
|
|
func testNotificationsPopoverCanCloseViaShortcutAndEscape() {
|
|
let app = XCUIApplication()
|
|
app.launchEnvironment["CMUX_UI_TEST_MULTI_WINDOW_NOTIF_SETUP"] = "1"
|
|
app.launchEnvironment["CMUX_UI_TEST_MULTI_WINDOW_NOTIF_PATH"] = dataPath
|
|
app.launchEnvironment["CMUX_TAG"] = launchTag
|
|
app.launch()
|
|
XCTAssertTrue(
|
|
ensureForegroundAfterLaunch(app, timeout: 12.0),
|
|
"Expected app to launch for notifications popover shortcut test. state=\(app.state.rawValue)"
|
|
)
|
|
|
|
XCTAssertTrue(
|
|
waitForData(keys: ["notifId1"], timeout: 15.0),
|
|
"Expected multi-window notification setup data"
|
|
)
|
|
|
|
guard let notifId1 = loadData()?["notifId1"], !notifId1.isEmpty else {
|
|
XCTFail("Missing setup notification id")
|
|
return
|
|
}
|
|
|
|
XCTAssertTrue(waitForWindowCount(atLeast: 1, app: app, timeout: 6.0))
|
|
|
|
app.typeKey("i", modifierFlags: [.command])
|
|
let targetButton = app.buttons["NotificationPopoverRow.\(notifId1)"]
|
|
XCTAssertTrue(targetButton.waitForExistence(timeout: 6.0), "Expected popover to open on Show Notifications shortcut")
|
|
|
|
app.typeKey("i", modifierFlags: [.command])
|
|
XCTAssertTrue(waitForElementToDisappear(targetButton, timeout: 3.0), "Expected popover to close on repeated Show Notifications shortcut")
|
|
|
|
app.typeKey("i", modifierFlags: [.command])
|
|
XCTAssertTrue(targetButton.waitForExistence(timeout: 6.0), "Expected popover to reopen on Show Notifications shortcut")
|
|
|
|
app.typeKey(XCUIKeyboardKey.escape.rawValue, modifierFlags: [])
|
|
XCTAssertTrue(waitForElementToDisappear(targetButton, timeout: 3.0), "Expected popover to close on Escape")
|
|
}
|
|
|
|
func testEmptyNotificationsPopoverBlocksTerminalTyping() throws {
|
|
let app = XCUIApplication()
|
|
app.launchArguments += ["-socketControlMode", "allowAll"]
|
|
app.launchEnvironment["CMUX_SOCKET_PATH"] = socketPath
|
|
app.launchEnvironment["CMUX_SOCKET_MODE"] = "allowAll"
|
|
app.launchEnvironment["CMUX_SOCKET_ENABLE"] = "1"
|
|
app.launchEnvironment["CMUX_UI_TEST_SOCKET_SANITY"] = "1"
|
|
app.launchEnvironment["CMUX_TAG"] = launchTag
|
|
app.launch()
|
|
XCTAssertTrue(
|
|
ensureForegroundAfterLaunch(app, timeout: 12.0),
|
|
"Expected app to launch for empty popover blocking test. state=\(app.state.rawValue)"
|
|
)
|
|
|
|
XCTAssertTrue(waitForWindowCount(atLeast: 1, app: app, timeout: 8.0))
|
|
guard let resolvedPath = resolveSocketPath(timeout: 8.0) else {
|
|
throw XCTSkip("Control socket unavailable in this test environment. requested=\(socketPath)")
|
|
}
|
|
socketPath = resolvedPath
|
|
let pingResponse = waitForSocketPong(timeout: 8.0)
|
|
guard pingResponse == "PONG" else {
|
|
throw XCTSkip("Control socket did not respond in time. path=\(socketPath) response=\(pingResponse ?? "<nil>")")
|
|
}
|
|
|
|
_ = socketCommand("clear_notifications")
|
|
|
|
app.typeKey("i", modifierFlags: [.command])
|
|
XCTAssertTrue(app.staticTexts["No notifications yet"].waitForExistence(timeout: 6.0), "Expected empty notifications popover state")
|
|
|
|
let marker = "cmux_notif_block_\(UUID().uuidString.replacingOccurrences(of: "-", with: "").prefix(8))"
|
|
let before = readCurrentTerminalText() ?? ""
|
|
XCTAssertFalse(before.contains(marker), "Unexpected marker precondition collision")
|
|
|
|
app.typeText(marker)
|
|
RunLoop.current.run(until: Date().addingTimeInterval(0.25))
|
|
|
|
guard let after = readCurrentTerminalText() else {
|
|
XCTFail("Expected terminal text from control socket")
|
|
return
|
|
}
|
|
XCTAssertFalse(after.contains(marker), "Expected typing to be blocked while empty notifications popover is open")
|
|
}
|
|
|
|
private func clickNotificationPopoverRowAndWaitForFocusChange(
|
|
button: XCUIElement,
|
|
app: XCUIApplication,
|
|
from token: String?,
|
|
timeout: TimeInterval
|
|
) -> Bool {
|
|
// `.click()` on a button inside an NSPopover can be flaky on the VM; prefer a coordinate click
|
|
// within the left side of the row (away from the clear button).
|
|
if button.exists {
|
|
let coord = button.coordinate(withNormalizedOffset: CGVector(dx: 0.15, dy: 0.5))
|
|
coord.click()
|
|
} else {
|
|
button.click()
|
|
}
|
|
|
|
// If the coordinate click was swallowed (popover auto-dismiss, etc), retry with a normal click.
|
|
let firstDeadline = min(1.0, timeout)
|
|
if waitForFocusChange(from: token, timeout: firstDeadline) {
|
|
return true
|
|
}
|
|
button.click()
|
|
return waitForFocusChange(from: token, timeout: max(0.0, timeout - firstDeadline))
|
|
}
|
|
|
|
private func waitForWindowCount(atLeast count: Int, app: XCUIApplication, timeout: TimeInterval) -> Bool {
|
|
let deadline = Date().addingTimeInterval(timeout)
|
|
while Date() < deadline {
|
|
if app.windows.count >= count { return true }
|
|
RunLoop.current.run(until: Date().addingTimeInterval(0.05))
|
|
}
|
|
return app.windows.count >= count
|
|
}
|
|
|
|
private func ensureForegroundAfterLaunch(_ app: XCUIApplication, timeout: TimeInterval) -> Bool {
|
|
if app.wait(for: .runningForeground, timeout: timeout) {
|
|
return true
|
|
}
|
|
if app.state == .runningBackground {
|
|
app.activate()
|
|
return app.wait(for: .runningForeground, timeout: 6.0)
|
|
}
|
|
return false
|
|
}
|
|
|
|
private func waitForElementToDisappear(_ element: XCUIElement, timeout: TimeInterval) -> Bool {
|
|
let predicate = NSPredicate(format: "exists == false")
|
|
let expectation = XCTNSPredicateExpectation(predicate: predicate, object: element)
|
|
return XCTWaiter().wait(for: [expectation], timeout: timeout) == .completed
|
|
}
|
|
|
|
private func waitForFocusChange(from token: String?, timeout: TimeInterval) -> Bool {
|
|
let deadline = Date().addingTimeInterval(timeout)
|
|
while Date() < deadline {
|
|
if let data = loadData(),
|
|
let current = data["focusToken"],
|
|
!current.isEmpty,
|
|
current != token {
|
|
return true
|
|
}
|
|
RunLoop.current.run(until: Date().addingTimeInterval(0.05))
|
|
}
|
|
if let data = loadData(),
|
|
let current = data["focusToken"],
|
|
!current.isEmpty,
|
|
current != token {
|
|
return true
|
|
}
|
|
return false
|
|
}
|
|
|
|
private func waitForData(keys: [String], timeout: TimeInterval) -> Bool {
|
|
let deadline = Date().addingTimeInterval(timeout)
|
|
while Date() < deadline {
|
|
if let data = loadData(), keys.allSatisfy({ (data[$0] ?? "").isEmpty == false }) {
|
|
return true
|
|
}
|
|
RunLoop.current.run(until: Date().addingTimeInterval(0.05))
|
|
}
|
|
if let data = loadData(), keys.allSatisfy({ (data[$0] ?? "").isEmpty == false }) {
|
|
return true
|
|
}
|
|
return false
|
|
}
|
|
|
|
private func waitForSocketPong(timeout: TimeInterval) -> String? {
|
|
let deadline = Date().addingTimeInterval(timeout)
|
|
var lastResponse: String?
|
|
while Date() < deadline {
|
|
lastResponse = socketCommand("ping")
|
|
if lastResponse == "PONG" {
|
|
return "PONG"
|
|
}
|
|
RunLoop.current.run(until: Date().addingTimeInterval(0.05))
|
|
}
|
|
return socketCommand("ping") ?? lastResponse
|
|
}
|
|
|
|
private func resolveSocketPath(timeout: TimeInterval) -> String? {
|
|
let deadline = Date().addingTimeInterval(timeout)
|
|
while Date() < deadline {
|
|
for candidate in expectedSocketCandidates() {
|
|
guard FileManager.default.fileExists(atPath: candidate) else { continue }
|
|
if socketRespondsToPing(at: candidate) {
|
|
return candidate
|
|
}
|
|
}
|
|
RunLoop.current.run(until: Date().addingTimeInterval(0.05))
|
|
}
|
|
for candidate in expectedSocketCandidates() {
|
|
guard FileManager.default.fileExists(atPath: candidate) else { continue }
|
|
if socketRespondsToPing(at: candidate) {
|
|
return candidate
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
private func expectedSocketCandidates() -> [String] {
|
|
var candidates = [socketPath]
|
|
let taggedDebugSocket = "/tmp/cmux-debug-\(launchTag).sock"
|
|
if taggedDebugSocket != socketPath {
|
|
candidates.append(taggedDebugSocket)
|
|
}
|
|
return candidates
|
|
}
|
|
|
|
private func socketRespondsToPing(at path: String) -> Bool {
|
|
let originalPath = socketPath
|
|
socketPath = path
|
|
defer { socketPath = originalPath }
|
|
return socketCommand("ping") == "PONG"
|
|
}
|
|
|
|
private func socketCommand(_ cmd: String) -> String? {
|
|
if let response = ControlSocketClient(path: socketPath).sendLine(cmd) {
|
|
return response
|
|
}
|
|
return socketCommandViaNetcat(cmd)
|
|
}
|
|
|
|
private func socketCommandViaNetcat(_ cmd: String) -> String? {
|
|
let nc = "/usr/bin/nc"
|
|
guard FileManager.default.isExecutableFile(atPath: nc) else { return nil }
|
|
|
|
let proc = Process()
|
|
proc.executableURL = URL(fileURLWithPath: "/bin/sh")
|
|
let script = "printf '%s\\n' \(shellSingleQuote(cmd)) | \(nc) -U \(shellSingleQuote(socketPath)) -w 2 2>/dev/null"
|
|
proc.arguments = ["-lc", script]
|
|
|
|
let outPipe = Pipe()
|
|
proc.standardOutput = outPipe
|
|
|
|
do {
|
|
try proc.run()
|
|
} catch {
|
|
return nil
|
|
}
|
|
|
|
proc.waitUntilExit()
|
|
|
|
let outData = outPipe.fileHandleForReading.readDataToEndOfFile()
|
|
guard let outStr = String(data: outData, encoding: .utf8) else { return nil }
|
|
if let first = outStr.split(separator: "\n", maxSplits: 1).first {
|
|
return String(first).trimmingCharacters(in: .whitespacesAndNewlines)
|
|
}
|
|
let trimmed = outStr.trimmingCharacters(in: .whitespacesAndNewlines)
|
|
return trimmed.isEmpty ? nil : trimmed
|
|
}
|
|
|
|
private func shellSingleQuote(_ value: String) -> String {
|
|
if value.isEmpty { return "''" }
|
|
return "'" + value.replacingOccurrences(of: "'", with: "'\"'\"'") + "'"
|
|
}
|
|
|
|
private final class ControlSocketClient {
|
|
private let path: String
|
|
|
|
init(path: String) {
|
|
self.path = path
|
|
}
|
|
|
|
func sendLine(_ line: String) -> String? {
|
|
let fd = socket(AF_UNIX, SOCK_STREAM, 0)
|
|
guard fd >= 0 else { return nil }
|
|
defer { close(fd) }
|
|
|
|
#if os(macOS)
|
|
var noSigPipe: Int32 = 1
|
|
_ = withUnsafePointer(to: &noSigPipe) { ptr in
|
|
setsockopt(
|
|
fd,
|
|
SOL_SOCKET,
|
|
SO_NOSIGPIPE,
|
|
ptr,
|
|
socklen_t(MemoryLayout<Int32>.size)
|
|
)
|
|
}
|
|
#endif
|
|
|
|
var addr = sockaddr_un()
|
|
memset(&addr, 0, MemoryLayout<sockaddr_un>.size)
|
|
addr.sun_family = sa_family_t(AF_UNIX)
|
|
|
|
let maxLen = MemoryLayout.size(ofValue: addr.sun_path)
|
|
let bytes = Array(path.utf8CString)
|
|
guard bytes.count <= maxLen else { return nil }
|
|
withUnsafeMutablePointer(to: &addr.sun_path) { p in
|
|
let raw = UnsafeMutableRawPointer(p).assumingMemoryBound(to: CChar.self)
|
|
memset(raw, 0, maxLen)
|
|
for i in 0..<bytes.count {
|
|
raw[i] = bytes[i]
|
|
}
|
|
}
|
|
|
|
let pathOffset = MemoryLayout<sockaddr_un>.offset(of: \.sun_path) ?? 0
|
|
let addrLen = socklen_t(pathOffset + bytes.count)
|
|
#if os(macOS)
|
|
addr.sun_len = UInt8(min(Int(addrLen), 255))
|
|
#endif
|
|
|
|
let connected = withUnsafePointer(to: &addr) { ptr in
|
|
ptr.withMemoryRebound(to: sockaddr.self, capacity: 1) { sa in
|
|
connect(fd, sa, addrLen)
|
|
}
|
|
}
|
|
guard connected == 0 else { return nil }
|
|
|
|
let payload = line + "\n"
|
|
let wrote: Bool = payload.withCString { cstr in
|
|
var remaining = strlen(cstr)
|
|
var p = UnsafeRawPointer(cstr)
|
|
while remaining > 0 {
|
|
let n = write(fd, p, remaining)
|
|
if n <= 0 { return false }
|
|
remaining -= n
|
|
p = p.advanced(by: n)
|
|
}
|
|
return true
|
|
}
|
|
guard wrote else { return nil }
|
|
|
|
var buf = [UInt8](repeating: 0, count: 4096)
|
|
var accum = ""
|
|
while true {
|
|
let n = read(fd, &buf, buf.count)
|
|
if n <= 0 { break }
|
|
if let chunk = String(bytes: buf[0..<n], encoding: .utf8) {
|
|
accum.append(chunk)
|
|
if let idx = accum.firstIndex(of: "\n") {
|
|
return String(accum[..<idx])
|
|
}
|
|
}
|
|
}
|
|
return accum.isEmpty ? nil : accum.trimmingCharacters(in: .whitespacesAndNewlines)
|
|
}
|
|
}
|
|
|
|
private func readCurrentTerminalText() -> String? {
|
|
guard let response = socketCommand("read_terminal_text"), response.hasPrefix("OK ") else {
|
|
return nil
|
|
}
|
|
let encoded = String(response.dropFirst(3)).trimmingCharacters(in: .whitespacesAndNewlines)
|
|
guard let data = Data(base64Encoded: encoded) else { return nil }
|
|
return String(data: data, encoding: .utf8)
|
|
}
|
|
|
|
private func loadData() -> [String: String]? {
|
|
guard let data = try? Data(contentsOf: URL(fileURLWithPath: dataPath)) else {
|
|
return nil
|
|
}
|
|
return (try? JSONSerialization.jsonObject(with: data)) as? [String: String]
|
|
}
|
|
}
|