From 76619dc50d2d2423077477efae8f26ad094c30ee Mon Sep 17 00:00:00 2001 From: Szymon Chmal Date: Wed, 18 Nov 2026 16:25:40 +0100 Subject: [PATCH 1/2] fix(android): the driver's Windows SDK fixtures and device paths follow the host, and its tests leave the Windows list (#1707) --- src/drivers/android/adb-tools.ts | 4 +- src/drivers/android/avd-config.ts | 10 ++-- src/drivers/android/device-table.test.ts | 3 +- src/drivers/android/device-table.ts | 6 +-- src/drivers/android/emulator.ts | 2 +- src/drivers/android/index-boot.test.ts | 34 +++++++++---- .../android/index-copies-recovery.test.ts | 21 ++++---- src/drivers/android/index-image-fit.test.ts | 49 +++++++++++-------- src/drivers/android/index-launch.test.ts | 3 +- src/drivers/android/index-lifecycle.test.ts | 38 ++++++++------ src/drivers/android/index.test.ts | 23 ++++----- .../physical-handler-inspect-list.test.ts | 12 ++++- src/drivers/android/physical-handler.test.ts | 11 ++--- src/drivers/android/sdk-paths.ts | 2 +- src/drivers/android/seeds-copies.test.ts | 17 ++++--- .../android/seeds-library-and-fit.test.ts | 3 +- src/drivers/android/seeds.ts | 4 +- src/drivers/android/test-index-lifecycle.ts | 3 +- src/drivers/android/test-physical-handler.ts | 10 ++-- src/drivers/android/test-sdk-fixtures.ts | 26 +++++++--- src/drivers/android/testing.ts | 2 +- src/drivers/android/two-instances.test.ts | 8 +-- src/test-support/windows-skipped.ts | 17 ------- 23 files changed, 171 insertions(+), 137 deletions(-) diff --git a/src/drivers/android/adb-tools.ts b/src/drivers/android/adb-tools.ts index 6820063dd..0d51e728a 100644 --- a/src/drivers/android/adb-tools.ts +++ b/src/drivers/android/adb-tools.ts @@ -111,8 +111,8 @@ export class AdbTools { /** why: a copy's AVD sits in its own folder under the root; a device made before copies sat at `/.avd`. */ avdFolder(data: AndroidDriverData): string { return data.avdHome === undefined - ? `${this.#options.deviceRoot}/${data.avdName}.avd` - : `${data.avdHome}/${SEED_AVD_NAME}.avd`; + ? join(this.#options.deviceRoot, `${data.avdName}.avd`) + : join(data.avdHome, `${SEED_AVD_NAME}.avd`); } dataFor(device: DriverDevice): AndroidDriverData { diff --git a/src/drivers/android/avd-config.ts b/src/drivers/android/avd-config.ts index 7ae8f1199..e7c390aa4 100644 --- a/src/drivers/android/avd-config.ts +++ b/src/drivers/android/avd-config.ts @@ -1,3 +1,5 @@ +import { join } from "node:path"; + import { DriverCrashError } from "../../core/index.js"; import { isMissingPathError, type Filesystem, type IdGenerator } from "../../ports/index.js"; import type { AdbTools } from "./adb-tools.js"; @@ -38,7 +40,7 @@ export class AvdConfig { }, (line) => !isSeedHardwareLine(line), ); - const bootPropPath = `${folder}/boot.prop`; + const bootPropPath = join(folder, "boot.prop"); const properties = Object.entries(profile.bootProperties); if (properties.length > 0) { await this.#options.filesystem.writeFileAtomic( @@ -76,7 +78,7 @@ export class AvdConfig { async #avdConfig(folder: string): Promise { try { - const contents = await this.#options.filesystem.readFile(`${folder}/config.ini`); + const contents = await this.#options.filesystem.readFile(join(folder, "config.ini")); return ( contents .split(/\r?\n/) @@ -122,7 +124,7 @@ export class AvdConfig { ); } } - const path = `${folder}/config.ini`; + const path = join(folder, "config.ini"); let contents: string; try { contents = await this.#options.filesystem.readFile(path); @@ -159,7 +161,7 @@ export class AvdConfig { async readDurableMark(folder: string): Promise { try { - const contents = await this.#options.filesystem.readFile(`${folder}/config.ini`); + const contents = await this.#options.filesystem.readFile(join(folder, "config.ini")); const line = contents .split(/\r?\n/) .find((entry) => entry.startsWith(`${DURABLE_MARK_KEY}=`)); diff --git a/src/drivers/android/device-table.test.ts b/src/drivers/android/device-table.test.ts index 515e45413..f68b1dccc 100644 --- a/src/drivers/android/device-table.test.ts +++ b/src/drivers/android/device-table.test.ts @@ -1,3 +1,4 @@ +import { join } from "node:path"; import { describe, expect, it } from "vitest"; import { @@ -545,7 +546,7 @@ describe("DeviceTable", () => { await expect(table.findLegacy("simlock_old")).resolves.toMatchObject({ device: { deviceId: "simlock_old" }, - path: `${home}/.android/avd/simlock_old.avd`, + path: join(home, ".android", "avd", "simlock_old.avd"), }); await expect(table.findLegacy("simlock_never_existed")).resolves.toBeUndefined(); }); diff --git a/src/drivers/android/device-table.ts b/src/drivers/android/device-table.ts index 62f5ba985..b3b264a84 100644 --- a/src/drivers/android/device-table.ts +++ b/src/drivers/android/device-table.ts @@ -223,10 +223,10 @@ export class DeviceTable { for (const entry of await filesystem.readdir(deviceRoot)) { const old = /^(.+)\.avd$/.exec(entry); if (old?.[1] !== undefined) { - entries.push({ avdName: old[1], deviceId: old[1], folder: `${deviceRoot}/${entry}` }); + entries.push({ avdName: old[1], deviceId: old[1], folder: join(deviceRoot, entry) }); continue; } - const folder = `${deviceRoot}/${entry}/${SEED_AVD_NAME}.avd`; + const folder = join(deviceRoot, entry, `${SEED_AVD_NAME}.avd`); if (await this.#holdsAvd(folder)) { entries.push({ avdName: SEED_AVD_NAME, deviceId: entry, folder }); } @@ -319,7 +319,7 @@ export class DeviceTable { deviceId: owner.deviceId, driverData: { ...(owner.avdName === SEED_AVD_NAME - ? { avdHome: `${this.#options.deviceRoot}/${owner.deviceId}` } + ? { avdHome: join(this.#options.deviceRoot, owner.deviceId) } : {}), avdName: owner.avdName, configHash: "recovered", diff --git a/src/drivers/android/emulator.ts b/src/drivers/android/emulator.ts index 6b8925029..a1b9d0750 100644 --- a/src/drivers/android/emulator.ts +++ b/src/drivers/android/emulator.ts @@ -158,7 +158,7 @@ export class Emulator { } #logPath(data: AndroidDriverData): string { - return `${this.#options.adbTools.avdFolder(data)}/emulator.log`; + return join(this.#options.adbTools.avdFolder(data), "emulator.log"); } /** why: bounded, since an emulator that ran a while may have written a lot before it exited. */ diff --git a/src/drivers/android/index-boot.test.ts b/src/drivers/android/index-boot.test.ts index 9473e6673..99b5b207b 100644 --- a/src/drivers/android/index-boot.test.ts +++ b/src/drivers/android/index-boot.test.ts @@ -1,4 +1,5 @@ import { describe, expect, it, vi } from "vitest"; +import { join } from "node:path"; import { promiseState } from "../../test-support/promise-state.js"; import { FakeClock, @@ -32,6 +33,7 @@ import { RecordingRunner, consolePortOf, copyPathExpectation, + withWindowsExtension, } from "./testing.js"; import { sdk, home, buildDriver } from "./test-index.js"; @@ -95,16 +97,30 @@ describe("AndroidDriver", () => { const versionedTools = `${sdk}/cmdline-tools/19.0/bin`; await filesystem.rm(`${sdk}/cmdline-tools/latest`); await filesystem.mkdirp(versionedTools); - await filesystem.writeFileAtomic(`${versionedTools}/avdmanager`, "binary"); - await filesystem.writeFileAtomic(`${versionedTools}/sdkmanager`, "binary"); + const versionedAvdmanager = withWindowsExtension( + `${versionedTools}/avdmanager`, + process.platform, + ".bat", + ); + await filesystem.writeFileAtomic(versionedAvdmanager, "binary"); + await filesystem.writeFileAtomic( + withWindowsExtension(`${versionedTools}/sdkmanager`, process.platform, ".bat"), + "binary", + ); const legacyTools = `${sdk}/tools/bin`; await filesystem.mkdirp(legacyTools); - await filesystem.writeFileAtomic(`${legacyTools}/avdmanager`, "binary"); - await filesystem.writeFileAtomic(`${legacyTools}/sdkmanager`, "binary"); + await filesystem.writeFileAtomic( + withWindowsExtension(`${legacyTools}/avdmanager`, process.platform, ".bat"), + "binary", + ); + await filesystem.writeFileAtomic( + withWindowsExtension(`${legacyTools}/sdkmanager`, process.platform, ".bat"), + "binary", + ); const runner = new EmulatorExitingRunner([ - processResult(`${versionedTools}/avdmanager`, ["list", "device"], pixelDevices), + processResult(versionedAvdmanager, ["list", "device"], pixelDevices), ]); const driver = await createDriver(filesystem, runner); @@ -317,9 +333,9 @@ describe("AndroidDriver", () => { await driver.makeReady(await driver.provision(spec)); expect(crashDatabases).toEqual([ - `${avdDirectory}/emu-crash.db`, - `${avdDirectory}/emu-crash.db`, - `${avdDirectory}/emu-crash.db`, + join(avdDirectory, "emu-crash.db"), + join(avdDirectory, "emu-crash.db"), + join(avdDirectory, "emu-crash.db"), ]); const crashReportMode = (args: readonly string[]) => { const flag = args.indexOf("-crash-report-mode"); @@ -562,7 +578,7 @@ describe("AndroidDriver", () => { it("sends the emulator's output to /emulator.log, mode 0600, emptied in place at each start", async () => { const harness = await provisionedHarness(); - const logPath = `${avdDirectory}/simlock_one/simlock.avd/emulator.log`; + const logPath = join(avdDirectory, "simlock_one", "simlock.avd", "emulator.log"); await harness.filesystem.writeFileAtomic(logPath, "left by an earlier start\n", { mode: 0o644, }); diff --git a/src/drivers/android/index-copies-recovery.test.ts b/src/drivers/android/index-copies-recovery.test.ts index 5c9b81dac..d649cb8f4 100644 --- a/src/drivers/android/index-copies-recovery.test.ts +++ b/src/drivers/android/index-copies-recovery.test.ts @@ -1,4 +1,5 @@ import { describe, expect, it, vi } from "vitest"; +import { join } from "node:path"; import { FakeClock, MemoryFilesystem, type ScriptedProcessExpectation } from "../../ports/index.js"; import { type AndroidDriverDiagnostic, type AndroidEmulatorLaunchOptions } from "./index.js"; import { @@ -24,9 +25,9 @@ import { sdk } from "./test-index.js"; describe("AndroidDriver image fit", () => { describe("seeds and copies", () => { - const sources = `${avdDirectory}/sources`; - const copyHome = `${avdDirectory}/simlock_one`; - const seedHome = `${sources}/seed_two`; + const sources = join(avdDirectory, "sources"); + const copyHome = join(avdDirectory, "simlock_one"); + const seedHome = join(sources, "seed_two"); async function seedHarness( expectations: readonly ScriptedProcessExpectation[], options: { @@ -160,7 +161,7 @@ describe("AndroidDriver image fit", () => { expect(await destroyed.filesystem.exists(seedHome)).toBe(false); await expect(destroyed.driver.listSources()).resolves.toEqual([]); - const otherHome = `${sources}/seed_device-4`; + const otherHome = join(sources, "seed_device-4"); const other = await seedHarness([ ...makingTheSeed(), processResult(binaries.avdmanager, ["list", "device"], pixelDevices), @@ -256,9 +257,9 @@ describe("AndroidDriver image fit", () => { processResult(binaries.adb, ["-s", serial, "emu", "kill"]), processResult(binaries.avdmanager, ["delete", "avd", "-n", "simlock_old"]), ]); - await harness.filesystem.mkdirp(`${avdDirectory}/simlock_old.avd`); + await harness.filesystem.mkdirp(join(avdDirectory, "simlock_old.avd")); await harness.filesystem.writeFileAtomic( - `${avdDirectory}/simlock_old.avd/config.ini`, + join(avdDirectory, "simlock_old.avd", "config.ini"), "hw.ramSize=2048\n", ); const legacy = { @@ -305,7 +306,7 @@ describe("AndroidDriver image fit", () => { }; const harness = async (expectations: readonly ScriptedProcessExpectation[]) => { const filesystem = await androidFilesystem(); - for (const home of [copyHome, `${avdDirectory}/simlock_two`]) { + for (const home of [copyHome, join(avdDirectory, "simlock_two")]) { await filesystem.mkdirp(`${home}/simlock.avd`); await filesystem.writeFileAtomic(`${home}/simlock.avd/config.ini`, "hw.ramSize=2048\n"); } @@ -327,7 +328,7 @@ describe("AndroidDriver image fit", () => { ]); await passes.driver.destroy(own); expect(await passes.filesystem.exists(copyHome)).toBe(false); - expect(await passes.filesystem.exists(`${avdDirectory}/simlock_two`)).toBe(true); + expect(await passes.filesystem.exists(join(avdDirectory, "simlock_two"))).toBe(true); const neighbour = await harness([ processResult( @@ -363,7 +364,7 @@ describe("AndroidDriver image fit", () => { ]); failingDelete.filesystem.defineFailure(copyHome, "EACCES"); await expect(failingDelete.driver.destroy(own)).rejects.toMatchObject({ code: "EACCES" }); - expect(await failingDelete.filesystem.exists(`${avdDirectory}/simlock_two`)).toBe(true); + expect(await failingDelete.filesystem.exists(join(avdDirectory, "simlock_two"))).toBe(true); const outside = await harness([]); await outside.filesystem.mkdirp("/elsewhere/simlock_two"); @@ -375,7 +376,7 @@ describe("AndroidDriver image fit", () => { }), ).rejects.toThrow("Android device simlock_two names a folder outside the root"); expect(await outside.filesystem.exists("/elsewhere/simlock_two")).toBe(true); - expect(await outside.filesystem.exists(`${avdDirectory}/simlock_two`)).toBe(true); + expect(await outside.filesystem.exists(join(avdDirectory, "simlock_two"))).toBe(true); const malformed = await harness([]); await expect( diff --git a/src/drivers/android/index-image-fit.test.ts b/src/drivers/android/index-image-fit.test.ts index 4ee535dce..465b4f583 100644 --- a/src/drivers/android/index-image-fit.test.ts +++ b/src/drivers/android/index-image-fit.test.ts @@ -96,9 +96,9 @@ live( describe("AndroidDriver image fit", () => { describe("seeds and copies", () => { - const sources = `${avdDirectory}/sources`; - const copyHome = `${avdDirectory}/simlock_one`; - const seedHome = `${sources}/seed_two`; + const sources = join(avdDirectory, "sources"); + const copyHome = join(avdDirectory, "simlock_one"); + const seedHome = join(sources, "seed_two"); async function seedHarness( expectations: readonly ScriptedProcessExpectation[], options: { @@ -194,11 +194,11 @@ describe("AndroidDriver image fit", () => { deviceId: "simlock_one", driverData: { avdHome: copyHome, avdName: "simlock" }, }); - await expect(harness.filesystem.readFile(`${copyHome}/simlock.avd/config.ini`)).resolves.toBe( - "hw.ramSize=2048\nsimlock.mark=three\n", - ); - await expect(harness.filesystem.readFile(`${copyHome}/simlock.ini`)).resolves.toBe( - `avd.ini.encoding=UTF-8\npath=${copyHome}/simlock.avd\ntarget=android-34\n`, + await expect( + harness.filesystem.readFile(join(copyHome, "simlock.avd", "config.ini")), + ).resolves.toBe("hw.ramSize=2048\nsimlock.mark=three\n"); + await expect(harness.filesystem.readFile(join(copyHome, "simlock.ini"))).resolves.toBe( + `avd.ini.encoding=UTF-8\npath=${join(copyHome, "simlock.avd")}\ntarget=android-34\n`, ); await expect(harness.driver.listSources()).resolves.toMatchObject([ { @@ -264,7 +264,7 @@ describe("AndroidDriver image fit", () => { }); describe("saveSource", () => { - const savedHome = `${sources}/baseline_four`; + const savedHome = join(sources, "baseline_four"); const serial = "emulator-5586"; const config = "hw.device.name=pixel_5\nimage.sysdir.1=system-images/android-34/google_apis/arm64-v8a/\nhw.ramSize=2048\n"; @@ -292,7 +292,7 @@ describe("AndroidDriver image fit", () => { const probe = processResult( binaries.adb, ["-s", serial, "emu", "avd", "path"], - `${copyHome}/simlock.avd\r\nOK\r\n`, + `${join(copyHome, "simlock.avd")}\r\nOK\r\n`, ); const savingSteps = [ processResult(binaries.emulator, ["-version"], "Android emulator version 36.1.9"), @@ -313,14 +313,19 @@ describe("AndroidDriver image fit", () => { ); const ready = await harness.driver.makeReady(await harness.driver.provision(harness.spec)); await harness.driver.saveSource({ ...ready, physical: false as const }); - await harness.filesystem.writeFileAtomic(`${savedHome}/simlock.avd/marker.txt`, "saved"); + await harness.filesystem.writeFileAtomic( + join(savedHome, "simlock.avd", "marker.txt"), + "saved", + ); const callsBefore = harness.runner.calls.length; const copy = await harness.driver.provision(harness.spec, { source: "baseline_four" }); expect(copy.deviceId).toBe("simlock_five"); await expect( - harness.filesystem.readFile(`${avdDirectory}/simlock_five/simlock.avd/marker.txt`), + harness.filesystem.readFile( + join(avdDirectory, "simlock_five", "simlock.avd", "marker.txt"), + ), ).resolves.toBe("saved"); expect(harness.runner.calls).toHaveLength(callsBefore + 1); @@ -330,15 +335,17 @@ describe("AndroidDriver image fit", () => { ).rejects.toThrow( "source baseline_four is stale: system image system-images;android-34;google_apis;arm64-v8a is not installed", ); - expect(await harness.filesystem.exists(`${avdDirectory}/simlock_six`)).toBe(false); + expect(await harness.filesystem.exists(join(avdDirectory, "simlock_six"))).toBe(false); }); it("keeps a powered-off copy of the device as a ready baseline source with one boot snapshot, powering the emulator off first, or killing it when it will not leave in 60 s, or polling adb with no process handle", async () => { const kept = async (harness: Awaited>) => { - expect(await harness.filesystem.exists(`${savedHome}/simlock.avd/config.ini`)).toBe(true); - await expect(harness.filesystem.readFile(`${savedHome}/simlock.ini`)).resolves.toContain( - `path=${savedHome}/simlock.avd`, - ); + expect( + await harness.filesystem.exists(join(savedHome, "simlock.avd", "config.ini")), + ).toBe(true); + await expect( + harness.filesystem.readFile(join(savedHome, "simlock.ini")), + ).resolves.toContain(`path=${join(savedHome, "simlock.avd")}`); expect(await harness.filesystem.exists(copyHome)).toBe(true); const listed = await harness.driver.listSources(); expect(listed.find((source) => source.id === "baseline_four")).toMatchObject({ @@ -399,7 +406,7 @@ describe("AndroidDriver image fit", () => { processResult( binaries.adb, ["-s", serial, "emu", "avd", "path"], - `${copyHome}/simlock.avd\r\nOK\r\n`, + `${join(copyHome, "simlock.avd")}\r\nOK\r\n`, ), processResult(binaries.adb, ["-s", serial, "emu", "kill"]), ...sourceBoot(), @@ -489,7 +496,7 @@ describe("AndroidDriver image fit", () => { }); describe("saveSource failures", () => { - const savedHome = `${sources}/baseline_four`; + const savedHome = join(sources, "baseline_four"); const serial = "emulator-5586"; const config = "hw.device.name=pixel_5\nimage.sysdir.1=system-images/android-34/google_apis/arm64-v8a/\nhw.ramSize=2048\n"; @@ -498,7 +505,7 @@ describe("AndroidDriver image fit", () => { ["-version"], "Android emulator version 36.1.9", ); - const probe = (path = `${copyHome}/simlock.avd`) => + const probe = (path = join(copyHome, "simlock.avd")) => processResult(binaries.adb, ["-s", serial, "emu", "avd", "path"], `${path}\r\nOK\r\n`); const poweredOff = [ version, @@ -511,7 +518,7 @@ describe("AndroidDriver image fit", () => { it("deletes the source's folder and row and throws when the ownership check fails, the copy fails or the boot snapshot is not saved, leaving the device as it was", async () => { const cases = [ { - expectations: [version, probe(`${avdDirectory}/other.avd`)], + expectations: [version, probe(join(avdDirectory, "other.avd"))], message: "emulator-5586 is not its emulator", sent: false, }, diff --git a/src/drivers/android/index-launch.test.ts b/src/drivers/android/index-launch.test.ts index f0caa5caa..04b0e3cf3 100644 --- a/src/drivers/android/index-launch.test.ts +++ b/src/drivers/android/index-launch.test.ts @@ -1,4 +1,5 @@ import { describe, expect, it } from "vitest"; +import { join } from "node:path"; import { type Driver } from "../../core/index.js"; import { MemoryFilesystem } from "../../ports/index.js"; import { type AndroidDriverDiagnostic, type AndroidEmulatorLaunchOptions } from "./index.js"; @@ -271,7 +272,7 @@ describe("AndroidDriver", () => { }); it("rethrows a non-missing-file config.ini read error from the mark write instead of clobbering it as empty", async () => { - const configPath = `${avdDirectory}/simlock_one/simlock.avd/config.ini`; + const configPath = join(avdDirectory, "simlock_one", "simlock.avd", "config.ini"); const permissionError = Object.assign(new Error("EACCES: permission denied"), { code: "EACCES", }); diff --git a/src/drivers/android/index-lifecycle.test.ts b/src/drivers/android/index-lifecycle.test.ts index bd217a5ab..91326ef57 100644 --- a/src/drivers/android/index-lifecycle.test.ts +++ b/src/drivers/android/index-lifecycle.test.ts @@ -1,4 +1,5 @@ import { describe, expect, it, vi } from "vitest"; +import { join } from "node:path"; import { promiseState } from "../../test-support/promise-state.js"; import { FakeClock, @@ -28,9 +29,9 @@ import { home } from "./test-index.js"; // why: The emulator outlives the daemon, so it is spawned detached; its output goes to the log file in its AVD folder. const emulatorOptions = { - env: { ...scopedEnv, ANDROID_EMU_CRASH_REPORTING_DATABASE: `${avdDirectory}/emu-crash.db` }, + env: { ...scopedEnv, ANDROID_EMU_CRASH_REPORTING_DATABASE: join(avdDirectory, "emu-crash.db") }, killChildren: true, - stdio: { file: `${avdDirectory}/simlock_one/simlock.avd/emulator.log` }, + stdio: { file: join(avdDirectory, "simlock_one", "simlock.avd", "emulator.log") }, } as const; function recordKillTimeout( @@ -184,7 +185,9 @@ function overridingAvdPath(inner: ProcessRunner): { class LinkedHomeFilesystem extends MemoryFilesystem { override async realpath(path: string): Promise { - const resolved = await super.realpath(path.replace(/^\/private\/home\//, "/home/")); + // why: the driver hands the path over in the host's separators, the link below is in `/` form. + const slashed = path.replaceAll("\\", "/"); + const resolved = await super.realpath(slashed.replace(/^\/private\/home\//, "/home/")); return resolved.replace(/^\/home\//, "/private/home/"); } } @@ -237,7 +240,7 @@ describe("AndroidDriver readiness on a taken console port", () => { // device starts by shutting it down. await driver.shutdown(stopped); - const ownPath = `${avdDirectory}/simlock_one/simlock.avd`; + const ownPath = join(avdDirectory, "simlock_one", "simlock.avd"); expect({ readied, other: other.observed() }).toEqual({ readied: { refused: expect.stringMatching( @@ -253,19 +256,22 @@ describe("AndroidDriver readiness on a taken console port", () => { readonly answer: string; readonly filesystem?: () => MemoryFilesystem; }>([ - { answer: `${avdDirectory}/simlock_one/simlock.avd\r\nOK\r\n`, reported: "exactly" }, { - answer: `${avdDirectory}/simlock_one/simlock.avd/\r\nOK\r\n`, + answer: `${join(avdDirectory, "simlock_one", "simlock.avd")}\r\nOK\r\n`, + reported: "exactly", + }, + { + answer: `${join(avdDirectory, "simlock_one", "simlock.avd")}/\r\nOK\r\n`, reported: "with a trailing slash", }, { - answer: `/private${avdDirectory}/simlock_one/simlock.avd\r\nOK\r\n`, + answer: `/private${join(avdDirectory, "simlock_one", "simlock.avd")}\r\nOK\r\n`, reported: "through a link to the device root's directory", }, // why: `/home` is a link to `/private/home`, as macOS's `/var` is to `/private/var`: the link // is on the device root's side, and the emulator answers with the resolved path. { - answer: `/private${avdDirectory}/simlock_one/simlock.avd\r\nOK\r\n`, + answer: `/private${join(avdDirectory, "simlock_one", "simlock.avd")}\r\nOK\r\n`, filesystem: () => new LinkedHomeFilesystem(), reported: "resolved, when the device root's own path runs through a link", }, @@ -287,7 +293,7 @@ describe("AndroidDriver readiness on a taken console port", () => { if (reported === "exactly") { // why: An exact answer needs nothing from the filesystem: a directory that cannot be // resolved this moment does not fail the boot. - filesystem.defineFailure(`${avdDirectory}/simlock_one/simlock.avd`, "EACCES"); + filesystem.defineFailure(join(avdDirectory, "simlock_one", "simlock.avd"), "EACCES"); } const ready = await driver.makeReady(device); @@ -312,9 +318,9 @@ describe("AndroidDriver readiness on a taken console port", () => { answered: "a directory that does not exist", }, { - answer: ok(`${avdDirectory}/simlock_two/simlock.avd\r\nOK\r\n`), + answer: ok(`${join(avdDirectory, "simlock_two", "simlock.avd")}\r\nOK\r\n`), answered: "another device's directory in the same root", - existing: `${avdDirectory}/simlock_two/simlock.avd`, + existing: join(avdDirectory, "simlock_two", "simlock.avd"), }, { answer: ok(`${home}/.android/avd/simlock_one/simlock.avd\r\nOK\r\n`), @@ -322,7 +328,7 @@ describe("AndroidDriver readiness on a taken console port", () => { existing: `${home}/.android/avd/simlock_one/simlock.avd`, }, { - answer: ok(`\r\n${avdDirectory}/simlock_one/simlock.avd\r\nOK\r\n`), + answer: ok(`\r\n${join(avdDirectory, "simlock_one", "simlock.avd")}\r\nOK\r\n`), answered: "its own directory below a blank first line", }, { @@ -444,7 +450,7 @@ describe("AndroidDriver console ports across a restart", () => { }, }; filesystem.onRemove = (path) => { - if (path === `${avdDirectory}/${running.deviceId}`) { + if (path === join(avdDirectory, running.deviceId)) { runningAtDeletion.push(host.avdAnswering(running.address)); } }; @@ -460,7 +466,7 @@ describe("AndroidDriver console ports across a restart", () => { undefined, ]); expect(killTimeouts, "the kill must be bounded").toEqual([5_000]); - expect(await filesystem.exists(`${avdDirectory}/${running.deviceId}`)).toBe(false); + expect(await filesystem.exists(join(avdDirectory, running.deviceId))).toBe(false); }); it("refuses to delete the AVD of a discovered emulator that does not exit", async () => { @@ -494,7 +500,7 @@ describe("AndroidDriver console ports across a restart", () => { clock.advance(1); await refused; - expect(await filesystem.exists(`${avdDirectory}/${running.deviceId}`)).toBe(true); + expect(await filesystem.exists(join(avdDirectory, running.deviceId))).toBe(true); }); it("refuses to delete the AVD when an attached emulator cannot say which AVD it runs", async () => { @@ -524,7 +530,7 @@ describe("AndroidDriver console ports across a restart", () => { expect({ kills: calls.filter((call) => call.args.includes("kill")).length, probeTimeoutMs: calls.find((call) => call.args.includes("path"))?.timeoutMs, - kept: await filesystem.exists(`${avdDirectory}/${running.deviceId}`), + kept: await filesystem.exists(join(avdDirectory, running.deviceId)), running: host.avdAnswering(running.address), }).toEqual({ kills: 0, probeTimeoutMs: 5_000, kept: true, running: running.deviceId }); }); diff --git a/src/drivers/android/index.test.ts b/src/drivers/android/index.test.ts index aafcae338..7b9e01298 100644 --- a/src/drivers/android/index.test.ts +++ b/src/drivers/android/index.test.ts @@ -1,4 +1,5 @@ import { describe, expect, it, vi } from "vitest"; +import { join } from "node:path"; import { ComponentInUseError, ComponentNotOwnedError, @@ -277,7 +278,7 @@ describe("AndroidDriver ownership", () => { filesystem.defineSymlink("/private/home", "/home"); filesystem.defineSymlink("/unreadable", avdDirectory); filesystem.defineFailure("/unreadable/simlock_one.avd", "EACCES"); - await filesystem.mkdirp(`${avdDirectory}/simlock_two.avd`); + await filesystem.mkdirp(join(avdDirectory, "simlock_two.avd")); for (const result of [ok(`${avdDirectory}/simlock_one.avd\r\nOK\r\n`), answer]) { const runner = new EmulatorExitingRunner([ @@ -324,18 +325,18 @@ describe("AndroidDriver ownership", () => { it("tells two running copies of one seed apart by each one's own AVD folder, still attributes an old-layout AVD, and lists no seed folder nor attributes its emulator", async () => { const filesystem = await androidFilesystem(); for (const folder of [ - `${avdDirectory}/simlock_a/simlock.avd`, - `${avdDirectory}/simlock_b/simlock.avd`, - `${avdDirectory}/simlock_old.avd`, - `${avdDirectory}/sources/seed_x/simlock.avd`, + join(avdDirectory, "simlock_a", "simlock.avd"), + join(avdDirectory, "simlock_b", "simlock.avd"), + join(avdDirectory, "simlock_old.avd"), + join(avdDirectory, "sources", "seed_x", "simlock.avd"), ]) { await filesystem.mkdirp(folder); } const running = [ - ["emulator-5554", "simlock", `${avdDirectory}/simlock_b/simlock.avd`], - ["emulator-5556", "simlock", `${avdDirectory}/simlock_a/simlock.avd`], - ["emulator-5558", "simlock_old", `${avdDirectory}/simlock_old.avd`], - ["emulator-5560", "simlock", `${avdDirectory}/sources/seed_x/simlock.avd`], + ["emulator-5554", "simlock", join(avdDirectory, "simlock_b", "simlock.avd")], + ["emulator-5556", "simlock", join(avdDirectory, "simlock_a", "simlock.avd")], + ["emulator-5558", "simlock_old", join(avdDirectory, "simlock_old.avd")], + ["emulator-5560", "simlock", join(avdDirectory, "sources", "seed_x", "simlock.avd")], ] as const; const runner = new EmulatorExitingRunner([ processResult( @@ -392,7 +393,7 @@ describe("AndroidDriver pre-root devices", () => { it("hands the device table its device root, its legacy AVD home, its environment and its avdmanager", async () => { const legacyHome = "/legacy/avd"; const filesystem = await androidFilesystem(); - await filesystem.mkdirp(`${avdDirectory}/simlock_new.avd`); + await filesystem.mkdirp(join(avdDirectory, "simlock_new.avd")); await filesystem.mkdirp(`${legacyHome}/simlock_old.avd`); const runner = new EmulatorExitingRunner([ processResult(binaries.adb, ["devices"], "List of devices attached\n"), @@ -408,7 +409,7 @@ describe("AndroidDriver pre-root devices", () => { await driver.destroyLegacy(legacy!.device); expect(reality.devices.map((device) => device.deviceId)).toEqual(["simlock_new"]); - expect(legacy?.path).toBe(`${legacyHome}/simlock_old.avd`); + expect(legacy?.path).toBe(join(legacyHome, "simlock_old.avd")); expect(runner.calls.at(-1)).toMatchObject({ command: binaries.avdmanager, options: { diff --git a/src/drivers/android/physical-handler-inspect-list.test.ts b/src/drivers/android/physical-handler-inspect-list.test.ts index c7f062f6c..2b20d3eec 100644 --- a/src/drivers/android/physical-handler-inspect-list.test.ts +++ b/src/drivers/android/physical-handler-inspect-list.test.ts @@ -63,7 +63,7 @@ describe("Android physical handler: inspectPhysical", () => { expect(runner.commands.filter((call) => call.args.includes("-s"))).toEqual([]); }); - it.each([ + const networkOnlyRows: (readonly [string, string, string])[] = [ [ "a network serial", "192.168.1.5:5555 device product:o1s model:SM_G991B transport_id:4", @@ -84,7 +84,15 @@ describe("Android physical handler: inspectPhysical", () => { `${PHONE} device product:o1s model:SM_G991B transport_id:3`, PHONE, ], - ])( + ]; + + // why: adb on Windows lists no `usb:` path for any USB device, so there a USB-shaped serial + // without one is a phone to enrol (`physical-handler-windows.test.ts`), not a network line. + it.each( + networkOnlyRows.filter( + ([name]) => process.platform !== "win32" || name !== "a USB-shaped serial on a network line", + ), + )( "refuses %s as network-only with the USB-only message, and runs no command naming it", async (_name, line, id) => { const { driver, runner } = await world(); diff --git a/src/drivers/android/physical-handler.test.ts b/src/drivers/android/physical-handler.test.ts index 7cbc57157..246864ff8 100644 --- a/src/drivers/android/physical-handler.test.ts +++ b/src/drivers/android/physical-handler.test.ts @@ -13,9 +13,8 @@ import { type StreamingProcessHandle, } from "../../ports/index.js"; import { AndroidDriver } from "./index.js"; -import { emulatorHelpListing } from "./testing.js"; +import { binaries, emulatorHelpListing } from "./testing.js"; import { - sdk, adb, avdDirectory, PHONE, @@ -112,7 +111,7 @@ async function expectReclaimAccepted(): Promise { const pixelDevices = `Available devices:\nid: 0 or "pixel_8"\n Name: Pixel 8\n OEM : Google\n`; function sdkTool(name: "avdmanager" | "sdkmanager"): string { - return `${sdk}/cmdline-tools/latest/bin/${name}`; + return binaries[name]; } function scripted(command: string, args: readonly (string | RegExp)[], stdout = "") { @@ -806,7 +805,7 @@ describe("Android physical handler: independence from emulator calls", () => { // why: the emulator call is the first boot of a seed, made inside `provision`: it holds the seed's lock and a console port while its emulator never answers. const emulatorExpectations = [ scripted(sdkTool("avdmanager"), ["list", "device"], pixelDevices), - scripted(`${sdk}/emulator/emulator`, ["-version"], "Android emulator version 36.1.9"), + scripted(binaries.emulator, ["-version"], "Android emulator version 36.1.9"), scripted(sdkTool("avdmanager"), [ "create", "avd", @@ -818,12 +817,12 @@ describe("Android physical handler: independence from emulator calls", () => { "pixel_8", ]), scripted(adb, ["devices"], "List of devices attached\n"), - scripted(`${sdk}/emulator/emulator`, ["-help"], emulatorHelpListing), + scripted(binaries.emulator, ["-help"], emulatorHelpListing), { hangs: true, match: { args: [/^-avd$/, "simlock", /.*/, /.*/, /.*/, /.*/, /.*/, /.*/, /.*/, /.*/, /.*/], - command: `${sdk}/emulator/emulator`, + command: binaries.emulator, }, }, { diff --git a/src/drivers/android/sdk-paths.ts b/src/drivers/android/sdk-paths.ts index 85f6f4a53..f01fa4f35 100644 --- a/src/drivers/android/sdk-paths.ts +++ b/src/drivers/android/sdk-paths.ts @@ -17,7 +17,7 @@ export interface AndroidSdkPaths { * why: The SDK's command-line tools are `.bat` scripts on Windows and its binaries `.exe`; a path * without the extension is not a file there, so a complete SDK would read as missing every tool. */ -function withWindowsExtension( +export function withWindowsExtension( path: string, platform: NodeJS.Platform, extension: ".bat" | ".exe", diff --git a/src/drivers/android/seeds-copies.test.ts b/src/drivers/android/seeds-copies.test.ts index 2c11ce0d6..05bd612f4 100644 --- a/src/drivers/android/seeds-copies.test.ts +++ b/src/drivers/android/seeds-copies.test.ts @@ -1,4 +1,5 @@ import { describe, expect, it, vi } from "vitest"; +import { join } from "node:path"; import { FakeClock, MemoryFilesystem, type ScriptedProcessExpectation } from "../../ports/index.js"; @@ -19,7 +20,7 @@ import { writeSeedFiles, } from "./testing.js"; -const copyHome = `${avdDirectory}/simlock_one`; +const copyHome = join(avdDirectory, "simlock_one"); /** why: the daemon after a restart: a new part over the same device folders and the same source table. */ function reopened( @@ -60,7 +61,7 @@ class CopyFailureFilesystem extends MemoryFilesystem { describe("Seeds", () => { describe("seeds and copies", () => { it("makes one seed when two plain leases of one kind are provisioned at once", async () => { - const madeHome = `${sources}/seed_three`; + const madeHome = join(sources, "seed_three"); const harness = await seedHarness([ ...makingTheSeed(madeHome), processResult(binaries.emulator, ["-version"], "Android emulator version 36.1.9"), @@ -76,7 +77,7 @@ describe("Seeds", () => { expect(harness.runner.calls.filter((call) => call.args[0] === "create")).toHaveLength(1); expect([first.deviceId, second.deviceId]).toEqual(["simlock_one", "simlock_two"]); await expect( - harness.filesystem.exists(`${avdDirectory}/simlock_two/simlock.avd`), + harness.filesystem.exists(join(avdDirectory, "simlock_two", "simlock.avd")), ).resolves.toBe(true); const listed = await harness.seeds.listSources(); expect(listed.filter((source) => source.orphan !== true)).toHaveLength(1); @@ -148,7 +149,7 @@ describe("Seeds", () => { it("destroys a stale seed and makes it again at the next provision", async () => { const harness = await seedHarness(makingTheSeed()); await harness.seeds.provision(harness.spec); - const newHome = `${sources}/seed_five`; + const newHome = join(sources, "seed_five"); await writeSeedFiles(harness.filesystem, newHome); const newer = "Android emulator version 36.2.0"; const later = await reopened(harness, [ @@ -290,7 +291,7 @@ describe("Seeds", () => { }); it("provisions a kind with a ready seed while another kind's seed is being made, and leaves that kind's making row and folder alone", async () => { - const makingHome = `${sources}/seed_device-4`; + const makingHome = join(sources, "seed_device-4"); const harness = await seedHarness([ ...makingTheSeed(), processResult(binaries.avdmanager, ["list", "device"], pixelDevices), @@ -335,7 +336,7 @@ describe("Seeds", () => { ); const second = await provisioning; - expect(second.driverData).toMatchObject({ avdHome: expect.stringContaining("/simlock_") }); + expect(second.driverData).toMatchObject({ avdHome: expect.stringContaining("simlock_") }); expect( harness.database.prepare("SELECT state FROM android_source_data ORDER BY state").all(), ).toEqual([{ state: "making" }, { state: "ready" }]); @@ -361,7 +362,7 @@ describe("Seeds", () => { it("lists each ready seed with its size, reports a sources folder no row names as an orphan, and destroys a source by id after stopping its emulator by path", async () => { const serial = "emulator-5586"; - const orphanHome = `${sources}/seed_orphan`; + const orphanHome = join(sources, "seed_orphan"); const harness = await seedHarness([ ...makingTheSeed(), processResult(binaries.emulator, ["-version"], "Android emulator version 36.1.9"), @@ -391,7 +392,7 @@ describe("Seeds", () => { await harness.seeds.destroySource("seed_orphan"); await harness.seeds.destroySource("seed_two"); - expect(await harness.filesystem.exists(`${sources}/seed_two`)).toBe(false); + expect(await harness.filesystem.exists(join(sources, "seed_two"))).toBe(false); expect(await harness.filesystem.exists(orphanHome)).toBe(false); expect( harness.runner.calls diff --git a/src/drivers/android/seeds-library-and-fit.test.ts b/src/drivers/android/seeds-library-and-fit.test.ts index 3ea664225..977dfd60c 100644 --- a/src/drivers/android/seeds-library-and-fit.test.ts +++ b/src/drivers/android/seeds-library-and-fit.test.ts @@ -1,4 +1,5 @@ import { describe, expect, it } from "vitest"; +import { join } from "node:path"; import { MemoryFilesystem } from "../../ports/index.js"; @@ -231,7 +232,7 @@ describe("Seeds", () => { it("rethrows and runs no `avdmanager delete` when a write after `avdmanager create avd` fails", async () => { const filesystem = new WriteFailureFilesystem( - `${avdDirectory}/sources/seed_two/simlock.avd/config.ini`, + join(avdDirectory, "sources", "seed_two", "simlock.avd", "config.ini"), new Error("disk full"), ); const harness = await libraryHarness({ filesystem, listing: pixelDevices }); diff --git a/src/drivers/android/seeds.ts b/src/drivers/android/seeds.ts index 3e4597894..78a399bc8 100644 --- a/src/drivers/android/seeds.ts +++ b/src/drivers/android/seeds.ts @@ -332,7 +332,9 @@ export class Seeds { `Android device ${deviceId} cannot be saved: it has no copy folder or image`, ); } - const config = await this.#filesystem.readFile(`${this.#adbTools.avdFolder(data)}/config.ini`); + const config = await this.#filesystem.readFile( + join(this.#adbTools.avdFolder(data), "config.ini"), + ); const kind = savedKindOf(config); if (kind === undefined) { throw new DriverCrashError( diff --git a/src/drivers/android/test-index-lifecycle.ts b/src/drivers/android/test-index-lifecycle.ts index 8192f7b2b..4e970d4f4 100644 --- a/src/drivers/android/test-index-lifecycle.ts +++ b/src/drivers/android/test-index-lifecycle.ts @@ -1,3 +1,4 @@ +import { join } from "node:path"; import { type ScriptedProcessExpectation } from "../../ports/index.js"; import { avdDirectory, binaries, processResult } from "./testing.js"; @@ -9,6 +10,6 @@ export function avdPathExpectation( return processResult( binaries.adb, ["-s", serial, "emu", "avd", "path"], - `${avdDirectory}/${avdName}.avd\r\nOK\r\n`, + `${join(avdDirectory, `${avdName}.avd`)}\r\nOK\r\n`, ); } diff --git a/src/drivers/android/test-physical-handler.ts b/src/drivers/android/test-physical-handler.ts index aab98ecb0..252e474ac 100644 --- a/src/drivers/android/test-physical-handler.ts +++ b/src/drivers/android/test-physical-handler.ts @@ -15,7 +15,7 @@ import { } from "../../ports/index.js"; import type { AndroidDriverConfig } from "./definition.js"; import { AndroidDriver } from "./index.js"; -import { memoryAndroidSourceDatabase } from "./testing.js"; +import { binaries, memoryAndroidSourceDatabase } from "./testing.js"; export const sdk = "/android-sdk"; @@ -25,7 +25,7 @@ const simlockHome = "/home/simlock/.simlock"; const instanceId = "instance-1"; -export const adb = `${sdk}/platform-tools/adb`; +export const adb = binaries.adb; export const avdDirectory = `${simlockHome}/devices/android`; @@ -250,11 +250,7 @@ export async function androidFilesystem(): Promise { const filesystem = new MemoryFilesystem(); await filesystem.mkdirp(`${sdk}/platform-tools`); await filesystem.writeFileAtomic(adb, "binary"); - for (const binary of [ - `${sdk}/cmdline-tools/latest/bin/avdmanager`, - `${sdk}/cmdline-tools/latest/bin/sdkmanager`, - `${sdk}/emulator/emulator`, - ]) { + for (const binary of [binaries.avdmanager, binaries.sdkmanager, binaries.emulator]) { await filesystem.mkdirp(binary.slice(0, binary.lastIndexOf("/"))); await filesystem.writeFileAtomic(binary, "binary"); } diff --git a/src/drivers/android/test-sdk-fixtures.ts b/src/drivers/android/test-sdk-fixtures.ts index be4f12291..42bceef85 100644 --- a/src/drivers/android/test-sdk-fixtures.ts +++ b/src/drivers/android/test-sdk-fixtures.ts @@ -1,3 +1,4 @@ +import { join, win32 } from "node:path"; import { MemoryFilesystem, NodeSqliteOpener, @@ -10,6 +11,7 @@ import { type SqliteDatabase, } from "../../ports/index.js"; import { type LibraryDeviceProfile } from "./profiles/index.js"; +import { adbPath, emulatorPath, withWindowsExtension } from "./sdk-paths.js"; import { androidSourceDataOwner } from "./source-data.js"; export const ANDROID_SDK_ROOT = "/android-sdk"; @@ -246,13 +248,24 @@ export const simlockHome = "/home/simlock/.simlock"; export const instanceId = "instance-1"; -export const avdDirectory = `${simlockHome}/devices/android`; +// why: the driver builds its device root with `join`, so on Windows it reads `\home\...`. +export const avdDirectory = join(simlockHome, "devices", "android"); +// why: the driver's SDK search runs with the host's platform, so the fake SDK holds the names +// that platform has (`adb.exe`, `avdmanager.bat` on Windows). export const binaries = { - adb: `${ANDROID_SDK_ROOT}/platform-tools/adb`, - avdmanager: `${ANDROID_SDK_ROOT}/cmdline-tools/latest/bin/avdmanager`, - emulator: `${ANDROID_SDK_ROOT}/emulator/emulator`, - sdkmanager: `${ANDROID_SDK_ROOT}/cmdline-tools/latest/bin/sdkmanager`, + adb: adbPath(ANDROID_SDK_ROOT), + avdmanager: withWindowsExtension( + `${ANDROID_SDK_ROOT}/cmdline-tools/latest/bin/avdmanager`, + process.platform, + ".bat", + ), + emulator: emulatorPath(ANDROID_SDK_ROOT), + sdkmanager: withWindowsExtension( + `${ANDROID_SDK_ROOT}/cmdline-tools/latest/bin/sdkmanager`, + process.platform, + ".bat", + ), } as const; export function ok(stdout = ""): ProcessResult { @@ -264,7 +277,8 @@ export class WorkingDirectoryFilesystem extends MemoryFilesystem { super(); } + // why: `win32.isAbsolute` reads `/x` and `D:\x` alike, so a path in either style is not joined to the folder. override async realpath(path: string): Promise { - return super.realpath(path.startsWith("/") ? path : `${this.workingDirectory}/${path}`); + return super.realpath(win32.isAbsolute(path) ? path : `${this.workingDirectory}/${path}`); } } diff --git a/src/drivers/android/testing.ts b/src/drivers/android/testing.ts index 05a012f10..0f41506e9 100644 --- a/src/drivers/android/testing.ts +++ b/src/drivers/android/testing.ts @@ -66,4 +66,4 @@ export { copyPathExpectation, } from "./test-emulator-host.js"; -export { locateSdk, type AndroidSdkPaths } from "./sdk-paths.js"; +export { locateSdk, withWindowsExtension, type AndroidSdkPaths } from "./sdk-paths.js"; diff --git a/src/drivers/android/two-instances.test.ts b/src/drivers/android/two-instances.test.ts index cbd20e1ad..fc5a716d2 100644 --- a/src/drivers/android/two-instances.test.ts +++ b/src/drivers/android/two-instances.test.ts @@ -14,7 +14,7 @@ import { type TcpProbe, } from "../../ports/index.js"; import { AndroidDriver } from "./index.js"; -import { memoryAndroidSourceDatabase } from "./testing.js"; +import { binaries, memoryAndroidSourceDatabase } from "./testing.js"; // Two Simlock instances on one machine, set up the way CLI.md and CONFIGURATION.md say to: // a distinct `SIMLOCK_HOME` each, and a distinct `drivers.android.adbServerPort` each. @@ -22,12 +22,6 @@ import { memoryAndroidSourceDatabase } from "./testing.js"; const sdk = "/android-sdk"; const home = "/home/simlock"; -const binaries = { - adb: `${sdk}/platform-tools/adb`, - avdmanager: `${sdk}/cmdline-tools/latest/bin/avdmanager`, - emulator: `${sdk}/emulator/emulator`, - sdkmanager: `${sdk}/cmdline-tools/latest/bin/sdkmanager`, -} as const; const pixelDevices = `Available devices:\nid: 0 or "pixel_8"\n Name: Pixel 8\n OEM : Google\n`; const spec = { physical: false, model: "Pixel 8", osVersion: "34", platform: "android" } as const; diff --git a/src/test-support/windows-skipped.ts b/src/test-support/windows-skipped.ts index acd2836ee..ccb6e3240 100644 --- a/src/test-support/windows-skipped.ts +++ b/src/test-support/windows-skipped.ts @@ -62,23 +62,6 @@ const WINDOWS_SKIPPED: readonly string[] = [ "src/daemon/session-path.e2e.test.ts", "src/delivery-stats.test.ts", "src/docs-surface-check.test.ts", - "src/drivers/android/device-table.test.ts", - "src/drivers/android/index-boot.test.ts", - "src/drivers/android/index-copies-recovery.test.ts", - "src/drivers/android/index-device-tcp.test.ts", - "src/drivers/android/index-image-fit.test.ts", - "src/drivers/android/index-launch.test.ts", - "src/drivers/android/index-lifecycle.test.ts", - "src/drivers/android/index-profiles-components.test.ts", - "src/drivers/android/index-screen-capture.test.ts", - "src/drivers/android/index.test.ts", - "src/drivers/android/physical-handler-inspect-list.test.ts", - "src/drivers/android/physical-handler-network.test.ts", - "src/drivers/android/physical-handler-passthrough.test.ts", - "src/drivers/android/physical-handler.test.ts", - "src/drivers/android/seeds-copies.test.ts", - "src/drivers/android/seeds-library-and-fit.test.ts", - "src/drivers/android/two-instances.test.ts", "src/drivers/ios/boot-courtesies.test.ts", "src/drivers/ios/boot-deadline.test.ts", "src/drivers/ios/devicectl-passthrough.test.ts", From f571471913e8c47392c1d2b5fc91b19e12cef1f5 Mon Sep 17 00:00:00 2001 From: Szymon Chmal Date: Wed, 18 Nov 2026 16:41:34 +0100 Subject: [PATCH 2/2] fix(android): the fixtures' device root is the resolved path the driver reads, and the emulator fake reads folders with node:path (#1707) --- src/drivers/android/index-lifecycle.test.ts | 5 +++-- src/drivers/android/index.test.ts | 9 +++++---- src/drivers/android/test-driver-harness.ts | 5 +++-- src/drivers/android/test-emulator-host.ts | 8 ++++---- src/drivers/android/test-physical-handler.ts | 4 +++- src/drivers/android/test-sdk-fixtures.ts | 11 ++++++++--- src/drivers/android/test-seed-harness.ts | 7 ++++--- src/drivers/android/test-seeds.ts | 5 +++-- src/drivers/android/testing.ts | 1 + 9 files changed, 34 insertions(+), 21 deletions(-) diff --git a/src/drivers/android/index-lifecycle.test.ts b/src/drivers/android/index-lifecycle.test.ts index 91326ef57..a39ddc5e0 100644 --- a/src/drivers/android/index-lifecycle.test.ts +++ b/src/drivers/android/index-lifecycle.test.ts @@ -12,6 +12,7 @@ import { answeringAvdPath, androidFilesystem, avdDirectory, + privateAliasOf, binaries, bootProbes, EmulatorExitingRunner, @@ -265,13 +266,13 @@ describe("AndroidDriver readiness on a taken console port", () => { reported: "with a trailing slash", }, { - answer: `/private${join(avdDirectory, "simlock_one", "simlock.avd")}\r\nOK\r\n`, + answer: `${privateAliasOf(join(avdDirectory, "simlock_one", "simlock.avd"))}\r\nOK\r\n`, reported: "through a link to the device root's directory", }, // why: `/home` is a link to `/private/home`, as macOS's `/var` is to `/private/var`: the link // is on the device root's side, and the emulator answers with the resolved path. { - answer: `/private${join(avdDirectory, "simlock_one", "simlock.avd")}\r\nOK\r\n`, + answer: `${privateAliasOf(join(avdDirectory, "simlock_one", "simlock.avd"))}\r\nOK\r\n`, filesystem: () => new LinkedHomeFilesystem(), reported: "resolved, when the device root's own path runs through a link", }, diff --git a/src/drivers/android/index.test.ts b/src/drivers/android/index.test.ts index 7b9e01298..c192157c5 100644 --- a/src/drivers/android/index.test.ts +++ b/src/drivers/android/index.test.ts @@ -11,6 +11,7 @@ import { AdbServerUnavailableError, AndroidDriver } from "./index.js"; import { androidFilesystem, avdDirectory, + privateAliasOf, binaries, EmulatorExitingRunner, instanceId, @@ -237,12 +238,12 @@ describe("AndroidDriver ownership", () => { it.each([ { reported: "a trailing slash", - answer: ok(`${avdDirectory}/simlock_one.avd/\r\nOK\r\n`), + answer: ok(`${join(avdDirectory, "simlock_one.avd")}/\r\nOK\r\n`), runState: "running", }, { reported: "a canonical alias", - answer: ok(`/private${avdDirectory}/simlock_one.avd\r\nOK\r\n`), + answer: ok(`${privateAliasOf(join(avdDirectory, "simlock_one.avd"))}\r\nOK\r\n`), runState: "running", }, { reported: "a blank path", answer: ok("\r\nOK\r\n"), runState: "stopped" }, @@ -260,7 +261,7 @@ describe("AndroidDriver ownership", () => { }, { reported: "a sibling AVD", - answer: ok(`${avdDirectory}/simlock_two.avd\r\nOK\r\n`), + answer: ok(`${join(avdDirectory, "simlock_two.avd")}\r\nOK\r\n`), runState: "stopped", }, { @@ -280,7 +281,7 @@ describe("AndroidDriver ownership", () => { filesystem.defineFailure("/unreadable/simlock_one.avd", "EACCES"); await filesystem.mkdirp(join(avdDirectory, "simlock_two.avd")); - for (const result of [ok(`${avdDirectory}/simlock_one.avd\r\nOK\r\n`), answer]) { + for (const result of [ok(`${join(avdDirectory, "simlock_one.avd")}\r\nOK\r\n`), answer]) { const runner = new EmulatorExitingRunner([ processResult( binaries.adb, diff --git a/src/drivers/android/test-driver-harness.ts b/src/drivers/android/test-driver-harness.ts index 7a31bb6a3..a5e53e67e 100644 --- a/src/drivers/android/test-driver-harness.ts +++ b/src/drivers/android/test-driver-harness.ts @@ -1,3 +1,4 @@ +import { join } from "node:path"; import { MemoryFilesystem, ScriptedProcessRunner, @@ -93,8 +94,8 @@ export async function provisionedHarness( ) { const filesystem = await androidFilesystem({}, options.filesystem); const ids = options.ids ?? ["one", "two"]; - const seedHome = `${avdDirectory}/sources/seed_${ids[1] ?? "two"}`; - const copyHome = `${avdDirectory}/simlock_${ids[0] ?? "one"}`; + const seedHome = join(avdDirectory, "sources", `seed_${ids[1] ?? "two"}`); + const copyHome = join(avdDirectory, `simlock_${ids[0] ?? "one"}`); await writeSeedFiles(filesystem, seedHome, options.config); const tcpProbe = new FakeTcpProbe([adbServerPort]); const clock = new FakeClock(); diff --git a/src/drivers/android/test-emulator-host.ts b/src/drivers/android/test-emulator-host.ts index be8194e63..9349b3deb 100644 --- a/src/drivers/android/test-emulator-host.ts +++ b/src/drivers/android/test-emulator-host.ts @@ -6,7 +6,7 @@ import { type ProcessRunOptions, type ScriptedProcessExpectation, } from "../../ports/index.js"; -import { basename } from "node:path"; +import { basename, dirname, join } from "node:path"; import { processResult, pixelDevices, avdDirectory, binaries, ok } from "./test-sdk-fixtures.js"; import { emulatorHelpListing, writeSeedFiles } from "./test-seed-harness.js"; @@ -37,7 +37,7 @@ export class EmulatorHost { avdAnswering(serial: string | undefined): string | undefined { const folder = this.#listening.get(consolePortOf(serial)); if (folder === undefined) return undefined; - const home = folder.slice(0, folder.lastIndexOf("/")); + const home = dirname(folder); return home === avdDirectory ? basename(folder, ".avd") : basename(home); } @@ -117,7 +117,7 @@ export class EmulatorHost { if (command !== binaries.emulator || args[0] !== "-avd") { throw new Error(`Unexpected spawn: ${command} ${args.join(" ")}`); } - const avdName = `${env?.["ANDROID_AVD_HOME"] ?? avdDirectory}/${args[1] ?? ""}.avd`; + const avdName = join(env?.["ANDROID_AVD_HOME"] ?? avdDirectory, `${args[1] ?? ""}.avd`); const port = Number(args[args.indexOf("-port") + 1]); let exit!: (result: ProcessResult) => void; const exited = new Promise((resolve) => { @@ -193,7 +193,7 @@ export function copyPathExpectation( return processResult( binaries.adb, ["-s", serial, "emu", "avd", "path"], - `${avdDirectory}/${folder}/simlock.avd\r\nOK\r\n`, + `${join(avdDirectory, folder, "simlock.avd")}\r\nOK\r\n`, ); } diff --git a/src/drivers/android/test-physical-handler.ts b/src/drivers/android/test-physical-handler.ts index 252e474ac..bb593a67c 100644 --- a/src/drivers/android/test-physical-handler.ts +++ b/src/drivers/android/test-physical-handler.ts @@ -1,3 +1,4 @@ +import { resolve } from "node:path"; import { OWNED_ROOT_MARKER_FILE } from "../../core/index.js"; import { FakeClock, @@ -27,7 +28,8 @@ const instanceId = "instance-1"; export const adb = binaries.adb; -export const avdDirectory = `${simlockHome}/devices/android`; +// why: `ensureOwnedRoot` resolves the configured root, so on Windows the driver reads `D:\home\...`. +export const avdDirectory = resolve(simlockHome, "devices", "android"); export const PHONE = "R58M123ABC"; diff --git a/src/drivers/android/test-sdk-fixtures.ts b/src/drivers/android/test-sdk-fixtures.ts index 42bceef85..560f262ee 100644 --- a/src/drivers/android/test-sdk-fixtures.ts +++ b/src/drivers/android/test-sdk-fixtures.ts @@ -1,4 +1,4 @@ -import { join, win32 } from "node:path"; +import { resolve, win32 } from "node:path"; import { MemoryFilesystem, NodeSqliteOpener, @@ -248,8 +248,13 @@ export const simlockHome = "/home/simlock/.simlock"; export const instanceId = "instance-1"; -// why: the driver builds its device root with `join`, so on Windows it reads `\home\...`. -export const avdDirectory = join(simlockHome, "devices", "android"); +// why: the canonical alias an emulator on macOS reports for a path (`/var` is `/private/var`), in `/` form on every host. +export function privateAliasOf(path: string): string { + return `/private${path.replace(/^[A-Za-z]:/, "").replaceAll("\\", "/")}`; +} + +// why: `ensureOwnedRoot` resolves the configured root, so on Windows the driver reads `D:\home\...`. +export const avdDirectory = resolve(simlockHome, "devices", "android"); // why: the driver's SDK search runs with the host's platform, so the fake SDK holds the names // that platform has (`adb.exe`, `avdmanager.bat` on Windows). diff --git a/src/drivers/android/test-seed-harness.ts b/src/drivers/android/test-seed-harness.ts index 45246cb08..6397121bb 100644 --- a/src/drivers/android/test-seed-harness.ts +++ b/src/drivers/android/test-seed-harness.ts @@ -1,3 +1,4 @@ +import { join } from "node:path"; import { type DriverCatalogEntry, type DriverDevice, @@ -80,7 +81,7 @@ export const emulatorHelpListing = [ .map((flag) => ` ${flag} described`) .join("\n"); -const defaultSeedHome = `${avdDirectory}/sources/seed_two`; +const defaultSeedHome = join(avdDirectory, "sources", "seed_two"); /** why: the calls of making and booting a seed, shared by the seed tests and the harness every driver test starts from. */ export const seedEmulatorLine = [ @@ -482,7 +483,7 @@ export async function libraryHarness( await writeDevicesXml(filesystem, options.devicesXml); } // why: the profile is applied to the seed's AVD, which `avdmanager create` writes in the seed's own folder. - const seedFolder = `${avdDirectory}/sources/seed_two`; + const seedFolder = join(avdDirectory, "sources", "seed_two"); const avd = `${seedFolder}/simlock.avd`; const configPath = `${avd}/config.ini`; const bootPropPath = `${avd}/boot.prop`; @@ -558,7 +559,7 @@ export async function taggedHarness( const runner = new EmulatorExitingRunner([ processResult(binaries.avdmanager, ["list", "device"], pixelDevices), ...makingASeedFrom(defaultSeedHome, "pixel_5"), - ...copyBootExpectations({ copyHome: `${avdDirectory}/simlock_one` }), + ...copyBootExpectations({ copyHome: join(avdDirectory, "simlock_one") }), markWriteExpectation("emulator-5586", "device-3"), ]); const driver = await build(filesystem, runner, { hostAbi, ids: ["one", "two"] }); diff --git a/src/drivers/android/test-seeds.ts b/src/drivers/android/test-seeds.ts index e6c2646a8..6041f7020 100644 --- a/src/drivers/android/test-seeds.ts +++ b/src/drivers/android/test-seeds.ts @@ -1,3 +1,4 @@ +import { join } from "node:path"; import { FakeClock, FakeTcpProbe, @@ -162,9 +163,9 @@ export const buildPart: BuildProvisioner = async (filesystem, processRunner, opt export const libraryHarness = (options?: Parameters[1]) => libraryHarnessWith(buildPart, options); -export const sources = `${avdDirectory}/sources`; +export const sources = join(avdDirectory, "sources"); -export const seedHome = `${sources}/seed_two`; +export const seedHome = join(sources, "seed_two"); export async function seedHarness( expectations: readonly ScriptedProcessExpectation[], diff --git a/src/drivers/android/testing.ts b/src/drivers/android/testing.ts index 0f41506e9..2e1e6cb02 100644 --- a/src/drivers/android/testing.ts +++ b/src/drivers/android/testing.ts @@ -17,6 +17,7 @@ export { answeringAvdPath, simlockHome, instanceId, + privateAliasOf, avdDirectory, binaries, ok,