Add code coverage ignore file

[jennuine]

🎉 New feature

Part of gazebosim/gz-sim#1575

Requires: gazebosim/gz-cmake#279

Summary

Adds coverage.ignore.in, which lists files to ignore in the coverage report

Test it

In the root of your colcon workspace:

colcon build --cmake-args -DBUILD_TESTING=ON -DCMAKE_BUILD_TYPE=Coverage --merge-install --packages-select ignition-utils1 --event-handlers console_direct+

# when testing with this PR, you should see a message:
# Ignore coverage additions: '/path/to/ws/src/ign-utils/cli/include/vendored-cli/*'

cd build/ignition-utils1
make test -j8
make coverage VERBOSE=1 -j8

# when testing with PR, you should see the file listed in the command:
# /usr/bin/lcov -q --remove coverage.info '*/test/*' '/usr/*' '*_TEST*' '*.cxx' 'moc_*.cpp' 'qrc_*.cpp' '*.pb.*' '*/build/*' '*/install/*' '/path/to/ws/src/ign-utils/cli/include/vendored-cli/*' --output-file coverage.info.cleaned

firefox coverage/index.html

Before PR

After PR

You can try adding other random files / directories and rerunning the above commands again

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.

[codecov]

Codecov Report

Merging #72 (52c8efd) into ign-utils1 (64fea9a) will increase coverage by 50.82%.
The diff coverage is n/a.

❗ Current head 52c8efd differs from pull request most recent head cde0cfb. Consider uploading reports for the commit cde0cfb to get more accurate results

@@               Coverage Diff               @@
##           ign-utils1      #72       +/-   ##
===============================================
+ Coverage       41.14%   91.97%   +50.82%     
===============================================
  Files              17        6       -11     
  Lines            2326      137     -2189     
===============================================
- Hits              957      126      -831     
+ Misses           1369       11     -1358     

Impacted Files	Coverage Δ
...lude/vendored-cli/ignition/utils/cli/Formatter.hpp
...ude/vendored-cli/ignition/utils/cli/Validators.hpp
...lude/vendored-cli/ignition/utils/cli/ConfigFwd.hpp
...include/vendored-cli/ignition/utils/cli/Option.hpp
...e/vendored-cli/ignition/utils/cli/FormatterFwd.hpp
...include/vendored-cli/ignition/utils/cli/Config.hpp
.../include/vendored-cli/ignition/utils/cli/Error.hpp
...de/vendored-cli/ignition/utils/cli/StringTools.hpp
...li/include/vendored-cli/ignition/utils/cli/App.hpp
...lude/vendored-cli/ignition/utils/cli/TypeTools.hpp
... and 1 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 64fea9a...cde0cfb. Read the comment docs.

[AzulRadio]

The ignore list looks good to me.

[chapulina]

increase coverage by 50.82%.

🚀