feat: post api template and tests

Author: abose

src/api/hello.js

@@ -24,6 +24,31 @@ const schema = {
     }
 };
 
+const postSchema = {
+    schema: {
+        body: {
+            type: 'object',
+            required: ['name'],
+            properties: {
+                name: {
+                    type: 'string',
+                    minLength: 1,
+                    maxLength: 10
+                }
+            }
+        },
+        response: {
+            200: { //HTTP_STATUS_CODES.OK
+                type: 'object',
+                required: ['message'],
+                properties: {
+                    message: {type: 'string'}
+                }
+            }
+        }
+    }
+};
+
 export function getHelloSchema() {
     return schema;
 }
@@ -35,3 +60,14 @@ export async function hello(request, _reply) {
     };
     return response;
 }
+
+export function getHelloPostSchema() {
+    return postSchema;
+}
+export async function helloPost(request, _reply) {
+    const name = request.body.name;
+    const response = {
+        message: `hello ${name}`
+    };
+    return response;
+}

src/server.js

@@ -20,7 +20,7 @@ import fastify from "fastify";
 import {init, isAuthenticated, addUnAuthenticatedAPI} from "./auth/auth.js";
 import {HTTP_STATUS_CODES} from "@aicore/libcommonutils";
 import {getConfigs} from "./utils/configs.js";
-import {getHelloSchema, hello} from "./api/hello.js";
+import {getHelloSchema, hello, getHelloPostSchema, helloPost} from "./api/hello.js";
 import {fastifyStatic} from "@fastify/static";
 
 import path from 'path';
@@ -77,6 +77,11 @@ server.get('/hello', getHelloSchema(), function (request, reply) {
     return hello(request, reply);
 });
 
+addUnAuthenticatedAPI('/helloPost');
+server.post('/helloPost', getHelloPostSchema(), function (request, reply) {
+    return helloPost(request, reply);
+});
+
 // An authenticated version of the hello api
 server.get('/helloAuth', getHelloSchema(), function (request, reply) {
     return hello(request, reply);

test/integration/hello.spec.js

@@ -21,6 +21,26 @@ describe('Integration Tests for hello api', function () {
         expect(output).eql({message: "hello world"});
     });
 
+    it('should say hello Post without auth', async function () {
+        let output = await fetch("http://localhost:5000/helloPost", {
+            method: 'post',
+            body: JSON.stringify({name: "ola"}),
+            headers: {'Content-Type': 'application/json'}
+        });
+        output = await output.json();
+        expect(output).eql({message: "hello ola"});
+    });
+
+    it('should hello Post say 400 without required args', async function () {
+        let output = await fetch("http://localhost:5000/helloPost", {
+            method: 'post',
+            body: JSON.stringify({}),
+            headers: {'Content-Type': 'application/json'}
+        });
+        output = await output.json();
+        expect(output.statusCode).eql(400);
+    });
+
     it('should say helloAuth if authorised', async function () {
         let output = await fetch("http://localhost:5000/helloAuth?name=world", { method: 'GET', headers: {
             authorization: "Basic hehe"

test/unit/api/hello.spec.js

@@ -1,7 +1,7 @@
 /*global describe, it*/
 import * as chai from 'chai';
-import {hello, getHelloSchema} from "../../../src/api/hello.js";
-import {getSimpleGetReply, getSimpleGETRequest} from '../data/simple-request.js';
+import {hello, getHelloSchema, helloPost, getHelloPostSchema} from "../../../src/api/hello.js";
+import {getSimpleGetReply, getSimpleGETRequest, getSimplePOSTReply, getSimplePOSTRequest} from '../data/simple-request.js';
 import Ajv from "ajv";
 
 export const AJV = new Ajv();
@@ -16,7 +16,7 @@ describe('unit Tests for hello api', function () {
         expect(helloResponse).eql({message: 'hello rambo'});
     });
 
-    it('should validate schemas for sample request/responses', async function () {
+    it('should validate schemas for sample GET request/responses', async function () {
         let request = getSimpleGETRequest();
         // request
         const requestValidator = AJV.compile(getHelloSchema().schema.querystring);
@@ -29,4 +29,18 @@ describe('unit Tests for hello api', function () {
         let response = await hello(getSimpleGETRequest(), getSimpleGetReply());
         expect(successResponseValidator(response)).to.be.true;
     });
+
+    it('should validate schemas for sample POST request/responses', async function () {
+        let request = getSimplePOSTRequest();
+        // request
+        const requestValidator = AJV.compile(getHelloPostSchema().schema.body);
+        expect(requestValidator(request.body)).to.be.true;
+        // message too long validation
+        request.body.name = "a name that is too long";
+        expect(requestValidator(request.body)).to.be.false;
+        // response
+        const successResponseValidator = AJV.compile(getHelloPostSchema().schema.response["200"]);
+        let response = await helloPost(getSimplePOSTRequest(), getSimplePOSTReply());
+        expect(successResponseValidator(response)).to.be.true;
+    });
 });

test/unit/data/simple-request.js

@@ -72,4 +72,54 @@ export function getSimpleGetReply() {
     return {...simpleGetReply};
 }
 
+const simplePostRequest = {
+    id: "req-2",
+    params:{},
+    query:{},
+    body: {
+        "name": "rambo"
+    },
+    raw:{
+        httpVersionMajor: 1,
+        httpVersionMinor: 1,
+        httpVersion: "1.1",
+        complete: false,
+        rawHeaders: [
+            "content-length",
+            "21",
+            "accept-encoding",
+            "gzip, deflate, br",
+            "Accept",
+            "*/*",
+            "User-Agent",
+            "Thunder Client (https://www.thunderclient.com)",
+            "Content-Type",
+            "application/json",
+            "Host",
+            "localhost:5000",
+            "Connection",
+            "close"
+        ],
+        rawTrailers: [],
+        aborted: false,
+        upgrade: false,
+        url: "/helloPost",
+        method: "POST",
+        statusCode: null,
+        statusMessage: null
+    },
+    log: logger
+};
+export function getSimplePOSTRequest() {
+    return {...simplePostRequest};
+}
+
+const simplePOSTReply = {
+    request: simpleGETRequest,
+    log: logger,
+    raw: {}
+};
+export function getSimplePOSTReply() {
+    return {...simplePOSTReply};
+}