Docker로 SonarQube 실행
# SonarQube 서버 실행
docker run -d --name sonarqube \
-p 9000:9000 \
-e SONAR_ES_BOOTSTRAP_CHECKS_DISABLE=true \
-v sonarqube_data:/opt/sonarqube/data \
-v sonarqube_extensions:/opt/sonarqube/extensions \
-v sonarqube_logs:/opt/sonarqube/logs \
sonarqube:lts-community
# 브라우저에서 http://localhost:9000 접속
# 초기 계정: admin / admin
# PostgreSQL과 함께 실행 (프로덕션)
# docker-compose.yml
# version: "3"
# services:
# sonarqube:
# image: sonarqube:lts-community
# depends_on:
# - db
# environment:
# SONAR_JDBC_URL: jdbc:postgresql://db:5432/sonar
# SONAR_JDBC_USERNAME: sonar
# SONAR_JDBC_PASSWORD: sonar
# ports:
# - "9000:9000"
# db:
# image: postgres:15
# environment:
# POSTGRES_USER: sonar
# POSTGRES_PASSWORD: sonar
# POSTGRES_DB: sonar
sonar-project.properties 설정
# 프로젝트 식별
sonar.projectKey=my-project
sonar.projectName=My Project
sonar.projectVersion=1.0
# 소스 코드 위치
sonar.sources=src
sonar.tests=tests
sonar.exclusions=**/node_modules/**,**/dist/**,**/*.test.ts
# 언어별 설정
sonar.language=java
sonar.java.binaries=target/classes
sonar.java.source=17
# 커버리지 리포트 연동
sonar.coverage.jacoco.xmlReportPaths=target/site/jacoco/jacoco.xml
sonar.javascript.lcov.reportPaths=coverage/lcov.info
sonar.python.coverage.reportPaths=coverage.xml
# 정적 분석 리포트 연동 (ESLint, Pylint 등)
sonar.eslint.reportPaths=eslint-report.json
sonar.python.pylint.reportPaths=pylint-report.txt
# 인코딩
sonar.sourceEncoding=UTF-8
# 브랜치 분석 (Developer Edition 이상)
# sonar.branch.name=feature/my-feature
# Pull Request 분석
# sonar.pullrequest.key=123
# sonar.pullrequest.branch=feature/my-feature
# sonar.pullrequest.base=main
GitHub Actions CI/CD 통합
# .github/workflows/sonarqube.yml
name: SonarQube Analysis
on:
push:
branches: [main, develop]
pull_request:
types: [opened, synchronize, reopened]
jobs:
sonarqube:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0 # 전체 히스토리 (blame 분석용)
- name: Set up JDK 17
uses: actions/setup-java@v4
with:
java-version: '17'
distribution: 'temurin'
- name: Cache SonarQube packages
uses: actions/cache@v4
with:
path: ~/.sonar/cache
key: ${{ runner.os }}-sonar
- name: Build and Test with Coverage
run: |
./gradlew build jacocoTestReport
- name: SonarQube Scan
uses: SonarSource/sonarqube-scan-action@master
env:
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
with:
args: >
-Dsonar.projectKey=my-project
-Dsonar.sources=src/main
-Dsonar.tests=src/test
-Dsonar.java.binaries=build/classes
-Dsonar.coverage.jacoco.xmlReportPaths=build/reports/jacoco/test/jacocoTestReport.xml
# PR 분석 시 Quality Gate 결과 확인
- name: SonarQube Quality Gate
uses: SonarSource/sonarqube-quality-gate-action@master
timeout-minutes: 5
env:
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
Python 프로젝트 분석 예제
# 의존성 설치
pip install coverage pytest pytest-cov
# 테스트 및 커버리지 수집
pytest --cov=src --cov-report=xml --cov-report=html tests/
# SonarScanner 실행
sonar-scanner \
-Dsonar.projectKey=my-python-project \
-Dsonar.sources=src \
-Dsonar.tests=tests \
-Dsonar.python.coverage.reportPaths=coverage.xml \
-Dsonar.python.version=3.11 \
-Dsonar.host.url=http://localhost:9000 \
-Dsonar.token=$SONAR_TOKEN
SonarQube API 활용
import requests
from typing import Optional
class SonarQubeClient:
"""SonarQube REST API 클라이언트"""
def __init__(self, base_url: str, token: str):
self.base_url = base_url.rstrip('/')
self.session = requests.Session()
self.session.auth = (token, '') # token as username, empty password
def get_project_status(self, project_key: str) -> dict:
"""프로젝트 Quality Gate 상태 조회"""
response = self.session.get(
f"{self.base_url}/api/qualitygates/project_status",
params={"projectKey": project_key}
)
response.raise_for_status()
return response.json()
def get_issues(
self,
project_key: str,
severities: Optional[list] = None,
types: Optional[list] = None,
page_size: int = 100
) -> list:
"""프로젝트 이슈 목록 조회"""
params = {
"componentKeys": project_key,
"ps": page_size,
"resolved": "false"
}
if severities:
params["severities"] = ",".join(severities)
if types:
params["types"] = ",".join(types)
all_issues = []
page = 1
while True:
params["p"] = page
response = self.session.get(
f"{self.base_url}/api/issues/search",
params=params
)
response.raise_for_status()
data = response.json()
all_issues.extend(data["issues"])
if len(all_issues) >= data["total"]:
break
page += 1
return all_issues
def get_metrics(self, project_key: str, metrics: list) -> dict:
"""프로젝트 메트릭 조회"""
response = self.session.get(
f"{self.base_url}/api/measures/component",
params={
"component": project_key,
"metricKeys": ",".join(metrics)
}
)
response.raise_for_status()
return response.json()
def create_quality_gate_condition(
self,
gate_name: str,
metric: str,
operator: str, # "LT", "GT"
error: str
):
"""Quality Gate 조건 추가"""
# 먼저 gate ID 조회
gates = self.session.get(
f"{self.base_url}/api/qualitygates/list"
).json()
gate_id = None
for gate in gates["qualitygates"]:
if gate["name"] == gate_name:
gate_id = gate["id"]
break
if not gate_id:
raise ValueError(f"Quality Gate '{gate_name}' not found")
response = self.session.post(
f"{self.base_url}/api/qualitygates/create_condition",
data={
"gateId": gate_id,
"metric": metric,
"op": operator,
"error": error
}
)
response.raise_for_status()
return response.json()
# 사용 예제
client = SonarQubeClient("http://localhost:9000", "squ_xxxxx")
# Quality Gate 상태 확인
status = client.get_project_status("my-project")
print(f"Quality Gate: {status['projectStatus']['status']}")
# 심각한 이슈 조회
critical_issues = client.get_issues(
"my-project",
severities=["BLOCKER", "CRITICAL"],
types=["BUG", "VULNERABILITY"]
)
print(f"Critical issues: {len(critical_issues)}")
# 주요 메트릭 조회
metrics = client.get_metrics("my-project", [
"coverage",
"duplicated_lines_density",
"sqale_rating", # Maintainability
"reliability_rating",
"security_rating",
"ncloc" # Lines of code
])
for measure in metrics["component"]["measures"]:
print(f"{measure['metric']}: {measure['value']}")