codeply-cli 0.3.0 → 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 +129 -6
  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 -290
  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,825 +1,825 @@
1
- ---
2
- name: kotlin-testing
3
- description: Kotlin testing patterns with Kotest, MockK, coroutine testing, property-based testing, and Kover coverage. Follows TDD methodology with idiomatic Kotlin practices.
4
- metadata:
5
- origin: ECC
6
- ---
7
-
8
- # Kotlin Testing Patterns
9
-
10
- Comprehensive Kotlin testing patterns for writing reliable, maintainable tests following TDD methodology with Kotest and MockK.
11
-
12
- ## When to Use
13
-
14
- - Writing new Kotlin functions or classes
15
- - Adding test coverage to existing Kotlin code
16
- - Implementing property-based tests
17
- - Following TDD workflow in Kotlin projects
18
- - Configuring Kover for code coverage
19
-
20
- ## How It Works
21
-
22
- 1. **Identify target code** — Find the function, class, or module to test
23
- 2. **Write a Kotest spec** — Choose a spec style (StringSpec, FunSpec, BehaviorSpec) matching the test scope
24
- 3. **Mock dependencies** — Use MockK to isolate the unit under test
25
- 4. **Run tests (RED)** — Verify the test fails with the expected error
26
- 5. **Implement code (GREEN)** — Write minimal code to pass the test
27
- 6. **Refactor** — Improve the implementation while keeping tests green
28
- 7. **Check coverage** — Run `./gradlew koverHtmlReport` and verify 80%+ coverage
29
-
30
- ## Examples
31
-
32
- The following sections contain detailed, runnable examples for each testing pattern:
33
-
34
- ### Quick Reference
35
-
36
- - **Kotest specs** — StringSpec, FunSpec, BehaviorSpec, DescribeSpec examples in [Kotest Spec Styles](#kotest-spec-styles)
37
- - **Mocking** — MockK setup, coroutine mocking, argument capture in [MockK](#mockk)
38
- - **TDD walkthrough** — Full RED/GREEN/REFACTOR cycle with EmailValidator in [TDD Workflow for Kotlin](#tdd-workflow-for-kotlin)
39
- - **Coverage** — Kover configuration and commands in [Kover Coverage](#kover-coverage)
40
- - **Ktor testing** — testApplication setup in [Ktor testApplication Testing](#ktor-testapplication-testing)
41
-
42
- ### TDD Workflow for Kotlin
43
-
44
- #### The RED-GREEN-REFACTOR Cycle
45
-
46
- ```
47
- RED -> Write a failing test first
48
- GREEN -> Write minimal code to pass the test
49
- REFACTOR -> Improve code while keeping tests green
50
- REPEAT -> Continue with next requirement
51
- ```
52
-
53
- #### Step-by-Step TDD in Kotlin
54
-
55
- ```kotlin
56
- // Step 1: Define the interface/signature
57
- // EmailValidator.kt
58
- package com.example.validator
59
-
60
- fun validateEmail(email: String): Result<String> {
61
- TODO("not implemented")
62
- }
63
-
64
- // Step 2: Write failing test (RED)
65
- // EmailValidatorTest.kt
66
- package com.example.validator
67
-
68
- import io.kotest.core.spec.style.StringSpec
69
- import io.kotest.matchers.result.shouldBeFailure
70
- import io.kotest.matchers.result.shouldBeSuccess
71
-
72
- class EmailValidatorTest : StringSpec({
73
- "valid email returns success" {
74
- validateEmail("user@example.com").shouldBeSuccess("user@example.com")
75
- }
76
-
77
- "empty email returns failure" {
78
- validateEmail("").shouldBeFailure()
79
- }
80
-
81
- "email without @ returns failure" {
82
- validateEmail("userexample.com").shouldBeFailure()
83
- }
84
- })
85
-
86
- // Step 3: Run tests - verify FAIL
87
- // $ ./gradlew test
88
- // EmailValidatorTest > valid email returns success FAILED
89
- // kotlin.NotImplementedError: An operation is not implemented
90
-
91
- // Step 4: Implement minimal code (GREEN)
92
- fun validateEmail(email: String): Result<String> {
93
- if (email.isBlank()) return Result.failure(IllegalArgumentException("Email cannot be blank"))
94
- if ('@' !in email) return Result.failure(IllegalArgumentException("Email must contain @"))
95
- val regex = Regex("^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,}$")
96
- if (!regex.matches(email)) return Result.failure(IllegalArgumentException("Invalid email format"))
97
- return Result.success(email)
98
- }
99
-
100
- // Step 5: Run tests - verify PASS
101
- // $ ./gradlew test
102
- // EmailValidatorTest > valid email returns success PASSED
103
- // EmailValidatorTest > empty email returns failure PASSED
104
- // EmailValidatorTest > email without @ returns failure PASSED
105
-
106
- // Step 6: Refactor if needed, verify tests still pass
107
- ```
108
-
109
- ### Kotest Spec Styles
110
-
111
- #### StringSpec (Simplest)
112
-
113
- ```kotlin
114
- class CalculatorTest : StringSpec({
115
- "add two positive numbers" {
116
- Calculator.add(2, 3) shouldBe 5
117
- }
118
-
119
- "add negative numbers" {
120
- Calculator.add(-1, -2) shouldBe -3
121
- }
122
-
123
- "add zero" {
124
- Calculator.add(0, 5) shouldBe 5
125
- }
126
- })
127
- ```
128
-
129
- #### FunSpec (JUnit-like)
130
-
131
- ```kotlin
132
- class UserServiceTest : FunSpec({
133
- val repository = mockk<UserRepository>()
134
- val service = UserService(repository)
135
-
136
- test("getUser returns user when found") {
137
- val expected = User(id = "1", name = "Alice")
138
- coEvery { repository.findById("1") } returns expected
139
-
140
- val result = service.getUser("1")
141
-
142
- result shouldBe expected
143
- }
144
-
145
- test("getUser throws when not found") {
146
- coEvery { repository.findById("999") } returns null
147
-
148
- shouldThrow<UserNotFoundException> {
149
- service.getUser("999")
150
- }
151
- }
152
- })
153
- ```
154
-
155
- #### BehaviorSpec (BDD Style)
156
-
157
- ```kotlin
158
- class OrderServiceTest : BehaviorSpec({
159
- val repository = mockk<OrderRepository>()
160
- val paymentService = mockk<PaymentService>()
161
- val service = OrderService(repository, paymentService)
162
-
163
- Given("a valid order request") {
164
- val request = CreateOrderRequest(
165
- userId = "user-1",
166
- items = listOf(OrderItem("product-1", quantity = 2)),
167
- )
168
-
169
- When("the order is placed") {
170
- coEvery { paymentService.charge(any()) } returns PaymentResult.Success
171
- coEvery { repository.save(any()) } answers { firstArg() }
172
-
173
- val result = service.placeOrder(request)
174
-
175
- Then("it should return a confirmed order") {
176
- result.status shouldBe OrderStatus.CONFIRMED
177
- }
178
-
179
- Then("it should charge payment") {
180
- coVerify(exactly = 1) { paymentService.charge(any()) }
181
- }
182
- }
183
-
184
- When("payment fails") {
185
- coEvery { paymentService.charge(any()) } returns PaymentResult.Declined
186
-
187
- Then("it should throw PaymentException") {
188
- shouldThrow<PaymentException> {
189
- service.placeOrder(request)
190
- }
191
- }
192
- }
193
- }
194
- })
195
- ```
196
-
197
- #### DescribeSpec (RSpec Style)
198
-
199
- ```kotlin
200
- class UserValidatorTest : DescribeSpec({
201
- describe("validateUser") {
202
- val validator = UserValidator()
203
-
204
- context("with valid input") {
205
- it("accepts a normal user") {
206
- val user = CreateUserRequest("Alice", "alice@example.com")
207
- validator.validate(user).shouldBeValid()
208
- }
209
- }
210
-
211
- context("with invalid name") {
212
- it("rejects blank name") {
213
- val user = CreateUserRequest("", "alice@example.com")
214
- validator.validate(user).shouldBeInvalid()
215
- }
216
-
217
- it("rejects name exceeding max length") {
218
- val user = CreateUserRequest("A".repeat(256), "alice@example.com")
219
- validator.validate(user).shouldBeInvalid()
220
- }
221
- }
222
- }
223
- })
224
- ```
225
-
226
- ### Kotest Matchers
227
-
228
- #### Core Matchers
229
-
230
- ```kotlin
231
- import io.kotest.matchers.shouldBe
232
- import io.kotest.matchers.shouldNotBe
233
- import io.kotest.matchers.string.*
234
- import io.kotest.matchers.collections.*
235
- import io.kotest.matchers.nulls.*
236
-
237
- // Equality
238
- result shouldBe expected
239
- result shouldNotBe unexpected
240
-
241
- // Strings
242
- name shouldStartWith "Al"
243
- name shouldEndWith "ice"
244
- name shouldContain "lic"
245
- name shouldMatch Regex("[A-Z][a-z]+")
246
- name.shouldBeBlank()
247
-
248
- // Collections
249
- list shouldContain "item"
250
- list shouldHaveSize 3
251
- list.shouldBeSorted()
252
- list.shouldContainAll("a", "b", "c")
253
- list.shouldBeEmpty()
254
-
255
- // Nulls
256
- result.shouldNotBeNull()
257
- result.shouldBeNull()
258
-
259
- // Types
260
- result.shouldBeInstanceOf<User>()
261
-
262
- // Numbers
263
- count shouldBeGreaterThan 0
264
- price shouldBeInRange 1.0..100.0
265
-
266
- // Exceptions
267
- shouldThrow<IllegalArgumentException> {
268
- validateAge(-1)
269
- }.message shouldBe "Age must be positive"
270
-
271
- shouldNotThrow<Exception> {
272
- validateAge(25)
273
- }
274
- ```
275
-
276
- #### Custom Matchers
277
-
278
- ```kotlin
279
- fun beActiveUser() = object : Matcher<User> {
280
- override fun test(value: User) = MatcherResult(
281
- value.isActive && value.lastLogin != null,
282
- { "User ${value.id} should be active with a last login" },
283
- { "User ${value.id} should not be active" },
284
- )
285
- }
286
-
287
- // Usage
288
- user should beActiveUser()
289
- ```
290
-
291
- ### MockK
292
-
293
- #### Basic Mocking
294
-
295
- ```kotlin
296
- class UserServiceTest : FunSpec({
297
- val repository = mockk<UserRepository>()
298
- val logger = mockk<Logger>(relaxed = true) // Relaxed: returns defaults
299
- val service = UserService(repository, logger)
300
-
301
- beforeTest {
302
- clearMocks(repository, logger)
303
- }
304
-
305
- test("findUser delegates to repository") {
306
- val expected = User(id = "1", name = "Alice")
307
- every { repository.findById("1") } returns expected
308
-
309
- val result = service.findUser("1")
310
-
311
- result shouldBe expected
312
- verify(exactly = 1) { repository.findById("1") }
313
- }
314
-
315
- test("findUser returns null for unknown id") {
316
- every { repository.findById(any()) } returns null
317
-
318
- val result = service.findUser("unknown")
319
-
320
- result.shouldBeNull()
321
- }
322
- })
323
- ```
324
-
325
- #### Coroutine Mocking
326
-
327
- ```kotlin
328
- class AsyncUserServiceTest : FunSpec({
329
- val repository = mockk<UserRepository>()
330
- val service = UserService(repository)
331
-
332
- test("getUser suspending function") {
333
- coEvery { repository.findById("1") } returns User(id = "1", name = "Alice")
334
-
335
- val result = service.getUser("1")
336
-
337
- result.name shouldBe "Alice"
338
- coVerify { repository.findById("1") }
339
- }
340
-
341
- test("getUser with delay") {
342
- coEvery { repository.findById("1") } coAnswers {
343
- delay(100) // Simulate async work
344
- User(id = "1", name = "Alice")
345
- }
346
-
347
- val result = service.getUser("1")
348
- result.name shouldBe "Alice"
349
- }
350
- })
351
- ```
352
-
353
- #### Argument Capture
354
-
355
- ```kotlin
356
- test("save captures the user argument") {
357
- val slot = slot<User>()
358
- coEvery { repository.save(capture(slot)) } returns Unit
359
-
360
- service.createUser(CreateUserRequest("Alice", "alice@example.com"))
361
-
362
- slot.captured.name shouldBe "Alice"
363
- slot.captured.email shouldBe "alice@example.com"
364
- slot.captured.id.shouldNotBeNull()
365
- }
366
- ```
367
-
368
- #### Spy and Partial Mocking
369
-
370
- ```kotlin
371
- test("spy on real object") {
372
- val realService = UserService(repository)
373
- val spy = spyk(realService)
374
-
375
- every { spy.generateId() } returns "fixed-id"
376
-
377
- spy.createUser(request)
378
-
379
- verify { spy.generateId() } // Overridden
380
- // Other methods use real implementation
381
- }
382
- ```
383
-
384
- ### Coroutine Testing
385
-
386
- #### runTest for Suspend Functions
387
-
388
- ```kotlin
389
- import kotlinx.coroutines.test.runTest
390
-
391
- class CoroutineServiceTest : FunSpec({
392
- test("concurrent fetches complete together") {
393
- runTest {
394
- val service = DataService(testScope = this)
395
-
396
- val result = service.fetchAllData()
397
-
398
- result.users.shouldNotBeEmpty()
399
- result.products.shouldNotBeEmpty()
400
- }
401
- }
402
-
403
- test("timeout after delay") {
404
- runTest {
405
- val service = SlowService()
406
-
407
- shouldThrow<TimeoutCancellationException> {
408
- withTimeout(100) {
409
- service.slowOperation() // Takes > 100ms
410
- }
411
- }
412
- }
413
- }
414
- })
415
- ```
416
-
417
- #### Testing Flows
418
-
419
- ```kotlin
420
- import io.kotest.matchers.collections.shouldContainInOrder
421
- import kotlinx.coroutines.flow.MutableSharedFlow
422
- import kotlinx.coroutines.flow.toList
423
- import kotlinx.coroutines.launch
424
- import kotlinx.coroutines.test.advanceTimeBy
425
- import kotlinx.coroutines.test.runTest
426
-
427
- class FlowServiceTest : FunSpec({
428
- test("observeUsers emits updates") {
429
- runTest {
430
- val service = UserFlowService()
431
-
432
- val emissions = service.observeUsers()
433
- .take(3)
434
- .toList()
435
-
436
- emissions shouldHaveSize 3
437
- emissions.last().shouldNotBeEmpty()
438
- }
439
- }
440
-
441
- test("searchUsers debounces input") {
442
- runTest {
443
- val service = SearchService()
444
- val queries = MutableSharedFlow<String>()
445
-
446
- val results = mutableListOf<List<User>>()
447
- val job = launch {
448
- service.searchUsers(queries).collect { results.add(it) }
449
- }
450
-
451
- queries.emit("a")
452
- queries.emit("ab")
453
- queries.emit("abc") // Only this should trigger search
454
- advanceTimeBy(500)
455
-
456
- results shouldHaveSize 1
457
- job.cancel()
458
- }
459
- }
460
- })
461
- ```
462
-
463
- #### TestDispatcher
464
-
465
- ```kotlin
466
- import kotlinx.coroutines.test.StandardTestDispatcher
467
- import kotlinx.coroutines.test.advanceUntilIdle
468
-
469
- class DispatcherTest : FunSpec({
470
- test("uses test dispatcher for controlled execution") {
471
- val dispatcher = StandardTestDispatcher()
472
-
473
- runTest(dispatcher) {
474
- var completed = false
475
-
476
- launch {
477
- delay(1000)
478
- completed = true
479
- }
480
-
481
- completed shouldBe false
482
- advanceTimeBy(1000)
483
- completed shouldBe true
484
- }
485
- }
486
- })
487
- ```
488
-
489
- ### Property-Based Testing
490
-
491
- #### Kotest Property Testing
492
-
493
- ```kotlin
494
- import io.kotest.core.spec.style.FunSpec
495
- import io.kotest.property.Arb
496
- import io.kotest.property.arbitrary.*
497
- import io.kotest.property.forAll
498
- import io.kotest.property.checkAll
499
- import kotlinx.serialization.json.Json
500
- import kotlinx.serialization.encodeToString
501
- import kotlinx.serialization.decodeFromString
502
-
503
- // Note: The serialization roundtrip test below requires the User data class
504
- // to be annotated with @Serializable (from kotlinx.serialization).
505
-
506
- class PropertyTest : FunSpec({
507
- test("string reverse is involutory") {
508
- forAll<String> { s ->
509
- s.reversed().reversed() == s
510
- }
511
- }
512
-
513
- test("list sort is idempotent") {
514
- forAll(Arb.list(Arb.int())) { list ->
515
- list.sorted() == list.sorted().sorted()
516
- }
517
- }
518
-
519
- test("serialization roundtrip preserves data") {
520
- checkAll(Arb.bind(Arb.string(1..50), Arb.string(5..100)) { name, email ->
521
- User(name = name, email = "$email@test.com")
522
- }) { user ->
523
- val json = Json.encodeToString(user)
524
- val decoded = Json.decodeFromString<User>(json)
525
- decoded shouldBe user
526
- }
527
- }
528
- })
529
- ```
530
-
531
- #### Custom Generators
532
-
533
- ```kotlin
534
- val userArb: Arb<User> = Arb.bind(
535
- Arb.string(minSize = 1, maxSize = 50),
536
- Arb.email(),
537
- Arb.enum<Role>(),
538
- ) { name, email, role ->
539
- User(
540
- id = UserId(UUID.randomUUID().toString()),
541
- name = name,
542
- email = Email(email),
543
- role = role,
544
- )
545
- }
546
-
547
- val moneyArb: Arb<Money> = Arb.bind(
548
- Arb.long(1L..1_000_000L),
549
- Arb.enum<Currency>(),
550
- ) { amount, currency ->
551
- Money(amount, currency)
552
- }
553
- ```
554
-
555
- ### Data-Driven Testing
556
-
557
- #### withData in Kotest
558
-
559
- ```kotlin
560
- class ParserTest : FunSpec({
561
- context("parsing valid dates") {
562
- withData(
563
- "2026-01-15" to LocalDate(2026, 1, 15),
564
- "2026-12-31" to LocalDate(2026, 12, 31),
565
- "2000-01-01" to LocalDate(2000, 1, 1),
566
- ) { (input, expected) ->
567
- parseDate(input) shouldBe expected
568
- }
569
- }
570
-
571
- context("rejecting invalid dates") {
572
- withData(
573
- nameFn = { "rejects '$it'" },
574
- "not-a-date",
575
- "2026-13-01",
576
- "2026-00-15",
577
- "",
578
- ) { input ->
579
- shouldThrow<DateParseException> {
580
- parseDate(input)
581
- }
582
- }
583
- }
584
- })
585
- ```
586
-
587
- ### Test Lifecycle and Fixtures
588
-
589
- #### BeforeTest / AfterTest
590
-
591
- ```kotlin
592
- class DatabaseTest : FunSpec({
593
- lateinit var db: Database
594
-
595
- beforeSpec {
596
- db = Database.connect("jdbc:h2:mem:test;DB_CLOSE_DELAY=-1")
597
- transaction(db) {
598
- SchemaUtils.create(UsersTable)
599
- }
600
- }
601
-
602
- afterSpec {
603
- transaction(db) {
604
- SchemaUtils.drop(UsersTable)
605
- }
606
- }
607
-
608
- beforeTest {
609
- transaction(db) {
610
- UsersTable.deleteAll()
611
- }
612
- }
613
-
614
- test("insert and retrieve user") {
615
- transaction(db) {
616
- UsersTable.insert {
617
- it[name] = "Alice"
618
- it[email] = "alice@example.com"
619
- }
620
- }
621
-
622
- val users = transaction(db) {
623
- UsersTable.selectAll().map { it[UsersTable.name] }
624
- }
625
-
626
- users shouldContain "Alice"
627
- }
628
- })
629
- ```
630
-
631
- #### Kotest Extensions
632
-
633
- ```kotlin
634
- // Reusable test extension
635
- class DatabaseExtension : BeforeSpecListener, AfterSpecListener {
636
- lateinit var db: Database
637
-
638
- override suspend fun beforeSpec(spec: Spec) {
639
- db = Database.connect("jdbc:h2:mem:test;DB_CLOSE_DELAY=-1")
640
- }
641
-
642
- override suspend fun afterSpec(spec: Spec) {
643
- // cleanup
644
- }
645
- }
646
-
647
- class UserRepositoryTest : FunSpec({
648
- val dbExt = DatabaseExtension()
649
- register(dbExt)
650
-
651
- test("save and find user") {
652
- val repo = UserRepository(dbExt.db)
653
- // ...
654
- }
655
- })
656
- ```
657
-
658
- ### Kover Coverage
659
-
660
- #### Gradle Configuration
661
-
662
- ```kotlin
663
- // build.gradle.kts
664
- plugins {
665
- id("org.jetbrains.kotlinx.kover") version "0.9.7"
666
- }
667
-
668
- kover {
669
- reports {
670
- total {
671
- html { onCheck = true }
672
- xml { onCheck = true }
673
- }
674
- filters {
675
- excludes {
676
- classes("*.generated.*", "*.config.*")
677
- }
678
- }
679
- verify {
680
- rule {
681
- minBound(80) // Fail build below 80% coverage
682
- }
683
- }
684
- }
685
- }
686
- ```
687
-
688
- #### Coverage Commands
689
-
690
- ```bash
691
- # Run tests with coverage
692
- ./gradlew koverHtmlReport
693
-
694
- # Verify coverage thresholds
695
- ./gradlew koverVerify
696
-
697
- # XML report for CI
698
- ./gradlew koverXmlReport
699
-
700
- # View HTML report (use the command for your OS)
701
- # macOS: open build/reports/kover/html/index.html
702
- # Linux: xdg-open build/reports/kover/html/index.html
703
- # Windows: start build/reports/kover/html/index.html
704
- ```
705
-
706
- #### Coverage Targets
707
-
708
- | Code Type | Target |
709
- |-----------|--------|
710
- | Critical business logic | 100% |
711
- | Public APIs | 90%+ |
712
- | General code | 80%+ |
713
- | Generated / config code | Exclude |
714
-
715
- ### Ktor testApplication Testing
716
-
717
- ```kotlin
718
- class ApiRoutesTest : FunSpec({
719
- test("GET /users returns list") {
720
- testApplication {
721
- application {
722
- configureRouting()
723
- configureSerialization()
724
- }
725
-
726
- val response = client.get("/users")
727
-
728
- response.status shouldBe HttpStatusCode.OK
729
- val users = response.body<List<UserResponse>>()
730
- users.shouldNotBeEmpty()
731
- }
732
- }
733
-
734
- test("POST /users creates user") {
735
- testApplication {
736
- application {
737
- configureRouting()
738
- configureSerialization()
739
- }
740
-
741
- val response = client.post("/users") {
742
- contentType(ContentType.Application.Json)
743
- setBody(CreateUserRequest("Alice", "alice@example.com"))
744
- }
745
-
746
- response.status shouldBe HttpStatusCode.Created
747
- }
748
- }
749
- })
750
- ```
751
-
752
- ### Testing Commands
753
-
754
- ```bash
755
- # Run all tests
756
- ./gradlew test
757
-
758
- # Run specific test class
759
- ./gradlew test --tests "com.example.UserServiceTest"
760
-
761
- # Run specific test
762
- ./gradlew test --tests "com.example.UserServiceTest.getUser returns user when found"
763
-
764
- # Run with verbose output
765
- ./gradlew test --info
766
-
767
- # Run with coverage
768
- ./gradlew koverHtmlReport
769
-
770
- # Run detekt (static analysis)
771
- ./gradlew detekt
772
-
773
- # Run ktlint (formatting check)
774
- ./gradlew ktlintCheck
775
-
776
- # Continuous testing
777
- ./gradlew test --continuous
778
- ```
779
-
780
- ### Best Practices
781
-
782
- **DO:**
783
- - Write tests FIRST (TDD)
784
- - Use Kotest's spec styles consistently across the project
785
- - Use MockK's `coEvery`/`coVerify` for suspend functions
786
- - Use `runTest` for coroutine testing
787
- - Test behavior, not implementation
788
- - Use property-based testing for pure functions
789
- - Use `data class` test fixtures for clarity
790
-
791
- **DON'T:**
792
- - Mix testing frameworks (pick Kotest and stick with it)
793
- - Mock data classes (use real instances)
794
- - Use `Thread.sleep()` in coroutine tests (use `advanceTimeBy`)
795
- - Skip the RED phase in TDD
796
- - Test private functions directly
797
- - Ignore flaky tests
798
-
799
- ### Integration with CI/CD
800
-
801
- ```yaml
802
- # GitHub Actions example
803
- test:
804
- runs-on: ubuntu-latest
805
- steps:
806
- - uses: actions/checkout@v4
807
- - uses: actions/setup-java@v4
808
- with:
809
- distribution: 'temurin'
810
- java-version: '21'
811
-
812
- - name: Run tests with coverage
813
- run: ./gradlew test koverXmlReport
814
-
815
- - name: Verify coverage
816
- run: ./gradlew koverVerify
817
-
818
- - name: Upload coverage
819
- uses: codecov/codecov-action@v5
820
- with:
821
- files: build/reports/kover/report.xml
822
- token: ${{ secrets.CODECOV_TOKEN }}
823
- ```
824
-
825
- **Remember**: Tests are documentation. They show how your Kotlin code is meant to be used. Use Kotest's expressive matchers to make tests readable and MockK for clean mocking of dependencies.
1
+ ---
2
+ name: kotlin-testing
3
+ description: Kotlin testing patterns with Kotest, MockK, coroutine testing, property-based testing, and Kover coverage. Follows TDD methodology with idiomatic Kotlin practices.
4
+ metadata:
5
+ origin: ECC
6
+ ---
7
+
8
+ # Kotlin Testing Patterns
9
+
10
+ Comprehensive Kotlin testing patterns for writing reliable, maintainable tests following TDD methodology with Kotest and MockK.
11
+
12
+ ## When to Use
13
+
14
+ - Writing new Kotlin functions or classes
15
+ - Adding test coverage to existing Kotlin code
16
+ - Implementing property-based tests
17
+ - Following TDD workflow in Kotlin projects
18
+ - Configuring Kover for code coverage
19
+
20
+ ## How It Works
21
+
22
+ 1. **Identify target code** — Find the function, class, or module to test
23
+ 2. **Write a Kotest spec** — Choose a spec style (StringSpec, FunSpec, BehaviorSpec) matching the test scope
24
+ 3. **Mock dependencies** — Use MockK to isolate the unit under test
25
+ 4. **Run tests (RED)** — Verify the test fails with the expected error
26
+ 5. **Implement code (GREEN)** — Write minimal code to pass the test
27
+ 6. **Refactor** — Improve the implementation while keeping tests green
28
+ 7. **Check coverage** — Run `./gradlew koverHtmlReport` and verify 80%+ coverage
29
+
30
+ ## Examples
31
+
32
+ The following sections contain detailed, runnable examples for each testing pattern:
33
+
34
+ ### Quick Reference
35
+
36
+ - **Kotest specs** — StringSpec, FunSpec, BehaviorSpec, DescribeSpec examples in [Kotest Spec Styles](#kotest-spec-styles)
37
+ - **Mocking** — MockK setup, coroutine mocking, argument capture in [MockK](#mockk)
38
+ - **TDD walkthrough** — Full RED/GREEN/REFACTOR cycle with EmailValidator in [TDD Workflow for Kotlin](#tdd-workflow-for-kotlin)
39
+ - **Coverage** — Kover configuration and commands in [Kover Coverage](#kover-coverage)
40
+ - **Ktor testing** — testApplication setup in [Ktor testApplication Testing](#ktor-testapplication-testing)
41
+
42
+ ### TDD Workflow for Kotlin
43
+
44
+ #### The RED-GREEN-REFACTOR Cycle
45
+
46
+ ```
47
+ RED -> Write a failing test first
48
+ GREEN -> Write minimal code to pass the test
49
+ REFACTOR -> Improve code while keeping tests green
50
+ REPEAT -> Continue with next requirement
51
+ ```
52
+
53
+ #### Step-by-Step TDD in Kotlin
54
+
55
+ ```kotlin
56
+ // Step 1: Define the interface/signature
57
+ // EmailValidator.kt
58
+ package com.example.validator
59
+
60
+ fun validateEmail(email: String): Result<String> {
61
+ TODO("not implemented")
62
+ }
63
+
64
+ // Step 2: Write failing test (RED)
65
+ // EmailValidatorTest.kt
66
+ package com.example.validator
67
+
68
+ import io.kotest.core.spec.style.StringSpec
69
+ import io.kotest.matchers.result.shouldBeFailure
70
+ import io.kotest.matchers.result.shouldBeSuccess
71
+
72
+ class EmailValidatorTest : StringSpec({
73
+ "valid email returns success" {
74
+ validateEmail("user@example.com").shouldBeSuccess("user@example.com")
75
+ }
76
+
77
+ "empty email returns failure" {
78
+ validateEmail("").shouldBeFailure()
79
+ }
80
+
81
+ "email without @ returns failure" {
82
+ validateEmail("userexample.com").shouldBeFailure()
83
+ }
84
+ })
85
+
86
+ // Step 3: Run tests - verify FAIL
87
+ // $ ./gradlew test
88
+ // EmailValidatorTest > valid email returns success FAILED
89
+ // kotlin.NotImplementedError: An operation is not implemented
90
+
91
+ // Step 4: Implement minimal code (GREEN)
92
+ fun validateEmail(email: String): Result<String> {
93
+ if (email.isBlank()) return Result.failure(IllegalArgumentException("Email cannot be blank"))
94
+ if ('@' !in email) return Result.failure(IllegalArgumentException("Email must contain @"))
95
+ val regex = Regex("^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,}$")
96
+ if (!regex.matches(email)) return Result.failure(IllegalArgumentException("Invalid email format"))
97
+ return Result.success(email)
98
+ }
99
+
100
+ // Step 5: Run tests - verify PASS
101
+ // $ ./gradlew test
102
+ // EmailValidatorTest > valid email returns success PASSED
103
+ // EmailValidatorTest > empty email returns failure PASSED
104
+ // EmailValidatorTest > email without @ returns failure PASSED
105
+
106
+ // Step 6: Refactor if needed, verify tests still pass
107
+ ```
108
+
109
+ ### Kotest Spec Styles
110
+
111
+ #### StringSpec (Simplest)
112
+
113
+ ```kotlin
114
+ class CalculatorTest : StringSpec({
115
+ "add two positive numbers" {
116
+ Calculator.add(2, 3) shouldBe 5
117
+ }
118
+
119
+ "add negative numbers" {
120
+ Calculator.add(-1, -2) shouldBe -3
121
+ }
122
+
123
+ "add zero" {
124
+ Calculator.add(0, 5) shouldBe 5
125
+ }
126
+ })
127
+ ```
128
+
129
+ #### FunSpec (JUnit-like)
130
+
131
+ ```kotlin
132
+ class UserServiceTest : FunSpec({
133
+ val repository = mockk<UserRepository>()
134
+ val service = UserService(repository)
135
+
136
+ test("getUser returns user when found") {
137
+ val expected = User(id = "1", name = "Alice")
138
+ coEvery { repository.findById("1") } returns expected
139
+
140
+ val result = service.getUser("1")
141
+
142
+ result shouldBe expected
143
+ }
144
+
145
+ test("getUser throws when not found") {
146
+ coEvery { repository.findById("999") } returns null
147
+
148
+ shouldThrow<UserNotFoundException> {
149
+ service.getUser("999")
150
+ }
151
+ }
152
+ })
153
+ ```
154
+
155
+ #### BehaviorSpec (BDD Style)
156
+
157
+ ```kotlin
158
+ class OrderServiceTest : BehaviorSpec({
159
+ val repository = mockk<OrderRepository>()
160
+ val paymentService = mockk<PaymentService>()
161
+ val service = OrderService(repository, paymentService)
162
+
163
+ Given("a valid order request") {
164
+ val request = CreateOrderRequest(
165
+ userId = "user-1",
166
+ items = listOf(OrderItem("product-1", quantity = 2)),
167
+ )
168
+
169
+ When("the order is placed") {
170
+ coEvery { paymentService.charge(any()) } returns PaymentResult.Success
171
+ coEvery { repository.save(any()) } answers { firstArg() }
172
+
173
+ val result = service.placeOrder(request)
174
+
175
+ Then("it should return a confirmed order") {
176
+ result.status shouldBe OrderStatus.CONFIRMED
177
+ }
178
+
179
+ Then("it should charge payment") {
180
+ coVerify(exactly = 1) { paymentService.charge(any()) }
181
+ }
182
+ }
183
+
184
+ When("payment fails") {
185
+ coEvery { paymentService.charge(any()) } returns PaymentResult.Declined
186
+
187
+ Then("it should throw PaymentException") {
188
+ shouldThrow<PaymentException> {
189
+ service.placeOrder(request)
190
+ }
191
+ }
192
+ }
193
+ }
194
+ })
195
+ ```
196
+
197
+ #### DescribeSpec (RSpec Style)
198
+
199
+ ```kotlin
200
+ class UserValidatorTest : DescribeSpec({
201
+ describe("validateUser") {
202
+ val validator = UserValidator()
203
+
204
+ context("with valid input") {
205
+ it("accepts a normal user") {
206
+ val user = CreateUserRequest("Alice", "alice@example.com")
207
+ validator.validate(user).shouldBeValid()
208
+ }
209
+ }
210
+
211
+ context("with invalid name") {
212
+ it("rejects blank name") {
213
+ val user = CreateUserRequest("", "alice@example.com")
214
+ validator.validate(user).shouldBeInvalid()
215
+ }
216
+
217
+ it("rejects name exceeding max length") {
218
+ val user = CreateUserRequest("A".repeat(256), "alice@example.com")
219
+ validator.validate(user).shouldBeInvalid()
220
+ }
221
+ }
222
+ }
223
+ })
224
+ ```
225
+
226
+ ### Kotest Matchers
227
+
228
+ #### Core Matchers
229
+
230
+ ```kotlin
231
+ import io.kotest.matchers.shouldBe
232
+ import io.kotest.matchers.shouldNotBe
233
+ import io.kotest.matchers.string.*
234
+ import io.kotest.matchers.collections.*
235
+ import io.kotest.matchers.nulls.*
236
+
237
+ // Equality
238
+ result shouldBe expected
239
+ result shouldNotBe unexpected
240
+
241
+ // Strings
242
+ name shouldStartWith "Al"
243
+ name shouldEndWith "ice"
244
+ name shouldContain "lic"
245
+ name shouldMatch Regex("[A-Z][a-z]+")
246
+ name.shouldBeBlank()
247
+
248
+ // Collections
249
+ list shouldContain "item"
250
+ list shouldHaveSize 3
251
+ list.shouldBeSorted()
252
+ list.shouldContainAll("a", "b", "c")
253
+ list.shouldBeEmpty()
254
+
255
+ // Nulls
256
+ result.shouldNotBeNull()
257
+ result.shouldBeNull()
258
+
259
+ // Types
260
+ result.shouldBeInstanceOf<User>()
261
+
262
+ // Numbers
263
+ count shouldBeGreaterThan 0
264
+ price shouldBeInRange 1.0..100.0
265
+
266
+ // Exceptions
267
+ shouldThrow<IllegalArgumentException> {
268
+ validateAge(-1)
269
+ }.message shouldBe "Age must be positive"
270
+
271
+ shouldNotThrow<Exception> {
272
+ validateAge(25)
273
+ }
274
+ ```
275
+
276
+ #### Custom Matchers
277
+
278
+ ```kotlin
279
+ fun beActiveUser() = object : Matcher<User> {
280
+ override fun test(value: User) = MatcherResult(
281
+ value.isActive && value.lastLogin != null,
282
+ { "User ${value.id} should be active with a last login" },
283
+ { "User ${value.id} should not be active" },
284
+ )
285
+ }
286
+
287
+ // Usage
288
+ user should beActiveUser()
289
+ ```
290
+
291
+ ### MockK
292
+
293
+ #### Basic Mocking
294
+
295
+ ```kotlin
296
+ class UserServiceTest : FunSpec({
297
+ val repository = mockk<UserRepository>()
298
+ val logger = mockk<Logger>(relaxed = true) // Relaxed: returns defaults
299
+ val service = UserService(repository, logger)
300
+
301
+ beforeTest {
302
+ clearMocks(repository, logger)
303
+ }
304
+
305
+ test("findUser delegates to repository") {
306
+ val expected = User(id = "1", name = "Alice")
307
+ every { repository.findById("1") } returns expected
308
+
309
+ val result = service.findUser("1")
310
+
311
+ result shouldBe expected
312
+ verify(exactly = 1) { repository.findById("1") }
313
+ }
314
+
315
+ test("findUser returns null for unknown id") {
316
+ every { repository.findById(any()) } returns null
317
+
318
+ val result = service.findUser("unknown")
319
+
320
+ result.shouldBeNull()
321
+ }
322
+ })
323
+ ```
324
+
325
+ #### Coroutine Mocking
326
+
327
+ ```kotlin
328
+ class AsyncUserServiceTest : FunSpec({
329
+ val repository = mockk<UserRepository>()
330
+ val service = UserService(repository)
331
+
332
+ test("getUser suspending function") {
333
+ coEvery { repository.findById("1") } returns User(id = "1", name = "Alice")
334
+
335
+ val result = service.getUser("1")
336
+
337
+ result.name shouldBe "Alice"
338
+ coVerify { repository.findById("1") }
339
+ }
340
+
341
+ test("getUser with delay") {
342
+ coEvery { repository.findById("1") } coAnswers {
343
+ delay(100) // Simulate async work
344
+ User(id = "1", name = "Alice")
345
+ }
346
+
347
+ val result = service.getUser("1")
348
+ result.name shouldBe "Alice"
349
+ }
350
+ })
351
+ ```
352
+
353
+ #### Argument Capture
354
+
355
+ ```kotlin
356
+ test("save captures the user argument") {
357
+ val slot = slot<User>()
358
+ coEvery { repository.save(capture(slot)) } returns Unit
359
+
360
+ service.createUser(CreateUserRequest("Alice", "alice@example.com"))
361
+
362
+ slot.captured.name shouldBe "Alice"
363
+ slot.captured.email shouldBe "alice@example.com"
364
+ slot.captured.id.shouldNotBeNull()
365
+ }
366
+ ```
367
+
368
+ #### Spy and Partial Mocking
369
+
370
+ ```kotlin
371
+ test("spy on real object") {
372
+ val realService = UserService(repository)
373
+ val spy = spyk(realService)
374
+
375
+ every { spy.generateId() } returns "fixed-id"
376
+
377
+ spy.createUser(request)
378
+
379
+ verify { spy.generateId() } // Overridden
380
+ // Other methods use real implementation
381
+ }
382
+ ```
383
+
384
+ ### Coroutine Testing
385
+
386
+ #### runTest for Suspend Functions
387
+
388
+ ```kotlin
389
+ import kotlinx.coroutines.test.runTest
390
+
391
+ class CoroutineServiceTest : FunSpec({
392
+ test("concurrent fetches complete together") {
393
+ runTest {
394
+ val service = DataService(testScope = this)
395
+
396
+ val result = service.fetchAllData()
397
+
398
+ result.users.shouldNotBeEmpty()
399
+ result.products.shouldNotBeEmpty()
400
+ }
401
+ }
402
+
403
+ test("timeout after delay") {
404
+ runTest {
405
+ val service = SlowService()
406
+
407
+ shouldThrow<TimeoutCancellationException> {
408
+ withTimeout(100) {
409
+ service.slowOperation() // Takes > 100ms
410
+ }
411
+ }
412
+ }
413
+ }
414
+ })
415
+ ```
416
+
417
+ #### Testing Flows
418
+
419
+ ```kotlin
420
+ import io.kotest.matchers.collections.shouldContainInOrder
421
+ import kotlinx.coroutines.flow.MutableSharedFlow
422
+ import kotlinx.coroutines.flow.toList
423
+ import kotlinx.coroutines.launch
424
+ import kotlinx.coroutines.test.advanceTimeBy
425
+ import kotlinx.coroutines.test.runTest
426
+
427
+ class FlowServiceTest : FunSpec({
428
+ test("observeUsers emits updates") {
429
+ runTest {
430
+ val service = UserFlowService()
431
+
432
+ val emissions = service.observeUsers()
433
+ .take(3)
434
+ .toList()
435
+
436
+ emissions shouldHaveSize 3
437
+ emissions.last().shouldNotBeEmpty()
438
+ }
439
+ }
440
+
441
+ test("searchUsers debounces input") {
442
+ runTest {
443
+ val service = SearchService()
444
+ val queries = MutableSharedFlow<String>()
445
+
446
+ val results = mutableListOf<List<User>>()
447
+ val job = launch {
448
+ service.searchUsers(queries).collect { results.add(it) }
449
+ }
450
+
451
+ queries.emit("a")
452
+ queries.emit("ab")
453
+ queries.emit("abc") // Only this should trigger search
454
+ advanceTimeBy(500)
455
+
456
+ results shouldHaveSize 1
457
+ job.cancel()
458
+ }
459
+ }
460
+ })
461
+ ```
462
+
463
+ #### TestDispatcher
464
+
465
+ ```kotlin
466
+ import kotlinx.coroutines.test.StandardTestDispatcher
467
+ import kotlinx.coroutines.test.advanceUntilIdle
468
+
469
+ class DispatcherTest : FunSpec({
470
+ test("uses test dispatcher for controlled execution") {
471
+ val dispatcher = StandardTestDispatcher()
472
+
473
+ runTest(dispatcher) {
474
+ var completed = false
475
+
476
+ launch {
477
+ delay(1000)
478
+ completed = true
479
+ }
480
+
481
+ completed shouldBe false
482
+ advanceTimeBy(1000)
483
+ completed shouldBe true
484
+ }
485
+ }
486
+ })
487
+ ```
488
+
489
+ ### Property-Based Testing
490
+
491
+ #### Kotest Property Testing
492
+
493
+ ```kotlin
494
+ import io.kotest.core.spec.style.FunSpec
495
+ import io.kotest.property.Arb
496
+ import io.kotest.property.arbitrary.*
497
+ import io.kotest.property.forAll
498
+ import io.kotest.property.checkAll
499
+ import kotlinx.serialization.json.Json
500
+ import kotlinx.serialization.encodeToString
501
+ import kotlinx.serialization.decodeFromString
502
+
503
+ // Note: The serialization roundtrip test below requires the User data class
504
+ // to be annotated with @Serializable (from kotlinx.serialization).
505
+
506
+ class PropertyTest : FunSpec({
507
+ test("string reverse is involutory") {
508
+ forAll<String> { s ->
509
+ s.reversed().reversed() == s
510
+ }
511
+ }
512
+
513
+ test("list sort is idempotent") {
514
+ forAll(Arb.list(Arb.int())) { list ->
515
+ list.sorted() == list.sorted().sorted()
516
+ }
517
+ }
518
+
519
+ test("serialization roundtrip preserves data") {
520
+ checkAll(Arb.bind(Arb.string(1..50), Arb.string(5..100)) { name, email ->
521
+ User(name = name, email = "$email@test.com")
522
+ }) { user ->
523
+ val json = Json.encodeToString(user)
524
+ val decoded = Json.decodeFromString<User>(json)
525
+ decoded shouldBe user
526
+ }
527
+ }
528
+ })
529
+ ```
530
+
531
+ #### Custom Generators
532
+
533
+ ```kotlin
534
+ val userArb: Arb<User> = Arb.bind(
535
+ Arb.string(minSize = 1, maxSize = 50),
536
+ Arb.email(),
537
+ Arb.enum<Role>(),
538
+ ) { name, email, role ->
539
+ User(
540
+ id = UserId(UUID.randomUUID().toString()),
541
+ name = name,
542
+ email = Email(email),
543
+ role = role,
544
+ )
545
+ }
546
+
547
+ val moneyArb: Arb<Money> = Arb.bind(
548
+ Arb.long(1L..1_000_000L),
549
+ Arb.enum<Currency>(),
550
+ ) { amount, currency ->
551
+ Money(amount, currency)
552
+ }
553
+ ```
554
+
555
+ ### Data-Driven Testing
556
+
557
+ #### withData in Kotest
558
+
559
+ ```kotlin
560
+ class ParserTest : FunSpec({
561
+ context("parsing valid dates") {
562
+ withData(
563
+ "2026-01-15" to LocalDate(2026, 1, 15),
564
+ "2026-12-31" to LocalDate(2026, 12, 31),
565
+ "2000-01-01" to LocalDate(2000, 1, 1),
566
+ ) { (input, expected) ->
567
+ parseDate(input) shouldBe expected
568
+ }
569
+ }
570
+
571
+ context("rejecting invalid dates") {
572
+ withData(
573
+ nameFn = { "rejects '$it'" },
574
+ "not-a-date",
575
+ "2026-13-01",
576
+ "2026-00-15",
577
+ "",
578
+ ) { input ->
579
+ shouldThrow<DateParseException> {
580
+ parseDate(input)
581
+ }
582
+ }
583
+ }
584
+ })
585
+ ```
586
+
587
+ ### Test Lifecycle and Fixtures
588
+
589
+ #### BeforeTest / AfterTest
590
+
591
+ ```kotlin
592
+ class DatabaseTest : FunSpec({
593
+ lateinit var db: Database
594
+
595
+ beforeSpec {
596
+ db = Database.connect("jdbc:h2:mem:test;DB_CLOSE_DELAY=-1")
597
+ transaction(db) {
598
+ SchemaUtils.create(UsersTable)
599
+ }
600
+ }
601
+
602
+ afterSpec {
603
+ transaction(db) {
604
+ SchemaUtils.drop(UsersTable)
605
+ }
606
+ }
607
+
608
+ beforeTest {
609
+ transaction(db) {
610
+ UsersTable.deleteAll()
611
+ }
612
+ }
613
+
614
+ test("insert and retrieve user") {
615
+ transaction(db) {
616
+ UsersTable.insert {
617
+ it[name] = "Alice"
618
+ it[email] = "alice@example.com"
619
+ }
620
+ }
621
+
622
+ val users = transaction(db) {
623
+ UsersTable.selectAll().map { it[UsersTable.name] }
624
+ }
625
+
626
+ users shouldContain "Alice"
627
+ }
628
+ })
629
+ ```
630
+
631
+ #### Kotest Extensions
632
+
633
+ ```kotlin
634
+ // Reusable test extension
635
+ class DatabaseExtension : BeforeSpecListener, AfterSpecListener {
636
+ lateinit var db: Database
637
+
638
+ override suspend fun beforeSpec(spec: Spec) {
639
+ db = Database.connect("jdbc:h2:mem:test;DB_CLOSE_DELAY=-1")
640
+ }
641
+
642
+ override suspend fun afterSpec(spec: Spec) {
643
+ // cleanup
644
+ }
645
+ }
646
+
647
+ class UserRepositoryTest : FunSpec({
648
+ val dbExt = DatabaseExtension()
649
+ register(dbExt)
650
+
651
+ test("save and find user") {
652
+ val repo = UserRepository(dbExt.db)
653
+ // ...
654
+ }
655
+ })
656
+ ```
657
+
658
+ ### Kover Coverage
659
+
660
+ #### Gradle Configuration
661
+
662
+ ```kotlin
663
+ // build.gradle.kts
664
+ plugins {
665
+ id("org.jetbrains.kotlinx.kover") version "0.9.7"
666
+ }
667
+
668
+ kover {
669
+ reports {
670
+ total {
671
+ html { onCheck = true }
672
+ xml { onCheck = true }
673
+ }
674
+ filters {
675
+ excludes {
676
+ classes("*.generated.*", "*.config.*")
677
+ }
678
+ }
679
+ verify {
680
+ rule {
681
+ minBound(80) // Fail build below 80% coverage
682
+ }
683
+ }
684
+ }
685
+ }
686
+ ```
687
+
688
+ #### Coverage Commands
689
+
690
+ ```bash
691
+ # Run tests with coverage
692
+ ./gradlew koverHtmlReport
693
+
694
+ # Verify coverage thresholds
695
+ ./gradlew koverVerify
696
+
697
+ # XML report for CI
698
+ ./gradlew koverXmlReport
699
+
700
+ # View HTML report (use the command for your OS)
701
+ # macOS: open build/reports/kover/html/index.html
702
+ # Linux: xdg-open build/reports/kover/html/index.html
703
+ # Windows: start build/reports/kover/html/index.html
704
+ ```
705
+
706
+ #### Coverage Targets
707
+
708
+ | Code Type | Target |
709
+ |-----------|--------|
710
+ | Critical business logic | 100% |
711
+ | Public APIs | 90%+ |
712
+ | General code | 80%+ |
713
+ | Generated / config code | Exclude |
714
+
715
+ ### Ktor testApplication Testing
716
+
717
+ ```kotlin
718
+ class ApiRoutesTest : FunSpec({
719
+ test("GET /users returns list") {
720
+ testApplication {
721
+ application {
722
+ configureRouting()
723
+ configureSerialization()
724
+ }
725
+
726
+ val response = client.get("/users")
727
+
728
+ response.status shouldBe HttpStatusCode.OK
729
+ val users = response.body<List<UserResponse>>()
730
+ users.shouldNotBeEmpty()
731
+ }
732
+ }
733
+
734
+ test("POST /users creates user") {
735
+ testApplication {
736
+ application {
737
+ configureRouting()
738
+ configureSerialization()
739
+ }
740
+
741
+ val response = client.post("/users") {
742
+ contentType(ContentType.Application.Json)
743
+ setBody(CreateUserRequest("Alice", "alice@example.com"))
744
+ }
745
+
746
+ response.status shouldBe HttpStatusCode.Created
747
+ }
748
+ }
749
+ })
750
+ ```
751
+
752
+ ### Testing Commands
753
+
754
+ ```bash
755
+ # Run all tests
756
+ ./gradlew test
757
+
758
+ # Run specific test class
759
+ ./gradlew test --tests "com.example.UserServiceTest"
760
+
761
+ # Run specific test
762
+ ./gradlew test --tests "com.example.UserServiceTest.getUser returns user when found"
763
+
764
+ # Run with verbose output
765
+ ./gradlew test --info
766
+
767
+ # Run with coverage
768
+ ./gradlew koverHtmlReport
769
+
770
+ # Run detekt (static analysis)
771
+ ./gradlew detekt
772
+
773
+ # Run ktlint (formatting check)
774
+ ./gradlew ktlintCheck
775
+
776
+ # Continuous testing
777
+ ./gradlew test --continuous
778
+ ```
779
+
780
+ ### Best Practices
781
+
782
+ **DO:**
783
+ - Write tests FIRST (TDD)
784
+ - Use Kotest's spec styles consistently across the project
785
+ - Use MockK's `coEvery`/`coVerify` for suspend functions
786
+ - Use `runTest` for coroutine testing
787
+ - Test behavior, not implementation
788
+ - Use property-based testing for pure functions
789
+ - Use `data class` test fixtures for clarity
790
+
791
+ **DON'T:**
792
+ - Mix testing frameworks (pick Kotest and stick with it)
793
+ - Mock data classes (use real instances)
794
+ - Use `Thread.sleep()` in coroutine tests (use `advanceTimeBy`)
795
+ - Skip the RED phase in TDD
796
+ - Test private functions directly
797
+ - Ignore flaky tests
798
+
799
+ ### Integration with CI/CD
800
+
801
+ ```yaml
802
+ # GitHub Actions example
803
+ test:
804
+ runs-on: ubuntu-latest
805
+ steps:
806
+ - uses: actions/checkout@v4
807
+ - uses: actions/setup-java@v4
808
+ with:
809
+ distribution: 'temurin'
810
+ java-version: '21'
811
+
812
+ - name: Run tests with coverage
813
+ run: ./gradlew test koverXmlReport
814
+
815
+ - name: Verify coverage
816
+ run: ./gradlew koverVerify
817
+
818
+ - name: Upload coverage
819
+ uses: codecov/codecov-action@v5
820
+ with:
821
+ files: build/reports/kover/report.xml
822
+ token: ${{ secrets.CODECOV_TOKEN }}
823
+ ```
824
+
825
+ **Remember**: Tests are documentation. They show how your Kotlin code is meant to be used. Use Kotest's expressive matchers to make tests readable and MockK for clean mocking of dependencies.