feat(sonar): Add optional static analysis with sonarcube

It is part of the helper script, since the build job is done in docker
(and the docker image is used for testing).

So sonar setup is done in container in 1st stage of image (builder)
to avoid taiting the multistage docker image small (used for testing).

The analysis will be done outside the build part,
since it requiere online resources (in a github action),
check following commits.

Origin: SiliconLabsSoftware/z-wave-engine-application-layer#73
Relate-to: #100
Last-Update: 2025-07-16
Forwarded: #134
Signed-off-by: Philippe Coval <[email protected]>

Author: rzr

CMakeLists.txt

@@ -4,6 +4,13 @@ project(z-wave-protocol-controller)
 # ##############################################################################
 # Include Configurations
 # ##############################################################################
+set(CMAKE_POSITION_INDEPENDENT_CODE ON) 
+option(COVERAGE "Enable coverage reporting" OFF)
+if(COVERAGE AND CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang")
+    message(STATUS "Building with code coverage")
+    add_compile_options(--coverage -O0 -g)
+    add_link_options(--coverage)
+endif()
 
 include(cmake/include/version.cmake)
 include(cmake/include/build_permutations.cmake)

helper.mk

@@ -23,6 +23,7 @@ version?=$(shell git describe --tags --always 2> /dev/null || echo "0")
 BUILD_DEV_GUI?=OFF
 BUILD_IMAGE_PROVIDER?=ON
 
+cmake?=cmake
 cmake_options?=-B ${build_dir}
 
 CMAKE_GENERATOR?=Ninja
@@ -31,6 +32,8 @@ export CMAKE_GENERATOR
 build_dir?=build
 sudo?=sudo
 
+default_rules?=configure prepare all test dist
+
 debian_codename?=bookworm
 
 packages?=cmake ninja-build build-essential python3-full ruby clang
@@ -40,6 +43,7 @@ packages+=python3-defusedxml # For extract_get.py
 # TODO: remove for offline build
 packages+=curl wget python3-pip
 packages+=expect
+packages+=gcovr
 
 # For docs
 packages+=graphviz
@@ -62,6 +66,33 @@ rust_url?=https://sh.rustup.rs
 RUST_VERSION?=1.71.0
 export PATH := ${HOME}/.cargo/bin:${PATH}
 
+app_dir?=opt
+
+# To be overloaded from env
+BRANCH_NAME?=tmp/local/${USER}/main
+SONAR_HOST_URL?=https://sonarcloud.io)
+SONAR_TOKEN?=${USER}
+
+sonar_bw_url?=${SONAR_HOST_URL}/static/cpp/build-wrapper-linux-x86.zip
+sonar_bw_file?=$(shell basename -- ${sonar_bw_url})
+sonar_bw_app?=${app_dir}/build-wrapper-linux-x86/build-wrapper-linux-x86-64
+sonar_bw_out_file?=${SONAR_OUT_DIR}/compile_commands.json
+
+sonar_scanner_url?=https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-7.1.0.4889-linux-x64.zip
+sonar_scanner_file?=$(shell basename -- ${sonar_scanner_url})
+sonar_scanner_app?=${app_dir}/sonar-scanner-7.1.0.4889-linux-x64/bin/sonar-scanner
+
+ifndef SONAR_OUT_DIR
+gcovr?=gcovr
+coverage_file?=${build_dir}/coverage.xml
+sonar_bw_cmdline?=
+else
+default_rules+=coverage sonar/deploy sonar/dist
+cmake_options+=-DCOVERAGE=ON
+gcovr?=gcovr --sonarqube
+sonar_bw_cmdline?=${sonar_bw_app} --out-dir "${SONAR_OUT_DIR}"
+coverage_file?=${SONAR_OUT_DIR}/coverage.xml
+endif
 
 # Allow overloading from env if needed
 ifdef VERBOSE
@@ -166,7 +197,7 @@ setup/cmake:
 		--prefix=/usr/local \
 		--skip-license
 	rm -v "${cmake_filename}"
-	cmake --version
+	${cmake} --version
 
 setup-cmake: setup/cmake
 
@@ -198,6 +229,54 @@ setup/debian/bookworm: setup/debian setup/rust setup/python setup/plantuml
 setup: setup/debian/${debian_codename}
 	date -u
 
+${sonar_bw_app}:
+	@echo "${project}: log: TODO: https://community.sonarsource.com/t/are-sonar-tools-versionned-on-public-sources/144031"
+	mkdir -p "${@D}"
+	cd "${app_dir}" \
+	&& wget -c "${sonar_bw_url}" \
+	&& unzip "${sonar_bw_file}"
+	file -E "$@"
+
+${sonar_scanner_app}:
+	mkdir -p "${@D}"
+	cd "${app_dir}" \
+	&& wget -c "${sonar_scanner_url}" \
+	&& unzip "${sonar_scanner_file}"
+	file -E "$@"
+
+sonar/configure: configure
+	ls -l ${sonar_bw_out_file}
+
+sonar/setup: ${sonar_bw_app} ${sonar_scanner_app}
+	file -E $^
+
+${SONAR_OUT_DIR}/compile_commands.json: coverage
+	ls $@
+
+sonar/dist: ${coverage_file} sonar-project.properties .scannerwork/report-task.txt
+	@echo "${project}: log: %@: Files for sonar/deploy"
+	ls -l "${sonar_bw_out_file}"
+	ls -l "${coverage_file}"
+	find "${build_dir}" -iname "*.gc*" | wc -l # Can not be processed outside build env
+	tar cvfz "${SONAR_OUT_DIR}/${@F}.tar.gz" $^
+
+
+.scannerwork/report-task.txt: ${sonar_scanner_app}
+	ls "${sonar_bw_out_file}"
+	ls "${coverage_file}"
+	@echo "${project}: log: $@: Uploading data to ${SONAR_HOST_URL}"
+	${<} \
+		--define sonar.branch.name=${BRANCH_NAME} \
+		--define sonar.cfamily.compile-commands="${sonar_bw_out_file}" \
+		--define sonar.coverageReportPaths="${coverage_file}" \
+		--define sonar.host.url="${SONAR_HOST_URL}" \
+		--define sonar.token="${SONAR_TOKEN}" \
+		--debug
+	find .scannerwork -type f
+
+sonar/deploy: .scannerwork/report-task.txt 
+	@echo "${project}: log: TODO: https://community.sonarsource.com/t/new-github-action-for-c-docker-project/136307/5?u=rzr"
+	ls -l $<
 
 git/lfs/prepare:
 	[ ! -r .git/lfs/objects ] \
@@ -225,12 +304,13 @@ reconfigure: configure/clean configure
 	@date -u
 
 ${build_dir}/CMakeCache.txt: CMakeLists.txt
-	cmake ${cmake_options}
+	${sonar_bw_cmdline} ${cmake} ${cmake_options}
 
 all: ${build_dir}/CMakeCache.txt
-#	cmake --build ${<D} \
+#	${sonar_bw_cmdline} ${cmake} --build ${<D} \
 #		|| cat ${build_dir}/CMakeFiles/CMakeOutput.log
-	cmake --build ${<D}
+	${sonar_bw_cmdline} ${cmake} --build ${<D}
+
 .PHONY: all
 
 ${build_dir}/%: all
@@ -239,11 +319,18 @@ ${build_dir}/%: all
 ${build_dir}: ${build_dir}/CMakeCache.txt
 	file -E "$<"
 
-test: ${build_dir}
+test: ${build_dir} all
 	ctest --test-dir ${<}/${project_test_dir}
 
 check: test
 
+coverage: ${coverage_file}
+	ls -l "$<"
+
+${coverage_file}: test all
+	${gcovr} --print-summary -o "$@"
+	ls -l "$@"
+
 zwa_project?=z-wave-stack-binaries
 zwa_ver?=25.1.0-28-g7e0b50f
 zwa_rev?=v${zwa_ver}
@@ -278,14 +365,14 @@ zwa/test: ./scripts/tests/z-wave-stack-binaries-test.sh ${zwa_dir}
 		--zpc.datastore_file=${datastore_file} \
 		--zpc.ota.cache_path=${cache_path} \
 		--log.level=d" \
-		time $< # Add debug=1 to begining of this line to trace 
+		time $< # Add debug=1 to begining of this line to trace
 
 dist/cmake: ${build_dir}
-	cmake --build $< --target package
-	cmake --build $< --target package_archive
+	${cmake} --build $< --target package
+	${cmake} --build $< --target package_archive
 
 dist/deb: ${build_dir}
-	cmake --build $< --target package
+	${cmake} --build $< --target package
 	install -d $</$@
 	cp -av ${<}/*.deb $</$@
 
@@ -296,9 +383,9 @@ distclean:
 
 prepare: git/prepare
 	git --version
-	cmake --version
+	${cmake} --version
 
-all/default: configure prepare all test dist
+all/default: ${default_rules}
 	@date -u
 
 run_args?=--help
@@ -353,6 +440,9 @@ prepare/docker: Dockerfile prepare
 docker_workdir?=/usr/local/opt/${project}
 docker_branch?=main
 docker_url?=${url}.git\#${docker_branch}
+docker_builder_target?=builder
+docker_builder_image?=${project}-${docker_builder_target}
+docker_build_args?=
 
 docker/%: Dockerfile
 	time docker run "${project}:latest" -C "${docker_workdir}" "${@F}"
@@ -363,14 +453,29 @@ test/docker: distclean prepare/docker docker/help docker/test docker/run
 test/docker/build:
 	time docker build -t "${project}:${docker_branch}" ${docker_url}
 
+build/docker:
+	@echo "${project}: log: $@: Multistage build to minimize test image"
+	docker build \
+		--tag "${docker_builder_image}:latest" \
+		--target ${docker_builder_target} \
+		${docker_build_args} \
+		.
+	docker build --tag "${project}:latest" ${docker_build_args} .
+
+dist/docker:
+	@echo "${project}: log: $@: Extract artifacts from multistage build"
+	docker create --name "${docker_builder_image}" "${docker_builder_image}"
+	docker cp ${docker_builder_image}:${docker_workdir}/dist dist
+	docker cp ${docker_builder_image}:${docker_workdir}/${SONAR_OUT_DIR} ${SONAR_OUT_DIR}
+
 docs: ./scripts/build/build_documentation.py doc ${PLANTUML_JAR_PATH} configure
 	@echo "# export PLANTUML_JAR_PATH=${plantuml_dir}/${plantuml_filename}"
 	@echo "$@: PLANTUML_JAR_PATH=${PLANTUML_JAR_PATH}"
 	$< --output-dir $@
 	touch $@/.nojekyll
 
 zpc/docs/api: docs
-	cmake --build build --target  zpc_doxygen
+	${cmake} --build build --target  zpc_doxygen
 	install -d docs/doxygen_zpc
 	cp -rfa build/zpc_doxygen_zpc/html/* docs/doxygen_zpc/
 

sonar-project.properties

@@ -0,0 +1,2 @@
+# https://docs.sonarsource.com/sonarqube-server/latest/project-administration/setting-analysis-scope/introduction/
+sonar.projectKey=z-wave-protocol-controller