1# XTS<a name="EN-US_TOPIC_0000001126156429"></a> 2 3- [Introduction](#section465982318513) 4- [System Types](#section125090457443) 5- [Directory Structure](#section161941989596) 6- [Constraints](#section119744591305) 7- [Usage Guidelines](#section137768191623) 8- [Test Case Development Guidelines](#section3695134065513) 9 - [C-based Test Case Development and Compilation \(for the Mini System\)](#section198193336544) 10 - [C-based Test Case Execution \(for the Mini System\)](#section13820233175418) 11 - [C++-based Test Case Development and Compilation \(for Standard and Small Systems\)](#section3822123311540) 12 - [C++-based Test Case Execution \(for Standard and Small Systems\)](#section128222336544) 13 14 15## Introduction<a name="section465982318513"></a> 16 17The X test suite \(XTS\) subsystem contains a set of OpenHarmony certification test suites, including the currently supported hardware abstract test suite \(HATS\). 18 19This subsystem contains the HATS and **tools** software package. 20 21- The **hats** directory stores the source code and configuration files of HATS test cases. The HATS helps device vendors detect the HAL software incompatibility as early as possible and ensures that the software is compatible to OpenHarmony during the entire development process. 22- The **tools** software package stores the test case development framework related to **hats**. 23 24## System Types<a name="section125090457443"></a> 25 26OpenHarmony supports the following system types: 27 28- Mini system 29 30 A mini system runs on the devices whose memory is greater than or equal to 128 KiB and that are equipped with MCU processors such as ARM Cortex-M and 32-bit RISC-V. This system provides multiple lightweight network protocols and graphics frameworks, and a wide range of read/write components for the IoT bus. Typical products include connection modules, sensors, and wearables for smart home. 31 32- Small system 33 34 A small system runs on the devices whose memory is greater than or equal to 1 MiB and that are equipped with application processors such as ARM Cortex-A. This system provides higher security capabilities, standard graphics frameworks, and video encoding and decoding capabilities. Typical products include smart home IP cameras, electronic cat eyes, and routers, and event data recorders \(EDRs\) for smart travel. 35 36- Standard system 37 38 A standard system runs on the devices whose memory is greater than or equal to 128 MiB and that are equipped with application processors such as ARM Cortex-A. This system provides a complete application framework supporting the enhanced interaction, 3D GPU, hardware composer, diverse components, and rich animations. This system applies to high-end refrigerator displays. 39 40 41## Directory Structure<a name="section161941989596"></a> 42 43``` 44/test/xts 45├── hats # Test code 46│ └── subsystem # Source code of subsystem test cases for the standard system 47│ └── subsystem_lite # Source code of subsystems test cases for mini and small systems 48│ └── BUILD.gn # Build configuration of test cases for the standard system 49│ └── build_lite 50│ └── BUILD.gn # Build configuration of test cases for mini and small systems 51└── tools # Test tool code 52``` 53 54## Constraints<a name="section119744591305"></a> 55 56Test cases for the mini system must be developed based on C, and those for the small system must be developed based on C++. 57 58## Usage Guidelines<a name="section137768191623"></a> 59 60**Table 1** Test case levels 61 62<a name="table12856113719456"></a> 63<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>Level</p> 64</th> 65<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>Definition</p> 66</th> 67<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>Scope</p> 68</th> 69</tr> 70</thead> 71<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> 72</td> 73<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>Smoke</p> 74</td> 75<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>Verifies basic functionalities of key features and basic DFX attributes with the most common input. The pass result indicates that the features are runnable.</p> 76</td> 77</tr> 78<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> 79</td> 80<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>Basic</p> 81</td> 82<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>Verifies basic functionalities of key features and basic DFX attributes with common input. The pass result indicates that the features are testable.</p> 83</td> 84</tr> 85<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> 86</td> 87<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>Major</p> 88</td> 89<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>Verifies basic functionalities of key features and basic DFX attributes with common input and errors. The pass result indicates that the features are functional and ready for beta testing.</p> 90</td> 91</tr> 92<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> 93</td> 94<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>Regular</p> 95</td> 96<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>Verifies functionalities of all key features, and all DFX attributes with common and uncommon input combinations or normal and abnormal preset conditions.</p> 97</td> 98</tr> 99<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> 100</td> 101<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>Rare</p> 102</td> 103<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>Verifies functionalities of key features under extremely abnormal presets and uncommon input combinations.</p> 104</td> 105</tr> 106</tbody> 107</table> 108 109**Table 2** Test case granularities 110 111<a name="table1690733521014"></a> 112<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>Test Scale</p> 113</th> 114<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>Test Objects</p> 115</th> 116<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>Test Environment</p> 117</th> 118</tr> 119</thead> 120<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> 121</td> 122<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>Service functionalities, all-scenario features, and mechanical power environment (MPE) and scenario-level DFX</p> 123</td> 124<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>Devices close to real devices</p> 125</td> 126</tr> 127<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> 128</td> 129<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>Modules, subsystem functionalities after module integration, and DFX</p> 130</td> 131<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>Single device that is actually used. You can perform message simulation, but do not mock functions.</p> 132</td> 133</tr> 134<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> 135</td> 136<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>Modules, classes, and functions</p> 137</td> 138<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>Local PC. Use a large number of mocks to replace dependencies with other modules.</p> 139</td> 140</tr> 141</tbody> 142</table> 143 144**Table 3** Test types 145 146<a name="table18811230124619"></a> 147<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>Type</p> 148</th> 149<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>Definition</p> 150</th> 151</tr> 152</thead> 153<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> 154</td> 155<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>Tests the correctness of both service and platform functionalities provided by the tested object for end users or developers.</p> 156</td> 157</tr> 158<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> 159</td> 160<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>Tests the processing capability of the tested object under specific preset conditions and load models. The processing capability is measured by the service volume that can be processed in a unit time, for example, call per second, frame per second, or event processing volume per second.</p> 161</td> 162</tr> 163<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> 164</td> 165<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>Tests the power consumption of the tested object in a certain period of time under specific preset conditions and load models.</p> 166</td> 167</tr> 168<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> 169</td> 170<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>Tests the service performance of the tested object under common and uncommon input conditions, or specified service volume pressure and long-term continuous running pressure. The test covers stability, pressure handling, fault injection, and Monkey test times.</p> 171</td> 172</tr> 173<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> 174</td> 175<td class="cellrowborder" valign="top" width="80.96%" headers="mcps1.2.3.1.2 "><a name="ul112421652121513"></a><a name="ul112421652121513"></a><ul id="ul112421652121513"><li>Tests the capability of defending against security threats, including but not limited to unauthorized access, use, disclosure, damage, modification, and destruction, to ensure information confidentiality, integrity, and availability.</li><li>Tests the privacy protection capability to ensure that the collection, use, retention, disclosure, and disposal of users' private data comply with laws and regulations.</li><li>Tests the compliance with various security specifications, such as security design, security requirements, and security certification of the Ministry of Industry and Information Technology (MIIT).</li></ul> 176</td> 177</tr> 178<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> 179</td> 180<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>Tests the internationalized data and localization capabilities of the tested object, including multi-language display, various input/output habits, time formats, and regional features, such as currency, time, and culture taboos.</p> 181</td> 182</tr> 183<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> 184</td> 185<td class="cellrowborder" valign="top" width="80.96%" headers="mcps1.2.3.1.2 "><a name="ul186961827111612"></a><a name="ul186961827111612"></a><ul id="ul186961827111612"><li>Tests backward compatibility of an application with its own data, the forward and backward compatibility with the system, and the compatibility with different user data, such as audio file content of the player and smart SMS messages.</li><li>Tests system backward compatibility with its own data and the compatibility of common applications in the ecosystem.</li><li>Tests software compatibility with related hardware.</li></ul> 186</td> 187</tr> 188<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> 189</td> 190<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>Tests user experience of the object in real user scenarios. All conclusions and comments should come from the users, which are all subjective evaluation in this case.</p> 191</td> 192</tr> 193<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> 194</td> 195<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>Tests the compliance with industry and company-specific standards, protocols, and specifications. The standards here do not include any security standards that should be classified into the security test.</p> 196</td> 197</tr> 198<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> 199</td> 200<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>Tests the safety property of the tested object to avoid possible hazards to personal safety, health, and the object itself.</p> 201</td> 202</tr> 203<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> 204</td> 205<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>Tests the resilience property of the tested object to ensure that it can withstand and maintain the defined running status (including downgrading) when being attacked, and recover from and adapt defense to the attacks to approach mission assurance.</p> 206</td> 207</tr> 208</tbody> 209</table> 210 211## Test Case Development Guidelines<a name="section3695134065513"></a> 212 213You should select the appropriate programming language and your target test framework to develop test cases. 214 215**Table 4** Test frameworks and test case languages for different systems 216 217<a name="table4418343171415"></a> 218<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>System</p> 219</th> 220<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>Test Framework</p> 221</th> 222<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>Language</p> 223</th> 224</tr> 225</thead> 226<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>Mini</p> 227</td> 228<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> 229</td> 230<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> 231</td> 232</tr> 233<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>Small</p> 234</td> 235<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> 236</td> 237<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> 238</td> 239</tr> 240<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>Standard</p> 241</td> 242<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 and HCPPTest</p> 243</td> 244<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>JavaScript and C++</p> 245</td> 246</tr> 247</tbody> 248</table> 249 250### C-based Test Case Development and Compilation \(for the Mini System\)<a name="section198193336544"></a> 251 252**Developing test cases for the mini system** 253 254The HCTest framework is used to support test cases developed with the C language. HCTest is enhanced and adapted based on the open-source test framework Unity. 255 2561. Access the **test/xts/hats** repository where the test cases will be stored. 257 258 ``` 259 ├── hats 260 │ └──subsystem_lite 261 │ │ └── module_hal 262 │ │ │ └── BUILD.gn 263 │ │ │ └── src 264 │ └──build_lite 265 │ │ └── BUILD.gn 266 ``` 267 2682. Write the test case in the **src** directory. 269 270 1 Import the test framework header file. 271 272 ``` 273 #include "hctest.h" 274 ``` 275 276 2. Use the **LITE\_TEST\_SUIT** macro to define names of the subsystem, module, and test suite. 277 278 ``` 279 /** 280 * @brief Registers a test suite named IntTestSuite. 281 * @param test Subsystem name 282 * @param example Module name 283 * @param IntTestSuite Test suite name 284 */ 285 LITE_TEST_SUIT(test, example, IntTestSuite); 286 ``` 287 288 3. Define Setup and TearDown. 289 290 Format: Test suite name+Setup, Test suite name+TearDown. 291 292 The Setup and TearDown functions must exist, but function bodies can be empty. 293 294 4. Use the **LITE\_TEST\_CASE** macro to write the test case. 295 296 Three parameters are involved: test suite name, test case name, and test case properties \(including type, granularity, and level\). 297 298 ``` 299 LITE_TEST_CASE(IntTestSuite, TestCase001, Function | MediumTest | Level1) 300 { 301 // Do something 302 }; 303 ``` 304 305 5. Use the **RUN\_TEST\_SUITE** macro to register the test suite. 306 307 ``` 308 RUN_TEST_SUITE(IntTestSuite); 309 ``` 310 3113. Create the configuration file \(**BUILD.gn**\) of the test module. 312 313 Create a **BUILD.gn** \(example\) build file in each test module directory. Specify the name of the built static library and its dependent header file and library in the build file. The format is as follows: 314 315 ``` 316 import("//test/xts/tools/lite/build/suite_lite.gni") 317 hctest_suite("HatsDemoTest") { 318 suite_name = "hats" 319 sources = [ 320 "src/test_demo.c", 321 ] 322 include_dirs = [ ] 323 cflags = [ "-Wno-error" ] 324 } 325 ``` 326 3274. Add build options to the **BUILD.gn** file in the **hats** directory. 328 329 You need to add the test module to the **test/xts/hats/build\_lite/BUILD.gn** script in the **hats** directory. 330 331 ``` 332 lite_component("hats") { 333 ... 334 if(board_name == "liteos_m") { 335 features += [ 336 ... 337 "//xts/hats/subsystem_lite/module_hal:HatsDemoTest" 338 ] 339 } 340 } 341 ``` 342 3435. Run build commands. 344 345 Test suites are built along with version build. The HATS is built together with the debug version. 346 347 > **NOTE:** 348 >The HATS build middleware is a static library, which will be linked to the image. 349 350 351### C-based Test Case Execution \(for the Mini System\)<a name="section13820233175418"></a> 352 353**Executing test cases for the mini system** 354 355Burn the image into the development board. 356 357**Executing the test** 358 3591. Use a serial port tool to log in to the development board and save information about the serial port. 3602. Restart the device and view serial port logs. 361 362**Analyzing the test result** 363 364View the serial port logs, whose format is as follows: 365 366The log for each test suite starts with **Start to run test suite:** and ends with **xx Tests xx Failures xx Ignored**. 367 368### C++-based Test Case Development and Compilation \(for Standard and Small Systems\)<a name="section3822123311540"></a> 369 370**Developing test cases for small-system devices** \(For examples of the standard system, go to the **global/i18n\_standard directory**.\) 371 372The HCPPTest framework is enhanced and adapted based on the open-source framework Googletest. 373 3741. Access the **test/xts/hats** repository where the test cases will be stored. 375 376 ``` 377 ├── hats 378 │ └──subsystem_lite 379 │ │ └── module_posix 380 │ │ │ └── BUILD.gn 381 │ │ │ └── src 382 │ └──build_lite 383 │ │ └── BUILD.gn 384 ``` 385 3862. Write the test case in the **src** directory. 387 388 1. Import the test framework header file. 389 390 The following statement includes **gtest.h**. 391 392 ``` 393 #include "gtest/gtest.h" 394 ``` 395 396 2. Define Setup and TearDown. 397 398 ``` 399 using namespace std; 400 using namespace testing::ext; 401 class TestSuite: public testing::Test { 402 protected: 403 // Preset action of the test suite, which is executed before the first test case 404 static void SetUpTestCase(void){ 405 } 406 // Test suite cleanup action, which is executed after the last test case 407 static void TearDownTestCase(void){ 408 } 409 // Preset action of the test case 410 virtual void SetUp() 411 { 412 } 413 // Cleanup action of the test case 414 virtual void TearDown() 415 { 416 } 417 }; 418 ``` 419 420 3. Use the **HWTEST** or **HWTEST\_F** macro to write the test case. 421 422 **HWTEST**: definition of common test cases, including the test suite name, test case name, and case annotation. 423 424 **HWTEST\_F**: definition of SetUp and TearDown test cases, including the test suite name, test case name, and case annotation. 425 426 Three parameters are involved: test suite name, test case name, and test case properties \(including type, granularity, and level\). 427 428 ``` 429 HWTEST_F(TestSuite, TestCase_0001, Function | MediumTest | Level1) { 430 // Do something 431 } 432 ``` 433 4343. Create a configuration file \(**BUILD.gn**\) of the test module. 435 436 Create a **BUILD.gn** build file in each test module directory. Specify the name of the built static library and its dependent header file and library in the build file. Each test module is independently built into a **.bin** executable file, which can be directly pushed to the development board for testing. 437 438 Example: 439 440 ``` 441 import("//test/xts/tools/lite/build/suite_lite.gni") 442 hcpptest_suite("HatsDemoTest") { 443 suite_name = "hats" 444 sources = [ 445 "src/TestDemo.cpp" 446 ] 447 448 include_dirs = [ 449 "src", 450 ... 451 ] 452 deps = [ 453 ... 454 ] 455 cflags = [ "-Wno-error" ] 456 } 457 ``` 458 4594. Add build options to the **BUILD.gn** file in the **hats** directory. 460 461 Add the test module to the **test/xts/hats/build\_lite/BUILD.gn** script in the **hats** directory. 462 463 ``` 464 lite_component("hats") { 465 ... 466 else if(board_name == "liteos_a") { 467 features += [ 468 ... 469 "//xts/hats/subsystem_lite/module_posix:HatsDemoTest" 470 ] 471 } 472 } 473 ``` 474 4755. Run build commands. 476 477 Test suites are built along with the version build. The HATS is built together with the debug version. 478 479 > **NOTE:** 480 >The HATS for the small system is independently built to an executable file \(.bin\) and archived in the **suites\\hats** directory of the build result. 481 482 483### C++-based Test Case Execution \(for Standard and Small Systems\)<a name="section128222336544"></a> 484 485**Executing test cases for the small system** 486 487Currently, test cases are shared by the NFS and mounted to the development board for execution. 488 489**Setting up the environment** 490 4911. Use a network cable or wireless network to connect the development board to your PC. 4922. Configure the IP address, subnet mask, and gateway for the development board. Ensure that the development board and the PC are in the same network segment. 4933. Install and register the NFS server on the PC and start the NFS service. 4944. Run the **mount** command for the development board to ensure that the development board can access NFS shared files on the PC. 495 496 Format: **mount** _NFS server IP address_**:/**_NFS shared directory_ **/**_development board directory_ **nfs** 497 498 Example: 499 500 ``` 501 mount 192.168.1.10:/nfs /nfs nfs 502 ``` 503 504 505**Executing test cases** 506 507Execute **HatsDemoTest.bin** to trigger test case execution, and analyze serial port logs generated after the execution is complete. 508
