SQ Official Doc Link: https://docs.sonarqube.org/display/SONAR/Concepts
Table of Contents
아키텍처(Architecture)
Concept | Definition | Related Topics |
|---|---|---|
| Analyzer | 소스 코드를 분석하여 스냅샷(snapshot)을 계산하는 클라이언트 어플리케이션. | SonarQube 설치 및 업그레이드 참조 |
| Database | 다음 내용을 저장합니다:
| SonarQube 설치 및 업그레이드 참조 |
| Server | 스냅샷(snapshot) 데이터를 브라우즈하고, 환경 설정값을 변경하기 위해 사용하는 웹 인터페이스 | SonarQube 설치 및 업그레이드 참조 |
품질(Quality)
Concept | Definition | Related Topics |
|---|---|---|
| Bug | 코드의 잘못된 지점을 표시하는 이슈입니다. 소프트웨어가 깨지기 직전의 상태에 있으며, 이 이슈는 반드시 수정되어야 합니다. | |
| Check | 체크(Check) = 코딩 규칙(Coding Rule) | |
| Code Smell | 유지보수성과 관련된 이슈입니다. 해당 이슈를 현재 상태로 두는 것은 최선의 경우, 코드 유지보수 담당자가 코드 변경시 필요한 것보다 더 많은 노력을 들여야 함을 의미합니다. 최악의 경우, 코드를 이해할 수 없을 정도로 혼란스럽기 때문에 코드를 변경할 때마다 새로운 에러가 추가될 수 있습니다. | |
| Coding Rule | 바람직한 코딩 프랙티스입니다. 코딩 프랙티스를 준수하지 않는 경우 코드 품질 저하가 발생하며, SonarQube에 이슈가 생성됩니다. 코딩 규칙들은 파일(file), 단위 테스트(unit test) 혹은 패키지(package)를 대상을 품질을 확인합니다. | See Viewing Unit Tests > Issues Perspective |
| Component | 소프트웨어 일부(project, module/package, file), 뷰(view) 혹은 디벨로퍼(developer)를 의미합니다. | |
| Cost | 개선 비용(Remediation Cost) 참조. | |
| Debt | 기술 부채(Technical Debt) 참조. | |
| Issue | When a component does not comply with a coding rule, an issue is logged (was violation prior to SonarQube 3.6) on the snapshot. An issue can be logged on a source file or a unit test file. There are 3 types of issue:
| |
| Leak Period | The period for which you're keeping a close watch on the introduction of new problems in the code. Typically this is since the previous_version, but if you don't use a Maven-like versioning scheme you may need to set a relatively arbitrary time period such as 21 days or since a specific date. | |
| Measure | The value of a metric for a given component at a given time. Examples:
| |
| Metric | A type of measurement. Metrics can have varying values, or measures, over time. Examples: number of lines of code, complexity, etc. A metric may be either:
| See detailed documentation on metrics. |
| Non-functional requirement | Non-functional requirement = coding rule | |
| Quality Profile | A set of coding rules. Each snapshot is based on a single quality profile. | See Quality Profiles. |
| Remediation Cost | The estimated time required to fix Vulnerability and Reliability Issues. | |
| Snapshot | A set of measures and issues on a given component at a given time. A snapshot is generated for each analysis. | |
| Technical Debt | The estimated time required to fix all Maintainability Issues / code smells | |
| Vulnerability | A security-related issue which represents a potential backdoor for attackers. See also Security-related rules. |
