[test] 투표 기능 단위 테스트 작성

.github/workflows/cd.yml

@@ -2,7 +2,6 @@ name: cd
 on:
   push:
     branches:
-      - dev
       - main
     paths-ignore:
       - 'README.md'

.github/workflows/ci.yml

@@ -9,6 +9,7 @@ on:
 
 permissions:
   contents: read
+  pull-requests: write
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -36,4 +37,12 @@ jobs:
         run: chmod +x gradlew
 
       - name: gradlew test
-        run: ./gradlew test
+        run: ./gradlew test
+
+      - name : add coverage to PR
+        id: jacoco
+        uses: madrapps/[email protected]
+        with:
+          paths: |
+            ${{ github.workspace }}/**/build/reports/jacoco/test/jacocoTestReport.xml
+          token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -36,5 +36,8 @@ out/
 ### VS Code ###
 .vscode/
 
-### properties/yml ###
+### properties ###
 /src/main/resources/conal-back-secret/*.properties
+
+### querydsl Qclass ##
+/src/main/generated/

build.gradle

@@ -2,6 +2,7 @@ plugins {
     id 'java'
     id 'org.springframework.boot' version '3.4.6-SNAPSHOT'
     id 'io.spring.dependency-management' version '1.1.7'
+    id 'jacoco'
 }
 
 group = 'com.specialwarriors'
@@ -92,4 +93,55 @@ dependencies {
 
 tasks.named('test') {
     useJUnitPlatform()
+    finalizedBy jacocoTestReport
+}
+
+jacoco {
+    toolVersion = "0.8.11"
+}
+
+def jacocoExcludePatterns = [
+        'com/specialwarriors/conal/ConalApplication.class',
+        '**/common/**',
+        '**/exception/**',
+        '**/dto/**',
+        '**/config/**',
+        '**/enums/**',
+        '**/converter/**',
+        '**/test/**'
+]
+
+for (qPattern in '**/QA'..'**/QZ') {
+    jacocoExcludePatterns.add(qPattern + '*')
+}
+
+jacocoTestReport {
+    reports {
+        xml.required = true
+        csv.required = true
+        html.required = true
+    }
+
+    afterEvaluate {
+        classDirectories.setFrom(files(classDirectories.files.collect {
+            fileTree(dir: it, excludes: jacocoExcludePatterns)
+        }))
+    }
+}
+
+jacocoTestCoverageVerification {
+    violationRules {
+
+        rule {
+            enabled = true
+            element = 'CLASS'
+
+            // 커버리지 제외 범위
+            excludes = jacocoExcludePatterns
+        }
+    }
+}
+
+clean {
+    delete file('src/main/generated')
 }

src/main/java/com/specialwarriors/conal/common/auth/jwt/JwtTokenProvider.java

@@ -34,7 +34,7 @@ public String createVoteUserToken(String email, Date issuedAt, long expirationMi
                 .compact();
     }
 
-    public String getEmailFrom(String token) {
+    public String extractEmailFrom(String token) {
 
         return Jwts.parser().verifyWith(secretKey).build()
                 .parseSignedClaims(token)

src/main/java/com/specialwarriors/conal/github_repo/domain/GithubRepo.java

@@ -18,13 +18,15 @@
 import java.util.ArrayList;
 import java.util.List;
 import lombok.AccessLevel;
+import lombok.EqualsAndHashCode;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
 @Table(name = "github_repos")
 @Entity
 @Getter
 @NoArgsConstructor(access = AccessLevel.PROTECTED)
+@EqualsAndHashCode(of = "id")
 public class GithubRepo {
 
     @Id

src/main/java/com/specialwarriors/conal/github_repo/exception/GithubRepoException.java

@@ -9,14 +9,14 @@
 @RequiredArgsConstructor
 public enum GithubRepoException implements BaseException {
 
-    UNAUTHORIZED_GITHUBREPO_ACCESS(HttpStatus.FORBIDDEN, "리포지토리 접근 권한이 없습니다"),
-    NOT_FOUND_GITHUBREPO_NAME(HttpStatus.NOT_FOUND, "깃허브 리포지토리 이름을 찾을 수 없습니다"),
-    NOT_FOUND_GITHUBREPO(HttpStatus.NOT_FOUND, "깃허브 리포지토리를 찾을 수 없습니다"),
-    NOT_FOUND_GITHUBREPO_EMAIL(HttpStatus.NOT_FOUND, "기여자 이메일이 없습니다"),
-    EXCEED_GITHUBREPO_EMAIL(HttpStatus.BAD_REQUEST, "이메일은 5개까지 등록할 수 있습니다"),
-    INVALID_GITHUBREPO_URL(HttpStatus.BAD_REQUEST, "잘못된 URL 입니다."),
-    INVALID_GITHUBREPO_EMAIL(HttpStatus.BAD_REQUEST, "잘못된 이메일 입니다"),
-    INVALID_GITHUBREPO_DURATION(HttpStatus.NOT_FOUND, "종료일이 존재하지 않습니다");
+    UNAUTHORIZED_GITHUB_REPO_ACCESS(HttpStatus.FORBIDDEN, "리포지토리 접근 권한이 없습니다"),
+    GITHUB_REPO_NAME_NOT_FOUND(HttpStatus.NOT_FOUND, "깃허브 리포지토리 이름을 찾을 수 없습니다"),
+    GITHUB_REPO_NOT_FOUND(HttpStatus.NOT_FOUND, "깃허브 리포지토리를 찾을 수 없습니다"),
+    GITHUB_REPO_EMAIL_NOT_FOUND(HttpStatus.NOT_FOUND, "기여자 이메일이 없습니다"),
+    GITHUB_REPO_EMAIL_LIMIT_EXCEED(HttpStatus.BAD_REQUEST, "이메일은 5개까지 등록할 수 있습니다"),
+    INVALID_GITHUB_REPO_URL(HttpStatus.BAD_REQUEST, "잘못된 URL 입니다."),
+    INVALID_GITHUB_REPO_EMAIL(HttpStatus.BAD_REQUEST, "잘못된 이메일 입니다"),
+    INVALID_GITHUB_REPO_DURATION(HttpStatus.NOT_FOUND, "종료일이 존재하지 않습니다");
 
     private final HttpStatus status;
     private final String message;

src/main/java/com/specialwarriors/conal/github_repo/service/GithubRepoQuery.java

@@ -4,6 +4,8 @@
 import com.specialwarriors.conal.github_repo.domain.GithubRepo;
 import com.specialwarriors.conal.github_repo.exception.GithubRepoException;
 import com.specialwarriors.conal.github_repo.repository.GithubRepoRepository;
+import com.specialwarriors.conal.user.domain.User;
+import com.specialwarriors.conal.user.service.UserQuery;
 import lombok.RequiredArgsConstructor;
 import org.springframework.stereotype.Component;
 
@@ -12,23 +14,23 @@
 public class GithubRepoQuery {
 
     private final GithubRepoRepository githubRepoRepository;
+    private final UserQuery userQuery;
 
     public GithubRepo findByUserIdAndRepositoryId(Long userId, Long repositoryId) {
 
-        GithubRepo githubRepo = githubRepoRepository.findById(repositoryId).orElseThrow(() ->
-                new GeneralException(GithubRepoException.NOT_FOUND_GITHUBREPO)
-        );
+        GithubRepo githubRepo = findById(repositoryId);
+        User user = userQuery.findById(userId);
 
-        if (!userId.equals(githubRepo.getUser().getId())) {
-            throw new GeneralException(GithubRepoException.UNAUTHORIZED_GITHUBREPO_ACCESS);
+        if (user.notHasGithubRepo(githubRepo)) {
+            throw new GeneralException(GithubRepoException.UNAUTHORIZED_GITHUB_REPO_ACCESS);
         }
 
         return githubRepo;
     }
 
-    public GithubRepo findByRepositoryId(long repositoryId) {
+    public GithubRepo findById(long repositoryId) {
 
         return githubRepoRepository.findById(repositoryId)
-                .orElseThrow(() -> new GeneralException(GithubRepoException.NOT_FOUND_GITHUBREPO));
+                .orElseThrow(() -> new GeneralException(GithubRepoException.GITHUB_REPO_NOT_FOUND));
     }
 }

src/main/java/com/specialwarriors/conal/github_repo/service/GithubRepoService.java

@@ -74,11 +74,11 @@ public GithubRepoCreateResponse createGithubRepo(Long userId, GithubRepoCreateRe
 
     private void validateCreateRequest(GithubRepoCreateRequest request) {
         if (request.name().isEmpty()) {
-            throw new GeneralException(GithubRepoException.NOT_FOUND_GITHUBREPO_NAME);
+            throw new GeneralException(GithubRepoException.GITHUB_REPO_NAME_NOT_FOUND);
         }
 
         if (!GITHUB_URL_PATTERN.matcher(request.url()).matches()) {
-            throw new GeneralException(GithubRepoException.INVALID_GITHUBREPO_URL);
+            throw new GeneralException(GithubRepoException.INVALID_GITHUB_REPO_URL);
         }
 
         long validEmailCount = request.emails().stream()
@@ -87,25 +87,25 @@ private void validateCreateRequest(GithubRepoCreateRequest request) {
                 .count();
 
         if (validEmailCount == 0) {
-            throw new GeneralException(GithubRepoException.NOT_FOUND_GITHUBREPO_EMAIL);
+            throw new GeneralException(GithubRepoException.GITHUB_REPO_EMAIL_NOT_FOUND);
         }
         if (validEmailCount > 5) {
-            throw new GeneralException(GithubRepoException.EXCEED_GITHUBREPO_EMAIL);
+            throw new GeneralException(GithubRepoException.GITHUB_REPO_EMAIL_LIMIT_EXCEED);
         }
 
         for (String email : request.emails()) {
 
             if (Objects.nonNull(email)) {
                 String trimmed = email.trim();
                 if (!trimmed.isEmpty() && !EMAIL_PATTERN.matcher(trimmed).matches()) {
-                    throw new GeneralException(GithubRepoException.INVALID_GITHUBREPO_EMAIL);
+                    throw new GeneralException(GithubRepoException.INVALID_GITHUB_REPO_EMAIL);
                 }
             }
 
         }
 
         if (request.endDate() == null) {
-            throw new GeneralException(GithubRepoException.INVALID_GITHUBREPO_DURATION);
+            throw new GeneralException(GithubRepoException.INVALID_GITHUB_REPO_DURATION);
         }
     }
 

src/main/java/com/specialwarriors/conal/notification/service/NotificationService.java

@@ -25,16 +25,17 @@ public class NotificationService {
     public void updateNotificationAgreement(long userId, long repositoryId,
             NotificationAgreementUpdateRequest request) {
 
-        GithubRepo githubRepo = githubRepoQuery.findByRepositoryId(repositoryId);
+        GithubRepo githubRepo = githubRepoQuery.findById(repositoryId);
 
         NotificationType notificationType = NotificationType.valueOf(request.type());
         NotificationAgreement notificationAgreement = notificationAgreementQuery
                 .findByGithubRepoAndType(githubRepo, notificationType);
 
         // 사용자가 자신의 github repo에 접근한 것이 맞는 지 검증
         User user = userQuery.findById(userId);
-        if (!user.hasGithubRepo(repositoryId)) {
-            throw new GeneralException(GithubRepoException.UNAUTHORIZED_GITHUBREPO_ACCESS);
+
+        if (user.notHasGithubRepo(githubRepo)) {
+            throw new GeneralException(GithubRepoException.UNAUTHORIZED_GITHUB_REPO_ACCESS);
         }
 
         if (request.isAgree()) {

src/main/java/com/specialwarriors/conal/user/domain/User.java

@@ -41,9 +41,9 @@ public User(int githubId, String username, String avatarUrl) {
         this.avatarUrl = avatarUrl;
     }
 
-    public boolean hasGithubRepo(long repositoryId) {
+    public boolean notHasGithubRepo(GithubRepo githubRepo) {
 
-        return githubRepos.stream().anyMatch(repo -> repo.getId() == repositoryId);
+        return !githubRepos.contains(githubRepo);
     }
 
     public void addGithubRepo(GithubRepo githubRepo) {

src/main/java/com/specialwarriors/conal/util/UrlUtil.java

@@ -19,7 +19,7 @@ public static String[] urlToOwnerAndReponame(String url) {
 
             return new String[]{owner, repoName};
         } else {
-            throw new GeneralException(GithubRepoException.INVALID_GITHUBREPO_URL);
+            throw new GeneralException(GithubRepoException.INVALID_GITHUB_REPO_URL);
         }
     }
 

src/main/java/com/specialwarriors/conal/vote/service/VoteService.java

@@ -39,7 +39,7 @@ public void openVote(long repoId) {
         final Date issuedAt = new Date();
         final long expirationMillis = 604800000;
 
-        GithubRepo githubRepo = githubRepoQuery.findByRepositoryId(repoId);
+        GithubRepo githubRepo = githubRepoQuery.findById(repoId);
         List<Contributor> contributors = githubRepo.getContributors();
 
         String[] userTokens = contributors.stream().map(Contributor::getEmail)
@@ -64,7 +64,7 @@ public List<String> findVoteTargetEmails(long repoId, String userToken) {
             throw new GeneralException(VoteException.UNAUTHORIZED_VOTE_ACCESS);
         }
 
-        GithubRepo githubRepo = githubRepoQuery.findByRepositoryId(repoId);
+        GithubRepo githubRepo = githubRepoQuery.findById(repoId);
 
         return githubRepo.getContributors().stream()
                 .map(Contributor::getEmail)
@@ -81,10 +81,10 @@ public List<VoteFormResponse> getVoteFormResponse(long repoId) {
         }
 
         Set<String> userTokens = redisTemplate.opsForSet().members(voteKey);
-        List<String> voteTargetEmails = userTokens.stream().map(jwtProvider::getEmailFrom).toList();
+        List<String> voteTargetEmails = userTokens.stream().map(jwtProvider::extractEmailFrom).toList();
 
         return userTokens.stream().map(userToken -> {
-                    String email = jwtProvider.getEmailFrom(userToken);
+                    String email = jwtProvider.extractEmailFrom(userToken);
 
                     return new VoteFormResponse(repoId, userToken, email, voteTargetEmails);
                 })