update the e2e cleanup script to also delete container images (#9939)

Author: dario-piotrowicz

pnpm-lock.yaml

@@ -1,3 +1,5 @@
+import assert from "node:assert";
+import { spawnSync } from "node:child_process";
 import { fetch } from "undici";
 import type { RequestInit, Response } from "undici";
 
@@ -288,3 +290,70 @@ export const listCertificates = async () => {
 export const deleteCertificate = async (id: string) => {
 	await apiFetch(`/mtls_certificates/${id}`, "DELETE");
 };
+
+// Note: the container images functions below don't directly use the REST API since
+//       they interact with the cloudflare images registry which has it's own
+//       non-trivial auth mechanism, so instead of duplicating a bunch of logic
+//       here we instead directly call wrangler
+//
+// TODO: Consider if it would make sense for all the functions here to use wrangler
+//       directly, what is the advantage of hitting the REST API directly?
+
+export const listE2eContainerImages = () => {
+	const output = runWranglerCommand("wrangler containers images list", {
+		// This operation can take literally minutes to run...
+		timeout: 3 * 60_000,
+	}).stdout;
+
+	return output
+		.split("\n")
+		.map((line) => {
+			const match = line.match(
+				/^(?<imageName>tmp-e2e-worker[a-z0-9-]+)\s+tmp-e2e$/
+			);
+			if (!match?.groups) {
+				return null;
+			}
+
+			return { name: match.groups.imageName, tag: "tmp-e2e" };
+		})
+		.filter(Boolean) as { name: string; tag: string }[];
+};
+
+export const deleteContainerImage = (image: { name: string; tag: string }) => {
+	const run = runWranglerCommand(
+		`wrangler containers images delete ${image.name}:${image.tag}`
+	);
+
+	return run.status === 0;
+};
+
+function runWranglerCommand(
+	wranglerCommand: string,
+	{ timeout = 10_000 } = {}
+) {
+	// Enforce a `wrangler` prefix to make commands clearer to read
+	assert(
+		wranglerCommand.startsWith("wrangler "),
+		"Commands must start with `wrangler` (e.g. `wrangler dev`) but got " +
+			wranglerCommand
+	);
+
+	const { status, stdout, stderr, output } = spawnSync(
+		"pnpm",
+		[wranglerCommand],
+		{
+			shell: true,
+			stdio: "pipe",
+			encoding: "utf8",
+			timeout,
+		}
+	);
+
+	return {
+		status,
+		stdout,
+		stderr,
+		output: output.filter((line) => line !== null).join("\n"),
+	};
+}

tools/e2e/common.ts

@@ -1,12 +1,14 @@
 import {
 	deleteCertificate,
 	deleteContainerApplication,
+	deleteContainerImage,
 	deleteDatabase,
 	deleteHyperdriveConfig,
 	deleteKVNamespace,
 	deleteProject,
 	deleteWorker,
 	listCertificates,
+	listE2eContainerImages,
 	listHyperdriveConfigs,
 	listTmpDatabases,
 	listTmpE2EContainerApplications,
@@ -34,6 +36,24 @@ run().catch((e) => {
 async function run() {
 	// KV namespaces don't have a creation timestamp, but deletion will fail if there is a worker bound to it
 	// so delete these first to avoid interrupting running e2e jobs (unless you are very very unlucky)
+	await deleteKVNamespaces();
+
+	await deleteProjects();
+
+	await deleteWorkers();
+
+	await deleteD1Databases();
+
+	await deleteHyperdriveConfigs();
+
+	await deleteMtlsCertificates();
+
+	await deleteContainerApplications();
+
+	deleteContainerImages();
+}
+
+async function deleteKVNamespaces() {
 	const kvNamespacesToDelete = await listTmpKVNamespaces();
 	for (const kvNamespace of kvNamespacesToDelete) {
 		console.log("Deleting KV namespace: " + kvNamespace.title);
@@ -45,7 +65,9 @@ async function run() {
 	if (kvNamespacesToDelete.length === 0) {
 		console.log(`No KV namespaces to delete.`);
 	}
+}
 
+async function deleteProjects() {
 	const projectsToDelete = await listTmpE2EProjects();
 
 	for (const project of projectsToDelete) {
@@ -58,7 +80,24 @@ async function run() {
 	if (projectsToDelete.length === 0) {
 		console.log(`No projects to delete.`);
 	}
+}
+
+function deleteContainerImages() {
+	const containerImagesToDelete = listE2eContainerImages();
+
+	for (const image of containerImagesToDelete) {
+		console.log("Deleting Container image: " + image.name + ":" + image.tag);
+		deleteContainerImage(image)
+			? console.log(`Successfully deleted project ${image.name}:${image.tag}`)
+			: console.log(`Successfully deleted project ${image.name}:${image.tag}`);
+	}
+
+	if (containerImagesToDelete.length === 0) {
+		console.log(`No container image to delete.`);
+	}
+}
 
+async function deleteWorkers() {
 	const workersToDelete = await listTmpE2EWorkers();
 
 	for (const worker of workersToDelete) {
@@ -71,8 +110,11 @@ async function run() {
 	if (workersToDelete.length === 0) {
 		console.log(`No workers to delete.`);
 	}
+}
 
+async function deleteD1Databases() {
 	const d1DatabasesToDelete = await listTmpDatabases();
+
 	for (const db of d1DatabasesToDelete) {
 		console.log("Deleting D1 database: " + db.name);
 		(await deleteDatabase(db.uuid))
@@ -82,7 +124,9 @@ async function run() {
 	if (d1DatabasesToDelete.length === 0) {
 		console.log(`No D1 databases to delete.`);
 	}
+}
 
+async function deleteHyperdriveConfigs() {
 	const hyperdriveConfigsToDelete = await listHyperdriveConfigs();
 	for (const config of hyperdriveConfigsToDelete) {
 		console.log("Deleting Hyperdrive configs: " + config.id);
@@ -94,7 +138,9 @@ async function run() {
 	if (hyperdriveConfigsToDelete.length === 0) {
 		console.log(`No Hyperdrive configs to delete.`);
 	}
+}
 
+async function deleteMtlsCertificates() {
 	const mtlsCertificates = await listCertificates();
 	for (const certificate of mtlsCertificates) {
 		console.log("Deleting mTLS certificate: " + certificate.id);
@@ -107,7 +153,9 @@ async function run() {
 			`Successfully deleted ${mtlsCertificates.length} mTLS certificates`
 		);
 	}
+}
 
+async function deleteContainerApplications() {
 	const containers = await listTmpE2EContainerApplications();
 	for (const container of containers) {
 		await deleteContainerApplication(container);

tools/e2e/e2eCleanup.ts

@@ -15,6 +15,7 @@
 		"@typescript-eslint/parser": "^6.9.0",
 		"find-up": "^6.3.0",
 		"ts-dedent": "^2.2.0",
-		"undici": "catalog:default"
+		"undici": "catalog:default",
+		"wrangler": "workspace:*"
 	}
 }