v1.4.2

Author: co-mmer

CHANGELOG.md

@@ -2,6 +2,14 @@
 
 # Changelog
 
+## [1.4.2]
+
+### Upgraded
+
+- spring-boot 3.4.4 → 3.4.5
+
+---
+
 ## [1.4.1]
 
 ### Upgraded
@@ -24,6 +32,8 @@
 - `answerAsMap(Class<K> keyType, Class<V> valueType)` now returns `null` instead of throwing
   a `MismatchedInputException` when the HTTP response is `null`.
 
+---
+
 ## [1.4.0]
 
 ### Added

README.md

@@ -16,12 +16,14 @@
 
 ## Overview
 
-This project provides a framework for structuring unit tests following the AAA (Arrange, Act,
-Assert) pattern with a focus on clarity and readability. The library offers a fluent API that guides
-the developer through each phase, ensuring that only contextually relevant methods are available at
-each step. This design choice enhances the ease of writing, maintaining, and understanding tests.
-The key goal is to provide a clean separation of concerns within the test, allowing developers to
-express their test logic fluently and naturally.
+A fluent testing framework for Spring's MockMvc that enforces the Arrange-Act-Assert (AAA)
+pattern and reduces boilerplate in controller tests.
+The library guides developers through each testing phase with a strongly-typed,
+step-by-step API, ensuring a consistent and intuitive test structure. Common tasks such as
+request setup, ObjectMapper-based serialization, and response assertions are fully abstracted,
+allowing developers to focus on the test logic itself rather than technical overhead.
+
+<img src="images/aaa-mockmvc-example1.png" alt="aaa-mockmvc-example"/>
 
 ___
 
@@ -38,15 +40,15 @@ ___
 ## Installation
 
 To include AAAMockMvc in the project, add the following dependency to the `pom.xml`.
-The sources can also be downloaded directly within the IDE (e.g., IntelliJ IDEA) to access the
+The sources can also be downloaded directly within the IDE (e.g. IntelliJ IDEA) to access the
 documentation of the classes.
 
 ```xml
 
 <dependency>
   <groupId>io.github.co-mmer</groupId>
   <artifactId>aaa-mockmvc</artifactId>
-  <version>1.4.1</version>
+  <version>1.4.2</version>
   <scope>test</scope>
 </dependency>
 
@@ -109,7 +111,7 @@ to `AAAMockMvc`.
 public class AAAMockMvcConfig {
 
   @Bean
-  AAAMockMvc aaaMockMvc(WebApplicationContext context, ObjectMapper objectMapper) {
+  public AAAMockMvc aaaMockMvc(WebApplicationContext context, ObjectMapper objectMapper) {
     return new AAAMockMvc(context, objectMapper);
   }
 
@@ -141,7 +143,7 @@ The framework will use a default ObjectMapper (`new ObjectMapper()`).
 public class AAAMockMvcConfig {
 
   @Bean
-  AAAMockMvc aaaMockMvc(MockMvc mockMvc) {
+  public AAAMockMvc aaaMockMvc(MockMvc mockMvc) {
     return new AAAMockMvc(mockMvc);
   }
 
@@ -177,7 +179,7 @@ specific configurations.
 public class AAAMockMvcConfig {
 
   @Bean
-  AAAMockMvc aaaMockMvc(WebApplicationContext context, ObjectMapper objectMapper) {
+  public AAAMockMvc aaaMockMvc(WebApplicationContext context, ObjectMapper objectMapper) {
     return new AAAMockMvc(context, objectMapper);
   }
 
@@ -304,22 +306,18 @@ In the provided library, every test follows the AAA structure using the followin
 
 ## Example
 
-- [Registration Scenario](#registration-scenario)
-- [Test Implementation](#test-implementation)
-
-This example demonstrates a typical registration process, where the user's email address must first
+This example demonstrates a registration process, where the user's email address must first
 be verified by sending a code. After the email verification, the user can proceed with the
-registration, including providing the verification code.
-
-The process is split into two main steps:
+registration, including providing the verification code. The process is split into two main steps:
 
 1. **Email Verification**: A verification code is sent to the provided email address.
 2. **Registration**: After receiving the verification code, the user sends it back to the backend
    for validation, allowing them to complete their registration.
 
-Below are the necessary code snippets to represent this scenario:
+### Main Code
 
-## Registration Scenario
+<details>
+<summary>Implementation of Registration Scenario</summary>
 
 ### 1. Verification Response Model
 
@@ -414,22 +412,19 @@ public class RegistrationController {
 
 ```
 
-## Test Implementation
+</details>
 
-The table below shows the same test scenario written in two different ways. On the left side, the
-test is written using **MockMvc**, which is the traditional way to perform HTTP tests in Spring. On
-the right side, the same test is written using the **AAA-Mock** framework, which is an open-source
-testing framework designed to make the test code more readable and concise.
+### Test Code
 
-It is important to note that in both examples, the use of helper private methods has been
-intentionally avoided to keep the tests straightforward and focused on the core testing logic. This
-ensures clarity and helps demonstrate the difference between the two testing approaches.
+The following examples demonstrate the same test scenario written in two different ways. First, the
+test is implemented using MockMvc, the traditional approach for performing HTTP tests in Spring.
+This is followed by the same test written with AAAMockMvc.
 
-<table>
-  <tr>
-    <td>
+To keep the tests straightforward and focused on the core testing logic, the use of private helper
+methods has been intentionally avoided. This ensures clarity and helps highlight the differences
+between the two testing approaches.
 
-**Test with MockMvc**
+### Test with MockMvc
 
 ```java
 
@@ -441,24 +436,25 @@ private ObjectMapper objectMapper;
 
 @Test
 @SneakyThrows
-void GIVEN_registration_with_valid_verification_WHEN_createRegistration_THEN_return_status_201() {
+void GIVEN_valid_code_WHEN_registration_THEN_status_201() {
 
   var verificationRequest = VerificationRequest.builder()
       .firstname(FIRSTNAME)
       .lastname(LASTNAME)
       .mail(EMAIL)
       .build();
 
-  var verificationResponseJson = mockMvc.perform(
-          MockMvcRequestBuilders.post(POST_CREATE_VERIFICATION)
-              .contentType(MediaType.APPLICATION_JSON)
-              .content(objectMapper.writeValueAsString(verificationRequest)))
+  var content = MockMvcRequestBuilders.post(SEND_MAIL_VERIFICATION)
+      .contentType(MediaType.APPLICATION_JSON)
+      .content(objectMapper.writeValueAsString(verificationRequest));
+
+  var verificationResponseJson = mockMvc.perform(content)
       .andReturn()
       .getResponse()
       .getContentAsString();
 
-  var verificationResponse = objectMapper.readValue(verificationResponseJson,
-      VerificationResponse.class);
+  var verificationResponse = objectMapper.readValue(
+      verificationResponseJson, VerificationResponse.class);
 
   var registrationRequest = RegistrationRequest.builder()
       .verification(VerificationResponse.builder()
@@ -468,24 +464,22 @@ void GIVEN_registration_with_valid_verification_WHEN_createRegistration_THEN_ret
           .build())
       .build();
 
-  mockMvc.perform(MockMvcRequestBuilders.post(POST_CREATE_REGISTRATION)
-          .contentType(MediaType.APPLICATION_JSON)
-          .content(objectMapper.writeValueAsString(registrationRequest)))
-      .andExpect(status().isCreated());
+  content = MockMvcRequestBuilders.post(POST_CREATE_REGISTRATION)
+      .contentType(MediaType.APPLICATION_JSON)
+      .content(objectMapper.writeValueAsString(registrationRequest));
+
+  mockMvc.perform(content).andExpect(status().isCreated());
 }
 
 ```
 
-</td>
-    <td>
-
-**Test with AAA-MockMvc**
+### Test with AAAMockMvc
 
 ```java
 
 @Test
 @SneakyThrows
-void GIVEN_registration_with_valid_verification_WHEN_createRegistration_THEN_return_status_201() {
+void GIVEN_valid_code_WHEN_registration_THEN_status_201() {
 
   var verificationRequest = VerificationRequest.builder()
       .firstname(FIRSTNAME)
@@ -495,7 +489,7 @@ void GIVEN_registration_with_valid_verification_WHEN_createRegistration_THEN_ret
 
   var verificationResponse = post()
       .arrange()
-      .arrangeUrl(POST_CREATE_VERIFICATION)
+      .arrangeUrl(SEND_VERIFICATION)
       .arrangeBody()
       .arrangeJson(verificationRequest)
       .act()
@@ -514,7 +508,7 @@ void GIVEN_registration_with_valid_verification_WHEN_createRegistration_THEN_ret
 
   post()
       .arrange()
-      .arrangeUrl(POST_CREATE_REGISTRATION)
+      .arrangeUrl(CREATE_REGISTRATION)
       .arrangeBody()
       .arrangeJson(registrationRequest)
       .act()
@@ -526,10 +520,6 @@ void GIVEN_registration_with_valid_verification_WHEN_createRegistration_THEN_ret
 
 ```
 
-</td>
-  </tr>
-</table>
-
 ---
 
 ## License

images/aaa-mockmvc-example1.png

@@ -6,16 +6,17 @@
 
   <groupId>io.github.co-mmer</groupId>
   <artifactId>aaa-mockmvc</artifactId>
-  <version>1.4.1</version>
+  <version>1.4.2</version>
   <packaging>jar</packaging>
 
   <name>AAA-MockMvc</name>
-  <description>This project provides a framework for structuring unit tests following the AAA
-    (Arrange, Act, Assert) pattern with a focus on clarity and readability.
-    The library offers a fluent API that guides the developer through each phase,
-    ensuring that only contextually relevant methods are available at each step.
-    The key goal is to provide a clean separation of concerns within the test, allowing developers
-    to express their test logic fluently and naturally.
+  <description>
+    A fluent testing framework for Spring's MockMvc that enforces the Arrange-Act-Assert (AAA)
+    pattern and reduces boilerplate in controller tests.
+    The library guides developers through each testing phase with a strongly-typed,
+    step-by-step API, ensuring a consistent and intuitive test structure. Common tasks such as
+    request setup, ObjectMapper-based serialization, and response assertions are fully abstracted,
+    allowing developers to focus on the test logic itself rather than technical overhead.
   </description>
   <url>https://github.com/co-mmer/aaa-mockmvc</url>
 
@@ -45,7 +46,7 @@
   <parent>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-parent</artifactId>
-    <version>3.4.4</version>
+    <version>3.4.5</version>
     <relativePath/>
   </parent>
 
@@ -58,71 +59,21 @@
 
   <dependencies>
 
-    <!-- Lombok -->
     <dependency>
       <groupId>org.projectlombok</groupId>
       <artifactId>lombok</artifactId>
       <version>1.18.38</version>
       <scope>provided</scope>
     </dependency>
 
-    <!-- jakarta -->
-    <dependency>
-      <groupId>jakarta.servlet</groupId>
-      <artifactId>jakarta.servlet-api</artifactId>
-      <version>6.1.0</version>
-      <scope>provided</scope>
-    </dependency>
-
-    <!-- Spring -->
     <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-web</artifactId>
-      <scope>provided</scope>
-      <exclusions>
-        <exclusion>
-          <groupId>org.springframework.boot</groupId>
-          <artifactId>spring-boot-starter-logging</artifactId>
-        </exclusion>
-        <exclusion>
-          <groupId>com.fasterxml.jackson.module</groupId>
-          <artifactId>jackson-module-parameter-names</artifactId>
-        </exclusion>
-        <exclusion>
-          <groupId>com.fasterxml.jackson.datatype</groupId>
-          <artifactId>jackson-datatype-jsr310</artifactId>
-        </exclusion>
-        <exclusion>
-          <groupId>com.fasterxml.jackson.datatype</groupId>
-          <artifactId>jackson-datatype-jdk8</artifactId>
-        </exclusion>
-        <exclusion>
-          <groupId>org.yaml</groupId>
-          <artifactId>snakeyaml</artifactId>
-        </exclusion>
-        <exclusion>
-          <groupId>org.springframework.boot</groupId>
-          <artifactId>spring-boot-starter-tomcat</artifactId>
-        </exclusion>
-        <exclusion>
-          <groupId>org.apache.tomcat.embed</groupId>
-          <artifactId>tomcat-embed-el</artifactId>
-        </exclusion>
-        <exclusion>
-          <groupId>org.apache.tomcat.embed</groupId>
-          <artifactId>tomcat-embed-websocket</artifactId>
-        </exclusion>
-        <exclusion>
-          <groupId>ch.qos.logback</groupId>
-          <artifactId>logback-classic</artifactId>
-        </exclusion>
-      </exclusions>
     </dependency>
 
     <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-test</artifactId>
-      <scope>provided</scope>
       <exclusions>
         <exclusion>
           <groupId>org.xmlunit</groupId>