Add TestContainers sample for Doma Spring Boot

doma-spring-boot-samples/doma-spring-boot-sample-testcontainers/README.md

@@ -0,0 +1,32 @@
+# Doma Spring Boot Sample with TestContainers
+
+This sample demonstrates how to use [TestContainers](https://www.testcontainers.org/) with Doma and Spring Boot.
+
+## Running the Sample
+
+To run this sample, you need:
+- Java 17 or later
+- Maven
+- Docker (for running TestContainers)
+
+### Build and Run Tests
+
+```bash
+./mvnw clean test
+```
+
+### Run with TestContainers
+
+```bash
+./mvnw spring-boot:test-run
+```
+
+This will start the application with a PostgreSQL container.
+
+## Features Demonstrated
+
+- Using TestContainers to start a PostgreSQL database for tests
+- Spring Boot's native TestContainers integration with `@ServiceConnection`
+- Using TestContainers at development time with `SpringApplication.from()`
+- Running Doma queries against a real PostgreSQL database in tests
+- Configuration for both development (H2) and test (PostgreSQL) environments

doma-spring-boot-samples/doma-spring-boot-sample-testcontainers/pom.xml

@@ -0,0 +1,99 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>doma-spring-boot-sample-testcontainers</artifactId>
+    <packaging>jar</packaging>
+
+    <name>doma-spring-boot-sample-testcontainers</name>
+    <description>Demo project for Spring Boot with Doma and TestContainers</description>
+
+    <parent>
+        <groupId>org.seasar.doma.boot</groupId>
+        <artifactId>doma-spring-boot-samples</artifactId>
+        <version>2.5.0-SNAPSHOT</version>
+        <relativePath>../pom.xml</relativePath>
+    </parent>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.seasar.doma</groupId>
+            <artifactId>doma-core</artifactId>
+            <version>${doma.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.seasar.doma</groupId>
+            <artifactId>doma-processor</artifactId>
+            <version>${doma.version}</version>
+            <optional>true</optional>
+        </dependency>
+        <dependency>
+            <groupId>org.seasar.doma.boot</groupId>
+            <artifactId>doma-spring-boot-starter</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+        </dependency>
+        <!-- PostgreSQL Driver -->
+        <dependency>
+            <groupId>org.postgresql</groupId>
+            <artifactId>postgresql</artifactId>
+            <scope>runtime</scope>
+        </dependency>
+        <!-- H2 for local development -->
+        <dependency>
+            <groupId>com.h2database</groupId>
+            <artifactId>h2</artifactId>
+            <scope>runtime</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <!-- TestContainers dependencies -->
+        <dependency>
+            <groupId>org.testcontainers</groupId>
+            <artifactId>testcontainers</artifactId>
+            <version>1.19.7</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.testcontainers</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <version>1.19.7</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.testcontainers</groupId>
+            <artifactId>postgresql</artifactId>
+            <version>1.19.7</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-testcontainers</artifactId>
+            <scope>test</scope>
+            <version>${spring-boot.version}</version>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.springframework.boot</groupId>
+                <artifactId>spring-boot-maven-plugin</artifactId>
+                <version>${spring-boot.version}</version>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>

doma-spring-boot-samples/doma-spring-boot-sample-testcontainers/src/main/java/org/seasar/doma/boot/sample/Application.java

@@ -0,0 +1,13 @@
+package org.seasar.doma.boot.sample;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class Application {
+
+	@SuppressWarnings("resource")
+	public static void main(String[] args) {
+		SpringApplication.run(Application.class, args);
+	}
+}

doma-spring-boot-samples/doma-spring-boot-sample-testcontainers/src/main/java/org/seasar/doma/boot/sample/Message.java

@@ -0,0 +1,13 @@
+package org.seasar.doma.boot.sample;
+
+import org.seasar.doma.*;
+
+@Entity
+@Table(name = "messages")
+public class Message {
+	@Id
+	@GeneratedValue(strategy = GenerationType.IDENTITY)
+	public Integer id;
+
+	public String text;
+}

doma-spring-boot-samples/doma-spring-boot-sample-testcontainers/src/main/java/org/seasar/doma/boot/sample/MessageController.java

@@ -0,0 +1,35 @@
+package org.seasar.doma.boot.sample;
+
+import java.util.List;
+
+import org.seasar.doma.boot.Pageables;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.web.PageableDefault;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/")
+public class MessageController {
+
+	private final MessageDao messageDao;
+
+	public MessageController(MessageDao messageDao) {
+		this.messageDao = messageDao;
+	}
+
+	@GetMapping
+	List<Message> list(@PageableDefault Pageable pageable) {
+		return messageDao.selectAll(Pageables.toSelectOptions(pageable));
+	}
+
+	@GetMapping(params = "text")
+	Message add(@RequestParam String text) {
+		Message message = new Message();
+		message.text = text;
+		messageDao.insert(message);
+		return message;
+	}
+}

doma-spring-boot-samples/doma-spring-boot-sample-testcontainers/src/main/java/org/seasar/doma/boot/sample/MessageDao.java

@@ -0,0 +1,21 @@
+package org.seasar.doma.boot.sample;
+
+import java.util.List;
+
+import org.seasar.doma.Dao;
+import org.seasar.doma.Insert;
+import org.seasar.doma.Select;
+import org.seasar.doma.boot.ConfigAutowireable;
+import org.seasar.doma.jdbc.SelectOptions;
+import org.springframework.transaction.annotation.Transactional;
+
+@Dao
+@ConfigAutowireable
+@Transactional
+public interface MessageDao {
+	@Select
+	List<Message> selectAll(SelectOptions options);
+
+	@Insert
+	int insert(Message message);
+}

doma-spring-boot-samples/doma-spring-boot-sample-testcontainers/src/main/resources/META-INF/org/seasar/doma/boot/sample/MessageDao/selectAll.sql

@@ -0,0 +1 @@
+SELECT id, text FROM messages ORDER BY id;

doma-spring-boot-samples/doma-spring-boot-sample-testcontainers/src/main/resources/application.properties

@@ -0,0 +1,11 @@
+# Development configuration using H2
+spring.datasource.url=jdbc:h2:mem:testdb;DB_CLOSE_DELAY=-1
+spring.datasource.driver-class-name=org.h2.Driver
+spring.datasource.username=sa
+spring.datasource.password=
+spring.sql.init.mode=always
+
+# Doma configuration
+doma.dialect=H2
+doma.naming=SNAKE_LOWER_CASE
+logging.level.org.springframework.jdbc.datasource.DataSourceTransactionManager=DEBUG

doma-spring-boot-samples/doma-spring-boot-sample-testcontainers/src/main/resources/schema.sql

@@ -0,0 +1,4 @@
+CREATE TABLE IF NOT EXISTS messages (
+  id SERIAL PRIMARY KEY,
+  text VARCHAR(255)
+);

doma-spring-boot-samples/doma-spring-boot-sample-testcontainers/src/test/java/org/seasar/doma/boot/sample/ApplicationTest.java

@@ -0,0 +1,84 @@
+package org.seasar.doma.boot.sample;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+import java.util.List;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
+import org.springframework.boot.test.web.client.TestRestTemplate;
+import org.springframework.boot.test.web.server.LocalServerPort;
+import org.springframework.core.ParameterizedTypeReference;
+import org.springframework.http.HttpEntity;
+import org.springframework.http.HttpMethod;
+import org.springframework.test.context.DynamicPropertyRegistry;
+import org.springframework.test.context.DynamicPropertySource;
+import org.springframework.web.util.UriComponentsBuilder;
+import org.testcontainers.containers.PostgreSQLContainer;
+import org.testcontainers.junit.jupiter.Container;
+import org.testcontainers.junit.jupiter.Testcontainers;
+
+@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
+@Testcontainers
+class ApplicationTest {
+	@Autowired
+	private TestRestTemplate restTemplate;
+	private final ParameterizedTypeReference<List<Message>> typedReference = new ParameterizedTypeReference<List<Message>>() {
+	};
+	@LocalServerPort
+	private int port;
+
+	@Container
+	static PostgreSQLContainer<?> postgres = new PostgreSQLContainer<>("postgres:15");
+
+	@DynamicPropertySource
+	static void configureProperties(DynamicPropertyRegistry registry) {
+		registry.add("spring.datasource.url", postgres::getJdbcUrl);
+		registry.add("spring.datasource.username", postgres::getUsername);
+		registry.add("spring.datasource.password", postgres::getPassword);
+		registry.add("doma.dialect", () -> "POSTGRES");
+	}
+
+	@Test
+	void testWithTestContainers() {
+		Message message1 = restTemplate.getForObject(
+				UriComponentsBuilder.fromUriString("http://localhost").port(port)
+						.queryParam("text", "hello").build().toUri(),
+				Message.class);
+		assertEquals(1, message1.id);
+		assertEquals("hello", message1.text);
+		Message message2 = restTemplate.getForObject(
+				UriComponentsBuilder.fromUriString("http://localhost").port(port)
+						.queryParam("text", "world").build().toUri(),
+				Message.class);
+		assertEquals(2, message2.id);
+		assertEquals("world", message2.text);
+
+		{
+			List<Message> messages = restTemplate.exchange(
+					UriComponentsBuilder.fromUriString("http://localhost").port(port)
+							.build().toUri(),
+					HttpMethod.GET, HttpEntity.EMPTY,
+					typedReference).getBody();
+			assertEquals(2, messages.size());
+			assertEquals(message1.id, messages.get(0).id);
+			assertEquals(message1.text, messages.get(0).text);
+			assertEquals(message2.id, messages.get(1).id);
+			assertEquals(message2.text, messages.get(1).text);
+		}
+
+		{
+			List<Message> messages = restTemplate.exchange(
+					UriComponentsBuilder.fromUriString("http://localhost").port(port)
+							.queryParam("page", "1").queryParam("size", "1").build()
+							.toUri(),
+					HttpMethod.GET, HttpEntity.EMPTY, typedReference)
+					.getBody();
+			assertEquals(1, messages.size());
+			assertEquals(message2.id, messages.get(0).id);
+			assertEquals(message2.text, messages.get(0).text);
+		}
+	}
+}

doma-spring-boot-samples/doma-spring-boot-sample-testcontainers/src/test/java/org/seasar/doma/boot/sample/TestApplication.java

@@ -0,0 +1,12 @@
+package org.seasar.doma.boot.sample;
+
+import org.springframework.boot.SpringApplication;
+
+public class TestApplication {
+
+	public static void main(String[] args) {
+		SpringApplication.from(Application::main)
+			.with(TestContainersConfig.class)
+			.run(args);
+	}
+}

doma-spring-boot-samples/doma-spring-boot-sample-testcontainers/src/test/java/org/seasar/doma/boot/sample/TestContainersConfig.java

@@ -0,0 +1,20 @@
+package org.seasar.doma.boot.sample;
+
+import org.springframework.boot.test.context.TestConfiguration;
+import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
+import org.springframework.context.annotation.Bean;
+import org.testcontainers.containers.PostgreSQLContainer;
+import org.testcontainers.utility.DockerImageName;
+
+@TestConfiguration(proxyBeanMethods = false)
+public class TestContainersConfig {
+
+	@Bean
+	@ServiceConnection
+	public PostgreSQLContainer<?> postgresContainer() {
+		return new PostgreSQLContainer<>(DockerImageName.parse("postgres:15"))
+				.withDatabaseName("testdb")
+				.withUsername("test")
+				.withPassword("test");
+	}
+}

doma-spring-boot-samples/doma-spring-boot-sample-testcontainers/src/test/resources/application-test.properties

@@ -0,0 +1,2 @@
+# Test configuration for PostgreSQL
+spring.sql.init.mode=always

doma-spring-boot-samples/pom.xml

@@ -20,6 +20,7 @@
         <module>doma-spring-boot-sample-event-handler</module>
         <module>doma-spring-boot-sample-two-datasource</module>
         <module>doma-spring-boot-sample-unified-criteria</module>
+        <module>doma-spring-boot-sample-testcontainers</module>
     </modules>
 
     <properties>