michaelh/zephyr
1
0
Fork 0
Code Releases Activity

sca: add HTML summary and full report options to ECLAIR configuration

Browse source 
Introduce ECLAIR_SUMMARY_HTML and ECLAIR_FULL_HTML CMake options to
enable the generation of HTML reports.

Signed-off-by: Luca Ciucci <luca.ciucci@bugseng.com>
This commit is contained in:
Luca Ciucci 2025-05-02 17:31:15 +02:00 • committed by Anas Nashif
commit 24f9ca7178
3 changed files with 14 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

6
cmake/sca/eclair/sca.cmake
View file

@ -84,6 +84,9 @@ endif()
if (ECLAIR_SUMMARY_ODT)
list(APPEND ECLAIR_REPORT_ADDITIONAL_OPTIONS "-summary_odt=${ECLAIR_OUTPUT_DIR}/summary_odt")
endif()
if (ECLAIR_SUMMARY_HTML)
list(APPEND ECLAIR_REPORT_ADDITIONAL_OPTIONS "-summary_html=${ECLAIR_OUTPUT_DIR}/summary_html")
endif()
if (ECLAIR_FULL_TXT_ALL_AREAS)
list(APPEND ECLAIR_REPORT_ADDITIONAL_OPTIONS "-setq=report_areas,areas")
endif()
@ -105,6 +108,9 @@ endif()
if (ECLAIR_FULL_ODT)
list(APPEND ECLAIR_REPORT_ADDITIONAL_OPTIONS "-full_odt=${ECLAIR_OUTPUT_DIR}/report_full_odt")
endif()
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}")

2
cmake/sca/eclair/sca_options.cmake
View file

@ -20,9 +20,11 @@ option(ECLAIR_REPORTS_SARIF "Findings in sarif JSON format" ON)
option(ECLAIR_SUMMARY_TXT "Plain textual summary format" OFF)
option(ECLAIR_SUMMARY_DOC "DOC summary format" OFF)
option(ECLAIR_SUMMARY_ODT "ODT summary format" OFF)
option(ECLAIR_SUMMARY_HTML "HTML summary format" OFF)
option(ECLAIR_FULL_TXT "Detailed plain textual format" ON)
option(ECLAIR_FULL_DOC "Detailed DOC format" OFF)
option(ECLAIR_FULL_ODT "Detailed ODT format" OFF)
option(ECLAIR_FULL_HTML "Detailed HTML format" OFF)
cmake_dependent_option(ECLAIR_FULL_DOC_ALL_AREAS "Show all areas in a full doc report"
OFF "ECLAIR_FULL_DOC OR ECLAIR_FULL_ODT" OFF)

6
doc/develop/sca/eclair.rst
View file

@ -135,12 +135,16 @@ default ecd file. Following additional reports and report formats can be generat
* Summary report in ODT format.
* Summary report in HTML format.
* Detailed reports in txt format.
* Detailed report in DOC format.
* Detailed report in ODT format.
* Detailed report in HTML format.
Related CMake options:
* ``ECLAIR_METRICS_TAB``
@ -149,9 +153,11 @@ Related CMake options:
* ``ECLAIR_SUMMARY_TXT``
* ``ECLAIR_SUMMARY_DOC``
* ``ECLAIR_SUMMARY_ODT``
* ``ECLAIR_SUMMARY_HTML``
* ``ECLAIR_FULL_TXT``
* ``ECLAIR_FULL_DOC``
* ``ECLAIR_FULL_ODT``
* ``ECLAIR_FULL_HTML``
Detail level of full reports
============================