From 0527fcdf5fe3690511ca22abdd4dfaf011b27152 Mon Sep 17 00:00:00 2001
From: Valentin Laurin <valentin.laurin@quickcase.app>
Date: Thu, 18 Nov 2021 16:35:44 +0000
Subject: [PATCH] Test: add support for Express res.set()

Resolves #178
And alias `res.header()`.
---
 README.md                        |  1 +
 src/test-modules/express.js      |  6 +++++-
 src/test-modules/express.test.js | 32 ++++++++++++++++++++++++++++++--
 3 files changed, 36 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index aefe31b..01fd4c9 100644
--- a/README.md
+++ b/README.md
@@ -1393,6 +1393,7 @@ test('should resolve with response when response expected', async () => {
   const res = await givenMiddleware(middleware).when({}).expectResponse();
   expect(res).toEqual({
     status: 201,
+    headers: {},
     body: {foo: 'bar'},
   });
 });
diff --git a/src/test-modules/express.js b/src/test-modules/express.js
index 8c65784..70b302e 100644
--- a/src/test-modules/express.js
+++ b/src/test-modules/express.js
@@ -1,3 +1,5 @@
+const isTrueObject = (variable) => typeof variable === 'object' && !Array.isArray(variable) && variable !== null;
+
 /**
  * Asynchronous function encapsulating the execution of an Express middleware for test purpose.
  * @param {function} middleware Express middleware function taking 3 parameters: req, res, next
@@ -13,12 +15,14 @@ export const expectMiddleware = (middleware, req, expectResponse = false) => new
     error,
   }) : resolve;
 
-  let response = {status: 200};
+  let response = {status: 200, headers: {}};
 
   const res = {};
   res.cookie = (name, value, options) => (response.cookies = [...(response.cookies || []), {name, value, options}], res);
   res.clearCookie = (name, options) => (response.clearCookies = [...(response.clearCookies || []), {name, options}], res);
   res.status = (code) => (response.status = code, res);
+  res.set = (field, value) => (response.headers = {...response.headers, ...(isTrueObject(field) ? field : {[field]: value})}, res);
+  res.header = res.set;
   res.json = (body) => (response.body = body, resolveResponse(response));
   res.redirect = (statusOrPath, path) => (Object.assign(response, path ? {status: statusOrPath, redirect: path} : {status: 302, redirect: statusOrPath}), resolveResponse(response));
   res.send = res.json;
diff --git a/src/test-modules/express.test.js b/src/test-modules/express.test.js
index 04f6bc3..ecb334a 100644
--- a/src/test-modules/express.test.js
+++ b/src/test-modules/express.test.js
@@ -6,13 +6,14 @@ describe('expectMiddleware', () => {
     const res = await expectMiddleware(middleware, {}, true);
     expect(res).toEqual({
       status: 201,
+      headers: {},
       body: {foo: 'bar'},
     });
   });
 
   test('should reject with response when response not expected', async () => {
     const middleware = (req, res) => res.send();
-    await expect(expectMiddleware(middleware, {}, false)).rejects.toEqual({status: 200});
+    await expect(expectMiddleware(middleware, {}, false)).rejects.toEqual({status: 200, headers: {}});
   });
 
   test('should resolve with next when next expected', async () => {
@@ -36,6 +37,7 @@ describe('expectMiddleware', () => {
     const res = await expectMiddleware(middleware, {}, true);
     expect(res).toEqual({
       status: 200,
+      headers: {},
       cookies: [
         {
           name: 'cookie1',
@@ -58,6 +60,7 @@ describe('expectMiddleware', () => {
     const res = await expectMiddleware(middleware, {}, true);
     expect(res).toEqual({
       status: 200,
+      headers: {},
       clearCookies: [
         {
           name: 'cookie1',
@@ -71,11 +74,32 @@ describe('expectMiddleware', () => {
     });
   });
 
+  test('should record headers set on response', async () => {
+    const middleware = (req, res) => res.set('header1', 'value1')
+                                        .set({
+                                          header2: 'value2',
+                                          header3: 'value3',
+                                        })
+                                        .header('header4', 'value4')
+                                        .send();
+    const res = await expectMiddleware(middleware, {}, true);
+    expect(res).toEqual({
+      status: 200,
+      headers: {
+        header1: 'value1',
+        header2: 'value2',
+        header3: 'value3',
+        header4: 'value4',
+      },
+    });
+  });
+
   test('should resolve with redirection and default status', async () => {
     const middleware = (req, res) => res.redirect('/foo/bar');
     const res = await expectMiddleware(middleware, {}, true);
     expect(res).toEqual({
       status: 302,
+      headers: {},
       redirect: '/foo/bar',
     });
   });
@@ -85,6 +109,7 @@ describe('expectMiddleware', () => {
     const res = await expectMiddleware(middleware, {}, true);
     expect(res).toEqual({
       status: 301,
+      headers: {},
       redirect: '/foo/bar',
     });
   });
@@ -94,6 +119,7 @@ describe('expectMiddleware', () => {
     const res = await expectMiddleware(middleware, {}, true);
     expect(res).toEqual({
       status: 200,
+      headers: {},
       body: 'some body',
     });
   });
@@ -103,6 +129,7 @@ describe('expectMiddleware', () => {
     const res = await expectMiddleware(middleware, {}, true);
     expect(res).toEqual({
       status: 200,
+      headers: {},
     });
   });
 });
@@ -113,13 +140,14 @@ describe('givenMiddleware', () => {
     const res = await givenMiddleware(middleware).when({}).expectResponse();
     expect(res).toEqual({
       status: 201,
+      headers: {},
       body: {foo: 'bar'},
     });
   });
 
   test('should reject with response when response not expected', async () => {
     const middleware = (req, res) => res.send();
-    await expect(givenMiddleware(middleware).when({}).expectNext()).rejects.toEqual({status: 200});
+    await expect(givenMiddleware(middleware).when({}).expectNext()).rejects.toEqual({status: 200, headers: {}});
   });
 
   test('should resolve with next when next expected', async () => {