https://github.com/weaviate/docs
The documentation repo for Weaviate Database, Cloud, Agents and much more!
https://github.com/weaviate/docs
docs documentation embeddings llm open-source vector-database weaviate
Last synced: 3 months ago
JSON representation
The documentation repo for Weaviate Database, Cloud, Agents and much more!
- Host: GitHub
- URL: https://github.com/weaviate/docs
- Owner: weaviate
- Created: 2025-01-16T09:38:36.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-07-03T11:37:34.000Z (3 months ago)
- Last Synced: 2025-07-03T12:30:47.581Z (3 months ago)
- Topics: docs, documentation, embeddings, llm, open-source, vector-database, weaviate
- Language: Python
- Homepage: https://weaviate-docs.netlify.app/docs/weaviate
- Size: 614 MB
- Stars: 6
- Watchers: 4
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README-tests.md
Awesome Lists containing this project
README
# Tests for Code Examples
At Weaviate, we maintain automated tests to ensure the accuracy and functionality of our code examples. This testing framework helps us catch issues early and maintain high-quality documentation.
## Overview
Our code examples are designed as self-contained, runnable scripts. Each script includes inline assertions to verify its functionality. These tests are managed through various testing frameworks and can be executed centrally to validate all examples.
## Prerequisites
Before running tests, ensure you have:
- Python 3.8+ and Node.js installed
- **Java 8+ and Maven** (for Java examples)
- Docker (required for running Weaviate instances)
- Rust and Cargo (for some examples)
- API keys for vectorization services:
- `COHERE_APIKEY`
- `HUGGINGFACE_APIKEY`
- `OPENAI_APIKEY`
## Setup
1. Create and activate a Python virtual environment:
```bash
python -m venv .venv
source .venv/bin/activate # On Windows: .venv\Scripts\activate
```
2. Install dependencies:
```bash
pip install -r requirements.txt
```
## Running Tests
### Python Tests
Run all Python tests:
```bash
pytest
```
Run specific test files:
```bash
pytest tests/path/to/test_file.py
```
### Java Tests
1. Start Weaviate instances:
```bash
tests/start-weaviate.sh
```
2. Navigate to the Java examples directory:
```bash
cd _includes/code/howto/java
```
3. Set required environment variables:
```bash
export OPENAI_APIKEY="your-openai-api-key"
# Optional: Set other API keys if needed
export COHERE_APIKEY="your-cohere-api-key"
export HUGGINGFACE_APIKEY="your-huggingface-api-key"
```
4. Install dependencies and run tests:
```bash
# Install dependencies
mvn clean install
# Run all tests
mvn test
# Run tests with specific tags
mvn test -Dgroups="crud"
mvn test -Dgroups="create"
# Run a specific test class
mvn test -Dtest=ManageDataCreateTest
```
5. Stop Weaviate instances when finished:
```bash
tests/stop-weaviate.sh
```
### Golang Tests
1. Start Weaviate instances:
```bash
tests/start-weaviate.sh
```
2. Navigate to the Go examples directory:
```bash
cd _includes/code/howto/go/docs
```
3. Update dependencies:
```bash
go mod tidy
```
4. Run tests:
```bash
# Run all tests
go test
# Run specific test file
go test -v
# Example:
go test docs/manage-data.classes_test.go -v
```
5. Stop Weaviate instances:
```bash
tests/stop-weaviate.sh
```
## Test Fixtures
The test suite includes several fixtures to help with testing:
- `empty_weaviates`: Provides a clean Weaviate instance for testing
- More fixtures are planned for different test scenarios
## Troubleshooting
- If tests fail to connect to Weaviate, ensure Docker is running and the Weaviate instances are up
- For API key issues, verify your environment variables are set correctly
- If you encounter dependency issues, try updating your virtual environment and reinstalling requirements
## Contributing
If you find issues with the tests or documentation:
1. Check if the issue is already reported on GitHub
2. If not, create a new issue with:
- The test that's failing
- Your environment details
- Any error messages
- Steps to reproduce
## Thanks
A big thanks to Jeremy for suggesting this testing framework! 😊