1# XTS子系统<a name="ZH-CN_TOPIC_0000001117409671"></a> 2 3- [简介](#section465982318513) 4- [系统类型](#section125090457443) 5- [目录](#section161941989596) 6- [约束](#section119744591305) 7- [使用说明](#section137768191623) 8- [用例开发指导](#section3695134065513) 9 - [C语言用例开发编译指导（适用于轻量系统产品用例开发）](#section198193336544) 10 - [C语言用例执行指导（适用于轻量系统产品用例开发）](#section13820233175418) 11 - [C++语言用例开发编译指导（适用于小型系统、标准系统用例开发）](#section3822123311540) 12 - [C++语言用例执行指导（适用于小型系统、标准系统用例开发）](#section128222336544) 13 - [JS语言用例开发指导（适用于标准系统）](#section159801435165220) 14 - [JS语言用例编译打包指导（适用于标准系统）](#section445519106559) 15 16- [相关仓](#section1371113476307) 17 18## 简介<a name="section465982318513"></a> 19 20XTS子系统是OpenHarmony兼容性测试套件的集合，当前包括acts（application compatibility test suite）应用兼容性测试套件，后续会拓展dcts（device compatibility test suite）设备兼容性测试套件等。 21 22XTS子系统当前包括acts与tools软件包： 23 24- acts，存放acts相关测试用例源码与配置文件，其目的是帮助终端设备厂商尽早发现软件与OpenHarmony的不兼容性，确保软件在整个开发过程中满足OpenHarmony的兼容性要求。 25- tools，存放acts相关测试用例开发框架。 26 27## 系统类型<a name="section125090457443"></a> 28 29OpenHarmony支持如下几种系统类型： 30 31- 轻量系统（mini system） 32 33 面向MCU类处理器例如Arm Cortex-M、RISC-V 32位的设备，硬件资源极其有限，支持的设备最小内存为128KiB，可以提供多种轻量级网络协议，轻量级的图形框架，以及丰富的IOT总线读写部件等。可支撑的产品如智能家居领域的连接类模组、传感器设备、穿戴类设备等。典型的开发板型号是Multi-modalV200Z-R。 34 35- 小型系统（small system） 36 37 面向应用处理器例如Arm Cortex-A的设备，支持的设备最小内存为1MiB，可以提供更高的安全能力、标准的图形框架、视频编解码的多媒体能力。可支撑的产品如智能家居领域的IP Camera、电子猫眼、路由器以及智慧出行域的行车记录仪等。典型的开发板型号是Hispark_Taurus。 38 39- 标准系统（standard system） 40 41 面向应用处理器例如Arm Cortex-A的设备，支持的设备最小内存为128MiB，可以提供增强的交互能力、3D GPU以及硬件合成能力、更多控件以及动效更丰富的图形能力、完整的应用框架。可支撑的产品如高端的冰箱显示屏。典型的开发板型号是润和DAYU200。 42 43 44## 目录<a name="section161941989596"></a> 45 46``` 47/test/xts 48├── acts # 测试代码存放目录 49│ └── subsystem # 标准系统子系统测试用例源码存放目录 50│ └── subsystem_lite # 轻量系统、小型系统子系统测试用例源码存放目录 51│ └── BUILD.gn # 标准系统测试用例编译配置 52│ └── build_lite # 轻量系统、小型系统测试用例编译配置存放目录 53│ └── BUILD.gn # 轻量系统、小型系统测试用例编译配置 54└── tools # 测试工具代码存放目录 55``` 56 57## 约束<a name="section119744591305"></a> 58 59轻量系统用例开发语言是C，小型系统用例开发语言是C++。 60 61## 使用说明<a name="section137768191623"></a> 62 63**表 1** 用例级别说明 64 65<a name="table12856113719456"></a> 66<table><thead align="left"><tr id="row88561737114517"><th class="cellrowborder" valign="top" width="33.333333333333336%" id="mcps1.2.4.1.1"><p id="p54711456452"><a name="p54711456452"></a><a name="p54711456452"></a>级别名称</p> 67</th> 68<th class="cellrowborder" valign="top" width="33.283328332833285%" id="mcps1.2.4.1.2"><p id="p114834544518"><a name="p114834544518"></a><a name="p114834544518"></a>基本定义</p> 69</th> 70<th class="cellrowborder" valign="top" width="33.383338333833386%" id="mcps1.2.4.1.3"><p id="p348154574518"><a name="p348154574518"></a><a name="p348154574518"></a>测试范围</p> 71</th> 72</tr> 73</thead> 74<tbody><tr id="row78561137134514"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.2.4.1.1 "><p id="p17481345124512"><a name="p17481345124512"></a><a name="p17481345124512"></a>Level0</p> 75</td> 76<td class="cellrowborder" valign="top" width="33.283328332833285%" headers="mcps1.2.4.1.2 "><p id="p1548945204514"><a name="p1548945204514"></a><a name="p1548945204514"></a>冒烟</p> 77</td> 78<td class="cellrowborder" valign="top" width="33.383338333833386%" headers="mcps1.2.4.1.3 "><p id="p174824517456"><a name="p174824517456"></a><a name="p174824517456"></a>验证关键功能点基本功能/最基本DFX属性在最常见输入下的表现，通过表示功能基本可运行。</p> 79</td> 80</tr> 81<tr id="row28563372451"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.2.4.1.1 "><p id="p448445144512"><a name="p448445144512"></a><a name="p448445144512"></a>Level1</p> 82</td> 83<td class="cellrowborder" valign="top" width="33.283328332833285%" headers="mcps1.2.4.1.2 "><p id="p44813452452"><a name="p44813452452"></a><a name="p44813452452"></a>基本</p> 84</td> 85<td class="cellrowborder" valign="top" width="33.383338333833386%" headers="mcps1.2.4.1.3 "><p id="p648184584514"><a name="p648184584514"></a><a name="p648184584514"></a>验证各功能点基本功能/基本DFX属性在常见输入下的表现，通过表示功能基本可测试。</p> 86</td> 87</tr> 88<tr id="row12856137204514"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.2.4.1.1 "><p id="p164834520453"><a name="p164834520453"></a><a name="p164834520453"></a>Level2</p> 89</td> 90<td class="cellrowborder" valign="top" width="33.283328332833285%" headers="mcps1.2.4.1.2 "><p id="p148245184511"><a name="p148245184511"></a><a name="p148245184511"></a>重要</p> 91</td> 92<td class="cellrowborder" valign="top" width="33.383338333833386%" headers="mcps1.2.4.1.3 "><p id="p348945124510"><a name="p348945124510"></a><a name="p348945124510"></a>验证各功能点的基本功能/基本DFX属性在常规输入/常见异常情况下的表现，通过表示功能基本正常可用，可开展Beta。</p> 93</td> 94</tr> 95<tr id="row48571137204514"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.2.4.1.1 "><p id="p7481545184513"><a name="p7481545184513"></a><a name="p7481545184513"></a>Level3</p> 96</td> 97<td class="cellrowborder" valign="top" width="33.283328332833285%" headers="mcps1.2.4.1.2 "><p id="p1748184514455"><a name="p1748184514455"></a><a name="p1748184514455"></a>一般</p> 98</td> 99<td class="cellrowborder" valign="top" width="33.383338333833386%" headers="mcps1.2.4.1.3 "><p id="p8481245104519"><a name="p8481245104519"></a><a name="p8481245104519"></a>验证各功能点的全部功能/全部DFX属性在各种常规/非常规输入组合下，或各种正常/异常预置条件组合下的表现。</p> 100</td> 101</tr> 102<tr id="row14857133712451"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.2.4.1.1 "><p id="p1248144515456"><a name="p1248144515456"></a><a name="p1248144515456"></a>Level4</p> 103</td> 104<td class="cellrowborder" valign="top" width="33.283328332833285%" headers="mcps1.2.4.1.2 "><p id="p94804514519"><a name="p94804514519"></a><a name="p94804514519"></a>生僻</p> 105</td> 106<td class="cellrowborder" valign="top" width="33.383338333833386%" headers="mcps1.2.4.1.3 "><p id="p1248445164516"><a name="p1248445164516"></a><a name="p1248445164516"></a>验证关键功能点在极端异常预置条件下、用户难以触及的异常输入组合下的表现。</p> 107</td> 108</tr> 109</tbody> 110</table> 111 112**表 2** 用例粒度说明 113 114<a name="table1690733521014"></a> 115<table><thead align="left"><tr id="row9907143516105"><th class="cellrowborder" valign="top" width="19.591959195919593%" id="mcps1.2.4.1.1"><p id="p1141312416102"><a name="p1141312416102"></a><a name="p1141312416102"></a>用例规模</p> 116</th> 117<th class="cellrowborder" valign="top" width="35.17351735173517%" id="mcps1.2.4.1.2"><p id="p34131416109"><a name="p34131416109"></a><a name="p34131416109"></a>被测试对象</p> 118</th> 119<th class="cellrowborder" valign="top" width="45.23452345234523%" id="mcps1.2.4.1.3"><p id="p12413141171010"><a name="p12413141171010"></a><a name="p12413141171010"></a>测试环境</p> 120</th> 121</tr> 122</thead> 123<tbody><tr id="row2907335181017"><td class="cellrowborder" valign="top" width="19.591959195919593%" headers="mcps1.2.4.1.1 "><p id="p6414134117109"><a name="p6414134117109"></a><a name="p6414134117109"></a>LargeTest</p> 124</td> 125<td class="cellrowborder" valign="top" width="35.17351735173517%" headers="mcps1.2.4.1.2 "><p id="p20414104113101"><a name="p20414104113101"></a><a name="p20414104113101"></a>业务功能/全场景特性/整机及场景级DFX</p> 126</td> 127<td class="cellrowborder" valign="top" width="45.23452345234523%" headers="mcps1.2.4.1.3 "><p id="p5414841121013"><a name="p5414841121013"></a><a name="p5414841121013"></a>尽量使用贴近真实的环境设备</p> 128</td> 129</tr> 130<tr id="row10907635131015"><td class="cellrowborder" valign="top" width="19.591959195919593%" headers="mcps1.2.4.1.1 "><p id="p19414134117104"><a name="p19414134117104"></a><a name="p19414134117104"></a>MediumTest</p> 131</td> 132<td class="cellrowborder" valign="top" width="35.17351735173517%" headers="mcps1.2.4.1.2 "><p id="p114141241141018"><a name="p114141241141018"></a><a name="p114141241141018"></a>模块/子系统集成至设备后的功能/DFX</p> 133</td> 134<td class="cellrowborder" valign="top" width="45.23452345234523%" headers="mcps1.2.4.1.3 "><p id="p14414941111015"><a name="p14414941111015"></a><a name="p14414941111015"></a>使用真实的单设备进行验证，可进行消息模拟，尽量不对函数进行MOCK</p> 135</td> 136</tr> 137<tr id="row1990713353100"><td class="cellrowborder" valign="top" width="19.591959195919593%" headers="mcps1.2.4.1.1 "><p id="p641414110109"><a name="p641414110109"></a><a name="p641414110109"></a>SmallTest</p> 138</td> 139<td class="cellrowborder" valign="top" width="35.17351735173517%" headers="mcps1.2.4.1.2 "><p id="p54141541181018"><a name="p54141541181018"></a><a name="p54141541181018"></a>模块/类/函数</p> 140</td> 141<td class="cellrowborder" valign="top" width="45.23452345234523%" headers="mcps1.2.4.1.3 "><p id="p1841494131013"><a name="p1841494131013"></a><a name="p1841494131013"></a>在开发者个人环境进行测试，尽量不依赖其他模块，存在大量的MOCK</p> 142</td> 143</tr> 144</tbody> 145</table> 146 147**表 3** 测试类型说明 148 149<a name="table18811230124619"></a> 150<table><thead align="left"><tr id="row48163019466"><th class="cellrowborder" valign="top" width="19.040000000000003%" id="mcps1.2.3.1.1"><p id="p1791784418465"><a name="p1791784418465"></a><a name="p1791784418465"></a>测试类型名称</p> 151</th> 152<th class="cellrowborder" valign="top" width="80.96%" id="mcps1.2.3.1.2"><p id="p2917164444614"><a name="p2917164444614"></a><a name="p2917164444614"></a>测试类型定义</p> 153</th> 154</tr> 155</thead> 156<tbody><tr id="row682630104615"><td class="cellrowborder" valign="top" width="19.040000000000003%" headers="mcps1.2.3.1.1 "><p id="p1091784414469"><a name="p1091784414469"></a><a name="p1091784414469"></a>Function</p> 157</td> 158<td class="cellrowborder" valign="top" width="80.96%" headers="mcps1.2.3.1.2 "><p id="p16917344104618"><a name="p16917344104618"></a><a name="p16917344104618"></a>验证被测对象提供给用户的业务功能实现正确性的测试项，这里的“用户”可以是终端用户或开发者，功能包括业务功能及平台功能</p> 159</td> 160</tr> 161<tr id="row1821930154611"><td class="cellrowborder" valign="top" width="19.040000000000003%" headers="mcps1.2.3.1.1 "><p id="p591714474612"><a name="p591714474612"></a><a name="p591714474612"></a>Performance</p> 162</td> 163<td class="cellrowborder" valign="top" width="80.96%" headers="mcps1.2.3.1.2 "><p id="p15917154410463"><a name="p15917154410463"></a><a name="p15917154410463"></a>验证被测对象在特定预置条件/负载模型下的处理能力的测试项，“处理能力”一般以单位时间内可处理的业务量来衡量，如呼叫/秒，帧率/秒，事件处理量/秒等</p> 164</td> 165</tr> 166<tr id="row13821030104616"><td class="cellrowborder" valign="top" width="19.040000000000003%" headers="mcps1.2.3.1.1 "><p id="p691711440467"><a name="p691711440467"></a><a name="p691711440467"></a>Power</p> 167</td> 168<td class="cellrowborder" valign="top" width="80.96%" headers="mcps1.2.3.1.2 "><p id="p159171544104616"><a name="p159171544104616"></a><a name="p159171544104616"></a>验证被测对象在特定预置条件/负载模型下在一定时间内能源消耗量的测试项</p> 169</td> 170</tr> 171<tr id="row6821330114618"><td class="cellrowborder" valign="top" width="19.040000000000003%" headers="mcps1.2.3.1.1 "><p id="p13917164454612"><a name="p13917164454612"></a><a name="p13917164454612"></a>Reliability</p> 172</td> 173<td class="cellrowborder" valign="top" width="80.96%" headers="mcps1.2.3.1.2 "><p id="p11917194416465"><a name="p11917194416465"></a><a name="p11917194416465"></a>验证被测对象在正常/异常输入情况下，或业务量压力和长时间连续运行压力情况下业务表现的测试项，含稳定性、压力、故障注入、Monkey测试项</p> 174</td> 175</tr> 176<tr id="row11821930184612"><td class="cellrowborder" valign="top" width="19.040000000000003%" headers="mcps1.2.3.1.1 "><p id="p1691774474618"><a name="p1691774474618"></a><a name="p1691774474618"></a>Security</p> 177</td> 178<td class="cellrowborder" valign="top" width="80.96%" headers="mcps1.2.3.1.2 "><p id="p1791784410463"><a name="p1791784410463"></a><a name="p1791784410463"></a>验证系统对恶意威胁的防护能力，威胁包括但不限于未授权访问、使用、泄露、破坏、修改、毁灭，以保障信息的机密性、完整性和可用性; 验证系统对用户隐私的保护能力，保障用户的隐私数据被收集、使用、保有、披露和处置符合法律规范，保障用户的隐私权; 验证对各类安全规范的遵从情况，如安全设计规范、安全红线、工信部安全认证规范等，保障安全相关法律法规的合规。</p> 179</td> 180</tr> 181<tr id="row16825307467"><td class="cellrowborder" valign="top" width="19.040000000000003%" headers="mcps1.2.3.1.1 "><p id="p129188444462"><a name="p129188444462"></a><a name="p129188444462"></a>Global</p> 182</td> 183<td class="cellrowborder" valign="top" width="80.96%" headers="mcps1.2.3.1.2 "><p id="p179186444465"><a name="p179186444465"></a><a name="p179186444465"></a>验证被测对象在是否具有国际化数据支持和本地化能力的测试项，包括语言显示、输入/输出习惯、时间显示、区域特性如货币时间禁忌等等</p> 184</td> 185</tr> 186<tr id="row08211308464"><td class="cellrowborder" valign="top" width="19.040000000000003%" headers="mcps1.2.3.1.1 "><p id="p191814447465"><a name="p191814447465"></a><a name="p191814447465"></a>Compatibility</p> 187</td> 188<td class="cellrowborder" valign="top" width="80.96%" headers="mcps1.2.3.1.2 "><p id="p99181344144613"><a name="p99181344144613"></a><a name="p99181344144613"></a>当被测对象为应用时，包括被测对象对于自身数据的后向兼容性、对于系统的前后向兼容性、对于不同用户数据(如播放器之音频文件格式/智能短信之用户短信内容)的兼容性测试项； 当被测对象为系统时，包括被测系统对于系统自身数据的后向兼容性、以及对于生态中常用应用的兼容性测试项；当被测对象为软件时，包括被测系统对于相关的硬件的兼容性；</p> 189</td> 190</tr> 191<tr id="row1782730124618"><td class="cellrowborder" valign="top" width="19.040000000000003%" headers="mcps1.2.3.1.1 "><p id="p13918144134614"><a name="p13918144134614"></a><a name="p13918144134614"></a>User</p> 192</td> 193<td class="cellrowborder" valign="top" width="80.96%" headers="mcps1.2.3.1.2 "><p id="p1291844494611"><a name="p1291844494611"></a><a name="p1291844494611"></a>验证被测对象在真实用户场景下的用户体验感受的测试项，注意此种情况下没有客观的“正确”与“失败”，所有的结论及评价都应该来自于用户</p> 194</td> 195</tr> 196<tr id="row58243024617"><td class="cellrowborder" valign="top" width="19.040000000000003%" headers="mcps1.2.3.1.1 "><p id="p1291884474614"><a name="p1291884474614"></a><a name="p1291884474614"></a>Standard</p> 197</td> 198<td class="cellrowborder" valign="top" width="80.96%" headers="mcps1.2.3.1.2 "><p id="p0918124424614"><a name="p0918124424614"></a><a name="p0918124424614"></a>验证被测对象对于行业及公司内标准/协议/规范的遵从情况的测试项，注意此处的“标准”不包含任何安全标准，针对安全标准的测试项划归为“安全测试”类型</p> 199</td> 200</tr> 201<tr id="row382830124619"><td class="cellrowborder" valign="top" width="19.040000000000003%" headers="mcps1.2.3.1.1 "><p id="p119181044164619"><a name="p119181044164619"></a><a name="p119181044164619"></a>Safety</p> 202</td> 203<td class="cellrowborder" valign="top" width="80.96%" headers="mcps1.2.3.1.2 "><p id="p1291818443468"><a name="p1291818443468"></a><a name="p1291818443468"></a>验证被测对象的Safety属性，避免产品可能对人身安全、健康以及产品本身带来的危害。</p> 204</td> 205</tr> 206<tr id="row1083153014465"><td class="cellrowborder" valign="top" width="19.040000000000003%" headers="mcps1.2.3.1.1 "><p id="p39187441469"><a name="p39187441469"></a><a name="p39187441469"></a>Resilience</p> 207</td> 208<td class="cellrowborder" valign="top" width="80.96%" headers="mcps1.2.3.1.2 "><p id="p891815444462"><a name="p891815444462"></a><a name="p891815444462"></a>验证被测对象的韧性属性，确保系统受攻击时承受并保持在有定义的运行状态（包括降级）、恢复并适应攻击以保障Mission达成。</p> 209</td> 210</tr> 211</tbody> 212</table> 213 214## 用例开发指导<a name="section3695134065513"></a> 215 216根据测试系统选择测试框架和对应测试用例语言。 217 218**表 4** 系统和测试框架、开发语言对应关系 219 220<a name="table4418343171415"></a> 221<table><thead align="left"><tr id="row34183435145"><th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.2.4.1.1"><p id="p941874311148"><a name="p941874311148"></a><a name="p941874311148"></a>系统</p> 222</th> 223<th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.2.4.1.2"><p id="p1841804341413"><a name="p1841804341413"></a><a name="p1841804341413"></a>测试框架</p> 224</th> 225<th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.2.4.1.3"><p id="p2418104311148"><a name="p2418104311148"></a><a name="p2418104311148"></a>语言</p> 226</th> 227</tr> 228</thead> 229<tbody><tr id="row8419164319148"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.1 "><p id="p7419194312143"><a name="p7419194312143"></a><a name="p7419194312143"></a>轻量系统</p> 230</td> 231<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.2 "><p id="p10419124312145"><a name="p10419124312145"></a><a name="p10419124312145"></a>hctest</p> 232</td> 233<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="p11419643191410"><a name="p11419643191410"></a><a name="p11419643191410"></a>c</p> 234</td> 235</tr> 236<tr id="row141915438147"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.1 "><p id="p441911436141"><a name="p441911436141"></a><a name="p441911436141"></a>小型系统</p> 237</td> 238<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.2 "><p id="p541916432142"><a name="p541916432142"></a><a name="p541916432142"></a>hcpptest</p> 239</td> 240<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="p54191643131416"><a name="p54191643131416"></a><a name="p54191643131416"></a>c++</p> 241</td> 242</tr> 243<tr id="row4419134341417"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.1 "><p id="p341964313143"><a name="p341964313143"></a><a name="p341964313143"></a>标准系统</p> 244</td> 245<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.2 "><p id="p10419443171416"><a name="p10419443171416"></a><a name="p10419443171416"></a>HJSUnit、hcpptest</p> 246</td> 247<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="p9419143181414"><a name="p9419143181414"></a><a name="p9419143181414"></a>js、c++</p> 248</td> 249</tr> 250</tbody> 251</table> 252 253### C语言用例开发编译指导（适用于轻量系统产品用例开发）<a name="section198193336544"></a> 254 255**示例：轻量系统测试用例开发** 256 257当前使用的测试框架是hctest，hctest测试框架支持使用C语言编写测试用例，是在开源测试框架unity的基础上进行增强和适配。 258 2591. 用例目录规范：测试用例存储到test/xts/acts仓中 260 261 ``` 262 ├── acts 263 │ └──subsystem_lite 264 │ │ └── module_hal 265 │ │ │ └── BUILD.gn 266 │ │ │ └── src 267 │ └──build_lite 268 │ │ └── BUILD.gn 269 ``` 270 2712. src目录下用例编写样例。 272 273 1. 引用测试框架 274 275 ``` 276 #include "hctest.h" 277 ``` 278 279 2. 使用宏定义LITE\_TEST\_SUIT定义子系统、模块、测试套件名称 280 281 ``` 282 /** 283 * @brief register a test suit named "IntTestSuite" 284 * @param test subsystem name 285 * @param example module name 286 * @param IntTestSuite test suit name 287 */ 288 LITE_TEST_SUIT(test, example, IntTestSuite); 289 ``` 290 291 3. 定义Setup与TearDown 292 293 命名方式：测试套件名称+Setup，测试套件名称+TearDown。 294 295 Setup与TearDown必须存在，可以为空函数。 296 297 4. 使用宏定义LITE\_TEST\_CASE写测试用例 298 299 包括三个参数：测试套件名称，测试用例名称，用例属性（测试类型、用例粒度、用例级别）。 300 301 ``` 302 LITE_TEST_CASE(IntTestSuite, TestCase001, Function | MediumTest | Level1) 303 { 304 //do something 305 }; 306 ``` 307 308 5. 使用宏定义 RUN\_TEST\_SUITE注册测试套件 309 310 ``` 311 RUN_TEST_SUITE(IntTestSuite); 312 ``` 313 3143. 测试模块的配置文件（BUILD.gn）样例： 315 316 在每个测试模块目录下新建BUILD.gn编译文件，用于指定编译后静态库的名称、依赖的头文件、依赖的库等；具体写法如下： 317 318 ``` 319 import("//test/xts/tools/lite/build/suite_lite.gni") 320 hctest_suite("ActsDemoTest") { 321 suite_name = "acts" 322 sources = [ 323 "src/test_demo.c", 324 ] 325 include_dirs = [ ] 326 cflags = [ "-Wno-error" ] 327 } 328 ``` 329 3304. acts下BUILD.gn增加编译选项。 331 332 需要将测试模块加入到acts目录下的编译脚本中，编译脚本路径：test/xts/acts/build\_lite/BUILD.gn。 333 334 ``` 335 lite_component("acts") { 336 ... 337 if(board_name == "liteos_m") { 338 features += [ 339 ... 340 "//xts/acts/subsystem_lite/module_hal:ActsDemoTest" 341 ] 342 } 343 } 344 ``` 345 3465. 测试套件编译命令。 347 348 随版本编译，debug版本编译时会同步编译acts测试套件 349 350 >**说明：** 351 >acts测试套件编译中间件为静态库，最终链接到版本镜像中 。 352 353 354### C语言用例执行指导（适用于轻量系统产品用例开发）<a name="section13820233175418"></a> 355 356**示例：轻量系统测试用例执行** 357 358将版本镜像烧录进开发板。 359 360**测试步骤** 361 3621. 使用串口工具登录开发板，并保存串口打印信息。 3632. 重启设备，查看串口日志。 364 365**测试结果分析指导** 366 367基于串口打印日志进行分析； 368 369每个测试套件执行以Start to run test suite开始，以xx Tests xx Failures xx Ignored结束。 370 371### C++语言用例开发编译指导（适用于小型系统、标准系统用例开发）<a name="section3822123311540"></a> 372 373**示例：小型系统测试用例开发**（标准系统参考具体样例目录：global/i18n\_standard） 374 375当前使用的测试框架是hcpptest，hcpptest测试框架是在开源的googletest测试框架的基础上进行的增强和适配。 376 3771. 规范用例目录：测试用例存储到test/xts/acts仓中。 378 379 ``` 380 ├── acts 381 │ └──subsystem_lite 382 │ │ └── module_posix 383 │ │ │ └── BUILD.gn 384 │ │ │ └── src 385 │ └──build_lite 386 │ │ └── BUILD.gn 387 ``` 388 3892. 测试模块src下用例编写样例： 390 391 1. 引用测试框架： 392 393 需要引用gtest.h 如：\#include "gtest/gtest.h" 394 395 ``` 396 #include "gtest/gtest.h" 397 ``` 398 399 2. 定义Setup与TearDown 400 401 ``` 402 using namespace std; 403 using namespace testing::ext; 404 class TestSuite: public testing::Test { 405 protected: 406 // Preset action of the test suite, which is executed before the first test case 407 static void SetUpTestCase(void){ 408 } 409 // Test suite cleanup action, which is executed after the last test case 410 static void TearDownTestCase(void){ 411 } 412 // Preset action of the test case 413 virtual void SetUp() 414 { 415 } 416 // Cleanup action of the test case 417 virtual void TearDown() 418 { 419 } 420 }; 421 ``` 422 423 3. 使用宏定义HWTEST或HWTEST\_F写测试用例 424 425 普通测试用例的定义：HWTEST（测试套名称， 测试用例名称， 用例标注）。 426 427 包含SetUp和TearDown的测试用例的定义 ：HWTEST\_F（测试套名称， 测试用例名称，用例标注）。 428 429 宏定义包括三个参数：测试套件名称，测试用例名称，用例属性（测试类型、用例粒度、用例级别）。 430 431 ``` 432 HWTEST_F(TestSuite, TestCase_0001, Function | MediumTest | Level1) { 433 // do something 434 } 435 ``` 436 4373. 测试模块下用例配置文件（BUILD.gn）样例： 438 439 每个测试模块目录下新建BUILD.gn编译文件，用于指定编译后可执行文件的名称、依赖的头文件、依赖的库等；具体写法如下。每个测试模块将独立编译成.bin可执行文件， 该文件可直接push到单板上进行测试。 440 441 举例： 442 443 ``` 444 import("//test/xts/tools/lite/build/suite_lite.gni") 445 hcpptest_suite("ActsDemoTest") { 446 suite_name = "acts" 447 sources = [ 448 "src/TestDemo.cpp" 449 ] 450 451 include_dirs = [ 452 "src", 453 ... 454 ] 455 deps = [ 456 ... 457 ] 458 cflags = [ "-Wno-error" ] 459 } 460 461 ``` 462 4634. acts目录下增加编译选项（BUILD.gn）样例： 464 465 将测试模块加入到acts目录下的编译脚本中，编译脚本为：test/xts/acts/build\_lite/BUILD.gn。 466 467 ``` 468 lite_component("acts") { 469 ... 470 else if(board_name == "liteos_a") { 471 features += [ 472 ... 473 "//xts/acts/subsystem_lite/module_posix:ActsDemoTest" 474 ] 475 } 476 } 477 ``` 478 4795. 测试套件编译命令。 480 481 随版本编译，debug版本编译时会同步编译acts测试套件 482 483 >**说明：** 484 >小型系统acts独立编译成可执行文件（bin格式）， 在编译产物的suites\\acts目录下归档。 485 486 487### C++语言用例执行指导（适用于小型系统、标准系统用例开发）<a name="section128222336544"></a> 488 489**示例：小型系统测试用例执行** 490 491目前的用例执行采用nfs共享的方式，mount到单板去执行。 492 493**环境搭建** 494 4951. 使用有限网线或无线将开发板与PC进行连接。 4962. 开发板配置IP、子网掩码、网关，确保开发板与PC处于同一个网段。 4973. PC安装nfs服务器并完成注册，启动nfs服务。 4984. 开发板配置mount命令，确保开发板可以访问PC端的nfs共享文件。 499 500 格式：mount \[nfs服务器IP\]:\[/nfs共享目录\] \[/开发板目录\] nfs 501 502 举例： 503 504 ``` 505 mount 192.168.1.10:/nfs /nfs nfs 506 ``` 507 508 509**用例执行** 510 511测试套件执行 ActsDemoTest.bin 触发用例执行，基于串口打印日志进行分析。 512 513### JS语言用例开发指导（适用于标准系统）<a name="section159801435165220"></a> 514 515当前使用的测试框架是HJSUnit，用于支撑OpenHarmony application测试（特指基于JS应用框架使用 Javascript 语言开发的 APP）进行自动化测试。 516 517**用例编写基础语法** 518 519测试用例为 js 语言，必须满足 JavaScript 语言编程规范: 520 521**表 5** 522 523<a name="table13980103565212"></a> 524<table><thead align="left"><tr id="row1098093545218"><th class="cellrowborder" valign="top" width="17.92179217921792%" id="mcps1.2.4.1.1"><p id="p49811235135214"><a name="p49811235135214"></a><a name="p49811235135214"></a>用例语法</p> 525</th> 526<th class="cellrowborder" valign="top" width="68.88688868886888%" id="mcps1.2.4.1.2"><p id="p898183565220"><a name="p898183565220"></a><a name="p898183565220"></a>描述</p> 527</th> 528<th class="cellrowborder" valign="top" width="13.19131913191319%" id="mcps1.2.4.1.3"><p id="p17981143512526"><a name="p17981143512526"></a><a name="p17981143512526"></a>要求</p> 529</th> 530</tr> 531</thead> 532<tbody><tr id="row1598183515528"><td class="cellrowborder" valign="top" width="17.92179217921792%" headers="mcps1.2.4.1.1 "><p id="p139810358527"><a name="p139810358527"></a><a name="p139810358527"></a>beforeAll</p> 533</td> 534<td class="cellrowborder" valign="top" width="68.88688868886888%" headers="mcps1.2.4.1.2 "><p id="p198111352526"><a name="p198111352526"></a><a name="p198111352526"></a>测试套级别的预置条件，在所有测试用例开始前执行且仅执行一次，支持一个参数：预置动作函数</p> 535</td> 536<td class="cellrowborder" valign="top" width="13.19131913191319%" headers="mcps1.2.4.1.3 "><p id="p298114355529"><a name="p298114355529"></a><a name="p298114355529"></a>可选</p> 537</td> 538</tr> 539<tr id="row11981103512529"><td class="cellrowborder" valign="top" width="17.92179217921792%" headers="mcps1.2.4.1.1 "><p id="p20981135135215"><a name="p20981135135215"></a><a name="p20981135135215"></a>afterAll</p> 540</td> 541<td class="cellrowborder" valign="top" width="68.88688868886888%" headers="mcps1.2.4.1.2 "><p id="p39811935115217"><a name="p39811935115217"></a><a name="p39811935115217"></a>测试套级别的清理条件，在所有测试用例结束后执行且仅执行一次，支持一个参数：清理动作函数</p> 542</td> 543<td class="cellrowborder" valign="top" width="13.19131913191319%" headers="mcps1.2.4.1.3 "><p id="p998110354527"><a name="p998110354527"></a><a name="p998110354527"></a>可选</p> 544</td> 545</tr> 546<tr id="row1298116359526"><td class="cellrowborder" valign="top" width="17.92179217921792%" headers="mcps1.2.4.1.1 "><p id="p898112359526"><a name="p898112359526"></a><a name="p898112359526"></a>beforeEach</p> 547</td> 548<td class="cellrowborder" valign="top" width="68.88688868886888%" headers="mcps1.2.4.1.2 "><p id="p149811335175215"><a name="p149811335175215"></a><a name="p149811335175215"></a>测试用例级别的预置条件，在每条测试用例开始前执行，执行次数与 it 定义的测试用例数一致，支持一个参数：预置动作函数</p> 549</td> 550<td class="cellrowborder" valign="top" width="13.19131913191319%" headers="mcps1.2.4.1.3 "><p id="p13981133585212"><a name="p13981133585212"></a><a name="p13981133585212"></a>可选</p> 551</td> 552</tr> 553<tr id="row6982435115219"><td class="cellrowborder" valign="top" width="17.92179217921792%" headers="mcps1.2.4.1.1 "><p id="p19982133517525"><a name="p19982133517525"></a><a name="p19982133517525"></a>afterEach</p> 554</td> 555<td class="cellrowborder" valign="top" width="68.88688868886888%" headers="mcps1.2.4.1.2 "><p id="p1398213575219"><a name="p1398213575219"></a><a name="p1398213575219"></a>测试用例级别的清理条件，在每条测试用例结束后执行，执行次数与 it 定义的测试用例数一致，支持一个参数：清理动作函数</p> 556</td> 557<td class="cellrowborder" valign="top" width="13.19131913191319%" headers="mcps1.2.4.1.3 "><p id="p159821535195219"><a name="p159821535195219"></a><a name="p159821535195219"></a>可选</p> 558</td> 559</tr> 560<tr id="row16982143513521"><td class="cellrowborder" valign="top" width="17.92179217921792%" headers="mcps1.2.4.1.1 "><p id="p598203510527"><a name="p598203510527"></a><a name="p598203510527"></a>describe</p> 561</td> 562<td class="cellrowborder" valign="top" width="68.88688868886888%" headers="mcps1.2.4.1.2 "><p id="p5982123595215"><a name="p5982123595215"></a><a name="p5982123595215"></a>定义一个测试套，支持两个参数：测试套名称和测试套函数； describe 支持嵌套，每个 describe 内均可以定义 beforeAll 、beforeEach 、afterEach 和 afterAll</p> 563</td> 564<td class="cellrowborder" valign="top" width="13.19131913191319%" headers="mcps1.2.4.1.3 "><p id="p898217352527"><a name="p898217352527"></a><a name="p898217352527"></a>必选</p> 565</td> 566</tr> 567<tr id="row6982113518526"><td class="cellrowborder" valign="top" width="17.92179217921792%" headers="mcps1.2.4.1.1 "><p id="p17982123510526"><a name="p17982123510526"></a><a name="p17982123510526"></a>it</p> 568</td> 569<td class="cellrowborder" valign="top" width="68.88688868886888%" headers="mcps1.2.4.1.2 "><p id="p598211352522"><a name="p598211352522"></a><a name="p598211352522"></a>定义一条测试用例，支持三个参数：用例名称，过滤参数和用例函数</p> 570<p id="p5205769588"><a name="p5205769588"></a><a name="p5205769588"></a>备注：</p> 571<p id="p6965058101"><a name="p6965058101"></a><a name="p6965058101"></a>过滤参数：过滤参数为一个 32 位的 Int 类型参数，0 位 置1表示不筛选、默认执行；0-10 位 置1表示<strong id="b9169154410212"><a name="b9169154410212"></a><a name="b9169154410212"></a>测试用例类型</strong>；16-18 位 置1表示<strong id="b1427947428"><a name="b1427947428"></a><a name="b1427947428"></a>测试用例规模</strong>；24-28 位 置1表示<strong id="b289818491213"><a name="b289818491213"></a><a name="b289818491213"></a>测试层级</strong>。</p> 572<p id="p7965165151011"><a name="p7965165151011"></a><a name="p7965165151011"></a><strong id="b69449534215"><a name="b69449534215"></a><a name="b69449534215"></a>测试用例类型</strong>。置位0-10分别表示：FUNCTION 方法类测试、PERFORMANCE 性能类测试、POWER 功耗类测试、RELIABILITY 可靠性测试、SECURITY 安全合规测试、GLOBAL 整体性测试、COMPATIBILITY 兼容性测试、USER 用户测试、STANDARD 标准测试、SAFETY 安全特性测试，RESILIENCE 压力测试。</p> 573<p id="p199651555102"><a name="p199651555102"></a><a name="p199651555102"></a><strong id="b10114125712211"><a name="b10114125712211"></a><a name="b10114125712211"></a>测试用例规模</strong>。置位16-18分别表示：SMALL 小型测试、MEDIUM 中型测试、LARGE 大型测试。</p> 574<p id="p296545151020"><a name="p296545151020"></a><a name="p296545151020"></a><strong id="b167975581223"><a name="b167975581223"></a><a name="b167975581223"></a>测试层级</strong>。置位24-28分别表示：LEVEL0-0 级测试、LEVEL1-1 级测试、LEVEL2-2 级测试、LEVEL3-3 级测试、LEVEL4-4 级测试。</p> 575</td> 576<td class="cellrowborder" valign="top" width="13.19131913191319%" headers="mcps1.2.4.1.3 "><p id="p17601752115716"><a name="p17601752115716"></a><a name="p17601752115716"></a>必选</p> 577</td> 578</tr> 579</tbody> 580</table> 581 582用例编写语法采用 jasmine 的标准语法，格式支持ES6格式。 583 5841. 规范用例目录：测试用例存储到entry/src/main/js/test目录。 585 586 ``` 587 ├── BUILD.gn 588 │ └──entry 589 │ │ └──src 590 │ │ │ └──main 591 │ │ │ │ └──js 592 │ │ │ │ │ └──default 593 │ │ │ │ │ │ └──pages 594 │ │ │ │ │ │ │ └──index 595 │ │ │ │ │ │ │ │ └──index.js # 入口文件 596 │ │ │ │ │ └──test # 测试代码存放目录 597 │ │ │ └── resources # hap资源存放目录 598 │ │ │ └── config.json # hap配置文件 599 ``` 600 6012. index.js示例 602 603 ``` 604 // 拉起js测试框架，加载测试用例 605 import {Core, ExpectExtend} from 'deccjsunit/index' 606 607 export default { 608 data: { 609 title: "" 610 }, 611 onInit() { 612 this.title = this.$t('strings.world'); 613 }, 614 onShow() { 615 console.info('onShow finish') 616 const core = Core.getInstance() 617 const expectExtend = new ExpectExtend({ 618 'id': 'extend' 619 }) 620 core.addService('expect', expectExtend) 621 core.init() 622 const configService = core.getDefaultService('config') 623 configService.setConfig(this) 624 require('../../../test/List.test') 625 core.execute() 626 }, 627 onReady() { 628 }, 629 } 630 ``` 631 6323. 单元测试用例示例 633 634 ``` 635 // Example1: 使用HJSUnit进行单元测试 636 describe('appInfoTest', function () { 637 it('app_info_test_001', 0, function () { 638 var info = app.getInfo() 639 expect(info.versionName).assertEqual('1.0') 640 expect(info.versionCode).assertEqual('3') 641 }) 642 }) 643 ``` 644 645 646### JS语言用例编译打包指导（适用于标准系统）<a name="section445519106559"></a> 647 648hap包编译请参考[标准系统js应用开发指导](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/build_overview-0000001055075201)。 649 650## 相关仓<a name="section1371113476307"></a> 651 652[xts\_acts](https://gitee.com/openharmony/xts_acts) 653 654[xts\_tools](https://gitee.com/openharmony/xts_tools) 655 656