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.
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)
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.
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.
kcov coverage collection is easy to integrate with travis-ci and coveralls.io. To upload data from the travis build to coveralls, run kcov with
kcov --coveralls-id=$TRAVIS_JOB_ID /path/to/outdir executable
which in addition to regular coverage collection uploads to coveralls.
Integrating with codecov is also simple. To upload data from the travis build to codecov, run kcov normally, and then upload using the codecov uploader
kcov /path/to/outdir executable
bash <(curl -s https://codecov.io/bash) -s /path/to/outdir
The easiest way to achieve this is to run the codecov uploader on travis success:
after_success:
- bash <(curl -s https://codecov.io/bash) -s /path/to/outdir
the -s /path/to/outdir part can be skipped if kcov produces output in the current directory.
Using dyninst, Kcov can instrument all binaries with very low overhead for embedded systems. Refer to the full system instrumentation documentation for details.
kcov is written by Simon Kagstrom simon.kagstrom@gmail.com and more information can be found at the web page