fix(clean): clean names, CI and pom

Author: emmanuelbruno

.github/workflows/ci.yml

@@ -1,3 +1,5 @@
+# This workflow is triggered on pushes and pull requests to the 'develop' and 'main' branches.
+
 name: Java CI with Maven
 
 on:
@@ -8,10 +10,15 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    # To run of Github-hosted runners, uncomment the line below and comment out the self-hosted runner line.
+    # runs-on: ubuntu-latest
+    # Use a self-hosted runner to ensure the necessary environment like sonarqube.
+    runs-on: self-hosted
 
     steps:
     - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
 
     - name: Set up JDK 21
       uses: actions/setup-java@v4

pom.xml

@@ -7,22 +7,36 @@
     <version>1.0.0-SNAPSHOT</version>
 
     <properties>
-        <compiler-plugin.version>3.15.0</compiler-plugin.version>
+        <!-- Java release level for the compiler (source/target) -->
         <maven.compiler.release>21</maven.compiler.release>
+
+        <!-- Maven Compiler Plugin: plugin version used to compile the project -->
+        <compiler-plugin.version>3.15.0</compiler-plugin.version>
+        <!-- Versions plugin: used for dependency/version updates -->
+        <versions-plugin.version>2.21.0</versions-plugin.version>
+
+        <!-- Encoding properties: ensure consistent encoding across all plugins and reports -->
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+
+        <!-- Quarkus platform BOM coordinates -->
         <quarkus.platform.artifact-id>quarkus-bom</quarkus.platform.artifact-id>
         <quarkus.platform.group-id>io.quarkus.platform</quarkus.platform.group-id>
         <quarkus.platform.version>3.31.2</quarkus.platform.version>
+
+        <!-- Testing dependencies versions -->
         <surefire-plugin.version>3.5.4</surefire-plugin.version>
         <testcontainers.version>1.21.4</testcontainers.version>
-        <versions-plugin.version>2.21.0</versions-plugin.version>
-        <quarkus-cucumber.version>1.3.0</quarkus-cucumber.version>
         <cucumber.version>7.34.2</cucumber.version>
+        <quarkus-cucumber.version>1.3.0</quarkus-cucumber.version>
 
+        <!-- For reproducible builds -->
         <project.build.outputTimestamp>2026-02-07T15:00:00Z</project.build.outputTimestamp>
     </properties>
 
+    <!-- Import Quarkus platform BOM for dependency version management -->
+    <!-- This ensures that all Quarkus dependencies use compatible versions as defined by the platform BOM -->
+    <!-- Not loaded as a regular dependency, but used to manage versions of Quarkus dependencies in the project -->
     <dependencyManagement>
         <dependencies>
             <dependency>
@@ -36,22 +50,29 @@
     </dependencyManagement>
 
     <dependencies>
+        <!-- Quarkus dependencies: these are the libraries that provide the functionality for the application, such as REST endpoints, database access, JSON handling, etc. -->
+
+        <!-- Database and ORM -->
         <dependency>
             <groupId>io.quarkus</groupId>
-            <artifactId>quarkus-rest-jackson</artifactId>
+            <artifactId>quarkus-jdbc-postgresql</artifactId>
         </dependency>
         <dependency>
             <groupId>io.quarkus</groupId>
-            <artifactId>quarkus-rest-client-jackson</artifactId>
+            <artifactId>quarkus-hibernate-orm-rest-data-panache</artifactId>
         </dependency>
+
+        <!-- Rest and JSON handling -->
         <dependency>
             <groupId>io.quarkus</groupId>
-            <artifactId>quarkus-jdbc-postgresql</artifactId>
+            <artifactId>quarkus-rest-jackson</artifactId>
         </dependency>
         <dependency>
             <groupId>io.quarkus</groupId>
-            <artifactId>quarkus-hibernate-orm-rest-data-panache</artifactId>
+            <artifactId>quarkus-rest-client-jackson</artifactId>
         </dependency>
+
+        <!-- OpenAPI and Health -->
         <dependency>
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-smallrye-openapi</artifactId>
@@ -60,29 +81,47 @@
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-smallrye-health</artifactId>
         </dependency>
+
+        <!-- Dependency injection -->
         <dependency>
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-arc</artifactId>
         </dependency>
+
+        <!-- Container image building -->
         <dependency>
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-container-image-jib</artifactId>
         </dependency>
+
+        <!-- Testing dependencies: these are used for writing and running tests,
+          including unit tests, integration tests, and end-to-end tests.
+          They include libraries for testing frameworks, mocking, test containers, a
+          nd Cucumber for BDD testing. -->
+        <!-- Quarkus testing support -->
         <dependency>
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-junit</artifactId>
             <scope>test</scope>
         </dependency>
+        <!-- REST-assured for testing REST endpoints -->
         <dependency>
             <groupId>io.rest-assured</groupId>
             <artifactId>rest-assured</artifactId>
             <scope>test</scope>
         </dependency>
+        <!-- Mockito for mocking dependencies in tests -->
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-junit-mockito</artifactId>
             <scope>test</scope>
         </dependency>
+        <!-- Testcontainers for integration testing with containers -->
         <dependency>
             <groupId>org.testcontainers</groupId>
             <artifactId>testcontainers</artifactId>
@@ -95,11 +134,10 @@
             <version>${testcontainers.version}</version>
             <scope>test</scope>
         </dependency>
-        <dependency>
-            <groupId>org.mockito</groupId>
-            <artifactId>mockito-core</artifactId>
-            <scope>test</scope>
-        </dependency>
+        <!-- Cucumber for Behavior Driven Development (BDD) testing -->
+        <!-- quarkus-cucumber provides integration between Cucumber and Quarkus,
+         allowing you to write BDD tests that can leverage Quarkus features
+         and run in the same environment as your application -->
         <dependency>
             <groupId>io.quarkiverse.cucumber</groupId>
             <artifactId>quarkus-cucumber</artifactId>
@@ -122,8 +160,16 @@
     </dependencies>
 
     <build>
+        <!-- Plugin management: defines versions and configuration for plugins
+         used in the build, such as the Quarkus Maven plugin for building the
+         application, the Surefire plugin for running tests, and plugins for
+         code quality and coverage analysis. -->
         <plugins>
             <plugin>
+                <!-- Quarkus Maven plugin: used to build the Quarkus application,
+                 generate code, and create native images. It is configured to
+                 execute goals for building the application, generating code,
+                 and running the native image agent. -->
                 <groupId>${quarkus.platform.group-id}</groupId>
                 <artifactId>quarkus-maven-plugin</artifactId>
                 <version>${quarkus.platform.version}</version>
@@ -139,6 +185,9 @@
                     </execution>
                 </executions>
             </plugin>
+            <!-- Compiler plugin: used to compile the Java source code.
+             It is configured to include parameter names in the compiled bytecode,
+             which can be useful for reflection and testing. -->
             <plugin>
                 <artifactId>maven-compiler-plugin</artifactId>
                 <version>${compiler-plugin.version}</version>
@@ -165,7 +214,6 @@
                 </configuration>
             </plugin>
 
-
             <!-- Failsafe / Integration Tests -->
             <plugin>
                 <artifactId>maven-failsafe-plugin</artifactId>
@@ -193,7 +241,10 @@
                 </configuration>
             </plugin>
 
-            <!-- Versions plugin: use organization rules.xml for dependency update rules -->
+            <!-- Plugin to manage versions of dependencies and plugins, using organization-specific rules for updates
+                can be used to check for outdated dependencies and suggest updates based on the rules defined in the provided rules.xml file
+
+                ./mvn versions:display-property-updates -->
             <plugin>
                 <groupId>org.codehaus.mojo</groupId>
                 <artifactId>versions-maven-plugin</artifactId>
@@ -207,8 +258,12 @@
     </build>
 
 
+    <!-- Profiles: these are different build configurations that can be activated based on certain conditions,
+     such as the presence of specific properties. -->
     <profiles>
-        <!-- Profil JVM -->
+        <!-- Profile JVM: this profile is activated when the "jvm" property is set. It configures the build to create
+         a JVM-based application package, build a container image using Jib, and load it into the local Docker registry. -->
+
         <profile>
             <id>jvm</id>
             <properties>
@@ -219,10 +274,14 @@
                 <quarkus.container-image.name>product-catalog</quarkus.container-image.name>
                 <quarkus.container-image.tag>1.0.0-jvm</quarkus.container-image.tag>
                 <quarkus.docker.dockerfile-jvm-path>src/main/docker/Dockerfile.jvm</quarkus.docker.dockerfile-jvm-path>
+                <quarkus.jib.base-jvm-image>registry.access.redhat.com/ubi9/openjdk-21-runtime@sha256:20252d0fd32221be2c6ffa91c19f0344c80c8ce3f054a26a2d7492a172516e53</quarkus.jib.base-jvm-image>
+
             </properties>
         </profile>
 
-        <!-- Profil Natif -->
+        <!-- Profile Native: this profile is activated when the "native" property is set. It configures the build
+         to create a native executable using GraalVM, build a container image using Jib, and load it into the local
+         Docker registry. It also specifies the builder image to use for building the native executable. -->
         <profile>
             <id>native</id>
             <properties>
@@ -234,8 +293,7 @@
                 <quarkus.container-image.group>brunoe</quarkus.container-image.group>
                 <quarkus.container-image.name>product-catalog</quarkus.container-image.name>
                 <quarkus.container-image.tag>1.0.0-native</quarkus.container-image.tag>
-
-                <quarkus.native.builder-image>quay.io/quarkus/ubi9-quarkus-mandrel-builder-image:jdk-21</quarkus.native.builder-image>
+                <quarkus.jib.base-native-image>quay.io/quarkus/ubi9-quarkus-mandrel-builder-image:jdk-21</quarkus.jib.base-native-image>
             </properties>
         </profile>
 

…ava/org/acme/api/v1/ProductResource.java …a/org/acme/api/v1/ProductResourceV1.javasrc/main/java/org/acme/api/v1/ProductResource.java renamed to src/main/java/org/acme/api/v1/ProductResourceV1.java src/main/java/org/acme/api/v1/ProductResource.java renamed to src/main/java/org/acme/api/v1/ProductResourceV1.java

@@ -25,7 +25,7 @@
 @Produces(MediaType.APPLICATION_JSON)
 @Consumes(MediaType.APPLICATION_JSON)
 @Tag(name = "Product V1", description = "Basic memory-based API for M1 introduction")
-public class ProductResource {
+public class ProductResourceV1 {
 
     /**
      * In-memory storage shared across all requests.

…ava/org/acme/api/v2/ProductResource.java …a/org/acme/api/v2/ProductResourceV2.javasrc/main/java/org/acme/api/v2/ProductResource.java renamed to src/main/java/org/acme/api/v2/ProductResourceV2.java src/main/java/org/acme/api/v2/ProductResource.java renamed to src/main/java/org/acme/api/v2/ProductResourceV2.java

@@ -27,7 +27,7 @@
 @Produces(MediaType.APPLICATION_JSON)
 @Consumes(MediaType.APPLICATION_JSON)
 @Tag(name = "Product V2", description = "Memory-based API with Path Params and Exceptions")
-public class ProductResource {
+public class ProductResourceV2 {
 
     /**
      * Shared in-memory storage.
@@ -89,7 +89,7 @@ public Response deleteProduct(@PathParam("sku") String sku) {
     /**
      * Creates a new product.
      * * @param product Product to create.
-     * 
+     *
      * @return 201 Created.
      * @throws WebApplicationException with 409 Conflict if SKU exists.
      */

…ava/org/acme/api/v3/ProductResource.java …a/org/acme/api/v3/ProductResourceV3.javasrc/main/java/org/acme/api/v3/ProductResource.java renamed to src/main/java/org/acme/api/v3/ProductResourceV3.java src/main/java/org/acme/api/v3/ProductResource.java renamed to src/main/java/org/acme/api/v3/ProductResourceV3.java

@@ -31,7 +31,7 @@
 @Consumes(MediaType.APPLICATION_JSON)
 @Tag(name = "Product V3", description = "Service-based API with Dependency Injection")
 @RequestScoped
-public class ProductResource {
+public class ProductResourceV3 {
 
     private final ProductServiceV3 service;
 
@@ -42,7 +42,7 @@ public class ProductResource {
      * @param service Business service orchestrating the repository.
      */
     @Inject
-    public ProductResource(ProductServiceV3 service) {
+    public ProductResourceV3(ProductServiceV3 service) {
         this.service = service;
     }
 

…ava/org/acme/api/v4/ProductResource.java …a/org/acme/api/v4/ProductResourceV4.javasrc/main/java/org/acme/api/v4/ProductResource.java renamed to src/main/java/org/acme/api/v4/ProductResourceV4.java src/main/java/org/acme/api/v4/ProductResource.java renamed to src/main/java/org/acme/api/v4/ProductResourceV4.java

@@ -31,7 +31,7 @@
 @Consumes(MediaType.APPLICATION_JSON)
 @Tag(name = "Product V4", description = "API using DTOs to encapsulate the Domain model")
 @RequestScoped
-public class ProductResource {
+public class ProductResourceV4 {
 
     private final ProductServiceV4 service;
 
@@ -41,7 +41,7 @@ public class ProductResource {
      * @param service Business service handling V4 logic.
      */
     @Inject
-    public ProductResource(ProductServiceV4 service) {
+    public ProductResourceV4(ProductServiceV4 service) {
         this.service = service;
     }
 

…ava/org/acme/api/v5/ProductResource.java …a/org/acme/api/v5/ProductResourceV5.javasrc/main/java/org/acme/api/v5/ProductResource.java renamed to src/main/java/org/acme/api/v5/ProductResourceV5.java src/main/java/org/acme/api/v5/ProductResource.java renamed to src/main/java/org/acme/api/v5/ProductResourceV5.java

@@ -40,12 +40,12 @@
 @Consumes(MediaType.APPLICATION_JSON)
 @Tag(name = "Product V5", description = "Validated and documented production-ready API")
 @RequestScoped
-public class ProductResource {
+public class ProductResourceV5 {
 
     private final ProductServiceV5 service;
 
     @Inject
-    public ProductResource(ProductServiceV5 service) {
+    public ProductResourceV5(ProductServiceV5 service) {
         this.service = service;
     }
 

src/main/resources/application.properties

@@ -35,8 +35,6 @@ quarkus.swagger-ui.always-include=true
 # ==========================
 # Validates that the database is actually reachable
 quarkus.datasource.health.enabled=true
-# Add specific liveness check for the JVM
-quarkus.smallrye-health.liveness.checks.enabled=true
 
 # ==========================
 # Logging

src/test/java/org/acme/api/cucumber/steps/ProductSteps.java

@@ -60,9 +60,9 @@ private void setResponse(Response response) {
     @Given("the product catalog is empty")
     public void theProductCatalogIsEmpty() {
         if (versionContext.getVersion().equals("v1"))
-            org.acme.api.v1.ProductResource.clearProducts();
+            org.acme.api.v1.ProductResourceV1.clearProducts();
         else if (versionContext.getVersion().equals("v2"))
-            org.acme.api.v2.ProductResource.clearProducts();
+            org.acme.api.v2.ProductResourceV2.clearProducts();
         else {
             // 1. Supprime tout
             repository.deleteAll();

src/test/java/org/acme/api/v1/ProductResourceV1IT.java

@@ -13,7 +13,7 @@
 import static org.hamcrest.Matchers.*;
 
 @QuarkusTest
-@TestHTTPEndpoint(ProductResource.class)
+@TestHTTPEndpoint(ProductResourceV1.class)
 @DisplayName("ProductResource v1 - In-Memory Tests")
 class ProductResourceV1IT {