@tryghost/express-test 0.2.0 → 0.3.0

package/lib/expect-request.js

@@ -1,5 +1,6 @@
 const assert = require('assert');
 const {Request, RequestOptions} = require('./request');
+const {snapshotManager} = require('@tryghost/jest-snapshot');
 
 class ExpectRequest extends Request {
     constructor(...args) {
@@ -54,6 +55,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) {
@@ -123,6 +148,21 @@ class ExpectRequest extends Request {
             assert.equal(expectedHeaderString, actualHeaderString, error);
         }
     }
+
+    _assertSnapshot(result, assertion) {
+        const {properties, field, error} = assertion;
+
+        const match = snapshotManager.match(result[field], properties);
+
+        if (match.pass !== true) {
+            const snapshotName = match.message().match(/Snapshot name: `(.*)`/)[1];
+            error.expected = match.expected;
+            error.actual = match.actual;
+            error.message = `Expected ${field} to match in Snapshot: "${snapshotName}" ${error.contextString}`;
+        }
+
+        assert.equal(match.pass, true, error);
+    }
 }
 
 module.exports = ExpectRequest;

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@tryghost/express-test",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "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.2.0",
     "cookiejar": "^2.1.3",
     "reqresnext": "^1.6.6"
   },
-  "gitHead": "ba2449737cd3a66d811e34b5b28b86f5d3538396"
+  "gitHead": "1750e2bdc5b8f659a4439490c79a8c262a74e66f"
 }