wrangler 2.20.0 → 3.0.0

package/src/__tests__/secret.test.ts

@@ -1,693 +0,0 @@
-import * as fs from "node:fs";
-import { writeFileSync } from "node:fs";
-import * as TOML from "@iarna/toml";
-import { rest } from "msw";
-import { mockAccountId, mockApiToken } from "./helpers/mock-account-id";
-import { mockConsoleMethods } from "./helpers/mock-console";
-import { mockConfirm, mockPrompt, clearDialogs } from "./helpers/mock-dialogs";
-import { useMockIsTTY } from "./helpers/mock-istty";
-import { mockGetMembershipsFail } from "./helpers/mock-oauth-flow";
-import { useMockStdin } from "./helpers/mock-stdin";
-import { msw } from "./helpers/msw";
-import { runInTempDir } from "./helpers/run-in-tmp";
-import { runWrangler } from "./helpers/run-wrangler";
-
-function createFetchResult(result: unknown, success = true) {
-	return {
-		success,
-		errors: [],
-		messages: [],
-		result,
-	};
-}
-
-export function mockGetMemberships(
-	accounts: { id: string; account: { id: string; name: string } }[]
-) {
-	msw.use(
-		rest.get("*/memberships", (req, res, ctx) => {
-			return res.once(ctx.json(createFetchResult(accounts)));
-		})
-	);
-}
-
-describe("wrangler secret", () => {
-	const std = mockConsoleMethods();
-	const { setIsTTY } = useMockIsTTY();
-	runInTempDir();
-	mockAccountId();
-	mockApiToken();
-	afterEach(() => {
-		clearDialogs();
-	});
-
-	describe("put", () => {
-		function mockPutRequest(
-			input: { name: string; text: string },
-			env?: string,
-			legacyEnv = false
-		) {
-			const servicesOrScripts = env && !legacyEnv ? "services" : "scripts";
-			const environment = env && !legacyEnv ? "/environments/:envName" : "";
-			msw.use(
-				rest.put(
-					`*/accounts/:accountId/workers/${servicesOrScripts}/:scriptName${environment}/secrets`,
-					async (req, res, ctx) => {
-						expect(req.params.accountId).toEqual("some-account-id");
-						expect(req.params.scriptName).toEqual(
-							legacyEnv && env ? `script-name-${env}` : "script-name"
-						);
-						if (!legacyEnv) {
-							expect(req.params.envName).toEqual(env);
-						}
-						const { name, text, type } = await req.json();
-						expect(type).toEqual("secret_text");
-						expect(name).toEqual(input.name);
-						expect(text).toEqual(input.text);
-
-						return res.once(ctx.json(createFetchResult({ name, type })));
-					}
-				)
-			);
-		}
-
-		describe("interactive", () => {
-			beforeEach(() => {
-				setIsTTY(true);
-			});
-
-			it("should trim stdin secret value", async () => {
-				mockPrompt({
-					text: "Enter a secret value:",
-					options: { isSecret: true },
-					result: `hunter2
-          `,
-				});
-
-				mockPutRequest({ name: `secret-name`, text: `hunter2` });
-				await runWrangler("secret put secret-name --name script-name");
-				expect(std.out).toMatchInlineSnapshot(`
-			"🌀 Creating the secret for the Worker \\"script-name\\"
-			✨ Success! Uploaded secret secret-name"
-		`);
-			});
-
-			it("should create a secret", async () => {
-				mockPrompt({
-					text: "Enter a secret value:",
-					options: { isSecret: true },
-					result: "the-secret",
-				});
-
-				mockPutRequest({ name: "the-key", text: "the-secret" });
-				await runWrangler("secret put the-key --name script-name");
-
-				expect(std.out).toMatchInlineSnapshot(`
-			"🌀 Creating the secret for the Worker \\"script-name\\"
-			✨ Success! Uploaded secret the-key"
-		`);
-				expect(std.err).toMatchInlineSnapshot(`""`);
-			});
-
-			it("should create secret:bulk", async () => {
-				writeFileSync(
-					"secret.json",
-					JSON.stringify({
-						"secret-name-1": "secret_text",
-						"secret-name-2": "secret_text",
-					})
-				);
-
-				// User counter to pass different secrets to the request mock
-				let counter = 0;
-				msw.use(
-					rest.put(
-						`*/accounts/:accountId/workers/scripts/:scriptName/secrets`,
-						(req, res, ctx) => {
-							expect(req.params.accountId).toEqual("some-account-id");
-							counter++;
-
-							return res(
-								ctx.json(
-									createFetchResult({
-										name: `secret-name-${counter}`,
-										type: "secret_text",
-									})
-								)
-							);
-						}
-					)
-				);
-
-				await runWrangler("secret:bulk ./secret.json --name script-name");
-
-				expect(std.out).toMatchInlineSnapshot(`
-			"🌀 Creating the secrets for the Worker \\"script-name\\"
-			✨ Successfully created secret for key: secret-name-1
-			✨ Successfully created secret for key: secret-name-2
-
-			Finished processing secrets JSON file:
-			✨ 2 secrets successfully uploaded"
-		`);
-				expect(std.err).toMatchInlineSnapshot(`""`);
-			});
-
-			it("should handle network failure on secret:bulk", async () => {
-				writeFileSync(
-					"secret.json",
-					JSON.stringify({
-						"secret-name-1": "secret_text",
-						"secret-name-2": "secret_text",
-					})
-				);
-
-				// User counter to pass different secrets to the request mock
-				let counter = 0;
-				msw.use(
-					rest.put(
-						`*/accounts/:accountId/workers/scripts/:scriptName/secrets`,
-						(req, res) => {
-							expect(req.params.accountId).toEqual("some-account-id");
-							counter++;
-
-							return res.networkError(`Failed to create secret ${counter}`);
-						}
-					)
-				);
-
-				await runWrangler("secret:bulk ./secret.json --name script-name");
-
-				expect(std.out).toMatchInlineSnapshot(`
-			"🌀 Creating the secrets for the Worker \\"script-name\\"
-
-			Finished processing secrets JSON file:
-			✨ 0 secrets successfully uploaded
-			🚨 2 secrets failed to upload"
-		`);
-				expect(std.err).toMatchInlineSnapshot(`
-			"X [ERROR] 🚨 Error uploading secret for key: secret-name-1:
-
-			                  request to
-			  https://api.cloudflare.com/client/v4/accounts/some-account-id/workers/scripts/script-name/secrets
-			  failed, reason: Failed to create secret 1
-
-
-			X [ERROR] 🚨 Error uploading secret for key: secret-name-2:
-
-			                  request to
-			  https://api.cloudflare.com/client/v4/accounts/some-account-id/workers/scripts/script-name/secrets
-			  failed, reason: Failed to create secret 2
-
-			"
-		`);
-			});
-
-			it("should count success and network failure on secret:bulk", async () => {
-				writeFileSync(
-					"secret.json",
-					JSON.stringify({
-						"secret-name-1": "secret_text",
-						"secret-name-2": "secret_text",
-						"secret-name-3": "secret_text",
-						"secret-name-4": "secret_text",
-						"secret-name-5": "secret_text",
-						"secret-name-6": "secret_text",
-						"secret-name-7": "secret_text",
-					})
-				);
-
-				// User counter to pass different secrets to the request mock
-				let counter = 0;
-				msw.use(
-					rest.put(
-						`*/accounts/:accountId/workers/scripts/:scriptName/secrets`,
-						(req, res, ctx) => {
-							expect(req.params.accountId).toEqual("some-account-id");
-							counter++;
-
-							if (counter % 2 === 0) {
-								return res(
-									ctx.json(
-										createFetchResult({
-											name: `secret-name-${counter}`,
-											type: "secret_text",
-										})
-									)
-								);
-							} else {
-								return res.networkError(`Failed to create secret ${counter}`);
-							}
-						}
-					)
-				);
-
-				await runWrangler("secret:bulk ./secret.json --name script-name");
-
-				expect(std.out).toMatchInlineSnapshot(`
-			"🌀 Creating the secrets for the Worker \\"script-name\\"
-			✨ Successfully created secret for key: secret-name-2
-			✨ Successfully created secret for key: secret-name-4
-			✨ Successfully created secret for key: secret-name-6
-
-			Finished processing secrets JSON file:
-			✨ 3 secrets successfully uploaded
-			🚨 4 secrets failed to upload"
-		`);
-				expect(std.err).toMatchInlineSnapshot(`
-			"X [ERROR] 🚨 Error uploading secret for key: secret-name-1:
-
-			                  request to
-			  https://api.cloudflare.com/client/v4/accounts/some-account-id/workers/scripts/script-name/secrets
-			  failed, reason: Failed to create secret 1
-
-
-			X [ERROR] 🚨 Error uploading secret for key: secret-name-3:
-
-			                  request to
-			  https://api.cloudflare.com/client/v4/accounts/some-account-id/workers/scripts/script-name/secrets
-			  failed, reason: Failed to create secret 3
-
-
-			X [ERROR] 🚨 Error uploading secret for key: secret-name-5:
-
-			                  request to
-			  https://api.cloudflare.com/client/v4/accounts/some-account-id/workers/scripts/script-name/secrets
-			  failed, reason: Failed to create secret 5
-
-
-			X [ERROR] 🚨 Error uploading secret for key: secret-name-7:
-
-			                  request to
-			  https://api.cloudflare.com/client/v4/accounts/some-account-id/workers/scripts/script-name/secrets
-			  failed, reason: Failed to create secret 7
-
-			"
-		`);
-			});
-
-			it("should create a secret: legacy envs", async () => {
-				mockPrompt({
-					text: "Enter a secret value:",
-					options: { isSecret: true },
-					result: "the-secret",
-				});
-
-				mockPutRequest(
-					{ name: "the-key", text: "the-secret" },
-					"some-env",
-					true
-				);
-				await runWrangler(
-					"secret put the-key --name script-name --env some-env --legacy-env"
-				);
-
-				expect(std.out).toMatchInlineSnapshot(`
-			"🌀 Creating the secret for the Worker \\"script-name-some-env\\"
-			✨ Success! Uploaded secret the-key"
-		`);
-				expect(std.err).toMatchInlineSnapshot(`""`);
-			});
-
-			it("should create a secret: service envs", async () => {
-				mockPrompt({
-					text: "Enter a secret value:",
-					options: { isSecret: true },
-					result: "the-secret",
-				});
-
-				mockPutRequest(
-					{ name: "the-key", text: "the-secret" },
-					"some-env",
-					false
-				);
-				await runWrangler(
-					"secret put the-key --name script-name --env some-env --legacy-env false"
-				);
-
-				expect(std.out).toMatchInlineSnapshot(`
-			"🌀 Creating the secret for the Worker \\"script-name\\" (some-env)
-			✨ Success! Uploaded secret the-key"
-		`);
-				expect(std.err).toMatchInlineSnapshot(`""`);
-			});
-
-			it("should error without a script name", async () => {
-				let error: Error | undefined;
-				try {
-					await runWrangler("secret put the-key");
-				} catch (e) {
-					error = e as Error;
-				}
-				expect(std.out).toMatchInlineSnapshot(`
-			          "
-			          If you think this is a bug then please create an issue at https://github.com/cloudflare/workers-sdk/issues/new/choose"
-		        `);
-				expect(std.err).toMatchInlineSnapshot(`
-			"X [ERROR] Required Worker name missing. Please specify the Worker name in wrangler.toml, or pass it as an argument with \`--name <worker-name>\`
-
-			"
-		`);
-				expect(error).toMatchInlineSnapshot(
-					`[Error: Required Worker name missing. Please specify the Worker name in wrangler.toml, or pass it as an argument with \`--name <worker-name>\`]`
-				);
-			});
-		});
-
-		describe("non-interactive", () => {
-			beforeEach(() => {
-				setIsTTY(false);
-			});
-			const mockStdIn = useMockStdin({ isTTY: false });
-
-			it("should trim stdin secret value, from piped input", async () => {
-				mockPutRequest({ name: "the-key", text: "the-secret" });
-				// Pipe the secret in as three chunks to test that we reconstitute it correctly.
-				mockStdIn.send(
-					`the`,
-					`-`,
-					`secret
-          ` // whitespace & newline being removed
-				);
-				await runWrangler("secret put the-key --name script-name");
-
-				expect(std.out).toMatchInlineSnapshot(`
-			"🌀 Creating the secret for the Worker \\"script-name\\"
-			✨ Success! Uploaded secret the-key"
-		`);
-				expect(std.warn).toMatchInlineSnapshot(`""`);
-				expect(std.err).toMatchInlineSnapshot(`""`);
-			});
-
-			it("should create a secret, from piped input", async () => {
-				mockPutRequest({ name: "the-key", text: "the-secret" });
-				// Pipe the secret in as three chunks to test that we reconstitute it correctly.
-				mockStdIn.send("the", "-", "secret");
-				await runWrangler("secret put the-key --name script-name");
-
-				expect(std.out).toMatchInlineSnapshot(`
-			"🌀 Creating the secret for the Worker \\"script-name\\"
-			✨ Success! Uploaded secret the-key"
-		`);
-				expect(std.warn).toMatchInlineSnapshot(`""`);
-				expect(std.err).toMatchInlineSnapshot(`""`);
-			});
-
-			it("should error if the piped input fails", async () => {
-				mockPutRequest({ name: "the-key", text: "the-secret" });
-				mockStdIn.throwError(new Error("Error in stdin stream"));
-				await expect(
-					runWrangler("secret put the-key --name script-name")
-				).rejects.toThrowErrorMatchingInlineSnapshot(`"Error in stdin stream"`);
-
-				expect(std.out).toMatchInlineSnapshot(`
-			          "
-			          If you think this is a bug then please create an issue at https://github.com/cloudflare/workers-sdk/issues/new/choose"
-		        `);
-				expect(std.warn).toMatchInlineSnapshot(`""`);
-			});
-
-			describe("with accountId", () => {
-				mockAccountId({ accountId: null });
-
-				it("should error if request for memberships fails", async () => {
-					mockGetMembershipsFail();
-					await expect(
-						runWrangler("secret put the-key --name script-name")
-					).rejects.toThrowErrorMatchingInlineSnapshot(
-						`"A request to the Cloudflare API (/memberships) failed."`
-					);
-				});
-
-				it("should error if a user has no account", async () => {
-					mockGetMemberships([]);
-					await expect(runWrangler("secret put the-key --name script-name"))
-						.rejects.toThrowErrorMatchingInlineSnapshot(`
-				                  "Failed to automatically retrieve account IDs for the logged in user.
-				                  In a non-interactive environment, it is mandatory to specify an account ID, either by assigning its value to CLOUDFLARE_ACCOUNT_ID, or as \`account_id\` in your \`wrangler.toml\` file."
-			                `);
-				});
-
-				it("should use the account from wrangler.toml", async () => {
-					fs.writeFileSync(
-						"wrangler.toml",
-						TOML.stringify({
-							account_id: "some-account-id",
-						}),
-						"utf-8"
-					);
-					mockStdIn.send("the-secret");
-					mockPutRequest({ name: "the-key", text: "the-secret" });
-					await runWrangler("secret put the-key --name script-name");
-					expect(std.out).toMatchInlineSnapshot(`
-				"🌀 Creating the secret for the Worker \\"script-name\\"
-				✨ Success! Uploaded secret the-key"
-			`);
-					expect(std.warn).toMatchInlineSnapshot(`""`);
-					expect(std.err).toMatchInlineSnapshot(`""`);
-				});
-
-				it("should error if a user has multiple accounts, and has not specified an account in wrangler.toml", async () => {
-					mockGetMemberships([
-						{
-							id: "1",
-							account: { id: "account-id-1", name: "account-name-1" },
-						},
-						{
-							id: "2",
-							account: { id: "account-id-2", name: "account-name-2" },
-						},
-						{
-							id: "3",
-							account: { id: "account-id-3", name: "account-name-3" },
-						},
-					]);
-
-					await expect(runWrangler("secret put the-key --name script-name"))
-						.rejects.toThrowErrorMatchingInlineSnapshot(`
-				"More than one account available but unable to select one in non-interactive mode.
-				Please set the appropriate \`account_id\` in your \`wrangler.toml\` file.
-				Available accounts are (\`<name>\`: \`<account_id>\`):
-				  \`account-name-1\`: \`account-id-1\`
-				  \`account-name-2\`: \`account-id-2\`
-				  \`account-name-3\`: \`account-id-3\`"
-			`);
-				});
-			});
-		});
-	});
-
-	describe("delete", () => {
-		beforeEach(() => {
-			setIsTTY(true);
-		});
-		function mockDeleteRequest(
-			input: {
-				scriptName: string;
-				secretName: string;
-			},
-			env?: string,
-			legacyEnv = false
-		) {
-			const servicesOrScripts = env && !legacyEnv ? "services" : "scripts";
-			const environment = env && !legacyEnv ? "/environments/:envName" : "";
-			msw.use(
-				rest.delete(
-					`*/accounts/:accountId/workers/${servicesOrScripts}/:scriptName${environment}/secrets/:secretName`,
-					(req, res, ctx) => {
-						expect(req.params.accountId).toEqual("some-account-id");
-						expect(req.params.scriptName).toEqual(
-							legacyEnv && env ? `script-name-${env}` : "script-name"
-						);
-						if (!legacyEnv) {
-							if (env) {
-								expect(req.params.secretName).toEqual(input.secretName);
-							}
-						}
-						return res.once(ctx.json(createFetchResult(null)));
-					}
-				)
-			);
-		}
-
-		it("should delete a secret", async () => {
-			mockDeleteRequest({ scriptName: "script-name", secretName: "the-key" });
-			mockConfirm({
-				text: "Are you sure you want to permanently delete the secret the-key on the Worker script-name?",
-				result: true,
-			});
-			await runWrangler("secret delete the-key --name script-name");
-			expect(std.out).toMatchInlineSnapshot(`
-			"🌀 Deleting the secret the-key on the Worker script-name
-			✨ Success! Deleted secret the-key"
-		`);
-			expect(std.err).toMatchInlineSnapshot(`""`);
-		});
-
-		it("should delete a secret: legacy envs", async () => {
-			mockDeleteRequest(
-				{ scriptName: "script-name", secretName: "the-key" },
-				"some-env",
-				true
-			);
-			mockConfirm({
-				text: "Are you sure you want to permanently delete the secret the-key on the Worker script-name-some-env?",
-				result: true,
-			});
-			await runWrangler(
-				"secret delete the-key --name script-name --env some-env --legacy-env"
-			);
-			expect(std.out).toMatchInlineSnapshot(`
-			"🌀 Deleting the secret the-key on the Worker script-name-some-env
-			✨ Success! Deleted secret the-key"
-		`);
-			expect(std.err).toMatchInlineSnapshot(`""`);
-		});
-
-		it("should delete a secret: service envs", async () => {
-			mockDeleteRequest(
-				{ scriptName: "script-name", secretName: "the-key" },
-				"some-env"
-			);
-			mockConfirm({
-				text: "Are you sure you want to permanently delete the secret the-key on the Worker script-name (some-env)?",
-				result: true,
-			});
-			await runWrangler(
-				"secret delete the-key --name script-name --env some-env --legacy-env false"
-			);
-			expect(std.out).toMatchInlineSnapshot(`
-			"🌀 Deleting the secret the-key on the Worker script-name (some-env)
-			✨ Success! Deleted secret the-key"
-		`);
-			expect(std.err).toMatchInlineSnapshot(`""`);
-		});
-
-		it("should error without a script name", async () => {
-			let error: Error | undefined;
-
-			try {
-				await runWrangler("secret delete the-key");
-			} catch (e) {
-				error = e as Error;
-			}
-			expect(std.out).toMatchInlineSnapshot(`
-			        "
-			        If you think this is a bug then please create an issue at https://github.com/cloudflare/workers-sdk/issues/new/choose"
-		      `);
-			expect(std.err).toMatchInlineSnapshot(`
-			"X [ERROR] Required Worker name missing. Please specify the Worker name in wrangler.toml, or pass it as an argument with \`--name <worker-name>\`
-
-			"
-		`);
-			expect(error).toMatchInlineSnapshot(
-				`[Error: Required Worker name missing. Please specify the Worker name in wrangler.toml, or pass it as an argument with \`--name <worker-name>\`]`
-			);
-		});
-	});
-
-	describe("list", () => {
-		beforeEach(() => {
-			setIsTTY(true);
-		});
-		function mockListRequest(
-			input: { scriptName: string },
-			env?: string,
-			legacyEnv = false
-		) {
-			const servicesOrScripts = env && !legacyEnv ? "services" : "scripts";
-			const environment = env && !legacyEnv ? "/environments/:envName" : "";
-			msw.use(
-				rest.get(
-					`*/accounts/:accountId/workers/${servicesOrScripts}/:scriptName${environment}/secrets`,
-					(req, res, ctx) => {
-						expect(req.params.accountId).toEqual("some-account-id");
-						expect(req.params.scriptName).toEqual(
-							legacyEnv && env ? `script-name-${env}` : "script-name"
-						);
-						if (!legacyEnv) {
-							expect(req.params.envName).toEqual(env);
-						}
-
-						return res.once(
-							ctx.json(
-								createFetchResult([
-									{
-										name: "the-secret-name",
-										type: "secret_text",
-									},
-								])
-							)
-						);
-					}
-				)
-			);
-		}
-
-		it("should list secrets", async () => {
-			mockListRequest({ scriptName: "script-name" });
-			await runWrangler("secret list --name script-name");
-			expect(std.out).toMatchInlineSnapshot(`
-			        "[
-			          {
-			            \\"name\\": \\"the-secret-name\\",
-			            \\"type\\": \\"secret_text\\"
-			          }
-			        ]"
-		      `);
-			expect(std.err).toMatchInlineSnapshot(`""`);
-		});
-
-		it("should list secrets: legacy envs", async () => {
-			mockListRequest({ scriptName: "script-name" }, "some-env", true);
-			await runWrangler(
-				"secret list --name script-name --env some-env --legacy-env"
-			);
-			expect(std.out).toMatchInlineSnapshot(`
-			        "[
-			          {
-			            \\"name\\": \\"the-secret-name\\",
-			            \\"type\\": \\"secret_text\\"
-			          }
-			        ]"
-		      `);
-			expect(std.err).toMatchInlineSnapshot(`""`);
-		});
-
-		it("should list secrets: service envs", async () => {
-			mockListRequest({ scriptName: "script-name" }, "some-env");
-			await runWrangler(
-				"secret list --name script-name --env some-env --legacy-env false"
-			);
-			expect(std.out).toMatchInlineSnapshot(`
-			        "[
-			          {
-			            \\"name\\": \\"the-secret-name\\",
-			            \\"type\\": \\"secret_text\\"
-			          }
-			        ]"
-		      `);
-			expect(std.err).toMatchInlineSnapshot(`""`);
-		});
-
-		it("should error without a script name", async () => {
-			let error: Error | undefined;
-			try {
-				await runWrangler("secret list");
-			} catch (e) {
-				error = e as Error;
-			}
-			expect(std.out).toMatchInlineSnapshot(`
-			        "
-			        If you think this is a bug then please create an issue at https://github.com/cloudflare/workers-sdk/issues/new/choose"
-		      `);
-			expect(std.err).toMatchInlineSnapshot(`
-			"X [ERROR] Required Worker name missing. Please specify the Worker name in wrangler.toml, or pass it as an argument with \`--name <worker-name>\`
-
-			"
-		`);
-			expect(error).toMatchInlineSnapshot(
-				`[Error: Required Worker name missing. Please specify the Worker name in wrangler.toml, or pass it as an argument with \`--name <worker-name>\`]`
-			);
-		});
-	});
-});