[test]: 테스트 작성

.github/workflows/ci.yml

@@ -7,6 +7,11 @@ on:
       - develop
       - 'weekly/**'
 
+permissions:
+  contents: write
+  issues: write
+  pull-requests: write
+
 jobs:
   build-and-test:
     runs-on: ubuntu-22.04
@@ -36,17 +41,6 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v2
 
-#      - name: Cache Gradle dependencies
-#        uses: actions/cache@v3
-#        with:
-#          path: |
-#            ~/.gradle/caches/modules-2/files-2.1
-#            ~/.gradle/wrapper
-#          key: gradle-${{ runner.os }}-${{ hashFiles('build.gradle', 'settings.gradle') }}
-#          restore-keys: |
-#            gradle-${{ runner.os }}-
-
-
       - name: Decode env.properties from GitHub Secrets
         run: |
           echo "${{ secrets.ENV_FILE }}" | base64 --decode > ./src/main/resources/env.properties
@@ -87,4 +81,33 @@ jobs:
         run: ./gradlew clean build -Dspring.profiles.active=test
 
       - name: Run Tests
-        run: ./gradlew test -Dspring.profiles.active=test
+        run: ./gradlew test -Dspring.profiles.active=test
+
+      - name: Generate JaCoCo Coverage Report
+        run: ./gradlew jacocoTestReport
+
+      - name: Generate Coverage Badge and Summary
+        uses: cicirello/jacoco-badge-generator@v2
+        with:
+          jacoco-csv-file: 'build/reports/jacoco/test/jacocoTestReport.csv'
+          badges-directory: 'badges'
+          generate-branches-badge: true
+          generate-summary: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Display Coverage Summary JSON
+        run: |
+          cat badges/coverage-summary.json
+
+      - name: Extract Coverage Information
+        if: ${{ github.event_name == 'pull_request' }}
+        run: |
+          COVERAGE=$(jq '.coverage' badges/coverage-summary.json)
+          BRANCH_COVERAGE=$(jq '.branches' badges/coverage-summary.json)
+          FORMATTED_COVERAGE=$(printf "%.2f" $COVERAGE)
+          FORMATTED_BRANCH_COVERAGE=$(printf "%.2f" $BRANCH_COVERAGE)
+          curl -s -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
+               -X POST \
+               -d "{\"body\": \"### 코드 커버리지\n- Coverage: ${FORMATTED_COVERAGE}%\n- Branches: ${FORMATTED_BRANCH_COVERAGE}%\n\"}" \
+               "https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.pull_request.number }}/comments"

.gitignore

@@ -56,4 +56,5 @@ splanet-db
 ### env ###
 .env
 /src/main/resources/env.properties
+/src/main/resources/env.properties.base64
 splanet-firebase.json

build.gradle

@@ -3,9 +3,10 @@ plugins {
 	id 'org.springframework.boot' version '3.3.3'
 	id 'io.spring.dependency-management' version '1.1.6'
 	id 'com.google.protobuf' version '0.9.4'
-
+	id 'jacoco'
 }
 
+
 group = 'com.splanet'
 version = '0.0.1-SNAPSHOT'
 
@@ -18,6 +19,7 @@ java {
 test {
 	useJUnitPlatform()
 	systemProperty 'spring.profiles.active', 'test'
+	finalizedBy jacocoTestReport
 }
 
 configurations {
@@ -93,6 +95,7 @@ dependencies {
 
 tasks.named('test') {
 	useJUnitPlatform()
+	finalizedBy jacocoTestReport
 }
 
 protobuf {
@@ -119,4 +122,30 @@ sourceSets {
 			srcDirs 'build/generated/source/proto/main/java', 'build/generated/source/proto/main/grpc'
 		}
 	}
+}
+
+jacoco {
+	toolVersion = "0.8.10"
+}
+
+jacocoTestReport {
+	dependsOn test
+	reports {
+		xml.required.set(true)
+		html.required.set(true)
+		csv.required.set(true)
+	}
+	classDirectories.setFrom(
+			files(classDirectories.files.collect {
+				fileTree(dir: it, exclude: [
+						'**/dto/**',       // dto 패키지 제외
+						'**/config/**',    // config 패키지 제외
+						'**/exception/**', // exception 패키지 제외
+						'**/core/**', // core 패키지 제외
+						'**/mapper/**', // mapper 패키지 제외
+						'**/grpc/**', // grpc 패키지 제외
+						'**/log/**', // log 패키지 제외
+				])
+			})
+	)
 }

src/main/java/com/splanet/splanet/core/exception/ErrorCode.java

@@ -54,6 +54,10 @@ public enum ErrorCode {
     // redis
     REDIS_SCAN_FAILED("Redis 키 스캔 중 오류가 발생했습니다.", HttpStatus.SERVICE_UNAVAILABLE),
 
+    // fcm
+    TOKEN_NOT_FOUND("해당 FCM 토큰을 찾을 수 없습니다.", HttpStatus.NOT_FOUND),
+
+    // ect
     INVALID_PLAN_FORMAT("", HttpStatus.BAD_REQUEST);
 
 

src/main/java/com/splanet/splanet/friend/repository/FriendRepository.java

@@ -9,10 +9,10 @@
 
 import java.util.List;
 
-
 @Repository
 public interface FriendRepository extends JpaRepository<Friend, Long> {
     List<Friend> findByUserId(Long userId);
+
     boolean existsByUserIdAndFriendId(Long userId, Long friendId);
 
     @Modifying

src/main/java/com/splanet/splanet/friend/service/FriendService.java

@@ -84,8 +84,6 @@ public ResponseEntity<List<PlanResponseDto>> getFriendPlan(Long friendId, Long u
         return ResponseEntity.ok(planResponseDtos);
     }
 
-    // 친구 삭제(취소)하기
-
     // 친구 삭제(취소)하기
     @Transactional
     public ResponseEntity<Map<String, String>> unfriend(Long friendId, Long userId) {

src/main/java/com/splanet/splanet/gpt/service/GptService.java

@@ -4,6 +4,7 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.splanet.splanet.core.properties.GptProperties;
 import com.splanet.splanet.plan.dto.PlanResponseDto;
+import com.splanet.splanet.plan.dto.PlanTimeDto;
 import com.splanet.splanet.plan.service.PlanService;
 import org.springframework.ai.openai.api.OpenAiApi;
 import org.springframework.http.ResponseEntity;
@@ -25,9 +26,9 @@ public class GptService {
 
     private static final double RESPONSE_TEMPERATURE = 0.8;
     private static final Map<Integer, String> PROMPT_TEMPLATES = Map.of(
-            3, "사용자 입력: \"%s\" (deviceId: %s) (groupId: %s) 기존 일정이 있다면 해당 시간과는 겹치지 않게 해 줘 기존일정:%s 현재 시간 이후로 가능한 자주 반복하여 짧고 집중적으로 일정을 완수할 수 있도록 계획을 세워줘. 시험이 포함된 경우, 시험 당일이 아닌 전날까지 준비가 완료되도록 해줘 (%s 기준). 모든 일정은 한국 시간(UTC+9)을 기준으로 설정해줘.",
-            2, "사용자 입력: \"%s\" (deviceId: %s) (groupId: %s) 기존 일정이 있다면 해당 시간과는 겹치지 않게 해 줘 기존일정:%s 현재 시간 이후로 적당한 간격을 두고 모든 일정을 완수할 수 있도록 계획해줘. 시험이 포함된 경우, 시험 당일이 아닌 전날까지 준비가 완료되도록 해줘 (%s 기준). 모든 일정은 한국 시간(UTC+9)을 기준으로 설정해줘.",
-            1, "사용자 입력: \"%s\" (deviceId: %s) (groupId: %s) 기존 일정이 있다면 해당 시간과는 겹치지 않게 해 줘 기존일정:%s 현재 시간 이후로 여유 있게 모든 일정을 완수할 수 있도록 계획해줘. 시험이 포함된 경우, 시험 당일이 아닌 전날까지 준비가 완료되도록 해줘 (%s 기준). 모든 일정은 한국 시간(UTC+9)을 기준으로 설정해줘."
+            3, "사용자 입력: \"%s\" (deviceId: %s) (groupId: %s) 제공된 가이드라인을 따르지 않으면 페널티가 부과될 것입니다. 모든 지침을 주의깊게 읽고 그에 따라 행동하세요. 기존 startDate와 endDate사이에 일정을 생성하지 말아줘. 기존 startDate, endDate:%s 현재 시간 이후로 가능한 자주 반복하여 짧고 집중적으로 일정을 완수할 수 있도록 계획을 세워줘. 현재 시간 : (%s 기준). 모든 일정은 한국 시간(UTC+9)을 기준으로 설정해줘. 또한, 기존 일정을 생각하고 새로운 일정을 적당한 간격을 두고 배치해줘.",
+            2, "사용자 입력: \"%s\" (deviceId: %s) (groupId: %s) 제공된 가이드라인을 따르지 않으면 페널티가 부과될 것입니다. 모든 지침을 주의깊게 읽고 그에 따라 행동하세요. 기존 startDate와 endDate사이에 일정을 생성하지 말아줘. 기존 startDate, endDate:%s 현재 시간 이후로 적당한 간격을 두고 모든 일정을 완수할 수 있도록 계획해줘. 현재 시간 : (%s 기준). 모든 일정은 한국 시간(UTC+9)을 기준으로 설정해줘. 또한, 기존 일정을 생각하고 새로운 일정을 적당한 간격을 두고 배치해줘.",
+            1, "사용자 입력: \"%s\" (deviceId: %s) (groupId: %s) 제공된 가이드라인을 따르지 않으면 페널티가 부과될 것입니다. 모든 지침을 주의깊게 읽고 그에 따라 행동하세요. 기존 startDate와 endDate사이에 일정을 생성하지 말아줘. 기존 startDate, endDate:%s 현재 시간 이후로 여유 있게 모든 일정을 완수할 수 있도록 계획해줘. 현재 시간 : (%s 기준). 모든 일정은 한국 시간(UTC+9)을 기준으로 설정해줘. 또한, 기존 일정을 생각하고 새로운 일정을 적당한 간격을 두고 배치해줘."
     );
 
     public GptService(OpenAiApi openAiApi, GptProperties gptProperties, PlanService planService, ObjectMapper objectMapper) {
@@ -39,7 +40,7 @@ public GptService(OpenAiApi openAiApi, GptProperties gptProperties, PlanService
 
     public String generateResponse(String userInput, Long userId, String deviceId, int groupId) {
         String currentTime = getCurrentTime();
-        List<PlanResponseDto> futurePlans = (userId != null) ? planService.getAllFuturePlansByUserId(userId) : List.of();
+        List<PlanTimeDto> futurePlans = (userId != null) ? planService.getAllFuturePlanTimesByUserId(userId) : List.of();
         String planJson = convertPlansToJson(futurePlans);
         String promptTemplate = PROMPT_TEMPLATES.get(groupId);
         String fullPrompt = String.format(promptTemplate, userInput, deviceId, groupId, planJson, currentTime);
@@ -54,7 +55,7 @@ private String getCurrentTime() {
         return LocalDateTime.now(ZoneId.of("Asia/Seoul")).format(DateTimeFormatter.ISO_LOCAL_DATE_TIME);
     }
 
-    private String convertPlansToJson(List<PlanResponseDto> futurePlans) {
+    private String convertPlansToJson(List<PlanTimeDto> futurePlans) {
         try {
             return objectMapper.writeValueAsString(futurePlans);
         } catch (JsonProcessingException e) {
@@ -85,3 +86,4 @@ private String getGptResponse(OpenAiApi.ChatCompletionRequest chatRequest) {
         }
     }
 }
+

src/main/java/com/splanet/splanet/notification/controller/FcmTokenApi.java

@@ -16,35 +16,25 @@
 public interface FcmTokenApi {
 
     @PostMapping("/register")
-    @Operation(summary = "FCM 토큰 등록", description = "유저가 FCM 토큰을 등록합니다.")
-    @ApiResponses(value = {
-            @ApiResponse(responseCode = "200", description = "FCM 토큰이 성공적으로 등록되었습니다."),
-            @ApiResponse(responseCode = "404", description = "유저를 찾을 수 없습니다.", content = @Content)
-    })
     ResponseEntity<String> registerFcmToken(
             @AuthenticationPrincipal Long userId,
             @RequestBody FcmTokenRequest fcmTokenRequest
     );
 
-    @PutMapping("/update")
-    @Operation(summary = "FCM 토큰 설정 수정", description = "알림 설정 및 알림 오프셋을 수정합니다.")
-    @ApiResponses(value = {
-            @ApiResponse(responseCode = "200", description = "FCM 토큰 설정이 성공적으로 수정되었습니다."),
-            @ApiResponse(responseCode = "404", description = "유저를 찾을 수 없습니다.", content = @Content)
-    })
-    ResponseEntity<String> updateFcmTokenSettings(
-            @AuthenticationPrincipal Long userId,
-            @RequestBody FcmTokenUpdateRequest fcmTokenUpdateRequest
+    @PutMapping("/update/notification-enabled")
+    ResponseEntity<String> updateNotificationEnabled(
+            @RequestParam String token,
+            @RequestParam Boolean isNotificationEnabled
+    );
+
+    @PutMapping("/update/notification-offset")
+    ResponseEntity<String> updateNotificationOffset(
+            @RequestParam String token,
+            @RequestParam Integer notificationOffset
     );
 
     @DeleteMapping("/delete")
-    @Operation(summary = "FCM 토큰 삭제", description = "유저의 FCM 토큰을 삭제합니다.")
-    @ApiResponses(value = {
-            @ApiResponse(responseCode = "200", description = "FCM 토큰이 성공적으로 삭제되었습니다."),
-            @ApiResponse(responseCode = "404", description = "해당 토큰을 찾을 수 없습니다.", content = @Content)
-    })
     ResponseEntity<String> deleteFcmToken(
-            @AuthenticationPrincipal Long userId,
             @RequestParam String token
     );
 }

src/main/java/com/splanet/splanet/notification/controller/FcmTokenController.java

@@ -1,7 +1,6 @@
 package com.splanet.splanet.notification.controller;
 
 import com.splanet.splanet.notification.dto.FcmTokenRequest;
-import com.splanet.splanet.notification.dto.FcmTokenUpdateRequest;
 import com.splanet.splanet.notification.service.FcmTokenService;
 import lombok.RequiredArgsConstructor;
 import org.springframework.http.ResponseEntity;
@@ -21,14 +20,20 @@ public ResponseEntity<String> registerFcmToken(Long userId, FcmTokenRequest fcmT
     }
 
     @Override
-    public ResponseEntity<String> updateFcmTokenSettings(Long userId, FcmTokenUpdateRequest fcmTokenUpdateRequest) {
-        fcmTokenService.updateFcmTokenSettings(userId, fcmTokenUpdateRequest);
-        return ResponseEntity.ok("FCM token 수정 완료");
+    public ResponseEntity<String> updateNotificationEnabled(String token, Boolean isNotificationEnabled) {
+        fcmTokenService.updateNotificationEnabled(token, isNotificationEnabled);
+        return ResponseEntity.ok("FCM 알림 여부 수정 완료");
     }
 
     @Override
-    public ResponseEntity<String> deleteFcmToken(Long userId, String token) {
-        fcmTokenService.deleteFcmToken(userId, token);
+    public ResponseEntity<String> updateNotificationOffset(String token, Integer notificationOffset) {
+        fcmTokenService.updateNotificationOffset(token, notificationOffset);
+        return ResponseEntity.ok("FCM 알림 오프셋 수정 완료");
+    }
+
+    @Override
+    public ResponseEntity<String> deleteFcmToken(String token) {
+        fcmTokenService.deleteFcmToken(token);
         return ResponseEntity.ok("FCM token 삭제 완료");
     }
 }

src/main/java/com/splanet/splanet/notification/repository/FcmTokenRepository.java

@@ -12,4 +12,5 @@ public interface FcmTokenRepository extends JpaRepository<FcmToken, Long> {
     Optional<FcmToken> findByUserIdAndToken(Long userId, String token);
     List<FcmToken> findByUserId(Long userId);
     List<FcmToken> findByUserIdIn(Collection<Long> userIds);
+    Optional<FcmToken> findByToken(String token);
 }

src/main/java/com/splanet/splanet/notification/service/FcmTokenService.java

@@ -1,4 +1,3 @@
-// src/main/java/com/splanet/splanet/notification/service/FcmTokenService.java
 package com.splanet.splanet.notification.service;
 
 import com.splanet.splanet.core.exception.BusinessException;
@@ -34,26 +33,33 @@ public void registerFcmToken(Long userId, String token) {
     }
 
     @Transactional
-    public void updateFcmTokenSettings(Long userId, FcmTokenUpdateRequest request) {
-        FcmToken fcmToken = fcmTokenRepository.findByUserIdAndToken(userId, request.token())
-                .orElseThrow(() -> new BusinessException(ErrorCode.USER_NOT_FOUND));
+    public void updateNotificationEnabled(String token, Boolean isNotificationEnabled) {
+        FcmToken fcmToken = fcmTokenRepository.findByToken(token)
+                .orElseThrow(() -> new BusinessException(ErrorCode.TOKEN_NOT_FOUND));
 
         fcmToken = fcmToken.toBuilder()
-                .isNotificationEnabled(request.isNotificationEnabled() != null
-                        ? request.isNotificationEnabled()
-                        : fcmToken.getIsNotificationEnabled())
-                .notificationOffset(request.notificationOffset() != null
-                        ? request.notificationOffset()
-                        : fcmToken.getNotificationOffset())
+                .isNotificationEnabled(isNotificationEnabled != null ? isNotificationEnabled : fcmToken.getIsNotificationEnabled())
                 .build();
 
         fcmTokenRepository.save(fcmToken);
     }
 
     @Transactional
-    public void deleteFcmToken(Long userId, String token) {
-        FcmToken fcmToken = fcmTokenRepository.findByUserIdAndToken(userId, token)
-                .orElseThrow(() -> new BusinessException(ErrorCode.USER_NOT_FOUND));
+    public void updateNotificationOffset(String token, Integer notificationOffset) {
+        FcmToken fcmToken = fcmTokenRepository.findByToken(token)
+                .orElseThrow(() -> new BusinessException(ErrorCode.TOKEN_NOT_FOUND));
+
+        fcmToken = fcmToken.toBuilder()
+                .notificationOffset(notificationOffset != null ? notificationOffset : fcmToken.getNotificationOffset())
+                .build();
+
+        fcmTokenRepository.save(fcmToken);
+    }
+
+    @Transactional
+    public void deleteFcmToken(String token) {
+        FcmToken fcmToken = fcmTokenRepository.findByToken(token)
+                .orElseThrow(() -> new BusinessException(ErrorCode.TOKEN_NOT_FOUND));
         fcmTokenRepository.delete(fcmToken);
     }
 }

src/main/java/com/splanet/splanet/notification/service/NotificationService.java

@@ -42,7 +42,16 @@ public void sendNotification(FcmToken fcmToken, Plan plan) {
 
         Notification notification = new Notification(title, body);
 
-        Message message = Message.builder().setToken(fcmToken.getToken()).setNotification(notification).putData("title", plan.getTitle()).putData("title", plan.getDescription()).putData("startDate", plan.getStartDate().toString()).build();
+        String clickActionUrl = "https://www.splanet.co.kr";
+
+        Message message = Message.builder().setToken(fcmToken.getToken())
+                .setNotification(notification)
+                .putData("click_action", clickActionUrl)
+                .putData("title", plan.getTitle())
+                .putData("description", plan.getDescription())
+                .putData("startDate", plan.getStartDate().toString())
+                .build();
+
         try {
             String response = firebaseMessaging.send(message);
             log.info("알림을 정상적으로 전송하였습니다. : {}", response);

src/main/java/com/splanet/splanet/plan/dto/PlanResponseDto.java

@@ -14,11 +14,9 @@ public class PlanResponseDto {
     private String description;
     private LocalDateTime startDate;
     private LocalDateTime endDate;
-
-    @JsonIgnore
     private Boolean accessibility;
-    @JsonIgnore
     private Boolean isCompleted;
+
     @JsonIgnore
     private LocalDateTime createdAt;
     @JsonIgnore

src/main/java/com/splanet/splanet/plan/dto/PlanTimeDto.java

@@ -0,0 +1,21 @@
+package com.splanet.splanet.plan.dto;
+
+import java.time.LocalDateTime;
+
+public class PlanTimeDto {
+    private LocalDateTime startDate;
+    private LocalDateTime endDate;
+
+    public PlanTimeDto(LocalDateTime startDate, LocalDateTime endDate) {
+        this.startDate = startDate;
+        this.endDate = endDate;
+    }
+
+    public LocalDateTime getStartDate() {
+        return startDate;
+    }
+
+    public LocalDateTime getEndDate() {
+        return endDate;
+    }
+}