Skip to content

docs: update AGENTS local testing workflows #365

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
shaypal5 wants to merge 3 commits into
base: master
Choose a base branch
from
+9 −3
Open

docs: update AGENTS local testing workflows #365

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c36971e
docs: update AGENTS local testing workflows
shaypal5 Mar 13, 2026
7165a1f
fix: replace non-existent test-mongo-local.sh calls in Makefile and c…
Copilot Mar 14, 2026
e4e1d9b
Potential fix for pull request finding
shaypal5 Mar 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -439,10 +439,13 @@ ______________________________________________________________________
- `make test-all-local` - Test all backends with Docker
- `make test-external` - Test all external backends
- `make test-mongo-local` - Test MongoDB only
- `make test-mongo-inmemory` - Test MongoDB marker set with local/in-memory setup
- `make test-mongo-also-local` - Test MongoDB together with local core tests
- `make test-redis-local` - Test Redis only
- `make test-sql-local` - Test SQL only
- `make services-start` - Start all Docker containers
- `make services-stop` - Stop all Docker containers
- `make services-logs` - Tail logs for Dockerized test services

**Available Cores:**

Expand All @@ -462,8 +465,11 @@ ______________________________________________________________________
- `-k, --keep-running` - Keep containers running after tests
- `-h, --html-coverage` - Generate HTML coverage report
- `-f, --files` - Run only specific test files
- `-p, --parallel` - Run tests with `pytest-xdist`
- `-w, --workers` - Set number of parallel workers (default: `auto`)

**Note:** External backends (MongoDB, Redis, SQL) require Docker. S3, memory, and pickle backends work without Docker.
**Note:** Redis and SQL backends require Docker. MongoDB tests run in-memory by default (no Docker needed) when invoked directly (for example, `pytest -m mongo` or `make test-mongo-inmemory` without `CACHIER_TEST_VS_DOCKERIZED_MONGO` set). When using `./scripts/test-local.sh mongo` or including `mongo` in the core list, MongoDB is always run via a Docker container and requires Docker. S3, memory, and pickle backends work without Docker.
You can also set cores with `CACHIER_TEST_CORES="mongo redis" ./scripts/test-local.sh`, in which case both MongoDB and Redis will run via Docker.

______________________________________________________________________

Expand Down
4 changes: 2 additions & 2 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,13 +69,13 @@ test-mongo-inmemory:

test-mongo-docker:
@echo "Running MongoDB tests against Docker MongoDB..."
./scripts/test-mongo-local.sh
./scripts/test-local.sh mongo

test-mongo-local: test-mongo-docker

test-mongo-also-local:
@echo "Running MongoDB tests with local core tests..."
./scripts/test-mongo-local.sh --mode also-local
./scripts/test-local.sh mongo memory pickle

# New unified testing targets
test-local:
Expand Down
Loading