node-tdd 3.3.1 → 3.4.0

package/lib/util/desc.js

@@ -1,35 +1,18 @@
-"use strict";
-
-const assert = require('assert');
-
-const path = require('path');
-
-const fs = require('smart-fs');
-
-const callsites = require('callsites');
-
-const get = require('lodash.get');
-
-const minimist = require('minimist');
-
-const tmp = require('tmp');
-
-const Joi = require('joi-strict');
-
-const RequestRecorder = require('../modules/request-recorder');
-
-const EnvManager = require('../modules/env-manager');
-
-const TimeKeeper = require('../modules/time-keeper');
-
-const LogRecorder = require('../modules/log-recorder');
-
-const RandomSeeder = require('../modules/random-seeder');
-
-const {
-  getParents,
-  genCassetteName
-} = require('./mocha-test');
+import assert from 'assert';
+import path from 'path';
+import fs from 'smart-fs';
+import callsites from 'callsites';
+import get from 'lodash.get';
+import { fileURLToPath } from 'url';
+import minimist from 'minimist';
+import tmp from 'tmp';
+import Joi from 'joi-strict';
+import RequestRecorder from '../modules/request-recorder.js';
+import EnvManager from '../modules/env-manager.js';
+import TimeKeeper from '../modules/time-keeper.js';
+import LogRecorder from '../modules/log-recorder.js';
+import RandomSeeder from '../modules/random-seeder.js';
+import { getParents, genCassetteName } from './mocha-test.js';
 
 const mocha = {
   it,
@@ -45,9 +28,19 @@ const mocha = {
 const desc = (suiteName, optsOrTests, testsOrNull = null) => {
   const opts = testsOrNull === null ? {} : optsOrTests;
   const tests = testsOrNull === null ? optsOrTests : testsOrNull;
-  const testFile = path.resolve(callsites()[1].getFileName());
 
-  const resolve = name => path.join(path.dirname(testFile), name.replace(/\$FILENAME/g, path.basename(testFile)));
+  const filenameOrUrl = callsites()[1].getFileName();
+  const testFile = path.resolve(
+    filenameOrUrl.startsWith('file://')
+      ? fileURLToPath(filenameOrUrl)
+      // eslint-disable-next-line @blackflux/rules/c8-prevent-ignore
+      /* c8 ignore next */
+      : filenameOrUrl
+  );
+  const resolve = (name) => path.join(
+    path.dirname(testFile),
+    name.replace(/\$FILENAME/g, path.basename(testFile))
+  );
 
   Joi.assert(opts, Joi.object().keys({
     useTmpDir: Joi.boolean().optional(),
@@ -55,11 +48,15 @@ const desc = (suiteName, optsOrTests, testsOrNull = null) => {
     nockFolder: Joi.string().optional(),
     nockModifiers: Joi.object().optional().pattern(Joi.string(), Joi.function()),
     nockStripHeaders: Joi.boolean().optional(),
-    nockReqHeaderOverwrite: Joi.object().optional().pattern(Joi.string(), Joi.alternatives(Joi.function(), Joi.string())),
+    nockReqHeaderOverwrite: Joi.object().optional()
+      .pattern(Joi.string(), Joi.alternatives(Joi.function(), Joi.string())),
     fixtureFolder: Joi.string().optional(),
     envVarsFile: Joi.string().optional(),
     envVars: Joi.object().optional().unknown(true).pattern(Joi.string(), Joi.string()),
-    timestamp: Joi.alternatives(Joi.number().integer().min(0), Joi.date().iso()).optional(),
+    timestamp: Joi.alternatives(
+      Joi.number().integer().min(0),
+      Joi.date().iso()
+    ).optional(),
     record: Joi.any().optional(),
     cryptoSeed: Joi.string().optional(),
     cryptoSeedReseed: Joi.when('cryptoSeed', {
@@ -84,6 +81,7 @@ const desc = (suiteName, optsOrTests, testsOrNull = null) => {
   const cryptoSeedReseed = get(opts, 'cryptoSeedReseed', false);
   const timeout = get(opts, 'timeout', null);
   const nockHeal = get(minimist(process.argv.slice(2)), 'nock-heal', false);
+
   let dir = null;
   let requestRecorder = null;
   let envManagerFile = null;
@@ -93,31 +91,22 @@ const desc = (suiteName, optsOrTests, testsOrNull = null) => {
   let randomSeeder = null;
 
   const getArgs = () => ({
-    capture: async fn => {
+    capture: async (fn) => {
       try {
         await fn();
       } catch (e) {
         return e;
       }
-
-      throw new assert.AssertionError({
-        message: 'expected [Function] to throw an error'
-      });
+      throw new assert.AssertionError({ message: 'expected [Function] to throw an error' });
     },
-    fixture: name => {
+    fixture: (name) => {
       const filepath = fs.guessFile(path.join(fixtureFolder, name));
-
       if (filepath === null) {
-        throw new assert.AssertionError({
-          message: `fixture "${name}" not found or ambiguous`
-        });
+        throw new assert.AssertionError({ message: `fixture "${name}" not found or ambiguous` });
       }
-
       return fs.smartRead(filepath);
     },
-    ...(dir === null ? {} : {
-      dir
-    }),
+    ...(dir === null ? {} : { dir }),
     ...(logRecorder === null ? {} : {
       recorder: {
         verbose: logRecorder.verbose,
@@ -126,56 +115,37 @@ const desc = (suiteName, optsOrTests, testsOrNull = null) => {
       }
     })
   });
-
   let beforeCb = () => {};
-
   let afterCb = () => {};
-
   let beforeEachCb = () => {};
+  let afterEachCb = () => {};
 
-  let afterEachCb = () => {}; // eslint-disable-next-line func-names
-
-
+  // eslint-disable-next-line func-names
   mocha.describe(suiteName, function () {
     return (async () => {
       if (timeout !== null) {
         this.timeout(timeout);
-      } // eslint-disable-next-line func-names
-
+      }
 
+      // eslint-disable-next-line func-names
       mocha.before(function () {
         return (async () => {
           if (getParents(this.test).length === 3 && fs.existsSync(envVarsFile)) {
-            envManagerFile = EnvManager({
-              envVars: fs.smartRead(envVarsFile),
-              allowOverwrite: false
-            });
+            envManagerFile = EnvManager({ envVars: fs.smartRead(envVarsFile), allowOverwrite: false });
             envManagerFile.apply();
           }
-
           if (envVars !== null) {
-            envManagerDesc = EnvManager({
-              envVars,
-              allowOverwrite: false
-            });
+            envManagerDesc = EnvManager({ envVars, allowOverwrite: false });
             envManagerDesc.apply();
           }
-
           if (timestamp !== null) {
-            timeKeeper = TimeKeeper({
-              timestamp
-            });
+            timeKeeper = TimeKeeper({ timestamp });
             timeKeeper.inject();
           }
-
           if (cryptoSeed !== null) {
-            randomSeeder = RandomSeeder({
-              seed: cryptoSeed,
-              reseed: cryptoSeedReseed
-            });
+            randomSeeder = RandomSeeder({ seed: cryptoSeed, reseed: cryptoSeedReseed });
             randomSeeder.inject();
           }
-
           if (useNock === true) {
             requestRecorder = RequestRecorder({
               cassetteFolder: `${nockFolder}/`,
@@ -186,56 +156,47 @@ const desc = (suiteName, optsOrTests, testsOrNull = null) => {
               modifiers: nockModifiers
             });
           }
-
           await beforeCb.call(this);
         })();
-      }); // eslint-disable-next-line func-names
+      });
 
+      // eslint-disable-next-line func-names
       mocha.after(function () {
         return (async () => {
           if (requestRecorder !== null) {
             requestRecorder.shutdown();
             requestRecorder = null;
           }
-
           if (randomSeeder !== null) {
             randomSeeder.release();
             randomSeeder = null;
           }
-
           if (timeKeeper !== null) {
             timeKeeper.release();
             timeKeeper = null;
           }
-
           if (envManagerDesc !== null) {
             envManagerDesc.unapply();
             envManagerDesc = null;
           }
-
           if (envManagerFile !== null) {
             envManagerFile.unapply();
             envManagerFile = null;
           }
-
           await afterCb.call(this);
         })();
-      }); // eslint-disable-next-line func-names
+      });
 
+      // eslint-disable-next-line func-names
       mocha.beforeEach(function () {
         return (async () => {
           if (useTmpDir === true) {
             tmp.setGracefulCleanup();
-            dir = tmp.dirSync({
-              keep: false,
-              unsafeCleanup: true
-            }).name;
+            dir = tmp.dirSync({ keep: false, unsafeCleanup: true }).name;
           }
-
           if (useNock === true) {
             await requestRecorder.inject(genCassetteName(this.currentTest));
           }
-
           if (record !== false) {
             logRecorder = LogRecorder({
               verbose: process.argv.slice(2).includes('--verbose'),
@@ -243,61 +204,56 @@ const desc = (suiteName, optsOrTests, testsOrNull = null) => {
             });
             logRecorder.inject();
           }
-
           await beforeEachCb.call(this, getArgs());
         })();
-      }); // eslint-disable-next-line func-names
+      });
 
+      // eslint-disable-next-line func-names
       mocha.afterEach(function () {
         return (async () => {
           await afterEachCb.call(this, getArgs());
-
           if (logRecorder !== null) {
             logRecorder.release();
             logRecorder = null;
           }
-
           if (requestRecorder !== null) {
             await requestRecorder.release();
           }
-
           if (dir !== null) {
             dir = null;
           }
         })();
       });
-      const globalsPrev = Object.keys(mocha).reduce((p, key) => Object.assign(p, {
-        [key]: global[key]
-      }));
-
-      global.it = (testName, fn) => mocha.it(testName, fn.length === 0 || /^[^(=]*\({/.test(fn.toString()) // eslint-disable-next-line func-names
-      ? function () {
-        return fn.call(this, getArgs());
-      } // eslint-disable-next-line func-names
-      : function (done) {
-        return fn.call(this, done);
-      });
 
+      const globalsPrev = Object.keys(mocha)
+        .reduce((p, key) => Object.assign(p, { [key]: global[key] }));
+      global.it = (testName, fn) => mocha.it(
+        testName,
+        fn.length === 0 || /^[^(=]*\({/.test(fn.toString())
+          // eslint-disable-next-line func-names
+          ? function () {
+            return fn.call(this, getArgs());
+          }
+          // eslint-disable-next-line func-names
+          : function (done) {
+            return fn.call(this, done);
+          }
+      );
       global.specify = global.it;
       global.describe = desc;
       global.context = global.describe;
-
-      global.before = fn => {
+      global.before = (fn) => {
         beforeCb = fn;
       };
-
-      global.after = fn => {
+      global.after = (fn) => {
         afterCb = fn;
       };
-
-      global.beforeEach = fn => {
+      global.beforeEach = (fn) => {
         beforeEachCb = fn;
       };
-
-      global.afterEach = fn => {
+      global.afterEach = (fn) => {
         afterEachCb = fn;
       };
-
       await tests.call(this);
       Object.entries(globalsPrev).forEach(([k, v]) => {
         global[k] = v;
@@ -305,5 +261,4 @@ const desc = (suiteName, optsOrTests, testsOrNull = null) => {
     })();
   });
 };
-
-module.exports = desc;
+export default desc;

package/lib/util/mocha-test.js

@@ -1,19 +1,19 @@
-"use strict";
-
-const getParents = test => {
+export const getParents = (test) => {
   const names = [];
   let cTest = test;
-
   while (cTest !== undefined) {
     names.splice(0, 0, cTest.title);
     cTest = cTest.parent;
   }
-
   return names;
 };
 
-module.exports.getParents = getParents;
-
-const genCassetteName = test => getParents(test).filter(e => !!e).map(e => e.replace(/[^a-zA-Z0-9]+/g, '-').replace(/^-+|-+$/g, '').replace(/^./, c => c.toLowerCase()).replace(/-(.)/g, (_, char) => char.toUpperCase())).concat(['recording.json']).join('_');
-
-module.exports.genCassetteName = genCassetteName;
+export const genCassetteName = (test) => getParents(test)
+  .filter((e) => !!e)
+  .map((e) => e
+    .replace(/[^a-zA-Z0-9]+/g, '-')
+    .replace(/^-+|-+$/g, '')
+    .replace(/^./, (c) => c.toLowerCase())
+    .replace(/-(.)/g, (_, char) => char.toUpperCase()))
+  .concat(['recording.json'])
+  .join('_');

package/package.json

@@ -1,21 +1,22 @@
 {
   "name": "node-tdd",
-  "version": "3.3.1",
+  "type": "module",
+  "version": "3.4.0",
   "description": "Drop in extension for mocha to abstract commonly used test setups",
   "main": "lib/index.js",
   "scripts": {
     "test": "yarn run clean && yarn run gardener && yarn run test-simple",
     "clean": "rm -rf lib",
-    "build": "npx babel src --out-dir lib --copy-files --include-dotfiles --config-file ./.babelrc",
+    "build": "cp -rf ./src ./lib",
     "build-clean": "yarn run clean && yarn run build",
-    "test-simple": "nyc mocha \"./test/**/*.spec.js\"",
+    "test-simple": "c8 mocha --experimental-loader=./test/hot.js \"./test/**/*.spec.js\"",
     "docker": "docker run --net host -u`id -u`:`id -g` -v $(pwd):/user/project -v ~/.aws:/user/.aws -v ~/.npmrc:/user/.npmrc -w /user/project -it --entrypoint /bin/bash",
     "t": "yarn test",
     "ts": "yarn run test-simple",
     "tsv": "yarn run test-simple --verbose",
     "coveralls": "node ./node_modules/coveralls/bin/coveralls.js < ./coverage/lcov.info",
     "semantic-release": "yarn run build-clean && npx semantic-release",
-    "gardener": "node gardener",
+    "gardener": "node gardener.js",
     "u": "yarn upgrade --latest --force",
     "i": "yarn install --frozen-lockfile",
     "it": "yarn run i && yarn run t"
@@ -41,29 +42,26 @@
   },
   "homepage": "https://github.com/blackflux/node-tdd#readme",
   "devDependencies": {
-    "@babel/cli": "7.14.8",
-    "@babel/core": "7.15.0",
-    "@babel/register": "7.15.3",
-    "@blackflux/eslint-plugin-rules": "2.0.3",
-    "@blackflux/robo-config-plugin": "5.3.0",
-    "aws-sdk": "2.981.0",
-    "aws-sdk-wrap": "9.6.0",
-    "axios": "0.24.0",
-    "babel-eslint": "10.1.0",
-    "babel-preset-latest-node": "5.5.1",
-    "chai": "4.3.4",
+    "@babel/core": "7.17.10",
+    "@babel/eslint-parser": "7.17.0",
+    "@babel/register": "7.17.7",
+    "@blackflux/eslint-plugin-rules": "2.1.0",
+    "@blackflux/robo-config-plugin": "7.7.12",
+    "aws-sdk": "2.1131.0",
+    "aws-sdk-wrap": "12.1.3",
+    "axios": "0.27.2",
+    "c8": "7.11.2",
+    "chai": "4.3.6",
     "coveralls": "3.1.1",
-    "eslint": "7.32.0",
-    "eslint-config-airbnb-base": "14.2.1",
-    "eslint-plugin-import": "2.24.2",
+    "eslint": "8.15.0",
+    "eslint-config-airbnb-base": "15.0.0",
+    "eslint-plugin-import": "2.26.0",
     "eslint-plugin-json": "3.1.0",
-    "eslint-plugin-markdown": "2.2.0",
-    "eslint-plugin-mocha": "9.0.0",
-    "fancy-log": "1.3.3",
-    "js-gardener": "3.0.3",
-    "lambda-monitor-logger": "3.0.0",
-    "nyc": "15.1.0",
-    "semantic-release": "17.4.7"
+    "eslint-plugin-markdown": "2.2.1",
+    "eslint-plugin-mocha": "10.0.3",
+    "fancy-log": "2.0.0",
+    "js-gardener": "3.0.5",
+    "lambda-monitor-logger": "3.2.2"
   },
   "licenses": [
     {
@@ -72,51 +70,21 @@
     }
   ],
   "engines": {
-    "node": ">= 12"
-  },
-  "nyc": {
-    "exclude": [
-      "gardener.js",
-      "node_modules/*",
-      "coverage/*",
-      "lib/*"
-    ],
-    "tempDir": "./coverage/.nyc_output",
-    "report-dir": "./coverage",
-    "check-coverage": true,
-    "per-file": false,
-    "lines": 100,
-    "statements": 100,
-    "functions": 100,
-    "branches": 100,
-    "include": [
-      "**/*.js"
-    ],
-    "reporter": [
-      "lcov",
-      "text-summary"
-    ],
-    "require": [
-      "@babel/register"
-    ],
-    "extension": [],
-    "cache": true,
-    "all": true,
-    "babel": true
+    "node": ">= 14"
   },
   "files": [
     "lib"
   ],
   "dependencies": {
-    "callsites": "3.1.0",
+    "callsites": "4.0.0",
     "compare-urls": "2.0.0",
-    "joi-strict": "2.0.0",
+    "joi-strict": "2.0.1",
     "lodash.clonedeep": "4.5.0",
     "lodash.get": "4.4.2",
-    "minimist": "1.2.5",
-    "nock": "13.1.3",
-    "object-scan": "17.0.0",
-    "smart-fs": "2.0.2",
+    "minimist": "1.2.6",
+    "nock": "13.2.4",
+    "object-scan": "18.0.1",
+    "smart-fs": "3.0.1",
     "timekeeper": "2.2.0",
     "tmp": "0.2.1",
     "uuid": "8.3.0",