Skip to content

Commit 24f9ca7

Browse files
LucaCiuccinashif
authored andcommitted
sca: add HTML summary and full report options to ECLAIR configuration
Introduce ECLAIR_SUMMARY_HTML and ECLAIR_FULL_HTML CMake options to enable the generation of HTML reports. Signed-off-by: Luca Ciucci <[email protected]>
1 parent d8b86f1 commit 24f9ca7

File tree

3 files changed

+14
-0
lines changed

3 files changed

+14
-0
lines changed

cmake/sca/eclair/sca.cmake

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,9 @@ endif()
8484
if (ECLAIR_SUMMARY_ODT)
8585
list(APPEND ECLAIR_REPORT_ADDITIONAL_OPTIONS "-summary_odt=${ECLAIR_OUTPUT_DIR}/summary_odt")
8686
endif()
87+
if (ECLAIR_SUMMARY_HTML)
88+
list(APPEND ECLAIR_REPORT_ADDITIONAL_OPTIONS "-summary_html=${ECLAIR_OUTPUT_DIR}/summary_html")
89+
endif()
8790
if (ECLAIR_FULL_TXT_ALL_AREAS)
8891
list(APPEND ECLAIR_REPORT_ADDITIONAL_OPTIONS "-setq=report_areas,areas")
8992
endif()
@@ -105,6 +108,9 @@ endif()
105108
if (ECLAIR_FULL_ODT)
106109
list(APPEND ECLAIR_REPORT_ADDITIONAL_OPTIONS "-full_odt=${ECLAIR_OUTPUT_DIR}/report_full_odt")
107110
endif()
111+
if (ECLAIR_FULL_HTL)
112+
list(APPEND ECLAIR_REPORT_ADDITIONAL_OPTIONS "-full_html=${ECLAIR_OUTPUT_DIR}/report_full_html")
113+
endif()
108114

109115
message(STATUS "ECLAIR outputs have been written to: ${ECLAIR_OUTPUT_DIR}")
110116
message(STATUS "ECLAIR ECB files have been written to: ${ECLAIR_ANALYSIS_DATA_DIR}")

cmake/sca/eclair/sca_options.cmake

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,11 @@ option(ECLAIR_REPORTS_SARIF "Findings in sarif JSON format" ON)
2020
option(ECLAIR_SUMMARY_TXT "Plain textual summary format" OFF)
2121
option(ECLAIR_SUMMARY_DOC "DOC summary format" OFF)
2222
option(ECLAIR_SUMMARY_ODT "ODT summary format" OFF)
23+
option(ECLAIR_SUMMARY_HTML "HTML summary format" OFF)
2324
option(ECLAIR_FULL_TXT "Detailed plain textual format" ON)
2425
option(ECLAIR_FULL_DOC "Detailed DOC format" OFF)
2526
option(ECLAIR_FULL_ODT "Detailed ODT format" OFF)
27+
option(ECLAIR_FULL_HTML "Detailed HTML format" OFF)
2628

2729
cmake_dependent_option(ECLAIR_FULL_DOC_ALL_AREAS "Show all areas in a full doc report"
2830
OFF "ECLAIR_FULL_DOC OR ECLAIR_FULL_ODT" OFF)

doc/develop/sca/eclair.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,12 +135,16 @@ default ecd file. Following additional reports and report formats can be generat
135135

136136
* Summary report in ODT format.
137137

138+
* Summary report in HTML format.
139+
138140
* Detailed reports in txt format.
139141

140142
* Detailed report in DOC format.
141143

142144
* Detailed report in ODT format.
143145

146+
* Detailed report in HTML format.
147+
144148
Related CMake options:
145149

146150
* ``ECLAIR_METRICS_TAB``
@@ -149,9 +153,11 @@ Related CMake options:
149153
* ``ECLAIR_SUMMARY_TXT``
150154
* ``ECLAIR_SUMMARY_DOC``
151155
* ``ECLAIR_SUMMARY_ODT``
156+
* ``ECLAIR_SUMMARY_HTML``
152157
* ``ECLAIR_FULL_TXT``
153158
* ``ECLAIR_FULL_DOC``
154159
* ``ECLAIR_FULL_ODT``
160+
* ``ECLAIR_FULL_HTML``
155161

156162
Detail level of full reports
157163
============================

0 commit comments

Comments
 (0)