Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
127 changes: 127 additions & 0 deletions e2e/tests/api/features/sbom-delete.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
import { expect, test } from "../fixtures";
import {
deleteSboms,
getFullSbomPaths,
uploadFiles,
} from "../helpers/general-helpers";
import { logger } from "../../common/constants";

// SBOMs to upload
const sbomDir = "tests/common/assets/sbom";

const sbomSingle = ["cnv-4.17-product-older.json.bz2"];

const sbomsMultiple = [
"cnv-4.17-index-older.json.bz2",
"cnv-4.17-binary-1-older.json.bz2",
"cnv-4.17-binary-2-older.json.bz2",
"cnv-4.17-product-latest.json.bz2",
"cnv-4.17-index-latest.json.bz2",
"cnv-4.17-binary-1-latest.json.bz2",
"cnv-4.17-binary-2-latest.json.bz2",
];

test.describe("SBOM / Delete", () => {
test.describe.configure({ mode: "serial" });

const sbomIdsDelete: string[] = [];

test.afterAll(async ({ axios }) => {
await deleteSboms(axios, sbomIdsDelete);
});

test("Single existing SBOM", async ({ axios }) => {
const fullSbomPaths = getFullSbomPaths(sbomDir, sbomSingle);
const sbomIdSingle = await uploadFiles(axios, "sbom", fullSbomPaths);
sbomIdsDelete.push(...sbomIdSingle);

// Delete the SBOM
const response = await axios.delete(
`/api/v3/sbom/${encodeURIComponent(sbomIdSingle[0])}`,
);
if (response.status !== 204) {
logger.error(
`Delete single existing SBOM failed with status ${response.status}:`,
response.data,
);
}
expect(response.status).toBe(204);

// Verify that the SBOM is deleted
const getResponse = await axios.get(
`/api/v3/sbom/${encodeURIComponent(sbomIdSingle[0])}`,
{ validateStatus: null },
);
expect(getResponse.status).toBe(404);
});

test("Multiple existing SBOMs", async ({ axios }) => {
const fullSbomPaths = getFullSbomPaths(sbomDir, sbomsMultiple);
const sbomIdsMultiple = await uploadFiles(axios, "sbom", fullSbomPaths);
sbomIdsDelete.push(...sbomIdsMultiple);

const response = await axios.delete("/api/v3/sbom", {
data: sbomIdsMultiple,
});
if (response.status !== 204) {
logger.error(
`Delete multiple existing SBOMs failed with status ${response.status}:`,
response.data,
);
}
expect(response.status).toBe(204);

// Verify that all SBOMs are deleted
for (const id of sbomIdsMultiple) {
const getResponse = await axios.get(
`/api/v3/sbom/${encodeURIComponent(id)}`,
{ validateStatus: null },
);
expect(getResponse.status).toBe(404);
}
});

test("Single non-existent SBOM", async ({ axios }) => {
const nonExistentId = Array.from(
{ length: 45 },
() =>
"abcdefghijklmnopqrstuvwxyz0123456789"[Math.floor(Math.random() * 36)],
).join("");

const response = await axios.delete(
`/api/v3/sbom/${encodeURIComponent(nonExistentId)}`,
{ validateStatus: null },
);
if (response.status !== 204) {
logger.error(
`Delete single non-existent SBOM failed with status ${response.status}:`,
response.data,
);
}
expect(response.status).toBe(204);
});
Comment on lines +84 to +102

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (testing): Avoid randomness for non-existent IDs to keep tests deterministic and reproducible

Using Math.random here makes failures hard to reproduce and, in rare cases, could even generate a valid ID. In e2e tests it’s preferable to use a fixed clearly invalid ID pattern (e.g. "nonexistent-sbom-id-...") or a seeded deterministic generator so runs remain predictable while still exercising the "non-existent" path.

Suggested change
test("Single non-existent SBOM", async ({ axios }) => {
const nonExistentId = Array.from({ length: 45 }, () =>
"abcdefghijklmnopqrstuvwxyz0123456789"[Math.floor(Math.random() * 36)],
).join("");
const response = await axios.delete(
`/api/v3/sbom/${encodeURIComponent(nonExistentId)}`,
{ validateStatus: null },
);
if (response.status !== 404) {
logger.error(
`Delete single non-existent SBOM failed with status ${response.status}:`,
response.data,
);
}
expect(response.status).toBe(404);
});
test("Single non-existent SBOM", async ({ axios }) => {
// Use a fixed clearly invalid ID to keep the test deterministic and reproducible
const nonExistentId = "nonexistent-sbom-id-should-return-404";
const response = await axios.delete(
`/api/v3/sbom/${encodeURIComponent(nonExistentId)}`,
{ validateStatus: null },
);
if (response.status !== 404) {
logger.error(
`Delete single non-existent SBOM failed with status ${response.status}:`,
response.data,
);
}
expect(response.status).toBe(404);
});


test("Multiple non-existent SBOMs", async ({ axios }) => {
const nonExistentIds = Array.from({ length: 7 }, () =>
Array.from(
{ length: 45 },
() =>
"abcdefghijklmnopqrstuvwxyz0123456789"[
Math.floor(Math.random() * 36)
],
).join(""),
);

const response = await axios.delete("/api/v3/sbom", {
data: nonExistentIds,
validateStatus: null,
});
if (response.status !== 204) {
logger.error(
`Delete multiple non-existent SBOMs failed with status ${response.status}:`,
response.data,
);
}
expect(response.status).toBe(204);
});
});
File renamed without changes.
Loading