[#7] feat: jacoco & SonarCloud 도입 (#8)

* chore: jacoco & SonarCloud 도입

* chore: CovigatorApplicationTests에 classes 속성 삽입

* chore: CI 스크립트에 외부 환경 변수 주입

* chore: 빌드 파일 수정

* chore: 빌드 파일 수정

* chore: 디렉토리 경로 수정

* chore: 빌드 파일 수정

* chore: 빌드 파일 수정

* chore: 빌드 파일 수정

* refactor: sonarcloud 이슈 해결

* refactor: sleep() 제거

* refactor: 불필요한 예외 throw 제거

.github/workflows/backend-ci.yml

@@ -10,6 +10,10 @@ on:
       - main
       - develop
 
+env:
+  JWT_SECRET_KEY: ${{ secrets.JWT_SECRET_KEY }}
+  JWT_EXPIRATION_LENGTH: ${{ secrets.JWT_EXPIRATION_LENGTH }}
+
 jobs:
   build:
     name: Build and analyze

build.gradle

@@ -2,6 +2,8 @@ plugins {
 	id 'java'
 	id 'org.springframework.boot' version '3.3.0'
 	id 'io.spring.dependency-management' version '1.1.5'
+	id 'jacoco'
+	id 'org.sonarqube' version '5.0.0.4638'
 }
 
 group = 'com.covigator'
@@ -11,6 +13,37 @@ java {
 	sourceCompatibility = '17'
 }
 
+def jacocoDir = layout.buildDirectory.dir("reports/")
+
+def jacocoExcludePatterns = [
+		// 측정에서 제외하는 패턴
+		"**/*Application*",
+		"**/config/*",
+		"**/exception/*",
+		"**/security/*",
+		"**/support/*"
+]
+
+
+sonar {
+	properties {
+		property "sonar.projectKey", "Covigator_Covigator-BE"
+		property "sonar.organization", "covigator"
+		property "sonar.host.url", "https://sonarcloud.io"
+		property 'sonar.sources', 'src'
+		property 'sonar.language', 'java'
+		property 'sonar.sourceEncoding', 'UTF-8'
+		property 'sonar.exclusions', '**/test/**, **/resources/**, **/*Application*, **/config/**, **/exception/**, **/security/**, **/support/**'
+		property 'sonar.test.inclusions', '**/*Test.java'
+		property 'sonar.java.coveragePlugin', 'jacoco'
+		property 'sonar.coverage.jacoco.xmlReportPaths', jacocoDir.get().file("jacoco/index.xml").asFile
+	}
+}
+
+jacoco {
+	toolVersion = '0.8.12'
+}
+
 configurations {
 	compileOnly {
 		extendsFrom annotationProcessor
@@ -40,4 +73,55 @@ dependencies {
 
 tasks.named('test') {
 	useJUnitPlatform()
+	finalizedBy 'jacocoTestReport'
+}
+
+jacocoTestReport {
+	dependsOn test //테스트가 수행되어야만 report를 생성할 수 있도록 설정
+	reports {
+		html.required.set(true)
+		xml.required.set(true)
+		html.destination jacocoDir.get().file("jacoco/index.html").asFile
+		xml.destination jacocoDir.get().file("jacoco/index.xml").asFile
+	}
+
+	afterEvaluate {
+		classDirectories.setFrom(
+				files(classDirectories.files.collect {
+					fileTree(dir: it, excludes: jacocoExcludePatterns)
+				})
+		)
+	}
+	finalizedBy jacocoTestCoverageVerification
 }
+
+jacocoTestCoverageVerification {
+	violationRules {
+		rule {
+			//rule 활성화
+			enabled = true
+
+			//클래스 단위로 룰 체크
+			element = 'CLASS'
+
+			// rule 을 violate 해도 빌드 성공
+			failOnViolation = false
+
+			// 라인 커버리지를 최소 70% 만족
+			limit {
+				counter = 'LINE'
+				value = 'COVEREDRATIO'
+				minimum = 0.60
+			}
+
+			// 브랜치 커버리지를 최소 70% 만족
+			limit {
+				counter = 'BRANCH'
+				value = 'COVEREDRATIO'
+				minimum = 0.60
+			}
+
+			excludes = jacocoExcludePatterns
+		}
+	}
+}

src/main/java/com/covigator/Covigator/CovigatorApplication.java → src/main/java/com/ku/covigator/CovigatorApplication.java

@@ -1,4 +1,4 @@
-package com.covigator.Covigator;
+package com.ku.covigator;
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;

src/main/java/com/covigator/Covigator/config/BaseTimeConfig.java → src/main/java/com/ku/covigator/config/BaseTimeConfig.java

@@ -1,4 +1,4 @@
-package com.covigator.Covigator.config;
+package com.ku.covigator.config;
 
 import org.springframework.context.annotation.Configuration;
 import org.springframework.data.jpa.repository.config.EnableJpaAuditing;

src/main/java/com/covigator/Covigator/config/PropertiesConfig.java → src/main/java/com/ku/covigator/config/PropertiesConfig.java

@@ -1,9 +1,9 @@
-package com.covigator.Covigator.config;
+package com.ku.covigator.config;
 
 import org.springframework.boot.context.properties.ConfigurationPropertiesScan;
 import org.springframework.context.annotation.Configuration;
 
 @Configuration
-@ConfigurationPropertiesScan("com.covigator.Covigator.config.properties")
+@ConfigurationPropertiesScan("com.ku.covigator.config.properties")
 public class PropertiesConfig {
 }

src/main/java/com/covigator/Covigator/config/SecurityConfig.java → src/main/java/com/ku/covigator/config/SecurityConfig.java

@@ -1,4 +1,4 @@
-package com.covigator.Covigator.config;
+package com.ku.covigator.config;
 
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;

src/main/java/com/covigator/Covigator/config/WebConfig.java → src/main/java/com/ku/covigator/config/WebConfig.java

@@ -1,6 +1,6 @@
-package com.covigator.Covigator.config;
+package com.ku.covigator.config;
 
-import com.covigator.Covigator.security.jwt.JwtAuthInterceptor;
+import com.ku.covigator.security.jwt.JwtAuthInterceptor;
 import lombok.RequiredArgsConstructor;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.web.servlet.config.annotation.InterceptorRegistry;

src/main/java/com/covigator/Covigator/config/properties/JwtProperties.java → src/main/java/com/ku/covigator/config/properties/JwtProperties.java

@@ -1,4 +1,4 @@
-package com.covigator.Covigator.config.properties;
+package com.ku.covigator.config.properties;
 
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;

src/main/java/com/covigator/Covigator/controller/AuthController.java → src/main/java/com/ku/covigator/controller/AuthController.java

@@ -1,8 +1,8 @@
-package com.covigator.Covigator.controller;
+package com.ku.covigator.controller;
 
-import com.covigator.Covigator.dto.request.MemberSignInRequest;
-import com.covigator.Covigator.dto.response.AccessTokenResponse;
-import com.covigator.Covigator.service.AuthService;
+import com.ku.covigator.dto.request.MemberSignInRequest;
+import com.ku.covigator.dto.response.AccessTokenResponse;
+import com.ku.covigator.service.AuthService;
 import lombok.RequiredArgsConstructor;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.PostMapping;

src/main/java/com/covigator/Covigator/controller/MemberController.java → src/main/java/com/ku/covigator/controller/MemberController.java

@@ -1,7 +1,7 @@
-package com.covigator.Covigator.controller;
+package com.ku.covigator.controller;
 
-import com.covigator.Covigator.dto.request.MemberSignUpRequest;
-import com.covigator.Covigator.service.MemberService;
+import com.ku.covigator.dto.request.MemberSignUpRequest;
+import com.ku.covigator.service.MemberService;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.http.ResponseEntity;

src/main/java/com/covigator/Covigator/domain/BaseTime.java → src/main/java/com/ku/covigator/domain/BaseTime.java

@@ -1,4 +1,4 @@
-package com.covigator.Covigator.domain;
+package com.ku.covigator.domain;
 
 import jakarta.persistence.Column;
 import jakarta.persistence.EntityListeners;

src/main/java/com/covigator/Covigator/domain/Member.java → src/main/java/com/ku/covigator/domain/Member.java

@@ -1,4 +1,4 @@
-package com.covigator.Covigator.domain;
+package com.ku.covigator.domain;
 
 import jakarta.persistence.*;
 import lombok.AccessLevel;

src/main/java/com/covigator/Covigator/domain/Status.java → src/main/java/com/ku/covigator/domain/Status.java

@@ -1,4 +1,4 @@
-package com.covigator.Covigator.domain;
+package com.ku.covigator.domain;
 
 import lombok.Getter;
 

src/main/java/com/covigator/Covigator/dto/request/MemberSignInRequest.java → src/main/java/com/ku/covigator/dto/request/MemberSignInRequest.java

@@ -1,4 +1,4 @@
-package com.covigator.Covigator.dto.request;
+package com.ku.covigator.dto.request;
 
 import lombok.AllArgsConstructor;
 import lombok.Getter;

src/main/java/com/covigator/Covigator/dto/request/MemberSignUpRequest.java → src/main/java/com/ku/covigator/dto/request/MemberSignUpRequest.java

@@ -1,6 +1,6 @@
-package com.covigator.Covigator.dto.request;
+package com.ku.covigator.dto.request;
 
-import com.covigator.Covigator.domain.Member;
+import com.ku.covigator.domain.Member;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 

src/main/java/com/covigator/Covigator/dto/response/AccessTokenResponse.java → src/main/java/com/ku/covigator/dto/response/AccessTokenResponse.java

@@ -1,4 +1,4 @@
-package com.covigator.Covigator.dto.response;
+package com.ku.covigator.dto.response;
 
 import lombok.AccessLevel;
 import lombok.AllArgsConstructor;

src/main/java/com/covigator/Covigator/exception/CovigatorException.java → src/main/java/com/ku/covigator/exception/CovigatorException.java

@@ -1,4 +1,4 @@
-package com.covigator.Covigator.exception;
+package com.ku.covigator.exception;
 
 import lombok.Getter;
 import org.springframework.http.HttpStatus;

src/main/java/com/covigator/Covigator/exception/badrequest/BadRequestException.java → src/main/java/com/ku/covigator/exception/badrequest/BadRequestException.java

@@ -1,6 +1,6 @@
-package com.covigator.Covigator.exception.badrequest;
+package com.ku.covigator.exception.badrequest;
 
-import com.covigator.Covigator.exception.CovigatorException;
+import com.ku.covigator.exception.CovigatorException;
 import org.springframework.http.HttpStatus;
 
 public class BadRequestException extends CovigatorException {

src/main/java/com/covigator/Covigator/exception/badrequest/DuplicateMemberException.java → src/main/java/com/ku/covigator/exception/badrequest/DuplicateMemberException.java

@@ -1,4 +1,4 @@
-package com.covigator.Covigator.exception.badrequest;
+package com.ku.covigator.exception.badrequest;
 
 import lombok.Getter;
 

src/main/java/com/covigator/Covigator/exception/badrequest/PasswordMismatchException.java → src/main/java/com/ku/covigator/exception/badrequest/PasswordMismatchException.java

@@ -1,4 +1,4 @@
-package com.covigator.Covigator.exception.badrequest;
+package com.ku.covigator.exception.badrequest;
 
 public class PasswordMismatchException extends BadRequestException{
     public PasswordMismatchException() {

src/main/java/com/covigator/Covigator/exception/jwt/JwtExpiredException.java → src/main/java/com/ku/covigator/exception/jwt/JwtExpiredException.java

@@ -1,6 +1,6 @@
-package com.covigator.Covigator.exception.jwt;
+package com.ku.covigator.exception.jwt;
 
-import com.covigator.Covigator.exception.badrequest.BadRequestException;
+import com.ku.covigator.exception.badrequest.BadRequestException;
 
 public class JwtExpiredException extends BadRequestException {
 

src/main/java/com/covigator/Covigator/exception/jwt/JwtInvalidException.java → src/main/java/com/ku/covigator/exception/jwt/JwtInvalidException.java

@@ -1,6 +1,6 @@
-package com.covigator.Covigator.exception.jwt;
+package com.ku.covigator.exception.jwt;
 
-import com.covigator.Covigator.exception.badrequest.BadRequestException;
+import com.ku.covigator.exception.badrequest.BadRequestException;
 
 public class JwtInvalidException extends BadRequestException {
 

src/main/java/com/covigator/Covigator/exception/jwt/JwtMalformedTokenException.java → src/main/java/com/ku/covigator/exception/jwt/JwtMalformedTokenException.java

@@ -1,6 +1,6 @@
-package com.covigator.Covigator.exception.jwt;
+package com.ku.covigator.exception.jwt;
 
-import com.covigator.Covigator.exception.badrequest.BadRequestException;
+import com.ku.covigator.exception.badrequest.BadRequestException;
 
 public class JwtMalformedTokenException extends BadRequestException {
 

src/main/java/com/covigator/Covigator/exception/jwt/JwtNotFoundException.java → src/main/java/com/ku/covigator/exception/jwt/JwtNotFoundException.java

@@ -1,6 +1,6 @@
-package com.covigator.Covigator.exception.jwt;
+package com.ku.covigator.exception.jwt;
 
-import com.covigator.Covigator.exception.badrequest.BadRequestException;
+import com.ku.covigator.exception.badrequest.BadRequestException;
 
 public class JwtNotFoundException extends BadRequestException {
 

src/main/java/com/covigator/Covigator/exception/jwt/JwtUnsupportedTokenException.java → src/main/java/com/ku/covigator/exception/jwt/JwtUnsupportedTokenException.java

@@ -1,6 +1,6 @@
-package com.covigator.Covigator.exception.jwt;
+package com.ku.covigator.exception.jwt;
 
-import com.covigator.Covigator.exception.badrequest.BadRequestException;
+import com.ku.covigator.exception.badrequest.BadRequestException;
 
 public class JwtUnsupportedTokenException extends BadRequestException {
 

src/main/java/com/covigator/Covigator/exception/notfound/NotFoundException.java → src/main/java/com/ku/covigator/exception/notfound/NotFoundException.java

@@ -1,6 +1,6 @@
-package com.covigator.Covigator.exception.notfound;
+package com.ku.covigator.exception.notfound;
 
-import com.covigator.Covigator.exception.CovigatorException;
+import com.ku.covigator.exception.CovigatorException;
 import org.springframework.http.HttpStatus;
 
 public class NotFoundException extends CovigatorException {

src/main/java/com/covigator/Covigator/exception/notfound/NotFoundMemberException.java → src/main/java/com/ku/covigator/exception/notfound/NotFoundMemberException.java

@@ -1,4 +1,4 @@
-package com.covigator.Covigator.exception.notfound;
+package com.ku.covigator.exception.notfound;
 
 public class NotFoundMemberException extends NotFoundException{
 

src/main/java/com/covigator/Covigator/repository/MemberRepository.java → src/main/java/com/ku/covigator/repository/MemberRepository.java

@@ -1,6 +1,6 @@
-package com.covigator.Covigator.repository;
+package com.ku.covigator.repository;
 
-import com.covigator.Covigator.domain.Member;
+import com.ku.covigator.domain.Member;
 import org.springframework.data.jpa.repository.JpaRepository;
 
 import java.util.Optional;

src/main/java/com/covigator/Covigator/security/jwt/JwtAuthInterceptor.java → src/main/java/com/ku/covigator/security/jwt/JwtAuthInterceptor.java

@@ -1,8 +1,7 @@
-package com.covigator.Covigator.security.jwt;
+package com.ku.covigator.security.jwt;
 
-import com.covigator.Covigator.exception.jwt.JwtNotFoundException;
-import com.covigator.Covigator.exception.jwt.JwtUnsupportedTokenException;
-import com.covigator.Covigator.security.jwt.JwtProvider;
+import com.ku.covigator.exception.jwt.JwtNotFoundException;
+import com.ku.covigator.exception.jwt.JwtUnsupportedTokenException;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
 import lombok.RequiredArgsConstructor;

src/main/java/com/covigator/Covigator/security/jwt/JwtProvider.java → src/main/java/com/ku/covigator/security/jwt/JwtProvider.java

@@ -1,10 +1,10 @@
-package com.covigator.Covigator.security.jwt;
+package com.ku.covigator.security.jwt;
 
-import com.covigator.Covigator.config.properties.JwtProperties;
-import com.covigator.Covigator.exception.jwt.JwtExpiredException;
-import com.covigator.Covigator.exception.jwt.JwtInvalidException;
-import com.covigator.Covigator.exception.jwt.JwtMalformedTokenException;
-import com.covigator.Covigator.exception.jwt.JwtUnsupportedTokenException;
+import com.ku.covigator.config.properties.JwtProperties;
+import com.ku.covigator.exception.jwt.JwtExpiredException;
+import com.ku.covigator.exception.jwt.JwtInvalidException;
+import com.ku.covigator.exception.jwt.JwtMalformedTokenException;
+import com.ku.covigator.exception.jwt.JwtUnsupportedTokenException;
 import io.jsonwebtoken.*;
 import io.jsonwebtoken.io.Decoders;
 import io.jsonwebtoken.security.Keys;

src/main/java/com/covigator/Covigator/service/AuthService.java → src/main/java/com/ku/covigator/service/AuthService.java

@@ -1,10 +1,10 @@
-package com.covigator.Covigator.service;
+package com.ku.covigator.service;
 
-import com.covigator.Covigator.domain.Member;
-import com.covigator.Covigator.exception.badrequest.PasswordMismatchException;
-import com.covigator.Covigator.exception.notfound.NotFoundMemberException;
-import com.covigator.Covigator.repository.MemberRepository;
-import com.covigator.Covigator.security.jwt.JwtProvider;
+import com.ku.covigator.domain.Member;
+import com.ku.covigator.exception.badrequest.PasswordMismatchException;
+import com.ku.covigator.exception.notfound.NotFoundMemberException;
+import com.ku.covigator.repository.MemberRepository;
+import com.ku.covigator.security.jwt.JwtProvider;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.security.crypto.password.PasswordEncoder;

src/main/java/com/covigator/Covigator/service/MemberService.java → src/main/java/com/ku/covigator/service/MemberService.java

@@ -1,8 +1,8 @@
-package com.covigator.Covigator.service;
+package com.ku.covigator.service;
 
-import com.covigator.Covigator.domain.Member;
-import com.covigator.Covigator.exception.badrequest.DuplicateMemberException;
-import com.covigator.Covigator.repository.MemberRepository;
+import com.ku.covigator.domain.Member;
+import com.ku.covigator.exception.badrequest.DuplicateMemberException;
+import com.ku.covigator.repository.MemberRepository;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.security.crypto.password.PasswordEncoder;

src/main/java/com/covigator/Covigator/support/logging/LoggingAspect.java → src/main/java/com/ku/covigator/support/logging/LoggingAspect.java

@@ -1,4 +1,4 @@
-package com.covigator.Covigator.support.logging;
+package com.ku.covigator.support.logging;
 
 import lombok.extern.slf4j.Slf4j;
 import org.aspectj.lang.JoinPoint;
@@ -12,10 +12,10 @@
 @Component
 public class LoggingAspect {
 
-    @Pointcut("execution(public * com.covigator.Covigator..*(..)) && !execution(public * com.covigator.Covigator.support.logging..*(..))")
+    @Pointcut("execution(public * com.ku.covigator..*(..)) && !execution(public * com.ku.covigator.support.logging..*(..))")
     private void allComponents() {}
 
-    @Pointcut("execution(public * com.covigator.Covigator.config..*(..))")
+    @Pointcut("execution(public * com.ku.covigator.config..*(..))")
     private void allConfig() {}
 
     @Before("allComponents() && !allConfig()")