moodlehq/bigbluebutton_mock

BigBlueButton模拟API服务器

镜像概述

本项目及相关Docker容器提供了BigBlueButton主服务器的模拟实现，可用于测试BigBlueButton集成功能。该镜像旨在为开发和测试环境提供一个轻量级、可控的BBB API模拟服务，避免对真实BBB服务器的依赖。

核心功能与特性

• 模拟BigBlueButton主要API端点，支持集成测试
• 支持并行运行，通过serverID前缀区分不同测试实例
• 提供后台管理端点，用于创建测试数据和重置状态
• 轻量级设计，易于部署和集成到自动化测试流程
• 兼容Moodle Docker测试环境，支持无缝集成

使用场景与适用范围

• 自动化测试：为PHPUnit、Behat等测试框架提供BBB API模拟服务
• 开发环境：在本地开发中模拟BBB服务器行为，无需部署真实服务器
• Moodle集成测试：与Moodle Docker环境配合，测试BBB模块功能
• 持续集成/持续部署(CI/CD)：作为测试阶段的依赖服务，确保集成功能稳定性

使用方法与配置说明

Docker快速启动

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

bash
docker run -p 8001:80 docker.xuanyuan.run/moodlehq/bigbluebutton_mock

自动化测试配置

运行PHPUnit或Behat等自动化测试时，需在config.php中定义TEST_MOD_BIGBLUEBUTTONBN_MOCK_SERVER常量，否则大多数BBB测试将被标记为跳过。

示例配置（添加到config.php中$CFG->wwwroot行之后）：

php
define('TEST_MOD_BIGBLUEBUTTONBN_MOCK_SERVER', "http://localhost:8001/hash" . sha1($CFG->wwwroot));

Moodle Docker集成

https://github.com/moodlehq/moodle-docker测试环境（自#241 PR起）已内置对该模拟服务器的支持。启动容器前，只需导出环境变量：

bash
export MOODLE_DOCKER_BBB_MOCK=1

API端点说明

所有端点必须以serverID为前缀，以支持并行运行，例如：

http://localhost:8001/someServerID/api

除标准端点外，提供以下后台管理端点用于测试数据管理：

• /backoffice/createMeeting：创建测试会议
• /backoffice/createRecording：创建测试录制
• /backoffice/reset：重置测试状态（测试间使用）
• /backoffice/meetings：查看当前会议列表
• /backoffice/recordings：查看当前录制列表

本地开发指南

依赖安装

• Symfony CLI：

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

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

  bash
  sudo apt install php7.4-sqlite3
  

环境检查

bash
cd application
symfony check:requirements

数据库设置

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

注意：数据库设计为一次性使用，不保证迁移兼容性。请准备好随时删除并重新创建数据库。

发布状态

若需发布到自有仓库（Docker Hub或Git Container Registry），需定义以下secrets（参考https://docs.github.com/en/actions/security-guides/encrypted-secrets）：

• DOCKERHUB_OWNER
• DOCKERHUB_TOKEN
• DOCKERHUB_USERNAME
• GH_OWNER