@su-record/vibe 2.6.17 → 2.6.19

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