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:
1 parent
676ae05335
commit
684e05109d
7 files changed
+178
-36
No files matched your search
@@ -212,6 +212,45 @@ jenkins-ci-rme/release-16-10-2026.sh
|
||||
|
||||
See `jenkins-ci-rme/README.md` for the pipeline details.
|
||||
|
||||
## Step 6 — Code coverage (lcov)
|
||||
|
||||
```bash
|
||||
export WORKSPACE=/path/to/pipeline-root # e.g. ~/release/qt6-migration-pipeline
|
||||
export PROJECT=guez
|
||||
export OS_VERSION=26.04
|
||||
|
||||
./new_docker_build.sh --docker-image legatus-qt6:1.0 \
|
||||
--run-coverage \
|
||||
--coverage-output-dir "${WORKSPACE}/coverage/${PROJECT}/${OS_VERSION}/" \
|
||||
> /path/to/coverage.log 2>&1
|
||||
```
|
||||
|
||||
(export the variables *before* the command — command-prefix variables are
|
||||
not expanded in the same command's arguments.)
|
||||
|
||||
The driver builds the release scope with `-O0 --coverage`, runs the same ctest
|
||||
suite, then captures the data with lcov: the report covers the release scope
|
||||
(`TetraIF`, `Z/src`, `Lts/Common`, `Lts/Proxies/TrainingAreaBase`), and test
|
||||
sources are filtered out of the report, so the percentages reflect the module
|
||||
code.
|
||||
|
||||
Artifacts in the coverage output directory:
|
||||
|
||||
| File | Contents |
|
||||
|---|---|
|
||||
| `html/index.html` | browsable report (line + branch coverage per file) |
|
||||
| `coverage.info` | machine-readable lcov tracefile |
|
||||
| `coverage_summary.txt` | whole-scope totals |
|
||||
|
||||
`--run-coverage` is mutually exclusive with `--run-jenkins-builder` (different
|
||||
instrumentation of the same build tree).
|
||||
|
||||
The Jenkins pipeline runs the same step on every build (`RunCoverage`
|
||||
parameter, on by default) and archives the report as build artifacts under
|
||||
`coverage/<project>/<os>/`; the local dry run
|
||||
(`jenkins-ci-rme/release-16-10-2026.sh`) does the same, with
|
||||
`DRYRUN_COVERAGE=OFF` to skip coverage there.
|
||||
|
||||
## Options reference
|
||||
|
||||
`./new_docker_build.sh --help` prints the full option list. The main
|
||||
@@ -225,10 +264,13 @@ ones:
|
||||
| `--run-jenkins-builder` | off | produce the DEB packages (Step 4) |
|
||||
| `--package-output-dir DIR` | `./packages-out` | where the DEBs are written |
|
||||
| `--lts-version / --project / --build-number / --build-tag` | `1.0` / `guez` / `1` / `manual-build` | package metadata |
|
||||
| `--run-coverage` | off | coverage build + lcov report (Step 6) |
|
||||
| `--coverage-output-dir DIR` | `./coverage-out` | where the coverage report is written |
|
||||
|
||||
Environment overrides: `DOCKER_IMAGE`, `RUN_JENKINS_BUILDER`,
|
||||
`PACKAGE_OUTPUT_DIR`, `PROJECT`, `LTS_VERSION`, `GUEZ_MODE`,
|
||||
`BUILD_NUMBER`, `BUILD_TAG`, `MIGRATE_PIPELINE_ROOT`.
|
||||
`PACKAGE_OUTPUT_DIR`, `RUN_COVERAGE`, `COVERAGE_OUTPUT_DIR`, `PROJECT`,
|
||||
`LTS_VERSION`, `GUEZ_MODE`, `BUILD_NUMBER`, `BUILD_TAG`,
|
||||
`MIGRATE_PIPELINE_ROOT`.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
|
||||
Reference in new issue
Block a user