Mocha는 JavaScript 테스트 프레임워크로, Node.js 환경에서 REST API 테스트를 작성하기 위해 많이 사용됩니다. 이번 포스트에서는 Mocha를 사용하여 REST API 테스트를 작성하는 방법에 대해 알아보겠습니다.
먼저, Mocha를 설치해야 합니다. 프로젝트 폴더에서 다음 명령어를 실행하여 Mocha를 설치합니다:
npm install mocha --save-dev
설치가 완료되면 test 폴더를 생성하고, 해당 폴더에 api.test.js 파일을 만듭니다. 이 파일은 REST API의 테스트 케이스를 작성할 곳입니다.
다음은 Mocha를 사용하여 REST API 테스트를 작성하는 예시입니다:
const assert = require('assert');
const request = require('supertest');
const app = require('../app');
describe('테스트 케이스 그룹 이름', () => {
before((done) => {
// 테스트하기 전에 필요한 작업들을 수행합니다
done();
});
it('GET 메서드 테스트', (done) => {
request(app)
.get('/api/endpoint') // 테스트하고자 하는 엔드포인트 입력
.expect(200)
.end((err, res) => {
if (err) {
return done(err);
}
assert.equal(res.body.message, 'Expected Result');
done();
});
});
it('POST 메서드 테스트', (done) => {
request(app)
.post('/api/endpoint') // 테스트하고자 하는 엔드포인트 입력
.send({ data: 'test' }) // POST 요청에 필요한 데이터 입력
.expect(201)
.end((err, res) => {
if (err) {
return done(err);
}
assert.equal(res.body.message, 'Expected Result');
done();
});
});
after((done) => {
// 테스트가 끝난 후 필요한 작업들을 수행합니다
done();
});
});
위의 예시 코드에서 app은 테스트 대상 서버의 Express 애플리케이션 객체를 가리킵니다. request 모듈로 요청을 생성하고, expect 메서드로 응답 상태 코드를 검증하고, end 메서드에 콜백 함수를 작성하여 추가적인 검증을 수행합니다.
테스트 케이스 그룹이나 테스트 메서드에 대한 설명을 추가하려면 두 번째 인자로 콜백 함수를 작성할 수 있습니다.
위의 예시 코드에서는 before와 after를 사용하여 테스트가 실행되기 전과 후에 필요한 작업들을 수행하도록 할 수 있습니다. 예를 들어, 데이터베이스 연결과 같은 초기화 작업을 before에서 수행하고, 연결을 종료하는 작업을 after에서 수행할 수 있습니다.
Mocha는 기본적으로 비동기 코드를 테스트하기 위해 Promise나 콜백을 사용합니다. 만약 비동기 작업이 완료될 때까지 테스트를 기다리도록 하려면 테스트 함수에 done 파라미터를 추가하고, 작업이 완료될 때마다 done()을 호출하면 됩니다.
이렇게 Mocha를 사용하여 REST API 테스트를 작성할 수 있습니다. Mocha에는 다양한 유용한 기능들이 있으니, 공식 문서나 관련 자료들을 참고하면 더욱 효율적인 테스트 작성이 가능합니다.
참고 문서: