프로젝트 페이지
SQ Official Doc Link: https://docs.sonarqube.org/display/SONAR/Project+Page
Table of Contents
프로젝트 페이지(Project Page)는 프로젝트의 첫 페이지로 다음 정보를 표시합니다:
- 해당 프로젝트의 릴리즈 가능 상태
- 해당 프로젝트의 현재 품질 상태
- 해당 프로젝트의 Leak Period 이후 변경된 품질 상태
프로젝트 페이지의 정보를 통해 다음을 판단할 수 있습니다:
- 오늘 프로젝트를 릴리즈 할 수 있는가?
- 그렇지 않다면, 품질 게이트를 통과하기 위해 어떤 개선을 해야할 것인가?
오늘 프로젝트를 릴리즈 할 수 있는가?
품질 게이트는 품질 정책을 적용할 수 있는 가장 강력한 도구이기 때문에, 프로젝트 페이지는 해당 프로젝트의 현재 품질 게이트 상태를 가장 먼저 표시합니다. 프로젝트가 품질 게이트를 통과했다면, 아주 단순한 초록색의 all-clear 아이콘이 나타납니다.
그렇지 않은 경우, 세부 사항이 바로 표시되어 무엇이 잘못되었는지 즉시 확인할 수 있습니다. 각 에러 혹은 주의 조건을 통해 현재 프로젝트 상태와 설정한 권장상태를 표시합니다.
무엇을 가장 먼저 수정해야 하는가?
프로젝트 품질을 개선하는 가장 최고의 방법은 신규 이슈들이 묻혀버리기 전에 즉시 수정하는 것입니다. 따라서 프로젝트 페이지의 중심에는 Leak Period가 오른쪽 노란색 영역으로 표시합니다. 프로젝트 스페이스 페이지는 핵심적인 지표들을 현재 값과 Leak Period 값으로 표시합니다.
품질 게이트 정보 바로 하단에서 신뢰성(Reliability), 보안성(Security) 및 유지보수성(Maintainability)과 관련된 과거 이슈와 신규 이슈 정보를 확인할 수 있습니다. 각 지표를 클릭하면 Measure Page 혹은 Issues Page로 이동하며 세부 정보를 확인할 수 있습니다.
개발자가 수행해야 하는 가장 중요한 일은 화면의 노란 영역의 신규 이슈 발생 여부를 확인하고, 검토하고 필요한 경우 수정을 하는 것입니다. 과거의 코드에 얼마나 많은 이슈가 존재했었는지에 관계 없이, 신규로 유입된 이슈 처리에 집중함으로써 과거에 릴리즈했던 소프트웨어 버전에 비해 상황이 마빠지지 않는 것을 보증할 수 있습니다.
그렇다면 어떤 이슈들을 먼저 처리해야 합니까? 버그, 취약점(Velnerabilities) 아니면 코드 스멜(Code Smell) 중 어떤 것입니까. 그것은 여러분의 코드에 존재하는 이슈의 성격에 따라 다릅니다. 예를 들어 5번의 중복된코드 블럭을 가지고 있다고 가정해 보겠습니다. 그리고 중복된 코드 블록 내에 3개의 버그와 5개의 보안 이슈가 있습니다. 아마도 먼저 중복을 제거한 뒤, 버그와 취약점을 정리된 코드에서 수정하는 것이 가장 최선의 방법일 것입니다.
때문에 발생한 이슈를 곧바로 수정하기 전에, 먼저 신규 이슈를 리뷰하는 것이 중요합니다.
어떻게 확인하나요...?
하위 레벨에서 프로젝트의 지표를 확인하려면?
프로젝트 레벨의 Measures 메뉴를 클릭하면 모든 프로젝트의 지표를 확인할 수 있는 별도의 페이지로 이동합니다.확인하고자 하는 지표를 클릭하거나, 지표 레벨 메뉴를 사용해 탐색하고자 하는 지표의 도메인을 돌아봅니다.
하나의 프로젝트에 존재하는 모든 이슈를 확인하려면?
프로젝트 레벨의 Issues 메뉴를 클릭하면 프로젝트 별 Issues 페이지로 이동합니다. 상위 레벨에서 수행할 수 있는 모든 작업을 수행할 수 있습니다. 이 페이지에서 Leak Period에 유입된 New Issues 목록에 신속하게 접근할 수 있습니다:
프로젝트 구조와 코드를 확인하려면?
프로젝트 레벨의 Code 메뉴를 클릭하면 프로젝트 구조의 아웃라인을 확인할 수 있습니다. 디렉토리의 파일 리스트를 확인하고, 파일을 클릭해 해당 파일의 코드를 확인할 수 있습니다.
프로젝트 규모가 너무 커서 드릴다운을 통해 세부 파일에 저근할 수 없는 경우, 같은 페이지의 검색 기능을 사용할 수 있습니다. 메인 메뉴의 검색 창은 SonarQube 인스턴스 전체에서 결과를 반환하며, 코드 페이지의 검색창은 해당 프로젝트의 파일과 디렉토리에서 결과를 반환합니다.
프로젝트 액티비티 / 히스토리를 확인하려면?
프로젝트 레빌의 Activity 메뉴를 클릭하면 해당 프로젝트가 SonarQube에 생성된 이후 수행된 코드 스캔 목록 전체를 표시할 수 있습니다. 또한 품질 게이트 및 품질 프로파일의 변화, 코드 스캔 당시의 버전 정보를 확인할 수 있습니다.
프로젝트의 리스크를 손쉽게 확인하려면?
시각화 도구를 사용해 프로젝트 컴포넌트를 비교해 가장 큰 리스크를 가진 요소를 신속하게 파악할 수 있습니다.
© 2017-2018 Moses Kim.
별도의 언급이 없는 한, 이 스페이스의 컨텐츠는 크리에이티브 커먼즈 저작자표시-비영리-동일조건변경허락 4.0 국제 라이선스에 따라 이용할 수 있습니다.
SONARQUBE는 SonarSource SA의 트레이드 마크입니다. 모든 트레이트 마크 및 저작권은 각 소유자의 소유물입니다.
::: SonarQube 관련 문의 : 이메일 :::