chroma-core/chroma

[CLN] Break up test_api

Aperta

#2586 aperta il 28 lug 2024

Vedi su GitHub
 (4 commenti) (0 reazioni) (1 assegnatario)Rust (2247 fork)batch import
by-chromacleanupgood first issue

Metriche repository

Star
 (27.958 stelle)
Metriche merge PR
 (Merge medio 1g 16h) (80 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
La richiesta prevede di suddividere `test api.py` (situato in `chromadb/test/test api.py`) in file separati per oggetto API (ad esempio `test collection.py`, `test database.py`). Ogni nuovo file dovrebbe concentrarsi sui casi eccezionali piuttosto che sul funzionamento normale. I test di proprietà esistenti coprono già i casi normali. Rivedere la struttura attuale dei test di proprietà e l'API di Chroma per identificare raggruppamenti logici. Non sono collegati PR, ma la richiesta ha un assegnatario, quindi confermare la disponibilità prima di iniziare.
Tech stack
python
Dominio
testing
Tipo issue
Test
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Pythonpytest
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75