이 문서는  SonarQube에서 test coverage 및 test execution 리포트를 활용해 코드 품질을 평가하는 방법에 대해 설명합니다.



개요

테스트 커버리지 보고서와 테스트 실행 보고서는 코드의 품질을 평가하는 데 도움이 되는 중요한 지표입니다. 

  • 테스트 커버리지 보고서는 코드 중 테스트 케이스로 검증된 부분의 비율을 보여줍니다. 
  • 테스트 실행 보고서는 어떤 테스트가 실행되었는지와 그 결과를 알려줍니다.

아래에서 가이드라인과 리소스, 그리고 언어 및 도구별 분석 파라미터에 대한 정보를 찾으실 수 있습니다.


일반 가이드라인

테스트 커버리지를 가져오기 전에 빌드 파이프라인의 일부로 코드 분석을 수행하도록 적절한 SonarScanner가 구성되어 있어야 합니다.

테스트 커버리지 리포팅을 활성화하려면 다음 단계를 수행해야 합니다.

  1. 빌드 파이프라인에 커버리지 도구 설정

    • 커버리지 도구는 SonarScanner 분석 전에 실행되도록 설정해야 합니다.

  2. 커버리지 도구 출력 리포트 설정

    • SonarScanner가 요구하는 출력 리포트 파일의 위치와 형식에 맞게 커버리지 도구를 구성합니다.

  3. SonarScanner 분석 파라미터 구성

    • SonarScanner가 리포트 파일을 가져올 수 있도록 분석 파라미터를 구성합니다.

위 작업을 완료하면, 빌드할 때마다 커버리지 도구가 분석을 수행하고 결과를 파일에 출력합니다(보통 테스트 커버리지용, 테스트 실행용 각각 하나씩). 

그런 다음 SonarScanner는 분석 프로세스의 일부로서 해당 파일들을 가져와 결과를 SonarQube에 전송합니다.


커버리지 지원

SonarQube는 다양한 언어와 도구의 기본 포맷으로 작성된 커버리지 데이터를 가져오는 것을 지원합니다.

또한, 지원되지 않는 도구의 데이터를 변환하여 사용할 수 있는 일반 포맷도 지원합니다.

하지만 SonarQube는 커버리지 보고서 자체를 생성하지는 않습니다. 

 자세한 가이드

 다음 언어에 대한 자세한 가이드를 제공합니다.

 테스트 커버리지 파라미터

 모든 커버리지 관련 분석 매개변수에 대한 참조는 테스트 커버리지 파라미터를 참조하세요.


테스트 실행 리포트

위의 내용은 테스트 커버리지 리포트, 즉 빌드 중에 테스트 유닛에서 테스트된 코드의 비율을 설명하는 보고서에 대해 설명합니다.

테스트 실행 리포트는 별도의 기능으로, 빌드 중 테스트 유닛 내의 어떤 테스트가 실행되었는지를 설명합니다.

자세한 내용은 테스트 실행 매개변수를 참조하세요.



참조

  • 레이블 없음