The harmonyostestrunner Tool

Introduction

The harmonyostestrunner tool runs a single Qt auto test on a HarmonyOS device or emulator and reports the result on the host. When you run a test with ctest, the CMake test wrapper normally invokes it for you. Invoke it directly when the test HAP is built on one machine but the device is attached to another, or when you have a test HAP but no CMake build tree at hand.

This tool does not build or install the test package. Instead, harmonydeployqt bundles the test binaries into a single test HAP (through its --test-bundle option). You must build, sign, and install that HAP on the device beforehand:

hdc install <path/to/autotests-signed.hap>

How it works

1. It verifies that the target device has the test bundle HAP installed.
2. It force-stops any running instance of the bundle, then launches the ability with aa start, telling the platform which test shared library to load and where to redirect the test's standard output and exit code inside the application sandbox.
3. It streams the test's standard output to the host as the test runs.
4. It waits for the test to finish, which it detects when the exit-code file becomes readable. A liveness check catches a crashed process, and an optional no-progress watchdog force-stops a test that stops producing PASS or FAIL results.
5. If the test declares blocking system dialogs and the test's output goes quiet, it dumps the screen layout with uitest and clicks the expected button.
6. It returns the test's exit code as its own exit code.

How to use it

The basic syntax is:

harmonyostestrunner [OPTIONS] <test-binary> [TESTARGS]

The <test-binary> argument is the path to the test shared library, for example libtst_qobject.so. Its file name selects which test inside the bundle to run. Anything after it, such as test function names or -v2, the tool forwards to the test.

Options

The following table lists the command-line options of harmonyostestrunner. You can set each option through the environment variable in parentheses. The command-line value takes precedence.

Example usage

Run the tst_qobject test on a specific device, executing only the signalsBlocked test case:

harmonyostestrunner --device 127.0.0.1:5555 libtst_qobject.so signalsBlocked

For more information about the Qt Test framework, see Qt Test Overview.