docs: Add instructions for run compaction tests

This commit is contained in:
2026-02-23 19:48:37 +00:00
committed by Anibal Angulo
parent be847a38ab
commit 84fb29ccf1

View File

@@ -90,3 +90,23 @@ For open source projects, say how it is licensed.
## Project status ## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
## Tests
### Compaction
Follow these steps before running the compaction test suite:
1. Install the required dependencies (Java and Google Cloud CLI):
```bash
mise use -g gcloud
mise use -g java
```
2. Open another terminal (or create a `tmux` pane) and start the Firestore emulator:
```bash
gcloud emulators firestore start --host-port=localhost:8153
```
3. Execute the tests with `pytest` through `uv`:
```bash
uv run pytest tests/test_compaction.py -v
```
If any step fails, double-check that the tools are installed and available on your `PATH` before trying again.