tape-six 0.9.6 → 0.10.0

package/README.md

@@ -3,7 +3,7 @@
 [npm-img]:      https://img.shields.io/npm/v/tape-six.svg
 [npm-url]:      https://npmjs.org/package/tape-six
 
-tape-six is a [TAP](https://en.wikipedia.org/wiki/Test_Anything_Protocol)-based library for unit tests. It is written in the modern JavaScript for the modern JavaScript and works in [node](https://nodejs.org/), [deno](https://deno.land/) and browsers.
+tape-six is a [TAP](https://en.wikipedia.org/wiki/Test_Anything_Protocol)-based library for unit tests. It is written in the modern JavaScript for the modern JavaScript and works in [node](https://nodejs.org/), [deno](https://deno.land/), [bun](https://bun.sh/) and browsers.
 
 Why `tape-six`? It was supposed to be named `tape6` but `npm` does not allow names "similar" to existing packages. Instead of eliminating name-squatting they force to use unintuitive and unmemorable names. That's why all internal names, environment variables, and public names still use `tape6`.
 
@@ -32,6 +32,7 @@ If you are familiar with other TAP-based libraries you'll feel right at home.
 
 The most recent releases:
 
+* 0.10.0 *Refactored test runners, refactored stopping tests on failure, added JSONL reporter, fixed bugs.*
 * 0.9.6 *Updated deps.*
 * 0.9.5 *Updated the lock file.*
 * 0.9.4 *Updated deps. Added test runners for Bun and Deno.*

package/bin/tape6-bun.js

@@ -1,29 +1,44 @@
 #!/usr/bin/env bun
 
-import {resolveTests, resolvePatterns} from '../src/node/config.js';
+import {fileURLToPath} from 'node:url';
+
+import {resolveTests, resolvePatterns} from '../src/utils/config.js';
 
 import {getReporter, setReporter} from '../src/test.js';
-import State from '../src/State.js';
+import State, {StopTest} from '../src/State.js';
 import TapReporter from '../src/TapReporter.js';
 import {selectTimer} from '../src/utils/timer.js';
 
 import TestWorker from '../src/bun/TestWorker.js';
 
 const options = {},
-  rootFolder = process.cwd();
+  rootFolder = Bun.cwd;
 
 let flags = '',
   parallel = '',
   files = [];
 
+const showSelf = () => {
+  const self = new URL(import.meta.url);
+  if (self.protocol === 'file:') {
+    console.log(fileURLToPath(self));
+  } else {
+    console.log(self);
+  }
+  process.exit(0);
+};
+
 const config = () => {
+  if (Bun.argv.includes('--self')) showSelf();
+
   const optionNames = {
     f: 'failureOnly',
     t: 'showTime',
     b: 'showBanner',
     d: 'showData',
     o: 'failOnce',
-    n: 'showAssertNumber'
+    n: 'showAssertNumber',
+    c: 'hasColors'
   };
 
   let flagIsSet = false,
@@ -53,7 +68,7 @@ const config = () => {
   }
 
   if (!flagIsSet) {
-    flags = process.env.TAPE6_FLAGS || flags;
+    flags = Bun.env.TAPE6_FLAGS || flags;
   }
   for (let i = 0; i < flags.length; ++i) {
     const option = flags[i].toLowerCase(),
@@ -62,7 +77,7 @@ const config = () => {
   }
 
   if (!parIsSet) {
-    parallel = process.env.TAPE6_PAR || parallel;
+    parallel = Bun.env.TAPE6_PAR || parallel;
   }
   if (parallel) {
     parallel = Math.max(0, +parallel);
@@ -76,7 +91,11 @@ const config = () => {
 const init = async () => {
   let reporter = getReporter();
   if (!reporter) {
-    if (!process.env.TAPE6_TAP) {
+    if (Bun.env.TAPE6_JSONL) {
+      const JSONLReporter = (await import('../src/JSONLReporter.js')).default,
+        jsonlReporter = new JSONLReporter(options);
+      reporter = jsonlReporter.report.bind(jsonlReporter);
+    } else if (!Bun.env.TAPE6_TAP) {
       const TTYReporter = (await import('../src/TTYReporter.js')).default,
         ttyReporter = new TTYReporter(options);
       ttyReporter.testCounter = -2;
@@ -93,7 +112,15 @@ const init = async () => {
   if (files.length) {
     files = await resolvePatterns(rootFolder, files);
   } else {
-    files = await resolveTests(rootFolder, 'deno');
+    files = await resolveTests(rootFolder, 'bun');
+  }
+};
+
+const safeEmit = rootState => event => {
+  try {
+    rootState.emit(event);
+  } catch (error) {
+    if (!(error instanceof StopTest)) throw error;
   }
 };
 
@@ -102,10 +129,12 @@ const main = async () => {
   await init();
   await selectTimer();
 
-  process.on('uncaughtException', error => console.error('UNHANDLED ERROR:', error));
+  process.on('uncaughtException', (error, origin) =>
+    console.error('UNHANDLED ERROR:', origin, error)
+  );
 
   const rootState = new State(null, {callback: getReporter(), failOnce: options.failOnce}),
-    worker = new TestWorker(event => rootState.emit(event), parallel, options);
+    worker = new TestWorker(safeEmit(rootState), parallel, options);
 
   rootState.emit({type: 'test', test: 0, time: rootState.timer.now()});
 

package/bin/tape6-deno.js

@@ -1,9 +1,11 @@
 #!/usr/bin/env -S deno run --allow-read --allow-env --allow-hrtime --ext=js
 
-import {resolveTests, resolvePatterns} from '../src/node/config.js';
+import {fileURLToPath} from 'node:url';
+
+import {resolveTests, resolvePatterns} from '../src/utils/config.js';
 
 import {getReporter, setReporter} from '../src/test.js';
-import State from '../src/State.js';
+import State, {StopTest} from '../src/State.js';
 import TapReporter from '../src/TapReporter.js';
 import {selectTimer} from '../src/utils/timer.js';
 
@@ -16,14 +18,27 @@ let flags = '',
   parallel = '',
   files = [];
 
+const showSelf = () => {
+  const self = new URL(import.meta.url);
+  if (self.protocol === 'file:') {
+    console.log(fileURLToPath(self));
+  } else {
+    console.log(self);
+  }
+  Deno.exit(0);
+};
+
 const config = () => {
+  if (Deno.args.includes('--self')) showSelf();
+
   const optionNames = {
     f: 'failureOnly',
     t: 'showTime',
     b: 'showBanner',
     d: 'showData',
     o: 'failOnce',
-    n: 'showAssertNumber'
+    n: 'showAssertNumber',
+    c: 'hasColors'
   };
 
   let flagIsSet = false,
@@ -76,7 +91,11 @@ const config = () => {
 const init = async () => {
   let reporter = getReporter();
   if (!reporter) {
-    if (!Deno.env.get('TAPE6_TAP')) {
+    if (Deno.env.get('TAPE6_JSONL')) {
+      const JSONLReporter = (await import('../src/JSONLReporter.js')).default,
+        jsonlReporter = new JSONLReporter(options);
+      reporter = jsonlReporter.report.bind(jsonlReporter);
+    } else if (!Deno.env.get('TAPE6_TAP')) {
       const TTYReporter = (await import('../src/TTYReporter.js')).default,
         ttyReporter = new TTYReporter(options);
       ttyReporter.testCounter = -2;
@@ -97,6 +116,14 @@ const init = async () => {
   }
 };
 
+const safeEmit = rootState => event => {
+  try {
+    rootState.emit(event);
+  } catch (error) {
+    if (!(error instanceof StopTest)) throw error;
+  }
+};
+
 const main = async () => {
   config();
   await init();
@@ -108,7 +135,7 @@ const main = async () => {
   });
 
   const rootState = new State(null, {callback: getReporter(), failOnce: options.failOnce}),
-    worker = new TestWorker(event => rootState.emit(event), parallel, options);
+    worker = new TestWorker(safeEmit(rootState), parallel, options);
 
   rootState.emit({type: 'test', test: 0, time: rootState.timer.now()});
 

package/bin/tape6-runner.js

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+
+import process from 'node:process';
+import {fileURLToPath} from 'node:url';
+
+const requestedRuntime =
+  {
+    node: 'tape6.js',
+    deno: 'tape6-deno.js',
+    bun: 'tape6-bun.js',
+    server: 'tape6-server.js',
+    runner: 'tape6-runner.js'
+  }[process.argv[2]];
+
+const runtime = requestedRuntime || 'tape6.js',
+  url = new URL('./' + runtime, import.meta.url),
+  fileName = url.protocol === 'file:' ? fileURLToPath(url) : url.href;
+
+console.log(fileName);
+process.exit(typeof requestedRuntime == 'string' ? 0 : 1);

package/bin/tape6-server.js

@@ -4,13 +4,25 @@ import http from 'node:http';
 import fs from 'node:fs';
 import path from 'node:path';
 import process from 'node:process';
+import {fileURLToPath} from 'node:url';
 
-import {resolveTests, resolvePatterns} from '../src/node/config.js';
+import {getConfig, resolveTests, resolvePatterns} from '../src/utils/config.js';
 
 const fsp = fs.promises;
 
 // simple static server with no dependencies
 
+const showSelf = () => {
+  const self = new URL(import.meta.url);
+  if (self.protocol === 'file:') {
+    console.log(fileURLToPath(self));
+  } else {
+    console.log(self);
+  }
+  process.exit(0);
+};
+if (process.argv.includes('--self')) showSelf();
+
 // MIME source: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types
 const mimeTable = {
     css: 'text/css',
@@ -47,7 +59,7 @@ if (!webAppPath) {
   const isWindows = path.sep === '\\';
   webAppPath = path.relative(
     rootFolder,
-    path.join(path.dirname(url.substring(isWindows ? 8 : 7)), '../webApp/')
+    path.join(path.dirname(fileURLToPath(url)), '../web-app/')
   );
 }
 
@@ -128,6 +140,11 @@ const server = http.createServer(async (req, res) => {
       method === 'HEAD'
     );
   }
+  if (url.pathname === '/--importmap') {
+    // get import map contents
+    const cfg = await getConfig(rootFolder);
+    return sendJson(req, res, cfg.importmap || {imports: {}}, method === 'HEAD');
+  }
   if (url.pathname === '/' || url.pathname === '/index' || url.pathname === '/index.html') {
     // redirect to the web app
     url.pathname = webAppPath;

package/bin/tape6.js

@@ -1,18 +1,16 @@
 #!/usr/bin/env node
 
-import cluster from 'node:cluster';
-import os from 'node:os';
-import path from 'node:path';
 import process from 'node:process';
+import {fileURLToPath} from 'node:url';
 
-import {resolveTests, resolvePatterns} from '../src/node/config.js';
+import {resolveTests, resolvePatterns} from '../src/utils/config.js';
 
 import {getReporter, setReporter} from '../src/test.js';
-import State from '../src/State.js';
+import State, {StopTest} from '../src/State.js';
 import TapReporter from '../src/TapReporter.js';
-import TestWorker from '../src/node/TestWorker.js';
 import {selectTimer} from '../src/utils/timer.js';
-import defer from '../src/utils/defer.js';
+
+import TestWorker from '../src/node/TestWorker.js';
 
 const options = {},
   rootFolder = process.cwd();
@@ -21,14 +19,27 @@ let flags = '',
   parallel = '',
   files = [];
 
-const mainConfiguration = () => {
+const showSelf = () => {
+  const self = new URL(import.meta.url);
+  if (self.protocol === 'file:') {
+    console.log(fileURLToPath(self));
+  } else {
+    console.log(self);
+  }
+  process.exit(0);
+};
+
+const config = () => {
+  if (process.argv.includes('--self')) showSelf();
+
   const optionNames = {
     f: 'failureOnly',
     t: 'showTime',
     b: 'showBanner',
     d: 'showData',
     o: 'failOnce',
-    n: 'showAssertNumber'
+    n: 'showAssertNumber',
+    c: 'hasColors'
   };
 
   let flagIsSet = false,
@@ -42,7 +53,8 @@ const mainConfiguration = () => {
         flagIsSet = true;
       }
       continue;
-    } else if (arg == '-p' || arg == '--par') {
+    }
+    if (arg == '-p' || arg == '--par') {
       if (++i < process.argv.length) {
         parallel = process.argv[i];
         parIsSet = true;
@@ -74,13 +86,17 @@ const mainConfiguration = () => {
   } else {
     parallel = 0;
   }
-  if (!parallel) parallel = os.cpus().length;
+  if (!parallel) parallel = navigator.hardwareConcurrency;
 };
 
-const mainInitialization = async () => {
+const init = async () => {
   let reporter = getReporter();
   if (!reporter) {
-    if (!process.env.TAPE6_TAP) {
+    if (process.env.TAPE6_JSONL) {
+      const JSONLReporter = (await import('../src/JSONLReporter.js')).default,
+        jsonlReporter = new JSONLReporter(options);
+      reporter = jsonlReporter.report.bind(jsonlReporter);
+    } else if (!process.env.TAPE6_TAP) {
       const TTYReporter = (await import('../src/TTYReporter.js')).default,
         ttyReporter = new TTYReporter(options);
       ttyReporter.testCounter = -2;
@@ -101,21 +117,33 @@ const mainInitialization = async () => {
   }
 };
 
-const mainProcess = async () => {
-  mainConfiguration();
-  await mainInitialization();
+const safeEmit = rootState => event => {
+  try {
+    rootState.emit(event);
+  } catch (error) {
+    if (!(error instanceof StopTest)) throw error;
+  }
+};
+
+const main = async () => {
+  config();
+  await init();
   await selectTimer();
 
-  process.on('uncaughtException', error => console.error('UNHANDLED ERROR:', error));
+  process.on('uncaughtException', (error, origin) =>
+    console.error('UNHANDLED ERROR:', origin, error)
+  );
 
   const rootState = new State(null, {callback: getReporter(), failOnce: options.failOnce}),
-    worker = new TestWorker(event => rootState.emit(event), parallel, options);
+    worker = new TestWorker(safeEmit(rootState), parallel, options);
 
   rootState.emit({type: 'test', test: 0, time: rootState.timer.now()});
+
   await new Promise(resolve => {
     worker.done = () => resolve();
     worker.execute(files);
   });
+
   rootState.emit({
     type: 'end',
     test: 0,
@@ -127,80 +155,4 @@ const mainProcess = async () => {
   process.exit(rootState.failed > 0 ? 1 : 0);
 };
 
-class BufferedReporter {
-  constructor() {
-    this.buffer = [];
-    this.inFlight = false;
-    this.shouldExit = false;
-  }
-  report(event) {
-    if (this.inFlight) {
-      this.buffer.push(event);
-      return this;
-    }
-    this.buffer.push(event);
-    return this.send();
-  }
-  send() {
-    if (!this.buffer.length) {
-      this.shouldExit && defer(() => process.exit(0));
-      return this;
-    }
-    this.inFlight = true;
-    const events = this.buffer;
-    this.buffer = [];
-    process.send({events});
-    return this;
-  }
-}
-
-const reporter = new BufferedReporter();
-
-const workerProcess = async () => {
-  setReporter(reporter.report.bind(reporter));
-
-  await new Promise((resolve, reject) => {
-    process.on('message', async ({id, fileName, options, received, done}) => {
-      reporter.inFlight = false;
-
-      if (done) return resolve();
-
-      if (received) {
-        if (reporter.buffer.length) {
-          reporter.send();
-        } else if (reporter.shouldExit) {
-          resolve();
-        }
-        return;
-      }
-
-      try {
-        let name = path.join(rootFolder, fileName);
-        if (!/^file:\/\//.test(name)) {
-          if (path.sep === '\\') {
-            // windows
-            name = 'file://' + path.posix.normalize(name);
-          } else {
-            name = 'file://' + name;
-          }
-        }
-        await import(name);
-      } catch (error) {
-        reject(error);
-      }
-    });
-    process.send({started: true});
-  });
-
-  if (reporter.inFlight || reporter.buffer.length) {
-    reporter.shouldExit = true;
-  } else {
-    process.exit(0);
-  }
-};
-
-const main = () => {
-  if (cluster.isWorker) return workerProcess();
-  return mainProcess();
-};
 main().catch(error => console.error('ERROR:', error));

package/index.js

@@ -1,14 +1,32 @@
-import {test, getTests, clearTests, getReporter, setReporter, runTests, getConfiguredFlag} from './src/test.js';
+import {
+  test,
+  getTests,
+  clearTests,
+  getReporter,
+  setReporter,
+  runTests,
+  getConfiguredFlag
+} from './src/test.js';
 import defer from './src/utils/defer.js';
 import State from './src/State.js';
 import TapReporter from './src/TapReporter.js';
 
-const optionNames = {f: 'failureOnly', t: 'showTime', b: 'showBanner', d: 'showData', o: 'failOnce', n: 'showAssertNumber'};
+const optionNames = {
+  f: 'failureOnly',
+  t: 'showTime',
+  b: 'showBanner',
+  d: 'showData',
+  o: 'failOnce',
+  n: 'showAssertNumber',
+  c: 'hasColors'
+};
 
 defer(async () => {
   if (getConfiguredFlag()) return; // bail out => somebody else is running the show
 
-  const isNode = typeof process == 'object' && typeof process.exit == 'function',
+  const isNode = typeof process == 'object' && process.versions?.node,
+    isDeno = typeof Deno == 'object',
+    isBun = typeof Bun == 'object',
     isBrowser = typeof window == 'object' && !!window.location,
     options = {};
 
@@ -18,8 +36,12 @@ defer(async () => {
     if (typeof window.__tape6_flags == 'string') {
       flags = window.__tape6_flags;
     } else if (window.location.search) {
-      flags = (new URLSearchParams(window.location.search.substring(1))).get('flags') || '';
+      flags = new URLSearchParams(window.location.search.substring(1)).get('flags') || '';
     }
+  } else if (isDeno) {
+    flags = Deno.env.get('TAPE6_FLAGS') || '';
+  } else if (isBun) {
+    flags = Bun.env.TAPE6_FLAGS || '';
   } else if (isNode) {
     flags = process.env.TAPE6_FLAGS || '';
   }
@@ -33,21 +55,46 @@ defer(async () => {
   let reporter = getReporter();
   if (!reporter) {
     if (isBrowser) {
-      const id = window.__tape6_id || (new URLSearchParams(window.location.search.substring(1))).get('id');
+      const id =
+        window.__tape6_id || new URLSearchParams(window.location.search.substring(1)).get('id');
       if (typeof window.__tape6_reporter == 'function') {
         reporter = event => window.__tape6_reporter(id, event);
       } else if (window.parent && typeof window.parent.__tape6_reporter == 'function') {
         reporter = event => window.parent.__tape6_reporter(id, event);
       }
+    } else if (isDeno) {
+      if (Deno.env.TAPE6_JSONL) {
+        const JSONLReporter = (await import('./src/JSONLReporter.js')).default,
+          jsonlReporter = new JSONLReporter(options);
+        reporter = jsonlReporter.report.bind(jsonlReporter);
+      } else if (!Deno.env.get('TAPE6_TAP')) {
+        const TTYReporter = (await import('./src/TTYReporter.js')).default,
+          ttyReporter = new TTYReporter(options);
+        reporter = ttyReporter.report.bind(ttyReporter);
+      }
+    } else if (isBun) {
+      if (Bun.env.TAPE6_JSONL) {
+        const JSONLReporter = (await import('./src/JSONLReporter.js')).default,
+          jsonlReporter = new JSONLReporter(options);
+        reporter = jsonlReporter.report.bind(jsonlReporter);
+      } else if (!Bun.env.TAPE6_TAP) {
+        const TTYReporter = (await import('./src/TTYReporter.js')).default,
+          ttyReporter = new TTYReporter(options);
+        reporter = ttyReporter.report.bind(ttyReporter);
+      }
     } else if (isNode) {
-      if (!process.env.TAPE6_TAP) {
+      if (process.env.TAPE6_JSONL) {
+        const JSONLReporter = (await import('./src/JSONLReporter.js')).default,
+          jsonlReporter = new JSONLReporter(options);
+        reporter = jsonlReporter.report.bind(jsonlReporter);
+      } else if (!process.env.TAPE6_TAP) {
         const TTYReporter = (await import('./src/TTYReporter.js')).default,
           ttyReporter = new TTYReporter(options);
         reporter = ttyReporter.report.bind(ttyReporter);
       }
     }
     if (!reporter) {
-      const tapReporter = new TapReporter({useJson: true});
+      const tapReporter = new TapReporter({useJson: true, hasColors: options.hasColors});
       reporter = tapReporter.report.bind(tapReporter);
     }
     setReporter(reporter);
@@ -60,12 +107,24 @@ defer(async () => {
     const tests = getTests();
     if (!tests.length) break;
     clearTests();
-    await runTests(rootState, tests);
+    const canContinue = await runTests(rootState, tests);
+    if (!canContinue) break;
+    await new Promise(resolve => defer(resolve));
   }
-  rootState.emit({type: 'end', test: 0, time: rootState.timer.now(), fail: rootState.failed > 0, data: rootState});
+  rootState.emit({
+    type: 'end',
+    test: 0,
+    time: rootState.timer.now(),
+    fail: rootState.failed > 0,
+    data: rootState
+  });
 
-  if (isNode) {
-    !process.env.TAPE6_WORKER && process.exit(rootState.failed > 0 ? 1 : 0);
+  if (isDeno) {
+    Deno.exit(rootState.failed > 0 ? 1 : 0);
+  } else if (isBun) {
+    process.exit(rootState.failed > 0 ? 1 : 0);
+  } else if (isNode) {
+    process.exit(rootState.failed > 0 ? 1 : 0);
   } else if (typeof __tape6_reportResults == 'function') {
     __tape6_reportResults(rootState.failed > 0 ? 'failure' : 'success');
   }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "tape-six",
-  "version": "0.9.6",
-  "description": "TAP for the modern JavaScript (ES6).",
+  "version": "0.10.0",
+  "description": "TAP the test harness for the modern JavaScript (ES6).",
   "type": "module",
   "main": "index.js",
   "module": "index.js",
@@ -12,15 +12,18 @@
     "tape6": "bin/tape6.js",
     "tape6-bun": "bin/tape6-bun.js",
     "tape6-deno": "bin/tape6-deno.js",
-    "tape6-server": "bin/tape6-server.js"
+    "tape6-server": "bin/tape6-server.js",
+    "tape6-runner": "bin/tape6-runner.js"
   },
   "scripts": {
     "start": "node bin/tape6-server.js --trace",
-    "test-chrome": "node tests/puppeteer-chrome.js",
     "copyDeep6": "node scripts/copyFolder.js --src ./vendors/deep6/src --dst ./src/deep6 --clear",
     "build": "npm run copyDeep6",
     "prepublishOnly": "npm run build",
-    "test": "node ./bin/tape6.js --flags FO"
+    "test": "node ./bin/tape6.js --flags FO",
+    "test-bun": "bun run ./bin/tape6-bun.js --flags FO",
+    "test-deno": "deno run -A ./bin/tape6-deno.js --flags FO",
+    "test-chrome": "node tests/puppeteer-chrome.js"
   },
   "github": "http://github.com/uhop/tape-six",
   "repository": {
@@ -35,6 +38,7 @@
     "browser"
   ],
   "author": "Eugene Lazutkin <eugene.lazutkin@gmail.com> (https://www.lazutkin.com/)",
+  "funding": "https://github.com/sponsors/uhop",
   "license": "BSD-3-Clause",
   "bugs": {
     "url": "https://github.com/uhop/tape-six/issues"
@@ -43,15 +47,21 @@
   "files": [
     "index.js",
     "bin",
-    "webApp",
+    "web-app",
     "src"
   ],
   "tape6": {
     "tests": [
       "/tests/test-*.*js"
-    ]
+    ],
+    "importmap": {
+      "imports": {
+        "tape-six": "../index.js",
+        "tape-six/": "../src/"
+      }
+    }
   },
   "devDependencies": {
-    "puppeteer": "^22.11.0"
+    "puppeteer": "^23.4.0"
   }
 }

package/src/JSONLReporter.js

@@ -0,0 +1,14 @@
+class JSONLReporter {
+  constructor({renumberAsserts = false}) {
+    this.renumberAsserts = renumberAsserts;
+    this.assertCounter = 0;
+  }
+  report(event) {
+    if (event.type === 'assert' && this.renumberAsserts) {
+      event = {...event, id: ++this.assertCounter};
+    }
+    console.log(JSON.stringify(event));
+  }
+}
+
+export default JSONLReporter;