feat: e2e testing content-type and accept-patch (#623)

Added E2E testing for Content-Type and Accept-Patch on the GET, POST, PUT and DELETE routes.

We need to make sure the correct Headers are included (or not) in the different routes.

Author: florent-uzio

docker-compose.yml

@@ -46,5 +46,5 @@ services:
       - POSTGRES_PASSWORD=password
       # If POSTGRES_DB != database_development, change DB_NAME in the payid service above
       - POSTGRES_DB=database_development
-      # Uncomment if you want to change the Postgres user (in that case, change DB_NAME in the payid service). Default value: postgres
+      # Uncomment if you want to change the Postgres user (in that case, change DB_USERNAME in the payid service). Default value: postgres
       #- POSTGRES_USER=postgres

src/routes/adminApiRouter.ts

@@ -32,22 +32,10 @@ adminApiRouter
   .get('/:payId', wrapAsync(getUser), sendSuccess)
 
   // Create user route
-  .post(
-    '/',
-    express.json(),
-    // TODO:(hbergren) checkRequestContentType E2E tests,
-    wrapAsync(postUser),
-    sendSuccess,
-  )
+  .post('/', express.json(), wrapAsync(postUser), sendSuccess)
 
   // Replace user route
-  .put(
-    '/:payId',
-    express.json(),
-    // TODO:(hbergren) checkRequestContentType E2E tests,
-    wrapAsync(putUser),
-    sendSuccess,
-  )
+  .put('/:payId', express.json(), wrapAsync(putUser), sendSuccess)
 
   // Delete user route
   .delete('/:payId', wrapAsync(deleteUser), sendSuccess)

test/integration/e2e/admin-api/deleteUsers.test.ts

@@ -8,6 +8,8 @@ import { appSetup, appCleanup } from '../../../helpers/helpers'
 let app: App
 const payIdApiVersion = '2020-05-28'
 
+const acceptPatch = 'application/merge-patch+json'
+
 describe('E2E - adminApiRouter - DELETE /users', function (): void {
   before(async function () {
     app = await appSetup()
@@ -26,6 +28,8 @@ describe('E2E - adminApiRouter - DELETE /users', function (): void {
     request(app.adminApiExpress)
       .delete(`/users/${payId}`)
       .set('PayID-API-Version', payIdApiVersion)
+      // THEN we expect to have an Accept-Patch header in the response
+      .expect('Accept-Patch', acceptPatch)
       // THEN we expect back a 204-No Content, indicating successful deletion
       .expect(HttpStatus.NoContent)
       .then((_res) => {
@@ -53,6 +57,8 @@ describe('E2E - adminApiRouter - DELETE /users', function (): void {
     request(app.adminApiExpress)
       .delete(`/users/${payId}`)
       .set('PayID-API-Version', payIdApiVersion)
+      // THEN we expect to have an Accept-Patch header in the response
+      .expect('Accept-Patch', acceptPatch)
       // THEN we expect back a 204-No Content, indicating successful deletion
       .expect(HttpStatus.NoContent)
       .then((_res) => {
@@ -75,6 +81,8 @@ describe('E2E - adminApiRouter - DELETE /users', function (): void {
     request(app.adminApiExpress)
       .delete(`/users/${payId}`)
       .set('PayID-API-Version', payIdApiVersion)
+      // THEN we expect to have an Accept-Patch header in the response
+      .expect('Accept-Patch', acceptPatch)
       // THEN we expect back a 204 - No Content
       .expect(HttpStatus.NoContent, done)
   })

test/integration/e2e/admin-api/getUsers.test.ts

@@ -8,6 +8,8 @@ import { appSetup, appCleanup } from '../../../helpers/helpers'
 let app: App
 const payIdApiVersion = '2020-05-28'
 
+const acceptPatch = 'application/merge-patch+json'
+
 describe('E2E - adminApiRouter - GET /users', function (): void {
   before(async function () {
     app = await appSetup()
@@ -35,6 +37,8 @@ describe('E2E - adminApiRouter - GET /users', function (): void {
       .get(`/users/${payId}`)
       .set('PayID-API-Version', payIdApiVersion)
       .expect('Content-Type', /json/u)
+      // THEN we expect to have an Accept-Patch header in the response
+      .expect('Accept-Patch', acceptPatch)
       // THEN We expect back a 200 - OK, with the account information
       .expect(HttpStatus.OK, expectedResponse, done)
   })
@@ -60,6 +64,8 @@ describe('E2E - adminApiRouter - GET /users', function (): void {
       .get(`/users/${payId}`)
       .set('PayID-API-Version', payIdApiVersion)
       .expect('Content-Type', /json/u)
+      // THEN we expect to have an Accept-Patch header in the response
+      .expect('Accept-Patch', acceptPatch)
       // THEN We expect back a 200 - OK, with the account information
       .expect(HttpStatus.OK, expectedResponse, done)
   })
@@ -79,6 +85,8 @@ describe('E2E - adminApiRouter - GET /users', function (): void {
       .get(`/users/${payId}`)
       .set('PayID-API-Version', payIdApiVersion)
       .expect('Content-Type', /json/u)
+      // THEN we expect to have an Accept-Patch header in the response
+      .expect('Accept-Patch', acceptPatch)
       // THEN We expect back a 404 - Not Found, with the expected error response object
       .expect(HttpStatus.NotFound, expectedErrorResponse, done)
   })

test/integration/e2e/admin-api/postUsers.test.ts

@@ -1,4 +1,5 @@
 import HttpStatus from '@xpring-eng/http-status'
+import { expect } from 'chai'
 import * as request from 'supertest'
 import 'mocha'
 
@@ -43,10 +44,54 @@ describe('E2E - adminApiRouter - POST /users', function (): void {
       .expect('Content-Type', /text\/plain/u)
       // THEN we expect the Location header to be set to the path of the created user resource
       .expect('Location', `/users/${userInformation.payId}`)
-      // AND we expect back a 201 - CREATED
+      // THEN we expect back a 201 - CREATED
       .expect(HttpStatus.Created, done)
   })
 
+  it('Returns a 201 when creating a new user, without an Accept-Patch header in the response', function (done): void {
+    // GIVEN a user with a PayID known to not exist on the PayID service
+    const userInformation = {
+      payId: 'johnfoo$xpring.money',
+      addresses: [
+        {
+          paymentNetwork: 'XRPL',
+          environment: 'TESTNET',
+          details: {
+            address: 'TVQWr6BhgBLW2jbFyqqufgq8T9eN7KresB684ZSHKQ3oDtq',
+          },
+        },
+        {
+          paymentNetwork: 'BTC',
+          environment: 'TESTNET',
+          details: {
+            address: 'mxNEbRXokcdJtT6sbukr1CTGVx8Tkxk3DC',
+          },
+        },
+      ],
+    }
+
+    // WHEN we make a POST request to /users with that user information
+    request(app.adminApiExpress)
+      .post(`/users`)
+      .set('PayID-API-Version', payIdApiVersion)
+      .send(userInformation)
+      .expect('Content-Type', /text\/plain/u)
+      // THEN we expect the Location header to be set to the path of the created user resource
+      .expect('Location', `/users/${userInformation.payId}`)
+      // THEN we expect back a 201 - CREATED
+      .expect(HttpStatus.Created)
+      .end(function (err, res) {
+        if (err) {
+          return done(err)
+        }
+
+        // AND ensure Accept-Patch header does not exist
+        expect(res.header).to.not.have.key('Accept-Patch')
+
+        return done()
+      })
+  })
+
   it('Returns a 201 when creating a new user with an uppercase PayID', function (done): void {
     const payId = 'johnsmith$xpring.money'
 
@@ -72,7 +117,7 @@ describe('E2E - adminApiRouter - POST /users', function (): void {
       .expect('Content-Type', /text\/plain/u)
       // THEN we expect the Location header to be set to the path of the created user resource
       .expect('Location', `/users/${payId}`)
-      // AND we expect back a 201 - CREATED
+      // THEN we expect back a 201 - CREATED
       .expect(HttpStatus.Created, done)
   })
 
@@ -99,7 +144,7 @@ describe('E2E - adminApiRouter - POST /users', function (): void {
       .expect('Content-Type', /text\/plain/u)
       // THEN we expect the Location header to be set to the path of the created user resource
       .expect('Location', `/users/${userInformation.payId}`)
-      // AND we expect back a 201 - CREATED
+      // THEN we expect back a 201 - CREATED
       .expect(HttpStatus.Created, done)
   })
 
@@ -159,6 +204,91 @@ describe('E2E - adminApiRouter - POST /users', function (): void {
       .expect(HttpStatus.Conflict, expectedErrorResponse, done)
   })
 
+  it('Returns a 415 - Unsupported Media Type when sending a wrong Content-Type header', function (done): void {
+    // GIVEN our new PayID user (must be sent as a String instead of an Object if Content-Type is not application/json)
+    // Otherwise an error ERR_INVALID_ARG_TYPE will be thrown by Supertest in the send() method.
+    const userInformation = `{
+      payId: 'johnfoo$xpring.money',
+      addresses: [
+        {
+          paymentNetwork: 'XRPL',
+          environment: 'TESTNET',
+          details: {
+            address: 'TVQWr6BhgBLW2jbFyqqufgq8T9eN7KresB684ZSHKQ3oDtq',
+          },
+        },
+        {
+          paymentNetwork: 'BTC',
+          environment: 'TESTNET',
+          details: {
+            address: 'mxNEbRXokcdJtT6sbukr1CTGVx8Tkxk3DC',
+          },
+        },
+      ],
+    }`
+
+    // AND our expected error response
+    const expectedErrorResponse = {
+      statusCode: 415,
+      error: 'Unsupported Media Type',
+      message:
+        "A 'Content-Type' header is required for this request: 'Content-Type: application/json'.",
+    }
+
+    // WHEN we make a POST request to /users with that user information
+    request(app.adminApiExpress)
+      .post(`/users`)
+      // WITH a wrong Content-Type
+      .set('Content-Type', 'application/xml')
+      .set('PayID-API-Version', payIdApiVersion)
+      .send(userInformation)
+      .expect('Content-Type', /json/u)
+      // THEN we expect back a 415 - Unsupported Media Type and our expected error response
+      .expect(HttpStatus.UnsupportedMediaType, expectedErrorResponse, done)
+  })
+
+  it('Returns a 415 - Unsupported Media Type when Content-Type header is missing', function (done): void {
+    // GIVEN our new PayID user (must be sent as a String instead of an Object
+    // otherwise Supertest will automatically add a "Content-Type: application/json" header.)
+    const userInformation = `{
+      payId: 'johnfoo$xpring.money',
+      addresses: [
+        {
+          paymentNetwork: 'XRPL',
+          environment: 'TESTNET',
+          details: {
+            address: 'TVQWr6BhgBLW2jbFyqqufgq8T9eN7KresB684ZSHKQ3oDtq',
+          },
+        },
+        {
+          paymentNetwork: 'BTC',
+          environment: 'TESTNET',
+          details: {
+            address: 'mxNEbRXokcdJtT6sbukr1CTGVx8Tkxk3DC',
+          },
+        },
+      ],
+    }`
+
+    // AND our expected error response
+    const expectedErrorResponse = {
+      statusCode: 415,
+      error: 'Unsupported Media Type',
+      message:
+        "A 'Content-Type' header is required for this request: 'Content-Type: application/json'.",
+    }
+
+    // WHEN we make a POST request to /users with that user information
+    request(app.adminApiExpress)
+      .post(`/users`)
+      // WITHOUT a Content-Type
+      .set('PayID-API-Version', payIdApiVersion)
+      .send(userInformation)
+      .expect('Content-Type', /json/u)
+      // THEN we expect back a 415 - Unsupported Media Type and our expected error response
+      .expect(HttpStatus.UnsupportedMediaType, expectedErrorResponse, done)
+  })
+
   after(function () {
     appCleanup(app)
   })