Yandex Taxi Testsuite 使用指南

一、项目目录结构及介绍

Yandex Taxi Testsuite 是一个专为微服务测试设计的框架，基于 Python 和 Pytest。这个框架由 Yandex.Taxi 开发并维护，旨在简化对用 C++ 和 Python 编写的微服务进行黑盒测试的过程。项目的主要组件和结构布局如下：

• 根目录：

  • submodules: 若作为子模块加入其他项目时，存放该框架代码的位置。
  • docs: 包含项目文档和示例的详细说明。
  • pytest.ini: Pytest 的配置文件，用于定制测试执行的行为。
  • setup.py 和 setup.cfg: Python 包的元数据和构建配置。
  • requirements.txt: 项目运行所需的依赖列表。
  • testsuite: 核心测试套件代码所在目录。
  • examples: 提供了多个使用此测试框架的实例，以简单聊天应用为例，展示了不同的存储后端（MongoDB、MySQL、PostgreSQL）如何被测试。

• 核心模块:

  • testsuite: 实现测试逻辑和环境搭建的核心代码。
  • conftest.py: 包含全局或特定于目录的Pytest固定装置(fixtures)。

• 示例服务: 每个服务目录下有其对应的 server.py （服务主体）、tests 目录（服务测试）和必要的配置文件。

二、项目的启动文件介绍

在使用 Yandex Taxi Testsuite 进行测试前，首先需要关注的是服务自身的启动脚本以及测试的执行命令。对于具体的微服务，启动文件通常是 server.py 或者服务定义的入口点。然而，考虑到测试执行本身，重点在于通过 Pytest 来运行测试集。

• 服务启动: 假设你的服务入口是 server.py，通常不会直接从测试框架内启动服务，而是通过相应的命令行工具或者脚本（如 Gunicorn 对于生产环境，或者直接使用 python server.py 在开发环境中快速验证）。

• 测试执行: 要运行测试，你应当在命令行中使用 pytest 命令。如果想运行特定的测试或所有测试，可以导航到项目测试目录并执行：

  pytest
  

  对于Yandex Taxi Testsuite的示例服务，还可以使用 Makefile 中预定义的目标来简化操作，例如：

  make runtests
  

三、项目的配置文件介绍

Yandex Taxi Testsuite 的配置主要分布在以下几个方面：

• Pytest 配置 (pytest.ini): 控制 Pytest 的行为，包括插件激活、测试收集规则等。

• Service 配置：每个微服务可能有自己的配置文件，这取决于具体实现和服务需求，并非框架强制要求。这些配置文件可以是 YAML、JSON 或者简单的 Python 文件，用于设置数据库连接、服务地址等。

• TestSuite 自定义配置：虽然框架本身并不直接指定一个固定的“配置文件”，但通过 conftest.py 或使用测试用例中的上下文管理器和固定装置，可以实现测试时的配置调整。

对于复杂的环境设置，比如数据库支持和操作系统特定配置，依赖项通过pip安装时的标志来指定，例如安装支持MongoDB的版本你会使用：

pip3 install yandex-taxi-testsuite[mongodb]

总之，Yandex Taxi Testsuite 强调通过Python代码和Pytest的机制来进行高度可定制化的配置和测试执行，而非依赖于单一的、预定义的配置文件结构。这就要求开发者根据实际的服务架构和测试需求，灵活组织和配置测试环境和流程。