From ff82b2d5f3f397e665a17ead8a94d3f0d8980819 Mon Sep 17 00:00:00 2001 From: A8080816 Date: Mon, 23 Feb 2026 19:48:37 +0000 Subject: [PATCH] docs: Add instructions for run compaction tests --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index d154857..948f12b 100644 --- a/README.md +++ b/README.md @@ -90,3 +90,23 @@ For open source projects, say how it is licensed. ## 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. + +## 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.