fake2db软件适配GaussDB开源验证任务
1 背景介绍
开源for Huawei(参考:https://developer.huaweicloud.cn/programs/opensource/contributing/) 通过和公司、高校、社区的开发者合作,完成鲲鹏、昇腾、欧拉、鸿蒙、高斯、云服务等与开源软件的适配开发,帮助繁荣Huawei的基础生态,同时让开源软件能够更加简单、高效的运行于华为云上。
开始之前,开发者可以下载 开源for Huawei Wiki(参考:https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview) 了解详细的开发步骤,技术准备,以及开发过程需要的各种资源。
2 需求分析
2.1 项目影响力
fake2db 是一个开源工具,用于生成测试数据以用于测试和开发。
项目数据:Fork 119, Star 2.3K, Contributor 17
star历史(https://star-history.com/):
2.2 任务目的和范围
本任务的主要目的是让 fake2db 社区支持GaussDB数据库,帮助拓展GaussDB的影响力,也方便 fake2db 的用户能够将数据库由MySQL换成GaussDB。同时,该任务可以为一些项目迁移打下基础,方便用户在使用 fake2db 的时候,可以选择GaussDB作为数据存储DB。
适配任务清单
生态 |
生态细类 |
是否需要验证 |
验证逻辑说明 |
是否需要适配 |
适配场景说明 |
昇腾生态 |
指令 |
否 |
使用昇腾处理器运行应用。 |
否 |
使用昇腾指令实现适配逻辑。 |
CANN |
否 |
应用功能依赖于CANN运行。 |
否 |
使用CANN实现适配逻辑。 |
|
MindSpore |
否 |
应用功能依赖于MindSpore运行。 |
否 |
使用MindSpore实现适配逻辑。 |
|
鲲鹏生态 |
指令 |
是 |
使用鲲鹏处理器运行应用。 |
否 |
使用鲲鹏指令实现适配逻辑。 |
Euler |
是 |
使用Euler系统运行应用。 |
否 |
使用Euler系统调用实现适配逻辑。 |
|
数据库生态 |
GaussDB |
是 |
使用GaussDB功能。 |
是 |
使用GaussDB的驱动和SQL实现适配逻辑。 |
|
GaussDB(DWS) |
否 |
使用GaussDB(DWS)功能。 |
否 |
使用GaussDB(DWS)的驱动和SQL实现适配逻辑。 |
存储生态 |
OBS |
否 |
使用OBS功能。 |
否 |
基于OBS API访问实现适配逻辑。 |
鸿蒙生态 |
HarmonyOS |
否 |
使用HarmonyOS系统运行应用。 |
否 |
使用HarmonyOS系统调用实现适配逻辑。 |
3 工作量评估和任务分解
3.1 工作量评估
任务 |
人/天 |
完成GaussDB数据库适配功能开发 |
2 |
完成DEMO设计和功能验证 |
2 |
基于CCE容器完成环境搭建和DEMO验证 |
2 |
输出开发资料和博客 |
1 |
代码推送上游社区和发布版本 |
2 |
总计 |
9人天 |
3.2 完成GaussDB数据库适配功能开发
- 在GitCode完成项目Fork,可以使用兼容GaussDB的数据库驱动 psycopg2,但可能需要对其进行扩展或定制以支持GaussDB特有的功能。
- 基于 GaussDB 数据库的SQL特性,适配对于自定制数据库/表的支持,可以参考(https://github.com/emirozer/fake2db/blob/master/fake2db/custom.py)完成。
3.3 完成GaussDB演示DEMO设计
参考下面的用例图:
DEMO在resource-server-python(使用了Django,开发者需要在里面使用ORM库实现对添加的测试数据进行访问)中完成, https://github.com/emirozer/fake2db/tree/master 的用法例子开发任务,通过RESTful API暴露数据库访问能力供前端使用。
主要需要完成的任务是:
- 完成 fake2db 对 GaussDB 数据库驱动的适配
- 通过Django提供RESTful API返回新建的测试数据
DEMO的简单部署图如下:
3.4 DEMO开发、部署和验证
根据DEMO设计,完成演示功能开发和部署。要求使用CCE容器(Euler镜像)进行部署。
3.5 在华为云开发者论坛输出博客
访问华为云开发者论坛(参考:https://bbs.huaweicloud.cn/blogs)发表博客,介绍完成这些任务的过程和心得。
内容包括不限于如下内容:
- 开源for Huawei的背景
- 开源软件的功能介绍
- 开发适配过程及碰到和解决的问题
- DEMO设计、开发、部署过程
- 代码推送开源社区及互动过程
博客打上如下标签:
- 开源(必选)
- 开发者(必选)
- GaussDB数据库(可选)
- 云数据库GaussDB(可选)
- 鲲鹏(可选)
- 昇腾(可选)
- 鸿蒙(可选)
- 对象存储OBS(可选)
3.6 代码推送上游社区
将代码合并到fake2db主干代码;更新fake2db相关资料,包括版本说明、开发指南等。
4 验收材料
验收细则 |
评分说明 |
是否为验收必选项 |
结果(通过/不通过) |
开发者举证 |
功能开发:完成与华为三大根技术生态(鲲鹏云、昇腾云、鸿蒙)适配的功能开发 |
完成GaussDB数据库适配功能开发。举证提供PR链接。 |
是 |
||
代码质量:适配华为三大根技术生态的代码质量经过工具检测达标 |
推送给开源社区的代码符合开源社区关于代码风格、功能、自动化测试等要求。 |
是 |
||
提供相关文档,比如部署文档、使用文档、配置文档等 |
根据社区要求,完善相关的开发指南和部署指导 |
否 |
||
合入到开源项目主仓:代码推送上游社区 |
代码合并到当前主干分支。举证提供代码仓库链接。 |
是 |
||
Deomo设计&开发:完成功能演示Demo的开发 |
举证提供DEMO仓库地址和DEMO开发提交记录。 |
是 |
||
Demo部署&验证:完成功能演示DEMO基于华为云鲲鹏环境的部署和功能验证 |
提供DEMO部署验证结果的关键截图进行举证。提供DEMO运行环境和资源的规格清单。 |
是 |
||
发布博客:发布博客介绍适配心得。 |
提供博客的地址。 |
是 |
||
制作单机版无高危开源镜像。 |
上架云商店。 |
否 |
||
单机版镜像上架时支持模板部署。 |
否 |
|||
制作集群版无高危开源镜像 |
上架云商店。 |
否 |
||
集群版镜像上架时支持模板部署 |
否 |
5 参考资料
- 开源for Huawei介绍、环境搭建、示例项目、开发和部署指南:https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview
- 点赞
- 收藏
- 关注作者
评论(0)