codeply-cli 0.3.1 → 0.4.0

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 (375) hide show
  1. package/THIRD_PARTY_NOTICES.md +63 -63
  2. package/bin/codeply.js +127 -0
  3. package/lib/agent.mjs +2139 -2139
  4. package/lib/ai.mjs +6 -6
  5. package/lib/apply-patch.js +217 -217
  6. package/lib/arity-table.json +138 -138
  7. package/lib/arity.js +70 -70
  8. package/lib/auth.mjs +6 -6
  9. package/lib/cloud.mjs +708 -0
  10. package/lib/commands.js +103 -103
  11. package/lib/design-library/assemble-artifact.mjs +21 -21
  12. package/lib/design-library/cleanup.mjs +45 -45
  13. package/lib/design-library/index.json +22379 -22379
  14. package/lib/design-library/make-table-data.mjs +39 -39
  15. package/lib/diagnostics.js +192 -192
  16. package/lib/edit-engine.js +364 -364
  17. package/lib/github-agent.mjs +311 -307
  18. package/lib/history.js +75 -75
  19. package/lib/mcp.js +258 -258
  20. package/lib/native-tools.mjs +189 -189
  21. package/lib/oauth-connectors.js +2 -1
  22. package/lib/permissions.js +109 -109
  23. package/lib/plugins.js +353 -353
  24. package/lib/server.mjs +457 -457
  25. package/lib/session-db.js +220 -220
  26. package/lib/share.js +168 -168
  27. package/lib/skills.js +416 -416
  28. package/lib/snapshot.js +146 -146
  29. package/lib/terminal-hints.js +154 -154
  30. package/lib/tools.mjs +2012 -2012
  31. package/lib/typecheck-worker.js +147 -147
  32. package/lib/web-tools.js +158 -158
  33. package/package.json +49 -47
  34. package/skills/SOURCE.md +58 -58
  35. package/skills/accessibility/SKILL.md +147 -147
  36. package/skills/agent-architecture-audit/SKILL.md +257 -257
  37. package/skills/agent-eval/SKILL.md +147 -147
  38. package/skills/agent-harness-construction/SKILL.md +74 -74
  39. package/skills/agent-introspection-debugging/SKILL.md +154 -154
  40. package/skills/agent-payment-x402/SKILL.md +225 -225
  41. package/skills/agent-self-evaluation/SKILL.md +182 -182
  42. package/skills/agent-self-evaluation/references/evaluation-criteria.md +71 -71
  43. package/skills/agent-self-evaluation/references/hook-integration.md +64 -64
  44. package/skills/agent-sort/SKILL.md +216 -216
  45. package/skills/agentic-engineering/SKILL.md +64 -64
  46. package/skills/agentic-os/SKILL.md +388 -388
  47. package/skills/ai-first-engineering/SKILL.md +52 -52
  48. package/skills/ai-regression-testing/SKILL.md +386 -386
  49. package/skills/android-clean-architecture/SKILL.md +340 -340
  50. package/skills/angular-developer/SKILL.md +155 -155
  51. package/skills/angular-developer/references/angular-animations.md +160 -160
  52. package/skills/angular-developer/references/angular-aria.md +410 -410
  53. package/skills/angular-developer/references/cli.md +86 -86
  54. package/skills/angular-developer/references/component-harnesses.md +59 -59
  55. package/skills/angular-developer/references/component-styling.md +91 -91
  56. package/skills/angular-developer/references/components.md +117 -117
  57. package/skills/angular-developer/references/creating-services.md +97 -97
  58. package/skills/angular-developer/references/data-resolvers.md +69 -69
  59. package/skills/angular-developer/references/define-routes.md +67 -67
  60. package/skills/angular-developer/references/defining-providers.md +72 -72
  61. package/skills/angular-developer/references/di-fundamentals.md +120 -120
  62. package/skills/angular-developer/references/e2e-testing.md +56 -56
  63. package/skills/angular-developer/references/effects.md +83 -83
  64. package/skills/angular-developer/references/hierarchical-injectors.md +43 -43
  65. package/skills/angular-developer/references/host-elements.md +80 -80
  66. package/skills/angular-developer/references/injection-context.md +63 -63
  67. package/skills/angular-developer/references/inputs.md +101 -101
  68. package/skills/angular-developer/references/linked-signal.md +59 -59
  69. package/skills/angular-developer/references/loading-strategies.md +61 -61
  70. package/skills/angular-developer/references/mcp.md +108 -108
  71. package/skills/angular-developer/references/navigate-to-routes.md +69 -69
  72. package/skills/angular-developer/references/outputs.md +86 -86
  73. package/skills/angular-developer/references/reactive-forms.md +122 -122
  74. package/skills/angular-developer/references/rendering-strategies.md +44 -44
  75. package/skills/angular-developer/references/resource.md +77 -77
  76. package/skills/angular-developer/references/route-animations.md +56 -56
  77. package/skills/angular-developer/references/route-guards.md +52 -52
  78. package/skills/angular-developer/references/router-lifecycle.md +45 -45
  79. package/skills/angular-developer/references/router-testing.md +87 -87
  80. package/skills/angular-developer/references/show-routes-with-outlets.md +68 -68
  81. package/skills/angular-developer/references/signal-forms.md +795 -795
  82. package/skills/angular-developer/references/signals-overview.md +94 -94
  83. package/skills/angular-developer/references/tailwind-css.md +69 -69
  84. package/skills/angular-developer/references/template-driven-forms.md +114 -114
  85. package/skills/angular-developer/references/testing-fundamentals.md +65 -65
  86. package/skills/api-connector-builder/SKILL.md +121 -121
  87. package/skills/api-design/SKILL.md +524 -524
  88. package/skills/architecture-decision-records/SKILL.md +180 -180
  89. package/skills/article-writing/SKILL.md +80 -80
  90. package/skills/automation-audit-ops/SKILL.md +143 -143
  91. package/skills/autonomous-agent-harness/SKILL.md +274 -274
  92. package/skills/autonomous-loops/SKILL.md +611 -611
  93. package/skills/backend-patterns/SKILL.md +562 -562
  94. package/skills/benchmark/SKILL.md +95 -95
  95. package/skills/benchmark-methodology/SKILL.md +191 -191
  96. package/skills/benchmark-optimization-loop/SKILL.md +71 -71
  97. package/skills/blender-motion-state-inspection/SKILL.md +165 -165
  98. package/skills/blueprint/SKILL.md +106 -106
  99. package/skills/brand-discovery/SKILL.md +145 -145
  100. package/skills/brand-discovery/references/10_purpose-why.md +40 -40
  101. package/skills/brand-discovery/references/20_positioning.md +44 -44
  102. package/skills/brand-discovery/references/30_audience-niche.md +52 -52
  103. package/skills/brand-discovery/references/40_personality-archetype.md +57 -57
  104. package/skills/brand-discovery/references/50_voice-tone.md +59 -59
  105. package/skills/brand-discovery/references/60_narrative-story.md +50 -50
  106. package/skills/brand-discovery/references/70_founder-tension.md +49 -49
  107. package/skills/brand-discovery/references/90_SYNTHESIS.md +133 -133
  108. package/skills/brand-voice/SKILL.md +98 -98
  109. package/skills/brand-voice/references/voice-profile-schema.md +55 -55
  110. package/skills/browser-qa/SKILL.md +105 -105
  111. package/skills/bun-runtime/SKILL.md +85 -85
  112. package/skills/canary-watch/SKILL.md +108 -108
  113. package/skills/carrier-relationship-management/SKILL.md +212 -212
  114. package/skills/cisco-ios-patterns/SKILL.md +164 -164
  115. package/skills/ck/SKILL.md +148 -148
  116. package/skills/claude-devfleet/SKILL.md +112 -112
  117. package/skills/click-path-audit/SKILL.md +245 -245
  118. package/skills/clickhouse-io/SKILL.md +445 -445
  119. package/skills/code-tour/SKILL.md +254 -254
  120. package/skills/codebase-onboarding/SKILL.md +234 -234
  121. package/skills/codehealth-mcp/SKILL.md +167 -167
  122. package/skills/coding-standards/SKILL.md +551 -551
  123. package/skills/competitive-platform-analysis/SKILL.md +214 -214
  124. package/skills/competitive-report-structure/SKILL.md +162 -162
  125. package/skills/compose-multiplatform-patterns/SKILL.md +300 -300
  126. package/skills/config-gc/SKILL.md +120 -120
  127. package/skills/configure-ecc/SKILL.md +385 -385
  128. package/skills/connections-optimizer/SKILL.md +190 -190
  129. package/skills/content-engine/SKILL.md +132 -132
  130. package/skills/content-hash-cache-pattern/SKILL.md +162 -162
  131. package/skills/context-budget/SKILL.md +136 -136
  132. package/skills/continuous-agent-loop/SKILL.md +46 -46
  133. package/skills/continuous-learning/SKILL.md +132 -132
  134. package/skills/continuous-learning-v2/SKILL.md +361 -361
  135. package/skills/contract-first/SKILL.md +287 -287
  136. package/skills/cost-aware-llm-pipeline/SKILL.md +184 -184
  137. package/skills/cost-tracking/SKILL.md +97 -97
  138. package/skills/council/SKILL.md +204 -204
  139. package/skills/cpp-coding-standards/SKILL.md +724 -724
  140. package/skills/cpp-testing/SKILL.md +325 -325
  141. package/skills/crosspost/SKILL.md +112 -112
  142. package/skills/csharp-testing/SKILL.md +322 -322
  143. package/skills/customer-billing-ops/SKILL.md +141 -141
  144. package/skills/customs-trade-compliance/SKILL.md +263 -263
  145. package/skills/dart-flutter-patterns/SKILL.md +564 -564
  146. package/skills/dashboard-builder/SKILL.md +109 -109
  147. package/skills/data-scraper-agent/SKILL.md +765 -765
  148. package/skills/data-throughput-accelerator/SKILL.md +74 -74
  149. package/skills/database-migrations/SKILL.md +430 -430
  150. package/skills/deep-research/SKILL.md +160 -160
  151. package/skills/defi-amm-security/SKILL.md +167 -167
  152. package/skills/delivery-gate/SKILL.md +126 -126
  153. package/skills/deployment-patterns/SKILL.md +428 -428
  154. package/skills/design-system/SKILL.md +83 -83
  155. package/skills/django-celery/SKILL.md +458 -458
  156. package/skills/django-patterns/SKILL.md +735 -735
  157. package/skills/django-security/SKILL.md +644 -644
  158. package/skills/django-tdd/SKILL.md +730 -730
  159. package/skills/django-verification/SKILL.md +470 -470
  160. package/skills/dmux-workflows/SKILL.md +192 -192
  161. package/skills/docker-patterns/SKILL.md +365 -365
  162. package/skills/documentation-lookup/SKILL.md +91 -91
  163. package/skills/dotnet-patterns/SKILL.md +322 -322
  164. package/skills/dynamic-workflow-mode/SKILL.md +124 -124
  165. package/skills/e2e-testing/SKILL.md +327 -327
  166. package/skills/ecc-guide/SKILL.md +190 -190
  167. package/skills/ecc-recipes/SKILL.md +149 -149
  168. package/skills/ecc-tools-cost-audit/SKILL.md +161 -161
  169. package/skills/email-ops/SKILL.md +122 -122
  170. package/skills/energy-procurement/SKILL.md +228 -228
  171. package/skills/enterprise-agent-ops/SKILL.md +51 -51
  172. package/skills/error-handling/SKILL.md +377 -377
  173. package/skills/eval-harness/SKILL.md +271 -271
  174. package/skills/evm-token-decimals/SKILL.md +131 -131
  175. package/skills/exa-search/SKILL.md +108 -108
  176. package/skills/fal-ai-media/SKILL.md +289 -289
  177. package/skills/fastapi-patterns/SKILL.md +514 -514
  178. package/skills/finance-billing-ops/SKILL.md +128 -128
  179. package/skills/flox-environments/SKILL.md +497 -497
  180. package/skills/flutter-dart-code-review/SKILL.md +436 -436
  181. package/skills/foundation-models-on-device/SKILL.md +243 -243
  182. package/skills/frontend-a11y/SKILL.md +446 -446
  183. package/skills/frontend-design-direction/SKILL.md +93 -93
  184. package/skills/frontend-patterns/SKILL.md +657 -657
  185. package/skills/frontend-slides/SKILL.md +185 -185
  186. package/skills/fsharp-testing/SKILL.md +281 -281
  187. package/skills/gan-style-harness/SKILL.md +279 -279
  188. package/skills/gateguard/SKILL.md +133 -133
  189. package/skills/generating-python-installer/SKILL.md +820 -820
  190. package/skills/git-workflow/SKILL.md +716 -716
  191. package/skills/github-ops/SKILL.md +145 -145
  192. package/skills/golang-patterns/SKILL.md +676 -676
  193. package/skills/golang-testing/SKILL.md +721 -721
  194. package/skills/google-workspace-ops/SKILL.md +96 -96
  195. package/skills/growth-log/SKILL.md +128 -128
  196. package/skills/healthcare-cdss-patterns/SKILL.md +246 -246
  197. package/skills/healthcare-emr-patterns/SKILL.md +160 -160
  198. package/skills/healthcare-eval-harness/SKILL.md +208 -208
  199. package/skills/healthcare-phi-compliance/SKILL.md +146 -146
  200. package/skills/hermes-imports/SKILL.md +89 -89
  201. package/skills/hexagonal-architecture/SKILL.md +277 -277
  202. package/skills/hipaa-compliance/SKILL.md +79 -79
  203. package/skills/homelab-network-readiness/SKILL.md +170 -170
  204. package/skills/homelab-network-setup/SKILL.md +130 -130
  205. package/skills/homelab-pihole-dns/SKILL.md +275 -275
  206. package/skills/homelab-vlan-segmentation/SKILL.md +312 -312
  207. package/skills/homelab-wireguard-vpn/SKILL.md +306 -306
  208. package/skills/hookify-rules/SKILL.md +128 -128
  209. package/skills/inherit-legacy-style/SKILL.md +157 -157
  210. package/skills/intent-driven-development/SKILL.md +360 -360
  211. package/skills/inventory-demand-planning/SKILL.md +247 -247
  212. package/skills/investor-materials/SKILL.md +97 -97
  213. package/skills/investor-outreach/SKILL.md +92 -92
  214. package/skills/ios-icon-gen/SKILL.md +158 -158
  215. package/skills/iterative-retrieval/SKILL.md +212 -212
  216. package/skills/ito-basket-compare/SKILL.md +64 -64
  217. package/skills/ito-compute/SKILL.md +129 -129
  218. package/skills/ito-data-atlas-agent/SKILL.md +64 -64
  219. package/skills/ito-market-intelligence/SKILL.md +61 -61
  220. package/skills/ito-trade-planner/SKILL.md +68 -68
  221. package/skills/java-coding-standards/SKILL.md +384 -384
  222. package/skills/jira-integration/SKILL.md +303 -303
  223. package/skills/jpa-patterns/SKILL.md +152 -152
  224. package/skills/knowledge-ops/SKILL.md +155 -155
  225. package/skills/kotlin-coroutines-flows/SKILL.md +285 -285
  226. package/skills/kotlin-exposed-patterns/SKILL.md +720 -720
  227. package/skills/kotlin-ktor-patterns/SKILL.md +690 -690
  228. package/skills/kotlin-patterns/SKILL.md +712 -712
  229. package/skills/kotlin-testing/SKILL.md +825 -825
  230. package/skills/kubernetes-patterns/SKILL.md +756 -756
  231. package/skills/laravel-patterns/SKILL.md +416 -416
  232. package/skills/laravel-plugin-discovery/SKILL.md +230 -230
  233. package/skills/laravel-security/SKILL.md +948 -948
  234. package/skills/laravel-tdd/SKILL.md +675 -675
  235. package/skills/laravel-verification/SKILL.md +180 -180
  236. package/skills/latency-critical-systems/SKILL.md +75 -75
  237. package/skills/lead-intelligence/SKILL.md +322 -322
  238. package/skills/liquid-glass-design/SKILL.md +279 -279
  239. package/skills/llm-trading-agent-security/SKILL.md +147 -147
  240. package/skills/logistics-exception-management/SKILL.md +222 -222
  241. package/skills/loop-design-check/SKILL.md +143 -143
  242. package/skills/mailtrap-email-integration/SKILL.md +77 -77
  243. package/skills/make-interfaces-feel-better/SKILL.md +152 -152
  244. package/skills/manim-video/SKILL.md +90 -90
  245. package/skills/market-research/SKILL.md +76 -76
  246. package/skills/marketing-campaign/SKILL.md +114 -114
  247. package/skills/mcp-server-patterns/SKILL.md +70 -70
  248. package/skills/messages-ops/SKILL.md +105 -105
  249. package/skills/ml-adoption-playbook/SKILL.md +57 -57
  250. package/skills/mle-workflow/SKILL.md +348 -348
  251. package/skills/motion-advanced/SKILL.md +596 -596
  252. package/skills/motion-foundations/SKILL.md +299 -299
  253. package/skills/motion-patterns/SKILL.md +434 -434
  254. package/skills/motion-ui/SKILL.md +576 -576
  255. package/skills/mysql-patterns/SKILL.md +413 -413
  256. package/skills/nanoclaw-repl/SKILL.md +34 -34
  257. package/skills/nestjs-patterns/SKILL.md +231 -231
  258. package/skills/netmiko-ssh-automation/SKILL.md +174 -174
  259. package/skills/network-bgp-diagnostics/SKILL.md +168 -168
  260. package/skills/network-config-validation/SKILL.md +211 -211
  261. package/skills/network-interface-health/SKILL.md +153 -153
  262. package/skills/nextjs-turbopack/SKILL.md +58 -58
  263. package/skills/nodejs-keccak256/SKILL.md +103 -103
  264. package/skills/nutrient-document-processing/SKILL.md +168 -168
  265. package/skills/nuxt4-patterns/SKILL.md +101 -101
  266. package/skills/openclaw-persona-forge/SKILL.md +289 -289
  267. package/skills/openclaw-persona-forge/references/avatar-style.md +124 -124
  268. package/skills/openclaw-persona-forge/references/boundary-rules.md +53 -53
  269. package/skills/openclaw-persona-forge/references/error-handling.md +53 -53
  270. package/skills/openclaw-persona-forge/references/identity-tension.md +48 -48
  271. package/skills/openclaw-persona-forge/references/naming-system.md +39 -39
  272. package/skills/openclaw-persona-forge/references/output-template.md +166 -166
  273. package/skills/opensource-pipeline/SKILL.md +256 -256
  274. package/skills/orch-add-feature/SKILL.md +45 -45
  275. package/skills/orch-build-mvp/SKILL.md +49 -49
  276. package/skills/orch-change-feature/SKILL.md +43 -43
  277. package/skills/orch-fix-defect/SKILL.md +43 -43
  278. package/skills/orch-pipeline/SKILL.md +121 -121
  279. package/skills/orch-refine-code/SKILL.md +44 -44
  280. package/skills/parallel-execution-optimizer/SKILL.md +74 -74
  281. package/skills/perl-patterns/SKILL.md +505 -505
  282. package/skills/perl-security/SKILL.md +504 -504
  283. package/skills/perl-testing/SKILL.md +476 -476
  284. package/skills/plan-canvas/SKILL.md +153 -153
  285. package/skills/plan-orchestrate/SKILL.md +263 -263
  286. package/skills/plankton-code-quality/SKILL.md +237 -237
  287. package/skills/postgres-patterns/SKILL.md +148 -148
  288. package/skills/prediction-market-oracle-research/SKILL.md +64 -64
  289. package/skills/prediction-market-risk-review/SKILL.md +61 -61
  290. package/skills/premium-web-design/SKILL.md +154 -154
  291. package/skills/prisma-patterns/SKILL.md +401 -401
  292. package/skills/product-capability/SKILL.md +142 -142
  293. package/skills/product-lens/SKILL.md +93 -93
  294. package/skills/production-audit/SKILL.md +207 -207
  295. package/skills/production-scheduling/SKILL.md +238 -238
  296. package/skills/project-flow-ops/SKILL.md +112 -112
  297. package/skills/prompt-optimizer/SKILL.md +398 -398
  298. package/skills/python-patterns/SKILL.md +751 -751
  299. package/skills/python-testing/SKILL.md +817 -817
  300. package/skills/pytorch-patterns/SKILL.md +397 -397
  301. package/skills/quality-nonconformance/SKILL.md +260 -260
  302. package/skills/quarkus-patterns/SKILL.md +723 -723
  303. package/skills/quarkus-security/SKILL.md +468 -468
  304. package/skills/quarkus-tdd/SKILL.md +812 -812
  305. package/skills/quarkus-verification/SKILL.md +480 -480
  306. package/skills/ralphinho-rfc-pipeline/SKILL.md +68 -68
  307. package/skills/react-native-patterns/SKILL.md +326 -326
  308. package/skills/react-patterns/SKILL.md +342 -342
  309. package/skills/react-performance/SKILL.md +575 -575
  310. package/skills/react-testing/SKILL.md +424 -424
  311. package/skills/recsys-pipeline-architect/SKILL.md +115 -115
  312. package/skills/recursive-decision-ledger/SKILL.md +81 -81
  313. package/skills/redis-patterns/SKILL.md +404 -404
  314. package/skills/regex-vs-llm-structured-text/SKILL.md +221 -221
  315. package/skills/remotion-video-creation/SKILL.md +43 -43
  316. package/skills/repo-scan/SKILL.md +79 -79
  317. package/skills/research-ops/SKILL.md +113 -113
  318. package/skills/returns-reverse-logistics/SKILL.md +240 -240
  319. package/skills/rules-distill/SKILL.md +265 -265
  320. package/skills/rust-patterns/SKILL.md +500 -500
  321. package/skills/rust-testing/SKILL.md +501 -501
  322. package/skills/safety-guard/SKILL.md +76 -76
  323. package/skills/santa-method/SKILL.md +307 -307
  324. package/skills/scientific-db-pubmed-database/SKILL.md +176 -176
  325. package/skills/scientific-db-uspto-database/SKILL.md +178 -178
  326. package/skills/scientific-pkg-gget/SKILL.md +167 -167
  327. package/skills/scientific-thinking-literature-review/SKILL.md +193 -193
  328. package/skills/scientific-thinking-scholar-evaluation/SKILL.md +161 -161
  329. package/skills/search-first/SKILL.md +183 -183
  330. package/skills/security-bounty-hunter/SKILL.md +100 -100
  331. package/skills/security-review/SKILL.md +504 -504
  332. package/skills/security-scan/SKILL.md +166 -166
  333. package/skills/seo/SKILL.md +155 -155
  334. package/skills/skill-comply/SKILL.md +59 -59
  335. package/skills/skill-scout/SKILL.md +141 -141
  336. package/skills/skill-stocktake/SKILL.md +195 -195
  337. package/skills/social-graph-ranker/SKILL.md +155 -155
  338. package/skills/social-publisher/SKILL.md +130 -130
  339. package/skills/springboot-patterns/SKILL.md +315 -315
  340. package/skills/springboot-security/SKILL.md +273 -273
  341. package/skills/springboot-tdd/SKILL.md +159 -159
  342. package/skills/springboot-verification/SKILL.md +232 -232
  343. package/skills/strategic-compact/SKILL.md +142 -142
  344. package/skills/swift-actor-persistence/SKILL.md +144 -144
  345. package/skills/swift-concurrency-6-2/SKILL.md +216 -216
  346. package/skills/swift-protocol-di-testing/SKILL.md +191 -191
  347. package/skills/swiftui-patterns/SKILL.md +259 -259
  348. package/skills/taste/SKILL.md +264 -264
  349. package/skills/taste/references/genre-taxonomy.md +87 -87
  350. package/skills/tdd-workflow/SKILL.md +583 -583
  351. package/skills/team-agent-orchestration/SKILL.md +111 -111
  352. package/skills/team-builder/SKILL.md +169 -169
  353. package/skills/terminal-ops/SKILL.md +110 -110
  354. package/skills/tinystruct-patterns/SKILL.md +279 -279
  355. package/skills/tinystruct-patterns/references/architecture.md +90 -90
  356. package/skills/tinystruct-patterns/references/data-handling.md +60 -60
  357. package/skills/tinystruct-patterns/references/database.md +99 -99
  358. package/skills/tinystruct-patterns/references/routing.md +64 -64
  359. package/skills/tinystruct-patterns/references/system-usage.md +97 -97
  360. package/skills/tinystruct-patterns/references/testing.md +72 -72
  361. package/skills/token-budget-advisor/SKILL.md +134 -134
  362. package/skills/ui-demo/SKILL.md +466 -466
  363. package/skills/ui-to-vue/SKILL.md +135 -135
  364. package/skills/uncloud/SKILL.md +344 -344
  365. package/skills/unified-memory/SKILL.md +170 -170
  366. package/skills/unified-notifications-ops/SKILL.md +188 -188
  367. package/skills/verification-loop/SKILL.md +129 -129
  368. package/skills/video-editing/SKILL.md +311 -311
  369. package/skills/videodb/SKILL.md +375 -375
  370. package/skills/visa-doc-translate/SKILL.md +117 -117
  371. package/skills/vite-patterns/SKILL.md +450 -450
  372. package/skills/vue-patterns/SKILL.md +471 -471
  373. package/skills/windows-desktop-e2e/SKILL.md +888 -888
  374. package/skills/workspace-surface-audit/SKILL.md +126 -126
  375. package/skills/x-api/SKILL.md +235 -235
@@ -1,888 +1,888 @@
1
- ---
2
- name: windows-desktop-e2e
3
- description: E2E testing for Windows native desktop apps (WPF, WinForms, Win32/MFC, Qt) using pywinauto and Windows UI Automation.
4
- metadata:
5
- origin: ECC
6
- ---
7
-
8
- # Windows Desktop E2E Testing
9
-
10
- End-to-end testing for Windows native desktop applications using **pywinauto** backed by Windows UI Automation (UIA). Covers WPF, WinForms, Win32/MFC, and Qt (5.x / 6.x) — with Qt-specific guidance as a dedicated section.
11
-
12
- ## When to Activate
13
-
14
- - Writing or running E2E tests for a Windows native desktop application
15
- - Setting up a desktop GUI test suite from scratch
16
- - Diagnosing flaky or failing desktop automation tests
17
- - Adding testability (AutomationId, accessible names) to an existing app
18
- - Integrating desktop E2E into a CI/CD pipeline (GitHub Actions `windows-latest`)
19
-
20
- ### When NOT to Use
21
-
22
- - Web applications → use `e2e-testing` skill (Playwright)
23
- - Electron / CEF / WebView2 apps → the HTML layer needs browser automation, not UIA
24
- - Mobile apps → use platform-specific tools (UIAutomator, XCUITest)
25
- - Pure unit or integration tests that don't need a running GUI
26
-
27
- ## Core Concepts
28
-
29
- All Windows desktop automation relies on **UI Automation (UIA)**, a Windows-built-in accessibility API. Every supported framework exposes a tree of UIA elements with properties Claude can read and act on:
30
-
31
- ```
32
- Your test (Python)
33
- └── pywinauto (UIA backend)
34
- └── Windows UI Automation API ← built into Windows, framework-agnostic
35
- └── App's UIA provider ← each framework ships its own
36
- └── Running .exe
37
- ```
38
-
39
- **UIA quality by framework:**
40
-
41
- | Framework | AutomationId | Reliability | Notes |
42
- |-----------|-------------|-------------|-------|
43
- | WPF | 5/5 | Excellent | `x:Name` maps directly to AutomationId |
44
- | WinForms | 4/5 | Good | `AccessibleName` = AutomationId |
45
- | UWP / WinUI 3 | 5/5 | Excellent | Full Microsoft support |
46
- | Qt 6.x | 5/5 | Excellent | Accessibility enabled by default; class names change to `Qt6*` |
47
- | Qt 5.15+ | 4/5 | Good | Improved Accessibility module |
48
- | Qt 5.7–5.14 | 3/5 | Fair | Needs `QT_ACCESSIBILITY=1`; objectName manual |
49
- | Win32 / MFC | 3/5 | Fair | Control IDs accessible; text matching common |
50
-
51
- ## Setup & Prerequisites
52
-
53
- ```bash
54
- # Python 3.8+, Windows only
55
- pip install pywinauto pytest pytest-html Pillow pytest-timeout
56
- # Optional: screen recording
57
- # Install ffmpeg and add to PATH: https://ffmpeg.org/download.html
58
- ```
59
-
60
- Verify UIA is reachable:
61
-
62
- ```python
63
- from pywinauto import Desktop
64
- Desktop(backend="uia").windows() # lists all top-level windows
65
- ```
66
-
67
- Install **Accessibility Insights for Windows** (free, from Microsoft) — your DevTools equivalent for inspecting the UIA element tree before writing any test.
68
-
69
- ## Testability Setup (by Framework)
70
-
71
- The single most impactful thing you can do is **give every interactive control a stable AutomationId** before writing tests.
72
-
73
- ### WPF
74
-
75
- ```xml
76
- <!-- XAML: x:Name becomes AutomationId automatically -->
77
- <TextBox x:Name="usernameInput" />
78
- <PasswordBox x:Name="passwordInput" />
79
- <Button x:Name="btnLogin" Content="Login" />
80
- <TextBlock x:Name="lblError" />
81
- ```
82
-
83
- ### WinForms
84
-
85
- ```csharp
86
- // Set in designer or code
87
- usernameInput.AccessibleName = "usernameInput";
88
- passwordInput.AccessibleName = "passwordInput";
89
- btnLogin.AccessibleName = "btnLogin";
90
- lblError.AccessibleName = "lblError";
91
- ```
92
-
93
- ### Win32 / MFC
94
-
95
- ```cpp
96
- // Control resource IDs in .rc file are exposed as AutomationId strings
97
- // IDC_EDIT_USERNAME -> AutomationId "1001"
98
- // Prefer SetWindowText for Name; add IAccessible for richer support
99
- ```
100
-
101
- ### Qt — see dedicated section below
102
-
103
- ---
104
-
105
- ## Page Object Model
106
-
107
- ```
108
- tests/
109
- ├── conftest.py # app launch fixture, failure screenshot
110
- ├── pytest.ini
111
- ├── config.py
112
- ├── pages/
113
- │ ├── __init__.py # required for imports
114
- │ ├── base_page.py # locators, wait, screenshot helpers
115
- │ ├── login_page.py
116
- │ └── main_page.py
117
- ├── tests/
118
- │ ├── __init__.py
119
- │ ├── test_login.py
120
- │ └── test_main_flow.py
121
- └── artifacts/ # screenshots, videos, logs
122
- ```
123
-
124
- ### base_page.py
125
-
126
- ```python
127
- import os, time
128
- from pywinauto import Desktop
129
- from config import ACTION_TIMEOUT, ARTIFACT_DIR
130
-
131
- class BasePage:
132
- def __init__(self, window):
133
- self.window = window
134
-
135
- # --- Locators (priority order) ---
136
-
137
- def by_id(self, auto_id, **kw):
138
- """AutomationId — most stable. Use as first choice."""
139
- return self.window.child_window(auto_id=auto_id, **kw)
140
-
141
- def by_name(self, name, **kw):
142
- """Visible text / accessible name."""
143
- return self.window.child_window(title=name, **kw)
144
-
145
- def by_class(self, cls, index=0, **kw):
146
- """Control class + index — fragile, avoid if possible."""
147
- return self.window.child_window(class_name=cls, found_index=index, **kw)
148
-
149
- # --- Waits ---
150
-
151
- def wait_visible(self, spec, timeout=ACTION_TIMEOUT):
152
- spec.wait("visible", timeout=timeout)
153
- return spec
154
-
155
- def wait_gone(self, spec, timeout=ACTION_TIMEOUT):
156
- spec.wait_not("visible", timeout=timeout)
157
- return spec
158
-
159
- def wait_window(self, title, timeout=ACTION_TIMEOUT):
160
- """Wait for a new top-level window (dialogs, child windows)."""
161
- dlg = Desktop(backend="uia").window(title=title)
162
- dlg.wait("visible", timeout=timeout)
163
- return dlg
164
-
165
- def wait_until(self, fn, timeout=ACTION_TIMEOUT, interval=0.3):
166
- """Poll an arbitrary condition — use when UIA events are unreliable."""
167
- deadline = time.time() + timeout
168
- while time.time() < deadline:
169
- try:
170
- if fn():
171
- return True
172
- except Exception:
173
- pass
174
- time.sleep(interval)
175
- raise TimeoutError(f"Condition not met within {timeout}s")
176
-
177
- # --- Actions ---
178
-
179
- def click(self, spec):
180
- self.wait_visible(spec)
181
- spec.click_input()
182
-
183
- def type_text(self, spec, text):
184
- self.wait_visible(spec)
185
- ctrl = spec.wrapper_object()
186
- try:
187
- ctrl.set_edit_text(text)
188
- except Exception as e:
189
- # Qt 5.x fallback: UIA Value Pattern may be incomplete
190
- import sys, pywinauto.keyboard as kb
191
- print(f"[windows-desktop-e2e] set_edit_text failed ({e}), using keyboard fallback", file=sys.stderr)
192
- ctrl.click_input()
193
- kb.send_keys("^a")
194
- kb.send_keys(text, with_spaces=True)
195
-
196
- def get_text(self, spec):
197
- ctrl = spec.wrapper_object()
198
- for attr in ("window_text", "get_value"):
199
- try:
200
- v = getattr(ctrl, attr)()
201
- if v:
202
- return v
203
- except Exception:
204
- pass
205
- return ""
206
-
207
- # --- Artifacts ---
208
-
209
- def screenshot(self, name):
210
- os.makedirs(ARTIFACT_DIR, exist_ok=True)
211
- path = os.path.join(ARTIFACT_DIR, f"{name}.png")
212
- self.window.capture_as_image().save(path)
213
- return path
214
- ```
215
-
216
- ### login_page.py
217
-
218
- ```python
219
- from pages.base_page import BasePage
220
-
221
- class LoginPage(BasePage):
222
- @property
223
- def username(self): return self.by_id("usernameInput")
224
-
225
- @property
226
- def password(self): return self.by_id("passwordInput")
227
-
228
- @property
229
- def btn_login(self): return self.by_id("btnLogin")
230
-
231
- @property
232
- def error_label(self): return self.by_id("lblError")
233
-
234
- def login(self, user, pwd):
235
- self.type_text(self.username, user)
236
- self.type_text(self.password, pwd)
237
- self.click(self.btn_login)
238
-
239
- def login_ok(self, user, pwd, main_title="Main Window"):
240
- self.login(user, pwd)
241
- return self.wait_window(main_title)
242
-
243
- def login_fail(self, user, pwd):
244
- self.login(user, pwd)
245
- self.wait_visible(self.error_label)
246
- return self.get_text(self.error_label)
247
- ```
248
-
249
- ### conftest.py
250
-
251
- > For new projects prefer the **Tier 1 sandbox fixture** (see below) — it adds filesystem isolation at zero extra cost. This basic fixture is for minimal/legacy setups only.
252
-
253
- ```python
254
- import os, pytest
255
- os.environ["QT_ACCESSIBILITY"] = "1" # Required for Qt 5.x UIA support
256
-
257
- from pywinauto import Application
258
- from config import APP_PATH, MAIN_WINDOW_TITLE, LAUNCH_TIMEOUT, ARTIFACT_DIR
259
-
260
- @pytest.fixture
261
- def app(request):
262
- if not APP_PATH:
263
- pytest.exit("APP_PATH environment variable is not set", returncode=1)
264
- proc = Application(backend="uia").start(APP_PATH, timeout=LAUNCH_TIMEOUT)
265
- win = proc.window(title=MAIN_WINDOW_TITLE)
266
- win.wait("visible", timeout=LAUNCH_TIMEOUT)
267
- yield win
268
- # Screenshot on failure
269
- if getattr(getattr(request.node, "rep_call", None), "failed", False):
270
- os.makedirs(ARTIFACT_DIR, exist_ok=True)
271
- try:
272
- win.capture_as_image().save(
273
- os.path.join(ARTIFACT_DIR, f"FAIL_{request.node.name}.png")
274
- )
275
- except Exception:
276
- pass
277
- # Graceful exit first, force-kill as fallback
278
- # proc is a pywinauto Application — use wait_for_process_exit(), not wait_for_process()
279
- try:
280
- win.close()
281
- proc.wait_for_process_exit(timeout=5)
282
- except Exception:
283
- proc.kill()
284
-
285
- @pytest.hookimpl(tryfirst=True, hookwrapper=True)
286
- def pytest_runtest_makereport(item, call):
287
- outcome = yield
288
- setattr(item, f"rep_{outcome.get_result().when}", outcome.get_result())
289
- ```
290
-
291
- ### config.py
292
-
293
- ```python
294
- import os
295
- APP_PATH = os.environ.get("APP_PATH", "") # set via env — no default path
296
- MAIN_WINDOW_TITLE = os.environ.get("APP_TITLE", "")
297
- LAUNCH_TIMEOUT = int(os.environ.get("LAUNCH_TIMEOUT", "15"))
298
- ACTION_TIMEOUT = int(os.environ.get("ACTION_TIMEOUT", "10"))
299
- ARTIFACT_DIR = os.path.join(os.path.dirname(__file__), "artifacts")
300
- ```
301
-
302
- ### pytest.ini
303
-
304
- ```ini
305
- [pytest]
306
- testpaths = tests
307
- markers =
308
- smoke: fast smoke tests for critical paths
309
- flaky: known-unstable tests
310
- addopts = -v --tb=short --html=artifacts/report.html --self-contained-html
311
- ```
312
-
313
- ## Locator Strategy
314
-
315
- ```
316
- AutomationId > Name (text) > ClassName + index > XPath
317
- (stable) (readable) (fragile) (last resort)
318
- ```
319
-
320
- Inspect with Accessibility Insights → **Properties** pane → look for `AutomationId` first.
321
-
322
- ```python
323
- # Inspect at runtime — paste into a REPL to explore the tree
324
- win.print_control_identifiers()
325
- # or narrow scope:
326
- win.child_window(auto_id="groupBox1").print_control_identifiers()
327
- ```
328
-
329
- ## Wait Patterns
330
-
331
- ```python
332
- # Wait for control to appear
333
- page.wait_visible(page.by_id("statusLabel"))
334
-
335
- # Wait for control to disappear (e.g. loading spinner)
336
- page.wait_gone(page.by_id("spinnerOverlay"))
337
-
338
- # Wait for a dialog to pop up
339
- dlg = page.wait_window("Confirm Delete")
340
-
341
- # Custom condition (e.g. text changes)
342
- page.wait_until(lambda: page.get_text(page.by_id("lblStatus")) == "Ready")
343
- ```
344
-
345
- **Never use `time.sleep()` as primary synchronization** — use `wait()` or `wait_until()`.
346
-
347
- ## Artifact Management
348
-
349
- ```python
350
- # Screenshot on demand
351
- page.screenshot("after_login")
352
-
353
- # Full-screen capture (when window is off-screen or minimised)
354
- import pyautogui
355
- pyautogui.screenshot("artifacts/fullscreen.png")
356
-
357
- # Screen recording with ffmpeg (start before test, stop after)
358
- import subprocess
359
-
360
- def start_recording(name):
361
- return subprocess.Popen([
362
- "ffmpeg", "-f", "gdigrab", "-framerate", "10",
363
- "-i", "desktop", "-y", f"artifacts/videos/{name}.mp4"
364
- ], stdin=subprocess.PIPE, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
365
-
366
- def stop_recording(proc):
367
- proc.stdin.write(b"q"); proc.stdin.flush(); proc.wait(timeout=10)
368
- ```
369
-
370
- ## Per-Step Trace (opt-in)
371
-
372
- The default failure screenshot is often too thin for diagnosing flaky tests. The step-level trace below is **off by default** — enable it only when reproducing a flaky case.
373
-
374
- ### Enable
375
-
376
- ```bash
377
- E2E_TRACE=1 pytest tests/test_login.py -v
378
- # Include typed text in the JSONL log (DO NOT use on tests that type credentials/PII):
379
- E2E_TRACE=1 E2E_TRACE_INCLUDE_TEXT=1 pytest ...
380
- ```
381
-
382
- ### Patch into BasePage
383
-
384
- ```python
385
- import os, json, time
386
- TRACE_ENABLED = os.environ.get("E2E_TRACE") == "1"
387
- TRACE_INCLUDE_TEXT = os.environ.get("E2E_TRACE_INCLUDE_TEXT") == "1"
388
-
389
- class BasePage:
390
- _step = 0
391
-
392
- def _trace(self, action, spec=None, text=None):
393
- if not TRACE_ENABLED:
394
- return
395
- BasePage._step += 1
396
- idx = f"{BasePage._step:03d}"
397
- os.makedirs(ARTIFACT_DIR, exist_ok=True)
398
- try:
399
- self.window.capture_as_image().save(
400
- os.path.join(ARTIFACT_DIR, f"step_{idx}_{action}.png"))
401
- except Exception:
402
- pass # capture failure must not break the test
403
- rec = {
404
- "ts": time.time(), "step": BasePage._step, "action": action,
405
- "locator": getattr(spec, "criteria", None),
406
- "text": text if TRACE_INCLUDE_TEXT else ("<redacted>" if text else None),
407
- }
408
- with open(os.path.join(ARTIFACT_DIR, "trace.jsonl"), "a") as f:
409
- f.write(json.dumps(rec) + "\n")
410
-
411
- def click(self, spec):
412
- self.wait_visible(spec); self._trace("click_before", spec)
413
- spec.click_input(); self._trace("click_after", spec)
414
-
415
- def type_text(self, spec, text):
416
- self.wait_visible(spec); self._trace("type_before", spec, text)
417
- # ... existing set_edit_text / keyboard fallback ...
418
- self._trace("type_after", spec)
419
- ```
420
-
421
- ### Caveats
422
-
423
- - **PII / credentials**: `type_text` content is `<redacted>` by default. Never set `E2E_TRACE_INCLUDE_TEXT=1` on login or payment flows.
424
- - **Overhead**: ~50–200ms per action + one PNG per step on disk. Don't enable on the default CI matrix — only on a dedicated flake-repro job.
425
- - **Artifact bloat**: a long flow produces tens of MB; tune `retention-days` accordingly.
426
- - **Parallel/rerun hygiene**: this simple example appends to `trace.jsonl` and uses a class-level counter. Clear the artifact directory before reruns, and use per-worker artifact dirs for parallel tests.
427
- - **Coverage gap**: actions performed outside `BasePage` (raw `pywinauto` calls in test code) are not traced.
428
-
429
- ## Flaky Test Handling
430
-
431
- ```python
432
- # Quarantine — equivalent to Playwright's test.fixme()
433
- @pytest.mark.skip(reason="Flaky: animation race on slow CI. Issue #42")
434
- def test_animated_transition(self, app): ...
435
-
436
- # Skip in CI only
437
- @pytest.mark.skipif(os.environ.get("CI") == "true", reason="Flaky in CI #43")
438
- def test_heavy_load(self, app): ...
439
- ```
440
-
441
- Common causes and fixes:
442
-
443
- | Cause | Fix |
444
- |-------|-----|
445
- | Control not ready | Replace `time.sleep` with `wait_visible` |
446
- | Window not focused | Add `win.set_focus()` before interactions |
447
- | Animation in progress | `wait_until(lambda: not loading_indicator.exists())` |
448
- | Dialog timing | `wait_window(title, timeout=15)` |
449
- | CI display not ready | Set `DISPLAY` or use virtual desktop in CI |
450
- | `set_edit_text` raises NotImplementedError | UIA ValuePattern missing (common on Qt 5.x) — `BasePage.type_text` already falls back to `keyboard.send_keys` |
451
- | Control exists but `wait_visible` times out | Window minimised or off-screen — call `win.restore()` + `win.set_focus()` before waiting |
452
-
453
- ## Test Isolation & Sandbox
454
-
455
- Three tiers of isolation — use the lightest tier that satisfies your needs.
456
-
457
- ### Tier 1 — Filesystem Isolation (default, always use)
458
-
459
- Each test gets its own `APPDATA` / `LOCALAPPDATA` / `TEMP` via `subprocess.Popen` and `Application.connect()`. pytest's `tmp_path` fixture handles cleanup automatically.
460
-
461
- ```python
462
- # conftest.py — replace the basic `app` fixture with this
463
- import os, subprocess, pytest
464
- from pywinauto import Application
465
- from config import APP_PATH, APP_ARGS, APP_TITLE, LAUNCH_TIMEOUT, ACTION_TIMEOUT, ARTIFACT_DIR
466
-
467
- @pytest.fixture(scope="function")
468
- def app(request, tmp_path):
469
- """Fresh process + isolated user-data dirs per test."""
470
- if not APP_PATH:
471
- pytest.exit("APP_PATH not set", returncode=1)
472
-
473
- # Redirect all per-user storage to an isolated tmp directory
474
- sandbox_env = os.environ.copy()
475
- sandbox_env["QT_ACCESSIBILITY"] = "1"
476
- sandbox_env["APPDATA"] = str(tmp_path / "AppData" / "Roaming")
477
- sandbox_env["LOCALAPPDATA"] = str(tmp_path / "AppData" / "Local")
478
- sandbox_env["TEMP"] = sandbox_env["TMP"] = str(tmp_path / "Temp")
479
- for p in (sandbox_env["APPDATA"], sandbox_env["LOCALAPPDATA"], sandbox_env["TEMP"]):
480
- os.makedirs(p, exist_ok=True)
481
-
482
- if not APP_TITLE:
483
- pytest.exit("APP_TITLE environment variable is not set", returncode=1)
484
-
485
- # shlex.split handles quoted args with spaces; plain split() breaks on them
486
- import shlex
487
- # Launch via subprocess so we can pass env; connect pywinauto by PID
488
- proc = subprocess.Popen(
489
- [APP_PATH] + shlex.split(APP_ARGS),
490
- env=sandbox_env,
491
- )
492
- pw_app = Application(backend="uia").connect(process=proc.pid, timeout=LAUNCH_TIMEOUT)
493
- win = pw_app.window(title=APP_TITLE)
494
- win.wait("visible", timeout=LAUNCH_TIMEOUT)
495
- yield win
496
-
497
- if getattr(getattr(request.node, "rep_call", None), "failed", False):
498
- os.makedirs(ARTIFACT_DIR, exist_ok=True)
499
- try:
500
- win.capture_as_image().save(
501
- os.path.join(ARTIFACT_DIR, f"FAIL_{request.node.name}.png")
502
- )
503
- except Exception:
504
- pass
505
- try:
506
- win.close()
507
- proc.wait(timeout=5)
508
- except Exception:
509
- proc.kill()
510
- # tmp_path is cleaned up automatically by pytest
511
-
512
- @pytest.hookimpl(tryfirst=True, hookwrapper=True)
513
- def pytest_runtest_makereport(item, call):
514
- outcome = yield
515
- setattr(item, f"rep_{outcome.get_result().when}", outcome.get_result())
516
- ```
517
-
518
- ### Tier 2 — Windows Job Object (optional: process-lifetime containment)
519
-
520
- Attach the process to a Job Object so it is **automatically terminated** when
521
- the test fixture's job handle is GC'd. Also prevents the app from spawning
522
- child processes that escape fixture cleanup.
523
-
524
- > **Scope of isolation:** Job Objects do NOT virtualize filesystem access or
525
- > block network traffic. File-write and network isolation require AppContainer,
526
- > Windows Firewall rules, or Tier 3 (Windows Sandbox). Use Tier 2 only for
527
- > process-lifetime and child-process containment.
528
-
529
- Requires no extra dependencies.
530
-
531
- ```python
532
- import ctypes, ctypes.wintypes as wt
533
-
534
- def restrict_process(pid: int):
535
- """
536
- Attach the process to a Job Object that prevents it from:
537
- - spawning processes outside the job (LIMIT_KILL_ON_JOB_CLOSE)
538
- Does NOT block network — use Windows Firewall rules for that.
539
- """
540
- JOB_OBJECT_LIMIT_KILL_ON_JOB_CLOSE = 0x00002000
541
- # Minimal rights: SET_QUOTA (0x0100) | TERMINATE (0x0001)
542
- PROCESS_SET_QUOTA_AND_TERMINATE = 0x0101
543
-
544
- kernel32 = ctypes.windll.kernel32
545
- job = kernel32.CreateJobObjectW(None, None)
546
- hproc = kernel32.OpenProcess(PROCESS_SET_QUOTA_AND_TERMINATE, False, pid)
547
-
548
- # Correct struct layout — LimitFlags is at offset +16, not +44
549
- class JOBOBJECT_BASIC_LIMIT_INFORMATION(ctypes.Structure):
550
- _fields_ = [
551
- ("PerProcessUserTimeLimit", wt.LARGE_INTEGER),
552
- ("PerJobUserTimeLimit", wt.LARGE_INTEGER),
553
- ("LimitFlags", wt.DWORD),
554
- ("MinimumWorkingSetSize", ctypes.c_size_t),
555
- ("MaximumWorkingSetSize", ctypes.c_size_t),
556
- ("ActiveProcessLimit", wt.DWORD),
557
- ("Affinity", ctypes.c_size_t),
558
- ("PriorityClass", wt.DWORD),
559
- ("SchedulingClass", wt.DWORD),
560
- ]
561
-
562
- info = JOBOBJECT_BASIC_LIMIT_INFORMATION()
563
- info.LimitFlags = JOB_OBJECT_LIMIT_KILL_ON_JOB_CLOSE
564
- ok = kernel32.SetInformationJobObject(job, 2, ctypes.byref(info), ctypes.sizeof(info))
565
- if not ok:
566
- raise ctypes.WinError()
567
- kernel32.AssignProcessToJobObject(job, hproc)
568
- kernel32.CloseHandle(hproc)
569
- return job # keep alive — job closes (kills proc) when GC'd
570
-
571
- # After proc = subprocess.Popen(...): job = restrict_process(proc.pid)
572
- ```
573
-
574
- ### Tier 3 — Windows Sandbox (CI full-OS isolation)
575
-
576
- When you need a clean Windows image per run (no leftover registry keys, no
577
- shared GPU state, true isolation), run the **entire test suite** inside
578
- [Windows Sandbox](https://learn.microsoft.com/windows/security/application-security/application-isolation/windows-sandbox/windows-sandbox-overview).
579
-
580
- **Requirement:** Windows 10/11 Pro or Enterprise, Virtualization enabled.
581
-
582
- Create `e2e-sandbox.wsb` in your project root:
583
-
584
- ```xml
585
- <Configuration>
586
- <MappedFolders>
587
- <!-- App binary (read-only) -->
588
- <MappedFolder>
589
- <HostFolder>C:\path\to\your\build\Release</HostFolder>
590
- <SandboxFolder>C:\app</SandboxFolder>
591
- <ReadOnly>true</ReadOnly>
592
- </MappedFolder>
593
- <!-- Test suite (read-write for artifacts) -->
594
- <MappedFolder>
595
- <HostFolder>C:\path\to\your\e2e_test</HostFolder>
596
- <SandboxFolder>C:\e2e_test</SandboxFolder>
597
- <ReadOnly>false</ReadOnly>
598
- </MappedFolder>
599
- </MappedFolders>
600
- <LogonCommand>
601
- <!--
602
- Windows Sandbox starts with no Python. Install it silently first,
603
- then install deps and run tests. Artifacts are written back to the
604
- host via the MappedFolder above.
605
- -->
606
- <Command>powershell -Command "
607
- winget install --id Python.Python.3.11 --silent --accept-package-agreements;
608
- $env:PATH += ';' + $env:LOCALAPPDATA + '\Programs\Python\Python311\Scripts';
609
- cd C:\e2e_test;
610
- pip install -r requirements.txt;
611
- pytest tests\ -v
612
- "</Command>
613
- </LogonCommand>
614
- </Configuration>
615
- ```
616
-
617
- Launch: `WindowsSandbox.exe e2e-sandbox.wsb`
618
-
619
- > pywinauto and the app both run **inside** the sandbox (same session required).
620
- > Artifacts are written back to the host via the mapped folder.
621
-
622
- ### Tier comparison
623
-
624
- | Tier | Isolation | Setup cost | Works on CI | Use when |
625
- |------|-----------|-----------|-------------|----------|
626
- | 1 — `tmp_path` env redirect | Filesystem | Zero | Always | Default for all tests |
627
- | 2 — Job Object | Process tree | Low | Always | Prevent child-process escape |
628
- | 3 — Windows Sandbox | Full OS | Medium | Needs Pro/Enterprise image | Nightly clean-room runs |
629
-
630
- ### Prevent hanging tests
631
-
632
- Add `pytest-timeout` to cap any single test. In `pytest.ini` set `timeout = 60` and `timeout_method = thread`. Note: `thread` method cannot kill Qt app subprocesses on Windows — add `atexit.register(lambda: [p.kill() for p in psutil.Process().children(recursive=True)])` in `conftest.py` to reap orphans.
633
-
634
- ## CI/CD Integration
635
-
636
- ```yaml
637
- # .github/workflows/e2e-desktop.yml
638
- name: Desktop E2E
639
- on: [push, pull_request]
640
-
641
- jobs:
642
- e2e:
643
- runs-on: windows-latest # real GUI environment, no Xvfb needed
644
- steps:
645
- - uses: actions/checkout@v4
646
-
647
- - uses: actions/setup-python@v5
648
- with: { python-version: "3.11" }
649
-
650
- - name: Install deps
651
- run: pip install pywinauto pytest pytest-html Pillow
652
-
653
- - name: Build app
654
- run: cmake --build build --config Release # adjust to your build system
655
-
656
- - name: Run E2E
657
- env:
658
- APP_PATH: ${{ github.workspace }}\build\Release\MyApp.exe
659
- APP_TITLE: "My Application"
660
- CI: "true"
661
- run: pytest tests/ --html=artifacts/report.html --self-contained-html --junitxml=artifacts/results.xml -v
662
-
663
- - uses: actions/upload-artifact@v4
664
- if: always()
665
- with:
666
- name: e2e-artifacts
667
- path: artifacts/
668
- retention-days: 14
669
- ```
670
-
671
- ## Qt Specific
672
-
673
- ### Enable UIA in Qt 5.x
674
-
675
- Qt 5.x accessibility is disabled by default in some builds (especially 5.7–5.14). Set the environment variable **before** launching. Qt 6.x enables accessibility by default — skip this step for Qt 6.
676
-
677
- ```python
678
- # conftest.py — add at module top
679
- import os
680
- os.environ["QT_ACCESSIBILITY"] = "1"
681
- ```
682
-
683
- Or export it in CI:
684
-
685
- ```yaml
686
- env:
687
- QT_ACCESSIBILITY: "1"
688
- ```
689
-
690
- ### Add Stable Identifiers to Qt Widgets
691
-
692
- ```cpp
693
- // Preferred: both objectName and accessibleName
694
- void setTestId(QWidget* w, const char* id) {
695
- w->setObjectName(id);
696
- w->setAccessibleName(id); // becomes UIA Name property
697
- }
698
-
699
- // In your dialog constructor:
700
- setTestId(ui->usernameEdit, "usernameInput");
701
- setTestId(ui->passwordEdit, "passwordInput");
702
- setTestId(ui->loginButton, "btnLogin");
703
- setTestId(ui->errorLabel, "lblError");
704
- ```
705
-
706
- Centralise all IDs in a header to avoid typos:
707
-
708
- ```cpp
709
- // test_ids.h
710
- #define TID_USERNAME "usernameInput"
711
- #define TID_PASSWORD "passwordInput"
712
- #define TID_BTN_LOGIN "btnLogin"
713
- #define TID_LBL_ERROR "lblError"
714
- ```
715
-
716
- ### Qt-Specific Quirks
717
-
718
- **QComboBox** — the dropdown is a separate top-level window:
719
-
720
- ```python
721
- from pywinauto import Desktop
722
-
723
- def select_combo_item(page, combo_spec, item_text):
724
- page.click(combo_spec)
725
- # Dropdown appears as a new root-level window
726
- # class_name varies by Qt version — verify with Accessibility Insights
727
- # Qt 5.x: "Qt5QWindowIcon" | Qt 6.x: "Qt6QWindowIcon" — verify with Accessibility Insights
728
- popup = Desktop(backend="uia").window(class_name_re="Qt[56]QWindowIcon")
729
- popup.wait("visible", timeout=5)
730
- popup.child_window(title=item_text).click_input()
731
- ```
732
-
733
- **QMessageBox / QDialog** — also separate top-level windows:
734
-
735
- ```python
736
- dlg = page.wait_window("Confirm") # wait for dialog title
737
- dlg.child_window(title="OK").click_input() # click button inside it
738
- ```
739
-
740
- **QTableWidget / QTableView** — row/cell access:
741
-
742
- ```python
743
- table = page.by_id("tblUsers").wrapper_object()
744
- cell = table.cell(row=0, column=1)
745
- print(cell.window_text())
746
- ```
747
-
748
- **Self-drawn controls** (`paintEvent`-only, `QGraphicsView`, `QOpenGLWidget`) — UIA cannot see their internals. Use the Fallback section below.
749
-
750
- ## Fallback: Screenshot Mode
751
-
752
- When a control is not reachable via UIA (self-drawn, third-party, game engine):
753
-
754
- ```bash
755
- pip install pyautogui Pillow opencv-python
756
- ```
757
-
758
- ```python
759
- import pyautogui, cv2, numpy as np
760
- from PIL import Image
761
-
762
- def find_image_on_screen(template_path, confidence=0.85):
763
- """Locate a template image on screen. Returns (x, y) center or None."""
764
- screen = np.array(pyautogui.screenshot())
765
- template = np.array(Image.open(template_path))
766
- result = cv2.matchTemplate(
767
- cv2.cvtColor(screen, cv2.COLOR_RGB2BGR),
768
- cv2.cvtColor(template, cv2.COLOR_RGB2BGR),
769
- cv2.TM_CCOEFF_NORMED,
770
- )
771
- _, max_val, _, max_loc = cv2.minMaxLoc(result)
772
- if max_val >= confidence:
773
- h, w = template.shape[:2]
774
- return max_loc[0] + w // 2, max_loc[1] + h // 2
775
- return None
776
-
777
- def click_image(template_path, confidence=0.85):
778
- pos = find_image_on_screen(template_path, confidence)
779
- if pos is None:
780
- raise RuntimeError(f"Image not found on screen: {template_path}")
781
- pyautogui.click(*pos)
782
- ```
783
-
784
- ### DPI / Scaling Rules (screenshot mode only)
785
-
786
- Screenshot matching is brutally sensitive to Windows display scaling (100% / 125% / 150%). Three hard rules:
787
-
788
- 1. **Capture templates at the same scale as the target machine.** Don't try to rescue a mismatch with `PIL.Image.resize` — `cv2.matchTemplate` is very fragile against resampling artefacts.
789
- 2. **Pin the CI display scaling.** On `windows-latest` add a step like `Set-DisplayResolution 1920 1080 -Force` and disable per-monitor DPI scaling, so screenshot dimensions are reproducible.
790
- 3. **Record the scale alongside each artefact.** On capture, write `GetDpiForWindow(hwnd) / 96` to `artifacts/<test>/metadata.json` — postmortems become obvious instead of guess-work.
791
-
792
- > Process-level DPI awareness (`SetProcessDpiAwarenessContext`) **can conflict with Qt's own DPI handling** when the app under test is Qt-based. Prefer "same-scale templates + CI pin" over flipping process-wide DPI mode in fixtures.
793
-
794
- ### Debugging Match Confidence
795
-
796
- When tuning the `confidence` threshold, the only sane workflow is to **see** where the match landed. The helper below is diagnosis-only — do not call it from test code.
797
-
798
- ```python
799
- def debug_match(template_path, out="artifacts/match_debug.png", confidence=0.85):
800
- """Diagnosis-only. Draw the best-match rectangle + score back on the current screen.
801
-
802
- NOT for production tests — use when calibrating confidence or chasing false matches.
803
- """
804
- import os, cv2, pyautogui, numpy as np
805
- screen = np.array(pyautogui.screenshot())[:, :, ::-1]
806
- tpl = cv2.imread(template_path)
807
- if tpl is None:
808
- raise RuntimeError(f"Template unreadable: {template_path}")
809
- res = cv2.matchTemplate(screen, tpl, cv2.TM_CCOEFF_NORMED)
810
- _, mv, _, ml = cv2.minMaxLoc(res)
811
- h, w = tpl.shape[:2]
812
- colour = (0, 255, 0) if mv >= confidence else (0, 0, 255) # green pass / red fail
813
- cv2.rectangle(screen, ml, (ml[0]+w, ml[1]+h), colour, 2)
814
- cv2.putText(screen, f"score={mv:.3f} thr={confidence}",
815
- (ml[0], max(20, ml[1]-6)),
816
- cv2.FONT_HERSHEY_SIMPLEX, 0.7, colour, 2)
817
- os.makedirs(os.path.dirname(out) or ".", exist_ok=True)
818
- cv2.imwrite(out, screen)
819
- return mv
820
- ```
821
-
822
- **Use sparingly** — image matching breaks on DPI changes, theme switches, and partial occlusion.
823
- Always try UIA first; fall back to screenshots only for genuinely unreachable controls.
824
-
825
- ## Anti-Patterns
826
-
827
- ```python
828
- # BAD: fixed sleep
829
- time.sleep(3)
830
- page.click(page.by_id("btnSubmit"))
831
-
832
- # GOOD: condition wait
833
- page.wait_visible(page.by_id("btnSubmit"))
834
- page.click(page.by_id("btnSubmit"))
835
- ```
836
-
837
- ```python
838
- # BAD: brittle class+index locator as primary strategy
839
- page.by_class("Edit", index=2).type_keys("hello")
840
-
841
- # GOOD: AutomationId
842
- page.by_id("usernameInput").set_edit_text("hello")
843
- ```
844
-
845
- ```python
846
- # BAD: assert on pixel coordinates
847
- assert btn.rectangle().left == 120
848
-
849
- # GOOD: assert on content / state
850
- assert page.get_text(page.by_id("lblStatus")) == "Logged in"
851
- assert page.by_id("btnLogout").is_enabled()
852
- ```
853
-
854
- ```python
855
- # BAD: share app instance across all tests (state leaks)
856
- @pytest.fixture(scope="session")
857
- def app(): ...
858
-
859
- # GOOD: fresh process per test (or per class at most)
860
- @pytest.fixture(scope="function")
861
- def app(): ...
862
- ```
863
-
864
- ## Running Tests
865
-
866
- ```bash
867
- # All tests
868
- pytest tests/ -v
869
-
870
- # Smoke only
871
- pytest tests/ -m smoke -v
872
-
873
- # Specific file
874
- pytest tests/test_login.py -v
875
-
876
- # With custom app path
877
- APP_PATH="C:\build\Release\MyApp.exe" APP_TITLE="MyApp" pytest tests/ -v
878
-
879
- # Detect flaky tests (repeat each 5 times)
880
- pip install pytest-repeat
881
- pytest tests/test_login.py --count=5 -v
882
- ```
883
-
884
- ## Related Skills
885
-
886
- - `e2e-testing` — Playwright E2E for web applications
887
- - `cpp-testing` — C++ unit/integration testing with GoogleTest
888
- - `cpp-coding-standards` — C++ code style and patterns
1
+ ---
2
+ name: windows-desktop-e2e
3
+ description: E2E testing for Windows native desktop apps (WPF, WinForms, Win32/MFC, Qt) using pywinauto and Windows UI Automation.
4
+ metadata:
5
+ origin: ECC
6
+ ---
7
+
8
+ # Windows Desktop E2E Testing
9
+
10
+ End-to-end testing for Windows native desktop applications using **pywinauto** backed by Windows UI Automation (UIA). Covers WPF, WinForms, Win32/MFC, and Qt (5.x / 6.x) — with Qt-specific guidance as a dedicated section.
11
+
12
+ ## When to Activate
13
+
14
+ - Writing or running E2E tests for a Windows native desktop application
15
+ - Setting up a desktop GUI test suite from scratch
16
+ - Diagnosing flaky or failing desktop automation tests
17
+ - Adding testability (AutomationId, accessible names) to an existing app
18
+ - Integrating desktop E2E into a CI/CD pipeline (GitHub Actions `windows-latest`)
19
+
20
+ ### When NOT to Use
21
+
22
+ - Web applications → use `e2e-testing` skill (Playwright)
23
+ - Electron / CEF / WebView2 apps → the HTML layer needs browser automation, not UIA
24
+ - Mobile apps → use platform-specific tools (UIAutomator, XCUITest)
25
+ - Pure unit or integration tests that don't need a running GUI
26
+
27
+ ## Core Concepts
28
+
29
+ All Windows desktop automation relies on **UI Automation (UIA)**, a Windows-built-in accessibility API. Every supported framework exposes a tree of UIA elements with properties Claude can read and act on:
30
+
31
+ ```
32
+ Your test (Python)
33
+ └── pywinauto (UIA backend)
34
+ └── Windows UI Automation API ← built into Windows, framework-agnostic
35
+ └── App's UIA provider ← each framework ships its own
36
+ └── Running .exe
37
+ ```
38
+
39
+ **UIA quality by framework:**
40
+
41
+ | Framework | AutomationId | Reliability | Notes |
42
+ |-----------|-------------|-------------|-------|
43
+ | WPF | 5/5 | Excellent | `x:Name` maps directly to AutomationId |
44
+ | WinForms | 4/5 | Good | `AccessibleName` = AutomationId |
45
+ | UWP / WinUI 3 | 5/5 | Excellent | Full Microsoft support |
46
+ | Qt 6.x | 5/5 | Excellent | Accessibility enabled by default; class names change to `Qt6*` |
47
+ | Qt 5.15+ | 4/5 | Good | Improved Accessibility module |
48
+ | Qt 5.7–5.14 | 3/5 | Fair | Needs `QT_ACCESSIBILITY=1`; objectName manual |
49
+ | Win32 / MFC | 3/5 | Fair | Control IDs accessible; text matching common |
50
+
51
+ ## Setup & Prerequisites
52
+
53
+ ```bash
54
+ # Python 3.8+, Windows only
55
+ pip install pywinauto pytest pytest-html Pillow pytest-timeout
56
+ # Optional: screen recording
57
+ # Install ffmpeg and add to PATH: https://ffmpeg.org/download.html
58
+ ```
59
+
60
+ Verify UIA is reachable:
61
+
62
+ ```python
63
+ from pywinauto import Desktop
64
+ Desktop(backend="uia").windows() # lists all top-level windows
65
+ ```
66
+
67
+ Install **Accessibility Insights for Windows** (free, from Microsoft) — your DevTools equivalent for inspecting the UIA element tree before writing any test.
68
+
69
+ ## Testability Setup (by Framework)
70
+
71
+ The single most impactful thing you can do is **give every interactive control a stable AutomationId** before writing tests.
72
+
73
+ ### WPF
74
+
75
+ ```xml
76
+ <!-- XAML: x:Name becomes AutomationId automatically -->
77
+ <TextBox x:Name="usernameInput" />
78
+ <PasswordBox x:Name="passwordInput" />
79
+ <Button x:Name="btnLogin" Content="Login" />
80
+ <TextBlock x:Name="lblError" />
81
+ ```
82
+
83
+ ### WinForms
84
+
85
+ ```csharp
86
+ // Set in designer or code
87
+ usernameInput.AccessibleName = "usernameInput";
88
+ passwordInput.AccessibleName = "passwordInput";
89
+ btnLogin.AccessibleName = "btnLogin";
90
+ lblError.AccessibleName = "lblError";
91
+ ```
92
+
93
+ ### Win32 / MFC
94
+
95
+ ```cpp
96
+ // Control resource IDs in .rc file are exposed as AutomationId strings
97
+ // IDC_EDIT_USERNAME -> AutomationId "1001"
98
+ // Prefer SetWindowText for Name; add IAccessible for richer support
99
+ ```
100
+
101
+ ### Qt — see dedicated section below
102
+
103
+ ---
104
+
105
+ ## Page Object Model
106
+
107
+ ```
108
+ tests/
109
+ ├── conftest.py # app launch fixture, failure screenshot
110
+ ├── pytest.ini
111
+ ├── config.py
112
+ ├── pages/
113
+ │ ├── __init__.py # required for imports
114
+ │ ├── base_page.py # locators, wait, screenshot helpers
115
+ │ ├── login_page.py
116
+ │ └── main_page.py
117
+ ├── tests/
118
+ │ ├── __init__.py
119
+ │ ├── test_login.py
120
+ │ └── test_main_flow.py
121
+ └── artifacts/ # screenshots, videos, logs
122
+ ```
123
+
124
+ ### base_page.py
125
+
126
+ ```python
127
+ import os, time
128
+ from pywinauto import Desktop
129
+ from config import ACTION_TIMEOUT, ARTIFACT_DIR
130
+
131
+ class BasePage:
132
+ def __init__(self, window):
133
+ self.window = window
134
+
135
+ # --- Locators (priority order) ---
136
+
137
+ def by_id(self, auto_id, **kw):
138
+ """AutomationId — most stable. Use as first choice."""
139
+ return self.window.child_window(auto_id=auto_id, **kw)
140
+
141
+ def by_name(self, name, **kw):
142
+ """Visible text / accessible name."""
143
+ return self.window.child_window(title=name, **kw)
144
+
145
+ def by_class(self, cls, index=0, **kw):
146
+ """Control class + index — fragile, avoid if possible."""
147
+ return self.window.child_window(class_name=cls, found_index=index, **kw)
148
+
149
+ # --- Waits ---
150
+
151
+ def wait_visible(self, spec, timeout=ACTION_TIMEOUT):
152
+ spec.wait("visible", timeout=timeout)
153
+ return spec
154
+
155
+ def wait_gone(self, spec, timeout=ACTION_TIMEOUT):
156
+ spec.wait_not("visible", timeout=timeout)
157
+ return spec
158
+
159
+ def wait_window(self, title, timeout=ACTION_TIMEOUT):
160
+ """Wait for a new top-level window (dialogs, child windows)."""
161
+ dlg = Desktop(backend="uia").window(title=title)
162
+ dlg.wait("visible", timeout=timeout)
163
+ return dlg
164
+
165
+ def wait_until(self, fn, timeout=ACTION_TIMEOUT, interval=0.3):
166
+ """Poll an arbitrary condition — use when UIA events are unreliable."""
167
+ deadline = time.time() + timeout
168
+ while time.time() < deadline:
169
+ try:
170
+ if fn():
171
+ return True
172
+ except Exception:
173
+ pass
174
+ time.sleep(interval)
175
+ raise TimeoutError(f"Condition not met within {timeout}s")
176
+
177
+ # --- Actions ---
178
+
179
+ def click(self, spec):
180
+ self.wait_visible(spec)
181
+ spec.click_input()
182
+
183
+ def type_text(self, spec, text):
184
+ self.wait_visible(spec)
185
+ ctrl = spec.wrapper_object()
186
+ try:
187
+ ctrl.set_edit_text(text)
188
+ except Exception as e:
189
+ # Qt 5.x fallback: UIA Value Pattern may be incomplete
190
+ import sys, pywinauto.keyboard as kb
191
+ print(f"[windows-desktop-e2e] set_edit_text failed ({e}), using keyboard fallback", file=sys.stderr)
192
+ ctrl.click_input()
193
+ kb.send_keys("^a")
194
+ kb.send_keys(text, with_spaces=True)
195
+
196
+ def get_text(self, spec):
197
+ ctrl = spec.wrapper_object()
198
+ for attr in ("window_text", "get_value"):
199
+ try:
200
+ v = getattr(ctrl, attr)()
201
+ if v:
202
+ return v
203
+ except Exception:
204
+ pass
205
+ return ""
206
+
207
+ # --- Artifacts ---
208
+
209
+ def screenshot(self, name):
210
+ os.makedirs(ARTIFACT_DIR, exist_ok=True)
211
+ path = os.path.join(ARTIFACT_DIR, f"{name}.png")
212
+ self.window.capture_as_image().save(path)
213
+ return path
214
+ ```
215
+
216
+ ### login_page.py
217
+
218
+ ```python
219
+ from pages.base_page import BasePage
220
+
221
+ class LoginPage(BasePage):
222
+ @property
223
+ def username(self): return self.by_id("usernameInput")
224
+
225
+ @property
226
+ def password(self): return self.by_id("passwordInput")
227
+
228
+ @property
229
+ def btn_login(self): return self.by_id("btnLogin")
230
+
231
+ @property
232
+ def error_label(self): return self.by_id("lblError")
233
+
234
+ def login(self, user, pwd):
235
+ self.type_text(self.username, user)
236
+ self.type_text(self.password, pwd)
237
+ self.click(self.btn_login)
238
+
239
+ def login_ok(self, user, pwd, main_title="Main Window"):
240
+ self.login(user, pwd)
241
+ return self.wait_window(main_title)
242
+
243
+ def login_fail(self, user, pwd):
244
+ self.login(user, pwd)
245
+ self.wait_visible(self.error_label)
246
+ return self.get_text(self.error_label)
247
+ ```
248
+
249
+ ### conftest.py
250
+
251
+ > For new projects prefer the **Tier 1 sandbox fixture** (see below) — it adds filesystem isolation at zero extra cost. This basic fixture is for minimal/legacy setups only.
252
+
253
+ ```python
254
+ import os, pytest
255
+ os.environ["QT_ACCESSIBILITY"] = "1" # Required for Qt 5.x UIA support
256
+
257
+ from pywinauto import Application
258
+ from config import APP_PATH, MAIN_WINDOW_TITLE, LAUNCH_TIMEOUT, ARTIFACT_DIR
259
+
260
+ @pytest.fixture
261
+ def app(request):
262
+ if not APP_PATH:
263
+ pytest.exit("APP_PATH environment variable is not set", returncode=1)
264
+ proc = Application(backend="uia").start(APP_PATH, timeout=LAUNCH_TIMEOUT)
265
+ win = proc.window(title=MAIN_WINDOW_TITLE)
266
+ win.wait("visible", timeout=LAUNCH_TIMEOUT)
267
+ yield win
268
+ # Screenshot on failure
269
+ if getattr(getattr(request.node, "rep_call", None), "failed", False):
270
+ os.makedirs(ARTIFACT_DIR, exist_ok=True)
271
+ try:
272
+ win.capture_as_image().save(
273
+ os.path.join(ARTIFACT_DIR, f"FAIL_{request.node.name}.png")
274
+ )
275
+ except Exception:
276
+ pass
277
+ # Graceful exit first, force-kill as fallback
278
+ # proc is a pywinauto Application — use wait_for_process_exit(), not wait_for_process()
279
+ try:
280
+ win.close()
281
+ proc.wait_for_process_exit(timeout=5)
282
+ except Exception:
283
+ proc.kill()
284
+
285
+ @pytest.hookimpl(tryfirst=True, hookwrapper=True)
286
+ def pytest_runtest_makereport(item, call):
287
+ outcome = yield
288
+ setattr(item, f"rep_{outcome.get_result().when}", outcome.get_result())
289
+ ```
290
+
291
+ ### config.py
292
+
293
+ ```python
294
+ import os
295
+ APP_PATH = os.environ.get("APP_PATH", "") # set via env — no default path
296
+ MAIN_WINDOW_TITLE = os.environ.get("APP_TITLE", "")
297
+ LAUNCH_TIMEOUT = int(os.environ.get("LAUNCH_TIMEOUT", "15"))
298
+ ACTION_TIMEOUT = int(os.environ.get("ACTION_TIMEOUT", "10"))
299
+ ARTIFACT_DIR = os.path.join(os.path.dirname(__file__), "artifacts")
300
+ ```
301
+
302
+ ### pytest.ini
303
+
304
+ ```ini
305
+ [pytest]
306
+ testpaths = tests
307
+ markers =
308
+ smoke: fast smoke tests for critical paths
309
+ flaky: known-unstable tests
310
+ addopts = -v --tb=short --html=artifacts/report.html --self-contained-html
311
+ ```
312
+
313
+ ## Locator Strategy
314
+
315
+ ```
316
+ AutomationId > Name (text) > ClassName + index > XPath
317
+ (stable) (readable) (fragile) (last resort)
318
+ ```
319
+
320
+ Inspect with Accessibility Insights → **Properties** pane → look for `AutomationId` first.
321
+
322
+ ```python
323
+ # Inspect at runtime — paste into a REPL to explore the tree
324
+ win.print_control_identifiers()
325
+ # or narrow scope:
326
+ win.child_window(auto_id="groupBox1").print_control_identifiers()
327
+ ```
328
+
329
+ ## Wait Patterns
330
+
331
+ ```python
332
+ # Wait for control to appear
333
+ page.wait_visible(page.by_id("statusLabel"))
334
+
335
+ # Wait for control to disappear (e.g. loading spinner)
336
+ page.wait_gone(page.by_id("spinnerOverlay"))
337
+
338
+ # Wait for a dialog to pop up
339
+ dlg = page.wait_window("Confirm Delete")
340
+
341
+ # Custom condition (e.g. text changes)
342
+ page.wait_until(lambda: page.get_text(page.by_id("lblStatus")) == "Ready")
343
+ ```
344
+
345
+ **Never use `time.sleep()` as primary synchronization** — use `wait()` or `wait_until()`.
346
+
347
+ ## Artifact Management
348
+
349
+ ```python
350
+ # Screenshot on demand
351
+ page.screenshot("after_login")
352
+
353
+ # Full-screen capture (when window is off-screen or minimised)
354
+ import pyautogui
355
+ pyautogui.screenshot("artifacts/fullscreen.png")
356
+
357
+ # Screen recording with ffmpeg (start before test, stop after)
358
+ import subprocess
359
+
360
+ def start_recording(name):
361
+ return subprocess.Popen([
362
+ "ffmpeg", "-f", "gdigrab", "-framerate", "10",
363
+ "-i", "desktop", "-y", f"artifacts/videos/{name}.mp4"
364
+ ], stdin=subprocess.PIPE, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
365
+
366
+ def stop_recording(proc):
367
+ proc.stdin.write(b"q"); proc.stdin.flush(); proc.wait(timeout=10)
368
+ ```
369
+
370
+ ## Per-Step Trace (opt-in)
371
+
372
+ The default failure screenshot is often too thin for diagnosing flaky tests. The step-level trace below is **off by default** — enable it only when reproducing a flaky case.
373
+
374
+ ### Enable
375
+
376
+ ```bash
377
+ E2E_TRACE=1 pytest tests/test_login.py -v
378
+ # Include typed text in the JSONL log (DO NOT use on tests that type credentials/PII):
379
+ E2E_TRACE=1 E2E_TRACE_INCLUDE_TEXT=1 pytest ...
380
+ ```
381
+
382
+ ### Patch into BasePage
383
+
384
+ ```python
385
+ import os, json, time
386
+ TRACE_ENABLED = os.environ.get("E2E_TRACE") == "1"
387
+ TRACE_INCLUDE_TEXT = os.environ.get("E2E_TRACE_INCLUDE_TEXT") == "1"
388
+
389
+ class BasePage:
390
+ _step = 0
391
+
392
+ def _trace(self, action, spec=None, text=None):
393
+ if not TRACE_ENABLED:
394
+ return
395
+ BasePage._step += 1
396
+ idx = f"{BasePage._step:03d}"
397
+ os.makedirs(ARTIFACT_DIR, exist_ok=True)
398
+ try:
399
+ self.window.capture_as_image().save(
400
+ os.path.join(ARTIFACT_DIR, f"step_{idx}_{action}.png"))
401
+ except Exception:
402
+ pass # capture failure must not break the test
403
+ rec = {
404
+ "ts": time.time(), "step": BasePage._step, "action": action,
405
+ "locator": getattr(spec, "criteria", None),
406
+ "text": text if TRACE_INCLUDE_TEXT else ("<redacted>" if text else None),
407
+ }
408
+ with open(os.path.join(ARTIFACT_DIR, "trace.jsonl"), "a") as f:
409
+ f.write(json.dumps(rec) + "\n")
410
+
411
+ def click(self, spec):
412
+ self.wait_visible(spec); self._trace("click_before", spec)
413
+ spec.click_input(); self._trace("click_after", spec)
414
+
415
+ def type_text(self, spec, text):
416
+ self.wait_visible(spec); self._trace("type_before", spec, text)
417
+ # ... existing set_edit_text / keyboard fallback ...
418
+ self._trace("type_after", spec)
419
+ ```
420
+
421
+ ### Caveats
422
+
423
+ - **PII / credentials**: `type_text` content is `<redacted>` by default. Never set `E2E_TRACE_INCLUDE_TEXT=1` on login or payment flows.
424
+ - **Overhead**: ~50–200ms per action + one PNG per step on disk. Don't enable on the default CI matrix — only on a dedicated flake-repro job.
425
+ - **Artifact bloat**: a long flow produces tens of MB; tune `retention-days` accordingly.
426
+ - **Parallel/rerun hygiene**: this simple example appends to `trace.jsonl` and uses a class-level counter. Clear the artifact directory before reruns, and use per-worker artifact dirs for parallel tests.
427
+ - **Coverage gap**: actions performed outside `BasePage` (raw `pywinauto` calls in test code) are not traced.
428
+
429
+ ## Flaky Test Handling
430
+
431
+ ```python
432
+ # Quarantine — equivalent to Playwright's test.fixme()
433
+ @pytest.mark.skip(reason="Flaky: animation race on slow CI. Issue #42")
434
+ def test_animated_transition(self, app): ...
435
+
436
+ # Skip in CI only
437
+ @pytest.mark.skipif(os.environ.get("CI") == "true", reason="Flaky in CI #43")
438
+ def test_heavy_load(self, app): ...
439
+ ```
440
+
441
+ Common causes and fixes:
442
+
443
+ | Cause | Fix |
444
+ |-------|-----|
445
+ | Control not ready | Replace `time.sleep` with `wait_visible` |
446
+ | Window not focused | Add `win.set_focus()` before interactions |
447
+ | Animation in progress | `wait_until(lambda: not loading_indicator.exists())` |
448
+ | Dialog timing | `wait_window(title, timeout=15)` |
449
+ | CI display not ready | Set `DISPLAY` or use virtual desktop in CI |
450
+ | `set_edit_text` raises NotImplementedError | UIA ValuePattern missing (common on Qt 5.x) — `BasePage.type_text` already falls back to `keyboard.send_keys` |
451
+ | Control exists but `wait_visible` times out | Window minimised or off-screen — call `win.restore()` + `win.set_focus()` before waiting |
452
+
453
+ ## Test Isolation & Sandbox
454
+
455
+ Three tiers of isolation — use the lightest tier that satisfies your needs.
456
+
457
+ ### Tier 1 — Filesystem Isolation (default, always use)
458
+
459
+ Each test gets its own `APPDATA` / `LOCALAPPDATA` / `TEMP` via `subprocess.Popen` and `Application.connect()`. pytest's `tmp_path` fixture handles cleanup automatically.
460
+
461
+ ```python
462
+ # conftest.py — replace the basic `app` fixture with this
463
+ import os, subprocess, pytest
464
+ from pywinauto import Application
465
+ from config import APP_PATH, APP_ARGS, APP_TITLE, LAUNCH_TIMEOUT, ACTION_TIMEOUT, ARTIFACT_DIR
466
+
467
+ @pytest.fixture(scope="function")
468
+ def app(request, tmp_path):
469
+ """Fresh process + isolated user-data dirs per test."""
470
+ if not APP_PATH:
471
+ pytest.exit("APP_PATH not set", returncode=1)
472
+
473
+ # Redirect all per-user storage to an isolated tmp directory
474
+ sandbox_env = os.environ.copy()
475
+ sandbox_env["QT_ACCESSIBILITY"] = "1"
476
+ sandbox_env["APPDATA"] = str(tmp_path / "AppData" / "Roaming")
477
+ sandbox_env["LOCALAPPDATA"] = str(tmp_path / "AppData" / "Local")
478
+ sandbox_env["TEMP"] = sandbox_env["TMP"] = str(tmp_path / "Temp")
479
+ for p in (sandbox_env["APPDATA"], sandbox_env["LOCALAPPDATA"], sandbox_env["TEMP"]):
480
+ os.makedirs(p, exist_ok=True)
481
+
482
+ if not APP_TITLE:
483
+ pytest.exit("APP_TITLE environment variable is not set", returncode=1)
484
+
485
+ # shlex.split handles quoted args with spaces; plain split() breaks on them
486
+ import shlex
487
+ # Launch via subprocess so we can pass env; connect pywinauto by PID
488
+ proc = subprocess.Popen(
489
+ [APP_PATH] + shlex.split(APP_ARGS),
490
+ env=sandbox_env,
491
+ )
492
+ pw_app = Application(backend="uia").connect(process=proc.pid, timeout=LAUNCH_TIMEOUT)
493
+ win = pw_app.window(title=APP_TITLE)
494
+ win.wait("visible", timeout=LAUNCH_TIMEOUT)
495
+ yield win
496
+
497
+ if getattr(getattr(request.node, "rep_call", None), "failed", False):
498
+ os.makedirs(ARTIFACT_DIR, exist_ok=True)
499
+ try:
500
+ win.capture_as_image().save(
501
+ os.path.join(ARTIFACT_DIR, f"FAIL_{request.node.name}.png")
502
+ )
503
+ except Exception:
504
+ pass
505
+ try:
506
+ win.close()
507
+ proc.wait(timeout=5)
508
+ except Exception:
509
+ proc.kill()
510
+ # tmp_path is cleaned up automatically by pytest
511
+
512
+ @pytest.hookimpl(tryfirst=True, hookwrapper=True)
513
+ def pytest_runtest_makereport(item, call):
514
+ outcome = yield
515
+ setattr(item, f"rep_{outcome.get_result().when}", outcome.get_result())
516
+ ```
517
+
518
+ ### Tier 2 — Windows Job Object (optional: process-lifetime containment)
519
+
520
+ Attach the process to a Job Object so it is **automatically terminated** when
521
+ the test fixture's job handle is GC'd. Also prevents the app from spawning
522
+ child processes that escape fixture cleanup.
523
+
524
+ > **Scope of isolation:** Job Objects do NOT virtualize filesystem access or
525
+ > block network traffic. File-write and network isolation require AppContainer,
526
+ > Windows Firewall rules, or Tier 3 (Windows Sandbox). Use Tier 2 only for
527
+ > process-lifetime and child-process containment.
528
+
529
+ Requires no extra dependencies.
530
+
531
+ ```python
532
+ import ctypes, ctypes.wintypes as wt
533
+
534
+ def restrict_process(pid: int):
535
+ """
536
+ Attach the process to a Job Object that prevents it from:
537
+ - spawning processes outside the job (LIMIT_KILL_ON_JOB_CLOSE)
538
+ Does NOT block network — use Windows Firewall rules for that.
539
+ """
540
+ JOB_OBJECT_LIMIT_KILL_ON_JOB_CLOSE = 0x00002000
541
+ # Minimal rights: SET_QUOTA (0x0100) | TERMINATE (0x0001)
542
+ PROCESS_SET_QUOTA_AND_TERMINATE = 0x0101
543
+
544
+ kernel32 = ctypes.windll.kernel32
545
+ job = kernel32.CreateJobObjectW(None, None)
546
+ hproc = kernel32.OpenProcess(PROCESS_SET_QUOTA_AND_TERMINATE, False, pid)
547
+
548
+ # Correct struct layout — LimitFlags is at offset +16, not +44
549
+ class JOBOBJECT_BASIC_LIMIT_INFORMATION(ctypes.Structure):
550
+ _fields_ = [
551
+ ("PerProcessUserTimeLimit", wt.LARGE_INTEGER),
552
+ ("PerJobUserTimeLimit", wt.LARGE_INTEGER),
553
+ ("LimitFlags", wt.DWORD),
554
+ ("MinimumWorkingSetSize", ctypes.c_size_t),
555
+ ("MaximumWorkingSetSize", ctypes.c_size_t),
556
+ ("ActiveProcessLimit", wt.DWORD),
557
+ ("Affinity", ctypes.c_size_t),
558
+ ("PriorityClass", wt.DWORD),
559
+ ("SchedulingClass", wt.DWORD),
560
+ ]
561
+
562
+ info = JOBOBJECT_BASIC_LIMIT_INFORMATION()
563
+ info.LimitFlags = JOB_OBJECT_LIMIT_KILL_ON_JOB_CLOSE
564
+ ok = kernel32.SetInformationJobObject(job, 2, ctypes.byref(info), ctypes.sizeof(info))
565
+ if not ok:
566
+ raise ctypes.WinError()
567
+ kernel32.AssignProcessToJobObject(job, hproc)
568
+ kernel32.CloseHandle(hproc)
569
+ return job # keep alive — job closes (kills proc) when GC'd
570
+
571
+ # After proc = subprocess.Popen(...): job = restrict_process(proc.pid)
572
+ ```
573
+
574
+ ### Tier 3 — Windows Sandbox (CI full-OS isolation)
575
+
576
+ When you need a clean Windows image per run (no leftover registry keys, no
577
+ shared GPU state, true isolation), run the **entire test suite** inside
578
+ [Windows Sandbox](https://learn.microsoft.com/windows/security/application-security/application-isolation/windows-sandbox/windows-sandbox-overview).
579
+
580
+ **Requirement:** Windows 10/11 Pro or Enterprise, Virtualization enabled.
581
+
582
+ Create `e2e-sandbox.wsb` in your project root:
583
+
584
+ ```xml
585
+ <Configuration>
586
+ <MappedFolders>
587
+ <!-- App binary (read-only) -->
588
+ <MappedFolder>
589
+ <HostFolder>C:\path\to\your\build\Release</HostFolder>
590
+ <SandboxFolder>C:\app</SandboxFolder>
591
+ <ReadOnly>true</ReadOnly>
592
+ </MappedFolder>
593
+ <!-- Test suite (read-write for artifacts) -->
594
+ <MappedFolder>
595
+ <HostFolder>C:\path\to\your\e2e_test</HostFolder>
596
+ <SandboxFolder>C:\e2e_test</SandboxFolder>
597
+ <ReadOnly>false</ReadOnly>
598
+ </MappedFolder>
599
+ </MappedFolders>
600
+ <LogonCommand>
601
+ <!--
602
+ Windows Sandbox starts with no Python. Install it silently first,
603
+ then install deps and run tests. Artifacts are written back to the
604
+ host via the MappedFolder above.
605
+ -->
606
+ <Command>powershell -Command "
607
+ winget install --id Python.Python.3.11 --silent --accept-package-agreements;
608
+ $env:PATH += ';' + $env:LOCALAPPDATA + '\Programs\Python\Python311\Scripts';
609
+ cd C:\e2e_test;
610
+ pip install -r requirements.txt;
611
+ pytest tests\ -v
612
+ "</Command>
613
+ </LogonCommand>
614
+ </Configuration>
615
+ ```
616
+
617
+ Launch: `WindowsSandbox.exe e2e-sandbox.wsb`
618
+
619
+ > pywinauto and the app both run **inside** the sandbox (same session required).
620
+ > Artifacts are written back to the host via the mapped folder.
621
+
622
+ ### Tier comparison
623
+
624
+ | Tier | Isolation | Setup cost | Works on CI | Use when |
625
+ |------|-----------|-----------|-------------|----------|
626
+ | 1 — `tmp_path` env redirect | Filesystem | Zero | Always | Default for all tests |
627
+ | 2 — Job Object | Process tree | Low | Always | Prevent child-process escape |
628
+ | 3 — Windows Sandbox | Full OS | Medium | Needs Pro/Enterprise image | Nightly clean-room runs |
629
+
630
+ ### Prevent hanging tests
631
+
632
+ Add `pytest-timeout` to cap any single test. In `pytest.ini` set `timeout = 60` and `timeout_method = thread`. Note: `thread` method cannot kill Qt app subprocesses on Windows — add `atexit.register(lambda: [p.kill() for p in psutil.Process().children(recursive=True)])` in `conftest.py` to reap orphans.
633
+
634
+ ## CI/CD Integration
635
+
636
+ ```yaml
637
+ # .github/workflows/e2e-desktop.yml
638
+ name: Desktop E2E
639
+ on: [push, pull_request]
640
+
641
+ jobs:
642
+ e2e:
643
+ runs-on: windows-latest # real GUI environment, no Xvfb needed
644
+ steps:
645
+ - uses: actions/checkout@v4
646
+
647
+ - uses: actions/setup-python@v5
648
+ with: { python-version: "3.11" }
649
+
650
+ - name: Install deps
651
+ run: pip install pywinauto pytest pytest-html Pillow
652
+
653
+ - name: Build app
654
+ run: cmake --build build --config Release # adjust to your build system
655
+
656
+ - name: Run E2E
657
+ env:
658
+ APP_PATH: ${{ github.workspace }}\build\Release\MyApp.exe
659
+ APP_TITLE: "My Application"
660
+ CI: "true"
661
+ run: pytest tests/ --html=artifacts/report.html --self-contained-html --junitxml=artifacts/results.xml -v
662
+
663
+ - uses: actions/upload-artifact@v4
664
+ if: always()
665
+ with:
666
+ name: e2e-artifacts
667
+ path: artifacts/
668
+ retention-days: 14
669
+ ```
670
+
671
+ ## Qt Specific
672
+
673
+ ### Enable UIA in Qt 5.x
674
+
675
+ Qt 5.x accessibility is disabled by default in some builds (especially 5.7–5.14). Set the environment variable **before** launching. Qt 6.x enables accessibility by default — skip this step for Qt 6.
676
+
677
+ ```python
678
+ # conftest.py — add at module top
679
+ import os
680
+ os.environ["QT_ACCESSIBILITY"] = "1"
681
+ ```
682
+
683
+ Or export it in CI:
684
+
685
+ ```yaml
686
+ env:
687
+ QT_ACCESSIBILITY: "1"
688
+ ```
689
+
690
+ ### Add Stable Identifiers to Qt Widgets
691
+
692
+ ```cpp
693
+ // Preferred: both objectName and accessibleName
694
+ void setTestId(QWidget* w, const char* id) {
695
+ w->setObjectName(id);
696
+ w->setAccessibleName(id); // becomes UIA Name property
697
+ }
698
+
699
+ // In your dialog constructor:
700
+ setTestId(ui->usernameEdit, "usernameInput");
701
+ setTestId(ui->passwordEdit, "passwordInput");
702
+ setTestId(ui->loginButton, "btnLogin");
703
+ setTestId(ui->errorLabel, "lblError");
704
+ ```
705
+
706
+ Centralise all IDs in a header to avoid typos:
707
+
708
+ ```cpp
709
+ // test_ids.h
710
+ #define TID_USERNAME "usernameInput"
711
+ #define TID_PASSWORD "passwordInput"
712
+ #define TID_BTN_LOGIN "btnLogin"
713
+ #define TID_LBL_ERROR "lblError"
714
+ ```
715
+
716
+ ### Qt-Specific Quirks
717
+
718
+ **QComboBox** — the dropdown is a separate top-level window:
719
+
720
+ ```python
721
+ from pywinauto import Desktop
722
+
723
+ def select_combo_item(page, combo_spec, item_text):
724
+ page.click(combo_spec)
725
+ # Dropdown appears as a new root-level window
726
+ # class_name varies by Qt version — verify with Accessibility Insights
727
+ # Qt 5.x: "Qt5QWindowIcon" | Qt 6.x: "Qt6QWindowIcon" — verify with Accessibility Insights
728
+ popup = Desktop(backend="uia").window(class_name_re="Qt[56]QWindowIcon")
729
+ popup.wait("visible", timeout=5)
730
+ popup.child_window(title=item_text).click_input()
731
+ ```
732
+
733
+ **QMessageBox / QDialog** — also separate top-level windows:
734
+
735
+ ```python
736
+ dlg = page.wait_window("Confirm") # wait for dialog title
737
+ dlg.child_window(title="OK").click_input() # click button inside it
738
+ ```
739
+
740
+ **QTableWidget / QTableView** — row/cell access:
741
+
742
+ ```python
743
+ table = page.by_id("tblUsers").wrapper_object()
744
+ cell = table.cell(row=0, column=1)
745
+ print(cell.window_text())
746
+ ```
747
+
748
+ **Self-drawn controls** (`paintEvent`-only, `QGraphicsView`, `QOpenGLWidget`) — UIA cannot see their internals. Use the Fallback section below.
749
+
750
+ ## Fallback: Screenshot Mode
751
+
752
+ When a control is not reachable via UIA (self-drawn, third-party, game engine):
753
+
754
+ ```bash
755
+ pip install pyautogui Pillow opencv-python
756
+ ```
757
+
758
+ ```python
759
+ import pyautogui, cv2, numpy as np
760
+ from PIL import Image
761
+
762
+ def find_image_on_screen(template_path, confidence=0.85):
763
+ """Locate a template image on screen. Returns (x, y) center or None."""
764
+ screen = np.array(pyautogui.screenshot())
765
+ template = np.array(Image.open(template_path))
766
+ result = cv2.matchTemplate(
767
+ cv2.cvtColor(screen, cv2.COLOR_RGB2BGR),
768
+ cv2.cvtColor(template, cv2.COLOR_RGB2BGR),
769
+ cv2.TM_CCOEFF_NORMED,
770
+ )
771
+ _, max_val, _, max_loc = cv2.minMaxLoc(result)
772
+ if max_val >= confidence:
773
+ h, w = template.shape[:2]
774
+ return max_loc[0] + w // 2, max_loc[1] + h // 2
775
+ return None
776
+
777
+ def click_image(template_path, confidence=0.85):
778
+ pos = find_image_on_screen(template_path, confidence)
779
+ if pos is None:
780
+ raise RuntimeError(f"Image not found on screen: {template_path}")
781
+ pyautogui.click(*pos)
782
+ ```
783
+
784
+ ### DPI / Scaling Rules (screenshot mode only)
785
+
786
+ Screenshot matching is brutally sensitive to Windows display scaling (100% / 125% / 150%). Three hard rules:
787
+
788
+ 1. **Capture templates at the same scale as the target machine.** Don't try to rescue a mismatch with `PIL.Image.resize` — `cv2.matchTemplate` is very fragile against resampling artefacts.
789
+ 2. **Pin the CI display scaling.** On `windows-latest` add a step like `Set-DisplayResolution 1920 1080 -Force` and disable per-monitor DPI scaling, so screenshot dimensions are reproducible.
790
+ 3. **Record the scale alongside each artefact.** On capture, write `GetDpiForWindow(hwnd) / 96` to `artifacts/<test>/metadata.json` — postmortems become obvious instead of guess-work.
791
+
792
+ > Process-level DPI awareness (`SetProcessDpiAwarenessContext`) **can conflict with Qt's own DPI handling** when the app under test is Qt-based. Prefer "same-scale templates + CI pin" over flipping process-wide DPI mode in fixtures.
793
+
794
+ ### Debugging Match Confidence
795
+
796
+ When tuning the `confidence` threshold, the only sane workflow is to **see** where the match landed. The helper below is diagnosis-only — do not call it from test code.
797
+
798
+ ```python
799
+ def debug_match(template_path, out="artifacts/match_debug.png", confidence=0.85):
800
+ """Diagnosis-only. Draw the best-match rectangle + score back on the current screen.
801
+
802
+ NOT for production tests — use when calibrating confidence or chasing false matches.
803
+ """
804
+ import os, cv2, pyautogui, numpy as np
805
+ screen = np.array(pyautogui.screenshot())[:, :, ::-1]
806
+ tpl = cv2.imread(template_path)
807
+ if tpl is None:
808
+ raise RuntimeError(f"Template unreadable: {template_path}")
809
+ res = cv2.matchTemplate(screen, tpl, cv2.TM_CCOEFF_NORMED)
810
+ _, mv, _, ml = cv2.minMaxLoc(res)
811
+ h, w = tpl.shape[:2]
812
+ colour = (0, 255, 0) if mv >= confidence else (0, 0, 255) # green pass / red fail
813
+ cv2.rectangle(screen, ml, (ml[0]+w, ml[1]+h), colour, 2)
814
+ cv2.putText(screen, f"score={mv:.3f} thr={confidence}",
815
+ (ml[0], max(20, ml[1]-6)),
816
+ cv2.FONT_HERSHEY_SIMPLEX, 0.7, colour, 2)
817
+ os.makedirs(os.path.dirname(out) or ".", exist_ok=True)
818
+ cv2.imwrite(out, screen)
819
+ return mv
820
+ ```
821
+
822
+ **Use sparingly** — image matching breaks on DPI changes, theme switches, and partial occlusion.
823
+ Always try UIA first; fall back to screenshots only for genuinely unreachable controls.
824
+
825
+ ## Anti-Patterns
826
+
827
+ ```python
828
+ # BAD: fixed sleep
829
+ time.sleep(3)
830
+ page.click(page.by_id("btnSubmit"))
831
+
832
+ # GOOD: condition wait
833
+ page.wait_visible(page.by_id("btnSubmit"))
834
+ page.click(page.by_id("btnSubmit"))
835
+ ```
836
+
837
+ ```python
838
+ # BAD: brittle class+index locator as primary strategy
839
+ page.by_class("Edit", index=2).type_keys("hello")
840
+
841
+ # GOOD: AutomationId
842
+ page.by_id("usernameInput").set_edit_text("hello")
843
+ ```
844
+
845
+ ```python
846
+ # BAD: assert on pixel coordinates
847
+ assert btn.rectangle().left == 120
848
+
849
+ # GOOD: assert on content / state
850
+ assert page.get_text(page.by_id("lblStatus")) == "Logged in"
851
+ assert page.by_id("btnLogout").is_enabled()
852
+ ```
853
+
854
+ ```python
855
+ # BAD: share app instance across all tests (state leaks)
856
+ @pytest.fixture(scope="session")
857
+ def app(): ...
858
+
859
+ # GOOD: fresh process per test (or per class at most)
860
+ @pytest.fixture(scope="function")
861
+ def app(): ...
862
+ ```
863
+
864
+ ## Running Tests
865
+
866
+ ```bash
867
+ # All tests
868
+ pytest tests/ -v
869
+
870
+ # Smoke only
871
+ pytest tests/ -m smoke -v
872
+
873
+ # Specific file
874
+ pytest tests/test_login.py -v
875
+
876
+ # With custom app path
877
+ APP_PATH="C:\build\Release\MyApp.exe" APP_TITLE="MyApp" pytest tests/ -v
878
+
879
+ # Detect flaky tests (repeat each 5 times)
880
+ pip install pytest-repeat
881
+ pytest tests/test_login.py --count=5 -v
882
+ ```
883
+
884
+ ## Related Skills
885
+
886
+ - `e2e-testing` — Playwright E2E for web applications
887
+ - `cpp-testing` — C++ unit/integration testing with GoogleTest
888
+ - `cpp-coding-standards` — C++ code style and patterns