test: make shell env path cache tests platform deterministic

This commit is contained in:
Peter Steinberger
2026-02-19 07:02:26 +00:00
parent 231f2af7df
commit c37cf02f29
3 changed files with 39 additions and 25 deletions

View File

@@ -224,35 +224,34 @@ describe("infra runtime", () => {
afterEach(() => resetShellPathCacheForTests());
it("returns PATH from login shell env", () => {
if (process.platform === "win32") {
return;
}
const exec = vi
.fn()
.mockReturnValue(Buffer.from("PATH=/custom/bin\0HOME=/home/user\0", "utf-8"));
const result = getShellPathFromLoginShell({ env: { SHELL: "/bin/sh" }, exec });
const result = getShellPathFromLoginShell({
env: { SHELL: "/bin/sh" },
exec,
platform: "linux",
});
expect(result).toBe("/custom/bin");
});
it("caches the value", () => {
if (process.platform === "win32") {
return;
}
const exec = vi.fn().mockReturnValue(Buffer.from("PATH=/custom/bin\0", "utf-8"));
const env = { SHELL: "/bin/sh" } as NodeJS.ProcessEnv;
expect(getShellPathFromLoginShell({ env, exec })).toBe("/custom/bin");
expect(getShellPathFromLoginShell({ env, exec })).toBe("/custom/bin");
expect(getShellPathFromLoginShell({ env, exec, platform: "linux" })).toBe("/custom/bin");
expect(getShellPathFromLoginShell({ env, exec, platform: "linux" })).toBe("/custom/bin");
expect(exec).toHaveBeenCalledTimes(1);
});
it("returns null on exec failure", () => {
if (process.platform === "win32") {
return;
}
const exec = vi.fn(() => {
throw new Error("boom");
});
const result = getShellPathFromLoginShell({ env: { SHELL: "/bin/sh" }, exec });
const result = getShellPathFromLoginShell({
env: { SHELL: "/bin/sh" },
exec,
platform: "linux",
});
expect(result).toBeNull();
});
});

View File

@@ -81,19 +81,14 @@ describe("shell env fallback", () => {
const first = getShellPathFromLoginShell({
env: {} as NodeJS.ProcessEnv,
exec: exec as unknown as Parameters<typeof getShellPathFromLoginShell>[0]["exec"],
platform: "linux",
});
const second = getShellPathFromLoginShell({
env: {} as NodeJS.ProcessEnv,
exec: exec as unknown as Parameters<typeof getShellPathFromLoginShell>[0]["exec"],
platform: "linux",
});
if (process.platform === "win32") {
expect(first).toBeNull();
expect(second).toBeNull();
expect(exec).not.toHaveBeenCalled();
return;
}
expect(first).toBe("/usr/local/bin:/usr/bin");
expect(second).toBe("/usr/local/bin:/usr/bin");
expect(exec).toHaveBeenCalledOnce();
@@ -108,18 +103,36 @@ describe("shell env fallback", () => {
const first = getShellPathFromLoginShell({
env: {} as NodeJS.ProcessEnv,
exec: exec as unknown as Parameters<typeof getShellPathFromLoginShell>[0]["exec"],
platform: "linux",
});
const second = getShellPathFromLoginShell({
env: {} as NodeJS.ProcessEnv,
exec: exec as unknown as Parameters<typeof getShellPathFromLoginShell>[0]["exec"],
platform: "linux",
});
expect(first).toBeNull();
expect(second).toBeNull();
if (process.platform === "win32") {
expect(exec).not.toHaveBeenCalled();
return;
}
expect(exec).toHaveBeenCalledOnce();
});
it("returns null without invoking shell on win32", () => {
resetShellPathCacheForTests();
const exec = vi.fn(() => Buffer.from("PATH=/usr/local/bin:/usr/bin\0HOME=/tmp\0"));
const first = getShellPathFromLoginShell({
env: {} as NodeJS.ProcessEnv,
exec: exec as unknown as Parameters<typeof getShellPathFromLoginShell>[0]["exec"],
platform: "win32",
});
const second = getShellPathFromLoginShell({
env: {} as NodeJS.ProcessEnv,
exec: exec as unknown as Parameters<typeof getShellPathFromLoginShell>[0]["exec"],
platform: "win32",
});
expect(first).toBeNull();
expect(second).toBeNull();
expect(exec).not.toHaveBeenCalled();
});
});

View File

@@ -140,11 +140,13 @@ export function getShellPathFromLoginShell(opts: {
env: NodeJS.ProcessEnv;
timeoutMs?: number;
exec?: typeof execFileSync;
platform?: NodeJS.Platform;
}): string | null {
if (cachedShellPath !== undefined) {
return cachedShellPath;
}
if (process.platform === "win32") {
const platform = opts.platform ?? process.platform;
if (platform === "win32") {
cachedShellPath = null;
return cachedShellPath;
}