Files
VCCPlusOSS/platforms/macos/Tests/SoftwareLibraryPublishedGameTests.swift
T
Brian Holman 5534005799 Sync VCC Plus 3.7.1 build 67 source
Refresh reviewed MCP output export, four-drive owned playtests, bounded BASIC readiness, and pinned CMOC 0.1.101 source/patches. Preserve independent source-edition identity, empty libraries, notices and privacy boundaries.

Validated 74 export/privacy checks, pinned dependency sources, and an independent unsigned universal Release build. A subsequent documentation-only correction removes an excluded qualification link; all build inputs remain identical.
2026-11-17 08:42:27 -07:00

710 lines
52 KiB
Swift

// SPDX-License-Identifier: GPL-3.0-or-later
import XCTest
import AppKit
import CryptoKit
import PDFKit
import ImageIO
/// Explicit opt-in qualification of the approved, published game packages.
/// Ordinary test runs use authored fixtures elsewhere and skip this network case.
/// No normal app settings, user disks, installed app or source checkout are opened.
final class SoftwareLibraryPublishedGameTests: XCTestCase {
private struct Fixture: Sendable {
let slug: String
let receiptDate: String
let edition: String
let diskSHA256: String
let ramKiB: Int
let keyboardOnly: Bool
var receiptFilename: String { receiptDate + "-" + slug + "-downloads.json" }
var releaseID: String { "vccplus." + slug + "." + edition }
static let approved: [Fixture] = [
.init(slug: "bone-quest", receiptDate: "2026-11-11", edition: "2026-11-11",
diskSHA256: "373a3f387daf541b1eb4edd3421a125dd57094e600ee48d162802ac22f65ceba", ramKiB: 512, keyboardOnly: true),
.init(slug: "capital-quest", receiptDate: "2026-11-12", edition: "2026-11-12",
diskSHA256: "3a1b42279e47460d06d3b9d31bdeac87d59ed67e6d67a1c5f1dbfa6fe884574e", ramKiB: 512, keyboardOnly: true),
.init(slug: "quadrapassel", receiptDate: "2026-11-11", edition: "build-05",
diskSHA256: "d05ab25fd90171b048cce54f3af18ca6d0bd81335e138044ff05315e99cbf582", ramKiB: 128, keyboardOnly: false)
]
}
/// These are candidate source-rebuild identities, not publication receipts.
/// Independently replayed in owned folders with the pinned unsigned development
/// runtime; this is not execution of the Developer ID-signed packaged compiler.
private struct CandidateSourceBaseline: Sendable {
let sourceZIP: String
let makefile: String
let binary: String
let disk: String
static let runtimeManifest = "a4dd934aed84a0b139e1d88b8a607d52ff7f6fc66c3bd3be30db7fd5d40dcbef"
static let compiler = "5769c5ffe14f0adad61c41aa72337261acc6fd882e7e6656bdcf350b414930a1"
static let wrapper = "b83e6ea79da5160cd85f5b7665524f19f717a4a6e76e12e661900dc071a1cea6"
static let reviewed: [String: Self] = [
"bone-quest": .init(sourceZIP: "99f9770965f9d2061f764ebe704da95f7f037a42c5df21a959b558b25d704da6",
makefile: "b0e9816d4b1712cd903b1e51ebb5c80901fb45ba4233f6b091e6e97fe5cdd1d7",
binary: "f57e5818d070009cb2713fe4d70f8f0cba2bd2e5c54833d4911348a708bdb0f0",
disk: "8614c31b92a5f3b70b7b35792414b7fd43042614de2bda4b6ff508711f157a8d"),
"capital-quest": .init(sourceZIP: "5f0cbc6ad58594a1c21a77079b2db4a2862546b6f701c2d515fe04f9727568f3",
makefile: "880c46b17747ed0cbe33c386b21f319b9e453ab64cab185bd7f802293226a886",
binary: "9b2fe10ebca6c515d3cb45f649ea772058be4186b8abac3fec95c3b69d955e6b",
disk: "28a07495e1afa5702fd7c9def0aa2c94d8671ec6cfd6de2c57d5b92b4aa0c930"),
"quadrapassel": .init(sourceZIP: "710c8e1e9d6cfbd800d5719e30ad2057aa9bade8c81f8d1e5374634b4d208438",
makefile: "70144a013bdf2ad4c7ea996b53a1d304d7f440236d91f22fc7e63481fb258a92",
binary: "4893e44f7ba33c3fa3b8f8268588104038dd402fae7cd3dcdbeeca11aa3e6df5",
disk: "49e931b0530214d9cdb2afd4f5a1f3819695b3267e70fec04dcc69f86fc5ce9f")
]
}
private struct Game: Sendable {
let fixture: Fixture
let publicationID: String
var slug: String { fixture.slug }
let record: LibraryJSON
let release: SoftwareLibraryRelease
var owned: SoftwareLibraryOwnedGame { release.ownedGame! }
}
private struct Inputs: Sendable {
let output: URL
let games: [Game]
let toolchain: URL?
}
private var macRoot: URL {
URL(fileURLWithPath: #filePath).deletingLastPathComponent().deletingLastPathComponent()
}
private static var architecture: String {
#if arch(arm64)
return "arm64"
#else
return "x86_64"
#endif
}
private func inputs() async throws -> Inputs {
let environment = ProcessInfo.processInfo.environment
guard let records = environment["VCC_EXCLUSIVE_RECEIPT_DIR"],
let output = environment["VCC_EXCLUSIVE_ACCEPTANCE_ROOT"] else {
throw XCTSkip("Set explicit published receipt and ignored acceptance-output directories to run real game qualification")
}
guard records.hasPrefix("/"), output.hasPrefix("/"),
output.contains("/.build/") || output.hasPrefix("/private/tmp/") || output.hasPrefix("/tmp/") else {
throw ProfileFailure.message("Published-game acceptance output must be an explicit ignored build or temporary directory")
}
let directory = URL(fileURLWithPath: output).appendingPathComponent("PublishedGames-" + Self.architecture + "-" + UUID().uuidString)
try FileManager.default.createDirectory(at: directory, withIntermediateDirectories: true)
let prepared: SoftwareLibraryCatalog?
if let path = environment["VCC_EXCLUSIVE_CATALOG"] { prepared = try await SoftwareLibraryCatalog.load(from: URL(fileURLWithPath: path)) }
else { prepared = nil }
var games: [Game] = []
for fixture in Fixture.approved {
let data = try Data(contentsOf: URL(fileURLWithPath: records).appendingPathComponent(fixture.receiptFilename))
guard let publicRecord = try JSONSerialization.jsonObject(with: data) as? [String: Any],
publicRecord["state"] as? String == "verified",
let publicationID = publicRecord["publicationId"] as? String,
var record = publicRecord["contract"] as? [String: Any] else {
throw ProfileFailure.message("A verified portable published-game record is required")
}
// The retained owner evidence explicitly records RGB. Mirror the
// intake's documented effective recommendation without altering receipts.
var setup = record["setup"] as! [String: Any]
var configuration = setup["configuration"] as! [String: Any]
configuration["video"] = "rgb"
if fixture.keyboardOnly {
configuration["controls"] = ["keyboard": "Use the keyboard to choose a mode, enter answers and submit with Enter; see the game manual for editing keys."]
}
setup["configuration"] = configuration; record["setup"] = setup
let json = try JSONDecoder().decode(LibraryJSON.self, from: JSONSerialization.data(withJSONObject: record))
let owned = try XCTUnwrap(SoftwareLibraryOwnedGame.parse(json))
XCTAssertEqual(owned.releaseID, fixture.releaseID)
XCTAssertEqual(owned.diskSHA256, fixture.diskSHA256)
XCTAssertEqual(owned.ramKiB, fixture.ramKiB)
XCTAssertEqual(owned.processor, "6809")
let release: SoftwareLibraryRelease
if let prepared {
release = try XCTUnwrap(prepared.releases.first(where: { $0.id == owned.releaseID }))
XCTAssertEqual(release.ownedGame?.gameID, owned.gameID)
XCTAssertEqual(release.packageSHA256, owned.package.sha256)
XCTAssertEqual(release.ownedGame?.diskSHA256, fixture.diskSHA256)
XCTAssertEqual(release.ownedGame?.source.package, owned.source.package)
XCTAssertEqual(release.ownedGame?.manualPDF, owned.manualPDF)
XCTAssertEqual(release.setup.ramKiB, owned.ramKiB)
XCTAssertEqual(release.setup.configuration["video"].string, "rgb")
} else {
release = SoftwareLibraryRelease(id: owned.releaseID, titleID: owned.gameID,
name: owned.package.url.lastPathComponent, category: owned.primaryBrowseCategory,
mediaType: "disk", contentRole: "software", sourceURL: owned.projectURL,
modifiedAt: nil, modifiedPrecision: nil, modifiedTimezone: nil,
packageSHA256: owned.package.sha256, byteSize: owned.package.byteSize,
languageStatus: "english", metadata: .object(["owned_game": json, "title": json["title"], "system": .string("CoCo 3")]),
setup: .init(status: "spot-checked", command: "DOS\r", instructions: "Approved published game; Cold Restart then DOS.",
configuration: json["setup"]["configuration"], selectedMembers: json["setup"]["selected_members"],
reasons: [], validation: json["setup"]["validation"]), assets: [], downloadURLs: [owned.package.url])
}
try release.validatePresentationMetadata()
games.append(Game(fixture: fixture, publicationID: publicationID, record: json, release: release))
}
let toolchain = environment["VCC_EXCLUSIVE_TOOLCHAIN"].map { URL(fileURLWithPath: $0) }
return Inputs(output: directory, games: games, toolchain: toolchain)
}
private func variant(_ release: SoftwareLibraryRelease, use6309: Bool) throws -> SoftwareLibraryRelease {
var object = try JSONSerialization.jsonObject(with: JSONEncoder().encode(release)) as! [String: Any]
var setup = object["setup"] as! [String: Any]
var configuration = setup["configuration"] as! [String: Any]
configuration["processor"] = use6309 ? "6309" : "6809"
setup["configuration"] = configuration; object["setup"] = setup
var metadata = object["metadata"] as! [String: Any]
var owned = metadata["owned_game"] as! [String: Any]
var ownedSetup = owned["setup"] as! [String: Any]
var ownedConfiguration = ownedSetup["configuration"] as! [String: Any]
ownedConfiguration["processor"] = use6309 ? "6309" : "6809"
ownedSetup["configuration"] = ownedConfiguration; owned["setup"] = ownedSetup
metadata["owned_game"] = owned; object["metadata"] = metadata
// HD6309 is a test-only recipe variant, never written into the approved
// canonical MC6809 catalog or portable publication record.
return try JSONDecoder().decode(SoftwareLibraryRelease.self, from: JSONSerialization.data(withJSONObject: object))
}
@MainActor private func step(_ operation: (@escaping @Sendable (VCCMachineSnapshot) -> Void) -> Void) async -> VCCMachineSnapshot {
await withCheckedContinuation { done in operation { done.resume(returning: $0) } }
}
@MainActor private func debugger(_ controller: VCCMachineController) async -> VCCDebuggerSnapshot {
await withCheckedContinuation { done in
controller.debuggerSnapshot(address: 0, followPC: false, memoryAddress: 0) { done.resume(returning: $0) }
}
}
@MainActor private func settle(_ model: MachineModel) async throws {
for _ in 0..<1000 {
if !model.busy && !model.diskSaving { return }
try await Task.sleep(nanoseconds: 10_000_000)
}
throw ProfileFailure.message("Published-game fixture did not settle")
}
@MainActor private func withMachine(output: URL, use6309: Bool, startingMachine: MachineSettings? = nil,
body: (MachineModel, VCCMachineController, UserDefaults) async throws -> Void) async throws {
_ = NSApplication.shared // Standalone hostless runs still need AppKit's input lifecycle.
let suite = "PublishedGame-" + UUID().uuidString
let defaults = UserDefaults(suiteName: suite)!
defer { defaults.removePersistentDomain(forName: suite) }
let controller = VCCMachineController()
let model = MachineModel(diskStore: .init(url: output.appendingPathComponent("Disks.json")), controller: controller,
displayDefaults: defaults, inputStore: .init(url: output.appendingPathComponent("Input.json")))
do {
try await settle(model)
var profile = ConfigurationProfile(name: "Published-game acceptance")
profile.systemROM = macRoot.appendingPathComponent("LocalResources/ROMs/coco3.rom")
profile.media.rom = macRoot.appendingPathComponent("LocalResources/ROMs/disk11.rom")
try XCTSkipUnless(FileManager.default.fileExists(atPath: profile.systemROM!.path)
&& FileManager.default.fileExists(atPath: profile.media.rom!.path), "Stage explicit local CoCo/Disk BASIC ROM inputs")
profile.sound = false; profile.videoOutput = 0
profile.machine.ram = 2; profile.machine.use6309 = !use6309
if let startingMachine { profile.machine = startingMachine }
profile.input.right.source = .keyboard; profile.input.left.source = .none
var cartridges = CartridgeAssignments(); cartridges.multiPak = true; cartridges.mpiConfigured = true
cartridges.physicalSlot = 4; cartridges.slots[4].kind = .floppy; profile.media.cartridges = cartridges
await model.loadProfile(profile); XCTAssertNil(model.profileError)
model.resume(); try await settle(model)
try await body(model, controller, defaults)
} catch {
await withCheckedContinuation { done in model.shutdown { done.resume() } }; throw error
}
await withCheckedContinuation { done in model.shutdown { done.resume() } }
}
private static func sha(_ data: Data) -> String { SHA256.hash(data: data).map { String(format: "%02x", $0) }.joined() }
private func artwork(_ descriptor: LibraryJSON, id: String) throws -> SoftwareLibraryAsset {
let url = try XCTUnwrap(URL(string: XCTUnwrap(descriptor["url"].string)))
let hash = try XCTUnwrap(descriptor["sha256"].string)
let size = try XCTUnwrap(descriptor["byte_size"].integer)
var asset = SoftwareLibraryAsset(id: id, name: id, kind: "screenshot", sourceURL: url,
sha256: hash, byteSize: Int64(size), credit: "Published game title capture", matchStatus: "project-owned", matchReason: "Owner-supplied verified capture")
asset.thumbnailURL = url; asset.thumbnailSHA256 = hash; asset.thumbnailByteSize = Int64(size)
return asset
}
private struct Raster {
let width: Int, height: Int
let rgba: [UInt8]
init(_ png: Data) throws {
guard let source = CGImageSourceCreateWithData(png as CFData, nil),
let image = CGImageSourceCreateImageAtIndex(source, 0, nil),
image.width > 0, image.height > 0, image.width <= 1280, image.height <= 960 else {
throw ProfileFailure.message("Published acceptance image could not be decoded")
}
width = image.width; height = image.height
var pixels = [UInt8](repeating: 0, count: width * height * 4)
let made = pixels.withUnsafeMutableBytes { bytes -> Bool in
guard let context = CGContext(data: bytes.baseAddress, width: image.width, height: image.height,
bitsPerComponent: 8, bytesPerRow: image.width * 4, space: CGColorSpaceCreateDeviceRGB(),
bitmapInfo: CGImageAlphaInfo.premultipliedLast.rawValue | CGBitmapInfo.byteOrder32Big.rawValue) else { return false }
context.interpolationQuality = .none
context.draw(image, in: CGRect(x: 0, y: 0, width: image.width, height: image.height))
return true
}
guard made else { throw ProfileFailure.message("Published acceptance image could not be rendered") }
rgba = pixels
}
func changedPixelFraction(comparedTo before: Raster) -> Double {
guard width == before.width, height == before.height else { return 1 }
var changed = 0
for offset in stride(from: 0, to: rgba.count, by: 4) {
if (0..<3).contains(where: { abs(Int(rgba[offset + $0]) - Int(before.rgba[offset + $0])) > 28 }) { changed += 1 }
}
return Double(changed) / Double(width * height)
}
/// Compare only authored, static PLAY UI in the 320x192 reference.
/// Coordinates map through the captured active picture, never full-frame
/// borders. Black background, pieces, preview tiles and numbers are omitted.
func staticForegroundMatch(to reference: Raster, regions: [CGRect]) -> (score: Double, pixels: Int, matched: Int) {
var foreground = 0, matched = 0
for region in regions {
guard region.minX >= 0, region.minY >= 0,
region.maxX <= CGFloat(reference.width), region.maxY <= CGFloat(reference.height) else { return (0, 0, 0) }
for y in Int(region.minY)..<Int(region.maxY) { for x in Int(region.minX)..<Int(region.maxX) {
let r = (y * reference.width + x) * 4
if (0..<3).allSatisfy({ reference.rgba[r + $0] <= 28 }) { continue }
foreground += 1
let a = ((y * height / reference.height) * width + x * width / reference.width) * 4
if (0..<3).allSatisfy({ abs(Int(rgba[a + $0]) - Int(reference.rgba[r + $0])) <= 28 }) { matched += 1 }
} }
}
return (foreground > 100 ? Double(matched) / Double(foreground) : 0, foreground, matched)
}
func similarity(to reference: Raster) -> Double {
var histogram: [UInt32: Int] = [:]
for index in stride(from: 0, to: reference.rgba.count, by: 4) {
let key = UInt32(reference.rgba[index]) << 16 | UInt32(reference.rgba[index + 1]) << 8 | UInt32(reference.rgba[index + 2])
histogram[key, default: 0] += 1
}
let background = histogram.max(by: { $0.value < $1.value })?.key ?? 0
var matched = 0, foreground = 0
for y in 0..<reference.height { for x in 0..<reference.width {
let r = (y * reference.width + x) * 4
let key = UInt32(reference.rgba[r]) << 16 | UInt32(reference.rgba[r + 1]) << 8 | UInt32(reference.rgba[r + 2])
if key == background { continue }
foreground += 1
let a = ((y * height / reference.height) * width + x * width / reference.width) * 4
let difference = (0..<3).map { abs(Int(rgba[a + $0]) - Int(reference.rgba[r + $0])) }.max()!
if difference <= 28 { matched += 1 }
} }
return foreground > 100 ? Double(matched) / Double(foreground) : 0
}
}
@MainActor private func waitForTitle(reference: Raster, controller: VCCMachineController,
output: URL) async throws -> (VCCMachineSnapshot, Double) {
var best: (VCCMachineSnapshot, Data, Double)?
var readyFrames = 0
let started = await step(controller.snapshot)
func retain(_ snapshot: VCCMachineSnapshot, png: Data, score: Double) throws {
try png.write(to: output, options: .atomic)
let metadata: [String: Any] = ["reference_width": reference.width, "reference_height": reference.height,
"reference_uses_full_frame": reference.width == 640 && reference.height == 480,
"foreground_similarity": score, "generation": snapshot.generation,
"frame": snapshot.frames, "observed_fields": snapshot.frames - min(snapshot.frames, started.frames),
"active_rect": [snapshot.activeVideoRect.minX, snapshot.activeVideoRect.minY,
snapshot.activeVideoRect.width, snapshot.activeVideoRect.height]]
try JSONSerialization.data(withJSONObject: metadata, options: [.prettyPrinted, .sortedKeys])
.write(to: output.deletingPathExtension().appendingPathExtension("json"), options: .atomic)
}
// Bone Quest's owner fixture waits up to 4,200 guest fields after DOS.
// Allow that bounded boot interval without accepting a partial title.
for _ in 0..<150 {
let snapshot = await step(controller.snapshot)
if snapshot.frames >= started.frames && snapshot.frames - started.frames > 4_500 { break }
// Published helper captures can include the complete 640x480 raster
// (e.g. 225-line GIME output centered vertically). Preserve that
// reference coordinate system instead of stretching its black border
// into the active picture. Legacy cropped references use active bounds.
let area = reference.width == 640 && reference.height == 480 ? VideoGeometry.fullFrame : snapshot.activeVideoRect
if snapshot.state == .running, snapshot.pasteRemaining == 0,
let capture = try? ScreenCapture(pixels: snapshot.pixels, area: area),
let png = try? capture.png(), let raster = try? Raster(png) {
let score = raster.similarity(to: reference)
if score > (best?.2 ?? -1) { best = (snapshot, png, score) }
// A partly drawn logo is not a ready game. Require the complete
// owner-supplied menu on successive observations, allowing a cursor blink.
readyFrames = score >= 0.95 ? readyFrames + 1 : 0
if readyFrames >= 2 {
try retain(snapshot, png: png, score: score)
return (snapshot, score)
}
}
try await Task.sleep(nanoseconds: 500_000_000)
}
if let best { try retain(best.0, png: best.1, score: best.2) }
throw ProfileFailure.message("Published title capture did not match its owner reference; best foreground similarity \(best?.2 ?? 0). Inspect retained frame before changing the qualification.")
}
@MainActor private func qualifySourcesAndManual(_ game: Game, model: MachineModel,
controller: VCCMachineController, defaults: UserDefaults, output: URL, toolchain: URL?) async throws -> [String: Any] {
_ = await step(controller.pause); try await settle(model)
let before = await debugger(controller)
let importer = SoftwareLibrarySourceImporter(cacheDirectory: output.appendingPathComponent("Source originals"))
let imported = try await importer.importProject(game.owned.source, to: output.appendingPathComponent("Editable Source With Spaces"))
let project = try CMOCProject.open(at: imported.projectDirectory)
let originalMakefile = try Data(contentsOf: project.makefileURL)
XCTAssertEqual(project.configuration.entrySource, game.owned.source.entrySource)
let workspace = CMOCDevelopmentModel(machine: model, toolchain: toolchain,
defaults: defaults, buildRoot: output.appendingPathComponent("Workspace builds"), recoveryRoot: output.appendingPathComponent("Recovery"))
let opened = try await workspace.openImportedProject(at: imported.projectDirectory,
expectedProjectID: workspace.assistantProjectID, preferredConfiguration: game.owned.source.buildConfiguration)
XCTAssertTrue(opened); XCTAssertFalse(workspace.building); XCTAssertNil(workspace.artifact)
if let configuration = game.owned.source.buildConfiguration { XCTAssertEqual(workspace.configurationName, configuration) }
XCTAssertEqual(workspace.configurationName, "Release", "The approved source package should open in its playable Release configuration")
XCTAssertEqual(try Data(contentsOf: project.makefileURL), originalMakefile)
let afterOpen = await debugger(controller)
XCTAssertEqual(afterOpen.machine.generation, before.machine.generation)
XCTAssertEqual(afterOpen.machine.cycles, before.machine.cycles)
XCTAssertEqual(afterOpen.registers, before.registers)
XCTAssertEqual(afterOpen.logicalMemory, before.logicalMemory)
let manual = try await SoftwareLibraryManualCache().localCopy(for: XCTUnwrap(game.release.primaryManualAsset), directory: output.appendingPathComponent("Manuals"))
let document = try XCTUnwrap(PDFDocument(url: manual)); XCTAssertGreaterThan(document.pageCount, 0)
let offline = URLSessionConfiguration.ephemeral; offline.protocolClasses = [PublishedGameOfflineTransport.self]
let cachedManual = try await SoftwareLibraryManualCache(session: URLSession(configuration: offline))
.localCopy(for: XCTUnwrap(game.release.primaryManualAsset), directory: output.appendingPathComponent("Manuals"))
XCTAssertEqual(cachedManual, manual)
let cover = try artwork(game.record["artwork"]["cover"], id: game.slug + "-cover")
let coverData = try await SoftwareLibraryArtworkCache().thumbnail(for: cover, directory: output.appendingPathComponent("Artwork"))
XCTAssertEqual(Self.sha(coverData), cover.thumbnailSHA256)
var report: [String: Any] = ["source_zip_sha256": Self.sha(try Data(contentsOf: imported.originalPackage)),
"source_open_without_build": true, "manual_pages": document.pageCount,
"manual_sha256": Self.sha(try Data(contentsOf: manual)), "manual_cached_without_network": true,
"cover_sha256": Self.sha(coverData), "configuration": workspace.configurationName]
if let toolchain {
let build = try await CMOCBuildService(toolchain: toolchain, buildRoot: output.appendingPathComponent("Source qualification"))
.build(project: project, overlays: [:], action: .disk, configuration: "Release")
XCTAssertEqual(build.diskSHA256, game.owned.diskSHA256, "The imported source must reproduce the approved disk with bundled tools")
XCTAssertEqual(Self.sha(try Data(contentsOf: XCTUnwrap(build.diskURL))), game.owned.diskSHA256)
report["rebuilt_disk_sha256"] = build.diskSHA256
report["source_build_configuration"] = build.configurationName
} else { report["source_build"] = "Not requested: set VCC_EXCLUSIVE_TOOLCHAIN to the published app's Toolchain directory" }
XCTAssertEqual(try Data(contentsOf: project.makefileURL), originalMakefile, "Source qualification must preserve the author's Makefile")
report["makefile_sha256"] = Self.sha(originalMakefile)
let afterBuild = await debugger(controller)
XCTAssertEqual(afterBuild.machine.generation, before.machine.generation)
XCTAssertEqual(afterBuild.machine.cycles, before.machine.cycles)
XCTAssertEqual(afterBuild.registers, before.registers)
XCTAssertEqual(afterBuild.logicalMemory, before.logicalMemory)
return report
}
@MainActor private func startCandidateDOS(_ model: MachineModel, controller: VCCMachineController) async throws {
// Native owned-media qualification observes the core's readiness only.
// The shared-program MCP screen surface intentionally rejects writable
// disks; it is not the permission path for this disposable native session.
// Visible OK precedes BASIC's direct-input loop, so require both actual
// direct input and a stable final OK on mature guest fields before typing.
let initial = await step(controller.snapshot)
guard initial.errorMessage == nil else {
throw ProfileFailure.message(initial.errorMessage ?? "Candidate Disk BASIC startup failed")
}
var ready = false, readyObservations = 0
var firstReadyField: UInt64?
var lastText = "(unavailable)"
var last = initial
let deadline = ContinuousClock.now.advanced(by: .seconds(15))
while ContinuousClock.now < deadline {
let readiness = await step(controller.assistantReadiness)
let (text, snapshot): (String?, VCCMachineSnapshot) = await withCheckedContinuation { done in
controller.inspectScreenText { done.resume(returning: ($0, $1)) }
}
last = snapshot; lastText = text ?? "(unavailable)"
guard readiness.errorMessage == nil, snapshot.errorMessage == nil,
readiness.state == .running, snapshot.state == .running,
readiness.generation == initial.generation, snapshot.generation == initial.generation else {
throw ProfileFailure.message(snapshot.errorMessage ?? readiness.errorMessage ?? "Candidate Disk BASIC changed during startup readiness checks")
}
let lines = (text ?? "").split(separator: "\n").map { $0.trimmingCharacters(in: .whitespaces) }.filter { !$0.isEmpty }
guard !lines.contains(where: { $0.hasPrefix("?") }) else {
throw ProfileFailure.message("Candidate Disk BASIC reported an error before DOS; no command was sent")
}
if readiness.assistantDirectPrompt?.boolValue == true,
readiness.assistantEmptyBASIC?.boolValue == true,
lines.last == "OK", readiness.pasteRemaining == 0, snapshot.pasteRemaining == 0 {
readyObservations += 1
if firstReadyField == nil { firstReadyField = readiness.frames }
if readyObservations >= 2, let firstReadyField, readiness.frames >= firstReadyField + 6 {
ready = true; break
}
} else { readyObservations = 0; firstReadyField = nil }
try await Task.sleep(for: .milliseconds(100))
}
guard ready else {
throw ProfileFailure.message("Candidate disk did not reach stable native direct Disk BASIC readiness; no command was sent. Screen: " + lastText +
String(format: " PC %04X, frame %llu.", last.programCounter, last.frames))
}
try await settle(model)
guard model.canPaste else { throw ProfileFailure.message("Candidate Disk BASIC was not ready for ordinary keyboard input") }
model.startPaste(try CocoPaste("DOS\n", mode: .text))
try await settle(model)
}
/// The published-binary test below deliberately retains its original hash
/// contract. This separate opt-in checks the reviewed compiler's different
/// outputs and actually boots those outputs, never a substituted old disk.
@MainActor func testReviewedCMOC101SourceRebuildsBootAndRespondOnBothGuestCPUs() async throws {
guard let path = ProcessInfo.processInfo.environment["VCC_TEST_TOOLCHAIN_DIR"] else {
throw XCTSkip("Set the pinned unsigned development toolchain and private published-game fixture inputs for current-compiler qualification")
}
guard path.hasPrefix("/") else { throw ProfileFailure.message("Candidate compiler qualification requires an absolute runtime path") }
let toolchain = URL(fileURLWithPath: path)
let manifestData = try Data(contentsOf: toolchain.appendingPathComponent("manifest.json"))
let compilerData = try Data(contentsOf: toolchain.appendingPathComponent("libexec/cmoc"))
let wrapperData = try Data(contentsOf: toolchain.appendingPathComponent("bin/cmoc"))
guard Self.sha(manifestData) == CandidateSourceBaseline.runtimeManifest,
Self.sha(compilerData) == CandidateSourceBaseline.compiler,
Self.sha(wrapperData) == CandidateSourceBaseline.wrapper else {
throw ProfileFailure.message("Unknown candidate compiler/runtime identity: independently review and qualify new rebuild baselines before accepting these bytes")
}
let inputs = try await inputs()
var results: [[String: Any]] = []
for game in inputs.games {
guard let expected = CandidateSourceBaseline.reviewed[game.slug],
game.owned.source.package.sha256 == expected.sourceZIP else {
throw ProfileFailure.message("The published source package has no reviewed candidate rebuild baseline")
}
let gameOutput = inputs.output.appendingPathComponent(game.slug)
try FileManager.default.createDirectory(at: gameOutput, withIntermediateDirectories: true)
let importer = SoftwareLibrarySourceImporter(cacheDirectory: gameOutput.appendingPathComponent("Candidate source originals"))
let imported = try await importer.importProject(game.owned.source, to: gameOutput.appendingPathComponent("Candidate Source With Spaces"))
guard Self.sha(try Data(contentsOf: imported.originalPackage)) == expected.sourceZIP else {
throw ProfileFailure.message("Candidate source archive differs from the reviewed immutable package")
}
let project = try CMOCProject.open(at: imported.projectDirectory)
let originalInputs = try project.inputFiles()
let originalMakefile = try Data(contentsOf: project.makefileURL)
guard Self.sha(originalMakefile) == expected.makefile else {
throw ProfileFailure.message("Candidate source Makefile differs from the reviewed unmodified recipe")
}
let build = try await CMOCBuildService(toolchain: toolchain, buildRoot: gameOutput.appendingPathComponent("Candidate source qualification"))
.build(project: project, overlays: [:], action: .disk, configuration: "Release")
let disk = try Data(contentsOf: XCTUnwrap(build.diskURL))
guard Self.sha(build.binaryData) == expected.binary, build.diskSHA256 == expected.disk,
Self.sha(disk) == expected.disk else {
throw ProfileFailure.message("Candidate compiler output differs from the independently replayed exact BIN/DSK baseline")
}
XCTAssertEqual(build.configurationName, "Release")
XCTAssertEqual(try project.inputFiles(), originalInputs, "Candidate compilation must preserve every imported input")
XCTAssertEqual(try Data(contentsOf: project.makefileURL), originalMakefile)
let hero = try artwork(game.record["artwork"]["hero"], id: game.slug + "-candidate-title")
let referenceData = try await SoftwareLibraryArtworkCache().thumbnail(for: hero, directory: gameOutput.appendingPathComponent("Artwork"))
let reference = try Raster(referenceData)
let gameplayReferenceSHA = "dd6c5b0e02e3a7c995056a436a4379ab617c7a0c60ddf246ad5ac9163e5239b8"
// Source-authored stable captions and all four well borders only.
// Exclude board cells, NEXT/HOLD previews and changing score values.
let gameplayStaticRegions: [CGRect] = [
CGRect(x: 32, y: 0, width: 168, height: 8),
CGRect(x: 32, y: 32, width: 40, height: 8),
CGRect(x: 32, y: 64, width: 40, height: 8),
CGRect(x: 32, y: 96, width: 40, height: 8),
CGRect(x: 216, y: 24, width: 32, height: 8),
CGRect(x: 216, y: 80, width: 32, height: 8),
CGRect(x: 32, y: 144, width: 48, height: 8),
CGRect(x: 32, y: 168, width: 72, height: 8),
CGRect(x: 118, y: 22, width: 84, height: 2),
CGRect(x: 118, y: 184, width: 84, height: 2),
CGRect(x: 118, y: 24, width: 2, height: 160),
CGRect(x: 200, y: 24, width: 2, height: 160)
]
let gameplayReference: Raster?
if game.slug == "quadrapassel" {
let gameplayData = try Data(contentsOf: imported.projectDirectory.appendingPathComponent("docs/manual/images/gameplay.png"))
guard Self.sha(gameplayData) == gameplayReferenceSHA else {
throw ProfileFailure.message("The source-authored Quadrapassel PLAY reference changed; review it before accepting gameplay qualification")
}
let raster = try Raster(gameplayData)
guard raster.width == 320, raster.height == 192 else {
throw ProfileFailure.message("The reviewed Quadrapassel PLAY reference must use its authored 320x192 coordinates")
}
gameplayReference = raster
} else { gameplayReference = nil }
for use6309 in [false, true] {
let output = gameOutput.appendingPathComponent(use6309 ? "candidate-6309" : "candidate-6809")
try FileManager.default.createDirectory(at: output, withIntermediateDirectories: true)
let working = output.appendingPathComponent("CandidateWorking.DSK")
try disk.write(to: working, options: .withoutOverwriting)
var settings = MachineSettings()
settings.use6309 = use6309; settings.ram = game.fixture.ramKiB == 128 ? 0 : 1
try await withMachine(output: output, use6309: use6309, startingMachine: settings) { model, controller, _ in
try await model.insertDiskFromMedia(working, drive: 0, execution: .run, reset: .coldRestart)
try await startCandidateDOS(model, controller: controller)
let (first, titleSimilarity) = try await waitForTitle(reference: reference, controller: controller,
output: output.appendingPathComponent("candidate-first-title.png"))
XCTAssertEqual(first.use6309, use6309)
XCTAssertEqual(first.ramConfiguration, UInt(settings.ram))
XCTAssertEqual(first.videoOutput, 0); XCTAssertTrue(first.disks[0].mounted)
XCTAssertFalse(first.debuggerDevelopmentAttached)
XCTAssertNil(first.errorMessage)
XCTAssertEqual(first.cpuOverclock, 1); XCTAssertEqual(first.frameInterval, 1); XCTAssertFalse(first.fastForward)
// An idle title must remain recognizable before ordinary input.
// A cursor blink or an animated tile alone cannot qualify a start.
try await Task.sleep(nanoseconds: 500_000_000)
let idle = await step(controller.snapshot)
let titleArea = reference.width == 640 && reference.height == 480 ? VideoGeometry.fullFrame : idle.activeVideoRect
let idleRaster = try Raster(ScreenCapture(pixels: idle.pixels, area: titleArea).png())
let idleTitleSimilarity = idleRaster.similarity(to: reference)
guard idle.state == .running, idle.generation == first.generation, idle.errorMessage == nil,
idleTitleSimilarity >= 0.95 else {
throw ProfileFailure.message("Candidate title changed before start input; inspect the idle scene before accepting a transition")
}
let beforePixels = try ScreenCapture(pixels: first.pixels, area: VideoGeometry.fullFrame).png()
let before = try Raster(beforePixels)
let key = game.slug == "quadrapassel" ? " " : "1"
var keyboard = CocoKeyboard()
keyboard.press(code: game.slug == "quadrapassel" ? 49 : 18, characters: key)
let mask = keyboard.mask
XCTAssertNotEqual(mask, 0)
controller.setKeyboardMask(mask)
try await Task.sleep(nanoseconds: 200_000_000)
controller.setKeyboardMask(0)
var progress: (VCCMachineSnapshot, Data, Double, Double)?
var gameplayProof: (score: Double, pixels: Int, matched: Int)?
var changedFrames = 0
for _ in 0..<80 {
try await Task.sleep(nanoseconds: 100_000_000)
let snapshot = await step(controller.snapshot)
guard snapshot.state == .running, snapshot.generation == first.generation,
snapshot.frames > idle.frames + 4, snapshot.pasteRemaining == 0, snapshot.errorMessage == nil else { continue }
let png = try ScreenCapture(pixels: snapshot.pixels, area: VideoGeometry.fullFrame).png()
let difference = try Raster(png).changedPixelFraction(comparedTo: before)
let sceneArea = reference.width == 640 && reference.height == 480 ? VideoGeometry.fullFrame : snapshot.activeVideoRect
let scene = try Raster(ScreenCapture(pixels: snapshot.pixels, area: sceneArea).png())
let titleSimilarity = scene.similarity(to: reference)
let staticMatch: (score: Double, pixels: Int, matched: Int)?
if let gameplayReference {
let activeScene = try Raster(ScreenCapture(pixels: snapshot.pixels, area: snapshot.activeVideoRect).png())
staticMatch = activeScene.staticForegroundMatch(to: gameplayReference, regions: gameplayStaticRegions)
} else { staticMatch = nil }
let gameplayReady = staticMatch.map { $0.score >= 0.95 && $0.pixels > 100 } ?? true
changedFrames = difference >= 0.005 && titleSimilarity < 0.90 && gameplayReady ? changedFrames + 1 : 0
if changedFrames >= 2 {
progress = (snapshot, png, difference, titleSimilarity); gameplayProof = staticMatch; break
}
}
guard let progress else { throw ProfileFailure.message("Candidate-built game did not leave its stable title scene after normal start input") }
let (guestText, inspected): (String?, VCCMachineSnapshot) = await withCheckedContinuation { done in
controller.inspectScreenText { done.resume(returning: ($0, $1)) }
}
XCTAssertNil(inspected.errorMessage)
XCTAssertEqual(inspected.generation, first.generation)
if let guestText {
let lines = guestText.uppercased().split(whereSeparator: \.isNewline).map { $0.trimmingCharacters(in: .whitespaces) }
guard !lines.contains(where: { $0 == "OK" || $0.hasPrefix("?") }) else {
throw ProfileFailure.message("Candidate start input returned to BASIC or an error prompt instead of remaining in the game")
}
}
XCTAssertEqual(progress.0.cpuOverclock, 1); XCTAssertEqual(progress.0.frameInterval, 1); XCTAssertFalse(progress.0.fastForward)
try progress.1.write(to: output.appendingPathComponent("candidate-after-start-key.png"), options: .atomic)
_ = await step(controller.pause); try await settle(model)
let retainedBeforeRestart = try await model.snapshotDiskCopy(inDrive: 0)
model.reset(); try await settle(model); model.resume(); try await settle(model)
let retainedAfterRestart = try await model.snapshotDiskCopy(inDrive: 0)
XCTAssertEqual(retainedAfterRestart, retainedBeforeRestart, "Cold restart must keep the owned working disk rather than replace it from a published package")
try await startCandidateDOS(model, controller: controller)
let (second, restartSimilarity) = try await waitForTitle(reference: reference, controller: controller,
output: output.appendingPathComponent("candidate-restarted-title.png"))
XCTAssertNotEqual(second.generation, first.generation)
XCTAssertEqual(second.use6309, use6309); XCTAssertEqual(second.ramConfiguration, UInt(settings.ram))
XCTAssertNil(second.errorMessage)
XCTAssertEqual(second.cpuOverclock, 1); XCTAssertEqual(second.frameInterval, 1); XCTAssertFalse(second.fastForward)
XCTAssertEqual(Self.sha(try Data(contentsOf: XCTUnwrap(build.diskURL))), expected.disk, "The frozen candidate artifact must not be the guest's writable copy")
var gameplayReceipt: [String: Any] = [:]
if let gameplayProof {
gameplayReceipt = ["gameplay_reference_sha256": gameplayReferenceSHA,
"gameplay_reference_size": [320, 192],
"gameplay_static_regions": gameplayStaticRegions.map { [Int($0.minX), Int($0.minY), Int($0.width), Int($0.height)] },
"gameplay_static_foreground_pixels": gameplayProof.pixels,
"gameplay_static_matched_pixels": gameplayProof.matched,
"gameplay_static_foreground_similarity": gameplayProof.score,
"gameplay_static_matching_observations": changedFrames]
}
results.append(["game": game.slug, "cpu": use6309 ? "6309" : "6809", "host_architecture": Self.architecture,
"source_zip_sha256": expected.sourceZIP, "makefile_sha256": expected.makefile,
"compiler_sha256": CandidateSourceBaseline.compiler, "runtime_manifest_sha256": CandidateSourceBaseline.runtimeManifest,
"runtime_kind": "pinned_unsigned_development_runtime", "packaged_compiler_execution": false,
"configuration": "Release", "candidate_binary_sha256": expected.binary, "candidate_disk_sha256": expected.disk,
"published_disk_sha256": game.fixture.diskSHA256, "candidate_is_published": false,
"ram_kib": game.fixture.ramKiB, "first_title_foreground_similarity": titleSimilarity,
"restart_title_foreground_similarity": restartSimilarity, "normal_start_key": key == " " ? "space" : key,
"idle_title_foreground_similarity": idleTitleSimilarity, "post_start_title_foreground_similarity": progress.3,
"stock_speed": true, "basic_or_error_prompt_after_start": false,
"visible_changed_pixel_fraction": progress.2, "normal_input_fields_advanced": progress.0.frames - first.frames,
"working_disk_preserved_across_restart": true,
"coverage": "Exact unsigned-development-runtime rebuild, normal DOS startup, rendered title, ordinary start-key title-to-game transition and cold restart; not packaged compiler execution or a full game playthrough"].merging(gameplayReceipt) { _, proof in proof })
try JSONSerialization.data(withJSONObject: results, options: [.prettyPrinted, .sortedKeys])
.write(to: inputs.output.appendingPathComponent("CandidateSourceAcceptance.json"), options: .atomic)
}
}
}
XCTAssertEqual(results.count, Fixture.approved.count * 2)
}
@MainActor func testPublishedFirstAndCachedPlaySourceAndManualAcceptance() async throws {
let inputs = try await inputs()
var results: [[String: Any]] = []
for game in inputs.games {
let installRoot = inputs.output.appendingPathComponent(game.slug)
let installer = SoftwareLibraryInstaller(root: installRoot.appendingPathComponent("Library"))
let receipt = try await installer.install(game.release)
let original = receipt.workingDirectory.deletingLastPathComponent().appendingPathComponent("Original/Files/" + game.owned.diskPath)
XCTAssertEqual(Self.sha(try Data(contentsOf: original)), game.owned.diskSHA256)
let hero = try artwork(game.record["artwork"]["hero"], id: game.slug + "-title")
let referenceData = try await SoftwareLibraryArtworkCache().thumbnail(for: hero, directory: installRoot.appendingPathComponent("Artwork"))
let reference = try Raster(referenceData)
for use6309 in [false, true] {
let output = installRoot.appendingPathComponent(use6309 ? "6309" : "6809")
try FileManager.default.createDirectory(at: output, withIntermediateDirectories: true)
let release = try variant(game.release, use6309: use6309)
try await withMachine(output: output, use6309: use6309) { model, controller, defaults in
let plan = try SoftwareLibraryLaunchPlan.prepare(release: release, receipt: receipt)
XCTAssertTrue(plan.usesCuratedStartup); XCTAssertEqual(plan.commands, ["DOS"])
XCTAssertEqual(plan.ramKiB, game.fixture.ramKiB)
let before = await step(controller.snapshot)
let prepared = try await model.prepareLibraryLaunch(plan)
XCTAssertEqual(prepared.profile.input.right.source, game.fixture.keyboardOnly ? .none : .keyboard,
"Keyboard-only recipes suppress keyboard joystick interception; joystick games preserve the user's assignment")
let launched = try await model.launchLibrary(prepared); XCTAssertNil(launched.message)
let (first, firstScore) = try await waitForTitle(reference: reference, controller: controller,
output: output.appendingPathComponent("first-title.png"))
XCTAssertNotEqual(first.generation, before.generation)
XCTAssertEqual(first.use6309, use6309)
XCTAssertEqual(first.ramConfiguration, game.fixture.ramKiB == 128 ? 0 : 1)
XCTAssertEqual(first.videoOutput, 0); XCTAssertTrue(first.disks[0].mounted)
var result: [String: Any] = ["id": game.owned.gameID, "cpu": use6309 ? "6309" : "6809",
"release_id": game.owned.releaseID, "publication_id": game.publicationID,
"receipt": game.fixture.receiptFilename,
"ram_kib": plan.ramKiB, "first_foreground_similarity": firstScore,
"reference_width": reference.width, "reference_height": reference.height,
"first_generation": first.generation, "first_frame": first.frames,
"canonical_recipe": !use6309, "disk_sha256": game.owned.diskSHA256]
if !use6309 {
result["source_and_manual"] = try await qualifySourcesAndManual(game, model: model,
controller: controller, defaults: defaults, output: output, toolchain: inputs.toolchain)
} else { _ = await step(controller.pause); try await settle(model) }
let working = receipt.workingDirectory.appendingPathComponent(game.owned.diskPath)
let savedBytes = try Data(contentsOf: working)
let offline = URLSessionConfiguration.ephemeral; offline.protocolClasses = [PublishedGameOfflineTransport.self]
let cached = try await SoftwareLibraryInstaller(root: installRoot.appendingPathComponent("Library"), session: URLSession(configuration: offline))
.install(game.release)
XCTAssertEqual(cached.workingDirectory, receipt.workingDirectory)
XCTAssertEqual(try Data(contentsOf: working), savedBytes, "Cached installation must not replace current writable bytes")
let beforeCached = await step(controller.snapshot)
let cachedPlan = try SoftwareLibraryLaunchPlan.prepare(release: release, receipt: cached)
let cachedPrepared = try await model.prepareLibraryLaunch(cachedPlan)
let cachedLaunch = try await model.launchLibrary(cachedPrepared); XCTAssertNil(cachedLaunch.message)
let (second, cachedScore) = try await waitForTitle(reference: reference, controller: controller,
output: output.appendingPathComponent("cached-title.png"))
XCTAssertNotEqual(second.generation, beforeCached.generation)
XCTAssertEqual(second.ramConfiguration, first.ramConfiguration); XCTAssertEqual(second.use6309, use6309)
XCTAssertEqual(Self.sha(try Data(contentsOf: original)), game.owned.diskSHA256)
result["cached_foreground_similarity"] = cachedScore
result["cached_generation"] = second.generation
result["cached_install_without_network"] = true
result["working_sha_before_cached_play"] = Self.sha(savedBytes)
results.append(result)
try JSONSerialization.data(withJSONObject: results, options: [.prettyPrinted, .sortedKeys])
.write(to: inputs.output.appendingPathComponent("Acceptance.json"), options: .atomic)
}
}
}
XCTAssertEqual(results.count, Fixture.approved.count * 2)
}
}
private final class PublishedGameOfflineTransport: URLProtocol, @unchecked Sendable {
override class func canInit(with request: URLRequest) -> Bool { true }
override class func canonicalRequest(for request: URLRequest) -> URLRequest { request }
override func startLoading() { client?.urlProtocol(self, didFailWithError: URLError(.notConnectedToInternet)) }
override func stopLoading() { }
}