test: Set up test containers and add the first integration as well as unit tests #9

Author: Miguel7373

.github/workflows/backend-test-action.yaml

@@ -0,0 +1,20 @@
+name: 'Backend tests'
+
+on: [push]
+jobs:
+  backend-tests:
+    runs-on: ubuntu-24.04
+    env:
+      TZ: 'Europe/Zurich'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Set up JDK ${{vars.JAVA_VERSION}}
+        uses: actions/setup-java@v4
+        with:
+          java-version: ${{vars.JAVA_VERSION}}
+          distribution: 'adopt'
+
+      - name: Use Maven to run unittests and integration tests
+        run: mvn clean verify

backend/pom.xml

@@ -61,6 +61,19 @@
 					 <version>2.8.9</version>
 				</dependency>
 
+      <dependency>
+          <groupId>org.testcontainers</groupId>
+          <artifactId>junit-jupiter</artifactId>
+          <version>1.19.8</version>
+          <scope>test</scope>
+      </dependency>
+      <dependency>
+          <groupId>org.testcontainers</groupId>
+          <artifactId>postgresql</artifactId>
+          <version>1.19.8</version>
+          <scope>test</scope>
+      </dependency>
+
     <!-- Dev Tools   -->
     <dependency>
       <groupId>org.springframework.boot</groupId>
@@ -85,6 +98,16 @@
       <artifactId>spring-security-test</artifactId>
       <scope>test</scope>
     </dependency>
+      <dependency>
+          <groupId>junit</groupId>
+          <artifactId>junit</artifactId>
+          <version>4.13.2</version>
+      </dependency>
+      <dependency>
+          <groupId>junit</groupId>
+          <artifactId>junit</artifactId>
+          <scope>test</scope>
+      </dependency>
   </dependencies>
   <build>
     <plugins>
@@ -127,6 +150,11 @@
           </java>
         </configuration>
       </plugin>
+        <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-surefire-plugin</artifactId>
+            <version>3.5.3</version>
+      </plugin>
     </plugins>
   </build>
 

backend/src/main/java/ch/puzzle/pcts/controller/ExampleController.java

@@ -3,7 +3,7 @@
 import ch.puzzle.pcts.dto.example.ExampleDto;
 import ch.puzzle.pcts.mapper.ExampleMapper;
 import ch.puzzle.pcts.model.example.Example;
-import ch.puzzle.pcts.service.business.ExampleService;
+import ch.puzzle.pcts.service.business.ExampleBusinessService;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.media.Content;
 import io.swagger.v3.oas.annotations.media.Schema;
@@ -24,10 +24,10 @@
 @RequestMapping("/api/v1/examples")
 public class ExampleController {
     private final ExampleMapper mapper;
-    private final ExampleService service;
+    private final ExampleBusinessService service;
 
     @Autowired
-    public ExampleController(ExampleMapper mapper, ExampleService service) {
+    public ExampleController(ExampleMapper mapper, ExampleBusinessService service) {
         this.mapper = mapper;
         this.service = service;
     }

…cts/service/business/ExampleService.java …ice/business/ExampleBusinessService.javabackend/src/main/java/ch/puzzle/pcts/service/business/ExampleService.java renamed to backend/src/main/java/ch/puzzle/pcts/service/business/ExampleBusinessService.java backend/src/main/java/ch/puzzle/pcts/service/business/ExampleService.java renamed to backend/src/main/java/ch/puzzle/pcts/service/business/ExampleBusinessService.java

@@ -8,11 +8,12 @@
 import org.springframework.stereotype.Service;
 
 @Service
-public class ExampleService {
+public class ExampleBusinessService {
     private final ExampleValidationService validationService;
     private final ExamplePersistenceService persistenceService;
 
-    public ExampleService(ExampleValidationService validationService, ExamplePersistenceService persistenceService) {
+    public ExampleBusinessService(ExampleValidationService validationService,
+                                  ExamplePersistenceService persistenceService) {
         this.validationService = validationService;
         this.persistenceService = persistenceService;
     }

backend/src/main/resources/db/test-data-migration/V0_0_2__initialData.sql

@@ -3,10 +3,7 @@ TRUNCATE TABLE example CASCADE;
 
 INSERT INTO example (id, text)
 VALUES (1, 'Example 1'),
-       (2, 'Example 2'),
-       (3, 'Example 3'),
-       (4, 'Example 4'),
-       (5, 'Example 5');
+       (2, 'Example 2');
 
 SELECT setval('sequence_example', (SELECT MAX(id) FROM example));
 

backend/src/test/java/ch/puzzle/pcts/controller/ExampleControllerTest.java

@@ -0,0 +1,26 @@
+package ch.puzzle.pcts.controller;
+
+import ch.puzzle.pcts.mapper.ExampleMapper;
+import ch.puzzle.pcts.service.business.ExampleBusinessService;
+import org.junit.jupiter.api.BeforeEach;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+
+class ExampleControllerTest {
+
+    @Mock
+    private ExampleMapper mapper;
+
+    @Mock
+    private ExampleBusinessService service;
+
+    @InjectMocks
+    private ExampleController controller;
+
+    @BeforeEach
+    void setup() {
+        MockitoAnnotations.openMocks(this);
+    }
+
+}

backend/src/test/java/ch/puzzle/pcts/service/business/ExampleBusinessServiceTest.java

@@ -0,0 +1,65 @@
+package ch.puzzle.pcts.service.business;
+
+import static org.junit.jupiter.api.Assertions.*;
+import static org.mockito.Mockito.*;
+
+import ch.puzzle.pcts.model.example.Example;
+import ch.puzzle.pcts.service.persistence.ExamplePersistenceService;
+import ch.puzzle.pcts.service.validation.ExampleValidationService;
+import java.util.List;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+
+class ExampleBusinessServiceTest {
+
+    @Mock
+    private ExampleValidationService validationService;
+
+    @Mock
+    private ExamplePersistenceService persistenceService;
+
+    @InjectMocks
+    private ExampleBusinessService businessService;
+
+    @BeforeEach
+    void setUp() {
+        MockitoAnnotations.openMocks(this);
+    }
+
+    @Test
+    void testGetById() {
+        Example example = new Example(1L, "Example1");
+        when(persistenceService.getById(1L)).thenReturn(example);
+
+        Example result = businessService.getById(1L);
+
+        assertEquals(example, result);
+        verify(persistenceService).getById(1L);
+    }
+
+    @Test
+    void testGetAll() {
+        List<Example> examples = List.of(new Example(1L, "Example1"), new Example(2L, "Example2"));
+        when(persistenceService.getAll()).thenReturn(examples);
+
+        List<Example> result = businessService.getAll();
+
+        assertEquals(2, result.size());
+        verify(persistenceService).getAll();
+    }
+
+    @Test
+    void testCreate() {
+        Example example = new Example(1L, "Example1");
+        when(persistenceService.create(example)).thenReturn(example);
+
+        Example result = businessService.create(example);
+
+        assertEquals(example, result);
+        verify(validationService).validateOnCreate(example);
+        verify(persistenceService).create(example);
+    }
+}

backend/src/test/java/ch/puzzle/pcts/service/persistence/ExamplePersistenceServiceIT.java

@@ -0,0 +1,49 @@
+package ch.puzzle.pcts.service.persistence;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import ch.puzzle.pcts.model.example.Example;
+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.test.context.ActiveProfiles;
+import org.springframework.test.context.DynamicPropertyRegistry;
+import org.springframework.test.context.DynamicPropertySource;
+import org.testcontainers.containers.PostgreSQLContainer;
+import org.testcontainers.junit.jupiter.Container;
+import org.testcontainers.junit.jupiter.Testcontainers;
+
+@SpringBootTest
+@Testcontainers
+@ActiveProfiles("test")
+class ExamplePersistenceServiceIT {
+
+    @Container
+    static PostgreSQLContainer<?> postgres = new PostgreSQLContainer<>("postgres:16-alpine");
+
+    @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);
+    }
+
+    @Autowired
+    private ExamplePersistenceService persistenceService;
+
+    @Test
+    void connectionEstablished() {
+        assertThat(postgres.isRunning()).isTrue();
+    }
+
+    @Test
+    void testGetAll() {
+        // when
+        List<Example> all = persistenceService.getAll();
+
+        // then
+        assertThat(all).hasSize(2);
+        assertThat(all).extracting(Example::getText).containsExactlyInAnyOrder("Example 1", "Example 2");
+    }
+}