cli.test.ts

import { execa } from "execa";
import fs from "node:fs";
import os from "node:os";
import { fileURLToPath } from "node:url";
import stripAnsi from "strip-ansi";
import type { TestCase } from "./test-helpers.js";

const root = new URL("../", import.meta.url);
const cwd = os.platform() === "win32" ? fileURLToPath(root) : root; // execa bug: fileURLToPath required on Windows
const cmd = "./bin/cli.js";
const TIMEOUT = 90_000;

describe("CLI", () => {
  const tests: TestCase<any, any>[] = [
    [
      "snapshot > GitHub API",
      {
        given: ["./examples/github-api.yaml"],
        want: new URL("./examples/github-api.ts", root),
        ci: { timeout: TIMEOUT },
      },
    ],
    [
      "snapshot > GitHub API (immutable)",
      {
        given: ["./examples/github-api.yaml", "--immutable"],
        want: new URL("./examples/github-api-immutable.ts", root),
        ci: { timeout: TIMEOUT },
      },
    ],
    [
      "snapshot > GitHub API (types + immutable)",
      {
        given: ["./examples/github-api.yaml", "--immutable", "--export-type"],
        want: new URL("./examples/github-api-export-type-immutable.ts", root),
        ci: { timeout: TIMEOUT },
      },
    ],
    [
      "snapshot > GitHub API (root types)",
      {
        given: ["./examples/github-api.yaml", "--root-types"],
        want: new URL("./examples/github-api-root-types.ts", root),
        ci: { timeout: TIMEOUT },
      },
    ],
    [
      "snapshot > GitHub API (next)",
      {
        given: ["./examples/github-api-next.yaml"],
        want: new URL("./examples/github-api-next.ts", root),
        ci: { timeout: TIMEOUT },
      },
    ],
    [
      "snapshot > Octokit GHES 3.6 Diff to API",
      {
        given: ["./examples/octokit-ghes-3.6-diff-to-api.json"],
        want: new URL("./examples/octokit-ghes-3.6-diff-to-api.ts", root),
        ci: { timeout: TIMEOUT },
      },
    ],
    [
      "snapshot > Stripe API",
      {
        given: ["./examples/stripe-api.yaml"],
        want: new URL("./examples/stripe-api.ts", root),
        ci: { timeout: TIMEOUT },
      },
    ],
    [
      "snapshot > DigitalOcean",
      {
        given: ["./examples/digital-ocean-api/DigitalOcean-public.v2.yaml"],
        want: new URL("./examples/digital-ocean-api.ts", root),
        ci: { timeout: TIMEOUT },
      },
    ],
  ];

  for (const [testName, { given, want, ci }] of tests) {
    test.skipIf(ci?.skipIf)(
      testName,
      async () => {
        const { stdout } = await execa(cmd, given, { cwd });
        if (want instanceof URL) {
          expect(stdout).toMatchFileSnapshot(fileURLToPath(want));
        } else {
          expect(stdout).toBe(`${want}\n`);
        }
      },
      ci?.timeout,
    );
  }

  test(
    "stdin",
    async () => {
      const input = fs.readFileSync(new URL("./examples/stripe-api.yaml", root));
      const { stdout } = await execa(cmd, { input, cwd });
      expect(stdout).toMatchFileSnapshot(fileURLToPath(new URL("./examples/stripe-api.ts", root)));
    },
    TIMEOUT,
  );

  describe("flags", () => {
    test("--help", async () => {
      const { stdout } = await execa(cmd, ["--help"], { cwd });
      expect(stdout).toEqual(expect.stringMatching(/^Usage\n\s+\$ openapi-typescript \[input\] \[options\]/));
    });

    test("--version", async () => {
      const { stdout } = await execa(cmd, ["--version"], { cwd });
      expect(stdout).toEqual(expect.stringMatching(/^v[\d.]+(-.*)?$/));
    });

    test(
      "--properties-required-by-default",
      async () => {
        const { stdout } = await execa(cmd, ["--properties-required-by-default=true", "./examples/github-api.yaml"], {
          cwd,
        });
        expect(stdout).toMatchFileSnapshot(fileURLToPath(new URL("./examples/github-api-required.ts", root)));
      },
      TIMEOUT,
    );
  });

  describe("Redocly config", () => {
    test.skipIf(os.platform() === "win32")("automatic config", async () => {
      const cwd = new URL("./fixtures/redocly/", import.meta.url);

      await execa("../../../bin/cli.js", {
        cwd: fileURLToPath(cwd),
      });
      for (const schema of ["a", "b", "c"]) {
        expect(fs.readFileSync(new URL(`./output/${schema}.ts`, cwd), "utf8")).toMatchFileSnapshot(
          fileURLToPath(new URL("../../../examples/simple-example.ts", cwd)),
        );
      }
    });

    test("--redocly config", async () => {
      await execa(cmd, ["--redocly", "test/fixtures/redocly-flag/redocly.yaml"], {
        cwd,
      });
      for (const schema of ["a", "b", "c"]) {
        expect(
          fs.readFileSync(new URL(`./test/fixtures/redocly-flag/output/${schema}.ts`, root), "utf8"),
        ).toMatchFileSnapshot(fileURLToPath(new URL("./examples/simple-example.ts", root)));
      }
    });

    test.skipIf(os.platform() === "win32")("lint error", async () => {
      const cwd = new URL("./fixtures/redocly-lint-error", import.meta.url);

      try {
        await execa("../../../bin/cli.js", {
          cwd: fileURLToPath(cwd),
        });
        throw new Error("Linting should have thrown an error");
      } catch (err) {
        expect(stripAnsi(String(err))).toMatch(/✘ {2}Servers must be present/);
      }
    });
  });
});