1# 自动化测试框架使用指导 2 3 4## 概述 5 6自动化测试框架arkxtest，作为工具集的重要组成部分，支持JS/TS语言的单元测试框架(JsUnit)及UI测试框架(UiTest)。<br>JsUnit提供单元测试用例执行能力，提供用例编写基础接口，生成对应报告，用于测试系统或应用接口。<br>UiTest通过简洁易用的API提供查找和操作界面控件能力，支持用户开发基于界面操作的自动化测试脚本。<br>本指南介绍了测试框架的主要功能、实现原理、环境准备，以及测试脚本编写和执行方法。同时，以shell命令方式，对外提供了获取截屏、控件树、录制用户操作、便捷注入UI模拟操作等能力，助力开发者更灵活方便测试和验证。 7 8## 实现原理 9 10测试框架分为单元测试框架和UI测试框架。<br>单元测试框架是测试框架的基础底座，提供了最基本的用例识别、调度、执行及结果汇总的能力。<br>UI测试框架主要对外提供了UiTest API供开发人员在对应测试场景调用，而其脚本的运行基础仍是单元测试框架。 11 12### 单元测试框架 13 14 图1.单元测试框架主要功能 15 16  17 18 图2.脚本基础流程运行图 19 20  21 22### UI测试框架 23 24 图3.UI测试框架主要功能 25 26  27 28## 基于ArkTS编写和执行测试 29 30### 搭建环境 31 32DevEco Studio可参考其官网介绍进行[下载](https://developer.harmonyos.com/cn/develop/deveco-studio#download)，并进行相关的配置动作。 33 34### 新建和编写测试脚本 35 36#### 新建测试脚本 37 38<!--RP2--> 39在DevEco Studio中新建应用开发工程，其中ohos目录即为测试脚本所在的目录。 40 41在工程目录下打开待测试模块下的ets文件，将光标置于代码中任意位置，单击**右键 > Show Context Actions** **> Create Ohos Test**或快捷键**Alt+enter** **> Create Ohos Test**创建测试类，更多指导请参考DevEco Studio中[指导](https://developer.harmonyos.com/cn/docs/documentation/doc-guides-V3/harmonyos_jnit_jsunit-0000001092459608-V3?catalogVersion=V3#section13366184061415)。 42 43<!--RP2End--> 44 45#### 编写单元测试脚本 46 47本章节主要描述单元测试框架支持能力，以及能力的使用方法, 具体请参考[单元测试框架功能特性](https://gitee.com/openharmony/testfwk_arkxtest/blob/master/README_zh.md#%E5%8D%95%E5%85%83%E6%B5%8B%E8%AF%95%E6%A1%86%E6%9E%B6%E5%8A%9F%E8%83%BD%E7%89%B9%E6%80%A7)。 48 49在单元测试框架，测试脚本需要包含如下基本元素: 50 511、依赖导包，以便使用依赖的测试接口。 52 532、测试代码编写，主要编写测试代码的相关逻辑，如接口调用等。 54 553、断言接口调用，设置测试代码中的检查点，如无检查点，则不可认为一个完整的测试脚本。 56 57如下示例代码实现的场景是：启动测试页面，检查设备当前显示的页面是否为预期页面。 58 59```ts 60import { describe, it, expect } from '@ohos/hypium'; 61import { abilityDelegatorRegistry } from '@kit.TestKit'; 62import { UIAbility, Want } from '@kit.AbilityKit'; 63 64const delegator = abilityDelegatorRegistry.getAbilityDelegator() 65const bundleName = abilityDelegatorRegistry.getArguments().bundleName; 66function sleep(time: number) { 67 return new Promise<void>((resolve: Function) => setTimeout(resolve, time)); 68} 69export default function abilityTest() { 70 describe('ActsAbilityTest', () =>{ 71 it('testUiExample',0, async (done: Function) => { 72 console.info("uitest: TestUiExample begin"); 73 //start tested ability 74 const want: Want = { 75 bundleName: bundleName, 76 abilityName: 'EntryAbility' 77 } 78 await delegator.startAbility(want); 79 await sleep(1000); 80 //check top display ability 81 const ability: UIAbility = await delegator.getCurrentTopAbility(); 82 console.info("get top ability"); 83 expect(ability.context.abilityInfo.name).assertEqual('EntryAbility'); 84 done(); 85 }) 86 }) 87} 88``` 89 90#### 编写UI测试脚本 91 92本章节主要介绍UI测试框架支持能力，以及对应能力API的使用方法。<br>UI测试基于单元测试，UI测试脚本在单元测试脚本上增加了对UiTest接口，<!--RP1-->具体请参考[API文档](../reference/apis-test-kit/js-apis-uitest.md)<!--RP1End-->。<br>如下的示例代码是在上面的单元测试脚本基础上增量编写，实现的场景是：在启动的应用页面上进行点击操作，然后检测当前页面变化是否为预期变化。 93 941. 编写Index.ets页面代码， 作为被测示例demo。 95 96 ```ts 97 @Entry 98 @Component 99 struct Index { 100 @State message: string = 'Hello World' 101 102 build() { 103 Row() { 104 Column() { 105 Text(this.message) 106 .fontSize(50) 107 .fontWeight(FontWeight.Bold) 108 Text("Next") 109 .fontSize(50) 110 .margin({top:20}) 111 .fontWeight(FontWeight.Bold) 112 Text("after click") 113 .fontSize(50) 114 .margin({top:20}) 115 .fontWeight(FontWeight.Bold) 116 } 117 .width('100%') 118 } 119 .height('100%') 120 } 121 } 122 ``` 123 1242. 在ohosTest > ets > test文件夹下.test.ets文件中编写具体测试代码。 125 126 ```ts 127 import { describe, it, expect } from '@ohos/hypium'; 128 // 导入测试依赖kit 129 import { abilityDelegatorRegistry, Driver, ON } from '@kit.TestKit'; 130 import { UIAbility, Want } from '@kit.AbilityKit'; 131 132 const delegator: abilityDelegatorRegistry.AbilityDelegator = abilityDelegatorRegistry.getAbilityDelegator() 133 const bundleName = abilityDelegatorRegistry.getArguments().bundleName; 134 function sleep(time: number) { 135 return new Promise<void>((resolve: Function) => setTimeout(resolve, time)); 136 } 137 export default function abilityTest() { 138 describe('ActsAbilityTest', () => { 139 it('testUiExample',0, async (done: Function) => { 140 console.info("uitest: TestUiExample begin"); 141 //start tested ability 142 const want: Want = { 143 bundleName: bundleName, 144 abilityName: 'EntryAbility' 145 } 146 await delegator.startAbility(want); 147 await sleep(1000); 148 //check top display ability 149 const ability: UIAbility = await delegator.getCurrentTopAbility(); 150 console.info("get top ability"); 151 expect(ability.context.abilityInfo.name).assertEqual('EntryAbility'); 152 //ui test code 153 //init driver 154 const driver = Driver.create(); 155 await driver.delayMs(1000); 156 //find button on text 'Next' 157 const button = await driver.findComponent(ON.text('Next')); 158 //click button 159 await button.click(); 160 await driver.delayMs(1000); 161 //check text 162 await driver.assertComponentExist(ON.text('after click')); 163 await driver.pressBack(); 164 done(); 165 }) 166 }) 167 } 168 ``` 169 170### 执行测试脚本 171 172#### 在DevEco Studio执行 173 174脚本执行需要连接硬件设备。通过点击按钮执行，当前支持以下执行方式： 175 1761、测试包级别执行，即执行测试包内的全部用例。 177 1782、测试套级别执行，即执行describe方法中定义的全部测试用例。 179 1803、测试方法级别执行，即执行指定it方法也就是单条测试用例。 181 182 183 184**查看测试结果** 185 186测试执行完毕后可直接在DevEco Studio中查看测试结果，如下图示例所示： 187 188 189 190**查看测试用例覆盖率** 191 192执行完测试用例后可以查看测试用例覆盖率，具体操作请参考[代码测试](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides-V5/ide-code-test-V5)下各章节内的覆盖率统计模式。 193 194#### 在CMD执行 195 196脚本执行需要连接硬件设备，将应用测试包安装到测试设备上，在cmd窗口中执行aa命令，完成对用例测试。 197 198> **说明：** 199> 200> 使用cmd的方式，需要配置好hdc相关的环境变量。 201 202**aa test命令执行配置参数** 203 204| 执行参数全写 | 执行参数缩写 | 执行参数含义 | 执行参数示例 | 205| ------------- | ------------ | -------------------------------------- | ---------------------------------- | 206| --bundleName | -b | 应用Bundle名称 | - b com.test.example | 207| --packageName | -p | 应用模块名，适用于FA模型应用 | - p com.test.example.entry | 208| --moduleName | -m | 应用模块名，适用于STAGE模型应用 | -m entry | 209| NA | -s | 特定参数，以<key, value>键值对方式传入 | - s unittest /ets/testrunner/OpenHarmonyTestRunner | 210 211框架当前支持多种用例执行方式，通过上表中的-s参数后的配置键值对参数传入触发，如下表所示。 212 213| 配置参数名 | 配置参数含义 | 配置参数取值 | 配置参数示例 | 214| ------------ | ----------------------------------------------------------------------------- | ------------------------------------------------------------ | ----------------------------------------- | 215| unittest | 用例执行所使用OpenHarmonyTestRunner对象 | OpenHarmonyTestRunner或用户自定义runner名称 | - s unittest OpenHarmonyTestRunner | 216| class | 指定要执行的测试套或测试用例 | {describeName}#{itName}，{describeName} | -s class attributeTest#testAttributeIt | 217| notClass | 指定不需要执行的测试套或测试用例 | {describeName}#{itName}，{describeName} | -s notClass attributeTest#testAttributeIt | 218| itName | 指定要执行的测试用例 | {itName} | -s itName testAttributeIt | 219| timeout | 测试用例执行的超时时间 | 正整数（单位ms），如不设置默认为 5000 | -s timeout 15000 | 220| breakOnError | 遇错即停模式，当执行用例断言失败或者发生错误时，退出测试执行流程 | true/false(默认值) | -s breakOnError true | 221| random | 测试用例随机顺序执行 | true/false(默认值) | -s random true | 222| testType | 指定要执行用例的用例类型 | function，performance，power，reliability， security，global，compatibility，user，standard，safety，resilience' | -s testType function | 223| level | 指定要执行用例的用例级别 | 0,1,2,3,4 | -s level 0 | 224| size | 指定要执行用例的用例规模 | small，medium，large | -s size small 225| stress | 指定要执行用例的执行次数 | 正整数 | -s stress 1000 | 226 227**在cmd窗口执行test命令** 228 229> **说明：** 230> 231>参数配置和命令均是基于Stage模型。 232 233 234示例代码1：执行所有测试用例。 235 236```shell 237 hdc shell aa test -b xxx -m xxx -s unittest OpenHarmonyTestRunner 238``` 239 240示例代码2：执行指定的describe测试套用例，指定多个需用逗号隔开。 241 242```shell 243 hdc shell aa test -b xxx -m xxx -s unittest OpenHarmonyTestRunner -s class s1,s2 244``` 245 246示例代码3：执行指定测试套中指定的用例，指定多个需用逗号隔开。 247 248```shell 249 hdc shell aa test -b xxx -m xxx -s unittest OpenHarmonyTestRunner -s class testStop#stop_1,testStop1#stop_0 250``` 251 252示例代码4：执行指定除配置以外的所有的用例，设置不执行多个测试套需用逗号隔开。 253 254```shell 255 hdc shell aa test -b xxx -m xxx -s unittest OpenHarmonyTestRunner -s notClass testStop 256``` 257 258示例代码5：执行指定it名称的所有用例，指定多个需用逗号隔开。 259 260```shell 261 hdc shell aa test -b xxx -m xxx -s unittest OpenHarmonyTestRunner -s itName stop_0 262``` 263 264示例代码6：用例执行超时时长配置。 265 266```shell 267 hdc shell aa test -b xxx -m xxx -s unittest OpenHarmonyTestRunner -s timeout 15000 268``` 269 270示例代码7：用例以breakOnError模式执行用例。 271 272```shell 273 hdc shell aa test -b xxx -m xxx -s unittest OpenHarmonyTestRunner -s breakOnError true 274``` 275 276示例代码8：执行测试类型匹配的测试用例。 277 278```shell 279 hdc shell aa test -b xxx -m xxx -s unittest OpenHarmonyTestRunner -s testType function 280``` 281 282示例代码9：执行测试级别匹配的测试用例。 283 284```shell 285 hdc shell aa test -b xxx -m xxx -s unittest OpenHarmonyTestRunner -s level 0 286``` 287 288示例代码10：执行测试规模匹配的测试用例。 289 290```shell 291 hdc shell aa test -b xxx -m xxx -s unittest OpenHarmonyTestRunner -s size small 292``` 293 294示例代码11：执行测试用例指定次数。 295 296```shell 297 hdc shell aa test -b xxx -m xxx -s unittest OpenHarmonyTestRunner -s stress 1000 298``` 299 300**查看测试结果** 301 302- cmd模式执行过程,会打印如下相关日志信息。 303 304 ``` 305 OHOS_REPORT_STATUS: class=testStop 306 OHOS_REPORT_STATUS: current=1 307 OHOS_REPORT_STATUS: id=JS 308 OHOS_REPORT_STATUS: numtests=447 309 OHOS_REPORT_STATUS: stream= 310 OHOS_REPORT_STATUS: test=stop_0 311 OHOS_REPORT_STATUS_CODE: 1 312 313 OHOS_REPORT_STATUS: class=testStop 314 OHOS_REPORT_STATUS: current=1 315 OHOS_REPORT_STATUS: id=JS 316 OHOS_REPORT_STATUS: numtests=447 317 OHOS_REPORT_STATUS: stream= 318 OHOS_REPORT_STATUS: test=stop_0 319 OHOS_REPORT_STATUS_CODE: 0 320 OHOS_REPORT_STATUS: consuming=4 321 ``` 322 323| 日志输出字段 | 日志输出字段含义 | 324| ------- | -------------------------| 325| OHOS_REPORT_SUM | 当前测试套用例总数。 | 326| OHOS_REPORT_STATUS: class | 当前执行用例测试套名称。| 327| OHOS_REPORT_STATUS: id | 用例执行语言,默认JS。 | 328| OHOS_REPORT_STATUS: numtests | 测试包中测试用例总数 。| 329| OHOS_REPORT_STATUS: stream | 当前用例发生错误时，记录错误信息。 | 330| OHOS_REPORT_STATUS: test| 当前用例执行的it name。 | 331| OHOS_REPORT_STATUS_CODE | 当前用例执行结果状态。0表示通过，1表示错误，2表示失败。| 332| OHOS_REPORT_STATUS: consuming | 当前用例执行消耗的时长（ms）。 | 333 334- cmd执行完成后,会打印如下相关日志信息。 335 336 ``` 337 OHOS_REPORT_RESULT: stream=Tests run: 447, Failure: 0, Error: 1, Pass: 201, Ignore: 245 338 OHOS_REPORT_CODE: 0 339 340 OHOS_REPORT_RESULT: breakOnError model, Stopping whole test suite if one specific test case failed or error 341 OHOS_REPORT_STATUS: taskconsuming=16029 342 343 ``` 344 345| 日志输出字段 | 日志输出字段含义 | 346| ------------------| -------------------------| 347| run | 当前测试包用例总数。 | 348| Failure | 当前测试失败用例个数。 | 349| Error | 当前执行用例发生错误用例个数。 | 350| Pass | 当前执行用例通过用例个数 。| 351| Ignore | 当前未执行用例个数。 | 352| taskconsuming| 执行当前测试用例总耗时（ms）。 | 353 354> **说明：** 355> 356> 当处于breakOnError模式，用例发生错误时,注意查看Ignore以及中断说明。 357 358## 基于shell命令测试 359 360在开发过程中，若需要快速进行截屏、 录屏、注入UI模拟操作、获取控件树等操作，可以使用shell命令，更方便完成相应测试。 361 362> **说明：** 363> 364> 使用cmd的方式，需要配置好hdc相关的环境变量。 365 366**命令列表** 367| 命令 | 配置参数 |描述 | 368|---------------|---------------------------------|---------------------------------| 369| help | help| 显示uitest工具能够支持的命令信息。 | 370| screenCap |[-p] | 截屏。非必填。<br>指定存储路径和文件名, 只支持存放在/data/local/tmp/下。<br>默认存储路径：/data/local/tmp，文件名：时间戳 + .png。 | 371| dumpLayout |[-p] \<-i \| -a>|支持在daemon运行时执行获取控件树。<br> **-p** ：指定存储路径和文件名, 只支持存放在/data/local/tmp/下。默认存储路径：/data/local/tmp，文件名：时间戳 + .json。<br> **-i** ：不过滤不可见控件,也不做窗口合并。<br> **-a** ：保存 BackgroundColor、 Content、FontColor、FontSize、extraAttrs 属性数据。<br> **默认** ：不保存上述属性数据。<br> **-a和-i** 不可同时使用。 | 372| uiRecord | uiRecord \<record \| read>|录制Ui操作。 <br> **record** ：开始录制，将当前界面操作记录到/data/local/tmp/record.csv，结束录制操作使用Ctrl+C结束录制。 <br> **read** ：读取并且打印录制数据。<br>各参数代表的含义请参考[用户录制操作](#用户录制操作)。| 373| uiInput | \<help \| click \| doubleClick \| longClick \| fling \| swipe \| drag \| dircFling \| inputText \| keyEvent>| 注入UI模拟操作。<br>各参数代表的含义请参考[注入ui模拟操作](#注入ui模拟操作)。 | 374| --version | --version|获取当前工具版本信息。 | 375| start-daemon|start-daemon| 拉起uitest测试进程。 | 376 377### 截图使用示例 378 379```bash 380# 存储路径：/data/local/tmp，文件名：时间戳 + .png。 381hdc shell uitest screenCap 382# 指定存储路径和文件名,存放在/data/local/tmp/下。 383hdc shell uitest screenCap -p /data/local/tmp/1.png 384``` 385 386### 获取控件树使用示例 387 388```bash 389hdc shell uitest dumpLayout -p /data/local/tmp/1.json 390``` 391 392### 用户录制操作 393>**说明** 394> 395> 录制过程中，需等待当前操作的识别结果在命令行输出后，再进行下一步操作。 396 397```bash 398# 将当前界面操作记录到/data/local/tmp/record.csv，结束录制操作使用Ctrl+C结束录制。 399hdc shell uitest uiRecord record 400# 读取并打印录制数据。 401hdc shell uitest uiRecord read 402``` 403 404以下举例为：record数据中包含的字段及字段含义，仅供参考 405 406 ``` 407 { 408 "ABILITY": "com.ohos.launcher.MainAbility", // 前台应用界面 409 "BUNDLE": "com.ohos.launcher", // 操作应用 410 "CENTER_X": "", // 预留字段,暂未使用 411 "CENTER_Y": "", // 预留字段,暂未使用 412 "EVENT_TYPE": "pointer", // 413 "LENGTH": "0", // 总体步长 414 "OP_TYPE": "click", //事件类型，当前支持点击、双击、长按、拖拽、滑动、抛滑动作录制 415 "VELO": "0.000000", // 离手速度 416 "direction.X": "0.000000",// 总体移动X方向 417 "direction.Y": "0.000000", // 总体移动Y方向 418 "duration": 33885000.0, // 手势操作持续时间 419 "fingerList": [{ 420 "LENGTH": "0", // 总体步长 421 "MAX_VEL": "40000", // 最大速度 422 "VELO": "0.000000", // 离手速度 423 "W1_BOUNDS": "{"bottom":361,"left":37,"right":118,"top":280}", // 起点控件bounds 424 "W1_HIER": "ROOT,3,0,0,0,0,0,0,0,0,5,0,0,0,0,0,0,0", // 起点控件hierarchy 425 "W1_ID": "", // 起点控件id 426 "W1_Text": "", // 起点控件text 427 "W1_Type": "Image", // 起点控件类型 428 "W2_BOUNDS": "{"bottom":361,"left":37,"right":118,"top":280}", // 终点控件bounds 429 "W2_HIER": "ROOT,3,0,0,0,0,0,0,0,0,5,0,0,0,0,0,0,0", // 终点控件hierarchy 430 "W2_ID": "", // 终点控件id 431 "W2_Text": "", // 终点控件text 432 "W2_Type": "Image", // 终点控件类型 433 "X2_POSI": "47", // 终点X 434 "X_POSI": "47", // 起点X 435 "Y2_POSI": "301", // 终点Y 436 "Y_POSI": "301", // 起点Y 437 "direction.X": "0.000000", // x方向移动量 438 "direction.Y": "0.000000" // Y方向移动量 439 }], 440 "fingerNumber": "1" //手指数量 441 } 442 ``` 443 444### 注入UI模拟操作 445 446| 命令 | 必填 | 描述 | 447|------|------|-----------------| 448| help | 是 | uiInput命令相关帮助信息。 | 449| click | 是 | 模拟单击操作。 | 450| doubleClick | 是 | 模拟双击操作。 | 451| longClick | 是 | 模拟长按操作。 | 452| fling | 是 | 模拟快滑操作。 | 453| swipe | 是 | 模拟慢滑操作。 | 454| drag | 是 | 模拟拖拽操作。 | 455| dircFling | 是 | 模拟指定方向滑动操作。 | 456| inputText | 是 | 模拟输入框输入文本操作。 | 457| keyEvent | 是 | 模拟实体按键事件(如：键盘,电源键,返回上一级,返回桌面等)，以及组合按键操作。 | 458 459 460#### uiInput click/doubleClick/longClick使用示例 461 462| 配置参数 | 必填 | 描述 | 463|---------|------|-----------------| 464| point_x | 是 | 点击x坐标点。 | 465| point_y | 是 | 点击y坐标点。 | 466 467```shell 468# 执行单击事件。 469hdc shell uitest uiInput click 100 100 470 471# 执行双击事件。 472hdc shell uitest uiInput doubleClick 100 100 473 474# 执行长按事件。 475hdc shell uitest uiInput longClick 100 100 476``` 477 478#### uiInput fling使用示例 479 480| 配置参数 | 必填 | 描述 | 481|------|------------------|-----------------| 482| from_x | 是 | 滑动起点x坐标。 | 483| from_y | 是 | 滑动起点y坐标。 | 484| to_x | 是 | 滑动终点x坐标。 | 485| to_y | 是 | 滑动终点y坐标。 | 486| swipeVelocityPps_ | 否 | 滑动速度，单位: (px/s)，取值范围：200-40000。<br> 默认值: 600。 | 487| stepLength_ | 否 | 滑动步长。默认值: 滑动距离/50。<br> **为实现更好的模拟效果，推荐参数缺省/使用默认值。** | 488 489 490```shell 491# 执行快滑操作，stepLength_缺省。 492hdc shell uitest uiInput fling 10 10 200 200 500 493``` 494 495#### uiInput swipe/drag使用示例 496 497| 配置参数 | 必填 | 描述 | 498|------|------------------|-----------------| 499| from_x | 是 | 滑动起点x坐标。 | 500| from_y | 是 | 滑动起点y坐标。 | 501| to_x | 是 | 滑动终点x坐标。 | 502| to_y | 是 | 滑动终点y坐标。 | 503| swipeVelocityPps_ | 否 | 滑动速度，单位: (px/s)，取值范围：200-40000。<br> 默认值: 600。 | 504 505```shell 506# 执行慢滑操作。 507hdc shell uitest uiInput swipe 10 10 200 200 500 508 509# 执行拖拽操作。 510hdc shell uitest uiInput drag 10 10 100 100 500 511``` 512 513#### uiInput dircFling使用示例 514 515| 配置参数 | 必填 | 描述 | 516|-------------------|-------------|----------| 517| direction | 否 | 滑动方向，取值范围：[0,1,2,3]，默认值为0。<br> 0代表向左滑动，1代表向右滑动，2代表向上滑动，3代表向下滑动。 | 518| swipeVelocityPps_ | 否| 滑动速度，单位: (px/s)，取值范围：200-40000。<br> 默认值: 600。 | 519| stepLength | 否 | 滑动步长。<br> 默认值: 滑动距离/50。为更好的模拟效果，推荐参数缺省/使用默认值。 | 520 521```shell 522# 执行左滑操作 523hdc shell uitest uiInput dircFling 0 500 524# 执行向右滑动操作 525hdc shell uitest uiInput dircFling 1 600 526# 执行向上滑动操作。 527hdc shell uitest uiInput dircFling 2 528# 执行向下滑动操作。 529hdc shell uitest uiInput dircFling 3 530``` 531 532#### uiInput inputText使用示例 533 534| 配置参数 | 必填 | 描述 | 535|------|------------------|----------| 536| point_x | 是 | 输入框x坐标点。 | 537| point_y | 是 | 输入框y坐标点。 | 538| text | 是 | 输入文本内容。 | 539 540```shell 541# 执行输入框输入操作。 542hdc shell uitest uiInput inputText 100 100 hello 543``` 544 545#### uiInput keyEvent使用示例 546 547| 配置参数 | 必填 | 描述 | 548|------|------|----------| 549| keyID1 | 是 | 实体按键对应ID，取值范围：KeyCode/Back/Home/Power。<br>当取Back/Home/Power时，不支持输入组合键。 | 550| keyID2 | 否 | 实体按键对应ID。 | 551| keyID3 | 否 | 实体按键对应ID。 | 552 553>**说明** 554> 555> 最多支持传入是三个键值，<!--RP3-->键值的具体取值请参考[KeyCode](../reference/apis-input-kit/js-apis-keycode.md)<!--RP3End-->。 556 557```shell 558# 返回主页。 559hdc shell uitest uiInput keyEvent Home 560# 返回。 561hdc shell uitest uiInput keyEvent Back 562# 组合键粘贴。 563hdc shell uitest uiInput keyEvent 2072 2038 564``` 565 566### 获取版本信息 567 568```bash 569hdc shell uitest --version 570``` 571### 拉起uitest测试进程 572 573```shell 574hdc shell uitest start-daemon 575``` 576 577>**说明** 578> 579> 设备需调成开发者模式。 580> 581> 仅元能力aa test拉起的测试hap才能调用Uitest的能力。 582> 583> 测试hap的<!--RP4-->[APL等级级别](../security/AccessToken/app-permission-mgmt-overview.md#权限机制中的基本概念)<!--RP4End-->需为system_basic、normal。 584 585<!--Del--> 586## 相关实例 587 588### 单元测试脚本实例 589 590#### 单元测试断言功能使用实例 591介绍单元测试框架中支持的断言能力如何使用，具体代码请查看[断言能力示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/jsunit/entry/src/ohosTest/ets/test/assertExampleTest/assertExample.test.ets) 592 593#### 单元测试测试套定义使用实例 594介绍单元测试框架测试套嵌如何定义，包括嵌套定义能力，具体代码请参考[测试套嵌套示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/jsunit/entry/src/ohosTest/ets/test/coverExampleTest/coverExample.test.ets) 595 596#### 单元测试测试应用自定义函数使用实例 597介绍针对应用内自定义函数如何使用框架能力进行测试，具体代码请参考[应用自定义函数测试示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/jsunit/entry/src/ohosTest/ets/test/customExampleTest/customExample.test.ets) 598 599#### 单元测试数据驱动能力使用实例 600介绍测试框架数据驱动能力、脚本重复执行配置功能，具体代码请参考[数据驱动能力示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/jsunit/entry/src/ohosTest/ets/test/paramExampleTest/paramExample.test.ets) 601 602### UI测试脚本实例（控件类） 603 604#### 查找指定控件能力实例 605介绍通过设置控件属性作为查找条件，在应用界面上查找组件对象，具体代码请参考[控件查找示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/uitest/entry/src/ohosTest/ets/test/findCommentExampleTest/Component/findCommentExample.test.ets) 606 607#### 模拟点击操作事件能力实例 608介绍模拟用户在应用界面上进行点击，长按，双击等事件,具体代码请参考[点击事件示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/uitest/entry/src/ohosTest/ets/test/operationExampleTest/ui/clickEvent.test.ets) 609 610#### 模拟鼠标操作能力实例 611介绍模拟鼠标左击、右击、滑轮事件,具体代码请参考[鼠标操作事件示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/uitest/entry/src/ohosTest/ets/test/operationExampleTest/ui/MouseEvent.test.ets) 612 613#### 模拟文本输入能力实例 614介绍模拟输入中文、英文文本内容，使用前提是针对可以输入文本的组件类似文本框等组件进行操作，具体代码请参考[文本输入能力示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/uitest/entry/src/ohosTest/ets/test/operationExampleTest/ui/InputEvent.test.ets) 615 616#### 截图能力实例 617介绍屏幕截图功能，包括指定区域截图能力，具体代码请参考[截图能力示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/uitest/entry/src/ohosTest/ets/test/operationExampleTest/ui/ScreenCapEvent.test.ets) 618 619#### 模拟快滑操作能力实例 620介绍模拟快滑操作能力，即在可滑动页面上进行滑动，滑动后手指离开屏幕，具体代码请参考[模拟快滑操作能力示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/uitest/entry/src/ohosTest/ets/test/operationExampleTest/ui/FlingEvent.test.ets) 621 622#### 模拟慢滑操作能力实例 623介绍模拟慢滑操作能力，即在可滑动页面上进行滑动，滑动后手指仍停留在屏幕，具体代码请参考[模拟慢滑操作能力示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/uitest/entry/src/ohosTest/ets/test/operationExampleTest/ui/SwipeEvent.test.ets) 624 625#### 模拟缩放操作能力实例 626介绍模拟缩放能力，即在支持放大缩小的图片上，模拟双指缩放操作的能力，具体代码请参考[模拟缩放操作能力示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/uitest/entry/src/ohosTest/ets/test/operationExampleTest/ui/PinchEvent.test.ets) 627 628#### 模拟滚动到组件顶端或底端能力实例 629介绍模拟针对滑动类组件，可以模拟操作直接滚动到组件顶端或底端，具体代码请参考[模拟滚动到组件顶端或底端示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/uitest/entry/src/ohosTest/ets/test/operationExampleTest/ui/ScrollerEvent.test.ets) 630 631### UI测试脚本实例（窗口类） 632 633#### 查找指定窗口能力实例 634介绍通过应用报名查找应用窗口，具体代码请参考[查找指定窗口能力示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/uitest/entry/src/ohosTest/ets/test/findCommentExampleTest/window/findWindowExample.test.ets) 635 636#### 模拟窗口移动能力实例 637介绍模拟移动窗口到指定位置能力，具体代码请参考[模拟窗口移动示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/uitest/entry/src/ohosTest/ets/test/operationExampleTest/window/MoveToEvent.test.ets) 638 639#### 模拟调整窗口大小能力实例 640介绍模拟调整窗口大小能力，并可指定调整的具体方向，具体代码请参考[模拟调整窗口大小能力示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/uitest/entry/src/ohosTest/ets/test/operationExampleTest/window/ReSizeWindow.test.ets) 641 642<!--DelEnd--> 643 644## 常见问题 645 646### 单元测试用例常见问题 647 648**1、用例中增加的打印日志在用例结果之后才打印** 649 650**问题描述** 651 652用例中增加的日志打印信息，没有在用例执行过程中出现，而是在用例执行结束之后才出现。 653 654**可能原因** 655 656此类情况只会存在于用例中有调用异步接口的情况，原则上用例中所有的日志信息均在用例执行结束之前打印。 657 658**解决方法** 659 660当被调用的异步接口多于一个时，建议将接口调用封装成Promise方式调用。 661 662**2、执行用例时报error：fail to start ability** 663 664**问题描述** 665 666执行测试用例时候，用例执行失败，控制台返回错误：fail to start ability。 667 668**可能原因** 669 670测试包打包过程中出现问题，未将测试框架依赖文件打包在测试包中。 671 672**解决方法** 673 674检查测试包中是否包含OpenHarmonyTestRunner.abc文件，如没有则重新编译打包后再次执行测试。 675 676**3、执行用例时报用例超时错误** 677 678**问题描述** 679 680用例执行结束，控制台提示execute time XXms错误，即用例执行超时。 681 682**可能原因** 683 6841.用例执行异步接口，但执行过程中没有执行到done函数，导致用例执行一直没有结束，直到超时结束。 685 6862.用例调用函数耗时过长，超过用例执行设置的超时时间。 687 6883.用例调用函数中断言失败，抛出失败异常，导致用例执行一直没有结束，直到超时结束。 689 690**解决方法** 691 6921.检查用例代码逻辑，确保即使断言失败场景认可走到done函数，保证用例执行结束。 693 6942.可在IDE中Run/Debug Configurations中修改用例执行超时配置参数，避免用例执行超时。 695 6963.检查用例代码逻辑，断言结果，确保断言Pass。 697### UI测试用例常见问题 698 699**1、失败日志有“Get windows failed/GetRootByWindow failed”错误信息** 700 701**问题描述** 702 703UI测试用例执行失败，查看hilog日志发现日志中有“Get windows failed/GetRootByWindow failed”错误信息。 704 705**可能原因** 706 707系统ArkUI开关未开启，导致被测试界面控件树信息未生成。 708 709**解决方法** 710 711执行如下命令，并重启设备再次执行用例。 712 713```shell 714hdc shell param set persist.ace.testmode.enabled 1 715``` 716 717**2、失败日志有“uitest-api dose not allow calling concurrently”错误信息** 718 719**问题描述** 720 721UI测试用例执行失败，查看hilog日志发现日志中有“uitest-api dose not allow calling concurrently”错误信息。 722 723**可能原因** 724 7251.用例中UI测试框架提供异步接口没有增加await语法糖调用。 726 7272.多进程执行UI测试用例，导致拉起多个UITest进程，框架不支持多进程调用。 728 729**解决方法** 730 7311.检查用例实现，异步接口增加await语法糖调用。 732 7332.避免多进程执行UI测试用例。 734 735**3、失败日志有“does not exist on current UI! Check if the UI has changed after you got the widget object”错误信息** 736 737**问题描述** 738 739UI测试用例执行失败，查看hilog日志发现日志中有“does not exist on current UI! Check if the UI has changed after you got the widget object”错误信息。 740 741**可能原因** 742 743在用例中代码查找到目标控件后，设备界面发生了变化，导致查找到的控件丢失，无法进行下一步的模拟操作。 744 745**解决方法** 746 747重新执行UI测试用例。
