kcov
Kcov is a Linux/OSX code coverage tester for compiled languages, Python and Bash. Kcov was originally a fork of Bcov, but has since evolved to support a large feature set in addition to that of Bcov.
Kcov, like Bcov, uses DWARF debugging information for compiled programs to make it possible to collect coverage information without special compiler switches.
Installing
Refer to the INSTALL file for build instructions, or use one of the pre-built Docker images:
- ragnaroek/kcov for releases since v31
- ragnaroek/kcov_head for the latest git HEAD (might be unstable)
How to use it
Basic usage is straight-forward:
kcov /path/to/outdir executable [args for the executable]
/path/to/outdir will contain lcov-style HTML output generated continuously while the application runs. Kcov will also write cobertura- compatible XML output and can upload coverage data directly to http://coveralls.io for easy integration with travis-ci. A generic coverage.json report is also generated which contains summaries for a given binary and each source file.
Filtering output
It's often useful to filter output, since e.g., /usr/include is seldom of interest. This can be done in two ways:
kcov --exclude-pattern=/usr/include --include-pattern=part/of/path,other/path \
/path/to/outdir executable
which will do a string-comparison and include everything which contains part/of/path or other/path but exclude everything that has the /usr/include string in it.
kcov --include-path=/my/src/path /path/to/outdir executable
kcov --exclude-path=/usr/include /path/to/outdir executable
Does the same thing, but with proper path lookups.
Use from continuous integration systems
kcov is easy to integrate with travis-ci together with coveralls.io or codecov.io. It can also be used from Jenkins, SonarQube and GitLab CI. Refer to
- coveralls for details about travis-ci + coveralls, or
- codecov for details about travis-ci + codecov
- jenkins for details about how to integrate in Jenkins
- sonarqube for how to use kcov and sonarqube together
- gitlab for use with GitLab
Full-system instrumentation
Kcov can instrument all binaries with very low overhead for embedded systems. Refer to the full system instrumentation documentation for details.
More information
kcov is written by Simon Kagstrom simon.kagstrom@gmail.com and more information can be found at the web page