Express 서버 API 테스트 하기
아래에서 진행되는 코드 완성본은 깃허브 레포지터리에 올려두었습니다.
서버 테스트를 하는 이유
서버에서 이뤄지는 로직들은 보통 DB 를 조작한다.
그래서 프론트에서 실행되는 로직보다는 중요도가 높고 더 위험한 경우가 많다.
그렇기 때문에 모든 API에 테스트를 작성할 수는 없어도 핵심 로직들에는 테스트를 셋업해두는게 정신 건강에 좋을 수 있다(!?) 라는 결론을 내렸다.
나에게 서버 테스트가 어려웠던 이유
테스트 코드를 작성하는 것은 어렵지 않다.
"테스트 코드를 실행시켜줄 환경이 세팅이 되어 있다면!...."
나에게는 테스트 코드를 작성하는게 어려웠던 이유는 테스트를 하기 위한 환경 세팅이었다.
그것이 어려워서 항상 벽에 부딪치는 경우가 많았다. 환경 셋업이 되어있다면 실제로 테스트를 짜주는 것은 크게 어렵지 않았다.
그러니.... 테스트 코드를 작성하기 위한 라이브러리, 환경 셋업을 기본적으로 보고 마지막으로 테스트 코드 작성까지 한 번 해봐야겠다.
핵심 개념
먼저 서버를 테스트 하기 위해 필요한 세팅의 핵심 개념부터 알아보자.
- 테스트용 DB를 따로 셋업해준다
- API 가 테스트용 DB를 바라보게 셋업해주고 CRUD를 하면서 테스트를 해본다
테스트 데이터베이스 셋업
테스트를 위해서 분리된 데이터베이스를 띄워줄 것이다.
보통 개발용 DB를 5432 포트에 일반적으로 띄워주고 있을 거니까 충돌하지 않게 5433 포트에 띄워준다.
Docker를 사용해서 기존 것과 충돌하지 않는 분리된 공간을 만들어주자.
docker-compose.yml
version: "3.8"
services:
db:
image: postgres:16-alpine
container_name: test-db
environment:
POSTGRES_USER: ${DB_USER}
POSTGRES_PASSWORD: ${DB_PASSWORD}
POSTGRES_DB: ${DB_NAME}
ports:
- "5433:5432"
POSTGRES에 사용될 유저이름, 패스워드, DB 이름은 환경변수를 통해 넣어줄 것이다. .env.test 로 환경변수를 생성해주자.
.env.test
DB_HOST=localhost DB_PORT=5433 DB_USER=testuser DB_PASSWORD=testpass DB_NAME=testdb
그리고 나서 이제 한 번 세팅이 제대로 되었는지 한 번 테스트를 해보자.
Docker를 이용해 DB 컨테이너를 띄워줄 것인데, 보다시피 .env.test 환경변수를 주입시켜야 한다.
docker-compose --env-file .env.test up 스크립트를 실행해보면 됨.
그러면 docker가 실행이 되면서 컨테이너를 띄울 것이다. docker desktop 에서도 띄워진 것을 확인할 수 있고, docker cli를 사용해서 생성된 postgreSQL 컨테이너의 터미널에 직접 들어가볼수도 있다.
docker exec -it <컨테이너이름> psql -U <유저이름> -d <DB이름> 와 같은 방식으로 터미널 에서 입력을 해주면 실제로 들어가볼수 있다. 우리가 세팅해준 값을 사용한다면 docker exec -it test-db psql -U testuser -d testdb 와 같이 스크립트를 실행시켜주면 된다. 그러면 postgreSQL 터미널에 접속이 될 것이다.
오케이, 데이터베이스를 독립된 공간에 띄우는 세팅은 끝났다!
(아, 참고로 데이터베이스를 꺼주려면 docker-compose down 을 실행해주면 됨)
Supertest와 Jest를 이용한 서버 테스트
테스트 데이터베이스 셋업이 끝났으니 이제 서버 로직을 테스트를 해보자.
우리는 HTTP request 요청을 테스트 할 수 있는 Supertest와 테스트 러너인 Jest 를 사용할 것이다. 일단 스크립트(npm install jest supertest --save-dev)를 실행해서 설치부터 먼저 하면 된다.
그리고 나서 Route와 Controller를 작성해주고, 거기에 알맞는 테스트 코드를 작성해준다.
그에 앞서서 실제 코드에서 테스트 DB 로 접속을 하게 세팅을 해주어야 한다. 여기서 dotenv와 pg 모듈을 사용할 것이니 요것도 설치를 해주어야 함(npm install dotenv pg)
db.js
const { Pool } = require("pg");
require("dotenv").config({ path: `.env.${process.env.NODE_ENV || "dev"}` });
const pool = new Pool({
host: process.env.DB_HOST,
port: process.env.DB_PORT,
user: process.env.DB_USER,
password: process.env.DB_PASSWORD,
database: process.env.DB_NAME,
});
module.exports = pool;
위와 같이 작성을 해두면, 스크립트를 실행할 때 NODE_ENV=test 로 주면 dotenv가 .env.test 에서 환경변수들을 읽어들일 것이다.
이제는 실제 테스트를 작성해보자.
users.test.js
const usersRouter = require("./users");
const request = require("supertest");
const pool = require("./db");
const express = require("express");
const app = express();
app.use(express.json());
app.use("/users", usersRouter);
beforeAll(async () => {
await pool.query(`
CREATE TABLE IF NOT EXISTS users (
id SERIAL PRIMARY KEY,
name VARCHAR(100) NOT NULL
)
`);
});
beforeEach(async () => {
await pool.query("DELETE FROM USERS");
});
// NOTE: 주석을 해제하면 각각의 테스트마다 어떤 데이터가 생성되었는지 볼 수 있습니다!
// afterEach(async () => {
// const users = await pool.query("SELECT * FROM USERS");
// console.log("users: ", users.rows);
// });
afterAll(async () => {
await pool.query(`
DROP TABLE users
`);
await pool.end();
});
describe("GET /users", () => {
test("아무도 없는 경우 빈 array를 돌려줌", async () => {
const getRes = await request(app).get("/users");
expect(getRes.body).toEqual([]);
});
test("유저를 찾아 돌려줌", async () => {
const userCount = 3;
for (let i = 0; i < userCount; i++) {
await request(app)
.post("/users")
.send({ name: `철수 ${i}` });
}
const getRes = await request(app).get("/users");
expect(getRes.body).toHaveLength(3);
});
});
describe("POST /users", () => {
test("User 생성", async () => {
const createRes = await request(app).post("/users").send({ name: "철수" });
expect(createRes.body.name).toBe("철수");
const getRes = await request(app).get("/users");
expect(getRes.body).toHaveLength(1);
expect(getRes.body[0].name).toBe("철수");
});
});
describe("GET /users/:id", () => {
test("User 정보 불러오기", async () => {
const createRes = await request(app).post("/users").send({ name: "철수" });
const getRes = await request(app).get(`/users/${createRes.body.id}`);
expect(getRes.body.name).toBe("철수");
});
});
describe("PATCH /users/:id", () => {
test("User 이름 변경", async () => {
const createRes = await request(app).post("/users").send({ name: "철수" });
await request(app).patch(`/users/${createRes.body.id}`).send({
name: "영희",
});
const getRes = await request(app).get(`/users/${createRes.body.id}`);
expect(getRes.body.name).toBe("영희");
});
});
users.js
const express = require("express");
const pool = require("./db");
const users = express.Router();
users.get("/", async (req, res) => {
const result = await pool.query("SELECT * FROM users");
res.json(result.rows);
});
users.post("/", async (req, res) => {
const { name } = req.body;
const result = await pool.query(
"INSERT INTO users (name) VALUES ($1) RETURNING *",
[name]
);
res.status(200).json(result.rows[0]);
});
users.get("/:id", async (req, res) => {
const { id } = req.params;
const result = await pool.query("SELECT * FROM users WHERE id = $1", [id]);
res.json(result.rows[0]);
});
users.patch("/:id", async (req, res) => {
const { id } = req.params;
const { name } = req.body;
const result = await pool.query(
"UPDATE users SET name = $1 WHERE id = $2 RETURNING *",
[name, id]
);
res.json(result.rows[0]);
});
module.exports = users;
이렇게 하고 나서 터미널에서 NODE_ENV=test npx jest 스크립트를 실행시켜보자.
테스트가 올바르게 실행되고 있는 것을 확인할 수 있다.
테스트를 마치고 나면 테스트 DB를 종료시켜주면 된다. docker-compose down
(추가) Shell 스크립트로 테스트 DB 띄웠다가 바로 내려가게 세팅
현재 테스트를 하는 프로세스는 아래와 같다.
- Docker로 테스트 DB 띄워주기
- 테스트 스크립트 실행하기
- 테스트 DB 종료해주기
그런데 매번할때마다 이렇게 하면 귀찮으니까 하나의 스크립트 파일로 DB 를 띄워주고, 테스트를 실행시켜주고, DB를 종료해주는 셋업까지 해주면 편하다.
test.sh
#!/bin/bash # ↑ shebang: 이 스크립트를 bash 쉘로 실행하라고 시스템에 알려주는 선언문 set -e # ↑ 명령어가 하나라도 실패하면 스크립트를 즉시 중단함 (exit on error) echo "테스트 데이터베이스 시작 중..." docker-compose --env-file .env.test up -d # ↑ docker-compose로 PostgreSQL 컨테이너를 백그라운드(-d)에서 시작 # --env-file .env.test: 환경변수 파일 지정 echo "PostgreSQL 준비 대기 중..." until pg_isready -h localhost -p 5433 -U testuser; do # ↑ pg_isready: PostgreSQL 서버가 연결을 받을 준비가 됐는지 확인하는 명령어 # -h localhost: 접속할 호스트 주소 # -p 5433: 접속할 포트 번호 # -U testuser: 접속할 유저 이름 # until: 조건이 참(true)이 될 때까지 do~done 사이의 명령을 반복 실행 sleep 1 # ↑ 1초 동안 대기한 후 다시 pg_isready 실행 done echo "PostgreSQL 준비 완료!" set +e # ↑ 에러가 발생해도 스크립트를 중단하지 않음 # (테스트가 실패해도 cleanup 작업을 실행해야 하기 때문) npm run test # ↑ NODE_ENV 환경변수를 test로 설정하고 테스트 실행 TEST_EXIT_CODE=$? # ↑ $?는 직전에 실행한 명령어의 종료 코드를 담고 있는 특수 변수 # 0이면 성공, 0이 아니면 실패 # cleanup 후에 이 값을 반환하기 위해 변수에 저장 set -e # ↑ 다시 에러 발생 시 중단 모드로 복귀 echo "테스트 데이터베이스 종료 중..." docker-compose --env-file .env.test down # ↑ Docker 컨테이너 정지 및 삭제 exit $TEST_EXIT_CODE # ↑ 저장해둔 테스트 종료 코드로 스크립트 종료 # CI/CD 파이프라인에서 이 값으로 테스트 성공/실패를 판단함