1.0.13 • Published 5 months ago

@ohos/hypium v1.0.13

Weekly downloads
-
License
Apache-2.0
Repository
-
Last release
5 months ago

Hypium是什么?


  • Hypium是OpenHarmony上的测试框架,提供测试用例编写、执行、结果显示能力,用于OpenHarmony系统应用接口以及应用界面测试。
  • Hypium结构化模型:hypium工程主要由List.test.js与TestCase.test.js组成。
rootProject                  // Hypium工程根目录
├── moduleA
│   ├── src
│      ├── main                   // 被测试应用目录
│      ├── ohosTest               // 测试用例目录
│         ├── js/ets
│            └── test
│               └── List.test.js      // 测试用例加载脚本,ets目录下为.ets后缀
│               └── TestCase.test.js  // 测试用例脚本,ets目录下为.ets后缀
└── moduleB
    ...
│               └── List.test.js      // 测试用例加载脚本,ets目录下为.ets后缀
│               └── TestCase.test.js  // 测试用例脚本,ets目录下为.ets后缀

安装使用


  • 在DevEco Studio内使用Hypium
  • 工程级package.json内配置:
"dependencies": {
    "@ohos/hypium": "1.0.7"
}

注: hypium服务于OpenHarmonyOS应用对外接口测试、系统对外接口测试(SDK中接口),完成HAP自动化测试。详细指导: Deveco Studio

通用语法

  • 测试用例采用业内通用语法,describe代表一个测试套, it代表一条用例。
No.API功能说明
1describe定义一个测试套,支持两个参数:测试套名称和测试套函数
2beforeAll在测试套内定义一个预置条件,在所有测试用例开始前执行且仅执行一次,支持一个参数:预置动作函数
3beforeEach在测试套内定义一个单元预置条件,在每条测试用例开始前执行,执行次数与it定义的测试用例数一致,支持一个参数:预置动作函数
4afterEach在测试套内定义一个单元清理条件,在每条测试用例结束后执行,执行次数与it定义的测试用例数一致,支持一个参数:清理动作函数
5afterAll在测试套内定义一个清理条件,在所有测试用例结束后执行且仅执行一次,支持一个参数:清理动作函数
6it定义一条测试用例,支持三个参数:用例名称,过滤参数和用例函数
7expect支持bool类型判断等多种断言方法

断言库

  • 示例代码:
  expect(${actualvalue}).assertX(${expectvalue})
  • 断言功能列表:
No.API功能说明
1assertClose检验actualvalue和expectvalue(0)的接近程度是否是expectValue(1)
2assertContain检验actualvalue中是否包含expectvalue
3assertDeepEquals@since1.0.4 检验actualvalue和expectvalue(0)是否是同一个对象
4assertEqual检验actualvalue是否等于expectvalue0
5assertFail抛出一个错误
6assertFalse检验actualvalue是否是false
7assertTrue检验actualvalue是否是true
8assertInstanceOf检验actualvalue是否是expectvalue类型
9assertLarger检验actualvalue是否大于expectvalue
10assertLess检验actualvalue是否小于expectvalue
11assertNaN@since1.0.4 检验actualvalue是否是NaN
12assertNegUnlimited@since1.0.4 检验actualvalue是否等于Number.NEGATIVE_INFINITY
13assertNull检验actualvalue是否是null
14assertPosUnlimited@since1.0.4 检验actualvalue是否等于Number.POSITIVE_INFINITY
15assertPromiseIsPending@since1.0.4 检验actualvalue是否处于Pending状态【actualvalue为promse对象】
16assertPromiseIsRejected@since1.0.4 检验actualvalue是否处于Rejected状态【同15】
17assertPromiseIsRejectedWith@since1.0.4 检验actualvalue是否处于Rejected状态,并且比较执行的结果值【同15】
18assertPromiseIsRejectedWithError@since1.0.4 检验actualvalue是否处于Rejected状态并有异常,同时比较异常的类型和message值【同15】
19assertPromiseIsResolved@since1.0.4 检验actualvalue是否处于Resolved状态【同15】
20assertPromiseIsResolvedWith@since1.0.4 检验actualvalue是否处于Resolved状态,并且比较执行的结果值【同15】
21assertThrowError检验actualvalue抛出Error内容是否是expectValue
22assertUndefined检验actualvalue是否是undefined
23not@since1.0.4 断言结果取反

示例代码:

  import { describe, it, expect } from '@ohos/hypium';

  export default async function assertCloseTest() {
    describe('assertClose', function () {
      it('assertClose_success', 0, function () {
        let a = 100;
        let b = 0.1;
        expect(a).assertClose(99, b);
      })
    })
  }

公共系统能力

No.API功能描述
1existKeyword(keyword: string, timeout: number): boolean@since1.0.3 hilog日志中查找指定字段是否存在,keyword是待查找关键字,timeout为设置的查找时间
2actionStart(tag: string): void@since1.0.3 cmd窗口输出开始tag
3actionEnd(tag: string): void@since1.0.3 cmd窗口输出结束tag

示例代码:

import { describe, it, expect, SysTestKit} from '@ohos/hypium';

export default function existKeywordTest() {
    describe('existKeywordTest', function () {
        it('existKeyword',DEFAULT, async function () {
            console.info("HelloTest");
            let isExist = await SysTestKit.existKeyword('HelloTest');
            console.info('isExist ------>' + isExist);
        })
    })
}
import { describe, it, expect, SysTestKit} from '@ohos/hypium';

export default function actionTest() {
    describe('actionTest', function () {
        it('existKeyword',DEFAULT, async function () {
            let tag = '[MyTest]';
			SysTestKit.actionStart(tag);
            //do something
            SysTestKit.actionEnd(tag);
        })
    })
}

专项能力

  • 测试用例属性筛选能力:hypium支持根据用例属性筛选执行指定测试用例,使用方式是先在测试用例上标记用例属性后,再在测试应用的启动shell命令后新增" -s ${Key} ${Value}"。
Key含义说明Value取值范围
level用例级别"0","1","2","3","4", 例如:-s level 1
size用例粒度"small","medium","large", 例如:-s size small
testType用例测试类型"function","performance","power","reliability","security","global","compatibility","user","standard","safety","resilience", 例如:-s testType function

示例代码

import { describe, it, expect, TestType, Size, Level } from '@ohos/hypium';

export default function attributeTest() {
    describe('attributeTest', function () {
        it("testAttributeIt", TestType.FUNCTION | Size.SMALLTEST | Level.LEVEL0, function () {
            console.info('Hello Test');
        })
    })
}

示例命令

XX -s level 1 -s size small -s testType function

该命令的作用是:筛选测试应用中同时满足a)用例级别是1 b)用例粒度是small c)用例测试类型是function 三个条件的用例执行。

  • 测试套/测试用例名称筛选能力(测试套与用例名称用“#”号连接,多个用“,”英文逗号分隔)
Key含义说明Value取值范围
class指定要执行的测试套&用例${describeName}#${itName},${describeName} , 例如:-s class attributeTest#testAttributeIt
notClass指定不执行的测试套&用例${describeName}#${itName},${describeName} , 例如:-s notClass attributeTest#testAttributeIt

示例命令

XX -s class attributeTest#testAttributeIt,abilityTest#testAbilityIt

该命令的作用是:筛选测试应用中attributeTest测试套下的testAttributeIt测试用例,abilityTest测试套下的testAbilityIt测试用例,只执行这两条用例。

  • 其他能力
能力项Key含义说明Value取值范围
随机执行能力random测试套&测试用例随机执行true, 不传参默认为false, 例如:-s random true
空跑能力dryRun显示要执行的测试用例信息全集true , 不传参默认为false,例如:-s dryRun true
异步超时能力timeout异步用例执行的超时时间正整数 , 单位ms,例如:-s timeout 5000
约束限制

随机执行能力和空跑能力从npm包1.0.3版本开始支持

Mock能力

约束限制

单元测试框架Mock能力从npm包1.0.1版本开始支持

约束


本模块首批接口从OpenHarmony SDK API version 8开始支持。

Hypium开放能力隐私声明

  • 我们如何收集和使用您的个人信息 您在使用集成了Hypium开放能力的测试应用时,Hypium不会处理您的个人信息。
  • SDK处理的个人信息 不涉及。
  • SDK集成第三方服务声明 不涉及。
  • SDK数据安全保护 不涉及。
  • SDK版本更新声明 为了向您提供最新的服务,我们会不时更新Hypium版本。我们强烈建议开发者集成使用最新版本的Hypium。
1.0.13

5 months ago

1.0.12

6 months ago

1.0.11

7 months ago

1.0.10

7 months ago

1.0.9

8 months ago

1.0.6

1 year ago