📝 Add docstrings to refactor/318-siteuser-test-fixture-module

src/test/java/com/example/solidconnection/siteuser/fixture/SiteUserFixture.java

@@ -0,0 +1,134 @@
+package com.example.solidconnection.siteuser.fixture;
+
+import com.example.solidconnection.siteuser.domain.AuthType;
+import com.example.solidconnection.siteuser.domain.SiteUser;
+import com.example.solidconnection.type.Role;
+import lombok.RequiredArgsConstructor;
+import org.springframework.boot.test.context.TestComponent;
+import org.springframework.security.crypto.password.PasswordEncoder;
+
+@TestComponent
+@RequiredArgsConstructor
+public class SiteUserFixture {
+
+    private final SiteUserFixtureBuilder siteUserFixtureBuilder;
+    private final PasswordEncoder passwordEncoder;
+
+    /**
+     * Creates a default test user with preset email, nickname, role, and password.
+     *
+     * @return a SiteUser instance representing a standard test user
+     */
+    public SiteUser 테스트_유저() {
+        return siteUserFixtureBuilder.siteUser()
+                .email("test@example.com")
+                .authType(AuthType.EMAIL)
+                .nickname("테스트유저")
+                .profileImageUrl("profileImageUrl")
+                .role(Role.MENTEE)
+                .password("password123")
+                .create();
+    }
+
+    /**
+     * Creates a test user with a unique email based on the given index and the specified nickname.
+     *
+     * @param index the numeric value to include in the user's email address for uniqueness
+     * @param nickname the nickname to assign to the user
+     * @return a new SiteUser instance with the specified nickname and a unique email
+     */
+    public SiteUser 테스트_유저(int index, String nickname) {
+        return siteUserFixtureBuilder.siteUser()
+                .email("test" + index + " @example.com")
+                .authType(AuthType.EMAIL)
+                .nickname(nickname)
+                .profileImageUrl("profileImageUrl")
+                .role(Role.MENTEE)
+                .password("password123")
+                .create();
+    }
+
+    /**
+     * Creates a test user with the specified email and authentication type.
+     *
+     * @param email the email address for the test user
+     * @param authType the authentication type for the test user
+     * @return a SiteUser instance with the given email and auth type, default nickname, profile image URL, mentee role, and password
+     */
+    public SiteUser 테스트_유저(String email, AuthType authType) {
+        return siteUserFixtureBuilder.siteUser()
+                .email(email)
+                .authType(authType)
+                .nickname("테스트유저")
+                .profileImageUrl("profileImageUrl")
+                .role(Role.MENTEE)
+                .password("password123")
+                .create();
+    }
+
+    /**
+     * Creates a test user with the specified email and password, encoding the password.
+     *
+     * @param email the email address for the test user
+     * @param password the raw password to be encoded for the test user
+     * @return a SiteUser instance with the given email and encoded password, default nickname, profile image URL, and mentee role
+     */
+    public SiteUser 테스트_유저(String email, String password) {
+        return siteUserFixtureBuilder.siteUser()
+                .email(email)
+                .authType(AuthType.EMAIL)
+                .nickname("테스트유저")
+                .profileImageUrl("profileImageUrl")
+                .role(Role.MENTEE)
+                .password(passwordEncoder.encode(password))
+                .create();
+    }
+
+    /**
+     * Creates a test user with a duplicated nickname for testing nickname collision scenarios.
+     *
+     * @return a SiteUser instance with a fixed email, nickname "중복닉네임", and default attributes
+     */
+    public SiteUser 중복_닉네임_테스트_유저() {
+        return siteUserFixtureBuilder.siteUser()
+                .email("duplicated@example.com")
+                .authType(AuthType.EMAIL)
+                .nickname("중복닉네임")
+                .profileImageUrl("profileImageUrl")
+                .role(Role.MENTEE)
+                .password("password123")
+                .create();
+    }
+
+    /**
+     * Creates a test user with a custom profile image URL and password.
+     *
+     * @return a SiteUser instance with email "customProfile@example.com", nickname "커스텀프로필", role MENTEE, authentication type EMAIL, profile image URL "profile/profileImageUrl", and password "customPassword123"
+     */
+    public SiteUser 커스텀_프로필_테스트_유저() {
+        return siteUserFixtureBuilder.siteUser()
+                .email("customProfile@example.com")
+                .authType(AuthType.EMAIL)
+                .nickname("커스텀프로필")
+                .profileImageUrl("profile/profileImageUrl")
+                .role(Role.MENTEE)
+                .password("customPassword123")
+                .create();
+    }
+
+    /**
+     * Creates a test admin user with predefined email, nickname, profile image URL, and password.
+     *
+     * @return a SiteUser instance representing an admin user for testing purposes
+     */
+    public SiteUser 테스트_어드민() {
+        return siteUserFixtureBuilder.siteUser()
+                .email("admin@example.com")
+                .authType(AuthType.EMAIL)
+                .nickname("테스트어드민")
+                .profileImageUrl("profileImageUrl")
+                .role(Role.ADMIN)
+                .password("admin123")
+                .create();
+    }
+}

src/test/java/com/example/solidconnection/siteuser/fixture/SiteUserFixtureBuilder.java

@@ -0,0 +1,116 @@
+package com.example.solidconnection.siteuser.fixture;
+
+import com.example.solidconnection.siteuser.domain.AuthType;
+import com.example.solidconnection.siteuser.domain.SiteUser;
+import com.example.solidconnection.siteuser.repository.SiteUserRepository;
+import com.example.solidconnection.type.PreparationStatus;
+import com.example.solidconnection.type.Role;
+import lombok.RequiredArgsConstructor;
+import org.springframework.boot.test.context.TestComponent;
+
+@TestComponent
+@RequiredArgsConstructor
+public class SiteUserFixtureBuilder {
+
+    private final SiteUserRepository siteUserRepository;
+
+    private String email;
+    private AuthType authType;
+    private String nickname;
+    private String profileImageUrl;
+    private Role role;
+    private String password;
+
+    /**
+     * Creates a new instance of the builder with the same repository for fresh configuration.
+     *
+     * @return a new SiteUserFixtureBuilder instance
+     */
+    public SiteUserFixtureBuilder siteUser() {
+        return new SiteUserFixtureBuilder(siteUserRepository);
+    }
+
+    /**
+     * Sets the email address for the SiteUser being built.
+     *
+     * @param email the email address to assign
+     * @return this builder instance for method chaining
+     */
+    public SiteUserFixtureBuilder email(String email) {
+        this.email = email;
+        return this;
+    }
+
+    /**
+     * Sets the authentication type for the user being built.
+     *
+     * @param authType the authentication type to assign
+     * @return this builder instance for method chaining
+     */
+    public SiteUserFixtureBuilder authType(AuthType authType) {
+        this.authType = authType;
+        return this;
+    }
+
+    /**
+     * Sets the nickname for the SiteUser being built.
+     *
+     * @param nickname the nickname to assign
+     * @return this builder instance for method chaining
+     */
+    public SiteUserFixtureBuilder nickname(String nickname) {
+        this.nickname = nickname;
+        return this;
+    }
+
+    /**
+     * Sets the profile image URL for the SiteUser being built.
+     *
+     * @param profileImageUrl the URL of the user's profile image
+     * @return this builder instance for method chaining
+     */
+    public SiteUserFixtureBuilder profileImageUrl(String profileImageUrl) {
+        this.profileImageUrl = profileImageUrl;
+        return this;
+    }
+
+    /**
+     * Sets the role for the SiteUser being built.
+     *
+     * @param role the user role to assign
+     * @return this builder instance for method chaining
+     */
+    public SiteUserFixtureBuilder role(Role role) {
+        this.role = role;
+        return this;
+    }
+
+    /**
+     * Sets the password for the SiteUser being built.
+     *
+     * @param password the password to assign
+     * @return this builder instance for method chaining
+     */
+    public SiteUserFixtureBuilder password(String password) {
+        this.password = password;
+        return this;
+    }
+
+    /**
+     * Builds and persists a new SiteUser entity using the configured attributes.
+     *
+     * @return the persisted SiteUser instance
+     */
+    public SiteUser create() {
+        SiteUser siteUser = new SiteUser(
+                email,
+                nickname,
+                profileImageUrl,
+                PreparationStatus.CONSIDERING,
+                role,
+                authType,
+                password
+        );
+        return siteUserRepository.save(siteUser);
+    }
+}