@tryghost/express-test 0.2.0 → 0.4.2

package/lib/expect-request.js

@@ -1,5 +1,7 @@
 const assert = require('assert');
 const {Request, RequestOptions} = require('./request');
+const {snapshotManager} = require('@tryghost/jest-snapshot');
+const {makeMessageFromMatchMessage} = require('./utils');
 
 class ExpectRequest extends Request {
     constructor(...args) {
@@ -54,6 +56,30 @@ class ExpectRequest extends Request {
         return this;
     }
 
+    matchBodySnapshot(properties = {}) {
+        let assertion = {
+            fn: this._assertSnapshot,
+            properties: properties,
+            field: 'body'
+        };
+
+        this._addAssertion(assertion);
+
+        return this;
+    }
+
+    matchHeaderSnapshot(properties = {}) {
+        let assertion = {
+            fn: this._assertSnapshot,
+            properties: properties,
+            field: 'headers'
+        };
+
+        this._addAssertion(assertion);
+
+        return this;
+    }
+
     finalize(callback) {
         super.finalize((error, response) => {
             if (error) {
@@ -78,6 +104,7 @@ class ExpectRequest extends Request {
     }
 
     _addAssertion(assertion) {
+        // We create the error here so that we get a useful stack trace
         let error = new assert.AssertionError({
             message: 'Unexpected assertion error',
             expected: assertion.expected,
@@ -95,6 +122,11 @@ class ExpectRequest extends Request {
         const {error} = assertion;
 
         error.message = `Expected statusCode ${assertion.expected}, got statusCode ${response.statusCode} ${error.contextString}`;
+
+        if (response.body && response.body.errors && response.body.errors[0].message) {
+            error.message += `\n${response.body.errors[0].message}`;
+        }
+
         error.actual = response.statusCode;
 
         assert.equal(response.statusCode, assertion.expected, error);
@@ -123,6 +155,40 @@ class ExpectRequest extends Request {
             assert.equal(expectedHeaderString, actualHeaderString, error);
         }
     }
+
+    _assertSnapshot(result, assertion) {
+        const {properties, field, error} = assertion;
+
+        if (!result[field]) {
+            error.message = `Unable to match snapshot on undefined field ${field} ${error.contextString}`;
+            error.expected = field;
+            error.actual = 'undefined';
+            assert.notEqual(result[field], undefined, error);
+        }
+
+        const hint = `[${field}]`;
+        const match = snapshotManager.match(result[field], properties, hint);
+
+        Object.keys(properties).forEach((prop) => {
+            const errorMessage = `"response.${field}" is missing the expected property "${prop}"`;
+            error.message = makeMessageFromMatchMessage(match.message(), errorMessage);
+            error.expected = prop;
+            error.actual = 'undefined';
+            error.showDiff = false; // Disable mocha's diff output as it's already present in match.message()
+
+            assert.notEqual(result[field][prop], undefined, error);
+        });
+
+        if (match.pass !== true) {
+            const errorMessage = `"response.${field}" does not match snapshot.`;
+            error.message = makeMessageFromMatchMessage(match.message(), errorMessage);
+            error.expected = match.expected;
+            error.actual = match.actual;
+            error.showDiff = false; // Disable mocha's diff output as it's already present in match.message()
+        }
+
+        assert.equal(match.pass, true, error);
+    }
 }
 
 module.exports = ExpectRequest;

package/lib/request.js

@@ -1,13 +1,14 @@
 const {default: reqresnext} = require('reqresnext');
 const {CookieAccessInfo} = require('cookiejar');
 const {parse} = require('url');
-const {isJSON} = require('./utils');
+const {isJSON, convertKeysToLowerCase} = require('./utils');
 
 class RequestOptions {
     constructor({method, url, headers, body} = {}) {
         this.method = method || 'GET';
         this.url = url || '/';
-        this.headers = headers || {};
+        // TODO: remove convertKeysToLowerCase utility once https://github.com/antongolub/reqresnext/issues/33 is fixed
+        this.headers = convertKeysToLowerCase(headers) || {};
         this.body = body;
     }
 
@@ -29,7 +30,8 @@ class Request {
     }
 
     header(name, value) {
-        this.reqOptions.headers[name] = value;
+        // TODO: remove toLowerCase once https://github.com/antongolub/reqresnext/issues/33 is fixed
+        this.reqOptions.headers[name.toLowerCase()] = value;
         return this;
     }
 
@@ -67,7 +69,7 @@ class Request {
         const {req, res} = reqresnext(Object.assign({}, reqOptions, {app}), {app});
 
         // This is needed to make error handling work
-        // @TODO: submit this upstream in reqresnext
+        // @TODO: remove once https://github.com/antongolub/reqresnext/issues/31 is solved
         req.socket.destroy = () => { };
         return {req, res};
     }

package/lib/utils.js

@@ -3,3 +3,19 @@ module.exports.isJSON = function isJSON(mime) {
     // but not /json-seq
     return /[/+]json($|[^-\w])/i.test(mime);
 };
+
+module.exports.makeMessageFromMatchMessage = function makeMessageFromMatchMessage(message, errorMessage) {
+    const messageLines = message.split('\n');
+    messageLines.splice(0, 1, errorMessage);
+    return messageLines.join('\n');
+};
+
+module.exports.convertKeysToLowerCase = function (map) {
+    const newMap = {};
+
+    for (const key in map) {
+        newMap[key.toLowerCase()] = map[key];
+    }
+
+    return newMap;
+};

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@tryghost/express-test",
-  "version": "0.2.0",
+  "version": "0.4.2",
   "repository": "https://github.com/TryGhost/framework/tree/main/packages/express-test",
   "author": "Ghost Foundation",
   "license": "MIT",
   "main": "index.js",
   "scripts": {
     "dev": "echo \"Implement me!\"",
-    "test": "NODE_ENV=testing c8 mocha './test/**/*.test.js'",
+    "test": "NODE_ENV=testing c8 mocha --require ./test/utils/overrides.js './test/**/*.test.js'",
     "lint": "eslint . --ext .js --cache",
     "posttest": "yarn lint"
   },
@@ -26,8 +26,9 @@
     "sinon": "13.0.1"
   },
   "dependencies": {
+    "@tryghost/jest-snapshot": "^0.3.1",
     "cookiejar": "^2.1.3",
     "reqresnext": "^1.6.6"
   },
-  "gitHead": "ba2449737cd3a66d811e34b5b28b86f5d3538396"
+  "gitHead": "fdec1082aa5efa81196205cbcd8a31c61b50c8fa"
 }