fnndsc/chris_store

ChRIS_store

ChRIS_store是ChRIS插件应用商店的后端服务，基于Django-PostgreSQL架构，用于存储ChRIS插件应用和工作流的描述信息，并支持将这些插件注册到ChRIS CUBE实例。

核心功能和特性

• Django-PostgreSQL架构：采用成熟的Django Web框架与PostgreSQL数据库组合，提供稳定可靠的后端服务
• 插件与工作流管理：支持ChRIS插件应用和工作流的存储、描述及注册管理
• REST API接口：提供完整的RESTful API，支持插件查询、注册、用户管理等操作
• 多环境支持：提供开发、测试和生产环境的部署配置
• 自动化测试：内置单元测试和集成测试支持，确保代码质量
• 安全配置：生产环境支持Docker Swarm部署及 secrets 管理

使用场景和适用范围

• ChRIS生态系统开发与维护
• 插件应用的集中管理与分发
• 工作流的存储与注册
• ChRIS CUBE实例的插件资源管理
• 开发团队进行ChRIS插件后端服务的二次开发

前置条件

支持平台

• Ubuntu 18.04+、MAC OS X 10.14+、Fedora 31+（Fedora需额外配置，详见https://github.com/mairin/ChRIS_store/wiki/Getting-the-ChRIS-Store-to-work-on-Fedora%EF%BC%89

软件要求

• Docker 18.06.0+
• Docker Compose 1.27.0+

Linux系统额外配置

将用户添加到docker组：

bash
sudo usermod -aG docker $USER

（配置后需注销并重新登录生效）

使用方法

快速启动（开发环境）

若只需快速启动开发环境实例：

bash
git clone https://github.com/FNNDSC/ChRIS_store
cd ChRIS_store
./make.sh down ; ./make.sh up

注意：此方式使用Django开发服务器，不适用于生产环境

生产环境部署

初始化Docker Swarm

bash
docker swarm init --advertise-addr 127.0.0.1

获取源码

bash
git clone https://github.com/FNNDSC/ChRIS_store
cd ChRIS_store

配置secrets

创建secrets目录：

bash
mkdir swarm/prod/secrets

将所需的密钥配置文件复制到secrets目录，具体文件说明见https://github.com/FNNDSC/ChRIS_store/wiki/ChRIS-store-backend-production-services-secret-configuration-files

部署服务

bash
./deploy.sh up

停止服务

bash
cd ChRIS_store
./deploy.sh down

移除Docker Swarm（可选）

bash
docker swarm leave --force

开发环境设置

虚拟环境配置（可选）

安装virtualenv：

bash
pip install virtualenv virtualenvwrapper

创建虚拟环境目录：

bash
mkdir ~/Python_Envs

配置环境变量（添加到.bashrc）：

bash
export WORKON_HOME=~/Python_Envs
source /usr/local/bin/virtualenvwrapper.sh

创建并激活虚拟环境：

bash
source ~/.bashrc
mkvirtualenv --python=python3 chris_store_env
workon chris_store_env  # 激活环境
deactivate  # 退出环境

安装开发工具

bash
cd ChRIS_store
workon chris_store_env
pip install httpie python-swiftclient django-storage-swift
# 可选择性安装requirements目录下的依赖

启动开发环境

bash
git clone https://github.com/FNNDSC/ChRIS_store.git
cd ChRIS_store
./make.sh up

测试与代码覆盖率

运行测试

获取容器ID：

bash
chris_store=$(docker ps -f ancestor=fnndsc/chris_store:dev -f name=chris_store_dev -q)

运行单元测试：

bash
docker exec -it $chris_store python manage.py test --exclude-tag integration

运行集成测试：

bash
docker exec -it $chris_store python manage.py test --tag integration

运行所有测试：

bash
docker exec -it $chris_store python manage.py test

代码覆盖率检查

bash
# 确保store_backend目录可写
docker exec -it $chris_store coverage run --source=plugins,users manage.py test
docker exec -it $chris_store coverage report

REST API使用示例

获取API根目录

bash
http http://localhost:8010/api/v1/

注册新插件

1. 生成插件描述JSON：

bash
docker run --rm -v /tmp/json:/json fnndsc/pl-simplefsapp simplefsapp --savejson /json

2. 上传插件：

bash
http -a cubeadmin:cubeadmin1234 -f POST http://localhost:8010/api/v1/plugins/ dock_image=fnndsc/pl-simplefsapp descriptor_file@/tmp/json/SimpleFSApp.json public_repo=https://github.com/FNNDSC/pl-simplefsapp name=pl-simplefsapp

创建用户账户（无需认证）

bash
http POST http://localhost:8010/api/v1/users/ Content-Type:application/vnd.collection+json Accept:application/vnd.collection+json template:='{"data":[{"name":"email","value":"developer@babymri.org"}, {"name":"password","value":"newstoreuser1234"}, {"name":"username","value":"newstoreuser"}]}'

Swift客户端使用

列出store_users桶中的文件：

bash
swift -A http://127.0.0.1:8080/auth/v1.0 -U chris:chris1234 -K testing list store_users

停止开发环境

bash
./make.sh down

API文档

完整API文档可在https://fnndsc.github.io/ChRIS_store%E6%9F%A5%E7%9C%8B%E3%80%82

构建文档

安装依赖：

bash
pip install Sphinx sphinxcontrib-httpdomain

构建HTML文档：

bash
cd docs/
make html

更多信息

如需贡献或加入开发，请访问加入我们。