Updated development documentation

Author: david-monichi

README.md

@@ -28,19 +28,7 @@ There is currently one database implementations available.
 
 ## Development
 
-Run application with local postgresql database in development mode:
-```bash
-  cd src/test/resources/docker-compose.yml
-  docker-compose up keycloak
-
-  mvn -DskipTests=true -Dquarkus.profile=local package io.quarkus:quarkus-maven-plugin::dev
-```
-
-In case of issues enable full debug logging by uncommenting the enable `ALL` logs in the `src/main/resources/application.properties` file:
-```properties
-    quarkus.log.level = ALL
-    quarkus.log.category."org.lfenergy.compas.scl.data".level = ALL
-```
+See [development](doc/development.md) documentation.
 
 ## Common Environment variables
 

app/src/main/resources/application-local.properties

@@ -10,3 +10,5 @@ quarkus.flyway.migrate-at-start = true
 quarkus.flyway.locations        = classpath:org/lfenergy/compas/scl/data/repository/postgresql/db/migration
 
 mp.jwt.verify.issuer             = ${JWT_VERIFY_ISSUER:http://127.0.0.1:8089/auth/realms/compas}
+
+compas.scl-data-service.features.soft-delete-enabled = true

app/src/main/resources/application.properties

@@ -15,6 +15,8 @@ quarkus.websocket.max-frame-size  = 157286400
 quarkus.log.level = INFO
 quarkus.log.category."org.lfenergy.compas.scl.data".level = INFO
 
+compas.scl-data-service.features.soft-delete-enabled = ${SCL_DATA_SERVICE_SOFT_DELETE_ENABLED:false}
+
 # Add scanning these dependencies for scanning, also used by native compilation.
 quarkus.index-dependency.websocket-commons.group-id    = org.lfenergy.compas.core
 quarkus.index-dependency.websocket-commons.artifact-id = websocket-commons

app/src/test/resources/docker-compose.yml

@@ -15,3 +15,19 @@ services:
       - KC_PROXY_HEADERS=xforwarded
       - KC_BOOTSTRAP_ADMIN_USERNAME=admin
       - KC_BOOTSTRAP_ADMIN_PASSWORD=admin
+
+  postgresql:
+    image: postgres:latest
+    container_name: compas_postgresql
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_DB: compas
+    ports:
+      - "5432:5432"
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U postgres"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+    restart: unless-stopped

doc/development.md

@@ -0,0 +1,29 @@
+# Development
+
+Run application with local postgresql database in development mode:
+```bash
+  cd src/test/resources/docker-compose.yml
+  docker-compose up keycloak
+
+  mvn -DskipTests=true -Dquarkus.profile=local package io.quarkus:quarkus-maven-plugin::dev
+```
+
+In case of issues enable full debug logging by uncommenting the enable `ALL` logs in the `src/main/resources/application.properties` file:
+```properties
+    quarkus.log.level = ALL
+    quarkus.log.category."org.lfenergy.compas.scl.data".level = ALL
+```
+
+## Verify setup
+
+To verify that the setup is correct, you can use the following curl command to list all ICDs in the database:
+```
+    curl -X GET "http://localhost:8080/scl-data-service/icd/list" -H "Authorization: Bearer <ACCESS_TOKEN>" -H "accept: application
+```
+
+The `<ACCESS_TOKEN>` should be replaced with a valid JWT token obtained from Keycloak with following command:
+```bash
+    curl -X POST "http://localhost:8089/auth/realms/compas/protocol/openid-connect/token" \
+    -H "Content-Type: application/x-www-form-urlencoded" \
+    -d "client_id=scl-data-service&username=scl-data-editor&password=editor&grant_type=password"
+```

doc/postgresql.md

@@ -37,6 +37,7 @@ Table: scl_file
 | type          | varchar(3)   | True     | The type of SCL stored                                             |
 | name          | varchar(255) | True     | The name of the SCL File                                           |
 | scl_data      | text         | True     | The SCL XML Content                                                |
+| is_deleted    | boolean      | False    | Flag indicating whether the record is marked as deleted            |
 
 ## Development
 

repository-postgresql/src/main/java/org/lfenergy/compas/scl/data/repository/postgresql/CompasSclDataPostgreSQLRepositoryConfiguration.java

@@ -4,27 +4,30 @@
 
 package org.lfenergy.compas.scl.data.repository.postgresql;
 
-import io.quarkus.arc.DefaultBean;
-import io.quarkus.arc.lookup.LookupIfProperty;
 import jakarta.enterprise.context.ApplicationScoped;
 import jakarta.enterprise.inject.Produces;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+import org.eclipse.microprofile.config.inject.ConfigProperty;
 import org.lfenergy.compas.scl.data.repository.CompasSclDataRepository;
 
 import javax.sql.DataSource;
 
 public class CompasSclDataPostgreSQLRepositoryConfiguration {
 
+    private static final Logger LOGGER = LogManager.getLogger(CompasSclDataPostgreSQLRepositoryConfiguration.class);
+
+    @ConfigProperty(name = "compas.scl-data-service.features.soft-delete-enabled", defaultValue = "false")
+    private boolean softDeleteEnabled;
+
     @Produces
     @ApplicationScoped
-    @LookupIfProperty(name = "compas.scl-data-service.features.soft-delete-enabled", stringValue = "true")
     CompasSclDataRepository softDeleteCompasSclDataPostgreSQLRepository(DataSource dataSource) {
+        if (!softDeleteEnabled) {
+            LOGGER.warn("Soft delete feature is disabled, using default repository.");
+            return new CompasSclDataPostgreSQLRepository(dataSource);
+        }
+        LOGGER.info("Soft delete feature is enabled. Using SoftDeleteCompasSclDataPostgreSQLRepository.");
         return new SoftDeleteCompasSclDataPostgreSQLRepository(dataSource);
     }
-
-    @Produces
-    @ApplicationScoped
-    @DefaultBean
-    CompasSclDataRepository defaultCompasSclDataPostgreSQLRepository(DataSource dataSource) {
-        return new CompasSclDataPostgreSQLRepository(dataSource);
-    }
 }

repository-postgresql/src/main/java/org/lfenergy/compas/scl/data/repository/postgresql/SoftDeleteCompasSclDataPostgreSQLRepository.java

@@ -27,7 +27,7 @@ public SoftDeleteCompasSclDataPostgreSQLRepository(DataSource dataSource) {
     public void delete(SclFileType type, UUID id) {
         var sql = """
                 UPDATE scl_file
-                 SET scl_file.is_deleted = true
+                 SET is_deleted = true
                  where scl_file.id   = ?
                  and   scl_file.type = ?
                 """;
@@ -47,7 +47,7 @@ public void delete(SclFileType type, UUID id) {
     public void delete(SclFileType type, UUID id, Version version) {
         var sql = """
                 UPDATE scl_file
-                 SET scl_file.is_deleted = true
+                 SET is_deleted = true
                  where scl_file.id   = ?
                  and   scl_file.type = ?
                  and   scl_file.major_version = ?