飞不高 发表于 2025-1-7 00:17:39

鸿蒙5.0开发【Instrument Test】测试框架

创建Instrument Test测试用例

创建默认测试用例


[*] 在工程目次下打开待测试模块(支持HAP、HAR、HSP模块)下的ets文件,将光标置于代码中恣意位置,单击右键 > Show Context Actions > Create Instrument Test或快捷键Alt+enter > Create Instrument Test创建测试类。
https://i-blog.csdnimg.cn/direct/1ae3e7ed0a56475c80733410edfd1b42.png
[*] 在弹出的Create Instrument Test窗口,输入或选择如下参数。

[*]Testing library:测试类型,默认为DECC-ArkTSUnit,JS语言默认为DECC-JSUnit。
[*]ArkTS name:创建的测试套件名称。测试套件为包含了测试用例的文件。测试套件名称要求在工程目次范围内具有唯一性,且不能利用逗号、横线、空格以及\ / : * ? “”< > | ()&等特殊字符。
[*]Destination package:测试套件存放的位置,建议存放在待测试模块的test目次下。
https://i-blog.csdnimg.cn/direct/eb2f20235a0341029681a20ccbb3fe64.png

[*] DevEco Studio在ohosTest/ets/test目次下主动生成对应的测试类。在测试类中,DevEco Studio会生成对应方法的用例模板,详细测试代码必要开发者根据业务逻辑举行开发。
说明

[*]您也可以手动在ohosTest > ets > test文件夹下创建测试用例,手动创建后,必要在List.test.ets文件中添加创建的用例类。手动创建的工程或汗青工程,ohosTest > ets > test文件夹下所有文件的文件名必须以.test.ets结尾,否则将在运行时弹窗提示“Error: Test files must end with ‘.test.ets’.”请点击Fix按钮,DevEco Studio将主动对ohosTest > ets > test目次下的文件名举行修改。
[*]测试用例名称应保持唯一性,并且不能利用逗号、横线、空格以及\ / : * ? “”< > | ()&等特殊字符。
[*]初次在HarmonyOS设备上运行UI测试框架必要利用命令“hdc -n shell param set persist.ace.testmode.enabled 1”使能UiTest测试本领。

自定义Ability和Resources

从5.0.3.403版本开始,新创建的工程/模块的ohosTest目次下默认不创建testability、testrunner和resources目次,汗青工程仍保留这些目次,如果新工程必要利用ability或resources本领,必要开发者自行创建。
说明
如果必要利用ability本领,必要同时创建testrunner目次及OpenHarmonyTestRunner.ets文件。
https://i-blog.csdnimg.cn/direct/1b47d0be813b4094bdb4e14151565848.png

[*] 创建以下目次或文件,文件内容示例可在[运行Instrument Test测试用例]后,在对应模块的build/default/intermediates/src/ohosTest下查看。

[*]testability目次 > TestAbility.ets文件
[*]testability目次 > pages目次 > Index.ets文件
[*]testrunner目次 > OpenHarmonyTestRunner.ets文件
[*]resources目次 > base目次 > element目次 > color.json文件
[*]resources目次 > base目次 > element目次 > string.json文件
[*]resources目次 > base目次 > media目次 > icon.png文件
[*]resources目次 > base目次 > profile目次 > test_pages.json文件

[*] 在module.json5文件中补充ability配置字段mainElement、pages、abilities。
{
"module": {
    "name": "entry_test",
    "type": "feature",
    "description": "$string:module_test_desc",
    "mainElement": "TestAbility",                                 // 对应下方abilities中的ability name。
    "deviceTypes": [
      "phone",
      "tablet",
      "2in1"
    ],
    "deliveryWithInstall": true,
    "installationFree": false,
    "pages": "$profile:test_pages",                                 // 对应resources目录 > base目录 > profile目录 > test_pages.json文件。
    "abilities": [                                                // 添加的ability的配置信息。
      {
      "name": "TestAbility",
      "srcEntry": "./ets/testability/TestAbility.ets",
      "description": "$string:TestAbility_desc",
      "icon": "$media:icon",
      "label": "$string:TestAbility_label",
      "exported": true,
      "startWindowIcon": "$media:icon",
      "startWindowBackground": "$color:start_window_background"
      }
    ]
}
}
运行Instrument Test测试用例

运行模式

利用DevEco Studio运行测试用例前,必要将设备与电脑举行毗连,将工程编译成带署名信息的HAP,再安装到真机设备或模拟器上运行。
可以采用运行工程目次(test)、测试文件(如Ability.test.ets)、测试套件(describe)、测试方法(it)的方式来运行测试用例:


[*] 在工程目次中,单击右键 > Run’测试文件名称’ ,执行测试。
https://i-blog.csdnimg.cn/direct/a7e572d98c064c578950887ed1909753.png
[*] 打开测试文件,单击测试套件左侧按钮。
https://i-blog.csdnimg.cn/direct/5e68f9bfb9d94f499320ecc2e8c5a23d.png
[*] 如果要根据自定义的配置执行Instrument Test,在[创建测试用例运行任务]后,通过如下方式的此中之一,执行Instrument Test:

[*] 在工具栏主菜单单击Run > Run’测试名称’ 。
[*] 在DevEco Studio的右上角,选择测试任务,然后单击右侧的按钮,执行Instrument Test。
https://i-blog.csdnimg.cn/direct/01479de216ca4df78da851c336fa53c0.png

执行完测试任务后,查看测试结果。
https://i-blog.csdnimg.cn/direct/c724b347535f4aa3a9b7eb8b27151394.png
调试模式

调试模式相比运行模式增长了断点管理功能。在断点掷中时,可以选择单步执行、步入步出、进入下个断点等方式举行调试,别的可以利用线程堆栈可视化、变量和表达式可视化功能,快速定位问题。
以文件级别为例,在添加断点之后,在工程目次中,选中文件,单击右键 > Debug’测试文件名称’ ,以调试模式执行测试任务。
https://i-blog.csdnimg.cn/direct/4c29bd2a3b3d4fa38a58b9fd95134b74.png
在断点掷中时,下方将出现Debug窗口。开发者可在该窗口中举行断点管理与基础调试本领的可视化操作,在断点掷中时可查看当火线程的变量和堆栈信息。
https://i-blog.csdnimg.cn/direct/f434a6cdbed64208868532f0ba0965df.png
断点掷中时,在代码编辑器窗口单击右键,在弹出的菜单中将出现调试模式特有功能,如盘算表达式、添加变量监视等。
https://i-blog.csdnimg.cn/direct/f0b9956e37c942f9beaff8e1d43c5aec.png
在跳出所有断点后,测试结束,与运行模式类似,在测试窗口查看测试结果。
https://i-blog.csdnimg.cn/direct/7d5f20bd945d4058982bce2f4f01c63b.png
说明
涉及调试C++代码时,请打开Run/Debug Configurations窗口,点击Debugger页签,设置Debug type。
覆盖率统计模式

说明


[*]源码文件的定名不可为“test.ets”、“xx.test.ets”、“test.ts”和“xx.test.ts”,该定名的文件不会生成报告。
[*]Instrument Test的覆盖率统计模式暂不支持元服务。
在Instrument Test运行的基础上支持代码覆盖率统计,当前仅支持ArkTS工程。
可以采用运行工程目次(test)、测试文件(如Ability.test.ets)、测试套件(describe)、测试方法(it)的方式来启动代码覆盖率的统计。
以文件级别为例,有两种方式启动测试:


[*] 方式一:在工程目次中,选中文件,单击右键 > Run ‘测试文件名称’ with Coverage,执行测试。
https://i-blog.csdnimg.cn/direct/e51fc213155b4d8ebde9f19b65c261f2.png
[*] 方式二:在DevEco Studio的右上角,选择测试任务,然后单击右侧的按钮,执行测试。
https://i-blog.csdnimg.cn/direct/36946e1afeec4ae98145311154a3ea43.png
启动测试后,举行编译构建,底部将出现Cover窗口,构建结束后主动拉起Cover窗口,测试任务结束后,窗口中会打印测试报告的路径。
https://i-blog.csdnimg.cn/direct/4dfd71890b854500bfada9d1d038b990.png
在本地找到报告的位置并在浏览器中打开,查看代码覆盖率详情。
https://i-blog.csdnimg.cn/direct/676feb9fc0c44aa186e5c4758ca10cbb.png
在Cover窗口中,单击rerun按钮可以按照之前的设置,重新执行覆盖率用例。
https://i-blog.csdnimg.cn/direct/086c325c27e04c758de4e813948e2cc8.png
(可选)自定义测试用例运行任务

默认情况下,测试用例可直接运行,如果必要自定义测试用例运行任务,可通过如下方法举行设置。

[*] 在工具栏主菜单单击Run > Edit Configurations进入Run/Debug Configurations界面。
[*] 在Run/Debug Configurations界面,单击+按钮,在弹出的下拉菜单中,单击Instrument Test。
https://i-blog.csdnimg.cn/direct/5fe1ffc6e1544325a0cf21f2bec3c672.png
[*] 根据实际情况,配置Instrument Test的运行参数。然后单击OK,完成配置。
如果模块依靠共享包,请提前设置HAP安装方式:单击Run > Edit Configurations,设置指定模块的HAP安装方式,勾选“Keep Application Data”,则表现采用覆盖安装方式,保留应用/服务缓存数据。
https://i-blog.csdnimg.cn/direct/b5ee6244430344abb887ce5d10f939f7.png
利用过滤条件筛选待运行的测试用例


[*] 在用例编写时,通过配置it的第二个入参,为每个用例添加过滤参数。此参数用于为测试用例添加标注,不添加则参数默认为0表现未被标注。
https://i-blog.csdnimg.cn/direct/18c958a53d7d41f585fe6fd6701e5d1f.png
[*] 打开Run/Debug Configurations窗口,点击Test Args,打开Test Args界面,添加命令行参数。
https://i-blog.csdnimg.cn/direct/13a99bb9dc704dac95efb1d52fe5f26b.png
例如将测试参数配置为level=1, size=medium
https://i-blog.csdnimg.cn/direct/afb70785e26749acbd4730e576e3f3b2.png
   Key含义说明Value取值范围level用例级别“0”,“1”,“2”,“3”,“4”, 例如:-s level 1size用例粒度“small”,“medium”,“large”, 例如:-s size smalltestType用例测试类型“function”,“performance”,“power”,“reliability”,“security”,“global”,“compatibility”,“user”,“standard”,“safety”,“resilience”, 例如:-s testType function
[*] 完成以上配置后,在运行此项配置对应的测试任务时,只运行过滤后的测试用例。
https://i-blog.csdnimg.cn/direct/c44b1b3b4ab14ad29b314b3291d5f000.png
调试C++代码

当开发者编写Instrument Test测试用例,涉及调试C++代码时,请打开Run/Debug Configurations窗口,点击Debugger页签,设置Debug type。
https://i-blog.csdnimg.cn/direct/8d3dfe977c3b44faad5062a0053d993e.png
调试类型Debug type默认为Detect Automatically,关于各调试类型的说明如下表所示:
调试类型调试代码Detect Automatically主动检测。根据工程模块及其依靠的模块涉及的编程语言,主动启动对应的调试器。如果检测到是Native模块,出现两个调试窗口(PandaDebugger、Native);如果不是Native模块,只出现PandaDebugger调试窗口。ArkTS/JS只调试ArkTS/JS,只出现PandaDebugger调试窗口。Native单独调试C++,只出现Native调试窗口。Dual(ArkTS/JS + Native)支持ArkTS/JS和C++混淆调试,出现两个调试窗口(PandaDebugger、Native)。 说明
调试C++代码时,当前模块及所有依靠的HSP模块的要保持同等,若不同等,可能无法进入C++代码的断点处。
ASan检测

Instrument Test针对C/C++方法提供ASan检测本领

[*] 在运行/调试配置窗口,选择对应的Instrument Test,点击Diagnostics页签,勾选Address Sanitizer选项,勾选后,测试包和源码包均开启ASan本领。
https://i-blog.csdnimg.cn/direct/c526abffb01b41dda9b4caaea7aeb28c.png
[*] 如果有引用本地library,需在library模块的build-profile.json5文件中,配置arguments字段值为“-DOHOS_ENABLE_ASAN=ON”,表现以ASan模式编译so文件。
https://i-blog.csdnimg.cn/direct/ae594a5b3f9345369415ccda9e717cc0.png
[*] 运行测试用例
[*] 当程序出现内存错误时,弹出ASan log信息,点击信息中的链接即可跳转至引起内存错误的代码处。
https://i-blog.csdnimg.cn/direct/92d2cdf661a9443782ed510c047bd73a.png
利用命令行执行测试Instrument Test

说明
从hvigor-ohos-plugin 4.3.0版本开始支持。
通过命令行方式执行Instrument Test,在工程根目次下执行命令:
hvigorw onDeviceTest -p module={moduleName} -p coverage={true | false} -p scope={suiteName}#{methodName}


[*] module:执行测试的模块,缺省默认是执行所有模块的用例。
[*] coverage:是否生成覆盖率报告,缺省默认是true。
覆盖率测试报告路径:/.test/default/outputs/ohosTest/reports/index.html
[*] scope:格式为{suiteName}#{methodName}或{suiteName},分别表现测试用例级别或测试套件级别的测试,缺省默认是执行当前模块的所有用例。
说明
多个module和scope之间用逗号分割。
测试结果文件:/.test/default/intermediates/ohosTest/coverage_data/test_result.txt

免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!更多信息从访问主页:qidao123.com:ToB企服之家,中国第一个企服评测及商务社交产业平台。
页: [1]
查看完整版本: 鸿蒙5.0开发【Instrument Test】测试框架