moodlehq/matrixsynapse_mock

Matrix Synapse Mock API Server

镜像概述和主要用途

该Docker镜像提供Matrix Synapse服务器的部分模拟实现，用于测试Synapse集成场景，尤其适用于Moodle平台的Matrix相关功能测试。通过模拟真实Synapse服务器的HTTP状态码、内容类型和响应内容，支持并行测试环境隔离及测试间状态重置。

核心功能和特性

• 端点隔离：所有API端点需添加serverID前缀，支持多并行测试环境
• 后台管理接口：提供创建管理员用户（/backoffice/create-admin）和重置测试状态（/backoffice/reset）功能
• 核心API模拟：实现Synapse和Matrix标准API的关键功能，包括用户管理、房间操作、认证授权等
• 真实响应模拟：模拟真实Synapse服务器的HTTP状态码、响应格式及错误码（如M_UNRECOGNIZED）

使用场景和适用范围

• Moodle平台的Matrix集成自动化测试（PHPUnit、Behat）
• Synapse客户端应用开发的本地测试环境
• 需要模拟Matrix协议交互的集成测试场景

使用方法和配置说明

快速部署（Docker）

通过以下命令启动Mock服务器：

bash
docker run -p 8001:80 moodlehq/matrixsynapse_mock

服务器将在本地8001端口运行，API访问路径需包含serverID前缀（如http://localhost:8001/serverID/API）。

API使用说明

基础访问格式

所有API请求需包含serverID前缀，格式如下：

http://{host}:{port}/{serverID}/{API路径}

后台管理接口

• 创建管理员用户
  请求方法：POST
  路径：/backoffice/create-admin

• 重置测试状态
  请求方法：POST
  路径：/backoffice/reset

示例请求：

bash
curl -i GET http://localhost:8001/serverID/backoffice/create-admin

错误响应示例：

json
{
    "errcode": "M_UNRECOGNIZED",
    "error": "Unrecognized request"
}

支持的API功能

• Synapse Mock API

  • 注册新用户（PUT）
  • 更新用户信息（PUT）
  • 获取用户信息（GET）
  • 添加用户到房间（POST）
  • 删除房间（DELETE）
  • 获取房间信息（GET）

• Matrix Mock API

  • 用户登录（POST）
  • 刷新令牌（POST）
  • 创建房间（POST）
  • 从房间移除用户（POST）
  • 房间属性操作（更新主题、名称、头像，PUT）
  • 获取房间成员（GET）
  • 媒体上传（POST）

API覆盖范围示例

无认证头请求

bash
curl -i -X GET http://localhost:8001/someServerID/_synapse/admin/v2/users/@barzuser:synapse

错误HTTP方法请求

bash
curl -i --header "Authorization: Bearer syt_YWRtaW4_iNofAsbInAInYAFwkmdi_1oVMxI" \
-X POST http://localhost:8001/someServerID/_synapse/admin/v2/users/@testuser:synapse

获取用户信息（支持存在/不存在用户场景）

bash
curl -i --header "Authorization: Bearer syt_YWRtaW4_iNofAsbInAInYAFwkmdi_1oVMxI" \
-X GET http://localhost:8001/someServerID/_synapse/admin/v2/users/@testuser:synapse

创建/更新用户

bash
curl -i --header "Authorization: Bearer syt_YWRtaW4_iNofAsbInAInYAFwkmdi_1oVMxI" \
-X PUT \
-d '{"displayname":"aSomeone new","threepids":[{"medium":"email","address":"aaanewuser@bar.com"}],"external_ids":[{"auth_provider":"oidc-keycloak","external_id":"43b3b9f9-4100-413f-9797-223b067b6e7e"}]}' \
http://localhost:8001/someServerID/_synapse/admin/v2/users/@anewuser:synapse

自动化测试配置

在Moodle自动化测试（如PHPUnit、Behat）中，需在config.php中定义TEST_COMMUNICATION_MATRIX_MOCK_SERVER常量，否则Matrix相关测试将被标记为跳过。配置示例：

php
// 在$CFG->wwwroot行之后添加
define('TEST_COMMUNICATION_MATRIX_MOCK_SERVER', "http://localhost:8001/hash" . sha1($CFG->wwwroot));

本地开发指南

依赖安装

• Symfony CLI：

  bash
  wget https://get.symfony.com/cli/installer -O - | bash
  

• PHP SQLite3（示例，根据PHP版本调整）：

  bash
  sudo apt install php7.4-sqlite3
  

环境准备

1. 检查系统需求：

   bash
   cd application
   symfony check:requirements
   

2. 数据库设置（数据库设计为可丢弃，不保证迁移兼容性）：

   bash
   php bin/console doctrine:database:drop --force
   php bin/console doctrine:schema:create
   

运行项目

• 启动服务器：

  bash
  symfony server:start --port=8001 --no-tls --allow-http
  

• 调试模式：

  bash
  XDEBUG_SESSION=1 symfony server:start --port=8001 --no-tls --allow-http
  

参考文档

• https://matrix-org.github.io/synapse/latest/usage/administration/admin_api/index.html
• Matrix官方API规范

发布状态

若需发布到自定义仓库（Docker Hub或Git Container Registry），需配置以下密钥（参考https://docs.github.com/en/actions/security-guides/encrypted-secrets%EF%BC%89%EF%BC%9A

• DOCKERHUB_OWNER
• DOCKERHUB_TOKEN
• DOCKERHUB_USERNAME
• GH_OWNER

!https://github.com/moodlehq/matrixsynapse_mock/actions/workflows/backoffice/reset

示例代码

• Docker Compose示例：

  yaml
  version: '3'
  services:
    moodle:
      image: moodlehq/matrixsynapse_mock
      ports:
        - "8001:80"
  

• 测试环境变量配置：

  bash
  export MOODLE_DOCKER_WEB_PORT=8080
  

• 模拟API请求：

  bash
  curl -X POST http://localhost:8001/serverID/backoffice/reset
  

注意事项

• 模拟服务器不持久化数据，重启后数据将丢失，适合测试环境。
• 支持的功能和参数可能与真实服务器存在差异，需根据实际情况调整。

通过以上配置和使用方法，用户可以快速部署和使用Matrix Synapse模拟服务器，确保应用的功能测试更加高效和可靠。