【Harmony】OpenHarmony轻量系统--XTS子系统编译适配及测试

本文内容为本人在移植国民技术N32G452适配OpenHarmony轻量系统的过程中，以添油方式仓促写就，其中或有不少相互矛盾或有失偏颇之处，但对于初入此道之开发者应能有一定的启迪作用。

国民技术-OpenHarmony轻量系统适配源码包

轻量系统应用兼容性测试适配

前提：基于OpenHarmony-V4.0-Release全量代码仓
在vendor目录下产品的config.json文件中，添加XTS子系统组件定义
兼容性测评官网

如何添加XTS子系统

执行编译XTS组件的指令不唯一，取决于gn构建文件内的私有工程设置

通常为：hb build -f -b debug --gn-args build_xts=true，build_xts是一个变量，如果使能了该变量，则会增加相关的编译部分。另外在用户私有的BUILD.gn文件里，也有该变量的相关依赖部分。--gn-args用于传递构建参数至GN构建系统
hb build -b debug，执行此条指令生成调试版本镜像，与 XTS 编译无关

就本人目前理解而言，要添加XTS子系统，前期需要实现的几点工作如下：

首先完成基于私有开发板的 OpenHarmony 工程移植适配工作，使得基于内核子系统的最简工程可以运行
而后建议在target_config.h添加启动shell功能配置，同时完成串口外设调试终端的移植适配，hb build，并烧录须测试验证ok。当然期间内必存在各种各样的编译报错，包括依赖关系不全、代码工程的不适配等
添加各项子系统并使其构建成功，如启动恢复子系统、DFX子系统，等等，
最后添加XTS子系统配置及其依赖，当然测试套件的静态库文件相当大，可以分批测试并保存测试结果，每次链接一部分库进行测试
- 一般在//device/board/xxx/xxx/BUILD.gn文件里的 if(build_xts=true)选项卡内添加相关的链接选项，其中hctest、sysparam、bootstrap等静态库是必须的，在添加XTS子系统之前，应完成相关部分部件的编写编译构建与测试，此部分是测试框架基石

添加编译XTS子系需要执行的步骤：

在工程配置target_config.h宏定义中使能Test测试项
- 使得系统启动初始化时会进行相关函数调用
在//kernel/liteos_m中make menuconfig中，使能测试相关配置 – 实际上为配置//vendor/xxx/kernel_configs/debug.config选项
在//vendor/xxx/config.json添加合适的子系统配置
- 补全文件末尾的third_patry和product_adapt_dir
在//device/board/xxx/liteos_m/config.gni添加适配的头文件路径
- 链接选项中增添合适的静态库链接，以实现链接测试用例相关库，其中测试静态库文件生成于//out/${company}//${product}//libs
- 还须添加源文件路径？
在//device/board/xxx/xxx.ld链接脚本中添加OpenHarmony特有的测试段

XTS子系统编译流程

通过hb工具读取系统配置文件(即vendor目录下产品的config.json)，获取参与编译的子系统以及部件信息
通过gn工具会读取XTS子系统BUILD.gn–all_features会读取轻量系统全部acts测试套件
- 判断是否debug版本if (ohos_build_type == "debug" && ohos_test_args != "notest") ，非debug版本XTS不参与编译
将轻量系统全部acts测试套件与产品的config.json子系统组件对比，存在的子系统部件参与最终编译
最终生成静态库.a归档路径：out/.../.../libs
- XTS子系统: libmodule_xxx.a，测试框架：libhctest.a
.a库链接操作

XTS子系统兼容性测评

规范编码以通过兼容性测试

遵循 OpenHarmony 的开发规范。OpenHarmony 提供了完善的开发规范，包括代码风格、命名规范、注释规范等
使用 OpenHarmony 的标准 API

XTS子系统测试项

轻量系统的全部测试项包含有：应用管理(Ability和Bundle)、网络通信(LwIP)、文件系统、系统参数、Wi-Fi IOT、分布式数据管理、安全、日志、事件、分布式调度、系统更新、系统引导

XTS测试库链接报错问题

不同的 OpenHarmony 发布版本，其所要求的测试模块及套件有所区别，通常情况下链接相应的测试库，报错是因为没有在vendor/xxx/xxx/config.json配置好相应的模块和组件、部件，导致工程找不到相应的函数实现

另外，用户也需要添加自己的工程对模块组件的适配

module_ActsUpdaterFuncTest 编译链接错误

更新功能测试库链接报错信息节选如下：

reference to `HotaWrite'
[OHOS ERROR] /home/jd_chen/Downloads/gcc-arm-none-eabi-10-2020-q4-major/bin/../lib/gcc/arm-none-eabi/10.2.1/../../../../arm-none-eabi/bin/ld: ota_func_test.c:(.text.subUpgradeAPI1000_runTest+0x64): undefined reference to `HotaCancel'
[OHOS ERROR] /home/jd_chen/Downloads/gcc-arm-none-eabi-10-2020-q4-major/bin/../lib/gcc/arm-none-eabi/10.2.1/../../../../arm-none-eabi/bin/ld: libs/libmodule_ActsUpdaterFuncTest.a(libmodule_ActsUpdaterFuncTest.ota_func_test.o): in function `subUpgradeAPI1200_runTest':
[OHOS ERROR] ota_func_test.c:(.text.subUpgradeAPI1200_runTest+0xe): undefined reference to `HotaCancel'
[OHOS ERROR] /home/jd_chen/Downloads/gcc-arm-none-eabi-10-2020-q4-major/bin/../lib/gcc/arm-none-eabi/10.2.1/../../../../arm-none-eabi/bin/ld: libs/libmodule_ActsUpdaterFuncTest.a(libmodule_ActsUpdaterFuncTest.ota_func_test.o): in function `subUpgradeAPI1100_runTest':
[OHOS ERROR] ota_func_test.c:(.text.subUpgradeAPI1100_runTest+0x14): undefined reference to `HotaGetUpdateIndex'
[OHOS ERROR] /home/jd_chen/Downloads/gcc-arm-none-eabi-10-2020-q4-major/bin/../lib/gcc/arm-none-eabi/10.2.1/../../../../arm-none-eabi/bin/ld: ota_func_test.c:(.text.subUpgradeAPI1100_runTest+0x24): undefined reference to `HotaSetPackageType'
[OHOS ERROR] /home/jd_chen/Downloads/gcc-arm-none-eabi-10-2020-q4-major/bin/../lib/gcc/arm-none-eabi/10.2.1/../../../../arm-none-eabi/bin/ld: ota_func_test.c:(.text.subUpgradeAPI1100_runTest+0x46): undefined reference to `HotaWrite'
[OHOS ERROR] /home/jd_chen/Downloads/gcc-arm-none-eabi-10-2020-q4-major/bin/../lib/gcc/arm-none-eabi/10.2.1/../../../../arm-none-eabi/bin/ld: ota_func_test.c:(.text.subUpgradeAPI1100_runTest+0x64): undefined reference to `HotaRead'
[OHOS ERROR] /home/jd_chen/Downloads/gcc-arm-none-eabi-10-2020-q4-major/bin/../lib/gcc/arm-none-eabi/10.2.1/../../../../arm-none-eabi/bin/ld: ota_func_test.c:(.text.subUpgradeAPI1100_runTest+0x84): undefined reference to `HotaCancel'
[OHOS ERROR] collect2: error: ld returned 1 exit status
[OHOS ERROR] Traceback (most recent call last):

其中，HotaWrite、HotaRead等函数实现位于文件//base/update/sys_installer_lite/frameworks/source/updater/hota_updater.c中。

经过分析，导致编译报错的原因有如下：

用户私有板的相关配置不正确，比如缺少头文件包含、或者库文件包含、或者没有指定生成相应子系统的组件部件
OpenHarmony V4.0 轻量系统源码工程在此方面的XTS子系统测试并未完善

而在细节测试，应用 Hi3861 芯片工程编译正常，但使用 //vendor/xxx一些其它例程，则也是 XTS 编译不通过

module_ActsHuksHalFunctionTest 编译链接错误

环境硬件抽象层功能测试

在库链接选项里增添"-lhuks_test_common",即可编译链接成功

module_ActsSamgrTest 运行报错堆栈溢出

服务管理测试运行错误

可能是轻量系统的堆内存默认设置的 60K 过小

module_ActsBundleMgrTest 编译链接错误

包管理测试库编译报错节选如下：

[OHOS ERROR] /home/jd_chen/Downloads/gcc-arm-none-eabi-10-2020-q4-major/bin/../lib/gcc/arm-none-eabi/10.2.1/../../../../arm-none-eabi/bin/ld: bundle_mgr_test.c:(.text.testSetElementDeviceIDIllegal_runTest+0x84): undefined reference to `ClearWant'


[OHOS ERROR] /home/jd_chen/Downloads/gcc-arm-none-eabi-10-2020-q4-major/bin/../lib/gcc/arm-none-eabi/10.2.1/../../../../arm-none-eabi/bin/ld: libs/libmodule_ActsBundleMgrTest.a(libmodule_ActsBundleMgrTest.bundle_mgr_test.o): in function `testGetBundleInfoIllegal_runTest':
[OHOS ERROR] bundle_mgr_test.c:(.text.testGetBundleInfoIllegal_runTest+0x28): undefined reference to `GetBundleInfo'
[OHOS ERROR] /home/jd_chen/Downloads/gcc-arm-none-eabi-10-2020-q4-major/bin/../lib/gcc/arm-none-eabi/10.2.1/../../../../arm-none-eabi/bin/ld: bundle_mgr_test.c:(.text.testGetBundleInfoIllegal_runTest+0x36): undefined reference to `GetBundleInfo'
[OHOS ERROR] /home/jd_chen/Downloads/gcc-arm-none-eabi-10-2020-q4-major/bin/../lib/gcc/arm-none-eabi/10.2.1/../../../../arm-none-eabi/bin/ld: bundle_mgr_test.c:(.text.testGetBundleInfoIllegal_runTest+0x4e): undefined reference to `GetBundleInfo'
[OHOS ERROR] /home/jd_chen/Downloads/gcc-arm-none-eabi-10-2020-q4-major/bin/../lib/gcc/arm-none-eabi/10.2.1/../../../../arm-none-eabi/bin/ld: bundle_mgr_test.c:(.text.testGetBundleInfoIllegal_runTest+0x5c): undefined reference to `GetBundleInfo'
[OHOS ERROR] /home/jd_chen/Downloads/gcc-arm-none-eabi-10-2020-q4-major/bin/../lib/gcc/arm-none-eabi/10.2.1/../../../../arm-none-eabi/bin/ld: libs/libmodule_ActsBundleMgrTest.a(libmodule_ActsBundleMgrTest.bundle_mgr_test.o): in function `testGetBundleInfosIllegal_runTest':
[OHOS ERROR] bundle_mgr_test.c:(.text.testGetBundleInfosIllegal_runTest+0x1c): undefined reference to `GetBundleInfos'
[OHOS ERROR] /home/jd_chen/Downloads/gcc-arm-none-eabi-10-2020-q4-major/bin/../lib/gcc/arm-none-eabi/10.2.1/../../../../arm-none-eabi/bin/ld: bundle_mgr_test.c:(.text.testGetBundleInfosIllegal_runTest+0x2a): undefined reference to `GetBundleInfos'
[OHOS ERROR] /home/jd_chen/Downloads/gcc-arm-none-eabi-10-2020-q4-major/bin/../lib/gcc/arm-none-eabi/10.2.1/../../../../arm-none-eabi/bin/ld: bundle_mgr_test.c:(.text.testGetBundleInfosIllegal_runTest+0x42): undefined reference to `GetBundleInfos'
[OHOS ERROR] collect2: error: ld returned 1 exit status

其中，SetElementDeviceID、ClearElement等函数实现位于文件foundation/bundlemanager/bundle_framework_lite/frameworks/bundle_lite/src/element_name.cpp中

另外，提示在文件test/xts/acts/appexecfwk_lite/appexecfwk_hal/src/bundle_mgr_test.c中的testGetBundleInfoIllegal_runTest函数中找不到GetBundleInfo以及其它的一些函数实现

module_ActsDeviceAttestTest 编译链接错误

设备认证测试模块编译链接报错信息如下：

[OHOS ERROR] /home/jd_chen/Downloads/gcc-arm-none-eabi-10-2020-q4-major/bin/../lib/gcc/arm-none-eabi/10.2.1/../../../../arm-none-eabi/bin/ld: libs/libmodule_ActsDeviceAttestTest.a(libmodule_ActsDeviceAttestTest.device_attest.o): in function `subDeviceAttest0100_runTest':
[OHOS ERROR] device_attest.c:(.text.subDeviceAttest0100_runTest+0xe): undefined reference to `StartDevAttestTask'
[OHOS ERROR] /home/jd_chen/Downloads/gcc-arm-none-eabi-10-2020-q4-major/bin/../lib/gcc/arm-none-eabi/10.2.1/../../../../arm-none-eabi/bin/ld: libs/libmodule_ActsDeviceAttestTest.a(libmodule_ActsDeviceAttestTest.device_attest.o): in function `subDeviceAttest0200_runTest':
[OHOS ERROR] device_attest.c:(.text.subDeviceAttest0200_runTest+0x1c): undefined reference to `GetAttestStatus'
[OHOS ERROR] collect2: error: ld returned 1 exit status

其中，StartDevAttestTask、GetAttestStatus函数实现位于文件test/xts/device_attest_lite/framework/mini/src/attest_framework_client_mini.c中

XTS子系统的兼容性测试用例适配开发

针对以上编译报错，可以通过自己编写相关的缺失函数实现通过编译测试

例如 UtilsFile 文件测试函数，需要编写能够符合测试用例（或者说符合API规范）的函数，例：当调用API删除不存在的文件时，函数应能返回异常

OpenHarmony轻量系统认证流程

准备烧录镜像、相关指导文档、XTS自测串口打印报告、PCS自检表、寄送样品及工具

通常情况下，由于芯片内存大小有限，无法一次性将所有的 XTS 测试用例库链接进程序中

因此，主要采用分批烧录、验证串口打印信息的方式，每一个测试模块都对应一个烧录镜像文件

另外，需要提供相关烧录工具以及指导文件

如果是通过烧录口直接烧录的方式，那么寄送的样品可以把线路板暴露出来
当然，也可以通过 IAP 在应用编程方式，或者空中升级方式，只要能够达到目标即可

兼容性认证测评申报

在兼容性平台上提请设备申报，包括有如下项：

产品定义： 需要明确所应用操作系统的发布版本、设备版本号、芯片型号（此类型信息须与源码上填写保持一致）

报告上传： 需要上传各个测试套的镜像文件、烧录以及测试指导文档、XTS自测导出的串口日志txt报告（每个测试模块对应一个txt文件），此外，软件版本号、安全补丁标签、版本ID、版本Hash须与测试模块中所打印日志保持一致

样机寄送： 安排样机寄送

兼容性认证测评驳回以及补充事项

XTS子系统源码分析

XTS子系统软件工作流程

LITE_TEST_CASE(IntTestSuite, TestCase001, Level0) 
{  
  //do something 
};

Jindu-Chen