# https://github.com/reviewboard/ReviewBot 项目说明书

生成时间：2026-06-14 13:59:14 UTC

## 目录

- [项目概述与核心特性](#page-1)
- [系统架构与组件设计](#page-2)
- [工具插件系统与支持的检查器](#page-3)
- [部署方式与运维指南](#page-4)

<a id='page-1'></a>

## 项目概述与核心特性

### 相关页面

相关主题：[系统架构与组件设计](#page-2)

<details>
<summary>相关源码文件</summary>

以下源码文件用于生成本页说明：

- [README.rst](https://github.com/reviewboard/ReviewBot/blob/main/README.rst)
- [bot/setup.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/setup.py)
- [extension/setup.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/setup.py)
- [bot/reviewbot/repositories.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/repositories.py)
- [bot/reviewbot/tools/base/__init__.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/base/__init__.py)
- [bot/reviewbot/tools/base/mixins.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/base/mixins.py)
- [bot/reviewbot/tools/clang.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/clang.py)
- [bot/reviewbot/tools/cargotool.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/cargotool.py)
- [bot/reviewbot/tools/jshint.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/jshint.py)
- [bot/reviewbot/tools/doc8.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/doc8.py)
- [extension/reviewbotext/integration.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/reviewbotext/integration.py)
- [extension/reviewbotext/forms.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/reviewbotext/forms.py)
- [extension/reviewbotext/resources.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/reviewbotext/resources.py)
- [bot/reviewbot/tools/testing/testcases.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/testing/testcases.py)
</details>

# 项目概述与核心特性

## 项目定位与组成

Review Bot 是 Review Board 官方推出的自动化代码审查机器人，旨在对 Review Board 上的 review request 自动执行静态分析、代码风格检查、安全扫描等任务，并在 review 中发表结构化的 diff 评论与一般性评论。根据 [README.rst](https://github.com/reviewboard/ReviewBot/blob/main/README.rst) 的描述，整个项目以 `Review Bot extension`（Review Board 插件）与 `Review Bot worker`（独立 Worker 进程）作为核心发行物，并提供 `Official Docker images` 便于一键部署。社区最新发布的 4.1 版本进一步带来了网络诊断改进与「仅通知 review request 拥有者」的邮件通知选项。

仓库的代码结构按职责划分为两个顶层目录：

| 目录 | 角色 | 关键元数据 |
|------|------|------------|
| `extension/` | Review Board 端集成，发布至 PyPI 的 `reviewbot-extension` | `install_requires=['celery~=5.3']`，Python ≥ 3.8，参考 [extension/setup.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/setup.py) |
| `bot/` | 独立 Worker 进程，发布至 PyPI 的 `reviewbot-worker` | 通过 `entry_points` 注册 20+ 个内置工具，参考 [bot/setup.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/setup.py) |

## 系统架构

Review Bot 采用「Review Board 端 + Worker 端」分离式架构，二者通过 Web API 与 Celery 消息队列协作。整体数据流如下：

```mermaid
flowchart LR
    RR[Review Request] -- published --> EXT[Review Bot Extension]
    EXT -- Celery task --> Q[消息队列]
    Q --> W[Review Bot Worker]
    W -- 拉取 diff --> API[Review Board Web API]
    W -- 工具执行 --> TOOL[静态分析工具]
    W -- 发布 review --> EXT
    EXT -- 邮件通知 --> OWNER[review request 拥有者]
```

如 [extension/reviewbotext/integration.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/reviewbotext/integration.py) 所示，Extension 端通过 `SignalHook` 监听 `review_request_published` 与 `status_update_request_run` 信号，触发对 Worker 的调度；Worker 端则通过 [bot/reviewbot/repositories.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/repositories.py) 提供的 `BaseRepository` 子类完成仓库克隆与本地 checkout，再调用工具完成分析。4.1 版本中新增的 `to_owner_only` 参数（见 [extension/reviewbotext/resources.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/reviewbotext/resources.py) 中的 `create` 方法）允许将评论邮件仅发送给 review request 拥有者，从而减少群发噪声。

## 工具生态与多语言支持

Worker 在启动时会按 `entry_points` 注册的内置工具清单加载若干工具类，覆盖 C/C++、Java、JavaScript、Python、Rust、Ruby、Go、Shell 等多语言生态。代表性工具示例：

- **Clang Static Analyzer**：执行 `clang --analyze` 并通过 plist 解析诊断结果，参考 [bot/reviewbot/tools/clang.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/clang.py)。
- **CargoTool**：调用 `cargo clippy` 与 `cargo test`，正则匹配测试输出中的失败摘要，参考 [bot/reviewbot/tools/cargotool.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/cargotool.py)。该工具在 4.1 版本中针对 `cargo clippy` 输出格式变化进行了适配。
- **JSHint**：支持从 HTML 中提取 JavaScript 片段，并通过 `FilePatternsFromSettingMixin` 动态扩展额外文件扩展名，参考 [bot/reviewbot/tools/jshint.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/jshint.py)。
- **doc8**：检查 reStructuredText 文档，配置项含 `max_line_length` 与 `encoding`，参考 [bot/reviewbot/tools/doc8.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/doc8.py)。

所有工具均继承自 `BaseTool`，并按需组合 `FullRepositoryToolMixin`、`FilePatternsFromSettingMixin`、`JavaToolMixin` 等基类（见 [bot/reviewbot/tools/base/__init__.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/base/__init__.py) 与 [bot/reviewbot/tools/base/mixins.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/base/mixins.py)），从而以统一的方式声明 `exe_dependencies`、`file_patterns`、`timeout` 与 `options`。

## 配置与扩展机制

Extension 端在管理界面提供 `ReviewBotConfigForm`（[extension/reviewbotext/forms.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/reviewbotext/forms.py)），管理员可在此为每个工具选择启用的 review request 类型、限制最大评论数 `max_comments`，并切换 4.1 新增的 `notify_owner_only` 开关。表单会通过 `ToolOptionsWidget` 动态渲染每个工具自定义的 `options`，实现了对工具级别的细粒度控制。

测试侧同样为扩展开发者提供了完整的脚手架：[bot/reviewbot/tools/testing/testcases.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/testing/testcases.py) 中的 `ToolTestCaseMetaclass` 会将标记为 simulation 或 integration 的方法自动拆分为独立测试，并要求子类显式声明 `tool_class`、`tool_exe_config_key` 与 `tool_exe_path`，保证了工具的端到端可验证性。

## See Also

- [安装与部署（Docker / PyPI）](https://www.reviewboard.org/docs/reviewbot/latest/installation/docker/)
- [工具参考手册](https://www.reviewboard.org/docs/reviewbot/latest/tools/)
- [Review Board 主项目](https://github.com/reviewboard/reviewboard/)
- [RBTools 命令行套件](https://github.com/reviewboard/rbtools/)

---

<a id='page-2'></a>

## 系统架构与组件设计

### 相关页面

相关主题：[项目概述与核心特性](#page-1), [工具插件系统与支持的检查器](#page-3)

<details>
<summary>相关源码文件</summary>

以下源码文件用于生成本页说明：

- [README.rst](https://github.com/reviewboard/ReviewBot/blob/main/README.rst)
- [bot/setup.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/setup.py)
- [extension/setup.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/setup.py)
- [bot/reviewbot/tools/base/__init__.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/base/__init__.py)
- [bot/reviewbot/tools/base/mixins.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/base/mixins.py)
- [bot/reviewbot/tools/clang.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/clang.py)
- [bot/reviewbot/tools/jshint.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/jshint.py)
- [bot/reviewbot/tools/cargotool.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/cargotool.py)
- [bot/reviewbot/tools/doc8.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/doc8.py)
- [bot/reviewbot/repositories.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/repositories.py)
- [extension/reviewbotext/integration.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/reviewbotext/integration.py)
- [extension/reviewbotext/resources.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/reviewbotext/resources.py)
- [extension/reviewbotext/forms.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/reviewbotext/forms.py)
- [extension/reviewbotext/compat/__init__.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/reviewbotext/compat/__init__.py)
</details>

# 系统架构与组件设计

## 整体架构概览

Review Bot 是一个为 Review Board 提供自动化代码审查能力的分布式系统。它采用典型的**双组件（Extension + Worker）分离架构**，由部署在 Review Board 服务端的扩展和独立运行的 Bot 工作进程共同构成。资料来源：[README.rst](https://github.com/reviewboard/ReviewBot/blob/main/README.rst)

系统由两个相互独立的 Python 包组成：

- **`reviewbot-worker`**（资料来源：[bot/setup.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/setup.py)）：负责实际执行代码检查工具，并通过 `reviewbot.tools` 入口点进行插件注册
- **`reviewbot-extension`**（资料来源：[extension/setup.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/setup.py)）：作为 Review Board 扩展运行，依赖 Celery 5.3+ 作为任务分发机制

```mermaid
flowchart LR
    RB[Review Board Server] -->|集成扩展| EXT[ReviewBot Extension]
    EXT -->|Celery 任务| BROKER[(消息代理)]
    BROKER -->|任务消费| WORKER[Bot Worker 进程]
    WORKER -->|执行工具| TOOLS[代码检查工具]
    WORKER -->|回传结果| EXT
    EXT -->|生成审查| RB
```

## 核心组件详解

### Bot Worker 组件

Worker 是工具执行主体，其核心抽象基于 `BaseTool` 基类（资料来源：[bot/reviewbot/tools/base/__init__.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/base/__init__.py)）。该基类与若干 Mixin 配合，覆盖三类典型工具场景：

| 基类 / Mixin | 职责与适用场景 |
|---|---|
| `BaseTool` | 定义工具元数据（`name`、`version`、`file_patterns`）、`build_base_command`、`handle_results` 等核心接口 |
| `FilePatternsFromSettingMixin` | 通过用户配置动态扩展文件匹配模式，支持扩展名与通配符两种方式（资料来源：[mixins.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/base/mixins.py)）|
| `FullRepositoryToolMixin` | 为需要完整仓库上下文的工具提供克隆能力，典型例子是 Clang 静态分析（资料来源：[clang.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/clang.py)）|

工具通过 Python 入口点机制注册，在 `bot/setup.py` 中可见 `cargotool`、`clang`、`jshint`、`doc8`、`flake8`、`rubocop`、`shellcheck` 等 19 个内置工具。

### Review Board Extension 组件

扩展侧的核心入口是 `ReviewBotIntegration`（资料来源：[extension/reviewbotext/integration.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/reviewbotext/integration.py)）。它在 `initialize()` 中通过 `SignalHook` 订阅两个关键信号：

- `review_request_published`：当用户发布审查请求时触发，自动入队
- `status_update_request_run`：在状态更新阶段重新运行分析

### 工具配置与 API 接口

每个工具通过声明 `options` 列表暴露其配置项，并通过 Django Form 动态渲染（资料来源：[extension/reviewbotext/forms.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/reviewbotext/forms.py)）。例如：

- JSHint 工具提供 `extra_ext_checks` 扩展名配置（资料来源：[jshint.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/jshint.py)）
- Cargo 工具提供 `clippy` 与 `test` 布尔开关（资料来源：[cargotool.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/cargotool.py)）
- Doc8 提供 `max_line_length` 与 `encoding` 文本检查参数（资料来源：[doc8.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/doc8.py)）

Extension 的 REST API 资源（资料来源：[extension/reviewbotext/resources.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/reviewbotext/resources.py)）负责发布自动化审查，并在 4.1 版本新增了 `to_owner_only` 参数用于控制通知仅发送给审查请求所有者。

## 数据流与组件协作

完整的自动化审查流程可概括为六个阶段：

1. 用户在 Review Board 中发布审查请求
2. Extension 通过 `review_request_published` 信号挂钩接收事件（资料来源：[integration.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/reviewbotext/integration.py)）
3. Extension 根据 Integration 配置匹配对应的工具
4. 通过 Celery（`celery~=5.3`，资料来源：[extension/setup.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/setup.py)）将任务异步分发至 Worker
5. Worker 拉取完整仓库（资料来源：[bot/reviewbot/repositories.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/repositories.py)）或逐文件执行工具命令
6. Worker 解析工具输出，生成 `diff_comments` 与 `general_comments` JSON 负载并通过 API 回写审查（资料来源：[resources.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/reviewbotext/resources.py)）

## 可扩展性与版本演进

Review Bot 通过清晰的插件边界保持良好的可扩展性：

- **工具扩展**：新增工具只需继承 `BaseTool` 并在 `setup.py` 中注册入口点，无需修改扩展代码
- **配置扩展**：通过 `options` 列表与 Django Form 字段声明机制，新增选项后 UI 自动呈现
- **版本兼容**：4.0.1 引入独立的 `compat` 模块（资料来源：[compat/__init__.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/reviewbotext/compat/__init__.py)）以应对 Review Board 不同主版本的 API 变更

社区反馈表明，Review Bot 4.1 修复了多个工具（包括 cargo clippy 等）的输出格式解析问题，正是这套分层架构使得工具适配与扩展升级可以独立发布与快速迭代。

## See Also

- 工具开发与插件注册机制
- 安装与 Docker 部署
- 配置项与通知策略

---

<a id='page-3'></a>

## 工具插件系统与支持的检查器

### 相关页面

相关主题：[系统架构与组件设计](#page-2), [部署方式与运维指南](#page-4)

```markdown
<details>
<summary>相关源码文件</summary>

以下源码文件用于生成本页说明：

- [bot/reviewbot/tools/base/tool.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/base/tool.py)
- [bot/reviewbot/tools/base/mixins.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/base/mixins.py)
- [bot/reviewbot/tools/base/__init__.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/base/__init__.py)
- [bot/reviewbot/tools/clang.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/clang.py)
- [bot/reviewbot/tools/jshint.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/jshint.py)
- [bot/reviewbot/tools/cargotool.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/cargotool.py)
- [bot/reviewbot/tools/gotool.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/gotool.py)
- [bot/reviewbot/tools/pmd.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/pmd.py)
- [bot/reviewbot/tools/doc8.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/doc8.py)
- [bot/reviewbot/tools/testing/testcases.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/testing/testcases.py)
- [bot/reviewbot/tools/utils/codeclimate.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/utils/codeclimate.py)
- [bot/reviewbot/repositories.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/repositories.py)
- [extension/reviewbotext/forms.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/reviewbotext/forms.py)
- [extension/reviewbotext/integration.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/reviewbotext/integration.py)
- [extension/reviewbotext/resources.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/reviewbotext/resources.py)
- [README.rst](https://github.com/reviewboard/ReviewBot/blob/main/README.rst)
- [bot/README.rst](https://github.com/reviewboard/ReviewBot/blob/main/bot/README.rst)
</details>

# 工具插件系统与支持的检查器

## 系统概述与插件架构

Review Bot 的工具插件系统是一个面向 Review Board 的可扩展自动化审查框架。所有"检查器"都以独立的 Python 类实现，统一继承自基类 `BaseTool`，并通过混入（Mixin）类获得额外能力。Worker 进程在启动时会扫描 `bot/reviewbot/tools/` 目录下的模块，自动注册符合接口约定的工具类，从而让管理员在 Review Board 集成页面上即可按需启用它们。

```mermaid
classDiagram
    class BaseTool {
        +name: str
        +version: str
        +description: str
        +timeout: int
        +exe_dependencies: list
        +file_patterns: list
        +options: list
        +build_base_command()
        +handle_file()
    }
    class FilePatternsFromSettingMixin
    class FullRepositoryToolMixin
    class JavaToolMixin
    class JSHintTool
    class ClangTool
    class CargoTool
    class GoTool
    class PMDTool
    class Doc8Tool
    BaseTool <|-- JSHintTool
    BaseTool <|-- ClangTool
    BaseTool <|-- CargoTool
    BaseTool <|-- GoTool
    BaseTool <|-- PMDTool
    BaseTool <|-- Doc8Tool
    FilePatternsFromSettingMixin <|-- JSHintTool
    FilePatternsFromSettingMixin <|-- PMDTool
    FullRepositoryToolMixin <|-- ClangTool
    FullRepositoryToolMixin <|-- CargoTool
    FullRepositoryToolMixin <|-- GoTool
    JavaToolMixin <|-- PMDTool
```

资料来源：[bot/reviewbot/tools/base/__init__.py:1-31]() [README.rst:1-40]()

## 工具基类与混入能力

每个检查器必须继承 `BaseTool`，并声明若干描述自身能力的类属性：`name`、`version`、`description`、`timeout`、`exe_dependencies`（运行所依赖的外部可执行命令）、`file_patterns`（默认匹配的文件 glob 模式）以及 `options`（动态生成配置表单字段的字典列表）。核心执行逻辑由两个方法承担：`build_base_command()` 组装命令行，而 `handle_file()` 逐文件解析工具输出并生成 Review Board 评论。

为减少重复代码，框架在 [bot/reviewbot/tools/base/mixins.py:1-90]() 中提供了三种混入：

- `FilePatternsFromSettingMixin`：允许管理员通过配置覆盖默认的文件后缀。例如 `JSHintTool` 默认仅匹配 `*.js`，但管理员可以设置 `extra_ext_checks` 添加更多扩展名 [bot/reviewbot/tools/jshint.py:1-70]()。
- `FullRepositoryToolMixin`：为需要完整仓库上下文的工具（Clang、Cargo、Go）封装克隆与切换分支的流程 [bot/reviewbot/tools/clang.py:1-40]() [bot/reviewbot/tools/cargotool.py:1-35]() [bot/reviewbot/tools/gotool.py:1-35]()。
- `JavaToolMixin`：为 Java 系工具（如 PMD）封装 JVM 类路径与运行环境 [bot/reviewbot/tools/pmd.py:1-50]()。

## 已支持的语言检查器

官方在 [README.rst:1-80]() 与 [bot/README.rst]() 中按语言分组列出了当前支持的检查器，覆盖 C/C++、JavaScript、Rust、Go、Java、Python、Ruby、Shell 等主流生态：

| 类别 | 工具名称 | 主要功能 | 默认文件模式 |
|------|----------|----------|--------------|
| C/C++ | Clang Static Analyzer | 通过 `clang --analyze` 做静态分析 | `*.c` `*.cc` `*.cpp` `*.m` 等 |
| JavaScript | JSHint | 代码风格与潜在问题检查 | `*.js` |
| Rust | CargoTool | 集成 `cargo clippy` 与 `cargo test` | `*.rs` |
| Go | GoTool | 集成 `go vet` 与 `go test` | `*.go` |
| Java | PMD | 多规则集静态分析 | 通过 `file_ext` 设置 |
| Python | doc8 / flake8 / pycodestyle / pydocstyle / pyflakes | 文档与代码质量 | `*.py` `*.rst` |
| Ruby | RuboCop | 代码格式化 | `*.rb` |
| Shell | ShellCheck | Shell 脚本静态分析 | `*.sh` |

资料来源：[bot/reviewbot/tools/doc8.py:1-30]() [bot/reviewbot/tools/pmd.py:1-50]()

## 工具配置、测试与代码复用

每个工具通过 `options` 列表声明其配置项，字段类型使用 Django 表单（如 `django.forms.BooleanField`、`django.forms.IntegerField`）。框架在扩展端的 `ReviewBotConfigForm` 中依据此列表动态渲染配置表单，管理员可在 Web UI 中调整阈值、规则集等参数 [extension/reviewbotext/forms.py:1-80]()。

工具的测试由 `ToolTestCaseMetaclass` 统一编排 [bot/reviewbot/tools/testing/testcases.py:1-60]()，它会把每一个测试方法拆分为"模拟测试"与"集成测试"两类运行，避免开发者编写两套重复用例。能够输出 CodeClimate 通用格式的工具可直接复用 `add_comment_from_codeclimate_issue()` 工具函数 [bot/reviewbot/tools/utils/codeclimate.py:1-30]()，将统一位置信息转换为 Review Board 的行/列评论。

完整的仓库访问能力由 [bot/reviewbot/repositories.py:1-60]() 提供，对接 Git 等后端，并与 `FullRepositoryToolMixin` 配合完成克隆操作。扩展端的 `ReviewBotIntegration` 通过信号钩子订阅 `review_request_published` 等事件，把工具的产物写回 Review Board [extension/reviewbotext/integration.py:1-60]()。

## 4.1 版本相关变更

根据社区发布说明，Review Bot 4.1 重点修复了若干工具在新版外部程序输出格式变更后无法正确解析的问题，明确包含 `cargo clippy` 与 `cargo test`，因此贡献给 Rust 项目时常常出现的"评论乱码"被恢复 [release-4.1]()。同时，扩展端新增了 `notify_owner_only` 选项，允许将机器人发布的评论邮件通知仅发送给 Review Request 的所有者，以减少对其他订阅者的噪音 [extension/reviewbotext/forms.py:50-70]()，对应的 Web API 参数 `to_owner_only` 也在 4.1 中加入 [extension/reviewbotext/resources.py:1-80]()。

资料来源：[extension/reviewbotext/forms.py:50-70]() [extension/reviewbotext/resources.py:1-80]()

## See Also

- 扩展集成入口：[extension/reviewbotext/integration.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/reviewbotext/integration.py)
- 仓库后端实现：[bot/reviewbot/repositories.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/repositories.py)
- 工具测试框架：[bot/reviewbot/tools/testing/testcases.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/testing/testcases.py)
- 项目说明文档：[README.rst](https://github.com/reviewboard/ReviewBot/blob/main/README.rst)

---

<a id='page-4'></a>

## 部署方式与运维指南

### 相关页面

相关主题：[工具插件系统与支持的检查器](#page-3), [项目概述与核心特性](#page-1)

<details>
<summary>相关源码文件</summary>

以下源码文件用于生成本页说明：

- [README.rst](https://github.com/reviewboard/ReviewBot/blob/main/README.rst)
- [bot/README.rst](https://github.com/reviewboard/ReviewBot/blob/main/bot/README.rst)
- [bot/setup.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/setup.py)
- [extension/setup.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/setup.py)
- [extension/reviewbotext/__init__.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/reviewbotext/__init__.py)
- [extension/reviewbotext/integration.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/reviewbotext/integration.py)
- [extension/reviewbotext/forms.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/reviewbotext/forms.py)
- [extension/reviewbotext/resources.py](https://github.com/reviewboard/ReviewBot/blob/main/extension/reviewbotext/resources.py)
- [bot/reviewbot/repositories.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/repositories.py)
- [bot/reviewbot/tools/base/mixins.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/base/mixins.py)
- [bot/reviewbot/tools/cargotool.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/cargotool.py)
- [bot/reviewbot/tools/testing/testcases.py](https://github.com/reviewboard/ReviewBot/blob/main/bot/reviewbot/tools/testing/testcases.py)
</details>

# 部署方式与运维指南

## 1. 部署概述

Review Bot 是一个由两部分组成的分布式自动化代码审查系统，分别发布为两个 PyPI 包：服务器端的 `Review Bot extension` 与工作端的 `Review Bot worker`。用户在管理员站点完成集成配置后，工作端会作为后台进程拉取待审查任务，并在 Review Board 中发布结果。资料来源：[README.rst](README.rst) 中明确指出官方提供 Docker 镜像以及完整的文档与下载入口。

部署形态分为三类：

| 部署方式 | 适用场景 | 说明 |
| --- | --- | --- |
| 官方 Docker 镜像 | 生产环境快速部署 | 由维护团队发布，需配合 Review Board 主站点 |
| 源码 / pip 安装 | 自定义扩展与调试 | 分别安装 `reviewbot-extension` 与 `reviewbot-worker` |
| 容器内手动安装 | 高级运维场景 | 在基础镜像中安装额外工具链 |

两个组件通过 Review Board 的 Web API 与信号机制进行通信，工作端使用 Celery 消费任务队列。资料来源：[extension/setup.py](extension/setup.py) 显示扩展依赖 `celery~=5.3`，Python 版本要求 `>=3.8`。

## 2. 组件架构

### 2.1 Worker 进程（bot/）

`bot/setup.py` 中的 `entry_points` 段注册了全部可用工具，用户安装包后即可在 Review Board 中选择这些工具：

```text
cargotool   = reviewbot.tools.cargotool:CargoTool
checkstyle  = reviewbot.tools.checkstyle:CheckstyleTool
clang       = reviewbot.tools.clang:ClangTool
cppcheck    = reviewbot.tools.cppcheck:CPPCheckTool
cpplint     = reviewbot.tools.cpplint:CPPLintTool
doc8        = reviewbot.tools.doc8:Doc8Tool
fbinfer     = reviewbot.tools.fbinfer:FBInferTool
flake8      = reviewbot.tools.flake8:Flake8Tool
gofmt       = reviewbot.tools.gofmt:GofmtTool
gotool      = reviewbot.tools.gotool:GoTool
jshint      = reviewbot.tools.jshint:JSHintTool
pmd         = reviewbot.tools.pmd:PMDTool
pycodestyle = reviewbot.tools.pycodestyle:PycodestyleTool
pydocstyle  = reviewbot.tools.pydocstyle:PydocstyleTool
pyflakes    = reviewbot.tools.pyflakes:PyflakesTool
rbsecretscanner = reviewbot.tools.rbsecretscanner:SecretScannerTool
rubocop     = reviewbot.tools.rubocop:RubocopTool
rustfmt     = reviewbot.tools.rustfmt:RustfmtTool
shellcheck  = reviewbot.tools.shellcheck:ShellCheckTool
```

资料来源：[bot/setup.py](bot/setup.py) 列出全部工具入口点。任何新增的工具必须遵循相同的命名约定才能被 Review Board 识别。

### 2.2 Extension 插件（extension/）

`extension/reviewbotext/integration.py` 中定义的 `ReviewBotIntegration` 类负责接收 Review Board 的信号，并触发对应工具的执行。它通过 `SignalHook` 监听 `review_request_published` 与 `status_update_request_run` 两个信号：

```python
SignalHook(self, review_request_published,
           self._on_review_request_published)
SignalHook(self, status_update_request_run,
           self._on_status_update_request_run)
```

资料来源：[extension/reviewbotext/integration.py](extension/reviewbotext/integration.py) 展示了集成钩子的注册方式。

## 3. 工具与扩展配置

### 3.1 工具的声明方式

每个工具类继承自 `BaseTool`，并定义 `name`、`version`、`description`、`timeout`、`exe_dependencies`、`file_patterns`、`options` 等属性。例如下面的 Cargo 工具片段：

```python
class CargoTool(FullRepositoryToolMixin, BaseTool):
    name = 'CargoTool'
    version = '1.0'
    timeout = 120
    exe_dependencies = ['cargo', 'cargo-clippy']
    file_patterns = ['*.rs']
```

资料来源：[bot/reviewbot/tools/cargotool.py](bot/reviewbot/tools/cargotool.py) 是工具声明的典型范例。`FullRepositoryToolMixin` 表明该工具需要拉取整个仓库才能运行，而 `BaseTool` 默认是按文件运行。

### 3.2 用户表单配置

工具实例化时所使用的设置由 `ReviewBotConfigForm` 收集，它支持单次评论上限、仅通知 review request 拥有者等高级选项。资料来源：[extension/reviewbotext/forms.py](extension/reviewbotext/forms.py) 中的 `notify_owner_only` 字段是 4.1 版本新增的特性，用于限制邮件通知的接收范围。

## 4. 运维要点与常见故障

### 4.1 仓库缓存与目录布局

工作端通过 `appdirs.site_data_dir('reviewbot')` 计算本地仓库根目录，所有克隆均落在该目录下。`BaseRepository` 类记录 `name`、`clone_path`、`repo_path` 三项关键属性，并按需惰性拉取。资料来源：[bot/reviewbot/repositories.py](bot/reviewbot/repositories.py) 描述了仓库生命周期管理。

### 4.2 文件模式匹配

若工具需要根据用户配置动态扩展待检查的文件后缀，可使用 `FilePatternsFromSettingMixin`。该 mixin 读取以逗号分隔的扩展名或模式列表，并允许子类通过 `file_extensions_setting` 与 `file_patterns_setting` 进行声明。资料来源：[bot/reviewbot/tools/base/mixins.py](bot/reviewbot/tools/base/mixins.py)。

### 4.3 升级与兼容性

* 4.1 版本恢复了若干工具因上游输出格式变化而出现的解析问题，运维人员升级后应重新跑一次回归。资料来源：社区讨论中明确指出 `cargo clippy` 与 `cargo test` 的输出格式修正。
* 3.2 版本强化了 Review Board 5 / 6 的兼容性，并改进了 Secret Scanning 与自动审查体验。资料来源：3.2 发布说明。
* 扩展包和 worker 包都明确要求 Python `>=3.8`，CI 在 3.8 至 3.13 区间内验证。资料来源：[bot/setup.py](bot/setup.py)、[extension/setup.py](extension/setup.py)。

### 4.4 测试与回归

工具测试应继承 `BaseToolTestCase`，它通过 `ToolTestCaseMetaclass` 将仿冒（simulation）与集成（integration）测试方法自动拆分为独立的用例。资料来源：[bot/reviewbot/tools/testing/testcases.py](bot/reviewbot/tools/testing/testcases.py) 提供了详细的测试脚手架，便于在升级工具链时验证解析逻辑仍然正确。

## 5. 部署架构总览

```mermaid
graph LR
  A[Review Board Server] -- WebAPI --> B[Review Bot Extension]
  B -- 信号触发 --> C[Celery 任务队列]
  C --> D[Review Bot Worker]
  D -- 拉取/克隆 --> E[本地仓库缓存]
  D -- 调用外部命令 --> F[代码检查工具]
  F -- 解析输出 --> D
  D -- 提交评论 --> A
```

## See Also

- [Review Board 官方文档](https://www.reviewboard.org/docs/)
- [Review Bot 下载与发布说明](https://www.reviewboard.org/downloads/reviewbot/)
- [社区讨论列表](https://groups.google.com/group/reviewboard/)

---

<!-- evidence_pipeline_checked: true -->
<!-- evidence_injected: true -->

---

## Doramagic 踩坑日志

项目：reviewboard/ReviewBot

摘要：发现 6 个潜在踩坑项，其中 0 个为 high/blocking；最高优先级：能力坑 - 能力判断依赖假设。

## 1. 能力坑 · 能力判断依赖假设

- 严重度：medium
- 证据强度：source_linked
- 发现：README/documentation is current enough for a first validation pass.
- 对用户的影响：假设不成立时，用户拿不到承诺的能力。
- 证据：capability.assumptions | github_repo:3355797 | https://github.com/reviewboard/ReviewBot | README/documentation is current enough for a first validation pass.

## 2. 维护坑 · 维护活跃度未知

- 严重度：medium
- 证据强度：source_linked
- 发现：未记录 last_activity_observed。
- 对用户的影响：新项目、停更项目和活跃项目会被混在一起，推荐信任度下降。
- 证据：evidence.maintainer_signals | github_repo:3355797 | https://github.com/reviewboard/ReviewBot | last_activity_observed missing

- 严重度：medium
- 证据强度：source_linked
- 发现：no_demo
- 证据：downstream_validation.risk_items | github_repo:3355797 | https://github.com/reviewboard/ReviewBot | no_demo; severity=medium

## 4. 安全/权限坑 · 存在评分风险

- 严重度：medium
- 证据强度：source_linked
- 发现：no_demo
- 对用户的影响：风险会影响是否适合普通用户安装。
- 证据：risks.scoring_risks | github_repo:3355797 | https://github.com/reviewboard/ReviewBot | no_demo; severity=medium

## 5. 维护坑 · issue/PR 响应质量未知

- 严重度：low
- 证据强度：source_linked
- 发现：issue_or_pr_quality=unknown。
- 对用户的影响：用户无法判断遇到问题后是否有人维护。
- 证据：evidence.maintainer_signals | github_repo:3355797 | https://github.com/reviewboard/ReviewBot | issue_or_pr_quality=unknown

## 6. 维护坑 · 发布节奏不明确

- 严重度：low
- 证据强度：source_linked
- 发现：release_recency=unknown。
- 对用户的影响：安装命令和文档可能落后于代码，用户踩坑概率升高。
- 证据：evidence.maintainer_signals | github_repo:3355797 | https://github.com/reviewboard/ReviewBot | release_recency=unknown

<!-- canonical_name: reviewboard/ReviewBot; human_manual_source: deepwiki_human_wiki -->