@loopback/testlab 4.0.0-alpha.8 → 4.1.0

package/dist/test-sandbox.js

@@ -0,0 +1,139 @@
+"use strict";
+// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Node module: @loopback/testlab
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TestSandbox = void 0;
+const fs_extra_1 = require("fs-extra");
+const path_1 = require("path");
+/**
+ * TestSandbox class provides a convenient way to get a reference to a
+ * sandbox folder in which you can perform operations for testing purposes.
+ */
+class TestSandbox {
+    /**
+     * Will create a directory if it doesn't already exist. If it exists, you
+     * still get an instance of the TestSandbox.
+     *
+     * @example
+     * ```ts
+     * // Create a sandbox as a unique temporary subdirectory under the rootPath
+     * const sandbox = new TestSandbox(rootPath);
+     * const sandbox = new TestSandbox(rootPath, {subdir: true});
+     *
+     * // Create a sandbox in the root path directly
+     * // This is same as the old behavior
+     * const sandbox = new TestSandbox(rootPath, {subdir: false});
+     *
+     * // Create a sandbox in the `test1` subdirectory of the root path
+     * const sandbox = new TestSandbox(rootPath, {subdir: 'test1'});
+     * ```
+     *
+     * @param rootPath - Root path of the TestSandbox. If relative it will be
+     * resolved against the current directory.
+     * @param options - Options to control if/how the sandbox creates a
+     * subdirectory for the sandbox. If not provided, the sandbox
+     * will automatically creates a unique temporary subdirectory. This allows
+     * sandboxes with the same root path can be used in parallel during testing.
+     */
+    constructor(rootPath, options) {
+        rootPath = (0, path_1.resolve)(rootPath);
+        (0, fs_extra_1.ensureDirSync)(rootPath);
+        options = { subdir: true, ...options };
+        const subdir = typeof options.subdir === 'string' ? options.subdir : '.';
+        if (options.subdir !== true) {
+            this._path = (0, path_1.resolve)(rootPath, subdir);
+        }
+        else {
+            // Create a unique temporary directory under the root path
+            // See https://nodejs.org/api/fs.html#fs_fs_mkdtempsync_prefix_options
+            this._path = (0, fs_extra_1.mkdtempSync)((0, path_1.join)(rootPath, `/${process.pid}`));
+        }
+    }
+    get path() {
+        if (!this._path) {
+            throw new Error(`TestSandbox instance was deleted. Create a new instance.`);
+        }
+        return this._path;
+    }
+    /**
+     * Resets the TestSandbox. (Remove all files in it).
+     */
+    async reset() {
+        // Decache files from require's cache so future tests aren't affected incase
+        // a file is recreated in sandbox with the same file name but different
+        // contents after resetting the sandbox.
+        for (const key in require.cache) {
+            if (key.startsWith(this.path)) {
+                delete require.cache[key];
+            }
+        }
+        await (0, fs_extra_1.emptyDir)(this.path);
+    }
+    /**
+     * Deletes the TestSandbox.
+     */
+    async delete() {
+        await (0, fs_extra_1.remove)(this.path);
+        delete this._path;
+    }
+    /**
+     * Makes a directory in the TestSandbox
+     *
+     * @param dir - Name of directory to create (relative to TestSandbox path)
+     */
+    async mkdir(dir) {
+        await (0, fs_extra_1.ensureDir)((0, path_1.resolve)(this.path, dir));
+    }
+    /**
+     * Copies a file from src to the TestSandbox. If copying a `.js` file which
+     * has an accompanying `.js.map` file in the src file location, the dest file
+     * will have its sourceMappingURL updated to point to the original file as
+     * an absolute path so you don't need to copy the map file.
+     *
+     * @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, transform) {
+        dest = dest
+            ? (0, path_1.resolve)(this.path, dest)
+            : (0, path_1.resolve)(this.path, (0, path_1.parse)(src).base);
+        if (transform == null) {
+            await (0, fs_extra_1.copy)(src, dest);
+        }
+        else {
+            let content = await (0, fs_extra_1.readFile)(src, 'utf-8');
+            content = transform(content);
+            await (0, fs_extra_1.outputFile)(dest, content, { encoding: 'utf-8' });
+        }
+        if ((0, path_1.parse)(src).ext === '.js' && (await (0, fs_extra_1.pathExists)(src + '.map'))) {
+            const srcMap = src + '.map';
+            await (0, fs_extra_1.appendFile)(dest, `\n//# sourceMappingURL=${srcMap}`);
+        }
+    }
+    /**
+     * Creates a new file and writes the given data serialized as JSON.
+     *
+     * @param dest - Destination filename, optionally including a relative path.
+     * @param data - The data to write.
+     */
+    async writeJsonFile(dest, data) {
+        dest = (0, path_1.resolve)(this.path, dest);
+        return (0, fs_extra_1.outputJson)(dest, data, { spaces: 2 });
+    }
+    /**
+     * Creates a new file and writes the given data as a UTF-8-encoded text.
+     *
+     * @param dest - Destination filename, optionally including a relative path.
+     * @param data - The text to write.
+     */
+    async writeTextFile(dest, data) {
+        dest = (0, path_1.resolve)(this.path, dest);
+        return (0, fs_extra_1.outputFile)(dest, data, 'utf-8');
+    }
+}
+exports.TestSandbox = TestSandbox;
+//# sourceMappingURL=test-sandbox.js.map

package/dist/test-sandbox.js.map

@@ -0,0 +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,uCAYkB;AAClB,+BAA0C;AAkB1C;;;GAGG;AACH,MAAa,WAAW;IAatB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,YAAY,QAAgB,EAAE,OAA4B;QACxD,QAAQ,GAAG,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC;QAC7B,IAAA,wBAAa,EAAC,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,IAAA,cAAO,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;SACxC;aAAM;YACL,0DAA0D;YAC1D,sEAAsE;YACtE,IAAI,CAAC,KAAK,GAAG,IAAA,sBAAW,EAAC,IAAA,WAAI,EAAC,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,IAAA,mBAAQ,EAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM;QACV,MAAM,IAAA,iBAAM,EAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAK,CAAC,GAAW;QACrB,MAAM,IAAA,oBAAS,EAAC,IAAA,cAAO,EAAC,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,IAAA,cAAO,EAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC;YAC1B,CAAC,CAAC,IAAA,cAAO,EAAC,IAAI,CAAC,IAAI,EAAE,IAAA,YAAK,EAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;QAExC,IAAI,SAAS,IAAI,IAAI,EAAE;YACrB,MAAM,IAAA,eAAI,EAAC,GAAG,EAAE,IAAI,CAAC,CAAC;SACvB;aAAM;YACL,IAAI,OAAO,GAAG,MAAM,IAAA,mBAAQ,EAAC,GAAG,EAAE,OAAO,CAAC,CAAC;YAC3C,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;YAC7B,MAAM,IAAA,qBAAU,EAAC,IAAI,EAAE,OAAO,EAAE,EAAC,QAAQ,EAAE,OAAO,EAAC,CAAC,CAAC;SACtD;QAED,IAAI,IAAA,YAAK,EAAC,GAAG,CAAC,CAAC,GAAG,KAAK,KAAK,IAAI,CAAC,MAAM,IAAA,qBAAU,EAAC,GAAG,GAAG,MAAM,CAAC,CAAC,EAAE;YAChE,MAAM,MAAM,GAAG,GAAG,GAAG,MAAM,CAAC;YAC5B,MAAM,IAAA,qBAAU,EAAC,IAAI,EAAE,0BAA0B,MAAM,EAAE,CAAC,CAAC;SAC5D;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,IAAY,EAAE,IAAa;QAC7C,IAAI,GAAG,IAAA,cAAO,EAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAChC,OAAO,IAAA,qBAAU,EAAC,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,IAAA,cAAO,EAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAChC,OAAO,IAAA,qBAAU,EAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACzC,CAAC;CACF;AA5ID,kCA4IC"}

package/dist/to-json.d.ts

@@ -0,0 +1,23 @@
+export declare function toJSON(value: Date): string;
+export declare function toJSON(value: Function): undefined;
+export declare function toJSON(value: unknown[]): unknown[];
+/**
+ * JSON encoding does not preserve properties that are undefined
+ * As a result, deepEqual checks fail because the expected model
+ * value contains these undefined property values, while the actual
+ * result returned by REST API does not.
+ * Use this function to convert a model instance into a data object
+ * as returned by REST API
+ */
+export declare function toJSON(value: object): object;
+export declare function toJSON(value: undefined): undefined;
+export declare function toJSON(value: null): null;
+export declare function toJSON(value: number): number;
+export declare function toJSON(value: boolean): boolean;
+export declare function toJSON(value: string): string;
+export declare function toJSON(value: unknown[] | null): unknown[] | null;
+export declare function toJSON(value: unknown[] | undefined): unknown[] | undefined;
+export declare function toJSON(value: unknown[] | null | undefined): unknown[] | null | undefined;
+export declare function toJSON(value: object | null): object | null;
+export declare function toJSON(value: object | undefined): object | undefined;
+export declare function toJSON(value: object | null | undefined): object | null | undefined;

package/dist/to-json.js

@@ -0,0 +1,12 @@
+"use strict";
+// Copyright IBM Corp. 2018,2019. All Rights Reserved.
+// Node module: @loopback/testlab
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toJSON = void 0;
+function toJSON(value) {
+    return JSON.parse(JSON.stringify({ value })).value;
+}
+exports.toJSON = toJSON;
+//# sourceMappingURL=to-json.js.map

package/dist/to-json.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"to-json.js","sourceRoot":"","sources":["../src/to-json.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;AAgDhE,SAAgB,MAAM,CAAI,KAAQ;IAChC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,EAAC,KAAK,EAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AACnD,CAAC;AAFD,wBAEC"}

package/dist/validate-api-spec.d.ts

@@ -0,0 +1 @@
+export declare function validateApiSpec(spec: any): Promise<void>;

package/dist/validate-api-spec.js

@@ -0,0 +1,16 @@
+"use strict";
+// Copyright IBM Corp. 2017,2019. All Rights Reserved.
+// Node module: @loopback/testlab
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateApiSpec = void 0;
+const validator = require('oas-validator');
+const util_1 = require("util");
+const validateAsync = (0, util_1.promisify)(validator.validate);
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+async function validateApiSpec(spec) {
+    await validateAsync(spec, {});
+}
+exports.validateApiSpec = validateApiSpec;
+//# sourceMappingURL=validate-api-spec.js.map

package/dist/validate-api-spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-api-spec.js","sourceRoot":"","sources":["../src/validate-api-spec.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;AAEhE,MAAM,SAAS,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;AAC3C,+BAA+B;AAE/B,MAAM,aAAa,GAAG,IAAA,gBAAS,EAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;AAEpD,8DAA8D;AACvD,KAAK,UAAU,eAAe,CAAC,IAAS;IAC7C,MAAM,aAAa,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;AAChC,CAAC;AAFD,0CAEC"}

package/fixtures/README.md

@@ -0,0 +1,9 @@
+# Static fixtures
+
+This directory contains test fixture files that we want to use in verbatim and
+also files that TypeScript compiler would not copy from `src` to `dist`.
+
+For example:
+
+- text files
+- JSON files not imported by any `.ts` file

package/fixtures/cert.pem

@@ -0,0 +1,21 @@
+-----BEGIN CERTIFICATE-----
+MIIDaDCCAlACCQDSmMwp5CM+CzANBgkqhkiG9w0BAQUFADB2MQswCQYDVQQGEwJV
+UzELMAkGA1UECAwCQ0ExCzAJBgNVBAcMAlNGMQswCQYDVQQKDAJMQjEMMAoGA1UE
+CwwDTEI0MRIwEAYDVQQDDAlsb2NhbGhvc3QxHjAcBgkqhkiG9w0BCQEWD2xiNEBl
+eGFtcGxlLmNvbTAeFw0xODA2MjgxNDMwNTdaFw0xOTA2MjgxNDMwNTdaMHYxCzAJ
+BgNVBAYTAlVTMQswCQYDVQQIDAJDQTELMAkGA1UEBwwCU0YxCzAJBgNVBAoMAkxC
+MQwwCgYDVQQLDANMQjQxEjAQBgNVBAMMCWxvY2FsaG9zdDEeMBwGCSqGSIb3DQEJ
+ARYPbGI0QGV4YW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKC
+AQEA3mV25nB7LprWwnw2esZbzuS9vG68Eqcjiu9K0ZO9Ym8al70Wz1Q7ytqfuP4c
+DEjEAngvbkrT3W1ZaXUOQz5vxAa5OaLpB7moOZ3cldVyDTwlExBvFrXB5Qqrh/7Y
+c7OVvtb3Dah1wzvRHEt8I0EXPnojjae2uxmTu3ThZqACcpZS5SQC3hA3VOmcRpMS
+xKd8tvbbYYb37aaldOJkxcKge0C5adpOB8MsDvWZagBDCWaN41Wc/mER71Q1UMrz
+BrGB0Let4IibvUcW5nlUlfzu9qjY6ZXdb4cTDA7q6xTHmaIwhLklsI/K2Mda1YC5
+aIu558Kxaq1e3RWb0Hl/RpEQSQIDAQABMA0GCSqGSIb3DQEBBQUAA4IBAQCSdHKL
+juogGyAvUH0cAOahhvuUOnfpjcOWscRa1VLpI8lR9hWX5CLt3IIqT3gVFTl8bQbq
+joOfUB+ArusERMtay8l/dI83l6BxOkjhz8IcKT89W5emsHPDk6l0DAMmcrZAgMM5
+Ow9Rt3M5dEJ7tY3xWS9WpM3WCSpou+4AZt9PLE/sCqSjkDCO0/+ao1Pr9HORP40n
+NOPjSqMjlesUVlfJQTi0Rscal3BQG4+2cNG+p8KzR6KLEJruORuHzRqLWh3jkUKU
+snB9FTDkj9kSq287SidEcF2tfi2X6ptAoxv/jdFx6unZ1q3wI0qSDZYaEAbwlO84
+q3Y/oEQkYu19Wzta
+-----END CERTIFICATE-----

package/fixtures/copy-me.txt

@@ -0,0 +1 @@
+Hello World!

package/fixtures/key.pem

@@ -0,0 +1,28 @@
+-----BEGIN PRIVATE KEY-----
+MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDeZXbmcHsumtbC
+fDZ6xlvO5L28brwSpyOK70rRk71ibxqXvRbPVDvK2p+4/hwMSMQCeC9uStPdbVlp
+dQ5DPm/EBrk5oukHuag5ndyV1XINPCUTEG8WtcHlCquH/thzs5W+1vcNqHXDO9Ec
+S3wjQRc+eiONp7a7GZO7dOFmoAJyllLlJALeEDdU6ZxGkxLEp3y29tthhvftpqV0
+4mTFwqB7QLlp2k4HwywO9ZlqAEMJZo3jVZz+YRHvVDVQyvMGsYHQt63giJu9Rxbm
+eVSV/O72qNjpld1vhxMMDurrFMeZojCEuSWwj8rYx1rVgLloi7nnwrFqrV7dFZvQ
+eX9GkRBJAgMBAAECggEABHSh8jH0tdVSUiks6j7JHhcFGh5Z1EHW+3SZ2iMMm0lA
+jiOyrkqwu/qvUoR8yV431xjTUnFbV0dWkD9RHtXEZXgBA/+YjZgRn73i6nmRRGSd
+FYmxwBG6Jb2V/C6F5aOGb4FdB8AFQ/kR0nBMt2QZdB38Ul020v7LL+lCjszL38HL
+qPuZLbvQi4Vs4J8JpO8k2ST3gQhaYWb36XOACaD20mL2xHNpOO5vyBJSnNVb6ueg
+jpy1QV/1JOEumYLXFGOudk2QRm/yN2ym4gwpqD3sWIM9iYZsc84K61oibhLRZFtO
+luUnuRLrNrzpZfZga2EqEPUEy0IHLij1S9+H2MQTFQKBgQD+A9fwVDnY//PdSDBp
++xlggP2N3RdINi1EStPiLsy//Ok7xSCTXgE09iouZsjaP9r6nSKlG3SO18Hvy4CI
+whRzu95Z2vZQLYHuCCwLnqIhpM7xnFL93ueud7ATiE3fGFhJNUMGTYTQ+ZmwFuFQ
+7eddWrqVOEqezy2btpnsIVkINwKBgQDgIl4sZ7fl98S64+K0fcB0rCnrciL7OBap
+aucHuzmjydaVWW5WkzUOMxh+er2Zeqt1+0cTjnV6J7DJ96d/R8eWkNjTVtULJezf
+z91titYbB3O6TwYLx4IzXoweHuC/uLhE27Jxnvgz2IZacK1fKvql1lM5MaP7GDZ8
+VPvmiUFrfwKBgEABs+4JKzJ0/Hwr7pcmALUCi+GtbmpxzGJDALUj2dAe6J55A8Ze
+j6tKxEJBACeOo5027z3vdyVvVJ0aCF9tmD25f0PhGuQFM5JJWN/sryoPH15eZ8M0
+4ehinGmvlP+8YLLBywvRiMAnxQRMH6aG7B/n9tAXCSaPSgzMrGiF1qttAoGBAJ51
+Dbk9FpFZ6tbqF7PdF7wkn3padgq/q53Y+z7HCcgXAUMTN+OzLRY933pD0ll4lVHS
+9XwJAlr7RoxzLxLYL23uN6yqPfIkvOO6dGRmfFodmZ7FEZQwV4dzt4Hv+JrywCvG
+WtDjP7x/vvSfpqKaoxute6b6xmDVzGd4OaLRtNOHAoGAUyockJhGQEkUG9A21DXv
+hqR343WeUne1tqwfxkg0DQIBAaaFgGkeL1DjdHhE5ZNz+F/t5LRcvMkZDShRK0u3
+Ytnw2XtSJYtCrPlnDrt1/59dBr7S1nbhStI5xfPojctd0DbVvhC5UfQMKSNHOLCs
+tUWwM07FtltvXMoC0xXf5sI=
+-----END PRIVATE KEY-----

package/package.json

@@ -1,43 +1,57 @@
 {
   "name": "@loopback/testlab",
-  "version": "4.0.0-alpha.8",
   "description": "A collection of test utilities we use to write LoopBack tests.",
+  "version": "4.1.0",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "author": "IBM Corp.",
+  "copyright.owner": "IBM Corp.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/loopbackio/loopback-next.git",
+    "directory": "packages/testlab"
+  },
+  "engines": {
+    "node": "12 || 14 || 16 || 17"
+  },
   "scripts": {
-    "build": "npm run build:lib && npm run build:lib6",
-    "build:current": "node ../../bin/compile-package",
-    "build:lib": "node ../../bin/compile-package es2017",
-    "build:lib6": "node ../../bin/compile-package es2015",
-    "clean": "rm -rf loopback-testlab*.tgz lib* package",
-    "prepublish": "npm run build",
-    "pretest": "npm run build:current",
-    "test": "mocha",
+    "build": "lb-tsc",
+    "clean": "lb-clean loopback-testlab*.tgz dist *.tsbuildinfo package",
+    "pretest": "npm run build",
+    "test": "lb-mocha \"dist/__tests__/**/*.js\"",
     "verify": "npm pack && tar xf loopback-testlab*.tgz && tree package && npm run clean"
   },
-  "author": "IBM",
-  "license": "MIT",
-  "dependencies": {
-    "@loopback/openapi-spec": "^4.0.0-alpha.10",
-    "@types/shot": "^3.4.0",
-    "@types/sinon": "^2.3.2",
-    "@types/supertest": "^2.0.0",
-    "@types/swagger-parser": "^4.0.1",
-    "shot": "^3.4.0",
-    "should": "^11.2.1",
-    "should-sinon": "0.0.5",
-    "sinon": "^2.4.0",
-    "supertest": "^3.0.0",
-    "swagger-parser": "^3.4.1"
+  "publishConfig": {
+    "access": "public"
   },
   "files": [
     "README.md",
-    "index.js",
-    "index.d.ts",
-    "lib",
-    "lib6",
-    "should-as-function.d.ts"
+    "dist",
+    "fixtures",
+    "should-as-function.d.ts",
+    "src",
+    "!*/__tests__"
   ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/strongloop/loopback-next.git"
-  }
+  "dependencies": {
+    "@hapi/shot": "^5.0.5",
+    "@types/express": "^4.17.13",
+    "@types/fs-extra": "^9.0.13",
+    "@types/shot": "^4.0.1",
+    "@types/sinon": "^10.0.11",
+    "@types/supertest": "^2.0.11",
+    "express": "^4.17.2",
+    "fs-extra": "^10.0.0",
+    "oas-validator": "^5.0.8",
+    "should": "^13.2.3",
+    "sinon": "^11.1.2",
+    "supertest": "^6.2.2",
+    "tslib": "^2.3.1"
+  },
+  "devDependencies": {
+    "@loopback/build": "^8.1.0",
+    "@loopback/eslint-config": "^12.0.2",
+    "@types/node": "^12.20.43"
+  },
+  "gitHead": "e16818ccb01edc0269ef6c45b022c5f1b67f852c"
 }

package/should-as-function.d.ts

@@ -1,3 +1,8 @@
+// Copyright IBM Corp. 2017,2019. All Rights Reserved.
+// Node module: @loopback/testlab
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
 // Type definitions for should.js v8.1.1
 // Project: https://github.com/shouldjs/should.js
 // Definitions by: Alex Varju <https://github.com/varju/>, Maxime LUCE <https://github.com/SomaticIT/>
@@ -19,6 +24,9 @@ interface Object {
 }
 */
 
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable @typescript-eslint/unified-signatures */
+
 interface ShouldAssertion {
   // basic grammar
   a: ShouldAssertion;
@@ -113,7 +121,8 @@ interface ShouldAssertion {
   enumerables(...properties: string[]): ShouldAssertion;
   startWith(expected: string, message?: any): ShouldAssertion;
   endWith(expected: string, message?: any): ShouldAssertion;
-  throw(message?: any): ShouldAssertion;
+  throw(propereties?: {}): ShouldAssertion;
+  throw(message: Function | string | RegExp, properties?: {}): ShouldAssertion;
 
   //promises
   eventually: ShouldAssertion;
@@ -121,7 +130,8 @@ interface ShouldAssertion {
   fulfilled(): Promise<any>;
   fulfilledWith(value: any): Promise<any>;
   rejected(): Promise<any>;
-  rejectedWith(err: Error | string | RegExp): Promise<any>;
+  rejectedWith(err: Function | string | RegExp, properties?: {}): Promise<any>;
+  rejectedWith(properties: {}): Promise<any>;
 
   //http
   header(field: string, val?: string): ShouldAssertion;
@@ -204,7 +214,6 @@ interface Internal extends ShouldInternal {
 }
 
 declare var should: Internal;
-declare var Should: Internal;
 interface Window {
   Should: Internal;
 }

package/src/client.ts

@@ -0,0 +1,57 @@
+// Copyright IBM Corp. 2017,2020. All Rights Reserved.
+// Node module: @loopback/testlab
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+/*
+ * HTTP client utilities
+ */
+
+import http from 'http';
+import supertest from 'supertest';
+
+export {supertest};
+
+export type Client = supertest.SuperTest<supertest.Test>;
+
+/**
+ * Create a SuperTest client connected to an HTTP server listening
+ * on an ephemeral port and calling `handler` to handle incoming requests.
+ * @param handler
+ */
+export function createClientForHandler(
+  handler: (req: http.IncomingMessage, res: http.ServerResponse) => void,
+): Client {
+  const server = http.createServer(handler);
+  return supertest(server);
+}
+
+/**
+ * Create a SuperTest client for a running RestApplication instance.
+ * It is the responsibility of the caller to ensure that the app
+ * is running and to stop the application after all tests are done.
+ * @param app - A running (listening) instance of a RestApplication.
+ */
+export function createRestAppClient(app: RestApplicationLike) {
+  const url = app.restServer.rootUrl ?? app.restServer.url;
+  if (!url) {
+    throw new Error(
+      `Cannot create client for ${app.constructor.name}, it is not listening.`,
+    );
+  }
+  return supertest(url);
+}
+
+/*
+ * These interfaces are meant to partially mirror the formats provided
+ * in our other libraries to avoid circular imports.
+ */
+
+export interface RestApplicationLike {
+  restServer: RestServerLike;
+}
+
+export interface RestServerLike {
+  url?: string;
+  rootUrl?: string;
+}

package/src/expect.ts

@@ -0,0 +1,15 @@
+// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Node module: @loopback/testlab
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+// eslint-disable-next-line @typescript-eslint/triple-slash-reference
+/// <reference path="../should-as-function.d.ts" />
+
+const shouldAsFunction: Internal = require('should/as-function');
+
+shouldAsFunction.use((should, assertion) => {
+  assertion.addChain('to');
+});
+
+export const expect = shouldAsFunction;

package/src/http-error-logger.ts

@@ -0,0 +1,35 @@
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/testlab
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+import {Request} from 'express';
+import {IncomingMessage} from 'http';
+
+/**
+ * Creates a Logger that logs an Error if the HTTP status code is not expected
+ *
+ * @param expectedStatusCode - HTTP status code that is expected
+ */
+export function createUnexpectedHttpErrorLogger(
+  expectedStatusCode?: number,
+): LogError {
+  return function logUnexpectedHttpError(
+    err: Error,
+    statusCode: number,
+    req: IncomingMessage,
+  ) {
+    if (statusCode === expectedStatusCode) return;
+
+    /* istanbul ignore next */
+    console.error(
+      'Unhandled error in %s %s: %s %s',
+      req.method,
+      req.url,
+      statusCode,
+      err.stack ?? err,
+    );
+  };
+}
+
+type LogError = (err: Error, statusCode: number, request: Request) => void;

package/src/http-server-config.ts

@@ -0,0 +1,97 @@
+// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Node module: @loopback/testlab
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+import assert from 'assert';
+import {readFileSync} from 'fs';
+import {ServerOptions as HttpsServerOptions} from 'https';
+import {ListenOptions} from 'net';
+import path from 'path';
+
+const FIXTURES = path.resolve(__dirname, '../fixtures');
+const DUMMY_TLS_CONFIG = {
+  key: readFileSync(path.join(FIXTURES, 'key.pem')),
+  cert: readFileSync(path.join(FIXTURES, 'cert.pem')),
+};
+
+export interface HttpOptions extends ListenOptions {
+  protocol?: 'http';
+}
+
+export interface HttpsOptions extends ListenOptions, HttpsServerOptions {
+  protocol: 'https';
+}
+
+/**
+ * An object that requires host and port properties
+ */
+export interface HostPort {
+  host: string;
+  port: number;
+}
+
+/**
+ * Assertion type guard for TypeScript to ensure `host` and `port` are set
+ * @param config - Host/port configuration
+ */
+function assertHostPort(config: Partial<HostPort>): asserts config is HostPort {
+  assert(config.host != null, 'host is not set');
+  assert(config.port != null, 'port is not set');
+}
+
+/**
+ * Create an HTTP-server configuration that works well in test environments.
+ *  - Ask the operating system to assign a free (ephemeral) port.
+ *  - Use IPv4 localhost `127.0.0.1` to avoid known IPv6 issues in Docker-based
+ *    environments like Travis-CI.
+ *  - Provide default TLS key & cert when `protocol` is set to `https`.
+ *
+ * @param customConfig - Additional configuration options to apply.
+ */
+export function givenHttpServerConfig<T extends HttpOptions | HttpsOptions>(
+  customConfig?: T,
+): HostPort & T {
+  const defaults: HostPort = {host: '127.0.0.1', port: 0};
+
+  if (isHttpsConfig(customConfig)) {
+    const config: T = {...customConfig};
+    if (config.host == null) config.host = defaults.host;
+    if (config.port == null) config.port = defaults.port;
+    setupTlsConfig(config);
+    assertHostPort(config);
+    return config;
+  }
+
+  assertHttpConfig(customConfig);
+  const config: T = {...customConfig};
+  if (config.host == null) config.host = defaults.host;
+  if (config.port == null) config.port = defaults.port;
+  assertHostPort(config);
+  return config;
+}
+
+function setupTlsConfig(config: HttpsServerOptions) {
+  if ('key' in config && 'cert' in config) return;
+  if ('pfx' in config) return;
+  Object.assign(config, DUMMY_TLS_CONFIG);
+}
+
+/**
+ * Type guard to check if the parameter is `HttpsOptions`
+ */
+function isHttpsConfig(
+  config?: HttpOptions | HttpsOptions,
+): config is HttpsOptions {
+  return config?.protocol === 'https';
+}
+
+/**
+ * Type guard to assert the parameter is `HttpOptions`
+ * @param config - Http config
+ */
+function assertHttpConfig(
+  config?: HttpOptions | HttpsOptions,
+): asserts config is HttpOptions {
+  assert(config?.protocol == null || config?.protocol === 'http');
+}

package/src/index.ts

@@ -0,0 +1,37 @@
+// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Node module: @loopback/testlab
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+/**
+ * A collection of test utilities we use to write LoopBack tests.
+ *
+ * @remarks
+ * Test utilities to help write LoopBack 4 tests:
+ *
+ * - `expect` - behavior-driven development (BDD) style assertions
+ * - `sinon`
+ *   - test spies: functions recording arguments and other information for all
+ *     of their calls
+ *   - stubs: functions (spies) with pre-programmed behavior
+ *   - mocks: fake methods (like spies) with pre-programmed behavior
+ *     (like stubs) as well as pre-programmed expectations
+ * - Helpers for creating `supertest` clients for LoopBack applications
+ * - HTTP request/response stubs for writing tests without a listening HTTP
+ *   server
+ * - Swagger/OpenAPI spec validation
+ *
+ * @packageDocumentation
+ */
+
+export * from './client';
+export * from './expect';
+export * from './http-error-logger';
+export * from './http-server-config';
+export * from './request';
+export * from './shot';
+export * from './sinon';
+export * from './skip';
+export * from './test-sandbox';
+export * from './to-json';
+export * from './validate-api-spec';