Comment: 테스트 코드 주석 추가

Author: joyewon0705

src/test/java/com/back/domain/user/controller/AuthControllerTest.java

@@ -35,7 +35,7 @@ class AuthControllerTest {
     @Test
     @DisplayName("정상 회원가입 → 201 Created")
     void register_success() throws Exception {
-        // given
+        // given: 정상적인 회원가입 요청 JSON
         String body = """
             {
               "username": "testuser",
@@ -45,32 +45,35 @@ void register_success() throws Exception {
             }
             """;
 
-        // when
+        // when: 회원가입 API 호출
         ResultActions resultActions = mvc.perform(
                 post("/api/auth/register")
                         .contentType(MediaType.APPLICATION_JSON)
                         .content(body)
         ).andDo(print());
 
-        // then
+        // then: 응답 값과 DB 저장값 검증
         resultActions
                 .andExpect(status().isCreated())
                 .andExpect(jsonPath("$.success").value(true))
                 .andExpect(jsonPath("$.data.username").value("testuser"))
                 .andExpect(jsonPath("$.data.email").value("[email protected]"))
                 .andExpect(jsonPath("$.data.nickname").value("홍길동"));
 
+        // DB에서 저장된 User 상태 검증
         User saved = userRepository.findByUsername("testuser").orElseThrow();
         assertThat(saved.getUserStatus()).isEqualTo(UserStatus.PENDING);
     }
 
     @Test
     @DisplayName("중복 username → 409 Conflict")
     void register_duplicateUsername() throws Exception {
+        // given: 이미 존재하는 username을 가진 User 저장
         User existing = User.createUser("dupuser", "[email protected]", "password123!");
         existing.setUserProfile(new UserProfile(existing, "dupnick", null, null, null, 0));
         userRepository.save(existing);
 
+        // 동일 username으로 회원가입 요청
         String body = """
             {
               "username": "dupuser",
@@ -80,6 +83,7 @@ void register_duplicateUsername() throws Exception {
             }
             """;
 
+        // when & then: 409 Conflict 응답 및 에러 코드 확인
         mvc.perform(post("/api/auth/register")
                         .contentType(MediaType.APPLICATION_JSON)
                         .content(body))
@@ -91,10 +95,12 @@ void register_duplicateUsername() throws Exception {
     @Test
     @DisplayName("중복 email → 409 Conflict")
     void register_duplicateEmail() throws Exception {
+        // given: 이미 존재하는 email을 가진 User 저장
         User existing = User.createUser("user1", "[email protected]", "password123!");
         existing.setUserProfile(new UserProfile(existing, "nick1", null, null, null, 0));
         userRepository.save(existing);
 
+        // 동일 email로 회원가입 요청
         String body = """
             {
               "username": "otheruser",
@@ -104,6 +110,7 @@ void register_duplicateEmail() throws Exception {
             }
             """;
 
+        // when & then: 409 Conflict 응답 및 에러 코드 확인
         mvc.perform(post("/api/auth/register")
                         .contentType(MediaType.APPLICATION_JSON)
                         .content(body))
@@ -115,10 +122,12 @@ void register_duplicateEmail() throws Exception {
     @Test
     @DisplayName("중복 nickname → 409 Conflict")
     void register_duplicateNickname() throws Exception {
+        // given: 이미 존재하는 nickname을 가진 User 저장
         User existing = User.createUser("user2", "[email protected]", "password123!");
         existing.setUserProfile(new UserProfile(existing, "dupnick", null, null, null, 0));
         userRepository.save(existing);
 
+        // 동일 nickname으로 회원가입 요청
         String body = """
             {
               "username": "newuser",
@@ -128,6 +137,7 @@ void register_duplicateNickname() throws Exception {
             }
             """;
 
+        // when & then: 409 Conflict 응답 및 에러 코드 확인
         mvc.perform(post("/api/auth/register")
                         .contentType(MediaType.APPLICATION_JSON)
                         .content(body))
@@ -139,6 +149,7 @@ void register_duplicateNickname() throws Exception {
     @Test
     @DisplayName("비밀번호 정책 위반 → 400 Bad Request")
     void register_invalidPassword() throws Exception {
+        // given: 숫자/특수문자 포함 안 된 약한 비밀번호
         String body = """
             {
               "username": "weakpw",
@@ -148,6 +159,7 @@ void register_invalidPassword() throws Exception {
             }
             """;
 
+        // when & then: 400 Bad Request 응답 및 에러 코드 확인
         mvc.perform(post("/api/auth/register")
                         .contentType(MediaType.APPLICATION_JSON)
                         .content(body))
@@ -159,6 +171,7 @@ void register_invalidPassword() throws Exception {
     @Test
     @DisplayName("잘못된 요청값 (필수 필드 누락) → 400 Bad Request")
     void register_invalidRequest_missingField() throws Exception {
+        // given: 필수 값 누락 (username, password, nickname 비어있음 / email 형식 잘못됨)
         String body = """
             {
               "username": "",
@@ -168,6 +181,7 @@ void register_invalidRequest_missingField() throws Exception {
             }
             """;
 
+        // when & then: 400 Bad Request 응답 및 공통 에러 코드 확인
         mvc.perform(post("/api/auth/register")
                         .contentType(MediaType.APPLICATION_JSON)
                         .content(body))

src/test/java/com/back/domain/user/service/UserServiceTest.java

@@ -38,15 +38,15 @@ class UserServiceTest {
     @Test
     @DisplayName("정상 회원가입 성공")
     void register_success() {
-        // given
+        // given: 정상적인 회원가입 요청 생성
         UserRegisterRequest request = new UserRegisterRequest(
                 "testuser", "[email protected]", "P@ssw0rd!", "홍길동"
         );
 
-        // when
+        // when: 회원가입 실행
         UserResponse response = userService.register(request);
 
-        // then
+        // then: 반환된 값 검증
         assertThat(response.username()).isEqualTo("testuser");
         assertThat(response.email()).isEqualTo("[email protected]");
         assertThat(response.nickname()).isEqualTo("홍길동");
@@ -56,17 +56,19 @@ void register_success() {
         String encoded = userRepository.findById(response.userId()).get().getPassword();
         assertThat(passwordEncoder.matches("P@ssw0rd!", encoded)).isTrue();
 
-        // UserProfile도 함께 저장됐는지 검증
+        // UserProfile도 함께 생성되었는지 확인
         assertThat(userProfileRepository.existsByNickname("홍길동")).isTrue();
     }
 
     @Test
     @DisplayName("중복된 username이면 예외 발생")
     void register_duplicateUsername() {
+        // given: 동일 username으로 첫 번째 가입
         userService.register(new UserRegisterRequest(
                 "dupuser", "[email protected]", "P@ssw0rd!", "닉네임"
         ));
 
+        // when & then: 같은 username으로 가입 시 예외 발생
         assertThatThrownBy(() ->
                 userService.register(new UserRegisterRequest(
                         "dupuser", "[email protected]", "P@ssw0rd!", "다른닉네임"
@@ -78,10 +80,12 @@ void register_duplicateUsername() {
     @Test
     @DisplayName("중복된 email이면 예외 발생")
     void register_duplicateEmail() {
+        // given: 동일 email로 첫 번째 가입
         userService.register(new UserRegisterRequest(
                 "user1", "[email protected]", "P@ssw0rd!", "닉네임"
         ));
 
+        // when & then: 같은 email로 가입 시 예외 발생
         assertThatThrownBy(() ->
                 userService.register(new UserRegisterRequest(
                         "user2", "[email protected]", "P@ssw0rd!", "다른닉네임"
@@ -93,10 +97,12 @@ void register_duplicateEmail() {
     @Test
     @DisplayName("중복된 nickname이면 예외 발생")
     void register_duplicateNickname() {
+        // given: 동일 nickname으로 첫 번째 가입
         userService.register(new UserRegisterRequest(
                 "user1", "[email protected]", "P@ssw0rd!", "dupnick"
         ));
 
+        // when & then: 같은 nickname으로 가입 시 예외 발생
         assertThatThrownBy(() ->
                 userService.register(new UserRegisterRequest(
                         "user2", "[email protected]", "P@ssw0rd!", "dupnick"
@@ -108,10 +114,12 @@ void register_duplicateNickname() {
     @Test
     @DisplayName("비밀번호 정책 위반(숫자/특수문자 없음) → 예외 발생")
     void register_invalidPassword_noNumberOrSpecial() {
+        // given: 숫자, 특수문자 없는 비밀번호
         UserRegisterRequest request = new UserRegisterRequest(
                 "user1", "[email protected]", "abcdefgh", "닉네임"
         );
 
+        // when & then: 정책 위반으로 예외 발생
         assertThatThrownBy(() -> userService.register(request))
                 .isInstanceOf(CustomException.class)
                 .hasMessage(ErrorCode.INVALID_PASSWORD.getMessage());
@@ -120,10 +128,12 @@ void register_invalidPassword_noNumberOrSpecial() {
     @Test
     @DisplayName("비밀번호 정책 위반(길이 7자) → 예외 발생")
     void register_invalidPassword_tooShort() {
+        // given: 7자리 비밀번호 (정책상 8자 이상 필요)
         UserRegisterRequest request = new UserRegisterRequest(
                 "user2", "[email protected]", "Abc12!", "닉네임"
         );
 
+        // when & then: 정책 위반으로 예외 발생
         assertThatThrownBy(() -> userService.register(request))
                 .isInstanceOf(CustomException.class)
                 .hasMessage(ErrorCode.INVALID_PASSWORD.getMessage());
@@ -132,12 +142,15 @@ void register_invalidPassword_tooShort() {
     @Test
     @DisplayName("비밀번호 정책 통과(정상 8자 이상, 숫자/특수문자 포함) → 성공")
     void register_validPassword() {
+        // given: 정책을 만족하는 정상 비밀번호
         UserRegisterRequest request = new UserRegisterRequest(
                 "user3", "[email protected]", "Abcd123!", "닉네임"
         );
 
+        // when: 회원가입 실행
         UserResponse response = userService.register(request);
 
+        // then: username과 비밀번호 인코딩 검증
         assertThat(response.username()).isEqualTo("user3");
         assertThat(passwordEncoder.matches("Abcd123!",
                 userRepository.findById(response.userId()).get().getPassword())).isTrue();