feat: add JPA and Flyway #30

nevio18324 · web-flow · commit 9e3e0552149f · 2025-08-26T13:21:29.000+02:00
* feat: add jpa #30 * docs(backend): write a readme on how to start the database #30 * chore: remove defined version #30 * chore: remove unnecassary dependency #30 * docs: add more structure to readme #30 * docs: write docs on how to start dev pcts #30 * refactor: move development properties to own file #30 * fix: replace long with Long so we can check if id is null or not #30 * feat: implement flyway and create migrations #30 * feat: create a test properties #30 * refactor: delete default spring test and format backend #30 * docs: make comment a todo #30 * refactor: clean up properties #30 * refactor: write sql statements in uppercase, move mapping from dto to entity into controller #30 * fix: hibernate generating an id already used by initial data #30 * refactor: change migration version to major version 0 #30 * refactor: change formatting and ids of default data and update docs #30
diff --git a/backend/README.md b/backend/README.md
@@ -1,6 +1,20 @@
 # PCTS Backend
 The backend of this project is written in Spring Boot.
 
+## Development
+### Dev-Database
+The database can be started via docker
+- cd into the root directory of the project
+- `cd docker`
+- Run `docker compose up`
+### Dev-Backend
+Make sure to set up the DB first
+#### Terminal
+You can start the backend via Terminal
+- cd to the project root
+- `cd backend`
+- `mvn spring-boot:run -Dspring-boot.run.arguments="--spring.profiles.active=dev"`
+
 ## Formatting
 We use the ***spotless*** Plugin for formatting the Java code:
 https://github.com/diffplug/spotless
diff --git a/backend/pom.xml b/backend/pom.xml
@@ -35,11 +35,31 @@
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-web</artifactId>
     </dependency>
-      <dependency>
-          <groupId>org.springdoc</groupId>
-          <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
-          <version>2.8.9</version>
-      </dependency>
+				<dependency>
+					 <groupId>org.postgresql</groupId>
+					 <artifactId>postgresql</artifactId>
+					 <scope>runtime</scope>
+				</dependency>
+				<dependency>
+					 <groupId>org.springframework.boot</groupId>
+					 <artifactId>spring-boot-starter-data-jpa</artifactId>
+				</dependency>
+				<dependency>
+					 <groupId>org.flywaydb</groupId>
+					 <artifactId>flyway-core</artifactId>
+					 <version>11.11.1</version>
+				</dependency>
+				<dependency>
+					 <groupId>org.flywaydb</groupId>
+					 <artifactId>flyway-database-postgresql</artifactId>
+					 <version>11.11.1</version>
+					 <scope>runtime</scope>
+				</dependency>
+    <dependency>
+					 <groupId>org.springdoc</groupId>
+					 <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
+					 <version>2.8.9</version>
+				</dependency>
 
     <!-- Dev Tools   -->
     <dependency>
@@ -66,7 +86,6 @@
       <scope>test</scope>
     </dependency>
   </dependencies>
-
   <build>
     <plugins>
       <plugin>
diff --git a/backend/src/main/java/ch/puzzle/pcts/controller/ExampleController.java b/backend/src/main/java/ch/puzzle/pcts/controller/ExampleController.java
@@ -1,6 +1,5 @@
 package ch.puzzle.pcts.controller;
 
-import ch.puzzle.pcts.dto.example.CreateExampleDto;
 import ch.puzzle.pcts.dto.example.ExampleDto;
 import ch.puzzle.pcts.mapper.ExampleMapper;
 import ch.puzzle.pcts.model.example.Example;
@@ -50,8 +49,8 @@ public ResponseEntity<ExampleDto> getExampleById(@PathVariable long id) {
     }
 
     @PostMapping
-    public ResponseEntity<ExampleDto> createNew(@Valid @RequestBody CreateExampleDto dto) {
-        Example newExample = service.create(dto);
+    public ResponseEntity<ExampleDto> createNew(@Valid @RequestBody ExampleDto dto) {
+        Example newExample = service.create(mapper.fromDto(dto));
         return ResponseEntity.ok(mapper.toDto(newExample));
     }
 }
diff --git a/backend/src/main/java/ch/puzzle/pcts/dto/example/CreateExampleDto.java b/backend/src/main/java/ch/puzzle/pcts/dto/example/CreateExampleDto.java
diff --git a/backend/src/main/java/ch/puzzle/pcts/dto/example/ExampleDto.java b/backend/src/main/java/ch/puzzle/pcts/dto/example/ExampleDto.java
@@ -1,4 +1,4 @@
 package ch.puzzle.pcts.dto.example;
 
-public record ExampleDto(long id, String text) {
+public record ExampleDto(Long id, String text) {
 }
diff --git a/backend/src/main/java/ch/puzzle/pcts/model/error/ErrorKey.java b/backend/src/main/java/ch/puzzle/pcts/model/error/ErrorKey.java
@@ -3,5 +3,6 @@
 public enum ErrorKey {
     VALIDATION,
     VALIDATION_DOES_NOT_INCLUDE,
-    INTERNAL
+    INTERNAL,
+    ID_IS_NOT_NULL
 }
diff --git a/backend/src/main/java/ch/puzzle/pcts/model/example/Example.java b/backend/src/main/java/ch/puzzle/pcts/model/example/Example.java
@@ -1,19 +1,29 @@
 package ch.puzzle.pcts.model.example;
 
+import jakarta.persistence.*;
+
+@Entity
 public class Example {
-    private long id;
+    @Id
+    @GeneratedValue(strategy = GenerationType.AUTO, generator = "sequence_example")
+    @SequenceGenerator(name = "sequence_example", allocationSize = 1)
+    private Long id;
+
     private String text;
 
-    public Example(long id, String text) {
+    public Example(Long id, String text) {
         this.id = id;
         this.text = text;
     }
 
-    public long getId() {
+    public Example() {
+    }
+
+    public Long getId() {
         return id;
     }
 
-    public void setId(long id) {
+    public void setId(Long id) {
         this.id = id;
     }
 
@@ -24,5 +34,4 @@ public String getText() {
     public void setText(String text) {
         this.text = text;
     }
-
 }
diff --git a/backend/src/main/java/ch/puzzle/pcts/repository/ExampleRepository.java b/backend/src/main/java/ch/puzzle/pcts/repository/ExampleRepository.java
@@ -1,33 +1,10 @@
 package ch.puzzle.pcts.repository;
 
-import ch.puzzle.pcts.dto.example.CreateExampleDto;
 import ch.puzzle.pcts.model.example.Example;
-import java.util.ArrayList;
-import java.util.List;
-import org.springframework.stereotype.Component;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.stereotype.Repository;
 
-// This should really be something like this:
-// @Repository
-// public interface ExampleRepository extends CrudRepository<> { ... }
-@Component
-public class ExampleRepository {
-    private List<Example> database = new ArrayList<>();
-
-    public ExampleRepository() {
-        this.database.add(new Example(1, "Some example"));
-        this.database.add(new Example(2, "Another one"));
-    }
-
-    public List<Example> getAll() {
-        return database;
-    }
-
-    public Example add(CreateExampleDto example) {
-        database.add(new Example(database.size() + 1, example.text()));
-        return database.getLast();
-    }
-
-    public Example getById(long id) {
-        return new Example(id, "This is example #" + id);
-    }
+@Repository
+public interface ExampleRepository extends JpaRepository<Example, Long> {
+    Example getById(long id);
 }
diff --git a/backend/src/main/java/ch/puzzle/pcts/service/business/ExampleService.java b/backend/src/main/java/ch/puzzle/pcts/service/business/ExampleService.java
@@ -1,9 +1,9 @@
 package ch.puzzle.pcts.service.business;
 
-import ch.puzzle.pcts.dto.example.CreateExampleDto;
 import ch.puzzle.pcts.model.example.Example;
 import ch.puzzle.pcts.service.persistence.ExamplePersistenceService;
 import ch.puzzle.pcts.service.validation.ExampleValidationService;
+import jakarta.transaction.Transactional;
 import java.util.List;
 import org.springframework.stereotype.Service;
 
@@ -25,8 +25,9 @@ public List<Example> getAll() {
         return persistenceService.getAll();
     }
 
-    public Example create(CreateExampleDto dto) {
-        validationService.validateOnCreate(dto);
-        return persistenceService.create(dto);
+    @Transactional
+    public Example create(Example example) {
+        validationService.validateOnCreate(example);
+        return persistenceService.create(example);
     }
 }
diff --git a/backend/src/main/java/ch/puzzle/pcts/service/persistence/ExamplePersistenceService.java b/backend/src/main/java/ch/puzzle/pcts/service/persistence/ExamplePersistenceService.java
@@ -1,6 +1,5 @@
 package ch.puzzle.pcts.service.persistence;
 
-import ch.puzzle.pcts.dto.example.CreateExampleDto;
 import ch.puzzle.pcts.model.example.Example;
 import ch.puzzle.pcts.repository.ExampleRepository;
 import java.util.List;
@@ -16,15 +15,15 @@ public ExamplePersistenceService(ExampleRepository repository) {
         this.repository = repository;
     }
 
-    public Example create(CreateExampleDto dto) {
-        return repository.add(dto);
+    public Example create(Example example) {
+        return repository.save(example);
     }
 
     public Example getById(long id) {
         return repository.getById(id);
     }
 
     public List<Example> getAll() {
-        return repository.getAll();
+        return repository.findAll();
     }
 }
diff --git a/backend/src/main/java/ch/puzzle/pcts/service/validation/ExampleValidationService.java b/backend/src/main/java/ch/puzzle/pcts/service/validation/ExampleValidationService.java
@@ -1,8 +1,8 @@
 package ch.puzzle.pcts.service.validation;
 
-import ch.puzzle.pcts.dto.example.CreateExampleDto;
 import ch.puzzle.pcts.exception.PCTSException;
 import ch.puzzle.pcts.model.error.ErrorKey;
+import ch.puzzle.pcts.model.example.Example;
 import ch.puzzle.pcts.service.persistence.ExamplePersistenceService;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
@@ -21,11 +21,14 @@ public ExampleValidationService(ExamplePersistenceService persistenceService) {
         this.persistenceService = persistenceService;
     }
 
-    public void validateOnCreate(CreateExampleDto dto) {
-        if (!dto.text().contains("Example")) {
+    public void validateOnCreate(Example example) {
+
+        if (!example.getText().contains("Example")) {
             throw new PCTSException(HttpStatus.BAD_REQUEST,
                                     "Text does need to include 'Example'",
                                     ErrorKey.VALIDATION_DOES_NOT_INCLUDE);
+        } else if (example.getId() != null) {
+            throw new PCTSException(HttpStatus.BAD_REQUEST, "Id needs to be undefined", ErrorKey.ID_IS_NOT_NULL);
         }
         // with the persistenceService, things like duplications and the like can also
         // be checked
diff --git a/backend/src/main/resources/application-dev.properties b/backend/src/main/resources/application-dev.properties
@@ -1 +1,12 @@
+spring.application.name=PCTS
+
+spring.datasource.url=jdbc:postgresql://localhost:5432/pcts
+spring.datasource.username=user
+spring.datasource.password=pwd
+spring.datasource.driver-class-name=org.postgresql.Driver
+
+#Flyway
+spring.flyway.locations=classpath:db/migration,classpath:db/dev-data-migration
+spring.flyway.schemas=public
+
 springdoc.api-docs.enabled=true
diff --git a/backend/src/main/resources/application-test.properties b/backend/src/main/resources/application-test.properties
@@ -0,0 +1,8 @@
+#Todo Should get filled out once test db exists
+#spring.datasource.url=
+#spring.datasource.username=
+#spring.datasource.password=
+#spring.datasource.driver-class-name=org.postgresql.Driver
+
+#Flyway
+spring.flyway.locations=classpath:db/migration,classpath:db/test-data-migration
diff --git a/backend/src/main/resources/application.properties b/backend/src/main/resources/application.properties
@@ -1,2 +1,9 @@
 spring.application.name=PCTS
+
+# Flyway
+spring.flyway.locations=classpath:db/migration
+
+# debug options
+logging.level.org.flywaydb.core=warn
+
 springdoc.api-docs.enabled=false
diff --git a/backend/src/main/resources/db/dev-data-migration/V0_0_2__initialData.sql b/backend/src/main/resources/db/dev-data-migration/V0_0_2__initialData.sql
@@ -0,0 +1,13 @@
+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');
+
+SELECT setval('sequence_example', (SELECT MAX(id) FROM example));
+
+
diff --git a/backend/src/main/resources/db/migration/V0_0_1__example.sql b/backend/src/main/resources/db/migration/V0_0_1__example.sql
@@ -0,0 +1,6 @@
+CREATE SEQUENCE IF NOT EXISTS sequence_example;
+CREATE TABLE IF NOT EXISTS example
+(
+    id       BIGINT NOT NUll PRIMARY KEY,
+    text     VARCHAR(250) NOT NULL
+);
diff --git a/backend/src/main/resources/db/test-data-migration/V0_0_2__initialData.sql b/backend/src/main/resources/db/test-data-migration/V0_0_2__initialData.sql
@@ -0,0 +1,13 @@
+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');
+
+SELECT setval('sequence_example', (SELECT MAX(id) FROM example));
+
+
diff --git a/backend/src/test/java/ch/puzzle/pcts/DemoApplicationTests.java b/backend/src/test/java/ch/puzzle/pcts/DemoApplicationTests.java
diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml
@@ -0,0 +1,11 @@
+services:
+  pcts-db:
+    container_name: ptcs-dev-db
+    image: postgres:17
+    restart: unless-stopped
+    environment:
+      POSTGRES_USER: user
+      POSTGRES_PASSWORD: pwd
+      POSTGRES_DB: pcts
+    ports:
+      - 5432:5432

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,5 @@`
`1`	`1`	`package ch.puzzle.pcts.controller;`
`2`	`2`
`3`		`-import ch.puzzle.pcts.dto.example.CreateExampleDto;`
`4`	`3`	`import ch.puzzle.pcts.dto.example.ExampleDto;`
`5`	`4`	`import ch.puzzle.pcts.mapper.ExampleMapper;`
`6`	`5`	`import ch.puzzle.pcts.model.example.Example;`
`@@ -50,8 +49,8 @@ public ResponseEntity<ExampleDto> getExampleById(@PathVariable long id) {`
`50`	`49`	`}`
`51`	`50`
`52`	`51`	`@PostMapping`
`53`		`- public ResponseEntity<ExampleDto> createNew(@Valid @RequestBody CreateExampleDto dto) {`
`54`		`- Example newExample = service.create(dto);`
	`52`	`+ public ResponseEntity<ExampleDto> createNew(@Valid @RequestBody ExampleDto dto) {`
	`53`	`+ Example newExample = service.create(mapper.fromDto(dto));`
`55`	`54`	`return ResponseEntity.ok(mapper.toDto(newExample));`
`56`	`55`	`}`
`57`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`package ch.puzzle.pcts.dto.example;`
`2`	`2`
`3`		`-public record ExampleDto(long id, String text) {`
	`3`	`+public record ExampleDto(Long id, String text) {`
`4`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,5 +3,6 @@`
`3`	`3`	`public enum ErrorKey {`
`4`	`4`	`VALIDATION,`
`5`	`5`	`VALIDATION_DOES_NOT_INCLUDE,`
`6`		`- INTERNAL`
	`6`	`+ INTERNAL,`
	`7`	`+ ID_IS_NOT_NULL`
`7`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,5 @@`
`1`	`1`	`package ch.puzzle.pcts.service.persistence;`
`2`	`2`
`3`		`-import ch.puzzle.pcts.dto.example.CreateExampleDto;`
`4`	`3`	`import ch.puzzle.pcts.model.example.Example;`
`5`	`4`	`import ch.puzzle.pcts.repository.ExampleRepository;`
`6`	`5`	`import java.util.List;`
`@@ -16,15 +15,15 @@ public ExamplePersistenceService(ExampleRepository repository) {`
`16`	`15`	`this.repository = repository;`
`17`	`16`	`}`
`18`	`17`
`19`		`- public Example create(CreateExampleDto dto) {`
`20`		`- return repository.add(dto);`
	`18`	`+ public Example create(Example example) {`
	`19`	`+ return repository.save(example);`
`21`	`20`	`}`
`22`	`21`
`23`	`22`	`public Example getById(long id) {`
`24`	`23`	`return repository.getById(id);`
`25`	`24`	`}`
`26`	`25`
`27`	`26`	`public List<Example> getAll() {`
`28`		`- return repository.getAll();`
	`27`	`+ return repository.findAll();`
`29`	`28`	`}`
`30`	`29`	`}`