arkxtest-guidelines.md 26.0 KB
Newer Older
1
# 自动化测试框架使用指导
R
ry 已提交
2 3 4 5


## 概述

6
OpenHarmony的自动化测试框架arkxtest,作为工具集的重要组成部分,支持JS/TS语言的单元测试框架(JsUnit)及UI测试框架(UiTest)。<br>JsUnit提供单元测试用例执行能力,提供用例编写基础接口,生成对应报告,用于测试系统或应用接口。<br>UiTest通过简洁易用的API提供查找和操作界面控件能力,支持用户开发基于界面操作的自动化测试脚本。本指南介绍了测试框架的主要功能、实现原理、环境准备,以及测试脚本编写和执行等内容。
R
ry 已提交
7 8


9
## 实现原理
R
ry 已提交
10

11
测试框架分为单元测试框架和UI测试框架。<br>单元测试框架是测试框架的基础底座,提供了最基本的用例识别、调度、执行及结果汇总的能力。<br>UI测试框架主要对外提供了UiTest API供开发人员在对应测试场景调用,而其脚本的运行基础仍是单元测试框架。
R
ry 已提交
12

13
### 单元测试框架
R
ry 已提交
14

15
  图1.单元测试框架主要功能
R
ry 已提交
16

17
  ![](figures/UnitTest.PNG)
R
ry 已提交
18

19
  图2.脚本基础流程运行图
L
lijialang 已提交
20

21
  ![](figures/TestFlow.PNG)
R
ry 已提交
22

23 24 25
> **说明:**
>
> 单元测试框架中的函数具体含义请参考[函数定义](https://gitee.com/openharmony/testfwk_arkxtest/blob/master/README_zh.md#%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E)。
R
ry 已提交
26

27
### UI测试框架
R
ry 已提交
28

29
  图3.UI测试框架主要功能
R
ry 已提交
30

31 32
  ![](figures/Uitest.PNG)

R
ry 已提交
33

34
## 约束与限制
R
ry 已提交
35

36
- UI测试框架的能力在OpenHarmony 3.1 release版本之后方可使用,历史版本不支持使用。
37

R
ry 已提交
38 39 40 41 42 43 44
- 单元测试框架的部分能力与其版本有关,具体能力与版本匹配信息可见代码仓中的[文档介绍](https://gitee.com/openharmony/testfwk_arkxtest/blob/master/README_zh.md)


## 环境准备

### 环境要求

45
OpenHarmony自动化脚本的编写主要基于DevEco Studio,并建议使用3.0之后的版本进行脚本编写。
R
ry 已提交
46 47 48 49 50 51 52

脚本执行需要PC连接OpenHarmony设备,如RK3568开发板等。

### 搭建环境

DevEco Studio可参考其官网介绍进行[下载](https://developer.harmonyos.com/cn/develop/deveco-studio#download),并进行相关的配置动作。

L
lijialang 已提交
53
## 新建和编写测试脚本
R
ry 已提交
54

L
lijialang 已提交
55
### 新建测试脚本
R
ry 已提交
56 57

1. 在DevEco Studio中新建应用开发工程,其中ohos目录即为测试脚本所在的目录。
58
2. 在工程目录下打开待测试模块下的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)
R
ry 已提交
59

L
lijialang 已提交
60
### 编写单元测试脚本
R
ry 已提交
61

62 63 64 65 66 67 68 69 70 71
本章节主要描述单元测试框架支持能力,以及能力的使用方法。

在单元测试框架,测试脚本需要包含如下基本元素:

1、依赖导包,以便使用依赖的测试接口。

2、测试代码编写,主要编写测试代码的相关逻辑,如接口调用等。

3、断言接口调用,设置测试代码中的检查点,如无检查点,则不可认为一个完整的测试脚本。

72
如下示例代码实现的场景是:启动测试页面,检查设备当前显示的页面是否为预期页面。
73

L
lijialang 已提交
74
```js
75
import { describe, it, expect } from '@ohos/hypium';
76
import abilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
77
import { BusinessError } from '@ohos.base';
78
import UIAbility from '@ohos.app.ability.UIAbility';
79

R
ry 已提交
80
const delegator = abilityDelegatorRegistry.getAbilityDelegator()
81 82 83
function sleep(time: number) {
  return new Promise<void>((resolve: Function) => setTimeout(resolve, time));
}
R
ry 已提交
84
export default function abilityTest() {
85 86
    describe('ActsAbilityTest', () =>{
    it('testUiExample',0, async (done: Function) => {
R
ry 已提交
87 88
      console.info("uitest: TestUiExample begin");
      //start tested ability
89
      await delegator.executeShellCommand('aa start -b com.ohos.uitest -a EntryAbility').then((result: abilityDelegatorRegistry.ShellCmdResult) =>{
R
ry 已提交
90
        console.info('Uitest, start ability finished:' + result)
91
      }).catch((err: BusinessError) => {
R
ry 已提交
92 93 94 95
        console.info('Uitest, start ability failed: ' + err)
      })
      await sleep(1000);
      //check top display ability
96
      await delegator.getCurrentTopAbility().then((Ability: UIAbility)=>{
R
ry 已提交
97
        console.info("get top ability");
98
        expect(Ability.context.abilityInfo.name).assertEqual('EntryAbility');
R
ry 已提交
99 100 101 102 103 104 105
      })
      done();
    })
  })
}
```

L
lijialang 已提交
106
### 编写UI测试脚本
R
ry 已提交
107

108
本章节主要介绍UI测试框架支持能力,以及对应能力API的使用方法。<br>UI测试基于单元测试,UI测试脚本在单元测试脚本上增加了对UiTest接口(提供链接)调用,进而完成对应的测试活动。<br>如下的示例代码是在上面的单元测试脚本基础上增量编写,实现的是在启动的应用页面上进行点击操作,然后检测当前页面变化是否为预期变化。
R
ry 已提交
109

110
1.增加依赖导包。
R
ry 已提交
111

L
lijialang 已提交
112
```js
113
import { Driver, ON } from '@ohos.UiTest'
R
ry 已提交
114 115
```

116
2.编写具体测试代码。
R
ry 已提交
117

L
lijialang 已提交
118
```js
119 120 121
import { describe, it, expect } from '@ohos/hypium';
import abilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
import { Driver, ON } from '@ohos.UiTest'
122
import { BusinessError } from '@ohos.base';
123
import UIAbility from '@ohos.app.ability.UIAbility';
124

125 126 127 128
const delegator: abilityDelegatorRegistry.AbilityDelegator = abilityDelegatorRegistry.getAbilityDelegator()
function sleep(time: number) {
  return new Promise<void>((resolve: Function) => setTimeout(resolve, time));
}
R
ry 已提交
129
export default function abilityTest() {
130
  describe('ActsAbilityTest', () => {
131
    it('testUiExample',0, async (done: Function) => {
R
ry 已提交
132 133
      console.info("uitest: TestUiExample begin");
      //start tested ability
134
      await delegator.executeShellCommand('aa start -b com.ohos.uitest -a EntryAbility').then((result: abilityDelegatorRegistry.ShellCmdResult) =>{
R
ry 已提交
135
        console.info('Uitest, start ability finished:' + result)
136
      }).catch((err: BusinessError) => {
R
ry 已提交
137 138 139 140
        console.info('Uitest, start ability failed: ' + err)
      })
      await sleep(1000);
      //check top display ability
141
      await delegator.getCurrentTopAbility().then((Ability: UIAbility)=>{
R
ry 已提交
142
        console.info("get top ability");
143
        expect(Ability.context.abilityInfo.name).assertEqual('EntryAbility');
R
ry 已提交
144 145
      })
      //ui test code
刘乐 已提交
146
      //init driver
147
      let driver = await Driver.create();
R
ry 已提交
148
      await driver.delayMs(1000);
刘乐 已提交
149
      //find button on text 'Next'
150
      let button = await driver.findComponent(ON.text('Next'));
R
ry 已提交
151 152 153 154
      //click button
      await button.click();
      await driver.delayMs(1000);
      //check text
刘乐 已提交
155
      await driver.assertComponentExist(ON.text('after click'));
R
ry 已提交
156 157 158 159 160 161 162 163 164
      await driver.pressBack();
      done();
    })
  })
}
```

## 执行测试脚本

165 166 167
### DevEco Studio执行

通过点击按钮执行,当前支持以下执行方式:
R
ry 已提交
168

169
1、测试包级别执行,即执行测试包内的全部用例。
R
ry 已提交
170

171
2、测试套级别执行,即执行describe方法中定义的全部测试用例。
R
ry 已提交
172

173
3、测试方法级别执行,即执行指定it方法也就是单条测试用例。
R
ry 已提交
174

175
![](figures/Execute.PNG)
R
ry 已提交
176

177
**查看测试结果**
R
ry 已提交
178 179 180

测试执行完毕后可直接在DevEco Studio中查看测试结果,如下图示例所示:

181
![](figures/TestResult.PNG)
182

183 184 185 186
**查看测试用例覆盖率**

执行完测试用例后可以查看测试用例覆盖率,具体操作请参考[OpenHarmony Test代码覆盖率统计](https://developer.harmonyos.com/cn/docs/documentation/doc-guides-V3/harmonyos_jnit_jsunit-0000001092459608-V3?catalogVersion=V3#section1989615417457)

187 188
### CMD执行

189 190 191 192
将应用测试包安装到测试设备上,在cmd窗口中执行aa命令,完成对用例测试。

> **说明:**
>
193
> 使用cmd的方式,需要配置好hdc相关的环境变量。
194 195 196 197 198

**aa test命令执行配置参数**

| 执行参数全写  | 执行参数缩写 | 执行参数含义                           | 执行参数示例                       |
| ------------- | ------------ | -------------------------------------- | ---------------------------------- |
199
| --bundleName  | -b           | 应用Bundle名称                         | - b com.test.example               |
200 201 202 203 204 205 206 207 208 209 210 211 212 213
| --packageName | -p           | 应用模块名,适用于FA模型应用           | - p com.test.example.entry         |
| --moduleName  | -m           | 应用模块名,适用于STAGE模型应用        | -m entry                           |
| NA            | -s           | 特定参数,以<key, value>键值对方式传入 | - s unittest OpenHarmonyTestRunner |

框架当前支持多种用例执行方式,通过上表中的-s参数后的配置键值对参数传入触发,如下表所示。

| 配置参数值     | 配置参数含义                                                 | 配置参数有值                                                 | 配置参数示例                              |
| ------------ | -----------------------------------------------------------------------------    | ------------------------------------------------------------ | ----------------------------------------- |
| unittest     | 用例执行所使用OpenHarmonyTestRunner对象  | OpenHarmonyTestRunner或用户自定义runner名称                  | - s unittest OpenHarmonyTestRunner        |
| class        | 指定要执行的测试套或测试用例                                   | {describeName}#{itName},{describeName}                      | -s class attributeTest#testAttributeIt    |
| notClass     | 指定不需要执行的测试套或测试用例                               | {describeName}#{itName},{describeName}                      | -s notClass attributeTest#testAttributeIt |
| itName       | 指定要执行的测试用例                                         | {itName}                                                     | -s itName testAttributeIt                 |
| timeout      | 测试用例执行的超时时间                                        | 正整数(单位ms),如不设置默认为 5000                        | -s timeout 15000                          |
| breakOnError | 遇错即停模式,当执行用例断言失败或者发生错误时,退出测试执行流程 | true/false(默认值)                                           | -s breakOnError true                      |
L
lijialang 已提交
214
| random | 测试用例随机顺序执行 | true/false(默认值)                                           | -s random true                      |
215 216
| testType     | 指定要执行用例的用例类型                                      | function,performance,power,reliability, security,global,compatibility,user,standard,safety,resilience' | -s testType function                      |
| level        | 指定要执行用例的用例级别                                      | 0,1,2,3,4                                                    | -s level 0                                |
L
lijialang 已提交
217 218
| size         | 指定要执行用例的用例规模                                    | small,medium,large                                         | -s size small        
| stress       | 指定要执行用例的执行次数                                    |  正整数                                         | -s stress 1000                            |
219

220
**cmd窗口执行test命令**
221 222 223 224

- 打开cmd窗口
- 执行 aa test 命令

225
示例代码1:执行所有测试用例。
226 227

```shell  
228
 hdc shell aa test -b xxx -p xxx -s unittest OpenHarmonyTestRunner
229 230
```

231
示例代码2:执行指定的describe测试套用例,指定多个需用逗号隔开。
232 233

```shell  
234
  hdc shell aa test -b xxx -p xxx -s unittest OpenHarmonyTestRunner -s class s1,s2
235 236
```

237
示例代码3:执行指定测试套中指定的用例,指定多个需用逗号隔开。
238 239

```shell  
240
  hdc shell aa test -b xxx -p xxx -s unittest OpenHarmonyTestRunner -s class testStop#stop_1,testStop1#stop_0
241 242
```

243
示例代码4:执行指定除配置以外的所有的用例,设置不执行多个测试套需用逗号隔开。
244 245

```shell  
246
  hdc shell aa test -b xxx -p xxx -s unittest OpenHarmonyTestRunner -s notClass testStop
247 248
```

249
示例代码5:执行指定it名称的所有用例,指定多个需用逗号隔开。
250 251

```shell  
252
  hdc shell aa test -b xxx -p xxx -s unittest OpenHarmonyTestRunner -s itName stop_0
253 254
```

255
示例代码6:用例执行超时时长配置。
256 257

```shell  
258
  hdc shell aa test -b xxx -p xxx -s unittest OpenHarmonyTestRunner  -s timeout 15000
259 260
```

261
示例代码7:用例以breakOnError模式执行用例。
262 263

```shell  
264
  hdc shell aa test -b xxx -p xxx -s unittest OpenHarmonyTestRunner   -s breakOnError true
265 266
```

267
示例代码8:执行测试类型匹配的测试用例。
268 269

```shell  
270
  hdc shell aa test -b xxx -p xxx -s unittest OpenHarmonyTestRunner   -s testType function
271 272
```

273
示例代码9:执行测试级别匹配的测试用例。
274 275

```shell  
276
  hdc shell aa test -b xxx -p xxx -s unittest OpenHarmonyTestRunner   -s level 0
277 278
```

279
示例代码10:执行测试规模匹配的测试用例。
280 281

```shell  
282
  hdc shell aa test -b xxx -p xxx -s unittest OpenHarmonyTestRunner   -s size small
283 284
```

285
示例代码11:执行测试用例指定次数。
L
lijialang 已提交
286 287 288 289 290

```shell  
  hdc shell aa test -b xxx -p xxx -s unittest OpenHarmonyTestRunner   -s stress 1000
```

291
**查看测试结果**
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315

- cmd模式执行过程,会打印如下相关日志信息。

```
OHOS_REPORT_STATUS: class=testStop
OHOS_REPORT_STATUS: current=1
OHOS_REPORT_STATUS: id=JS
OHOS_REPORT_STATUS: numtests=447
OHOS_REPORT_STATUS: stream=
OHOS_REPORT_STATUS: test=stop_0
OHOS_REPORT_STATUS_CODE: 1

OHOS_REPORT_STATUS: class=testStop
OHOS_REPORT_STATUS: current=1
OHOS_REPORT_STATUS: id=JS
OHOS_REPORT_STATUS: numtests=447
OHOS_REPORT_STATUS: stream=
OHOS_REPORT_STATUS: test=stop_0
OHOS_REPORT_STATUS_CODE: 0
OHOS_REPORT_STATUS: consuming=4
```

| 日志输出字段               | 日志输出字段含义       |
| -------           | -------------------------|
316 317 318 319 320 321 322
| OHOS_REPORT_SUM    | 当前测试套用例总数。 |
| OHOS_REPORT_STATUS: class | 当前执行用例测试套名称。|
| OHOS_REPORT_STATUS: id | 用例执行语言,默认JS。  |
| OHOS_REPORT_STATUS: numtests | 测试包中测试用例总数 。|
| OHOS_REPORT_STATUS: stream | 当前用例发生错误时,记录错误信息。 |
| OHOS_REPORT_STATUS: test| 当前用例执行的it name。 |
| OHOS_REPORT_STATUS_CODE | 当前用例执行结果状态。0表示通过,1表示错误,2表示失败。|
323
| OHOS_REPORT_STATUS: consuming | 当前用例执行消耗的时长(ms)。 |
324 325 326 327 328 329 330 331 332 333 334 335 336

- cmd执行完成后,会打印如下相关日志信息。

```
OHOS_REPORT_RESULT: stream=Tests run: 447, Failure: 0, Error: 1, Pass: 201, Ignore: 245
OHOS_REPORT_CODE: 0

OHOS_REPORT_RESULT: breakOnError model, Stopping whole test suite if one specific test case failed or error
OHOS_REPORT_STATUS: taskconsuming=16029

```
| 日志输出字段               | 日志输出字段含义           |
| ------------------| -------------------------|
337 338 339 340 341
| run    | 当前测试包用例总数。 |
| Failure | 当前测试失败用例个数。 |
| Error | 当前执行用例发生错误用例个数。  |
| Pass | 当前执行用例通过用例个数 。|
| Ignore | 当前未执行用例个数。 |
342
| taskconsuming| 执行当前测试用例总耗时(ms)。 |
343

344
> 当处于breakOnError模式,用例发生错误时,注意查看Ignore以及中断说明。
R
add FAQ  
ry 已提交
345

L
lijialang 已提交
346 347
## 录制用户操作
### 使用录制功能
L
lijialang 已提交
348
> 将当前界面操作记录到/data/local/tmp/layout/record.csv,结束录制操作使用Ctrl+C结束录制
L
lijialang 已提交
349 350 351 352

```shell  
 hdc shell uitest uiRecord record
```
L
lijialang 已提交
353 354 355 356 357
### 查看录制数据
支持两种方式查看数据。

#### 命令读取并打印录制数据

L
lijialang 已提交
358 359 360
```shell  
 hdc shell uitest uiRecord read
```
L
lijialang 已提交
361
#### 命令导出 record.csv文件查看录制数据
L
lijialang 已提交
362
```shell  
L
lijialang 已提交
363
hdc file recv /data/local/tmp/layout/record.csv D:\tool  # D:\tool 为本地存储路径,用户可自定义
L
lijialang 已提交
364 365 366 367
```
- record 数据字段含义请参考如下示例数据。
```
{
L
lijialang 已提交
368 369
	"ABILITY": "com.ohos.launcher.MainAbility", // 前台应用界面
	"BUNDLE": "com.ohos.launcher", // 操作应用
L
lijialang 已提交
370 371 372 373
	"CENTER_X": "", // 模拟捏合中心X, pinch事件
	"CENTER_Y": "", // 模拟捏合中心Y, pinch事件
	"EVENT_TYPE": "pointer", //  
	"LENGTH": "0", // 总体步长
L
lijialang 已提交
374
	"OP_TYPE": "click", //事件类型,当前支持点击、双击、长按、拖拽、捏合、滑动、抛滑动作录制
L
lijialang 已提交
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
	"VELO": "0.000000", // 离手速度
	"direction.X": "0.000000",// 总体移动X方向
	"direction.Y": "0.000000", // 总体移动Y方向
	"duration": 33885000.0, // 手势操作持续时间
	"fingerList": [{
		"LENGTH": "0", // 总体步长
		"MAX_VEL": "40000", // 最大速度
		"VELO": "0.000000", // 离手速度
		"W1_BOUNDS": "{"bottom":361,"left":37,"right":118,"top":280}", // 起点控件bounds
		"W1_HIER": "ROOT,3,0,0,0,0,0,0,0,0,5,0,0,0,0,0,0,0", // 起点控件hierarchy
		"W1_ID": "", // 起点控件id
		"W1_Text": "", // 起点控件text
		"W1_Type": "Image", // 起点控件类型
		"W2_BOUNDS": "{"bottom":361,"left":37,"right":118,"top":280}", // 终点控件bounds
		"W2_HIER": "ROOT,3,0,0,0,0,0,0,0,0,5,0,0,0,0,0,0,0", // 终点控件hierarchy
		"W2_ID": "", // 终点控件id
		"W2_Text": "", // 终点控件text
		"W2_Type": "Image", // 终点控件类型
		"X2_POSI": "47", // 终点X
		"X_POSI": "47", // 起点X
		"Y2_POSI": "301", // 终点Y
		"Y_POSI": "301", // 起点Y
		"direction.X": "0.000000", // x方向移动量
		"direction.Y": "0.000000" // Y方向移动量
	}],
	"fingerNumber": "1" //手指数量
}
```

404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
## 相关实例

### 单元测试脚本实例

#### 单元测试断言功能使用实例
介绍单元测试框架中支持的断言能力如何使用,具体代码请查看[断言能力示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/jsunit/entry/src/ohosTest/ets/test/assertExampleTest/assertExample.test.ets)

#### 单元测试测试套定义使用实例
介绍单元测试框架测试套嵌如何定义,包括嵌套定义能力,具体代码请参考[测试套嵌套示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/jsunit/entry/src/ohosTest/ets/test/coverExampleTest/coverExample.test.ets)

#### 单元测试测试应用自定义函数使用实例
介绍针对应用内自定义函数如何使用框架能力进行测试,具体代码请参考[应用自定义函数测试示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/jsunit/entry/src/ohosTest/ets/test/customExampleTest/customExample.test.ets)

#### 单元测试数据驱动能力使用实例
介绍测试框架数据驱动能力、脚本重复执行配置功能,具体代码请参考[数据驱动能力示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/jsunit/entry/src/ohosTest/ets/test/paramExampleTest/paramExample.test.ets)

### UI测试脚本实例(控件类)

#### 查找指定控件能力实例
介绍通过设置控件属性作为查找条件,在应用界面上查找组件对象,具体代码请参考[控件查找示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/uitest/entry/src/ohosTest/ets/test/findCommentExampleTest/Component/findCommentExample.test.ets)

#### 模拟点击操作事件能力实例
介绍模拟用户在应用界面上进行点击,长按,双击等事件,具体代码请参考[点击事件示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/uitest/entry/src/ohosTest/ets/test/operationExampleTest/ui/clickEvent.test.ets)

#### 模拟鼠标操作能力实例
介绍模拟鼠标左击、右击、滑轮事件,具体代码请参考[鼠标操作事件示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/uitest/entry/src/ohosTest/ets/test/operationExampleTest/ui/MouseEvent.test.ets)

#### 模拟文本输入能力实例
介绍模拟输入中文、英文文本内容,使用前提是针对可以输入文本的组件类似文本框等组件进行操作,具体代码请参考[文本输入能力示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/uitest/entry/src/ohosTest/ets/test/operationExampleTest/ui/InputEvent.test.ets)

#### 截图能力实例
介绍屏幕截图功能,包括指定区域截图能力,具体代码请参考[截图能力示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/uitest/entry/src/ohosTest/ets/test/operationExampleTest/ui/ScreenCapEvent.test.ets)

#### 模拟快滑操作能力实例
介绍模拟快滑操作能力,即在可滑动页面上进行滑动,滑动后手指离开屏幕,具体代码请参考[模拟快滑操作能力示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/uitest/entry/src/ohosTest/ets/test/operationExampleTest/ui/FlingEvent.test.ets)

#### 模拟慢滑操作能力实例
介绍模拟慢滑操作能力,即在可滑动页面上进行滑动,滑动后手指仍停留在屏幕,具体代码请参考[模拟慢滑操作能力示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/uitest/entry/src/ohosTest/ets/test/operationExampleTest/ui/SwipeEvent.test.ets)

#### 模拟缩放操作能力实例
介绍模拟缩放能力,即在支持放大缩小的图片上,模拟双指缩放操作的能力,具体代码请参考[模拟缩放操作能力示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/uitest/entry/src/ohosTest/ets/test/operationExampleTest/ui/PinchEvent.test.ets)

#### 模拟滚动到组件顶端或底端能力实例
介绍模拟针对滑动类组件,可以模拟操作直接滚动到组件顶端或底端,具体代码请参考[模拟滚动到组件顶端或底端示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/uitest/entry/src/ohosTest/ets/test/operationExampleTest/ui/ScrollerEvent.test.ets)

### UI测试脚本实例(窗口类)

#### 查找指定窗口能力实例
介绍通过应用报名查找应用窗口,具体代码请参考[查找指定窗口能力示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/uitest/entry/src/ohosTest/ets/test/findCommentExampleTest/window/findWindowExample.test.ets)

#### 模拟窗口移动能力实例
介绍模拟移动窗口到指定位置能力,具体代码请参考[模拟窗口移动示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/uitest/entry/src/ohosTest/ets/test/operationExampleTest/window/MoveToEvent.test.ets)

#### 模拟调整窗口大小能力实例
介绍模拟调整窗口大小能力,并可指定调整的具体方向,具体代码请参考[模拟调整窗口大小能力示例](https://gitee.com/openharmony/applications_app_samples/blob/master/code/Project/Test/uitest/entry/src/ohosTest/ets/test/operationExampleTest/window/ReSizeWindow.test.ets)

R
add FAQ  
ry 已提交
460 461
## 常见问题

R
add FAQ  
ry 已提交
462
### 单元测试用例常见问题
R
add FAQ  
ry 已提交
463

R
add FAQ  
ry 已提交
464
**1、用例中增加的打印日志在用例结果之后才打印**
R
add FAQ  
ry 已提交
465

R
add FAQ  
ry 已提交
466
**问题描述**
R
add FAQ  
ry 已提交
467 468 469

用例中增加的日志打印信息,没有在用例执行过程中出现,而是在用例执行结束之后才出现。

470
**可能原因**
R
add FAQ  
ry 已提交
471 472 473

此类情况只会存在于用例中有调用异步接口的情况,原则上用例中所有的日志信息均在用例执行结束之前打印。

474
**解决方法**
R
add FAQ  
ry 已提交
475 476 477

当被调用的异步接口多于一个时,建议将接口调用封装成Promise方式调用。

R
add FAQ  
ry 已提交
478
**2、执行用例时报error:fail to start ability**
R
add FAQ  
ry 已提交
479 480 481 482 483 484 485 486 487 488 489 490 491

**问题描述**

执行测试用例时候,用例执行失败,控制台返回错误:fail to start ability。

**可能原因**

测试包打包过程中出现问题,未将测试框架依赖文件打包在测试包中。

**解决方法**

检查测试包中是否包含OpenHarmonyTestRunner.abc文件,如没有则重新编译打包后再次执行测试。

R
add FAQ  
ry 已提交
492
**3、执行用例时报用例超时错误**
R
add FAQ  
ry 已提交
493 494 495 496 497 498 499 500 501 502 503

**问题描述**

用例执行结束,控制台提示execute time XXms错误,即用例执行超时

**可能原因**

1.用例执行异步接口,但执行过程中没有执行到done函数,导致用例执行一直没有结束,直到超时结束。

2.用例调用函数耗时过长,超过用例执行设置的超时时间。

504 505
3.用例调用函数中断言失败,抛出失败异常,导致用例执行一直没有结束,直到超时结束。

R
add FAQ  
ry 已提交
506 507 508 509
**解决方法**

1.检查用例代码逻辑,确保即使断言失败场景认可走到done函数,保证用例执行结束。

510
2.可在IDE中Run/Debug Configurations中修改用例执行超时配置参数,避免用例执行超时。
R
add FAQ  
ry 已提交
511

512
3.检查用例代码逻辑,断言结果,确保断言Pass。
R
add FAQ  
ry 已提交
513
### UI测试用例常见问题
R
add FAQ  
ry 已提交
514

R
add FAQ  
ry 已提交
515
**1、失败日志有“Get windows failed/GetRootByWindow failed”错误信息**
R
add FAQ  
ry 已提交
516 517 518

**问题描述**

R
add FAQ  
ry 已提交
519
UI测试用例执行失败,查看hilog日志发现日志中有“Get windows failed/GetRootByWindow failed”错误信息。
R
add FAQ  
ry 已提交
520 521 522 523 524 525 526 527 528 529 530 531 532

**可能原因**

系统ArkUI开关未开启,导致被测试界面控件树信息未生成。

**解决方法**

执行如下命令,并重启设备再次执行用例。

```shell
hdc shell param set persist.ace.testmode.enabled 1
```

R
add FAQ  
ry 已提交
533
**2、失败日志有“uitest-api dose not allow calling concurrently”错误信息**
R
add FAQ  
ry 已提交
534 535 536

**问题描述**

R
add FAQ  
ry 已提交
537
UI测试用例执行失败,查看hilog日志发现日志中有“uitest-api dose not allow calling concurrently”错误信息。
R
add FAQ  
ry 已提交
538 539 540 541 542 543 544 545 546 547 548 549 550

**可能原因**

1.用例中UI测试框架提供异步接口没有增加await语法糖调用。

2.多进程执行UI测试用例,导致拉起多个UITest进程,框架不支持多进程调用。

**解决方法**

1.检查用例实现,异步接口增加await语法糖调用。

2.避免多进程执行UI测试用例。

L
lijialang 已提交
551
**3、失败日志有“does not exist on current UI! Check if the UI has changed after you got the widget object”错误信息**
R
add FAQ  
ry 已提交
552

553
**问题描述** 
R
add FAQ  
ry 已提交
554

L
lijialang 已提交
555
UI测试用例执行失败,查看hilog日志发现日志中有“does not exist on current UI! Check if the UI has changed after you got the widget object”错误信息。
R
add FAQ  
ry 已提交
556 557 558 559 560 561 562

**可能原因**

在用例中代码查找到目标控件后,设备界面发生了变化,导致查找到的控件丢失,无法进行下一步的模拟操作。

**解决方法**

R
add FAQ  
ry 已提交
563
重新执行UI测试用例。