Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Coverage #682

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Coverage #682

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d7e4e3b
Import CodeCoverage.cmake
marcusmueller Oct 23, 2023
03c81f8
Add Coverage Infrastructure
marcusmueller Oct 23, 2023
7d25032
CodeCoverage: make distinction between CXX and C compiler flags
marcusmueller Oct 23, 2023
b458735
CMake/CodeCoverage: Add source reference
marcusmueller Nov 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,22 @@ endif(ENABLE_ORC)
########################################################################
add_subdirectory(docs)

########################################################################
# Setup Coverage
########################################################################
if(${CMAKE_BUILD_TYPE} STREQUAL "Coverage")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the CodeCoverage.cmake setting the Build_Type to anything other than Debug results in a warning. Either removing that check from there or leaving the CMAKE_BUILD_TYPE alone and just adding a switch to enable coverage would be an option.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is honestly just a mirror of what GR does; looking back, yes, having extra flags instead of a build type of its own would have been a worthwhile option, but I foreseeable won't have time to implement that.

# Use CodeCoverage based on Lars Bilke's
# https://github.com/bilke/cmake-modules , with extensive
# modifications as done in the past for GNU Radio.
include(CodeCoverage)
append_coverage_compiler_flags()
setup_target_for_coverage_gcovr_html(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why only html output and why gcovr? IIRC lcov is the more mature and complete tool. Allowing regular coverage output we can hook that into codecov.io pipelines and add information to pullrequests and pushes to track coverage as we go.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

gcov vs lcov:

TBH, because I looked into lcov first, couldn't make it work, and then resorted to doing what was possible within limited time :)

html:

because I wanted this to be immediately useful for insights, and hence jumped on a minimum effort way of getting readable output. Proper CI integration, including things like complaining when you add code that is specifically not well-covered, is something that needs to come – but having this seemed better than not having it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

gcov vs lcov:

TBH, because I looked into lcov first, couldn't make it work, and then resorted to doing what was possible within limited time :)

html:

because I wanted this to be immediately useful for insights, and hence jumped on a minimum effort way of getting readable output. Proper CI integration, including things like complaining when you add code that is specifically not well-covered, is something that needs to come – but having this seemed better than not having it.

NAME coverage
EXECUTABLE "ctest"
DEPENDENCIES volk_profile
)
endif()

########################################################################
# Detect /lib versus /lib64
########################################################################
Expand Down
Loading
Loading