arkXtest User Guide

Overview

arkXtest is an automated test framework that consists of JsUnit and UiTest.
JsUnit is a unit test framework that provides basic APIs for compiling test cases and generating test reports for testing system and application APIs.
UiTest is a UI test framework that provides the UI component search and operation capabilities through simple and easy-to-use APIs, and allows you to develop automated test scripts based on GUI operations.
This document will help to familiarize you with arkXtest, describing its main functions, implementation principles, environment setup, and test script compilation and execution. In addition, the shell commands are provided for the following features: obtaining screenshots, component trees, recording user operations, and conveniently injecting UI simulation operations, which facilitates testing and verification.

Implementation

arkXtest is divided into two parts: unit test framework and UI test framework.
As the backbone of arkXtest, the unit test framework offers such features as identifying, scheduling, and executing test scripts, as well as summarizing test script execution results.
The UI test framework provides UiTest APIs for you to call in different test scenarios. Its test scripts are executed on top of the unit test framework.

Unit Test Framework

Figure 1 Main functions of the unit test framework

Figure 2 Basic script process

UI Test Framework

Figure 3 Main functions of the UI test framework

Compile and Execute Tests Based on ArkTS

Setting Up the Environment

Download DevEco Studio and set it up as instructed on the official website.

Creating and Compiling a Test Script

Creating a Test Script

1. Open DevEco Studio and create a project, in which the ohos directory is where the test script is located.

2. Open the .ets file of the module to be tested in the project directory. Move the cursor to any position in the code, and then right-click and choose Show Context Actions > Create Ohos Test or press Alt+Enter and choose Create Ohos Test to create a test class. For more details, see DevEco Studio User Guide.

Writing a Unit Test Script

This section describes how to use the unit test framework to write a unit test script. For details about the functionality of the unit test framework, see arkXtest.

The unit test script must contain the following basic elements:

1. Import of the dependencies so that the dependent test APIs can be used.

2. Test code, mainly about the related logic, such as API invoking.

3. Invoking of the assertion APIs and setting of checkpoints. If there is no checkpoint, the test script is considered as incomplete.

The following sample code is used to start the test page to check whether the page displayed on the device is the expected page.

import { describe, it, expect } from '@ohos/hypium';
import { abilityDelegatorRegistry } from '@kit.TestKit';
import { UIAbility, Want } from '@kit.AbilityKit';

const delegator = abilityDelegatorRegistry.getAbilityDelegator()
const bundleName = abilityDelegatorRegistry.getArguments().bundleName;
function sleep(time: number) {
  return new Promise<void>((resolve: Function) => setTimeout(resolve, time));
}
export default function abilityTest() {
  describe('ActsAbilityTest', () =>{
    it('testUiExample',0, async (done: Function) => {
      console.info("uitest: TestUiExample begin");
      //start tested ability
      const want: Want = {
        bundleName: bundleName,
        abilityName: 'EntryAbility'
      }
      await delegator.startAbility(want);
      await sleep(1000);
      // Check the top display ability.
      const ability: UIAbility = await delegator.getCurrentTopAbility();
      console.info("get top ability");
      expect(ability.context.abilityInfo.name).assertEqual('EntryAbility');
      done();
    })
  })
}

Writing a UI Test Script

To write a UI test script to complete the corresponding test activities, simply add the invoking of the UiTest API to a unit test script. For details about the available APIs, see @ohos.UiTest.
In this example, the UI test script is written based on the preceding unit test script. It implements the click operation on the started application page and checks whether the page changes as expected.

1. Write the demo code in the index.etsfile.

  @Entry
  @Component
  struct Index {
    @State message: string = 'Hello World'

    build() {
      Row() {
        Column() {
          Text(this.message)
            .fontSize(50)
            .fontWeight(FontWeight.Bold)
          Text("Next")
            .fontSize(50)
            .margin({top:20})
            .fontWeight(FontWeight.Bold)
          Text("after click")
            .fontSize(50)
            .margin({top:20})
            .fontWeight(FontWeight.Bold)
        }
        .width('100%')
      }
      .height('100%')
    }
  }

1. Write test code in the .test.ets file under ohosTest > ets > test.

  import { describe, it, expect } from '@ohos/hypium';
  // Import the test dependencies.
  import { abilityDelegatorRegistry, Driver, ON } from '@kit.TestKit';
  import { UIAbility, Want } from '@kit.AbilityKit';

  const delegator: abilityDelegatorRegistry.AbilityDelegator = abilityDelegatorRegistry.getAbilityDelegator()
  const bundleName = abilityDelegatorRegistry.getArguments().bundleName;
  function sleep(time: number) {
    return new Promise<void>((resolve: Function) => setTimeout(resolve, time));
  }
  export default function abilityTest() {
    describe('ActsAbilityTest', () => {
       it('testUiExample',0, async (done: Function) => {
          console.info("uitest: TestUiExample begin");
          //start tested ability
          const want: Want = {
             bundleName: bundleName,
             abilityName: 'EntryAbility'
          }
          await delegator.startAbility(want);
          await sleep(1000);
          // Check the top display ability.
          const ability: UIAbility = await delegator.getCurrentTopAbility();
          console.info("get top ability");
          expect(ability.context.abilityInfo.name).assertEqual('EntryAbility');
          // UI test code
          // Initialize the driver.
          const driver = Driver.create();
          await driver.delayMs(1000);
          // Find the button on text 'Next'.
          const button = await driver.findComponent(ON.text('Next'));
          // Click the button.
          await button.click();
          await driver.delayMs(1000);
          // Check text.
          await driver.assertComponentExist(ON.text('after click'));
          await driver.pressBack();
          done();
       })
    })
  }

Running the Test Script

In DevEco Studio

To execute the script, you need to connect to a hardware device. You can run a test script in DevEco Studio in any of the following modes:

1. Test package level: All test cases in the test package are executed.

2. Test suite level: All test cases defined in the describe method are executed.

3. Test method level: The specified it method, that is, a single test case, is executed.

Viewing the Test Result

After the test is complete, you can view the test result in DevEco Studio, as shown in the following figure.

Viewing the Test Case Coverage

After the test is complete, you can view the test coverage. For details, see the coverage statistics modes in Code Test.

In the CMD

To run the script, you need to connect to a hardware device, install the application test package on the test device, and run the aa command in the cmd window.

NOTE

Before running commands in the CLI, make sure hdc-related environment variables have been configured.

The table below lists the keywords in aa test commands.

The framework supports multiple test case execution modes, which are triggered by the key-value pair following the -s keyword. The table below lists the available keys and values.

Running Commands

NOTE

Parameter configuration and commands are based on the stage model.

Example 1: Execute all test cases.

 hdc shell aa test -b xxx -m xxx -s unittest OpenHarmonyTestRunner

Example 2: Execute cases in the specified test suites, separated by commas (,).

  hdc shell aa test -b xxx -m xxx -s unittest OpenHarmonyTestRunner -s class s1,s2

Example 3: Execute specified cases in the specified test suites, separated by commas (,).

  hdc shell aa test -b xxx -m xxx -s unittest OpenHarmonyTestRunner -s class testStop#stop_1,testStop1#stop_0

Example 4: Execute all test cases except the specified ones, separated by commas (,).

  hdc shell aa test -b xxx -m xxx -s unittest OpenHarmonyTestRunner -s notClass testStop

Example 5: Execute specified test cases, separated by commas (,).

  hdc shell aa test -b xxx -m xxx -s unittest OpenHarmonyTestRunner -s itName stop_0

Example 6: Set the timeout interval for executing a test case.

  hdc shell aa test -b xxx -m xxx -s unittest OpenHarmonyTestRunner -s timeout 15000

Example 7: Enable break-on-error mode.

  hdc shell aa test -b xxx -m xxx -s unittest OpenHarmonyTestRunner -s breakOnError true

Example 8: Execute test cases of the specified type.

  hdc shell aa test -b xxx -m xxx -s unittest OpenHarmonyTestRunner -s testType function

Example 9: Execute test cases at the specified level.

  hdc shell aa test -b xxx -m xxx -s unittest OpenHarmonyTestRunner -s level 0

Example 10: Execute test cases with the specified size.

  hdc shell aa test -b xxx -m xxx -s unittest OpenHarmonyTestRunner -s size small

Example 11: Execute test cases for a specified number of times.

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

Viewing the Test Result

• During test execution in the CLI, the log information similar to the following is displayed:

  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

• After the commands are executed, the following log information is displayed:

  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

NOTE

When an error occurs in break-on-error mode, check the Ignore and interrupt information.

Executing Tests Based on Shell Commands

During development, you can use shell commands to quickly perform operations such as screenshot capturing, screen recording, UI injection simulation, and component tree obtaining.

NOTE

Before running commands in the CLI, make sure hdc-related environment variables have been configured.

Commands |Command |Parameter|Description | |—————|———————————|———————————| |help |help| Displays the commands supported by the uitest tool. | |screenCap |[-p]|Captures the current screen. This parameter is optional.
The file can be stored only in /data/local/tmp/ by default.
The file name is in the format of Timestamp + .png.| |dumpLayout |[-p] <-i |-a>|Obtains the component tree when the daemon is running.
-p: specifies the path and name of the file, which can be stored only in /data/local/tmp/ by default. The file name is in the format of Timestamp + .json.
-i: disables filtering of invisible components and window merging.
-a: stores the data of the BackgroundColor, Content, FontColor, FontSize and extraAttrs attributes.
The preceding attribute data is not saved by default.
The -a and -i parameters cannot be used at the same time.| |uiRecord |uiRecord <record |read>|Records UI operations.
record: starts recording the operations on the current page to /data/local/tmp/record.csv. To stop recording, press Ctrl+C.
read: Reads and prints recorded data.
For details about the parameters, see Recording User Operations.| |uiInput |<help |click |doubleClick |longClick |fling |swipe |drag |dircFling |inputText |keyEvent>|Injects simulated UI operations.
For details about the parameters, see Injecting Simulated UI Operations. | |–version|–version|Obtains the version information about the current tool. | |start-daemon|start-daemon|Starts the uitest process.|

Example of Capturing Screenshots

# Specify the file name in the format of Timestamp + .png.
hdc shell uitest screenCap
# Save the file in /data/local/tmp/.
hdc shell uitest screenCap -p /data/local/tmp/1.png

Example of Obtaining the Component Tree

hdc shell uitest dumpLayout -p /data/local/tmp/1.json

Recording User Operations

NOTE

During the recording, you should perform the next operation after the recognition result of the current operation is displayed in the command line.

# Record the operations on the current page to **/data/local/tmp/record.csv**. To stop the recording, press **Ctrl+C**.
hdc shell uitest uiRecord record
# Read and print record data.
hdc shell uitest uiRecord read

The following describes the fields in the recording data:

 {
	 "ABILITY": "com.ohos.launcher.MainAbility", // Foreground application page.
	 "BUNDLE": "com.ohos.launcher", // Application.
	 "CENTER_X": "", // Reserved field.
	 "CENTER_Y": "", // Reserved field.
	 "EVENT_TYPE": "pointer", //  
	 "LENGTH": "0", // Total length.
	 "OP_TYPE": "click", // Event type. Currently, click, double-click, long-press, drag, pinch, swipe, and fling types are supported.
	 "VELO": "0.000000", // Hands-off velocity.
	 "direction.X": "0.000000",// Movement along the x-axis.
	 "direction.Y": "0.000000", // Movement along the y-axis.
	 "duration": 33885000.0, // Gesture duration.
	 "fingerList": [{
		 "LENGTH": "0", // Total length.
		 "MAX_VEL": "40000", // Maximum velocity.
		 "VELO": "0.000000", // Hands-off velocity.
		 "W1_BOUNDS": "{"bottom":361,"left":37,"right":118,"top":280}", // Starting component bounds.
		 "W1_HIER": "ROOT,3,0,0,0,0,0,0,0,0,5,0,0,0,0,0,0,0", // Starting component hierarchy.
		 "W1_ID": "", // ID of the starting component.
		 "W1_Text": "", // Text of the starting component.
		 "W1_Type": "Image", // Type of the starting component.
		 "W2_BOUNDS": "{"bottom":361,"left":37,"right":118,"top":280}", // Ending component bounds.
		 "W2_HIER": "ROOT,3,0,0,0,0,0,0,0,0,5,0,0,0,0,0,0,0", // Ending component hierarchy.
		 "W2_ID": "", // ID of the ending component.
		 "W2_Text": "", // Text of the ending component.
		 "W2_Type": "Image", // Type of the ending component.
		 "X2_POSI": "47", // X coordinate of the ending point.
		 "X_POSI": "47", // X coordinate of the starting point.
		 "Y2_POSI": "301", // Y coordinate of the ending point.
		 "Y_POSI": "301", // Y coordinate of the starting point.
		 "direction.X": "0.000000", // Movement along the x-axis.
		 "direction.Y": "0.000000" // Movement along the y-axis.
	 }],
	 "fingerNumber": "1" // Number of fingers.
 }

Injecting Simulated UI Operations

Example of Running the click/doubleClick/longClick Commands

# Execute the click event.
hdc shell uitest uiInput click 100 100

# Execute the double-click event.
hdc shell uitest uiInput doubleClick 100 100

# Execute a long-click event.
hdc shell uitest uiInput longClick 100 100

Example of Running the uiInput fling Command

# Execute the fling event. The default value of stepLength_ is used.
hdc shell uitest uiInput fling 10 10 200 200 500 

Example of Running the uiInput swipe/drag Command

# Execute the swipe event.
hdc shell uitest uiInput swipe 10 10 200 200 500

# Execute the drag event.
hdc shell uitest uiInput drag 10 10 100 100 500 

Example of Running the uiInput dircFling Command

# Execute the leftward fling event.
hdc shell uitest uiInput dircFling 0 500
# Execute the rightward fling event.
hdc shell uitest uiInput dircFling 1 600
# Execute the upward fling event.
hdc shell uitest uiInput dircFling 2 
# Execute the downward fling event.
hdc shell uitest uiInput dircFling 3

Example of Running the uiInput inputText Command

# Execute the input text event.
hdc shell uitest uiInput inputText 100 100 hello 

Example of Running the uiInput text Command

# Execute the text input in the text box at the focused position. If the current focused position does not support text input, no effect is displayed.
hdc shell uitest uiInput text hello

Example of Running the uiInput keyEvent Command

NOTE

A maximum of three key values can be passed. For details about the key values, see KeyCode.

# Back to home page.
hdc shell uitest uiInput keyEvent Home
# Back to the last page.
hdc shell uitest uiInput keyEvent Back
# Perform a key combination to copy and paste text.
hdc shell uitest uiInput keyEvent 2072 2038

Obtaining the Version Information

hdc shell uitest --version

Starting the Uitest Process

hdc shell uitest start-daemon

NOTE

You need to enable the developer mode for the device.

Only the test HAP started by the aa test ability can call the ability of the UiTest.

The Ability Privilege Level (APL) of the test HAP must be system_basic or normal.

Examples

Unit Test Scripts

Using Assertion APIs of the Unit Test

For details about how to use the available APIs, see Example of Using Assertion APIs.

Defining Unit Test Suites

For details about how to define and nest the unit test suite, see Example of Defining Test Suites.

Testing Custom Application Functions Using Unit Test

For details about how to test the custom functions in an application, see Example of Testing Custom Application Functions.

Using Data-Driven Capability of the Unit Test

For details about how to use the data-driven capability and configure repeat script execution, see Example of Using Data-Driven Capability.

UI Test Scripts for Components

Searching for Specified Components

For details about how to search for a component in an application UI by specifying the attributes of the component, see Example of Searching for Specified Components.

Simulating Click Events

For details about how to simulate a click event, a long-click event or a double-click event, see Example of Simulating Click Events.

Simulating Mouse Events

For details about how to simulate a mouse left-click event, a mouse right-click event, or a mouse scroll wheel event, see Example of Simulating Mouse Events.

Simulating Input Events

For details about how to simulate the input of Chinese and English text, see Example of Simulating Input Events.

Simulating Screenshot Events

For details about how to simulate capturing a screenshot (in a specified area), see Example of Simulating Screenshot Events.

Simulating Fling Events

For details about how to simulate a fling event (the finger leaves the screen after sliding), see Example of Simulating Fling Events.

Simulating Swipe Events

For details about how to simulate a swipe event (the finger stays on the screen after sliding), see Example of Simulating Swipe Events.

Simulating Pinch Events

For details about how to simulate a zoom-in and zoom-out operation on pictures, see Example of Simulating Pinch Events.

Simulating Scroll Events

For details about how to simulate components scrolling, see Example of Simulating Scroll Events.

UI Test Scripts for Windows

Searching for Specified Windows

For details about how to search for an application window by using the bundle name of the application, see Example of Searching for Specified Windows.

Simulating Window Move Events

For details about how to simulate moving a window to a specified position, see Example of Simulating Window Move Events.

Simulating Window Size Adjustments

For details about how to simulate a window size adjustment and direction specification, see Example of Simulating Window Size Adjustments.

FAQs

FAQs About Unit Test Cases

1. What should I do if logs in the test case are printed after the test case result?

Problem

The logs added to the test case are displayed after the test case execution, rather than during the test case execution.

Possible Causes

More than one asynchronous API is called in the test case.
In principle, logs in the test case are printed before the test case execution is complete.

Solutions

If more than one asynchronous API is called, you are advised to encapsulate the API invoking into the promise mode.

2. What should I do if the message “error: fail to start ability” is reported during test case execution?

Problem

When a test case is executed, the console returns the error message “fail to start ability”.

Possible Causes

An error occurs during the packaging of the test package, and the test framework dependency file is not included in the test package.

Solutions

Check whether the test package contains the OpenHarmonyTestRunner.abc file. If the file does not exist, rebuild and pack the file and perform the test again.

3. What should I do if a timeout error is reported during case execution?

Problem

After the test case execution is complete, the console displays the error message “execute time XXms”, indicating that the case execution times out.

Possible Causes

1. The test case is executed through an asynchronous API, but the done function is not executed during the execution. As a result, the test case execution does not end until it times out.

2. The time taken for API invocation is longer than the timeout interval set for test case execution.

3. Test assertion fails, and a failure exception is thrown. As a result, the test case execution does not end until it times out.

Solutions

1. Check the code logic of the test case to ensure that the done function is executed even if the assertion fails.

2. Modify the case execution timeout settings under Run/Debug Configurations in DevEco Studio.

3. Check the code logic and assertion result of the test case and make sure that the assertion is passed.

   FAQs About UI Test Cases

1. What should I do if the failure log contains “Get windows failed/GetRootByWindow failed”?

Problem

The UI test case fails to be executed. The HiLog file contains the error message “Get windows failed/GetRootByWindow failed.”

Possible Causes

The ArkUI feature is disabled. As a result, the component tree information is not generated on the test page.

Solutions

Run the following command, restart the device, and execute the test case again:

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

2. What should I do if the failure log contains “uitest-api does not allow calling concurrently”?

Problem

The UI test case fails to be executed. The HiLog file contains the error message “uitest-api does not allow calling concurrently.”

Possible Causes

1. In the test case, the await operator is not added to the asynchronous API provided by the UI test framework.

2. The UI test case is executed in multiple processes. As a result, multiple UI test processes are started. The framework does not support multi-process invoking.

Solutions

1. Check the case implementation and add the await operator to the asynchronous API.

2. Do not execute UI test cases in multiple processes.

3. What should I do if the failure log contains “does not exist on current UI! Check if the UI has changed after you got the widget object”?

Problem

The UI test case fails to be executed. The HiLog file contains the error message “does not exist on current UI! Check if the UI has changed after you got the widget object.”

Possible Causes

After the target component is found in the code of the test case, the device UI changes, resulting in loss of the found component and inability to perform emulation.

Solutions

Run the UI test case again.

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Test Kit

harmony 鸿蒙SmartPerf User Guide

harmony 鸿蒙wukong User Guide