测试
我们所有的包都有单元测试和集成测试,我们更倾向于使用单元测试而不是集成测试。
每次拉取请求时都会运行单元测试,因此它们应该快速且可靠。
集成测试每天运行一次,它们需要更多的设置,因此应保留用于确认与外部服务的接口点。
单元测试
单元测试覆盖不需要调用外部API的模块化逻辑。 如果您添加了新逻辑,请添加一个单元测试。
安装单元测试的依赖项:
poetry install --with test
运行单元测试:
make test
要在Docker中运行单元测试:
make docker_tests
运行特定测试:
TEST_FILE=tests/unit_tests/test_imports.py make test
集成测试
集成测试涵盖了需要调用外部API的逻辑(通常是与其他服务的集成)。 如果您添加了对新外部API的支持,请添加一个新的集成测试。
警告:几乎没有任何测试应该是集成测试。
需要建立网络连接的测试使得其他开发者难以测试代码。
相反,建议依赖responses
库和/或mock.patch来使用小型夹具模拟请求。
安装集成测试的依赖项:
poetry install --with test,test_integration
运行集成测试:
make integration_tests
准备
集成测试使用了多个搜索引擎和数据库。测试的目的是根据它们的规范和要求验证引擎和数据库的正确行为。
要运行一些集成测试,例如位于tests/integration_tests/vectorstores/
的测试,您需要安装以下软件:
- Docker
- Python 3.8.1 或更高版本
任何新的依赖项都应通过运行以下命令添加:
# add package and install it after adding:
poetry add tiktoken@latest --group "test_integration" && poetry install --with test_integration
在运行任何测试之前,您应该启动一个安装了所有必要依赖项的特定Docker容器。例如,我们使用elasticsearch.yml
容器来运行test_elasticsearch.py
:
cd tests/integration_tests/vectorstores/docker-compose
docker-compose -f elasticsearch.yml up
对于需要更复杂准备的环境,请查找*.sh
。例如,opensearch.sh
会构建所需的docker镜像,然后启动opensearch。
准备本地测试的环境变量:
- 复制
tests/integration_tests/.env.example
到tests/integration_tests/.env
- 在
tests/integration_tests/.env
文件中设置变量,例如OPENAI_API_KEY
此外,需要注意的是,一些集成测试可能需要设置某些环境变量,例如OPENAI_API_KEY
。请确保在运行测试之前设置所有必需的环境变量,以确保它们正确运行。
使用 pytest-vcr 记录 HTTP 交互
此存储库中的一些集成测试涉及向外部服务发出HTTP请求。为了防止每次运行测试时都发出这些请求,我们使用pytest-vcr来记录和回放HTTP交互。
在CI/CD管道中运行测试时,您可能不希望修改现有的cassettes。您可以使用--vcr-record=none命令行选项来禁用录制新的cassettes。以下是一个示例:
pytest --log-cli-level=10 tests/integration_tests/vectorstores/test_pinecone.py --vcr-record=none
pytest tests/integration_tests/vectorstores/test_elasticsearch.py --vcr-record=none
运行一些带有覆盖率的测试:
pytest tests/integration_tests/vectorstores/test_elasticsearch.py --cov=langchain --cov-report=html
start "" htmlcov/index.html || open htmlcov/index.html
覆盖率
代码覆盖率(即单元测试覆盖的代码量)有助于识别代码中可能更脆弱或更稳定的区域。
覆盖率需要集成测试的依赖项:
poetry install --with test_integration
要获取当前覆盖率的报告,请运行以下命令:
make coverage