Merge pull request #506 from boostcampwm-2024/perf/test-parallel

⚡️ perf: E2E 테스트 병렬 실행 개선 (3)

Author: Jo-Minseok

server/src/app.module.ts

@@ -11,7 +11,6 @@ import { FeedModule } from './feed/module/feed.module';
 import { WinstonLoggerModule } from './common/logger/logger.module';
 import { ChatModule } from './chat/module/chat.module';
 import { StatisticModule } from './statistic/module/statistic.module';
-import { TestModule } from './common/test/test.module';
 import { UserModule } from './user/module/user.module';
 import { ActivityModule } from './activity/module/activity.module';
 import { EmailModule } from './common/email/email.module';
@@ -60,7 +59,6 @@ const exists = !!chosen && fs.existsSync(chosen);
     }),
     WinstonLoggerModule,
     RedisModule,
-    TestModule,
     EmailModule,
     MetricsModule,
     AdminModule,

server/src/common/database/load.config.ts

@@ -5,9 +5,15 @@ export function loadDBSetting(configService: ConfigService) {
   const isDev = env === 'LOCAL' || env === 'DEV';
   const isTest = env === 'TEST';
 
+  const workerId = process.env.JEST_WORKER_ID;
+
+  const database = isTest
+    ? `denamu_test_${workerId}`
+    : configService.get<string>('DB_NAME');
+
   return {
-    type: configService.get<'mysql' | 'sqlite'>('DB_TYPE'),
-    database: configService.get<string>('DB_NAME'),
+    type: configService.get<'mysql'>('DB_TYPE'),
+    database,
     host: configService.get<string>('DB_HOST'),
     port: configService.get<number>('DB_PORT'),
     username: configService.get<string>('DB_USER'),

server/src/common/redis/redis.module.ts

@@ -11,11 +11,14 @@ import Redis from 'ioredis';
       provide: 'REDIS_CLIENT',
       inject: [ConfigService],
       useFactory: (configService: ConfigService) => {
+        const workerId = Number(process.env.JEST_WORKER_ID ?? 0);
+
         return new Redis({
           host: configService.get<string>('REDIS_HOST'),
           port: configService.get<number>('REDIS_PORT'),
           username: configService.get<string>('REDIS_USER'),
           password: configService.get<string>('REDIS_PASSWORD'),
+          db: workerId,
         });
       },
     },

server/src/common/test/test.module.ts

@@ -50,8 +50,7 @@ export class UserScheduler {
       }
     } catch (error) {
       this.logger.error(
-        `[UserScheduler]: streak 업데이트 스케줄러 동작중 오류 발생: ${error.message}`,
-        error.stack,
+        `[UserScheduler]: streak 업데이트 스케줄러 동작중 오류 발생: ${error}`,
       );
     }
   }

server/src/common/test/test.service.ts

@@ -1,4 +1,4 @@
-import { HttpStatus, INestApplication } from '@nestjs/common';
+import { HttpStatus } from '@nestjs/common';
 import * as supertest from 'supertest';
 import { UserRepository } from '../../../src/user/repository/user.repository';
 import { ActivityRepository } from '../../../src/activity/repository/activity.repository';
@@ -7,30 +7,31 @@ import { ActivityFixture } from '../../config/common/fixture/activity.fixture';
 import { User } from '../../../src/user/entity/user.entity';
 import TestAgent from 'supertest/lib/agent';
 import { ReadActivityQueryRequestDto } from '../../../src/activity/dto/request/readActivity.dto';
+import { Activity } from '../../../src/activity/entity/activity.entity';
+import { testApp } from '../../config/e2e/env/jest.setup';
 
 const URL = '/api/activity';
 
 describe(`GET ${URL}/{userId} E2E Test`, () => {
-  let app: INestApplication;
   let user: User;
-  let activities: Array<{ activityDate: Date; viewCount: number }>;
+  let activities: Activity[];
   let agent: TestAgent;
+  let activityRepository: ActivityRepository;
+  let userRepository: UserRepository;
 
-  beforeAll(async () => {
-    app = global.testApp;
-    agent = supertest(app.getHttpServer());
-    const userRepository = app.get(UserRepository);
-    const activityRepository = app.get(ActivityRepository);
-    user = await userRepository.save(UserFixture.createUserFixture());
-    activities = Array.from({ length: 5 }).map((_, i) =>
-      ActivityFixture.createActivityFixture(
-        user,
-        { viewCount: (i + 1) * 2 },
-        i,
-      ),
-    );
+  beforeAll(() => {
+    agent = supertest(testApp.getHttpServer());
+    activityRepository = testApp.get(ActivityRepository);
+    userRepository = testApp.get(UserRepository);
+  });
 
-    await activityRepository.insert(activities);
+  beforeEach(async () => {
+    user = await userRepository.save(
+      await UserFixture.createUserCryptFixture(),
+    );
+    activities = await activityRepository.save(
+      ActivityFixture.createActivitiesFixture(user, 3),
+    );
   });
 
   it('[404] 존재하지 않는 사용자 ID로 요청할 경우 활동 데이터 조회를 실패한다.', async () => {
@@ -61,13 +62,12 @@ describe(`GET ${URL}/{userId} E2E Test`, () => {
 
     // Http then
     const { data } = response.body;
-    const expectedDailyActivities = activities.map((activity) => ({
-      date: activity.activityDate.toISOString().split('T')[0],
-      viewCount: activity.viewCount,
-    }));
     expect(response.status).toBe(HttpStatus.OK);
     expect(data).toStrictEqual({
-      dailyActivities: expectedDailyActivities,
+      dailyActivities: activities.map((activity) => ({
+        date: activity.activityDate.toISOString().split('T')[0],
+        viewCount: activity.viewCount,
+      })),
       maxStreak: user.maxStreak,
       currentStreak: user.currentStreak,
       totalViews: user.totalViews,

server/src/user/scheduler/user.scheduler.ts

@@ -1,39 +1,46 @@
-import { AdminFixture } from './../../config/common/fixture/admin.fixture';
-import { HttpStatus, INestApplication } from '@nestjs/common';
+import {
+  ADMIN_DEFAULT_PASSWORD,
+  AdminFixture,
+} from './../../config/common/fixture/admin.fixture';
+import { HttpStatus } from '@nestjs/common';
 import { LoginAdminRequestDto } from '../../../src/admin/dto/request/loginAdmin.dto';
 import * as supertest from 'supertest';
 import { AdminRepository } from '../../../src/admin/repository/admin.repository';
 import TestAgent from 'supertest/lib/agent';
 import { RedisService } from '../../../src/common/redis/redis.service';
 import { REDIS_KEYS } from '../../../src/common/redis/redis.constant';
 import * as uuid from 'uuid';
+import { Admin } from '../../../src/admin/entity/admin.entity';
+import { testApp } from '../../config/e2e/env/jest.setup';
 
 const URL = '/api/admin/login';
 
 describe(`POST ${URL} E2E Test`, () => {
-  let app: INestApplication;
   let agent: TestAgent;
   let redisService: RedisService;
+  let admin: Admin;
+  let adminRepository: AdminRepository;
   const redisKeyMake = (data: string) => `${REDIS_KEYS.ADMIN_AUTH_KEY}:${data}`;
   const sessionKey = 'admin-login-sessionKey';
 
-  beforeAll(async () => {
-    app = global.testApp;
-    agent = supertest(app.getHttpServer());
-    redisService = app.get(RedisService);
-    const adminRepository = app.get(AdminRepository);
-    await adminRepository.insert(await AdminFixture.createAdminCryptFixture());
+  beforeAll(() => {
+    agent = supertest(testApp.getHttpServer());
+    redisService = testApp.get(RedisService);
+    adminRepository = testApp.get(AdminRepository);
   });
 
-  beforeEach(() => {
+  beforeEach(async () => {
     jest.spyOn(uuid, 'v4').mockReturnValue(sessionKey as any);
+    admin = await adminRepository.save(
+      await AdminFixture.createAdminCryptFixture(),
+    );
   });
 
   it('[401] 등록되지 않은 ID로 로그인할 경우 로그인을 실패한다.', async () => {
     // given
     const requestDto = new LoginAdminRequestDto({
       loginId: 'testWrongAdminId',
-      password: AdminFixture.GENERAL_ADMIN.password,
+      password: ADMIN_DEFAULT_PASSWORD,
     });
 
     // Http when
@@ -54,7 +61,7 @@ describe(`POST ${URL} E2E Test`, () => {
   it('[401] 비밀번호가 다를 경우 로그인을 실패한다.', async () => {
     // given
     const requestDto = new LoginAdminRequestDto({
-      loginId: AdminFixture.GENERAL_ADMIN.loginId,
+      loginId: admin.loginId,
       password: 'testWrongAdminPassword!',
     });
 
@@ -76,8 +83,8 @@ describe(`POST ${URL} E2E Test`, () => {
   it('[200] 존재하는 사용자의 정보로 로그인할 경우 로그인을 성공한다.', async () => {
     // given
     const requestDto = new LoginAdminRequestDto({
-      loginId: AdminFixture.GENERAL_ADMIN.loginId,
-      password: AdminFixture.GENERAL_ADMIN.password,
+      loginId: admin.loginId,
+      password: ADMIN_DEFAULT_PASSWORD,
     });
 
     // Http when
@@ -93,6 +100,6 @@ describe(`POST ${URL} E2E Test`, () => {
     const savedSession = await redisService.get(redisKeyMake(sessionKey));
 
     // DB, Redis then
-    expect(savedSession).toBe(AdminFixture.GENERAL_ADMIN.loginId);
+    expect(savedSession).toBe(admin.loginId);
   });
 });

server/test/activity/e2e/get.e2e-spec.ts

@@ -1,23 +1,25 @@
-import { HttpStatus, INestApplication } from '@nestjs/common';
+import { HttpStatus } from '@nestjs/common';
 import * as supertest from 'supertest';
 import { RedisService } from '../../../src/common/redis/redis.service';
 import { REDIS_KEYS } from '../../../src/common/redis/redis.constant';
 import TestAgent from 'supertest/lib/agent';
+import { testApp } from '../../config/e2e/env/jest.setup';
 
 const URL = '/api/admin/logout';
 
 describe(`POST ${URL} E2E Test`, () => {
-  let app: INestApplication;
   let agent: TestAgent;
   let redisService: RedisService;
   const redisKeyMake = (data: string) => `${REDIS_KEYS.ADMIN_AUTH_KEY}:${data}`;
   const sessionKey = 'admin-logout-sessionKey';
   const sessionId = 'test1234';
 
-  beforeAll(async () => {
-    app = global.testApp;
-    agent = supertest(app.getHttpServer());
-    redisService = app.get(RedisService);
+  beforeAll(() => {
+    agent = supertest(testApp.getHttpServer());
+    redisService = testApp.get(RedisService);
+  });
+
+  beforeEach(async () => {
     await redisService.set(redisKeyMake(sessionKey), sessionId);
   });
 
@@ -70,9 +72,9 @@ describe(`POST ${URL} E2E Test`, () => {
     expect(data).toBeUndefined();
 
     // DB, Redis when
-    const savedSessionId = await redisService.get(redisKeyMake(sessionKey));
+    const savedSession = await redisService.get(redisKeyMake(sessionKey));
 
     // DB, Redis then
-    expect(savedSessionId).toBeNull();
+    expect(savedSession).toBeNull();
   });
 });

server/test/admin/e2e/login.e2e-spec.ts

@@ -1,4 +1,4 @@
-import { HttpStatus, INestApplication } from '@nestjs/common';
+import { HttpStatus } from '@nestjs/common';
 import { RegisterAdminRequestDto } from '../../../src/admin/dto/request/registerAdmin.dto';
 import * as supertest from 'supertest';
 import { AdminFixture } from '../../config/common/fixture/admin.fixture';
@@ -7,27 +7,25 @@ import TestAgent from 'supertest/lib/agent';
 import { RedisService } from '../../../src/common/redis/redis.service';
 import { REDIS_KEYS } from '../../../src/common/redis/redis.constant';
 import * as bcrypt from 'bcrypt';
-import { Admin } from '../../../src/admin/entity/admin.entity';
+import { testApp } from '../../config/e2e/env/jest.setup';
 
 const URL = '/api/admin/register';
 
 describe(`POST ${URL} E2E Test`, () => {
-  let app: INestApplication;
   let agent: TestAgent;
   let adminRepository: AdminRepository;
-  let admin: Admin;
+  let redisService: RedisService;
   const sessionKey = 'admin-register-session-key';
   const redisKeyMake = (data: string) => `${REDIS_KEYS.ADMIN_AUTH_KEY}:${data}`;
 
-  beforeAll(async () => {
-    app = global.testApp;
-    agent = supertest(app.getHttpServer());
-    adminRepository = app.get(AdminRepository);
-    const redisService = app.get(RedisService);
-    admin = await adminRepository.save(
-      await AdminFixture.createAdminCryptFixture(),
-    );
-    await redisService.set(redisKeyMake(sessionKey), admin.loginId);
+  beforeAll(() => {
+    agent = supertest(testApp.getHttpServer());
+    adminRepository = testApp.get(AdminRepository);
+    redisService = testApp.get(RedisService);
+  });
+
+  beforeEach(async () => {
+    await redisService.set(redisKeyMake(sessionKey), 'testAdminId');
   });
 
   it('[401] 관리자 로그인 쿠키가 없을 경우 회원가입을 실패한다.', async () => {
@@ -83,9 +81,12 @@ describe(`POST ${URL} E2E Test`, () => {
 
   it('[409] 중복된 ID로 회원가입을 할 경우 다른 관리자 계정 회원가입을 실패한다.', async () => {
     // given
+    const admin = await adminRepository.save(
+      await AdminFixture.createAdminCryptFixture(),
+    );
     const newAdminDto = new RegisterAdminRequestDto({
-      loginId: AdminFixture.GENERAL_ADMIN.loginId,
-      password: AdminFixture.GENERAL_ADMIN.password,
+      loginId: admin.loginId,
+      password: 'testNewAdminPassword!',
     });
 
     // Http when
@@ -136,8 +137,5 @@ describe(`POST ${URL} E2E Test`, () => {
     expect(
       await bcrypt.compare(newAdminDto.password, savedAdmin.password),
     ).toBeTruthy();
-
-    // cleanup
-    await adminRepository.delete({ loginId: newAdminDto.loginId });
   });
 });