OpenHarmony——测试子系统
测试子系统
简介
开发过程采用测试驱动开发模式,开发者基于系统新增特性可以通过开发者自己开发用例保证,对于系统已有特性的修改,也可通过修改项目中原有的测试用例保证,开发者测试旨在帮助开发者在开发阶段就能开发出高质量代码。
目录
test/
├── developertest # 开发者测试框架
│ ├── aw # 测试框架的静态库
│ ├── config # 测试框架配置
│ ├── examples # 测试用例示例
│ ├── src # 测试框架源码
│ ├── third_party # 测试框架依赖第三方组件适配
│ ├── start.bat # 开发者测试入口(Windows)
│ ├── start.sh # 开发者测试入口(Linux)
│ └── BUILD.gn # 测试框架编译入口
├── xdevice # 测试框架基础组件
│ ├── config # 框架配置文件
│ ├── extension # 基础组件扩展仓
│ ├── resource # 基础组件测试资源
│ └── src # 基础组件源码
└── xts # XTS认证套件
约束
测试工具环境依赖
- python版本>=3.7.5
- paramiko版本>=2.7.1
- setuptools版本>=40.8.0
- rsa版本>=4.0
- NFS版本>=V4,设备不支持hdc连接,支持串口时使用
- pyserial版本>=3.3,设备不支持hdc连接,支持串口时使用
- 运行操作系统:Windows版本>=Win10,Linux为Ubuntu18.04
安装
依赖python环境:
1、安装Linux扩展组件readline,
执行如下命令如下:
sudo apt-get install libreadline-dev
安装成功提示
Reading package lists... Done
Building dependency tree
Reading state information... Done
libreadline-dev is already the newest version (7.0-3).
0 upgraded, 0 newly installed, 0 to remove and 11 not upgraded.
2、安装setuptools插件,安装命令如下
pip3 install setuptools
安装成功提示如下:
Requirement already satisfied: setuptools in d:\programs\python37\lib\site-packages (41.2.0)
3、安装paramiko插件,安装命令如下:
pip3 install paramiko
安装成功提示如下:
Installing collected packages: pycparser, cffi, pynacl, bcrypt, cryptography, paramiko
Successfully installed bcrypt-3.2.0 cffi-1.14.4 cryptography-3.3.1 paramiko-2.7.2 pycparser-2.20 pynacl-1.4.0
安装python的rsa插件,安装命令如下:
pip3 install rsa
安装成功提示如下:
Installing collected packages: pyasn1, rsa
Successfully installed pyasn1-0.4.8 rsa-4.7
需要本地的python安装串口插件pyserial,安装命令如下:
pip3 install pyserial
安装成功提示如下:
Requirement already satisfied: pyserial in d:\programs\python37\lib\site-packages\pyserial-3.4-py3.7.egg (3.4)
如果设备仅支持串口输出测试结果,则需要安装NFS Server
windows环境下安装,例如安装haneWIN NFS Server1.2.50,下载地址:https://www.hanewin.net/nfs-e.htm 。
Linux环境下安装,安装命令如下:
sudo apt install nfs-kernel-server
安装成功提示如下:
Reading package lists... Done
Building dependency tree
Reading state information... Done
nfs-kernel-server is already the newest version (1:1.3.4-2.1ubuntu5.3).
0 upgraded, 0 newly installed, 0 to remove and 11 not upgraded.
编写测试用例
-
测试用例规范
-
详见测试demo用例:developertest/examples/calculator/test/unittest/common/calculator_add_test.cpp。
-
测试用例目录规划
subsystem # 子系统,系统组件 ├── parts # 部件 │ └── test # 模块测试目录 │ └── unittest # 单元测试 │ ├── common # 公共用例 │ ├── phone # 手机形态用例 │ └── ivi # 车机形态 │ └── liteos-a # ipcamera使用liteos内核时的用例 │ └── moduletest # 模块测试 │ ├── common │ ├── phone │ └── ivi │ └── liteos-a └── test # 子系统测试目录 └── resource # 测试资源 ├── module ├── common ├── phone ├── ivi ├── liteos-a └── systemtest # 系统测试 ├── common ├── phone ├── ivi ├── liteos-a
说明: 其中phone,ivi,liteos-a仅不同设备形态举例,如区分手机,车机,IPCamera等不同形态设备,对于同一特性在不同开发板上,如果用例没有差异,则用例放置common目录下,如果同一特性,用例区分不同设备形态,可能包含内核差异,芯片平台差异,则用例以目录区分。
-
编写测试用例步骤
-
添加测试用例文件头注释信息。
-
引用gtest头文件和ext命名空间。
-
添加被测试类的头文件。
-
定义测试套(测试类)。
-
实现该测试套具体的测试用例,包括用例注释和用例逻辑实现。
-
编写测试用例编译配置。
说明: *样例参考: 仅支持串口设备形态编译示例:developertest/examples/lite/cxx_demo/test/unittest/common/calc_subtraction_test.cpp。 支持hdc连接的设备形态编译示例:developertest/examples/calculator/test/unittest/common/calculator_add_test.cpp。
注意点如下: a、SetUp & TearDown是针对该测试套下每条用例执行前和执行后的处理逻辑 b、SetUpTestCase & TearDownTestCase是针对该测试套下所有用例执行前和执行后的处理逻辑 c、HWTEST的使用:特点:只适合做简单测试(执行不依赖Setup & Teardown)缺点:多个测试场景需要相同数据配置的情况不适用,测试用例之间可能相互影响,不具备独立性 d、使用printf函数打印日志
-
-
编写测试用例编译文件
-
定义测试用例编译构建目标。
- 添加测试用例编译文件头注释信息。
- 导入测试用例编译模板文件。
- 指定测试用例文件的输出路径。
- 配置测试用例编译依赖包含目录。
- 指定测试用例编译目标输出的文件名称。
- 编写具体的测试用例编译脚本(添加需要参与编译的源文件、配置和依赖 )。
- 对目标测试用例文件进行条件分组(分组名称固定为:unittest/moduletest)。
-
如果存在多个测试套,定义公共编译配置。
-
将测试用例添加到构建系统中。
说明: *样例参考: 1、仅支持串口设备形态编译示例: 用例编译配置:developertest/examples/lite/cxx_demo/test/unittest/common/BUILD.gn 编译入口配置:developertest/examples/lite/BUILD.gn 2、支持hdc连接的设备形态编译示例: 用例编译配置:developertest/examples/calculator/test/unittest/common/BUILD.gn 编译入口配置:developertest/examples/ohos.build
-
-
编写测试用例资源
-
在部件或者模块的test目录下创建resource目录。
-
在resource目录下创建形态目录,如phone。
-
在设备形态目录下创建一个以模块名命名的文件夹,如testmodule。
-
在模块目录下创建一个ohos_test.xml文件,文件内容格式如下
<?xml version="1.0" encoding="UTF-8"?> <configuration ver ="2.0" ><target name ="DetectorFileTest" ><preparer ><option name ="push" value ="test.txt -> /data/test/resource" src ="res" /></preparer ></target ></configuration >-
-
在测试用例的编译配置文件中定义resource_config_file,用来指定对应的资源文件ohos_test.xml。
说明: 如上资源文件功能:将resource目录下的test.txt文件通过hdc push命令推送到被测设备的/data/test/resource目录下。
-
ohos_test.xml文件标签说明如下:
说明: target_name:测试单元的名字,通常定义在测试目录的BUILD.gn中。 preparer:表示该测试单元执行前执行的动作。 cleaner:表示测试单元执行结束后的动作。 特别的,src=”res” 表示测试资源位于子系统根目录的resource目录, src=“out“ 表示out/release/$(子系统名)目录。
-
-
测试用例级别定义
- 基本(Level1)
- 重要(Level2)
- 一般(Level3)
- 生僻(Level4)
-
-
使用测试框架
-
可选,安装xdevice组件。
-
以Windows环境为例,打开xdevice安装目录:test/xdevice。
-
打开控制台窗口,执行如下命令:
python setup.py install 安装成功如下图:Installed d:\programs\python37\lib\site-packages\xdevice-0.0.0-py3.7.egg Processing dependencies for xdevice==0.0.0 Finished processing dependencies for xdevice==0.0.0
-
-
-
-
必选,developertest组件配置。
文件:developertest/config/user_config.xml。
-
测试框架通用配置。
[build] # 配置测试用例的编译参数,例如:
<build> <example>false</example> <version>false</version> <testcase>true</testcase> ... ... </build>
说明: 测试用例的编译参数说明如下: example:是否编译测试用例示例,默认false。 version:是否编译测试版本,默认false。 testcase:是否编译测试用例,默认true。
-
支持hdc连接的被测设备。
[device] # 配置标签为usb-hdc的环境信息,测试设备的IP地址和hdc映射的端口号,例如:
<device type ="usb-hdc" ><ip ></ip ><port ></port ><sn ></sn ></device > -
仅支持串口的被测设备。
[board_info] # 开发板配置信息,例如:
<board_info ><board_series ></board_series ><board_type ></board_type ><board_product ></board_product ><build_command ></build_command ></board_info >说明: 开发板配置信息如下: board_series:开发板系列,默认hispark。 board_type:开发板类型,默认taurus。 board_product:目标产品,默认ipcamera。 build_command:测试版本和用例的编译命令,默认hb build。
[device] # 配置标签为ipcamera的串口信息,COM口和波特率,例如:
<device type ="com" label ="ipcamera" ><serial ><com ></com ><type ></type ><baud_rate ></baud_rate ><data_bits ></data_bits ><stop_bits ></stop_bits ><timeout ></timeout ></serial ></device >
-
-
修改developertest组件配置。可选,如果测试用例已完成编译,可以直接指定测试用例的编译输出路径,测试平台执行测试用例时即不会重新编译测试用例。
文件:config/user_config.xml。
-
[test_cases] # 指定测试用例的输出路径,编译输出目录,例如:
<test_cases ><dir ></dir ></test_cases > -
[NFS] # 被测设备仅支持串口时配置,指定NFS的映射路径,host_dir为PC侧的NFS目录,board_dir为板侧创建的目录,例如:
<NFS ><host_dir ></host_dir ><board_dir ></board_dir ></NFS >
-
-
测试环境准备(当被测设备仅支持串口时,需要检查)。
- 系统镜像与文件系统已烧录进开发板,开发板上系统正常运行,在系统模式下,如shell登录时设备提示符OHOS#。
- 开发主机和开发板串口连接正常,网口连接正常。
- 开发主机IP与开发板IP处在同一小网网段,相互可以ping通。
- 开发主机侧创建空目录用于开发板通过NFS挂载测试用例,并且NFS服务启动正常。
-
运行测试套。
-
启动测试框架,打开test/developertest目录。
-
Windows环境启动测试框架。
start.bat
-
Linux环境启动测试框架。
./strat.sh
-
-
设备形态选择。
根据实际的开发板选择,设备形态配置:developertest/config/framework_config.xml。
-
执行测试指令。
-
查询测试用例支持的子系统,模块,产品形态以及测试类型,使用show命令。
usage: show productlist Querying Supported Product Forms show typelist Querying the Supported Test Type show subsystemlist Querying Supported Subsystems show modulelist Querying Supported Modules -
执行测试指令示例,其中-t为必选,-ss和-tm为可选字段。
run -t ut -ss test -tm example
-
参数说明:指定参数可以执行特定特性、模块对应的测试套。
usage: run [-h] [-p PRODUCTFORM] [-t [TESTTYPE [TESTTYPE ...]]] [-ss SUBSYSTEM] [-tm TESTMODULE] [-ts TESTSUIT] [-tc TESTCASE] [-tl TESTLEVEL] optional arguments: -h, --help show this help message and exit -p PRODUCTFORM, --productform PRODUCTFORM Specified product form -t [TESTTYPE [TESTTYPE ...]], --testtype [TESTTYPE [TESTTYPE ...]] Specify test type(UT,MST,ST,PERF,ALL) -ss SUBSYSTEM, --subsystem SUBSYSTEM Specify test subsystem -tm TESTMODULE, --testmodule TESTMODULE Specified test module -ts TESTSUIT, --testsuite TESTSUIT Specify test suite -tc TESTCASE, --testcase TESTCASE Specify test case -tl TESTLEVEL, --testlevel TESTLEVEL Specify test level
-
-
-
测试框架帮助。
帮助指令,用于查询测试平台支持哪些测试指令。
help
-
退出自测试平台。
退出自测试平台,使用如下命令退出测试平台。
quit
测试结果与日志
-
通过在测试框架中执行测试指令,即可以生成测试日志和测试报告。
-
测试结果
-
测试用例的结果会直接显示在控制台上,执行一次的测试结果根路径如下:
reports/xxxx-xx-xx-xx-xx-xx
-
测试用例格式化结果
result/
-
测试用例日志
log/plan_log_xxxx-xx-xx-xx-xx-xx.log
-
测试报告汇总
summary_report.html -
测试报告详情
details_report.html
-
-
测试框架日志
reports/platform_log_xxxx-xx-xx-xx-xx-xx.log -
最新测试报告
reports/latest
涉及仓
测试子系统
test_developertest
test_xdevice
test_xdevice_extension