Develop

.github/workflows/deploy-image.yml

@@ -1,10 +1,10 @@
 #
 name: Create and publish a Docker image
 
-# Configures this workflow to run every time a change is pushed to the branch called `release`.
+# Configures this workflow to run every time a change is pushed to a branch.
 on:
   push:
-    branches: ['main']
+    branches: ['**']
 
 # Defines two custom environment variables for the workflow. These are used for the Container registry domain, and a name for the Docker image that this workflow builds.
 env:
@@ -25,6 +25,29 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Compute application version
+        id: version
+        run: |
+          branch_tag=$(echo "${GITHUB_REF_NAME}" | tr '/[:upper:]' '-[:lower:]')
+          if [ "${GITHUB_REF_NAME}" = "main" ]; then
+            app_version="main-${GITHUB_SHA::12}"
+          else
+            app_version="${branch_tag}-${GITHUB_SHA::12}"
+          fi
+          echo "branch_tag=${branch_tag}" >> "$GITHUB_OUTPUT"
+          echo "app_version=${app_version}" >> "$GITHUB_OUTPUT"
+      - name: Check whether branch tag conflicts with a Git tag
+        id: branch-tag-check
+        run: |
+          if [ "${GITHUB_REF_NAME}" = "main" ]; then
+            echo "publish_branch_tag=false" >> "$GITHUB_OUTPUT"
+          elif git rev-parse --verify --quiet "refs/tags/${GITHUB_REF_NAME}" >/dev/null; then
+            echo "publish_branch_tag=false" >> "$GITHUB_OUTPUT"
+          else
+            echo "publish_branch_tag=true" >> "$GITHUB_OUTPUT"
+          fi
       # Uses the `docker/login-action` action to log in to the Container registry registry using the account and password that will publish the packages. Once published, the packages are scoped to the account defined here.
       - name: Log in to the Container registry
         uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
@@ -38,6 +61,10 @@ jobs:
         uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
         with:
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=raw,value=main,enable=${{ github.ref_name == 'main' }}
+            type=raw,value=${{ steps.version.outputs.app_version }}
+            type=raw,value=${{ steps.version.outputs.branch_tag }},enable=${{ steps.branch-tag-check.outputs.publish_branch_tag == 'true' }}
       # This step uses the `docker/build-push-action` action to build the image, based on your repository's `Dockerfile`. If the build succeeds, it pushes the image to GitHub Packages.
       # It uses the `context` parameter to define the build's context as the set of files located in the specified path. For more information, see "[Usage](https://github.com/docker/build-push-action#usage)" in the README of the `docker/build-push-action` repository.
       # It uses the `tags` and `labels` parameters to tag and label the image with the output from the "meta" step.
@@ -51,7 +78,7 @@ jobs:
           build-args: |
             UID:"${DOCKER_UID}" 
             GID:"${DOCKER_GID}"
-            APP_VERSION:"1.43"
+            APP_VERSION:"${{ steps.version.outputs.app_version }}"
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
 

.github/workflows/deploy-release.yml

@@ -26,6 +26,10 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
+      - name: Compute application version
+        id: version
+        run: |
+          echo "app_version=${GITHUB_REF_NAME#v}" >> "$GITHUB_OUTPUT"
       # Uses the `docker/login-action` action to log in to the Container registry registry using the account and password that will publish the packages. Once published, the packages are scoped to the account defined here.
       - name: Log in to the Container registry
         uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
@@ -39,6 +43,10 @@ jobs:
         uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
         with:
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=raw,value=${{ steps.version.outputs.app_version }}
+            type=raw,value=${{ github.ref_name }}
+            type=raw,value=latest
       # This step uses the `docker/build-push-action` action to build the image, based on your repository's `Dockerfile`. If the build succeeds, it pushes the image to GitHub Packages.
       # It uses the `context` parameter to define the build's context as the set of files located in the specified path. For more information, see "[Usage](https://github.com/docker/build-push-action#usage)" in the README of the `docker/build-push-action` repository.
       # It uses the `tags` and `labels` parameters to tag and label the image with the output from the "meta" step.
@@ -52,7 +60,9 @@ jobs:
           build-args: |
             UID:"${DOCKER_UID}" 
             GID:"${DOCKER_GID}"
-          tags: ghcr.io/${{ github.repository_owner }}/${{ github.repository }}:${{ github.ref_name }}
+            APP_VERSION:"${{ steps.version.outputs.app_version }}"
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
 
       # This step generates an artifact attestation for the image, which is an unforgeable statement about where and how it was built. It increases supply chain security for people who consume the image. For more information, see "[AUTOTITLE](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds)." 
       - name: Generate artifact attestation

.github/workflows/maven.yml

@@ -29,6 +29,13 @@ jobs:
         cache: maven
     - name: Build with Maven
       run: mvn -B clean install --file pom.xml
+    - name: Upload App Coverage Report
+      if: always()
+      uses: actions/upload-artifact@v4
+      with:
+        name: jacoco-app-report
+        path: app/target/site/jacoco
+        if-no-files-found: warn
 
     # Optional: Uploads the full dependency graph to GitHub to improve the quality of Dependabot alerts this repository can receive
     #- name: Update dependency graph

.gitignore

@@ -0,0 +1,6 @@
+app/target/
+db/target/
+AGENTS.md
+comparaison-api-v2-vs-v3 _1_.md
+doc/target/
+

README.md

@@ -76,6 +76,22 @@ Exemple pour Visual Studio Code .vscode/launch.json :
 }
 ```
 
+### Configuration de l'API REMOcRA
+
+Le client REMOcRA est configuré en v3 only avec authentification Keycloak / OIDC.
+
+Variables d'environnement disponibles :
+
+```sh
+API_HOST=http://localhost:8881
+API_BASE_PATH=/api
+API_AUTH_TYPE=keycloak
+API_KEYCLOAK_URL=https://keycloak.example
+API_KEYCLOAK_REALM=remocra
+API_KEYCLOAK_CLIENT_ID=sync-remocra
+API_KEYCLOAK_CLIENT_SECRET=change-me
+```
+
 
 
 ## Formatage de code (API)

app/pom.xml

@@ -128,6 +128,40 @@
 
   <build>
     <plugins>
+      <plugin>
+        <artifactId>maven-compiler-plugin</artifactId>
+        <configuration>
+          <useIncrementalCompilation>false</useIncrementalCompilation>
+          <annotationProcessorPaths>
+            <path>
+              <groupId>org.immutables</groupId>
+              <artifactId>value</artifactId>
+              <version>${immutables.version}</version>
+            </path>
+          </annotationProcessorPaths>
+        </configuration>
+      </plugin>
+
+      <plugin>
+        <groupId>org.jacoco</groupId>
+        <artifactId>jacoco-maven-plugin</artifactId>
+        <executions>
+          <execution>
+            <id>prepare-agent</id>
+            <goals>
+              <goal>prepare-agent</goal>
+            </goals>
+          </execution>
+          <execution>
+            <id>report</id>
+            <phase>verify</phase>
+            <goals>
+              <goal>report</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-jar-plugin</artifactId>

app/src/main/java/fr/eaudeparis/syncremocra/api/ApiEndpoints.java

@@ -0,0 +1,101 @@
+package fr.eaudeparis.syncremocra.api;
+
+/**
+ * Centralise les chemins des endpoints REMOcRA utilisés par l'application.
+ *
+ * <p>Cette classe ne gère que les chemins relatifs. La construction de l'URL complète ({@code host
+ * + basePath + path}) reste du ressort de {@link fr.eaudeparis.syncremocra.util.RequestManager}.
+ */
+public class ApiEndpoints {
+
+  private static final String DECI_ROOT = "/deci";
+  private static final String PEI_ROOT = DECI_ROOT + "/pei";
+  private static final String REFERENTIEL_ROOT = DECI_ROOT + "/referentiel";
+  private static final String INDISPO_TEMPORAIRE_ROOT = DECI_ROOT + "/indispoTemporaire";
+  private static final String VISITES_SEGMENT = "/visites";
+  private static final String CARACTERISTIQUES_SEGMENT = "/caracteristiques";
+
+  /** @return Endpoint de récupération des diffs PEI */
+  public String peiDiff() {
+    return PEI_ROOT + "/diff";
+  }
+
+  /**
+   * @param reference Référence ou numéro du PEI
+   * @return Endpoint du PEI ciblé
+   */
+  public String pei(String reference) {
+    return PEI_ROOT + "/" + reference;
+  }
+
+  /**
+   * @param reference Référence ou numéro du PEI
+   * @return Endpoint des caractéristiques du PEI ciblé
+   */
+  public String peiCaracteristiques(String reference) {
+    return pei(reference) + CARACTERISTIQUES_SEGMENT;
+  }
+
+  /**
+   * @param reference Référence ou numéro du PEI
+   * @return Endpoint de mise à jour des caractéristiques PIBI
+   */
+  public String peiPibiCaracteristiques(String reference) {
+    return pei(reference) + "/pibi-caracteristiques";
+  }
+
+  /**
+   * @param reference Référence ou numéro du PEI
+   * @return Endpoint de mise à jour des caractéristiques PENA
+   */
+  public String peiPenaCaracteristiques(String reference) {
+    return pei(reference) + "/pena-caracteristiques";
+  }
+
+  /**
+   * @param reference Référence ou numéro du PEI
+   * @return Endpoint de la collection de visites du PEI ciblé
+   */
+  public String peiVisites(String reference) {
+    return pei(reference) + VISITES_SEGMENT;
+  }
+
+  /**
+   * @param reference Référence ou numéro du PEI
+   * @param identifiantVisite Identifiant de la visite
+   * @return Endpoint d'une visite spécifique d'un PEI
+   */
+  public String peiVisite(String reference, Object identifiantVisite) {
+    return peiVisites(reference) + "/" + identifiantVisite;
+  }
+
+  /** @return Endpoint de la collection des indisponibilités temporaires */
+  public String indispoTemporaire() {
+    return INDISPO_TEMPORAIRE_ROOT;
+  }
+
+  /**
+   * @param identifiant Identifiant de l'indisponibilité temporaire
+   * @return Endpoint d'une indisponibilité temporaire spécifique
+   */
+  public String indispoTemporaire(Object identifiant) {
+    return INDISPO_TEMPORAIRE_ROOT + "/" + identifiant;
+  }
+
+  /**
+   * @param type Type de PEI en minuscule, par exemple {@code pibi} ou {@code pena}
+   * @param nature Nature du PEI
+   * @return Endpoint du référentiel des anomalies pour le type et la nature fournis
+   */
+  public String referentielNaturesAnomalies(String type, String nature) {
+    return REFERENTIEL_ROOT + "/" + type + "/" + nature + "/naturesAnomalies";
+  }
+
+  /**
+   * @param type Type de PEI en minuscule, par exemple {@code pibi} ou {@code pena}
+   * @return Endpoint du référentiel des natures PEI pour le type fourni
+   */
+  public String referentielNaturesPei(String type) {
+    return REFERENTIEL_ROOT + "/" + type + "/naturesPEI";
+  }
+}

app/src/main/java/fr/eaudeparis/syncremocra/api/ApiModule.java

@@ -11,10 +11,31 @@ public class ApiModule extends AbstractModule {
 
   public static ApiModule create(Config config) {
     ImmutableApiSettings.Builder builder = ImmutableApiSettings.builder();
-    builder
-        .host(config.getString("host"))
-        .mail(config.getString("mail"))
-        .password(config.getString("password"));
+    builder.host(config.getString("host"));
+    if (config.hasPath("mail")) {
+      builder.mail(config.getString("mail"));
+    }
+    if (config.hasPath("password")) {
+      builder.password(config.getString("password"));
+    }
+    if (config.hasPath("base_path")) {
+      builder.basePath(config.getString("base_path"));
+    }
+    if (config.hasPath("auth_type")) {
+      builder.authType(config.getString("auth_type"));
+    }
+    if (config.hasPath("keycloak_url")) {
+      builder.keycloakUrl(config.getString("keycloak_url"));
+    }
+    if (config.hasPath("keycloak_realm")) {
+      builder.keycloakRealm(config.getString("keycloak_realm"));
+    }
+    if (config.hasPath("keycloak_client_id")) {
+      builder.keycloakClientId(config.getString("keycloak_client_id"));
+    }
+    if (config.hasPath("keycloak_client_secret")) {
+      builder.keycloakClientSecret(config.getString("keycloak_client_secret"));
+    }
     return new ApiModule(builder.build());
   }
 
@@ -25,5 +46,6 @@ public ApiModule(ImmutableApiSettings settings) {
   @Override
   protected void configure() {
     bind(ApiSettings.class).toInstance(apiSettings);
+    bind(ApiEndpoints.class).asEagerSingleton();
   }
 }

app/src/main/java/fr/eaudeparis/syncremocra/api/ApiSettings.java

@@ -4,9 +4,54 @@
 
 @Value.Immutable
 public interface ApiSettings {
+  /** @return URL racine de l'instance REMOcRA ou du reverse proxy exposant l'API */
   String host();
 
-  String password();
+  /** @return Préfixe optionnel ajouté devant les endpoints, par exemple {@code /api} */
+  @Value.Default
+  default String basePath() {
+    return "";
+  }
 
-  String mail();
+  /** @return Type d'authentification API supporté par le client v3, soit {@code keycloak} */
+  @Value.Default
+  default String authType() {
+    return "keycloak";
+  }
+
+  /** @return Mot de passe historique conservé pour compatibilité de configuration locale */
+  @Value.Default
+  default String password() {
+    return "";
+  }
+
+  /** @return Adresse e-mail historique conservée pour compatibilité de configuration locale */
+  @Value.Default
+  default String mail() {
+    return "";
+  }
+
+  /** @return URL de base de Keycloak en mode OIDC */
+  @Value.Default
+  default String keycloakUrl() {
+    return "";
+  }
+
+  /** @return Realm Keycloak utilisé pour récupérer le jeton OIDC */
+  @Value.Default
+  default String keycloakRealm() {
+    return "";
+  }
+
+  /** @return Client ID Keycloak utilisé pour le flux {@code client_credentials} */
+  @Value.Default
+  default String keycloakClientId() {
+    return "";
+  }
+
+  /** @return Secret du client Keycloak utilisé pour le flux {@code client_credentials} */
+  @Value.Default
+  default String keycloakClientSecret() {
+    return "";
+  }
 }