cometbft/e2e-node

CometBFT端到端测试应用镜像

镜像概述和主要用途

本Docker镜像提供了针对CometBFT***框架的端到端测试应用，旨在通过模拟真实场景下的节点交互、交易处理和共识流程，全面验证CometBFT的功能正确性、性能表现及系统稳定性。镜像内置测试工具链和预设测试场景，支持快速部署测试环境并执行自动化测试流程。

核心功能和特性

• 多节点测试环境模拟：支持一键部署包含多个CometBFT节点的测试网络，模拟分布式***环境
• 共识协议验证：自动测试Tendermint共识算法的核心流程，包括提案、预投票、预提交及提交阶段的正确性
• 交易流程测试：模拟用户交易提交、区块打包、状态同步等完整流程，验证交易处理逻辑
• 网络异常场景模拟：支持网络分区、节点故障及恢复等异常场景测试，验证系统容错能力
• 性能指标收集：实时采集测试过程中的节点响应时间、区块生成速度、共识延迟等关键指标
• 测试用例可扩展：支持用户自定义测试用例，通过挂载配置文件扩展测试场景

使用场景和适用范围

• CometBFT框架开发者：在框架迭代过程中验证新功能或修复的正确性
• 应用开发者：测试基于CometBFT构建的应用在共识、交易等流程中的兼容性
• 自动化测试流程：集成到CI/CD管道中，作为代码提交或版本发布前的自动化测试环节
• 共识算法研究：模拟不同网络规模、节点配置下的共识行为，分析算法性能瓶颈
• 系统稳定性验证：长时间运行测试以验证CometBFT在持续负载下的稳定性

使用方法和配置说明

基本使用（Docker Run）

通过以下命令启动基础测试环境，默认执行预设的共识协议测试用例：

bash
docker run -it --name cometbft-e2e-test \
  -v /path/to/custom/testcases:/testcases \  # 可选：挂载自定义测试用例
  -e NODE_COUNT=4 \                         # 测试节点数量（默认4）
  -e TEST_DURATION=300 \                    # 测试持续时间（秒，默认300）
  -e LOG_LEVEL=info \                       # 日志级别（debug/info/warn/error，默认info）
  cometbft/e2e-test

Docker Compose配置（多节点复杂测试）

对于需要模拟复杂网络拓扑的测试场景，可使用docker-compose.yml配置多节点协同测试：

yaml
version: '3'
services:
  test-controller:
    image: docker.xuanyuan.run/cometbft/e2e-test
    command: ["run", "--controller"]
    environment:
      - NODE_COUNT=5
      - TEST_CASE=/testcases/network_partition_test.json
      - METRICS_OUTPUT=/metrics/results.json
    volumes:
      - ./testcases:/testcases
      - ./metrics:/metrics
    depends_on:
      - node-1
      - node-2
      - node-3
      - node-4
      - node-5

  node-1:
    image: docker.xuanyuan.run/cometbft/cometbft:latest
    command: ["node", "--proxy_app=kvstore"]
    volumes:
      - ./node1/data:/cometbft/data
      - ./node1/config:/cometbft/config

  # 重复定义node-2至node-5，配置对应的数据和配置目录

配置参数说明

自定义测试用例

用户可通过挂载JSON格式的自定义测试用例文件扩展测试场景，测试用例基本结构示例：

json
{
  "name": "网络分区恢复测试",
  "steps": [
    {
      "action": "start_network",
      "nodes": 5
    },
    {
      "action": "partition_network",
      "partitions": [["node-1", "node-2"], ["node-3", "node-4", "node-5"]],
      "duration": 60
    },
    {
      "action": "heal_network",
      "verify_consensus": true
    },
    {
      "action": "submit_transactions",
      "count": 100,
      "rate": 10
    }
  ],
  "expected_results": {
    "consensus_achieved": true,
    "transaction_success_rate": ">95%"
  }
}

注意事项

• 测试过程中需确保Docker环境资源充足（建议至少4GB内存、2核CPU），避免资源限制影响测试结果
• 自定义测试用例需遵循JSON Schema规范，可通过镜像内置的validate-testcase命令验证格式正确性
• 长时间运行测试建议挂载外部日志目录，避免容器内日志文件过大
• 网络延迟、节点数量等参数需根据测试目标合理配置，过度模拟极端场景可能导致测试效率降低