Skip to content

Run Windows games on Apple Silicon — free, open source, with an open compatibility database that tells you what actually works.

12.4 KB
Raw Blame
import XCTest
@testable import HighballKit

final class GamePageCopyTests: XCTestCase {
    private func entry(_ json: String) throws -> GameDBEntry {
        try JSONDecoder().decode(GameDBEntry.self, from: Data(json.utf8))
    }
    private let today = Date(timeIntervalSince1970: 1_788_480_000)   // 2026-09-04 UTC-ish

    func testVerifiedOnAnotherChipNamesTheGap() throws {
        let e = try entry(#"{"id":"x","title":"X","steam_appid":1,"status":"verified-local","lastVerified":"2026-08-23","verified":{"chip":"Apple M4 Pro","macos":"26","fps":"60 to 82"}}"#)
        let v = GamePageCopy.verdict(e, myChip: "Apple M1 Pro", today: today)
        XCTAssertEqual(v.headline, "Verified on an M4 Pro.")
        XCTAssertEqual(v.detail, "60 to 82 frames per second on macOS 26, last confirmed 12 days ago. Your Mac is an M1 Pro.")
    }

    func testVerifiedOnTheSameChipSaysSo() throws {
        let e = try entry(#"{"id":"x","title":"X","steam_appid":1,"status":"verified-local","lastVerified":"2026-09-04","verified":{"chip":"Apple M1 Pro","macos":"26.6.2","fps":"about 70"}}"#)
        let v = GamePageCopy.verdict(e, myChip: "Apple M1 Pro", today: today)
        XCTAssertEqual(v.headline, "Verified on an M1 Pro, the same chip as yours.")
        XCTAssertEqual(v.detail, "About 70 frames per second on macOS 26.6.2, last confirmed today.")
    }

    func testVerifiedWithoutStructuredFactsStaysHonest() throws {
        let e = try entry(#"{"id":"x","title":"X","steam_appid":1,"status":"verified-local","lastVerified":"2026-05-01"}"#)
        let v = GamePageCopy.verdict(e, myChip: "Apple M1 Pro", today: today)
        XCTAssertEqual(v.headline, "Verified on this project's own Mac.")
        XCTAssertEqual(v.detail, "Last confirmed on 2026-05-01.")
    }

    func testNoRowIsAnInvitation() {
        let v = GamePageCopy.verdict(nil, myChip: "Apple M2", today: today)
        XCTAssertEqual(v.headline, "Nobody has tested this on an M2 yet.")
    }

    func testBlockedNamesTheAntiCheat() throws {
        let e = try entry(#"{"id":"x","title":"X","steam_appid":1,"status":"blocked-anticheat","anticheat":{"names":["Vanguard"],"macVerdict":"blocked","note":"kernel driver"}}"#)
        XCTAssertEqual(GamePageCopy.verdict(e, myChip: "Apple M1", today: today).headline, "Can't run: Vanguard.")
    }

    /// World of Warships stops itself on macOS on purpose: blocked like an anti-cheat game (no
    /// Play, no renderer), but the page must not blame an anti-cheat it does not have.
    func testAPublisherBlockIsBlockedAndSaysWhose() throws {
        let e = try entry(#"{"id":"x","title":"X","steam_appid":1,"status":"blocked-publisher","renderer":null}"#)
        XCTAssertTrue(e.isBlocked)
        XCTAssertEqual(GamePageCopy.verdict(e, myChip: "Apple M1", today: today).headline, "Can't run: its publisher blocks macOS.")
        let anticheat = try entry(#"{"id":"y","title":"Y","steam_appid":2,"status":"blocked-anticheat"}"#)
        XCTAssertTrue(anticheat.isBlocked, "the anti-cheat block keeps its behaviour")
        let community = try entry(#"{"id":"z","title":"Z","steam_appid":3,"status":"community"}"#)
        XCTAssertFalse(community.isBlocked)
    }

    /// An opt-in fix is never Play's to apply (highball-db#60): the page says so instead of
    /// listing steps Play will not take, and decoding keeps the flag.
    func testAnOptInFixIsLeftToTheOwner() throws {
        let e = try entry(#"{"id":"x","title":"X","steam_appid":1,"status":"community","renderer":"dxvk"}"#)
        var recipe = Recipe(id: "x", kind: .game, title: "Modern Direct3D 9", steps: [
            .copy(from: "renderers/d9vk-modern/wine/x86_64-windows/d3d9.dll", to: "game/d3d9.dll", asNative: true),
        ])
        recipe.optIn = true
        XCTAssertTrue(recipe.isOptIn)
        let items = GamePageCopy.willDo(e, recipe: recipe, applied: false, bottleRenderer: .dxvk, osMajor: 26)
        XCTAssertEqual(items.map(\.text), [
            "Use DXVK (Vulkan on Metal), the way it was verified",
            "Leave the optional Modern Direct3D 9 fix alone; it is under Game settings for when the notes say your Mac needs it",
        ])
        let done = GamePageCopy.willDo(e, recipe: recipe, applied: true, bottleRenderer: .dxvk, osMajor: 26)
        XCTAssertEqual(done[1].text, "Keep the Modern Direct3D 9 fix you applied under Game settings")
        XCTAssertTrue(done[1].done)
        let json = #"{"id":"x","kind":"game","title":"t","optIn":true,"steps":[{"type":"note","text":"n"}]}"#
        let decoded = try JSONDecoder.highball.decode(Recipe.self, from: Data(json.utf8))
        XCTAssertTrue(decoded.isOptIn)
        let plain = try JSONDecoder.highball.decode(Recipe.self, from: Data(#"{"id":"y","kind":"game","title":"t","steps":[{"type":"note","text":"n"}]}"#.utf8))
        XCTAssertFalse(plain.isOptIn, "absent means Play applies it, as every recipe before")
    }

    func testWillDoListsRendererArgsAndRecipeSteps() throws {
        let e = try entry(#"{"id":"x","title":"X","steam_appid":1,"status":"verified-local","renderer":"dxmt","launchArgs":["-windowed"]}"#)
        let recipe = Recipe(id: "x", kind: .game, title: "X fix", steps: [
            .winetricks(verbs: ["vcrun2022"], slow: "about a minute"),
            .environment(name: "MVK_SHADOW_IMPORT", value: "1"),
            .note("Alt-tab twice if the window stays black"),
        ])
        let items = GamePageCopy.willDo(e, recipe: recipe, applied: false, bottleRenderer: .dxvk, osMajor: 26)
        XCTAssertEqual(items.map(\.text), [
            "Use DXMT (DirectX 11 on Metal) for this game, the way it was verified, instead of the environment's DXVK (Vulkan on Metal)",
            "Start it with -windowed",
            "Install vcrun2022",
            "Set MVK_SHADOW_IMPORT for this game",
            "Alt-tab twice if the window stays black",
        ])
        XCTAssertEqual(items[2].cost, "about a minute")
        let done = GamePageCopy.willDo(e, recipe: recipe, applied: true, bottleRenderer: .dxmt, osMajor: 26)
        XCTAssertEqual(done[0].text, "Use DXMT (DirectX 11 on Metal), the way it was verified")
        XCTAssertTrue(done[2].done); XCTAssertNil(done[2].cost)
    }
}

extension GamePageCopyTests {
    func testD3DMetalAskConsequenceComesFromTheRow() throws {
        let only = try entry(#"{"id":"x","title":"X","steam_appid":1,"status":"verified-local","renderer":"d3dmetal"}"#)
        XCTAssertTrue(GamePageCopy.d3dMetalAsk(title: "X", entry: only).contains("no other graphics mode"))
        XCTAssertNil(GamePageCopy.otherWorkingRenderer(only))
        let alt = try entry(#"{"id":"x","title":"X","steam_appid":1,"status":"verified-local","renderer":"d3dmetal","rendererResults":{"dxvk":{"verdict":"works","detail":"slower"}}}"#)
        XCTAssertTrue(GamePageCopy.d3dMetalAsk(title: "X", entry: alt).contains("but slower"))
        XCTAssertEqual(GamePageCopy.otherWorkingRenderer(alt), .dxvk)
        let e = try entry(#"{"id":"x","title":"X","steam_appid":1,"status":"verified-local","renderer":"dxmt"}"#)
        // The row asks for one mode and the environment's explicit setting wins: the plan says so
        // in one line, and names the mode held back so the page can offer it for this game.
        XCTAssertEqual(GamePageCopy.willDo(e, recipe: nil, applied: false, bottleRenderer: .dxvk, explicit: true, osMajor: 26).first?.text,
                       "Use DXVK (Vulkan on Metal), your environment's setting. The database asks for DXMT (DirectX 11 on Metal), and an environment's own setting wins")
        XCTAssertEqual(GamePageCopy.rowRendererHeldBack(e, bottleRenderer: .dxvk, explicit: true, gameOverride: nil, osMajor: 26), .dxmt)
        XCTAssertNil(GamePageCopy.rowRendererHeldBack(e, bottleRenderer: .dxvk, explicit: false, gameOverride: nil, osMajor: 26), "not explicit: the row applies on its own")
        XCTAssertNil(GamePageCopy.rowRendererHeldBack(e, bottleRenderer: .dxvk, explicit: true, gameOverride: .dxmt, osMajor: 26), "a per-game choice already exists")
        XCTAssertEqual(GamePageCopy.willDo(e, recipe: nil, applied: false, bottleRenderer: .dxmt, explicit: true, osMajor: 26).first?.text,
                       "Use DXMT (DirectX 11 on Metal), the environment's setting (set by you)", "same mode: nothing is held back")
        XCTAssertNil(GamePageCopy.rowRendererHeldBack(e, bottleRenderer: .dxmt, explicit: true, gameOverride: nil, osMajor: 26))
    }

    /// The page and the launch agree on a program that only has Direct3D 12: the plan names the mode
    /// Play will really use and offers nothing for this game alone (0.10.9 release pass, 2026-10-06).
    func testADirect3D12OnlyGameIsNeverPromisedAModeWithoutIt() throws {
        let forza = try entry(#"{"id":"forza-horizon-6","title":"Forza Horizon 6","steam_appid":2483190,"status":"verified-local","renderer":"d3dmetal"}"#)
        XCTAssertEqual(GamePageCopy.willDo(forza, recipe: nil, applied: false, bottleRenderer: .dxmt, explicit: true, needsDirect3D12: true, osMajor: 27).first?.text,
                       "Use Apple's DirectX 12 support for this game: it only has DirectX 12, which DXMT (DirectX 11 on Metal), your environment's setting, does not have. The environment keeps DXMT (DirectX 11 on Metal) for everything else")
        XCTAssertNil(GamePageCopy.rowRendererHeldBack(forza, bottleRenderer: .dxmt, explicit: true, gameOverride: nil, needsDirect3D12: true, osMajor: 27),
                     "Play already uses the row's mode, so there is nothing to offer")
        // A game with another graphics path: the environment's explicit mode wins as before, and the
        // page still offers the row's mode for this game.
        XCTAssertEqual(GamePageCopy.willDo(forza, recipe: nil, applied: false, bottleRenderer: .dxmt, explicit: true, needsDirect3D12: false, osMajor: 27).first?.text,
                       "Use DXMT (DirectX 11 on Metal), your environment's setting. The database asks for Apple's DirectX 12 support, and an environment's own setting wins")
        XCTAssertEqual(GamePageCopy.rowRendererHeldBack(forza, bottleRenderer: .dxmt, explicit: true, gameOverride: nil, needsDirect3D12: false, osMajor: 27), .d3dmetal)
        // No row, environment on Automatic: the plan now says what Play has done since highball#139.
        XCTAssertEqual(GamePageCopy.willDo(nil, recipe: nil, applied: false, bottleRenderer: .dxmt, explicit: false, needsDirect3D12: true, osMajor: 27).first?.text,
                       "Use Apple's DirectX 12 support for this game: it only has DirectX 12, which the environment's DXMT (DirectX 11 on Metal) does not have")
        // A row that chose, or a per-game choice, is told as before.
        XCTAssertEqual(GamePageCopy.willDo(forza, recipe: nil, applied: false, bottleRenderer: .dxmt, explicit: false, needsDirect3D12: true, osMajor: 27).first?.text,
                       "Use Apple's DirectX 12 support for this game, the way it was verified, instead of the environment's DXMT (DirectX 11 on Metal)")
        XCTAssertEqual(GamePageCopy.willDo(forza, recipe: nil, applied: false, bottleRenderer: .dxmt, explicit: true, gameOverride: .d3dmetal, needsDirect3D12: true, osMajor: 27).first?.text,
                       "Use Apple's DirectX 12 support for this game (set by you); the environment stays on DXMT (DirectX 11 on Metal)")
    }

    func testFpsPhraseKeepsTheFigureAndWhereItWasRead() {
        XCTAssertEqual(GamePageCopy.fpsPhrase("60 to 82"), "60 to 82 frames per second")
        XCTAssertEqual(GamePageCopy.fpsPhrase("111.8 fps"), "111.8 fps")
        XCTAssertEqual(GamePageCopy.fpsPhrase("About 70"), "About 70 frames per second")
        XCTAssertEqual(GamePageCopy.fpsPhrase("about 34 in the prologue blizzard ride at 1280x720 windowed (GPU 18-21 ms), 55-60 in the menus"),
                       "about 34 frames per second in the prologue blizzard ride at 1280x720 windowed (GPU 18-21 ms), 55-60 in the menus")
        XCTAssertEqual(GamePageCopy.fpsPhrase("60-120 in the prologue mission at 1280x800. An earlier reading of 48 was at 800x600."),
                       "60-120 frames per second in the prologue mission at 1280x800", "one sentence: the verdict stops at the first full stop")
        XCTAssertEqual(GamePageCopy.fpsPhrase("menu renders, DXVK, HDR-off recipe"), "menu renders, DXVK, HDR-off recipe", "no figure: used as it is")
        XCTAssertEqual(GamePageCopy.fpsPhrase("111.8 driving at Laguna Seca, GPU-bound. Measured 2026-09-10 on a fresh install."),
                       "111.8 frames per second driving at Laguna Seca, GPU-bound")
        XCTAssertNil(GamePageCopy.fpsPhrase("  "))
    }
}