@su-record/vibe 2.7.18 → 2.7.20

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 (345) hide show
  1. package/.env.example +37 -37
  2. package/CLAUDE.md +153 -153
  3. package/LICENSE +21 -21
  4. package/README.md +451 -449
  5. package/agents/architect-low.md +41 -41
  6. package/agents/architect-medium.md +59 -59
  7. package/agents/architect.md +80 -80
  8. package/agents/build-error-resolver.md +115 -115
  9. package/agents/compounder.md +261 -261
  10. package/agents/diagrammer.md +178 -178
  11. package/agents/docs/api-documenter.md +99 -99
  12. package/agents/docs/changelog-writer.md +93 -93
  13. package/agents/e2e-tester.md +294 -294
  14. package/agents/event/event-comms.md +78 -0
  15. package/agents/event/event-content.md +68 -0
  16. package/agents/event/event-image.md +95 -0
  17. package/agents/event/event-ops.md +84 -0
  18. package/agents/event/event-scheduler.md +69 -0
  19. package/agents/event/event-speaker.md +86 -0
  20. package/agents/explorer-low.md +42 -42
  21. package/agents/explorer-medium.md +59 -59
  22. package/agents/explorer.md +48 -48
  23. package/agents/implementer-low.md +43 -43
  24. package/agents/implementer-medium.md +52 -52
  25. package/agents/implementer.md +54 -54
  26. package/agents/junior-mentor.md +141 -141
  27. package/agents/planning/requirements-analyst.md +84 -84
  28. package/agents/planning/ux-advisor.md +83 -83
  29. package/agents/qa/acceptance-tester.md +86 -86
  30. package/agents/qa/edge-case-finder.md +93 -93
  31. package/agents/refactor-cleaner.md +143 -143
  32. package/agents/research/best-practices-agent.md +199 -199
  33. package/agents/research/codebase-patterns-agent.md +157 -157
  34. package/agents/research/framework-docs-agent.md +188 -188
  35. package/agents/research/security-advisory-agent.md +213 -213
  36. package/agents/review/architecture-reviewer.md +107 -107
  37. package/agents/review/complexity-reviewer.md +116 -116
  38. package/agents/review/data-integrity-reviewer.md +88 -88
  39. package/agents/review/git-history-reviewer.md +103 -103
  40. package/agents/review/performance-reviewer.md +86 -86
  41. package/agents/review/python-reviewer.md +150 -150
  42. package/agents/review/rails-reviewer.md +139 -139
  43. package/agents/review/react-reviewer.md +144 -144
  44. package/agents/review/security-reviewer.md +80 -80
  45. package/agents/review/simplicity-reviewer.md +140 -140
  46. package/agents/review/test-coverage-reviewer.md +116 -116
  47. package/agents/review/typescript-reviewer.md +127 -127
  48. package/agents/searcher.md +54 -54
  49. package/agents/simplifier.md +120 -120
  50. package/agents/tester.md +49 -49
  51. package/agents/ui/ui-a11y-auditor.md +93 -93
  52. package/agents/ui/ui-antipattern-detector.md +94 -94
  53. package/agents/ui/ui-dataviz-advisor.md +69 -69
  54. package/agents/ui/ui-design-system-gen.md +57 -57
  55. package/agents/ui/ui-industry-analyzer.md +49 -49
  56. package/agents/ui/ui-layout-architect.md +65 -65
  57. package/agents/ui/ui-stack-implementer.md +68 -68
  58. package/agents/ui/ux-compliance-reviewer.md +81 -81
  59. package/agents/ui-previewer.md +258 -258
  60. package/commands/vibe.analyze.md +379 -379
  61. package/commands/vibe.event.md +163 -0
  62. package/commands/vibe.review.md +607 -607
  63. package/commands/vibe.run.md +2217 -2124
  64. package/commands/vibe.spec.md +1195 -1195
  65. package/commands/vibe.spec.review.md +569 -569
  66. package/commands/vibe.trace.md +50 -0
  67. package/commands/vibe.utils.md +413 -413
  68. package/commands/vibe.verify.md +484 -484
  69. package/dist/__tests__/architecture.test.d.ts +2 -0
  70. package/dist/__tests__/architecture.test.d.ts.map +1 -0
  71. package/dist/__tests__/architecture.test.js +207 -0
  72. package/dist/__tests__/architecture.test.js.map +1 -0
  73. package/dist/cli/auth.js +3 -3
  74. package/dist/cli/auth.js.map +1 -1
  75. package/dist/cli/collaborator.js +52 -52
  76. package/dist/cli/commands/evolution.js +12 -12
  77. package/dist/cli/commands/info.d.ts.map +1 -1
  78. package/dist/cli/commands/info.js +45 -81
  79. package/dist/cli/commands/info.js.map +1 -1
  80. package/dist/cli/commands/init.js +5 -5
  81. package/dist/cli/commands/remove.js +14 -14
  82. package/dist/cli/commands/sentinel.js +27 -27
  83. package/dist/cli/commands/skills.js +5 -5
  84. package/dist/cli/commands/slack.js +10 -10
  85. package/dist/cli/commands/telegram.js +12 -12
  86. package/dist/cli/detect.d.ts.map +1 -1
  87. package/dist/cli/detect.js +55 -32
  88. package/dist/cli/detect.js.map +1 -1
  89. package/dist/cli/index.d.ts +1 -1
  90. package/dist/cli/index.d.ts.map +1 -1
  91. package/dist/cli/index.js +52 -52
  92. package/dist/cli/index.js.map +1 -1
  93. package/dist/cli/llm/claude-commands.js +16 -16
  94. package/dist/cli/llm/config.js +18 -18
  95. package/dist/cli/llm/gemini-commands.js +16 -16
  96. package/dist/cli/llm/gpt-commands.js +19 -19
  97. package/dist/cli/llm/help.js +21 -21
  98. package/dist/cli/postinstall/constants.d.ts.map +1 -1
  99. package/dist/cli/postinstall/constants.js +24 -0
  100. package/dist/cli/postinstall/constants.js.map +1 -1
  101. package/dist/cli/postinstall/cursor-agents.js +32 -32
  102. package/dist/cli/postinstall/cursor-rules.js +83 -83
  103. package/dist/cli/postinstall/cursor-skills.js +743 -743
  104. package/dist/cli/setup/Provisioner.js +42 -42
  105. package/dist/infra/lib/AutomationLevel.d.ts +48 -0
  106. package/dist/infra/lib/AutomationLevel.d.ts.map +1 -0
  107. package/dist/infra/lib/AutomationLevel.js +157 -0
  108. package/dist/infra/lib/AutomationLevel.js.map +1 -0
  109. package/dist/infra/lib/DecisionTracer.d.ts +81 -0
  110. package/dist/infra/lib/DecisionTracer.d.ts.map +1 -0
  111. package/dist/infra/lib/DecisionTracer.js +135 -0
  112. package/dist/infra/lib/DecisionTracer.js.map +1 -0
  113. package/dist/infra/lib/DeepInit.js +24 -24
  114. package/dist/infra/lib/InteractiveCheckpoint.d.ts +75 -0
  115. package/dist/infra/lib/InteractiveCheckpoint.d.ts.map +1 -0
  116. package/dist/infra/lib/InteractiveCheckpoint.js +179 -0
  117. package/dist/infra/lib/InteractiveCheckpoint.js.map +1 -0
  118. package/dist/infra/lib/IterationTracker.d.ts +44 -0
  119. package/dist/infra/lib/IterationTracker.d.ts.map +1 -1
  120. package/dist/infra/lib/IterationTracker.js +267 -12
  121. package/dist/infra/lib/IterationTracker.js.map +1 -1
  122. package/dist/infra/lib/LoopBreaker.d.ts +56 -0
  123. package/dist/infra/lib/LoopBreaker.d.ts.map +1 -0
  124. package/dist/infra/lib/LoopBreaker.js +109 -0
  125. package/dist/infra/lib/LoopBreaker.js.map +1 -0
  126. package/dist/infra/lib/PythonParser.js +108 -108
  127. package/dist/infra/lib/ReviewRace.js +96 -96
  128. package/dist/infra/lib/SkillFrontmatter.js +28 -28
  129. package/dist/infra/lib/SkillQualityGate.js +9 -9
  130. package/dist/infra/lib/SkillRepository.js +159 -159
  131. package/dist/infra/lib/UltraQA.js +99 -99
  132. package/dist/infra/lib/VerificationLoop.d.ts +105 -0
  133. package/dist/infra/lib/VerificationLoop.d.ts.map +1 -0
  134. package/dist/infra/lib/VerificationLoop.js +189 -0
  135. package/dist/infra/lib/VerificationLoop.js.map +1 -0
  136. package/dist/infra/lib/__tests__/AutomationLevel.test.d.ts +2 -0
  137. package/dist/infra/lib/__tests__/AutomationLevel.test.d.ts.map +1 -0
  138. package/dist/infra/lib/__tests__/AutomationLevel.test.js +297 -0
  139. package/dist/infra/lib/__tests__/AutomationLevel.test.js.map +1 -0
  140. package/dist/infra/lib/__tests__/DecisionTracer.test.d.ts +2 -0
  141. package/dist/infra/lib/__tests__/DecisionTracer.test.d.ts.map +1 -0
  142. package/dist/infra/lib/__tests__/DecisionTracer.test.js +274 -0
  143. package/dist/infra/lib/__tests__/DecisionTracer.test.js.map +1 -0
  144. package/dist/infra/lib/__tests__/InteractiveCheckpoint.test.d.ts +2 -0
  145. package/dist/infra/lib/__tests__/InteractiveCheckpoint.test.d.ts.map +1 -0
  146. package/dist/infra/lib/__tests__/InteractiveCheckpoint.test.js +350 -0
  147. package/dist/infra/lib/__tests__/InteractiveCheckpoint.test.js.map +1 -0
  148. package/dist/infra/lib/__tests__/LoopBreaker.test.d.ts +2 -0
  149. package/dist/infra/lib/__tests__/LoopBreaker.test.d.ts.map +1 -0
  150. package/dist/infra/lib/__tests__/LoopBreaker.test.js +340 -0
  151. package/dist/infra/lib/__tests__/LoopBreaker.test.js.map +1 -0
  152. package/dist/infra/lib/__tests__/VerificationLoop.test.d.ts +2 -0
  153. package/dist/infra/lib/__tests__/VerificationLoop.test.d.ts.map +1 -0
  154. package/dist/infra/lib/__tests__/VerificationLoop.test.js +486 -0
  155. package/dist/infra/lib/__tests__/VerificationLoop.test.js.map +1 -0
  156. package/dist/infra/lib/autonomy/AuditStore.js +41 -41
  157. package/dist/infra/lib/autonomy/ConfirmationStore.js +30 -30
  158. package/dist/infra/lib/autonomy/EventOutbox.js +38 -38
  159. package/dist/infra/lib/autonomy/PolicyEngine.d.ts +3 -3
  160. package/dist/infra/lib/autonomy/PolicyEngine.js +18 -18
  161. package/dist/infra/lib/autonomy/SecuritySentinel.js +1 -1
  162. package/dist/infra/lib/autonomy/SuggestionStore.js +33 -33
  163. package/dist/infra/lib/embedding/VectorStore.js +22 -22
  164. package/dist/infra/lib/embedding/__tests__/EmbeddingProvider.test.js +4 -0
  165. package/dist/infra/lib/embedding/__tests__/EmbeddingProvider.test.js.map +1 -1
  166. package/dist/infra/lib/evolution/AgentAnalyzer.js +10 -10
  167. package/dist/infra/lib/evolution/DeprecationDetector.d.ts +68 -0
  168. package/dist/infra/lib/evolution/DeprecationDetector.d.ts.map +1 -0
  169. package/dist/infra/lib/evolution/DeprecationDetector.js +207 -0
  170. package/dist/infra/lib/evolution/DeprecationDetector.js.map +1 -0
  171. package/dist/infra/lib/evolution/DescriptionOptimizer.js +21 -21
  172. package/dist/infra/lib/evolution/GenerationRegistry.js +36 -36
  173. package/dist/infra/lib/evolution/InsightStore.js +90 -90
  174. package/dist/infra/lib/evolution/ParityTester.d.ts +74 -0
  175. package/dist/infra/lib/evolution/ParityTester.d.ts.map +1 -0
  176. package/dist/infra/lib/evolution/ParityTester.js +238 -0
  177. package/dist/infra/lib/evolution/ParityTester.js.map +1 -0
  178. package/dist/infra/lib/evolution/RollbackManager.js +5 -5
  179. package/dist/infra/lib/evolution/SkillBenchmark.js +23 -23
  180. package/dist/infra/lib/evolution/SkillEvalRunner.js +50 -50
  181. package/dist/infra/lib/evolution/SkillGapDetector.js +10 -10
  182. package/dist/infra/lib/evolution/UsageTracker.js +28 -28
  183. package/dist/infra/lib/evolution/__tests__/deprecation.test.d.ts +2 -0
  184. package/dist/infra/lib/evolution/__tests__/deprecation.test.d.ts.map +1 -0
  185. package/dist/infra/lib/evolution/__tests__/deprecation.test.js +251 -0
  186. package/dist/infra/lib/evolution/__tests__/deprecation.test.js.map +1 -0
  187. package/dist/infra/lib/evolution/__tests__/parity.test.d.ts +2 -0
  188. package/dist/infra/lib/evolution/__tests__/parity.test.d.ts.map +1 -0
  189. package/dist/infra/lib/evolution/__tests__/parity.test.js +319 -0
  190. package/dist/infra/lib/evolution/__tests__/parity.test.js.map +1 -0
  191. package/dist/infra/lib/evolution/index.d.ts +4 -0
  192. package/dist/infra/lib/evolution/index.d.ts.map +1 -1
  193. package/dist/infra/lib/evolution/index.js +3 -0
  194. package/dist/infra/lib/evolution/index.js.map +1 -1
  195. package/dist/infra/lib/gemini/orchestration.js +5 -5
  196. package/dist/infra/lib/gpt/orchestration.js +4 -4
  197. package/dist/infra/lib/gpt/specializations.d.ts +1 -1
  198. package/dist/infra/lib/gpt/specializations.js +1 -1
  199. package/dist/infra/lib/memory/KnowledgeGraph.js +4 -4
  200. package/dist/infra/lib/memory/MemorySearch.js +57 -57
  201. package/dist/infra/lib/memory/MemoryStorage.js +181 -181
  202. package/dist/infra/lib/memory/ObservationStore.js +28 -28
  203. package/dist/infra/lib/memory/ReflectionStore.js +30 -30
  204. package/dist/infra/lib/memory/SessionRAGRetriever.js +7 -7
  205. package/dist/infra/lib/memory/SessionRAGStore.js +225 -225
  206. package/dist/infra/lib/memory/SessionSummarizer.js +9 -9
  207. package/dist/infra/lib/telemetry/SkillTelemetry.d.ts +6 -0
  208. package/dist/infra/lib/telemetry/SkillTelemetry.d.ts.map +1 -1
  209. package/dist/infra/lib/telemetry/SkillTelemetry.js +11 -0
  210. package/dist/infra/lib/telemetry/SkillTelemetry.js.map +1 -1
  211. package/dist/infra/orchestrator/AgentManager.js +12 -12
  212. package/dist/infra/orchestrator/AgentRegistry.js +65 -65
  213. package/dist/infra/orchestrator/BackgroundManager.d.ts.map +1 -1
  214. package/dist/infra/orchestrator/BackgroundManager.js +2 -0
  215. package/dist/infra/orchestrator/BackgroundManager.js.map +1 -1
  216. package/dist/infra/orchestrator/MultiLlmResearch.js +8 -8
  217. package/dist/infra/orchestrator/PhasePipeline.js +1 -1
  218. package/dist/infra/orchestrator/PhasePipeline.js.map +1 -1
  219. package/dist/infra/orchestrator/SwarmOrchestrator.test.js +16 -16
  220. package/dist/infra/orchestrator/parallelResearch.js +24 -24
  221. package/dist/tools/convention/analyzeComplexity.test.js +115 -115
  222. package/dist/tools/convention/validateCodeQuality.test.js +104 -104
  223. package/dist/tools/index.d.ts +16 -19
  224. package/dist/tools/index.d.ts.map +1 -1
  225. package/dist/tools/index.js +15 -27
  226. package/dist/tools/index.js.map +1 -1
  227. package/dist/tools/memory/createMemoryTimeline.js +10 -10
  228. package/dist/tools/memory/getMemoryGraph.js +12 -12
  229. package/dist/tools/memory/getSessionContext.js +9 -9
  230. package/dist/tools/memory/linkMemories.js +14 -14
  231. package/dist/tools/memory/listMemories.js +4 -4
  232. package/dist/tools/memory/recallMemory.js +4 -4
  233. package/dist/tools/memory/saveMemory.js +4 -4
  234. package/dist/tools/memory/searchMemoriesAdvanced.js +23 -23
  235. package/dist/tools/memory/startSession.js +1 -1
  236. package/dist/tools/memory/startSession.js.map +1 -1
  237. package/dist/tools/semantic/analyzeDependencyGraph.js +12 -12
  238. package/dist/tools/semantic/astGrep.test.js +6 -6
  239. package/dist/tools/spec/index.d.ts +0 -4
  240. package/dist/tools/spec/index.d.ts.map +1 -1
  241. package/dist/tools/spec/index.js +0 -4
  242. package/dist/tools/spec/index.js.map +1 -1
  243. package/dist/tools/spec/prdParser.test.js +171 -171
  244. package/dist/tools/spec/specGenerator.js +169 -169
  245. package/dist/tools/spec/traceabilityMatrix.js +64 -64
  246. package/dist/tools/spec/traceabilityMatrix.test.js +28 -28
  247. package/hooks/gemini-hooks.json +73 -73
  248. package/hooks/hooks.json +137 -137
  249. package/hooks/scripts/code-check.js +77 -77
  250. package/hooks/scripts/context-save.js +212 -212
  251. package/hooks/scripts/evolution-engine.js +69 -0
  252. package/hooks/scripts/hud-status.js +291 -291
  253. package/hooks/scripts/keyword-detector.js +214 -214
  254. package/hooks/scripts/llm-orchestrate.js +475 -475
  255. package/hooks/scripts/post-edit.js +32 -32
  256. package/hooks/scripts/pre-tool-guard.js +125 -125
  257. package/hooks/scripts/prompt-dispatcher.js +185 -185
  258. package/hooks/scripts/sentinel-guard.js +104 -104
  259. package/hooks/scripts/session-start.js +106 -106
  260. package/hooks/scripts/skill-injector.js +83 -0
  261. package/hooks/scripts/stop-notify.js +209 -209
  262. package/hooks/scripts/utils.js +100 -100
  263. package/languages/csharp-unity.md +515 -515
  264. package/languages/gdscript-godot.md +470 -470
  265. package/languages/ruby-rails.md +489 -489
  266. package/languages/typescript-angular.md +433 -433
  267. package/languages/typescript-astro.md +416 -416
  268. package/languages/typescript-electron.md +406 -406
  269. package/languages/typescript-nestjs.md +524 -524
  270. package/languages/typescript-svelte.md +407 -407
  271. package/languages/typescript-tauri.md +365 -365
  272. package/package.json +101 -123
  273. package/skills/agents-md/SKILL.md +120 -120
  274. package/skills/arch-guard/SKILL.md +180 -180
  275. package/skills/brand-assets/SKILL.md +146 -146
  276. package/skills/capability-loop/SKILL.md +167 -167
  277. package/skills/characterization-test/SKILL.md +206 -206
  278. package/skills/commerce-patterns/SKILL.md +63 -63
  279. package/skills/commit-push-pr/SKILL.md +75 -75
  280. package/skills/context7-usage/SKILL.md +105 -105
  281. package/skills/core-capabilities/SKILL.md +13 -13
  282. package/skills/e2e-commerce/SKILL.md +61 -61
  283. package/skills/event-comms/SKILL.md +161 -0
  284. package/skills/event-ops/SKILL.md +197 -0
  285. package/skills/event-planning/SKILL.md +131 -0
  286. package/skills/exec-plan/SKILL.md +147 -147
  287. package/skills/frontend-design/SKILL.md +12 -12
  288. package/skills/git-worktree/SKILL.md +72 -72
  289. package/skills/handoff/SKILL.md +109 -109
  290. package/skills/parallel-research/SKILL.md +87 -87
  291. package/skills/priority-todos/SKILL.md +63 -63
  292. package/skills/seo-checklist/SKILL.md +57 -57
  293. package/skills/techdebt/SKILL.md +122 -122
  294. package/skills/tool-fallback/SKILL.md +103 -103
  295. package/skills/typescript-advanced-types/SKILL.md +66 -66
  296. package/skills/ui-ux-pro-max/SKILL.md +221 -221
  297. package/skills/vercel-react-best-practices/SKILL.md +59 -59
  298. package/skills/video-production/SKILL.md +51 -51
  299. package/vibe/config.json +29 -29
  300. package/vibe/constitution.md +227 -227
  301. package/vibe/rules/principles/communication-guide.md +98 -98
  302. package/vibe/rules/principles/development-philosophy.md +52 -52
  303. package/vibe/rules/principles/quick-start.md +102 -102
  304. package/vibe/rules/quality/bdd-contract-testing.md +393 -393
  305. package/vibe/rules/quality/checklist.md +276 -276
  306. package/vibe/rules/quality/performance.md +236 -236
  307. package/vibe/rules/quality/testing-strategy.md +440 -440
  308. package/vibe/rules/standards/anti-patterns.md +541 -541
  309. package/vibe/rules/standards/code-structure.md +291 -291
  310. package/vibe/rules/standards/complexity-metrics.md +313 -313
  311. package/vibe/rules/standards/git-workflow.md +237 -237
  312. package/vibe/rules/standards/naming-conventions.md +198 -198
  313. package/vibe/rules/standards/security.md +305 -305
  314. package/vibe/rules/writing/document-style.md +74 -74
  315. package/vibe/setup.sh +31 -31
  316. package/vibe/templates/constitution-template.md +252 -252
  317. package/vibe/templates/contract-backend-template.md +526 -526
  318. package/vibe/templates/contract-frontend-template.md +599 -599
  319. package/vibe/templates/feature-template.md +96 -96
  320. package/vibe/templates/spec-template.md +221 -221
  321. package/vibe/ui-ux-data/charts.csv +26 -26
  322. package/vibe/ui-ux-data/colors.csv +97 -97
  323. package/vibe/ui-ux-data/icons.csv +101 -101
  324. package/vibe/ui-ux-data/landing.csv +31 -31
  325. package/vibe/ui-ux-data/products.csv +96 -96
  326. package/vibe/ui-ux-data/react-performance.csv +45 -45
  327. package/vibe/ui-ux-data/stacks/astro.csv +54 -54
  328. package/vibe/ui-ux-data/stacks/flutter.csv +53 -53
  329. package/vibe/ui-ux-data/stacks/html-tailwind.csv +56 -56
  330. package/vibe/ui-ux-data/stacks/jetpack-compose.csv +53 -53
  331. package/vibe/ui-ux-data/stacks/nextjs.csv +53 -53
  332. package/vibe/ui-ux-data/stacks/nuxt-ui.csv +51 -51
  333. package/vibe/ui-ux-data/stacks/nuxtjs.csv +59 -59
  334. package/vibe/ui-ux-data/stacks/react-native.csv +52 -52
  335. package/vibe/ui-ux-data/stacks/react.csv +54 -54
  336. package/vibe/ui-ux-data/stacks/shadcn.csv +61 -61
  337. package/vibe/ui-ux-data/stacks/svelte.csv +54 -54
  338. package/vibe/ui-ux-data/stacks/swiftui.csv +51 -51
  339. package/vibe/ui-ux-data/stacks/vue.csv +50 -50
  340. package/vibe/ui-ux-data/styles.csv +68 -68
  341. package/vibe/ui-ux-data/typography.csv +57 -57
  342. package/vibe/ui-ux-data/ui-reasoning.csv +101 -101
  343. package/vibe/ui-ux-data/ux-guidelines.csv +99 -99
  344. package/vibe/ui-ux-data/version.json +31 -31
  345. package/vibe/ui-ux-data/web-interface.csv +31 -31
@@ -1,526 +1,526 @@
1
- # Backend Contract Tests: {Feature Name}
2
-
3
- **Generated from**: `specs/{feature-name}.md` (Section 6: API Contract)
4
- **Framework**: {FastAPI | Django | Express | NestJS}
5
- **Language**: {Python | TypeScript | JavaScript}
6
- **Priority**: {HIGH | MEDIUM | LOW}
7
-
8
- ---
9
-
10
- ## Overview
11
-
12
- Contract Testing **validates API contracts (schemas)**:
13
-
14
- - ✅ Request/Response schema compliance
15
- - ✅ Status code matching
16
- - ✅ Header validation
17
- - ✅ Data types and required fields verification
18
-
19
- **Consumer → Provider contract assurance** (Pact pattern)
20
-
21
- ---
22
-
23
- ## API Contracts
24
-
25
- ### Contract 1: {Endpoint Name}
26
-
27
- **Endpoint**: `POST /api/v1/{resource}`
28
- **Mapped to**: REQ-001 in SPEC
29
-
30
- #### Request Contract
31
-
32
- ```json
33
- {
34
- "method": "POST",
35
- "path": "/api/v1/{resource}",
36
- "headers": {
37
- "Content-Type": "application/json",
38
- "Authorization": "Bearer {token}"
39
- },
40
- "body": {
41
- "field1": "string (required)",
42
- "field2": "integer (required)",
43
- "field3": "boolean (optional)"
44
- }
45
- }
46
- ```
47
-
48
- **JSON Schema**:
49
-
50
- ```json
51
- {
52
- "$schema": "http://json-schema.org/draft-07/schema#",
53
- "type": "object",
54
- "required": ["field1", "field2"],
55
- "properties": {
56
- "field1": {
57
- "type": "string",
58
- "minLength": 1,
59
- "maxLength": 100
60
- },
61
- "field2": {
62
- "type": "integer",
63
- "minimum": 0
64
- },
65
- "field3": {
66
- "type": "boolean",
67
- "default": false
68
- }
69
- },
70
- "additionalProperties": false
71
- }
72
- ```
73
-
74
- #### Response Contract (Success)
75
-
76
- ```json
77
- {
78
- "status": 201,
79
- "headers": {
80
- "Content-Type": "application/json"
81
- },
82
- "body": {
83
- "id": "uuid",
84
- "field1": "string",
85
- "field2": "integer",
86
- "field3": "boolean",
87
- "created_at": "datetime (ISO 8601)"
88
- }
89
- }
90
- ```
91
-
92
- **JSON Schema**:
93
-
94
- ```json
95
- {
96
- "$schema": "http://json-schema.org/draft-07/schema#",
97
- "type": "object",
98
- "required": ["id", "field1", "field2", "created_at"],
99
- "properties": {
100
- "id": {
101
- "type": "string",
102
- "format": "uuid"
103
- },
104
- "field1": {
105
- "type": "string"
106
- },
107
- "field2": {
108
- "type": "integer"
109
- },
110
- "field3": {
111
- "type": "boolean"
112
- },
113
- "created_at": {
114
- "type": "string",
115
- "format": "date-time"
116
- }
117
- }
118
- }
119
- ```
120
-
121
- #### Response Contract (Error)
122
-
123
- ```json
124
- {
125
- "status": 400,
126
- "body": {
127
- "error": "string",
128
- "message": "string",
129
- "details": ["array of strings (optional)"]
130
- }
131
- }
132
- ```
133
-
134
- ---
135
-
136
- ## Implementation
137
-
138
- ### Python (FastAPI + Pydantic)
139
-
140
- **File**: `tests/contract/test_{feature_name}_contract.py`
141
-
142
- ```python
143
- import pytest
144
- from fastapi.testclient import TestClient
145
- from jsonschema import validate, ValidationError
146
- from app.main import app
147
-
148
- client = TestClient(app)
149
-
150
- # JSON Schema definitions
151
- REQUEST_SCHEMA = {
152
- "$schema": "http://json-schema.org/draft-07/schema#",
153
- "type": "object",
154
- "required": ["field1", "field2"],
155
- "properties": {
156
- "field1": {"type": "string", "minLength": 1, "maxLength": 100},
157
- "field2": {"type": "integer", "minimum": 0},
158
- "field3": {"type": "boolean", "default": False}
159
- },
160
- "additionalProperties": False
161
- }
162
-
163
- RESPONSE_SCHEMA = {
164
- "$schema": "http://json-schema.org/draft-07/schema#",
165
- "type": "object",
166
- "required": ["id", "field1", "field2", "created_at"],
167
- "properties": {
168
- "id": {"type": "string", "format": "uuid"},
169
- "field1": {"type": "string"},
170
- "field2": {"type": "integer"},
171
- "field3": {"type": "boolean"},
172
- "created_at": {"type": "string", "format": "date-time"}
173
- }
174
- }
175
-
176
- class TestCreateResourceContract:
177
- """Contract tests for POST /api/v1/resource"""
178
-
179
- def test_request_schema_valid(self):
180
- """Request body matches contract schema"""
181
- payload = {
182
- "field1": "test value",
183
- "field2": 42,
184
- "field3": True
185
- }
186
- # Should not raise ValidationError
187
- validate(instance=payload, schema=REQUEST_SCHEMA)
188
-
189
- def test_request_schema_invalid_missing_required(self):
190
- """Request with missing required field is rejected"""
191
- payload = {
192
- "field1": "test value"
193
- # Missing field2
194
- }
195
- with pytest.raises(ValidationError):
196
- validate(instance=payload, schema=REQUEST_SCHEMA)
197
-
198
- def test_response_schema_success(self):
199
- """Response body matches contract schema (201 Created)"""
200
- payload = {
201
- "field1": "test value",
202
- "field2": 42,
203
- "field3": True
204
- }
205
- response = client.post(
206
- "/api/v1/resource",
207
- json=payload,
208
- headers={"Authorization": "Bearer test-token"}
209
- )
210
-
211
- # Status code contract
212
- assert response.status_code == 201
213
-
214
- # Response schema contract
215
- response_data = response.json()
216
- validate(instance=response_data, schema=RESPONSE_SCHEMA)
217
-
218
- # Data contract
219
- assert response_data["field1"] == payload["field1"]
220
- assert response_data["field2"] == payload["field2"]
221
- assert response_data["field3"] == payload["field3"]
222
-
223
- def test_response_schema_error(self):
224
- """Error response matches contract schema (400 Bad Request)"""
225
- payload = {
226
- "field1": "", # Invalid: empty string
227
- "field2": -1 # Invalid: negative
228
- }
229
- response = client.post(
230
- "/api/v1/resource",
231
- json=payload,
232
- headers={"Authorization": "Bearer test-token"}
233
- )
234
-
235
- # Status code contract
236
- assert response.status_code == 400
237
-
238
- # Error schema contract
239
- error_data = response.json()
240
- assert "error" in error_data
241
- assert "message" in error_data
242
- assert isinstance(error_data["message"], str)
243
-
244
- def test_headers_contract(self):
245
- """Response headers match contract"""
246
- payload = {
247
- "field1": "test value",
248
- "field2": 42
249
- }
250
- response = client.post(
251
- "/api/v1/resource",
252
- json=payload,
253
- headers={"Authorization": "Bearer test-token"}
254
- )
255
-
256
- assert response.headers["Content-Type"] == "application/json"
257
-
258
- @pytest.mark.parametrize("invalid_payload,expected_error", [
259
- ({"field1": "x" * 101, "field2": 42}, "field1 too long"),
260
- ({"field1": "test", "field2": -1}, "field2 must be positive"),
261
- ({"field2": 42}, "field1 is required"),
262
- ])
263
- def test_validation_errors(self, invalid_payload, expected_error):
264
- """Contract validation errors are properly handled"""
265
- response = client.post(
266
- "/api/v1/resource",
267
- json=invalid_payload,
268
- headers={"Authorization": "Bearer test-token"}
269
- )
270
- assert response.status_code == 400
271
- ```
272
-
273
- **Run**:
274
-
275
- ```bash
276
- pytest tests/contract/test_{feature_name}_contract.py -v --tb=short
277
- ```
278
-
279
- ---
280
-
281
- ### Python (Pact - Consumer-Driven Contracts)
282
-
283
- **File**: `tests/pact/consumer_test_{feature_name}.py`
284
-
285
- ```python
286
- import pytest
287
- from pact import Consumer, Provider, Like, EachLike, Format
288
-
289
- pact = Consumer('FrontendApp').has_pact_with(Provider('BackendAPI'))
290
-
291
- @pytest.fixture(scope='module')
292
- def setup_pact():
293
- pact.start_service()
294
- yield
295
- pact.stop_service()
296
-
297
- def test_create_resource_contract(setup_pact):
298
- """Consumer expects provider to create resource"""
299
- expected = {
300
- 'id': Format().uuid,
301
- 'field1': Like('test value'),
302
- 'field2': Like(42),
303
- 'field3': Like(True),
304
- 'created_at': Format().iso_8601_datetime
305
- }
306
-
307
- (pact
308
- .given('user is authenticated')
309
- .upon_receiving('a request to create resource')
310
- .with_request('POST', '/api/v1/resource',
311
- headers={'Authorization': Like('Bearer token')},
312
- body={
313
- 'field1': 'test value',
314
- 'field2': 42,
315
- 'field3': True
316
- })
317
- .will_respond_with(201, body=expected))
318
-
319
- with pact:
320
- # Test consumer code
321
- result = api_client.create_resource(field1='test value', field2=42)
322
- assert result['id'] is not None
323
- assert result['field1'] == 'test value'
324
- ```
325
-
326
- **Generate Pact file**:
327
-
328
- ```bash
329
- pytest tests/pact/ --pact-broker-url=https://your-pact-broker.com
330
- ```
331
-
332
- ---
333
-
334
- ### TypeScript (NestJS + Jest)
335
-
336
- **File**: `test/contract/{feature-name}.contract.spec.ts`
337
-
338
- ```typescript
339
- import { Test } from '@nestjs/testing';
340
- import { INestApplication, ValidationPipe } from '@nestjs/common';
341
- import * as request from 'supertest';
342
- import { AppModule } from '../src/app.module';
343
- import Ajv from 'ajv';
344
- import addFormats from 'ajv-formats';
345
-
346
- describe('Create Resource Contract (e2e)', () => {
347
- let app: INestApplication;
348
- const ajv = new Ajv();
349
- addFormats(ajv);
350
-
351
- const requestSchema = {
352
- type: 'object',
353
- required: ['field1', 'field2'],
354
- properties: {
355
- field1: { type: 'string', minLength: 1, maxLength: 100 },
356
- field2: { type: 'integer', minimum: 0 },
357
- field3: { type: 'boolean' }
358
- },
359
- additionalProperties: false
360
- };
361
-
362
- const responseSchema = {
363
- type: 'object',
364
- required: ['id', 'field1', 'field2', 'createdAt'],
365
- properties: {
366
- id: { type: 'string', format: 'uuid' },
367
- field1: { type: 'string' },
368
- field2: { type: 'integer' },
369
- field3: { type: 'boolean' },
370
- createdAt: { type: 'string', format: 'date-time' }
371
- }
372
- };
373
-
374
- beforeAll(async () => {
375
- const moduleFixture = await Test.createTestingModule({
376
- imports: [AppModule],
377
- }).compile();
378
-
379
- app = moduleFixture.createNestApplication();
380
- app.useGlobalPipes(new ValidationPipe());
381
- await app.init();
382
- });
383
-
384
- afterAll(async () => {
385
- await app.close();
386
- });
387
-
388
- it('POST /api/v1/resource - validates request schema', () => {
389
- const payload = {
390
- field1: 'test value',
391
- field2: 42,
392
- field3: true
393
- };
394
-
395
- const validate = ajv.compile(requestSchema);
396
- expect(validate(payload)).toBe(true);
397
- });
398
-
399
- it('POST /api/v1/resource - validates response schema (201)', async () => {
400
- const response = await request(app.getHttpServer())
401
- .post('/api/v1/resource')
402
- .set('Authorization', 'Bearer test-token')
403
- .send({
404
- field1: 'test value',
405
- field2: 42,
406
- field3: true
407
- })
408
- .expect(201)
409
- .expect('Content-Type', /json/);
410
-
411
- const validate = ajv.compile(responseSchema);
412
- expect(validate(response.body)).toBe(true);
413
- });
414
-
415
- it('POST /api/v1/resource - returns 400 for invalid request', async () => {
416
- await request(app.getHttpServer())
417
- .post('/api/v1/resource')
418
- .set('Authorization', 'Bearer test-token')
419
- .send({
420
- field1: '', // Invalid
421
- field2: -1 // Invalid
422
- })
423
- .expect(400);
424
- });
425
- });
426
- ```
427
-
428
- **Run**:
429
-
430
- ```bash
431
- npm test -- test/contract/{feature-name}.contract.spec.ts
432
- ```
433
-
434
- ---
435
-
436
- ## Contract Testing Strategy
437
-
438
- ### 1. Provider Tests (Backend)
439
-
440
- ```bash
441
- # Run all contract tests
442
- pytest tests/contract/ -v
443
-
444
- # Run specific contract
445
- pytest tests/contract/test_{feature_name}_contract.py
446
-
447
- # Generate Pact file for consumer
448
- pytest tests/pact/ --pact-broker-url=...
449
- ```
450
-
451
- ### 2. Consumer Tests (Frontend)
452
-
453
- ```bash
454
- # Verify against provider contract
455
- npm run test:contract -- --pact-broker-url=...
456
- ```
457
-
458
- ### 3. CI/CD Integration
459
-
460
- ```yaml
461
- # .github/workflows/contract-tests.yml
462
- name: Contract Tests
463
-
464
- on: [pull_request]
465
-
466
- jobs:
467
- contract-tests:
468
- runs-on: ubuntu-latest
469
- steps:
470
- - uses: actions/checkout@v2
471
- - name: Run provider contract tests
472
- run: pytest tests/contract/ -v
473
- - name: Publish Pact
474
- run: pytest tests/pact/ --pact-broker-url=${{ secrets.PACT_BROKER_URL }}
475
- ```
476
-
477
- ---
478
-
479
- ## Coverage Mapping
480
-
481
- | Contract | SPEC REQ | Endpoints | Status |
482
- |----------|----------|-----------|--------|
483
- | Create Resource | REQ-001 | POST /api/v1/resource | ⬜ |
484
- | Get Resource | REQ-002 | GET /api/v1/resource/:id | ⬜ |
485
- | Update Resource | REQ-003 | PATCH /api/v1/resource/:id | ⬜ |
486
-
487
- **Coverage**: 0 / {Total contracts} (0%)
488
-
489
- ---
490
-
491
- ## Best Practices
492
-
493
- 1. **Test Contract, Not Implementation**
494
- - ✅ Verify schema compliance
495
- - ❌ Do not test business logic
496
-
497
- 2. **Provider-First vs Consumer-First**
498
- - Provider-First: Define API first → Write contract tests
499
- - Consumer-First: Frontend requirements → Write Pact → Implement provider
500
-
501
- 3. **Version Control**
502
- - Manage contract files per API version
503
- - Detect breaking changes
504
-
505
- 4. **Pact Broker Usage**
506
- - Central contract management
507
- - Consumer-Provider matching
508
- - CI/CD automation
509
-
510
- ---
511
-
512
- ## Next Steps
513
-
514
- ```bash
515
- # 1. Write contract tests
516
- vibe contract "{feature name}"
517
-
518
- # 2. Implement provider
519
- vibe run "Task 1-1"
520
-
521
- # 3. Verify contract
522
- vibe test "{feature name}" --contract
523
-
524
- # 4. Publish Pact (optional)
525
- pytest tests/pact/ --pact-broker-url=...
526
- ```
1
+ # Backend Contract Tests: {Feature Name}
2
+
3
+ **Generated from**: `specs/{feature-name}.md` (Section 6: API Contract)
4
+ **Framework**: {FastAPI | Django | Express | NestJS}
5
+ **Language**: {Python | TypeScript | JavaScript}
6
+ **Priority**: {HIGH | MEDIUM | LOW}
7
+
8
+ ---
9
+
10
+ ## Overview
11
+
12
+ Contract Testing **validates API contracts (schemas)**:
13
+
14
+ - ✅ Request/Response schema compliance
15
+ - ✅ Status code matching
16
+ - ✅ Header validation
17
+ - ✅ Data types and required fields verification
18
+
19
+ **Consumer → Provider contract assurance** (Pact pattern)
20
+
21
+ ---
22
+
23
+ ## API Contracts
24
+
25
+ ### Contract 1: {Endpoint Name}
26
+
27
+ **Endpoint**: `POST /api/v1/{resource}`
28
+ **Mapped to**: REQ-001 in SPEC
29
+
30
+ #### Request Contract
31
+
32
+ ```json
33
+ {
34
+ "method": "POST",
35
+ "path": "/api/v1/{resource}",
36
+ "headers": {
37
+ "Content-Type": "application/json",
38
+ "Authorization": "Bearer {token}"
39
+ },
40
+ "body": {
41
+ "field1": "string (required)",
42
+ "field2": "integer (required)",
43
+ "field3": "boolean (optional)"
44
+ }
45
+ }
46
+ ```
47
+
48
+ **JSON Schema**:
49
+
50
+ ```json
51
+ {
52
+ "$schema": "http://json-schema.org/draft-07/schema#",
53
+ "type": "object",
54
+ "required": ["field1", "field2"],
55
+ "properties": {
56
+ "field1": {
57
+ "type": "string",
58
+ "minLength": 1,
59
+ "maxLength": 100
60
+ },
61
+ "field2": {
62
+ "type": "integer",
63
+ "minimum": 0
64
+ },
65
+ "field3": {
66
+ "type": "boolean",
67
+ "default": false
68
+ }
69
+ },
70
+ "additionalProperties": false
71
+ }
72
+ ```
73
+
74
+ #### Response Contract (Success)
75
+
76
+ ```json
77
+ {
78
+ "status": 201,
79
+ "headers": {
80
+ "Content-Type": "application/json"
81
+ },
82
+ "body": {
83
+ "id": "uuid",
84
+ "field1": "string",
85
+ "field2": "integer",
86
+ "field3": "boolean",
87
+ "created_at": "datetime (ISO 8601)"
88
+ }
89
+ }
90
+ ```
91
+
92
+ **JSON Schema**:
93
+
94
+ ```json
95
+ {
96
+ "$schema": "http://json-schema.org/draft-07/schema#",
97
+ "type": "object",
98
+ "required": ["id", "field1", "field2", "created_at"],
99
+ "properties": {
100
+ "id": {
101
+ "type": "string",
102
+ "format": "uuid"
103
+ },
104
+ "field1": {
105
+ "type": "string"
106
+ },
107
+ "field2": {
108
+ "type": "integer"
109
+ },
110
+ "field3": {
111
+ "type": "boolean"
112
+ },
113
+ "created_at": {
114
+ "type": "string",
115
+ "format": "date-time"
116
+ }
117
+ }
118
+ }
119
+ ```
120
+
121
+ #### Response Contract (Error)
122
+
123
+ ```json
124
+ {
125
+ "status": 400,
126
+ "body": {
127
+ "error": "string",
128
+ "message": "string",
129
+ "details": ["array of strings (optional)"]
130
+ }
131
+ }
132
+ ```
133
+
134
+ ---
135
+
136
+ ## Implementation
137
+
138
+ ### Python (FastAPI + Pydantic)
139
+
140
+ **File**: `tests/contract/test_{feature_name}_contract.py`
141
+
142
+ ```python
143
+ import pytest
144
+ from fastapi.testclient import TestClient
145
+ from jsonschema import validate, ValidationError
146
+ from app.main import app
147
+
148
+ client = TestClient(app)
149
+
150
+ # JSON Schema definitions
151
+ REQUEST_SCHEMA = {
152
+ "$schema": "http://json-schema.org/draft-07/schema#",
153
+ "type": "object",
154
+ "required": ["field1", "field2"],
155
+ "properties": {
156
+ "field1": {"type": "string", "minLength": 1, "maxLength": 100},
157
+ "field2": {"type": "integer", "minimum": 0},
158
+ "field3": {"type": "boolean", "default": False}
159
+ },
160
+ "additionalProperties": False
161
+ }
162
+
163
+ RESPONSE_SCHEMA = {
164
+ "$schema": "http://json-schema.org/draft-07/schema#",
165
+ "type": "object",
166
+ "required": ["id", "field1", "field2", "created_at"],
167
+ "properties": {
168
+ "id": {"type": "string", "format": "uuid"},
169
+ "field1": {"type": "string"},
170
+ "field2": {"type": "integer"},
171
+ "field3": {"type": "boolean"},
172
+ "created_at": {"type": "string", "format": "date-time"}
173
+ }
174
+ }
175
+
176
+ class TestCreateResourceContract:
177
+ """Contract tests for POST /api/v1/resource"""
178
+
179
+ def test_request_schema_valid(self):
180
+ """Request body matches contract schema"""
181
+ payload = {
182
+ "field1": "test value",
183
+ "field2": 42,
184
+ "field3": True
185
+ }
186
+ # Should not raise ValidationError
187
+ validate(instance=payload, schema=REQUEST_SCHEMA)
188
+
189
+ def test_request_schema_invalid_missing_required(self):
190
+ """Request with missing required field is rejected"""
191
+ payload = {
192
+ "field1": "test value"
193
+ # Missing field2
194
+ }
195
+ with pytest.raises(ValidationError):
196
+ validate(instance=payload, schema=REQUEST_SCHEMA)
197
+
198
+ def test_response_schema_success(self):
199
+ """Response body matches contract schema (201 Created)"""
200
+ payload = {
201
+ "field1": "test value",
202
+ "field2": 42,
203
+ "field3": True
204
+ }
205
+ response = client.post(
206
+ "/api/v1/resource",
207
+ json=payload,
208
+ headers={"Authorization": "Bearer test-token"}
209
+ )
210
+
211
+ # Status code contract
212
+ assert response.status_code == 201
213
+
214
+ # Response schema contract
215
+ response_data = response.json()
216
+ validate(instance=response_data, schema=RESPONSE_SCHEMA)
217
+
218
+ # Data contract
219
+ assert response_data["field1"] == payload["field1"]
220
+ assert response_data["field2"] == payload["field2"]
221
+ assert response_data["field3"] == payload["field3"]
222
+
223
+ def test_response_schema_error(self):
224
+ """Error response matches contract schema (400 Bad Request)"""
225
+ payload = {
226
+ "field1": "", # Invalid: empty string
227
+ "field2": -1 # Invalid: negative
228
+ }
229
+ response = client.post(
230
+ "/api/v1/resource",
231
+ json=payload,
232
+ headers={"Authorization": "Bearer test-token"}
233
+ )
234
+
235
+ # Status code contract
236
+ assert response.status_code == 400
237
+
238
+ # Error schema contract
239
+ error_data = response.json()
240
+ assert "error" in error_data
241
+ assert "message" in error_data
242
+ assert isinstance(error_data["message"], str)
243
+
244
+ def test_headers_contract(self):
245
+ """Response headers match contract"""
246
+ payload = {
247
+ "field1": "test value",
248
+ "field2": 42
249
+ }
250
+ response = client.post(
251
+ "/api/v1/resource",
252
+ json=payload,
253
+ headers={"Authorization": "Bearer test-token"}
254
+ )
255
+
256
+ assert response.headers["Content-Type"] == "application/json"
257
+
258
+ @pytest.mark.parametrize("invalid_payload,expected_error", [
259
+ ({"field1": "x" * 101, "field2": 42}, "field1 too long"),
260
+ ({"field1": "test", "field2": -1}, "field2 must be positive"),
261
+ ({"field2": 42}, "field1 is required"),
262
+ ])
263
+ def test_validation_errors(self, invalid_payload, expected_error):
264
+ """Contract validation errors are properly handled"""
265
+ response = client.post(
266
+ "/api/v1/resource",
267
+ json=invalid_payload,
268
+ headers={"Authorization": "Bearer test-token"}
269
+ )
270
+ assert response.status_code == 400
271
+ ```
272
+
273
+ **Run**:
274
+
275
+ ```bash
276
+ pytest tests/contract/test_{feature_name}_contract.py -v --tb=short
277
+ ```
278
+
279
+ ---
280
+
281
+ ### Python (Pact - Consumer-Driven Contracts)
282
+
283
+ **File**: `tests/pact/consumer_test_{feature_name}.py`
284
+
285
+ ```python
286
+ import pytest
287
+ from pact import Consumer, Provider, Like, EachLike, Format
288
+
289
+ pact = Consumer('FrontendApp').has_pact_with(Provider('BackendAPI'))
290
+
291
+ @pytest.fixture(scope='module')
292
+ def setup_pact():
293
+ pact.start_service()
294
+ yield
295
+ pact.stop_service()
296
+
297
+ def test_create_resource_contract(setup_pact):
298
+ """Consumer expects provider to create resource"""
299
+ expected = {
300
+ 'id': Format().uuid,
301
+ 'field1': Like('test value'),
302
+ 'field2': Like(42),
303
+ 'field3': Like(True),
304
+ 'created_at': Format().iso_8601_datetime
305
+ }
306
+
307
+ (pact
308
+ .given('user is authenticated')
309
+ .upon_receiving('a request to create resource')
310
+ .with_request('POST', '/api/v1/resource',
311
+ headers={'Authorization': Like('Bearer token')},
312
+ body={
313
+ 'field1': 'test value',
314
+ 'field2': 42,
315
+ 'field3': True
316
+ })
317
+ .will_respond_with(201, body=expected))
318
+
319
+ with pact:
320
+ # Test consumer code
321
+ result = api_client.create_resource(field1='test value', field2=42)
322
+ assert result['id'] is not None
323
+ assert result['field1'] == 'test value'
324
+ ```
325
+
326
+ **Generate Pact file**:
327
+
328
+ ```bash
329
+ pytest tests/pact/ --pact-broker-url=https://your-pact-broker.com
330
+ ```
331
+
332
+ ---
333
+
334
+ ### TypeScript (NestJS + Jest)
335
+
336
+ **File**: `test/contract/{feature-name}.contract.spec.ts`
337
+
338
+ ```typescript
339
+ import { Test } from '@nestjs/testing';
340
+ import { INestApplication, ValidationPipe } from '@nestjs/common';
341
+ import * as request from 'supertest';
342
+ import { AppModule } from '../src/app.module';
343
+ import Ajv from 'ajv';
344
+ import addFormats from 'ajv-formats';
345
+
346
+ describe('Create Resource Contract (e2e)', () => {
347
+ let app: INestApplication;
348
+ const ajv = new Ajv();
349
+ addFormats(ajv);
350
+
351
+ const requestSchema = {
352
+ type: 'object',
353
+ required: ['field1', 'field2'],
354
+ properties: {
355
+ field1: { type: 'string', minLength: 1, maxLength: 100 },
356
+ field2: { type: 'integer', minimum: 0 },
357
+ field3: { type: 'boolean' }
358
+ },
359
+ additionalProperties: false
360
+ };
361
+
362
+ const responseSchema = {
363
+ type: 'object',
364
+ required: ['id', 'field1', 'field2', 'createdAt'],
365
+ properties: {
366
+ id: { type: 'string', format: 'uuid' },
367
+ field1: { type: 'string' },
368
+ field2: { type: 'integer' },
369
+ field3: { type: 'boolean' },
370
+ createdAt: { type: 'string', format: 'date-time' }
371
+ }
372
+ };
373
+
374
+ beforeAll(async () => {
375
+ const moduleFixture = await Test.createTestingModule({
376
+ imports: [AppModule],
377
+ }).compile();
378
+
379
+ app = moduleFixture.createNestApplication();
380
+ app.useGlobalPipes(new ValidationPipe());
381
+ await app.init();
382
+ });
383
+
384
+ afterAll(async () => {
385
+ await app.close();
386
+ });
387
+
388
+ it('POST /api/v1/resource - validates request schema', () => {
389
+ const payload = {
390
+ field1: 'test value',
391
+ field2: 42,
392
+ field3: true
393
+ };
394
+
395
+ const validate = ajv.compile(requestSchema);
396
+ expect(validate(payload)).toBe(true);
397
+ });
398
+
399
+ it('POST /api/v1/resource - validates response schema (201)', async () => {
400
+ const response = await request(app.getHttpServer())
401
+ .post('/api/v1/resource')
402
+ .set('Authorization', 'Bearer test-token')
403
+ .send({
404
+ field1: 'test value',
405
+ field2: 42,
406
+ field3: true
407
+ })
408
+ .expect(201)
409
+ .expect('Content-Type', /json/);
410
+
411
+ const validate = ajv.compile(responseSchema);
412
+ expect(validate(response.body)).toBe(true);
413
+ });
414
+
415
+ it('POST /api/v1/resource - returns 400 for invalid request', async () => {
416
+ await request(app.getHttpServer())
417
+ .post('/api/v1/resource')
418
+ .set('Authorization', 'Bearer test-token')
419
+ .send({
420
+ field1: '', // Invalid
421
+ field2: -1 // Invalid
422
+ })
423
+ .expect(400);
424
+ });
425
+ });
426
+ ```
427
+
428
+ **Run**:
429
+
430
+ ```bash
431
+ npm test -- test/contract/{feature-name}.contract.spec.ts
432
+ ```
433
+
434
+ ---
435
+
436
+ ## Contract Testing Strategy
437
+
438
+ ### 1. Provider Tests (Backend)
439
+
440
+ ```bash
441
+ # Run all contract tests
442
+ pytest tests/contract/ -v
443
+
444
+ # Run specific contract
445
+ pytest tests/contract/test_{feature_name}_contract.py
446
+
447
+ # Generate Pact file for consumer
448
+ pytest tests/pact/ --pact-broker-url=...
449
+ ```
450
+
451
+ ### 2. Consumer Tests (Frontend)
452
+
453
+ ```bash
454
+ # Verify against provider contract
455
+ npm run test:contract -- --pact-broker-url=...
456
+ ```
457
+
458
+ ### 3. CI/CD Integration
459
+
460
+ ```yaml
461
+ # .github/workflows/contract-tests.yml
462
+ name: Contract Tests
463
+
464
+ on: [pull_request]
465
+
466
+ jobs:
467
+ contract-tests:
468
+ runs-on: ubuntu-latest
469
+ steps:
470
+ - uses: actions/checkout@v2
471
+ - name: Run provider contract tests
472
+ run: pytest tests/contract/ -v
473
+ - name: Publish Pact
474
+ run: pytest tests/pact/ --pact-broker-url=${{ secrets.PACT_BROKER_URL }}
475
+ ```
476
+
477
+ ---
478
+
479
+ ## Coverage Mapping
480
+
481
+ | Contract | SPEC REQ | Endpoints | Status |
482
+ |----------|----------|-----------|--------|
483
+ | Create Resource | REQ-001 | POST /api/v1/resource | ⬜ |
484
+ | Get Resource | REQ-002 | GET /api/v1/resource/:id | ⬜ |
485
+ | Update Resource | REQ-003 | PATCH /api/v1/resource/:id | ⬜ |
486
+
487
+ **Coverage**: 0 / {Total contracts} (0%)
488
+
489
+ ---
490
+
491
+ ## Best Practices
492
+
493
+ 1. **Test Contract, Not Implementation**
494
+ - ✅ Verify schema compliance
495
+ - ❌ Do not test business logic
496
+
497
+ 2. **Provider-First vs Consumer-First**
498
+ - Provider-First: Define API first → Write contract tests
499
+ - Consumer-First: Frontend requirements → Write Pact → Implement provider
500
+
501
+ 3. **Version Control**
502
+ - Manage contract files per API version
503
+ - Detect breaking changes
504
+
505
+ 4. **Pact Broker Usage**
506
+ - Central contract management
507
+ - Consumer-Provider matching
508
+ - CI/CD automation
509
+
510
+ ---
511
+
512
+ ## Next Steps
513
+
514
+ ```bash
515
+ # 1. Write contract tests
516
+ vibe contract "{feature name}"
517
+
518
+ # 2. Implement provider
519
+ vibe run "Task 1-1"
520
+
521
+ # 3. Verify contract
522
+ vibe test "{feature name}" --contract
523
+
524
+ # 4. Publish Pact (optional)
525
+ pytest tests/pact/ --pact-broker-url=...
526
+ ```