feat: add basic API tests

package.json

@@ -77,6 +77,7 @@
     "@types/node-fetch": "^2.5.12",
     "@types/rimraf": "^3.0.2",
     "@types/serve-handler": "^6.1.1",
+    "@types/supertest": "^6.0.2",
     "@types/uuid": "^9.0.8",
     "@types/wrap-ansi": "^8.0.1",
     "@types/ws": "^8.2.0",
@@ -100,6 +101,7 @@
     "react-dom": "^16.14.0",
     "rimraf": "^3.0.2",
     "simple-git": "^3.16.0",
+    "supertest": "^6.3.4",
     "ts-node": "^10.9.1",
     "ts-node-dev": "^2.0.0",
     "tslib": "^2.3.1",

src/adapters/api/app.ts

@@ -36,9 +36,8 @@ export class App {
     await this.initializeErrorHandling();
   }
   public listen() {
-    this.app.listen(this.port, () => {
+    return this.app.listen(this.port, () => {
       logger.info('=================================');
-      logger.info(`= ENV: ${this.env}`);
       logger.info(`= 🚀 AsyncAPI Server API listening on the port ${this.port}`);
       logger.info('=================================');
     });

src/api.ts

@@ -8,6 +8,6 @@ export async function runApi(port: string| number) {
     new GeneratorController()
   ], port);
   await app.init();
-  app.listen();
+  return app.listen();
 }
 // runApi();

test/integration/api.test.ts

@@ -0,0 +1,33 @@
+// api.test.js
+import { expect, test } from '@oclif/test';
+import supertest from 'supertest';
+import { App } from '../../src/adapters/api/app';
+import { PingController } from '../../src/adapters/api/controllers/ping.controller';
+import { GeneratorController } from '../../src/adapters/api/controllers/generator.controller';
+
+const apiUrl = 'http://localhost:3001/v1';
+let server: any;
+let api: any;
+
+describe('API Tests', () => {
+  before(async() => {
+    api = new App([
+      new PingController(),
+      new GeneratorController()
+    ], 3001);
+    await api.init();
+    server = api.listen();
+  });
+  after(() => {
+    server.close();
+  });
+  describe('/ping', () => {
+    test
+      .it('should return 200 for /ping', async (ctx, done) => {
+        const response = await supertest(apiUrl).get('/ping');
+        console.log(`response: ${JSON.stringify(response)}`);
+        expect(response.status).to.equal(200);
+        done();
+      });
+  });
+});