test(websheep-api): ✅ validate response & add utils

Author: yjaaidi

apps/websheep-api/src/app/authz1/sheep.router.spec.ts

@@ -1,21 +1,50 @@
-import { Express } from 'express';
-import * as request from 'supertest';
+import { openApiDocument } from './../shared/openapi/document';
 import * as express from 'express';
+// Import this plugin
+import jestOpenAPI from 'jest-openapi';
+import { join } from 'path';
+import * as request from 'supertest';
 import { resetDatabase } from '../database';
 import { sheepRouter } from './sheep.router';
 
+jestOpenAPI({
+  ...openApiDocument,
+  /* Remove servers otherwise the test crashes because we are using a random server port. */
+  servers: []
+});
+
 describe('sheep router', () => {
-  let app: Express;
+  it(`should get farmer's sheep without authorization`, async () => {
+    const { client, givenUser } = setUp();
+
+    givenUser('karinelemarchand');
 
-  beforeEach(() => {
-    app = express();
+    const response = await client.get('/farmers/foobar/sheep');
+
+    expect(response.status).toEqual(200);
+    expect(response.body.totalCount).toEqual(13);
+    expect(response.body.items[0].name).toEqual('Adriana');
+    expect(response).toSatisfyApiSpec();
+  });
+
+  function setUp() {
+    let _userId: string;
+
+    const app = express();
+
+    app.use((req, res, next) => {
+      req['user'] = _userId ? { id: _userId } : null;
+      next();
+    });
     app.use(sheepRouter);
+
     resetDatabase();
-  });
 
-  it(`should get farmer's sheep without authorization`, async () => {
-    const { body } = await request(app).get('/farmers/foobar/sheep');
-    expect(body.totalCount).toEqual(13);
-    expect(body.items[0].name).toEqual('Adriana');
-  });
+    return {
+      client: request(app),
+      givenUser(userId: string) {
+        _userId = userId;
+      }
+    };
+  }
 });

apps/websheep-api/src/app/shared/openapi/websheep.yaml

@@ -1,4 +1,4 @@
-openapi: '3.0.0'
+openapi: '3.1.0'
 info:
   version: 1.0.0
   title: Websheep
@@ -338,6 +338,8 @@ components:
         createdAt:
           type: string
           format: date-time
+        farmId:
+          type: string
 
     #    Sheep:
     #      allOf:
@@ -372,7 +374,6 @@ components:
       allOf:
         - $ref: '#/components/schemas/ListResponse'
         - type: object
-          additionalProperties: false
           properties:
             items:
               type: array

apps/websheep-api/src/app/shared/sheep/get-farmer-sheep-list.ts

@@ -14,8 +14,6 @@ export function getFarmerSheepList(req, res) {
     .map(sheep => serializeSheep({ sheep, host: req.headers.host }));
 
   res.json({
-    next: null,
-    previous: null,
     totalCount: sheepList.length,
     items: sheepList
   });

package.json

@@ -98,6 +98,7 @@
     "dotenv": "6.2.0",
     "eslint": "6.1.0",
     "jest": "24.1.0",
+    "jest-openapi": "^0.14.2",
     "jest-preset-angular": "7.0.0",
     "jsonpath": "^1.0.2",
     "prettier": "1.18.2",