cucumber-html-reporter를 이용한 시각적인 Cucumber 테스트 리포트 생성

cucumber-html-reporter는 Cucumber 테스트 수행 결과로 생성된 JSON 파일을 가독성이 높은 HTML 리포트로 변환해주는 유용한 라이브러리입니다. 이 도구는 테스트 결과를 단순히 텍스트로 보여주는 것을 넘어, 다양한 테마와 시각적인 차트를 통해 프로젝트의 품질 상태를 한눈에 파악할 수 있게 도와줍니다.

주요 특징 및 장점

  • 다양한 테마 제공: 사용자의 취향이나 프로젝트 성격에 맞춰 Bootstrap, Hierarchy, Foundation, Simple 등 네 가지 스타일의 테마를 선택할 수 있습니다.
  • 시각적 데이터 표현: 테스트 통과 및 실패율을 파악하기 쉬운 파이 차트(Pie Chart)를 자동으로 생성합니다.
  • 상세한 메타데이터 추가: 테스트 환경, 앱 버전, 브라우저 정보 등 커스텀 메타데이터를 리포트에 포함하여 실행 맥락을 명확히 할 수 있습니다.
  • 스크린샷 첨부: UI 자동화 테스트 중 오류가 발생했을 때, 해당 단계의 스크린샷을 리포트 내부에 직접 임베딩하여 디버깅 효율을 높입니다.
  • 멀티 JSON 병합: 여러 개로 분산된 Cucumber JSON 결과 파일을 하나의 통합 리포트로 합쳐서 관리할 수 있습니다.

활용 사례

이 도구는 특히 CI/CD(지속적 통합/배포) 파이프라인에서 큰 효과를 발휘합니다. 자동화된 빌드 프로세스 끝에 시각적인 리포트를 생성함으로써, 개발자뿐만 아니라 기획자나 품질 관리자 등 비기술적 이해관계자들도 테스트 결과를 쉽게 이해할 수 있습니다. 또한, 실패한 테스트 케이스에 대한 상세한 단계별 설명과 스크린샷은 원인 분석 시간을 획기적으로 단축해 줍니다.

설치 및 설정 방법

프로젝트에 라이브러리를 추가하려면 NPM을 사용하여 간단히 설치할 수 있습니다.

npm install cucumber-html-reporter --save-dev

설치가 완료되면, 다음과 같이 Node.js 스크립트를 작성하여 리포트 생성 로직을 구성할 수 있습니다. 기존의 options 변수 구조를 프로젝트 상황에 맞게 최적화하여 구현해 보겠습니다.

const reporter = require('cucumber-html-reporter');

const reportConfig = {
    theme: 'hierarchy',
    jsonFile: 'logs/cucumber_results.json',
    output: 'artifacts/test_report.html',
    reportSuiteAsScenarios: true,
    scenarioTimestamp: true,
    launchReport: true,
    metadata: {
        "플랫폼": "Web Dashboards",
        "테스트 환경": "Staging",
        "실행 브라우저": "Chrome 120",
        "병렬 실행 여부": "Yes"
    }
};

try {
    reporter.generate(reportConfig);
    console.log('HTML 리포트가 성공적으로 생성되었습니다.');
} catch (err) {
    console.error('리포트 생성 중 오류가 발생했습니다: ', err);
}

위 코드에서 jsonFile은 Cucumber 실행 결과로 얻은 JSON 경로를 가리키며, output은 생성될 HTML 파일의 위치를 지정합니다. launchReport 옵션을 true로 설정하면 리포트 생성이 완료된 후 기본 브라우저에서 자동으로 파일이 열려 결과를 즉시 확인할 수 있습니다.

cucumber-html-reporter는 단순한 결과 전달을 넘어, 자동화 테스트의 가치를 높여주는 강력한 보조 도구입니다. 텍스트 위주의 로그에서 벗어나 데이터 기반의 의사결정을 돕는 세련된 보고 체계를 구축해 보시기 바랍니다.

태그: Cucumber bdd HTML-Reporter Node.js automation-testing

10월 24일 12:09에 게시됨