code coverage: add JaCoCo report merge

 Motivation:

 To improve test quality tracking, this adds JaCoCo coverage reports to the CI pipeline.

 Modifications:

 - CI: Added JaCoCo stage in .gitlab-ci.yml.

 - Scripts: New generate-jacoco-report.sh for report aggregation.

 - POM: Configured JaCoCo Maven plugin.

 Results:

 - Coverage reports for modules and merged report for the whole project are generated and archived in CI artifacts (.exec/.html).

 Testing:

 - Validated reports locally and in CI.

 Acked-by: Tigran Mkrtchyan
 Target: master
 Require-book: no
 Require-notes: no
 Committed:

Author: chubnastia

.github/workflows/build.yml

@@ -10,15 +10,37 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+
       - name: Set up JDK 17
         uses: actions/setup-java@v4
         with:
           java-version: "17"
           distribution: "temurin"
           cache: maven
+
+      - name: Cache JaCoCo CLI
+        id: cache-jacoco
+        uses: actions/cache@v4
+        with:
+            path: ~/jacoco-0.8.14
+            key: ${{ runner.os }}-jacoco-cli-${{ hashFiles('generate-jacoco-report.sh') }}
+            restore-keys: |
+                ${{ runner.os }}-jacoco-cli-
+
       - name: Build with Maven
         run: mvn --batch-mode --update-snapshots package
 
+      - name: Generate JaCoCo Report
+        run: |
+         chmod +x ./generate-jacoco-report.sh
+         ./generate-jacoco-report.sh
+
+      - name: Upload JaCoCo Report
+        uses: actions/upload-artifact@v4
+        with:
+            name: JaCoCo Coverage Report
+            path: target/coverage-reports/site
+
       - name: JUnit test report
         uses: mikepenz/action-junit-report@v5
         if: always()

README.md

@@ -11,7 +11,7 @@ with nfs4.1-files and flex-files layout types.
 Building from sources
 ---------------------
 
-To build nfs4j from source code Java11 and Maven3 are required.
+To build nfs4j from source code Java17 and Maven4 are required.
 
 To run benchmarks:
 

benchmarks/jmh-result.json

@@ -0,0 +1,91 @@
+#!/bin/bash
+
+# Define paths
+PROJECT_ROOT="${PROJECT_ROOT:-$(pwd)}"
+JACOCO_VERSION="0.8.14"
+JACOCO_DIR="$HOME/jacoco-$JACOCO_VERSION"
+JACOCO_CLI_JAR="$JACOCO_DIR/lib/jacococli.jar"
+MERGED_EXEC="$PROJECT_ROOT/target/coverage-reports/merged.exec"
+REPORT_DIR="$PROJECT_ROOT/target/coverage-reports/site"
+
+# Ensure the report directory exists
+mkdir -p "$REPORT_DIR"
+
+# Debug: Print paths
+echo "DEBUG: JACOCO_CLI_JAR: $JACOCO_CLI_JAR"
+echo "DEBUG: Checking if $JACOCO_CLI_JAR exists..."
+
+# Check if JaCoCo CLI JAR exists in the cache directory
+if [ ! -f "$JACOCO_CLI_JAR" ]; then
+    echo "JaCoCo CLI JAR not found in cache directory. Downloading..."
+    mkdir -p "$JACOCO_DIR"
+    wget -q "https://github.com/jacoco/jacoco/releases/download/v$JACOCO_VERSION/jacoco-$JACOCO_VERSION.zip" -O "/tmp/jacoco-$JACOCO_VERSION.zip"
+    unzip -q "/tmp/jacoco-$JACOCO_VERSION.zip" -d "$JACOCO_DIR"
+    rm -f "/tmp/jacoco-$JACOCO_VERSION.zip"
+    echo "DEBUG: Downloaded JaCoCo CLI to $JACOCO_DIR"
+    ls -la "$JACOCO_DIR"
+else
+    echo "DEBUG: JaCoCo CLI JAR found at $JACOCO_CLI_JAR"
+fi
+
+# Check if JaCoCo CLI JAR exists after download
+if [ ! -f "$JACOCO_CLI_JAR" ]; then
+    echo "Error: JaCoCo CLI JAR not found at $JACOCO_CLI_JAR"
+    exit 1
+fi
+
+# Find all jacoco-ut.exec files dynamically
+EXEC_FILES=($(find "$PROJECT_ROOT" -name "jacoco-ut.exec" -type f))
+
+# Check if any execution data files were found
+if [ ${#EXEC_FILES[@]} -eq 0 ]; then
+    echo "Error: No jacoco-ut.exec files found in $PROJECT_ROOT"
+    exit 1
+fi
+
+# Check if all execution data files exist
+for exec_file in "${EXEC_FILES[@]}"; do
+    if [ ! -f "$exec_file" ]; then
+        echo "Error: Execution data file not found at $exec_file"
+        exit 1
+    fi
+done
+
+# Merge execution data files
+echo "Merging execution data files..."
+java -jar "$JACOCO_CLI_JAR" merge "${EXEC_FILES[@]}" --destfile "$MERGED_EXEC"
+
+if [ $? -ne 0 ]; then
+    echo "Error: Failed to merge execution data files"
+    exit 1
+fi
+
+# Generate the coverage report
+echo "Generating coverage report..."
+
+# Build classfiles and sourcefiles arguments dynamically
+CLASSFILES_ARGS=()
+SOURCEFILES_ARGS=()
+
+for exec_file in "${EXEC_FILES[@]}"; do
+    # Extract module path (e.g., core, dlm, rquota) from the exec file path
+    module_path=$(dirname "$(dirname "$(dirname "$exec_file")")")
+    module_name=$(basename "$module_path")
+
+    # Add classfiles and sourcefiles arguments
+    CLASSFILES_ARGS+=("--classfiles" "$module_path/target/classes")
+    SOURCEFILES_ARGS+=("--sourcefiles" "$module_path/src/main/java")
+done
+
+# Generate the report with dynamic arguments
+java -jar "$JACOCO_CLI_JAR" report "$MERGED_EXEC" \
+    "${CLASSFILES_ARGS[@]}" \
+    "${SOURCEFILES_ARGS[@]}" \
+    --html "$REPORT_DIR"
+
+if [ $? -ne 0 ]; then
+    echo "Error: Failed to generate coverage report"
+    exit 1
+fi
+
+echo "Coverage report generated successfully at ${REPORT_DIR}/index.html"

generate-jacoco-report.sh

@@ -96,7 +96,7 @@
         <plugin>
             <groupId>org.jacoco</groupId>
             <artifactId>jacoco-maven-plugin</artifactId>
-            <version>0.8.12</version>
+            <version>0.8.14</version>
             <executions>
                 <!--
                     Prepares the property pointing to the JaCoCo runtime agent which