@loopback/testlab 4.0.0-alpha.8 → 4.1.0

package/dist/http-server-config.js

@@ -0,0 +1,76 @@
+"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.givenHttpServerConfig = void 0;
+const tslib_1 = require("tslib");
+const assert_1 = (0, tslib_1.__importDefault)(require("assert"));
+const fs_1 = require("fs");
+const path_1 = (0, tslib_1.__importDefault)(require("path"));
+const FIXTURES = path_1.default.resolve(__dirname, '../fixtures');
+const DUMMY_TLS_CONFIG = {
+    key: (0, fs_1.readFileSync)(path_1.default.join(FIXTURES, 'key.pem')),
+    cert: (0, fs_1.readFileSync)(path_1.default.join(FIXTURES, 'cert.pem')),
+};
+/**
+ * Assertion type guard for TypeScript to ensure `host` and `port` are set
+ * @param config - Host/port configuration
+ */
+function assertHostPort(config) {
+    (0, assert_1.default)(config.host != null, 'host is not set');
+    (0, assert_1.default)(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.
+ */
+function givenHttpServerConfig(customConfig) {
+    const defaults = { host: '127.0.0.1', port: 0 };
+    if (isHttpsConfig(customConfig)) {
+        const config = { ...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 = { ...customConfig };
+    if (config.host == null)
+        config.host = defaults.host;
+    if (config.port == null)
+        config.port = defaults.port;
+    assertHostPort(config);
+    return config;
+}
+exports.givenHttpServerConfig = givenHttpServerConfig;
+function setupTlsConfig(config) {
+    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) {
+    return (config === null || config === void 0 ? void 0 : config.protocol) === 'https';
+}
+/**
+ * Type guard to assert the parameter is `HttpOptions`
+ * @param config - Http config
+ */
+function assertHttpConfig(config) {
+    (0, assert_1.default)((config === null || config === void 0 ? void 0 : config.protocol) == null || (config === null || config === void 0 ? void 0 : config.protocol) === 'http');
+}
+//# sourceMappingURL=http-server-config.js.map

package/dist/http-server-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-server-config.js","sourceRoot":"","sources":["../src/http-server-config.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,iEAA4B;AAC5B,2BAAgC;AAGhC,6DAAwB;AAExB,MAAM,QAAQ,GAAG,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;AACxD,MAAM,gBAAgB,GAAG;IACvB,GAAG,EAAE,IAAA,iBAAY,EAAC,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IACjD,IAAI,EAAE,IAAA,iBAAY,EAAC,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;CACpD,CAAC;AAkBF;;;GAGG;AACH,SAAS,cAAc,CAAC,MAAyB;IAC/C,IAAA,gBAAM,EAAC,MAAM,CAAC,IAAI,IAAI,IAAI,EAAE,iBAAiB,CAAC,CAAC;IAC/C,IAAA,gBAAM,EAAC,MAAM,CAAC,IAAI,IAAI,IAAI,EAAE,iBAAiB,CAAC,CAAC;AACjD,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,qBAAqB,CACnC,YAAgB;IAEhB,MAAM,QAAQ,GAAa,EAAC,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,EAAC,CAAC;IAExD,IAAI,aAAa,CAAC,YAAY,CAAC,EAAE;QAC/B,MAAM,MAAM,GAAM,EAAC,GAAG,YAAY,EAAC,CAAC;QACpC,IAAI,MAAM,CAAC,IAAI,IAAI,IAAI;YAAE,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;QACrD,IAAI,MAAM,CAAC,IAAI,IAAI,IAAI;YAAE,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;QACrD,cAAc,CAAC,MAAM,CAAC,CAAC;QACvB,cAAc,CAAC,MAAM,CAAC,CAAC;QACvB,OAAO,MAAM,CAAC;KACf;IAED,gBAAgB,CAAC,YAAY,CAAC,CAAC;IAC/B,MAAM,MAAM,GAAM,EAAC,GAAG,YAAY,EAAC,CAAC;IACpC,IAAI,MAAM,CAAC,IAAI,IAAI,IAAI;QAAE,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;IACrD,IAAI,MAAM,CAAC,IAAI,IAAI,IAAI;QAAE,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;IACrD,cAAc,CAAC,MAAM,CAAC,CAAC;IACvB,OAAO,MAAM,CAAC;AAChB,CAAC;AApBD,sDAoBC;AAED,SAAS,cAAc,CAAC,MAA0B;IAChD,IAAI,KAAK,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM;QAAE,OAAO;IAChD,IAAI,KAAK,IAAI,MAAM;QAAE,OAAO;IAC5B,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;AAC1C,CAAC;AAED;;GAEG;AACH,SAAS,aAAa,CACpB,MAAmC;IAEnC,OAAO,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,MAAK,OAAO,CAAC;AACtC,CAAC;AAED;;;GAGG;AACH,SAAS,gBAAgB,CACvB,MAAmC;IAEnC,IAAA,gBAAM,EAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,KAAI,IAAI,IAAI,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,MAAK,MAAM,CAAC,CAAC;AAClE,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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';

package/dist/index.js

@@ -0,0 +1,39 @@
+"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 });
+const tslib_1 = require("tslib");
+/**
+ * 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
+ */
+(0, tslib_1.__exportStar)(require("./client"), exports);
+(0, tslib_1.__exportStar)(require("./expect"), exports);
+(0, tslib_1.__exportStar)(require("./http-error-logger"), exports);
+(0, tslib_1.__exportStar)(require("./http-server-config"), exports);
+(0, tslib_1.__exportStar)(require("./request"), exports);
+(0, tslib_1.__exportStar)(require("./shot"), exports);
+(0, tslib_1.__exportStar)(require("./sinon"), exports);
+(0, tslib_1.__exportStar)(require("./skip"), exports);
+(0, tslib_1.__exportStar)(require("./test-sandbox"), exports);
+(0, tslib_1.__exportStar)(require("./to-json"), exports);
+(0, tslib_1.__exportStar)(require("./validate-api-spec"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;AAEhE;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,wDAAyB;AACzB,wDAAyB;AACzB,mEAAoC;AACpC,oEAAqC;AACrC,yDAA0B;AAC1B,sDAAuB;AACvB,uDAAwB;AACxB,sDAAuB;AACvB,8DAA+B;AAC/B,yDAA0B;AAC1B,mEAAoC"}

package/dist/request.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="node" />
+import http, { IncomingMessage } from 'http';
+import https from 'https';
+/**
+ * Async wrapper for making HTTP GET requests
+ * @param urlString
+ */
+export declare function httpGetAsync(urlString: string, agent?: http.Agent): Promise<IncomingMessage>;
+/**
+ * Async wrapper for making HTTPS GET requests
+ * @param urlString
+ */
+export declare function httpsGetAsync(urlString: string, agent?: https.Agent): Promise<IncomingMessage>;

package/dist/request.js

@@ -0,0 +1,40 @@
+"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.httpsGetAsync = exports.httpGetAsync = void 0;
+const tslib_1 = require("tslib");
+const http_1 = (0, tslib_1.__importDefault)(require("http"));
+const https_1 = (0, tslib_1.__importDefault)(require("https"));
+const url_1 = (0, tslib_1.__importDefault)(require("url"));
+/**
+ * Async wrapper for making HTTP GET requests
+ * @param urlString
+ */
+function httpGetAsync(urlString, agent) {
+    return new Promise((resolve, reject) => {
+        const urlOptions = url_1.default.parse(urlString);
+        const options = { agent, ...urlOptions };
+        http_1.default.get(options, resolve).on('error', reject);
+    });
+}
+exports.httpGetAsync = httpGetAsync;
+/**
+ * Async wrapper for making HTTPS GET requests
+ * @param urlString
+ */
+function httpsGetAsync(urlString, agent) {
+    agent =
+        agent !== null && agent !== void 0 ? agent : new https_1.default.Agent({
+            rejectUnauthorized: false,
+        });
+    const urlOptions = url_1.default.parse(urlString);
+    const options = { agent, ...urlOptions };
+    return new Promise((resolve, reject) => {
+        https_1.default.get(options, resolve).on('error', reject);
+    });
+}
+exports.httpsGetAsync = httpsGetAsync;
+//# sourceMappingURL=request.js.map

package/dist/request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.js","sourceRoot":"","sources":["../src/request.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,6DAA2C;AAC3C,+DAA0B;AAC1B,2DAAsB;AAEtB;;;GAGG;AACH,SAAgB,YAAY,CAC1B,SAAiB,EACjB,KAAkB;IAElB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,UAAU,GAAG,aAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACxC,MAAM,OAAO,GAAG,EAAC,KAAK,EAAE,GAAG,UAAU,EAAC,CAAC;QACvC,cAAI,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;AACL,CAAC;AATD,oCASC;AAED;;;GAGG;AACH,SAAgB,aAAa,CAC3B,SAAiB,EACjB,KAAmB;IAEnB,KAAK;QACH,KAAK,aAAL,KAAK,cAAL,KAAK,GACL,IAAI,eAAK,CAAC,KAAK,CAAC;YACd,kBAAkB,EAAE,KAAK;SAC1B,CAAC,CAAC;IAEL,MAAM,UAAU,GAAG,aAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACxC,MAAM,OAAO,GAAG,EAAC,KAAK,EAAE,GAAG,UAAU,EAAC,CAAC;IAEvC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,eAAK,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;AACL,CAAC;AAhBD,sCAgBC"}

package/dist/shot.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="node" />
+import express from 'express';
+import { IncomingMessage, ServerResponse } from 'http';
+import { Listener as ShotListener, RequestOptions as ShotRequestOptions, ResponseObject } from 'shot';
+declare const inject: (dispatchFunc: ShotListener, options: ShotRequestOptions) => Promise<ResponseObject>;
+export { inject, ShotRequestOptions };
+export declare function stubServerRequest(options: ShotRequestOptions): IncomingMessage;
+export declare type ShotCallback = (response: ResponseObject) => void;
+export declare type ShotResponseCtor = new (request: IncomingMessage, onEnd: ShotCallback) => ServerResponse;
+export declare function stubServerResponse(request: IncomingMessage, onEnd: ShotCallback): ServerResponse;
+export declare type ObservedResponse = ResponseObject;
+export interface HandlerContextStub {
+    request: IncomingMessage;
+    response: ServerResponse;
+    result: Promise<ObservedResponse>;
+}
+export declare function stubHandlerContext(requestOptions?: ShotRequestOptions): HandlerContextStub;
+export interface ExpressContextStub extends HandlerContextStub {
+    app: express.Application;
+    request: express.Request;
+    response: express.Response;
+    result: Promise<ObservedResponse>;
+}
+export declare function stubExpressContext(requestOptions?: ShotRequestOptions): ExpressContextStub;

package/dist/shot.js

@@ -0,0 +1,108 @@
+"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.stubExpressContext = exports.stubHandlerContext = exports.stubServerResponse = exports.stubServerRequest = exports.inject = void 0;
+const tslib_1 = require("tslib");
+/*
+ * HTTP Request/Response mocks
+ * https://github.com/hapijs/shot
+ */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const express_1 = (0, tslib_1.__importDefault)(require("express"));
+const util_1 = (0, tslib_1.__importDefault)(require("util"));
+const inject = require('@hapi/shot');
+exports.inject = inject;
+const ShotRequest = require('@hapi/shot/lib/request');
+function stubServerRequest(options) {
+    const stub = new ShotRequest(options);
+    // Hacky workaround for Express, see
+    // https://github.com/expressjs/express/blob/4.16.3/lib/middleware/init.js
+    // https://github.com/hapijs/shot/issues/82#issuecomment-247943773
+    // https://github.com/jfhbrook/pickleback
+    Object.assign(stub, ShotRequest.prototype);
+    return stub;
+}
+exports.stubServerRequest = stubServerRequest;
+const ShotResponse = require('@hapi/shot/lib/response');
+function stubServerResponse(request, onEnd) {
+    const stub = new ShotResponse(request, onEnd);
+    // Hacky workaround for Express, see
+    // https://github.com/expressjs/express/blob/4.16.3/lib/middleware/init.js
+    // https://github.com/hapijs/shot/issues/82#issuecomment-247943773
+    // https://github.com/jfhbrook/pickleback
+    Object.assign(stub, ShotResponse.prototype);
+    return stub;
+}
+exports.stubServerResponse = stubServerResponse;
+function stubHandlerContext(requestOptions = { url: '/' }) {
+    const request = stubServerRequest(requestOptions);
+    let response;
+    const result = new Promise(resolve => {
+        response = new ShotResponse(request, resolve);
+    });
+    const context = { request, response: response, result };
+    defineCustomContextInspect(context, requestOptions);
+    return context;
+}
+exports.stubHandlerContext = stubHandlerContext;
+function stubExpressContext(requestOptions = { url: '/' }) {
+    const app = (0, express_1.default)();
+    const request = new ShotRequest(requestOptions);
+    // mix in Express Request API
+    const RequestApi = express_1.default.request;
+    for (const key of Object.getOwnPropertyNames(RequestApi)) {
+        Object.defineProperty(request, key, Object.getOwnPropertyDescriptor(RequestApi, key));
+    }
+    request.app = app;
+    request.originalUrl = request.url;
+    parseQuery(request);
+    let response;
+    const result = new Promise(resolve => {
+        response = new ShotResponse(request, resolve);
+        // mix in Express Response API
+        Object.assign(response, express_1.default.response);
+        const ResponseApi = express_1.default.response;
+        for (const key of Object.getOwnPropertyNames(ResponseApi)) {
+            Object.defineProperty(response, key, Object.getOwnPropertyDescriptor(ResponseApi, key));
+        }
+        response.app = app;
+        response.req = request;
+        request.res = response;
+    });
+    const context = { app, request, response: response, result };
+    defineCustomContextInspect(context, requestOptions);
+    return context;
+}
+exports.stubExpressContext = stubExpressContext;
+/**
+ * Use `express.query` to parse the query string into `request.query` object
+ * @param request - Express http request object
+ */
+function parseQuery(request) {
+    // Use `express.query` to parse the query string
+    // See https://github.com/expressjs/express/blob/master/lib/express.js#L79
+    // See https://github.com/expressjs/express/blob/master/lib/middleware/query.js
+    express_1.default.query()(request, {}, () => { });
+}
+function defineCustomContextInspect(context, requestOptions) {
+    // Setup custom inspect functions to make test error messages easier to read
+    const inspectOpts = (depth, opts) => util_1.default.inspect(requestOptions, opts);
+    defineCustomInspect(context.request, (depth, opts) => `[RequestStub with options ${inspectOpts(depth, opts)}]`);
+    defineCustomInspect(context.response, (depth, opts) => `[ResponseStub for request with options ${inspectOpts(depth, opts)}]`);
+    context.result = context.result.then(r => {
+        defineCustomInspect(r, (depth, opts) => `[ObservedResponse for request with options ${inspectOpts(depth, opts)}]`);
+        return r;
+    });
+}
+// @types/node@v10.17.29 seems to miss the type definition of `util.inspect.custom`
+// error TS2339: Property 'custom' does not exist on type 'typeof inspect'.
+// Use a workaround for now to access the `custom` symbol for now.
+// https://nodejs.org/api/util.html#util_util_inspect_custom
+const custom = Symbol.for('nodejs.util.inspect.custom');
+function defineCustomInspect(obj, inspectFn) {
+    obj[custom] = inspectFn;
+}
+//# sourceMappingURL=shot.js.map

package/dist/shot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shot.js","sourceRoot":"","sources":["../src/shot.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE;;;GAGG;AAEH,uDAAuD;AAEvD,mEAA8B;AAO9B,6DAAwB;AAExB,MAAM,MAAM,GAGmB,OAAO,CAAC,YAAY,CAAC,CAAC;AAG7C,wBAAM;AAEd,MAAM,WAAW,GAAoB,OAAO,CAAC,wBAAwB,CAAC,CAAC;AAGvE,SAAgB,iBAAiB,CAC/B,OAA2B;IAE3B,MAAM,IAAI,GAAG,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC;IACtC,oCAAoC;IACpC,0EAA0E;IAC1E,kEAAkE;IAClE,yCAAyC;IACzC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;IAC3C,OAAO,IAAI,CAAC;AACd,CAAC;AAVD,8CAUC;AAED,MAAM,YAAY,GAAqB,OAAO,CAAC,yBAAyB,CAAC,CAAC;AAQ1E,SAAgB,kBAAkB,CAChC,OAAwB,EACxB,KAAmB;IAEnB,MAAM,IAAI,GAAG,IAAI,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC9C,oCAAoC;IACpC,0EAA0E;IAC1E,kEAAkE;IAClE,yCAAyC;IACzC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC;IAC5C,OAAO,IAAI,CAAC;AACd,CAAC;AAXD,gDAWC;AAUD,SAAgB,kBAAkB,CAChC,iBAAqC,EAAC,GAAG,EAAE,GAAG,EAAC;IAE/C,MAAM,OAAO,GAAG,iBAAiB,CAAC,cAAc,CAAC,CAAC;IAClD,IAAI,QAAoC,CAAC;IACzC,MAAM,MAAM,GAAG,IAAI,OAAO,CAAmB,OAAO,CAAC,EAAE;QACrD,QAAQ,GAAG,IAAI,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,EAAC,OAAO,EAAE,QAAQ,EAAE,QAAS,EAAE,MAAM,EAAC,CAAC;IACvD,0BAA0B,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;IACpD,OAAO,OAAO,CAAC;AACjB,CAAC;AAZD,gDAYC;AASD,SAAgB,kBAAkB,CAChC,iBAAqC,EAAC,GAAG,EAAE,GAAG,EAAC;IAE/C,MAAM,GAAG,GAAG,IAAA,iBAAO,GAAE,CAAC;IAEtB,MAAM,OAAO,GAAG,IAAI,WAAW,CAAC,cAAc,CAAoB,CAAC;IACnE,6BAA6B;IAC7B,MAAM,UAAU,GAAI,iBAAe,CAAC,OAAO,CAAC;IAC5C,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,mBAAmB,CAAC,UAAU,CAAC,EAAE;QACxD,MAAM,CAAC,cAAc,CACnB,OAAO,EACP,GAAG,EACH,MAAM,CAAC,wBAAwB,CAAC,UAAU,EAAE,GAAG,CAAE,CAClD,CAAC;KACH;IACD,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC;IAClB,OAAO,CAAC,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC;IAClC,UAAU,CAAC,OAAO,CAAC,CAAC;IAEpB,IAAI,QAAsC,CAAC;IAC3C,MAAM,MAAM,GAAG,IAAI,OAAO,CAAmB,OAAO,CAAC,EAAE;QACrD,QAAQ,GAAG,IAAI,YAAY,CAAC,OAAO,EAAE,OAAO,CAAqB,CAAC;QAClE,8BAA8B;QAC9B,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAG,iBAAe,CAAC,QAAQ,CAAC,CAAC;QACnD,MAAM,WAAW,GAAI,iBAAe,CAAC,QAAQ,CAAC;QAC9C,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,mBAAmB,CAAC,WAAW,CAAC,EAAE;YACzD,MAAM,CAAC,cAAc,CACnB,QAAQ,EACR,GAAG,EACH,MAAM,CAAC,wBAAwB,CAAC,WAAW,EAAE,GAAG,CAAE,CACnD,CAAC;SACH;QACD,QAAQ,CAAC,GAAG,GAAG,GAAG,CAAC;QAClB,QAAgB,CAAC,GAAG,GAAG,OAAO,CAAC;QAC/B,OAAe,CAAC,GAAG,GAAG,QAAQ,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,EAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAS,EAAE,MAAM,EAAC,CAAC;IAC5D,0BAA0B,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;IACpD,OAAO,OAAO,CAAC;AACjB,CAAC;AAxCD,gDAwCC;AAED;;;GAGG;AACH,SAAS,UAAU,CAAC,OAAwB;IAC1C,gDAAgD;IAChD,0EAA0E;IAC1E,+EAA+E;IAC9E,iBAAe,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,EAAE,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;AAClD,CAAC;AAED,SAAS,0BAA0B,CACjC,OAA2B,EAC3B,cAAkC;IAElC,4EAA4E;IAC5E,MAAM,WAAW,GAAG,CAAC,KAAa,EAAE,IAAS,EAAE,EAAE,CAC/C,cAAI,CAAC,OAAO,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;IAErC,mBAAmB,CACjB,OAAO,CAAC,OAAO,EACf,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,6BAA6B,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,CAC1E,CAAC;IAEF,mBAAmB,CACjB,OAAO,CAAC,QAAQ,EAChB,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CACd,0CAA0C,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,CACxE,CAAC;IAEF,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE;QACvC,mBAAmB,CACjB,CAAC,EACD,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CACd,8CAA8C,WAAW,CACvD,KAAK,EACL,IAAI,CACL,GAAG,CACP,CAAC;QACF,OAAO,CAAC,CAAC;IACX,CAAC,CAAC,CAAC;AACL,CAAC;AAED,mFAAmF;AACnF,2EAA2E;AAC3E,kEAAkE;AAClE,4DAA4D;AAC5D,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;AAExD,SAAS,mBAAmB,CAC1B,GAAQ,EACR,SAA2C;IAE3C,GAAG,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;AAC1B,CAAC"}

package/dist/sinon.d.ts

@@ -0,0 +1,25 @@
+import sinon, { SinonSpy } from 'sinon';
+export { sinon, SinonSpy };
+export declare type StubbedInstanceWithSinonAccessor<T> = T & {
+    stubs: sinon.SinonStubbedInstance<T>;
+};
+/**
+ * Creates a new object with the given functions as the prototype and stubs all
+ * implemented functions.
+ *
+ * Note: The given constructor function is not invoked. See also the stub API.
+ *
+ * This is a helper method replacing `sinon.createStubInstance` and working
+ * around the limitations of TypeScript and Sinon, where Sinon is not able to
+ * list private/protected members in the type definition of the stub instance
+ * and therefore the stub instance cannot be assigned to places expecting TType.
+ * See also
+ *  - https://github.com/Microsoft/TypeScript/issues/13543
+ *  - https://github.com/DefinitelyTyped/DefinitelyTyped/issues/14811
+ *
+ * @typeParam TType - Type being stubbed.
+ * @param constructor - Object or class to stub.
+ * @returns A stubbed version of the constructor, with an extra property `stubs`
+ * providing access to stub API for individual methods.
+ */
+export declare function createStubInstance<TType>(constructor: sinon.StubbableType<TType>): StubbedInstanceWithSinonAccessor<TType>;

package/dist/sinon.js

@@ -0,0 +1,35 @@
+"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.createStubInstance = exports.sinon = void 0;
+const tslib_1 = require("tslib");
+const sinon_1 = (0, tslib_1.__importDefault)(require("sinon"));
+exports.sinon = sinon_1.default;
+/**
+ * Creates a new object with the given functions as the prototype and stubs all
+ * implemented functions.
+ *
+ * Note: The given constructor function is not invoked. See also the stub API.
+ *
+ * This is a helper method replacing `sinon.createStubInstance` and working
+ * around the limitations of TypeScript and Sinon, where Sinon is not able to
+ * list private/protected members in the type definition of the stub instance
+ * and therefore the stub instance cannot be assigned to places expecting TType.
+ * See also
+ *  - https://github.com/Microsoft/TypeScript/issues/13543
+ *  - https://github.com/DefinitelyTyped/DefinitelyTyped/issues/14811
+ *
+ * @typeParam TType - Type being stubbed.
+ * @param constructor - Object or class to stub.
+ * @returns A stubbed version of the constructor, with an extra property `stubs`
+ * providing access to stub API for individual methods.
+ */
+function createStubInstance(constructor) {
+    const stub = sinon_1.default.createStubInstance(constructor);
+    return Object.assign(stub, { stubs: stub });
+}
+exports.createStubInstance = createStubInstance;
+//# sourceMappingURL=sinon.js.map

package/dist/sinon.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sinon.js","sourceRoot":"","sources":["../src/sinon.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,+DAAsC;AAE9B,gBAFD,eAAK,CAEC;AAMb;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,kBAAkB,CAChC,WAAuC;IAEvC,MAAM,IAAI,GAAG,eAAK,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;IACnD,OAAO,MAAM,CAAC,MAAM,CAAC,IAAa,EAAE,EAAC,KAAK,EAAE,IAAI,EAAC,CAAC,CAAC;AACrD,CAAC;AALD,gDAKC"}

package/dist/skip.d.ts

@@ -0,0 +1,49 @@
+/**
+ * A function defining a new test case or a test suite, e.g. `it` or `describe`.
+ */
+export declare type TestDefinition<ARGS extends unknown[], RETVAL> = (name: string, ...args: ARGS) => RETVAL;
+/**
+ * Helper function for skipping tests when a certain condition is met.
+ *
+ * @example
+ * ```ts
+ * skipIf(
+ *   !features.freeFormProperties,
+ *   describe,
+ *  'free-form properties (strict: false)',
+ *   () => {
+ *     // the tests
+ *   }
+ * );
+ * ```
+ *
+ * @param skip - Should the test case/suite be skipped?
+ * @param verb - The function to invoke to define the test case or the test
+ * suite, e.g. `it` or `describe`.
+ * @param name - The test name (the first argument of `verb` function).
+ * @param args - Additional arguments (framework specific), typically a function
+ * implementing the test.
+ */
+export declare function skipIf<ARGS extends unknown[], RETVAL>(skip: boolean, verb: TestDefinition<ARGS, RETVAL> & {
+    skip: TestDefinition<ARGS, RETVAL>;
+}, name: string, ...args: ARGS): RETVAL;
+/**
+ * Helper function for skipping tests on Travis CI.
+ *
+ * @example
+ *
+ * ```ts
+ * skipOnTravis(it, 'does something when some condition', async () => {
+ *   // the test
+ * });
+ * ```
+ *
+ * @param verb - The function to invoke to define the test case or the test
+ * suite, e.g. `it` or `describe`.
+ * @param name - The test name (the first argument of `verb` function).
+ * @param args - Additional arguments (framework specific), typically a function
+ * implementing the test.
+ */
+export declare function skipOnTravis<ARGS extends unknown[], RETVAL>(verb: TestDefinition<ARGS, RETVAL> & {
+    skip: TestDefinition<ARGS, RETVAL>;
+}, name: string, ...args: ARGS): RETVAL;

package/dist/skip.js

@@ -0,0 +1,65 @@
+"use strict";
+// Copyright IBM Corp. 2019,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.skipOnTravis = exports.skipIf = void 0;
+/**
+ * Helper function for skipping tests when a certain condition is met.
+ *
+ * @example
+ * ```ts
+ * skipIf(
+ *   !features.freeFormProperties,
+ *   describe,
+ *  'free-form properties (strict: false)',
+ *   () => {
+ *     // the tests
+ *   }
+ * );
+ * ```
+ *
+ * @param skip - Should the test case/suite be skipped?
+ * @param verb - The function to invoke to define the test case or the test
+ * suite, e.g. `it` or `describe`.
+ * @param name - The test name (the first argument of `verb` function).
+ * @param args - Additional arguments (framework specific), typically a function
+ * implementing the test.
+ */
+function skipIf(skip, verb, name, ...args) {
+    if (skip) {
+        return verb.skip(`[SKIPPED] ${name}`, ...args);
+    }
+    else {
+        return verb(name, ...args);
+    }
+}
+exports.skipIf = skipIf;
+/**
+ * Helper function for skipping tests on Travis CI.
+ *
+ * @example
+ *
+ * ```ts
+ * skipOnTravis(it, 'does something when some condition', async () => {
+ *   // the test
+ * });
+ * ```
+ *
+ * @param verb - The function to invoke to define the test case or the test
+ * suite, e.g. `it` or `describe`.
+ * @param name - The test name (the first argument of `verb` function).
+ * @param args - Additional arguments (framework specific), typically a function
+ * implementing the test.
+ */
+function skipOnTravis(verb, name, ...args) {
+    if (process.env.TRAVIS) {
+        return verb.skip(`[SKIPPED ON TRAVIS] ${name}`, ...args);
+    }
+    else {
+        return verb(name, ...args);
+    }
+}
+exports.skipOnTravis = skipOnTravis;
+//# sourceMappingURL=skip.js.map

package/dist/skip.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"skip.js","sourceRoot":"","sources":["../src/skip.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;AAUhE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,MAAM,CACpB,IAAa,EACb,IAAyE,EACzE,IAAY,EACZ,GAAG,IAAU;IAEb,IAAI,IAAI,EAAE;QACR,OAAO,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;KAChD;SAAM;QACL,OAAO,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;KAC5B;AACH,CAAC;AAXD,wBAWC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,YAAY,CAC1B,IAAyE,EACzE,IAAY,EACZ,GAAG,IAAU;IAEb,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE;QACtB,OAAO,IAAI,CAAC,IAAI,CAAC,uBAAuB,IAAI,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;KAC1D;SAAM;QACL,OAAO,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;KAC5B;AACH,CAAC;AAVD,oCAUC"}

package/dist/test-sandbox.d.ts

@@ -0,0 +1,89 @@
+/**
+ * Options for a test sandbox
+ */
+export interface TestSandboxOptions {
+    /**
+     * The `subdir` controls if/how the sandbox creates a subdirectory under the
+     * root path. It has one of the following values:
+     *
+     * - `true`: Creates a unique subdirectory. This will be the default behavior.
+     * - `false`: Uses the root path as the target directory without creating a
+     * subdirectory.
+     * - a string such as `sub-dir-1`: creates a subdirectory with the given value.
+     */
+    subdir: boolean | string;
+}
+/**
+ * TestSandbox class provides a convenient way to get a reference to a
+ * sandbox folder in which you can perform operations for testing purposes.
+ */
+export declare class TestSandbox {
+    private _path?;
+    get path(): string;
+    /**
+     * 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: string, options?: TestSandboxOptions);
+    /**
+     * Resets the TestSandbox. (Remove all files in it).
+     */
+    reset(): Promise<void>;
+    /**
+     * Deletes the TestSandbox.
+     */
+    delete(): Promise<void>;
+    /**
+     * Makes a directory in the TestSandbox
+     *
+     * @param dir - Name of directory to create (relative to TestSandbox path)
+     */
+    mkdir(dir: string): Promise<void>;
+    /**
+     * 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.
+     */
+    copyFile(src: string, dest?: string, transform?: (content: string) => string): Promise<void>;
+    /**
+     * 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.
+     */
+    writeJsonFile(dest: string, data: unknown): Promise<void>;
+    /**
+     * 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.
+     */
+    writeTextFile(dest: string, data: string): Promise<void>;
+}