feat: 코드 정적 분석을 위한 Jacoco 및 SonarCloud 도입 #147
Conversation
Ji-soo708
changed the title
Ji-soo708
changed the title
|
처음 커버리지 측정한 거라 모든 코드에 대해 측정이 됐나보네요. 👀 |
| "**/*Application*", | ||
| "**/*Controller*", | ||
| "**/config/*", | ||
| "**/dto/*", | ||
| "**/exception/*", | ||
| "**/security/*", | ||
| "**/support/*" |
There was a problem hiding this comment.
테스트 커비리지 제외하는 패키지로 이해했는데 맞을까요?
Controller, dto, exception, support 까지 제외한 이유가 궁금합니다~
There was a problem hiding this comment.
네 맞습니다~ 해당 부분은 테스트 리포트 생성을 수행하는 태스크입니다. 저희 프로젝트에서는 주로 비즈니스 로직을 다루는 서비스 위주로 테스트를 진행하기에 서비스 외의 패키지 아래 파일들에 대해서는 커버리지가 비교적 낮게 나옵니다. 그래서 Controller나 dto, exception 이런 패키지들은 다른 프로젝트들에서도 커버리지 영역에서 일반적으로 제외하는 영역이라 저희도 제외했습니다! 만약 해당 패키지나 클래스들을 제외하지 않으면 아래와 같이 커버리지가 낮게 나옵니다.
There was a problem hiding this comment.
dto는 비즈니스로직만 테스트하여도 커버리지가 좀 나왔던 것 같은데, dto도 제외시키는게 좋을까요?
There was a problem hiding this comment.
비즈니스로직 테스트가 잘 되어있어서 dto도 커버리지가 대체적으로 잘 나오는 편이지만 사진처럼 커버리지가 안나오는 dto들도 꽤 있었고 일반적으로 커버리지에서 많이들 제외하는 영역이라 저희도 제외했습니다! 그래도 dto 패키지 커버리지가 90% 나오는데 포함해도 될 거 같네요. 🙂 (근데 라인커버리지쪽에서는 실패뜨는 게 좀 있네요. 일단은 dto 역시 제외하고 머지하겠습니다! 나중에 리팩토링 후에 포함시켜도 될 거 같아요)
| excludes = [ | ||
| '**.*Application*', | ||
| '**.*Controller*', | ||
| '**.config.*', | ||
| '**.dto.*', | ||
| '**.exception.*', | ||
| '**.security.*', | ||
| '**.support.*' | ||
| ] + Qdomains |
There was a problem hiding this comment.
위에 남긴 코멘트 내용과 동일합니다~ 참고로 해당 태스크는 커버리지를 확인하는 태스크입니다.
| with: | ||
| arguments: check | ||
| cache-read-only: ${{ github.ref != 'refs/heads/main' && github.ref != 'refs/heads/develop' }} |
There was a problem hiding this comment.
cache-read-only는 빌드 시에 gradle cache를 이용해서 하도록 적용하는 것으로 이해했는데 맞을까요?
아래 이유가 궁금해서 코멘트 작성해봅니다 😄
- 캐시 도입 이유
- main, develop 브랜치에는 캐시 적용 제외된 이유
There was a problem hiding this comment.
이 부분은 main과 develop 브랜치일때만 cache-read-only가 false되게 설정한 부분입니다. cache-read-only는 true일 경우 cache를 읽기만 하고 cache에 저장하지 않고 false일 경우는 읽기와 저장 모두 수행합니다.
결국 main이나 develop 브랜치에서 푸시될 때만 캐시에 저장되고 다른 브랜치들에서는 캐시읽기만 허용한 것인데 주로 안정된 코드를 추가하는 주요 브랜치에서만 빌드 시간을 최적화하기 위해 이렇게 설정했습니다.
There was a problem hiding this comment.
오..이부분 read-only가 true일 때랑 false일 때랑 시간의 차이도 궁금하네요 👀 새로운 것을 알아갑니다 👍
| with: | ||
| arguments: check | ||
| cache-read-only: ${{ github.ref != 'refs/heads/main' && github.ref != 'refs/heads/develop' }} |
There was a problem hiding this comment.
오..이부분 read-only가 true일 때랑 false일 때랑 시간의 차이도 궁금하네요 👀 새로운 것을 알아갑니다 👍
| - name: Build and analyze | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} |
There was a problem hiding this comment.
SONAR_TOKEN 도 추가되었군요 👀
There was a problem hiding this comment.
네 맞아요. SonarCloud에 대한 액세스를 인증하는데 사용되는 토큰입니다~
| "**/*Application*", | ||
| "**/*Controller*", | ||
| "**/config/*", | ||
| "**/dto/*", | ||
| "**/exception/*", | ||
| "**/security/*", | ||
| "**/support/*" |
There was a problem hiding this comment.
dto는 비즈니스로직만 테스트하여도 커버리지가 좀 나왔던 것 같은데, dto도 제외시키는게 좋을까요?
build.gradle
Outdated
| sonar { | ||
| properties { | ||
| property 'sonar.host.url', 'https://sonarcloud.io' | ||
| property 'sonar.organization', 'mocacong' | ||
| property 'sonar.projectKey', 'mocacong_Mocacong-Backend' | ||
| property 'sonar.coverage.jacoco.xmlReportPaths', 'build/reports/jacoco/index.xml' | ||
| property 'sonar.sources', 'src' | ||
| property 'sonar.language', 'java' | ||
| property 'sonar.sourceEncoding', 'UTF-8' | ||
| property 'sonar.exclusions', '**/test/**, **/resources/**, **/*Application*.java, **/*Controller*.java ,**/config/**, **/dto/**, ' + | ||
| '**/exception/**, **/security/**, **/support/**, **/Q*.java' | ||
| property 'sonar.test.inclusions', '**/*Test.java' | ||
| property 'sonar.java.coveragePlugin', 'jacoco' | ||
| } | ||
| } |
There was a problem hiding this comment.
개인적으로는 jacoco 관련 설정이 아래로 가고 의존성 선언이 더 위쪽으로 왔으면 하는데 어떤가요?
There was a problem hiding this comment.
좋습니다. 안그래도 새로 생긴 태스크들 추가하면서 dependency 위치를 어디다 두어야 할지가 고민됐었네요 ㅎㅎ..
|
개요
작업사항
주의사항