用户可通过该项目参与开源鸿蒙社区开发创新奖励计划,完成Fuzz用例编写、编译测试及代码提交。核心功能包括Fuzz测试框架初始化、用例编写、本地与线上编译测试,支持查看覆盖率报告及提交代码到主干。【此简介由AI生成】
| Files | Last commit | Last update |
|---|---|---|
| 9 months ago | ||
| 11 months ago | ||
| 11 months ago | ||
| 1 year ago | ||
| 11 months ago | ||
| 11 months ago |
开源鸿蒙社区开发创新奖励计划参赛指南
参赛者你好!首先鸿蒙社区欢迎你参加此次的开发创新奖励计划!如果你是第一次参赛,那么本指南将带领你完整的走过这次的参赛流程。让我们从赛前准备开始吧!
1、赛前准备
1.1准备GitCode账号
在参赛前,我们首先需要准备一个GitCode账号,请开发者自行前往GitCode官网进行注册和登录。
1.2 签署DCO协议
要成为鸿蒙社区的贡献者,我们需要签署DCO协议(Developer Certificate of Origin 开发者原创声明)。签署及查询签署状态流程如下:
1.2.1签署协议:
打开签署DCO协议网址,进入签署页面,在页面下方输入姓名、邮箱以及对应验证码等信息后,点击“我同意签署”即可完成签署。请务必牢记DCO协议所绑定的邮箱!

1.2.2 查询签署状态:
打开签署DCO协议网址,点击进入查询签署状态页面,在输入框中输入要查询的邮箱后点击查询按钮即可得到查询结果。

1.3 了解贡献规则
我们还需要了解C语言编程规范、C++语言编程规范以及C&C++安全编程指南等代码贡献规则,通过这些了解,我们可以提前规避一些因代码规范问题导致的冒烟测试失败、门禁测试失败等问题。
在做完上述准备后,我们便可以开始准备参赛了!
2、预约参赛
2.1 登录GitCode账号
首先我们需要在青软平台首页右上角点击登录按钮,登录在“赛前准备”中准备的GitCode账号,具体操作可参考下图。

2.2 预约参赛
在登录之后,点击页面上方导航栏中的“奖励计划”选项,进入对应月份的赛事详情页,点击“预约参赛”按钮完成预约。完成预约后,参赛者需留意开赛时间等待开赛。请务必在开赛时间内参加比赛!

3、编译测试流程
3.1 进入比赛环境
在开赛后,青软平台赛事详情页中的“参赛”按钮会被点亮,点击该按钮即可进入比赛环境。
3.2 编写Fuzz用例
在编写Fuzz用例及后面的步骤中,我们以qos_manager部件为例子来展示流程。
3.2.1 初始化框架
在比赛环境中打开OpenHarmony项目下的任意文件,单击鼠标右键,依次进入“HarmonyPilot——Fuzz Test——Init Fuzz Test”,单击“Init Fuzz Test”选项创建FuzzDriver实例。在页面上方弹出的选项框中选择要创建实例的部件,这里我们选中qos_manager部件,“是否打开部件目录”选择“是”,而后在输入框中填写fuzzer名称。请注意,这里我们为fuzzer文件夹命名时,一般以类名或接口名命名,且必须以“_fuzzer”结尾!这里我们以“template_fuzzer”为例命名。

3.2.2 编写测试用例
初始化框架成功后,参赛选手即可在对应的fuzzer文件夹下书写测试用例代码。此处仅展示示例代码。

3.2.3 检查bundle.json文件
在完成框架初始化后,bundle.json文件的最下方会新增一行代码,这行代码指向我们新创建的fuzzer文件夹,以此来使我们编写的用例可以单独编译。

3.3 本地编译
点击打开qos_manager部件下的bundle.json文件,在文件编辑页面单击鼠标右键,依次进入“HarmonyPilot——Fuzz Test——Start Local Compile”,单击“Start Local Compile”选项,输入框下方弹出编译选项。编译选项和我们在3.2.3中检查的bundle.json文件下方代码行一一对应,点击选择指向我们新创建的fuzzer文件夹的选项(一般为最后一项)即可触发本地编译。本地编译需要约几分钟完成,请耐心等待。下方终端窗口出现“build successful”字样即代表本地编译成功!

3.4 线上编译及测试
点击打开qos_manager部件下的bundle.json文件,在文件编辑页面单击鼠标右键,依次进入“HarmonyPilot——Fuzz Test——Start Fuzz Test”,单击“Start Fuzz Test”选项即可触发线上编译及测试流程。界面右下角弹出触发任务成功提示后,可前往数字化协作平台-Fuzz测试-个人构建页面查看任务进展。该流程需要约十分钟才能完成,请耐心等待结果。

3.5 查看构建日志及覆盖率报告
- 进入数字化协作平台-Fuzz测试-个人构建页面后,筛选页面左上角的任务状态,找到你触发的任务后,点击“日志地址”栏下的网址即可查看构建日志。
- 进入数字化协作平台-Fuzz测试-个人构建页面后,筛选页面左上角的任务状态,找到你触发的任务后,点击“详情”栏下的“查看”按钮即可查看覆盖率报告。

4、 提交代码到主干
4.1 ForK仓库、提交代码
4.1.1 Fork仓库:
进入青软平台首页后点击进入对应月份的赛事详情页,在详情页的部件列表中找到qos_manger部件,点击其对应的链接进入resourceschedule_qos_manager仓库并将其Fork到我们的私人仓库中。

4.1.2 绑定远程仓库:
在webIDE中,右键点击qos_manager文件夹,单击选择“Open in Integrated Terminal(在集成终端中打开)”打开终端输入框。在第一步Fork的私人仓库页面点击“Clone”按钮,复制Https形式的项目地址。重新回到webIDE的终端输入框执行以下命令:
git remote add 仓库名称 项目地址
#仓库名称可自定义,一般命名为origin,项目地址为复制的私人仓库项目地址

4.1.3 提交代码:
在终端输入框中继续执行以下命令将代码提交至本地仓库:
git add .
# 将变更文件添加至暂存区,请勿忽略后面的“.”
git commit -m "提交说明 Signed-off-by: user.name <user.email>"
# 将变更文件提交至本地仓库
# 例如本次提交说明可记为“添加template_fuzzer” ,用户名为“Tom”,签署DCO协议使用邮箱为“example@123.com”
# 则输入命令应为
git commit -m "添加template_fuzzer Signed-off-by: Tom <example@123.com>"
注意:在提交commit时必须按照示例添加Signde-off-by信息,缺失此信息将导致门禁DCO检查不通过,需要重走流程,请参赛者务必重视!

接下来我们需要将代码提交到我们的远程仓库,在这一步中,我们需要到GitCode账号的个人设置中生成令牌来验证身份。打开GitCode官网并登录,将鼠标悬浮至右上角账号头像处,在弹出的选项框中选中个人设置。在个人设置部分填入相关信息并生成个人令牌。建议将生成的令牌新建记事本保存,以方便后续使用。生成流程如下:

在拥有个人令牌后,在webIDE的终端输入框中继续执行以下命令将代码提交至远程仓库。下述命令执行完毕后,页面将弹出账号密码验证输入框,输入我们的GitCode账号和令牌,稍许等待后,终端窗口出现成功提示,即代表代码已经推送至我们的私人远程仓库中。
git checkout -b master
# 创建master分支
git push origin master
# 将本地变更推送至origin远程仓库的master分支

4.2 创建PR及ISSUE,触发门禁
4.2.1 创建PR
进入GitCode网站个人项目Fork的resourceschedule_qos_manager仓库,点击页面上方的“Pull Request”进入PR页面,单击页面中的“新建Pull Request”按钮来新建PR。单击“下一步”后,在新建PR详情页输入PR名称及描述后点击“创建”按钮完成PR创建。上述流程可参考下图:



4.2.2 创建ISSUE
进入GitCode网站OpenHarmony项目下的resourceschedule_qos_manager仓库,点击页面上方的“Issue”进入Issue页面,单击“新建Issue”按钮后选择“空白issue”模板。在新建Issue详情页输入Issue标题和对应内容后点击“创建”按钮完成Issue创建。

4.2.3 关联PR和ISSUE,触发门禁
-
在完成Issue和PR的创建后,进入PR的详情页面,在页面右侧找到“关联Issue”一栏,点击栏中的小齿轮按钮,在弹出的弹窗中选中第2步所创建的Issue,完成关联。

-
完成关联后,在PR页面下方输入“start build”进行评论,即可触发门禁。评论后稍等片刻,机器人账户openharmony_ci便会新增“触发门禁成功”评论。门禁程序约1小时左右才能运行完成,请耐心等待,具体进度可在数字化协作平台门禁页面查看。门禁通过后,由仓库Committer审核通过,PR即完成合并,代码合入主干。对应流程可参考下图:

Introduction
用户可通过该项目参与开源鸿蒙社区开发创新奖励计划,完成Fuzz用例编写、编译测试及代码提交。核心功能包括Fuzz测试框架初始化、用例编写、本地与线上编译测试,支持查看覆盖率报告及提交代码到主干。【此简介由AI生成】
Customize your domain