| Ben Clayton | 5af571b | 2021-11-23 17:57:37 +0000 | [diff] [blame] | 1 | # Generating and viewing Tint code-coverage |
| 2 | |
| 3 | Requirements: |
| 4 | |
| 5 | * Host running Linux or macOS |
| 6 | * Clang toolchain on the `PATH` environment variable |
| 7 | |
| 8 | ## Building Tint with coverage generation enabled |
| 9 | |
| James Price | fe0c2a7 | 2023-01-04 18:06:49 +0000 | [diff] [blame] | 10 | Follow the steps [to build Tint with CMake](../README.md), but include the additional `-DDAWN_EMIT_COVERAGE=1` CMake flag. |
| Ben Clayton | 5af571b | 2021-11-23 17:57:37 +0000 | [diff] [blame] | 11 | |
| 12 | ## Generate coverage information |
| 13 | |
| 14 | Use the `<tint>/tools/tint-generate-coverage` script to run the tint executable or unit tests and generate the coverage information. |
| 15 | |
| 16 | The script takes the executable to invoke as the first command line argument, followed by additional arguments to pass to the executable. |
| 17 | |
| 18 | For example, to see the code coverage for all unit tests, run: |
| 19 | `<tint>/tools/tint-generate-coverage <build>/tint_unittests --gtest_brief` |
| 20 | |
| 21 | The script will emit two files at the root of the tint directory: |
| 22 | |
| 23 | * `coverage.summary` - A text file giving a coverage summary for all Tint source files. |
| 24 | * `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. |
