Add lcov code coverage to the release pipeline and Jenkins

- new_docker_build.sh: new --run-coverage mode (mutually exclusive with
  --run-jenkins-builder). Instruments the release-scope build with
  -O0 -g --coverage -fPIC -DNDEBUG (RELEASE flag override keeps -DNDEBUG
  and -fPIC so behavior and PIC match the green baseline), runs ctest,
  then collects the lcov report: capture --external -> extract on the
  four release dirs -> remove test sources -> summary -> genhtml, all
  with --ignore-errors mismatch,inconsistent,unused (GCC 15 + lcov 2.4).
  Report lands in --coverage-output-dir (default ./coverage-out):
  html/index.html, coverage.info, coverage_summary.txt.
- Dockerfile image gains lcov via APT_PACKAGES (genhtml ships in the
  same package).
- Jenkinsfile: RunCoverage parameter (default on) + per-OS Coverage
  stage running the driver on the agent and archiving
  coverage/<project>/<os>/**.
- release-16-10-2026.sh: same coverage step, gated by DRYRUN_COVERAGE
  (default ON, mirrors the Jenkins default).
- README: Step 6 (code coverage) and options/env reference entries.
- .gitignore: coverage-out/
This commit is contained in:
berrux-dev committed 2026-10-15 09:00:33 +02:00
1 parent 676ae05335
commit 684e05109d
7 files changed
+178 -36

No files matched your search

@@ -43,6 +43,13 @@ Package production options (RPM/DEB):
--build-number NUM Build number for package (default: 1)
--build-tag TAG Build tag for package (default: manual-build)
Coverage options (lcov):
--run-coverage Build the release scope with -O0 --coverage, run ctest
and collect an lcov coverage report (mutually
exclusive with --run-jenkins-builder)
--coverage-output-dir DIR Directory to mount for coverage output
(default: ./coverage-out)
Environment variable overrides:
BUILD_PREBUILT_IMAGE=ON|OFF
DELETE_PREBUILT_IMAGE=ON|OFF
@@ -54,6 +61,8 @@ Environment variable overrides:
GUEZ_MODE=ON|OFF
BUILD_NUMBER=<num>
BUILD_TAG=<tag>
RUN_COVERAGE=ON|OFF
COVERAGE_OUTPUT_DIR=<dir>
MIGRATE_PIPELINE_ROOT resolution (highest precedence first):
1. exported MIGRATE_PIPELINE_ROOT (e.g. from a Jenkinsfile)
@@ -67,6 +76,9 @@ Examples:
./new_docker_build.sh --docker-image legatus-qt6:1.0 \
--run-jenkins-builder \
--package-output-dir "${WORKSPACE}/rpms/${PROJECT}/${OS_VERSION}/"
./new_docker_build.sh --docker-image legatus-qt6:1.0 \
--run-coverage \
--coverage-output-dir "${WORKSPACE}/coverage/${PROJECT}/${OS_VERSION}/"
EOF
}
@@ -184,6 +196,8 @@ APT_PACKAGES=(
postgresql-server-dev-all
git
python3-pip
# Code coverage (genhtml ships in the same package)
lcov
# Packaging tools for RPM/DEB build
rpm
debhelper
@@ -295,6 +309,9 @@ DELETE_PREBUILT_IMAGE="${DELETE_PREBUILT_IMAGE:-OFF}"
# Jenkins builder options for RPM/DEB package production
RUN_JENKINS_BUILDER="${RUN_JENKINS_BUILDER:-OFF}"
PACKAGE_OUTPUT_DIR="${PACKAGE_OUTPUT_DIR:-./packages-out}"
# Code coverage (lcov)
RUN_COVERAGE="${RUN_COVERAGE:-OFF}"
COVERAGE_OUTPUT_DIR="${COVERAGE_OUTPUT_DIR:-./coverage-out}"
LTS_VERSION="${LTS_VERSION:-1.0}"
PROJECT="${PROJECT:-guez}"
GUEZ_MODE="${GUEZ_MODE:-ON}"
@@ -327,6 +344,14 @@ while [[ $# -gt 0 ]]; do
[[ $# -gt 0 ]] || die "--package-output-dir requires a directory path"
PACKAGE_OUTPUT_DIR="$1"
;;
--run-coverage)
RUN_COVERAGE=ON
;;
--coverage-output-dir)
shift
[[ $# -gt 0 ]] || die "--coverage-output-dir requires a directory path"
COVERAGE_OUTPUT_DIR="$1"
;;
--lts-version)
shift
[[ $# -gt 0 ]] || die "--lts-version requires a version string"
@@ -362,12 +387,17 @@ done
BUILD_PREBUILT_IMAGE="$(normalize_on_off "$BUILD_PREBUILT_IMAGE" "BUILD_PREBUILT_IMAGE")"
DELETE_PREBUILT_IMAGE="$(normalize_on_off "$DELETE_PREBUILT_IMAGE" "DELETE_PREBUILT_IMAGE")"
RUN_JENKINS_BUILDER="$(normalize_on_off "$RUN_JENKINS_BUILDER" "RUN_JENKINS_BUILDER")"
RUN_COVERAGE="$(normalize_on_off "$RUN_COVERAGE" "RUN_COVERAGE")"
if [[ "${RUN_COVERAGE}" == "ON" && "${RUN_JENKINS_BUILDER}" == "ON" ]]; then
die "--run-coverage is mutually exclusive with --run-jenkins-builder"
fi
# Default for the Docker image name
DOCKER_IMAGE="${DOCKER_IMAGE:-legatus-qt6-prebuilt:latest}"
# Export variables for Docker container
export RELEASE_BUILD RUN_CTEST BUILD_PREBUILT_IMAGE DELETE_PREBUILT_IMAGE DOCKER_IMAGE RUN_JENKINS_BUILDER PACKAGE_OUTPUT_DIR LTS_VERSION PROJECT GUEZ_MODE BUILD_NUMBER BUILD_TAG
export RELEASE_BUILD RUN_CTEST BUILD_PREBUILT_IMAGE DELETE_PREBUILT_IMAGE DOCKER_IMAGE RUN_JENKINS_BUILDER PACKAGE_OUTPUT_DIR RUN_COVERAGE COVERAGE_OUTPUT_DIR LTS_VERSION PROJECT GUEZ_MODE BUILD_NUMBER BUILD_TAG
require_non_empty "${DOCKER_IMAGE}" "DOCKER_IMAGE"
@@ -391,6 +421,8 @@ log_info "DELETE_PREBUILT_IMAGE=${DELETE_PREBUILT_IMAGE}"
log_info "DOCKER_IMAGE=${DOCKER_IMAGE}"
log_info "RUN_JENKINS_BUILDER=${RUN_JENKINS_BUILDER}"
log_info "PACKAGE_OUTPUT_DIR=${PACKAGE_OUTPUT_DIR}"
log_info "RUN_COVERAGE=${RUN_COVERAGE}"
log_info "COVERAGE_OUTPUT_DIR=${COVERAGE_OUTPUT_DIR}"
log_info "LTS_VERSION=${LTS_VERSION}"
log_info "PROJECT=${PROJECT}"
log_info "GUEZ_MODE=${GUEZ_MODE}"
@@ -426,6 +458,7 @@ RELEASE_BUILD="${RELEASE_BUILD:-ON}"
RUN_CTEST="${RUN_CTEST:-ON}"
# Packaging variables
RUN_JENKINS_BUILDER="${RUN_JENKINS_BUILDER:-OFF}"
RUN_COVERAGE="${RUN_COVERAGE:-OFF}"
LTS_VERSION="${LTS_VERSION:-1.0}"
PROJECT="${PROJECT:-guez}"
GUEZ_MODE="${GUEZ_MODE:-ON}"
@@ -457,12 +490,29 @@ cd build4
# RELEASE_BUILD=ON selects the release scope (TetraIF, Z/src, Lts/Common +
# TrainingAreaBase); all other BUILD_* flags are left at their CMake defaults.
COV_CMAKE_ARGS=()
if [[ "${RUN_COVERAGE}" == "ON" ]]; then
# Instrument the Release build with gcov. CMAKE_<LANG>_FLAGS_RELEASE replaces
# the default "-O3 -DNDEBUG" entirely, so -O0/--coverage must be carried
# there (plain CMAKE_<LANG>_FLAGS would come first on the command line and
# lose to -O3); -DNDEBUG is kept so behavior matches the standard build.
# -fPIC: plain static libs (e.g. tabTelegrams) are not PIC by default and
# are linked into shared libraries - at -O0 the non-PIC relocations show up
# at link time. Never add USE_IPO/USE_UNITY_BUILD here - LTO breaks gcov.
COV_CMAKE_ARGS=(
"-DCMAKE_C_FLAGS_RELEASE=-O0 -g --coverage -DNDEBUG -fPIC"
"-DCMAKE_CXX_FLAGS_RELEASE=-O0 -g --coverage -DNDEBUG -fPIC"
"-DCMAKE_EXE_LINKER_FLAGS=--coverage"
"-DCMAKE_SHARED_LINKER_FLAGS=--coverage"
)
fi
cmake .. \
-DBUILD_TESTING=ON \
-DRELEASE_BUILD="${RELEASE_BUILD}" \
-DCMAKE_CXX_STANDARD=17 \
-DCMAKE_BUILD_TYPE=Release \
-DCMAKE_PREFIX_PATH="${QT_BASE_DIR}/${QT_VERSION}/${QT_ARCH_DIR}:/usr/local"
-DCMAKE_PREFIX_PATH="${QT_BASE_DIR}/${QT_VERSION}/${QT_ARCH_DIR}:/usr/local" \
"${COV_CMAKE_ARGS[@]}"
read -r -a RELEASE_TARGETS_ARRAY <<< "${RELEASE_BUILD_TARGETS}"
@@ -479,6 +529,56 @@ else
log_info "Skipping CTest"
fi
# Code coverage (lcov): capture, filter to the release scope and generate the
# HTML report. Runs only in --run-coverage mode, after ctest (so the .gcda
# data files exist). cwd is build4, so --directory . is the build tree; all
# artifacts are written via absolute paths.
if [[ "${RUN_COVERAGE}" == "ON" ]]; then
log_info "=== Code coverage (lcov) ==="
COVOUT=/workspace/coverage-out
SRCROOT=/workspace/qt-migration-legatus/qt6-after/qt6-migrated-legatus
mkdir -p "${COVOUT}"
# GCC 15 + lcov 2.x: the branch data (libstdc++, Qt headers and some of
# our sources) trips lcov's consistency checks (mismatch / inconsistent),
# and a filter pattern that matches no file is an "unused" error. The
# extract step below keeps only the release scope, so these quirks do not
# affect the report - ignore those error classes on every step.
COV_IGNORE=(--ignore-errors mismatch,inconsistent,unused)
lcov --capture --directory . --external "${COV_IGNORE[@]}" \
--rc branch_coverage=1 \
--output-file "${COVOUT}/raw.info"
lcov --extract "${COVOUT}/raw.info" \
"${SRCROOT}/TetraIF/*" \
"${SRCROOT}/Z/src/*" \
"${SRCROOT}/Lts/Common/*" \
"${SRCROOT}/Lts/Proxies/TrainingAreaBase/*" \
"${COV_IGNORE[@]}" \
--rc branch_coverage=1 \
--output-file "${COVOUT}/scoped.info"
lcov --remove "${COVOUT}/scoped.info" \
"*/unit-test/*" \
"*CommonUnitTestsPlaceholder*" \
"*/UnitTests/*" \
"*/tests/*" \
"*/test_*" \
"*_test.cpp" \
"*_test.h" \
"*_unit_test*" \
"${COV_IGNORE[@]}" \
--rc branch_coverage=1 \
--output-file "${COVOUT}/coverage.info"
lcov --summary "${COVOUT}/coverage.info" "${COV_IGNORE[@]}" --rc branch_coverage=1 \
> "${COVOUT}/coverage_summary.txt"
genhtml "${COVOUT}/coverage.info" \
--output-directory "${COVOUT}/html" \
"${COV_IGNORE[@]}" \
--branch-coverage --legend \
--rc branch_coverage=1
log_info "Coverage report written to ${COVOUT} (host: ${COVERAGE_OUTPUT_DIR})"
cat "${COVOUT}/coverage_summary.txt"
fi
# DEB package production with the in-tree rpmbuild script
if [[ "${RUN_JENKINS_BUILDER}" == "ON" ]]; then
log_info "=== DEB Package Production (in-tree rpmbuild) ==="
@@ -551,6 +651,8 @@ docker run --rm \
-e RELEASE_BUILD \
-e RUN_CTEST \
-e RUN_JENKINS_BUILDER \
-e RUN_COVERAGE \
-e COVERAGE_OUTPUT_DIR \
-e PACKAGE_OUTPUT_DIR \
-e LTS_VERSION \
-e PROJECT \
@@ -566,5 +668,6 @@ docker run --rm \
-v "${MIGRATE_PIPELINE_ROOT}/external:/workspace/external:ro" \
-v "${CONTAINER_SCRIPT_HOST}:/tmp/run-build-inside-container.sh:ro" \
-v "${PACKAGE_OUTPUT_DIR}:/workspace/packages-out" \
-v "${COVERAGE_OUTPUT_DIR}:/workspace/coverage-out" \
"${DOCKER_IMAGE}" \
bash /tmp/run-build-inside-container.sh