wrangler 0.0.0-e928f94 → 0.0.0-e978986

package/src/__tests__/index.test.ts

@@ -1,153 +1,256 @@
-import * as fs from "node:fs";
-import * as fsp from "node:fs/promises";
-import * as path from "node:path";
-import * as TOML from "@iarna/toml";
-import { main } from "../index";
-// @ts-expect-error we're mocking cfetch, so of course setMock isn't a thing
-import { setMock, unsetAllMocks } from "../cfetch";
-
-jest.mock("../cfetch", () => {
-  return jest.requireActual("./mock-cfetch");
-});
+import { getPackageManager } from "../package-manager";
+import { mockConsoleMethods } from "./helpers/mock-console";
+import { runInTempDir } from "./helpers/run-in-tmp";
+import { runWrangler } from "./helpers/run-wrangler";
+import { writeWorkerSource } from "./helpers/write-worker-source";
+import writeWranglerToml from "./helpers/write-wrangler-toml";
+import type { PackageManager } from "../package-manager";
 
-async function w(cmd: void | string, options?: { tap: boolean }) {
-  const tapped = options?.tap ? tap() : undefined;
-  await main([...(cmd ? cmd.split(" ") : [])]);
-  tapped?.off();
-  return { stdout: tapped?.out, stderr: tapped?.err };
-}
+describe("wrangler", () => {
+  let mockPackageManager: PackageManager;
+  runInTempDir();
 
-function tap() {
-  const oldLog = console.log;
-  const oldError = console.error;
-
-  const toReturn = {
-    off: () => {
-      console.log = oldLog;
-      console.error = oldError;
-    },
-    out: "",
-    err: "",
-  };
-
-  console.log = (...args) => {
-    toReturn.out += args.join("");
-    oldLog.apply(console, args);
-    // console.trace(...args); // use this if you want to find the true source of your console.log
-  };
-  console.error = (...args) => {
-    toReturn.err += args.join("");
-    oldError.apply(console, args);
-  };
-
-  return toReturn;
-}
+  beforeEach(() => {
+    mockPackageManager = {
+      cwd: process.cwd(),
+      // @ts-expect-error we're making a fake package manager here
+      type: "mockpm",
+      addDevDeps: jest.fn(),
+      install: jest.fn(),
+    };
+    (getPackageManager as jest.Mock).mockResolvedValue(mockPackageManager);
+  });
 
-describe("wrangler", () => {
-  it("should run", async () => {
-    const { stdout } = await w(undefined, { tap: true });
-
-    expect(stdout).toMatchInlineSnapshot(`
-      "wrangler
-
-      Commands:
-        wrangler init [name]       📥 Create a wrangler.toml configuration file
-        wrangler dev <filename>    👂 Start a local server for developing your worker
-        wrangler publish [script]  🆙 Publish your Worker to Cloudflare.
-        wrangler tail [name]       🦚 Starts a log tailing session for a deployed Worker.
-        wrangler secret            🤫 Generate a secret that can be referenced in the worker script
-        wrangler kv:namespace      🗂️  Interact with your Workers KV Namespaces
-        wrangler kv:key            🔑 Individually manage Workers KV key-value pairs
-        wrangler kv:bulk           💪 Interact with multiple Workers KV key-value pairs at once
-        wrangler pages             ⚡️ Configure Cloudflare Pages
-
-      Flags:
-        -c, --config   Path to .toml configuration file  [string]
-        -h, --help     Show help  [boolean]
-        -v, --version  Show version number  [boolean]
-
-      Options:
-        -l, --local  Run on my machine  [boolean] [default: false]"
-    `);
+  const std = mockConsoleMethods();
+
+  describe("no command", () => {
+    it("should display a list of available commands", async () => {
+      await runWrangler();
+
+      expect(std.out).toMatchInlineSnapshot(`
+        "wrangler
+
+        Commands:
+          wrangler init [name]       📥 Create a wrangler.toml configuration file
+          wrangler dev [script]      👂 Start a local server for developing your worker
+          wrangler publish [script]  🆙 Publish your Worker to Cloudflare.
+          wrangler tail [name]       🦚 Starts a log tailing session for a published Worker.
+          wrangler secret            🤫 Generate a secret that can be referenced in the worker script
+          wrangler kv:namespace      🗂️  Interact with your Workers KV Namespaces
+          wrangler kv:key            🔑 Individually manage Workers KV key-value pairs
+          wrangler kv:bulk           💪 Interact with multiple Workers KV key-value pairs at once
+          wrangler pages             ⚡️ Configure Cloudflare Pages
+          wrangler r2                📦 Interact with an R2 store
+          wrangler login             🔓 Login to Cloudflare
+          wrangler logout            🚪 Logout from Cloudflare
+          wrangler whoami            🕵️  Retrieve your user info and test your auth config
+
+        Flags:
+          -c, --config   Path to .toml configuration file  [string]
+          -h, --help     Show help  [boolean]
+          -v, --version  Show version number  [boolean]"
+      `);
+
+      expect(std.err).toMatchInlineSnapshot(`""`);
+    });
   });
 
-  describe("init", () => {
-    const ogcwd = process.cwd();
+  describe("invalid command", () => {
+    it("should display an error", async () => {
+      await expect(
+        runWrangler("invalid-command")
+      ).rejects.toThrowErrorMatchingInlineSnapshot(
+        `"Unknown argument: invalid-command"`
+      );
 
-    beforeEach(() => {
-      process.chdir(path.join(__dirname, "fixtures", "init"));
+      expect(std.out).toMatchInlineSnapshot(`
+        "
+        wrangler
+
+        Commands:
+          wrangler init [name]       📥 Create a wrangler.toml configuration file
+          wrangler dev [script]      👂 Start a local server for developing your worker
+          wrangler publish [script]  🆙 Publish your Worker to Cloudflare.
+          wrangler tail [name]       🦚 Starts a log tailing session for a published Worker.
+          wrangler secret            🤫 Generate a secret that can be referenced in the worker script
+          wrangler kv:namespace      🗂️  Interact with your Workers KV Namespaces
+          wrangler kv:key            🔑 Individually manage Workers KV key-value pairs
+          wrangler kv:bulk           💪 Interact with multiple Workers KV key-value pairs at once
+          wrangler pages             ⚡️ Configure Cloudflare Pages
+          wrangler r2                📦 Interact with an R2 store
+          wrangler login             🔓 Login to Cloudflare
+          wrangler logout            🚪 Logout from Cloudflare
+          wrangler whoami            🕵️  Retrieve your user info and test your auth config
+
+        Flags:
+          -c, --config   Path to .toml configuration file  [string]
+          -h, --help     Show help  [boolean]
+          -v, --version  Show version number  [boolean]"
+      `);
+      expect(std.err).toMatchInlineSnapshot(`
+        "X [ERROR] Unknown argument: invalid-command
+
+        "
+      `);
     });
+  });
 
-    afterEach(async () => {
-      await fsp.rm("./wrangler.toml");
-      process.chdir(ogcwd);
+  describe("preview", () => {
+    it("should throw an error if the deprecated command is used with positional arguments", async () => {
+      await expect(runWrangler("preview GET")).rejects
+        .toThrowErrorMatchingInlineSnapshot(`
+              "Deprecation:
+              The \`wrangler preview\` command has been deprecated.
+              Try using \`wrangler dev\` to to try out a worker during development.
+              "
+            `);
+      await expect(runWrangler(`preview GET "SomeBody"`)).rejects
+        .toThrowErrorMatchingInlineSnapshot(`
+              "Deprecation:
+              The \`wrangler preview\` command has been deprecated.
+              Try using \`wrangler dev\` to to try out a worker during development.
+              "
+            `);
     });
+  });
+
+  describe("subcommand implicit help ran on incomplete command execution", () => {
+    it("no subcommand for 'secret' should display a list of available subcommands", async () => {
+      await runWrangler("secret");
+      await endEventLoop();
+      expect(std.out).toMatchInlineSnapshot(`
+        "wrangler secret
+
+        🤫 Generate a secret that can be referenced in the worker script
 
-    it("should create a wrangler.toml", async () => {
-      await w("init");
-      const parsed = TOML.parse(await fsp.readFile("./wrangler.toml", "utf-8"));
-      expect(typeof parsed.compatibility_date).toBe("string");
+        Commands:
+          wrangler secret put <key>     Create or update a secret variable for a script
+          wrangler secret delete <key>  Delete a secret variable from a script
+          wrangler secret list          List all secrets for a script
+
+        Flags:
+          -c, --config   Path to .toml configuration file  [string]
+          -h, --help     Show help  [boolean]
+          -v, --version  Show version number  [boolean]"
+      `);
     });
 
-    it("should error when wrangler.toml already exists", async () => {
-      fs.closeSync(fs.openSync("./wrangler.toml", "w"));
-      const { stderr } = await w("init", { tap: true });
-      expect(stderr.endsWith("wrangler.toml already exists.")).toBe(true);
+    it("no subcommand 'kv:namespace' should display a list of available subcommands", async () => {
+      await runWrangler("kv:namespace");
+      await endEventLoop();
+      expect(std.out).toMatchInlineSnapshot(`
+        "wrangler kv:namespace
+
+        🗂️  Interact with your Workers KV Namespaces
+
+        Commands:
+          wrangler kv:namespace create <namespace>  Create a new namespace
+          wrangler kv:namespace list                Outputs a list of all KV namespaces associated with your account id.
+          wrangler kv:namespace delete              Deletes a given namespace.
+
+        Flags:
+          -c, --config   Path to .toml configuration file  [string]
+          -h, --help     Show help  [boolean]
+          -v, --version  Show version number  [boolean]"
+      `);
     });
-  });
 
-  describe("kv:namespace", () => {
-    afterAll(() => {
-      unsetAllMocks();
+    it("no subcommand 'kv:key' should display a list of available subcommands", async () => {
+      await runWrangler("kv:key");
+      await endEventLoop();
+      expect(std.out).toMatchInlineSnapshot(`
+        "wrangler kv:key
+
+        🔑 Individually manage Workers KV key-value pairs
+
+        Commands:
+          wrangler kv:key put <key> [value]  Writes a single key/value pair to the given namespace.
+          wrangler kv:key list               Outputs a list of all keys in a given namespace.
+          wrangler kv:key get <key>          Reads a single value by key from the given namespace.
+          wrangler kv:key delete <key>       Removes a single key value pair from the given namespace.
+
+        Flags:
+          -c, --config   Path to .toml configuration file  [string]
+          -h, --help     Show help  [boolean]
+          -v, --version  Show version number  [boolean]"
+      `);
     });
-    let KVNamespaces: { title: string; id: string }[] = [];
-    it("can create a namespace", async () => {
-      setMock("/accounts/:accountId/storage/kv/namespaces", (uri, init) => {
-        expect(init.method === "POST");
-        const body = JSON.parse(init.body);
-        expect(body.title).toBe("worker-UnitTestNamespace");
-        KVNamespaces.push({ title: body.title, id: "some-namespace-id" });
-        return { id: "some-namespace-id" };
-      });
 
-      await w("kv:namespace create UnitTestNamespace");
-      expect(
-        KVNamespaces.find((ns) => ns.title === `worker-UnitTestNamespace`)
-      ).toBeTruthy();
+    it("no subcommand 'kv:bulk' should display a list of available subcommands", async () => {
+      await runWrangler("kv:bulk");
+      await endEventLoop();
+      expect(std.out).toMatchInlineSnapshot(`
+        "wrangler kv:bulk
+
+        💪 Interact with multiple Workers KV key-value pairs at once
+
+        Commands:
+          wrangler kv:bulk put <filename>     Upload multiple key-value pairs to a namespace
+          wrangler kv:bulk delete <filename>  Delete multiple key-value pairs from a namespace
+
+        Flags:
+          -c, --config   Path to .toml configuration file  [string]
+          -h, --help     Show help  [boolean]
+          -v, --version  Show version number  [boolean]"
+      `);
     });
 
-    let createdNamespace: { id: string; title: string };
-    it("can list namespaces", async () => {
-      setMock(
-        "/accounts/:accountId/storage/kv/namespaces\\?:qs",
-        (uri, init) => {
-          expect(init).toBe(undefined);
-          return KVNamespaces;
-        }
-      );
-      const { stdout } = await w("kv:namespace list", { tap: true });
-      const namespaces = JSON.parse(stdout);
-      createdNamespace = namespaces.find(
-        (ns) => ns.title === "worker-UnitTestNamespace"
-      );
-      expect(createdNamespace.title).toBe("worker-UnitTestNamespace");
+    it("no subcommand 'r2' should display a list of available subcommands", async () => {
+      await runWrangler("r2");
+      await endEventLoop();
+      expect(std.out).toMatchInlineSnapshot(`
+        "wrangler r2
+
+        📦 Interact with an R2 store
+
+        Commands:
+          wrangler r2 bucket  Manage R2 buckets
+
+        Flags:
+          -c, --config   Path to .toml configuration file  [string]
+          -h, --help     Show help  [boolean]
+          -v, --version  Show version number  [boolean]"
+      `);
     });
+  });
 
-    it("can delete a namespace", async () => {
-      const namespaceIdToDelete = createdNamespace.id;
-      setMock(
-        "/accounts/:accountId/storage/kv/namespaces/:namespaceId",
-        (uri, init) => {
-          expect(init.method).toBe("DELETE");
-          KVNamespaces = KVNamespaces.filter(
-            (ns) => ns.id !== namespaceIdToDelete
-          );
-        }
-      );
-      await w(`kv:namespace delete --namespace-id ${namespaceIdToDelete}`);
-      expect(KVNamespaces.find((ns) => ns.id === namespaceIdToDelete)).toBe(
-        undefined
-      );
+  describe("Deprecated commands", () => {
+    it("should print a deprecation message for 'generate'", async () => {
+      await runWrangler("generate").catch((err) => {
+        expect(err.message).toMatchInlineSnapshot(`
+          "Deprecation:
+          \`wrangler generate\` has been deprecated.
+          Try running \`wrangler init\` to generate a basic Worker, or cloning the template repository instead:
+
+          \`\`\`
+          git clone https://github.com/cloudflare/worker-template
+          \`\`\`
+
+          Please refer to https://developers.cloudflare.com/workers/wrangler/deprecations/#generate for more information."
+        `);
+      });
     });
   });
+
+  it("should print a deprecation message for 'build' and then try to run `publish --dry-run --outdir`", async () => {
+    writeWranglerToml({
+      main: "index.js",
+    });
+    writeWorkerSource();
+    await runWrangler("build");
+    await endEventLoop();
+    expect(std.out).toMatchInlineSnapshot(`
+      "▲ [WARNING] Deprecation: \`wrangler build\` has been deprecated.
+
+        Please refer to https://developers.cloudflare.com/workers/wrangler/migration/deprecations/#build for more information.
+        Attempting to run \`wrangler publish --dry-run --outdir=dist\` for you instead:
+
+
+      --dry-run: exiting now."
+    `);
+  });
 });
+
+function endEventLoop() {
+  return new Promise((resolve) => setImmediate(resolve));
+}