Feature/283 봉사 시간 랭킹 기능 구현

.github/workflows/CD.yml

@@ -8,12 +8,6 @@ jobs:
   build-and-push:
     runs-on: ubuntu-latest
 
-    services:
-      redis:
-        image: redis
-        ports:
-          - 6379:6379
-
     env:
       DB_URL: ${{ secrets.DB_URL }}
       DB_USERNAME: ${{ secrets.DB_USERNAME }}
@@ -43,6 +37,16 @@ jobs:
       ELASTIC_PASSWORD: ${{ secrets.ELASTIC_PASSWORD }}
       LOKI_URL: ${{ secrets.LOKI_URL }}
 
+      TESTCONTAINERS_REUSE_ENABLE: true
+      TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE: /var/run/docker.sock
+      DOCKER_HOST: unix:///var/run/docker.sock
+
+    services:
+      redis:
+        image: redis
+        ports:
+          - 6379:6379
+
     steps:
       - name: Github Repository 파일 불러오기
         uses: actions/checkout@v4

.github/workflows/CI.yml

@@ -1,9 +1,6 @@
 name: CI Pipeline
 
 on:
-  push:
-    branches:
-      [ main ]
   pull_request:
     branches:
       [ main ]
@@ -14,14 +11,6 @@ jobs:
   Continuous-Integration:
     runs-on: ubuntu-latest
 
-    #Action 환경에서 Redis 실행을 위한 설정 추후 서버 배포시 제거 예정
-    services:
-      redis:
-        image: redis
-        ports:
-          - 6379:6379
-
-
     env:
       DB_URL: ${{ secrets.DB_URL }}
       DB_USERNAME: ${{ secrets.DB_USERNAME }}
@@ -51,13 +40,25 @@ jobs:
       ELASTIC_PASSWORD: ${{ secrets.ELASTIC_PASSWORD }}
       LOKI_URL: ${{ secrets.LOKI_URL }}
 
+      TESTCONTAINERS_REUSE_ENABLE: true
+      TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE: /var/run/docker.sock
+      DOCKER_HOST: unix:///var/run/docker.sock
+
+    services:
+      redis:
+        image: redis
+        ports:
+          - 6379:6379
 
     steps:
       - name: Github Repository 파일 불러오기
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
+      - name: Set up Docker
+        uses: docker/setup-buildx-action@v3
+
       - name: JDK 21 버전 설치
         uses: actions/setup-java@v4
         with:
@@ -88,6 +89,13 @@ jobs:
       - name: 빌드 및 테스트
         run: ./gradlew build
 
+      - name: 테스트 레포트 저장
+        if: ${{ always() }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: test-reports
+          path: build/reports/tests/test
+
       - name: Close PR, if build fail
         if: ${{ failure() }}
         uses: actions/github-script@v6
@@ -113,6 +121,6 @@ jobs:
 
       - name: SonarCloud 빌드및 분석
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
         run: ./gradlew build sonar --info

build.gradle

@@ -41,6 +41,7 @@ dependencies {
 
     // Querydsl
     implementation 'com.querydsl:querydsl-jpa:5.0.0:jakarta'
+    implementation 'com.querydsl:querydsl-sql:5.0.0'
     annotationProcessor "com.querydsl:querydsl-apt:${dependencyManagement.importedProperties['querydsl.version']}:jakarta"
     annotationProcessor "jakarta.annotation:jakarta.annotation-api"
     annotationProcessor "jakarta.persistence:jakarta.persistence-api"
@@ -79,6 +80,10 @@ dependencies {
     testImplementation 'org.springframework.boot:spring-boot-starter-test'
     testImplementation 'org.springframework.security:spring-security-test'
     testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
+    testImplementation group: 'org.testcontainers', name: 'testcontainers', version: '1.20.4'
+    testImplementation group: 'org.testcontainers', name: 'junit-jupiter', version: '1.20.4'
+    testImplementation group: 'org.testcontainers', name: 'mysql', version: '1.20.4'
+
 }
 
 // Querydsl 설정
@@ -103,6 +108,7 @@ tasks.named('test') {
     useJUnitPlatform()
     jvmArgs("-XX:+EnableDynamicAgentLoading")
     if (gradle.startParameter.taskNames.contains('build')) {
+        exclude '**/*ControllerTest.class'
         finalizedBy 'jacocoTestReport'
     }
 }
@@ -131,7 +137,9 @@ def jacocoExcludePatterns = [
         '**/fixture/*',
         '**/*Factory*',
         '**/event/**',
-        '**/*Aspect*'
+        '**/*Aspect*',
+        '**/Aspect/*',
+        '**/utils/*'
 ]
 
 def jacocoExcludePatternsForVerify = [
@@ -151,7 +159,9 @@ def jacocoExcludePatternsForVerify = [
         '*.fixture.*',
         '*.*Factory*',
         '*.*event*.*',
-        '*.*Aspect*'
+        '*.*Aspect*',
+        '*.Aspect.*',
+        '*.utils.*'
 ]
 
 jacocoTestReport {

src/main/java/com/somemore/domains/volunteer/repository/VolunteerRepositoryImpl.java

@@ -103,7 +103,7 @@ private Optional<Volunteer> findOne(BooleanExpression condition) {
                                 condition,
                                 isNotDeleted()
                         )
-                        .fetchOne()
+                        .fetchFirst()
         );
     }
 

src/main/java/com/somemore/domains/volunteerrecord/controller/VolunteerRankingApiController.java

@@ -0,0 +1,27 @@
+package com.somemore.domains.volunteerrecord.controller;
+
+import com.somemore.domains.volunteerrecord.dto.response.VolunteerRankingResponseDto;
+import com.somemore.domains.volunteerrecord.usecase.GetVolunteerRankingUseCase;
+import com.somemore.global.common.response.ApiResponse;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import lombok.RequiredArgsConstructor;
+import org.springframework.web.bind.annotation.*;
+
+@Tag(name = "Volunteer Ranking API", description = "봉사 시간 랭킹 API")
+@RequiredArgsConstructor
+@RequestMapping("/api/volunteerrecord")
+@RestController
+public class VolunteerRankingApiController {
+
+    private final GetVolunteerRankingUseCase getVolunteerRankingUseCase;
+
+    @Operation(summary = "봉사 시간 랭킹", description = "봉사 시간 랭킹을 반환합니다.")
+    @GetMapping("/ranking")
+    public ApiResponse<VolunteerRankingResponseDto> updateCenterProfile() {
+
+        VolunteerRankingResponseDto volunteerRankings = getVolunteerRankingUseCase.getVolunteerRanking();
+
+        return ApiResponse.ok(volunteerRankings,"봉사 시간 랭킹 반환 성공");
+    }
+}

src/main/java/com/somemore/domains/volunteerrecord/dto/response/VolunteerMonthlyRankingResponseDto.java

@@ -0,0 +1,11 @@
+package com.somemore.domains.volunteerrecord.dto.response;
+
+import java.util.UUID;
+
+public record VolunteerMonthlyRankingResponseDto(
+        UUID volunteerId,
+        int totalHours,
+        long ranking,
+        String nickname
+) {
+}

src/main/java/com/somemore/domains/volunteerrecord/dto/response/VolunteerRankingResponseDto.java

@@ -0,0 +1,28 @@
+package com.somemore.domains.volunteerrecord.dto.response;
+
+import com.fasterxml.jackson.databind.PropertyNamingStrategies;
+import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import com.somemore.domains.center.dto.response.PreferItemResponseDto;
+import lombok.Builder;
+
+import java.util.List;
+
+@JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
+@Builder
+public record VolunteerRankingResponseDto(
+        List<VolunteerTotalRankingResponseDto> volunteerTotalRankingResponse,
+        List<VolunteerMonthlyRankingResponseDto> volunteerMonthlyResponse,
+        List<VolunteerWeeklyRankingResponseDto> volunteerWeeklyRankingResponse
+) {
+    public static VolunteerRankingResponseDto of(
+            List<VolunteerTotalRankingResponseDto> totalRanking,
+            List<VolunteerMonthlyRankingResponseDto> monthlyRanking,
+            List<VolunteerWeeklyRankingResponseDto> weeklyRanking){
+
+        return VolunteerRankingResponseDto.builder()
+                .volunteerTotalRankingResponse(totalRanking)
+                .volunteerMonthlyResponse(monthlyRanking)
+                .volunteerWeeklyRankingResponse(weeklyRanking)
+                .build();
+    }
+}

src/main/java/com/somemore/domains/volunteerrecord/dto/response/VolunteerTotalRankingResponseDto.java

@@ -0,0 +1,11 @@
+package com.somemore.domains.volunteerrecord.dto.response;
+
+import java.util.UUID;
+
+public record VolunteerTotalRankingResponseDto(
+        UUID volunteerId,
+        int totalHours,
+        long ranking,
+        String nickname
+) {
+}

src/main/java/com/somemore/domains/volunteerrecord/dto/response/VolunteerWeeklyRankingResponseDto.java

@@ -0,0 +1,11 @@
+package com.somemore.domains.volunteerrecord.dto.response;
+
+import java.util.UUID;
+
+public record VolunteerWeeklyRankingResponseDto(
+        UUID volunteerId,
+        int totalHours,
+        long ranking,
+        String nickname
+) {
+}

src/main/java/com/somemore/domains/volunteerrecord/event/handler/SettleVolunteerHoursHandlerImpl.java

@@ -1,7 +1,7 @@
 package com.somemore.domains.volunteerrecord.event.handler;
 
 import com.somemore.domains.volunteerrecord.domain.VolunteerRecord;
-import com.somemore.domains.volunteerrecord.usecase.VolunteerRecordCreateUseCase;
+import com.somemore.domains.volunteerrecord.usecase.CreateVolunteerRecordUseCase;
 import lombok.RequiredArgsConstructor;
 import org.springframework.stereotype.Component;
 import org.springframework.transaction.annotation.Transactional;
@@ -11,11 +11,11 @@
 @Transactional
 public class SettleVolunteerHoursHandlerImpl implements SettleVolunteerHoursHandler {
 
-    private final VolunteerRecordCreateUseCase volunteerRecordCreateUseCase;
+    private final CreateVolunteerRecordUseCase createvolunteerRecordUseCase;
 
     @Override
     public void handle(VolunteerRecord volunteerRecord) {
 
-        volunteerRecordCreateUseCase.create(volunteerRecord);
+        createvolunteerRecordUseCase.create(volunteerRecord);
     }
 }

src/main/java/com/somemore/domains/volunteerrecord/repository/VolunteerRankingRedisRepository.java

@@ -0,0 +1,52 @@
+package com.somemore.domains.volunteerrecord.repository;
+
+import com.somemore.domains.volunteerrecord.dto.response.VolunteerMonthlyRankingResponseDto;
+import com.somemore.domains.volunteerrecord.dto.response.VolunteerRankingResponseDto;
+import com.somemore.domains.volunteerrecord.dto.response.VolunteerTotalRankingResponseDto;
+import com.somemore.domains.volunteerrecord.dto.response.VolunteerWeeklyRankingResponseDto;
+import lombok.RequiredArgsConstructor;
+import org.springframework.data.redis.core.RedisTemplate;
+import org.springframework.stereotype.Repository;
+
+import java.time.Duration;
+import java.util.List;
+import java.util.Optional;
+
+@RequiredArgsConstructor
+@Repository
+public class VolunteerRankingRedisRepository {
+
+    private final RedisTemplate<String, Object> redisTemplate;
+
+    private static final Duration CACHE_TTL = Duration.ofMinutes(60);
+    private static final String TOTAL_RANKING_KEY = "volunteer:total_ranking";
+    private static final String MONTHLY_RANKING_KEY = "volunteer:monthly_ranking";
+    private static final String WEEKLY_RANKING_KEY = "volunteer:weekly_ranking";
+
+    public void saveRanking(VolunteerRankingResponseDto rankings) {
+        redisTemplate.opsForValue().set(TOTAL_RANKING_KEY, rankings.volunteerTotalRankingResponse(), CACHE_TTL);
+        redisTemplate.opsForValue().set(MONTHLY_RANKING_KEY, rankings.volunteerMonthlyResponse(), CACHE_TTL);
+        redisTemplate.opsForValue().set(WEEKLY_RANKING_KEY, rankings.volunteerWeeklyRankingResponse(), CACHE_TTL);
+    }
+
+    @SuppressWarnings("unchecked")
+    public Optional<VolunteerRankingResponseDto> getRankings() {
+
+        List<VolunteerTotalRankingResponseDto> totalRanking =
+                (List<VolunteerTotalRankingResponseDto>) redisTemplate.opsForValue().get(TOTAL_RANKING_KEY);
+        List<VolunteerMonthlyRankingResponseDto> monthlyRanking =
+                (List<VolunteerMonthlyRankingResponseDto>) redisTemplate.opsForValue().get(MONTHLY_RANKING_KEY);
+        List<VolunteerWeeklyRankingResponseDto> weeklyRanking =
+                (List<VolunteerWeeklyRankingResponseDto>) redisTemplate.opsForValue().get(WEEKLY_RANKING_KEY);
+
+        if (totalRanking == null || monthlyRanking == null || weeklyRanking == null) {
+            return Optional.empty();
+        }
+
+        return Optional.of(VolunteerRankingResponseDto.of(
+                totalRanking,
+                monthlyRanking,
+                weeklyRanking
+        ));
+    }
+}

src/main/java/com/somemore/domains/volunteerrecord/repository/VolunteerRecordJpaRepository.java

@@ -2,6 +2,54 @@
 
 import com.somemore.domains.volunteerrecord.domain.VolunteerRecord;
 import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.jpa.repository.Query;
+
+import java.util.List;
 
 public interface VolunteerRecordJpaRepository extends JpaRepository<VolunteerRecord, Long> {
-}
+
+    @Query(value = """
+        SELECT volunteerId, totalHours, ranking
+        FROM (
+            SELECT 
+                vr.volunteer_id AS volunteerId, 
+                SUM(vr.volunteer_hours) AS totalHours,
+                DENSE_RANK() OVER (ORDER BY SUM(vr.volunteer_hours) DESC) AS ranking
+            FROM volunteer_record vr
+            GROUP BY vr.volunteer_id
+        ) ranked
+        WHERE ranking <= 4
+        """, nativeQuery = true)
+    List<Object[]> findTotalTopRankingWithTies();
+
+    @Query(value = """
+        SELECT volunteerId, totalHours, ranking
+        FROM (
+            SELECT 
+                vr.volunteer_id AS volunteerId, 
+                SUM(vr.volunteer_hours) AS totalHours,
+                DENSE_RANK() OVER (ORDER BY SUM(vr.volunteer_hours) DESC) AS ranking
+            FROM volunteer_record vr
+            WHERE YEARWEEK(vr.volunteer_date, 1) = YEARWEEK(CURDATE(), 1)
+            GROUP BY vr.volunteer_id
+        ) ranked
+        WHERE ranking <= 4
+        """, nativeQuery = true)
+    List<Object[]> findWeeklyTopRankingWithTies();
+
+    @Query(value = """
+        SELECT volunteerId, totalHours, ranking
+        FROM (
+            SELECT 
+                vr.volunteer_id AS volunteerId, 
+                SUM(vr.volunteer_hours) AS totalHours,
+                DENSE_RANK() OVER (ORDER BY SUM(vr.volunteer_hours) DESC) AS ranking
+            FROM volunteer_record vr
+            WHERE MONTH(vr.volunteer_date) = MONTH(CURDATE())
+              AND YEAR(vr.volunteer_date) = YEAR(CURDATE())
+            GROUP BY vr.volunteer_id
+        ) ranked
+        WHERE ranking <= 4
+        """, nativeQuery = true)
+    List<Object[]> findMonthlyTopRankingWithTies();
+}

src/main/java/com/somemore/domains/volunteerrecord/repository/VolunteerRecordRepository.java

@@ -2,6 +2,12 @@
 
 import com.somemore.domains.volunteerrecord.domain.VolunteerRecord;
 
+import java.util.List;
+
 public interface VolunteerRecordRepository {
     void save(VolunteerRecord volunteerRecord);
+    List<Object[]> findTotalTopRankingWithTies();
+    List<Object[]> findWeeklyTopRankingWithTies();
+    List<Object[]> findMonthlyTopRankingWithTies();
+
 }