docs: Add more details in README.md file🫸🌀✏️📗🐧🐳

Author: hendisantika

README.md

@@ -1 +1,215 @@
-# spring-boot-test-container-postgresql
+# Spring Boot Test Container PostgreSQL
+
+A demonstration project showcasing the integration of Spring Boot with Testcontainers for PostgreSQL database testing.
+
+## Overview
+
+This project is a RESTful API for managing blog posts, built with Spring Boot and PostgreSQL. It demonstrates how to use
+Testcontainers for integration testing with a real PostgreSQL database.
+
+## Technologies Used
+
+- Java 21 (with preview features)
+- Spring Boot 3.5.0
+- Spring Data JDBC
+- Spring WebFlux (WebClient)
+- PostgreSQL
+- Testcontainers
+- Docker & Docker Compose
+- Maven
+- Springdoc OpenAPI
+
+## Prerequisites
+
+- Java 21 or higher
+- Docker and Docker Compose
+- Maven
+
+## Getting Started
+
+### Clone the Repository
+
+```bash
+git clone https://github.com/hendisantika/spring-boot-test-container-postgresql.git
+cd spring-boot-test-container-postgresql
+```
+
+### Build and Run
+
+You can run the application using Maven:
+
+```bash
+./mvnw spring-boot:run
+```
+
+Or build and run the JAR file:
+
+```bash
+./mvnw clean package
+java -jar target/test-container-postgresql-0.0.1-SNAPSHOT.jar
+```
+
+### Using Docker Compose
+
+The project includes a `compose.yaml` file for running the PostgreSQL database:
+
+```bash
+docker-compose up -d
+```
+
+## API Endpoints
+
+The application provides the following RESTful API endpoints:
+
+- `GET /api/posts` - Get all posts
+- `GET /api/posts/{id}` - Get a post by ID
+- `POST /api/posts` - Create a new post
+- `PUT /api/posts/{id}` - Update an existing post
+- `DELETE /api/posts/{id}` - Delete a post
+
+### API Documentation
+
+The API documentation is available via Springdoc OpenAPI at:
+
+```
+http://localhost:8080/swagger-ui.html
+```
+
+### Using cURL
+
+You can interact with the API using cURL commands:
+
+#### Get All Posts
+
+```bash
+curl -X GET http://localhost:8080/api/posts
+```
+
+#### Get Post by ID
+
+```bash
+curl -X GET http://localhost:8080/api/posts/1
+```
+
+#### Create a New Post
+
+```bash
+curl -X POST http://localhost:8080/api/posts \
+  -H "Content-Type: application/json" \
+  -d '{"userId": 1, "title": "New Post", "body": "This is a new post created with cURL"}'
+```
+
+#### Update a Post
+
+```bash
+curl -X PUT http://localhost:8080/api/posts/1 \
+  -H "Content-Type: application/json" \
+  -d '{"userId": 1, "title": "Updated Post", "body": "This post was updated with cURL"}'
+```
+
+#### Delete a Post
+
+```bash
+curl -X DELETE http://localhost:8080/api/posts/1
+```
+
+### HTTP Client
+
+The project includes a WebClient-based HTTP client for programmatic API access. The client is implemented in the
+`PostClient` class.
+
+#### Using the HTTP Client
+
+To use the HTTP client in your code:
+
+```java
+
+@Autowired
+private PostClient postClient;
+
+// Get all posts
+Flux<Post> posts = postClient.getAllPosts();
+
+// Get post by ID
+Mono<Post> post = postClient.getPostById(1);
+
+// Create a new post
+Post newPost = new Post(null, 1, "New Post", "This is a new post", null);
+Mono<Post> createdPost = postClient.createPost(newPost);
+
+// Update a post
+Post updatedPost = new Post(1, 1, "Updated Post", "This post was updated", null);
+Mono<Post> result = postClient.updatePost(1, updatedPost);
+
+// Delete a post
+Mono<Void> deleteResult = postClient.deletePost(1);
+```
+
+#### Running the Example Client
+
+The project includes an example client that demonstrates how to use the HTTP client. To run it:
+
+```bash
+./mvnw spring-boot:run -Dspring-boot.run.profiles=client-example
+```
+
+## Data Model
+
+The application uses a simple `Post` model with the following fields:
+
+- `id` (Integer) - Primary key
+- `userId` (Integer) - User ID associated with the post
+- `title` (String) - Post title (required)
+- `body` (String) - Post content (required)
+- `version` (Integer) - Version for optimistic locking
+
+## Testing
+
+The project demonstrates several testing approaches using Testcontainers:
+
+### Repository Tests
+
+Tests the repository layer with a real PostgreSQL database using Testcontainers.
+
+```bash
+./mvnw test -Dtest=PostRepositoryTest
+```
+
+### Controller Tests
+
+Tests the controller layer with a real PostgreSQL database using Testcontainers.
+
+```bash
+./mvnw test -Dtest=PostControllerTest
+```
+
+### Integration Tests
+
+Tests the entire application with a real PostgreSQL database using Testcontainers.
+
+```bash
+./mvnw test -Dtest=SpringBootTestContainerPostgresqlApplicationTests
+```
+
+## Project Structure
+
+- `src/main/java` - Java source code
+  - `controller` - REST controllers
+  - `model` - Data models
+  - `repository` - Data access layer
+  - `exception` - Custom exceptions
+- `src/main/resources` - Application resources
+  - `data/posts.json` - Initial data for the application
+  - `schema.sql` - Database schema definition
+- `src/test/java` - Test source code
+
+## License
+
+This project is open source and available under the [MIT License](LICENSE).
+
+## Author
+
+Hendi Santika
+
+- Email: [email protected]
+- Telegram: @hendisantika34

pom.xml

@@ -85,6 +85,10 @@
             <artifactId>spring-boot-starter-test</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-webflux</artifactId>
+        </dependency>
     </dependencies>
 
     <build>

src/main/java/id/my/hendisantika/testcontainerpostgresql/client/PostClient.java

@@ -0,0 +1,64 @@
+package id.my.hendisantika.testcontainerpostgresql.client;
+
+import id.my.hendisantika.testcontainerpostgresql.model.Post;
+import org.springframework.stereotype.Component;
+import org.springframework.web.reactive.function.client.WebClient;
+import reactor.core.publisher.Flux;
+import reactor.core.publisher.Mono;
+
+/**
+ * Created by IntelliJ IDEA.
+ * Project : spring-boot-test-container-postgresql
+ * User: hendisantika
+ * Email: [email protected]
+ * Telegram : @hendisantika34
+ * Date: 18/11/24
+ * Time: 08.30
+ * To change this template use File | Settings | File Templates.
+ */
+@Component
+public class PostClient {
+
+    private final WebClient webClient;
+
+    public PostClient(WebClient.Builder webClientBuilder) {
+        this.webClient = webClientBuilder.baseUrl("http://localhost:8080").build();
+    }
+
+    public Flux<Post> getAllPosts() {
+        return webClient.get()
+                .uri("/api/posts")
+                .retrieve()
+                .bodyToFlux(Post.class);
+    }
+
+    public Mono<Post> getPostById(Integer id) {
+        return webClient.get()
+                .uri("/api/posts/{id}", id)
+                .retrieve()
+                .bodyToMono(Post.class);
+    }
+
+    public Mono<Post> createPost(Post post) {
+        return webClient.post()
+                .uri("/api/posts")
+                .bodyValue(post)
+                .retrieve()
+                .bodyToMono(Post.class);
+    }
+
+    public Mono<Post> updatePost(Integer id, Post post) {
+        return webClient.put()
+                .uri("/api/posts/{id}", id)
+                .bodyValue(post)
+                .retrieve()
+                .bodyToMono(Post.class);
+    }
+
+    public Mono<Void> deletePost(Integer id) {
+        return webClient.delete()
+                .uri("/api/posts/{id}", id)
+                .retrieve()
+                .bodyToMono(Void.class);
+    }
+}

src/main/java/id/my/hendisantika/testcontainerpostgresql/client/PostClientExample.java

@@ -0,0 +1,68 @@
+package id.my.hendisantika.testcontainerpostgresql.client;
+
+import id.my.hendisantika.testcontainerpostgresql.model.Post;
+import org.springframework.boot.CommandLineRunner;
+import org.springframework.context.annotation.Profile;
+import org.springframework.stereotype.Component;
+
+/**
+ * Created by IntelliJ IDEA.
+ * Project : spring-boot-test-container-postgresql
+ * User: hendisantika
+ * Email: [email protected]
+ * Telegram : @hendisantika34
+ * Date: 18/11/24
+ * Time: 08.40
+ * To change this template use File | Settings | File Templates.
+ * <p>
+ * This class demonstrates how to use the PostClient.
+ * It's disabled by default (only runs with "client-example" profile).
+ * To run it, use: ./mvnw spring-boot:run -Dspring-boot.run.profiles=client-example
+ */
+@Component
+@Profile("client-example")
+public class PostClientExample implements CommandLineRunner {
+
+    private final PostClient postClient;
+
+    public PostClientExample(PostClient postClient) {
+        this.postClient = postClient;
+    }
+
+    @Override
+    public void run(String... args) {
+        System.out.println("Running PostClient example...");
+
+        // Get all posts
+        postClient.getAllPosts()
+                .collectList()
+                .doOnNext(posts -> System.out.println("Found " + posts.size() + " posts"))
+                .block();
+
+        // Get post by ID
+        Post post = postClient.getPostById(1)
+                .doOnNext(p -> System.out.println("Found post: " + p))
+                .block();
+
+        // Create a new post
+        if (post != null) {
+            Post newPost = new Post(null, post.userId(), "New Post Title", "New Post Body", null);
+            postClient.createPost(newPost)
+                    .doOnNext(p -> System.out.println("Created post: " + p))
+                    .block();
+        }
+
+        // Example of how to update a post
+        if (post != null) {
+            Post updatedPost = new Post(post.id(), post.userId(), "Updated Title", "Updated Body", post.version());
+            postClient.updatePost(post.id(), updatedPost)
+                    .doOnNext(p -> System.out.println("Updated post: " + p))
+                    .block();
+        }
+
+        // Example of how to delete a post (commented out to prevent actual deletion)
+        // postClient.deletePost(101).block();
+
+        System.out.println("PostClient example completed.");
+    }
+}

src/main/java/id/my/hendisantika/testcontainerpostgresql/config/WebClientConfig.java

@@ -0,0 +1,24 @@
+package id.my.hendisantika.testcontainerpostgresql.config;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.reactive.function.client.WebClient;
+
+/**
+ * Created by IntelliJ IDEA.
+ * Project : spring-boot-test-container-postgresql
+ * User: hendisantika
+ * Email: [email protected]
+ * Telegram : @hendisantika34
+ * Date: 18/11/24
+ * Time: 08.35
+ * To change this template use File | Settings | File Templates.
+ */
+@Configuration
+public class WebClientConfig {
+
+    @Bean
+    public WebClient.Builder webClientBuilder() {
+        return WebClient.builder();
+    }
+}