grcov collects and aggregates code coverage information for multiple source files.
This is a project initiated by Mozilla to gather code coverage results on Firefox.
- Download grcov from https://github.com/mozilla/grcov/releases or run
cargo install grcov - Run grcov:
USAGE:
grcov [FLAGS] [OPTIONS] <paths>...
FLAGS:
--branch
Enables parsing branch coverage information
-h, --help
Prints help information
--ignore-not-existing
Ignore source files that can't be found on the disk
--llvm
Speeds-up parsing, when the code coverage information is exclusively coming from a llvm build
-V, --version
Prints version information
OPTIONS:
--commit-sha <COMMIT HASH>
Sets the hash of the commit used to generate the code coverage data
--filter <filter>
Filters out covered/uncovered files. Use 'covered' to only return covered files, 'uncovered' to only return
uncovered files [possible values: covered, uncovered]
--ignore-dir <PATH>...
Ignore files/directories specified as globs
-o, --output-file <FILE>
Specifies the output file
-t, --output-type <OUTPUT TYPE>
Sets a custom output type:
- *lcov* for the lcov INFO format;
- *coveralls* for the Coveralls specific format;
- *coveralls+* for the Coveralls specific format with function information;
- *ade* for the ActiveData-ETL specific format;
- *files* to only return a list of files.
[default: lcov] [possible values: ade, lcov, coveralls, coveralls+, files]
--path-mapping <PATH>...
-p, --prefix-dir <PATH>
Specifies a prefix to remove from the paths (e.g. if grcov is run on a different machine than the one that
generated the code coverage information)
--service-job-number <SERVICE JOB NUMBER>
Sets the service job number
--service-name <SERVICE NAME>
Sets the service name
--service-number <SERVICE NUMBER>
Sets the service number
-s, --source-dir <DIRECTORY>
Specifies the root directory of the source files
--threads <NUMBER>
[default: 24]
--token <TOKEN>
Sets the repository token from Coveralls, required for the 'coveralls' and 'coveralls+' formats
ARGS:
<paths>...
Sets the input paths to use
Let's see a few examples, assuming the source directory is ~/Documents/mozilla-central and the build directory is ~/Documents/mozilla-central/build.
grcov ~/Documents/mozilla-central/build -t lcov > lcov.infoAs the LCOV output is compatible with lcov, genhtml can be used to generate a HTML summary of the code coverage:
genhtml -o report/ --show-details --highlight --ignore-errors source --legend lcov.infogrcov ~/Documents/FD/mozilla-central/build -t coveralls -s ~/Documents/FD/mozilla-central --token YOUR_COVERALLS_TOKEN > coveralls.jsonHere is an example of .travis.yml file
language: rust
before_install:
- curl -L https://github.com/mozilla/grcov/releases/latest/download/grcov-linux-x86_64.tar.bz2 | tar jxf -
matrix:
include:
- os: linux
rust: nightly
script:
- export CARGO_INCREMENTAL=0
- export RUSTFLAGS="-Zprofile -Ccodegen-units=1 -Cinline-threshold=0 -Clink-dead-code -Coverflow-checks=off -Zno-landing-pads"
- cargo build --verbose $CARGO_OPTIONS
- cargo test --verbose $CARGO_OPTIONS
- |
zip -0 ccov.zip `find . \( -name "YOUR_PROJECT_NAME*.gc*" \) -print`;
./grcov ccov.zip -s . -t lcov --llvm --branch --ignore-not-existing --ignore-dir "/*" -o lcov.info;
bash <(curl -s https://codecov.io/bash) -f lcov.info;In order to build, either LLVM 7 or LLVM 8 libraries and headers are required. If one of these versions is sucessfully installed, build with:
cargo build
To run tests:
cargo test
- GCC 4.9 or higher is required (if parsing coverage artifacts generated by GCC).
Published under the MPL 2.0 license.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent