zephyr/cmake/sca/codechecker/sca.cmake
Noah Pendleton f61950a782 cmake: sca: Enable CodeChecker error exit status
Normally the return code of `CodeChecker analyze` and `CodeChecker parse`
is suppressed, so all the enabled commands can execute instead of
crashing the build.

Add a new option, `CODECHECKER_PARSE_EXIT_STATUS`, to permit failing the
build if `CodeChecker parse` returns non-zero.

Signed-off-by: Noah Pendleton <noah.pendleton@gmail.com>
2024-06-15 05:14:48 -04:00

94 lines
2.8 KiB
CMake

# SPDX-License-Identifier: Apache-2.0
#
# Copyright (c) 2023, Basalte bv
find_program(CODECHECKER_EXE NAMES CodeChecker codechecker REQUIRED)
message(STATUS "Found SCA: CodeChecker (${CODECHECKER_EXE})")
# CodeChecker uses the compile_commands.json as input
set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
# Create an output directory for our tool
set(output_dir ${CMAKE_BINARY_DIR}/sca/codechecker)
file(MAKE_DIRECTORY ${output_dir})
# Use a dummy file to let CodeChecker know we can start analyzing
set_property(GLOBAL APPEND PROPERTY extra_post_build_commands COMMAND
${CMAKE_COMMAND} -E touch ${output_dir}/codechecker.ready)
set_property(GLOBAL APPEND PROPERTY extra_post_build_byproducts
${output_dir}/codechecker.ready)
add_custom_target(codechecker ALL
COMMAND ${CODECHECKER_EXE} analyze
--keep-gcc-include-fixed
--keep-gcc-intrin
--output ${output_dir}/codechecker.plist
--name zephyr # Set a default metadata name
${CODECHECKER_ANALYZE_OPTS}
${CMAKE_BINARY_DIR}/compile_commands.json
|| ${CMAKE_COMMAND} -E true # allow to continue processing results
DEPENDS ${CMAKE_BINARY_DIR}/compile_commands.json ${output_dir}/codechecker.ready
BYPRODUCTS ${output_dir}/codechecker.plist
VERBATIM
USES_TERMINAL
COMMAND_EXPAND_LISTS
)
# Cleanup dummy file
add_custom_command(
TARGET codechecker POST_BUILD
COMMAND ${CMAKE_COMMAND} -E rm ${output_dir}/codechecker.ready
)
# If 'codechecker parse' returns an exit status of '2', it means more than 0
# issues were detected. Suppress the exit status by default, but permit opting
# in to the failure.
if(NOT CODECHECKER_PARSE_EXIT_STATUS)
set(CODECHECKER_PARSE_OPTS ${CODECHECKER_PARSE_OPTS} || ${CMAKE_COMMAND} -E true)
endif()
if(CODECHECKER_EXPORT)
string(REPLACE "," ";" export_list ${CODECHECKER_EXPORT})
foreach(export_item IN LISTS export_list)
message(STATUS "CodeChecker export: ${CMAKE_BINARY_DIR}/codechecker.${export_item}")
add_custom_command(
TARGET codechecker POST_BUILD
COMMAND ${CODECHECKER_EXE} parse
${output_dir}/codechecker.plist
--export ${export_item}
--output ${output_dir}/codechecker.${export_item}
${CODECHECKER_PARSE_OPTS}
BYPRODUCTS ${output_dir}/codechecker.${export_item}
VERBATIM
USES_TERMINAL
COMMAND_EXPAND_LISTS
)
endforeach()
else()
# Output parse results
add_custom_command(
TARGET codechecker POST_BUILD
COMMAND ${CODECHECKER_EXE} parse
${output_dir}/codechecker.plist
${CODECHECKER_PARSE_OPTS}
VERBATIM
USES_TERMINAL
COMMAND_EXPAND_LISTS
)
endif()
if(CODECHECKER_STORE OR CODECHECKER_STORE_OPTS)
add_custom_command(
TARGET codechecker POST_BUILD
COMMAND ${CODECHECKER_EXE} store
${CODECHECKER_STORE_OPTS}
${output_dir}/codechecker.plist
VERBATIM
USES_TERMINAL
COMMAND_EXPAND_LISTS
)
endif()