sdcplatform/ras-secure-message

ras-secure-message镜像说明

镜像概述

ras-secure-message是为RAS系统设计的安全消息服务API镜像，用于实现受访者与ONS（英国国家统计局）之间的消息传递功能，支持安全认证、通知集成等特性。

核心功能

1. 提供受访者与ONS之间的消息传递API接口
2. 支持基础认证和JWT安全机制保障通信安全
3. 可集成Gov Notify服务发送通知
4. 与ras-party服务及UAA实例交互获取必要数据

使用场景

适用于RAS系统中受访者与ONS之间的安全消息通信场景，例如调查数据相关的消息交互、通知推送等。

配置说明

环境变量配置

以下是可配置的环境变量列表：

部署示例

Docker Run方式

1. 启动PostgreSQL容器：

bash
docker run -d -p 5432:5432 --name postgres -e POSTGRES_PASSWORD=postgres -e POSTGRES_DB=postgres postgres

2. 运行应用（需先配置环境变量）：

bash
pipenv run python run.py

Docker Compose方式

bash
docker-compose up

Make命令方式（PostgreSQL已配置时）

bash
make start

测试说明

1. 安装依赖：

bash
make build

2. 确保PostgreSQL运行：

bash
docker run -d -p 5432:5432 --name postgres -e POSTGRES_PASSWORD=postgres -e POSTGRES_DB=postgres postgres

3. 运行测试：

bash
make test # 运行所有测试（linters、behave和单元测试）
make lint # 仅运行linters

4. 测试API健康状态：

bash
curl http://127.0.0.1:5050/health

预期响应：{"status": "healthy"}

数据库迁移说明

镜像包含“migrations”文件夹用于记录SQL迁移文件，但目前未使用Alembic等迁移工具，需手动执行迁移脚本到数据库。