Files
punktfunk/clients/apple/Tests/PunktfunkKitTests/RemoteFirstLightTests.swift
T
enricobuehler 0494e0200a
ci / rust (push) Has been cancelled
feat(apple): adapt the macOS client to ABI v2 — client identity + SPAKE2 PIN pairing
The pairing/renegotiation batch bumped the punktfunk/1 ABI to v2 and the host now
hard-rejects v1 Hellos (m3.rs), so streaming from the Mac was dead until the bundled
PunktfunkCore.xcframework is rebuilt — it is gitignored, so that is a per-checkout step:
bash scripts/build-xcframework.sh. The Swift wrapper itself was already adapted upstream;
this lands the app on top of it.

- ClientIdentityStore: persistent client identity in the login Keychain, presented on
  every connect so paired hosts recognize this Mac. Keychain access failure throws
  instead of regenerating (a fresh identity would silently un-pair this Mac from every
  --require-pairing host); a lost first-run race resolves toward the stored identity;
  pairing uses the strict loadForPairing() so a memory-only identity can't strand a
  ceremony.
- PairSheet: the SPAKE2 PIN ceremony, reachable from a host card's context menu and from
  the trust prompt's "Pair with PIN instead…" (which drops the live session first — the
  host's accept loop is sequential). Success pins the verified fingerprint and connects;
  an in-flight ceremony self-discards when the sheet is dismissed, so a late success
  can't pin + auto-connect behind the user's back. Wrong PIN and Keychain failures get
  distinct, actionable error text.
- Tests: identity unit tests; the full pairing ceremony + --require-pairing gate on
  loopback (test-loopback.sh arms a second host, parses its PIN from the log, and gives
  both hosts throwaway config homes — no more writes to the real ~/.config/punktfunk);
  remote pairing + pinned stream over the LAN (PUNKTFUNK_REMOTE_PIN, _PORT).

Validated live against the box: SPAKE2 ceremony with the host's arming PIN → verified
fingerprint → pinned + identified 720p60 session (host persisted the client identity);
first light 60/60 AUs decoded to pixels; vkcube on glass through the app.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-06-10 21:49:43 +02:00

115 lines
5.1 KiB
Swift

// First light, headless: the full client pipeline against a REAL remote host QUIC
// handshake over the LAN, NVENC HEVC AUs through FEC + AES-GCM, AnnexB conversion, and a
// real VTDecompressionSession turning them into pixels. Everything the GUI does except
// putting the layer on glass.
//
// Run (host side, on the Linux box):
// PUNKTFUNK_COMPOSITOR=gamescope PUNKTFUNK_GAMESCOPE_APP=vkcube PUNKTFUNK_ZEROCOPY=1 \
// punktfunk-host m3-host --source virtual --seconds 120
// Then here:
// PUNKTFUNK_REMOTE_HOST=192.168.1.70 swift test --filter RemoteFirstLightTests
import CoreMedia
import VideoToolbox
import XCTest
@testable import PunktfunkKit
final class RemoteFirstLightTests: XCTestCase {
/// The pairing ceremony over the real LAN, exactly as the app runs it: fresh identity,
/// SPAKE2 with the host's arming PIN, then a pinned + identified session. Needs the
/// host armed (--allow-pairing) and its logged PIN in PUNKTFUNK_REMOTE_PIN. Heads-up:
/// every run durably adds one throwaway "remote-test" identity to the host's
/// ~/.config/punktfunk/punktfunk1-paired.json prune those entries at will.
func testRemotePairingThenPinnedStream() throws {
let env = ProcessInfo.processInfo.environment
guard let host = env["PUNKTFUNK_REMOTE_HOST"], let pin = env["PUNKTFUNK_REMOTE_PIN"]
else {
throw XCTSkip("set PUNKTFUNK_REMOTE_HOST + PUNKTFUNK_REMOTE_PIN "
+ "(host armed with --allow-pairing)")
}
let port = env["PUNKTFUNK_REMOTE_PORT"].flatMap(UInt16.init) ?? 9777
let identity = try generateIdentity()
let fingerprint = try pair(
host: host, port: port, identity: identity, pin: pin, name: "remote-test")
XCTAssertEqual(fingerprint.count, 32)
let conn = try PunktfunkConnection(
host: host, port: port, width: 1280, height: 720, refreshHz: 60,
pinSHA256: fingerprint, identity: identity)
defer { conn.close() }
XCTAssertEqual(conn.hostFingerprint, fingerprint)
var got = 0
let deadline = Date().addingTimeInterval(20)
while got < 10, Date() < deadline {
if try conn.nextAU(timeoutMs: 2000) != nil { got += 1 }
}
XCTAssertGreaterThanOrEqual(got, 10, "paired + pinned session must stream")
}
func testRemoteStreamDecodesToPixels() throws {
let env = ProcessInfo.processInfo.environment
guard let host = env["PUNKTFUNK_REMOTE_HOST"] else {
throw XCTSkip("set PUNKTFUNK_REMOTE_HOST (and start m3-host --source virtual there)")
}
let port = env["PUNKTFUNK_REMOTE_PORT"].flatMap(UInt16.init) ?? 9777
let width: UInt32 = 1280
let height: UInt32 = 720
let conn = try PunktfunkConnection(
host: host, port: port, width: width, height: height, refreshHz: 60)
defer { conn.close() }
XCTAssertEqual(conn.width, width)
XCTAssertEqual(conn.height, height)
var format: CMVideoFormatDescription?
var decoder: VTDecompressionSession?
defer { decoder.map { VTDecompressionSessionInvalidate($0) } }
var received = 0
var decoded = 0
var firstPtsNs: UInt64 = 0
var lastPtsNs: UInt64 = 0
let deadline = Date().addingTimeInterval(30)
while decoded < 60, Date() < deadline {
guard let au = try conn.nextAU(timeoutMs: 2000) else { continue }
received += 1
if firstPtsNs == 0 { firstPtsNs = au.ptsNs }
lastPtsNs = au.ptsNs
if let f = AnnexB.formatDescription(fromIDR: au.data) {
format = f
if decoder == nil {
let dims = CMVideoFormatDescriptionGetDimensions(f)
XCTAssertEqual(UInt32(dims.width), width)
XCTAssertEqual(UInt32(dims.height), height)
var session: VTDecompressionSession?
XCTAssertEqual(
VTDecompressionSessionCreate(
allocator: nil, formatDescription: f, decoderSpecification: nil,
imageBufferAttributes: nil, outputCallback: nil,
decompressionSessionOut: &session),
noErr)
decoder = session
}
}
guard let f = format, let dec = decoder,
let sample = AnnexB.sampleBuffer(au: au, format: f)
else { continue }
var gotPixels = false
VTDecompressionSessionDecodeFrame(
dec, sampleBuffer: sample, flags: [], infoFlagsOut: nil
) { status, _, imageBuffer, _, _ in
gotPixels = status == noErr && imageBuffer != nil
}
if gotPixels { decoded += 1 }
}
XCTAssertGreaterThanOrEqual(decoded, 60, "decoded \(decoded)/\(received) received AUs")
// The host stamps pts with its capture wall clock 60 frames should span ~1 s.
let spanMs = Double(lastPtsNs &- firstPtsNs) / 1_000_000
print("first light: \(decoded) frames decoded, \(received) received, pts span \(Int(spanMs)) ms")
}
}