Jest로 Express 테스트하기

Jest로 Express API 유닛 테스트를 할 때 겪었던 문제를 다른 사람들도 안 겪었으면 하는 바램에서 글을 썼다. 원래 유닛 테스트는 MochaChai를 사용했는데 이번에 한 번 Jest로 테스트 프레임워크를 바꿔보았다.

Jest를 사용하기 위해서는 일단 Install.

1
npm install --save-dev babel-cli, babel-preset-env, jest, supertest

아래는 간단한 웹 서버 코드다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// app.js
import express from 'express';

const app = express();
const port = 3000;

app.get('/hello', (req, res) => {
res.send('world!');
});

app.get('/status', (req, res) => {
res.send('ok');
});

app.listen(port);

module.exports = app;

매우 간단한 이 웹 서버는 두 개의 라우트(/hello, /status)밖에 없다. /hello 라우트는 단순하게 “world!” 문자열만 리턴하며 /status는 단순하게 “ok” 문자열만 리턴한다.

이제 Jest와 Supertest를 사용해서 이 라우트를 테스트를 해보겠다.

먼저 /hello

1
2
3
4
5
6
7
8
9
10
11
12
// tests/hello.test.js
import request from 'supertest';
import app from '../app';

describe('Test /hello', () => {
it ('should return world!', (done) => {
request(app).get('/hello').then((response) => {
expect(response.text).toBe('world!');
done();
});
});
});

Test!

깔끔하게 성공한 것을 볼 수 있다.

그럼 이제 /status에 대한 테스트를 해보자. 이 테스트는 다른 파일에 작성하도록 한다. 물론 식은 죽 먹기다.

1
2
3
4
5
6
7
8
9
10
11
12
// tests/status.test.js
import request from 'supertest';
import app from '../app';

describe('Test /status', () => {
it ('should return ok', (done) => {
request(app).get('/status').then((response) => {
expect(response.text).toBe('ok');
done();
});
});
});

Test! fire

scream 당연히 성공할 줄 알았던 테스트가 EADDRINUSE 에러를 내면서 실패했다. 문제는 첫 번째 테스트를 실행하면서 서버는 아직도 3000번 포트를 listen 하고 있기 때문이다. 그래서 두 번째 테스트에서 다시 import app from ‘../app’ 을 실행하면 이전 테스트에서 이미 listen하고 있는 3000번 포트를 다시 사용하기 때문에 문제가 발생한 것이었다.

이 문제를 해결하기 위해서는 테스트가 아닐 경우에만 3000번 포트를 열도록 변경해야 한다. 어차피 테스트 환경일 경우에는 Supertest를 통해서 서버를 구동하기 때문에 네트워크 포트를 열 필요가 없다. 따라서 package.json을 아래와 같이 바꾼다.

1
2
3
4
5
{
"scripts": {
"unit": "NODE_ENV=test jest tests/*.test.js --forceExit",
}
}

그리고 app.js를 아래와 같이 바꾼다.

1
2
3
4
// ...
if (process.env.NODE_ENV !== 'test') {
app.listen(port);
}

다시 한 번 실행하면

성공!

공유하기 댓글