sagebionetworks/genie-bpc-quac-wrapper

GENIE BPC 质量保证检查清单包装器

概述和主要用途

GENIE BPC 质量保证检查清单包装器是一个工具，用于监控请求的上传实体，并在实体修改和错误报告生成时通知联系人。该工具设计用于 Service Catalog 的调度作业环境，以实现自动化的质量监控和通知流程。

核心功能和特性

• 上传实体监控：跟踪请求的上传实体状态变化
• 通知机制：在实体修改和错误报告生成时自动通知联系人
• 时间配置：支持按天或小时为单位配置监控时间范围
• 测试模式：可在合成测试上传数据上运行，验证功能正确性
• 详细日志：提供详细的脚本进度报告，便于调试和状态跟踪
• Synapse 集成：通过 Synapse 个人访问令牌（PAT）进行认证，确保安全访问

使用场景和适用范围

适用于需要自动化监控 GENIE BPC 项目上传实体状态的场景，特别适合：

• Service Catalog 调度作业环境中的定期质量检查
• 需要及时获取实体修改和错误报告通知的团队协作场景
• 开发和测试阶段对质量保证流程的验证

使用方法和配置说明

安装

1. 克隆仓库并导航至项目目录：

bash
git clone git@github.com:Sage-Bionetworks/genie-bpc-quac-wrapper.git
cd genie-bpc-quac-wrapper/

2. 构建 Docker 镜像：

bash
docker build -t genie-bpc-quac-wrapper .

Synapse 认证配置

需将 Synapse 个人访问令牌（PAT）设置为环境变量以进行认证：

bash
export SYNAPSE_AUTH_TOKEN={此处替换为您的个人访问令牌}

命令行接口和参数说明

运行容器以显示命令行接口帮助：

bash
docker run -e SYNAPSE_AUTH_TOKEN=$SYNAPSE_AUTH_TOKEN --rm genie-bpc-quac-wrapper -h

命令行接口参数说明：

usage: genie-bpc-quac-wrapper.R [-h] [-v VALUE] [-u {day,hour}] [-t] [-d]

optional arguments:
  -h, --help            显示帮助信息并退出
  -v VALUE, --value VALUE 时间单位数量（默认：1）
  -u {day,hour}, --unit {day,hour} 时间单位（默认：day）
  -t, --testing         在合成测试上传上运行
  -d, --verbose         向用户报告脚本进度的详细信息

示例运行

1. 显示帮助信息：

bash
docker run -e SYNAPSE_AUTH_TOKEN=$SYNAPSE_AUTH_TOKEN --rm genie-bpc-quac-wrapper -h

2. 详细模式运行（默认检查过去1天）：

bash
docker run -e SYNAPSE_AUTH_TOKEN=$SYNAPSE_AUTH_TOKEN --rm genie-bpc-quac-wrapper -d

3. 检查过去2小时的上传（详细模式）：

bash
docker run -e SYNAPSE_AUTH_TOKEN=$SYNAPSE_AUTH_TOKEN --rm genie-bpc-quac-wrapper -v 2 -u hour -d

4. 测试模式运行（使用合成测试数据）：

bash
docker run -e SYNAPSE_AUTH_TOKEN=$SYNAPSE_AUTH_TOKEN --rm genie-bpc-quac-wrapper -t -d

注意事项

当 https://github.com/Sage-Bionetworks/genie-bpc-quac 仓库更新时，需通过拉取请求手动触发关联的 Docker 镜像更新。