test: re-implement e2e test with standard naming and structure

Author: kenso312

src/modules/app/app.config.ts

@@ -39,6 +39,7 @@ export class AppConfig {
     const { BASE_PATH, CLUSTERING, LOG_LEVEL, NODE_ENV } = process.env;
 
     return {
+      // Exclude may not work for e2e testing
       exclude: [
         {
           method: RequestMethod.ALL,

src/modules/app/app.service.spec.ts

@@ -13,7 +13,7 @@ describe('AppService', () => {
     service = app.get<AppService>(AppService);
   });
 
-  describe('get the app version number', () => {
+  describe('getVersion()', () => {
     it('should return version number', async () => {
       const result: VersionRes = {
         version: process.env.npm_package_version,
@@ -22,10 +22,9 @@ describe('AppService', () => {
     });
   });
 
-  describe('get the health status', () => {
-    const OK = 'OK';
-    it(`should return ${OK}`, async () => {
-      expect(service.healthz()).toEqual(OK);
+  describe('healthz()', () => {
+    it('should return health status', async () => {
+      expect(service.healthz()).toEqual('OK');
     });
   });
 });

src/utils/helper.ts

@@ -1,5 +1,6 @@
 import { ApiResponseOptions } from '@nestjs/swagger';
 import { INestApplication } from '@nestjs/common';
+import { NodeEnv } from '@share/enums';
 import { NormalException } from '@/exception/normal.exception';
 
 /**
@@ -19,10 +20,13 @@ export const toSwaggerError = (
  * Encapsulate the init setup for bootstrap, E2E testing and swagger script resued
  */
 export const initialize = (app: INestApplication) => {
+  const { BASE_PATH, NODE_ENV } = process.env;
+
   app.enableVersioning();
 
-  // Enable CORS by default because Swagger UI required
-  app.enableCors();
+  // For Swagger UI
+  if (NODE_ENV === NodeEnv.DEVELOPMENT) app.enableCors();
 
-  app.setGlobalPrefix(process.env.BASE_PATH);
+  // For convenience
+  if (BASE_PATH && NODE_ENV !== NodeEnv.TEST) app.setGlobalPrefix(BASE_PATH);
 };

test/app.e2e-spec.ts

@@ -3,14 +3,15 @@ import {
   FastifyAdapter,
   NestFastifyApplication,
 } from '@nestjs/platform-fastify';
+import { HttpSuccessResponse } from '@share/interfaces';
 import { Test, TestingModule } from '@nestjs/testing';
+import { des } from './common';
 import { initialize } from '@util/helper';
-import { wrapDataObj } from './common';
 
-describe('AppController (e2e)', () => {
+describe('AppModule', () => {
   let app: NestFastifyApplication;
 
-  const { BASE_PATH, npm_package_version } = process.env;
+  const { npm_package_version } = process.env;
 
   beforeAll(async () => {
     const moduleFixture: TestingModule = await Test.createTestingModule({
@@ -27,24 +28,26 @@ describe('AppController (e2e)', () => {
     await app.getHttpAdapter().getInstance().ready();
   });
 
-  const versionPath = `${BASE_PATH}/version`;
-  it(`${versionPath} (GET)`, async () => {
-    const result: VersionRes = { version: npm_package_version };
+  des({ url: '/version' }, async (config) => {
+    it('should return version number with 200 status code', async () => {
+      const expectedResult: VersionRes = { version: npm_package_version };
+      const response = await app.inject(config);
+      const actualResult = response.json<HttpSuccessResponse<VersionRes>>();
 
-    const response = await app.inject({
-      url: versionPath,
+      expect(response.statusCode).toEqual(200);
+      expect(actualResult.data).toEqual(expectedResult);
     });
-    expect(response.statusCode).toEqual(200);
-    expect(response.json()).toEqual(wrapDataObj(result));
   });
 
-  const healthPath = `${BASE_PATH}/healthz`;
-  it(`${healthPath} (GET)`, async () => {
-    const response = await app.inject({
-      url: healthPath,
+  des({ url: '/healthz' }, async (config) => {
+    it('should return health status with 200 status code', async () => {
+      const expectedResult = 'OK';
+      const response = await app.inject(config);
+      const actualResult = response.json<HttpSuccessResponse<string>>();
+
+      expect(response.statusCode).toEqual(200);
+      expect(actualResult.data).toEqual(expectedResult);
     });
-    expect(response.statusCode).toEqual(200);
-    expect(response.json()).toEqual(wrapDataObj('OK'));
   });
 
   afterAll(async () => {

test/common.ts

@@ -1,6 +1,13 @@
+import { InjectOptions } from 'fastify';
+
 /**
- * Returns an object with a 'data' key.
+ * Wrapper function for showing request URL and method in the description
  */
-export const wrapDataObj = <T = any>(data: T) => {
-  return { data };
+export const des = (
+  config: InjectOptions,
+  action: (config: InjectOptions) => Promise<void> | void
+) => {
+  describe(`${config.url}  (${config.method || 'GET'})`, () => {
+    action(config);
+  });
 };