SyTest Docker镜像

这些Dockerfile创建用于运行SyTest的容器，支持多种配置。SyTest本身不包含在这些镜像中，但包含其依赖。

包含的镜像

• matrixdotorg/sytest：基础容器，已安装SyTest依赖
  • 标签基于底层Debian/Ubuntu镜像：bionic、buster或testing
• matrixdotorg/sytest-synapse：针对Synapse运行SyTest
  • 标签基于底层Debian/Ubuntu镜像：bionic、buster或testing
• matrixdotorg/sytest-dendrite:go113：在Go 1.13上针对Dendrite运行SyTest
  • 当前使用Debian 10（Buster）作为基础镜像

目标特定详情

Synapse

sytest-synapse镜像要求将Synapse git仓库的检出目录挂载到/src；服务器日志将写入/logs，建议同时挂载卷到该目录。

使用示例

bash
docker run --rm -it -v /path/to/synapse:/src:ro -v /path/to/日志存放目录:/logs matrixdotorg/sytest-synapse:buster

环境变量

通过-e设置以下变量控制测试：

• POSTGRES：设为非空值以使用PostgreSQL数据库（默认sqlite）
• WORKERS：设为非空值以测试工作模式部署（需POSTGRES，默认单体模式）
• REDIS：设为非空值以使用redis复制（需WORKERS，替代旧TCP方式）
• OFFLINE：设为非空值以避免更新Python/Perl依赖
• BLACKLIST：设为非空值以修改默认黑名单文件（路径相对于Synapse目录）
• TIMEOUT_FACTOR：测试超时时间的乘数

配置示例

• 工作模式（TCP复制）：

  bash
  docker run --rm -it -e POSTGRES=1 -e WORKERS=1 -v /path/to/synapse:/src:ro \
      -v /path/to/日志存放目录:/logs matrixdotorg/sytest-synapse:buster
  

• 工作模式（Redis）：

  bash
  docker run --rm -it -e POSTGRES=1 -e WORKERS=1 -e REDIS=1 \
       -v /path/to/synapse:/src:ro \
       -v /path/to/日志存放目录:/logs \
       matrixdotorg/sytest-synapse:buster
  

Dendrite

sytest-dendrite镜像要求将Dendrite git仓库的检出目录挂载到/src；服务器日志写入/logs，建议挂载卷到该目录。

使用示例

bash
docker run --rm -it -v /path/to/dendrite:/src:ro -v /path/to/日志存放目录:/logs matrixdotorg/sytest-dendrite

使用本地Sytest检出目录

默认情况下，镜像会下载对应分支的Sytest（通常与目标homeserver同名分支或develop分支）。若需使用本地Sytest检出目录，可挂载到容器的/sytest文件夹：

bash
docker run --rm -it -v /path/to/synapse:/src:ro -v /path/to/日志存放目录:/logs \
    -v /path/to/code/sytest:/sytest:ro matrixdotorg/sytest-synapse:buster

运行单个测试文件及命令行选项

可在docker命令末尾添加参数以传递给sytest。例如运行单个测试文件：

bash
docker run --rm -it ... matrixdotorg/sytest-synapse:buster tests/20profile-events.pl

构建容器

通过以下命令构建并推送容器：

bash
./build.sh  # 构建容器
./push.sh   # 推送到Docker Hub

启动时加载sytest插件

设置PLUGINS环境变量以自动加载插件，值为一个或多个tar.gz文件URL（空格分隔）。引导脚本会在插件中搜索${SYTEST_TARGET}_sytest.sh以执行自定义脚本。

bash
docker run --rm -it -e PLUGINS="[***] [***]"