XTS认证子系统开发指南

简介

XTS子系统是OpenHarmony生态认证测试套件的集合，当前包括acts（application compatibility test suite）应用兼容性测试套件，后续会拓展dcts（device compatibility test suite）设备兼容性测试套件等。

XTS子系统当前包括acts与tools软件包：

• acts，存放acts相关测试用例源码与配置文件，其目的是帮助终端设备厂商尽早发现软件与OpenHarmony的不兼容性，确保软件在整个开发过程中满足OpenHarmony的兼容性要求。
• tools，存放acts相关测试用例开发框架。

设备类型

OpenHarmony支持如下几种设备类型：

• 轻量系统类设备（参考内存≥128KB）

  面向MCU类处理器，例如Arm Cortex-M、RISC-V 32位的设备，资源极其有限，参考内存≥128KB，提供丰富的近距连接能力以及丰富的外设总线访问能力。典型产品有智能家居领域的联接类模组、传感器设备等。联接类模组通常应用在智能物联网设备中，负责实现联接部分的硬件模块，在智能家居领域由厂家集成到其设备中。例如：联接类模组提供WLAN/Bluetooth的接入和数据的联接，模组与厂家家居的芯片通常通过UART或GPIO等总线接口进行通信。

• 小型系统类设备（参考内存≥1MB）

  面向应用处理器，例如Arm Cortex-A的设备，参考内存≥1MB，提供更高的安全能力，提供标准的图形框架，提供视频编解码的多媒体能力。典型产品有智能家居领域的IPCamera、电子猫眼、路由器以及智慧出行域的行车记录仪等。

• 标准系统类设备（参考内存≥128MB）

  面向应用处理器，例如Arm Cortex-A的设备，参考内存≥128MB，提供增强的交互能力，提供3D GPU以及硬件合成能力，提供更多控件以及动效更丰富的图形能力，提供完整的应用框架。典型产品有高端的冰箱显示屏等。

• 大型系统类设备（参考内存≥1GB）

  面向应用处理器，例如Arm Cortex-A的设备，参考内存≥1GB，提供完整的兼容应用框架。典型的产品有智慧屏、智能手表等。

目录

/test/xts
├── acts                 # 测试代码存放目录
│   └── subsystem       # 大型系统类设备子系统测试用例源码存放目录
│   └── subsystem_lite  # 轻量系统类设备、小型系统类设备子系统测试用例源码存放目录
│   └── BUILD.gn        # 大型系统类设备测试用例编译配置
│   └── build_lite      # 轻量系统类设备、小型系统类设备测试用例编译配置存放目录
│       └── BUILD.gn    # 轻量系统类设备、小型系统类设备测试用例编译配置
└── tools                # 测试工具代码存放目录

约束

轻量系统类设备用例开发语言是C，小型系统类设备用例开发语言是C++。

使用说明

表 1 用例级别说明

表 2 用例粒度说明

表 3 测试类型说明

用例开发指导

根据测试设备选择测试框架和对应测试用例语言。

表 4 设备和测试框架、开发语言对应关系

C语言用例开发编译指导（适用于轻量系统类设备产品用例开发）

示例：轻量系统类设备测试用例开发

当前使用的测试框架是hctest，hctest测试框架支持使用C语言编写测试用例，是在开源测试框架unity的基础上进行增强和适配。

1. 用例目录规范：测试用例存储到test/xts/acts仓中

   ├── acts
   │ └──subsystem_lite
   │ │ └── module_hal
   │ │ │ └── BUILD.gn
   │ │ │ └── src
   │ └──build_lite
   │ │ └── BUILD.gn
   

2. src目录下用例编写样例。

   1.引用测试框架

   #include "hctest.h"
   

   1. 使用宏定义LITE_TEST_SUIT定义子系统、模块、测试套件名称

   /**  
   * @brief  register a test suit named "IntTestSuite"  
   * @param  test subsystem name  
   * @param  example module name  
   * @param  IntTestSuite test suit name  
   */
   LITE_TEST_SUIT(test, example, IntTestSuite);
   

   1. 定义Setup与TearDown

   命名方式：测试套件名称+Setup，测试套件名称+TearDown。

   Setup与TearDown必须存在，可以为空函数。

   1. 使用宏定义LITE_TEST_CASE写测试用例

   包括三个参数：测试套件名称，测试用例名称，用例属性（测试类型、用例粒度、用例级别）。

   LITE_TEST_CASE(IntTestSuite, TestCase001, Function | MediumTest | Level1) 
   {  
     //do something 
   };
   

   1. 使用宏定义 RUN_TEST_SUITE注册测试套件

   RUN_TEST_SUITE(IntTestSuite);
   

3. 测试模块的配置文件（BUILD.gn）样例：

   在每个测试模块目录下新建BUILD.gn编译文件，用于指定编译后静态库的名称、依赖的头文件、依赖的库等；具体写法如下：

   import("//test/xts/tools/lite/build/suite_lite.gni")
   hctest_suite("ActsDemoTest") {
       suite_name = "acts"
       sources = [
           "src/test_demo.c",
       ]
       include_dirs = [ ]
       cflags = [ "-Wno-error" ]
   }
   

4. acts下BUILD.gn增加编译选项。

   需要将测试模块加入到acts目录下的编译脚本中，编译脚本路径：test/xts/acts/build_lite/BUILD.gn。

   lite_component("acts") {  
       ...
       if(board_name == "liteos_m") {
           features += [    
               ...
               "//xts/acts/subsystem_lite/module_hal:ActsDemoTest"
           ]    
       }
   }
   

5. 测试套件编译命令。

   随版本编译，debug版本编译时会同步编译acts测试套件

   说明： acts测试套件编译中间件为静态库，最终链接到版本镜像中 。

C语言用例执行指导（适用于轻量系统类设备产品用例开发）

示例：轻量系统类设备测试用例执行

将版本镜像烧录进开发板。

测试步骤

1. 使用串口工具登录开发板，并保存串口打印信息。
2. 重启设备，查看串口日志。

测试结果分析指导

基于串口打印日志进行分析；

每个测试套件执行以Start to run test suite开始，以xx Tests xx Failures xx Ignored结束。

C++语言用例开发编译指导（适用于小型系统类设备、标准系统类设备、大型系统类设备用例开发）

示例：小型系统类设备测试用例开发

当前使用的测试框架是hcpptest，hcpptest测试框架是在开源的googletest测试框架的基础上进行的增强和适配。

1. 规范用例目录：测试用例存储到test/xts/acts仓中。

   ├── acts
   │ └──subsystem_lite
   │ │ └── module_posix
   │ │ │ └── BUILD.gn
   │ │ │ └── src
   │ └──build_lite
   │ │ └── BUILD.gn
   

2. 测试模块src下用例编写样例：

   1. 引用测试框架：

   需要引用gtest.h 如：#include “gtest/gtest.h”

   #include "gtest/gtest.h"
   

   1. 定义Setup与TearDown

   using namespace std;
   using namespace testing::ext;
   class TestSuite: public testing::Test {
   protected:
   // Preset action of the test suite, which is executed before the first test case
   static void SetUpTestCase(void){
   }
   // Test suite cleanup action, which is executed after the last test case
   static void TearDownTestCase(void){
   }
   // Preset action of the test case
   virtual void SetUp()
   {
   }
   // Cleanup action of the test case
   virtual void TearDown()
   {
   }
   };
   

   1. 使用宏定义HWTEST或HWTEST_F写测试用例

   普通测试用例的定义：HWTEST（测试套名称， 测试用例名称， 用例标注）。

   包含SetUp和TearDown的测试用例的定义 ：HWTEST_F（测试套名称， 测试用例名称，用例标注）。

   宏定义包括三个参数：测试套件名称，测试用例名称，用例属性（测试类型、用例粒度、用例级别）。

   HWTEST_F(TestSuite, TestCase_0001, Function | MediumTest | Level1) {
   // do something
   }
   

3. 测试模块下用例配置文件（BUILD.gn）样例：

   每个测试模块目录下新建BUILD.gn编译文件，用于指定编译后可执行文件的名称、依赖的头文件、依赖的库等；具体写法如下。每个测试模块将独立编译成.bin可执行文件， 该文件可直接mount到单板上进行测试。

   举例：

   import("//test/xts/tools/lite/build/suite_lite.gni")
   hcpptest_suite("ActsDemoTest") {
       suite_name = "acts"
       sources = [
           "src/TestDemo.cpp"
       ]
   
       include_dirs = [
           "src",
           ...
       ]
       deps = [
           ...
       ]
       cflags = [ "-Wno-error" ]
   }
   

4. acts目录下增加编译选项（BUILD.gn）样例：

   将测试模块加入到acts目录下的编译脚本中，编译脚本为：test/xts/acts/build_lite/BUILD.gn。

    lite_component("acts") {  
   ...
   else if(board_name == "liteos_a") {
           features += [
               ...
               "//xts/acts/subsystem_lite/module_posix:ActsDemoTest"
           ]
       }
   }
   

5. 测试套件编译命令。

   随版本编译，debug版本编译时会同步编译acts测试套件

   说明： 小型系统类设备acts独立编译成可执行文件（bin格式）， 在编译产物的suites\acts目录下归档。

C++语言用例执行指导（适用于小型系统类设备、标准系统类设备、大型系统类设备用例开发）

示例：小型系统类设备测试用例执行

目前的用例执行采用nfs共享的方式，mount到单板去执行。

环境搭建

1. 使用有限网线或无线将开发板与PC进行连接。

2. 开发板配置IP、子网掩码、网关，确保开发板与PC处于同一个网段。

3. PC安装nfs服务器并完成注册，启动nfs服务。

4. 开发板配置mount命令，确保开发板可以访问PC端的nfs共享文件。

   格式：mount [nfs服务器IP]:[/nfs共享目录] [/开发板目录] nfs

   举例：

   mount 192.168.1.10:/nfs /nfs nfs
   

用例执行

测试套件执行 ActsDemoTest.bin 触发用例执行，基于串口打印日志进行分析。

相关仓

[XTS认证子系统]

[xts_acts]

[xts_tools]