[Tutorial] Node.js REST API-environment split

Node.js REST API - environment split

*환경의 분리

서버가 실행되는 모드를 몇 개 정의해야 한다. 이건 테스트 때문이다. 아직 테스트에 db를 붙이지는 않았지만 곧 테스트에 디비를 붙일 것이다. 하지만 테스트 할 때 디비를 붙이게 되면 데이터베이스 테스트에서 사용한 데이터들이 쌓이게 된다. 따라서 테스트용 데이터 베이스가 따로 있어야하는데 이것을 위해 서버 환경을 분리할 것이다.

우리는 세가지 모드를 사용할 것이다.

-development

-test

-production

“development”는 개발 모드이다. 우리가 지금까지 사용했던 환경이다.

“test”는 테스트 환경을 의미한다.

“production”은 운영모드이다. 실제로 코드가 서버로 배포되어 동작하는 환경을 의미한다.

이러한 환경 정보는 NODE_ENV라는 환경변수에 설정하여 사용할 수있다. 노드 코드에서는 process.env.NODE_ENV 라는 변수를 통해 접근할 수 있다.

테스트 환경과 개발환경을 분리하기 위해서 app/config/environment.js파일을 만들자.

environments 라는 변수를 두어 각 환경 이름에 해당하는 키를 만들었다. 그리고  nodeEnv라는 상수에 노드 환경변수 값을 할당했다. 

노드를 실행하기 전에 “Node_ENV = test”라고 실행하면 이값에 “test”라는 문자열이 들어간다. 만약 아무것도 설정하지 않으면 “development”문자열이 들어가게 될것이다.

마지막으로 environments 객체에서 노드 환경변수에 해당하는 부분의 객체를 반환하는 모듈로 만들었다.

*테스트에 데이터베이스 연동하기

environment 모듈을 사용하여 기존코드를 변경해야한다.

environment에는 데이터베이스 접속정보가 있는데 이 부분은 models.js 를 수정하면 된다.

아래 코드처럼 말이다.

 environments 모듈은 NODE_ENV 환경변수 값에 따라 각각 다른 데이터베이스로 연결한다.

그럼  api/users/user.spec.js 테스트 코드로 돌아가 보자. 모카에는 before() / after() 함수가 있다.

이것은 테스트가 실행되기 전/후에 각각 한번씩 실행되는 함수이다. before() 함수를 이용해 테스트 데이터베이스를 초기화하는 등의 테스트 환경을 만들어 줄 수 있다. 아래 코드를 한번 보자

it()함수가 실행되기 직전 before() 함수가 먼저 실행된다. before() 함수에서는 데이터베이스를 초기화 할 수있는 sync({force: true}) 함수를 실행하면 된다.

*sync-database 모듈

한편 app.js에서 sync() 함수를 사용하고 있는데 이것을 테스트에서도 따로 떼어 내기 위해서는 데이터를 싱크할 수 있는 별도의 모듈로 떼어내는 것이 편리하다.

app/config/environment.js를 다시 수정한다.

test mode에서는 sequelize의 force가 true이지만 development나 production에서는 false이어야만 한다.

 bin/sync-databse.js 파일로 만들어 보자

이 모듈은 데이터베이스를 싱크하는 매우 간단한 코드이다.

실행 모드가 test이냐 아니냐에 따라서force의 값이 달라질것이다.

*www.js

이참에 서버 구동하는 모듈도 별도로 만들어 보자 bin/www.js 파일을 만든다.

서버 구동로직을 옮겨왔으니 app.js에서도 이부분을 제거해야하한다. app.js의 남은 부분은 아래와 같다.

이제는 app.js가 아니라 bin/www.js 파일로 서버를 구동할 수 있다. package.json의 start 스크립트도 변경해야한다.

*테스트 데이터 구성

이제 테스트 코드의 before() 함수에서 데이터베이스 싱크 모듈을 불러와 실행해 보자

user.spec.js  describe()함수의 before()

이제 실제 데이터베이스에 샘플데이터를 넣고 “GET /users”를 테스트 해보자 먼저 before()함수에서 데이터베이스에 데이터 3개를 넣는 코드를 작성한다.

before()함수는 여러개 실행할 수 있다. 전부 다 it() 함수가 호출되기 전에 실행이 완료 된다.

두번째 before() 함수에서는 데이터베이스에 users  테이블에 있는 유저를 추가하는 역할을 한다.

sequelize 모델에는 create() 말고도 bulkCreate() 함수가 있다. create()  함수가 하나의 row만 생성한다면 blukCreate()  함수는 여러개 데이터를 배열로 받아 여러개 row를 생성하는 함수이다. 이렇게 샘플데이터를 테이블에 넣은 후 it()으로 api테스트를 진행 할 수 있다.

*테스트 데이터 삭제

마지막으로 after() 함수를 이용해 데이터베이스를 초기화 한다. 유저 데이터를 넣었기 때문에 다시 삭제하는 것이다. 여기서는 간단히 drop후 데이터베이스 싱크를 돌리자.

after(‘clear up database’, (done) => {

models.User.drop();

syncDatabase().then( () => done());

});

*테스트 코드 실행

마지막으로 테스트를 실행해야한다. 이번에는 NODE_ENV 환경변수를 설정해 주어야 한다. 우리는 테스트 데이터베이스와 개발 데이터베이스를 분리했으니까 테스트시에는 테스트 데이터베이스로 접속해야한다.

테스트 실행시  “NODE_ENV=test”만 추가해주면 된다.

package.json

그리고 명령문에서 npm test로 테스트를 진행한다.

$ npm test

*나머지 테스트코드에서도 데이터베이스를 연결해보자

• Create(POST)

• Destroy(DELETE)
  

*폴더정리

다시 한번리펙토링을 해야할 것 같다. 리펙토링은 많이 할수록 좋음!

bin이라는 폴더를 만들게 되면서 서버 어플리케이션 코드와 섞이게 되었다.

bin폴더에는 두개의 파일이 있는데 데이터베이스를 싱크하는 sync-database.js와 서버를 실제로 구동하는 www.js이 있다. 엄밀히 말하는 어플리케이션 로직은 아닌셈이다.

한편 api 폴더에는 라우팅 로직들과 models.js에 정의된 모델링 코드들은 어플리케이션으로 분리할 수 있다.

아래와 같이 파일들을 옮기자

/app: 서버 기능

/api: api로직을 담당

/config: 서버가 구동하기 위한 환경 변수 정의 (상수)

/models: 데이터베이스 모델링

/bin: 서버 구동을 위한 코드

/www.js: 서버 구동

/sync-database: db 싱크

각 파일에서 사용하는 모듈의 상대 경로도 변경하는 것을 잊지말자.

코드는 https://github.com/kiryun/NodeJS_REST-API_tutorial/commits/master 에서 볼 수 있다.