node-tdd 6.2.4 → 6.3.0

package/README.md

@@ -166,6 +166,18 @@ Used to customize the name of the file that environment variables are loaded fro
 
 To allow overwriting of environment variables, prefix the name of the environment variable with `^`.
 
+#### envVarsFileRecording
+
+Type: `string`<br>
+Default: `$FILENAME.env.recording.yml` (depends on `envVarsFile`)
+
+Used to customize the name of the file that environment variables are loaded from,
+if it exists and `useNock` is true and no cassette file exists.
+
+Environment variables are loaded after `envVars` and `envVarsFile` variables are loaded.
+
+Defined environment variables will overwrite set ones.
+
 #### envVars
 
 Type: `object`<br>

package/lib/modules/request-recorder.js

@@ -9,6 +9,7 @@ import get from 'lodash.get';
 import cloneDeep from 'lodash.clonedeep';
 import nockCommon from 'nock/lib/common.js';
 import compareUrls from '../util/compare-urls.js';
+import EnvManager from './env-manager.js';
 import nockListener from './request-recorder/nock-listener.js';
 import nockMock from './request-recorder/nock-mock.js';
 import healSqs from './request-recorder/heal-sqs.js';
@@ -35,6 +36,7 @@ export default (opts) => {
       Joi.string().case('lower'),
       Joi.alternatives(Joi.string(), Joi.function())
     ),
+    envVarsFileRecording: Joi.string().optional(),
     strict: Joi.boolean(),
     heal: Joi.alternatives(Joi.boolean(), Joi.string()),
     modifiers: Joi.object().pattern(
@@ -42,8 +44,9 @@ export default (opts) => {
       Joi.alternatives(Joi.function(), Joi.link('#modifiers'))
     )
   }), 'Invalid Options Provided');
-  let nockDone = null;
   let cassetteFilePath = null;
+  let envManagerFile = null;
+  let nockDone = null;
   const knownCassetteNames = [];
   const records = [];
   const outOfOrderErrors = [];
@@ -90,6 +93,11 @@ export default (opts) => {
           })));
       }
 
+      if (!hasCassette && typeof opts.envVarsFileRecording === 'string' && fs.existsSync(opts.envVarsFileRecording)) {
+        envManagerFile = EnvManager({ envVars: fs.smartRead(opts.envVarsFileRecording), allowOverwrite: true });
+        envManagerFile.apply();
+      }
+
       nockBack.setMode(hasCassette ? 'lockdown' : 'record');
       nockBack.fixtures = opts.cassetteFolder;
       nockMock.patch();
@@ -296,6 +304,11 @@ export default (opts) => {
       nockListener.unsubscribeAll('no match');
       nockMock.unpatch();
 
+      if (envManagerFile !== null) {
+        envManagerFile.unapply();
+        envManagerFile = null;
+      }
+
       if (opts.heal !== false) {
         fs.smartWrite(
           cassetteFilePath,

package/lib/util/desc.js

@@ -38,9 +38,10 @@ const desc = (suiteName, optsOrTests, testsOrNull = null) => {
       /* c8 ignore next */
       : filenameOrUrl
   );
-  const resolve = (name) => path.join(
-    path.dirname(testFile),
-    name.replace(/\$FILENAME/g, path.basename(testFile))
+  const resolve = (name) => (
+    name.startsWith('/')
+      ? name
+      : path.join(path.dirname(testFile), name.replace(/\$FILENAME/g, path.basename(testFile)))
   );
 
   Joi.assert(opts, Joi.object().keys({
@@ -53,6 +54,7 @@ const desc = (suiteName, optsOrTests, testsOrNull = null) => {
       .pattern(Joi.string(), Joi.alternatives(Joi.function(), Joi.string())),
     fixtureFolder: Joi.string().optional(),
     envVarsFile: Joi.string().optional(),
+    envVarsFileRecording: Joi.string().optional(),
     envVars: Joi.object().optional().unknown(true).pattern(Joi.string(), Joi.string()),
     clearCache: Joi.boolean().optional(),
     timestamp: Joi.alternatives(
@@ -76,6 +78,11 @@ const desc = (suiteName, optsOrTests, testsOrNull = null) => {
   const nockReqHeaderOverwrite = get(opts, 'nockReqHeaderOverwrite', {});
   const fixtureFolder = resolve(get(opts, 'fixtureFolder', '$FILENAME__fixtures'));
   const envVarsFile = resolve(get(opts, 'envVarsFile', '$FILENAME.env.yml'));
+  const envVarsFileRecording = resolve(get(
+    opts,
+    'envVarsFileRecording',
+    envVarsFile.replace(/(\.[^.]+)$/, '.recording$1')
+  ));
   const envVars = get(opts, 'envVars', null);
   const clearCache = get(opts, 'clearCache', true);
   const timestamp = get(opts, 'timestamp', null);
@@ -158,6 +165,7 @@ const desc = (suiteName, optsOrTests, testsOrNull = null) => {
               cassetteFolder: `${nockFolder}/`,
               stripHeaders: nockStripHeaders,
               reqHeaderOverwrite: nockReqHeaderOverwrite,
+              envVarsFileRecording,
               strict: true,
               heal: nockHeal,
               modifiers: nockModifiers

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "node-tdd",
   "type": "module",
-  "version": "6.2.4",
+  "version": "6.3.0",
   "description": "Drop in extension for mocha to abstract commonly used test setups",
   "main": "lib/index.js",
   "scripts": {