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 - [JavaScript-based Test Case Development \(for the Standard System\)](#section159801435165220) 14 - [JavaScript-based Test Case Packaging \(for the Standard System\)](#section445519106559) 15 - [\#EN-US\_TOPIC\_0000001126156429/section191521423950](#section191521423950) 16 17- [Full Compilation Guide \(for the Standard System\)](#section1519992743415) 18- [Full Test Case Execution Guide \(for Small and Standard Systems\)](#section118149111426) 19 20## Introduction<a name="section465982318513"></a> 21 22The X test suite \(XTS\) subsystem contains a set of OpenHarmony certification test suites, including the currently supported application compatibility test suite \(ACTS\) and the device compatibility test suite \(DCTS\) that will be supported in the future. 23 24This subsystem contains the ACTS and **tools** software package. 25 26- The **acts** directory stores the source code and configuration files of ACTS test cases. The ACTS helps device vendors detect the software incompatibility as early as possible and ensures that the software is compatible to OpenHarmony during the entire development process. 27- The **tools** software package stores the test case development framework related to **acts**. 28 29## System Types<a name="section125090457443"></a> 30 31OpenHarmony supports the following system types: 32 33- Mini system 34 35 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. 36 37- Small system 38 39 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. 40 41- Standard system 42 43 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. 44 45 46## Directory Structure<a name="section161941989596"></a> 47 48``` 49/test/xts 50├── acts # Test code 51│ └── subsystem # Source code of subsystem test cases for the standard system 52│ └── subsystem_lite # Source code of subsystems test cases for mini and small systems 53│ └── BUILD.gn # Build configuration of test cases for the standard system 54│ └── build_lite 55│ └── BUILD.gn # Build configuration of test cases for mini and small systems 56└── tools # Test tool code 57``` 58 59## Constraints<a name="section119744591305"></a> 60 61Test cases for the mini system must be developed based on C, and those for the small system must be developed based on C++. 62 63## Usage Guidelines<a name="section137768191623"></a> 64 65**Table 1** Test case levels 66 67<a name="table12856113719456"></a> 68<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> 69</th> 70<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> 71</th> 72<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> 73</th> 74</tr> 75</thead> 76<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> 77</td> 78<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> 79</td> 80<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> 81</td> 82</tr> 83<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> 84</td> 85<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> 86</td> 87<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> 88</td> 89</tr> 90<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> 91</td> 92<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> 93</td> 94<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> 95</td> 96</tr> 97<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> 98</td> 99<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> 100</td> 101<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> 102</td> 103</tr> 104<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> 105</td> 106<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> 107</td> 108<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> 109</td> 110</tr> 111</tbody> 112</table> 113 114**Table 2** Test case granularities 115 116<a name="table1690733521014"></a> 117<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> 118</th> 119<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> 120</th> 121<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> 122</th> 123</tr> 124</thead> 125<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> 126</td> 127<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> 128</td> 129<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> 130</td> 131</tr> 132<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> 133</td> 134<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> 135</td> 136<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> 137</td> 138</tr> 139<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> 140</td> 141<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> 142</td> 143<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> 144</td> 145</tr> 146</tbody> 147</table> 148 149**Table 3** Test types 150 151<a name="table18811230124619"></a> 152<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> 153</th> 154<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> 155</th> 156</tr> 157</thead> 158<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> 159</td> 160<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> 161</td> 162</tr> 163<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> 164</td> 165<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> 166</td> 167</tr> 168<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> 169</td> 170<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> 171</td> 172</tr> 173<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> 174</td> 175<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> 176</td> 177</tr> 178<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> 179</td> 180<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> 181</td> 182</tr> 183<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> 184</td> 185<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> 186</td> 187</tr> 188<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> 189</td> 190<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> 191</td> 192</tr> 193<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> 194</td> 195<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> 196</td> 197</tr> 198<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> 199</td> 200<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> 201</td> 202</tr> 203<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> 204</td> 205<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> 206</td> 207</tr> 208<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> 209</td> 210<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> 211</td> 212</tr> 213</tbody> 214</table> 215 216## Test Case Development Guidelines<a name="section3695134065513"></a> 217 218You should select the appropriate programming language and your target test framework to develop test cases. 219 220**Table 4** Test frameworks and test case languages for different systems 221 222<a name="table4418343171415"></a> 223<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> 224</th> 225<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> 226</th> 227<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> 228</th> 229</tr> 230</thead> 231<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> 232</td> 233<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> 234</td> 235<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> 236</td> 237</tr> 238<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> 239</td> 240<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> 241</td> 242<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> 243</td> 244</tr> 245<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> 246</td> 247<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> 248</td> 249<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> 250</td> 251</tr> 252</tbody> 253</table> 254 255### C-based Test Case Development and Compilation \(for the Mini System\)<a name="section198193336544"></a> 256 257**Developing test cases for the mini system** 258 259The 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. 260 2611. Access the **test/xts/acts** repository where the test cases will be stored. 262 263 ``` 264 ├── acts 265 │ └──subsystem_lite 266 │ │ └── module_hal 267 │ │ │ └── BUILD.gn 268 │ │ │ └── src 269 │ └──build_lite 270 │ │ └── BUILD.gn 271 ``` 272 2732. Write the test case in the **src** directory. 274 275 1. Import the test framework header file. 276 277 ``` 278 #include "hctest.h" 279 ``` 280 281 2. Use the **LITE\_TEST\_SUIT** macro to define names of the subsystem, module, and test suite. 282 283 ``` 284 /** 285 * @brief Registers a test suite named IntTestSuite. 286 * @param test Subsystem name 287 * @param example Module name 288 * @param IntTestSuite Test suite name 289 */ 290 LITE_TEST_SUIT(test, example, IntTestSuite); 291 ``` 292 293 3. Define Setup and TearDown. 294 295 Format: Test suite name+Setup, Test suite name+TearDown. 296 297 The Setup and TearDown functions must exist, but function bodies can be empty. 298 299 4. Use the **LITE\_TEST\_CASE** macro to write the test case. 300 301 Three parameters are involved: test suite name, test case name, and test case properties \(including type, granularity, and level\). 302 303 ``` 304 LITE_TEST_CASE(IntTestSuite, TestCase001, Function | MediumTest | Level1) 305 { 306 // Do something 307 }; 308 ``` 309 310 5. Use the **RUN\_TEST\_SUITE** macro to register the test suite. 311 312 ``` 313 RUN_TEST_SUITE(IntTestSuite); 314 ``` 315 3163. Create the configuration file \(**BUILD.gn**\) of the test module. 317 318 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: 319 320 ``` 321 import("//test/xts/tools/lite/build/suite_lite.gni") 322 hctest_suite("ActsDemoTest") { 323 suite_name = "acts" 324 sources = [ 325 "src/test_demo.c", 326 ] 327 include_dirs = [ ] 328 cflags = [ "-Wno-error" ] 329 } 330 ``` 331 3324. Add build options to the **BUILD.gn** file in the **acts** directory. 333 334 You need to add the test module to the **test/xts/acts/build\_lite/BUILD.gn** script in the **acts** directory. 335 336 ``` 337 lite_component("acts") { 338 ... 339 if(board_name == "liteos_m") { 340 features += [ 341 ... 342 "//xts/acts/subsystem_lite/module_hal:ActsDemoTest" 343 ] 344 } 345 } 346 ``` 347 3485. Run build commands. 349 350 Test suites are built along with version build. The ACTS is built together with the debug version. 351 352 > **NOTE:** 353 >The ACTS build middleware is a static library, which will be linked to the image. 354 355 356### C-based Test Case Execution \(for the Mini System\)<a name="section13820233175418"></a> 357 358**Executing test cases for the mini system** 359 360Burn the image into the development board. 361 362**Executing the test** 363 3641. Use a serial port tool to log in to the development board and save information about the serial port. 3652. Restart the device and view serial port logs. 366 367**Analyzing the test result** 368 369View the serial port logs, whose format is as follows: 370 371The log for each test suite starts with **Start to run test suite:** and ends with **xx Tests xx Failures xx Ignored**. 372 373### C++-based Test Case Development and Compilation \(for Standard and Small Systems\)<a name="section3822123311540"></a> 374 375**Developing test cases for small-system devices** \(For examples of the standard system, go to the **global/i18n\_standard directory**.\) 376 377The HCPPTest framework is enhanced and adapted based on the open-source framework Googletest. 378 3791. Access the **test/xts/acts** repository where the test cases will be stored. 380 381 ``` 382 ├── acts 383 │ └──subsystem_lite 384 │ │ └── module_posix 385 │ │ │ └── BUILD.gn 386 │ │ │ └── src 387 │ └──build_lite 388 │ │ └── BUILD.gn 389 ``` 390 3912. Write the test case in the **src** directory. 392 393 1. Import the test framework header file. 394 395 The following statement includes **gtest.h**. 396 397 ``` 398 #include "gtest/gtest.h" 399 ``` 400 401 2. Define Setup and TearDown. 402 403 ``` 404 using namespace std; 405 using namespace testing::ext; 406 class TestSuite: public testing::Test { 407 protected: 408 // Preset action of the test suite, which is executed before the first test case 409 static void SetUpTestCase(void){ 410 } 411 // Test suite cleanup action, which is executed after the last test case 412 static void TearDownTestCase(void){ 413 } 414 // Preset action of the test case 415 virtual void SetUp() 416 { 417 } 418 // Cleanup action of the test case 419 virtual void TearDown() 420 { 421 } 422 }; 423 ``` 424 425 3. Use the **HWTEST** or **HWTEST\_F** macro to write the test case. 426 427 **HWTEST**: definition of common test cases, including the test suite name, test case name, and case annotation. 428 429 **HWTEST\_F**: definition of SetUp and TearDown test cases, including the test suite name, test case name, and case annotation. 430 431 Three parameters are involved: test suite name, test case name, and test case properties \(including type, granularity, and level\). 432 433 ``` 434 HWTEST_F(TestSuite, TestCase_0001, Function | MediumTest | Level1) { 435 // Do something 436 } 437 ``` 438 4393. Create a configuration file \(**BUILD.gn**\) of the test module. 440 441 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. 442 443 Example: 444 445 ``` 446 import("//test/xts/tools/lite/build/suite_lite.gni") 447 hcpptest_suite("ActsDemoTest") { 448 suite_name = "acts" 449 sources = [ 450 "src/TestDemo.cpp" 451 ] 452 453 include_dirs = [ 454 "src", 455 ... 456 ] 457 deps = [ 458 ... 459 ] 460 cflags = [ "-Wno-error" ] 461 } 462 463 ``` 464 4654. Add build options to the **BUILD.gn** file in the **acts** directory. 466 467 Add the test module to the **test/xts/acts/build\_lite/BUILD.gn** script in the **acts** directory. 468 469 ``` 470 lite_component("acts") { 471 ... 472 else if(board_name == "liteos_a") { 473 features += [ 474 ... 475 "//xts/acts/subsystem_lite/module_posix:ActsDemoTest" 476 ] 477 } 478 } 479 ``` 480 4815. Run build commands. 482 483 Test suites are built along with the version build. The ACTS is built together with the debug version. 484 485 > **NOTE:** 486 >The ACTS for the small system is independently built to an executable file \(.bin\) and archived in the **suites\\acts** directory of the build result. 487 488 489### C++-based Test Case Execution \(for Standard and Small Systems\)<a name="section128222336544"></a> 490 491**Executing test cases for the small system** 492 493Currently, test cases are shared by the NFS and mounted to the development board for execution. 494 495**Setting up the environment** 496 4971. Use a network cable or wireless network to connect the development board to your PC. 4982. 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. 4993. Install and register the NFS server on the PC and start the NFS service. 5004. Run the **mount** command for the development board to ensure that the development board can access NFS shared files on the PC. 501 502 Format: **mount** _NFS server IP address_**:/**_NFS shared directory_ **/**_development board directory_ **nfs** 503 504 Example: 505 506 ``` 507 mount 192.168.1.10:/nfs /nfs nfs 508 ``` 509 510 511**Executing test cases** 512 513Execute **ActsDemoTest.bin** to trigger test case execution, and analyze serial port logs generated after the execution is complete. 514 515### JavaScript-based Test Case Development \(for the Standard System\)<a name="section159801435165220"></a> 516 517The HJSUnit framework is used to support automated test of OpenHarmony apps that are developed using the JavaScript language based on the JS application framework. 518 519**Basic syntax of test cases** 520 521The test cases are developed with the JavaScript language and must meet the programming specifications of the language. 522 523**Table 5** 524 525<a name="table13980103565212"></a> 526<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>Syntax</p> 527</th> 528<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>Description</p> 529</th> 530<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>Mandatory</p> 531</th> 532</tr> 533</thead> 534<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> 535</td> 536<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>Presets a test-suite-level action executed only once before all test cases are executed. You can pass the action function as the only parameter.</p> 537</td> 538<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>No</p> 539</td> 540</tr> 541<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> 542</td> 543<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>Presets a test-suite-level clear action executed only once after all test cases are executed. You can pass the clear function as the only parameter.</p> 544</td> 545<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>No</p> 546</td> 547</tr> 548<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> 549</td> 550<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>Presets a test-case-level action executed before each test case is executed. The number of execution times is the same as the number of test cases defined by <strong id="b32523248388"><a name="b32523248388"></a><a name="b32523248388"></a>it</strong>. You can pass the action function as the only parameter.</p> 551</td> 552<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>No</p> 553</td> 554</tr> 555<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> 556</td> 557<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>Presets a test-case-level clear action executed after each test case is executed. The number of execution times is the same as the number of test cases defined by <strong id="b10590142313399"><a name="b10590142313399"></a><a name="b10590142313399"></a>it</strong>. You can pass the clear function as the only parameter.</p> 558</td> 559<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>No</p> 560</td> 561</tr> 562<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> 563</td> 564<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>Defines a test suite. You can pass two parameters: test suite name and test suite function. The <strong id="b7320205019400"><a name="b7320205019400"></a><a name="b7320205019400"></a>describe</strong> statement supports nesting. You can use <strong id="b138214222410"><a name="b138214222410"></a><a name="b138214222410"></a>beforeall</strong>, <strong id="b18677102314115"><a name="b18677102314115"></a><a name="b18677102314115"></a>beforeEach</strong>, <strong id="b1353142514113"><a name="b1353142514113"></a><a name="b1353142514113"></a>afterEach</strong>, and <strong id="b131041629204111"><a name="b131041629204111"></a><a name="b131041629204111"></a>afterAll</strong> in each <strong id="b590433484116"><a name="b590433484116"></a><a name="b590433484116"></a>describe</strong> statement.</p> 565</td> 566<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>Yes</p> 567</td> 568</tr> 569<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> 570</td> 571<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>Defines a test case. You can pass three parameters: test case name, filter parameter, and test case function.</p> 572<p id="p5205769588"><a name="p5205769588"></a><a name="p5205769588"></a>Usage of the filter parameter:</p> 573<p id="p1545919528618"><a name="p1545919528618"></a><a name="p1545919528618"></a>The value of the filter parameter is a 32-bit integer. Setting different bits to <strong id="b045919521765"><a name="b045919521765"></a><a name="b045919521765"></a>1</strong> means different configurations:</p> 574<a name="ul6932113319395"></a><a name="ul6932113319395"></a><ul id="ul6932113319395"><li>bit 0: whether the filter parameter takes effect. <strong id="b1193293318395"><a name="b1193293318395"></a><a name="b1193293318395"></a>1</strong> means that the test case is used for the function test and other settings of the parameter do not take effect.</li><li>Bits 0-10: test case categories</li><li>Bits 16-18: test case scales</li><li>Bits 24-28: test levels</li></ul> 575<p id="p7965165151011"><a name="p7965165151011"></a><a name="p7965165151011"></a><strong id="b15148755145114"><a name="b15148755145114"></a><a name="b15148755145114"></a>Test case categories</strong>: Bits 0-10 indicate FUNCTION (function test), PERFORMANCE (performance test), POWER (power consumption test), RELIABILITY (reliability test), SECURITY (security compliance test), GLOBAL (integrity test), COMPATIBILITY (compatibility test), USER (user test), STANDARD (standard test), SAFETY (security feature test), and RESILIENCE (resilience test), respectively.</p> 576<p id="p199651555102"><a name="p199651555102"></a><a name="p199651555102"></a><strong id="b135908568519"><a name="b135908568519"></a><a name="b135908568519"></a>Test case scales</strong>: Bits 16-18 indicate SMALL (small-scale test), MEDIUM (medium-scale test), and LARGE (large-scale test), respectively.</p> 577<p id="p296545151020"><a name="p296545151020"></a><a name="p296545151020"></a><strong id="b12181058125111"><a name="b12181058125111"></a><a name="b12181058125111"></a>Test levels</strong>: Bits 24-28 indicate LEVEL0 (level-0 test), LEVEL1 (level-1 test), LEVEL2 (level-2 test), LEVEL3 (level-3 test), and LEVEL4 (level-4 test), respectively.</p> 578</td> 579<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>Yes</p> 580</td> 581</tr> 582</tbody> 583</table> 584 585Use the standard syntax of Jasmine to write test cases. The ES6 specification is supported. 586 5871. Store the test cases in the **entry/src/main/js/test** directory, whose structure is as follows: 588 589 ``` 590 ├── BUILD.gn 591 │ └──entry 592 │ │ └──src 593 │ │ │ └──main 594 │ │ │ │ └──js 595 │ │ │ │ │ └──default 596 │ │ │ │ │ │ └──pages 597 │ │ │ │ │ │ │ └──index 598 │ │ │ │ │ │ │ │ └──index.js # Entry file 599 │ │ │ │ │ └──test # Test code 600 │ │ │ └── resources # HAP resources 601 │ │ │ └── config.json # HAP configuration file 602 ``` 603 6042. Start the JS test framework and load test cases. The following is an example for **index.js**. 605 606 ``` 607 // Start the JS test framework and load test cases. 608 import {Core, ExpectExtend} from 'deccjsunit/index' 609 610 export default { 611 data: { 612 title: "" 613 }, 614 onInit() { 615 this.title = this.$t('strings.world'); 616 }, 617 onShow() { 618 console.info('onShow finish') 619 const core = Core.getInstance() 620 const expectExtend = new ExpectExtend({ 621 'id': 'extend' 622 }) 623 core.addService('expect', expectExtend) 624 core.init() 625 const configService = core.getDefaultService('config') 626 configService.setConfig(this) 627 require('../../../test/List.test') 628 core.execute() 629 }, 630 onReady() { 631 }, 632 } 633 ``` 634 6353. Write a unit test case by referring to the following example: 636 637 ``` 638 // Use HJSUnit to perform the unit test. 639 describe('appInfoTest', function () { 640 it('app_info_test_001', 0, function () { 641 var info = app.getInfo() 642 expect(info.versionName).assertEqual('1.0') 643 expect(info.versionCode).assertEqual('3') 644 }) 645 }) 646 ``` 647 648 649### JavaScript-based Test Case Packaging \(for the Standard System\)<a name="section445519106559"></a> 650 651For details about how to build a HAP, see the JS application development guide of the standard system [Building and Creating HAPs](https://developer.harmonyos.com/en/docs/documentation/doc-guides/build_overview-0000001055075201). 652 653## Full Compilation Guide \(for the Standard System\)<a name="section1519992743415"></a> 654 6551. Perform full building. 656 657 Command: 658 659 ``` 660 ./build.sh suite=acts system_size=standard 661 ``` 662 663 Test case output directory: **out/release/suites/acts/testcases** 664 665 Test framework and case output directory: **out/release/suites/acts** \(The test suite execution framework is compiled during case compilation.\) 666 667 668## Full Test Case Execution Guide \(for Small and Standard Systems\)<a name="section118149111426"></a> 669 670**Setting up a test environment** 671 672Install Python 3.7 or a later version on a Windows environment and ensure that the Windows environment is properly connected to the test device. 673 674**Test execution directory** \(corresponding to the **out/release/suites/acts** directory generated during compilation\) 675 676``` 677├── testcase # Directory for storing test suite files 678│ └──xxx.hap # HAP file executed by the test suite 679│ └──xxx.json # Execution configuration file of the test suite 680├── tools # Test framework tool directory 681├── run.bat # File for starting the test suite on the Windows platform 682├── report # Directory for storing the test reports 683``` 684 685**Executing test cases** 686 6871. On the Windows environment, locate the directory in which the test cases are stored \(**out/release/suites/acts**, copied from the Linux server\), go to the directory in the Windows command window, and run **acts\\run.bat**. 688 6891. Enter the command for executing the test case. 690 691 - Execute all test cases. 692 693 ``` 694 run acts 695 ``` 696 697  698 699 - Execute the test cases of a module \(view specific module information in **\\acts\\testcases\\**\). 700 701 ``` 702 run –l ActsSamgrTest 703 ``` 704 705  706 707 Wait until the test case is complete. 708 709 7101. View test reports. 711 712 Go to **acts\\reports\\**, obtain the current execution record, and open **summary\_report.html** to view the test report. 713 714 715
