Newman 사용 방법

Newman이란?

Newman은 포스트맨을 cmd/터미널에서 실행시킬 수 있는 러너입니다.

포스트맨에 만들어 놓은 컬렉션과 환경 변수를 지정해서 실행하고 테스트할 수 있습니다.

일반적으로 서버는 윈도우보다는 Unix 계열 OS를 많이 사용하기 때문에 newman을 설치해서 배치성이나 api 자동화 테스트하는 데 사용하고 있습니다.

 

Newman Install

뉴맨을 설치하기 위해서 선행으로 설치되어 있어야 되는 것이 있습니다.

node.js (https://nodejs.org/en/download/current/) 링크에 들어가서 os에 맞게 node.js를 설치해주세요.

 

node.js가 설치 완료됐다면 newman을 설치하겠습니다.

cmd/터미널을 열고 newman 패키지를 설치합시다.

$npm install -g newman
$newman -v    # newman 제대로 설치 됐는지 버전 체크

 

 

포스트맨에 만들어 놓은 컬렉션을 newman으로 실행시켜 보겠습니다.

필요한 파일로 포스트맨에 만들어 놓은 컬렉션 파일과 컬렉션에서 사용한 환경 변수 파일이 필요합니다.

$ newman 컬렉션파일명.json # 환경변수를 사용하지 않다면 컬렉션만 실행시키면 됩니다.
$ newman 컬렉션파일명.json -e 환경변수파일명.json # 환경변수를 사용한다면 -e 플래그와 함께 사용한다.

 

실행 결과

포스트맨 실행한 방식과 동일하게 cli로 실행시킬 수 있습니다.

 

실제 실무에서 newman으로 api 자동화 테스트를 사용하고 있습니다.

개발을 하다 보면 프로젝트가 커짐에 따라서 일부 코드 수정으로 인해서 다른 코드가 실행이 안될 수 있는 상황이 발생할 수 있기 때문에 현재 배포 전에 api 전수 검사용으로 사용하고 있습니다. (깃헙 액션 사용)

전수 검사를 통해서 api 하나라도 실패를 하게 된다면 배포를 안하게 됨으로써 버그나 오류를 사전에 방지할 수 있어서 newman을 사용하는 것을 추천드립니다.

 

다만, 단점이라면 api가 추가될 때마다 계속 관리를 해줘야 되기 때문에 신경을 안쓰게 된다면 사용하는 의미가 퇴색될 수 있습니다.