@su-record/vibe 2.6.26 → 2.6.28

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 (287) hide show
  1. package/CLAUDE.md +202 -153
  2. package/LICENSE +21 -21
  3. package/README.md +267 -236
  4. package/agents/architect-low.md +41 -41
  5. package/agents/architect-medium.md +59 -59
  6. package/agents/architect.md +80 -80
  7. package/agents/build-error-resolver.md +115 -115
  8. package/agents/compounder.md +261 -261
  9. package/agents/diagrammer.md +178 -178
  10. package/agents/docs/api-documenter.md +99 -99
  11. package/agents/docs/changelog-writer.md +93 -93
  12. package/agents/e2e-tester.md +266 -266
  13. package/agents/explorer-low.md +42 -42
  14. package/agents/explorer-medium.md +59 -59
  15. package/agents/explorer.md +48 -48
  16. package/agents/implementer-low.md +43 -43
  17. package/agents/implementer-medium.md +52 -52
  18. package/agents/implementer.md +54 -54
  19. package/agents/planning/requirements-analyst.md +84 -84
  20. package/agents/planning/ux-advisor.md +83 -83
  21. package/agents/qa/acceptance-tester.md +86 -86
  22. package/agents/qa/edge-case-finder.md +93 -93
  23. package/agents/refactor-cleaner.md +143 -143
  24. package/agents/research/best-practices-agent.md +199 -199
  25. package/agents/research/codebase-patterns-agent.md +157 -157
  26. package/agents/research/framework-docs-agent.md +188 -188
  27. package/agents/research/security-advisory-agent.md +213 -213
  28. package/agents/review/architecture-reviewer.md +107 -107
  29. package/agents/review/complexity-reviewer.md +116 -116
  30. package/agents/review/data-integrity-reviewer.md +88 -88
  31. package/agents/review/git-history-reviewer.md +103 -103
  32. package/agents/review/performance-reviewer.md +86 -86
  33. package/agents/review/python-reviewer.md +150 -150
  34. package/agents/review/rails-reviewer.md +139 -139
  35. package/agents/review/react-reviewer.md +144 -144
  36. package/agents/review/security-reviewer.md +80 -80
  37. package/agents/review/simplicity-reviewer.md +140 -140
  38. package/agents/review/test-coverage-reviewer.md +116 -116
  39. package/agents/review/typescript-reviewer.md +127 -127
  40. package/agents/searcher.md +54 -54
  41. package/agents/simplifier.md +120 -120
  42. package/agents/tester.md +49 -49
  43. package/agents/ui-previewer.md +268 -268
  44. package/commands/vibe.analyze.md +356 -356
  45. package/commands/vibe.reason.md +329 -329
  46. package/commands/vibe.review.md +423 -423
  47. package/commands/vibe.run.md +1313 -1313
  48. package/commands/vibe.spec.md +1054 -1054
  49. package/commands/vibe.spec.review.md +412 -412
  50. package/commands/vibe.trace.md +161 -161
  51. package/commands/vibe.utils.md +376 -376
  52. package/commands/vibe.verify.md +375 -375
  53. package/dist/cli/collaborator.js +52 -52
  54. package/dist/cli/detect.js +32 -32
  55. package/dist/cli/hud.js +20 -20
  56. package/dist/cli/index.js +112 -112
  57. package/dist/cli/llm.js +144 -144
  58. package/dist/cli/mcp.d.ts +49 -0
  59. package/dist/cli/mcp.d.ts.map +1 -0
  60. package/dist/cli/mcp.js +169 -0
  61. package/dist/cli/mcp.js.map +1 -0
  62. package/dist/cli/postinstall.d.ts.map +1 -1
  63. package/dist/cli/postinstall.js +886 -858
  64. package/dist/cli/postinstall.js.map +1 -1
  65. package/dist/cli/setup/GlobalInstaller.d.ts +6 -0
  66. package/dist/cli/setup/GlobalInstaller.d.ts.map +1 -1
  67. package/dist/cli/setup/GlobalInstaller.js +26 -0
  68. package/dist/cli/setup/GlobalInstaller.js.map +1 -1
  69. package/dist/lib/DeepInit.js +24 -24
  70. package/dist/lib/IterationTracker.js +11 -11
  71. package/dist/lib/MemoryManager.d.ts +30 -0
  72. package/dist/lib/MemoryManager.d.ts.map +1 -1
  73. package/dist/lib/MemoryManager.js +74 -0
  74. package/dist/lib/MemoryManager.js.map +1 -1
  75. package/dist/lib/PythonParser.js +108 -108
  76. package/dist/lib/ReviewRace.js +96 -96
  77. package/dist/lib/SkillFrontmatter.js +28 -28
  78. package/dist/lib/SkillQualityGate.js +9 -9
  79. package/dist/lib/SkillRepository.js +159 -159
  80. package/dist/lib/UltraQA.js +77 -77
  81. package/dist/lib/gemini-api.js +5 -5
  82. package/dist/lib/gemini-mcp.d.ts +10 -0
  83. package/dist/lib/gemini-mcp.d.ts.map +1 -0
  84. package/dist/lib/gemini-mcp.js +353 -0
  85. package/dist/lib/gemini-mcp.js.map +1 -0
  86. package/dist/lib/gpt-api.js +4 -4
  87. package/dist/lib/gpt-mcp.d.ts +10 -0
  88. package/dist/lib/gpt-mcp.d.ts.map +1 -0
  89. package/dist/lib/gpt-mcp.js +352 -0
  90. package/dist/lib/gpt-mcp.js.map +1 -0
  91. package/dist/lib/memory/KnowledgeGraph.js +4 -4
  92. package/dist/lib/memory/MemorySearch.js +43 -43
  93. package/dist/lib/memory/MemoryStorage.js +130 -130
  94. package/dist/lib/memory/ObservationStore.js +28 -28
  95. package/dist/lib/memory/SessionRAGRetriever.d.ts +66 -0
  96. package/dist/lib/memory/SessionRAGRetriever.d.ts.map +1 -0
  97. package/dist/lib/memory/SessionRAGRetriever.js +196 -0
  98. package/dist/lib/memory/SessionRAGRetriever.js.map +1 -0
  99. package/dist/lib/memory/SessionRAGRetriever.test.d.ts +2 -0
  100. package/dist/lib/memory/SessionRAGRetriever.test.d.ts.map +1 -0
  101. package/dist/lib/memory/SessionRAGRetriever.test.js +180 -0
  102. package/dist/lib/memory/SessionRAGRetriever.test.js.map +1 -0
  103. package/dist/lib/memory/SessionRAGStore.d.ts +153 -0
  104. package/dist/lib/memory/SessionRAGStore.d.ts.map +1 -0
  105. package/dist/lib/memory/SessionRAGStore.js +673 -0
  106. package/dist/lib/memory/SessionRAGStore.js.map +1 -0
  107. package/dist/lib/memory/SessionRAGStore.test.d.ts +2 -0
  108. package/dist/lib/memory/SessionRAGStore.test.d.ts.map +1 -0
  109. package/dist/lib/memory/SessionRAGStore.test.js +326 -0
  110. package/dist/lib/memory/SessionRAGStore.test.js.map +1 -0
  111. package/dist/lib/memory/SessionSummarizer.js +9 -9
  112. package/dist/orchestrator/AgentManager.js +12 -12
  113. package/dist/orchestrator/MultiLlmResearch.js +8 -8
  114. package/dist/orchestrator/SmartRouter.js +11 -11
  115. package/dist/orchestrator/SwarmOrchestrator.test.js +16 -16
  116. package/dist/orchestrator/parallelResearch.js +24 -24
  117. package/dist/tools/analytics/getUsageAnalytics.d.ts +10 -0
  118. package/dist/tools/analytics/getUsageAnalytics.d.ts.map +1 -0
  119. package/dist/tools/analytics/getUsageAnalytics.js +246 -0
  120. package/dist/tools/analytics/getUsageAnalytics.js.map +1 -0
  121. package/dist/tools/analytics/index.d.ts +5 -0
  122. package/dist/tools/analytics/index.d.ts.map +1 -0
  123. package/dist/tools/analytics/index.js +5 -0
  124. package/dist/tools/analytics/index.js.map +1 -0
  125. package/dist/tools/convention/analyzeComplexity.test.js +115 -115
  126. package/dist/tools/convention/getCodingGuide.d.ts +7 -0
  127. package/dist/tools/convention/getCodingGuide.d.ts.map +1 -0
  128. package/dist/tools/convention/getCodingGuide.js +69 -0
  129. package/dist/tools/convention/getCodingGuide.js.map +1 -0
  130. package/dist/tools/convention/validateCodeQuality.test.js +104 -104
  131. package/dist/tools/index.d.ts +5 -0
  132. package/dist/tools/index.d.ts.map +1 -1
  133. package/dist/tools/index.js +4 -0
  134. package/dist/tools/index.js.map +1 -1
  135. package/dist/tools/memory/index.d.ts +3 -0
  136. package/dist/tools/memory/index.d.ts.map +1 -1
  137. package/dist/tools/memory/index.js +4 -0
  138. package/dist/tools/memory/index.js.map +1 -1
  139. package/dist/tools/memory/manageGoals.d.ts +11 -0
  140. package/dist/tools/memory/manageGoals.d.ts.map +1 -0
  141. package/dist/tools/memory/manageGoals.js +152 -0
  142. package/dist/tools/memory/manageGoals.js.map +1 -0
  143. package/dist/tools/memory/retrieveSessionContext.d.ts +9 -0
  144. package/dist/tools/memory/retrieveSessionContext.d.ts.map +1 -0
  145. package/dist/tools/memory/retrieveSessionContext.js +140 -0
  146. package/dist/tools/memory/retrieveSessionContext.js.map +1 -0
  147. package/dist/tools/memory/saveSessionItem.d.ts +26 -0
  148. package/dist/tools/memory/saveSessionItem.d.ts.map +1 -0
  149. package/dist/tools/memory/saveSessionItem.js +218 -0
  150. package/dist/tools/memory/saveSessionItem.js.map +1 -0
  151. package/dist/tools/memory/startSession.d.ts.map +1 -1
  152. package/dist/tools/memory/startSession.js +29 -0
  153. package/dist/tools/memory/startSession.js.map +1 -1
  154. package/dist/tools/planning/analyzeRequirements.d.ts +9 -0
  155. package/dist/tools/planning/analyzeRequirements.d.ts.map +1 -0
  156. package/dist/tools/planning/analyzeRequirements.js +171 -0
  157. package/dist/tools/planning/analyzeRequirements.js.map +1 -0
  158. package/dist/tools/planning/createUserStories.d.ts +9 -0
  159. package/dist/tools/planning/createUserStories.d.ts.map +1 -0
  160. package/dist/tools/planning/createUserStories.js +124 -0
  161. package/dist/tools/planning/createUserStories.js.map +1 -0
  162. package/dist/tools/planning/featureRoadmap.d.ts +10 -0
  163. package/dist/tools/planning/featureRoadmap.d.ts.map +1 -0
  164. package/dist/tools/planning/featureRoadmap.js +207 -0
  165. package/dist/tools/planning/featureRoadmap.js.map +1 -0
  166. package/dist/tools/planning/generatePrd.d.ts +11 -0
  167. package/dist/tools/planning/generatePrd.d.ts.map +1 -0
  168. package/dist/tools/planning/generatePrd.js +161 -0
  169. package/dist/tools/planning/generatePrd.js.map +1 -0
  170. package/dist/tools/planning/index.d.ts +8 -0
  171. package/dist/tools/planning/index.d.ts.map +1 -0
  172. package/dist/tools/planning/index.js +8 -0
  173. package/dist/tools/planning/index.js.map +1 -0
  174. package/dist/tools/prompt/analyzePrompt.d.ts +7 -0
  175. package/dist/tools/prompt/analyzePrompt.d.ts.map +1 -0
  176. package/dist/tools/prompt/analyzePrompt.js +150 -0
  177. package/dist/tools/prompt/analyzePrompt.js.map +1 -0
  178. package/dist/tools/prompt/enhancePrompt.d.ts +8 -0
  179. package/dist/tools/prompt/enhancePrompt.d.ts.map +1 -0
  180. package/dist/tools/prompt/enhancePrompt.js +110 -0
  181. package/dist/tools/prompt/enhancePrompt.js.map +1 -0
  182. package/dist/tools/prompt/enhancePromptGemini.d.ts +8 -0
  183. package/dist/tools/prompt/enhancePromptGemini.d.ts.map +1 -0
  184. package/dist/tools/prompt/enhancePromptGemini.js +332 -0
  185. package/dist/tools/prompt/enhancePromptGemini.js.map +1 -0
  186. package/dist/tools/prompt/index.d.ts +7 -0
  187. package/dist/tools/prompt/index.d.ts.map +1 -0
  188. package/dist/tools/prompt/index.js +7 -0
  189. package/dist/tools/prompt/index.js.map +1 -0
  190. package/dist/tools/reasoning/applyReasoningFramework.d.ts +8 -0
  191. package/dist/tools/reasoning/applyReasoningFramework.d.ts.map +1 -0
  192. package/dist/tools/reasoning/applyReasoningFramework.js +266 -0
  193. package/dist/tools/reasoning/applyReasoningFramework.js.map +1 -0
  194. package/dist/tools/reasoning/index.d.ts +5 -0
  195. package/dist/tools/reasoning/index.d.ts.map +1 -0
  196. package/dist/tools/reasoning/index.js +5 -0
  197. package/dist/tools/reasoning/index.js.map +1 -0
  198. package/dist/tools/spec/prdParser.test.js +171 -171
  199. package/dist/tools/spec/specGenerator.js +169 -169
  200. package/dist/tools/spec/traceabilityMatrix.js +64 -64
  201. package/dist/tools/spec/traceabilityMatrix.test.js +28 -28
  202. package/dist/tools/thinking/analyzeProblem.d.ts +7 -0
  203. package/dist/tools/thinking/analyzeProblem.d.ts.map +1 -0
  204. package/dist/tools/thinking/analyzeProblem.js +55 -0
  205. package/dist/tools/thinking/analyzeProblem.js.map +1 -0
  206. package/dist/tools/thinking/breakDownProblem.d.ts +8 -0
  207. package/dist/tools/thinking/breakDownProblem.d.ts.map +1 -0
  208. package/dist/tools/thinking/breakDownProblem.js +145 -0
  209. package/dist/tools/thinking/breakDownProblem.js.map +1 -0
  210. package/dist/tools/thinking/createThinkingChain.d.ts +7 -0
  211. package/dist/tools/thinking/createThinkingChain.d.ts.map +1 -0
  212. package/dist/tools/thinking/createThinkingChain.js +44 -0
  213. package/dist/tools/thinking/createThinkingChain.js.map +1 -0
  214. package/dist/tools/thinking/formatAsPlan.d.ts +9 -0
  215. package/dist/tools/thinking/formatAsPlan.d.ts.map +1 -0
  216. package/dist/tools/thinking/formatAsPlan.js +78 -0
  217. package/dist/tools/thinking/formatAsPlan.js.map +1 -0
  218. package/dist/tools/thinking/index.d.ts +10 -0
  219. package/dist/tools/thinking/index.d.ts.map +1 -0
  220. package/dist/tools/thinking/index.js +10 -0
  221. package/dist/tools/thinking/index.js.map +1 -0
  222. package/dist/tools/thinking/stepByStepAnalysis.d.ts +8 -0
  223. package/dist/tools/thinking/stepByStepAnalysis.d.ts.map +1 -0
  224. package/dist/tools/thinking/stepByStepAnalysis.js +63 -0
  225. package/dist/tools/thinking/stepByStepAnalysis.js.map +1 -0
  226. package/dist/tools/thinking/thinkAloudProcess.d.ts +8 -0
  227. package/dist/tools/thinking/thinkAloudProcess.d.ts.map +1 -0
  228. package/dist/tools/thinking/thinkAloudProcess.js +80 -0
  229. package/dist/tools/thinking/thinkAloudProcess.js.map +1 -0
  230. package/hooks/hooks.json +115 -115
  231. package/hooks/scripts/code-check.js +70 -70
  232. package/hooks/scripts/code-review.js +22 -22
  233. package/hooks/scripts/complexity.js +22 -22
  234. package/hooks/scripts/compound.js +23 -23
  235. package/hooks/scripts/context-save.js +53 -53
  236. package/hooks/scripts/gemini-ui-gen.js +281 -281
  237. package/hooks/scripts/generate-brand-assets.js +474 -474
  238. package/hooks/scripts/hud-multiline.js +262 -262
  239. package/hooks/scripts/hud-status.js +291 -291
  240. package/hooks/scripts/keyword-detector.js +214 -214
  241. package/hooks/scripts/llm-orchestrate.js +171 -171
  242. package/hooks/scripts/post-edit.js +97 -97
  243. package/hooks/scripts/post-tool-verify.js +210 -210
  244. package/hooks/scripts/pre-tool-guard.js +125 -125
  245. package/hooks/scripts/prompt-dispatcher.js +161 -161
  246. package/hooks/scripts/recall.js +22 -22
  247. package/hooks/scripts/session-start.js +30 -30
  248. package/hooks/scripts/skill-injector.js +191 -191
  249. package/hooks/scripts/utils.js +97 -97
  250. package/languages/csharp-unity.md +515 -515
  251. package/languages/gdscript-godot.md +470 -470
  252. package/languages/ruby-rails.md +489 -489
  253. package/languages/typescript-angular.md +433 -433
  254. package/languages/typescript-astro.md +416 -416
  255. package/languages/typescript-electron.md +406 -406
  256. package/languages/typescript-nestjs.md +524 -524
  257. package/languages/typescript-svelte.md +407 -407
  258. package/languages/typescript-tauri.md +365 -365
  259. package/package.json +84 -84
  260. package/skills/brand-assets.md +141 -141
  261. package/skills/commerce-patterns.md +361 -361
  262. package/skills/context7-usage.md +102 -102
  263. package/skills/e2e-commerce.md +304 -304
  264. package/skills/frontend-design.md +92 -92
  265. package/skills/git-worktree.md +181 -181
  266. package/skills/parallel-research.md +77 -77
  267. package/skills/priority-todos.md +239 -239
  268. package/skills/seo-checklist.md +244 -244
  269. package/skills/tool-fallback.md +190 -190
  270. package/skills/vibe-capabilities.md +161 -161
  271. package/vibe/constitution.md +227 -227
  272. package/vibe/rules/core/communication-guide.md +98 -98
  273. package/vibe/rules/core/development-philosophy.md +52 -52
  274. package/vibe/rules/core/quick-start.md +102 -102
  275. package/vibe/rules/quality/bdd-contract-testing.md +393 -393
  276. package/vibe/rules/quality/checklist.md +276 -276
  277. package/vibe/rules/quality/testing-strategy.md +440 -440
  278. package/vibe/rules/standards/anti-patterns.md +541 -541
  279. package/vibe/rules/standards/code-structure.md +291 -291
  280. package/vibe/rules/standards/complexity-metrics.md +313 -313
  281. package/vibe/rules/standards/naming-conventions.md +198 -198
  282. package/vibe/setup.sh +31 -31
  283. package/vibe/templates/constitution-template.md +252 -252
  284. package/vibe/templates/contract-backend-template.md +526 -526
  285. package/vibe/templates/contract-frontend-template.md +599 -599
  286. package/vibe/templates/feature-template.md +96 -96
  287. package/vibe/templates/spec-template.md +221 -221
@@ -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
+ ```