1# XTS测评用例开发指导<a name="ZH-CN_TOPIC_0000001126156429"></a> 2 3 4## 简介<a name="section465982318513"></a> 5 6XTS子系统是OpenHarmony兼容性测评套件的集合，当前包括acts（application compatibility test suite）应用兼容性测试套件，后续会拓展dcts（device compatibility test suite）设备兼容性测试套件等。 7 8XTS子系统当前包括acts与tools软件包： 9 10- acts，存放acts相关测试用例源码与配置文件，其目的是帮助终端设备厂商尽早发现软件与OpenHarmony的不兼容性，确保软件在整个开发过程中满足OpenHarmony的兼容性要求。 11- tools，存放acts相关测试用例开发框架。 12 13## 系统类型<a name="section125090457443"></a> 14 15OpenHarmony支持如下几种系统类型： 16 17- 轻量系统（mini system） 18 19 面向MCU类处理器例如Arm Cortex-M、RISC-V 32位的设备，硬件资源极其有限，支持的设备最小内存为128KiB，可以提供多种轻量级网络协议，轻量级的图形框架，以及丰富的IOT总线读写部件等。可支撑的产品如智能家居领域的连接类模组、传感器设备、穿戴类设备等。 20 21- 小型系统（small system） 22 23 面向应用处理器例如Arm Cortex-A的设备，支持的设备最小内存为1MiB，可以提供更高的安全能力、标准的图形框架、视频编解码的多媒体能力。可支撑的产品如智能家居领域的IP Camera、电子猫眼、路由器以及智慧出行域的行车记录仪等。 24 25- 标准系统（standard system） 26 27 面向应用处理器例如Arm Cortex-A的设备，支持的设备最小内存为128MiB，可以提供增强的交互能力、3D GPU以及硬件合成能力、更多控件以及动效更丰富的图形能力、完整的应用框架。可支撑的产品如高端的冰箱显示屏。 28 29 30## 目录<a name="section161941989596"></a> 31 32``` 33/test/xts 34├── acts # 测试代码存放目录 35│ └── subsystem # 标准系统子系统测试用例源码存放目录 36│ └── subsystem_lite # 轻量系统、小型系统子系统测试用例源码存放目录 37│ └── BUILD.gn # 标准系统测试用例编译配置 38│ └── build_lite # 轻量系统、小型系统测试用例编译配置存放目录 39│ └── BUILD.gn # 轻量系统、小型系统测试用例编译配置 40└── tools # 测试工具代码存放目录 41``` 42 43## 约束<a name="section119744591305"></a> 44 45轻量系统用例开发语言是C，小型系统用例开发语言是C++。 46 47## 使用说明<a name="section137768191623"></a> 48 49**表 1** 用例级别说明 50 51<a name="table12856113719456"></a> 52<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> 53</th> 54<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> 55</th> 56<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> 57</th> 58</tr> 59</thead> 60<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> 61</td> 62<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> 63</td> 64<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> 65</td> 66</tr> 67<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> 68</td> 69<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> 70</td> 71<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> 72</td> 73</tr> 74<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> 75</td> 76<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> 77</td> 78<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> 79</td> 80</tr> 81<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> 82</td> 83<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> 84</td> 85<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> 86</td> 87</tr> 88<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> 89</td> 90<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> 91</td> 92<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> 93</td> 94</tr> 95</tbody> 96</table> 97 98**表 2** 用例粒度说明 99 100<a name="table1690733521014"></a> 101<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> 102</th> 103<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> 104</th> 105<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> 106</th> 107</tr> 108</thead> 109<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> 110</td> 111<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> 112</td> 113<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> 114</td> 115</tr> 116<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> 117</td> 118<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> 119</td> 120<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> 121</td> 122</tr> 123<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> 124</td> 125<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> 126</td> 127<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> 128</td> 129</tr> 130</tbody> 131</table> 132 133**表 3** 测试类型说明 134 135<a name="table18811230124619"></a> 136<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> 137</th> 138<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> 139</th> 140</tr> 141</thead> 142<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> 143</td> 144<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> 145</td> 146</tr> 147<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> 148</td> 149<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> 150</td> 151</tr> 152<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> 153</td> 154<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> 155</td> 156</tr> 157<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> 158</td> 159<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> 160</td> 161</tr> 162<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> 163</td> 164<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> 165</td> 166</tr> 167<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> 168</td> 169<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> 170</td> 171</tr> 172<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> 173</td> 174<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> 175</td> 176</tr> 177<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> 178</td> 179<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> 180</td> 181</tr> 182<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> 183</td> 184<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> 185</td> 186</tr> 187<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> 188</td> 189<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> 190</td> 191</tr> 192<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> 193</td> 194<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> 195</td> 196</tr> 197</tbody> 198</table> 199 200## 用例开发指导<a name="section3695134065513"></a> 201 202根据测试系统选择测试框架和对应测试用例语言。 203 204**表 4** 系统和测试框架、开发语言对应关系 205 206<a name="table4418343171415"></a> 207<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> 208</th> 209<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> 210</th> 211<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> 212</th> 213</tr> 214</thead> 215<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> 216</td> 217<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> 218</td> 219<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> 220</td> 221</tr> 222<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> 223</td> 224<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> 225</td> 226<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> 227</td> 228</tr> 229<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> 230</td> 231<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> 232</td> 233<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> 234</td> 235</tr> 236</tbody> 237</table> 238 239### C语言用例开发编译指导（适用于轻量系统产品用例开发）<a name="section198193336544"></a> 240 241**示例：轻量系统测试用例开发** 242 243当前使用的测试框架是hctest，hctest测试框架支持使用C语言编写测试用例，是在开源测试框架unity的基础上进行增强和适配。 244 2451. 用例目录规范：测试用例存储到test/xts/acts仓中 246 247 ``` 248 ├── acts 249 │ └──subsystem_lite 250 │ │ └── module_hal 251 │ │ │ └── BUILD.gn 252 │ │ │ └── src 253 │ └──build_lite 254 │ │ └── BUILD.gn 255 ``` 256 2572. src目录下用例编写样例。 258 259 1.引用测试框架 260 261 ``` 262 #include "hctest.h" 263 ``` 264 265 2. 使用宏定义LITE\_TEST\_SUIT定义子系统、模块、测试套件名称 266 267 ``` 268 /** 269 * @brief register a test suit named "IntTestSuite" 270 * @param test subsystem name 271 * @param example module name 272 * @param IntTestSuite test suit name 273 */ 274 LITE_TEST_SUIT(test, example, IntTestSuite); 275 ``` 276 277 3. 定义Setup与TearDown 278 279 命名方式：测试套件名称+Setup，测试套件名称+TearDown。 280 281 Setup与TearDown必须存在，可以为空函数。 282 283 4. 使用宏定义LITE\_TEST\_CASE写测试用例 284 285 包括三个参数：测试套件名称，测试用例名称，用例属性（测试类型、用例粒度、用例级别）。 286 287 ``` 288 LITE_TEST_CASE(IntTestSuite, TestCase001, Function | MediumTest | Level1) 289 { 290 //do something 291 }; 292 ``` 293 294 5. 使用宏定义 RUN\_TEST\_SUITE注册测试套件 295 296 ``` 297 RUN_TEST_SUITE(IntTestSuite); 298 ``` 299 3003. 测试模块的配置文件（BUILD.gn）样例： 301 302 在每个测试模块目录下新建BUILD.gn编译文件，用于指定编译后静态库的名称、依赖的头文件、依赖的库等；具体写法如下： 303 304 ``` 305 import("//test/xts/tools/lite/build/suite_lite.gni") 306 hctest_suite("ActsDemoTest") { 307 suite_name = "acts" 308 sources = [ 309 "src/test_demo.c", 310 ] 311 include_dirs = [ ] 312 cflags = [ "-Wno-error" ] 313 } 314 ``` 315 3164. acts下BUILD.gn增加编译选项。 317 318 需要将测试模块加入到acts目录下的编译脚本中，编译脚本路径：test/xts/acts/build\_lite/BUILD.gn。 319 320 ``` 321 lite_component("acts") { 322 ... 323 if(board_name == "liteos_m") { 324 features += [ 325 ... 326 "//xts/acts/subsystem_lite/module_hal:ActsDemoTest" 327 ] 328 } 329 } 330 ``` 331 3325. 测试套件编译命令。 333 334 随版本编译，debug版本编译时会同步编译acts测试套件 335 336 > **说明：** 337 >acts测试套件编译中间件为静态库，最终链接到版本镜像中 。 338 339 340### C语言用例执行指导（适用于轻量系统产品用例开发）<a name="section13820233175418"></a> 341 342**示例：轻量系统测试用例执行** 343 344将版本镜像烧录进开发板。 345 346**测试步骤** 347 3481. 使用串口工具登录开发板，并保存串口打印信息。 3492. 重启设备，查看串口日志。 350 351**测试结果分析指导** 352 353基于串口打印日志进行分析； 354 355每个测试套件执行以Start to run test suite开始，以xx Tests xx Failures xx Ignored结束。 356 357### C++语言用例开发编译指导（适用于小型系统、标准系统用例开发）<a name="section3822123311540"></a> 358 359**示例：小型系统测试用例开发**（标准参考具体样例目录：global/i18n\_standard） 360 361当前使用的测试框架是hcpptest，hcpptest测试框架是在开源的googletest测试框架的基础上进行的增强和适配。 362 3631. 规范用例目录：测试用例存储到test/xts/acts仓中。 364 365 ``` 366 ├── acts 367 │ └──subsystem_lite 368 │ │ └── module_posix 369 │ │ │ └── BUILD.gn 370 │ │ │ └── src 371 │ └──build_lite 372 │ │ └── BUILD.gn 373 ``` 374 3752. 测试模块src下用例编写样例： 376 377 1. 引用测试框架： 378 379 需要引用gtest.h 如：\#include "gtest/gtest.h" 380 381 ``` 382 #include "gtest/gtest.h" 383 ``` 384 385 2. 定义Setup与TearDown 386 387 ``` 388 using namespace std; 389 using namespace testing::ext; 390 class TestSuite: public testing::Test { 391 protected: 392 // Preset action of the test suite, which is executed before the first test case 393 static void SetUpTestCase(void){ 394 } 395 // Test suite cleanup action, which is executed after the last test case 396 static void TearDownTestCase(void){ 397 } 398 // Preset action of the test case 399 virtual void SetUp() 400 { 401 } 402 // Cleanup action of the test case 403 virtual void TearDown() 404 { 405 } 406 }; 407 ``` 408 409 3. 使用宏定义HWTEST或HWTEST\_F写测试用例 410 411 普通测试用例的定义：HWTEST（测试套名称， 测试用例名称， 用例标注）。 412 413 包含SetUp和TearDown的测试用例的定义 ：HWTEST\_F（测试套名称， 测试用例名称，用例标注）。 414 415 宏定义包括三个参数：测试套件名称，测试用例名称，用例属性（测试类型、用例粒度、用例级别）。 416 417 ``` 418 HWTEST_F(TestSuite, TestCase_0001, Function | MediumTest | Level1) { 419 // do something 420 } 421 ``` 422 4233. 测试模块下用例配置文件（BUILD.gn）样例： 424 425 每个测试模块目录下新建BUILD.gn编译文件，用于指定编译后可执行文件的名称、依赖的头文件、依赖的库等；具体写法如下。每个测试模块将独立编译成.bin可执行文件， 该文件可直接push到单板上进行测试。 426 427 举例： 428 429 ``` 430 import("//test/xts/tools/lite/build/suite_lite.gni") 431 hcpptest_suite("ActsDemoTest") { 432 suite_name = "acts" 433 sources = [ 434 "src/TestDemo.cpp" 435 ] 436 437 include_dirs = [ 438 "src", 439 ... 440 ] 441 deps = [ 442 ... 443 ] 444 cflags = [ "-Wno-error" ] 445 } 446 447 ``` 448 4494. acts目录下增加编译选项（BUILD.gn）样例： 450 451 将测试模块加入到acts目录下的编译脚本中，编译脚本为：test/xts/acts/build\_lite/BUILD.gn。 452 453 ``` 454 lite_component("acts") { 455 ... 456 else if(board_name == "liteos_a") { 457 features += [ 458 ... 459 "//xts/acts/subsystem_lite/module_posix:ActsDemoTest" 460 ] 461 } 462 } 463 ``` 464 4655. 测试套件编译命令。 466 467 随版本编译，debug版本编译时会同步编译acts测试套件 468 469 > **说明：** 470 >小型系统acts独立编译成可执行文件（bin格式）， 在编译产物的suites\\acts目录下归档。 471 472 473### C++语言用例执行指导（适用于小型系统、标准系统用例开发）<a name="section128222336544"></a> 474 475**示例：小型系统测试用例执行** 476 477目前的用例执行采用nfs共享的方式，mount到单板去执行。 478 479**环境搭建** 480 4811. 使用有限网线或无线将开发板与PC进行连接。 4822. 开发板配置IP、子网掩码、网关，确保开发板与PC处于同一个网段。 4833. PC安装nfs服务器并完成注册，启动nfs服务。 4844. 开发板配置mount命令，确保开发板可以访问PC端的nfs共享文件。 485 486 格式：mount \[nfs服务器IP\]:\[/nfs共享目录\] \[/开发板目录\] nfs 487 488 举例： 489 490 ``` 491 mount 192.168.1.10:/nfs /nfs nfs 492 ``` 493 494 495**用例执行** 496 497测试套件执行 ActsDemoTest.bin 触发用例执行，基于串口打印日志进行分析。 498 499### JS语言用例开发指导（适用于标准系统）<a name="section159801435165220"></a> 500 501当前使用的测试框架是HJSUnit，用于支撑OpenHarmony application测试（特指基于JS应用框架使用 Javascript 语言开发的 APP）进行自动化测试。 502 503**用例编写基础语法** 504 505测试用例为 js 语言，必须满足 JavaScript 语言编程规范: 506 507**表 5** 508 509<a name="table13980103565212"></a> 510<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> 511</th> 512<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> 513</th> 514<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> 515</th> 516</tr> 517</thead> 518<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> 519</td> 520<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> 521</td> 522<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> 523</td> 524</tr> 525<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> 526</td> 527<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> 528</td> 529<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> 530</td> 531</tr> 532<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> 533</td> 534<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> 535</td> 536<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> 537</td> 538</tr> 539<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> 540</td> 541<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> 542</td> 543<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> 544</td> 545</tr> 546<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> 547</td> 548<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> 549</td> 550<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> 551</td> 552</tr> 553<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> 554</td> 555<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> 556<p id="p5205769588"><a name="p5205769588"></a><a name="p5205769588"></a>备注：</p> 557<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> 558<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> 559<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> 560<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> 561</td> 562<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> 563</td> 564</tr> 565</tbody> 566</table> 567 568用例编写语法采用 jasmine 的标准语法，格式支持ES6格式。 569 5701. 规范用例目录：测试用例存储到entry/src/main/js/test目录。 571 572 ``` 573 ├── BUILD.gn 574 │ └──entry 575 │ │ └──src 576 │ │ │ └──main 577 │ │ │ │ └──js 578 │ │ │ │ │ └──default 579 │ │ │ │ │ │ └──pages 580 │ │ │ │ │ │ │ └──index 581 │ │ │ │ │ │ │ │ └──index.js # 入口文件 582 │ │ │ │ │ └──test # 测试代码存放目录 583 │ │ │ └── resources # hap资源存放目录 584 │ │ │ └── config.json # hap配置文件 585 ``` 586 5872. index.js示例 588 589 ``` 590 // 拉起js测试框架，加载测试用例 591 import {Core, ExpectExtend} from 'deccjsunit/index' 592 593 export default { 594 data: { 595 title: "" 596 }, 597 onInit() { 598 this.title = this.$t('strings.world'); 599 }, 600 onShow() { 601 console.info('onShow finish') 602 const core = Core.getInstance() 603 const expectExtend = new ExpectExtend({ 604 'id': 'extend' 605 }) 606 core.addService('expect', expectExtend) 607 core.init() 608 const configService = core.getDefaultService('config') 609 configService.setConfig(this) 610 require('../../../test/List.test') 611 core.execute() 612 }, 613 onReady() { 614 }, 615 } 616 ``` 617 6183. 单元测试用例示例 619 620 ``` 621 // Example1: 使用HJSUnit进行单元测试 622 describe('appInfoTest', function () { 623 it('app_info_test_001', 0, function () { 624 var info = app.getInfo() 625 expect(info.versionName).assertEqual('1.0') 626 expect(info.versionCode).assertEqual('3') 627 }) 628 }) 629 ``` 630 631 632### JS语言用例编译打包指导（适用于标准系统）<a name="section445519106559"></a> 633 634hap包编译请参考[标准系统js应用开发指导](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/build_overview-0000001055075201)。 635 636## 全量编译指导（适用于标准系统）<a name="section1519992743415"></a> 637 6381. 全量编译 639 640 **命令**： 641 642 ``` 643 ./build.sh suite=acts system_size=standard 644 ``` 645 646 **测试用例输出目录**：out/release/suites/acts/testcases 647 648 **测试框架&用例整体输出目录**：out/release/suites/acts（编译用例时会同步编译测试套执行框架） 649 650 651## 全量用例执行指导（适用于小型系统、标准系统）<a name="section118149111426"></a> 652 653**搭建测试环境** 654 655Windows工作台下安装python3.7及以上版本，确保工作台和测试设备正常连接。 656 657**测试执行目录**（对应编译生成的out/release/suites/acts目录） 658 659``` 660├── testcase # 测试套文件存放目录 661│ └──xxx.hap # 测试套可执行hap文件 662│ └──xxx.json # 测试套对应执行配置文件 663├── tools # 测试框架工具目录 664├── run.bat # window平台测试套启动执行文件 665├── report # 测试报告生成目录 666``` 667 668**用例执行** 669 6701. 在Windows工作台上，找到从Linux服务器上拷贝下来的测试套件用例目录\(对应编译生成的out/release/suites/acts目录\)，在Windows命令窗口进入对应目录，直接执行acts\\run.bat。 671 6721. 界面启动后，输入用例执行指令。 673 674 - 全量执行 675 676 ``` 677 run acts 678 ``` 679 680  681 682 - 模块执行\(具体模块可以查看\\acts\\testcases\\\) 683 684 ``` 685 run –l ActsSamgrTest 686 ``` 687 688  689 690 等待执行完成。 691 692 6931. 查看测试报告。 694 695 进入acts\\reports\\，获取当前的执行记录，打开“summary\_report.html”可以获取到测试报告。 696 697 698
