BAEL 8160 - How to tear down / empty database after test in HSQL? (#17786)

* update parent-boot-2 properties

* add HSQL DB version

* Update pom.xml

* add HSQL DB Dependency

* Create application-hsql.properties

* Add application properties of HSQL DB

* Create DbteardownApplication.java

* Create Customer.java

* create customer Entity

* Create CustomerRepository.java

* Create CustomerController.java

* Create JdbcTemplateLiveTest.java

* Add a teardown method which use JdbcTemplate class

* Create JdbcTestUtilsLiveTest.java

* add tear down method which use JdbcTestUtility Class

* Create PropertiesLiveTest.java

* add a tear down method which use Properties configuration

* Create SqlScriptLiveTest

* add a tear down method which use sql script
* add a cleanup.sql

* Create TransactionalLiveTest.java

* add a tear down method which use Transaction

* renamed test method names

* Update application-hsql.properties

* Refactor tests to use repository instead of MVC, add @DirtiesContext to isolate side effects

* Switched from MockMvc to repository-based tests to streamline test execution and focus on database operations.
* Added @DirtiesContext annotation to ensure test isolation and prevent unintended side effects between tests.

* Full test isolation

Author: shyakadev

parent-boot-2/pom.xml

@@ -109,6 +109,7 @@
         <mysql-connector-java.version>8.2.0</mysql-connector-java.version>
         <org.slf4j.version>1.7.32</org.slf4j.version>
         <logback.version>1.2.7</logback.version>
+        <hsqldb.version>2.7.1</hsqldb.version>
     </properties>
 
 </project>

testing-modules/spring-testing-2/pom.xml

@@ -50,6 +50,12 @@
             <artifactId>byte-buddy</artifactId>
             <version>${byte-buddy.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.hsqldb</groupId>
+            <artifactId>hsqldb</artifactId>
+            <version>${hsqldb.version}</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <build>

testing-modules/spring-testing-2/src/main/java/com/baeldung/dbteardown/Customer.java

@@ -0,0 +1,58 @@
+package com.baeldung.dbteardown;
+
+import javax.persistence.Entity;
+import javax.persistence.GeneratedValue;
+import javax.persistence.GenerationType;
+import javax.persistence.Id;
+import javax.persistence.Table;
+
+@Entity
+@Table(name = "customers")
+public class Customer {
+
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    private long id;
+
+    private String name;
+
+    private String email;
+
+    public Customer() {
+
+    }
+
+    public Customer(String name, String email) {
+        this.name = name;
+        this.email = email;
+    }
+
+    public void setId(long id) {
+        this.id = id;
+    }
+
+    public long getId() {
+        return id;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setEmail(String email) {
+        this.email = email;
+    }
+
+    public String getEmail() {
+        return email;
+    }
+
+    @Override
+    public String toString() {
+        return "Customer{" + "id=" + id + ", name=" + name + ", email=" + email + '}';
+    }
+}

testing-modules/spring-testing-2/src/main/java/com/baeldung/dbteardown/CustomerRepository.java

@@ -0,0 +1,12 @@
+package com.baeldung.dbteardown;
+
+import java.util.Optional;
+
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.stereotype.Repository;
+
+@Repository
+public interface CustomerRepository extends JpaRepository<Customer, Long> {
+
+    Optional<Customer> findByName(String name);
+}

testing-modules/spring-testing-2/src/main/java/com/baeldung/dbteardown/DbteardownApplication.java

@@ -0,0 +1,12 @@
+package com.baeldung.dbteardown;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class DbteardownApplication {
+
+    public static void main(String[] args) {
+        SpringApplication.run(DbteardownApplication.class, args);
+    }
+}

testing-modules/spring-testing-2/src/test/java/com/baeldung/dbteardown/JdbcTemplateIntegrationTest.java

@@ -0,0 +1,62 @@
+package com.baeldung.dbteardown;
+
+import java.util.Optional;
+
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.jdbc.core.JdbcTemplate;
+import org.springframework.test.annotation.DirtiesContext;
+import org.springframework.test.context.ActiveProfiles;
+
+@SpringBootTest
+@ActiveProfiles("hsql")
+@DirtiesContext
+class JdbcTemplateIntegrationTest {
+
+    @Autowired
+    private CustomerRepository customerRepository;
+
+    @Autowired
+    private JdbcTemplate jdbcTemplate;
+
+    @BeforeEach
+    void setUp() {
+        String insertSql = "INSERT INTO customers (name, email) VALUES (?, ?)";
+        Customer customer = new Customer("John", "[email protected]");
+        jdbcTemplate.update(insertSql, customer.getName(), customer.getEmail());
+    }
+
+    @AfterEach
+    void tearDown() {
+        this.jdbcTemplate.execute("TRUNCATE TABLE customers");
+    }
+
+    @Test
+    void givenCustomer_whenSaved_thenReturnSameCustomer() throws Exception {
+        Customer customer = new Customer("Doe", "[email protected]");
+
+        Customer savedCustomer = customerRepository.save(customer);
+
+        Assertions.assertEquals(customer, savedCustomer);
+    }
+
+    @Test
+    void givenExistingCustomer_whenFoundByName_thenReturnCustomer() throws Exception {
+        Optional<Customer> customer = customerRepository.findByName("John");
+
+        Assertions.assertTrue(customer.isPresent(), "Customer should be present");
+        Assertions.assertEquals("John", customer.get()
+            .getName(), "Customer name should match");
+    }
+
+    @Test
+    void givenNonExistingCustomer_whenFoundByName_thenReturnNull() throws Exception {
+        Optional<Customer> customer = customerRepository.findByName("Doe");
+
+        Assertions.assertFalse(customer.isPresent(), "Customer should not be found");
+    }
+}

testing-modules/spring-testing-2/src/test/java/com/baeldung/dbteardown/JdbcTestUtilsIntegrationTest.java

@@ -0,0 +1,63 @@
+package com.baeldung.dbteardown;
+
+import java.util.Optional;
+
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.jdbc.core.JdbcTemplate;
+import org.springframework.test.annotation.DirtiesContext;
+import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.jdbc.JdbcTestUtils;
+
+@SpringBootTest
+@ActiveProfiles("hsql")
+@DirtiesContext
+public class JdbcTestUtilsIntegrationTest {
+
+    @Autowired
+    private CustomerRepository customerRepository;
+
+    @Autowired
+    private JdbcTemplate jdbcTemplate;
+
+    @BeforeEach
+    void setUp() {
+        String insertSql = "INSERT INTO customers (name, email) VALUES (?, ?)";
+        Customer customer = new Customer("John", "[email protected]");
+        jdbcTemplate.update(insertSql, customer.getName(), customer.getEmail());
+    }
+
+    @AfterEach
+    void tearDown() {
+        JdbcTestUtils.deleteFromTables(jdbcTemplate, "customers");
+    }
+
+    @Test
+    void givenCustomer_whenSaved_thenReturnSameCustomer() throws Exception {
+        Customer customer = new Customer("Doe", "[email protected]");
+
+        Customer savedCustomer = customerRepository.save(customer);
+
+        Assertions.assertEquals(customer, savedCustomer);
+    }
+
+    @Test
+    void givenExistingCustomer_whenFoundByName_thenReturnCustomer() throws Exception {
+        Optional<Customer> customer = customerRepository.findByName("John");
+
+        Assertions.assertTrue(customer.isPresent(), "Customer should be present");
+        Assertions.assertEquals("John", customer.get()
+            .getName(), "Customer name should match");
+    }
+
+    @Test
+    void givenNonExistingCustomer_whenFoundByName_thenReturnNull() throws Exception {
+        Optional<Customer> customer = customerRepository.findByName("Doe");
+
+        Assertions.assertFalse(customer.isPresent(), "Customer should not be found");
+    }
+}

testing-modules/spring-testing-2/src/test/java/com/baeldung/dbteardown/PropertiesIntegrationTest.java

@@ -0,0 +1,60 @@
+package com.baeldung.dbteardown;
+
+import java.util.Optional;
+
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.jdbc.core.JdbcTemplate;
+import org.springframework.test.annotation.DirtiesContext;
+import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.context.TestPropertySource;
+
+@SpringBootTest
+@ActiveProfiles("hsql")
+@TestPropertySource(properties = { "spring.jpa.hibernate.ddl-auto=create-drop" })
+public class PropertiesIntegrationTest {
+
+    @Autowired
+    private CustomerRepository customerRepository;
+
+    @Autowired
+    private JdbcTemplate jdbcTemplate;
+
+    @BeforeEach
+    void setUp() {
+        String insertSql = "INSERT INTO customers (name, email) VALUES (?, ?)";
+        Customer customer = new Customer("John", "[email protected]");
+        jdbcTemplate.update(insertSql, customer.getName(), customer.getEmail());
+    }
+
+    @Test
+    @DirtiesContext
+    void givenCustomer_whenSaved_thenReturnSameCustomer() throws Exception {
+        Customer customer = new Customer("Doe", "[email protected]");
+
+        Customer savedCustomer = customerRepository.save(customer);
+
+        Assertions.assertEquals(customer, savedCustomer);
+    }
+
+    @Test
+    @DirtiesContext
+    void givenExistingCustomer_whenFoundByName_thenReturnCustomer() throws Exception {
+        Optional<Customer> customer = customerRepository.findByName("John");
+
+        Assertions.assertTrue(customer.isPresent(), "Customer should be present");
+        Assertions.assertEquals("John", customer.get()
+            .getName(), "Customer name should match");
+    }
+
+    @Test
+    @DirtiesContext
+    void givenNonExistingCustomer_whenFoundByName_thenReturnNull() throws Exception {
+        Optional<Customer> customer = customerRepository.findByName("Doe");
+
+        Assertions.assertFalse(customer.isPresent(), "Customer should not be found");
+    }
+}

testing-modules/spring-testing-2/src/test/java/com/baeldung/dbteardown/SqlScriptIntegrationTest.java

@@ -0,0 +1,58 @@
+package com.baeldung.dbteardown;
+
+import java.util.Optional;
+
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.jdbc.core.JdbcTemplate;
+import org.springframework.test.annotation.DirtiesContext;
+import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.context.jdbc.Sql;
+
+@SpringBootTest
+@ActiveProfiles("hsql")
+@DirtiesContext
+@Sql(scripts = "/cleanup.sql", executionPhase = Sql.ExecutionPhase.AFTER_TEST_METHOD)
+public class SqlScriptIntegrationTest {
+
+    @Autowired
+    private CustomerRepository customerRepository;
+
+    @Autowired
+    private JdbcTemplate jdbcTemplate;
+
+    @BeforeEach
+    void setUp() {
+        String insertSql = "INSERT INTO customers (name, email) VALUES (?, ?)";
+        Customer customer = new Customer("John", "[email protected]");
+        jdbcTemplate.update(insertSql, customer.getName(), customer.getEmail());
+    }
+
+    @Test
+    void givenCustomer_whenSaved_thenReturnSameCustomer() throws Exception {
+        Customer customer = new Customer("Doe", "[email protected]");
+
+        Customer savedCustomer = customerRepository.save(customer);
+
+        Assertions.assertEquals(customer, savedCustomer);
+    }
+
+    @Test
+    void givenExistingCustomer_whenFoundByName_thenReturnCustomer() throws Exception {
+        Optional<Customer> customer = customerRepository.findByName("John");
+
+        Assertions.assertTrue(customer.isPresent(), "Customer should be present");
+        Assertions.assertEquals("John", customer.get()
+            .getName(), "Customer name should match");
+    }
+
+    @Test
+    void givenNonExistingCustomer_whenFoundByName_thenReturnNull() throws Exception {
+        Optional<Customer> customer = customerRepository.findByName("Doe");
+
+        Assertions.assertFalse(customer.isPresent(), "Customer should not be found");
+    }
+}