aljaz/turso
1
0
Fork 0
mirror of https://github.com/aljazceru/turso.git synced 2026-01-07 02:04:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add tests prerequisites to README and CONTRIBUTING

Browse Source
This commit is contained in:
Daniel Kaluza
2024-12-31 13:02:20 +01:00
parent b18abba118
commit 4c1e8038b3
2 changed files with 22 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
CONTRIBUTING.md
View File

@@ -35,7 +35,7 @@ Fork the repository and open a pull request to submit your work. Please consider
As general guideline for pull requests, please:
* Don't mix fixes and cleanups in same pull request. They just increase the likelhood of merge conflicts. Cleanups are welcome, but just keep them separate.
* Don't mix fixes and cleanups in same pull request. They just increase the likelihood of merge conflicts. Cleanups are welcome, but just keep them separate.
* Prefer `git rebase main` over `git merge main` on your branches to keep git logs clean.
## Debugging query execution
@@ -69,6 +69,18 @@ If the bytecode is the same, but query results are different, then the bug is so
The `testing/test.all` is a starting point for adding functional tests using a similar syntax to SQLite.
The purpose of these tests is to verify behavior matches with SQLite and Limbo.
### Prerequisites
1. [Cargo-c](https://github.com/lu-zero/cargo-c) is needed for building C-ABI compatible library. You can get it via:
```console
cargo install cargo-c
```
2. [SQLite](https://www.sqlite.org/index.html) is needed for compatibility checking. You can install it using `brew`:
```console
brew install sqlite
```
### Running the tests
To run the test suite with Limbo, simply run:
```

9
README.md
View File

@@ -115,6 +115,15 @@ Test coverage report:
cargo tarpaulin -o html
```
> [!NOTE]
> Generation of coverage report requires [tarpaulin](https://github.com/xd009642/tarpaulin) binary to be installed.
> You can install it with `cargo install cargo-tarpaulin`
[//]: # (TODO remove the below tip when the bug is solved)
> [!TIP]
> If coverage fails with "Test failed during run" error and all of the tests passed it might be the result of tarpaulin [bug](https://github.com/xd009642/tarpaulin/issues/1642). You can temporarily set [dynamic libraries linking manually](https://doc.rust-lang.org/cargo/reference/environment-variables.html#dynamic-library-paths) as a workaround, e.g. for linux `LD_LIBRARY_PATH="$(rustc --print=target-libdir)" cargo tarpaulin -o html`.
Run benchmarks:
```console