test: consolidate redundant suites and speed up timers

This commit is contained in:
Peter Steinberger
2026-02-23 04:44:42 +00:00
parent a6a2a9276e
commit 86a8b65e9d
10 changed files with 171 additions and 224 deletions

View File

@@ -1,7 +1,52 @@
import { describe, expect, it } from "vitest";
import { spawn } from "node:child_process";
import path from "node:path";
import process from "node:process";
import { afterEach, describe, expect, it } from "vitest";
import { withEnvAsync } from "../test-utils/env.js";
import { attachChildProcessBridge } from "./child-process-bridge.js";
import { runCommandWithTimeout, shouldSpawnWithShell } from "./exec.js";
const CHILD_READY_TIMEOUT_MS = 4_000;
const CHILD_EXIT_TIMEOUT_MS = 4_000;
function waitForLine(
stream: NodeJS.ReadableStream,
timeoutMs = CHILD_READY_TIMEOUT_MS,
): Promise<string> {
return new Promise((resolve, reject) => {
let buffer = "";
const timeout = setTimeout(() => {
cleanup();
reject(new Error("timeout waiting for line"));
}, timeoutMs);
const onData = (chunk: Buffer | string): void => {
buffer += chunk.toString();
const idx = buffer.indexOf("\n");
if (idx >= 0) {
const line = buffer.slice(0, idx).trim();
cleanup();
resolve(line);
}
};
const onError = (err: unknown): void => {
cleanup();
reject(err);
};
const cleanup = (): void => {
clearTimeout(timeout);
stream.off("data", onData);
stream.off("error", onError);
};
stream.on("data", onData);
stream.on("error", onError);
});
}
describe("runCommandWithTimeout", () => {
it("never enables shell execution (Windows cmd.exe injection hardening)", () => {
expect(
@@ -56,16 +101,16 @@ describe("runCommandWithTimeout", () => {
"let count = 0;",
'const ticker = setInterval(() => { process.stdout.write(".");',
"count += 1;",
"if (count === 4) {",
"if (count === 2) {",
"clearInterval(ticker);",
"process.exit(0);",
"}",
"}, 60);",
"}, 40);",
].join(" "),
],
{
timeoutMs: 5_000,
noOutputTimeoutMs: 250,
noOutputTimeoutMs: 500,
},
);
@@ -73,7 +118,7 @@ describe("runCommandWithTimeout", () => {
expect(result.code ?? 0).toBe(0);
expect(result.termination).toBe("exit");
expect(result.noOutputTimedOut).toBe(false);
expect(result.stdout.length).toBeGreaterThanOrEqual(5);
expect(result.stdout.length).toBeGreaterThanOrEqual(3);
});
it("reports global timeout termination when overall timeout elapses", async () => {
@@ -89,3 +134,64 @@ describe("runCommandWithTimeout", () => {
expect(result.code).not.toBe(0);
});
});
describe("attachChildProcessBridge", () => {
const children: Array<{ kill: (signal?: NodeJS.Signals) => boolean }> = [];
const detachments: Array<() => void> = [];
afterEach(() => {
for (const detach of detachments) {
try {
detach();
} catch {
// ignore
}
}
detachments.length = 0;
for (const child of children) {
try {
child.kill("SIGKILL");
} catch {
// ignore
}
}
children.length = 0;
});
it("forwards SIGTERM to the wrapped child", async () => {
const childPath = path.resolve(process.cwd(), "test/fixtures/child-process-bridge/child.js");
const beforeSigterm = new Set(process.listeners("SIGTERM"));
const child = spawn(process.execPath, [childPath], {
stdio: ["ignore", "pipe", "inherit"],
env: process.env,
});
const { detach } = attachChildProcessBridge(child);
detachments.push(detach);
children.push(child);
const afterSigterm = process.listeners("SIGTERM");
const addedSigterm = afterSigterm.find((listener) => !beforeSigterm.has(listener));
if (!child.stdout) {
throw new Error("expected stdout");
}
const ready = await waitForLine(child.stdout);
expect(ready).toBe("ready");
if (!addedSigterm) {
throw new Error("expected SIGTERM listener");
}
addedSigterm("SIGTERM");
await new Promise<void>((resolve, reject) => {
const timeout = setTimeout(
() => reject(new Error("timeout waiting for child exit")),
CHILD_EXIT_TIMEOUT_MS,
);
child.once("exit", () => {
clearTimeout(timeout);
resolve();
});
});
});
});