@loopback/testlab 3.1.8 → 3.2.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.2.0](https://github.com/strongloop/loopback-next/compare/@loopback/testlab@3.1.8...@loopback/testlab@3.2.0) (2020-06-30)
+
+
+### Features
+
+* **testlab:** add transform option for sandbox copyFile ([f5565fb](https://github.com/strongloop/loopback-next/commit/f5565fbfce2e88f4f0accaaa620f4237dc67545c))
+
+
+
+
+
 ## [3.1.8](https://github.com/strongloop/loopback-next/compare/@loopback/testlab@3.1.7...@loopback/testlab@3.1.8) (2020-06-23)
 
 

package/dist/test-sandbox.d.ts

@@ -69,8 +69,9 @@ export declare class TestSandbox {
      * @param src - Absolute path of file to be copied to the TestSandbox
      * @param dest - Optional. Destination filename of the copy operation
      * (relative to TestSandbox). Original filename used if not specified.
+     * @param transform - Optional. A function to transform the file content.
      */
-    copyFile(src: string, dest?: string): Promise<void>;
+    copyFile(src: string, dest?: string, transform?: (content: string) => string): Promise<void>;
     /**
      * Creates a new file and writes the given data serialized as JSON.
      *

package/dist/test-sandbox.js

@@ -95,12 +95,20 @@ class TestSandbox {
      * @param src - Absolute path of file to be copied to the TestSandbox
      * @param dest - Optional. Destination filename of the copy operation
      * (relative to TestSandbox). Original filename used if not specified.
+     * @param transform - Optional. A function to transform the file content.
      */
-    async copyFile(src, dest) {
+    async copyFile(src, dest, transform) {
         dest = dest
             ? path_1.resolve(this.path, dest)
             : path_1.resolve(this.path, path_1.parse(src).base);
-        await fs_extra_1.copy(src, dest);
+        if (transform == null) {
+            await fs_extra_1.copy(src, dest);
+        }
+        else {
+            let content = await fs_extra_1.readFile(src, 'utf-8');
+            content = transform(content);
+            await fs_extra_1.outputFile(dest, content, { encoding: 'utf-8' });
+        }
         if (path_1.parse(src).ext === '.js' && fs_extra_1.pathExists(src + '.map')) {
             const srcMap = src + '.map';
             await fs_extra_1.appendFile(dest, `\n//# sourceMappingURL=${srcMap}`);
@@ -114,9 +122,7 @@ class TestSandbox {
      */
     async writeJsonFile(dest, data) {
         dest = path_1.resolve(this.path, dest);
-        const destDir = path_1.parse(dest).dir;
-        await fs_extra_1.ensureDir(destDir);
-        return fs_extra_1.writeJson(dest, data, { spaces: 2 });
+        return fs_extra_1.outputJson(dest, data, { spaces: 2 });
     }
     /**
      * Creates a new file and writes the given data as a UTF-8-encoded text.
@@ -126,9 +132,7 @@ class TestSandbox {
      */
     async writeTextFile(dest, data) {
         dest = path_1.resolve(this.path, dest);
-        const destDir = path_1.parse(dest).dir;
-        await fs_extra_1.ensureDir(destDir);
-        return fs_extra_1.writeFile(dest, data, { encoding: 'utf-8' });
+        return fs_extra_1.outputFile(dest, data, 'utf-8');
     }
 }
 exports.TestSandbox = TestSandbox;

package/dist/test-sandbox.js.map

@@ -1 +1 @@
-{"version":3,"file":"test-sandbox.js","sourceRoot":"","sources":["../src/test-sandbox.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;AAEhE,uCAWkB;AAClB,+BAA0C;AAkB1C;;;GAGG;AACH,MAAa,WAAW;IAatB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,YAAY,QAAgB,EAAE,OAA4B;QACxD,QAAQ,GAAG,cAAO,CAAC,QAAQ,CAAC,CAAC;QAC7B,wBAAa,CAAC,QAAQ,CAAC,CAAC;QACxB,OAAO,GAAG,EAAC,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,EAAC,CAAC;QACrC,MAAM,MAAM,GAAG,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC;QACzE,IAAI,OAAO,CAAC,MAAM,KAAK,IAAI,EAAE;YAC3B,IAAI,CAAC,KAAK,GAAG,cAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;SACxC;aAAM;YACL,0DAA0D;YAC1D,sEAAsE;YACtE,IAAI,CAAC,KAAK,GAAG,sBAAW,CAAC,WAAI,CAAC,QAAQ,EAAE,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;SAC7D;IACH,CAAC;IA9CD,IAAW,IAAI;QACb,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;YACf,MAAM,IAAI,KAAK,CACb,0DAA0D,CAC3D,CAAC;SACH;QACD,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAyCD;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,4EAA4E;QAC5E,uEAAuE;QACvE,wCAAwC;QACxC,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,KAAK,EAAE;YAC/B,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBAC7B,OAAO,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;aAC3B;SACF;QAED,MAAM,mBAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM;QACV,MAAM,iBAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAK,CAAC,GAAW;QACrB,MAAM,oBAAS,CAAC,cAAO,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,QAAQ,CAAC,GAAW,EAAE,IAAa;QACvC,IAAI,GAAG,IAAI;YACT,CAAC,CAAC,cAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC;YAC1B,CAAC,CAAC,cAAO,CAAC,IAAI,CAAC,IAAI,EAAE,YAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;QAExC,MAAM,eAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAEtB,IAAI,YAAK,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,KAAK,IAAI,qBAAU,CAAC,GAAG,GAAG,MAAM,CAAC,EAAE;YACxD,MAAM,MAAM,GAAG,GAAG,GAAG,MAAM,CAAC;YAC5B,MAAM,qBAAU,CAAC,IAAI,EAAE,0BAA0B,MAAM,EAAE,CAAC,CAAC;SAC5D;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,IAAY,EAAE,IAAa;QAC7C,IAAI,GAAG,cAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAChC,MAAM,OAAO,GAAG,YAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC;QAChC,MAAM,oBAAS,CAAC,OAAO,CAAC,CAAC;QACzB,OAAO,oBAAS,CAAC,IAAI,EAAE,IAAI,EAAE,EAAC,MAAM,EAAE,CAAC,EAAC,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,IAAY,EAAE,IAAY;QAC5C,IAAI,GAAG,cAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAChC,MAAM,OAAO,GAAG,YAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC;QAChC,MAAM,oBAAS,CAAC,OAAO,CAAC,CAAC;QACzB,OAAO,oBAAS,CAAC,IAAI,EAAE,IAAI,EAAE,EAAC,QAAQ,EAAE,OAAO,EAAC,CAAC,CAAC;IACpD,CAAC;CACF;AArID,kCAqIC"}
+{"version":3,"file":"test-sandbox.js","sourceRoot":"","sources":["../src/test-sandbox.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;AAEhE,uCAYkB;AAClB,+BAA0C;AAkB1C;;;GAGG;AACH,MAAa,WAAW;IAatB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,YAAY,QAAgB,EAAE,OAA4B;QACxD,QAAQ,GAAG,cAAO,CAAC,QAAQ,CAAC,CAAC;QAC7B,wBAAa,CAAC,QAAQ,CAAC,CAAC;QACxB,OAAO,GAAG,EAAC,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,EAAC,CAAC;QACrC,MAAM,MAAM,GAAG,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC;QACzE,IAAI,OAAO,CAAC,MAAM,KAAK,IAAI,EAAE;YAC3B,IAAI,CAAC,KAAK,GAAG,cAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;SACxC;aAAM;YACL,0DAA0D;YAC1D,sEAAsE;YACtE,IAAI,CAAC,KAAK,GAAG,sBAAW,CAAC,WAAI,CAAC,QAAQ,EAAE,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;SAC7D;IACH,CAAC;IA9CD,IAAW,IAAI;QACb,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;YACf,MAAM,IAAI,KAAK,CACb,0DAA0D,CAC3D,CAAC;SACH;QACD,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAyCD;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,4EAA4E;QAC5E,uEAAuE;QACvE,wCAAwC;QACxC,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,KAAK,EAAE;YAC/B,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBAC7B,OAAO,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;aAC3B;SACF;QAED,MAAM,mBAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM;QACV,MAAM,iBAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAK,CAAC,GAAW;QACrB,MAAM,oBAAS,CAAC,cAAO,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,QAAQ,CACZ,GAAW,EACX,IAAa,EACb,SAAuC;QAEvC,IAAI,GAAG,IAAI;YACT,CAAC,CAAC,cAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC;YAC1B,CAAC,CAAC,cAAO,CAAC,IAAI,CAAC,IAAI,EAAE,YAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;QAExC,IAAI,SAAS,IAAI,IAAI,EAAE;YACrB,MAAM,eAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;SACvB;aAAM;YACL,IAAI,OAAO,GAAG,MAAM,mBAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;YAC3C,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;YAC7B,MAAM,qBAAU,CAAC,IAAI,EAAE,OAAO,EAAE,EAAC,QAAQ,EAAE,OAAO,EAAC,CAAC,CAAC;SACtD;QAED,IAAI,YAAK,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,KAAK,IAAI,qBAAU,CAAC,GAAG,GAAG,MAAM,CAAC,EAAE;YACxD,MAAM,MAAM,GAAG,GAAG,GAAG,MAAM,CAAC;YAC5B,MAAM,qBAAU,CAAC,IAAI,EAAE,0BAA0B,MAAM,EAAE,CAAC,CAAC;SAC5D;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,IAAY,EAAE,IAAa;QAC7C,IAAI,GAAG,cAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAChC,OAAO,qBAAU,CAAC,IAAI,EAAE,IAAI,EAAE,EAAC,MAAM,EAAE,CAAC,EAAC,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,IAAY,EAAE,IAAY;QAC5C,IAAI,GAAG,cAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAChC,OAAO,qBAAU,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACzC,CAAC;CACF;AA5ID,kCA4IC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loopback/testlab",
-  "version": "3.1.8",
+  "version": "3.2.0",
   "description": "A collection of test utilities we use to write LoopBack tests.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -26,7 +26,7 @@
     "@types/fs-extra": "^9.0.1",
     "@types/shot": "^4.0.0",
     "@types/sinon": "^9.0.4",
-    "@types/supertest": "^2.0.9",
+    "@types/supertest": "^2.0.10",
     "express": "^4.17.1",
     "fs-extra": "^9.0.1",
     "oas-validator": "^4.0.3",
@@ -36,8 +36,8 @@
     "tslib": "^2.0.0"
   },
   "devDependencies": {
-    "@loopback/build": "^6.0.0",
-    "@loopback/eslint-config": "^8.0.2",
+    "@loopback/build": "^6.1.0",
+    "@loopback/eslint-config": "^8.0.3",
     "@types/node": "^10.17.26"
   },
   "files": [
@@ -53,5 +53,5 @@
     "url": "https://github.com/strongloop/loopback-next.git",
     "directory": "packages/testlab"
   },
-  "gitHead": "9ccb0b7ae75727ec9b90c5bba18885edb3f93a92"
+  "gitHead": "b89db3d3b8be6a36e63e91c2331d217fda7538de"
 }

package/src/test-sandbox.ts

@@ -10,10 +10,11 @@ import {
   ensureDir,
   ensureDirSync,
   mkdtempSync,
+  outputFile,
+  outputJson,
   pathExists,
+  readFile,
   remove,
-  writeFile,
-  writeJson,
 } from 'fs-extra';
 import {join, parse, resolve} from 'path';
 
@@ -131,13 +132,24 @@ export class TestSandbox {
    * @param src - Absolute path of file to be copied to the TestSandbox
    * @param dest - Optional. Destination filename of the copy operation
    * (relative to TestSandbox). Original filename used if not specified.
+   * @param transform - Optional. A function to transform the file content.
    */
-  async copyFile(src: string, dest?: string): Promise<void> {
+  async copyFile(
+    src: string,
+    dest?: string,
+    transform?: (content: string) => string,
+  ): Promise<void> {
     dest = dest
       ? resolve(this.path, dest)
       : resolve(this.path, parse(src).base);
 
-    await copy(src, dest);
+    if (transform == null) {
+      await copy(src, dest);
+    } else {
+      let content = await readFile(src, 'utf-8');
+      content = transform(content);
+      await outputFile(dest, content, {encoding: 'utf-8'});
+    }
 
     if (parse(src).ext === '.js' && pathExists(src + '.map')) {
       const srcMap = src + '.map';
@@ -153,9 +165,7 @@ export class TestSandbox {
    */
   async writeJsonFile(dest: string, data: unknown): Promise<void> {
     dest = resolve(this.path, dest);
-    const destDir = parse(dest).dir;
-    await ensureDir(destDir);
-    return writeJson(dest, data, {spaces: 2});
+    return outputJson(dest, data, {spaces: 2});
   }
 
   /**
@@ -166,8 +176,6 @@ export class TestSandbox {
    */
   async writeTextFile(dest: string, data: string): Promise<void> {
     dest = resolve(this.path, dest);
-    const destDir = parse(dest).dir;
-    await ensureDir(destDir);
-    return writeFile(dest, data, {encoding: 'utf-8'});
+    return outputFile(dest, data, 'utf-8');
   }
 }