encounter
/
dawn-cmake
mirror of https://github.com/encounter/dawn-cmake.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
dawn-cmake/docs/tint/coverage-info.md

25 lines
1.1 KiB
Markdown
Raw Normal View History

Document the process of generating code coverage Update the script to check coverage generation is enabled, and provide a sensible error message if it is not. Change-Id: I42f2b97d18bb3be2d081200cb682ea310476943f Reviewed-on: https://dawn-review.googlesource.com/c/tint/+/70520 Kokoro: Kokoro <noreply+kokoro@google.com> Commit-Queue: Ben Clayton <bclayton@chromium.org> Reviewed-by: David Neto <dneto@google.com>
2021-11-23 17:57:37 +00:00
# Generating and viewing Tint code-coverage
Requirements:
* Host running Linux or macOS
* Clang toolchain on the `PATH` environment variable
## Building Tint with coverage generation enabled
tint: TINT_EMIT_COVERAGE -> DAWN_EMIT_COVERAGE Change-Id: Ic215fba55238d89f9790f071361e29fddfc3624d Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/116340 Commit-Queue: James Price <jrprice@google.com> Kokoro: Kokoro <noreply+kokoro@google.com> Reviewed-by: Ben Clayton <bclayton@google.com>
2023-01-04 18:06:49 +00:00
Follow the steps [to build Tint with CMake](../README.md), but include the additional `-DDAWN_EMIT_COVERAGE=1` CMake flag.
Document the process of generating code coverage Update the script to check coverage generation is enabled, and provide a sensible error message if it is not. Change-Id: I42f2b97d18bb3be2d081200cb682ea310476943f Reviewed-on: https://dawn-review.googlesource.com/c/tint/+/70520 Kokoro: Kokoro <noreply+kokoro@google.com> Commit-Queue: Ben Clayton <bclayton@chromium.org> Reviewed-by: David Neto <dneto@google.com>
2021-11-23 17:57:37 +00:00
## Generate coverage information
Use the `<tint>/tools/tint-generate-coverage` script to run the tint executable or unit tests and generate the coverage information.
The script takes the executable to invoke as the first command line argument, followed by additional arguments to pass to the executable.
For example, to see the code coverage for all unit tests, run:
`<tint>/tools/tint-generate-coverage <build>/tint_unittests --gtest_brief`
The script will emit two files at the root of the tint directory:
* `coverage.summary` - A text file giving a coverage summary for all Tint source files.
* `lcov.info` - A binary coverage file that can be consumed with the [VSCode Coverage Gutters](https://marketplace.visualstudio.com/items?itemName=ryanluker.vscode-coverage-gutters) extension.