모듈 기반 Node.js 프로젝트에서 단위 테스트 하기

Jaden Kim·2023년 4월 26일
JavaScriptjesttest
0
post-thumbnail

저번에 input-output 기반의 테스트가 이상적이라는 글을 썼다.
이 글에서는 javascript로 작성된 Node.js 프로젝트에서 input-output 기반의 테스트 코드를 작성하는 방법을 다루려고 한다.

typescript로 프로젝트가 구성되어 있다면 더 나은 해결책이 많지만, 레거시 코드를 다루다보면 javascript로 되어 있는 프로젝트에서 작업을 해야 하는 경우가 많다.
나와 같이 레거시 환경에서 단위 테스트를 시도해보려고 하는 사람들에게 이 글을 바친다...😇

1. 의존성을 가진 모듈 확인하기

먼저 테스트 대상이 되는 코드를 분석해서, 해당 메서드가 어떤 모듈에 의존성을 가지는지 파악해야 한다.
저번 글에서 다뤘던 getPosts 메서드를 다시 살펴보자..

getPosts는 크게 3개의 작업을 한다.

  1. velogUidRepository.getByUserId 메서드를 통해 사용자에 해당하는 velogUid 데이터를 가져온다.

  2. velogPostAxios.reqGetPosts 메서드를 통해 외부 API와 통신하여 posts 정보를 가져온다.

  3. 받아온 posts 정보를 반환한다.

여기서 1, 2 단계는 외부(db, velog api)와 통신하는 부분이며, 실제로 수행하기 위해서는 시간이 드는 작업들이다.

2. 외부 의존 모듈을 mock으로 감싸기

테스트 상황에서 매번 외부 API를 직접 호출하거나, db와 통신을 해야 한다면 테스트 시간이 매우 길어질 수밖에 없다.
단위 테스트 상황에서는 해당 메서드들을 stubbing해서 구현한 후, 이를 테스트 대상 메서드가 사용하도록 하는 것이 바람직하다.

다만 문제는, 일반적인 레거시 Node.js 프로젝트는 의존성 주입을 사용하고 있지 않다는 것이다.
따라서 테스트 대상 메서드가 stubbing한 구현체를 사용하게 하기 위해서는 모듈 자체를 모킹해야 한다.
모듈 자체를 모킹하면, 해당 모듈을 참조하는 모든 곳에서 모킹된 내용을 바탕으로 동작하게 할 수 있다.

jest.mock()을 사용하면 테스트 대상 모듈을 손쉽게 모킹할 수 있다.

const velogUidRepository = require("#velog-post/repositories/velog-uid.repository");
const velogPostAxios = require("#velog-post/velog-post.axios");

jest.mock("#velog-post/repositories/velog-uid.repository");
jest.mock("#velog-post/velog-post.axios");

이렇게 하면 해당 모듈을 참조하는 모든 곳에서 모킹된 모듈을 사용하게 되어서, stub으로 구현한 메서드를 사용하도록 할 수 있다.

3. 의존하고 있는 메서드에 대한 stub 구현하기

이제 필요한 메서드들에 대한 stub을 구현해야 한다.
테스트에 사용할 임시 데이터들을 상수로 정의해두고, 이를 바탕으로 최소한의 로직을 담고 있는 stub 메서드를 구현할 수 있다.

먼저 velogUidRepository.getByUserId에 대한 stub을 구현해보자.

const EXISTING_USER_ID = 1;
const VELOG_UID = 123;

const VELOG_UID_DATA_LIST = [{ userId: EXISTING_USER_ID, velogUid: VELOG_UID }];

const mockGetVelogUidByUserId = ({ userId }) =>
  Promise.resolve(VELOG_UID_DATA_LIST.find((data) => data.userId === userId));

임의의 velog_uid 정보의 리스트를 담고 있는 VELOG_UID_DATA_LIST를 정의했다.
mockGetVelogUidByUserId는 매개변수로 userId를 받아서, 해당 userId가 담겨있는 데이터를 VELOG_UID_DATA_LIST에서 찾아서 반환한다.

데이터베이스 이용 여부를 제외하면, mockGetVelogUidByUserId는 velogUidRepository.getByUserId와 하는 역할이 비슷하다.
이와 같이 기능을 단순화해서 stub 메서드를 구현하면 된다.

이번엔 velogPostAxios.reqGetPosts에 대한 stub을 구현해보자.

const VELOG_UID = 123;
const VELOG_TOKEN = "valid_token";

const VELOG_POST_LIST = [
  {
    velogUid: VELOG_UID,
    name: "post1",
    content: "hello world",
  },
];

const isValidReq = ({ velogUid, velogToken }) =>
  velogUid === VELOG_UID && velogToken === VELOG_TOKEN;

const mockReqGetVelogPost = ({ velogUid, velogToken }) =>
  isValidReq({ velogUid, velogToken })
    ? Promise.resolve(VELOG_POST_LIST)
    : Promise.reject(VelogAxiosError);

mockReqGetVelogPost는 매개변수로 velogUid, velogToken를 받아서, 이것이 미리 정의해둔 데이터와 일치하는지를 확인한다.
일치할 경우 유효한 요청이라고 판단해서 VELOG_POST_LIST를 resolve 하고, 일치하지 않다면 VelogAxiosError를 reject 한다.

4. stub한 메서드 재활용을 위해 class로 리팩토링하기

위와 같이 구현한 stub 메서드를 여러 테스트 코드에서 재활용하기 위해서는 stub 메서드들을 담고 있는 파일을 구분시킬 필요가 있다.
테스트 코드에서는 해당 파일로부터 메서드를 import 하도록 구성해야 한다.

이렇게 메서드를 모아놓는데 가장 적절한 데이터 구조는 class 라고 판단했다.
그 이유는 특정 데이터를 초기에 넘겨주고 각 stub 메서드에서 이 데이터를 사용하는 구조가 필요했는데, 이 경우에는 class가 가장 적절했기 때문이다.

생성자에서 stub 메서드들이 사용할 데이터를 받고, stub 메서드를 메서드로 가지고 있는 구조는 다음과 같이 구성할 수 있다.

class VelogUidRepositoryStub {
  #velogUidDataList = [];

  constructor(velogUidDataList) {
    this.#velogUidDataList = velogUidDataList;
  }

  async getVelogUidByUserId({ userId }) {
    return this.#velogUidDataList.find((data) => data.userId === userId);
  }
}

만약 stub 메서드에서 사용할 데이터(위 예시의 velogUidDataList)를 stub 파일에서 고정된 값으로 정의해놓는다면, 테스트 코드 안에서 데이터가 명시적으로 드러나지 않게 된다.
이 경우 테스트 코드를 이해하기 위해 stub 메서드를 담고 있는 파일까지 확인해야 하기 때문에 가독성을 저해할 수 있다.
따라서 stub 메서드를 사용하는 측에서 생성자를 통해 사용할 데이터를 넘겨주도록 구성하는 편이 유연성과 가독성 측면에서 적절하다.

VelogPostAxios에 대한 stub은 다음과 같이 정의할 수 있다.
token을 바탕으로 요청에 대한 유효성 검증을 수행하기 때문에, 생성자에서 유효하다고 판단할 토큰 값을 함께 넘겨준다.

class VelogPostAxios에 {
  #velogPostList = [];

  #validVelogToken = "";

  constructor(velogPostList, validVelogToken) {
    this.#velogPostList = velogPostList;
    this.#validVelogToken = validVelogToken;
  }

  async reqGetVelogPostList({ velogUid, velogToken }) {
    if (velogToken === this.#validVelogToken) {
      return this.#velogPostList.filter((post) => post.velogUid === velogUid);
    }
    throw new VelogAxiosError();
}

5. stub한 메서드를 모킹한 모듈에 적용시키기

이제 위와 같이 구현해 둔 stub 메서드를 모킹한 모듈에 적용시켜야 한다.
테스트에서 사용할 데이터를 정의하고, 이를 사용하여 stub 객체를 생성한다.

const EXISTING_USER_ID = 1;
const VELOG_UID = 123;
const VELOG_TOKEN = "valid_token";

const VELOG_UID_DATA_LIST = [{ userId: EXISTING_USER_ID, velogUid: VELOG_UID }];
const VELOG_POST_LIST = [
  {
    velogUid: VELOG_UID,
    name: "post1",
    content: "hello world",
  },
];

const velogUidRepositoryStub = new VelogUidRepositoryStub(VELOG_UID_DATA_LIST);
const velogPostAxiosStub = new VelogPostAxiosStub(VELOG_POST_LIST, VELOG_TOKEN);

이제 stub 메서드를 모킹에 적용시키면 된다.
jest.mock()으로 모듈 자체를 모킹해두었기 때문에 간단하게 stub한 메서드를 적용시킬 수 있다.

단 주의해야 할 점은, 다음과 같이 클래스의 멤버 메서드를 그냥 변수로써 넘겨주게 되면 문제가 발생한다는 점이다.

velogUidRepository.getByUserId.mockImplementation(
  velogUidRepositoryStub.getVelogUidByUserId
);
velogPostAxios.reqGetPosts.mockImplementation(
  velogPostAxiosStub.reqGetVelogPost
);

이것의 이유는, 클래스 문법 내의 메서드는 기본적으로 strict mode 로 실행되기 때문이다.
멤버 메서드를 그냥 변수로 전달하게 되면, 메서드 내에서 객체의 this에 접근하는게 불가능해진다. 참고링크

따라서 다음과 같이 메서드를 하나 wrapping해서 객체를 통해 해당 메서드에 접근하도록 구성해야 한다.

velogUidRepository.getByUserId.mockImplementation((...props) => {
  velogUidRepositoryStub.getVelogUidByUserId(...props);
});
velogPostAxios.reqGetPosts.mockImplementation((...props) => {
  velogPostAxiosStub.reqGetVelogPost(...props);
});

지금까지 작성한 내용을 종합하면 아래와 같다.

describe("velogPostService", () => {
  const EXISTING_USER_ID = 1;
  const VELOG_UID = 123;
  const VELOG_TOKEN = "valid_token";

  const VELOG_UID_DATA_LIST = [
    { userId: EXISTING_USER_ID, velogUid: VELOG_UID },
  ];
  const VELOG_POST_LIST = [
    {
      velogUid: VELOG_UID,
      name: "post1",
      content: "hello world",
    },
  ];

  describe("getPosts", () => {
    beforeEach(() => {
      const velogUidRepositoryStub = new VelogUidRepositoryStub(
        VELOG_UID_DATA_LIST
      );
      velogUidRepository.getByUserId.mockImplementation((...props) => {
        velogUidRepositoryStub.getVelogUidByUserId(...props);
      });

      const velogPostAxiosStub = new VelogPostAxiosStub(
        VELOG_POST_LIST,
        VELOG_TOKEN
      );
      velogPostAxios.reqGetPosts.mockImplementation((...props) => {
        velogPostAxiosStub.reqGetVelogPost(...props);
      });
    });
  });
});

데이터를 정의하는 상수 부분은 describe 최상단에 두거나 beforeAll에 둔다.
그리고 beforeEach 안에 stub 객체를 생성하고 모킹을 적용하는 부분을 넣는다.

이렇게 하는 이유는 필요에 따라서 특정 테스트 케이스에서는 beforeEach에서 구현한 것과 다른 stub 메서드를 해당 mock에 적용시킬 수도 있기 때문이다.
이런 특이 케이스에 대한 테스트가 끝난 후에는 기본 stub 메서드로 매번 변경해주기 위해서 beforeEach에 mock 적용 부분을 넣었다.

6. 실제 테스트 케이스 작성

이제 각 테스트 케이스에 대한 테스트 코드를 작성하면 된다.

stub으로 구현한 메서드를 적용시키는 방법을 사용했기 때문에
행위 기반이 아닌 상태 기반의 직관적인 테스트 코드를 작성할 수 있다.

describe("postService", () => {
  // 필요한 상수 정의
  describe("getPosts", () => {
    beforeEach(() => {
      // 필요한 의존성 mocking 적용
    });

    it("userId, velogToken이 유효할 경우 post 목록을 반환", async () => {
      // given
      const userId = EXISTING_USER_ID;
      const velogToken = VELOG_TOKEN;

      // when
      const posts = await postService.getPosts({
        userId,
        velogToken,
      });

      // then
      expect(posts).toEqual(POST_LIST);
    });
  });
});

에러가 발생하는 경우는 아래와 같이 테스트할 수 있다.

describe("postService", () => {
  // 필요한 상수 정의
  describe("getPosts", () => {
    beforeEach(() => {
      // 필요한 의존성 mocking 적용
    });

    it("userId, velogToken이 유효할 경우 post 목록을 반환", async () => {
      // 정상 호출 상황 테스트
    });

    it("유효하지 않은 userId로 호출하면 UserNotFoundError 발생", async () => {
      // given
      const userId = 999; // 임의의 user id
      const velogToken = VELOG_TOKEN;

      // when
      // then
      await expect(() =>
        postService.getPosts({
          userId,
          velogToken,
        })
      ).rejects.toEqual(new UserNotFoundError());
    });
  });
});
profile
Jaden Kim
이전 포스트

테스트 코드의 이상적 형태 (with Jest)

다음 포스트

테스트 커버리지를 높이면서 코드 개선하기 (with Typescript)

0개의 댓글