@tryghost/express-test 0.3.0 → 0.4.0

package/lib/expect-request.js

@@ -1,6 +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) {
@@ -55,7 +56,7 @@ class ExpectRequest extends Request {
         return this;
     }
 
-    matchBodySnapshot(properties) {
+    matchBodySnapshot(properties = {}) {
         let assertion = {
             fn: this._assertSnapshot,
             properties: properties,
@@ -67,7 +68,7 @@ class ExpectRequest extends Request {
         return this;
     }
 
-    matchHeaderSnapshot(properties) {
+    matchHeaderSnapshot(properties = {}) {
         let assertion = {
             fn: this._assertSnapshot,
             properties: properties,
@@ -103,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,
@@ -152,13 +154,32 @@ class ExpectRequest extends Request {
     _assertSnapshot(result, assertion) {
         const {properties, field, error} = assertion;
 
-        const match = snapshotManager.match(result[field], properties);
+        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 snapshotName = match.message().match(/Snapshot name: `(.*)`/)[1];
+            const errorMessage = `"response.${field}" does not match snapshot.`;
+            error.message = makeMessageFromMatchMessage(match.message(), errorMessage);
             error.expected = match.expected;
             error.actual = match.actual;
-            error.message = `Expected ${field} to match in Snapshot: "${snapshotName}" ${error.contextString}`;
+            error.showDiff = false; // Disable mocha's diff output as it's already present in match.message()
         }
 
         assert.equal(match.pass, true, error);

package/lib/utils.js

@@ -3,3 +3,9 @@ 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');
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/express-test",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "repository": "https://github.com/TryGhost/framework/tree/main/packages/express-test",
   "author": "Ghost Foundation",
   "license": "MIT",
@@ -26,9 +26,9 @@
     "sinon": "13.0.1"
   },
   "dependencies": {
-    "@tryghost/jest-snapshot": "^0.2.0",
+    "@tryghost/jest-snapshot": "^0.3.0",
     "cookiejar": "^2.1.3",
     "reqresnext": "^1.6.6"
   },
-  "gitHead": "1750e2bdc5b8f659a4439490c79a8c262a74e66f"
+  "gitHead": "5304fb34a2b5dd02f96386fceed34124940ce9ec"
 }