1# XTS Test Case Development<a name="EN-US_TOPIC_0000001126156429"></a> 2 3## Introduction<a name="section465982318513"></a> 4 5The X test suite \(XTS\) subsystem contains a set of OpenHarmony compatibility 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. 6 7This subsystem contains the ACTS and **tools** software package. 8 9- 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. 10- The **tools** software package stores the test case development framework related to **acts**. 11 12## System Types<a name="section125090457443"></a> 13 14OpenHarmony supports the following system types: 15 16- Mini system 17 18 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. 19 20- Small system 21 22 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. 23 24- Standard system 25 26 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. 27 28 29## Directory Structure<a name="section161941989596"></a> 30 31``` 32/test/xts 33├── acts # Test code 34│ └── subsystem # Source code of subsystem test cases for the standard system 35│ └── subsystem_lite # Source code of subsystems test cases for mini and small systems 36│ └── BUILD.gn # Build configuration of test cases for the standard system 37│ └── build_lite 38│ └── BUILD.gn # Build configuration of test cases for mini and small systems 39└── tools # Test tool code 40``` 41 42## Constraints<a name="section119744591305"></a> 43 44Test cases for the mini system must be developed based on C, and those for the small system must be developed based on C++. 45 46## Usage Guidelines<a name="section137768191623"></a> 47 48**Table 1** Test case levels 49 50<a name="table12856113719456"></a> 51<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> 52</th> 53<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> 54</th> 55<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> 56</th> 57</tr> 58</thead> 59<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> 60</td> 61<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> 62</td> 63<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> 64</td> 65</tr> 66<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> 67</td> 68<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> 69</td> 70<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> 71</td> 72</tr> 73<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> 74</td> 75<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> 76</td> 77<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> 78</td> 79</tr> 80<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> 81</td> 82<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> 83</td> 84<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> 85</td> 86</tr> 87<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> 88</td> 89<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> 90</td> 91<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> 92</td> 93</tr> 94</tbody> 95</table> 96 97**Table 2** Test case granularities 98 99<a name="table1690733521014"></a> 100<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> 101</th> 102<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> 103</th> 104<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> 105</th> 106</tr> 107</thead> 108<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> 109</td> 110<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> 111</td> 112<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> 113</td> 114</tr> 115<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> 116</td> 117<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> 118</td> 119<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> 120</td> 121</tr> 122<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> 123</td> 124<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> 125</td> 126<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> 127</td> 128</tr> 129</tbody> 130</table> 131 132**Table 3** Test types 133 134<a name="table18811230124619"></a> 135<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> 136</th> 137<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> 138</th> 139</tr> 140</thead> 141<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> 142</td> 143<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> 144</td> 145</tr> 146<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> 147</td> 148<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> 149</td> 150</tr> 151<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> 152</td> 153<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> 154</td> 155</tr> 156<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> 157</td> 158<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> 159</td> 160</tr> 161<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> 162</td> 163<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> 164</td> 165</tr> 166<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> 167</td> 168<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> 169</td> 170</tr> 171<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> 172</td> 173<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> 174</td> 175</tr> 176<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> 177</td> 178<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> 179</td> 180</tr> 181<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> 182</td> 183<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> 184</td> 185</tr> 186<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> 187</td> 188<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> 189</td> 190</tr> 191<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> 192</td> 193<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> 194</td> 195</tr> 196</tbody> 197</table> 198 199## Test Case Development Guidelines<a name="section3695134065513"></a> 200 201You should select the appropriate programming language and your target test framework to develop test cases. 202 203**Table 4** Test frameworks and test case languages for different systems 204 205<a name="table4418343171415"></a> 206<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> 207</th> 208<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> 209</th> 210<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> 211</th> 212</tr> 213</thead> 214<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> 215</td> 216<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> 217</td> 218<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> 219</td> 220</tr> 221<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> 222</td> 223<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> 224</td> 225<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> 226</td> 227</tr> 228<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> 229</td> 230<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> 231</td> 232<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> 233</td> 234</tr> 235</tbody> 236</table> 237 238### C-based Test Case Development and Compilation \(for the Mini System\)<a name="section198193336544"></a> 239 240**Developing test cases for the mini system** 241 242The 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. 243 2441. Access the **test/xts/acts** repository where the test cases will be stored. 245 246 ``` 247 ├── acts 248 │ └──subsystem_lite 249 │ │ └── module_hal 250 │ │ │ └── BUILD.gn 251 │ │ │ └── src 252 │ └──build_lite 253 │ │ └── BUILD.gn 254 ``` 255 2562. Write the test case in the **src** directory. 257 258 1. Import the test framework header file. 259 260 ``` 261 #include "hctest.h" 262 ``` 263 264 2. Use the **LITE\_TEST\_SUIT** macro to define names of the subsystem, module, and test suite. 265 266 ``` 267 /** 268 * @brief Registers a test suite named IntTestSuite. 269 * @param test Subsystem name 270 * @param example Module name 271 * @param IntTestSuite Test suite name 272 */ 273 LITE_TEST_SUIT(test, example, IntTestSuite); 274 ``` 275 276 3. Define Setup and TearDown. 277 278 Format: Test suite name+Setup, Test suite name+TearDown. 279 280 The Setup and TearDown functions must exist, but function bodies can be empty. 281 282 4. Use the **LITE\_TEST\_CASE** macro to write the test case. 283 284 Three parameters are involved: test suite name, test case name, and test case properties \(including type, granularity, and level\). 285 286 ``` 287 LITE_TEST_CASE(IntTestSuite, TestCase001, Function | MediumTest | Level1) 288 { 289 // Do something 290 }; 291 ``` 292 293 5. Use the **RUN\_TEST\_SUITE** macro to register the test suite. 294 295 ``` 296 RUN_TEST_SUITE(IntTestSuite); 297 ``` 298 2993. Create the configuration file \(**BUILD.gn**\) of the test module. 300 301 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: 302 303 ``` 304 import("//test/xts/tools/lite/build/suite_lite.gni") 305 hctest_suite("ActsDemoTest") { 306 suite_name = "acts" 307 sources = [ 308 "src/test_demo.c", 309 ] 310 include_dirs = [ ] 311 cflags = [ "-Wno-error" ] 312 } 313 ``` 314 3154. Add build options to the **BUILD.gn** file in the **acts** directory. 316 317 You need to add the test module to the **test/xts/acts/build\_lite/BUILD.gn** script in the **acts** directory. 318 319 ``` 320 lite_component("acts") { 321 ... 322 if(board_name == "liteos_m") { 323 features += [ 324 ... 325 "//xts/acts/subsystem_lite/module_hal:ActsDemoTest" 326 ] 327 } 328 } 329 ``` 330 3315. Run build commands. 332 333 Test suites are built along with version build. The ACTS is built together with the debug version. 334 335 > **NOTE** 336 >The ACTS build middleware is a static library, which will be linked to the image. 337 338 339### C-based Test Case Execution \(for the Mini System\)<a name="section13820233175418"></a> 340 341**Executing test cases for the mini system** 342 343Burn the image into the development board. 344 345**Executing the test** 346 3471. Use a serial port tool to log in to the development board and save information about the serial port. 3482. Restart the device and view serial port logs. 349 350**Analyzing the test result** 351 352View the serial port logs, whose format is as follows: 353 354The log for each test suite starts with **Start to run test suite:** and ends with **xx Tests xx Failures xx Ignored**. 355 356### C++-based Test Case Development and Compilation \(for Standard and Small Systems\)<a name="section3822123311540"></a> 357 358**Developing test cases for small-system devices** \(For examples of the standard system, go to the **global/i18n\_standard directory**.\) 359 360The HCPPTest framework is enhanced and adapted based on the open-source framework Googletest. 361 3621. Access the **test/xts/acts** repository where the test cases will be stored. 363 364 ``` 365 ├── acts 366 │ └──subsystem_lite 367 │ │ └── module_posix 368 │ │ │ └── BUILD.gn 369 │ │ │ └── src 370 │ └──build_lite 371 │ │ └── BUILD.gn 372 ``` 373 3742. Write the test case in the **src** directory. 375 376 1. Import the test framework header file. 377 378 The following statement includes **gtest.h**. 379 380 ``` 381 #include "gtest/gtest.h" 382 ``` 383 384 2. Define Setup and TearDown. 385 386 ``` 387 using namespace std; 388 using namespace testing::ext; 389 class TestSuite: public testing::Test { 390 protected: 391 // Preset action of the test suite, which is executed before the first test case 392 static void SetUpTestCase(void){ 393 } 394 // Test suite cleanup action, which is executed after the last test case 395 static void TearDownTestCase(void){ 396 } 397 // Preset action of the test case 398 virtual void SetUp() 399 { 400 } 401 // Cleanup action of the test case 402 virtual void TearDown() 403 { 404 } 405 }; 406 ``` 407 408 3. Use the **HWTEST** or **HWTEST\_F** macro to write the test case. 409 410 **HWTEST**: definition of common test cases, including the test suite name, test case name, and case annotation. 411 412 **HWTEST\_F**: definition of SetUp and TearDown test cases, including the test suite name, test case name, and case annotation. 413 414 Three parameters are involved: test suite name, test case name, and test case properties \(including type, granularity, and level\). 415 416 ``` 417 HWTEST_F(TestSuite, TestCase_0001, Function | MediumTest | Level1) { 418 // Do something 419 } 420 ``` 421 4223. Create a configuration file \(**BUILD.gn**\) of the test module. 423 424 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. 425 426 Example: 427 428 ``` 429 import("//test/xts/tools/lite/build/suite_lite.gni") 430 hcpptest_suite("ActsDemoTest") { 431 suite_name = "acts" 432 sources = [ 433 "src/TestDemo.cpp" 434 ] 435 436 include_dirs = [ 437 "src", 438 ... 439 ] 440 deps = [ 441 ... 442 ] 443 cflags = [ "-Wno-error" ] 444 } 445 446 ``` 447 4484. Add build options to the **BUILD.gn** file in the **acts** directory. 449 450 Add the test module to the **test/xts/acts/build\_lite/BUILD.gn** script in the **acts** directory. 451 452 ``` 453 lite_component("acts") { 454 ... 455 else if(board_name == "liteos_a") { 456 features += [ 457 ... 458 "//xts/acts/subsystem_lite/module_posix:ActsDemoTest" 459 ] 460 } 461 } 462 ``` 463 4645. Run build commands. 465 466 Test suites are built along with the version build. The ACTS is built together with the debug version. 467 468 > **NOTE:** 469 >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. 470 471 472### C++-based Test Case Execution \(for Standard and Small Systems\)<a name="section128222336544"></a> 473 474**Executing test cases for the small system** 475 476Currently, test cases are shared by the NFS and mounted to the development board for execution. 477 478**Setting up the environment** 479 4801. Use a network cable or wireless network to connect the development board to your PC. 4812. 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. 4823. Install and register the NFS server on the PC and start the NFS service. 4834. Run the **mount** command for the development board to ensure that the development board can access NFS shared files on the PC. 484 485 Format: **mount** _NFS server IP address_**:/**_NFS shared directory_ **/**_development board directory_ **nfs** 486 487 Example: 488 489 ``` 490 mount 192.168.1.10:/nfs /nfs nfs 491 ``` 492 493 494**Executing test cases** 495 496Execute **ActsDemoTest.bin** to trigger test case execution, and analyze serial port logs generated after the execution is complete. 497 498### JavaScript-based Test Case Development \(for the Standard System\)<a name="section159801435165220"></a> 499 500The HJSUnit framework is used to support automated test of OpenHarmony apps that are developed using the JavaScript language based on the JS application framework. 501 502**Basic syntax of test cases** 503 504The test cases are developed with the JavaScript language and must meet the programming specifications of the language. 505 506**Table 5** 507 508<a name="table13980103565212"></a> 509 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>Syntax</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>Description</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>Mandatory</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>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> 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>No</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>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> 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>No</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>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> 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>No</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>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> 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>No</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>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> 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>Yes</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>Defines a test case. You can pass three parameters: test case name, filter parameter, and test case function.</p> 556<p id="p5205769588"><a name="p5205769588"></a><a name="p5205769588"></a>Usage of the filter parameter:</p> 557<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> 558<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> 559<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> 560<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> 561<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> 562</td> 563<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> 564</td> 565</tr> 566</tbody> 567</table> 568 569Use the standard syntax of Jasmine to write test cases. The ES6 specification is supported. 570 5711. Store the test cases in the **entry/src/main/js/test** directory, whose structure is as follows: 572 573 ``` 574 ├── BUILD.gn 575 │ └──entry 576 │ │ └──src 577 │ │ │ └──main 578 │ │ │ │ └──js 579 │ │ │ │ │ └──default 580 │ │ │ │ │ │ └──pages 581 │ │ │ │ │ │ │ └──index 582 │ │ │ │ │ │ │ │ └──index.js # Entry file 583 │ │ │ │ │ └──test # Test code 584 │ │ │ └── resources # HAP resources 585 │ │ │ └── config.json # HAP configuration file 586 ``` 587 5882. Start the JS test framework and load test cases. The following is an example for **index.js**. 589 590 ``` 591 // Start the JS test framework and load test cases. 592 import {Core, ExpectExtend} from 'deccjsunit/index' 593 594 export default { 595 data: { 596 title: "" 597 }, 598 onInit() { 599 this.title = this.$t('strings.world'); 600 }, 601 onShow() { 602 console.info('onShow finish') 603 const core = Core.getInstance() 604 const expectExtend = new ExpectExtend({ 605 'id': 'extend' 606 }) 607 core.addService('expect', expectExtend) 608 core.init() 609 const configService = core.getDefaultService('config') 610 configService.setConfig(this) 611 require('../../../test/List.test') 612 core.execute() 613 }, 614 onReady() { 615 }, 616 } 617 ``` 618 6193. Write a unit test case by referring to the following example: 620 621 ``` 622 // Use HJSUnit to perform the unit test. 623 describe('appInfoTest', function () { 624 it('app_info_test_001', 0, function () { 625 var info = app.getInfo() 626 expect(info.versionName).assertEqual('1.0') 627 expect(info.versionCode).assertEqual('3') 628 }) 629 }) 630 ``` 631 632 633### JavaScript-based Test Case Packaging \(for the Standard System\)<a name="section445519106559"></a> 634 635For 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). 636 637## Full Compilation Guide \(for the Standard System\)<a name="section1519992743415"></a> 638 6391. Perform full building. 640 641 Command: 642 643 ``` 644 ./build.sh suite=acts system_size=standard 645 ``` 646 647 Test case output directory: **out/release/suites/acts/testcases** 648 649 Test framework and case output directory: **out/release/suites/acts** \(The test suite execution framework is compiled during case compilation.\) 650 651 652## Full Test Case Execution Guide \(for Small and Standard Systems\)<a name="section118149111426"></a> 653 654**Setting up a test environment** 655 656Install Python 3.7 or a later version on a Windows environment and ensure that the Windows environment is properly connected to the test device. 657 658**Test execution directory** \(corresponding to the **out/release/suites/acts** directory generated during compilation\) 659 660``` 661├── testcase # Directory for storing test suite files 662│ └──xxx.hap # HAP file executed by the test suite 663│ └──xxx.json # Execution configuration file of the test suite 664├── tools # Test framework tool directory 665├── run.bat # File for starting the test suite on the Windows platform 666├── report # Directory for storing the test reports 667``` 668 669**Executing test cases** 670 6711. 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**. 672 6731. Enter the command for executing the test case. 674 675 - Execute all test cases. 676 677 ``` 678 run acts 679 ``` 680 681  682 683 - Execute the test cases of a module \(view specific module information in **\\acts\\testcases\\**\). 684 685 ``` 686 run –l ActsSamgrTest 687 ``` 688 689  690 691 Wait until the test case is complete. 692 693 6943. View test reports. 695 696 Go to **acts\\reports\\**, obtain the current execution record, and open **summary\_report.html** to view the test report. 697 698 699
