From 0de4f8de4a2501a904dcd912bae032c6fb4b1e72 Mon Sep 17 00:00:00 2001
From: Nicola Vetrini <nicola.vetrini@bugseng.com>
Date: Wed, 16 Jul 2025 21:30:22 +0200
Subject: [PATCH] sca: eclair: Make ECLAIR project root configurable.

The project root was set unconditionally as the variable ZEPHYR_BASE,
but users developing a Zephyr application may wish to override the project
root used by ECLAIR as the base directory of their projects, so that
all paths processed by the tool are relative to that directory.

- A new cmake variable ECLAIR_PROJECT_ROOT is introduced;
- additional messages to output this information before the build starts.

Signed-off-by: Nicola Vetrini <nicola.vetrini@bugseng.com>
---
 cmake/sca/eclair/eclair.template |  3 ++-
 cmake/sca/eclair/sca.cmake       | 13 +++++++++----
 2 files changed, 11 insertions(+), 5 deletions(-)

diff --git a/cmake/sca/eclair/eclair.template b/cmake/sca/eclair/eclair.template
index fd7b0fe8b77..d82824edb87 100644
--- a/cmake/sca/eclair/eclair.template
+++ b/cmake/sca/eclair/eclair.template
@@ -18,7 +18,8 @@ foreach(i RANGE ${end_of_options} ${CMAKE_ARGC})
 endforeach()
 
 list(APPEND ECLAIR_ARGS +incremental
-                        -project_name=@ECLAIR_PROJECT_NAME@ -project_root=@ZEPHYR_BASE@
+                        -project_name=@ECLAIR_PROJECT_NAME@
+                        -project_root=@ECLAIR_PROJECT_ROOT@
                         -eval_file=@ECLAIR_ECL_DIR@/analysis.ecl
                         -eval_file=@ECLAIR_ANALYSIS_ECL_DIR@/analysis_@ECLAIR_RULESET@.ecl
                         @ECLAIR_ENV_ADDITIONAL_OPTIONS@)
diff --git a/cmake/sca/eclair/sca.cmake b/cmake/sca/eclair/sca.cmake
index 0c98bd174fc..e5e2b311095 100644
--- a/cmake/sca/eclair/sca.cmake
+++ b/cmake/sca/eclair/sca.cmake
@@ -24,6 +24,7 @@ endif()
 
 # ECLAIR Settings
 set(ECLAIR_PROJECT_NAME "Zephyr-${BOARD}${BOARD_QUALIFIERS}")
+set(ECLAIR_PROJECT_ROOT "${ZEPHYR_BASE}")
 set(ECLAIR_OUTPUT_DIR "${CMAKE_BINARY_DIR}/sca/eclair")
 set(ECLAIR_ECL_DIR "${ZEPHYR_BASE}/cmake/sca/eclair/ECL")
 set(ECLAIR_ANALYSIS_ECL_DIR "${ZEPHYR_BASE}/cmake/sca/eclair/ECL")
@@ -112,12 +113,15 @@ if (ECLAIR_FULL_HTL)
   list(APPEND ECLAIR_REPORT_ADDITIONAL_OPTIONS "-full_html=${ECLAIR_OUTPUT_DIR}/report_full_html")
 endif()
 
-message(STATUS "ECLAIR outputs have been written to: ${ECLAIR_OUTPUT_DIR}")
-message(STATUS "ECLAIR ECB files have been written to: ${ECLAIR_ANALYSIS_DATA_DIR}")
+message(STATUS "ECLAIR project name: ${ECLAIR_PROJECT_NAME}")
+message(STATUS "ECLAIR project root is: ${ECLAIR_PROJECT_ROOT}")
+message(STATUS "ECLAIR outputs will be written to: ${ECLAIR_OUTPUT_DIR}")
+message(STATUS "ECLAIR ECB files will be written to: ${ECLAIR_ANALYSIS_DATA_DIR}")
 
 list(APPEND ECLAIR_CLEAN_ARGS
                         +clean
-                        -project_name=${ECLAIR_PROJECT_NAME} -project_root=${ZEPHYR_BASE}
+                        -project_name=${ECLAIR_PROJECT_NAME}
+                        -project_root=${ECLAIR_PROJECT_ROOT}
                         -eval_file=${ECLAIR_ECL_DIR}/analysis.ecl
                         -eval_file=${ECLAIR_ANALYSIS_ECL_DIR}/analysis_${ECLAIR_RULESET}.ecl
                         ${ECLAIR_ENV_ADDITIONAL_OPTIONS})
@@ -142,7 +146,8 @@ set(CMAKE_C_COMPILER_LAUNCHER ${launch_environment} CACHE INTERNAL "")
 
 list(APPEND ECLAIR_PROJECT_ARGS
                         +project
-                        -project_name=${ECLAIR_PROJECT_NAME} -project_root=${ZEPHYR_BASE}
+                        -project_name=${ECLAIR_PROJECT_NAME}
+                        -project_root=${ECLAIR_PROJECT_ROOT}
                         -eval_file=${ECLAIR_ECL_DIR}/analysis.ecl
                         -eval_file=${ECLAIR_ANALYSIS_ECL_DIR}/analysis_${ECLAIR_RULESET}.ecl
                         ${ECLAIR_ENV_ADDITIONAL_OPTIONS})