Tox Testing

🚀 Tox 測試 MCP 服務器

本項目是一個基於 Model Context Protocol (MCP) 的測試服務器，它能在 Python 項目中執行 tox 命令以運行 pytest 測試。藉助 MCP，該服務器為運行和管理 Python 測試提供了便捷途徑。

🚀 快速開始

本服務器提供了一個工具 run_tox_tests，可在不同模式下運行測試。例如，若要運行所有測試，可使用如下參數：

{
  "mode": "all"
}

✨ 主要特性

工具

• run_tox_tests - 執行 tox 測試命令，支持多種模式和選項
  • 支持的執行模式：
    • all: 運行所有測試或指定組中的測試
    • file: 運行特定文件中的測試
    • case: 運行特定的測試用例
    • directory: 運行指定目錄中的所有測試
  • 支持的測試組：
    • clients: 客戶端相關測試
    • api: API 端點測試
    • auth: 認證測試
    • uploads: 上傳功能測試
    • routes: 路由處理程序測試

📦 安裝指南

開發環境搭建

安裝依賴項：

npm install

構建服務器：

npm run build

開發時自動重建：

npm run watch

在 VSCode 中使用

要在 VSCode 中使用，請將服務器配置添加到 MCP 設置文件中，路徑為： ~/.config/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json

{
  "mcpServers": {
    "tox-testing": {
      "command": "node",
      "args": ["/path/to/tox-testing/build/index.js"],
      "env": {
        "TOX_APP_DIR": "/path/to/your/python/project",
        "TOX_TIMEOUT": "600"
      }
    }
  }
}

配置選項

• env.TOX_TIMEOUT: (可選) 測試執行的最大等待時間，單位為秒。如果測試運行時間超過此超時，則會終止，默認值為 600 秒（10 分鐘）
• env.TOX_APP_DIR: (必需) 包含 tox.ini 文件的目錄。在此目錄中執行 tox 命令。路徑應指向 Python 項目的根目錄，其中包含 tox.ini 文件

⚠️ 重要提示

超時設置特別重要，它可用於防止測試進程掛起、管理長時間運行的集成測試以及確保 CI/CD 管道不會卡住。

💻 使用示例

基礎用法

服務器提供了一個工具 run_tox_tests，以下是不同使用模式的示例：

運行所有測試

{
  "mode": "all"
}

運行指定組中的測試

{
  "mode": "all",
  "group": "api"
}

運行特定文件中的測試

{
  "mode": "file",
  "testFile": "tests/test_api.py"
}

運行特定的測試用例

{
  "mode": "case",
  // 這裡原文檔未完整給出，保持原樣
}