Gradle: SonarQube 리포트 만들기: 핵심 가이드, 예제, 방법

혹시 코드 품질을 자동으로 체크하는 방법을 고민하고 계신가요? 버그를 미리 잡고, 보안을 철저하게 지키면서 유지보수도 편리하게 만들 수 있다면 정말 좋겠죠? 바로 그 역할을 하는 게 SonarQube입니다! 예전에는 Gradle에서 명령어 하나로 쉽게 분석할 수 있었지만, 최신 버전부터는 보안 토큰이 필요해졌어요. 처음엔 살짝 귀찮을 수도 있지만, 몇 가지 설정만 하면 금방 끝나니 걱정 마세요!

이 글에서는 SonarQube를 Gradle과 함께 설정하는 방법을 하나하나 차근차근 알려드릴게요. 처음 접하는 분들도 쉽게 따라 할 수 있도록 최대한 친절하게 설명할 테니, 부담 없이 따라오시면 됩니다! 😊

 

---

 

Gradle: SonarQube 리포트 만들기: 핵심 가이드, 예제, 방법

 

SonarQube, 이게 대체 뭔가요?

SonarQube는 코드 품질과 보안을 자동으로 분석해주는 아주 유용한 오픈 소스 도구입니다. 여러 프로그래밍 언어를 지원하고, CI/CD 환경과도 잘 맞아떨어져서 개발자들이 애용하죠. 주요 기능을 간단히 살펴볼까요?

• 중복 코드 감지 – "어? 이 코드 또 있네?" 싶은 부분을 찾아줍니다.
• 버그 및 보안 취약점 감지 – 예상치 못한 보안 허점을 미리 경고해 줍니다.
• 코드 품질 개선 제안 – 더 깔끔하고 유지보수하기 편한 코드로 바꿀 방법을 알려줘요.
• 테스트 커버리지 분석 – 테스트가 충분한지 체크해 줍니다.
• 코드 복잡도 분석 – 너무 복잡한 코드라면 경고를 띄워 줍니다.

Gradle과 연동하면 이런 점검이 자동으로 가능하니, 효율적인 개발을 원하신다면 꼭 한 번 써보세요!

 

---

 

왜 보안 토큰이 필요할까요?

예전 SonarQube는 그냥 명령어 하나만 입력하면 분석이 됐지만, 최신 버전에서는 보안 토큰이 필수로 추가되었습니다. 왜 그런 걸까요?

• 보안 강화 – 누구나 우리 프로젝트를 분석할 수 없도록 보호합니다.
• 사용자 인증 – 누가 분석을 실행했는지 명확하게 기록됩니다.
• CI/CD 환경에서 안전한 연동 – 자동화된 빌드 과정에서도 보안을 유지할 수 있습니다.

번거로워 보일 수도 있지만, 한 번만 설정하면 크게 신경 쓰지 않아도 됩니다. 자, 이제 토큰을 만들어봅시다!

 

---

 

1단계: SonarQube 보안 토큰 만들기

1. SonarQube 로그인하기

• 웹 브라우저에서 SonarQube 인스턴스에 접속하고 로그인하세요.

 

2. 보안 설정으로 이동

• 우측 상단의 프로필 아이콘을 클릭한 후 My Account > Security로 이동합니다.

 

3. 보안 토큰 생성

• Tokens 섹션에서 Generate Token 버튼을 누르세요.
• 원하는 이름(예: Gradle-Sonar-Token)을 입력하고 Generate를 클릭하면 토큰이 생성됩니다.
• 생성된 토큰을 복사해서 안전한 곳(메모장, 패스워드 매니저 등)에 저장하세요.

 

⚠ 중요: 이 페이지를 닫으면 토큰을 다시 확인할 수 없으니, 꼭 저장하세요! 분실하면 새로 만들어야 합니다.

 

---

 

2단계: Gradle에서 SonarQube 설정하기

1. SonarQube 플러그인 추가

Gradle 빌드 파일(build.gradle)에 SonarQube 플러그인을 추가해야 합니다.

 

Groovy 기반 Gradle

plugins {
    id "org.sonarqube" version "4.0"
}

 

Kotlin 기반 Gradle

plugins {
    id("org.sonarqube") version "4.0"
}

 

2. SonarQube 속성 설정

SonarQube 프로젝트 키와 서버 URL을 build.gradle에 추가하세요.

sonarqube {
    properties {
        property "sonar.projectKey", "your_project_key"
        property "sonar.host.url", "http://your-sonarqube-instance-url"
    }
}

 

각 항목을 실제 프로젝트 키와 SonarQube 서버 URL로 변경하면 됩니다!

 

---

 

3단계: SonarQube 분석 실행하기

보안 토큰과 함께 SonarQube 분석을 실행하려면 아래 명령어를 입력하세요.

gradle sonar -Dsonar.login=YOUR_GENERATED_TOKEN

 

예제:

gradle sonar -Dsonar.login=12345abcdef67890

 

⚠ 실제 실행할 때는 12345abcdef67890 대신 여러분이 생성한 토큰을 입력하세요!

 

---

 

4단계: SonarQube 리포트 확인하기

모든 설정이 끝났다면 이제 분석 결과를 확인해볼까요?

• SonarQube 대시보드에 접속하세요.
• 프로젝트를 선택하면 코드 품질 점검 결과를 볼 수 있습니다.

 

---

 

SonarQube & Gradle 활용 꿀팁

1. 보안 토큰을 안전하게 저장하세요!

매번 입력하는 게 번거롭다면 gradle.properties 파일에 저장할 수도 있어요.

sonar.login=YOUR_GENERATED_TOKEN

 

그리고 build.gradle에서 이렇게 설정하면 됩니다.

sonarqube {
    properties {
        property "sonar.login", findProperty("sonar.login")
    }
}

 

2. CI/CD 파이프라인에 자동화 적용하기

Jenkins, GitHub Actions, GitLab CI 같은 도구와 연동하면 SonarQube 분석을 자동화할 수 있습니다.

 

3. 코드 품질 점검을 습관화하세요!

• 팀원들과 함께 정기적으로 분석 결과를 검토하세요.
• SonarQube의 Quality Gates 기능을 활용하면 품질이 낮은 코드를 배포 전에 걸러낼 수 있습니다.