luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-09-20 01:06:15 +02:00
Code Issues Packages Projects Releases Wiki Activity
c242972043
glib/.lcovrc

33 lines
1.1 KiB
Plaintext
Raw Normal View History

ci: Add lcov configuration to ignore g_return_*if_fail()/g_assert*() While we can’t add markers to the macro implementations to cause lcov to ignore them automatically, we can change our lcov configuration to ignore all calls to them. See https://github.com/linux-test-project/lcov/issues/44. This causes all the un-takeable branches and un-reachable assertions to be ignored by our code coverage, which bumps our statistics: • Lines: 74.9% → 74.8% • Functions: 82.3% → 82.3% • Branches: 53.3% → 64.2% The rationale is that nobody should be testing programmer error handling, as g_return_*if_fail() are used to guard against — so it’s not reasonable to count missed branches like that in code coverage statistics. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-10-03 15:47:26 +02:00
# lcov and genhtml configuration
build: Ignore branches in g_clear_*() functions under lcov It’s not useful for lcov to demand branch coverage of all branches within `g_clear_*()` functions (such as `g_clear_pointer()`). By choosing to use `g_clear_*()`, the programmer explicitly doesn’t care about whether the pointer is `NULL`. The tests shouldn’t have to either. Signed-off-by: Philip Withnall <pwithnall@gnome.org>
2024-01-18 14:06:10 +01:00
# See lcovrc(5)
ci: Add lcov configuration to ignore g_return_*if_fail()/g_assert*() While we can’t add markers to the macro implementations to cause lcov to ignore them automatically, we can change our lcov configuration to ignore all calls to them. See https://github.com/linux-test-project/lcov/issues/44. This causes all the un-takeable branches and un-reachable assertions to be ignored by our code coverage, which bumps our statistics: • Lines: 74.9% → 74.8% • Functions: 82.3% → 82.3% • Branches: 53.3% → 64.2% The rationale is that nobody should be testing programmer error handling, as g_return_*if_fail() are used to guard against — so it’s not reasonable to count missed branches like that in code coverage statistics. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-10-03 15:47:26 +02:00
# Always enable branch coverage
lcov_branch_coverage = 1
ci: Also compile C++ files with coverage collection
2024-07-24 11:34:44 +02:00
# Disable exception branch for C++:
# https://github.com/linux-test-project/lcov/issues/209
no_exception_branch = 1
ci: Add lcov configuration to ignore g_return_*if_fail()/g_assert*() While we can’t add markers to the macro implementations to cause lcov to ignore them automatically, we can change our lcov configuration to ignore all calls to them. See https://github.com/linux-test-project/lcov/issues/44. This causes all the un-takeable branches and un-reachable assertions to be ignored by our code coverage, which bumps our statistics: • Lines: 74.9% → 74.8% • Functions: 82.3% → 82.3% • Branches: 53.3% → 64.2% The rationale is that nobody should be testing programmer error handling, as g_return_*if_fail() are used to guard against — so it’s not reasonable to count missed branches like that in code coverage statistics. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-10-03 15:47:26 +02:00
# Exclude precondition assertions, as we can never reasonably get full branch
# coverage of them, as they should never normally fail.
build: Ignore branches in g_clear_*() functions under lcov It’s not useful for lcov to demand branch coverage of all branches within `g_clear_*()` functions (such as `g_clear_pointer()`). By choosing to use `g_clear_*()`, the programmer explicitly doesn’t care about whether the pointer is `NULL`. The tests shouldn’t have to either. Signed-off-by: Philip Withnall <pwithnall@gnome.org>
2024-01-18 14:06:10 +01:00
# Similarly exclude g_clear_*() functions (such as g_clear_object(),
# g_clear_pointer(), etc.) as it’s not useful to test both sides of the branch
# in them.
ci: Add lcov configuration to ignore g_return_*if_fail()/g_assert*() While we can’t add markers to the macro implementations to cause lcov to ignore them automatically, we can change our lcov configuration to ignore all calls to them. See https://github.com/linux-test-project/lcov/issues/44. This causes all the un-takeable branches and un-reachable assertions to be ignored by our code coverage, which bumps our statistics: • Lines: 74.9% → 74.8% • Functions: 82.3% → 82.3% • Branches: 53.3% → 64.2% The rationale is that nobody should be testing programmer error handling, as g_return_*if_fail() are used to guard against — so it’s not reasonable to count missed branches like that in code coverage statistics. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-10-03 15:47:26 +02:00
# See https://github.com/linux-test-project/lcov/issues/44
build: Ignore branches in g_clear_*() functions under lcov It’s not useful for lcov to demand branch coverage of all branches within `g_clear_*()` functions (such as `g_clear_pointer()`). By choosing to use `g_clear_*()`, the programmer explicitly doesn’t care about whether the pointer is `NULL`. The tests shouldn’t have to either. Signed-off-by: Philip Withnall <pwithnall@gnome.org>
2024-01-18 14:06:10 +01:00
lcov_excl_br_line = LCOV_EXCL_BR_LINE|g_return_if_fail|g_return_val_if_fail|g_assert|g_assert_|g_clear_
ci: Add lcov configuration to ignore g_return_*if_fail()/g_assert*() While we can’t add markers to the macro implementations to cause lcov to ignore them automatically, we can change our lcov configuration to ignore all calls to them. See https://github.com/linux-test-project/lcov/issues/44. This causes all the un-takeable branches and un-reachable assertions to be ignored by our code coverage, which bumps our statistics: • Lines: 74.9% → 74.8% • Functions: 82.3% → 82.3% • Branches: 53.3% → 64.2% The rationale is that nobody should be testing programmer error handling, as g_return_*if_fail() are used to guard against — so it’s not reasonable to count missed branches like that in code coverage statistics. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-10-03 15:47:26 +02:00
# Similarly for unreachable assertions.
ci: Ignore lcov errors on source missing When using dtrace some temporary files may be leaked as source files and this may lead to build issues such as geninfo: ERROR: unable to open /builds/GNOME/glib/_build/.dtrace-temp.ed1c5ba9.c: No such file or directory AFAIK there's no way to keep these temporary files around, so the only thing we can do is making lcov less strict about missing files. We can drop the special option from genhtml since it's using the same lcovrc file
2024-05-24 18:00:55 +02:00
lcov_excl_line = LCOV_EXCL_LINE|g_return_if_reached|g_return_val_if_reached|g_assert_not_reached
# When using dtrace some temporary files may be leaked as source files
ignore_errors = source
ci: Update coverage files atomically Since we run tests in parallel we may end up rewriting the coverage info while running files acting on the same source files. The compiler can be smart though, so let's use the proper flag. Despite this, sometimes we may still end up into negative reports, so let's ignore them in CI since it's not worth breaking the build because of these coverage-parsing failures.
2024-05-24 18:53:34 +02:00
# Sometimes we may have negative counting despite using atomic profile update
ignore_errors = negative
ci: Ignore unused patterns gnulib doesn't seem to be used at the moment so its _build folder, but let's still try and don't fail if that's not happening
2024-05-24 19:40:06 +02:00
# gnulib paths may not be used
ignore_errors = unused
ci: Ignore empty lcov files such as the baselines ones
2024-08-02 13:49:51 +02:00
# baseline lcov files may be empty
ignore_errors = empty
Reference in New Issue Copy Permalink