NASA PDS DOI 服务

本工具为PDS操作员提供创建DOI的服务。

先决条件

• Python 3
• OSTI服务器的登录账户

用户文档

https://nasa-pds.github.io/pds-doi-service/ 

开发者

获取代码并在分支上工作

git clone ...
git checkout -b "#<issue number>"

安装虚拟环境

pip install virtualenv
python -m venv venv
source venv/bin/activate

部署依赖项

pip install -r requirements_dev.txt

或

pip intall -e .

启动API服务器（待重构）

pds-doi-start-dev

测试

单元测试

python setup.py test

行为测试

您首先需要在项目基本目录中获取一些参考数据集

curl https://pds.nasa.gov/software/test-data/pds-doi-service/aaDOI_production_submitted_labels.zip > aaDOI_production_submitted_labels.zip
unzip aaDOI_production_submitted_labels.zip

然后您可以运行行为测试

behave

您也可以运行它们以获得更友好的报告

behave -f allure_behave.formatter:AllureFormatter -o ./allure ./features 
allure service allure

报告给TestRail

测试报告可以推送到TestRail：https://cae-testrail.jpl.nasa.gov/testrail/

项目：行星数据系统（PDS）测试套件：pds-doi-service

设置环境

export TESTRAIL_USER=<your email in testrail>
export TESTRAIL_KEY=<your API key in tesrail>

运行测试

behave

在https://cae-testrail.jpl.nasa.gov/testrail/index.php?/projects/overview/168中查看结果

文档管理

设计

在此存储库中查看

https://github.com/NASA-PDS/pds-doi-service/tree/master/docs

用户文档

由sphinx管理

brew install sphinx-doc
pip install -r requirements_dev.txt
cd docs
sphinx-build -b html source build -a 

构建与发布

构建和发布过程由GitHub Actions管理。