Skip to content

test: make the provider-option E2E hermetic #3301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lidge-jun merged 1 commit into from
Sep 2, 2026
Merged

test: make the provider-option E2E hermetic #3301

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 39 additions & 1 deletion tests/fixtures/openai-provider-option-migration-child.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,16 @@ mkdirSync(codexHome, { recursive: true, mode: 0o700 });
process.env.OPENCODEX_HOME = opencodexHome;
process.env.CODEX_HOME = codexHome;

const ACL_OK = { success: true, exitCode: 0, timedOut: false, stdout: "" };
const PRINCIPAL_OK = {
success: true,
exitCode: 0,
timedOut: false,
stdout: "S-1-5-21-1-2-3-1001\nocx-provider-option-migration\n",
};
let aclSeamCalls = 0;
let principalSeamCalls = 0;

const forward = {
adapter: "openai-responses",
baseUrl: "https://chatgpt.com/backend-api/codex",
Expand Down Expand Up @@ -80,11 +90,30 @@ writeFileSync(v1BackupPath, v1Sentinel, { mode: 0o600 });
chmodSync(configPath, 0o600);
chmodSync(v1BackupPath, 0o600);

const [configModule, startupModule, migrationModule] = await Promise.all([
const [configModule, configPaths, startupModule, migrationModule, windowsAcl, windowsPrincipal] = await Promise.all([
import("../../src/config"),
import("../../src/config/paths"),
import("../../src/providers/openai-tier-startup"),
import("../../src/providers/openai-tiers"),
import("../../src/lib/windows-secret-acl"),
import("../../src/lib/windows-user-principal"),
]);
windowsAcl.setIcaclsRunnerForTests(() => {
aclSeamCalls += 1;
return ACL_OK;
});
windowsAcl.setAsyncIcaclsRunnerForTests(async () => {
aclSeamCalls += 1;
return ACL_OK;
});
windowsPrincipal.setWindowsPrincipalRunnerForTests(() => {
principalSeamCalls += 1;
return PRINCIPAL_OK;
});
windowsPrincipal.setAsyncWindowsPrincipalRunnerForTests(async () => {
principalSeamCalls += 1;
return PRINCIPAL_OK;
});
const warnings: string[] = [];
const originalWarn = console.warn;
console.warn = message => { warnings.push(String(message)); };
Expand Down Expand Up @@ -161,12 +190,14 @@ try {
&& relevantWarnings.every(warning => warning === "[openai-provider-migration] providerContextCaps.openai + providerContextCaps.openai-multi: kept lower positive cap");

process.stdout.write(JSON.stringify({
aclSeamCalls,
backupMatchesOriginal: backupBytes === original,
backupMode: statSync(v2BackupPath).mode & 0o777,
v1BackupUnchanged: readFileSync(v1BackupPath, "utf8") === v1Sentinel,
firstProviderIds: Object.keys(first.providers),
firstDefaultProvider: first.defaultProvider,
mode: first.providers.openai?.codexAccountMode,
principalSeamCalls,
hiddenLegacy: !Object.hasOwn(first.providers, "openai-multi") && !Object.hasOwn(first.providers, "chatgpt"),
marker: first.openaiProviderTierVersion,
selectedModels: first.providers.openai?.selectedModels,
Expand All @@ -193,4 +224,11 @@ try {
}) + "\n");
} finally {
console.warn = originalWarn;
await configPaths.flushConfigDirHardeningForTests();
windowsAcl.setIcaclsRunnerForTests(null);
windowsAcl.setAsyncIcaclsRunnerForTests(null);
windowsAcl.resetHardenedStateForTests();
windowsPrincipal.setWindowsPrincipalRunnerForTests(null);
windowsPrincipal.setAsyncWindowsPrincipalRunnerForTests(null);
windowsPrincipal.resetWindowsPrincipalForTests();
}
64 changes: 62 additions & 2 deletions tests/openai-provider-option-e2e.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,14 @@ type Capture = {
};

type MigrationReceipt = {
aclSeamCalls: number;
backupMatchesOriginal: boolean;
backupMode: number;
v1BackupUnchanged: boolean;
firstProviderIds: string[];
firstDefaultProvider: string;
mode: string;
principalSeamCalls: number;
hiddenLegacy: boolean;
marker: number;
selectedModels: string[];
Expand All @@ -50,6 +52,14 @@ type MigrationReceipt = {
collisionFailsBeforeSave: boolean;
};

const ACL_OK = { success: true, exitCode: 0, timedOut: false, stdout: "" };
const PRINCIPAL_OK = {
success: true,
exitCode: 0,
timedOut: false,
stdout: "S-1-5-21-1-2-3-1001\nocx-provider-option-e2e\n",
};

function hashTree(path: string): string {
const hash = createHash("sha256");
if (!existsSync(path)) return hash.update("absent").digest("hex");
Expand Down Expand Up @@ -122,8 +132,12 @@ describe("OpenAI provider-option integration spine", () => {
CLAUDE_CONFIG_DIR: process.env.CLAUDE_CONFIG_DIR,
};
const savedFetch = globalThis.fetch;
const savedWebSocket = globalThis.WebSocket;
const blockedUpstreamWebSocketUrls: string[] = [];
const captures: Capture[] = [];
const resets: Array<() => void> = [];
let aclSeamCalls = 0;
let principalSeamCalls = 0;
let loopbackOrigin: string | null = null;
let server: { url: URL; stop(closeActiveConnections?: boolean): Promise<void> } | null = null;

Expand Down Expand Up @@ -162,6 +176,13 @@ describe("OpenAI provider-option integration spine", () => {
}) + "\n", { mode: 0o600 });
chmodSync(authPath, 0o600);

globalThis.WebSocket = new Proxy(savedWebSocket, {
construct(_target, args) {
const url = String(args[0]);
blockedUpstreamWebSocketUrls.push(url);
throw new Error(`deny-by-default WebSocket blocked: ${url}`);
},
}) as typeof WebSocket;
globalThis.fetch = (async (input, init) => {
const request = new Request(input, init);
const url = new URL(request.url);
Expand Down Expand Up @@ -231,6 +252,8 @@ describe("OpenAI provider-option integration spine", () => {
serverModule,
mainAccount,
sidecar,
windowsAcl,
windowsPrincipal,
] = await Promise.all([
import("../src/config"),
import("../src/providers/derive"),
Expand All @@ -245,8 +268,27 @@ describe("OpenAI provider-option integration spine", () => {
import("../src/server"),
import("../src/codex/main-account"),
import("../src/providers/openai-sidecar"),
import("../src/lib/windows-secret-acl"),
import("../src/lib/windows-user-principal"),
]);

windowsAcl.setIcaclsRunnerForTests(() => {
aclSeamCalls += 1;
return ACL_OK;
});
windowsAcl.setAsyncIcaclsRunnerForTests(async () => {
aclSeamCalls += 1;
return ACL_OK;
});
windowsPrincipal.setWindowsPrincipalRunnerForTests(() => {
principalSeamCalls += 1;
return PRINCIPAL_OK;
});
windowsPrincipal.setAsyncWindowsPrincipalRunnerForTests(async () => {
principalSeamCalls += 1;
return PRINCIPAL_OK;
});

resets.push(
requestLog.clearRequestLogsForTests,
catalog.resetCatalogRuntimeStateForTests,
Expand All @@ -258,6 +300,12 @@ describe("OpenAI provider-option integration spine", () => {
websocketRegistry.clearCodexWebSocketRegistry,
() => authApi.clearAccountNeedsReauth("fixture-pool"),
() => authApi.clearAccountNeedsReauth(mainAccount.MAIN_CODEX_ACCOUNT_ID),
() => windowsAcl.setIcaclsRunnerForTests(null),
() => windowsAcl.setAsyncIcaclsRunnerForTests(null),
windowsAcl.resetHardenedStateForTests,
() => windowsPrincipal.setWindowsPrincipalRunnerForTests(null),
() => windowsPrincipal.setAsyncWindowsPrincipalRunnerForTests(null),
windowsPrincipal.resetWindowsPrincipalForTests,
);

const seed = (id: string) => deriveModule.providerConfigSeed(
Expand Down Expand Up @@ -351,10 +399,9 @@ describe("OpenAI provider-option integration spine", () => {
expect(captures.at(-1)).toMatchObject({ authorization: "Bearer fixture-pool-access", accountId: "fixture-pool-account" });
expect(captures.at(-1)?.body.reasoning).toBeUndefined();

const NativeWebSocket = globalThis.WebSocket;
const expectedWsUrl = new URL("/v1/responses", server.url);
expectedWsUrl.protocol = "ws:";
const ws = new NativeWebSocket(expectedWsUrl, {
const ws = new savedWebSocket(expectedWsUrl, {
headers: { authorization: "Bearer fixture-caller-main" },
} as unknown as string[]);
await new Promise<void>((resolve, reject) => {
Expand Down Expand Up @@ -542,12 +589,14 @@ describe("OpenAI provider-option integration spine", () => {
expect(exitCode).toBe(0);
const receipt = JSON.parse(stdout) as MigrationReceipt;
expect(receipt).toEqual({
aclSeamCalls: expect.any(Number),
backupMatchesOriginal: true,
backupMode: expect.any(Number),
v1BackupUnchanged: true,
firstProviderIds: ["openai", "openai-apikey", "custom"],
firstDefaultProvider: "openai",
mode: "pool",
principalSeamCalls: expect.any(Number),
hiddenLegacy: true,
marker: 2,
selectedModels: ["gpt-5.6-sol", "gpt-5.6-terra", "gpt-5.6-luna"],
Expand All @@ -566,11 +615,21 @@ describe("OpenAI provider-option integration spine", () => {
});
if (process.platform !== "win32") {
expect(receipt.backupMode).toBe(0o600);
} else {
expect(receipt.aclSeamCalls).toBeGreaterThan(0);
expect(receipt.principalSeamCalls).toBeGreaterThan(0);
}
} finally {
removeTreeWithRetry(migrationRoot);
}

expect(new Set(blockedUpstreamWebSocketUrls)).toEqual(new Set([
"wss://chatgpt.com/backend-api/codex/responses",
]));
if (process.platform === "win32") {
expect(aclSeamCalls).toBeGreaterThan(0);
expect(principalSeamCalls).toBeGreaterThan(0);
}
expect(captures.every(capture => upstreamTuples.has(`${capture.method} ${capture.url}`))).toBe(true);
const evidenceDir = process.env.OCX_EVIDENCE_DIR;
if (evidenceDir) {
Expand All @@ -595,6 +654,7 @@ describe("OpenAI provider-option integration spine", () => {
if (server) await server.stop(true);
} finally {
globalThis.fetch = savedFetch;
globalThis.WebSocket = savedWebSocket;
for (const reset of resets) reset();
restoreEnv("OPENCODEX_HOME", previousEnv.OPENCODEX_HOME);
restoreEnv("CODEX_HOME", previousEnv.CODEX_HOME);
Expand Down
Loading