@ohos.test.PerfTest

PerfTest提供白盒性能测试能力，供开发者在测试场景使用，支持对指定代码段或指定场景的性能数据测试，支持自动化执行测试代码段，并采集耗时、CPU、内存、时延、帧率等性能数据。

说明： - 本模块首批接口从API version 20开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - 本模块接口在自动化测试脚本中使用。 - 本模块接口不支持并发调用。 - 本模块接口适用于手机、平板、PC/2in1、智慧屏、车机。

导入模块

import { PerfMetric, PerfTest, PerfTestStrategy, PerfMeasureResult } from '@kit.TestKit';

PerfMetric

框架支持采集的性能指标。

原子化服务API： 从API version 20开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Test.PerfTest

说明

1. 以上指标均用于采集指定应用进程的性能数据，非系统整机性能数据。
2. CPU（CPU_LOAD/CPU_USAGE）、内存（MEMORY_RSS/MEMORY_PSS）数据采集说明如下：
3. 测试过程中，代码段执行开始前和代码段执行结束后，会分别采集指定应用进程的CPU和内存数据，因此测试过程中需要保证被测应用进程一直存在。
4. 应用启动时延（APP_START_RESPONSE_TIME/APP_START_COMPLETE_TIME）数据采集说明如下：
5. 应用启动时延数据受系统打点上报限制，开始时间为点击事件上报时间点，响应时延结束时间为点击后系统响应首帧的上屏时间点（首帧显示在屏幕上的时间点），完成时延结束时间为应用启动后的首帧上屏时间点，与端到端用户感知时延存在差异。
6. 应用启动时延数据采集支持的场景：桌面点击应用图标启动、Dock栏点击应用图标启动、应用中心点击应用图标启动。
7. 单次测试期间，仅第一次指定应用启动的时延数据会被采集。
8. 页面切换时延（PAGE_SWITCH_COMPLETE_TIME）数据采集说明如下：
9. 页面切换时延计算受系统打点上报限制，开始时间为点击事件上报时间点，完成时延结束时间为页面切换后的首帧上屏时间点，与端到端用户感知时延存在差异。
10. 页面切换时延数据采集支持的场景：Router、Navigation控件内的页面切换。
11. 单次测试期间，仅指定应用内第一次页面切换的时延数据会被采集。
12. 列表滑动帧率（LIST_SWIPE_FPS）数据采集说明如下：
13. 列表滑动帧率：指的是在列表滑动时，屏幕每秒钟渲染更新帧的次数。
14. 列表滑动帧率数据采集支持的场景：ArkUI子系统List、Grid、scroll、waterflow滚动控件列表的滑动。
15. 单次测试期间，仅指定应用内第一次列表滑动的帧率数据会被采集。

PerfTestStrategy

性能测试执行策略。

原子化服务API： 从API version 20开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Test.PerfTest

说明

属性actionCode和resetCode的入参类型为回调函数”Callback<boolean>“。在代码段中需要主动调用此回调函数，通知框架代码段执行完成，否则会导致代码段执行超时。 其中，回调函数的参数为boolean类型，true代表代码段执行符合预期，false代码段执行不符合预期。代码示例。

PerfMeasureResult

性能指标对应测量结果数据。

原子化服务API： 从API version 20开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Test.PerfTest

PerfTest

PerfTest类为白盒性能测试框架的总入口，提供测试任务创建、测试代码段执行和数据采集、测量结果获取等能力。

create

static create(strategy: PerfTestStrategy): PerfTest

静态方法，构造一个PerfTest对象，并返回该对象。

原子化服务API： 从API version 20开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Test.PerfTest

参数：

返回值：

错误码：

以下错误码的详细介绍请参见perftest错误码。

示例：

import { PerfMetric, PerfTest, PerfTestStrategy } from '@kit.TestKit';

async function demo() {
  let metrics: Array<PerfMetric> = [PerfMetric.DURATION];
  let num = 0;
  let actionCode = async (finish: Callback<boolean>) => { // 定义测试代码段，入参类型'Callback<boolean>'，命名为finish
    for (let index = 0; index < 10000; index++) {
      num++;
    }
    finish(true); // 调用finish回调函数，通知代码段执行结束，且执行符合预期
  }
  let resetCode = async (finish: Callback<boolean>) => {  // 定义测试结束环境重置代码段
    num = 0;
    finish(true);
  }
  let perfTestStrategy: PerfTestStrategy = {
    metrics: metrics,
    actionCode: actionCode,
    resetCode: resetCode,
    timeout: 30000,
    iterations: 10,
  };
  let perfTest: PerfTest = PerfTest.create(perfTestStrategy); // 构造一个PerfTest对象，创建测试任务
}

run

run(): Promise<void>

运行性能测试，迭代执行测试代码段并采集性能数据，使用Promise回调。

原子化服务API： 从API version 20开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Test.PerfTest

返回值：

错误码：

以下错误码的详细介绍请参见perftest错误码。

示例：

import { PerfMetric, PerfTest, PerfTestStrategy } from '@kit.TestKit';

async function demo() {
  let metrics: Array<PerfMetric> = [PerfMetric.DURATION];
  let num = 0;
  let actionCode = async (finish: Callback<boolean>) => {
    for (let index = 0; index < 10000; index++) {
      num++;
    }
    finish(true);
  }
  let perfTestStrategy: PerfTestStrategy = {
    metrics: metrics,
    actionCode: actionCode
  };
  let perfTest: PerfTest = PerfTest.create(perfTestStrategy);
  await perfTest.run(); // 运行性能测试
}

getMeasureResult

getMeasureResult(metric: PerfMetric): PerfMeasureResult

获取指定性能指标的测量数据。

原子化服务API： 从API version 20开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Test.PerfTest

参数：

返回值：

错误码：

以下错误码的详细介绍请参见perftest错误码。

示例：

import { PerfMetric, PerfTest, PerfTestStrategy } from '@kit.TestKit';

async function demo() {
  let metrics: Array<PerfMetric> = [PerfMetric.DURATION];
  let num = 0;
  let actionCode = async (finish: Callback<boolean>) => {
    for (let index = 0; index < 10000; index++) {
      num++;
    }
    finish(true);
  }
  let perfTestStrategy: PerfTestStrategy = {
    metrics: metrics,
    actionCode: actionCode
  };
  let perfTest: PerfTest = PerfTest.create(perfTestStrategy);
  await perfTest.run();
  let res = perfTest.getMeasureResult(PerfMetric.DURATION); // 获取指定性能指标的测量数据
}

destroy

destroy(): void

销毁PerfTest对象。

原子化服务API： 从API version 20开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Test.PerfTest

错误码：

以下错误码的详细介绍请参见perftest错误码。

示例：

import { PerfMetric, PerfTest, PerfTestStrategy } from '@kit.TestKit';

async function demo() {
  let metrics: Array<PerfMetric> = [PerfMetric.DURATION];
  let num = 0;
  let actionCode = async (finish: Callback<boolean>) => {
    for (let index = 0; index < 10000; index++) {
      num++;
    }
    finish(true);
  }
  let perfTestStrategy: PerfTestStrategy = {
    metrics: metrics,
    actionCode: actionCode
  };
  let perfTest: PerfTest = PerfTest.create(perfTestStrategy);
  await perfTest.run();
  perfTest.destroy(); // 销毁PerfTest对象
}

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Test Kit（应用测试服务）

harmony 鸿蒙perftest错误码

harmony 鸿蒙uitest错误码

harmony 鸿蒙@ohos.app.ability.abilityDelegatorRegistry (AbilityDelegatorRegistry)

harmony 鸿蒙@ohos.application.abilityDelegatorRegistry (AbilityDelegatorRegistry)

harmony 鸿蒙@ohos.application.testRunner (TestRunner)

harmony 鸿蒙AbilityDelegator

harmony 鸿蒙AbilityDelegatorArgs

harmony 鸿蒙ShellCmdResult

harmony 鸿蒙js-apis-uitest