codeply-cli 0.5.6 → 0.6.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 (429) hide show
  1. package/LICENSE +21 -21
  2. package/THIRD_PARTY_NOTICES.md +65 -65
  3. package/bin/codeply.js +8 -3
  4. package/lib/agent.mjs +2596 -2268
  5. package/lib/ai.js +135 -27
  6. package/lib/ai.mjs +6 -6
  7. package/lib/apply-patch.js +217 -217
  8. package/lib/arity-table.json +138 -138
  9. package/lib/arity.js +70 -70
  10. package/lib/auth.mjs +6 -6
  11. package/lib/autopilot.js +84 -0
  12. package/lib/bot-mail.js +46 -0
  13. package/lib/bots.js +142 -15
  14. package/lib/brain.js +914 -0
  15. package/lib/call-assist.js +120 -0
  16. package/lib/chatgpt.js +282 -282
  17. package/lib/cloud-browser.mjs +143 -143
  18. package/lib/cloud.mjs +1396 -1320
  19. package/lib/commands.js +103 -103
  20. package/lib/computer.js +136 -0
  21. package/lib/design-library/assemble-artifact.mjs +21 -21
  22. package/lib/design-library/cleanup.mjs +45 -45
  23. package/lib/design-library/index.json +22379 -22379
  24. package/lib/design-library/make-table-data.mjs +39 -39
  25. package/lib/design-tools.mjs +173 -0
  26. package/lib/diagnostics.js +192 -192
  27. package/lib/dsh-acp.mjs +444 -0
  28. package/lib/edit-engine.js +364 -364
  29. package/lib/github-agent.mjs +326 -326
  30. package/lib/handoff.mjs +245 -0
  31. package/lib/history.js +78 -75
  32. package/lib/life-sources.js +319 -0
  33. package/lib/life-store.js +356 -0
  34. package/lib/life-triggers.js +286 -0
  35. package/lib/life.js +487 -0
  36. package/lib/mail-watch.js +3 -3
  37. package/lib/mcp.js +258 -258
  38. package/lib/native-tools.mjs +17 -5
  39. package/lib/oauth-connectors.js +76 -21
  40. package/lib/permissions.js +109 -109
  41. package/lib/plugins.js +356 -353
  42. package/lib/reach.js +67 -67
  43. package/lib/render-md.mjs +647 -617
  44. package/lib/screen.js +77 -0
  45. package/lib/server.mjs +458 -457
  46. package/lib/session-db.js +220 -220
  47. package/lib/share.js +208 -168
  48. package/lib/skills.js +4 -1
  49. package/lib/snapshot.js +146 -146
  50. package/lib/subagents.js +4 -2
  51. package/lib/telemetry.js +105 -105
  52. package/lib/terminal-hints.js +154 -154
  53. package/lib/textarea.mjs +264 -258
  54. package/lib/tools.mjs +326 -40
  55. package/lib/tui.mjs +1459 -1086
  56. package/lib/typecheck-worker.js +147 -147
  57. package/lib/web-tools.js +209 -209
  58. package/package.json +1 -1
  59. package/skills/SOURCE.md +58 -58
  60. package/skills/accessibility/SKILL.md +147 -147
  61. package/skills/agent-architecture-audit/SKILL.md +257 -257
  62. package/skills/agent-eval/SKILL.md +147 -147
  63. package/skills/agent-harness-construction/SKILL.md +74 -74
  64. package/skills/agent-introspection-debugging/SKILL.md +154 -154
  65. package/skills/agent-payment-x402/SKILL.md +225 -225
  66. package/skills/agent-self-evaluation/SKILL.md +182 -182
  67. package/skills/agent-self-evaluation/references/evaluation-criteria.md +71 -71
  68. package/skills/agent-self-evaluation/references/hook-integration.md +64 -64
  69. package/skills/agent-sort/SKILL.md +216 -216
  70. package/skills/agentic-engineering/SKILL.md +64 -64
  71. package/skills/agentic-os/SKILL.md +388 -388
  72. package/skills/ai-first-engineering/SKILL.md +52 -52
  73. package/skills/ai-regression-testing/SKILL.md +386 -386
  74. package/skills/android-clean-architecture/SKILL.md +340 -340
  75. package/skills/angular-developer/SKILL.md +155 -155
  76. package/skills/angular-developer/references/angular-animations.md +160 -160
  77. package/skills/angular-developer/references/angular-aria.md +410 -410
  78. package/skills/angular-developer/references/cli.md +86 -86
  79. package/skills/angular-developer/references/component-harnesses.md +59 -59
  80. package/skills/angular-developer/references/component-styling.md +91 -91
  81. package/skills/angular-developer/references/components.md +117 -117
  82. package/skills/angular-developer/references/creating-services.md +97 -97
  83. package/skills/angular-developer/references/data-resolvers.md +69 -69
  84. package/skills/angular-developer/references/define-routes.md +67 -67
  85. package/skills/angular-developer/references/defining-providers.md +72 -72
  86. package/skills/angular-developer/references/di-fundamentals.md +120 -120
  87. package/skills/angular-developer/references/e2e-testing.md +56 -56
  88. package/skills/angular-developer/references/effects.md +83 -83
  89. package/skills/angular-developer/references/hierarchical-injectors.md +43 -43
  90. package/skills/angular-developer/references/host-elements.md +80 -80
  91. package/skills/angular-developer/references/injection-context.md +63 -63
  92. package/skills/angular-developer/references/inputs.md +101 -101
  93. package/skills/angular-developer/references/linked-signal.md +59 -59
  94. package/skills/angular-developer/references/loading-strategies.md +61 -61
  95. package/skills/angular-developer/references/mcp.md +108 -108
  96. package/skills/angular-developer/references/navigate-to-routes.md +69 -69
  97. package/skills/angular-developer/references/outputs.md +86 -86
  98. package/skills/angular-developer/references/reactive-forms.md +122 -122
  99. package/skills/angular-developer/references/rendering-strategies.md +44 -44
  100. package/skills/angular-developer/references/resource.md +77 -77
  101. package/skills/angular-developer/references/route-animations.md +56 -56
  102. package/skills/angular-developer/references/route-guards.md +52 -52
  103. package/skills/angular-developer/references/router-lifecycle.md +45 -45
  104. package/skills/angular-developer/references/router-testing.md +87 -87
  105. package/skills/angular-developer/references/show-routes-with-outlets.md +68 -68
  106. package/skills/angular-developer/references/signal-forms.md +795 -795
  107. package/skills/angular-developer/references/signals-overview.md +94 -94
  108. package/skills/angular-developer/references/tailwind-css.md +69 -69
  109. package/skills/angular-developer/references/template-driven-forms.md +114 -114
  110. package/skills/angular-developer/references/testing-fundamentals.md +65 -65
  111. package/skills/api-connector-builder/SKILL.md +121 -121
  112. package/skills/api-design/SKILL.md +524 -524
  113. package/skills/architecture-decision-records/SKILL.md +180 -180
  114. package/skills/article-writing/SKILL.md +80 -80
  115. package/skills/automation-audit-ops/SKILL.md +143 -143
  116. package/skills/autonomous-agent-harness/SKILL.md +274 -274
  117. package/skills/autonomous-loops/SKILL.md +611 -611
  118. package/skills/backend-patterns/SKILL.md +562 -562
  119. package/skills/benchmark/SKILL.md +95 -95
  120. package/skills/benchmark-methodology/SKILL.md +191 -191
  121. package/skills/benchmark-optimization-loop/SKILL.md +71 -71
  122. package/skills/blender-motion-state-inspection/SKILL.md +165 -165
  123. package/skills/blueprint/SKILL.md +106 -106
  124. package/skills/brand-discovery/SKILL.md +145 -145
  125. package/skills/brand-discovery/references/10_purpose-why.md +40 -40
  126. package/skills/brand-discovery/references/20_positioning.md +44 -44
  127. package/skills/brand-discovery/references/30_audience-niche.md +52 -52
  128. package/skills/brand-discovery/references/40_personality-archetype.md +57 -57
  129. package/skills/brand-discovery/references/50_voice-tone.md +59 -59
  130. package/skills/brand-discovery/references/60_narrative-story.md +50 -50
  131. package/skills/brand-discovery/references/70_founder-tension.md +49 -49
  132. package/skills/brand-discovery/references/90_SYNTHESIS.md +133 -133
  133. package/skills/brand-voice/SKILL.md +98 -98
  134. package/skills/brand-voice/references/voice-profile-schema.md +55 -55
  135. package/skills/browser-qa/SKILL.md +105 -105
  136. package/skills/bun-runtime/SKILL.md +85 -85
  137. package/skills/canary-watch/SKILL.md +108 -108
  138. package/skills/carrier-relationship-management/SKILL.md +212 -212
  139. package/skills/cisco-ios-patterns/SKILL.md +164 -164
  140. package/skills/ck/SKILL.md +148 -148
  141. package/skills/claude-devfleet/SKILL.md +112 -112
  142. package/skills/click-path-audit/SKILL.md +245 -245
  143. package/skills/clickhouse-io/SKILL.md +445 -445
  144. package/skills/code-tour/SKILL.md +254 -254
  145. package/skills/codebase-onboarding/SKILL.md +234 -234
  146. package/skills/codehealth-mcp/SKILL.md +167 -167
  147. package/skills/codeply-taste/LICENSE +21 -0
  148. package/skills/codeply-taste/SKILL.md +100 -0
  149. package/skills/codeply-taste/SOURCE.md +10 -0
  150. package/skills/codeply-taste/assets/base.css +100 -0
  151. package/skills/codeply-taste/assets/base.js +37 -0
  152. package/skills/codeply-taste/library/directions.json +1078 -0
  153. package/skills/codeply-taste/library/heroes.json +894 -0
  154. package/skills/codeply-taste/library/motions.json +57 -0
  155. package/skills/codeply-taste/library/palettes.json +1485 -0
  156. package/skills/codeply-taste/library/photos.json +7240 -0
  157. package/skills/codeply-taste/library/sections.json +4136 -0
  158. package/skills/codeply-taste/library/sites.json +7274 -0
  159. package/skills/codeply-taste/library/type.json +2024 -0
  160. package/skills/codeply-taste/references/colour.md +141 -0
  161. package/skills/codeply-taste/references/copy.md +177 -0
  162. package/skills/codeply-taste/references/critique.md +171 -0
  163. package/skills/codeply-taste/references/imagery.md +377 -0
  164. package/skills/codeply-taste/references/layout.md +178 -0
  165. package/skills/codeply-taste/references/motion.md +292 -0
  166. package/skills/codeply-taste/references/research.md +306 -0
  167. package/skills/codeply-taste/references/tells.md +115 -0
  168. package/skills/codeply-taste/references/type.md +170 -0
  169. package/skills/codeply-taste/scripts/assets.mjs +865 -0
  170. package/skills/codeply-taste/scripts/draw.mjs +525 -0
  171. package/skills/codeply-taste/scripts/inspect.mjs +205 -0
  172. package/skills/codeply-taste/scripts/lib/cdp.mjs +205 -0
  173. package/skills/codeply-taste/scripts/lib/probe.mjs +569 -0
  174. package/skills/codeply-taste/scripts/lib/rules.mjs +137 -0
  175. package/skills/codeply-taste/scripts/lint.mjs +108 -0
  176. package/skills/coding-standards/SKILL.md +551 -551
  177. package/skills/competitive-platform-analysis/SKILL.md +214 -214
  178. package/skills/competitive-report-structure/SKILL.md +162 -162
  179. package/skills/compose-multiplatform-patterns/SKILL.md +300 -300
  180. package/skills/config-gc/SKILL.md +120 -120
  181. package/skills/configure-ecc/SKILL.md +385 -385
  182. package/skills/connections-optimizer/SKILL.md +190 -190
  183. package/skills/content-engine/SKILL.md +132 -132
  184. package/skills/content-hash-cache-pattern/SKILL.md +162 -162
  185. package/skills/context-budget/SKILL.md +136 -136
  186. package/skills/continuous-agent-loop/SKILL.md +46 -46
  187. package/skills/continuous-learning/SKILL.md +132 -132
  188. package/skills/continuous-learning-v2/SKILL.md +361 -361
  189. package/skills/contract-first/SKILL.md +287 -287
  190. package/skills/cost-aware-llm-pipeline/SKILL.md +184 -184
  191. package/skills/cost-tracking/SKILL.md +97 -97
  192. package/skills/council/SKILL.md +204 -204
  193. package/skills/cpp-coding-standards/SKILL.md +724 -724
  194. package/skills/cpp-testing/SKILL.md +325 -325
  195. package/skills/crosspost/SKILL.md +112 -112
  196. package/skills/csharp-testing/SKILL.md +322 -322
  197. package/skills/customer-billing-ops/SKILL.md +141 -141
  198. package/skills/customs-trade-compliance/SKILL.md +263 -263
  199. package/skills/dart-flutter-patterns/SKILL.md +564 -564
  200. package/skills/dashboard-builder/SKILL.md +109 -109
  201. package/skills/data-scraper-agent/SKILL.md +765 -765
  202. package/skills/data-throughput-accelerator/SKILL.md +74 -74
  203. package/skills/database-migrations/SKILL.md +430 -430
  204. package/skills/deep-research/SKILL.md +160 -160
  205. package/skills/defi-amm-security/SKILL.md +167 -167
  206. package/skills/delivery-gate/SKILL.md +126 -126
  207. package/skills/deployment-patterns/SKILL.md +428 -428
  208. package/skills/design-system/SKILL.md +83 -83
  209. package/skills/django-celery/SKILL.md +458 -458
  210. package/skills/django-patterns/SKILL.md +735 -735
  211. package/skills/django-security/SKILL.md +644 -644
  212. package/skills/django-tdd/SKILL.md +730 -730
  213. package/skills/django-verification/SKILL.md +470 -470
  214. package/skills/dmux-workflows/SKILL.md +192 -192
  215. package/skills/docker-patterns/SKILL.md +365 -365
  216. package/skills/documentation-lookup/SKILL.md +91 -91
  217. package/skills/dotnet-patterns/SKILL.md +322 -322
  218. package/skills/dynamic-workflow-mode/SKILL.md +124 -124
  219. package/skills/e2e-testing/SKILL.md +327 -327
  220. package/skills/ecc-guide/SKILL.md +190 -190
  221. package/skills/ecc-recipes/SKILL.md +149 -149
  222. package/skills/ecc-tools-cost-audit/SKILL.md +161 -161
  223. package/skills/email-ops/SKILL.md +122 -122
  224. package/skills/energy-procurement/SKILL.md +228 -228
  225. package/skills/enterprise-agent-ops/SKILL.md +51 -51
  226. package/skills/error-handling/SKILL.md +377 -377
  227. package/skills/eval-harness/SKILL.md +271 -271
  228. package/skills/evm-token-decimals/SKILL.md +131 -131
  229. package/skills/exa-search/SKILL.md +108 -108
  230. package/skills/fal-ai-media/SKILL.md +289 -289
  231. package/skills/fastapi-patterns/SKILL.md +514 -514
  232. package/skills/finance-billing-ops/SKILL.md +128 -128
  233. package/skills/flox-environments/SKILL.md +497 -497
  234. package/skills/flutter-dart-code-review/SKILL.md +436 -436
  235. package/skills/foundation-models-on-device/SKILL.md +243 -243
  236. package/skills/frontend-a11y/SKILL.md +446 -446
  237. package/skills/frontend-design-direction/SKILL.md +93 -93
  238. package/skills/frontend-patterns/SKILL.md +657 -657
  239. package/skills/frontend-slides/SKILL.md +185 -185
  240. package/skills/fsharp-testing/SKILL.md +281 -281
  241. package/skills/gan-style-harness/SKILL.md +279 -279
  242. package/skills/gateguard/SKILL.md +133 -133
  243. package/skills/generating-python-installer/SKILL.md +820 -820
  244. package/skills/git-workflow/SKILL.md +716 -716
  245. package/skills/github-ops/SKILL.md +145 -145
  246. package/skills/golang-patterns/SKILL.md +676 -676
  247. package/skills/golang-testing/SKILL.md +721 -721
  248. package/skills/google-workspace-ops/SKILL.md +96 -96
  249. package/skills/growth-log/SKILL.md +128 -128
  250. package/skills/healthcare-cdss-patterns/SKILL.md +246 -246
  251. package/skills/healthcare-emr-patterns/SKILL.md +160 -160
  252. package/skills/healthcare-eval-harness/SKILL.md +208 -208
  253. package/skills/healthcare-phi-compliance/SKILL.md +146 -146
  254. package/skills/hermes-imports/SKILL.md +89 -89
  255. package/skills/hexagonal-architecture/SKILL.md +277 -277
  256. package/skills/hipaa-compliance/SKILL.md +79 -79
  257. package/skills/homelab-network-readiness/SKILL.md +170 -170
  258. package/skills/homelab-network-setup/SKILL.md +130 -130
  259. package/skills/homelab-pihole-dns/SKILL.md +275 -275
  260. package/skills/homelab-vlan-segmentation/SKILL.md +312 -312
  261. package/skills/homelab-wireguard-vpn/SKILL.md +306 -306
  262. package/skills/hookify-rules/SKILL.md +128 -128
  263. package/skills/inherit-legacy-style/SKILL.md +157 -157
  264. package/skills/intent-driven-development/SKILL.md +360 -360
  265. package/skills/inventory-demand-planning/SKILL.md +247 -247
  266. package/skills/investor-materials/SKILL.md +97 -97
  267. package/skills/investor-outreach/SKILL.md +92 -92
  268. package/skills/ios-icon-gen/SKILL.md +158 -158
  269. package/skills/iterative-retrieval/SKILL.md +212 -212
  270. package/skills/ito-basket-compare/SKILL.md +64 -64
  271. package/skills/ito-compute/SKILL.md +129 -129
  272. package/skills/ito-data-atlas-agent/SKILL.md +64 -64
  273. package/skills/ito-market-intelligence/SKILL.md +61 -61
  274. package/skills/ito-trade-planner/SKILL.md +68 -68
  275. package/skills/java-coding-standards/SKILL.md +384 -384
  276. package/skills/jira-integration/SKILL.md +303 -303
  277. package/skills/jpa-patterns/SKILL.md +152 -152
  278. package/skills/knowledge-ops/SKILL.md +155 -155
  279. package/skills/kotlin-coroutines-flows/SKILL.md +285 -285
  280. package/skills/kotlin-exposed-patterns/SKILL.md +720 -720
  281. package/skills/kotlin-ktor-patterns/SKILL.md +690 -690
  282. package/skills/kotlin-patterns/SKILL.md +712 -712
  283. package/skills/kotlin-testing/SKILL.md +825 -825
  284. package/skills/kubernetes-patterns/SKILL.md +756 -756
  285. package/skills/laravel-patterns/SKILL.md +416 -416
  286. package/skills/laravel-plugin-discovery/SKILL.md +230 -230
  287. package/skills/laravel-security/SKILL.md +948 -948
  288. package/skills/laravel-tdd/SKILL.md +675 -675
  289. package/skills/laravel-verification/SKILL.md +180 -180
  290. package/skills/latency-critical-systems/SKILL.md +75 -75
  291. package/skills/lead-intelligence/SKILL.md +322 -322
  292. package/skills/liquid-glass-design/SKILL.md +279 -279
  293. package/skills/llm-trading-agent-security/SKILL.md +147 -147
  294. package/skills/logistics-exception-management/SKILL.md +222 -222
  295. package/skills/loop-design-check/SKILL.md +143 -143
  296. package/skills/mailtrap-email-integration/SKILL.md +77 -77
  297. package/skills/make-interfaces-feel-better/SKILL.md +152 -152
  298. package/skills/manim-video/SKILL.md +90 -90
  299. package/skills/market-research/SKILL.md +76 -76
  300. package/skills/marketing-campaign/SKILL.md +114 -114
  301. package/skills/mcp-server-patterns/SKILL.md +70 -70
  302. package/skills/messages-ops/SKILL.md +105 -105
  303. package/skills/ml-adoption-playbook/SKILL.md +57 -57
  304. package/skills/mle-workflow/SKILL.md +348 -348
  305. package/skills/motion-advanced/SKILL.md +596 -596
  306. package/skills/motion-foundations/SKILL.md +299 -299
  307. package/skills/motion-patterns/SKILL.md +434 -434
  308. package/skills/motion-ui/SKILL.md +576 -576
  309. package/skills/mysql-patterns/SKILL.md +413 -413
  310. package/skills/nanoclaw-repl/SKILL.md +34 -34
  311. package/skills/nestjs-patterns/SKILL.md +231 -231
  312. package/skills/netmiko-ssh-automation/SKILL.md +174 -174
  313. package/skills/network-bgp-diagnostics/SKILL.md +168 -168
  314. package/skills/network-config-validation/SKILL.md +211 -211
  315. package/skills/network-interface-health/SKILL.md +153 -153
  316. package/skills/nextjs-turbopack/SKILL.md +58 -58
  317. package/skills/nodejs-keccak256/SKILL.md +103 -103
  318. package/skills/nutrient-document-processing/SKILL.md +168 -168
  319. package/skills/nuxt4-patterns/SKILL.md +101 -101
  320. package/skills/openclaw-persona-forge/SKILL.md +289 -289
  321. package/skills/openclaw-persona-forge/references/avatar-style.md +124 -124
  322. package/skills/openclaw-persona-forge/references/boundary-rules.md +53 -53
  323. package/skills/openclaw-persona-forge/references/error-handling.md +53 -53
  324. package/skills/openclaw-persona-forge/references/identity-tension.md +48 -48
  325. package/skills/openclaw-persona-forge/references/naming-system.md +39 -39
  326. package/skills/openclaw-persona-forge/references/output-template.md +166 -166
  327. package/skills/opensource-pipeline/SKILL.md +256 -256
  328. package/skills/orch-add-feature/SKILL.md +45 -45
  329. package/skills/orch-build-mvp/SKILL.md +49 -49
  330. package/skills/orch-change-feature/SKILL.md +43 -43
  331. package/skills/orch-fix-defect/SKILL.md +43 -43
  332. package/skills/orch-pipeline/SKILL.md +121 -121
  333. package/skills/orch-refine-code/SKILL.md +44 -44
  334. package/skills/parallel-execution-optimizer/SKILL.md +74 -74
  335. package/skills/perl-patterns/SKILL.md +505 -505
  336. package/skills/perl-security/SKILL.md +504 -504
  337. package/skills/perl-testing/SKILL.md +476 -476
  338. package/skills/plan-canvas/SKILL.md +153 -153
  339. package/skills/plan-orchestrate/SKILL.md +263 -263
  340. package/skills/plankton-code-quality/SKILL.md +237 -237
  341. package/skills/postgres-patterns/SKILL.md +148 -148
  342. package/skills/prediction-market-oracle-research/SKILL.md +64 -64
  343. package/skills/prediction-market-risk-review/SKILL.md +61 -61
  344. package/skills/premium-web-design/SKILL.md +154 -154
  345. package/skills/prisma-patterns/SKILL.md +401 -401
  346. package/skills/product-capability/SKILL.md +142 -142
  347. package/skills/product-lens/SKILL.md +93 -93
  348. package/skills/production-audit/SKILL.md +207 -207
  349. package/skills/production-scheduling/SKILL.md +238 -238
  350. package/skills/project-flow-ops/SKILL.md +112 -112
  351. package/skills/prompt-optimizer/SKILL.md +398 -398
  352. package/skills/python-patterns/SKILL.md +751 -751
  353. package/skills/python-testing/SKILL.md +817 -817
  354. package/skills/pytorch-patterns/SKILL.md +397 -397
  355. package/skills/quality-nonconformance/SKILL.md +260 -260
  356. package/skills/quarkus-patterns/SKILL.md +723 -723
  357. package/skills/quarkus-security/SKILL.md +468 -468
  358. package/skills/quarkus-tdd/SKILL.md +812 -812
  359. package/skills/quarkus-verification/SKILL.md +480 -480
  360. package/skills/ralphinho-rfc-pipeline/SKILL.md +68 -68
  361. package/skills/react-native-patterns/SKILL.md +326 -326
  362. package/skills/react-patterns/SKILL.md +342 -342
  363. package/skills/react-performance/SKILL.md +575 -575
  364. package/skills/react-testing/SKILL.md +424 -424
  365. package/skills/recsys-pipeline-architect/SKILL.md +115 -115
  366. package/skills/recursive-decision-ledger/SKILL.md +81 -81
  367. package/skills/redis-patterns/SKILL.md +404 -404
  368. package/skills/regex-vs-llm-structured-text/SKILL.md +221 -221
  369. package/skills/remotion-video-creation/SKILL.md +43 -43
  370. package/skills/repo-scan/SKILL.md +79 -79
  371. package/skills/research-ops/SKILL.md +113 -113
  372. package/skills/returns-reverse-logistics/SKILL.md +240 -240
  373. package/skills/rules-distill/SKILL.md +265 -265
  374. package/skills/rust-patterns/SKILL.md +500 -500
  375. package/skills/rust-testing/SKILL.md +501 -501
  376. package/skills/safety-guard/SKILL.md +76 -76
  377. package/skills/santa-method/SKILL.md +307 -307
  378. package/skills/scientific-db-pubmed-database/SKILL.md +176 -176
  379. package/skills/scientific-db-uspto-database/SKILL.md +178 -178
  380. package/skills/scientific-pkg-gget/SKILL.md +167 -167
  381. package/skills/scientific-thinking-literature-review/SKILL.md +193 -193
  382. package/skills/scientific-thinking-scholar-evaluation/SKILL.md +161 -161
  383. package/skills/search-first/SKILL.md +183 -183
  384. package/skills/security-bounty-hunter/SKILL.md +100 -100
  385. package/skills/security-review/SKILL.md +504 -504
  386. package/skills/security-scan/SKILL.md +166 -166
  387. package/skills/seo/SKILL.md +155 -155
  388. package/skills/skill-comply/SKILL.md +59 -59
  389. package/skills/skill-scout/SKILL.md +141 -141
  390. package/skills/skill-stocktake/SKILL.md +195 -195
  391. package/skills/social-graph-ranker/SKILL.md +155 -155
  392. package/skills/social-publisher/SKILL.md +130 -130
  393. package/skills/springboot-patterns/SKILL.md +315 -315
  394. package/skills/springboot-security/SKILL.md +273 -273
  395. package/skills/springboot-tdd/SKILL.md +159 -159
  396. package/skills/springboot-verification/SKILL.md +232 -232
  397. package/skills/strategic-compact/SKILL.md +142 -142
  398. package/skills/swift-actor-persistence/SKILL.md +144 -144
  399. package/skills/swift-concurrency-6-2/SKILL.md +216 -216
  400. package/skills/swift-protocol-di-testing/SKILL.md +191 -191
  401. package/skills/swiftui-patterns/SKILL.md +259 -259
  402. package/skills/taste/SKILL.md +264 -264
  403. package/skills/taste/references/genre-taxonomy.md +87 -87
  404. package/skills/tdd-workflow/SKILL.md +583 -583
  405. package/skills/team-agent-orchestration/SKILL.md +111 -111
  406. package/skills/team-builder/SKILL.md +169 -169
  407. package/skills/terminal-ops/SKILL.md +110 -110
  408. package/skills/tinystruct-patterns/SKILL.md +279 -279
  409. package/skills/tinystruct-patterns/references/architecture.md +90 -90
  410. package/skills/tinystruct-patterns/references/data-handling.md +60 -60
  411. package/skills/tinystruct-patterns/references/database.md +99 -99
  412. package/skills/tinystruct-patterns/references/routing.md +64 -64
  413. package/skills/tinystruct-patterns/references/system-usage.md +97 -97
  414. package/skills/tinystruct-patterns/references/testing.md +72 -72
  415. package/skills/token-budget-advisor/SKILL.md +134 -134
  416. package/skills/ui-demo/SKILL.md +466 -466
  417. package/skills/ui-to-vue/SKILL.md +135 -135
  418. package/skills/uncloud/SKILL.md +344 -344
  419. package/skills/unified-memory/SKILL.md +170 -170
  420. package/skills/unified-notifications-ops/SKILL.md +188 -188
  421. package/skills/verification-loop/SKILL.md +129 -129
  422. package/skills/video-editing/SKILL.md +311 -311
  423. package/skills/videodb/SKILL.md +375 -375
  424. package/skills/visa-doc-translate/SKILL.md +117 -117
  425. package/skills/vite-patterns/SKILL.md +450 -450
  426. package/skills/vue-patterns/SKILL.md +471 -471
  427. package/skills/windows-desktop-e2e/SKILL.md +888 -888
  428. package/skills/workspace-surface-audit/SKILL.md +126 -126
  429. package/skills/x-api/SKILL.md +235 -235
@@ -1,721 +1,721 @@
1
- ---
2
- name: golang-testing
3
- description: Go testing patterns including table-driven tests, subtests, benchmarks, fuzzing, and test coverage. Follows TDD methodology with idiomatic Go practices.
4
- metadata:
5
- origin: ECC
6
- ---
7
-
8
- # Go Testing Patterns
9
-
10
- Comprehensive Go testing patterns for writing reliable, maintainable tests following TDD methodology.
11
-
12
- ## When to Activate
13
-
14
- - Writing new Go functions or methods
15
- - Adding test coverage to existing code
16
- - Creating benchmarks for performance-critical code
17
- - Implementing fuzz tests for input validation
18
- - Following TDD workflow in Go projects
19
-
20
- ## TDD Workflow for Go
21
-
22
- ### The RED-GREEN-REFACTOR Cycle
23
-
24
- ```
25
- RED → Write a failing test first
26
- GREEN → Write minimal code to pass the test
27
- REFACTOR → Improve code while keeping tests green
28
- REPEAT → Continue with next requirement
29
- ```
30
-
31
- ### Step-by-Step TDD in Go
32
-
33
- ```go
34
- // Step 1: Define the interface/signature
35
- // calculator.go
36
- package calculator
37
-
38
- func Add(a, b int) int {
39
- panic("not implemented") // Placeholder
40
- }
41
-
42
- // Step 2: Write failing test (RED)
43
- // calculator_test.go
44
- package calculator
45
-
46
- import "testing"
47
-
48
- func TestAdd(t *testing.T) {
49
- got := Add(2, 3)
50
- want := 5
51
- if got != want {
52
- t.Errorf("Add(2, 3) = %d; want %d", got, want)
53
- }
54
- }
55
-
56
- // Step 3: Run test - verify FAIL
57
- // $ go test
58
- // --- FAIL: TestAdd (0.00s)
59
- // panic: not implemented
60
-
61
- // Step 4: Implement minimal code (GREEN)
62
- func Add(a, b int) int {
63
- return a + b
64
- }
65
-
66
- // Step 5: Run test - verify PASS
67
- // $ go test
68
- // PASS
69
-
70
- // Step 6: Refactor if needed, verify tests still pass
71
- ```
72
-
73
- ## Table-Driven Tests
74
-
75
- The standard pattern for Go tests. Enables comprehensive coverage with minimal code.
76
-
77
- ```go
78
- func TestAdd(t *testing.T) {
79
- tests := []struct {
80
- name string
81
- a, b int
82
- expected int
83
- }{
84
- {"positive numbers", 2, 3, 5},
85
- {"negative numbers", -1, -2, -3},
86
- {"zero values", 0, 0, 0},
87
- {"mixed signs", -1, 1, 0},
88
- {"large numbers", 1000000, 2000000, 3000000},
89
- }
90
-
91
- for _, tt := range tests {
92
- t.Run(tt.name, func(t *testing.T) {
93
- got := Add(tt.a, tt.b)
94
- if got != tt.expected {
95
- t.Errorf("Add(%d, %d) = %d; want %d",
96
- tt.a, tt.b, got, tt.expected)
97
- }
98
- })
99
- }
100
- }
101
- ```
102
-
103
- ### Table-Driven Tests with Error Cases
104
-
105
- ```go
106
- func TestParseConfig(t *testing.T) {
107
- tests := []struct {
108
- name string
109
- input string
110
- want *Config
111
- wantErr bool
112
- }{
113
- {
114
- name: "valid config",
115
- input: `{"host": "localhost", "port": 8080}`,
116
- want: &Config{Host: "localhost", Port: 8080},
117
- },
118
- {
119
- name: "invalid JSON",
120
- input: `{invalid}`,
121
- wantErr: true,
122
- },
123
- {
124
- name: "empty input",
125
- input: "",
126
- wantErr: true,
127
- },
128
- {
129
- name: "minimal config",
130
- input: `{}`,
131
- want: &Config{}, // Zero value config
132
- },
133
- }
134
-
135
- for _, tt := range tests {
136
- t.Run(tt.name, func(t *testing.T) {
137
- got, err := ParseConfig(tt.input)
138
-
139
- if tt.wantErr {
140
- if err == nil {
141
- t.Error("expected error, got nil")
142
- }
143
- return
144
- }
145
-
146
- if err != nil {
147
- t.Fatalf("unexpected error: %v", err)
148
- }
149
-
150
- if !reflect.DeepEqual(got, tt.want) {
151
- t.Errorf("got %+v; want %+v", got, tt.want)
152
- }
153
- })
154
- }
155
- }
156
- ```
157
-
158
- ## Subtests and Sub-benchmarks
159
-
160
- ### Organizing Related Tests
161
-
162
- ```go
163
- func TestUser(t *testing.T) {
164
- // Setup shared by all subtests
165
- db := setupTestDB(t)
166
-
167
- t.Run("Create", func(t *testing.T) {
168
- user := &User{Name: "Alice"}
169
- err := db.CreateUser(user)
170
- if err != nil {
171
- t.Fatalf("CreateUser failed: %v", err)
172
- }
173
- if user.ID == "" {
174
- t.Error("expected user ID to be set")
175
- }
176
- })
177
-
178
- t.Run("Get", func(t *testing.T) {
179
- user, err := db.GetUser("alice-id")
180
- if err != nil {
181
- t.Fatalf("GetUser failed: %v", err)
182
- }
183
- if user.Name != "Alice" {
184
- t.Errorf("got name %q; want %q", user.Name, "Alice")
185
- }
186
- })
187
-
188
- t.Run("Update", func(t *testing.T) {
189
- // ...
190
- })
191
-
192
- t.Run("Delete", func(t *testing.T) {
193
- // ...
194
- })
195
- }
196
- ```
197
-
198
- ### Parallel Subtests
199
-
200
- ```go
201
- func TestParallel(t *testing.T) {
202
- tests := []struct {
203
- name string
204
- input string
205
- }{
206
- {"case1", "input1"},
207
- {"case2", "input2"},
208
- {"case3", "input3"},
209
- }
210
-
211
- for _, tt := range tests {
212
- tt := tt // Capture range variable
213
- t.Run(tt.name, func(t *testing.T) {
214
- t.Parallel() // Run subtests in parallel
215
- result := Process(tt.input)
216
- // assertions...
217
- _ = result
218
- })
219
- }
220
- }
221
- ```
222
-
223
- ## Test Helpers
224
-
225
- ### Helper Functions
226
-
227
- ```go
228
- func setupTestDB(t *testing.T) *sql.DB {
229
- t.Helper() // Marks this as a helper function
230
-
231
- db, err := sql.Open("sqlite3", ":memory:")
232
- if err != nil {
233
- t.Fatalf("failed to open database: %v", err)
234
- }
235
-
236
- // Cleanup when test finishes
237
- t.Cleanup(func() {
238
- db.Close()
239
- })
240
-
241
- // Run migrations
242
- if _, err := db.Exec(schema); err != nil {
243
- t.Fatalf("failed to create schema: %v", err)
244
- }
245
-
246
- return db
247
- }
248
-
249
- func assertNoError(t *testing.T, err error) {
250
- t.Helper()
251
- if err != nil {
252
- t.Fatalf("unexpected error: %v", err)
253
- }
254
- }
255
-
256
- func assertEqual[T comparable](t *testing.T, got, want T) {
257
- t.Helper()
258
- if got != want {
259
- t.Errorf("got %v; want %v", got, want)
260
- }
261
- }
262
- ```
263
-
264
- ### Temporary Files and Directories
265
-
266
- ```go
267
- func TestFileProcessing(t *testing.T) {
268
- // Create temp directory - automatically cleaned up
269
- tmpDir := t.TempDir()
270
-
271
- // Create test file
272
- testFile := filepath.Join(tmpDir, "test.txt")
273
- err := os.WriteFile(testFile, []byte("test content"), 0644)
274
- if err != nil {
275
- t.Fatalf("failed to create test file: %v", err)
276
- }
277
-
278
- // Run test
279
- result, err := ProcessFile(testFile)
280
- if err != nil {
281
- t.Fatalf("ProcessFile failed: %v", err)
282
- }
283
-
284
- // Assert...
285
- _ = result
286
- }
287
- ```
288
-
289
- ## Golden Files
290
-
291
- Testing against expected output files stored in `testdata/`.
292
-
293
- ```go
294
- var update = flag.Bool("update", false, "update golden files")
295
-
296
- func TestRender(t *testing.T) {
297
- tests := []struct {
298
- name string
299
- input Template
300
- }{
301
- {"simple", Template{Name: "test"}},
302
- {"complex", Template{Name: "test", Items: []string{"a", "b"}}},
303
- }
304
-
305
- for _, tt := range tests {
306
- t.Run(tt.name, func(t *testing.T) {
307
- got := Render(tt.input)
308
-
309
- golden := filepath.Join("testdata", tt.name+".golden")
310
-
311
- if *update {
312
- // Update golden file: go test -update
313
- err := os.WriteFile(golden, got, 0644)
314
- if err != nil {
315
- t.Fatalf("failed to update golden file: %v", err)
316
- }
317
- }
318
-
319
- want, err := os.ReadFile(golden)
320
- if err != nil {
321
- t.Fatalf("failed to read golden file: %v", err)
322
- }
323
-
324
- if !bytes.Equal(got, want) {
325
- t.Errorf("output mismatch:\ngot:\n%s\nwant:\n%s", got, want)
326
- }
327
- })
328
- }
329
- }
330
- ```
331
-
332
- ## Mocking with Interfaces
333
-
334
- ### Interface-Based Mocking
335
-
336
- ```go
337
- // Define interface for dependencies
338
- type UserRepository interface {
339
- GetUser(id string) (*User, error)
340
- SaveUser(user *User) error
341
- }
342
-
343
- // Production implementation
344
- type PostgresUserRepository struct {
345
- db *sql.DB
346
- }
347
-
348
- func (r *PostgresUserRepository) GetUser(id string) (*User, error) {
349
- // Real database query
350
- }
351
-
352
- // Mock implementation for tests
353
- type MockUserRepository struct {
354
- GetUserFunc func(id string) (*User, error)
355
- SaveUserFunc func(user *User) error
356
- }
357
-
358
- func (m *MockUserRepository) GetUser(id string) (*User, error) {
359
- return m.GetUserFunc(id)
360
- }
361
-
362
- func (m *MockUserRepository) SaveUser(user *User) error {
363
- return m.SaveUserFunc(user)
364
- }
365
-
366
- // Test using mock
367
- func TestUserService(t *testing.T) {
368
- mock := &MockUserRepository{
369
- GetUserFunc: func(id string) (*User, error) {
370
- if id == "123" {
371
- return &User{ID: "123", Name: "Alice"}, nil
372
- }
373
- return nil, ErrNotFound
374
- },
375
- }
376
-
377
- service := NewUserService(mock)
378
-
379
- user, err := service.GetUserProfile("123")
380
- if err != nil {
381
- t.Fatalf("unexpected error: %v", err)
382
- }
383
- if user.Name != "Alice" {
384
- t.Errorf("got name %q; want %q", user.Name, "Alice")
385
- }
386
- }
387
- ```
388
-
389
- ## Benchmarks
390
-
391
- ### Basic Benchmarks
392
-
393
- ```go
394
- func BenchmarkProcess(b *testing.B) {
395
- data := generateTestData(1000)
396
- b.ResetTimer() // Don't count setup time
397
-
398
- for i := 0; i < b.N; i++ {
399
- Process(data)
400
- }
401
- }
402
-
403
- // Run: go test -bench=BenchmarkProcess -benchmem
404
- // Output: BenchmarkProcess-8 10000 105234 ns/op 4096 B/op 10 allocs/op
405
- ```
406
-
407
- ### Benchmark with Different Sizes
408
-
409
- ```go
410
- func BenchmarkSort(b *testing.B) {
411
- sizes := []int{100, 1000, 10000, 100000}
412
-
413
- for _, size := range sizes {
414
- b.Run(fmt.Sprintf("size=%d", size), func(b *testing.B) {
415
- data := generateRandomSlice(size)
416
- b.ResetTimer()
417
-
418
- for i := 0; i < b.N; i++ {
419
- // Make a copy to avoid sorting already sorted data
420
- tmp := make([]int, len(data))
421
- copy(tmp, data)
422
- sort.Ints(tmp)
423
- }
424
- })
425
- }
426
- }
427
- ```
428
-
429
- ### Memory Allocation Benchmarks
430
-
431
- ```go
432
- func BenchmarkStringConcat(b *testing.B) {
433
- parts := []string{"hello", "world", "foo", "bar", "baz"}
434
-
435
- b.Run("plus", func(b *testing.B) {
436
- for i := 0; i < b.N; i++ {
437
- var s string
438
- for _, p := range parts {
439
- s += p
440
- }
441
- _ = s
442
- }
443
- })
444
-
445
- b.Run("builder", func(b *testing.B) {
446
- for i := 0; i < b.N; i++ {
447
- var sb strings.Builder
448
- for _, p := range parts {
449
- sb.WriteString(p)
450
- }
451
- _ = sb.String()
452
- }
453
- })
454
-
455
- b.Run("join", func(b *testing.B) {
456
- for i := 0; i < b.N; i++ {
457
- _ = strings.Join(parts, "")
458
- }
459
- })
460
- }
461
- ```
462
-
463
- ## Fuzzing (Go 1.18+)
464
-
465
- ### Basic Fuzz Test
466
-
467
- ```go
468
- func FuzzParseJSON(f *testing.F) {
469
- // Add seed corpus
470
- f.Add(`{"name": "test"}`)
471
- f.Add(`{"count": 123}`)
472
- f.Add(`[]`)
473
- f.Add(`""`)
474
-
475
- f.Fuzz(func(t *testing.T, input string) {
476
- var result map[string]interface{}
477
- err := json.Unmarshal([]byte(input), &result)
478
-
479
- if err != nil {
480
- // Invalid JSON is expected for random input
481
- return
482
- }
483
-
484
- // If parsing succeeded, re-encoding should work
485
- _, err = json.Marshal(result)
486
- if err != nil {
487
- t.Errorf("Marshal failed after successful Unmarshal: %v", err)
488
- }
489
- })
490
- }
491
-
492
- // Run: go test -fuzz=FuzzParseJSON -fuzztime=30s
493
- ```
494
-
495
- ### Fuzz Test with Multiple Inputs
496
-
497
- ```go
498
- func FuzzCompare(f *testing.F) {
499
- f.Add("hello", "world")
500
- f.Add("", "")
501
- f.Add("abc", "abc")
502
-
503
- f.Fuzz(func(t *testing.T, a, b string) {
504
- result := Compare(a, b)
505
-
506
- // Property: Compare(a, a) should always equal 0
507
- if a == b && result != 0 {
508
- t.Errorf("Compare(%q, %q) = %d; want 0", a, b, result)
509
- }
510
-
511
- // Property: Compare(a, b) and Compare(b, a) should have opposite signs
512
- reverse := Compare(b, a)
513
- if (result > 0 && reverse >= 0) || (result < 0 && reverse <= 0) {
514
- if result != 0 || reverse != 0 {
515
- t.Errorf("Compare(%q, %q) = %d, Compare(%q, %q) = %d; inconsistent",
516
- a, b, result, b, a, reverse)
517
- }
518
- }
519
- })
520
- }
521
- ```
522
-
523
- ## Test Coverage
524
-
525
- ### Running Coverage
526
-
527
- ```bash
528
- # Basic coverage
529
- go test -cover ./...
530
-
531
- # Generate coverage profile
532
- go test -coverprofile=coverage.out ./...
533
-
534
- # View coverage in browser
535
- go tool cover -html=coverage.out
536
-
537
- # View coverage by function
538
- go tool cover -func=coverage.out
539
-
540
- # Coverage with race detection
541
- go test -race -coverprofile=coverage.out ./...
542
- ```
543
-
544
- ### Coverage Targets
545
-
546
- | Code Type | Target |
547
- |-----------|--------|
548
- | Critical business logic | 100% |
549
- | Public APIs | 90%+ |
550
- | General code | 80%+ |
551
- | Generated code | Exclude |
552
-
553
- ### Excluding Generated Code from Coverage
554
-
555
- ```go
556
- //go:generate mockgen -source=interface.go -destination=mock_interface.go
557
-
558
- // In coverage profile, exclude with build tags:
559
- // go test -cover -tags=!generate ./...
560
- ```
561
-
562
- ## HTTP Handler Testing
563
-
564
- ```go
565
- func TestHealthHandler(t *testing.T) {
566
- // Create request
567
- req := httptest.NewRequest(http.MethodGet, "/health", nil)
568
- w := httptest.NewRecorder()
569
-
570
- // Call handler
571
- HealthHandler(w, req)
572
-
573
- // Check response
574
- resp := w.Result()
575
- defer resp.Body.Close()
576
-
577
- if resp.StatusCode != http.StatusOK {
578
- t.Errorf("got status %d; want %d", resp.StatusCode, http.StatusOK)
579
- }
580
-
581
- body, _ := io.ReadAll(resp.Body)
582
- if string(body) != "OK" {
583
- t.Errorf("got body %q; want %q", body, "OK")
584
- }
585
- }
586
-
587
- func TestAPIHandler(t *testing.T) {
588
- tests := []struct {
589
- name string
590
- method string
591
- path string
592
- body string
593
- wantStatus int
594
- wantBody string
595
- }{
596
- {
597
- name: "get user",
598
- method: http.MethodGet,
599
- path: "/users/123",
600
- wantStatus: http.StatusOK,
601
- wantBody: `{"id":"123","name":"Alice"}`,
602
- },
603
- {
604
- name: "not found",
605
- method: http.MethodGet,
606
- path: "/users/999",
607
- wantStatus: http.StatusNotFound,
608
- },
609
- {
610
- name: "create user",
611
- method: http.MethodPost,
612
- path: "/users",
613
- body: `{"name":"Bob"}`,
614
- wantStatus: http.StatusCreated,
615
- },
616
- }
617
-
618
- handler := NewAPIHandler()
619
-
620
- for _, tt := range tests {
621
- t.Run(tt.name, func(t *testing.T) {
622
- var body io.Reader
623
- if tt.body != "" {
624
- body = strings.NewReader(tt.body)
625
- }
626
-
627
- req := httptest.NewRequest(tt.method, tt.path, body)
628
- req.Header.Set("Content-Type", "application/json")
629
- w := httptest.NewRecorder()
630
-
631
- handler.ServeHTTP(w, req)
632
-
633
- if w.Code != tt.wantStatus {
634
- t.Errorf("got status %d; want %d", w.Code, tt.wantStatus)
635
- }
636
-
637
- if tt.wantBody != "" && w.Body.String() != tt.wantBody {
638
- t.Errorf("got body %q; want %q", w.Body.String(), tt.wantBody)
639
- }
640
- })
641
- }
642
- }
643
- ```
644
-
645
- ## Testing Commands
646
-
647
- ```bash
648
- # Run all tests
649
- go test ./...
650
-
651
- # Run tests with verbose output
652
- go test -v ./...
653
-
654
- # Run specific test
655
- go test -run TestAdd ./...
656
-
657
- # Run tests matching pattern
658
- go test -run "TestUser/Create" ./...
659
-
660
- # Run tests with race detector
661
- go test -race ./...
662
-
663
- # Run tests with coverage
664
- go test -cover -coverprofile=coverage.out ./...
665
-
666
- # Run short tests only
667
- go test -short ./...
668
-
669
- # Run tests with timeout
670
- go test -timeout 30s ./...
671
-
672
- # Run benchmarks
673
- go test -bench=. -benchmem ./...
674
-
675
- # Run fuzzing
676
- go test -fuzz=FuzzParse -fuzztime=30s ./...
677
-
678
- # Count test runs (for flaky test detection)
679
- go test -count=10 ./...
680
- ```
681
-
682
- ## Best Practices
683
-
684
- **DO:**
685
- - Write tests FIRST (TDD)
686
- - Use table-driven tests for comprehensive coverage
687
- - Test behavior, not implementation
688
- - Use `t.Helper()` in helper functions
689
- - Use `t.Parallel()` for independent tests
690
- - Clean up resources with `t.Cleanup()`
691
- - Use meaningful test names that describe the scenario
692
-
693
- **DON'T:**
694
- - Test private functions directly (test through public API)
695
- - Use `time.Sleep()` in tests (use channels or conditions)
696
- - Ignore flaky tests (fix or remove them)
697
- - Mock everything (prefer integration tests when possible)
698
- - Skip error path testing
699
-
700
- ## Integration with CI/CD
701
-
702
- ```yaml
703
- # GitHub Actions example
704
- test:
705
- runs-on: ubuntu-latest
706
- steps:
707
- - uses: actions/checkout@v4
708
- - uses: actions/setup-go@v5
709
- with:
710
- go-version: '1.22'
711
-
712
- - name: Run tests
713
- run: go test -race -coverprofile=coverage.out ./...
714
-
715
- - name: Check coverage
716
- run: |
717
- go tool cover -func=coverage.out | grep total | awk '{print $3}' | \
718
- awk -F'%' '{if ($1 < 80) exit 1}'
719
- ```
720
-
721
- **Remember**: Tests are documentation. They show how your code is meant to be used. Write them clearly and keep them up to date.
1
+ ---
2
+ name: golang-testing
3
+ description: Go testing patterns including table-driven tests, subtests, benchmarks, fuzzing, and test coverage. Follows TDD methodology with idiomatic Go practices.
4
+ metadata:
5
+ origin: ECC
6
+ ---
7
+
8
+ # Go Testing Patterns
9
+
10
+ Comprehensive Go testing patterns for writing reliable, maintainable tests following TDD methodology.
11
+
12
+ ## When to Activate
13
+
14
+ - Writing new Go functions or methods
15
+ - Adding test coverage to existing code
16
+ - Creating benchmarks for performance-critical code
17
+ - Implementing fuzz tests for input validation
18
+ - Following TDD workflow in Go projects
19
+
20
+ ## TDD Workflow for Go
21
+
22
+ ### The RED-GREEN-REFACTOR Cycle
23
+
24
+ ```
25
+ RED → Write a failing test first
26
+ GREEN → Write minimal code to pass the test
27
+ REFACTOR → Improve code while keeping tests green
28
+ REPEAT → Continue with next requirement
29
+ ```
30
+
31
+ ### Step-by-Step TDD in Go
32
+
33
+ ```go
34
+ // Step 1: Define the interface/signature
35
+ // calculator.go
36
+ package calculator
37
+
38
+ func Add(a, b int) int {
39
+ panic("not implemented") // Placeholder
40
+ }
41
+
42
+ // Step 2: Write failing test (RED)
43
+ // calculator_test.go
44
+ package calculator
45
+
46
+ import "testing"
47
+
48
+ func TestAdd(t *testing.T) {
49
+ got := Add(2, 3)
50
+ want := 5
51
+ if got != want {
52
+ t.Errorf("Add(2, 3) = %d; want %d", got, want)
53
+ }
54
+ }
55
+
56
+ // Step 3: Run test - verify FAIL
57
+ // $ go test
58
+ // --- FAIL: TestAdd (0.00s)
59
+ // panic: not implemented
60
+
61
+ // Step 4: Implement minimal code (GREEN)
62
+ func Add(a, b int) int {
63
+ return a + b
64
+ }
65
+
66
+ // Step 5: Run test - verify PASS
67
+ // $ go test
68
+ // PASS
69
+
70
+ // Step 6: Refactor if needed, verify tests still pass
71
+ ```
72
+
73
+ ## Table-Driven Tests
74
+
75
+ The standard pattern for Go tests. Enables comprehensive coverage with minimal code.
76
+
77
+ ```go
78
+ func TestAdd(t *testing.T) {
79
+ tests := []struct {
80
+ name string
81
+ a, b int
82
+ expected int
83
+ }{
84
+ {"positive numbers", 2, 3, 5},
85
+ {"negative numbers", -1, -2, -3},
86
+ {"zero values", 0, 0, 0},
87
+ {"mixed signs", -1, 1, 0},
88
+ {"large numbers", 1000000, 2000000, 3000000},
89
+ }
90
+
91
+ for _, tt := range tests {
92
+ t.Run(tt.name, func(t *testing.T) {
93
+ got := Add(tt.a, tt.b)
94
+ if got != tt.expected {
95
+ t.Errorf("Add(%d, %d) = %d; want %d",
96
+ tt.a, tt.b, got, tt.expected)
97
+ }
98
+ })
99
+ }
100
+ }
101
+ ```
102
+
103
+ ### Table-Driven Tests with Error Cases
104
+
105
+ ```go
106
+ func TestParseConfig(t *testing.T) {
107
+ tests := []struct {
108
+ name string
109
+ input string
110
+ want *Config
111
+ wantErr bool
112
+ }{
113
+ {
114
+ name: "valid config",
115
+ input: `{"host": "localhost", "port": 8080}`,
116
+ want: &Config{Host: "localhost", Port: 8080},
117
+ },
118
+ {
119
+ name: "invalid JSON",
120
+ input: `{invalid}`,
121
+ wantErr: true,
122
+ },
123
+ {
124
+ name: "empty input",
125
+ input: "",
126
+ wantErr: true,
127
+ },
128
+ {
129
+ name: "minimal config",
130
+ input: `{}`,
131
+ want: &Config{}, // Zero value config
132
+ },
133
+ }
134
+
135
+ for _, tt := range tests {
136
+ t.Run(tt.name, func(t *testing.T) {
137
+ got, err := ParseConfig(tt.input)
138
+
139
+ if tt.wantErr {
140
+ if err == nil {
141
+ t.Error("expected error, got nil")
142
+ }
143
+ return
144
+ }
145
+
146
+ if err != nil {
147
+ t.Fatalf("unexpected error: %v", err)
148
+ }
149
+
150
+ if !reflect.DeepEqual(got, tt.want) {
151
+ t.Errorf("got %+v; want %+v", got, tt.want)
152
+ }
153
+ })
154
+ }
155
+ }
156
+ ```
157
+
158
+ ## Subtests and Sub-benchmarks
159
+
160
+ ### Organizing Related Tests
161
+
162
+ ```go
163
+ func TestUser(t *testing.T) {
164
+ // Setup shared by all subtests
165
+ db := setupTestDB(t)
166
+
167
+ t.Run("Create", func(t *testing.T) {
168
+ user := &User{Name: "Alice"}
169
+ err := db.CreateUser(user)
170
+ if err != nil {
171
+ t.Fatalf("CreateUser failed: %v", err)
172
+ }
173
+ if user.ID == "" {
174
+ t.Error("expected user ID to be set")
175
+ }
176
+ })
177
+
178
+ t.Run("Get", func(t *testing.T) {
179
+ user, err := db.GetUser("alice-id")
180
+ if err != nil {
181
+ t.Fatalf("GetUser failed: %v", err)
182
+ }
183
+ if user.Name != "Alice" {
184
+ t.Errorf("got name %q; want %q", user.Name, "Alice")
185
+ }
186
+ })
187
+
188
+ t.Run("Update", func(t *testing.T) {
189
+ // ...
190
+ })
191
+
192
+ t.Run("Delete", func(t *testing.T) {
193
+ // ...
194
+ })
195
+ }
196
+ ```
197
+
198
+ ### Parallel Subtests
199
+
200
+ ```go
201
+ func TestParallel(t *testing.T) {
202
+ tests := []struct {
203
+ name string
204
+ input string
205
+ }{
206
+ {"case1", "input1"},
207
+ {"case2", "input2"},
208
+ {"case3", "input3"},
209
+ }
210
+
211
+ for _, tt := range tests {
212
+ tt := tt // Capture range variable
213
+ t.Run(tt.name, func(t *testing.T) {
214
+ t.Parallel() // Run subtests in parallel
215
+ result := Process(tt.input)
216
+ // assertions...
217
+ _ = result
218
+ })
219
+ }
220
+ }
221
+ ```
222
+
223
+ ## Test Helpers
224
+
225
+ ### Helper Functions
226
+
227
+ ```go
228
+ func setupTestDB(t *testing.T) *sql.DB {
229
+ t.Helper() // Marks this as a helper function
230
+
231
+ db, err := sql.Open("sqlite3", ":memory:")
232
+ if err != nil {
233
+ t.Fatalf("failed to open database: %v", err)
234
+ }
235
+
236
+ // Cleanup when test finishes
237
+ t.Cleanup(func() {
238
+ db.Close()
239
+ })
240
+
241
+ // Run migrations
242
+ if _, err := db.Exec(schema); err != nil {
243
+ t.Fatalf("failed to create schema: %v", err)
244
+ }
245
+
246
+ return db
247
+ }
248
+
249
+ func assertNoError(t *testing.T, err error) {
250
+ t.Helper()
251
+ if err != nil {
252
+ t.Fatalf("unexpected error: %v", err)
253
+ }
254
+ }
255
+
256
+ func assertEqual[T comparable](t *testing.T, got, want T) {
257
+ t.Helper()
258
+ if got != want {
259
+ t.Errorf("got %v; want %v", got, want)
260
+ }
261
+ }
262
+ ```
263
+
264
+ ### Temporary Files and Directories
265
+
266
+ ```go
267
+ func TestFileProcessing(t *testing.T) {
268
+ // Create temp directory - automatically cleaned up
269
+ tmpDir := t.TempDir()
270
+
271
+ // Create test file
272
+ testFile := filepath.Join(tmpDir, "test.txt")
273
+ err := os.WriteFile(testFile, []byte("test content"), 0644)
274
+ if err != nil {
275
+ t.Fatalf("failed to create test file: %v", err)
276
+ }
277
+
278
+ // Run test
279
+ result, err := ProcessFile(testFile)
280
+ if err != nil {
281
+ t.Fatalf("ProcessFile failed: %v", err)
282
+ }
283
+
284
+ // Assert...
285
+ _ = result
286
+ }
287
+ ```
288
+
289
+ ## Golden Files
290
+
291
+ Testing against expected output files stored in `testdata/`.
292
+
293
+ ```go
294
+ var update = flag.Bool("update", false, "update golden files")
295
+
296
+ func TestRender(t *testing.T) {
297
+ tests := []struct {
298
+ name string
299
+ input Template
300
+ }{
301
+ {"simple", Template{Name: "test"}},
302
+ {"complex", Template{Name: "test", Items: []string{"a", "b"}}},
303
+ }
304
+
305
+ for _, tt := range tests {
306
+ t.Run(tt.name, func(t *testing.T) {
307
+ got := Render(tt.input)
308
+
309
+ golden := filepath.Join("testdata", tt.name+".golden")
310
+
311
+ if *update {
312
+ // Update golden file: go test -update
313
+ err := os.WriteFile(golden, got, 0644)
314
+ if err != nil {
315
+ t.Fatalf("failed to update golden file: %v", err)
316
+ }
317
+ }
318
+
319
+ want, err := os.ReadFile(golden)
320
+ if err != nil {
321
+ t.Fatalf("failed to read golden file: %v", err)
322
+ }
323
+
324
+ if !bytes.Equal(got, want) {
325
+ t.Errorf("output mismatch:\ngot:\n%s\nwant:\n%s", got, want)
326
+ }
327
+ })
328
+ }
329
+ }
330
+ ```
331
+
332
+ ## Mocking with Interfaces
333
+
334
+ ### Interface-Based Mocking
335
+
336
+ ```go
337
+ // Define interface for dependencies
338
+ type UserRepository interface {
339
+ GetUser(id string) (*User, error)
340
+ SaveUser(user *User) error
341
+ }
342
+
343
+ // Production implementation
344
+ type PostgresUserRepository struct {
345
+ db *sql.DB
346
+ }
347
+
348
+ func (r *PostgresUserRepository) GetUser(id string) (*User, error) {
349
+ // Real database query
350
+ }
351
+
352
+ // Mock implementation for tests
353
+ type MockUserRepository struct {
354
+ GetUserFunc func(id string) (*User, error)
355
+ SaveUserFunc func(user *User) error
356
+ }
357
+
358
+ func (m *MockUserRepository) GetUser(id string) (*User, error) {
359
+ return m.GetUserFunc(id)
360
+ }
361
+
362
+ func (m *MockUserRepository) SaveUser(user *User) error {
363
+ return m.SaveUserFunc(user)
364
+ }
365
+
366
+ // Test using mock
367
+ func TestUserService(t *testing.T) {
368
+ mock := &MockUserRepository{
369
+ GetUserFunc: func(id string) (*User, error) {
370
+ if id == "123" {
371
+ return &User{ID: "123", Name: "Alice"}, nil
372
+ }
373
+ return nil, ErrNotFound
374
+ },
375
+ }
376
+
377
+ service := NewUserService(mock)
378
+
379
+ user, err := service.GetUserProfile("123")
380
+ if err != nil {
381
+ t.Fatalf("unexpected error: %v", err)
382
+ }
383
+ if user.Name != "Alice" {
384
+ t.Errorf("got name %q; want %q", user.Name, "Alice")
385
+ }
386
+ }
387
+ ```
388
+
389
+ ## Benchmarks
390
+
391
+ ### Basic Benchmarks
392
+
393
+ ```go
394
+ func BenchmarkProcess(b *testing.B) {
395
+ data := generateTestData(1000)
396
+ b.ResetTimer() // Don't count setup time
397
+
398
+ for i := 0; i < b.N; i++ {
399
+ Process(data)
400
+ }
401
+ }
402
+
403
+ // Run: go test -bench=BenchmarkProcess -benchmem
404
+ // Output: BenchmarkProcess-8 10000 105234 ns/op 4096 B/op 10 allocs/op
405
+ ```
406
+
407
+ ### Benchmark with Different Sizes
408
+
409
+ ```go
410
+ func BenchmarkSort(b *testing.B) {
411
+ sizes := []int{100, 1000, 10000, 100000}
412
+
413
+ for _, size := range sizes {
414
+ b.Run(fmt.Sprintf("size=%d", size), func(b *testing.B) {
415
+ data := generateRandomSlice(size)
416
+ b.ResetTimer()
417
+
418
+ for i := 0; i < b.N; i++ {
419
+ // Make a copy to avoid sorting already sorted data
420
+ tmp := make([]int, len(data))
421
+ copy(tmp, data)
422
+ sort.Ints(tmp)
423
+ }
424
+ })
425
+ }
426
+ }
427
+ ```
428
+
429
+ ### Memory Allocation Benchmarks
430
+
431
+ ```go
432
+ func BenchmarkStringConcat(b *testing.B) {
433
+ parts := []string{"hello", "world", "foo", "bar", "baz"}
434
+
435
+ b.Run("plus", func(b *testing.B) {
436
+ for i := 0; i < b.N; i++ {
437
+ var s string
438
+ for _, p := range parts {
439
+ s += p
440
+ }
441
+ _ = s
442
+ }
443
+ })
444
+
445
+ b.Run("builder", func(b *testing.B) {
446
+ for i := 0; i < b.N; i++ {
447
+ var sb strings.Builder
448
+ for _, p := range parts {
449
+ sb.WriteString(p)
450
+ }
451
+ _ = sb.String()
452
+ }
453
+ })
454
+
455
+ b.Run("join", func(b *testing.B) {
456
+ for i := 0; i < b.N; i++ {
457
+ _ = strings.Join(parts, "")
458
+ }
459
+ })
460
+ }
461
+ ```
462
+
463
+ ## Fuzzing (Go 1.18+)
464
+
465
+ ### Basic Fuzz Test
466
+
467
+ ```go
468
+ func FuzzParseJSON(f *testing.F) {
469
+ // Add seed corpus
470
+ f.Add(`{"name": "test"}`)
471
+ f.Add(`{"count": 123}`)
472
+ f.Add(`[]`)
473
+ f.Add(`""`)
474
+
475
+ f.Fuzz(func(t *testing.T, input string) {
476
+ var result map[string]interface{}
477
+ err := json.Unmarshal([]byte(input), &result)
478
+
479
+ if err != nil {
480
+ // Invalid JSON is expected for random input
481
+ return
482
+ }
483
+
484
+ // If parsing succeeded, re-encoding should work
485
+ _, err = json.Marshal(result)
486
+ if err != nil {
487
+ t.Errorf("Marshal failed after successful Unmarshal: %v", err)
488
+ }
489
+ })
490
+ }
491
+
492
+ // Run: go test -fuzz=FuzzParseJSON -fuzztime=30s
493
+ ```
494
+
495
+ ### Fuzz Test with Multiple Inputs
496
+
497
+ ```go
498
+ func FuzzCompare(f *testing.F) {
499
+ f.Add("hello", "world")
500
+ f.Add("", "")
501
+ f.Add("abc", "abc")
502
+
503
+ f.Fuzz(func(t *testing.T, a, b string) {
504
+ result := Compare(a, b)
505
+
506
+ // Property: Compare(a, a) should always equal 0
507
+ if a == b && result != 0 {
508
+ t.Errorf("Compare(%q, %q) = %d; want 0", a, b, result)
509
+ }
510
+
511
+ // Property: Compare(a, b) and Compare(b, a) should have opposite signs
512
+ reverse := Compare(b, a)
513
+ if (result > 0 && reverse >= 0) || (result < 0 && reverse <= 0) {
514
+ if result != 0 || reverse != 0 {
515
+ t.Errorf("Compare(%q, %q) = %d, Compare(%q, %q) = %d; inconsistent",
516
+ a, b, result, b, a, reverse)
517
+ }
518
+ }
519
+ })
520
+ }
521
+ ```
522
+
523
+ ## Test Coverage
524
+
525
+ ### Running Coverage
526
+
527
+ ```bash
528
+ # Basic coverage
529
+ go test -cover ./...
530
+
531
+ # Generate coverage profile
532
+ go test -coverprofile=coverage.out ./...
533
+
534
+ # View coverage in browser
535
+ go tool cover -html=coverage.out
536
+
537
+ # View coverage by function
538
+ go tool cover -func=coverage.out
539
+
540
+ # Coverage with race detection
541
+ go test -race -coverprofile=coverage.out ./...
542
+ ```
543
+
544
+ ### Coverage Targets
545
+
546
+ | Code Type | Target |
547
+ |-----------|--------|
548
+ | Critical business logic | 100% |
549
+ | Public APIs | 90%+ |
550
+ | General code | 80%+ |
551
+ | Generated code | Exclude |
552
+
553
+ ### Excluding Generated Code from Coverage
554
+
555
+ ```go
556
+ //go:generate mockgen -source=interface.go -destination=mock_interface.go
557
+
558
+ // In coverage profile, exclude with build tags:
559
+ // go test -cover -tags=!generate ./...
560
+ ```
561
+
562
+ ## HTTP Handler Testing
563
+
564
+ ```go
565
+ func TestHealthHandler(t *testing.T) {
566
+ // Create request
567
+ req := httptest.NewRequest(http.MethodGet, "/health", nil)
568
+ w := httptest.NewRecorder()
569
+
570
+ // Call handler
571
+ HealthHandler(w, req)
572
+
573
+ // Check response
574
+ resp := w.Result()
575
+ defer resp.Body.Close()
576
+
577
+ if resp.StatusCode != http.StatusOK {
578
+ t.Errorf("got status %d; want %d", resp.StatusCode, http.StatusOK)
579
+ }
580
+
581
+ body, _ := io.ReadAll(resp.Body)
582
+ if string(body) != "OK" {
583
+ t.Errorf("got body %q; want %q", body, "OK")
584
+ }
585
+ }
586
+
587
+ func TestAPIHandler(t *testing.T) {
588
+ tests := []struct {
589
+ name string
590
+ method string
591
+ path string
592
+ body string
593
+ wantStatus int
594
+ wantBody string
595
+ }{
596
+ {
597
+ name: "get user",
598
+ method: http.MethodGet,
599
+ path: "/users/123",
600
+ wantStatus: http.StatusOK,
601
+ wantBody: `{"id":"123","name":"Alice"}`,
602
+ },
603
+ {
604
+ name: "not found",
605
+ method: http.MethodGet,
606
+ path: "/users/999",
607
+ wantStatus: http.StatusNotFound,
608
+ },
609
+ {
610
+ name: "create user",
611
+ method: http.MethodPost,
612
+ path: "/users",
613
+ body: `{"name":"Bob"}`,
614
+ wantStatus: http.StatusCreated,
615
+ },
616
+ }
617
+
618
+ handler := NewAPIHandler()
619
+
620
+ for _, tt := range tests {
621
+ t.Run(tt.name, func(t *testing.T) {
622
+ var body io.Reader
623
+ if tt.body != "" {
624
+ body = strings.NewReader(tt.body)
625
+ }
626
+
627
+ req := httptest.NewRequest(tt.method, tt.path, body)
628
+ req.Header.Set("Content-Type", "application/json")
629
+ w := httptest.NewRecorder()
630
+
631
+ handler.ServeHTTP(w, req)
632
+
633
+ if w.Code != tt.wantStatus {
634
+ t.Errorf("got status %d; want %d", w.Code, tt.wantStatus)
635
+ }
636
+
637
+ if tt.wantBody != "" && w.Body.String() != tt.wantBody {
638
+ t.Errorf("got body %q; want %q", w.Body.String(), tt.wantBody)
639
+ }
640
+ })
641
+ }
642
+ }
643
+ ```
644
+
645
+ ## Testing Commands
646
+
647
+ ```bash
648
+ # Run all tests
649
+ go test ./...
650
+
651
+ # Run tests with verbose output
652
+ go test -v ./...
653
+
654
+ # Run specific test
655
+ go test -run TestAdd ./...
656
+
657
+ # Run tests matching pattern
658
+ go test -run "TestUser/Create" ./...
659
+
660
+ # Run tests with race detector
661
+ go test -race ./...
662
+
663
+ # Run tests with coverage
664
+ go test -cover -coverprofile=coverage.out ./...
665
+
666
+ # Run short tests only
667
+ go test -short ./...
668
+
669
+ # Run tests with timeout
670
+ go test -timeout 30s ./...
671
+
672
+ # Run benchmarks
673
+ go test -bench=. -benchmem ./...
674
+
675
+ # Run fuzzing
676
+ go test -fuzz=FuzzParse -fuzztime=30s ./...
677
+
678
+ # Count test runs (for flaky test detection)
679
+ go test -count=10 ./...
680
+ ```
681
+
682
+ ## Best Practices
683
+
684
+ **DO:**
685
+ - Write tests FIRST (TDD)
686
+ - Use table-driven tests for comprehensive coverage
687
+ - Test behavior, not implementation
688
+ - Use `t.Helper()` in helper functions
689
+ - Use `t.Parallel()` for independent tests
690
+ - Clean up resources with `t.Cleanup()`
691
+ - Use meaningful test names that describe the scenario
692
+
693
+ **DON'T:**
694
+ - Test private functions directly (test through public API)
695
+ - Use `time.Sleep()` in tests (use channels or conditions)
696
+ - Ignore flaky tests (fix or remove them)
697
+ - Mock everything (prefer integration tests when possible)
698
+ - Skip error path testing
699
+
700
+ ## Integration with CI/CD
701
+
702
+ ```yaml
703
+ # GitHub Actions example
704
+ test:
705
+ runs-on: ubuntu-latest
706
+ steps:
707
+ - uses: actions/checkout@v4
708
+ - uses: actions/setup-go@v5
709
+ with:
710
+ go-version: '1.22'
711
+
712
+ - name: Run tests
713
+ run: go test -race -coverprofile=coverage.out ./...
714
+
715
+ - name: Check coverage
716
+ run: |
717
+ go tool cover -func=coverage.out | grep total | awk '{print $3}' | \
718
+ awk -F'%' '{if ($1 < 80) exit 1}'
719
+ ```
720
+
721
+ **Remember**: Tests are documentation. They show how your code is meant to be used. Write them clearly and keep them up to date.