chroma-core/chroma

[CLN] Break up test_api

Open

#2586 opened on Jul 28, 2024

View on GitHub
 (3 comments) (0 reactions) (1 assignee)Rust (27,958 stars) (2,247 forks)batch import
by-chromacleanupgood first issue

Description

test_api.py is a legacy of Chroma's launch, and provided some basic initial test coverage. We've continued to add to it as the project has evolved, and it's become a catch-all kitchen sink test file.

In practice a lot of the surface covered in test_api is better covered by our property tests. test_api.py should be broken up into separate files by API / object, and each object test should cover exceptional cases, rather than normal operation.

For example, we should save entropy in the property tests by not having them generate lists of IDs that are shorter than the lists of documents on a Collection.add call, but we should also be testing this path.

Contributor guide

Tech stack
python
Domain
testing
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Python testing with pytestChroma API basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
The issue requests breaking up `test api.py` (located at `chromadb/test/test api.py`) into separate files per API object (e.g., `test collection.py`, `test database.py`). Each new file should focus on exceptional cases rather than normal operation. Existing property tests already cover normal cases. Review the current structure of property tests and the Chroma API to identify logical groupings. No PRs are linked, but the issue has an assignee so confirm availability before starting.