# UI测试框架使用指导

#### 概述

UI测试框架（UITest）为开发者提供UI界面查找和模拟操作能力，可覆盖UI自动化测试的关键场景，包括界面控件精准查找、UI交互操作（如点击、滑动、文本输入等）、外设行为模拟（如键盘输入、鼠标操作、触控板手势、手写笔动作等），助力开发者开发高效可靠的界面自动化测试用例。

#### 功能全景

UITest支持采用ArkTS API与命令行两种方式，为界面自动化测试提供灵活高效的技术支撑，其中：

**ArkTS脚本开发能力：**

提供简洁易用的API接口，满足各类测试场景需求，支持点击、双击、长按、滑动等常用UI交互操作，助力开发者快速开发基于界面交互逻辑的自动化测试脚本。

**命令行测试能力：**

支持通过命令行直接实现多元化测试操作，包括获取当前界面截图、获取控件树、录制界面操作流程、便捷注入UI模拟事件等。

UITest分为客户端和服务端。

**· 客户端：**

包含跨语言通信层、IPC模块等，主要功能为对外导出API，为UI测试框架启动提供入口。客户端由测试应用加载，运行在应用进程。其中，跨语言通信层主要进行接口导出、JSON序列化对象处理、上层ArkTS接口与底层C++接口的转换、参数解析和校验。此外，由于本模块涉及C++层对ArkTS层回调函数的调用，跨语言通信层同时负责ArkTS回调函数的管理和调用。

**· 服务端：**

以独立进程运行，通过IPC与客户端进行通信。服务端启动后，通过广播与客户端建立连接，通过IPC通信确保连接不断开。服务端监听客户端进程状态，实现按需启停。服务端负责UI测试框架核心逻辑的处理，主要分为以下两部分：

1.  框架运行通用能力：进行IPC消息处理、进程管理、C++接口和错误码的管理，包括接口调用监听等。
2.  UI测试能力：解析无障碍节点构建页面控件树、控件匹配查找、操作事件构造、多模事件注入、UI事件监听、屏幕显示控制等。

#### 使用ArkTS接口进行UI测试

本章节介绍UI测试框架ArkTS API的具体使用方法。

UI测试是在单元测试基础上进行UITest接口调用，接口的详细定义与参数说明可参考API文档。

#### UI测试示例

下面提供一个UI测试的简单示例，介绍如何在单元测试脚本基础上进行UI测试的增量开发，具体实现功能如下：

1.  调用程序框架服务能力，启动目标被测应用，并确认应用运行状态。
2.  调用UI测试框架能力，页面中执行点击操作。
3.  通过添加断言，验证操作后当前页面的实际变化是否与预期结果一致。

开发步骤如下：

1.  在main > ets > pages文件夹下编写clickToAfter.ets页面代码，作为被测示例demo。
    
    ```
    @Entry
    @Component
    struct Index {
      @State message: string = 'Hello World';
      @State text: string = '';
    
      build() {
        Row() {
          Column() {
            Text(this.message)
              .fontSize(50)
              .fontWeight(FontWeight.Bold)
            Text('Next')
              .fontSize(50)
              .margin({ top: 20 })
              .fontWeight(FontWeight.Bold)
              .onClick((event?: ClickEvent) => {
                if (event) {
                  this.text = 'after click';
                }
              })
              .width('100%')
            Text(this.text).margin(15)
          }
        }
        .height('100%')
      }
    }
    ```
    
2.  在ohosTest > ets > test文件夹下新建测试文件，并编写具体测试代码。
    
    ```
    import { describe, expect, it, Level } from '@ohos/hypium';
    // 导入测试依赖kit
    import { abilityDelegatorRegistry, Driver, ON } from '@kit.TestKit';
    import { UIAbility, Want } from '@kit.AbilityKit';
    
    const delegator: abilityDelegatorRegistry.AbilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
    
    export default function abilityTest() {
      describe('ActsAbilityTest', () => {
        it('testUiExample', Level.LEVEL3, async (done: Function) => {
          // 初始化Driver对象
          const driver = Driver.create();
          const bundleName = abilityDelegatorRegistry.getArguments().bundleName;
          // 指定被测应用包名、ability名，请开发者替换为被测应用包名和ability名
          const want: Want = {
            bundleName: bundleName,
            abilityName: 'EntryAbility'
          }
          // 拉起被测应用
          await delegator.startAbility(want);
          // 等待应用拉起完成
          await driver.waitForIdle(4000, 5000);
          // 确认当前应用顶部Ability为指定的ability
          const ability: UIAbility = await delegator.getCurrentTopAbility();
          expect(ability.context.abilityInfo.name).assertEqual('EntryAbility');
    
          // 依据指定文本“Next”查找目标控件
          const next = await driver.findComponent(ON.text('Next'));
          // 点击目标控件
          await next.click();
          await driver.waitForIdle(4000, 5000);
          // 通过断言文本为“after click”的控件存在，确认操作后页面变化符合预期
          await driver.assertComponentExist(ON.text('after click'));
          await driver.pressBack();
          done();
        })
      })
    }
    ```
    

#### 控件查找与操作

UITest支持依据多种属性构造匹配器进行控件查找；支持查找当前页面符合匹配条件的单个或多个目标控件，并返回控件对象；支持在滚动组件内部进行滚动查找目标控件；支持对控件对象进行操作或获取控件的属性信息。

如下给出控件查找与操作的示例，下面代码执行前请参考UI测试示例，实现对应的Index.ets页面代码。

```
import { describe, it, TestType } from '@ohos/hypium';
// 导入测试依赖kit
import { Component, Driver, ON, On } from '@kit.TestKit';

export default function abilityTest() {
  describe('componentOperationTest', () => {
    /**
     * 查找类型为'Button'的控件，并进行控件点击操作
     */
    it('componentSearchAndOperation', TestType.FUNCTION, async () => {
      let driver: Driver = Driver.create();
      await driver.delayMs(1000);
      let button: Component = await driver.findComponent(ON.type('Button'));
      await button.click();
    })

    /**
     * 利用相对位置查找控件，查找'Scroll'类型控件中文本内容为'123'的控件
     */
    it('relativePositioncomponentSearch', TestType.FUNCTION, async () => {
      let driver: Driver = Driver.create();
      let on: On = ON.text('123').within(ON.type('Scroll'));
      let items: Array<Component> = await driver.findComponents(on);
    })

    /**
     * 查找类型为'Image'的控件，并进行对其进行双指放大操作
     */
    it('componentPinch', TestType.FUNCTION, async () => {
      let driver: Driver = Driver.create();
      let image: Component = await driver.findComponent(ON.type('Image'));
      await image.pinchOut(1.5);
    })
  })
}
```

#### 模拟触摸屏手指操作

UITest支持模拟包括点击、双击、长按、滑动、拖拽、多指操作等事件。

如下给出触摸屏坐标级的手指操作模拟的示例，下面代码执行前请参考UI测试示例，实现对应的Index.ets页面代码。

```
import { describe, it, Level, Size, TestType } from '@ohos/hypium';
// 导入测试依赖kit
import { Driver, PointerMatrix, UiDirection } from '@kit.TestKit';

export default function abilityTest() {
  describe('touchScreen_sample', () => {
    /**
     * 基于坐标的触摸屏手指操作
     */
    it('touchScreenOperation', TestType.FUNCTION, async () => {
      let driver: Driver = Driver.create();
      // 单击
      await driver.click(100, 100);
      // 指定屏幕id进行单击，从API version 20开始支持
      await driver.clickAt({ x: 100, y: 100, displayId: 0 });
      // 滑动
      await driver.swipe(100, 100, 200, 200, 600);
      // 指定屏幕id进行滑动，从API version 20开始支持
      await driver.swipeBetween({ x: 100, y: 100, displayId: 0 }, { x: 1000, y: 1000, displayId: 0 }, 800);
      // 抛滑
      await driver.fling({ x: 100, y: 100 }, { x: 200, y: 200 }, 5, 600);
      // 指定方向的抛滑
      await driver.fling(UiDirection.DOWN, 10000);
      // 拖拽
      await driver.drag(100, 100, 200, 200, 600);
      // 指定屏幕id和拖拽移动前的长按时间，从API version 20开始支持
      await driver.dragBetween({ x: 100, y: 100, displayId: 0 }, { x: 1000, y: 1000, displayId: 0 }, 800, 1500);
      // 多指操作，指定使用两根手指，每根手指基于两个坐标点滑动
      let pointers: PointerMatrix = PointerMatrix.create(2, 2);
      pointers.setPoint(0, 0, { x: 100, y: 100 });
      pointers.setPoint(0, 1, { x: 200, y: 100 });
      pointers.setPoint(1, 0, { x: 100, y: 200 });
      pointers.setPoint(1, 1, { x: 200, y: 200 });
      await driver.injectMultiPointerAction(pointers);
    })
  })
}
```

#### 页面加载等待

在与页面进行交互后，可通过在指定时间内等待某控件的出现或等待页面空闲来判断页面跳转是否完成。

如下给出页面加载等待的示例，下面代码执行前请参考UI测试示例，实现对应的Index.ets页面代码。

```
import { describe, it, Level, Size, TestType } from '@ohos/hypium';
// 导入测试依赖kit
import { abilityDelegatorRegistry, Driver, ON } from '@kit.TestKit';

const delegator: abilityDelegatorRegistry.AbilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
// 指定被测应用包名、ability名，请开发者替换为被测应用包名和ability名
const bundleName: string = 'com.uitestScene.acts';
const abilityName: string = 'com.uitestScene.acts.MainAbility';

export default function abilityTest() {
  describe('waitForComp_sample', () => {
    it('testWaitForComponent_static', TestType.FUNCTION | Size.MEDIUMTEST | Level.LEVEL3,
      async (done: Function): Promise<void> => {
        let driver = Driver.create();
        // 拉起目标应用
        await delegator.executeShellCommand(`aa start -b ${bundleName} -a ${abilityName}`).then(result => {
        }).catch((err: Error) => {
          done();
        })
        // 通过等待目标应用首页上的指定控件出现，判断应用拉起完成
        let button = await driver.waitForComponent(ON.text('StartAbility Success!'), 1000);
      })
  })
}
```

#### 模拟文本输入

UITest支持向指定坐标点或指定控件输入文本内容，同时支持指定输入方式：输入文本时是否以复制粘贴方式输入、是否以追加的方式进行输入。

如下给出文本输入的示例，包括基于控件的文本输入和基于坐标的文本输入两种方式。下面代码执行前请参考UI测试示例，实现对应的Index.ets页面代码。

```
import { describe, it, Level, Size, TestType } from '@ohos/hypium';
// 导入测试依赖kit
import { Driver, ON } from '@kit.TestKit';

export default function abilityTest() {
  describe('inputTextTest', () => {
    /**
     * 基于控件的文本输入，调用接口会默认清空文本框中内容后输入指定文本
     * 当输入文本中不包含中文、特殊字符，且文本长度不超过200字符时默认为逐字键入
     */
    it('componentInputText', TestType.FUNCTION, async () => {
      let driver = Driver.create();
      let input = await driver.findComponent(ON.type('TextInput'));
      await input.inputText('abc');
    })
    /**
     * 基于控件的文本输入，指定以复制粘贴方式注入输入指定文本
     * 指定以追加方式输入，即在输入文本签不清空原有内容
     */
    it('componentInputTextAddition', TestType.FUNCTION, async () => {
      let driver = Driver.create();
      let input = await driver.findComponent(ON.type('TextInput'));
      // 该接口从API version 20开始支持
      await input.inputText('abc', { paste: true, addition: true });
    })

    /**
     * 基于坐标的文本输入，点击指定位置使输入框获焦，并在光标处输入指定文本
     * 当输入文本中不包含中文、特殊字符，且文本长度不超过200字符时默认为逐字键入
     */
    it('pointInputText', TestType.FUNCTION | Size.MEDIUMTEST | Level.LEVEL3, async () => {
      let driver = Driver.create();
      let input = await driver.findComponent(ON.type('TextInput'));
      let center = await input.getBoundsCenter();
      await driver.inputText(center, 'abc');
    })

    /**
     * 基于坐标的文本输入，指定以复制粘贴方式注入输入指定文本
     * 指定以追加方式输入，即点击指定位置使输入框获焦后将光标移动至原有文本末尾后输入
     */
    it('pointInputTextAddition', TestType.FUNCTION | Size.MEDIUMTEST | Level.LEVEL3, async () => {
      let driver = Driver.create();
      let input = await driver.findComponent(ON.type('TextInput'));
      let center = await input.getBoundsCenter();
      // 该接口从API version 20开始支持
      await driver.inputText(center, '123', { paste: true, addition: true });
    })

    /**
     * 基于坐标的文本输入，指定以复制粘贴方式注入输入指定文本
     * 指定以追加方式输入，即点击指定位置使输入框获焦后将光标移动至原有文本末尾后输入
     * 当输入内容包含中文或特殊字符时，仅支持以复制粘贴方式输入文本，'paste'字段不生效
     */
    it('pointInputTextChinese', TestType.FUNCTION | Size.MEDIUMTEST | Level.LEVEL3, async () => {
      let driver = Driver.create();
      let input = await driver.findComponent(ON.type('TextInput'));
      let center = await input.getBoundsCenter();
      // 该接口从API version 20开始支持
      await driver.inputText(center, '你好', { paste: false, addition: true });
    })
  })
}
```

#### 截图

1.  指定截图文件保存路径，路径需为当前应用的沙箱路径。
2.  测试HAP的APL等级级别为normal，对应要求使用用户级加密区的应用沙箱路径。且需指定将文件保存在应用在本设备上存放持久化数据的子目录。

如下给出屏幕截图的示例，指定屏幕id和截取屏幕区域，并将截图保存到指定路径下。下面代码执行前请参考UI测试示例，实现对应的Index.ets页面代码。多屏场景下，期望对指定屏幕做截图操作时，可以调用display模块的接口获取Display对象，实现屏幕相关属性获取。

```
import { describe, it, Level, Size, TestType } from '@ohos/hypium';
// 导入测试依赖kit
import { Driver } from '@kit.TestKit';
import { display } from '@kit.ArkUI';

export default function abilityTest() {
  describe('screenCap_sample', () => {
    /**
     * 截取指定区域的屏幕，并保存到指定路径
     */
    it('screenCapture', TestType.FUNCTION, async () => {
      let driver = Driver.create();
      // 应用沙箱路径，el2为用户级加密区，base为应用在本设备上存放持久化数据的子目录
      // 请开发者使用时替换为实际的路径
      let savePath = '/data/storage/el2/base/cache/1.png';
      let res = await driver.screenCapture(savePath, {
        left: 0,
        top: 0,
        right: 100,
        bottom: 100
      });
    })

    /**
     * 截取指定屏幕id的屏幕全屏，并保存到指定路径
     */
    it('screenCapWithId', TestType.FUNCTION | Size.MEDIUMTEST | Level.LEVEL3, async () => {
      let driver = Driver.create();
      // 获取默认屏幕对象
      let disPlay = display.getDefaultDisplaySync();
      let savePath = '/data/storage/el2/base/cache/1.png';
      // 从API version 20开始支持
      let res = await driver.screenCap(savePath, disPlay.id); // 获取默认屏幕ID属性
    })
  })
}
```

#### UI事件监听

如下给出UI界面事件的监听的示例，设置监听回调函数，监听toast、dialog等控件的出现，等待事件发生后进行下一步操作。下面代码执行前请参考UI测试示例，实现对应的Index.ets页面代码。

```
import { describe, it, TestType } from '@ohos/hypium';
// 导入测试依赖kit
import { Driver, UIElementInfo } from '@kit.TestKit';

export default function abilityTest() {
  describe('eventObserver_sample', () => {
    // 监听Toast控件出现
    it('toastObserver', TestType.FUNCTION, async () => {
      let driver = Driver.create();
      let observer = driver.createUIEventObserver();
      let callback = (uiElementInfo: UIElementInfo) => {
        let bundleName = uiElementInfo.bundleName;
        let text = uiElementInfo.text;
        let type = uiElementInfo.type;
      }
      observer.once('toastShow', callback);
    })
  })
}
```

#### 模拟键鼠操作

如下给出键鼠模拟操作，包括键盘按键、组合键输入操作的示例，包括鼠标点击、移动、拖拽操作和键鼠组合操作等。下面代码执行前请参考UI测试示例，实现对应的Index.ets页面代码。

```
import { describe, it, Level, Size, TestType } from '@ohos/hypium';
// 导入测试依赖kit
import { Driver, MouseButton } from '@kit.TestKit';
import { KeyCode } from '@kit.InputKit';

export default function abilityTest() {
  describe('mouseAndKey_sample', () => {
    // 模拟键盘按键输入、组合键输入
    it('keyBoardOperation', TestType.FUNCTION | Size.MEDIUMTEST | Level.LEVEL3, async () => {
      let driver = Driver.create();
      // 键盘按键输入（注入返回键）
      await driver.triggerKey(KeyCode.KEYCODE_BACK);
      // 键盘组合键输入（注入保存组合键）
      await driver.triggerCombineKeys(KeyCode.KEYCODE_CTRL_LEFT, KeyCode.KEYCODE_S);
    })

    // 模拟鼠标左键单击、鼠标移动、鼠标拖拽操作
    it('mouseOperation', TestType.FUNCTION | Size.MEDIUMTEST | Level.LEVEL3, async () => {
      let driver = Driver.create();
      // 鼠标左键单击
      await driver.mouseClick({ x: 100, y: 100 }, MouseButton.MOUSE_BUTTON_LEFT);
      // 鼠标移动
      await driver.mouseMoveTo({ x: 100, y: 100 });
      // 鼠标拖拽
      await driver.mouseDrag({ x: 100, y: 100 }, { x: 200, y: 200 }, 600);
    })

    // 模拟键盘、鼠标组合操作
    it('combinedOperation', TestType.FUNCTION | Size.MEDIUMTEST | Level.LEVEL3, async () => {
      let driver = Driver.create();
      // 按下左CTRL键，同时鼠标滚轮滚动
      await driver.mouseScroll({ x: 100, y: 100 }, true, 30, KeyCode.KEYCODE_CTRL_LEFT);
      // 按下左CTRL键，同时鼠标左键长按
      await driver.mouseLongClick({ x: 100, y: 100 }, MouseButton.MOUSE_BUTTON_LEFT, KeyCode.KEYCODE_CTRL_LEFT);
    })
  })
}
```

#### 窗口查找与操作

如下给出窗口查找和操作的示例，根据窗口属性查找窗口，并进行窗口最小化等操作。下面代码执行前请参考UI测试示例，实现对应的Index.ets页面代码。

```
import { describe, expect, it, TestType } from '@ohos/hypium';
// 导入测试依赖kit
import { Driver } from '@kit.TestKit';

// 设备不支持时的错误代码
const DeviceErrorCode = 17000005;

export default function abilityTest() {
  describe('findWindowAndOp_sample', () => {
    // 根据指定条件查找活跃窗口，并对其进行窗口最小化操作
    it('windowSearchAndOperation', TestType.FUNCTION, async () => {
      let driver = Driver.create();
      try {
        let window = await driver.findWindow({ active: true });
        await window.minimize();
      } catch (error) {
        // 在不支持窗口操作的设备上调用minimize接口操作窗口时，将抛出17000005错误码
        expect(error.code).assertEqual(DeviceErrorCode);
      }
    })
  })
}
```

#### 模拟触摸板操作

如下给出触摸板模拟操作的示例，触摸板三指上滑返回桌面，三指下滑恢复应用窗口。下面代码执行前请参考UI测试示例，实现对应的Index.ets页面代码。

```
import { describe, expect, it, Level, Size, TestType } from '@ohos/hypium';
// 导入测试依赖kit
import { Driver, UiDirection } from '@kit.TestKit';

// 设备不支持时的错误代码
const DeviceErrorCode = 17000005;

export default function abilityTest() {
  describe('touchPadOp_sample', () => {
    // PC/2in1场景，模拟触摸板三指上滑（界面返回桌面），三指下滑（界面恢复窗口）操作
    it('touchPadOperation', TestType.FUNCTION | Size.MEDIUMTEST | Level.LEVEL3, async () => {
      let driver = Driver.create();
      try {
        // 触摸板三指上滑返回桌面
        await driver.touchPadMultiFingerSwipe(3, UiDirection.UP);
        // 触摸板三指下滑恢复窗口
        await driver.touchPadMultiFingerSwipe(3, UiDirection.DOWN);
      } catch (error) {
        // 在不支持触摸板操作的设备上调用时，将抛出17000005错误码
        expect(error.code).assertEqual(DeviceErrorCode);
      }
    })
  })
}
```

#### 模拟手写笔操作

如下给出手写笔模拟操作，包括点击、滑动等操作的示例，支持设置操作时的压力值大小。下面代码执行前请参考UI测试示例，实现对应的Index.ets页面代码。

```
import { describe, it, Level, Size, TestType } from '@ohos/hypium';
// 导入测试依赖kit
import { Driver } from '@kit.TestKit';

export default function abilityTest() {
  describe('penOp_sample', () => {
    // 模拟手写笔单击、双击、长按、滑动操作
    it('penOperation', TestType.FUNCTION | Size.MEDIUMTEST | Level.LEVEL3, async () => {
      let driver = Driver.create();
      // 手写笔单击
      await driver.penClick({ x: 100, y: 100 });
      // 手写笔双击
      await driver.penDoubleClick({ x: 100, y: 100 });
      // 手写笔长按
      await driver.penLongClick({ x: 100, y: 100 }, 0.5);
      // 手写笔滑动
      await driver.penSwipe({ x: 100, y: 100 }, { x: 100, y: 500 }, 600, 0.5);
    })
  })
}
```

#### 模拟表冠操作

如下给出表冠模拟操作的示例，包括表冠的顺/逆时针旋转。下面代码执行前请参考UI测试示例，实现对应的Index.ets页面代码。

```
import { describe, expect, it, Level, Size, TestType } from '@ohos/hypium';
// 导入测试依赖kit
import { Driver } from '@kit.TestKit';

// 设备不支持时的错误代码
const CapabilityCode = 801;

export default function abilityTest() {
  describe('watchOp_sample', () => {
    // 手表场景，模拟表冠顺/逆时针旋转，从API version 20开始支持
    it('crownRotate', TestType.FUNCTION | Size.MEDIUMTEST | Level.LEVEL3, async () => {
      let driver = Driver.create();
      try {
        // 顺时针旋转50格，旋转速度为30格/秒
        await driver.crownRotate(50, 30);
        // 逆时针旋转20格，旋转速度为30格/秒
        await driver.crownRotate(-20, 30);
      } catch (error) {
        // driver.crownRotate接口仅在智能表设备上生效，其他设备调用时将抛出801错误码
        expect(error.code).assertEqual(CapabilityCode);
      }
    })
  })
}
```

#### 屏幕显示操作

如下给出屏幕显示操作的示例，包括获取屏幕大小、分辨率等属性和屏幕唤醒、屏幕旋转等操作。下面代码执行前请参考UI测试示例，实现对应的Index.ets页面代码。

```
import { describe, it, Level, Size, TestType } from '@ohos/hypium';
// 导入测试依赖kit
import { DisplayRotation, Driver, Point } from '@kit.TestKit';

export default function abilityTest() {
  describe('displayOp_sample', () => {
    // 屏幕属性获取和屏幕操作
    it('displayOperation', TestType.FUNCTION | Size.MEDIUMTEST | Level.LEVEL3, async () => {
      let driver = Driver.create();
      // 获取屏幕大小
      let size: Point = await driver.getDisplaySize();
      // 获取屏幕清晰度
      let density: Point = await driver.getDisplayDensity();
      // 唤醒屏幕
      await driver.wakeUpDisplay();
      // 屏幕顺时针旋转90度
      await driver.setDisplayRotation(DisplayRotation.ROTATION_90);
    })
  })
}
```

#### 基于命令行进行UI测试

在开发阶段，如果需要快速执行截图、界面操作录制、UI模拟操作注入、控件树获取等测试相关操作，可借助命令行实现，提升测试效率。

#### 环境要求

根据hdc命令行工具指导，完成环境准备。确保设备已成功连接，并执行hdc shell。

#### 命令列表

| 命令 | 参数 | 说明 |
| --- | --- | --- |
| help | - | 显示UITest工具能够支持的命令信息。 |
| screenCap | [-p] [-d] | 截图。 各参数代表的含义请参考获取截图。 |
| dumpLayout | [-p] <-i \| -a \| -b \| -w \| -m \| -d> | 获取控件树。 各参数代表的含义请参考获取控件树。 |
| uiRecord | <record \| read> | 录制界面操作。 record ：开始录制，将当前界面操作记录到'/data/local/tmp/record.csv'，结束录制操作使用Ctrl+C结束录制。 read ：读取并且打印录制数据。 各参数代表的含义请参考录制界面操作。 |
| uiInput | <help \| click \| doubleClick \| longClick \| fling \| swipe \| drag \| dircFling \| inputText \| keyEvent \| text> | 注入UI模拟操作。 各参数代表的含义请参考注入UI模拟操作。 |
| --version | - | 获取当前UITest工具版本信息。 |
| start-daemon | - | 拉起UITest测试进程。 |

#### 获取截图

| 参数 | 二级参数 | 说明 |
| --- | --- | --- |
| -p | <savePath> | 指定存储路径和文件名，只支持存放在'/data/local/tmp/'下。默认存储路径：'/data/local/tmp'，文件名：'时间戳 + .png'。 |
| -d | <displayId> | 多屏场景下，获取指定ID屏幕下的截图。 说明： 从API version 20开始支持该命令。 |

```
# 存储路径：/data/local/tmp，文件名：时间戳 + .png。
hdc shell uitest screenCap
# 指定存储路径和文件名，存放在/data/local/tmp/下。
hdc shell uitest screenCap -p /data/local/tmp/1.png
```

#### 获取控件树

| 参数 | 二级参数 | 说明 |
| --- | --- | --- |
| -p | <savePath> | 指定存储路径和文件名，只支持存放在'/data/local/tmp/'下。默认存储路径：'/data/local/tmp'，文件名：'时间戳 + .json'。 |
| -i | - | 不过滤不可见控件，也不做窗口合并。 |
| -a | - | 保存控件的BackgroundColor、Content、FontColor、FontSize、extraAttrs属性数据。 说明 ：默认不保存上述属性数据， -a和-i不可同时使用。 |
| -b | <bundleName> | 获取指定包名对应目标窗口的控件树信息。 |
| -w | <windowId> | 获取指定ID目标窗口的控件树信息。 说明： 可通过hidumper工具获取应用窗口信息, 包含应用对应窗口的id。 |
| -m | <true\|false> | 指定在获取控件树信息时是否合并窗口信息。true表示合并窗口信息，false表示不合并窗口信息，不设置时默认为true。 |
| -d | <displayId> | 多屏场景下，获取指定ID屏幕下的控件树。 说明： 1. 从API version 20开始支持该命令。 2. 可通过hidumper工具获取应用窗口信息，包含应用对应窗口的DisplayId。 |

```
# 指定存储路径和文件名，存放在/data/local/tmp/下。
hdc shell uitest dumpLayout -p /data/local/tmp/1.json
```

#### 录制界面操作

录制过程中，需等待当前操作的识别结果在命令行输出后，再进行下一步操作。

**参数列表**

| 参数 | 二级参数 | 说明 |
| --- | --- | --- |
| -W | <true/false> | 录制过程中是否保存操作坐标对应的控件信息到/data/local/tmp/record.csv文件中。true表示保存控件信息，false表示仅记录坐标信息，不设置时默认为true。 说明： 从API version 20开始支持该命令。 |
| -l | - | 在每次操作后保存当前布局信息，文件保存路径：/data/local/tmp/layout_录制启动时间戳_操作序号.json。 说明： 从API version 20开始支持该命令。 |
| -c | <true/false> | 是否将录制到的操作事件信息打印到控制台，true表示打印，false表示不打印，不设置时默认为true。 说明： 从API version 20开始支持该命令。 |

```
# 将当前界面操作记录到/data/local/tmp/record.csv，结束录制操作使用Ctrl+C结束录制。
hdc shell uitest uiRecord record
# 录制时仅记录操作的坐标，不匹配目标控件。
hdc shell uitest uiRecord record -W false
# 每次操作后，保存页面布局，文件保存路径：/data/local/tmp/layout_录制启动时间戳_操作序号.json。
hdc shell uitest uiRecord record -l
# 录制到的操作事件信息不打印到控制台。
hdc shell uitest uiRecord record -c false
# 读取并打印录制数据。
hdc shell uitest uiRecord read
```

录制数据中字段及含义如下。

```
{
  "ABILITY": "com.ohos.launcher.MainAbility", // 被操作应用对应的Ability名称
  "BUNDLE": "com.ohos.launcher", // 被操作应用对应的包名
  "CENTER_X": "", // 预留字段，暂未使用
  "CENTER_Y": "", // 预留字段，暂未使用
  "EVENT_TYPE": "pointer", // 操作类型
  "LENGTH": "0", // 总体步长
  "OP_TYPE": "click", // 事件类型，当前支持点击、双击、长按、拖拽、滑动、抛滑动作录制
  "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}", // 起点控件边界
    "W1_HIER": "ROOT,3,0,0,0,0,0,0,0,0,5,0,0,0,0,0,0,0", // 起点控件页面层级
    "W1_ID": "", // 起点控件id
    "W1_Text": "", // 起点控件text
    "W1_Type": "Image", // 起点控件类型
    "W2_BOUNDS": "{"bottom":361,"left":37,"right":118,"top":280}", // 终点控件边界
    "W2_HIER": "ROOT,3,0,0,0,0,0,0,0,0,5,0,0,0,0,0,0,0", // 终点控件页面层级
    "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" // 手指数量
}
```

#### 注入UI模拟操作

| 参数 | 说明 |
| --- | --- |
| help | uiInput命令相关帮助信息。 |
| click | 模拟单击操作。具体请参考下方uiInput-click/doubleClick/longClick使用示例。 |
| doubleClick | 模拟双击操作。具体请参考下方uiInput click/doubleClick/longClick使用示例。 |
| longClick | 模拟长按操作。具体请参考下方uiInput click/doubleClick/longClick使用示例。 |
| fling | 模拟快滑操作，即操作结束后页面存在惯性滚动。具体请参考下方uiInput fling使用示例。 |
| swipe | 模拟慢滑操作。具体请参考下方uiInput swipe/drag使用示例。 |
| drag | 模拟拖拽操作。具体请参考下方uiInput swipe/drag使用示例。 |
| dircFling | 模拟指定方向滑动操作。具体请参考下方uiInput dircFling使用示例。 |
| inputText | 指定坐标点，模拟输入框输入文本操作。具体请参考下方uiInput inputText使用示例。 |
| text | 无需指定坐标点，在当前获焦处，模拟输入框输入文本操作。具体请参考下方uiInput text使用示例。 说明： 从API version 18开始支持该命令。 |
| keyEvent | 模拟实体按键事件（如：键盘，电源键，返回上一级，返回桌面等），以及组合按键操作。具体请参考下方uiInput keyEvent使用示例。 |

*   uiInput-click/doubleClick/longClick使用示例

| 参数 | 必填 | 说明 |
| --- | --- | --- |
| point_x | 是 | 点击x坐标点。 |
| point_y | 是 | 点击y坐标点。 |

```
# 执行单击事件。
hdc shell uitest uiInput click 100 100

# 执行双击事件。
hdc shell uitest uiInput doubleClick 100 100

# 执行长按事件。
hdc shell uitest uiInput longClick 100 100
```

*   uiInput fling使用示例

| 参数 | 必填 | 说明 |
| --- | --- | --- |
| from_x | 是 | 滑动起点x坐标。 |
| from_y | 是 | 滑动起点y坐标。 |
| to_x | 是 | 滑动终点x坐标。 |
| to_y | 是 | 滑动终点y坐标。 |
| swipeVelocityPps_ | 否 | 滑动速度，单位：px/s，取值范围：200-40000。 默认值：600。取值超出限定范围时，取默认值。 |
| stepLength_ | 否 | 滑动步长，单位：px。默认值：滑动距离/50。 说明： 滑动距离根据入参给出的滑动起止坐标点计算得出。 为实现更好的模拟效果，推荐参数缺省/使用默认值。 |

```
# 执行快滑操作，stepLength_缺省。
hdc shell uitest uiInput fling 10 10 200 200 500
```

*   uiInput swipe/drag使用示例

| 参数 | 必填 | 说明 |
| --- | --- | --- |
| from_x | 是 | 滑动起点x坐标。 |
| from_y | 是 | 滑动起点y坐标。 |
| to_x | 是 | 滑动终点x坐标。 |
| to_y | 是 | 滑动终点y坐标。 |
| swipeVelocityPps_ | 否 | 滑动速度，单位：px/s，取值范围：200-40000。 默认值：600。取值超出限定范围时，取默认值。 |

```
# 执行慢滑操作。
hdc shell uitest uiInput swipe 10 10 200 200 500

# 执行拖拽操作。
hdc shell uitest uiInput drag 10 10 100 100 500
```

*   uiInput dircFling使用示例

| 参数 | 必填 | 说明 |
| --- | --- | --- |
| direction | 否 | 滑动方向，取值范围：[0,1,2,3]，默认值为0。 0代表向左滑动，1代表向右滑动，2代表向上滑动，3代表向下滑动。 |
| swipeVelocityPps_ | 否 | 滑动速度，单位：px/s，取值范围：200-40000。 默认值: 600。取值超出限定范围时，取默认值。 |
| stepLength | 否 | 滑动步长，单位：px。 默认值： 如果滑动方向为0、1，默认值为屏幕宽度/200； 如果滑动方向为2、3，默认值为屏幕高度/200。为更好的模拟效果，推荐参数缺省/使用默认值。 |

```
# 执行左滑操作。
hdc shell uitest uiInput dircFling 0 500
# 执行向右滑动操作。
hdc shell uitest uiInput dircFling 1 600
# 执行向上滑动操作。
hdc shell uitest uiInput dircFling 2
# 执行向下滑动操作。
hdc shell uitest uiInput dircFling 3
```

*   uiInput inputText使用示例

| 参数 | 必填 | 说明 |
| --- | --- | --- |
| point_x | 是 | 输入框x坐标点。 |
| point_y | 是 | 输入框y坐标点。 |
| text | 是 | 输入文本内容。 |

```
# 执行输入框输入操作。
hdc shell uitest uiInput inputText 100 100 hello
```

*   uiInput text使用示例

| 参数 | 必填 | 说明 |
| --- | --- | --- |
| text | 是 | 输入文本内容。 |

```
# 无需输入坐标点，在当前获焦处，执行输入框输入操作。若当前获焦处不支持文本输入，则无实际效果。
hdc shell uitest uiInput text hello
```

*   uiInput keyEvent使用示例

| 参数 | 必填 | 说明 |
| --- | --- | --- |
| keyID1 | 是 | 实体按键对应ID，取值范围：Back、Home、Power、或KeyCode键码值。 当取值为Back、Home或Power时，不支持输入组合键。 当前注入大写锁定键（KeyCode=2074）无效，请使用组合键实现大写字母输入。如“按键shift+按键V”输入大写字母V。 |
| keyID2 | 否 | 实体按键对应ID，取值范围：KeyCode键码值，默认值为空。 |
| keyID3 | 否 | 实体按键对应ID，取值范围：KeyCode键码值，默认值为空。 |

```
# 返回主页。
hdc shell uitest uiInput keyEvent Home
# 返回。
hdc shell uitest uiInput keyEvent Back
# 组合键粘贴。
hdc shell uitest uiInput keyEvent 2072 2038
# 输入小写字母v。
hdc shell uitest uiInput keyEvent 2038
# 输入大写字母V。
hdc shell uitest uiInput keyEvent 2047 2038
```

#### 获取版本信息

```
hdc shell uitest --version
```

#### 拉起UITest测试进程

仅元能力aa test拉起的测试HAP才能调用UITest的能力，且测试HAP的APL等级级别需为normal。

```
hdc shell uitest start-daemon
```

#### 常见问题

#### 失败日志有“uitest-api does not allow calling concurrently”错误信息

**问题描述**

UI测试用例执行失败，查看hilog日志发现日志中有“uitest-api does not allow calling concurrently”错误信息。

**可能原因**

1.  用例中UI测试框架提供异步接口没有增加await语法糖调用。
2.  多进程执行UI测试用例，导致拉起多个UITest进程，框架不支持多进程调用。

**解决方法**

1.  检查用例实现，异步接口增加await语法糖调用。
2.  避免多进程执行UI测试用例。

#### 失败日志有“does not exist on current UI! Check if the UI has changed after you got the widget object”错误信息

**问题描述**

UI测试用例执行失败，查看hilog日志发现日志中有“does not exist on current UI! Check if the UI has changed after you got the widget object”错误信息。

**可能原因**

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

**解决方法**

重新执行UI测试用例，确保进行模拟操作时控件在界面中存在。

#### 失败日志有“Cannot connect to AAMS, RET\_ERR\_CONNECTION\_EXIST”错误信息

**问题描述**

UI测试用例执行失败，查看hilog日志发现日志中有“Cannot connect to AAMS, RET\_ERR\_CONNECTION\_EXIST”错误信息。

**可能原因**

在用例执行的同时使用了其他依赖UI测试框架运行的测试工具。

**解决方法**

关闭依赖UI测试框架运行的测试工具或重启设备。