Add Windows test in CI (#666)

* Add Windows test in CI

* Fix CLI test in Windows

* Resolve local Windows paths better

Author: drwpow

.github/workflows/pull_request.yml

@@ -3,13 +3,6 @@ name: branch
 on: [pull_request]
 
 jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
-      - run: npm ci
-      - run: npm run build
   lint:
     runs-on: ubuntu-latest
     steps:
@@ -18,10 +11,11 @@ jobs:
       - run: npm ci
       - run: npm run lint
   test:
-    runs-on: ubuntu-latest
     strategy:
       matrix:
         node-version: [12.x, 14.x, 16.x]
+        os: [ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2

package-lock.json

@@ -61,6 +61,7 @@
     "mime": "^2.5.2",
     "node-fetch": "^2.6.1",
     "prettier": "^2.3.1",
+    "slash": "^3.0.0",
     "tiny-glob": "^0.2.9"
   },
   "devDependencies": {

package.json

@@ -2,6 +2,7 @@ import fs from "fs";
 import path from "path";
 import { URL } from "url";
 import fetch, { Headers } from "node-fetch";
+import slash from "slash";
 import mime from "mime";
 import yaml from "js-yaml";
 import { GlobalContext } from "./types";
@@ -36,7 +37,9 @@ export function resolveSchema(url: string): URL {
   }
 
   // option 2: local
-  const localPath = path.isAbsolute(url) ? new URL("", `file://${url}`) : new URL(url, `file://${process.cwd()}/`); // if absolute path is provided use that; otherwise search cwd\
+  const localPath = path.isAbsolute(url)
+    ? new URL("", `file://${slash(url)}`)
+    : new URL(url, `file://${slash(process.cwd())}/`); // if absolute path is provided use that; otherwise search cwd\
   if (!fs.existsSync(localPath)) {
     throw new Error(`Could not locate ${url}`);
   } else if (fs.statSync(localPath).isDirectory()) {
@@ -108,7 +111,9 @@ export default async function load(schemaURL: URL, options: LoadOptions): Promis
     if (refURL) {
       // load $refs (only if new) and merge subschemas with top-level schema
       const nextURL =
-        refURL.startsWith("http://") || refURL.startsWith("https://") ? new URL(refURL) : new URL(refURL, schemaURL);
+        refURL.startsWith("http://") || refURL.startsWith("https://")
+          ? new URL(refURL)
+          : new URL(slash(refURL), schemaURL);
       refPromises.push(
         load(nextURL, options).then((subschemas) => {
           for (const subschemaURL of Object.keys(subschemas)) {

src/load.ts

@@ -1,50 +1,51 @@
 import fs from "fs";
 import path from "path";
 import { execSync } from "child_process";
+import { sanitizeLB } from "../test-utils";
 
 // Note(drew): OpenAPI support is already well-tested in v2/index.test.ts and
 // v3/index.test.ts. So this file is mainly for testing other flags.
 
+const cmd = `node ../../bin/cli.js`;
+
 describe("cli", () => {
   it("--prettier-config (JSON)", async () => {
-    execSync(
-      `../../bin/cli.js specs/petstore.yaml -o generated/prettier-json.ts --prettier-config fixtures/.prettierrc`,
-      { cwd: __dirname }
-    );
+    execSync(`${cmd} specs/petstore.yaml -o generated/prettier-json.ts --prettier-config fixtures/.prettierrc`, {
+      cwd: __dirname,
+    });
     const [generated, expected] = await Promise.all([
       fs.promises.readFile(path.join(__dirname, "generated", "prettier-json.ts"), "utf8"),
       fs.promises.readFile(path.join(__dirname, "expected", "prettier-json.ts"), "utf8"),
     ]);
-    expect(generated).toBe(expected);
+    expect(generated).toBe(sanitizeLB(expected));
   });
 
   it("--prettier-config (.js)", async () => {
-    execSync(
-      `../../bin/cli.js specs/petstore.yaml -o generated/prettier-js.ts --prettier-config fixtures/prettier.config.js`,
-      { cwd: __dirname }
-    );
+    execSync(`${cmd} specs/petstore.yaml -o generated/prettier-js.ts --prettier-config fixtures/prettier.config.js`, {
+      cwd: __dirname,
+    });
     const [generated, expected] = await Promise.all([
       fs.promises.readFile(path.join(__dirname, "generated", "prettier-js.ts"), "utf8"),
       fs.promises.readFile(path.join(__dirname, "expected", "prettier-js.ts"), "utf8"),
     ]);
-    expect(generated).toBe(expected);
+    expect(generated).toBe(sanitizeLB(expected));
   });
 
   it("stdout", async () => {
     const expected = fs.readFileSync(path.join(__dirname, "expected", "stdout.ts"), "utf8");
-    const generated = execSync(`../../bin/cli.js specs/petstore.yaml`, { cwd: __dirname });
-    expect(generated.toString("utf8")).toBe(expected);
+    const generated = execSync(`${cmd} specs/petstore.yaml`, { cwd: __dirname });
+    expect(generated.toString("utf8")).toBe(sanitizeLB(expected));
   });
 
   it("supports glob paths", async () => {
-    execSync(`../../bin/cli.js "specs/*.yaml" -o generated/`, { cwd: __dirname }); // Quotes are necessary because shells like zsh treats glob weirdly
+    execSync(`${cmd} "specs/*.yaml" -o generated/`, { cwd: __dirname }); // Quotes are necessary because shells like zsh treats glob weirdly
     const [generatedPetstore, expectedPetstore, generatedManifold, expectedManifold] = await Promise.all([
       fs.promises.readFile(path.join(__dirname, "generated", "specs", "petstore.ts"), "utf8"),
       fs.promises.readFile(path.join(__dirname, "expected", "petstore.ts"), "utf8"),
       fs.promises.readFile(path.join(__dirname, "generated", "specs", "manifold.ts"), "utf8"),
       fs.promises.readFile(path.join(__dirname, "expected", "manifold.ts"), "utf8"),
     ]);
-    expect(generatedPetstore).toBe(expectedPetstore);
-    expect(generatedManifold).toBe(expectedManifold);
+    expect(generatedPetstore).toBe(sanitizeLB(expectedPetstore));
+    expect(generatedManifold).toBe(sanitizeLB(expectedManifold));
   });
 });

tests/bin/cli.test.ts

@@ -0,0 +1,3 @@
+export function sanitizeLB(code: string): string {
+  return code.replace(/\r\n/g, "\n");
+}

tests/test-utils.ts

@@ -1,7 +1,9 @@
 import { execSync } from "child_process";
 import fs from "fs";
 import path from "path";
+import { sanitizeLB } from "../test-utils";
 
+const cmd = `node ../../bin/cli.js`;
 const schemas = fs.readdirSync(path.join(__dirname, "specs"));
 
 // simple snapshot tests with valid schemas to make sure it can generally parse & generate output
@@ -10,43 +12,40 @@ describe("cli", () => {
     const output = schema.replace(".yaml", ".ts");
 
     it(`reads ${schema} spec (v2) from file`, async () => {
-      execSync(`../../bin/cli.js specs/${schema} -o generated/${output} --prettier-config .prettierrc`, {
+      execSync(`${cmd} specs/${schema} -o generated/${output} --prettier-config .prettierrc`, {
         cwd: __dirname,
       });
       const [generated, expected] = await Promise.all([
         fs.promises.readFile(path.join(__dirname, "generated", output), "utf8"),
         fs.promises.readFile(path.join(__dirname, "expected", output), "utf8"),
       ]);
-      expect(generated).toBe(expected);
+      expect(generated).toBe(sanitizeLB(expected));
     });
 
     it(`reads ${schema} spec (v2) from file (immutable types)`, async () => {
       const output = schema.replace(".yaml", ".immutable.ts");
 
-      execSync(
-        `../../bin/cli.js specs/${schema} -o generated/${output} --prettier-config .prettierrc --immutable-types`,
-        {
-          cwd: __dirname,
-        }
-      );
+      execSync(`${cmd} specs/${schema} -o generated/${output} --prettier-config .prettierrc --immutable-types`, {
+        cwd: __dirname,
+      });
 
       const [generated, expected] = await Promise.all([
         fs.promises.readFile(path.join(__dirname, "generated", output), "utf8"),
         fs.promises.readFile(path.join(__dirname, "expected", output), "utf8"),
       ]);
-      expect(generated).toBe(expected);
+      expect(generated).toBe(sanitizeLB(expected));
     });
   });
 
   it("reads spec (v2) from remote resource", async () => {
     execSync(
-      "../../bin/cli.js https://raw.githubusercontent.com/drwpow/openapi-typescript/main/tests/v2/specs/manifold.yaml -o generated/http.ts",
+      `${cmd} https://raw.githubusercontent.com/drwpow/openapi-typescript/main/tests/v2/specs/manifold.yaml -o generated/http.ts`,
       { cwd: __dirname }
     );
     const [generated, expected] = await Promise.all([
       fs.promises.readFile(path.join(__dirname, "generated", "http.ts"), "utf8"),
       fs.promises.readFile(path.join(__dirname, "expected", "http.ts"), "utf8"),
     ]);
-    expect(generated).toBe(expected);
+    expect(generated).toBe(sanitizeLB(expected));
   });
 });