Task 34 : Add Java Doc for AbstractBaseServiceTest, AbstractRestContr…

…ollerTest, AbstractTestContainerConfiguration and GlobalExceptionHandlerTest

src/test/java/com/springboot/ratelimiter/base/AbstractBaseServiceTest.java

@@ -5,6 +5,9 @@
 import org.mockito.junit.jupiter.MockitoSettings;
 import org.mockito.quality.Strictness;
 
+/**
+ * Abstract base class named {@link AbstractBaseServiceTest} for service layer tests using Mockito.
+ */
 @ExtendWith(MockitoExtension.class)
 @MockitoSettings(strictness = Strictness.LENIENT)
 public abstract class AbstractBaseServiceTest {

src/test/java/com/springboot/ratelimiter/base/AbstractRestControllerTest.java

@@ -6,6 +6,10 @@
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.test.web.servlet.MockMvc;
 
+
+/**
+ * Base class named {@link AbstractRestControllerTest} for REST controller tests.
+ */
 @SpringBootTest
 @AutoConfigureMockMvc
 public class AbstractRestControllerTest extends AbstractTestContainerConfiguration {

src/test/java/com/springboot/ratelimiter/base/AbstractTestContainerConfiguration.java

@@ -8,6 +8,9 @@
 import org.testcontainers.junit.jupiter.Container;
 import org.testcontainers.junit.jupiter.Testcontainers;
 
+/**
+ * Configuration class named {@link AbstractTestContainerConfiguration} for Testcontainers setup.
+ */
 @Testcontainers
 class AbstractTestContainerConfiguration {
 
@@ -18,13 +21,21 @@ class AbstractTestContainerConfiguration {
     public static GenericContainer<?> redisContainer = new GenericContainer<>("redis:latest")
             .withExposedPorts(6379);
 
+    /**
+     * Starts the Testcontainers before all tests.
+     */
     @BeforeAll
     static void beforeAll() {
         MYSQL_CONTAINER.withReuse(true);
         MYSQL_CONTAINER.start();
         redisContainer.start();
     }
 
+    /**
+     * Overrides Spring properties with container properties.
+     *
+     * @param dynamicPropertyRegistry the registry to override properties
+     */
     @DynamicPropertySource
     private static void overrideProps(DynamicPropertyRegistry dynamicPropertyRegistry) {
         dynamicPropertyRegistry.add("spring.datasource.username", MYSQL_CONTAINER::getUsername);

src/test/java/com/springboot/ratelimiter/common/exception/GlobalExceptionHandlerTest.java

@@ -25,11 +25,21 @@
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.when;
 
+/**
+ * Test class for {@link GlobalExceptionHandler}.
+ * This class tests the various exception handling methods of the {@link GlobalExceptionHandler} class
+ * to ensure they return the expected {@link CustomError} responses.
+ */
 class GlobalExceptionHandlerTest extends AbstractRestControllerTest {
 
     @InjectMocks
     private GlobalExceptionHandler globalExceptionHandler;
 
+    /**
+     * Tests the handling of {@link MethodArgumentNotValidException}.
+     * This test verifies that a {@link CustomError} is returned with the expected properties
+     * when a {@link MethodArgumentNotValidException} is thrown.
+     */
     @Test
     void givenMethodArgumentNotValidException_handleMethodArgumentNotValid_throwCustomError() {
 
@@ -60,7 +70,11 @@ void givenMethodArgumentNotValidException_handleMethodArgumentNotValid_throwCust
 
     }
 
-
+    /**
+     * Tests the handling of {@link ConstraintViolationException} for path variable errors.
+     * This test verifies that a {@link CustomError} is returned with the expected properties
+     * when a {@link ConstraintViolationException} is thrown.
+     */
     @Test
     void givenConstraintViolationException_whenHandlePathVariableErrors_throwCustomError() {
 
@@ -102,6 +116,11 @@ void givenConstraintViolationException_whenHandlePathVariableErrors_throwCustomE
 
     }
 
+    /**
+     * Tests the handling of {@link RuntimeException}.
+     * This test verifies that a {@link CustomError} is returned with the expected properties
+     * when a {@link RuntimeException} is thrown.
+     */
     @Test
     void givenRuntimeException_whenHandleRuntimeException_throwCustomError() {
 
@@ -126,6 +145,11 @@ void givenRuntimeException_whenHandleRuntimeException_throwCustomError() {
 
     }
 
+    /**
+     * Tests the handling of {@link RateLimitExceededException}.
+     * This test verifies that a {@link CustomError} is returned with the expected properties
+     * when a {@link RateLimitExceededException} is thrown.
+     */
     @Test
     void givenRateLimitExceededException_whenHandleRateLimitExceededException_throwCustomError() {
 
@@ -151,6 +175,11 @@ void givenRateLimitExceededException_whenHandleRateLimitExceededException_throwC
 
     }
 
+    /**
+     * Tests the handling of {@link EmailAlreadyExistsException}.
+     * This test verifies that a {@link CustomError} is returned with the expected properties
+     * when an {@link EmailAlreadyExistsException} is thrown.
+     */
     @Test
     void givenEmailAlreadyExistsException_whenHandleEmailAlreadyExistsException_throwCustomError() {
 
@@ -175,6 +204,11 @@ void givenEmailAlreadyExistsException_whenHandleEmailAlreadyExistsException_thro
 
     }
 
+    /**
+     * Tests the handling of {@link UserNotFoundException}.
+     * This test verifies that a {@link CustomError} is returned with the expected properties
+     * when a {@link UserNotFoundException} is thrown.
+     */
     @Test
     void givenUserNotFoundException_whenHandleUserNotFoundException_throwCustomError() {
 
@@ -199,6 +233,12 @@ void givenUserNotFoundException_whenHandleUserNotFoundException_throwCustomError
 
     }
 
+    /**
+     * Verifies the properties of a {@link CustomError}.
+     *
+     * @param expectedError the expected custom error
+     * @param actualError   the actual custom error
+     */
     private void checkCustomError(CustomError expectedError, CustomError actualError) {
 
         assertThat(actualError).isNotNull();