traversaro
commented
1 year ago I never setup code coverage integration in our projects, but let's try. For example, an example codebase that integrates coverage is https://github.com/temken/template_cpp_cmake_libphysica .
Let's decompose the practice of doing coverage in some steps:
-
- We just need to add coverage to one CI job, so probably for coverage we can concentrate on the apt job
-
- To collect coverage data, you need to compile all your code with the
--coverageflag, and in Debug mode (to avoid that different lines are merged together or re-ordered by the optimizers). Enabling this option ensure that whenever we run the tests, a.gcnofile is also generated, that contains information on which lines have been tested by the test (see https://gcc.gnu.org/onlinedocs/gcc-12.1.0/gcc/Instrumentation-Options.html for more nfo)
- To collect coverage data, you need to compile all your code with the
-
- Once you have all the .gcno files, you need something to collect them in a structured form, such as gcov or lcov
-
- Then, you need someway to get the files by gcov/lcov and display them. Possible ways to do so are services like codecov (https://about.codecov.io/) or simple github actions like https://github.com/threeal/gcovr-action
Again, I do not have a lot of experience on this, so feel free to explore yourself also in other directions.
lucapa17
@traversaro Do you have any advice for the coverage test? Thank you in advance!