onsdigital/eq-survey-runner

eQ Survey Runner Docker镜像文档

镜像概述和主要用途

eQ Survey Runner是ONSdigital开发的调查运行应用Docker镜像，用于部署和运行调查应用。该镜像支持本地开发、测试及前端资源管理，通过Docker Compose实现容器化部署，简化环境配置，确保开发与测试环境一致性。

核心功能和特性

• 容器化部署：通过Docker Compose一键构建和启动应用容器
• 热重载支持：代码更改实时反映到运行中的应用，无需重启容器
• 多环境测试：支持本地、Docker及预生产环境的功能测试
• 前端资源管理：集成Node.js、Yarn和Gulp，支持JS/CSS编译、代码 lint 及测试
• JWT认证集成：支持基于JWT的用户认证，需使用RSA密钥对签名和加密
• 国际化支持：通过Flask-Babel实现多语言翻译，支持消息提取和编译
• 性能分析：可通过环境变量启用请求级性能分析，生成Pstats报告

使用场景和适用范围

• 调查应用的本地开发环境搭建
• 自动化测试（单元测试、功能测试）执行
• CI/CD流程中的应用构建与部署验证
• 前端资源的编译与优化

使用方法和配置说明

前置条件

• 安装Docker及Docker Compose：Docker官方安装指南

Docker部署步骤

1. 启动应用容器

bash
# 构建并后台运行容器
docker-compose up -d

应用启动后可通过 http://localhost:8000/ 访问。代码更改会实时生效，但新增依赖需重建容器。

2. 重建容器

bash
# 常规重建
docker-compose build

# 从零重建（重新加载依赖）
docker-compose build --no-cache

3. 运行单元测试

bash
# 构建应用镜像
docker build -t onsdigital/eq-survey-runner .

# 构建测试镜像
docker build -t onsdigital/eq-survey-runner-unit-tests -f Dockerfile.test .

# 运行单元测试
docker run onsdigital/eq-survey-runner-unit-tests

4. 启动调查入口工具

需配合上游工具生成JWT令牌以登录应用：

bash
docker run -it -p 8000:8000 onsdigital/go-launch-a-survey:latest

前端工具包使用

前端依赖Node.js和Yarn，支持以下命令：

功能测试选项

可通过参数指定测试环境、测试用例或测试套件：

bash
# 示例：通过Sauce Labs在预生产环境运行MCI测试用例
yarn test_functional_sauce -- --env=preprod --spec=mci

环境变量配置

应用环境变量

测试环境变量

JWT集成说明

访问应用需提供有效的JWE加密JWT令牌，通过/session?token=<JWE_TOKEN>访问。

JWT要求

• Payload：包含exp（过期时间）和iat（签发时间）
• Header：alg=RS256，type=JWT，kid=EDCRRM
• JWE Header：alg=RSA-OAEP，enc=A256GCM

开发环境令牌生成

使用项目脚本生成测试令牌：

bash
python token_generator.py

性能分析

设置EQ_PROFILING=True启用性能分析，报告生成在profiling目录，可通过Pstats查看：

bash
python -m pstats <profiling_filename>

依赖管理

通过hashin工具管理依赖哈希，安装依赖时使用--require-hashes确保包完整性：

bash
# 安装hashin
pip install hashin

# 添加依赖并更新哈希
hashin <package_name>

# 安装依赖（验证哈希）
pip install --require-hashes -r requirements.txt