HarmonyOS|[鸿蒙开发] - 如何获取HarmonyOS应用的代码覆盖率信息

id="article_content" class="article_content clearfix"> id="content_views" class="markdown_views prism-atom-one-light">

1. 背景

1.1 背景描述

目前在准备鸿蒙应用的开发环境，由于项目要求，需要在提交CodeReview的时候，展示单元测试的覆盖率。但是目前并没有针对于鸿蒙应用的打包流程，如果要等一切完善之后再开发，那时间可太长了，所以需要调研一种可行的短期的方案。

最终的目标是通过自动化的方式将代码覆盖率的数据以文本的方式（coverage： Line Coverage: 100%, Branch Coverage: 100%）添加到git commit的信息中，如下图所示：

在这里插入图片描述

1.2 实施计划

先确定下大概的实施计划：

调研如何构建HarmonyOS应用的单元测试和UI测试；
获取测试覆盖率文件；
如何通过命令构建HarmonyOS应用和执行HarmonyOS应用的单元测试和UI测试；
通过脚本修改git commit信息；

2.HarmonyOS应用的单元测试和UI测试

2.1 测试概述

HarmonyOS中的自动化测试框架是arkxtest，支持JS/TS语言的单元测试框架（JsUnit）及UI测试框架（UiTest）。

JsUnit
- 提供单元测试用例执行能力；
- 提供用例编写基础接口，生成对应报告；
- 用于测试系统或应用接口；
UiTest
- 提供了API用于查找和操作界面的控件；
- 支持用户开发基于界面操作的自动化测试脚本；

单元测试框架是测试框架的基础，提供了最基本的用例识别、调度、执行及结果汇总的能力。 UI测试框架主要对外提供了UiTest API供开发人员在对应测试场景。

2.2 新建&运行测试脚本

DevEco Studio中新建应用开发工程，其中ohosTest和test目录均为测试脚本所在的目录，只是有所不同：

在这里插入图片描述

Instrument Test: 测试用例存放在ohosTest测试目录下，需要运行在设备或模拟器上，支持单元测试和UI测试；
Local Test: 测试用例存放在test测试目录下，不需要运行在设备或者模拟器上，支持单元测试；

2.2.1 Local Test

a.在工程目录下打开待测试模块的ets文件，将光标置于代码的任意位置，右键 -> Show Context Actions -> Create Local Test创建测试类:

在这里插入图片描述

b.在弹出的Create Local Test窗口，配置如下参数：

Testing library: 测试类型，默认为DECC-ArkTSUnit
ArkTS name: 测试套件名称
Destination package: 存放的位置

c.DevEco Studio会在test目录下自动生成对应的测试类。在测试类中，DevEco Studio会生成对应方法的用例模板

d.可以直接在test文件夹上右键执行单元测试：

从图中可以看出，有三个选择：

直接运行测试用例
Debug测试用例
运行测试用例，并生成代码覆盖率文件

在这里插入图片描述

DevEco提供了4种运行模式：

工程目录（test），在test文件夹上右键；
测试文件（如LocalUnit.test.ets），在测试文件上右键；
测试套件（describe），测试文件内部
测试方法（it），测试文件内部

这里是以工程目录test为例。

e.查看生成的覆盖率文件:

当运行测试用例，并生成代码覆盖率文件之后，会在控制台输出覆盖率文件的路径：

在这里插入图片描述

我们打开该文件，可以看到包含了覆盖率信息，并且可以点击文件，查看具体文件的覆盖率信息：

在这里插入图片描述

需要注意的是，单元测试无法针对于UI描述进行测试，需要使用UI测试，下面是鸿蒙官方在工单中的回复：

在这里插入图片描述

2.2.2 Instrument Test

Instrument Test的创建和执行过程和Local Test类似。

a.打开ets文件，将光标置于任意位置，右键->Show Context Actions -> Create Instrument Test创建测试类：

在这里插入图片描述

b.和Local Test一样，填写测试套件的名称；

c.DevEco Studio会在ohosTest目录下自动生成对应的测试类，并且也会生成对应方法的用例模板；

d.运行Instrument Test测试用例运行Instrument Test测试用例需要先将设备和电脑进行连接，将工程编译成带签名信息的HAP，再安装到真机设备或模拟器上运行。

运行Instrument Test测试用例的方法和模式和Local Test相同，不过针对的是ohosTest文件夹。

c.查看代码覆盖率 Instrument Test也会生成代码覆盖率文件，可以查看所有文件的覆盖率信息，和Local Test一样。

需要注意的是： Instrument Test针对于.ets文件的branch覆盖率，是基于.ets文件编译生成的.js文件进行统计的。

// index.ets:
@Entry  
@Component  
struct Index {  
  
@State name: string = "aa";  
  
build() {  
}  
  
}

// index.js
"use strict";  
class Index extends ViewPU {  
constructor(parent, params, __localStorage, elmtId = -1, paramsLambda = undefined, extraInfo) {  
super(parent, __localStorage, elmtId, extraInfo);  
if (typeof paramsLambda === "function") {  
this.paramsGenerator_ = paramsLambda;  
}  
this.__name = new ObservedPropertySimplePU("aa", this, "name");  
this.setInitiallyProvidedValue(params);  
}  
setInitiallyProvidedValue(params) {  
if (params.name !== undefined) {  
this.name = params.name;  
}  
}  
updateStateVars(params) {  
}  
purgeVariableDependenciesOnElmtId(rmElmtId) {  
this.__name.purgeDependencyOnElmtId(rmElmtId);  
}  
aboutToBeDeleted() {  
this.__name.aboutToBeDeleted();  
SubscriberManager.Get().delete(this.id__());  
this.aboutToBeDeletedInternal();  
}  
get name() {  
return this.__name.get();  
}  
set name(newValue) {  
this.__name.set(newValue);  
}  
initialRender() {  
}  
rerender() {  
this.updateDirtyElements();  
}  
static getEntryName() {  
return "Index";  
}  
}  
registerNamedRoute(() => new Index(undefined, {}), "", { bundleName: "com.example.studytest", moduleName: "entry", pagePath: "pages/Index" });  
//# sourceMappingURL=Index.js.map

 class="hljs-button signin active" data-title="登录复制" data-report-click="{"spm":"1001.2101.3001.4334"}">