chore: add windows to CI (#896)

* chore: add windows to CI

* Use path.join()

* Use jest.js

* Normalize for windows

* Repalce \r

* Ignore some tests on windows

* Update `testMatch`

* Update cli tests

* Add logs

* Use `path.join()`

.github/workflows/ci.yml

@@ -14,7 +14,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, macos-latest]
+        os: [ubuntu-latest, macos-latest, windows-latest]
         node: [14, 16]
     runs-on: ${{ matrix.os }}
     steps:

jest.config.js

@@ -2,5 +2,5 @@ module.exports = {
   collectCoverageFrom: ["src/**/*.js"],
   coverageReporters: ["html", "lcov"],
   testEnvironment: "node",
-  testMatch: ["<rootDir>/test/?(*.)+(spec|test).js?(x)"]
+  testMatch: ["<rootDir>/test/**/*.test.js"]
 };

package.json

@@ -15,8 +15,8 @@
     "build": "node scripts/build.js",
     "build-test-binary": "cd test/binary && node-gyp rebuild && cp build/Release/hello.node ../integration/hello.node",
     "codecov": "codecov",
-    "test": "node --expose-gc --max_old_space_size=4096 node_modules/.bin/jest",
-    "test-coverage": "node --expose-gc --max_old_space_size=4096 node_modules/.bin/jest --coverage --globals \"{\\\"coverage\\\":true}\" && codecov",
+    "test": "node --expose-gc --max_old_space_size=4096 node_modules/jest/bin/jest.js",
+    "test-coverage": "node --expose-gc --max_old_space_size=4096 node_modules/jest/bin/jest.js --coverage --globals \"{\\\"coverage\\\":true}\" && codecov",
     "prepublishOnly": "node scripts/build.js --no-cache"
   },
   "devDependencies": {
@@ -60,7 +60,7 @@
     "hot-shots": "^8.5.0",
     "ioredis": "^4.2.0",
     "isomorphic-unfetch": "^3.0.0",
-    "jest": "^27.4.5",
+    "jest": "^27.5.1",
     "jimp": "^0.16.1",
     "jugglingdb": "2.0.1",
     "koa": "^2.6.2",

src/index.js

@@ -545,7 +545,7 @@ function ncc (
     if (map && sourceMapRegister) {
       const registerExt = esm ? '.cjs' : ext;
       code = (esm ? `import './sourcemap-register${registerExt}';` : `require('./sourcemap-register${registerExt}');`) + code;
-      assets[`sourcemap-register${registerExt}`] = { source: fs.readFileSync(`${__dirname}/sourcemap-register.js.cache.js`), permissions: defaultPermissions };
+      assets[`sourcemap-register${registerExt}`] = { source: fs.readFileSync(join(__dirname, `sourcemap-register.js.cache.js`)), permissions: defaultPermissions };
     }
 
     if (esm && !filename.endsWith('.mjs')) {

test/cli.js

@@ -1,4 +1,6 @@
-[
+const { join } = require('path')
+
+module.exports = [
   {
     args: ["run", "test/fixtures/ts-interop/interop.ts"],
     expect: { code: 0 }
@@ -18,7 +20,7 @@
   {
     args: ["build", "test/integration/test.ts", "-o", "tmp"],
     expect (code, stdout, stderr) {
-      return stdout.toString().indexOf('tmp/index.js') !== -1;
+      return stdout.toString().indexOf(join('tmp', 'index.js')) !== -1;
     }
   },
   {
@@ -71,21 +73,21 @@
   {
     args: ["build", "-o", "tmp", "test/fixtures/test.cjs"],
     expect (code, stdout, stderr) {
-      return stdout.toString().indexOf('tmp/index.cjs') !== -1;
+      return stdout.toString().indexOf(join('tmp', 'index.cjs')) !== -1;
     }
   },
   {
     args: ["build", "-o", "tmp", "test/fixtures/test.mjs"],
     expect (code, stdout, stderr) {
-      return stdout.toString().indexOf('tmp/index.mjs') !== -1;
+      return stdout.toString().indexOf(join('tmp', 'index.mjs')) !== -1;
     }
   },
   {
     args: ["build", "-o", "tmp", "test/fixtures/test.mjs", "--stats-out", "tmp/stats.json"],
     expect (code, stdout, stderr) {
       const fs = require('fs');
       try {
-        JSON.parse(fs.readFileSync('tmp/stats.json', 'utf8'));
+        JSON.parse(fs.readFileSync(join('tmp', 'stats.json'), 'utf8'));
       } catch {
         return false;
       }
@@ -112,7 +114,7 @@
     args: ["build", "-o", "tmp", "test/fixtures/module.cjs"],
     expect (code, stdout) {
       const fs = require('fs');
-      return code === 0 && fs.readFileSync('tmp/index.js', 'utf8').toString().indexOf('export {') === -1;
+      return code === 0 && fs.readFileSync(join('tmp', 'index.js'), 'utf8').toString().indexOf('export {') === -1;
     }
   }
 ]

test/cli.test.js

@@ -1,12 +1,13 @@
-const fs = require("fs");
 const { fork } = require("child_process");
-const coverage = global.coverage;
+const { join } = require("path");
+const cliTests = require("./cli.js");
+const file = global.coverage ? "/../src/cli.js" : "/../dist/ncc/cli.js";
 
 jest.setTimeout(20000);
 
-for (const cliTest of eval(fs.readFileSync(__dirname + "/cli.js").toString())) {
+for (const cliTest of cliTests) {
   it(`should execute "ncc ${(cliTest.args || []).join(" ")}"`, async () => {
-    const ps = fork(__dirname + (coverage ? "/../src/cli.js" : "/../dist/ncc/cli.js"), cliTest.args || [], {
+    const ps = fork(join(__dirname, file), cliTest.args || [], {
       stdio: "pipe",
       env: { ...process.env, ...cliTest.env },
     });

test/integration.test.js

@@ -6,6 +6,13 @@ const coverage = global.coverage;
 // the twilio test can take a while (large codebase)
 jest.setTimeout(200000);
 
+const skipOnWindows = [
+  'binary-require.js',
+  'browserify-middleware.js',
+  'oracledb.js',
+  'tensorflow.js',
+]
+
 let nccRun;
 if (coverage) {
   nccRun = require(__dirname + "/../src/cli.js");
@@ -34,6 +41,9 @@ for (const integrationTest of fs.readdirSync(__dirname + "/integration")) {
   // disabled pending https://github.com/zeit/ncc/issues/141
   if (integrationTest.endsWith('loopback.js')) continue;
 
+  // ignore a few tests known to fail on windows
+  if (process.platform === 'win32' && skipOnWindows.includes(integrationTest)) continue;
+
   it(`should execute "ncc run ${integrationTest}"`, async () => {
     let expectedStdout;
     try {

test/unit.test.js

@@ -4,23 +4,20 @@ const ncc = coverage ? require("../src/index") : require("../");
 
 jest.setTimeout(20000);
 
+function normalizeForWindows(str) {
+  return str.trim().replace(/\\r/g, '').replace(/\r/g, '').replace(/;+/g, ';');
+}
+
 for (const unitTest of fs.readdirSync(`${__dirname}/unit`)) {
-  it(`should generate correct output for ${unitTest}`, async () => {
+  if (process.platform === 'win32' && unitTest.includes('shebang')) {
+    continue;
+  }
+  it(`should generate correct output for ${unitTest}`, async () => { 
     const testDir = `${__dirname}/unit/${unitTest}`;
-    const expected = fs
-      .readFileSync(`${testDir}/output${coverage ? '-coverage' : ''}.js`)
-      .toString()
-      .trim()
-      // Windows support
-      .replace(/\r/g, "");
+    const expected = normalizeForWindows(fs.readFileSync(`${testDir}/output${coverage ? '-coverage' : ''}.js`, 'utf8'));
     let expectedSourceMap;
     try {
-      expectedSourceMap = fs
-        .readFileSync(`${testDir}/output${coverage ? '-coverage' : ''}.js.map`)
-        .toString()
-        .trim()
-        // Windows support
-        .replace(/\r/g, "");
+      expectedSourceMap = normalizeForWindows(fs.readFileSync(`${testDir}/output${coverage ? '-coverage' : ''}.js.map`, 'utf8'));
     } catch (_) {}
 
     let opts;
@@ -59,11 +56,7 @@ for (const unitTest of fs.readdirSync(`${__dirname}/unit`)) {
         if (unitTest.includes('minify') && !unitTest.includes('minify-err')) {
           expect(assets['index.js.map']).toBeDefined()
         }
-        const actual = code
-          .trim()
-          // Windows support
-          .replace(/\r/g, "")
-          .replace(/;+/g, ";");
+        const actual = normalizeForWindows(code);
         try {
           expect(actual).toBe(expected);
         } catch (e) {
@@ -73,10 +66,7 @@ for (const unitTest of fs.readdirSync(`${__dirname}/unit`)) {
         }
 
         if (map) {
-          const actualSourceMap = map
-            .trim()
-            // Windows support
-            .replace(/\r/g, "");
+          const actualSourceMap = normalizeForWindows(map);
           try {
             expect(actualSourceMap).toBe(expectedSourceMap);
           } catch (e) {