node-tdd 3.3.1 → 3.4.0

package/README.md

@@ -24,8 +24,8 @@ Drop-in extension for mocha by simply importing `describe` as below.
 
 <!-- eslint-disable import/no-unresolved, import/no-extraneous-dependencies -->
 ```js
-const expect = require('chai').expect;
-const { describe } = require('node-tdd');
+import { expect } from 'chai';
+import { describe } from 'node-tdd';
 
 describe('Testing some stuff', /* { ...options }, */ () => {
   it('Testing a thing', () => {
@@ -36,6 +36,16 @@ describe('Testing some stuff', /* { ...options }, */ () => {
 
 Please see tests for further usage examples.
 
+### Custom Cassette Logic
+
+### delayConnection
+
+Delay the connection by a certain number of ms.
+
+### delayBody
+
+Delay the response body by a certain number of ms.
+
 ### Function Kwargs
 
 #### dir

package/lib/index.js

@@ -1,8 +1,13 @@
-"use strict";
+import describe_ from './util/desc.js';
+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';
 
-module.exports.describe = require('./util/desc');
-module.exports.RequestRecorder = require('./modules/request-recorder');
-module.exports.EnvManager = require('./modules/env-manager');
-module.exports.TimeKeeper = require('./modules/time-keeper');
-module.exports.LogRecorder = require('./modules/log-recorder');
-module.exports.RandomSeeder = require('./modules/random-seeder');
+export const describe = describe_;
+export const RequestRecorder = RequestRecorder_;
+export const EnvManager = EnvManager_;
+export const TimeKeeper = TimeKeeper_;
+export const LogRecorder = LogRecorder_;
+export const RandomSeeder = RandomSeeder_;

package/lib/modules/env-manager.js

@@ -1,8 +1,5 @@
-"use strict";
-
-const assert = require('assert');
-
-const Joi = require('joi-strict');
+import assert from 'assert';
+import Joi from 'joi-strict';
 
 const setEnvVar = (key, value) => {
   if ([null, undefined].includes(value)) {
@@ -13,7 +10,7 @@ const setEnvVar = (key, value) => {
   }
 };
 
-module.exports = opts => {
+export default (opts) => {
   Joi.assert(opts, Joi.object().keys({
     envVars: Joi.object().pattern(Joi.string(), Joi.string()),
     allowOverwrite: Joi.boolean()
@@ -24,22 +21,20 @@ module.exports = opts => {
       envVarsOverwritten.length = 0;
       Object.entries(opts.envVars).forEach(([key, value]) => {
         const envVar = key.replace(/^\^/, '');
-
         if (opts.allowOverwrite === true || key.startsWith('^')) {
           envVarsOverwritten[envVar] = process.env[envVar];
         } else {
           assert(process.env[envVar] === undefined, `Environment Variable Set: ${envVar}`);
         }
-
         setEnvVar(envVar, value);
       });
     },
     unapply: () => {
-      Object.keys(opts.envVars).forEach(key => {
+      Object.keys(opts.envVars).forEach((key) => {
         const envVar = key.replace(/^\^/, '');
         assert(typeof process.env[envVar] === 'string', `Environment Variable Set: ${envVar}`);
         setEnvVar(envVar, envVarsOverwritten[envVar]);
       });
     }
   };
-};
+};

package/lib/modules/log-recorder.js

@@ -1,10 +1,7 @@
-"use strict";
+import assert from 'assert';
+import Joi from 'joi-strict';
 
-const assert = require('assert');
-
-const Joi = require('joi-strict');
-
-module.exports = opts => {
+export default (opts) => {
   Joi.assert(opts, Joi.object().keys({
     logger: Joi.any(),
     verbose: Joi.boolean()
@@ -12,13 +9,17 @@ module.exports = opts => {
   const logger = opts.logger;
   let verbose = opts.verbose;
   let loggerOriginal = null;
-  const logLevels = Object.entries(logger).filter(([k, v]) => typeof v === 'function').map(([k]) => k);
+
+  const logLevels = Object
+    .entries(logger)
+    .filter(([k, v]) => typeof v === 'function')
+    .map(([k]) => k);
   assert(logLevels.length !== 0, 'Passed logger does not expose logging functionality');
-  let logs;
 
+  let logs;
   const reset = () => {
     logs = [];
-    logLevels.forEach(level => {
+    logLevels.forEach((level) => {
       logs[level] = [];
     });
   };
@@ -27,16 +28,14 @@ module.exports = opts => {
     inject: () => {
       assert(loggerOriginal === null);
       verbose = opts.verbose;
-      loggerOriginal = logLevels.reduce((p, c) => Object.assign(p, {
-        [c]: logger[c]
-      }), {});
+      loggerOriginal = logLevels
+        .reduce((p, c) => Object.assign(p, { [c]: logger[c] }), {});
       reset();
-      Object.keys(loggerOriginal).forEach(logLevel => {
+      Object.keys(loggerOriginal).forEach((logLevel) => {
         logger[logLevel] = (...args) => {
           if (verbose === true) {
             loggerOriginal[logLevel](...args);
           }
-
           logs.push(...args);
           logs[logLevel].push(...args);
         };
@@ -47,7 +46,7 @@ module.exports = opts => {
       Object.assign(logger, loggerOriginal);
       loggerOriginal = null;
     },
-    verbose: state => {
+    verbose: (state) => {
       assert(typeof state === 'boolean');
       verbose = state;
     },
@@ -58,4 +57,4 @@ module.exports = opts => {
     },
     reset
   };
-};
+};

package/lib/modules/random-seeder.js

@@ -1,27 +1,21 @@
-"use strict";
+import assert from 'assert';
+import crypto from 'crypto';
+import get from 'lodash.get';
+import Joi from 'joi-strict';
 
-const assert = require('assert');
+const libs = { Math, crypto };
 
-const crypto = require('crypto');
-
-const get = require('lodash.get');
-
-const Joi = require('joi-strict');
-
-const libs = {
-  Math,
-  crypto
-};
-
-module.exports = opts => {
+export default (opts) => {
   Joi.assert(opts, Joi.object().keys({
     seed: Joi.string(),
     reseed: Joi.boolean()
   }), 'Invalid Options Provided');
   let original = null;
+
   return {
     inject: () => {
       assert(original === null);
+
       original = {
         crypto: {
           randomBytes: crypto.randomBytes,
@@ -36,13 +30,18 @@ module.exports = opts => {
       crypto.randomBytes = (size, cb) => {
         // randomization is seeded "per key"
         const stack = new Error().stack.split('\n');
-        const subStack = stack.slice(stack.findIndex(e => e.indexOf('/node_modules/') !== -1));
-        const stackOrigin = get(subStack, [subStack.findIndex(e => e.indexOf('/node_modules/') === -1) - 1], '');
+        const subStack = stack.slice(stack.findIndex((e) => e.indexOf('/node_modules/') !== -1));
+        const stackOrigin = get(subStack, [subStack.findIndex((e) => e.indexOf('/node_modules/') === -1) - 1], '');
         const originFile = get(stackOrigin.match(/^.*?\([^)]+?\/node_modules\/([^)]+):\d+:\d+\)$/), [1], '');
         const key = `${originFile}@${size}`;
-        executionCounts[key] = opts.reseed === true ? null : (executionCounts[key] || 0) + 1;
-        let result = crypto.createHash('sha256').update(opts.seed).update(key).update(String(executionCounts[key])).digest();
 
+        executionCounts[key] = opts.reseed === true ? null : (executionCounts[key] || 0) + 1;
+        let result = crypto
+          .createHash('sha256')
+          .update(opts.seed)
+          .update(key)
+          .update(String(executionCounts[key]))
+          .digest();
         while (result.length < size) {
           result = Buffer.concat([result, crypto.createHash('sha256').update(result).digest()]);
         }
@@ -50,7 +49,6 @@ module.exports = opts => {
         result = result.slice(0, size);
         return cb ? cb(null, result) : result;
       };
-
       crypto.randomFillSync = (buffer, offset, size) => {
         const o = offset || 0;
         const s = size || buffer.byteLength;
@@ -59,7 +57,6 @@ module.exports = opts => {
         });
         return buffer;
       };
-
       Math.random = () => crypto.randomBytes(4).readUInt32LE() / 0xffffffff;
     },
     release: () => {
@@ -73,4 +70,4 @@ module.exports = opts => {
     },
     isInjected: () => original !== null
   };
-};
+};

package/lib/modules/request-recorder/apply-modifiers.js

@@ -1,31 +1,24 @@
-"use strict";
+import objectScan from 'object-scan';
 
-const objectScan = require('object-scan');
-
-module.exports = (input, modifiers) => {
+export default (input, modifiers) => {
   objectScan(['**'], {
-    filterFn: ({
-      key,
-      value,
-      parent
-    }) => {
+    filterFn: ({ key, value, parent }) => {
       const k = key[key.length - 1];
-
       if (typeof k === 'string' && k.includes('|')) {
         const [newKey, ...modifierNames] = k.split('|');
-        const unknownModifiers = modifierNames.filter(n => typeof modifiers[n] !== 'function');
-
+        const unknownModifiers = modifierNames
+          .filter((n) => typeof modifiers[n] !== 'function');
         if (unknownModifiers.length !== 0) {
           // eslint-disable-next-line no-console
           console.warn(`Unknown Modifier(s) detected: ${unknownModifiers.join(', ')}`);
           return;
-        } // eslint-disable-next-line no-param-reassign
-
-
-        delete parent[k]; // eslint-disable-next-line no-param-reassign
-
-        parent[newKey] = modifierNames.reduce((p, modifierName) => modifiers[modifierName](p), value);
+        }
+        // eslint-disable-next-line no-param-reassign
+        delete parent[k];
+        // eslint-disable-next-line no-param-reassign
+        parent[newKey] = modifierNames
+          .reduce((p, modifierName) => modifiers[modifierName](p), value);
       }
     }
   })(input);
-};
+};

package/lib/modules/request-recorder/heal-sqs-send-message-batch.js

@@ -1,31 +1,24 @@
-"use strict";
+import crypto from 'crypto';
+import qs from 'querystring';
+import get from 'lodash.get';
 
-const crypto = require('crypto');
+import { v4 as uuid4 } from 'uuid';
+import xml2js from 'xml2js';
 
-const qs = require('querystring');
+const parseRequestBody = (body) => Object.values(Object
+  .entries(qs.parse(body))
+  .filter(([k, v]) => k.startsWith('SendMessageBatchRequestEntry.'))
+  .sort((a, b) => a[0].localeCompare(b[0]))
+  .map(([k, v]) => [k.split('.'), v])
+  .reduce((p, [k, v]) => {
+    if (p[k[1]] === undefined) {
+      Object.assign(p, { [k[1]]: {} });
+    }
+    Object.assign(p[k[1]], { [k[2]]: v });
+    return p;
+  }, {}));
 
-const get = require('lodash.get');
-
-const {
-  v4: uuid4
-} = require('uuid');
-
-const xml2js = require('xml2js');
-
-const parseRequestBody = body => Object.values(Object.entries(qs.parse(body)).filter(([k, v]) => k.startsWith('SendMessageBatchRequestEntry.')).sort((a, b) => a[0].localeCompare(b[0])).map(([k, v]) => [k.split('.'), v]).reduce((p, [k, v]) => {
-  if (p[k[1]] === undefined) {
-    Object.assign(p, {
-      [k[1]]: {}
-    });
-  }
-
-  Object.assign(p[k[1]], {
-    [k[2]]: v
-  });
-  return p;
-}, {}));
-
-const parseResponseBody = body => {
+const parseResponseBody = (body) => {
   let parsed = null;
   xml2js.parseString(body, (err, result) => {
     parsed = result;
@@ -33,15 +26,51 @@ const parseResponseBody = body => {
   return parsed;
 };
 
-module.exports = (requestBody, responseBody, scope) => {
-  if (!/^https:\/\/sqs\.[a-z0-9-]+\.amazonaws\.com:443$/.test(scope.basePath) || !responseBody.startsWith('<?xml version="1.0"?><SendMessageBatchResponse')) {
+export default (requestBody, responseBody, scope) => {
+  if (
+    !/^https:\/\/sqs\.[a-z0-9-]+\.amazonaws\.com:443$/.test(scope.basePath)
+    || !responseBody.startsWith('<?xml version="1.0"?><SendMessageBatchResponse')) {
     return responseBody;
   }
 
   const responseBodyParsed = parseResponseBody(responseBody);
-  const resultEntries = parseRequestBody(requestBody).map(({
-    Id,
-    MessageBody
-  }, idx) => ['<SendMessageBatchResultEntry>', `<Id>${Id}</Id>`, `<MessageId>${get(responseBodyParsed, ['SendMessageBatchResponse', 'SendMessageBatchResult', 0, 'SendMessageBatchResultEntry', idx, 'MessageId'], uuid4())}</MessageId>`, `<MD5OfMessageBody>${crypto.createHash('md5').update(MessageBody).digest('hex')}</MD5OfMessageBody>`, '</SendMessageBatchResultEntry>'].join(''));
-  return ['<?xml version="1.0"?>', '<SendMessageBatchResponse xmlns="http://queue.amazonaws.com/doc/2012-11-05/">', '<SendMessageBatchResult>', ...resultEntries, '</SendMessageBatchResult>', '<ResponseMetadata>', `<RequestId>${get(responseBodyParsed, ['SendMessageBatchResponse', 'ResponseMetadata', 0, 'RequestId', 0], uuid4())}</RequestId>`, '</ResponseMetadata>', '</SendMessageBatchResponse>'].join('');
-};
+
+  const resultEntries = parseRequestBody(requestBody)
+    .map(({ Id, MessageBody }, idx) => [
+      '<SendMessageBatchResultEntry>',
+      `<Id>${Id}</Id>`,
+      `<MessageId>${
+        get(responseBodyParsed, [
+          'SendMessageBatchResponse',
+          'SendMessageBatchResult',
+          0,
+          'SendMessageBatchResultEntry',
+          idx,
+          'MessageId'
+        ], uuid4())
+      }</MessageId>`,
+      `<MD5OfMessageBody>${
+        crypto.createHash('md5').update(MessageBody).digest('hex')
+      }</MD5OfMessageBody>`,
+      '</SendMessageBatchResultEntry>'
+    ].join(''));
+  return [
+    '<?xml version="1.0"?>',
+    '<SendMessageBatchResponse xmlns="http://queue.amazonaws.com/doc/2012-11-05/">',
+    '<SendMessageBatchResult>',
+    ...resultEntries,
+    '</SendMessageBatchResult>',
+    '<ResponseMetadata>',
+    `<RequestId>${
+      get(responseBodyParsed, [
+        'SendMessageBatchResponse',
+        'ResponseMetadata',
+        0,
+        'RequestId',
+        0
+      ], uuid4())
+    }</RequestId>`,
+    '</ResponseMetadata>',
+    '</SendMessageBatchResponse>'
+  ].join('');
+};

package/lib/modules/request-recorder/nock-listener.js

@@ -1,20 +1,18 @@
-"use strict";
+import nock from 'nock';
 
-const nock = require('nock');
-
-module.exports = (() => {
+export default (() => {
   const fnLists = {
     'no match': []
   };
   Object.entries(fnLists).forEach(([event, fns]) => {
-    nock.emitter.on(event, (...args) => fns.forEach(fn => fn(...args)));
+    nock.emitter.on(event, (...args) => fns.forEach((fn) => fn(...args)));
   });
   return {
     subscribe: (event, f) => {
       fnLists[event].push(f);
     },
-    unsubscribeAll: event => {
+    unsubscribeAll: (event) => {
       fnLists[event].length = 0;
     }
   };
-})();
+})();

package/lib/modules/request-recorder/nock-mock.js

@@ -1,30 +1,27 @@
-"use strict";
-
-const nockCommon = require('nock/lib/common');
+import nockCommon from 'nock/lib/common.js';
 
 const fns = ['setInterval', 'setTimeout', 'deleteHeadersField'];
 const originals = fns.reduce((p, c) => Object.assign(p, {
   [c]: nockCommon[c]
 }), {});
-module.exports = {
+
+export default {
   patch: () => {
-    fns.forEach(fn => {
+    fns.forEach((fn) => {
       nockCommon[fn] = (...args) => {
         if (fn === 'deleteHeadersField') {
           return undefined;
         }
-
         if (args[1] === 0) {
           return args[0](...args.slice(2));
         }
-
         return originals[fn](...args);
       };
     });
   },
   unpatch: () => {
-    fns.forEach(fn => {
+    fns.forEach((fn) => {
       nockCommon[fn] = originals[fn];
     });
   }
-};
+};

package/lib/modules/request-recorder/request-injector.js

@@ -1,23 +1,15 @@
-"use strict";
-
-const assert = require('assert');
-
-const http = require('http');
-
-const https = require('https');
-
-const nockCommon = require('nock/lib/common');
+import assert from 'assert';
+import http from 'http';
+import https from 'https';
+import nockCommon from 'nock/lib/common.js';
 
 let lastProtocol = null;
 let lastOptions = null;
 const lastBody = [];
 
-const wrapper = proto => {
+const wrapper = (proto) => {
   let requestOriginal = null;
-  const protocol = {
-    http,
-    https
-  }[proto];
+  const protocol = { http, https }[proto];
 
   const requestWrapper = (...args) => {
     lastProtocol = proto;
@@ -25,12 +17,10 @@ const wrapper = proto => {
     lastBody.length = 0;
     const result = requestOriginal.call(protocol, ...args);
     const writeOriginal = result.write;
-
     result.write = (chunk, encoding, callback) => {
       lastBody.push(chunk.toString());
       return writeOriginal.call(result, chunk, encoding, callback);
     };
-
     return result;
   };
 
@@ -51,7 +41,7 @@ const wrapper = proto => {
   };
 };
 
-module.exports = (() => {
+export default (() => {
   const httpWrapper = wrapper('http');
   const httpsWrapper = wrapper('https');
   return {
@@ -69,4 +59,4 @@ module.exports = (() => {
       body: lastBody.length === 0 ? undefined : lastBody.join('')
     })
   };
-})();
+})();

package/lib/modules/request-recorder/util.js

@@ -1,12 +1,9 @@
-"use strict";
+export const buildKey = (interceptor) => `${interceptor.method} ${interceptor.basePath}${interceptor.uri}`;
 
-module.exports.buildKey = interceptor => `${interceptor.method} ${interceptor.basePath}${interceptor.uri}`;
-
-module.exports.tryParseJson = value => {
+export const tryParseJson = (value) => {
   if (typeof value !== 'string') {
     return value;
   }
-
   try {
     return JSON.parse(value);
   } catch (e) {
@@ -14,27 +11,28 @@ module.exports.tryParseJson = value => {
   }
 };
 
-module.exports.nullAsString = value => value === null ? 'null' : value;
+export const nullAsString = (value) => (value === null ? 'null' : value);
 
-module.exports.convertHeaders = array => {
+export const convertHeaders = (array) => {
   const obj = {};
-
   for (let idx = 0; idx < array.length; idx += 2) {
     obj[array[idx].toLowerCase()] = array[idx + 1];
   }
-
   return obj;
 };
 
-module.exports.rewriteHeaders = (headers, fn = (k, v) => v) => {
+export const rewriteHeaders = (headers, fn = (k, v) => v) => {
   if (headers === undefined) {
     return {};
   }
-
-  const headersLower = Object.fromEntries(Object.entries(headers).sort(([a], [b]) => a > b ? 1 : -1).map(([k, v]) => [k.toLowerCase(), v]));
+  const headersLower = Object.fromEntries(
+    Object.entries(headers)
+      .sort(([a], [b]) => (a > b ? 1 : -1))
+      .map(([k, v]) => [k.toLowerCase(), v])
+  );
   const result = {};
   Object.entries(headersLower).forEach(([k, v]) => {
     result[k] = fn(k, v, headersLower);
   });
   return result;
-};
+};