Add code coverage ignore file

[AzulRadio]

Signed-off-by: youhy [email protected]

New feature

Part of gz-sim#1575

Summary

Allow users to add coverage.ignore.in each repo to ignore files for the code coverage report.

Test it

coverage.ignore.in looks like this:

profiler/src/Remotery/vis/*
graphics/src/tiny_obj_loader.h

It can only take files. Directories will be ignored.

Then add the following line to CMakeList.txt of the package.

configure_file("${PROJECT_SOURCE_DIR}/coverage.ignore.in"
               ${PROJECT_BINARY_DIR}/coverage.ignore)

Code coverage report sometimes doesn't update with the coverage.ignore if we read from source_dir, so adding this extra step to read it from the binary_dir.

Can be test with
gz-common azulradio/codecoverage_ignore branch

Before:

After:

Checklist

• Signed all commits for DCO
• Added tests
• Added example and/or tutorial
• Updated documentation (as needed)
• Updated migration guide (as needed)
• Consider updating Python bindings (if the library has them)
• codecheck passed (See contributing)
• All tests passed (See test coverage)
• While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

[jennuine]

This needs to be updated, I tested the gazebosim/gz-physics#388 PR and this file is still appearing in my local coverage report

[jennuine]

fb7f098 I added a debug message & removed any potential path prefixes from the html report using --prefix ${PROJECT_SOURCE_DIR}. For example, for gz-utils:

w/o removing prefix

w/ removing prefix

---

PRs that are ready to test with:

• citadel: Add code coverage ignore file gz-physics#388
• fortress: Add code coverage ignore file gz-utils#72

[chapulina]

LGTM! Just one final comment

[chapulina]

Yay! Can't wait to see the latest coverage numbers with this in!