mirror of
https://github.com/qdrant/qdrant.git
synced 2026-07-23 11:11:00 -05:00
Add docs about coverage reports (#5958)
* Add docs about running coverage tests locally * Add link to CI coverage report * higlight that we only cover unit tests * Add CI coverage report image * Add more steps * Remove OOM instructions
This commit is contained in:
@@ -153,6 +153,28 @@ Use [pprof](https://github.com/google/pprof) and the following command to genera
|
||||
|
||||

|
||||
|
||||
### Coverage reports
|
||||
|
||||
We generate coverage reports every day that can be accessed [here](https://app.codecov.io/gh/qdrant/qdrant/tree/code-coverage)
|
||||
|
||||
Note: These reports **only cover the Rust unit tests** (for now)
|
||||
|
||||

|
||||
|
||||
You can also generate coverage reports locally with the following commands
|
||||
|
||||
```bash
|
||||
cd qdrant
|
||||
cargo install cargo-llvm-cov
|
||||
./tools/coverage.sh
|
||||
|
||||
cd target/llvm-cov/html
|
||||
python -m http.server
|
||||
open http://localhost:8000
|
||||
```
|
||||
|
||||

|
||||
|
||||
### Tango.rs-based benchmarks
|
||||
|
||||
Some benchmarks are implemented using the [Tango.rs](https://github.com/bazhenov/tango) framework.
|
||||
|
||||
BIN
docs/imgs/ci-coverage-report.png
Normal file
BIN
docs/imgs/ci-coverage-report.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 144 KiB |
BIN
docs/imgs/local-coverage-report.png
Normal file
BIN
docs/imgs/local-coverage-report.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 428 KiB |
Reference in New Issue
Block a user