Skip to content

OpenAI's Codex Security CLI and TypeScript SDK for finding, validating, and fixing security vulnerabilities. npm: https://www.npmjs.com/package/@openai/codex-security

test(sdk): isolate sparse package archive cases (#2003)

Michael D'Angelob65405ccc5ca
diff --git a/sdk/typescript/tests-ts/package-tar-listing.test.ts b/sdk/typescript/tests-ts/package-tar-listing.test.ts
index 138fcf7dc..490d4be1c 100644
--- a/sdk/typescript/tests-ts/package-tar-listing.test.ts
+++ b/sdk/typescript/tests-ts/package-tar-listing.test.ts
@@ -886,232 +886,235 @@ describe("npm package tar listings", () => {
}
});
- test("checks reconstructed sparse binary assets and their discarded metadata", async () => {
- const root = mkdtempSync(join(tmpdir(), "codex-package-sparse-assets-"));
- try {
- const logo = readFileSync(
- new URL(
- "../../../plugins/codex-security/assets/logo.png",
- import.meta.url,
- ),
- );
- const oldGnuText = Buffer.alloc(32 * 1024);
- const oldGnuExtents = Array.from({ length: 32 }, (_, index) => {
- oldGnuText.write("Public contents.", index * 1024);
- return { offset: index * 1024, size: 512 };
- });
- oldGnuExtents.push({ offset: oldGnuText.length, size: 0 });
- const unicodeCompressedPayload = Buffer.from(cleanCompressedPayload);
- Buffer.from("😀").copy(
- unicodeCompressedPayload,
- unicodeCompressedPayload.indexOf("Go/w") - 4,
- );
- const leadingMarker = cleanCompressedPayload.indexOf("Go/w");
- expect(leadingMarker).toBeGreaterThan(0);
- const repositoryCompressedPayload = Buffer.from(cleanCompressedPayload);
- const repositoryMarker = Buffer.from(
- ["github.com", "openai", "openai"].join("/"),
- );
- repositoryMarker.copy(repositoryCompressedPayload, 300);
- const repositoryMarkerEnd = 300 + repositoryMarker.length;
- expect(
- brotliDecompressSync(repositoryCompressedPayload).toString("utf8"),
- ).toMatch(/^[A-Za-z0-9]+$/u);
- const middle = Math.floor(cleanCompressedPayload.length / 2);
- const cases = [
- {
- name: "brotli",
- files: [["runtime.mjs.br", cleanCompressedPayload, true]],
- },
- {
- name: "unicode-brotli",
- files: [["runtime.mjs.br", unicodeCompressedPayload, true]],
- },
- {
- name: "sparse-brotli-leading-delimiter",
- files: [
- [
- "runtime.mjs.br.part-000",
- cleanCompressedPayload.subarray(0, leadingMarker),
- false,
- ],
- [
- "runtime.mjs.br.part-001",
- cleanCompressedPayload.subarray(leadingMarker),
- true,
- ],
+ describe("reconstructed sparse binary assets and discarded metadata", () => {
+ const logo = readFileSync(
+ new URL(
+ "../../../plugins/codex-security/assets/logo.png",
+ import.meta.url,
+ ),
+ );
+ const oldGnuText = Buffer.alloc(32 * 1024);
+ const oldGnuExtents = Array.from({ length: 32 }, (_, index) => {
+ oldGnuText.write("Public contents.", index * 1024);
+ return { offset: index * 1024, size: 512 };
+ });
+ oldGnuExtents.push({ offset: oldGnuText.length, size: 0 });
+ const unicodeCompressedPayload = Buffer.from(cleanCompressedPayload);
+ Buffer.from("😀").copy(
+ unicodeCompressedPayload,
+ unicodeCompressedPayload.indexOf("Go/w") - 4,
+ );
+ const leadingMarker = cleanCompressedPayload.indexOf("Go/w");
+ const repositoryCompressedPayload = Buffer.from(cleanCompressedPayload);
+ const repositoryMarker = Buffer.from(
+ ["github.com", "openai", "openai"].join("/"),
+ );
+ repositoryMarker.copy(repositoryCompressedPayload, 300);
+ const repositoryMarkerEnd = 300 + repositoryMarker.length;
+ const middle = Math.floor(cleanCompressedPayload.length / 2);
+ const cases = [
+ {
+ name: "brotli",
+ files: [["runtime.mjs.br", cleanCompressedPayload, true]],
+ },
+ {
+ name: "unicode-brotli",
+ files: [["runtime.mjs.br", unicodeCompressedPayload, true]],
+ },
+ {
+ name: "sparse-brotli-leading-delimiter",
+ checkFixture: () => expect(leadingMarker).toBeGreaterThan(0),
+ files: [
+ [
+ "runtime.mjs.br.part-000",
+ cleanCompressedPayload.subarray(0, leadingMarker),
+ false,
],
- },
- {
- name: "sparse-brotli-trailing-delimiter",
- files: [
- [
- "runtime.mjs.br.part-000",
- repositoryCompressedPayload.subarray(0, repositoryMarkerEnd),
- true,
- ],
- [
- "runtime.mjs.br.part-001",
- repositoryCompressedPayload.subarray(repositoryMarkerEnd),
- false,
- ],
+ [
+ "runtime.mjs.br.part-001",
+ cleanCompressedPayload.subarray(leadingMarker),
+ true,
],
- },
- {
- name: "mixed-split-brotli",
- files: [
- [
- "runtime.mjs.br.part-000",
- cleanCompressedPayload.subarray(0, middle),
- true,
- ],
- [
- "runtime.mjs.br.part-001",
- cleanCompressedPayload.subarray(middle),
- false,
- ],
+ ],
+ },
+ {
+ name: "sparse-brotli-trailing-delimiter",
+ checkFixture: () =>
+ expect(
+ brotliDecompressSync(repositoryCompressedPayload).toString("utf8"),
+ ).toMatch(/^[A-Za-z0-9]+$/u),
+ files: [
+ [
+ "runtime.mjs.br.part-000",
+ repositoryCompressedPayload.subarray(0, repositoryMarkerEnd),
+ true,
],
- },
- {
- name: "mixed-sparse-split-tail",
- files: [
- [
- "runtime.mjs.br.part-000",
- cleanCompressedPayload.subarray(0, middle),
- true,
- ],
- [
- "runtime.mjs.br.part-001",
- cleanCompressedPayload.subarray(middle),
- "0.1-tail",
- ],
+ [
+ "runtime.mjs.br.part-001",
+ repositoryCompressedPayload.subarray(repositoryMarkerEnd),
+ false,
],
- error: "npm tarball contains trailing Brotli data",
- },
- { name: "png", files: [["logo.png", logo, true]] },
- {
- name: "pax-sparse-zero-byte-hole-png",
- files: [["logo.png", logo, "0.1-hole"]],
- error: "npm tarball contains an unexpected PNG asset",
- },
- {
- name: "pax-sparse-zero-byte-hole-tail",
- files: [["logo.png", logo, "0.1-hole"]],
- tailMarker: true,
- error:
- /npm tarball contains (?:an internal reference\.|an invalid tar entry)/u,
- },
- {
- name: "oldgnu-brotli",
- files: [["runtime.mjs.br", cleanCompressedPayload, "oldgnu"]],
- error: "npm tarball contains an invalid tar entry",
- },
- {
- name: "oldgnu-png",
- files: [["logo.png", logo, "oldgnu"]],
- error: "npm tarball contains an invalid tar entry",
- },
- {
- name: "oldgnu-continuations",
- files: [["helpers.mjs", oldGnuText, "oldgnu"]],
- extents: oldGnuExtents,
- },
- {
- name: "oldgnu-unused-main-slot",
- files: [["runtime.mjs.br", cleanCompressedPayload, "oldgnu"]],
- metadataMarker: "unused",
- error: "npm tarball contains an invalid tar entry",
- },
- {
- name: "oldgnu-unused-continuation-slot",
- files: [["helpers.mjs", oldGnuText, "oldgnu"]],
- extents: oldGnuExtents,
- metadataMarker: "unused",
- },
- {
- name: "oldgnu-continuation-marker",
- files: [["helpers.mjs", oldGnuText, "oldgnu"]],
- extents: oldGnuExtents,
- metadataMarker: "continuation",
- error: "npm tarball contains an internal reference.",
- },
- {
- name: "oldgnu-metadata-boundary-marker",
- files: [["helpers.mjs", oldGnuText, "oldgnu"]],
- extents: oldGnuExtents,
- metadataMarker: "boundary",
- error: "npm tarball contains an internal reference.",
- },
- {
- name: "oldgnu-text-body-boundary-marker",
- files: [
- ["helpers.mjs", Buffer.from("synthetic-reference\n"), "oldgnu"],
+ ],
+ },
+ {
+ name: "mixed-split-brotli",
+ files: [
+ [
+ "runtime.mjs.br.part-000",
+ cleanCompressedPayload.subarray(0, middle),
+ true,
],
- metadataMarker: "boundary",
- error: "npm tarball contains an internal reference.",
- },
- {
- name: "global-sparse-keys",
- files: [["runtime.mjs.br", cleanCompressedPayload, false]],
- globalSparse: true,
- },
- {
- name: "expanded-marker",
- files: [
- [
- "runtime.mjs.br",
- brotliCompressSync(Buffer.from("go/synthetic-reference")),
- true,
- ],
+ [
+ "runtime.mjs.br.part-001",
+ cleanCompressedPayload.subarray(middle),
+ false,
],
- error: "npm tarball contains an internal reference.",
- },
- {
- name: "sparse-header-map-boundary-marker",
- files: [["runtime.mjs.br", cleanCompressedPayload, "1.0"]],
- headerMapMarker: true,
- error: "npm tarball contains an internal reference.",
- },
- {
- name: "sparse-tail-header-boundary-marker",
- files: [
- ["runtime.mjs.br", cleanCompressedPayload, "1.0"],
- ["extra.mjs", Buffer.from("Public contents."), false],
+ ],
+ },
+ {
+ name: "mixed-sparse-split-tail",
+ files: [
+ [
+ "runtime.mjs.br.part-000",
+ cleanCompressedPayload.subarray(0, middle),
+ true,
],
- tailBoundaryMarker: true,
- error:
- /npm tarball contains (?:an internal reference\.|an invalid tar entry:)/u,
- },
- {
- name: "map-padding-marker",
- files: [["runtime.mjs.br", cleanCompressedPayload, "1.0"]],
- mapMarker: true,
- error: "npm tarball contains an internal reference.",
- },
- {
- name: "discarded-tail-marker",
- files: [["logo.png", logo, "1.0"]],
- tailMarker: true,
- error:
- /npm tarball contains (?:an internal reference\.|an invalid tar entry:)/u,
- },
- ] satisfies {
- name: string;
+ [
+ "runtime.mjs.br.part-001",
+ cleanCompressedPayload.subarray(middle),
+ "0.1-tail",
+ ],
+ ],
+ error: "npm tarball contains trailing Brotli data",
+ },
+ { name: "png", files: [["logo.png", logo, true]] },
+ {
+ name: "pax-sparse-zero-byte-hole-png",
+ files: [["logo.png", logo, "0.1-hole"]],
+ error: "npm tarball contains an unexpected PNG asset",
+ },
+ {
+ name: "pax-sparse-zero-byte-hole-tail",
+ files: [["logo.png", logo, "0.1-hole"]],
+ tailMarker: true,
+ error:
+ /npm tarball contains (?:an internal reference\.|an invalid tar entry)/u,
+ },
+ {
+ name: "oldgnu-brotli",
+ files: [["runtime.mjs.br", cleanCompressedPayload, "oldgnu"]],
+ error: "npm tarball contains an invalid tar entry",
+ },
+ {
+ name: "oldgnu-png",
+ files: [["logo.png", logo, "oldgnu"]],
+ error: "npm tarball contains an invalid tar entry",
+ },
+ {
+ name: "oldgnu-continuations",
+ files: [["helpers.mjs", oldGnuText, "oldgnu"]],
+ extents: oldGnuExtents,
+ },
+ {
+ name: "oldgnu-unused-main-slot",
+ files: [["runtime.mjs.br", cleanCompressedPayload, "oldgnu"]],
+ metadataMarker: "unused",
+ error: "npm tarball contains an invalid tar entry",
+ },
+ {
+ name: "oldgnu-unused-continuation-slot",
+ files: [["helpers.mjs", oldGnuText, "oldgnu"]],
+ extents: oldGnuExtents,
+ metadataMarker: "unused",
+ },
+ {
+ name: "oldgnu-continuation-marker",
+ files: [["helpers.mjs", oldGnuText, "oldgnu"]],
+ extents: oldGnuExtents,
+ metadataMarker: "continuation",
+ error: "npm tarball contains an internal reference.",
+ },
+ {
+ name: "oldgnu-metadata-boundary-marker",
+ files: [["helpers.mjs", oldGnuText, "oldgnu"]],
+ extents: oldGnuExtents,
+ metadataMarker: "boundary",
+ error: "npm tarball contains an internal reference.",
+ },
+ {
+ name: "oldgnu-text-body-boundary-marker",
+ files: [
+ ["helpers.mjs", Buffer.from("synthetic-reference\n"), "oldgnu"],
+ ],
+ metadataMarker: "boundary",
+ error: "npm tarball contains an internal reference.",
+ },
+ {
+ name: "global-sparse-keys",
+ files: [["runtime.mjs.br", cleanCompressedPayload, false]],
+ globalSparse: true,
+ },
+ {
+ name: "expanded-marker",
+ files: [
+ [
+ "runtime.mjs.br",
+ brotliCompressSync(Buffer.from("go/synthetic-reference")),
+ true,
+ ],
+ ],
+ error: "npm tarball contains an internal reference.",
+ },
+ {
+ name: "sparse-header-map-boundary-marker",
+ files: [["runtime.mjs.br", cleanCompressedPayload, "1.0"]],
+ headerMapMarker: true,
+ error: "npm tarball contains an internal reference.",
+ },
+ {
+ name: "sparse-tail-header-boundary-marker",
files: [
- string,
- Buffer,
- boolean | "1.0" | "0.1-tail" | "0.1-hole" | "oldgnu",
- ][];
- extents?: { offset: number; size: number }[];
- metadataMarker?: "continuation" | "boundary" | "unused";
- globalSparse?: boolean;
- mapMarker?: boolean;
- headerMapMarker?: boolean;
- tailMarker?: boolean;
- tailBoundaryMarker?: boolean;
- error?: string | RegExp;
- }[];
- for (const scenario of cases) {
+ ["runtime.mjs.br", cleanCompressedPayload, "1.0"],
+ ["extra.mjs", Buffer.from("Public contents."), false],
+ ],
+ tailBoundaryMarker: true,
+ error:
+ /npm tarball contains (?:an internal reference\.|an invalid tar entry:)/u,
+ },
+ {
+ name: "map-padding-marker",
+ files: [["runtime.mjs.br", cleanCompressedPayload, "1.0"]],
+ mapMarker: true,
+ error: "npm tarball contains an internal reference.",
+ },
+ {
+ name: "discarded-tail-marker",
+ files: [["logo.png", logo, "1.0"]],
+ tailMarker: true,
+ error:
+ /npm tarball contains (?:an internal reference\.|an invalid tar entry:)/u,
+ },
+ ] satisfies {
+ name: string;
+ checkFixture?: () => void;
+ files: [
+ string,
+ Buffer,
+ boolean | "1.0" | "0.1-tail" | "0.1-hole" | "oldgnu",
+ ][];
+ extents?: { offset: number; size: number }[];
+ metadataMarker?: "continuation" | "boundary" | "unused";
+ globalSparse?: boolean;
+ mapMarker?: boolean;
+ headerMapMarker?: boolean;
+ tailMarker?: boolean;
+ tailBoundaryMarker?: boolean;
+ error?: string | RegExp;
+ }[];
+ test.each(cases)("$name", async (scenario) => {
+ scenario.checkFixture?.();
+ const root = mkdtempSync(join(tmpdir(), "codex-package-sparse-assets-"));
+ try {
const records = scenario.files.map(([name, contents, sparse]) => {
const path = `package/_bundled_plugin/${name}`;
if (!sparse) return tarRecord(contents, { name: path });
@@ -1248,24 +1251,17 @@ describe("npm package tar listings", () => {
environment,
);
if (scenario.error) {
- expect({ scenario: scenario.name, status: result.status }).toEqual({
- scenario: scenario.name,
- status: 1,
- });
+ expect(result.status, result.stderr).toBe(1);
if (typeof scenario.error === "string")
expect(result.stderr).toContain(scenario.error);
else expect(result.stderr).toMatch(scenario.error);
} else {
- expect({
- scenario: scenario.name,
- status: result.status,
- stderr: result.stderr,
- }).toEqual({ scenario: scenario.name, status: 0, stderr: "" });
+ expect(result).toEqual({ status: 0, stderr: "" });
}
+ } finally {
+ rmSync(root, { force: true, recursive: true });
}
- } finally {
- rmSync(root, { force: true, recursive: true });
- }
+ });
});
test.each([0x78, 0x67])(