ff1b622bdd
- Delete old example scripts (mail_reader_leann.py, google_history_reader_leann.py, etc.) - Remove migration hints and backward compatibility - Update tests to use new unified examples directly - Clean up all references to old script names - Users now only see the new unified interface
88 lines
2.1 KiB
Markdown
88 lines
2.1 KiB
Markdown
# LEANN Tests
|
|
|
|
This directory contains automated tests for the LEANN project using pytest.
|
|
|
|
## Test Files
|
|
|
|
### `test_readme_examples.py`
|
|
Tests the examples shown in README.md:
|
|
- The basic example code that users see first
|
|
- Import statements work correctly
|
|
- Different backend options (HNSW, DiskANN)
|
|
- Different LLM configuration options
|
|
|
|
### `test_basic.py`
|
|
Basic functionality tests that verify:
|
|
- All packages can be imported correctly
|
|
- C++ extensions (FAISS, DiskANN) load properly
|
|
- Basic index building and searching works for both HNSW and DiskANN backends
|
|
- Uses parametrized tests to test both backends
|
|
|
|
### `test_document_rag.py`
|
|
Tests the document RAG example functionality:
|
|
- Tests with facebook/contriever embeddings
|
|
- Tests with OpenAI embeddings (if API key is available)
|
|
- Tests error handling with invalid parameters
|
|
- Verifies that normalized embeddings are detected and cosine distance is used
|
|
|
|
## Running Tests
|
|
|
|
### Install test dependencies:
|
|
```bash
|
|
# Using extras
|
|
uv pip install -e ".[test]"
|
|
```
|
|
|
|
### Run all tests:
|
|
```bash
|
|
pytest tests/
|
|
|
|
# Or with coverage
|
|
pytest tests/ --cov=leann --cov-report=html
|
|
|
|
# Run in parallel (faster)
|
|
pytest tests/ -n auto
|
|
```
|
|
|
|
### Run specific tests:
|
|
```bash
|
|
# Only basic tests
|
|
pytest tests/test_basic.py
|
|
|
|
# Only tests that don't require OpenAI
|
|
pytest tests/ -m "not openai"
|
|
|
|
# Skip slow tests
|
|
pytest tests/ -m "not slow"
|
|
```
|
|
|
|
### Run with specific backend:
|
|
```bash
|
|
# Test only HNSW backend
|
|
pytest tests/test_basic.py::test_backend_basic[hnsw]
|
|
|
|
# Test only DiskANN backend
|
|
pytest tests/test_basic.py::test_backend_basic[diskann]
|
|
```
|
|
|
|
## CI/CD Integration
|
|
|
|
Tests are automatically run in GitHub Actions:
|
|
1. After building wheel packages
|
|
2. On multiple Python versions (3.9 - 3.13)
|
|
3. On both Ubuntu and macOS
|
|
4. Using pytest with appropriate markers and flags
|
|
|
|
### pytest.ini Configuration
|
|
|
|
The `pytest.ini` file configures:
|
|
- Test discovery paths
|
|
- Default timeout (600 seconds)
|
|
- Environment variables (HF_HUB_DISABLE_SYMLINKS, TOKENIZERS_PARALLELISM)
|
|
- Custom markers for slow and OpenAI tests
|
|
- Verbose output with short tracebacks
|
|
|
|
### Known Issues
|
|
|
|
- OpenAI tests are automatically skipped if no API key is provided
|