@loopback/testlab 3.2.12 → 3.4.1

package/README.md

@@ -85,119 +85,6 @@ by Shot in your unit tests:
 - Code modifying core HTTP Response, including full request/response handlers
 - Code parsing Express HTTP Request or modifying Express HTTP Response
 
-### `skipIf`
-
-Helper function for skipping tests when a certain condition is met. Use this
-helper together with `it` or `describe`.
-
-```ts
-skipIf(someCondition, it, 'does something', async () => {
-  // the test code
-});
-```
-
-Unfortunately, type inference does not work well for `describe`, you have to
-help the compiler to figure out the correct types.
-
-```ts
-skipIf<[(this: Suite) => void], void>(
-  someCondition,
-  describe,
-  'some suite name',
-  () => {
-    // define the test cases
-  },
-);
-```
-
-Under the hood, `skipIf` invokes the provided test verb by default (e.g. `it`).
-When the provided condition was true, then it calls `.skip` instead (e.g.
-`it.skip`).
-
-### `skipOnTravis`
-
-Helper function for skipping tests on Travis environment. If you need to skip
-testing on Travis for any reason, use this helper together with `it` or
-`describe`.
-
-```ts
-skipOnTravis(it, 'does something when some condition', async () => {
-  // the test code
-});
-```
-
-Under the hood, `skipOnTravis` invokes the provided test verb by default (e.g.
-`it`). When the helper detects Travis CI environment variables, then it calls
-`.skip` instead (e.g. `it.skip`).
-
-### `createRestAppClient`
-
-Helper function to create a `supertest` client connected to a running
-RestApplication. It is the responsibility of the caller to ensure that the app
-is running and to stop the application after all tests are done.
-
-Example use:
-
-```ts
-import {Client, createRestAppClient} from '@loopback/testlab';
-
-describe('My application', () => {
-  app: MyApplication; // extends RestApplication
-  client: Client;
-
-  before(givenRunningApplication);
-  before(() => {
-    client = createRestAppClient(app);
-  });
-  after(() => app.stop());
-
-  it('invokes GET /ping', async () => {
-    await client.get('/ping?msg=world').expect(200);
-  });
-});
-```
-
-### `givenHttpServerConfig`
-
-Helper function for generating Travis-friendly host (127.0.0.1). This is
-required because Travis is not able to handle IPv6 addresses.
-
-### `httpGetAsync`
-
-Async wrapper for making HTTP GET requests.
-
-```ts
-import {httpGetAsync} from '@loopback/testlab';
-const response = await httpGetAsync('http://example.com');
-```
-
-### `httpsGetAsync`
-
-Async wrapper for making HTTPS GET requests.
-
-```ts
-import {httpsGetAsync} from '@loopback/testlab';
-const response = await httpsGetAsync('https://example.com');
-```
-
-### `toJSON`
-
-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.
-
-```ts
-import {createClientForHandler, toJSON} from '@loopback/testlab';
-
-it('gets a todo by ID', () => {
-  return client
-    .get(`/todos/${persistedTodo.id}`)
-    .expect(200, toJSON(persistedTodo));
-});
-```
-
 #### Test request parsing
 
 Use the factory function `stubServerRequest` to create a stub request that can
@@ -315,6 +202,119 @@ describe('response writer', () => {
 });
 ```
 
+### `skipIf`
+
+Helper function for skipping tests when a certain condition is met. Use this
+helper together with `it` or `describe`.
+
+```ts
+skipIf(someCondition, it, 'does something', async () => {
+  // the test code
+});
+```
+
+Unfortunately, type inference does not work well for `describe`, you have to
+help the compiler to figure out the correct types.
+
+```ts
+skipIf<[(this: Suite) => void], void>(
+  someCondition,
+  describe,
+  'some suite name',
+  () => {
+    // define the test cases
+  },
+);
+```
+
+Under the hood, `skipIf` invokes the provided test verb by default (e.g. `it`).
+When the provided condition was true, then it calls `.skip` instead (e.g.
+`it.skip`).
+
+### `skipOnTravis`
+
+Helper function for skipping tests on Travis environment. If you need to skip
+testing on Travis for any reason, use this helper together with `it` or
+`describe`.
+
+```ts
+skipOnTravis(it, 'does something when some condition', async () => {
+  // the test code
+});
+```
+
+Under the hood, `skipOnTravis` invokes the provided test verb by default (e.g.
+`it`). When the helper detects Travis CI environment variables, then it calls
+`.skip` instead (e.g. `it.skip`).
+
+### `createRestAppClient`
+
+Helper function to create a `supertest` client connected to a running
+RestApplication. It is the responsibility of the caller to ensure that the app
+is running and to stop the application after all tests are done.
+
+Example use:
+
+```ts
+import {Client, createRestAppClient} from '@loopback/testlab';
+
+describe('My application', () => {
+  app: MyApplication; // extends RestApplication
+  client: Client;
+
+  before(givenRunningApplication);
+  before(() => {
+    client = createRestAppClient(app);
+  });
+  after(() => app.stop());
+
+  it('invokes GET /ping', async () => {
+    await client.get('/ping?msg=world').expect(200);
+  });
+});
+```
+
+### `givenHttpServerConfig`
+
+Helper function for generating Travis-friendly host (127.0.0.1). This is
+required because Travis is not able to handle IPv6 addresses.
+
+### `httpGetAsync`
+
+Async wrapper for making HTTP GET requests.
+
+```ts
+import {httpGetAsync} from '@loopback/testlab';
+const response = await httpGetAsync('http://example.com');
+```
+
+### `httpsGetAsync`
+
+Async wrapper for making HTTPS GET requests.
+
+```ts
+import {httpsGetAsync} from '@loopback/testlab';
+const response = await httpsGetAsync('https://example.com');
+```
+
+### `toJSON`
+
+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.
+
+```ts
+import {createClientForHandler, toJSON} from '@loopback/testlab';
+
+it('gets a todo by ID', () => {
+  return client
+    .get(`/todos/${persistedTodo.id}`)
+    .expect(200, toJSON(persistedTodo));
+});
+```
+
 ### `validateApiSpec`
 
 Verify that your application API specification is a valid OpenAPI spec document.

package/dist/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE;;GAEG;AAEH,wDAAwB;AACxB,uCAAwC;AAEhC,8BAAS;AAIjB;;;;GAIG;AACH,SAAgB,sBAAsB,CACpC,OAAsE;IAEtE,MAAM,MAAM,GAAG,cAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAC1C,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC;AAC3B,CAAC;AALD,wDAKC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,GAAwB;;IAC1D,MAAM,GAAG,SAAG,GAAG,CAAC,UAAU,CAAC,OAAO,mCAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC;IACzD,IAAI,CAAC,GAAG,EAAE;QACR,MAAM,IAAI,KAAK,CACb,4BAA4B,GAAG,CAAC,WAAW,CAAC,IAAI,wBAAwB,CACzE,CAAC;KACH;IACD,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC;AACxB,CAAC;AARD,kDAQC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE;;GAEG;AAEH,wDAAwB;AACxB,uCAAwC;AAEhC,8BAAS;AAIjB;;;;GAIG;AACH,SAAgB,sBAAsB,CACpC,OAAsE;IAEtE,MAAM,MAAM,GAAG,cAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAC1C,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC;AAC3B,CAAC;AALD,wDAKC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,GAAwB;;IAC1D,MAAM,GAAG,GAAG,MAAA,GAAG,CAAC,UAAU,CAAC,OAAO,mCAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC;IACzD,IAAI,CAAC,GAAG,EAAE;QACR,MAAM,IAAI,KAAK,CACb,4BAA4B,GAAG,CAAC,WAAW,CAAC,IAAI,wBAAwB,CACzE,CAAC;KACH;IACD,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC;AACxB,CAAC;AARD,kDAQC"}

package/dist/http-error-logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"http-error-logger.js","sourceRoot":"","sources":["../src/http-error-logger.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;AAKhE;;;;GAIG;AACH,SAAgB,+BAA+B,CAC7C,kBAA2B;IAE3B,OAAO,SAAS,sBAAsB,CACpC,GAAU,EACV,UAAkB,EAClB,GAAoB;;QAEpB,IAAI,UAAU,KAAK,kBAAkB;YAAE,OAAO;QAE9C,0BAA0B;QAC1B,OAAO,CAAC,KAAK,CACX,iCAAiC,EACjC,GAAG,CAAC,MAAM,EACV,GAAG,CAAC,GAAG,EACP,UAAU,QACV,GAAG,CAAC,KAAK,mCAAI,GAAG,CACjB,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAnBD,0EAmBC"}
+{"version":3,"file":"http-error-logger.js","sourceRoot":"","sources":["../src/http-error-logger.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;AAKhE;;;;GAIG;AACH,SAAgB,+BAA+B,CAC7C,kBAA2B;IAE3B,OAAO,SAAS,sBAAsB,CACpC,GAAU,EACV,UAAkB,EAClB,GAAoB;;QAEpB,IAAI,UAAU,KAAK,kBAAkB;YAAE,OAAO;QAE9C,0BAA0B;QAC1B,OAAO,CAAC,KAAK,CACX,iCAAiC,EACjC,GAAG,CAAC,MAAM,EACV,GAAG,CAAC,GAAG,EACP,UAAU,EACV,MAAA,GAAG,CAAC,KAAK,mCAAI,GAAG,CACjB,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAnBD,0EAmBC"}

package/dist/request.js

@@ -26,9 +26,10 @@ exports.httpGetAsync = httpGetAsync;
  * @param urlString
  */
 function httpsGetAsync(urlString, agent) {
-    agent = agent !== null && agent !== void 0 ? agent : new https_1.default.Agent({
-        rejectUnauthorized: false,
-    });
+    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) => {

package/dist/request.js.map

@@ -1 +1 @@
-{"version":3,"file":"request.js","sourceRoot":"","sources":["../src/request.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,wDAA2C;AAC3C,0DAA0B;AAC1B,sDAAsB;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,GACH,KAAK,aAAL,KAAK,cAAL,KAAK,GACL,IAAI,eAAK,CAAC,KAAK,CAAC;QACd,kBAAkB,EAAE,KAAK;KAC1B,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"}
+{"version":3,"file":"request.js","sourceRoot":"","sources":["../src/request.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,wDAA2C;AAC3C,0DAA0B;AAC1B,sDAAsB;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/package.json

@@ -1,11 +1,19 @@
 {
   "name": "@loopback/testlab",
-  "version": "3.2.12",
   "description": "A collection of test utilities we use to write LoopBack tests.",
+  "version": "3.4.1",
+  "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/strongloop/loopback-next.git",
+    "directory": "packages/testlab"
+  },
   "engines": {
-    "node": "^10.16 || 12 || 14 || 15"
+    "node": "^10.16 || 12 || 14 || 16"
   },
   "scripts": {
     "build": "lb-tsc",
@@ -14,32 +22,9 @@
     "test": "lb-mocha \"dist/__tests__/**/*.js\"",
     "verify": "npm pack && tar xf loopback-testlab*.tgz && tree package && npm run clean"
   },
-  "author": "IBM Corp.",
-  "copyright.owner": "IBM Corp.",
-  "license": "MIT",
   "publishConfig": {
     "access": "public"
   },
-  "dependencies": {
-    "@hapi/shot": "^5.0.5",
-    "@types/express": "^4.17.11",
-    "@types/fs-extra": "^9.0.6",
-    "@types/shot": "^4.0.0",
-    "@types/sinon": "^9.0.10",
-    "@types/supertest": "^2.0.10",
-    "express": "^4.17.1",
-    "fs-extra": "^9.1.0",
-    "oas-validator": "^5.0.4",
-    "should": "^13.2.3",
-    "sinon": "^9.2.4",
-    "supertest": "^6.0.1",
-    "tslib": "^2.1.0"
-  },
-  "devDependencies": {
-    "@loopback/build": "^6.2.9",
-    "@loopback/eslint-config": "^10.0.5",
-    "@types/node": "^10.17.35"
-  },
   "files": [
     "README.md",
     "dist",
@@ -48,10 +33,25 @@
     "src",
     "!*/__tests__"
   ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/strongloop/loopback-next.git",
-    "directory": "packages/testlab"
+  "dependencies": {
+    "@hapi/shot": "^5.0.5",
+    "@types/express": "^4.17.12",
+    "@types/fs-extra": "^9.0.11",
+    "@types/shot": "^4.0.0",
+    "@types/sinon": "^10.0.2",
+    "@types/supertest": "^2.0.11",
+    "express": "^4.17.1",
+    "fs-extra": "^10.0.0",
+    "oas-validator": "^5.0.6",
+    "should": "^13.2.3",
+    "sinon": "^11.1.1",
+    "supertest": "^6.1.3",
+    "tslib": "^2.2.0"
+  },
+  "devDependencies": {
+    "@loopback/build": "^6.4.1",
+    "@loopback/eslint-config": "^10.2.1",
+    "@types/node": "^10.17.60"
   },
-  "gitHead": "0fcf97fa1e87457de85f8f1b6b5cbf9f4f0bd640"
+  "gitHead": "2a3b684ec76fa299d80b099abbf101358538cb75"
 }