@ohos-cpf/3rdloop 0.0.2 → 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (393) hide show
  1. package/README.md +290 -244
  2. package/bin/3rdloop.mjs +46 -46
  3. package/lib/cli.js +781 -781
  4. package/lib/config-cmd.js +451 -451
  5. package/lib/config.js +318 -318
  6. package/lib/doctor.js +113 -113
  7. package/lib/exit-codes.js +30 -30
  8. package/lib/opencode.js +155 -155
  9. package/lib/orch.js +426 -426
  10. package/lib/queries.js +263 -263
  11. package/lib/step.js +325 -325
  12. package/lib/ui.js +222 -222
  13. package/lib/update.js +279 -279
  14. package/lib/workflow.js +308 -308
  15. package/lib/workflows.js +131 -131
  16. package/package.json +50 -50
  17. package/vendor/Server/Agent/SkillSelector/README.md +343 -343
  18. package/vendor/Server/Agent/SkillSelector/core/Agent.js +207 -207
  19. package/vendor/Server/Agent/SkillSelector/index.js +14 -14
  20. package/vendor/Server/Agent/SkillSelector/llm/llmClient.js +313 -313
  21. package/vendor/Server/Agent/SkillSelector/llm/prompts.js +161 -161
  22. package/vendor/Server/Agent/SkillSelector/llm/reactSteps.js +144 -144
  23. package/vendor/Server/Agent/SkillSelector/matcher/fuzzyMatcher.js +433 -433
  24. package/vendor/Server/Agent/SkillSelector/scanner/skillScanner.js +382 -382
  25. package/vendor/Server/Agent/SkillSelector/utils/actionWords.js +59 -59
  26. package/vendor/Server/Brain/AnalysisStrategies.js +422 -422
  27. package/vendor/Server/Brain/Brain.js +686 -686
  28. package/vendor/Server/Brain/DecompositionStrategies.js +621 -621
  29. package/vendor/Server/Brain/PlanPersistence.js +196 -196
  30. package/vendor/Server/Brain/SkillExecutor.js +251 -251
  31. package/vendor/Server/Brain/index.js +11 -11
  32. package/vendor/Server/CLI/cli.js +275 -275
  33. package/vendor/Server/CLI/deveco-code/index.js +71 -71
  34. package/vendor/Server/CLI/deveco-code.js +5 -5
  35. package/vendor/Server/CLI/opencode/index.js +817 -818
  36. package/vendor/Server/CLI/opencode.js +5 -5
  37. package/vendor/Server/DbUse/MessageArchive.js +61 -61
  38. package/vendor/Server/DbUse/StorageManager.js +107 -107
  39. package/vendor/Server/DbUse/adapters/BaseAdapter.js +94 -94
  40. package/vendor/Server/DbUse/adapters/FileAdapter.js +138 -138
  41. package/vendor/Server/DbUse/adapters/JsonAdapter.js +138 -138
  42. package/vendor/Server/DbUse/adapters/JsonlAdapter.js +114 -114
  43. package/vendor/Server/DbUse/adapters/SqliteAdapter.js +157 -157
  44. package/vendor/Server/DbUse/index.js +160 -160
  45. package/vendor/Server/DbUse/stores/SessionStore.js +279 -279
  46. package/vendor/Server/DbUse/stores/TaskExecutionStore.js +133 -133
  47. package/vendor/Server/DbUse/stores/TaskRegistryStore.js +262 -262
  48. package/vendor/Server/DbUse/stores/TaskStepStore.js +279 -279
  49. package/vendor/Server/FlexRunner/FlexRunner.js +1759 -1759
  50. package/vendor/Server/FlexRunner/index.js +12 -12
  51. package/vendor/Server/Knowledge/KnowledgeImporter.js +523 -523
  52. package/vendor/Server/Knowledge/KnowledgeManager.js +341 -341
  53. package/vendor/Server/Knowledge/index.js +33 -33
  54. package/vendor/Server/LoopEngine/LoopEngine.js +1133 -1133
  55. package/vendor/Server/LoopEngine/index.js +11 -11
  56. package/vendor/Server/Orchestrator/Orchestrator.js +0 -3
  57. package/vendor/Server/Orchestrator/StepNode.js +312 -312
  58. package/vendor/Server/Orchestrator/index.js +13 -13
  59. package/vendor/Server/Routes/controllers/BrainController.js +241 -241
  60. package/vendor/Server/Routes/controllers/FlexRunnerController.js +1125 -1125
  61. package/vendor/Server/Routes/controllers/HealthController.js +44 -44
  62. package/vendor/Server/Routes/controllers/KnowledgeImportController.js +355 -355
  63. package/vendor/Server/Routes/controllers/LoopEngineController.js +788 -788
  64. package/vendor/Server/Routes/controllers/StatsController.js +57 -57
  65. package/vendor/Server/Routes/controllers/StreamController.js +67 -67
  66. package/vendor/Server/Routes/library/logger.js +179 -179
  67. package/vendor/Server/Routes/library/zipArchive.js +172 -172
  68. package/vendor/Server/Routes/router/Router.js +204 -204
  69. package/vendor/Server/Routes/routes/brain.js +47 -47
  70. package/vendor/Server/Routes/routes/flexrunner.js +72 -72
  71. package/vendor/Server/Routes/routes/health.js +28 -28
  72. package/vendor/Server/Routes/routes/index.js +57 -57
  73. package/vendor/Server/Routes/routes/knowledge.js +55 -55
  74. package/vendor/Server/Routes/routes/loopengine.js +58 -58
  75. package/vendor/Server/Routes/routes/orchestrator.js +61 -61
  76. package/vendor/Server/Routes/routes/registry.js +97 -97
  77. package/vendor/Server/Routes/routes/stats.js +23 -23
  78. package/vendor/Server/Routes/routes/stream.js +30 -30
  79. package/vendor/Server/Routes/server.js +203 -203
  80. package/vendor/Server/Routes/sse/SseHub.js +308 -308
  81. package/vendor/Server/Skills/acceptance-check/SKILL.md +191 -191
  82. package/vendor/Server/Skills/acceptance-check/references/PHASE1_ARTIFACT_COLLECTION.md +52 -52
  83. package/vendor/Server/Skills/acceptance-check/references/PHASE2_CRITERIA_EVALUATION.md +77 -77
  84. package/vendor/Server/Skills/acceptance-check/references/PHASE2_EVIDENCE_VERIFICATION.md +70 -70
  85. package/vendor/Server/Skills/arkts-code-check/SKILL.md +320 -320
  86. package/vendor/Server/Skills/arkts-code-check/references/CODE_CHECK_GUIDE.md +210 -210
  87. package/vendor/Server/Skills/arkts-code-check/references/FILE_TYPE_GUIDE.md +28 -28
  88. package/vendor/Server/Skills/arkts-code-check/references/PHASE1_INFO_COLLECTION.md +233 -233
  89. package/vendor/Server/Skills/arkts-code-check/references/REPORT_TEMPLATE.md +219 -219
  90. package/vendor/Server/Skills/arkts-library-compile-validate/SKILL.md +328 -328
  91. package/vendor/Server/Skills/arkts-library-compile-validate/scripts/build.ps1 +93 -93
  92. package/vendor/Server/Skills/arkts-library-compile-validate/scripts/code-linter.cjs +432 -432
  93. package/vendor/Server/Skills/arkts-library-compile-validate/scripts/migrate.cjs +851 -851
  94. package/vendor/Server/Skills/arkts-library-compile-validate/scripts/ohpm-switch.cjs +788 -788
  95. package/vendor/Server/Skills/arkts-library-demo-code/SKILL.md +291 -291
  96. package/vendor/Server/Skills/arkts-library-demo-code/references/API_SIGNATURE_CHECKS.md +68 -68
  97. package/vendor/Server/Skills/arkts-library-demo-code/references/BUILD_VALIDATION.md +184 -184
  98. package/vendor/Server/Skills/arkts-library-demo-code/references/CODE_STANDARDS.md +337 -337
  99. package/vendor/Server/Skills/arkts-library-demo-code/references/EXAMPLES.md +400 -400
  100. package/vendor/Server/Skills/arkts-library-demo-code/references/SYSTEM_API_LOOKUP.md +98 -98
  101. package/vendor/Server/Skills/arkts-library-demo-code/references/TEMPLATE.md +544 -544
  102. package/vendor/Server/Skills/arkts-library-demo-code/scripts/build.ps1 +93 -93
  103. package/vendor/Server/Skills/arkts-library-demo-code/scripts/code-linter.cjs +432 -432
  104. package/vendor/Server/Skills/arkts-library-demo-code/scripts/migrate.cjs +851 -851
  105. package/vendor/Server/Skills/arkts-library-demo-code/scripts/ohpm-switch.cjs +788 -788
  106. package/vendor/Server/Skills/arkts-library-demo-coverage/SKILL.md +174 -174
  107. package/vendor/Server/Skills/arkts-library-demo-scenario/SKILL.md +321 -321
  108. package/vendor/Server/Skills/arkts-library-demo-scenario/references/EXAMPLES.md +100 -100
  109. package/vendor/Server/Skills/arkts-library-demo-scenario/references/TEMPLATE.md +185 -185
  110. package/vendor/Server/Skills/arkts-library-documentation-quality-check/SKILL.md +233 -233
  111. package/vendor/Server/Skills/arkts-library-documentation-quality-check/assets/REPORT_TEMPLATE.md +102 -102
  112. package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/CHECK_DIMENSIONS.md +89 -89
  113. package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/COMPLIANCE_CHECKLIST.md +62 -62
  114. package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/KB_QUERY_GUIDE.md +107 -107
  115. package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/MCP_TOOL_DISCOVERY.md +124 -124
  116. package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/REPORT_TEMPLATE.md +90 -90
  117. package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/SCORING_FORMULA.md +57 -57
  118. package/vendor/Server/Skills/arkts-library-documentation-quality-check/scripts/validate-skill.cjs +259 -259
  119. package/vendor/Server/Skills/arkts-library-interface-spec/SKILL.md +97 -97
  120. package/vendor/Server/Skills/arkts-library-memory-leak-check/SKILL.md +391 -391
  121. package/vendor/Server/Skills/arkts-library-source-clone/SKILL.md +113 -113
  122. package/vendor/Server/Skills/arkts-library-stability-check/SKILL.md +312 -312
  123. package/vendor/Server/Skills/arkts-library-stability-check/assets/REPORT_TEMPLATE.md +154 -154
  124. package/vendor/Server/Skills/arkts-library-stability-check/references/CHECKLIST.md +165 -165
  125. package/vendor/Server/Skills/arkts-library-stability-check/references/CODE_EXAMPLES.md +308 -308
  126. package/vendor/Server/Skills/arkts-library-stability-check/references/SCORING_RULES.md +90 -90
  127. package/vendor/Server/Skills/arkts-library-stability-check/scripts/validate-skill.cjs +282 -282
  128. package/vendor/Server/Skills/arkts-library-test-coverage-check/SKILL.md +360 -360
  129. package/vendor/Server/Skills/arkts-library-test-coverage-check/assets/REPORT_TEMPLATE.md +145 -145
  130. package/vendor/Server/Skills/arkts-library-test-coverage-check/references/CHECKLIST.md +252 -252
  131. package/vendor/Server/Skills/arkts-library-test-coverage-check/references/MCP_TOOL_USAGE.md +114 -114
  132. package/vendor/Server/Skills/arkts-library-test-coverage-check/scripts/validate-skill.cjs +262 -262
  133. package/vendor/Server/Skills/arkts-library-xts-code/SKILL.md +455 -455
  134. package/vendor/Server/Skills/arkts-library-xts-code/assets/report-template.md +60 -60
  135. package/vendor/Server/Skills/arkts-library-xts-code/references/ACCESS_MODIFIER_PRECHECK.md +76 -76
  136. package/vendor/Server/Skills/arkts-library-xts-code/references/BUILD_VERIFICATION.md +200 -200
  137. package/vendor/Server/Skills/arkts-library-xts-code/references/CODE_STANDARDS.md +518 -518
  138. package/vendor/Server/Skills/arkts-library-xts-code/references/SUBAGENT_PROMPT_TEMPLATE.md +276 -276
  139. package/vendor/Server/Skills/arkts-library-xts-code/references/SYSTEM_API_LOOKUP.md +92 -92
  140. package/vendor/Server/Skills/arkts-library-xts-code/references/XTS_TEMPLATE.md +767 -767
  141. package/vendor/Server/Skills/arkts-library-xts-code/scripts/build.ps1 +93 -93
  142. package/vendor/Server/Skills/arkts-library-xts-code/scripts/code-linter.cjs +432 -432
  143. package/vendor/Server/Skills/arkts-library-xts-code/scripts/migrate.cjs +851 -851
  144. package/vendor/Server/Skills/arkts-library-xts-code/scripts/ohpm-switch.cjs +788 -788
  145. package/vendor/Server/Skills/arkts-library-xts-code/scripts/precheck-access-modifiers.cjs +221 -221
  146. package/vendor/Server/Skills/arkts-library-xts-code-fix/SKILL.md +228 -228
  147. package/vendor/Server/Skills/arkts-library-xts-coverage/SKILL.md +97 -97
  148. package/vendor/Server/Skills/arkts-library-xts-doc/SKILL.md +194 -194
  149. package/vendor/Server/Skills/arkts-library-xts-doc/references/EXAMPLES.md +575 -575
  150. package/vendor/Server/Skills/arkts-library-xts-doc/references/TEMPLATE.md +574 -574
  151. package/vendor/Server/Skills/arkts-library-xts-doc/references/TESTABILITY_GUIDE.md +182 -182
  152. package/vendor/Server/Skills/arkts-library-xts-execution/SKILL.md +490 -490
  153. package/vendor/Server/Skills/arkts-library-xts-execution/references/error-fixing-examples.md +217 -217
  154. package/vendor/Server/Skills/arkts-library-xts-execution/scripts/build.ps1 +93 -93
  155. package/vendor/Server/Skills/arkts-library-xts-execution/scripts/code-linter.cjs +432 -432
  156. package/vendor/Server/Skills/arkts-library-xts-execution/scripts/migrate.cjs +851 -851
  157. package/vendor/Server/Skills/arkts-library-xts-execution/scripts/ohpm-switch.cjs +788 -788
  158. package/vendor/Server/Skills/flutter-code-check/SKILL.md +299 -299
  159. package/vendor/Server/Skills/flutter-code-check/assets/OUTPUT_TEMPLATE.md +311 -311
  160. package/vendor/Server/Skills/flutter-code-check/references/CHECKLIST.md +190 -190
  161. package/vendor/Server/Skills/flutter-code-check/references/PLATFORMS.md +133 -133
  162. package/vendor/Server/Skills/flutter-code-check/scripts/validate-skill.cjs +259 -259
  163. package/vendor/Server/Skills/flutter-interface/README.md +75 -75
  164. package/vendor/Server/Skills/flutter-interface/SKILL.md +291 -291
  165. package/vendor/Server/Skills/flutter-interface/references/EXAMPLES.md +336 -336
  166. package/vendor/Server/Skills/flutter-interface/references/GIT_CLONE_GUIDE.md +190 -190
  167. package/vendor/Server/Skills/flutter-interface/references/SCRIPT_REFERENCE.md +258 -258
  168. package/vendor/Server/Skills/flutter-interface/references/TEMPLATE.md +254 -254
  169. package/vendor/Server/Skills/flutter-library-consistency-check/SKILL.md +517 -517
  170. package/vendor/Server/Skills/flutter-library-consistency-check/references/CHECKLIST.md +381 -381
  171. package/vendor/Server/Skills/flutter-library-consistency-check/references/FUNCTION_COMPARISON_GUIDE.md +341 -341
  172. package/vendor/Server/Skills/flutter-library-consistency-check/references/PLATFORM_LIMITATION_GUIDE.md +71 -71
  173. package/vendor/Server/Skills/flutter-library-documentation-quality-check/SKILL.md +518 -518
  174. package/vendor/Server/Skills/flutter-library-documentation-quality-check/references/CHECKLIST.md +406 -406
  175. package/vendor/Server/Skills/flutter-library-memory-leak-check/SKILL.md +652 -652
  176. package/vendor/Server/Skills/flutter-library-memory-leak-check/references/CHECKLIST.md +396 -396
  177. package/vendor/Server/Skills/flutter-library-stability-check/SKILL.md +744 -744
  178. package/vendor/Server/Skills/flutter-library-stability-check/references/CHECKLIST.md +720 -720
  179. package/vendor/Server/Skills/flutter-library-test-coverage-check/SKILL.md +414 -414
  180. package/vendor/Server/Skills/flutter-library-test-coverage-check/assets/REPORT_TEMPLATE.md +150 -150
  181. package/vendor/Server/Skills/flutter-library-test-coverage-check/references/CHECKLIST.md +304 -304
  182. package/vendor/Server/Skills/flutter-library-test-coverage-check/references/SCORING_RULES.md +265 -265
  183. package/vendor/Server/Skills/flutter-library-test-coverage-check/references/SCRIPT_USAGE.md +286 -286
  184. package/vendor/Server/Skills/knowledge-import/SKILL.md +383 -383
  185. package/vendor/Server/Skills/knowledge-import/references/MCP_TOOL_USAGE.md +165 -165
  186. package/vendor/Server/Skills/knowledge-import/references/SKILL_LOCATOR_GUIDE.md +91 -91
  187. package/vendor/Server/Skills/knowledge-import/references/SKILL_OPTIMIZATION_GUIDE.md +127 -127
  188. package/vendor/Server/Skills/ohos-lib-pr-push/SKILL.md +453 -301
  189. package/vendor/Server/Skills/ohos-lib-pr-push/assets/PR_CHECKLIST.md +151 -0
  190. package/vendor/Server/Skills/ohos-lib-pr-push/assets/PR_ISSUE_TEMPLATE.md +257 -105
  191. package/vendor/Server/Skills/ohos-lib-pr-push/references/GITCODE_API.md +191 -127
  192. package/vendor/Server/Skills/ohos-lib-pr-push/scripts/gitcode-api.cjs +317 -208
  193. package/vendor/Server/Skills/rn-code-check/SKILL.md +320 -320
  194. package/vendor/Server/Skills/rn-code-check/references/API-GUIDE.md +234 -234
  195. package/vendor/Server/Skills/rn-code-check/references/CHECKLIST.md +188 -188
  196. package/vendor/Server/Skills/rn-code-check/references/REPORT-TEMPLATE.md +246 -246
  197. package/vendor/Server/Skills/rn-lib-add-example/SKILL.md +198 -198
  198. package/vendor/Server/Skills/rn-lib-add-example/references/APP_RENAME_GUIDE.md +40 -40
  199. package/vendor/Server/Skills/rn-lib-add-example/references/SHELL_ADAPTATION_CHECKLIST.md +78 -78
  200. package/vendor/Server/Skills/rn-lib-add-example/references/TEMPLATE_REPO_GUIDE.md +70 -70
  201. package/vendor/Server/Skills/rn-lib-add-example/references/VERIFICATION_GUIDE.md +47 -47
  202. package/vendor/Server/Skills/rn-lib-add-example/scripts/create-example.cjs +252 -252
  203. package/vendor/Server/Skills/rn-lib-update-doc/SKILL.md +176 -176
  204. package/vendor/Server/Skills/rn-lib-update-doc/config.json +5 -5
  205. package/vendor/Server/Skills/rn-lib-update-doc/references/changelog-template.md +35 -35
  206. package/vendor/Server/Skills/rn-lib-update-doc/references/format-diff.md +137 -137
  207. package/vendor/Server/Skills/rn-lib-update-doc/references/link-registry.json +33 -33
  208. package/vendor/Server/Skills/rn-lib-update-doc/references/model-0.4.2-overview.md +40 -40
  209. package/vendor/Server/Skills/rn-lib-update-doc/references/model-0.4.2.md +429 -429
  210. package/vendor/Server/Skills/rn-lib-update-doc/scripts/detect-readme-format.cjs +105 -105
  211. package/vendor/Server/Skills/rn-lib-update-doc/scripts/find-usage-doc.cjs +90 -90
  212. package/vendor/Server/Skills/rn-lib-update-doc/scripts/link-verify.cjs +213 -213
  213. package/vendor/Server/Skills/rn-lib-update-doc/scripts/normalize-changelog.cjs +73 -73
  214. package/vendor/Server/Skills/rn-lib-update-doc/scripts/normalize-package-meta.cjs +258 -258
  215. package/vendor/Server/Skills/rn-lib-update-doc/scripts/normalize-readme-links.cjs +341 -341
  216. package/vendor/Server/Skills/rn-lib-update-doc/scripts/resolve-usage-docs.cjs +67 -67
  217. package/vendor/Server/Skills/rn-library-consistency-check/SKILL.md +299 -299
  218. package/vendor/Server/Skills/rn-library-consistency-check/assets/REPORT_TEMPLATE.md +293 -293
  219. package/vendor/Server/Skills/rn-library-consistency-check/references/ARKTS_COMPONENT_CHECK_GUIDE.md +857 -857
  220. package/vendor/Server/Skills/rn-library-consistency-check/references/ARKTS_TURBOMODULE_CHECK_GUIDE.md +856 -856
  221. package/vendor/Server/Skills/rn-library-consistency-check/references/CHECKLIST.md +157 -157
  222. package/vendor/Server/Skills/rn-library-consistency-check/references/CPP_COMPONENT_CHECK_GUIDE.md +801 -801
  223. package/vendor/Server/Skills/rn-library-consistency-check/references/CPP_TURBOMODULE_CHECK_GUIDE.md +683 -683
  224. package/vendor/Server/Skills/rn-library-consistency-check/references/FUNCTION_COMPARISON_GUIDE.md +233 -233
  225. package/vendor/Server/Skills/rn-library-consistency-check/references/NATIVE_COMPONENT_IDENTIFICATION.md +1373 -1373
  226. package/vendor/Server/Skills/rn-library-consistency-check/references/SCORING_STANDARD.md +220 -220
  227. package/vendor/Server/Skills/rn-library-consistency-check/scripts/validate-skill.py +245 -245
  228. package/vendor/Server/Skills/rn-library-documentation-quality-check/SKILL.md +263 -263
  229. package/vendor/Server/Skills/rn-library-documentation-quality-check/assets/MODEL.md +414 -414
  230. package/vendor/Server/Skills/rn-library-documentation-quality-check/assets/MODEL_en.md +413 -413
  231. package/vendor/Server/Skills/rn-library-documentation-quality-check/assets/REPORT_TEMPLATE.md +311 -311
  232. package/vendor/Server/Skills/rn-library-documentation-quality-check/references/CHECK_CHECKLIST.md +355 -355
  233. package/vendor/Server/Skills/rn-library-documentation-quality-check/references/CROSS_VALIDATION_GUIDE.md +115 -115
  234. package/vendor/Server/Skills/rn-library-documentation-quality-check/references/DOC_COLLECTION_GUIDE.md +139 -139
  235. package/vendor/Server/Skills/rn-library-documentation-quality-check/references/EXAMPLES.md +586 -586
  236. package/vendor/Server/Skills/rn-library-documentation-quality-check/references/GOTCHAS.md +57 -57
  237. package/vendor/Server/Skills/rn-library-documentation-quality-check/scripts/validate-skill.py +259 -259
  238. package/vendor/Server/Skills/rn-library-interface-analyzer/SKILL.md +301 -301
  239. package/vendor/Server/Skills/rn-library-interface-analyzer/assets/REPORT_TEMPLATE.md +148 -148
  240. package/vendor/Server/Skills/rn-library-interface-analyzer/references/DOC_ANNOTATION_GUIDE.md +118 -118
  241. package/vendor/Server/Skills/rn-library-interface-analyzer/references/SCRIPT_USAGE_GUIDE.md +168 -168
  242. package/vendor/Server/Skills/rn-library-interface-analyzer/references/URL_PARSING_RULES.md +176 -176
  243. package/vendor/Server/Skills/rn-library-issue-generalizer/SKILL.md +274 -274
  244. package/vendor/Server/Skills/rn-library-issue-generalizer/assets/case-template.md +45 -45
  245. package/vendor/Server/Skills/rn-library-issue-generalizer/assets/rule-template.md +25 -25
  246. package/vendor/Server/Skills/rn-library-issue-generalizer/references/PR_FETCH_GUIDE.md +61 -61
  247. package/vendor/Server/Skills/rn-library-issue-generalizer/references/RULE_TEMPLATE_GUIDE.md +165 -165
  248. package/vendor/Server/Skills/rn-library-issue-generalizer/scripts/fetch-pr-info.py +239 -239
  249. package/vendor/Server/Skills/rn-library-known-issue-check/SKILL.md +263 -263
  250. package/vendor/Server/Skills/rn-library-known-issue-check/assets/REPORT_TEMPLATE.md +96 -96
  251. package/vendor/Server/Skills/rn-library-known-issue-check/references/COMPLIANCE_CHECKLIST.md +57 -57
  252. package/vendor/Server/Skills/rn-library-known-issue-check/references/INSPECTION_GUIDE.md +99 -99
  253. package/vendor/Server/Skills/rn-library-known-issue-check/references/PRESCREEN_GUIDE.md +64 -64
  254. package/vendor/Server/Skills/rn-library-known-issue-check/references/SOURCE_PREP_GUIDE.md +74 -74
  255. package/vendor/Server/Skills/rn-library-known-issue-check/scripts/validate-known-issue-report.py +164 -164
  256. package/vendor/Server/Skills/rn-library-memory-leak-check/SKILL.md +356 -339
  257. package/vendor/Server/Skills/rn-library-memory-leak-check/assets/REPORT_TEMPLATE.md +85 -83
  258. package/vendor/Server/Skills/rn-library-memory-leak-check/references/CHECKLIST.md +905 -859
  259. package/vendor/Server/Skills/rn-library-memory-leak-check/references/HARMONY_CODE_PATTERNS.md +124 -122
  260. package/vendor/Server/Skills/rn-library-memory-leak-check/scripts/scan_harmony_code.py +287 -279
  261. package/vendor/Server/Skills/rn-library-stability-check/SKILL.md +273 -273
  262. package/vendor/Server/Skills/rn-library-stability-check/assets/REPORT_TEMPLATE.md +129 -129
  263. package/vendor/Server/Skills/rn-library-stability-check/references/CHECKLIST.md +581 -581
  264. package/vendor/Server/Skills/rn-library-stability-check/references/SCORING_RULES.md +138 -138
  265. package/vendor/Server/Skills/rn-library-stability-check/scripts/scan-harmony-code.py +168 -168
  266. package/vendor/Server/Skills/rn-library-test-coverage-check/SKILL.md +526 -506
  267. package/vendor/Server/Skills/rn-library-test-coverage-check/references/CHECKLIST.md +321 -280
  268. package/vendor/Server/Skills/rn-library-test-coverage-check/references/DEMO_LOCATION.md +221 -221
  269. package/vendor/Server/Skills/rn-library-test-coverage-check/references/REPORT_TEMPLATE.md +220 -209
  270. package/vendor/Server/Skills/rn-library-test-coverage-check/references/SCRIPT_USAGE.md +325 -325
  271. package/vendor/Server/Skills/rn-ohos-xts-generator/SKILL.md +279 -279
  272. package/vendor/Server/Skills/rn-ohos-xts-generator/assets/TEST_FILE_TEMPLATES.md +404 -404
  273. package/vendor/Server/Skills/rn-ohos-xts-generator/references/BUILD_TROUBLESHOOTING.md +185 -185
  274. package/vendor/Server/Skills/rn-ohos-xts-generator/references/BUILD_WORKFLOW.md +265 -265
  275. package/vendor/Server/Skills/rn-ohos-xts-generator/references/COMMON_CONFIG.md +189 -189
  276. package/vendor/Server/Skills/rn-ohos-xts-generator/references/CONFIG_GUIDE.md +203 -203
  277. package/vendor/Server/Skills/rn-ohos-xts-generator/references/COVERAGE_ANALYZER.md +147 -147
  278. package/vendor/Server/Skills/rn-ohos-xts-generator/references/DESIGN_DOC_GUIDE.md +148 -148
  279. package/vendor/Server/Skills/rn-ohos-xts-generator/references/GENERATION_FLOW.md +165 -165
  280. package/vendor/Server/Skills/rn-ohos-xts-generator/references/GENERATION_STRATEGY.md +195 -195
  281. package/vendor/Server/Skills/rn-ohos-xts-generator/references/HARMONY_SCANNER.md +249 -249
  282. package/vendor/Server/Skills/rn-ohos-xts-generator/references/JEST_FRAMEWORK.md +235 -235
  283. package/vendor/Server/Skills/rn-ohos-xts-generator/references/PLATFORM_COMPAT.md +161 -161
  284. package/vendor/Server/Skills/rn-ohos-xts-generator/references/RN_TEST_PATTERNS.md +413 -413
  285. package/vendor/Server/Skills/rn-ohos-xts-generator/references/SOURCE_PARSER.md +235 -235
  286. package/vendor/Server/Skills/rn-ohos-xts-generator/references/TEST_CONVENTIONS.md +245 -245
  287. package/vendor/Server/Skills/rn-ohos-xts-generator/references/TROUBLESHOOTING.md +282 -282
  288. package/vendor/Server/Skills/rn-ohos-xts-generator/references/USAGE_GUIDE.md +251 -251
  289. package/vendor/Server/Skills/rnoh-cptf-api-test/SKILL.md +469 -469
  290. package/vendor/Server/Skills/rnoh-cptf-api-test/assets/CPTF_TEST_TEMPLATE.md +310 -310
  291. package/vendor/Server/Skills/rnoh-cptf-api-test/assets/DEMO_PAGE_TEMPLATE.md +303 -303
  292. package/vendor/Server/Skills/rnoh-cptf-api-test/references/CPTF_TEST_GENERATION_GUIDE.md +421 -421
  293. package/vendor/Server/Skills/rnoh-cptf-api-test/references/DEMO_GENERATION_GUIDE.md +358 -358
  294. package/vendor/Server/Skills/rnoh-cptf-api-test/references/QUALITY_CHECKLIST.md +114 -114
  295. package/vendor/Server/Skills/rnoh-cptf-api-test/references/SPEC_PARSING_GUIDE.md +274 -274
  296. package/vendor/Server/Skills/rnoh-cptf-api-test/scripts/validate-rnoh-cptf-api-test.sh +185 -185
  297. package/vendor/Server/Skills/rnoh-cptf-demo-test/SKILL.md +191 -191
  298. package/vendor/Server/Skills/rnoh-cptf-demo-test/assets/TEST_TEMPLATE.md +216 -216
  299. package/vendor/Server/Skills/rnoh-cptf-demo-test/references/CPTF_SETUP.md +107 -107
  300. package/vendor/Server/Skills/rnoh-cptf-demo-test/references/DEMO_ANALYSIS.md +120 -120
  301. package/vendor/Server/Skills/rnoh-cptf-demo-test/scripts/validate-rnoh-cptf-test.sh +108 -108
  302. package/vendor/Server/Skills/rnoh-cptf-test-run/SKILL.md +237 -237
  303. package/vendor/Server/Skills/rnoh-cptf-test-run/references/DEBUG_PLAYBOOK.md +261 -261
  304. package/vendor/Server/Skills/rnoh-cptf-test-run/scripts/validate-run-env.sh +112 -112
  305. package/vendor/Server/Skills/rnoh-lib-code-adapt/SKILL.md +497 -497
  306. package/vendor/Server/Skills/rnoh-lib-code-adapt/references/adapt-checklist.md +270 -270
  307. package/vendor/Server/Skills/rnoh-lib-code-adapt/references/api-migration-checklist.md +164 -164
  308. package/vendor/Server/Skills/rnoh-lib-code-adapt/references/common-compile-errors.md +556 -556
  309. package/vendor/Server/Skills/rnoh-lib-code-adapt/references/deveco-cli-tools.md +459 -459
  310. package/vendor/Server/Skills/rnoh-lib-code-adapt/references/edge-cases.md +65 -65
  311. package/vendor/Server/Skills/rnoh-lib-code-adapt/references/har-tgz-build.md +512 -512
  312. package/vendor/Server/Skills/rnoh-lib-code-adapt/references/version-compat-matrix.md +132 -132
  313. package/vendor/Server/Skills/rnoh-lib-code-adapt/scripts/auto-integrate.sh +424 -424
  314. package/vendor/Server/Skills/rnoh-lib-demo-coverage/SKILL.md +137 -137
  315. package/vendor/Server/Skills/rnoh-lib-demo-create/SKILL.md +306 -306
  316. package/vendor/Server/Skills/rnoh-lib-demo-create/assets/DEMO_PAGE_TEMPLATE.md +485 -485
  317. package/vendor/Server/Skills/rnoh-lib-demo-create/assets/INDEX_TEMPLATE.md +172 -172
  318. package/vendor/Server/Skills/rnoh-lib-demo-create/references/DEMO_CODE_RULES.md +422 -422
  319. package/vendor/Server/Skills/rnoh-lib-demo-create/references/QUALITY_CHECKLIST.md +95 -95
  320. package/vendor/Server/Skills/rnoh-lib-demo-create/references/SOURCE_EXPLORATION.md +169 -169
  321. package/vendor/Server/Skills/rnoh-lib-demo-doc/SKILL.md +554 -554
  322. package/vendor/Server/Skills/rnoh-lib-demo-doc/assets/DEMO_DOC_TEMPLATE.md +106 -106
  323. package/vendor/Server/Skills/rnoh-lib-demo-doc/references/COVERAGE_INCREMENTAL.md +216 -216
  324. package/vendor/Server/Skills/rnoh-lib-demo-doc/references/DEMO_DESIGN_RULES.md +413 -413
  325. package/vendor/Server/Skills/rnoh-lib-demo-doc/references/OUTPUT_FORMAT.md +269 -269
  326. package/vendor/Server/Skills/rnoh-lib-demo-doc/references/QUALITY_CHECKLIST.md +98 -98
  327. package/vendor/Server/Skills/rnoh-lib-func-test/SKILL.md +337 -337
  328. package/vendor/Server/Skills/rnoh-lib-rnt-search/SKILL.md +722 -722
  329. package/vendor/Server/Skills/rnoh-lib-rnt-search/assets/PORT_REPORT_TEMPLATE.md +219 -219
  330. package/vendor/Server/Skills/rnoh-lib-rnt-search/references/DEMO_PORTING_GUIDE.md +345 -345
  331. package/vendor/Server/Skills/rnoh-lib-rnt-search/references/PORT_VERIFICATION.md +269 -269
  332. package/vendor/Server/Skills/rnoh-lib-rnt-search/references/RNT_PROJECT_STRUCTURE.md +173 -173
  333. package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/analyze-demo-deps.cjs +267 -267
  334. package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/detect-rnoh-version.cjs +174 -174
  335. package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/find-rnt-demo.sh +111 -111
  336. package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/port-demo.sh +186 -186
  337. package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/read-lib-meta.cjs +150 -150
  338. package/vendor/Server/Skills/rnoh-lib-test-align/SKILL.md +296 -296
  339. package/vendor/Server/Skills/rnoh-lib-test-align/references/jest-troubleshooting.md +371 -371
  340. package/vendor/Server/Skills/rnoh-lib-test-align/references/port-test-demo-guide.md +212 -212
  341. package/vendor/Server/Skills/rnoh-lib-test-align/references/runtime-troubleshooting.md +345 -345
  342. package/vendor/Server/Skills/rnoh-lib-test-align/references/unit-test-template.md +223 -223
  343. package/vendor/Server/Skills/rnoh-lib-test-align/scripts/port-test-demo.sh +1053 -1053
  344. package/vendor/Server/Skills/rnoh-lib-version-diff/SKILL.md +295 -255
  345. package/vendor/Server/Skills/rnoh-lib-version-diff/references/OHOS_ADAPTATION.md +82 -77
  346. package/vendor/Server/Skills/rnoh-lib-version-diff/references/OHOS_API_LOOKUP.md +224 -224
  347. package/vendor/Server/Skills/rnoh-lib-version-diff/references/script-reference.md +175 -174
  348. package/vendor/Server/Skills/rnoh-lib-version-diff/scripts/detect-upstream-version.js +967 -967
  349. package/vendor/Server/Skills/rnoh-lib-version-diff/scripts/generate-diff.js +1798 -1798
  350. package/vendor/Server/Skills/rnoh-lib-version-diff/scripts/package.json +5 -5
  351. package/vendor/Server/Skills/rnoh-lib-version-diff/templates/report-template.md +180 -137
  352. package/vendor/Server/Skills/rnoh-lib-xts-coverage/SKILL.md +145 -145
  353. package/vendor/Server/Skills/skill-generator/SKILL.md +365 -365
  354. package/vendor/Server/Skills/skill-generator/assets/SKILL_TEMPLATE.md +183 -183
  355. package/vendor/Server/Skills/skill-generator/references/COMPLIANCE_CHECKLIST.md +82 -82
  356. package/vendor/Server/Skills/skill-generator/references/KB_QUERY_GUIDE.md +110 -110
  357. package/vendor/Server/Skills/skill-generator/references/MCP_TOOL_DISCOVERY.md +122 -122
  358. package/vendor/Server/Skills/skill-generator/references/SKILL_SPEC.md +121 -121
  359. package/vendor/Server/Skills/skill-generator/scripts/validate-skill.cjs +259 -259
  360. package/vendor/Server/Skills/task-analysis/SKILL.md +234 -234
  361. package/vendor/Server/Skills/task-analysis/assets/OUTPUT_EXAMPLES.md +160 -160
  362. package/vendor/Server/Skills/task-analysis/references/ACCEPTANCE_CRITERIA_GUIDE.md +190 -190
  363. package/vendor/Server/Skills/task-analysis/references/ANALYSIS_SCHEMA.md +224 -224
  364. package/vendor/Server/Skills/task-analysis/references/INTEGRATION_CONTEXT.md +162 -162
  365. package/vendor/Server/Skills/task-analysis/references/LESSONS_LEARNED.md +55 -55
  366. package/vendor/Server/Skills/task-analysis/references/REPLAN_CONTEXT_GUIDE.md +126 -126
  367. package/vendor/Server/Skills/task-analysis/scripts/validate-analysis-output.sh +256 -256
  368. package/vendor/Server/Skills/task-decomposition/SKILL.md +528 -528
  369. package/vendor/Server/Skills/task-decomposition/assets/OUTPUT_EXAMPLES.md +451 -451
  370. package/vendor/Server/Skills/task-decomposition/references/ACCEPTANCE_CRITERIA_GUIDE.md +179 -179
  371. package/vendor/Server/Skills/task-decomposition/references/DEPENDENCY_GRAPH_GUIDE.md +152 -152
  372. package/vendor/Server/Skills/task-decomposition/references/INTEGRATION_CONTEXT.md +175 -175
  373. package/vendor/Server/Skills/task-decomposition/references/REPLAN_CONTEXT_GUIDE.md +195 -195
  374. package/vendor/Server/Skills/task-decomposition/references/TASK_DECOMPOSITION_TEMPLATES.md +226 -226
  375. package/vendor/Server/Skills/task-decomposition/scripts/list-available-skills.cjs +263 -263
  376. package/vendor/Server/Skills/task-decomposition/scripts/skill-blacklist.json +29 -29
  377. package/vendor/Server/Skills/task-decomposition/scripts/validate-decomposition-output.cjs +376 -376
  378. package/vendor/Server/Skills/task-decomposition/scripts/validate-param-consistency.cjs +259 -259
  379. package/vendor/Server/Skills/task-decomposition/scripts/validate-specified-skills.cjs +216 -216
  380. package/vendor/Server/Skills/task-decomposition/scripts/validate-step-graph.cjs +424 -424
  381. package/vendor/Server/Skills/tpc-cpp-check/SKILL.md +427 -427
  382. package/vendor/Server/Skills/tpc-cpp-check/references/CHECKLIST.md +214 -214
  383. package/vendor/Server/Skills/tpc-cpp-check/references/HPKBUILD_GUIDE.md +235 -235
  384. package/vendor/Server/Skills/tpc-cpp-check/references/REPORT_TEMPLATE.md +250 -250
  385. package/vendor/Server/TestCheck/TestCheck.js +775 -775
  386. package/vendor/Server/TestCheck/index.js +11 -11
  387. package/vendor/Server/library/McpToolGuide.js +280 -280
  388. package/vendor/Server/library/StatsService.js +126 -126
  389. package/vendor/Server/library/cstTime.js +16 -16
  390. package/vendor/VERSION +3 -3
  391. package/workflows/pr-check.mjs +105 -105
  392. package/workflows/pr-push.mjs +192 -192
  393. package/vendor/Server/Agent/SkillSelector/types.js +0 -63
@@ -1,767 +1,767 @@
1
- # XTS 测试代码模板
2
-
3
- 本文档提供 ArkTS XTS 测试代码生成时使用的标准模板,包含测试文件模板、测试函数模板、异步测试模板、多接口协同测试模板等。
4
-
5
- > ⚠️ **核心规范**:
6
- > - `it()` 必须使用三参数格式 `it(name, 0, () => {})` — 省略 filter 部分设备崩溃
7
- > - 断言 API 必须使用 hypium 专用方法(`assertEqual`/`assertNull`/`assertTrue`/`assertFalse`/`assertLarger`/`assertContain`),**禁止** Jest 风格(`toBe`/`toEqual`/`toBeTruthy`/`toThrow` 等)
8
- > - hilog 导入:`import { hilog } from '@kit.PerformanceAnalysisKit'`(禁止 `import hilog from '@ohos.hilog'`)
9
- > - 文件扩展名:`.test.ets`(禁止 `.ts`)
10
- > - 禁止 `catch(e) { throw e }`(arkts-limited-throw),正常测试不包裹 try-catch
11
- > - 文件路径通过 `abilityDelegatorRegistry` 获取沙箱目录,禁止硬编码
12
-
13
- ---
14
-
15
- ## 一、测试文件基础模板
16
-
17
- 完整的 XTS 测试文件结构模板:
18
-
19
- ```typescript
20
- /**
21
- * {LibraryName} XTS 测试用例
22
- *
23
- * 基于 XTS 用例描述文档生成,验证 {LibraryName} 的核心功能。
24
- * 文档来源:ohos_{LibraryName}xts用例描述.md
25
- *
26
- * 用例总数:{N}
27
- * 可测试接口数:{M}
28
- *
29
- * @author lalhan
30
- */
31
-
32
- import { describe, it, expect, beforeAll, afterAll, beforeEach, afterEach } from '@ohos/hypium';
33
- import { hilog } from '@kit.PerformanceAnalysisKit';
34
- import { abilityDelegatorRegistry } from '@kit.TestKit';
35
- import { common } from '@kit.AbilityKit';
36
- import { {ImportedSymbols} } from '{LibraryPackage}';
37
-
38
- // ─── 日志常量 ──────────────────────────────────────────────────────────────
39
- const DOMAIN: number = 0xD001;
40
- const TAG: string = '{LibraryName}_XtsTest';
41
-
42
- // ─── 全局测试上下文 ──────────────────────────────────────────────────────────
43
- /** 测试用临时目录(由 beforeAll 从 AbilityDelegator 获取真实 Context) */
44
- let tempDir: string = '';
45
-
46
- /**
47
- * {LibraryName} XTS 测试套件
48
- *
49
- * 验证 {LibraryName} 的以下功能模块:
50
- * - 模块 A:{功能描述}
51
- * - 模块 B:{功能描述}
52
- */
53
- export default function {LibraryName}XtsTest() {
54
- describe('{LibraryName}XtsTest', () => {
55
-
56
- // ─── 测试套件生命周期 ────────────────────────────────────────────────
57
-
58
- beforeAll(() => {
59
- // 通过 AbilityDelegator 获取应用真实 Context,以访问沙箱临时目录
60
- const delegator = abilityDelegatorRegistry.getAbilityDelegator();
61
- const appContext: common.Context = delegator.getAppContext();
62
- tempDir = appContext.tempDir;
63
- hilog.info(DOMAIN, TAG, 'XTS test suite started, tempDir=%{public}s', tempDir);
64
- });
65
-
66
- afterAll(() => {
67
- hilog.info(DOMAIN, TAG, 'XTS test suite finished');
68
- });
69
-
70
- // ─── 测试用例区域 ──────────────────────────────────────────────────────
71
-
72
- // 此处插入各个测试函数(见后续模板)
73
-
74
- });
75
- }
76
- ```
77
-
78
- ---
79
-
80
- ## 二、单接口正向测试
81
-
82
- 适用于单个接口的基础功能验证测试:
83
-
84
- ```typescript
85
- /**
86
- * 用例 {SEQ}: {用例名称}
87
- *
88
- * 用例描述:{从用例描述文档提取的详细描述}
89
- * 涉及接口:{接口签名}
90
- * 预期结果:
91
- * 1. {预期结果 1}
92
- * 2. {预期结果 2}
93
- */
94
- it('{function_snake_case}_{SEQ}', 0, () => {
95
- hilog.info(DOMAIN, TAG, 'Test {SEQ}: {用例名称} started');
96
-
97
- // ─── 测试数据准备 ────────────────────────────────────────────────────
98
- const inputData = { ... }; // 准备测试输入数据
99
- const expectedOutput = { ... }; // 准备预期输出
100
-
101
- // ─── 测试执行 ────────────────────────────────────────────────────────
102
- const result = {LibraryCall(inputData)};
103
- hilog.debug(DOMAIN, TAG, 'Result: %{public}s', JSON.stringify(result));
104
-
105
- // ─── 断言验证 ──────────────────────────────────────────────────────
106
- expect(result).assertEqual(expectedOutput);
107
-
108
- hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
109
- });
110
- ```
111
-
112
- > **关于 try-catch 策略**:ArkTS 严格模式下禁止 `throw err`(arkts-limited-throw),因此正常测试不建议包裹 try-catch。`expect` 断言失败会自动让测试框架标记失败,运行时异常也会被框架捕获。
113
-
114
- ---
115
-
116
- ## 三、多接口协同测试
117
-
118
- 适用于多个接口协同完成功能流程的测试:
119
-
120
- ```typescript
121
- /**
122
- * 用例 {SEQ}: {用例名称}
123
- *
124
- * 用例描述:验证多个接口的协同工作能力,确保接口间调用顺序和状态传递正确
125
- * 涉及接口:
126
- * - {接口 1 签名}(作用:{接口 1 作用})
127
- * - {接口 2 签名}(作用:{接口 2 作用})
128
- * 预期结果:
129
- * 1. {接口 1 执行后状态}
130
- * 2. {接口 2 执行后状态}
131
- * 3. {协同验证结果}
132
- */
133
- it('{functions_snake_case}_{SEQ}', 0, () => {
134
- hilog.info(DOMAIN, TAG, 'Test {SEQ}: {用例名称} started');
135
-
136
- // ─── 步骤 1:{接口 1 功能} ──────────────────────────────────────────────
137
- const {objName} = {初始状态};
138
- const {step1Result} = {接口 1 调用};
139
- hilog.debug(DOMAIN, TAG, 'Step 1 result: %{public}s', JSON.stringify({step1Result}));
140
- expect({step1Result}).assertEqual({预期结果 1});
141
-
142
- // ─── 步骤 2:{接口 2 功能} ──────────────────────────────────────────────
143
- const {step2Result} = {接口 2 调用};
144
- hilog.debug(DOMAIN, TAG, 'Step 2 result: %{public}s', String({step2Result}));
145
- expect({step2Result}).assertEqual({预期结果 2});
146
-
147
- // ─── 步骤 3:协同验证 ────────────────────────────────────────────────
148
- expect({协同验证表达式}).assertEqual({预期协同结果});
149
-
150
- hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
151
- });
152
- ```
153
-
154
- ---
155
-
156
- ## 四、空值/null/undefined 输入测试
157
-
158
- 适用于验证接口对空值输入的处理测试:
159
-
160
- ```typescript
161
- /**
162
- * 用例 {SEQ}: {用例名称}
163
- *
164
- * 用例描述:验证接口对 null/undefined/空值输入的处理能力,确保空值不会导致崩溃
165
- * 涉及接口:{接口签名}
166
- * 预期结果:
167
- * 1. 输入 null 时,应抛出异常或返回安全默认值
168
- * 2. 输入空数组/空字符串/空对象时,应返回空结果或安全默认值
169
- * 3. 所有空值输入不应导致崩溃或不可预期行为
170
- */
171
- it('{function_null_input}_{SEQ}', 0, () => {
172
- hilog.info(DOMAIN, TAG, 'Test {SEQ}: {用例名称} started');
173
-
174
- // ─── 测试 1:null 输入(预期抛异常) ──────────────────────────────────────
175
- let caught1: boolean = false;
176
- try {
177
- {接口调用(null 或 null 等效值)};
178
- } catch (e) {
179
- caught1 = true;
180
- }
181
- expect(caught1).assertTrue();
182
- hilog.debug(DOMAIN, TAG, 'Null input handled correctly (exception thrown)');
183
-
184
- // ─── 测试 2:null 输入(预期返回安全默认值) ─────────────────────────────
185
- const result2 = {接口调用(null 或 null 等效值)};
186
- expect(result2).assertNull(); // 或 .assertEqual({安全默认值})
187
- hilog.debug(DOMAIN, TAG, 'Null input result: %{public}s', String(result2));
188
-
189
- // ─── 测试 3:空集合输入(空数组/空字符串/空对象)───────────────────────
190
- const result3 = {接口调用([])}; // 或 '' 或 {}
191
- hilog.debug(DOMAIN, TAG, 'Empty collection result: %{public}s', JSON.stringify(result3));
192
- expect(result3).assertEqual({预期空结果}); // 如 []、''、{} 或 null
193
-
194
- hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
195
- });
196
- ```
197
-
198
- > **null 输入处理策略**:
199
- > - 若参数类型允许 null,直接传入 null
200
- > - 若参数类型不允许 null(ArkTS 严格类型),使用 `{} as SomeType` 作为空对象 mock(仅当库不实际使用该参数时)
201
- > - 若需要验证 null 拒绝,用 try-catch + 布尔标记模式
202
-
203
- ---
204
-
205
- ## 五、异常参数与边界值测试
206
-
207
- 适用于验证接口对异常参数和边界值的处理测试:
208
-
209
- ```typescript
210
- /**
211
- * 用例 {SEQ}: {用例名称}
212
- *
213
- * 用例描述:验证接口对异常参数(类型不匹配、超限值)和边界值(NaN、Infinity、负值、零值)的处理能力
214
- * 涉及接口:{接口签名}
215
- * 预期结果:
216
- * 1. 类型不匹配参数应抛出异常或返回错误码
217
- * 2. 超限值应被合理处理(clamp 到范围或抛出异常)
218
- * 3. NaN/Infinity/负值/零值应返回预期结果或抛出异常
219
- * 4. 所有异常处理不应导致崩溃
220
- */
221
- it('{function_exception_boundary}_{SEQ}', 0, () => {
222
- hilog.info(DOMAIN, TAG, 'Test {SEQ}: {用例名称} started');
223
-
224
- // ─── 测试 1:类型不匹配参数(预期抛异常) ──────────────────────────────
225
- let caught1: boolean = false;
226
- try {
227
- {接口调用({类型不匹配值})};
228
- } catch (e) {
229
- caught1 = true;
230
- }
231
- expect(caught1).assertTrue();
232
- hilog.debug(DOMAIN, TAG, 'Type mismatch handled correctly');
233
-
234
- // ─── 测试 2:特殊值 NaN ────────────────────────────────────────────────
235
- const result2 = {接口调用(NaN)};
236
- hilog.debug(DOMAIN, TAG, 'NaN input result: %{public}s', String(result2));
237
- expect(Number.isNaN(result2)).assertTrue(); // 或 expect(result2).assertEqual({默认值})
238
-
239
- // ─── 测试 3:特殊值 Infinity ────────────────────────────────────────────
240
- const result3 = {接口调用(Infinity)};
241
- hilog.debug(DOMAIN, TAG, 'Infinity input result: %{public}s', String(result3));
242
- expect(result3).assertEqual({预期结果});
243
-
244
- // ─── 测试 4:负值/零值 ──────────────────────────────────────────────────
245
- const result4 = {接口调用({负值或零值})};
246
- hilog.debug(DOMAIN, TAG, 'Negative/zero input result: %{public}s', String(result4));
247
- expect(result4).assertEqual({预期结果});
248
-
249
- hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
250
- });
251
- ```
252
-
253
- ---
254
-
255
- ## 六、反向测试(状态异常)
256
-
257
- 适用于验证接口在异常状态下的行为测试:
258
-
259
- ```typescript
260
- /**
261
- * 用例 {SEQ}: {用例名称}
262
- *
263
- * 用例描述:验证接口在未初始化状态下的调用行为
264
- * 涉及接口:{接口签名}
265
- * 前置条件:{正常前置条件}(本测试故意不满足)
266
- * 预期结果:
267
- * 1. 在未满足前置条件时调用,应抛出异常或返回错误码
268
- * 2. 不应导致崩溃或不可预期行为
269
- */
270
- it('{function_state_error}_{SEQ}', 0, () => {
271
- hilog.info(DOMAIN, TAG, 'Test {SEQ}: {用例名称} started');
272
-
273
- // ─── 测试场景:未初始化状态调用 ──────────────────────────────────────
274
- // 不调用初始化方法,直接调用执行方法
275
- let caught: boolean = false;
276
- try {
277
- {执行接口调用()};
278
- } catch (e) {
279
- caught = true;
280
- }
281
- expect(caught).assertTrue();
282
- hilog.debug(DOMAIN, TAG, 'Uninitialized call handled correctly');
283
-
284
- hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
285
- });
286
- ```
287
-
288
- ---
289
-
290
- ## 七、大数据量测试
291
-
292
- 适用于验证接口在大数据量输入下的处理能力和性能:
293
-
294
- ```typescript
295
- /**
296
- * 用例 {SEQ}: {用例名称}
297
- *
298
- * 用例描述:验证接口在大数据量输入(大数组、深度嵌套、大量属性)下的处理能力
299
- * 涉及接口:{接口签名}
300
- * 预期结果:
301
- * 1. 大数据量输入应正确处理,返回值结构与预期一致
302
- * 2. 操作应在合理时间内完成(建议 5 秒内)
303
- * 3. 不应发生内存溢出、栈溢出或崩溃
304
- * 4. 大数据量操作的结果准确性可验证(如首尾元素、深层值)
305
- */
306
- it('{function_large_data}_{SEQ}', 0, () => {
307
- hilog.info(DOMAIN, TAG, 'Test {SEQ}: {用例名称} started');
308
-
309
- // ─── 准备大数据量测试数据 ────────────────────────────────────────────
310
- const largeArray: number[] = [];
311
- for (let i = 0; i < 10000; i++) {
312
- largeArray.push(i);
313
- }
314
- // 生成深度嵌套对象(10+ 层)需定义逐层嵌套的 interface 类型
315
- // 生成大量属性对象(1000+ 属性)需用类型安全的方式构建
316
-
317
- // ─── 测试 1:大数组处理 ────────────────────────────────────────────────
318
- const startTime1: number = Date.now();
319
- const result1 = {接口调用(largeArray)};
320
- const duration1: number = Date.now() - startTime1;
321
- hilog.debug(DOMAIN, TAG, 'Large array result length: %{public}d, duration: %{public}d ms', result1.length, duration1);
322
-
323
- // 验证结果正确性(长度、首尾元素)
324
- expect(result1.length).assertEqual({预期长度});
325
- expect(result1[0]).assertEqual({预期首元素});
326
- expect(result1[result1.length - 1]).assertEqual({预期尾元素});
327
- // 验证不超时(5 秒内完成)—— 反转比较方向:5000 > duration
328
- expect(5000).assertLarger(duration1);
329
-
330
- // ─── 测试 2:深度嵌套结构处理 ──────────────────────────────────────────
331
- // 构建深度嵌套对象(使用类型安全的方式,避免 any/Object)
332
- const deepNestedObj: {DeepNestedType} = {构建深度嵌套数据};
333
- const startTime2: number = Date.now();
334
- const result2 = {接口调用(deepNestedObj)};
335
- const duration2: number = Date.now() - startTime2;
336
- hilog.debug(DOMAIN, TAG, 'Deep nested result duration: %{public}d ms', duration2);
337
-
338
- // 验证深层拷贝完整性
339
- expect({深层属性访问}).assertEqual({预期深层值});
340
- // 验证不超时 —— 反转比较方向:5000 > duration
341
- expect(5000).assertLarger(duration2);
342
- // 验证不崩溃(能执行到这里即说明未崩溃)
343
-
344
- hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
345
- });
346
- ```
347
-
348
- > ⚠️ **大数据测试注意事项**:
349
- > 1. ArkTS 禁止 `any`/`Object` 类型,构建大数据结构必须使用类型安全的方式(定义 interface 或具体类型)
350
- > 2. 生成大数组推荐使用 `for` 循环逐个 push,避免使用动态构造
351
- > 3. 深度嵌套对象需定义逐层嵌套的 interface 类型
352
- > 4. 性能断言使用 `expect(5000).assertLarger(duration)` 验证操作在 5 秒内完成(反转比较方向)
353
- > 5. 大数据测试建议放在测试文件末尾,与正向/反向测试分组区分
354
- > 6. **期望值必须程序化计算**:当大数据通过 `arr[i] = f(i)` 生成时,首尾元素的期望值必须用 `f(0)` 和 `f(lastIndex)` 计算或表达式表示,禁止硬编码。例如 `arr[i] = i % 256`,`arr[9999]` 的期望值应写为 `expect(arr[9999]).assertEqual(9999 % 256)` 而非 `255`。
355
-
356
- ---
357
-
358
- ## 八、异步测试
359
-
360
- 适用于验证异步接口的测试:
361
-
362
- ```typescript
363
- /**
364
- * 用例 {SEQ}: {用例名称}
365
- *
366
- * 用例描述:验证异步接口的正确性
367
- * 涉及接口:{接口签名}(返回 Promise)
368
- * 预期结果:
369
- * 1. Promise resolve 后,结果应为 {预期结果}
370
- * 2. Promise 不应 reject
371
- */
372
- it('{async_function}_{SEQ}', 0, async () => {
373
- hilog.info(DOMAIN, TAG, 'Test {SEQ}: {用例名称} started');
374
-
375
- // ─── 异步测试执行 ────────────────────────────────────────────────────
376
- const result = await {异步接口调用()};
377
- hilog.debug(DOMAIN, TAG, 'Async result: %{public}s', JSON.stringify(result));
378
-
379
- // ─── 断言验证 ──────────────────────────────────────────────────────
380
- expect(result).assertEqual({预期结果});
381
-
382
- hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
383
- });
384
- ```
385
-
386
- > ⚠️ **同步方法内部委托异步方法的陷阱**:若库的某个同步方法(如 `saveIntoFile`)内部实际委托给异步方法(如 `saveIntoFileAsync`),则测试时必须使用 `async` 函数 + `await` 调用异步版本,否则异步操作尚未完成就执行了后续断言。
387
-
388
- **超时验证变体**(在异步测试中附加执行时间断言):
389
-
390
- ```typescript
391
- it('{async_timeout}_{SEQ}', 0, async () => {
392
- hilog.info(DOMAIN, TAG, 'Test {SEQ} started (async with timeout)');
393
-
394
- const startTime = Date.now();
395
-
396
- const result = await {异步接口调用()};
397
- const duration = Date.now() - startTime;
398
-
399
- // 验证结果正确性
400
- expect(result).assertEqual({预期结果});
401
-
402
- // 验证执行时间在合理范围内 —— 反转比较方向:5000 > duration
403
- expect(5000).assertLarger(duration);
404
-
405
- hilog.info(DOMAIN, TAG, 'Test {SEQ} passed, duration: %{public}dms', duration);
406
- });
407
- ```
408
-
409
- ---
410
-
411
- ## 九、类型判断测试
412
-
413
- 适用于验证类型判断接口的测试:
414
-
415
- ```typescript
416
- /**
417
- * 用例 {SEQ}: {用例名称}
418
- *
419
- * 用例描述:验证类型判断接口对不同类型值的判断准确性
420
- * 涉及接口:{类型判断接口签名}
421
- * 预期结果:
422
- * 1. 输入 {类型 A} 时,应返回 true
423
- * 2. 输入 {类型 B} 时,应返回 false
424
- */
425
- it('{is_type}_{SEQ}', 0, () => {
426
- hilog.info(DOMAIN, TAG, 'Test {SEQ}: {用例名称} started');
427
-
428
- // ─── 正向测试:输入目标类型 ──────────────────────────────────────────
429
- const trueResult = {类型判断接口({目标类型值})};
430
- expect(trueResult).assertTrue();
431
- hilog.debug(DOMAIN, TAG, 'True test passed');
432
-
433
- // ─── 反向测试:输入非目标类型 ────────────────────────────────────────
434
- const falseResult = {类型判断接口({非目标类型值})};
435
- expect(falseResult).assertFalse();
436
- hilog.debug(DOMAIN, TAG, 'False test passed');
437
-
438
- hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
439
- });
440
- ```
441
-
442
- ---
443
-
444
- ## 十、需要 Mock 数据的测试模板
445
-
446
- ```typescript
447
- /**
448
- * 用例 {SEQ}: {用例名称}(需 Mock)
449
- *
450
- * 测试前提:需准备模拟数据或使用测试服务器
451
- */
452
- it('{mock_function}_{SEQ}', 0, () => {
453
- hilog.info(DOMAIN, TAG, 'Test {SEQ} started (with mock data)');
454
-
455
- // ─── 准备 Mock 数据 ────────────────────────────────────────────────────
456
- const mockData = {
457
- status: 200,
458
- data: { id: 1, name: 'test' }
459
- };
460
- const mockUrl = 'http://test-server.mock/api';
461
-
462
- // 使用 Mock 数据验证接口逻辑
463
- const result = {接口调用(mockUrl)};
464
- expect(result.status).assertEqual(mockData.status);
465
- expect(result.data).assertEqual(mockData.data);
466
-
467
- hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
468
- });
469
- ```
470
-
471
- ---
472
-
473
- ## 十一、降级测试(接口不可导入)
474
-
475
- > 当接口类型被标记为「未导出」或「ESObject 阻断」时使用此模板。
476
- > 仅测试 getter 初始状态,setter 标注不可测试原因。
477
-
478
- ### 11.1 setter 参数不可导入 — 仅测试 getter
479
-
480
- ```typescript
481
- /**
482
- * 用例 {SEQ}: {用例名称}
483
- * 涉及接口:{仅列出可测试的 getter 接口}
484
- * 降级说明:{UnimportableType} {未导出/ESObject阻断},setXxx() 不可测试
485
- * 预期结果:
486
- * 1. getXxx() 初始返回 null/默认值
487
- */
488
- it('{name}_degraded_{SEQ}', 0, () => {
489
- hilog.info(DOMAIN, TAG, 'Test {SEQ}: {用例名称} (降级) started');
490
-
491
- const obj = new TestableSubclass();
492
- expect(obj.getXxx()).assertNull();
493
- // setXxx({UnimportableType}) 不可测试:{UnimportableType} {未导出/ESObject阻断}
494
-
495
- hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
496
- });
497
- ```
498
-
499
- ### 11.2 构造器参数含不可导入类型 — 使用 SDK Mock 替代
500
-
501
- ```typescript
502
- /**
503
- * 用例 {SEQ}: {用例名称}
504
- * 降级说明:构造器参数 {UnimportableType} 不可导入,使用 {SDKMockMethod} 创建 Mock 对象
505
- * 预期结果:
506
- * 1. 构造成功,getXxx() 返回预期值
507
- */
508
- it('{name}_mock_{SEQ}', 0, () => {
509
- hilog.info(DOMAIN, TAG, 'Test {SEQ}: {用例名称} (Mock 降级) started');
510
-
511
- const mockParam = ble.createGattClientDevice('mock-device-id');
512
- const obj = new TargetClass(mockParam, {numberParam});
513
- expect(obj.getXxx()).assertEqual({预期值});
514
- hilog.debug(DOMAIN, TAG, 'Result: %{public}s', String(obj.getXxx()));
515
-
516
- hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
517
- });
518
- ```
519
-
520
- ### 11.3 getter 返回不可导入类型 — 仅验证初始 null
521
-
522
- ```typescript
523
- /**
524
- * 用例 {SEQ}: {用例名称}
525
- * 降级说明:getXxx() 返回类型 {UnimportableType} 不可导入,仅验证初始 null 状态
526
- * 预期结果:
527
- * 1. getXxx() 初始返回 null
528
- */
529
- it('{name}_getter_only_{SEQ}', 0, () => {
530
- hilog.info(DOMAIN, TAG, 'Test {SEQ}: {用例名称} (getter-only 降级) started');
531
-
532
- const obj = new TestableSubclass();
533
- expect(obj.getXxx()).assertNull();
534
- hilog.debug(DOMAIN, TAG, 'getXxx initial null: %{public}s', String(obj.getXxx() === null));
535
-
536
- hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
537
- });
538
- ```
539
-
540
- ---
541
-
542
- ## 十二、interface 实例化模板
543
-
544
- > ⚠️ interface 类型禁止 `new`(见 [CODE_STANDARDS.md 二](CODE_STANDARDS.md))
545
-
546
- ### 12.1 interface 对象字面量
547
-
548
- ```typescript
549
- // ✅ 正确:interface 用对象字面量赋值
550
- const headerOpt: HeaderOptions = { key: 'Accept', value: '*/*' };
551
-
552
- // ❌ 错误:interface 不能 new
553
- // const headerOpt = new HeaderOptions();
554
- ```
555
-
556
- ### 12.2 implements 实现类
557
-
558
- ```typescript
559
- // ✅ 正确:interface 用 implements 实现类
560
- class TestCallback implements OnLoadCallBack {
561
- onLoadSuccess: (data: ImageInfo) => void = (data: ImageInfo) => {
562
- hilog.debug(DOMAIN, TAG, 'onLoadSuccess: %{public}s', JSON.stringify(data));
563
- };
564
- onLoadFailed: (err: ErrorInfo) => void = (err: ErrorInfo) => {
565
- hilog.error(DOMAIN, TAG, 'onLoadFailed: %{public}s', JSON.stringify(err));
566
- };
567
- }
568
-
569
- const callback: OnLoadCallBack = new TestCallback();
570
- option.onLoadListener = callback;
571
- ```
572
-
573
- ### 12.3 嵌套 interface 属性赋值
574
-
575
- ```typescript
576
- // ✅ 正确:通过嵌套 interface 对象设置(接口属性为对象时整体赋值)
577
- const option = new ImageKnifeOptionV2();
578
- option.onLoadListener = {
579
- onLoadSuccess: (data: ImageInfo) => { ... },
580
- onLoadFailed: (err: ErrorInfo) => { ... },
581
- };
582
-
583
- // ❌ 错误:直接赋值嵌套属性
584
- // option.onLoadSuccess = (data) => { ... }; // onLoadSuccess 不是直接属性
585
- ```
586
-
587
- ---
588
-
589
- ## 十三、测试套件注册模板
590
-
591
- 测试套件需要在 ohosTest 的入口文件中注册:
592
-
593
- ```typescript
594
- // entry/src/ohosTest/ets/test/List.test.ets
595
-
596
- import {LibraryName}XtsTest from './{LibraryName}XtsTest.test';
597
- import {OtherLibrary}XtsTest from './{OtherLibrary}XtsTest.test';
598
-
599
- export default function testsuite() {
600
- {LibraryName}XtsTest();
601
- {OtherLibrary}XtsTest();
602
- }
603
- ```
604
-
605
- > **注意**:import 路径不带 `.ets` 扩展名,但保留 `.test` 部分(如 `'./LodashXtsTest.test'`)。
606
-
607
- ---
608
-
609
- ## 十四、测试覆盖率统计注释
610
-
611
- 在测试文件末尾添加覆盖率统计注释:
612
-
613
- ```typescript
614
- /**
615
- * ─── 测试覆盖率统计 ──────────────────────────────────────────────────────
616
- *
617
- * 用例总数:{N}
618
- * 可测试接口数:{M}
619
- * 测试函数数:{K}
620
- *
621
- * 功能模块覆盖:
622
- * - {模块 A}:{X} 个用例({接口列表})- 100% 覆盖
623
- * - {模块 B}:{Y} 个用例({接口列表})- 100% 覆盖
624
- *
625
- * 测试类型分布:
626
- * - 正向功能测试:{X} 个({%})
627
- * - 多接口协同测试:{X} 个({%})
628
- * - 空值输入测试:{X} 个({%})
629
- * - 异常/边界值测试:{X} 个({%})
630
- * - 大数据量测试:{X} 个({%})
631
- */
632
- ```
633
-
634
- ---
635
-
636
- ## 十五、外部硬件/服务依赖接口测试模板
637
-
638
- 适用于接口依赖真实硬件(BLE/NFC/传感器/定位等)或外部服务,测试环境无法提供真实设备的场景。
639
- 核心策略:try-catch 验证不崩溃 + 可选状态预检 + 链式返回判空。
640
-
641
- ```typescript
642
- /**
643
- * 用例 {SEQ}: {用例名称}
644
- *
645
- * 用例描述:验证 {接口名} 在无真实硬件环境下的健壮性,确保不崩溃
646
- * 涉及接口:{接口签名}(依赖 BLE/NFC/传感器等硬件)
647
- * 预期结果:
648
- * 1. 无硬件时调用应安全失败或返回默认值,不崩溃
649
- * 2. 返回值若为 null/false 属于预期行为(硬件不可用)
650
- */
651
- it('{hardware_func}_{SEQ}', 0, () => {
652
- hilog.info(DOMAIN, TAG, 'Test {SEQ}: {用例名称} started');
653
-
654
- // ─── 可选:硬件状态预检 ────────────────────────────────────────────
655
- // 若库提供 isXxxEnabled() 方法,先查询当前硬件状态
656
- // let hardwareAvailable: boolean = false;
657
- // try {
658
- // hardwareAvailable = SomeManager.getInstance().isBlueEnable();
659
- // } catch (e) { /* 硬件查询失败也视为不可用 */ }
660
- // hilog.debug(DOMAIN, TAG, 'Hardware available: %{public}s', String(hardwareAvailable));
661
-
662
- // ─── 硬件依赖调用(try-catch 验证不崩溃)────────────────────────────
663
- let caught: boolean = false;
664
- let result: boolean = false;
665
- try {
666
- // 调用依赖硬件的接口(如 scan/connect/enableBluetooth)
667
- result = SomeManager.getInstance().startScan();
668
- } catch (e) {
669
- caught = true;
670
- }
671
-
672
- // 断言:不崩溃即通过(caught 为 true 或 false 均可接受)
673
- // 若返回值为 boolean,额外验证类型正确
674
- expect(typeof result === 'boolean').assertTrue();
675
- hilog.debug(DOMAIN, TAG, 'Hardware call result: caught=%{public}s, result=%{public}s', String(caught), String(result));
676
-
677
- hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
678
- });
679
- ```
680
-
681
- > **适用场景分类**:
682
- > - 纯硬件操作(scan/connect/enable):try-catch + 布尔标记验证不崩溃
683
- > - 回调透传:注入 Mock 实现验证回调标志(见 XTS_TEMPLATE.md 十二 implements 模板)
684
- > - 链式返回:验证返回值非 null(`expect(result !== null).assertTrue()`)+ instanceof 判断
685
- > - 状态查询:先 reset 再断言状态值(见 XTS_TEMPLATE.md 十六 单例状态隔离)
686
-
687
- ---
688
-
689
- ## 十六、单例状态隔离模板(beforeEach 重置)
690
-
691
- 适用于库使用单例模式(含 `getInstance()` 静态方法)且实例状态跨用例持久化的场景。
692
- 在 `beforeEach` 中调用 reset/stop 方法重置单例状态,防止前序用例污染后续断言。
693
-
694
- ```typescript
695
- export default function {LibraryName}XtsTest() {
696
- describe('{LibraryName}XtsTest', () => {
697
-
698
- beforeAll(() => {
699
- // 全局初始化(仅执行一次)
700
- const delegator = abilityDelegatorRegistry.getAbilityDelegator();
701
- const appContext: common.Context = delegator.getAppContext();
702
- tempDir = appContext.tempDir;
703
- hilog.info(DOMAIN, TAG, 'XTS test suite started, tempDir=%{public}s', tempDir);
704
- });
705
-
706
- // ─── 单例状态重置(每个用例前执行)──────────────────────────────────
707
- beforeEach(() => {
708
- // 调用库提供的 reset/stop 方法将单例恢复到已知初始状态
709
- // 用 try-catch 包裹:若单例尚未初始化或 reset 方法抛异常,不影响后续用例
710
- try { SomeManager.getInstance().stopScan() } catch (e) {}
711
- try { SomeManager.getInstance().stopLeScan() } catch (e) {}
712
- // 可选:重置其他单例
713
- // try { OtherManager.getInstance().reset() } catch (e) {}
714
- });
715
-
716
- afterEach(() => {
717
- hilog.info(DOMAIN, TAG, 'Test case finished');
718
- });
719
-
720
- // ─── 测试用例 ────────────────────────────────────────────────────────
721
-
722
- /**
723
- * 用例 {SEQ}: 单例初始状态验证
724
- *
725
- * 用例描述:验证单例在 beforeEach 重置后处于初始状态
726
- * 涉及接口:SomeManager.getInstance().getScanState()
727
- * 预期结果:
728
- * 1. beforeEach 重置后 getScanState() 返回 STATE_IDLE
729
- */
730
- it('singleton_initial_state_{SEQ}', 0, () => {
731
- hilog.info(DOMAIN, TAG, 'Test {SEQ}: singleton initial state started');
732
-
733
- // beforeEach 已调用 stopScan(),此时状态应为 IDLE
734
- const state: number = SomeManager.getInstance().getScanState();
735
- expect(state).assertEqual(0); // STATE_IDLE = 0
736
- hilog.debug(DOMAIN, TAG, 'Singleton state after reset: %{public}d', state);
737
-
738
- hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
739
- });
740
-
741
- /**
742
- * 用例 {SEQ}: 单例状态变更后验证
743
- *
744
- * 用例描述:验证调用 startScan() 后状态变更为 SCANNING
745
- * 涉及接口:SomeManager.getInstance().startScan() / getScanState()
746
- * 预期结果:
747
- * 1. startScan() 后 getScanState() 返回 STATE_SCANNING
748
- */
749
- it('singleton_after_start_{SEQ}', 0, () => {
750
- hilog.info(DOMAIN, TAG, 'Test {SEQ}: singleton state after start started');
751
-
752
- // beforeEach 已重置,从已知初始状态开始
753
- try { SomeManager.getInstance().startScan() } catch (e) {}
754
- const state: number = SomeManager.getInstance().getScanState();
755
- expect(state).assertEqual(1); // STATE_SCANNING = 1
756
- hilog.debug(DOMAIN, TAG, 'Singleton state after start: %{public}d', state);
757
-
758
- hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
759
- });
760
-
761
- });
762
- }
763
- ```
764
-
765
- > **降级策略**:若库未提供 reset/stop 方法(无法重置单例状态),改为断言"调用某方法后的状态"而非"初始状态"。
766
- > 例如,不验证 `getScanState() == STATE_IDLE`,改为验证 `startScan()` 后 `getScanState() == STATE_SCANNING`,
767
- > 避免因前序用例已修改状态而导致"初始状态"断言不稳定。
1
+ # XTS 测试代码模板
2
+
3
+ 本文档提供 ArkTS XTS 测试代码生成时使用的标准模板,包含测试文件模板、测试函数模板、异步测试模板、多接口协同测试模板等。
4
+
5
+ > ⚠️ **核心规范**:
6
+ > - `it()` 必须使用三参数格式 `it(name, 0, () => {})` — 省略 filter 部分设备崩溃
7
+ > - 断言 API 必须使用 hypium 专用方法(`assertEqual`/`assertNull`/`assertTrue`/`assertFalse`/`assertLarger`/`assertContain`),**禁止** Jest 风格(`toBe`/`toEqual`/`toBeTruthy`/`toThrow` 等)
8
+ > - hilog 导入:`import { hilog } from '@kit.PerformanceAnalysisKit'`(禁止 `import hilog from '@ohos.hilog'`)
9
+ > - 文件扩展名:`.test.ets`(禁止 `.ts`)
10
+ > - 禁止 `catch(e) { throw e }`(arkts-limited-throw),正常测试不包裹 try-catch
11
+ > - 文件路径通过 `abilityDelegatorRegistry` 获取沙箱目录,禁止硬编码
12
+
13
+ ---
14
+
15
+ ## 一、测试文件基础模板
16
+
17
+ 完整的 XTS 测试文件结构模板:
18
+
19
+ ```typescript
20
+ /**
21
+ * {LibraryName} XTS 测试用例
22
+ *
23
+ * 基于 XTS 用例描述文档生成,验证 {LibraryName} 的核心功能。
24
+ * 文档来源:ohos_{LibraryName}xts用例描述.md
25
+ *
26
+ * 用例总数:{N}
27
+ * 可测试接口数:{M}
28
+ *
29
+ * @author lalhan
30
+ */
31
+
32
+ import { describe, it, expect, beforeAll, afterAll, beforeEach, afterEach } from '@ohos/hypium';
33
+ import { hilog } from '@kit.PerformanceAnalysisKit';
34
+ import { abilityDelegatorRegistry } from '@kit.TestKit';
35
+ import { common } from '@kit.AbilityKit';
36
+ import { {ImportedSymbols} } from '{LibraryPackage}';
37
+
38
+ // ─── 日志常量 ──────────────────────────────────────────────────────────────
39
+ const DOMAIN: number = 0xD001;
40
+ const TAG: string = '{LibraryName}_XtsTest';
41
+
42
+ // ─── 全局测试上下文 ──────────────────────────────────────────────────────────
43
+ /** 测试用临时目录(由 beforeAll 从 AbilityDelegator 获取真实 Context) */
44
+ let tempDir: string = '';
45
+
46
+ /**
47
+ * {LibraryName} XTS 测试套件
48
+ *
49
+ * 验证 {LibraryName} 的以下功能模块:
50
+ * - 模块 A:{功能描述}
51
+ * - 模块 B:{功能描述}
52
+ */
53
+ export default function {LibraryName}XtsTest() {
54
+ describe('{LibraryName}XtsTest', () => {
55
+
56
+ // ─── 测试套件生命周期 ────────────────────────────────────────────────
57
+
58
+ beforeAll(() => {
59
+ // 通过 AbilityDelegator 获取应用真实 Context,以访问沙箱临时目录
60
+ const delegator = abilityDelegatorRegistry.getAbilityDelegator();
61
+ const appContext: common.Context = delegator.getAppContext();
62
+ tempDir = appContext.tempDir;
63
+ hilog.info(DOMAIN, TAG, 'XTS test suite started, tempDir=%{public}s', tempDir);
64
+ });
65
+
66
+ afterAll(() => {
67
+ hilog.info(DOMAIN, TAG, 'XTS test suite finished');
68
+ });
69
+
70
+ // ─── 测试用例区域 ──────────────────────────────────────────────────────
71
+
72
+ // 此处插入各个测试函数(见后续模板)
73
+
74
+ });
75
+ }
76
+ ```
77
+
78
+ ---
79
+
80
+ ## 二、单接口正向测试
81
+
82
+ 适用于单个接口的基础功能验证测试:
83
+
84
+ ```typescript
85
+ /**
86
+ * 用例 {SEQ}: {用例名称}
87
+ *
88
+ * 用例描述:{从用例描述文档提取的详细描述}
89
+ * 涉及接口:{接口签名}
90
+ * 预期结果:
91
+ * 1. {预期结果 1}
92
+ * 2. {预期结果 2}
93
+ */
94
+ it('{function_snake_case}_{SEQ}', 0, () => {
95
+ hilog.info(DOMAIN, TAG, 'Test {SEQ}: {用例名称} started');
96
+
97
+ // ─── 测试数据准备 ────────────────────────────────────────────────────
98
+ const inputData = { ... }; // 准备测试输入数据
99
+ const expectedOutput = { ... }; // 准备预期输出
100
+
101
+ // ─── 测试执行 ────────────────────────────────────────────────────────
102
+ const result = {LibraryCall(inputData)};
103
+ hilog.debug(DOMAIN, TAG, 'Result: %{public}s', JSON.stringify(result));
104
+
105
+ // ─── 断言验证 ──────────────────────────────────────────────────────
106
+ expect(result).assertEqual(expectedOutput);
107
+
108
+ hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
109
+ });
110
+ ```
111
+
112
+ > **关于 try-catch 策略**:ArkTS 严格模式下禁止 `throw err`(arkts-limited-throw),因此正常测试不建议包裹 try-catch。`expect` 断言失败会自动让测试框架标记失败,运行时异常也会被框架捕获。
113
+
114
+ ---
115
+
116
+ ## 三、多接口协同测试
117
+
118
+ 适用于多个接口协同完成功能流程的测试:
119
+
120
+ ```typescript
121
+ /**
122
+ * 用例 {SEQ}: {用例名称}
123
+ *
124
+ * 用例描述:验证多个接口的协同工作能力,确保接口间调用顺序和状态传递正确
125
+ * 涉及接口:
126
+ * - {接口 1 签名}(作用:{接口 1 作用})
127
+ * - {接口 2 签名}(作用:{接口 2 作用})
128
+ * 预期结果:
129
+ * 1. {接口 1 执行后状态}
130
+ * 2. {接口 2 执行后状态}
131
+ * 3. {协同验证结果}
132
+ */
133
+ it('{functions_snake_case}_{SEQ}', 0, () => {
134
+ hilog.info(DOMAIN, TAG, 'Test {SEQ}: {用例名称} started');
135
+
136
+ // ─── 步骤 1:{接口 1 功能} ──────────────────────────────────────────────
137
+ const {objName} = {初始状态};
138
+ const {step1Result} = {接口 1 调用};
139
+ hilog.debug(DOMAIN, TAG, 'Step 1 result: %{public}s', JSON.stringify({step1Result}));
140
+ expect({step1Result}).assertEqual({预期结果 1});
141
+
142
+ // ─── 步骤 2:{接口 2 功能} ──────────────────────────────────────────────
143
+ const {step2Result} = {接口 2 调用};
144
+ hilog.debug(DOMAIN, TAG, 'Step 2 result: %{public}s', String({step2Result}));
145
+ expect({step2Result}).assertEqual({预期结果 2});
146
+
147
+ // ─── 步骤 3:协同验证 ────────────────────────────────────────────────
148
+ expect({协同验证表达式}).assertEqual({预期协同结果});
149
+
150
+ hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
151
+ });
152
+ ```
153
+
154
+ ---
155
+
156
+ ## 四、空值/null/undefined 输入测试
157
+
158
+ 适用于验证接口对空值输入的处理测试:
159
+
160
+ ```typescript
161
+ /**
162
+ * 用例 {SEQ}: {用例名称}
163
+ *
164
+ * 用例描述:验证接口对 null/undefined/空值输入的处理能力,确保空值不会导致崩溃
165
+ * 涉及接口:{接口签名}
166
+ * 预期结果:
167
+ * 1. 输入 null 时,应抛出异常或返回安全默认值
168
+ * 2. 输入空数组/空字符串/空对象时,应返回空结果或安全默认值
169
+ * 3. 所有空值输入不应导致崩溃或不可预期行为
170
+ */
171
+ it('{function_null_input}_{SEQ}', 0, () => {
172
+ hilog.info(DOMAIN, TAG, 'Test {SEQ}: {用例名称} started');
173
+
174
+ // ─── 测试 1:null 输入(预期抛异常) ──────────────────────────────────────
175
+ let caught1: boolean = false;
176
+ try {
177
+ {接口调用(null 或 null 等效值)};
178
+ } catch (e) {
179
+ caught1 = true;
180
+ }
181
+ expect(caught1).assertTrue();
182
+ hilog.debug(DOMAIN, TAG, 'Null input handled correctly (exception thrown)');
183
+
184
+ // ─── 测试 2:null 输入(预期返回安全默认值) ─────────────────────────────
185
+ const result2 = {接口调用(null 或 null 等效值)};
186
+ expect(result2).assertNull(); // 或 .assertEqual({安全默认值})
187
+ hilog.debug(DOMAIN, TAG, 'Null input result: %{public}s', String(result2));
188
+
189
+ // ─── 测试 3:空集合输入(空数组/空字符串/空对象)───────────────────────
190
+ const result3 = {接口调用([])}; // 或 '' 或 {}
191
+ hilog.debug(DOMAIN, TAG, 'Empty collection result: %{public}s', JSON.stringify(result3));
192
+ expect(result3).assertEqual({预期空结果}); // 如 []、''、{} 或 null
193
+
194
+ hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
195
+ });
196
+ ```
197
+
198
+ > **null 输入处理策略**:
199
+ > - 若参数类型允许 null,直接传入 null
200
+ > - 若参数类型不允许 null(ArkTS 严格类型),使用 `{} as SomeType` 作为空对象 mock(仅当库不实际使用该参数时)
201
+ > - 若需要验证 null 拒绝,用 try-catch + 布尔标记模式
202
+
203
+ ---
204
+
205
+ ## 五、异常参数与边界值测试
206
+
207
+ 适用于验证接口对异常参数和边界值的处理测试:
208
+
209
+ ```typescript
210
+ /**
211
+ * 用例 {SEQ}: {用例名称}
212
+ *
213
+ * 用例描述:验证接口对异常参数(类型不匹配、超限值)和边界值(NaN、Infinity、负值、零值)的处理能力
214
+ * 涉及接口:{接口签名}
215
+ * 预期结果:
216
+ * 1. 类型不匹配参数应抛出异常或返回错误码
217
+ * 2. 超限值应被合理处理(clamp 到范围或抛出异常)
218
+ * 3. NaN/Infinity/负值/零值应返回预期结果或抛出异常
219
+ * 4. 所有异常处理不应导致崩溃
220
+ */
221
+ it('{function_exception_boundary}_{SEQ}', 0, () => {
222
+ hilog.info(DOMAIN, TAG, 'Test {SEQ}: {用例名称} started');
223
+
224
+ // ─── 测试 1:类型不匹配参数(预期抛异常) ──────────────────────────────
225
+ let caught1: boolean = false;
226
+ try {
227
+ {接口调用({类型不匹配值})};
228
+ } catch (e) {
229
+ caught1 = true;
230
+ }
231
+ expect(caught1).assertTrue();
232
+ hilog.debug(DOMAIN, TAG, 'Type mismatch handled correctly');
233
+
234
+ // ─── 测试 2:特殊值 NaN ────────────────────────────────────────────────
235
+ const result2 = {接口调用(NaN)};
236
+ hilog.debug(DOMAIN, TAG, 'NaN input result: %{public}s', String(result2));
237
+ expect(Number.isNaN(result2)).assertTrue(); // 或 expect(result2).assertEqual({默认值})
238
+
239
+ // ─── 测试 3:特殊值 Infinity ────────────────────────────────────────────
240
+ const result3 = {接口调用(Infinity)};
241
+ hilog.debug(DOMAIN, TAG, 'Infinity input result: %{public}s', String(result3));
242
+ expect(result3).assertEqual({预期结果});
243
+
244
+ // ─── 测试 4:负值/零值 ──────────────────────────────────────────────────
245
+ const result4 = {接口调用({负值或零值})};
246
+ hilog.debug(DOMAIN, TAG, 'Negative/zero input result: %{public}s', String(result4));
247
+ expect(result4).assertEqual({预期结果});
248
+
249
+ hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
250
+ });
251
+ ```
252
+
253
+ ---
254
+
255
+ ## 六、反向测试(状态异常)
256
+
257
+ 适用于验证接口在异常状态下的行为测试:
258
+
259
+ ```typescript
260
+ /**
261
+ * 用例 {SEQ}: {用例名称}
262
+ *
263
+ * 用例描述:验证接口在未初始化状态下的调用行为
264
+ * 涉及接口:{接口签名}
265
+ * 前置条件:{正常前置条件}(本测试故意不满足)
266
+ * 预期结果:
267
+ * 1. 在未满足前置条件时调用,应抛出异常或返回错误码
268
+ * 2. 不应导致崩溃或不可预期行为
269
+ */
270
+ it('{function_state_error}_{SEQ}', 0, () => {
271
+ hilog.info(DOMAIN, TAG, 'Test {SEQ}: {用例名称} started');
272
+
273
+ // ─── 测试场景:未初始化状态调用 ──────────────────────────────────────
274
+ // 不调用初始化方法,直接调用执行方法
275
+ let caught: boolean = false;
276
+ try {
277
+ {执行接口调用()};
278
+ } catch (e) {
279
+ caught = true;
280
+ }
281
+ expect(caught).assertTrue();
282
+ hilog.debug(DOMAIN, TAG, 'Uninitialized call handled correctly');
283
+
284
+ hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
285
+ });
286
+ ```
287
+
288
+ ---
289
+
290
+ ## 七、大数据量测试
291
+
292
+ 适用于验证接口在大数据量输入下的处理能力和性能:
293
+
294
+ ```typescript
295
+ /**
296
+ * 用例 {SEQ}: {用例名称}
297
+ *
298
+ * 用例描述:验证接口在大数据量输入(大数组、深度嵌套、大量属性)下的处理能力
299
+ * 涉及接口:{接口签名}
300
+ * 预期结果:
301
+ * 1. 大数据量输入应正确处理,返回值结构与预期一致
302
+ * 2. 操作应在合理时间内完成(建议 5 秒内)
303
+ * 3. 不应发生内存溢出、栈溢出或崩溃
304
+ * 4. 大数据量操作的结果准确性可验证(如首尾元素、深层值)
305
+ */
306
+ it('{function_large_data}_{SEQ}', 0, () => {
307
+ hilog.info(DOMAIN, TAG, 'Test {SEQ}: {用例名称} started');
308
+
309
+ // ─── 准备大数据量测试数据 ────────────────────────────────────────────
310
+ const largeArray: number[] = [];
311
+ for (let i = 0; i < 10000; i++) {
312
+ largeArray.push(i);
313
+ }
314
+ // 生成深度嵌套对象(10+ 层)需定义逐层嵌套的 interface 类型
315
+ // 生成大量属性对象(1000+ 属性)需用类型安全的方式构建
316
+
317
+ // ─── 测试 1:大数组处理 ────────────────────────────────────────────────
318
+ const startTime1: number = Date.now();
319
+ const result1 = {接口调用(largeArray)};
320
+ const duration1: number = Date.now() - startTime1;
321
+ hilog.debug(DOMAIN, TAG, 'Large array result length: %{public}d, duration: %{public}d ms', result1.length, duration1);
322
+
323
+ // 验证结果正确性(长度、首尾元素)
324
+ expect(result1.length).assertEqual({预期长度});
325
+ expect(result1[0]).assertEqual({预期首元素});
326
+ expect(result1[result1.length - 1]).assertEqual({预期尾元素});
327
+ // 验证不超时(5 秒内完成)—— 反转比较方向:5000 > duration
328
+ expect(5000).assertLarger(duration1);
329
+
330
+ // ─── 测试 2:深度嵌套结构处理 ──────────────────────────────────────────
331
+ // 构建深度嵌套对象(使用类型安全的方式,避免 any/Object)
332
+ const deepNestedObj: {DeepNestedType} = {构建深度嵌套数据};
333
+ const startTime2: number = Date.now();
334
+ const result2 = {接口调用(deepNestedObj)};
335
+ const duration2: number = Date.now() - startTime2;
336
+ hilog.debug(DOMAIN, TAG, 'Deep nested result duration: %{public}d ms', duration2);
337
+
338
+ // 验证深层拷贝完整性
339
+ expect({深层属性访问}).assertEqual({预期深层值});
340
+ // 验证不超时 —— 反转比较方向:5000 > duration
341
+ expect(5000).assertLarger(duration2);
342
+ // 验证不崩溃(能执行到这里即说明未崩溃)
343
+
344
+ hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
345
+ });
346
+ ```
347
+
348
+ > ⚠️ **大数据测试注意事项**:
349
+ > 1. ArkTS 禁止 `any`/`Object` 类型,构建大数据结构必须使用类型安全的方式(定义 interface 或具体类型)
350
+ > 2. 生成大数组推荐使用 `for` 循环逐个 push,避免使用动态构造
351
+ > 3. 深度嵌套对象需定义逐层嵌套的 interface 类型
352
+ > 4. 性能断言使用 `expect(5000).assertLarger(duration)` 验证操作在 5 秒内完成(反转比较方向)
353
+ > 5. 大数据测试建议放在测试文件末尾,与正向/反向测试分组区分
354
+ > 6. **期望值必须程序化计算**:当大数据通过 `arr[i] = f(i)` 生成时,首尾元素的期望值必须用 `f(0)` 和 `f(lastIndex)` 计算或表达式表示,禁止硬编码。例如 `arr[i] = i % 256`,`arr[9999]` 的期望值应写为 `expect(arr[9999]).assertEqual(9999 % 256)` 而非 `255`。
355
+
356
+ ---
357
+
358
+ ## 八、异步测试
359
+
360
+ 适用于验证异步接口的测试:
361
+
362
+ ```typescript
363
+ /**
364
+ * 用例 {SEQ}: {用例名称}
365
+ *
366
+ * 用例描述:验证异步接口的正确性
367
+ * 涉及接口:{接口签名}(返回 Promise)
368
+ * 预期结果:
369
+ * 1. Promise resolve 后,结果应为 {预期结果}
370
+ * 2. Promise 不应 reject
371
+ */
372
+ it('{async_function}_{SEQ}', 0, async () => {
373
+ hilog.info(DOMAIN, TAG, 'Test {SEQ}: {用例名称} started');
374
+
375
+ // ─── 异步测试执行 ────────────────────────────────────────────────────
376
+ const result = await {异步接口调用()};
377
+ hilog.debug(DOMAIN, TAG, 'Async result: %{public}s', JSON.stringify(result));
378
+
379
+ // ─── 断言验证 ──────────────────────────────────────────────────────
380
+ expect(result).assertEqual({预期结果});
381
+
382
+ hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
383
+ });
384
+ ```
385
+
386
+ > ⚠️ **同步方法内部委托异步方法的陷阱**:若库的某个同步方法(如 `saveIntoFile`)内部实际委托给异步方法(如 `saveIntoFileAsync`),则测试时必须使用 `async` 函数 + `await` 调用异步版本,否则异步操作尚未完成就执行了后续断言。
387
+
388
+ **超时验证变体**(在异步测试中附加执行时间断言):
389
+
390
+ ```typescript
391
+ it('{async_timeout}_{SEQ}', 0, async () => {
392
+ hilog.info(DOMAIN, TAG, 'Test {SEQ} started (async with timeout)');
393
+
394
+ const startTime = Date.now();
395
+
396
+ const result = await {异步接口调用()};
397
+ const duration = Date.now() - startTime;
398
+
399
+ // 验证结果正确性
400
+ expect(result).assertEqual({预期结果});
401
+
402
+ // 验证执行时间在合理范围内 —— 反转比较方向:5000 > duration
403
+ expect(5000).assertLarger(duration);
404
+
405
+ hilog.info(DOMAIN, TAG, 'Test {SEQ} passed, duration: %{public}dms', duration);
406
+ });
407
+ ```
408
+
409
+ ---
410
+
411
+ ## 九、类型判断测试
412
+
413
+ 适用于验证类型判断接口的测试:
414
+
415
+ ```typescript
416
+ /**
417
+ * 用例 {SEQ}: {用例名称}
418
+ *
419
+ * 用例描述:验证类型判断接口对不同类型值的判断准确性
420
+ * 涉及接口:{类型判断接口签名}
421
+ * 预期结果:
422
+ * 1. 输入 {类型 A} 时,应返回 true
423
+ * 2. 输入 {类型 B} 时,应返回 false
424
+ */
425
+ it('{is_type}_{SEQ}', 0, () => {
426
+ hilog.info(DOMAIN, TAG, 'Test {SEQ}: {用例名称} started');
427
+
428
+ // ─── 正向测试:输入目标类型 ──────────────────────────────────────────
429
+ const trueResult = {类型判断接口({目标类型值})};
430
+ expect(trueResult).assertTrue();
431
+ hilog.debug(DOMAIN, TAG, 'True test passed');
432
+
433
+ // ─── 反向测试:输入非目标类型 ────────────────────────────────────────
434
+ const falseResult = {类型判断接口({非目标类型值})};
435
+ expect(falseResult).assertFalse();
436
+ hilog.debug(DOMAIN, TAG, 'False test passed');
437
+
438
+ hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
439
+ });
440
+ ```
441
+
442
+ ---
443
+
444
+ ## 十、需要 Mock 数据的测试模板
445
+
446
+ ```typescript
447
+ /**
448
+ * 用例 {SEQ}: {用例名称}(需 Mock)
449
+ *
450
+ * 测试前提:需准备模拟数据或使用测试服务器
451
+ */
452
+ it('{mock_function}_{SEQ}', 0, () => {
453
+ hilog.info(DOMAIN, TAG, 'Test {SEQ} started (with mock data)');
454
+
455
+ // ─── 准备 Mock 数据 ────────────────────────────────────────────────────
456
+ const mockData = {
457
+ status: 200,
458
+ data: { id: 1, name: 'test' }
459
+ };
460
+ const mockUrl = 'http://test-server.mock/api';
461
+
462
+ // 使用 Mock 数据验证接口逻辑
463
+ const result = {接口调用(mockUrl)};
464
+ expect(result.status).assertEqual(mockData.status);
465
+ expect(result.data).assertEqual(mockData.data);
466
+
467
+ hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
468
+ });
469
+ ```
470
+
471
+ ---
472
+
473
+ ## 十一、降级测试(接口不可导入)
474
+
475
+ > 当接口类型被标记为「未导出」或「ESObject 阻断」时使用此模板。
476
+ > 仅测试 getter 初始状态,setter 标注不可测试原因。
477
+
478
+ ### 11.1 setter 参数不可导入 — 仅测试 getter
479
+
480
+ ```typescript
481
+ /**
482
+ * 用例 {SEQ}: {用例名称}
483
+ * 涉及接口:{仅列出可测试的 getter 接口}
484
+ * 降级说明:{UnimportableType} {未导出/ESObject阻断},setXxx() 不可测试
485
+ * 预期结果:
486
+ * 1. getXxx() 初始返回 null/默认值
487
+ */
488
+ it('{name}_degraded_{SEQ}', 0, () => {
489
+ hilog.info(DOMAIN, TAG, 'Test {SEQ}: {用例名称} (降级) started');
490
+
491
+ const obj = new TestableSubclass();
492
+ expect(obj.getXxx()).assertNull();
493
+ // setXxx({UnimportableType}) 不可测试:{UnimportableType} {未导出/ESObject阻断}
494
+
495
+ hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
496
+ });
497
+ ```
498
+
499
+ ### 11.2 构造器参数含不可导入类型 — 使用 SDK Mock 替代
500
+
501
+ ```typescript
502
+ /**
503
+ * 用例 {SEQ}: {用例名称}
504
+ * 降级说明:构造器参数 {UnimportableType} 不可导入,使用 {SDKMockMethod} 创建 Mock 对象
505
+ * 预期结果:
506
+ * 1. 构造成功,getXxx() 返回预期值
507
+ */
508
+ it('{name}_mock_{SEQ}', 0, () => {
509
+ hilog.info(DOMAIN, TAG, 'Test {SEQ}: {用例名称} (Mock 降级) started');
510
+
511
+ const mockParam = ble.createGattClientDevice('mock-device-id');
512
+ const obj = new TargetClass(mockParam, {numberParam});
513
+ expect(obj.getXxx()).assertEqual({预期值});
514
+ hilog.debug(DOMAIN, TAG, 'Result: %{public}s', String(obj.getXxx()));
515
+
516
+ hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
517
+ });
518
+ ```
519
+
520
+ ### 11.3 getter 返回不可导入类型 — 仅验证初始 null
521
+
522
+ ```typescript
523
+ /**
524
+ * 用例 {SEQ}: {用例名称}
525
+ * 降级说明:getXxx() 返回类型 {UnimportableType} 不可导入,仅验证初始 null 状态
526
+ * 预期结果:
527
+ * 1. getXxx() 初始返回 null
528
+ */
529
+ it('{name}_getter_only_{SEQ}', 0, () => {
530
+ hilog.info(DOMAIN, TAG, 'Test {SEQ}: {用例名称} (getter-only 降级) started');
531
+
532
+ const obj = new TestableSubclass();
533
+ expect(obj.getXxx()).assertNull();
534
+ hilog.debug(DOMAIN, TAG, 'getXxx initial null: %{public}s', String(obj.getXxx() === null));
535
+
536
+ hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
537
+ });
538
+ ```
539
+
540
+ ---
541
+
542
+ ## 十二、interface 实例化模板
543
+
544
+ > ⚠️ interface 类型禁止 `new`(见 [CODE_STANDARDS.md 二](CODE_STANDARDS.md))
545
+
546
+ ### 12.1 interface 对象字面量
547
+
548
+ ```typescript
549
+ // ✅ 正确:interface 用对象字面量赋值
550
+ const headerOpt: HeaderOptions = { key: 'Accept', value: '*/*' };
551
+
552
+ // ❌ 错误:interface 不能 new
553
+ // const headerOpt = new HeaderOptions();
554
+ ```
555
+
556
+ ### 12.2 implements 实现类
557
+
558
+ ```typescript
559
+ // ✅ 正确:interface 用 implements 实现类
560
+ class TestCallback implements OnLoadCallBack {
561
+ onLoadSuccess: (data: ImageInfo) => void = (data: ImageInfo) => {
562
+ hilog.debug(DOMAIN, TAG, 'onLoadSuccess: %{public}s', JSON.stringify(data));
563
+ };
564
+ onLoadFailed: (err: ErrorInfo) => void = (err: ErrorInfo) => {
565
+ hilog.error(DOMAIN, TAG, 'onLoadFailed: %{public}s', JSON.stringify(err));
566
+ };
567
+ }
568
+
569
+ const callback: OnLoadCallBack = new TestCallback();
570
+ option.onLoadListener = callback;
571
+ ```
572
+
573
+ ### 12.3 嵌套 interface 属性赋值
574
+
575
+ ```typescript
576
+ // ✅ 正确:通过嵌套 interface 对象设置(接口属性为对象时整体赋值)
577
+ const option = new ImageKnifeOptionV2();
578
+ option.onLoadListener = {
579
+ onLoadSuccess: (data: ImageInfo) => { ... },
580
+ onLoadFailed: (err: ErrorInfo) => { ... },
581
+ };
582
+
583
+ // ❌ 错误:直接赋值嵌套属性
584
+ // option.onLoadSuccess = (data) => { ... }; // onLoadSuccess 不是直接属性
585
+ ```
586
+
587
+ ---
588
+
589
+ ## 十三、测试套件注册模板
590
+
591
+ 测试套件需要在 ohosTest 的入口文件中注册:
592
+
593
+ ```typescript
594
+ // entry/src/ohosTest/ets/test/List.test.ets
595
+
596
+ import {LibraryName}XtsTest from './{LibraryName}XtsTest.test';
597
+ import {OtherLibrary}XtsTest from './{OtherLibrary}XtsTest.test';
598
+
599
+ export default function testsuite() {
600
+ {LibraryName}XtsTest();
601
+ {OtherLibrary}XtsTest();
602
+ }
603
+ ```
604
+
605
+ > **注意**:import 路径不带 `.ets` 扩展名,但保留 `.test` 部分(如 `'./LodashXtsTest.test'`)。
606
+
607
+ ---
608
+
609
+ ## 十四、测试覆盖率统计注释
610
+
611
+ 在测试文件末尾添加覆盖率统计注释:
612
+
613
+ ```typescript
614
+ /**
615
+ * ─── 测试覆盖率统计 ──────────────────────────────────────────────────────
616
+ *
617
+ * 用例总数:{N}
618
+ * 可测试接口数:{M}
619
+ * 测试函数数:{K}
620
+ *
621
+ * 功能模块覆盖:
622
+ * - {模块 A}:{X} 个用例({接口列表})- 100% 覆盖
623
+ * - {模块 B}:{Y} 个用例({接口列表})- 100% 覆盖
624
+ *
625
+ * 测试类型分布:
626
+ * - 正向功能测试:{X} 个({%})
627
+ * - 多接口协同测试:{X} 个({%})
628
+ * - 空值输入测试:{X} 个({%})
629
+ * - 异常/边界值测试:{X} 个({%})
630
+ * - 大数据量测试:{X} 个({%})
631
+ */
632
+ ```
633
+
634
+ ---
635
+
636
+ ## 十五、外部硬件/服务依赖接口测试模板
637
+
638
+ 适用于接口依赖真实硬件(BLE/NFC/传感器/定位等)或外部服务,测试环境无法提供真实设备的场景。
639
+ 核心策略:try-catch 验证不崩溃 + 可选状态预检 + 链式返回判空。
640
+
641
+ ```typescript
642
+ /**
643
+ * 用例 {SEQ}: {用例名称}
644
+ *
645
+ * 用例描述:验证 {接口名} 在无真实硬件环境下的健壮性,确保不崩溃
646
+ * 涉及接口:{接口签名}(依赖 BLE/NFC/传感器等硬件)
647
+ * 预期结果:
648
+ * 1. 无硬件时调用应安全失败或返回默认值,不崩溃
649
+ * 2. 返回值若为 null/false 属于预期行为(硬件不可用)
650
+ */
651
+ it('{hardware_func}_{SEQ}', 0, () => {
652
+ hilog.info(DOMAIN, TAG, 'Test {SEQ}: {用例名称} started');
653
+
654
+ // ─── 可选:硬件状态预检 ────────────────────────────────────────────
655
+ // 若库提供 isXxxEnabled() 方法,先查询当前硬件状态
656
+ // let hardwareAvailable: boolean = false;
657
+ // try {
658
+ // hardwareAvailable = SomeManager.getInstance().isBlueEnable();
659
+ // } catch (e) { /* 硬件查询失败也视为不可用 */ }
660
+ // hilog.debug(DOMAIN, TAG, 'Hardware available: %{public}s', String(hardwareAvailable));
661
+
662
+ // ─── 硬件依赖调用(try-catch 验证不崩溃)────────────────────────────
663
+ let caught: boolean = false;
664
+ let result: boolean = false;
665
+ try {
666
+ // 调用依赖硬件的接口(如 scan/connect/enableBluetooth)
667
+ result = SomeManager.getInstance().startScan();
668
+ } catch (e) {
669
+ caught = true;
670
+ }
671
+
672
+ // 断言:不崩溃即通过(caught 为 true 或 false 均可接受)
673
+ // 若返回值为 boolean,额外验证类型正确
674
+ expect(typeof result === 'boolean').assertTrue();
675
+ hilog.debug(DOMAIN, TAG, 'Hardware call result: caught=%{public}s, result=%{public}s', String(caught), String(result));
676
+
677
+ hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
678
+ });
679
+ ```
680
+
681
+ > **适用场景分类**:
682
+ > - 纯硬件操作(scan/connect/enable):try-catch + 布尔标记验证不崩溃
683
+ > - 回调透传:注入 Mock 实现验证回调标志(见 XTS_TEMPLATE.md 十二 implements 模板)
684
+ > - 链式返回:验证返回值非 null(`expect(result !== null).assertTrue()`)+ instanceof 判断
685
+ > - 状态查询:先 reset 再断言状态值(见 XTS_TEMPLATE.md 十六 单例状态隔离)
686
+
687
+ ---
688
+
689
+ ## 十六、单例状态隔离模板(beforeEach 重置)
690
+
691
+ 适用于库使用单例模式(含 `getInstance()` 静态方法)且实例状态跨用例持久化的场景。
692
+ 在 `beforeEach` 中调用 reset/stop 方法重置单例状态,防止前序用例污染后续断言。
693
+
694
+ ```typescript
695
+ export default function {LibraryName}XtsTest() {
696
+ describe('{LibraryName}XtsTest', () => {
697
+
698
+ beforeAll(() => {
699
+ // 全局初始化(仅执行一次)
700
+ const delegator = abilityDelegatorRegistry.getAbilityDelegator();
701
+ const appContext: common.Context = delegator.getAppContext();
702
+ tempDir = appContext.tempDir;
703
+ hilog.info(DOMAIN, TAG, 'XTS test suite started, tempDir=%{public}s', tempDir);
704
+ });
705
+
706
+ // ─── 单例状态重置(每个用例前执行)──────────────────────────────────
707
+ beforeEach(() => {
708
+ // 调用库提供的 reset/stop 方法将单例恢复到已知初始状态
709
+ // 用 try-catch 包裹:若单例尚未初始化或 reset 方法抛异常,不影响后续用例
710
+ try { SomeManager.getInstance().stopScan() } catch (e) {}
711
+ try { SomeManager.getInstance().stopLeScan() } catch (e) {}
712
+ // 可选:重置其他单例
713
+ // try { OtherManager.getInstance().reset() } catch (e) {}
714
+ });
715
+
716
+ afterEach(() => {
717
+ hilog.info(DOMAIN, TAG, 'Test case finished');
718
+ });
719
+
720
+ // ─── 测试用例 ────────────────────────────────────────────────────────
721
+
722
+ /**
723
+ * 用例 {SEQ}: 单例初始状态验证
724
+ *
725
+ * 用例描述:验证单例在 beforeEach 重置后处于初始状态
726
+ * 涉及接口:SomeManager.getInstance().getScanState()
727
+ * 预期结果:
728
+ * 1. beforeEach 重置后 getScanState() 返回 STATE_IDLE
729
+ */
730
+ it('singleton_initial_state_{SEQ}', 0, () => {
731
+ hilog.info(DOMAIN, TAG, 'Test {SEQ}: singleton initial state started');
732
+
733
+ // beforeEach 已调用 stopScan(),此时状态应为 IDLE
734
+ const state: number = SomeManager.getInstance().getScanState();
735
+ expect(state).assertEqual(0); // STATE_IDLE = 0
736
+ hilog.debug(DOMAIN, TAG, 'Singleton state after reset: %{public}d', state);
737
+
738
+ hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
739
+ });
740
+
741
+ /**
742
+ * 用例 {SEQ}: 单例状态变更后验证
743
+ *
744
+ * 用例描述:验证调用 startScan() 后状态变更为 SCANNING
745
+ * 涉及接口:SomeManager.getInstance().startScan() / getScanState()
746
+ * 预期结果:
747
+ * 1. startScan() 后 getScanState() 返回 STATE_SCANNING
748
+ */
749
+ it('singleton_after_start_{SEQ}', 0, () => {
750
+ hilog.info(DOMAIN, TAG, 'Test {SEQ}: singleton state after start started');
751
+
752
+ // beforeEach 已重置,从已知初始状态开始
753
+ try { SomeManager.getInstance().startScan() } catch (e) {}
754
+ const state: number = SomeManager.getInstance().getScanState();
755
+ expect(state).assertEqual(1); // STATE_SCANNING = 1
756
+ hilog.debug(DOMAIN, TAG, 'Singleton state after start: %{public}d', state);
757
+
758
+ hilog.info(DOMAIN, TAG, 'Test {SEQ} passed');
759
+ });
760
+
761
+ });
762
+ }
763
+ ```
764
+
765
+ > **降级策略**:若库未提供 reset/stop 方法(无法重置单例状态),改为断言"调用某方法后的状态"而非"初始状态"。
766
+ > 例如,不验证 `getScanState() == STATE_IDLE`,改为验证 `startScan()` 后 `getScanState() == STATE_SCANNING`,
767
+ > 避免因前序用例已修改状态而导致"初始状态"断言不稳定。