Unit Testing the User Service

🔶 Jest Path Error

TypeScript에서는 절대경로를 이해할 수 있지만 jest는 아래와 같이 경로를 이해하지 못한다.
Cannot find module 'src/common/entities/core.entity' from 'users/entities/user.entity.ts'

🔸 해결방법

// package.json

  "jest": {
    "moduleNameMapper": {
     "^src/(.*)$": "<rootDir>/$1"
   },
   "moduleDirectories": [
     "src",
     "node_modules"
   ],
  }

🔷 Mocking

🔹 getRepositoryToken()

유닛 테스트에서 일반적으로 데이터베이스 연결을 피하고 테스트를 독립적으로 유지하고 실행 프로세스를 최대한 빠르게 유지하기를 원한다.

이를 위해서는 연결 인스턴스에서 가져온 Repository 대신에 Mock Repository를 만들어 custom providers를 사용할 수 있다.

클래스가 @InjectRepository() 데코레이터를 사용하여 UsersRepository를 요청할 때마다 Nest는 등록된 mockRepository 객체를 대신 사용한다.
https://docs.nestjs.com/techniques/database#testing

describe('UserService', () => {
  let service: UserService;
  let usersRepository: MockRepository<User>;

  beforeAll(async () => {
    const module = await Test.createTestingModule({
      providers: [
        UserService,
        {
          provide: getRepositoryToken(User),
          useValue: mockRepository,
        },
        {
          provide: getRepositoryToken(Verification),
          useValue: mockRepository,
        },
        {
          provide: JwtService,
          useValue: mockJwtService,
        },
        {
          provide: MailService,
          useValue: mockMailService,
        },
      ],
    }).compile();
    service = module.get<UserService>(UserService);
    usersRepository = module.get(getRepositoryToken(User));
  });

🔹 jest.fn()

• 새로운 mock 함수를 생성한다.
  https://jestjs.io/docs/jest-object#jestfnimplementation

it('should fail if the password is wrong', async () => {
      const mockedUser = {
        checkPassword: jest.fn(() => Promise.resolve(false)),
      };
      usersRepository.findOne.mockResolvedValue(mockedUser);
      const result = await service.login(loginArgs);
      expect(result).toEqual({ ok: false, error: 'Wrong Password' });
    });

• jest.fn(implements)
  jest.fn 내부에 함수를 구현하여 mockResolvedValue와 같이 해당 line을 가로채는 기능을 할 수 있다.

const mockRepository = {
  findOne: jest.fn(),
  save: jest.fn(),
  create: jest.fn(),
};

const mockJwtService = {
  sign: jest.fn(),
  verify: jest.fn(),
};

const mockMailService = {
  sendVerificationEmail: jest.fn(),
};

🔹 Record

• 테스트를 할 때 레포지토리를 받아와서 사용하지 않고 mock Repository를 사용해야 하는데 이 때 mock Repository애서도 레포지토리를 받아와서 사용할 때와 같이 Repository 내장 함수를 모두 사용할 수 있어야만 한다. 이 내장 함수 또한 모두 mock type으로 만들며 그 때 사용하는 것이 Record이다.

• Record는 속성 키가 Key이고 속성 값이 Type인 객체 유형을 구성한다.
  이 유틸리티는 유형의 속성을 다른 유형에 매핑하는 데 사용할 수 있다.

type MockRepository<T = any> = Partial<Record<keyof Repository<T>, jest.Mock>>;

🔹 Reason of Mocking

- .mockfn.mockResolvedValue()

아래의 코드와 같이 테스트하고자 하는 함수(createAccount)를 실행하기 전에 mockfn.mockResolvedValue를 사용하면 userService의 createAccount 실행에 쓰이는 findOne line을 가로채 mock result를 return 할 수 있다.

이렇게 함으로써 다른 function과 실제 데이터베이스에 의존하지 않고 함수 자체만을 테스트할 수 있다. 이렇게 하는 이유는 integration test가 아닌 unit test, 함수 하나만을 테스트하기 위한 것이기 때문이다.

describe('createAccount', () => {
    it('Should fail if user exists', async () => {
      usersRepository.findOne.mockResolvedValue({
        id: 1,
        email: 'exist@naver.com',
      });
      const result = await service.createAccount({
        email: '',
        password: '',
        role: 0,
      });
      expect(result).toMatchObject({
        ok: false,
        error: 'There is a user with that email already',
      });
    });
  });

🔷 npm run test:cov

npm run test:cov는 테스트의 진행상황(어떠한 파일에 몇 퍼센트가 테스트 되었고 몇 번째 줄이 테스트 되었는지)를 나타낸다. 실행하게 되면 원치 않는 파일의 진행상황까지 모두 보여주기 때문에 이를 제한하기 위해서는 package.json을 다음과 같이 수정해야한다.

"coveragePathIgnorePatterns": [
      "node_modules",
      ".entity.ts",
      ".constants.ts"
    ]

🔷 mockResolvedValue VS mockReturnValue

• await를 사용하는 줄은 하나의 promise를 반환하기 때문에 mockResolvedValue를 리턴하게 하고 그게 아닌 경우에는 값을 반환하는 메서드에서 mockReturnValue를 사용한다.

	usersRepository.findOne.mockResolvedValue(undefined);
    usersRepository.create.mockReturnValue(createAccountArgs);

📑 UserService Testing Code

https://github.com/Ju-yeop/nuber-eats-backend/blob/main/src/users/users.service.spec.ts