Merge pull request #11 from hckrnews/feature/phase1

Mock undefined controllers
trojs · Jun 22, 2023 · e5241de · e5241de
2 parents 1a16712 + 2c324b6
commit e5241de
Show file tree

Hide file tree

Showing 5 changed files with 55 additions and 3 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
     "name": "@hckrnews/openapi-server",
     "description": "OpenAPI Server",
-    "version": "0.1.7",
+    "version": "0.1.8",
     "author": {
         "name": "Pieter Wigboldus",
         "url": "https://hckr.news/"

diff --git a/src/__fixtures__/spec.json b/src/__fixtures__/spec.json
@@ -112,6 +112,37 @@
                     }
                 ]
             }
+        },
+        "/v1/user": {
+            "get": {
+                "operationId": "getUser",
+                "summary": "Get all user record",
+                "description": "Get the user record from the database.",
+                "parameters": [],
+                "responses": {
+                    "200": {
+                        "description": "",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/user"
+                                }
+                            }
+                        }
+                    },
+                    "401": {
+                        "description": "Unauthorized"
+                    }
+                },
+                "tags": [
+                    "Example"
+                ],
+                "security": [
+                    {
+                        "apiKey": []
+                    }
+                ]
+            }
         }
     },
     "info": {

diff --git a/src/router.js b/src/router.js
@@ -27,6 +27,9 @@ export const setupRouter = ({ env, openAPISpecification, controllers }) => {
   })
 
   operationIds({ specification: openAPISpecification }).forEach((operationId) => {
+    if (!Object.hasOwn(controllers, operationId)) {
+      return
+    }
     api.register(
       operationId,
       makeExpressCallback({
@@ -36,6 +39,13 @@ export const setupRouter = ({ env, openAPISpecification, controllers }) => {
     )
   })
 
+  api.register('notImplemented', (context, request, response) => {
+    const { mock } = context.api.mockResponseForOperation(
+      context.operation.operationId
+    )
+    return mock
+  })
+
   api.registerSecurityHandler(
     'apiKey',
     (context) => context.request.headers['x-api-key'] === secret

diff --git a/src/server.test.js b/src/server.test.js
@@ -134,6 +134,17 @@ test('Test the server', async (t) => {
     assert.deepEqual(response.body, exampleResponse)
   })
 
+  await t.test('It should return the mocked user, because we don\' have a controller yet', async () => {
+    const response = await request
+      .get('/v1/user')
+      .set('x-api-key', envExample.SECRET)
+
+    assert.strictEqual(response.status, 200)
+    assert.deepEqual(response.body, {
+      name: 'Pieter'
+    })
+  })
+
   await t.test('It should catch error\'s', async () => {
     const response = await request
       .get('/v1/users')