NestJS TDD

개요

Test-Driven Development (TDD)는 소프트웨어 개발 방법론 중 하나로, 테스트 코드를 작성하고 그 후에 실제 코드를 작성하는 접근 방식

테스트 코드의 범위

1. Unit Test : 모듈을 구성하고 있는 단위 기능들에 대한 테스트
2. Integration Test : 어플리케이션을 구성하는 여러 모듈 간 상호작용에 대한 테스트
3. E2E Test : End to End Test로 사용자의 관점에서 어플리케이션이 의도대로(시나리오대로) 작동하는지에 대한 테스트

목표

• 품질 향상: 테스트 주도 개발은 초기부터 코드의 품질을 보장하므로 소프트웨어의 안정성을 향상
• 유지보수성 강화: 테스트 케이스를 작성하면 변경 사항에 대한 영향을 쉽게 파악하고 수정할 수 있다
• 빠른 개발 주기: 작은 단위의 기능을 작성하고 테스트하는 반복적인 사이클을 통해 개발 주기를 단축

기대 효과

• 디버깅 시간 감소: 초기에 테스트를 작성하면 추후 디버깅 소요 시간 감소
• 리팩토링 용이성: 코드 변경 시 테스트가 실패하면서 더 나은 설계로의 리팩토링 용이
• 신뢰성 향상: 작성한 테스트 케이스를 통해 소프트웨어의 신뢰성이 향상되어 사용자에게 더 안정적인 제품 제공

사용 프레임워크

• Jest - https://jestjs.io/docs/getting-started

개발 사이클

1. 요구사항 정의
   • 모듈, 컨트롤러, 서비스 등의 구조를 고려하여 애플리케이션의 기본 구조를 설계
2. Unit test 코드 작성
   • 아직 구현되지 않은 기능에 대한 테스트 코드를 작성 (service layer)
   • Unit test 코드 예시 (NestJS)

// payments.service.spec.ts
describe('PaymentsService', () => {
  let app: TestingModule;
  let paymentsService: PaymentsService;

	// beforeEach - 각 테스트 케이스가 수행되기 전에 필요한 코드 작성 (module 의존성 정의 및 service 객체 생성 등), 필요에 따라 beforeAll로 대체
  beforeEach(async () => {
    app = await Test.createTestingModule({
      imports: [AppModule],
    }).compile();

    paymentsService = app.get<PaymentsService>(PaymentsService);
  });

	// afterEach - 각 테스트 케이스가 수행 완료된 후 처리할 코드 작성, 필요에 따라 afterAll로 대체
  afterEach(() => {
    app.close();
  });

	// 테스트 명세 정의
  describe('[Payments]', () => {
		// 테스트 코드 작성
    test('.register 결제 등록 서비스', async () => {
			// mock data 정의
      const data = {
        method: 0,
        orderList: [
          {
            productId: 1,
            count: 5,
          },
          {
            productId: 3,
            count: 2,
          },
          {
            productId: 2,
            count: 3,
          },
        ],
      } as Payments;
      data.memberId = 1;
      data.createdBy = 'system';

			// service unit 테스트 결과에 따른 예상되는 결과를 toMatchObject로 비교
      expect(await paymentsService.register(data)).toMatchObject({
        orderId: expect.anything(), // uuid
        orderName: 'Velostar Share 2.0 외 2건',
        amount: 10050000,
        customerEmail: undefined,
        customerName: undefined,
      });
    });
		
		test('.register 결제 등록 서비스 - 예외 케이스 1 : 유효하지 않은 productId', async () => {
      const data = {
        method: 0,
        orderList: [
          {
            productId: 100,
            count: 5,
          }
        ],
      } as Payments;
      data.memberId = 1;
      data.createdBy = 'system';
      await expect(paymentsService.register(data)).rejects.toEqual(new InternalServerErrorException('Transaction Fail.'));
    });
  });
});

3. 기능 구현 및 예외 코드 작성
4. 테스트 코드 실행
   
5. 리팩토링 (테스트 코드 및 메인 코드 업데이트)
6. unit test 코드를 e2e 코드로 통합
   • e2e test 코드 예시 (NestJS)

describe('AppController (e2e)', () => {
  let app: INestApplication;
  let adminAuth;
  let businessAuth;
  let memberAuth;

  let membersService;
  let membersBusinessService;
  let businessDetailsService;

  beforeAll(async () => {
    const moduleRef: TestingModule = await Test.createTestingModule({
      imports: [AppModule],
    }).compile();

    membersService = moduleRef.get<MembersService>(MembersService);
    adminAuth = await membersService.signIn({
      identifier: 'superAdmin@blockodyssey.io',
      password: 'test123!',
    } as Members);

    businessAuth = await membersService.signIn({
      identifier: 'testVehicleE@blockodyssey.io',
      password: 'test123!',
    } as Members);

    memberAuth = await membersService.signIn({
      identifier: 'testMemberE@blockodyssey.io',
      password: 'test123!',
    } as Members);

    membersBusinessService = moduleRef.get<MembersBusinessService>(MembersBusinessService);
    businessDetailsService = moduleRef.get<BusinessDetailsService>(BusinessDetailsService);

    app = moduleRef.createNestApplication();
    await app.init();
  });

  afterAll(() => {
    app.close();
  });

  describe('[Auth]', () => {
    test('회원 가입', () => {
      return request(app.getHttpServer())
        .post('/members/signUp')
        .send({
          members: {
            identifier: 'newUser@blockodyssey.io',
            password: 'test123!',
          },
        })
        .expect(201);
    });

    test('회원 가입 - 이메일 중복', () => {
      return request(app.getHttpServer())
        .post('/members/signUp')
        .send({
          members: {
            identifier: 'admin@blockodyssey.io',
            password: 'test123!',
          },
        })
        .expect(409);
    });

    test.skip('회원 인증', () => {
      return request(app.getHttpServer())
        .post('/members/verify')
        .send({
          members: {
            verifyKey: '$2b$10$qYXQiBx0ti0iJYi6j5O.t.dZFCin6JWw2vyTxvVYbuTfstn/AdsJ2',
          },
        })
        .expect(201);
    });

  });

});

7. 테스트 Coverage 체크
8. 반복