bmalph 1.0.0 → 2.2.1

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 (455) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +398 -217
  3. package/bmad/bmm/agents/analyst.agent.yaml +43 -36
  4. package/bmad/bmm/agents/architect.agent.yaml +29 -28
  5. package/bmad/bmm/agents/dev.agent.yaml +38 -38
  6. package/bmad/bmm/agents/pm.agent.yaml +44 -46
  7. package/bmad/bmm/agents/qa.agent.yaml +58 -0
  8. package/bmad/bmm/agents/quick-flow-solo-dev.agent.yaml +32 -32
  9. package/bmad/bmm/agents/sm.agent.yaml +37 -36
  10. package/bmad/bmm/agents/tech-writer/tech-writer-sidecar/documentation-standards.md +223 -223
  11. package/bmad/bmm/agents/tech-writer/tech-writer.agent.yaml +46 -45
  12. package/bmad/bmm/agents/ux-designer.agent.yaml +27 -26
  13. package/bmad/bmm/data/project-context-template.md +26 -26
  14. package/bmad/bmm/module-help.csv +31 -31
  15. package/bmad/bmm/module.yaml +50 -44
  16. package/bmad/bmm/teams/default-party.csv +20 -21
  17. package/bmad/bmm/teams/team-fullstack.yaml +12 -12
  18. package/bmad/bmm/workflows/1-analysis/create-product-brief/product-brief.template.md +10 -10
  19. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md +177 -177
  20. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md +161 -161
  21. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md +199 -199
  22. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md +202 -202
  23. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md +205 -205
  24. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md +219 -219
  25. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md +162 -162
  26. package/bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md +57 -58
  27. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md +137 -137
  28. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md +229 -229
  29. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md +238 -238
  30. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md +206 -206
  31. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md +234 -234
  32. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md +443 -443
  33. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-01-init.md +182 -182
  34. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md +237 -237
  35. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md +249 -249
  36. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md +259 -259
  37. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md +177 -177
  38. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md +475 -475
  39. package/bmad/bmm/workflows/1-analysis/research/research.template.md +29 -29
  40. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md +137 -137
  41. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md +239 -239
  42. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md +248 -248
  43. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md +202 -202
  44. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md +233 -239
  45. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md +486 -486
  46. package/bmad/bmm/workflows/1-analysis/research/workflow-domain-research.md +54 -0
  47. package/bmad/bmm/workflows/1-analysis/research/workflow-market-research.md +54 -0
  48. package/bmad/bmm/workflows/1-analysis/research/workflow-technical-research.md +54 -0
  49. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/data/domain-complexity.csv +14 -12
  50. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/data/prd-purpose.md +197 -197
  51. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/data/project-types.csv +10 -10
  52. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-01-init.md +191 -191
  53. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-01b-continue.md +153 -153
  54. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-02-discovery.md +224 -224
  55. package/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02b-vision.md +154 -0
  56. package/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02c-executive-summary.md +170 -0
  57. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-03-success.md +226 -226
  58. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-04-journeys.md +213 -213
  59. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-05-domain.md +207 -207
  60. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-06-innovation.md +226 -226
  61. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-07-project-type.md +237 -237
  62. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-08-scoping.md +228 -228
  63. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-09-functional.md +231 -231
  64. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-10-nonfunctional.md +242 -242
  65. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-11-polish.md +217 -217
  66. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-12-complete.md +124 -124
  67. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-e/step-e-01-discovery.md +247 -247
  68. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-e/step-e-01b-legacy-conversion.md +208 -208
  69. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-e/step-e-02-review.md +249 -249
  70. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-e/step-e-03-edit.md +253 -253
  71. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-e/step-e-04-complete.md +168 -168
  72. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-01-discovery.md +226 -218
  73. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-02-format-detection.md +191 -191
  74. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-02b-parity-check.md +209 -209
  75. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-03-density-validation.md +174 -174
  76. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-04-brief-coverage-validation.md +214 -214
  77. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-05-measurability-validation.md +228 -228
  78. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-06-traceability-validation.md +217 -217
  79. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-07-implementation-leakage-validation.md +205 -205
  80. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-08-domain-compliance-validation.md +243 -243
  81. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-09-project-type-validation.md +263 -263
  82. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-10-smart-validation.md +209 -209
  83. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-11-holistic-quality-validation.md +264 -264
  84. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-12-completeness-validation.md +242 -242
  85. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-13-report-complete.md +231 -231
  86. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/templates/prd-template.md +10 -10
  87. package/bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-create-prd.md +63 -0
  88. package/bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-edit-prd.md +65 -0
  89. package/bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-validate-prd.md +63 -0
  90. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md +135 -135
  91. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md +127 -127
  92. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md +190 -190
  93. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md +216 -216
  94. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md +219 -219
  95. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md +234 -234
  96. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md +252 -252
  97. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md +254 -254
  98. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md +224 -224
  99. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md +224 -224
  100. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md +241 -241
  101. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md +248 -248
  102. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md +237 -237
  103. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md +264 -264
  104. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md +171 -171
  105. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/ux-design-template.md +13 -13
  106. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md +42 -43
  107. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md +184 -190
  108. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md +172 -178
  109. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md +173 -179
  110. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md +133 -139
  111. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md +245 -252
  112. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +129 -135
  113. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/templates/readiness-report-template.md +4 -4
  114. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md +54 -55
  115. package/bmad/bmm/workflows/3-solutioning/create-architecture/architecture-decision-template.md +12 -12
  116. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/domain-complexity.csv +12 -10
  117. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/project-types.csv +6 -6
  118. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-01-init.md +153 -153
  119. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-01b-continue.md +164 -164
  120. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md +224 -224
  121. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md +331 -331
  122. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md +318 -318
  123. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md +359 -359
  124. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md +379 -379
  125. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md +359 -359
  126. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md +76 -76
  127. package/bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md +49 -50
  128. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md +259 -259
  129. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md +233 -233
  130. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md +272 -272
  131. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +149 -149
  132. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/templates/epics-template.md +57 -57
  133. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md +58 -59
  134. package/bmad/bmm/workflows/4-implementation/code-review/checklist.md +23 -23
  135. package/bmad/bmm/workflows/4-implementation/code-review/instructions.xml +226 -226
  136. package/bmad/bmm/workflows/4-implementation/code-review/workflow.yaml +44 -51
  137. package/bmad/bmm/workflows/4-implementation/correct-course/checklist.md +288 -288
  138. package/bmad/bmm/workflows/4-implementation/correct-course/instructions.md +207 -206
  139. package/bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml +54 -60
  140. package/bmad/bmm/workflows/4-implementation/create-story/checklist.md +358 -358
  141. package/bmad/bmm/workflows/4-implementation/create-story/instructions.xml +346 -345
  142. package/bmad/bmm/workflows/4-implementation/create-story/template.md +49 -49
  143. package/bmad/bmm/workflows/4-implementation/create-story/workflow.yaml +53 -61
  144. package/bmad/bmm/workflows/4-implementation/dev-story/checklist.md +80 -80
  145. package/bmad/bmm/workflows/4-implementation/dev-story/instructions.xml +410 -410
  146. package/bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml +21 -27
  147. package/bmad/bmm/workflows/4-implementation/retrospective/instructions.md +1444 -1443
  148. package/bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml +53 -58
  149. package/bmad/bmm/workflows/4-implementation/sprint-planning/checklist.md +33 -33
  150. package/bmad/bmm/workflows/4-implementation/sprint-planning/instructions.md +226 -225
  151. package/bmad/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml +55 -55
  152. package/bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +47 -54
  153. package/bmad/bmm/workflows/4-implementation/sprint-status/instructions.md +230 -229
  154. package/bmad/bmm/workflows/4-implementation/sprint-status/workflow.yaml +25 -36
  155. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +174 -156
  156. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md +118 -120
  157. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md +111 -113
  158. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md +111 -113
  159. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +104 -106
  160. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md +146 -140
  161. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +50 -50
  162. package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md +191 -189
  163. package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md +144 -144
  164. package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md +127 -128
  165. package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md +200 -191
  166. package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/tech-spec-template.md +74 -74
  167. package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md +79 -79
  168. package/bmad/bmm/workflows/document-project/checklist.md +245 -245
  169. package/bmad/bmm/workflows/document-project/documentation-requirements.csv +12 -12
  170. package/bmad/bmm/workflows/document-project/instructions.md +130 -221
  171. package/bmad/bmm/workflows/document-project/templates/deep-dive-template.md +345 -345
  172. package/bmad/bmm/workflows/document-project/templates/index-template.md +169 -169
  173. package/bmad/bmm/workflows/document-project/templates/project-overview-template.md +103 -103
  174. package/bmad/bmm/workflows/document-project/templates/project-scan-report-schema.json +160 -160
  175. package/bmad/bmm/workflows/document-project/templates/source-tree-template.md +135 -135
  176. package/bmad/bmm/workflows/document-project/workflow.yaml +22 -30
  177. package/bmad/bmm/workflows/document-project/workflows/deep-dive-instructions.md +298 -298
  178. package/bmad/bmm/workflows/document-project/workflows/deep-dive.yaml +31 -31
  179. package/bmad/bmm/workflows/document-project/workflows/full-scan-instructions.md +1106 -1106
  180. package/bmad/bmm/workflows/document-project/workflows/full-scan.yaml +31 -31
  181. package/bmad/bmm/workflows/generate-project-context/project-context-template.md +21 -0
  182. package/bmad/bmm/workflows/generate-project-context/steps/step-01-discover.md +184 -0
  183. package/bmad/bmm/workflows/generate-project-context/steps/step-02-generate.md +318 -0
  184. package/bmad/bmm/workflows/generate-project-context/steps/step-03-complete.md +278 -0
  185. package/bmad/bmm/workflows/generate-project-context/workflow.md +49 -0
  186. package/bmad/bmm/workflows/qa/automate/checklist.md +33 -0
  187. package/bmad/bmm/workflows/qa/automate/instructions.md +110 -0
  188. package/bmad/bmm/workflows/qa/automate/workflow.yaml +44 -0
  189. package/bmad/core/agents/bmad-master.agent.yaml +30 -30
  190. package/bmad/core/module-help.csv +9 -11
  191. package/bmad/core/module.yaml +25 -25
  192. package/bmad/core/tasks/editorial-review-prose.xml +102 -91
  193. package/bmad/core/tasks/editorial-review-structure.xml +209 -198
  194. package/bmad/core/tasks/help.md +85 -0
  195. package/bmad/core/tasks/index-docs.xml +64 -64
  196. package/bmad/core/tasks/review-adversarial-general.xml +48 -48
  197. package/bmad/core/tasks/shard-doc.xml +107 -108
  198. package/bmad/core/tasks/workflow.xml +234 -234
  199. package/bmad/core/workflows/advanced-elicitation/methods.csv +51 -51
  200. package/bmad/core/workflows/advanced-elicitation/workflow.xml +116 -116
  201. package/bmad/core/workflows/brainstorming/brain-methods.csv +61 -61
  202. package/bmad/core/workflows/brainstorming/steps/step-01-session-setup.md +197 -197
  203. package/bmad/core/workflows/brainstorming/steps/step-01b-continue.md +122 -122
  204. package/bmad/core/workflows/brainstorming/steps/step-02a-user-selected.md +225 -225
  205. package/bmad/core/workflows/brainstorming/steps/step-02b-ai-recommended.md +237 -237
  206. package/bmad/core/workflows/brainstorming/steps/step-02c-random-selection.md +209 -209
  207. package/bmad/core/workflows/brainstorming/steps/step-02d-progressive-flow.md +264 -264
  208. package/bmad/core/workflows/brainstorming/steps/step-03-technique-execution.md +399 -399
  209. package/bmad/core/workflows/brainstorming/steps/step-04-idea-organization.md +303 -303
  210. package/bmad/core/workflows/brainstorming/template.md +15 -15
  211. package/bmad/core/workflows/brainstorming/workflow.md +58 -58
  212. package/bmad/core/workflows/party-mode/steps/step-01-agent-loading.md +138 -138
  213. package/bmad/core/workflows/party-mode/steps/step-02-discussion-orchestration.md +187 -187
  214. package/bmad/core/workflows/party-mode/steps/step-03-graceful-exit.md +168 -157
  215. package/bmad/core/workflows/party-mode/workflow.md +194 -194
  216. package/bundled-versions.json +3 -0
  217. package/dist/cli.js +61 -6
  218. package/dist/commands/check-updates.d.ts +5 -0
  219. package/dist/commands/check-updates.js +63 -0
  220. package/dist/commands/doctor.d.ts +39 -1
  221. package/dist/commands/doctor.js +348 -79
  222. package/dist/commands/init.d.ts +2 -0
  223. package/dist/commands/init.js +41 -15
  224. package/dist/commands/status.d.ts +7 -1
  225. package/dist/commands/status.js +111 -42
  226. package/dist/commands/upgrade.d.ts +7 -1
  227. package/dist/commands/upgrade.js +43 -12
  228. package/dist/installer.d.ts +19 -2
  229. package/dist/installer.js +305 -66
  230. package/dist/transition/artifacts.d.ts +2 -0
  231. package/dist/transition/artifacts.js +46 -0
  232. package/dist/transition/context.d.ts +19 -0
  233. package/dist/transition/context.js +261 -0
  234. package/dist/transition/fix-plan.d.ts +15 -0
  235. package/dist/transition/fix-plan.js +94 -0
  236. package/dist/transition/index.d.ts +9 -0
  237. package/dist/transition/index.js +16 -0
  238. package/dist/transition/orchestration.d.ts +2 -0
  239. package/dist/transition/orchestration.js +243 -0
  240. package/dist/transition/specs-changelog.d.ts +3 -0
  241. package/dist/transition/specs-changelog.js +75 -0
  242. package/dist/transition/specs-index.d.ts +22 -0
  243. package/dist/transition/specs-index.js +157 -0
  244. package/dist/transition/story-parsing.d.ts +7 -0
  245. package/dist/transition/story-parsing.js +124 -0
  246. package/dist/transition/tech-stack.d.ts +3 -0
  247. package/dist/transition/tech-stack.js +79 -0
  248. package/dist/transition/types.d.ts +60 -0
  249. package/dist/transition/types.js +1 -0
  250. package/dist/utils/config.d.ts +4 -0
  251. package/dist/utils/config.js +14 -4
  252. package/dist/utils/constants.d.ts +70 -0
  253. package/dist/utils/constants.js +97 -0
  254. package/dist/utils/dryrun.d.ts +7 -0
  255. package/dist/utils/dryrun.js +48 -0
  256. package/dist/utils/errors.d.ts +63 -0
  257. package/dist/utils/errors.js +86 -0
  258. package/dist/utils/file-system.d.ts +24 -0
  259. package/dist/utils/file-system.js +99 -0
  260. package/dist/utils/github.d.ts +83 -0
  261. package/dist/utils/github.js +230 -0
  262. package/dist/utils/json.js +3 -3
  263. package/dist/utils/logger.d.ts +6 -0
  264. package/dist/utils/logger.js +27 -0
  265. package/dist/utils/state.d.ts +4 -7
  266. package/dist/utils/state.js +147 -26
  267. package/dist/utils/validate.d.ts +40 -0
  268. package/dist/utils/validate.js +175 -1
  269. package/package.json +75 -59
  270. package/ralph/RALPH-REFERENCE.md +412 -0
  271. package/ralph/lib/circuit_breaker.sh +463 -330
  272. package/ralph/lib/date_utils.sh +104 -53
  273. package/ralph/lib/enable_core.sh +815 -0
  274. package/ralph/lib/response_analyzer.sh +884 -768
  275. package/ralph/lib/task_sources.sh +577 -0
  276. package/ralph/lib/timeout_utils.sh +145 -145
  277. package/ralph/lib/wizard_utils.sh +547 -0
  278. package/ralph/ralph_import.sh +636 -0
  279. package/ralph/ralph_loop.sh +1793 -1391
  280. package/ralph/ralph_monitor.sh +125 -0
  281. package/ralph/templates/AGENT.md +158 -158
  282. package/ralph/templates/PROMPT.md +285 -292
  283. package/ralph/templates/fix_plan.md +27 -27
  284. package/ralph/templates/ralphrc.template +102 -0
  285. package/ralph/templates/specs/.gitkeep +1 -1
  286. package/slash-commands/advanced-elicitation.md +1 -1
  287. package/slash-commands/adversarial-review.md +1 -1
  288. package/slash-commands/analyst.md +1 -1
  289. package/slash-commands/architect.md +1 -1
  290. package/slash-commands/bmad-help.md +1 -1
  291. package/slash-commands/bmalph-implement.md +152 -152
  292. package/slash-commands/brainstorm-project.md +1 -1
  293. package/slash-commands/brainstorming.md +1 -1
  294. package/slash-commands/correct-course.md +1 -1
  295. package/slash-commands/create-architecture.md +1 -1
  296. package/slash-commands/create-brief.md +1 -1
  297. package/slash-commands/create-epics-stories.md +1 -1
  298. package/slash-commands/create-prd.md +1 -1
  299. package/slash-commands/create-story.md +1 -1
  300. package/slash-commands/create-ux.md +1 -1
  301. package/slash-commands/dev.md +1 -1
  302. package/slash-commands/document-project.md +1 -1
  303. package/slash-commands/domain-research.md +1 -1
  304. package/slash-commands/editorial-prose.md +1 -1
  305. package/slash-commands/editorial-structure.md +1 -1
  306. package/slash-commands/execute-workflow.md +1 -1
  307. package/slash-commands/generate-project-context.md +1 -0
  308. package/slash-commands/implementation-readiness.md +1 -1
  309. package/slash-commands/index-docs.md +1 -1
  310. package/slash-commands/market-research.md +1 -1
  311. package/slash-commands/party-mode.md +1 -1
  312. package/slash-commands/pm.md +1 -1
  313. package/slash-commands/qa-automate.md +1 -0
  314. package/slash-commands/qa.md +1 -0
  315. package/slash-commands/quick-dev.md +1 -1
  316. package/slash-commands/quick-flow-solo-dev.md +1 -1
  317. package/slash-commands/retrospective.md +1 -1
  318. package/slash-commands/shard-doc.md +1 -1
  319. package/slash-commands/sm.md +1 -1
  320. package/slash-commands/sprint-planning.md +1 -1
  321. package/slash-commands/sprint-status.md +1 -1
  322. package/slash-commands/tech-spec.md +1 -1
  323. package/slash-commands/tech-writer.md +1 -0
  324. package/slash-commands/technical-research.md +1 -1
  325. package/slash-commands/ux-designer.md +1 -1
  326. package/slash-commands/validate-architecture.md +1 -1
  327. package/slash-commands/validate-brief.md +1 -1
  328. package/slash-commands/validate-epics-stories.md +1 -1
  329. package/slash-commands/validate-prd.md +1 -1
  330. package/slash-commands/validate-story.md +1 -1
  331. package/slash-commands/validate-ux.md +1 -1
  332. package/bmad/bmm/agents/tea.agent.yaml +0 -63
  333. package/bmad/bmm/sub-modules/claude-code/config.yaml +0 -4
  334. package/bmad/bmm/sub-modules/claude-code/injections.yaml +0 -242
  335. package/bmad/bmm/sub-modules/claude-code/readme.md +0 -87
  336. package/bmad/bmm/testarch/knowledge/adr-quality-readiness-checklist.md +0 -350
  337. package/bmad/bmm/testarch/knowledge/api-request.md +0 -442
  338. package/bmad/bmm/testarch/knowledge/api-testing-patterns.md +0 -843
  339. package/bmad/bmm/testarch/knowledge/auth-session.md +0 -552
  340. package/bmad/bmm/testarch/knowledge/burn-in.md +0 -273
  341. package/bmad/bmm/testarch/knowledge/ci-burn-in.md +0 -675
  342. package/bmad/bmm/testarch/knowledge/component-tdd.md +0 -486
  343. package/bmad/bmm/testarch/knowledge/contract-testing.md +0 -957
  344. package/bmad/bmm/testarch/knowledge/data-factories.md +0 -500
  345. package/bmad/bmm/testarch/knowledge/email-auth.md +0 -721
  346. package/bmad/bmm/testarch/knowledge/error-handling.md +0 -725
  347. package/bmad/bmm/testarch/knowledge/feature-flags.md +0 -750
  348. package/bmad/bmm/testarch/knowledge/file-utils.md +0 -463
  349. package/bmad/bmm/testarch/knowledge/fixture-architecture.md +0 -401
  350. package/bmad/bmm/testarch/knowledge/fixtures-composition.md +0 -382
  351. package/bmad/bmm/testarch/knowledge/intercept-network-call.md +0 -430
  352. package/bmad/bmm/testarch/knowledge/log.md +0 -429
  353. package/bmad/bmm/testarch/knowledge/network-error-monitor.md +0 -405
  354. package/bmad/bmm/testarch/knowledge/network-first.md +0 -486
  355. package/bmad/bmm/testarch/knowledge/network-recorder.md +0 -527
  356. package/bmad/bmm/testarch/knowledge/nfr-criteria.md +0 -670
  357. package/bmad/bmm/testarch/knowledge/overview.md +0 -286
  358. package/bmad/bmm/testarch/knowledge/playwright-config.md +0 -730
  359. package/bmad/bmm/testarch/knowledge/probability-impact.md +0 -601
  360. package/bmad/bmm/testarch/knowledge/recurse.md +0 -421
  361. package/bmad/bmm/testarch/knowledge/risk-governance.md +0 -615
  362. package/bmad/bmm/testarch/knowledge/selective-testing.md +0 -732
  363. package/bmad/bmm/testarch/knowledge/selector-resilience.md +0 -527
  364. package/bmad/bmm/testarch/knowledge/test-healing-patterns.md +0 -644
  365. package/bmad/bmm/testarch/knowledge/test-levels-framework.md +0 -473
  366. package/bmad/bmm/testarch/knowledge/test-priorities-matrix.md +0 -373
  367. package/bmad/bmm/testarch/knowledge/test-quality.md +0 -664
  368. package/bmad/bmm/testarch/knowledge/timing-debugging.md +0 -372
  369. package/bmad/bmm/testarch/knowledge/visual-debugging.md +0 -524
  370. package/bmad/bmm/testarch/tea-index.csv +0 -35
  371. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-02-customer-insights.md +0 -200
  372. package/bmad/bmm/workflows/1-analysis/research/workflow.md +0 -173
  373. package/bmad/bmm/workflows/2-plan-workflows/prd/validation-report-prd-workflow.md +0 -433
  374. package/bmad/bmm/workflows/2-plan-workflows/prd/workflow.md +0 -150
  375. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/data/project-levels.yaml +0 -59
  376. package/bmad/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-library.json +0 -90
  377. package/bmad/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-templates.yaml +0 -127
  378. package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/checklist.md +0 -39
  379. package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/instructions.md +0 -130
  380. package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml +0 -27
  381. package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/checklist.md +0 -43
  382. package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/instructions.md +0 -141
  383. package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml +0 -27
  384. package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/checklist.md +0 -49
  385. package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/instructions.md +0 -241
  386. package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml +0 -27
  387. package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/checklist.md +0 -38
  388. package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/instructions.md +0 -133
  389. package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yaml +0 -27
  390. package/bmad/bmm/workflows/testarch/atdd/atdd-checklist-template.md +0 -363
  391. package/bmad/bmm/workflows/testarch/atdd/checklist.md +0 -374
  392. package/bmad/bmm/workflows/testarch/atdd/instructions.md +0 -806
  393. package/bmad/bmm/workflows/testarch/atdd/workflow.yaml +0 -47
  394. package/bmad/bmm/workflows/testarch/automate/checklist.md +0 -582
  395. package/bmad/bmm/workflows/testarch/automate/instructions.md +0 -1324
  396. package/bmad/bmm/workflows/testarch/automate/workflow.yaml +0 -54
  397. package/bmad/bmm/workflows/testarch/ci/checklist.md +0 -247
  398. package/bmad/bmm/workflows/testarch/ci/github-actions-template.yaml +0 -198
  399. package/bmad/bmm/workflows/testarch/ci/gitlab-ci-template.yaml +0 -149
  400. package/bmad/bmm/workflows/testarch/ci/instructions.md +0 -536
  401. package/bmad/bmm/workflows/testarch/ci/workflow.yaml +0 -47
  402. package/bmad/bmm/workflows/testarch/framework/checklist.md +0 -320
  403. package/bmad/bmm/workflows/testarch/framework/instructions.md +0 -481
  404. package/bmad/bmm/workflows/testarch/framework/workflow.yaml +0 -49
  405. package/bmad/bmm/workflows/testarch/nfr-assess/checklist.md +0 -407
  406. package/bmad/bmm/workflows/testarch/nfr-assess/instructions.md +0 -726
  407. package/bmad/bmm/workflows/testarch/nfr-assess/nfr-report-template.md +0 -461
  408. package/bmad/bmm/workflows/testarch/nfr-assess/workflow.yaml +0 -49
  409. package/bmad/bmm/workflows/testarch/test-design/checklist.md +0 -407
  410. package/bmad/bmm/workflows/testarch/test-design/instructions.md +0 -1158
  411. package/bmad/bmm/workflows/testarch/test-design/test-design-architecture-template.md +0 -213
  412. package/bmad/bmm/workflows/testarch/test-design/test-design-qa-template.md +0 -286
  413. package/bmad/bmm/workflows/testarch/test-design/test-design-template.md +0 -294
  414. package/bmad/bmm/workflows/testarch/test-design/workflow.yaml +0 -71
  415. package/bmad/bmm/workflows/testarch/test-review/checklist.md +0 -472
  416. package/bmad/bmm/workflows/testarch/test-review/instructions.md +0 -628
  417. package/bmad/bmm/workflows/testarch/test-review/test-review-template.md +0 -390
  418. package/bmad/bmm/workflows/testarch/test-review/workflow.yaml +0 -48
  419. package/bmad/bmm/workflows/testarch/trace/checklist.md +0 -642
  420. package/bmad/bmm/workflows/testarch/trace/instructions.md +0 -1030
  421. package/bmad/bmm/workflows/testarch/trace/trace-template.md +0 -675
  422. package/bmad/bmm/workflows/testarch/trace/workflow.yaml +0 -57
  423. package/bmad/core/resources/excalidraw/README.md +0 -160
  424. package/bmad/core/resources/excalidraw/excalidraw-helpers.md +0 -127
  425. package/bmad/core/resources/excalidraw/library-loader.md +0 -50
  426. package/bmad/core/resources/excalidraw/validate-json-instructions.md +0 -79
  427. package/bmad/core/tasks/bmad-help.md +0 -62
  428. package/dist/commands/guide.d.ts +0 -1
  429. package/dist/commands/guide.js +0 -19
  430. package/dist/commands/implement.d.ts +0 -1
  431. package/dist/commands/implement.js +0 -83
  432. package/dist/commands/plan.d.ts +0 -5
  433. package/dist/commands/plan.js +0 -44
  434. package/dist/commands/reset.d.ts +0 -5
  435. package/dist/commands/reset.js +0 -35
  436. package/dist/commands/resume.d.ts +0 -1
  437. package/dist/commands/resume.js +0 -44
  438. package/dist/commands/start.d.ts +0 -5
  439. package/dist/commands/start.js +0 -54
  440. package/dist/transition.d.ts +0 -52
  441. package/dist/transition.js +0 -656
  442. package/slash-commands/atdd.md +0 -1
  443. package/slash-commands/continuous-integration.md +0 -1
  444. package/slash-commands/create-dataflow.md +0 -1
  445. package/slash-commands/create-diagram.md +0 -1
  446. package/slash-commands/create-flowchart.md +0 -1
  447. package/slash-commands/create-wireframe.md +0 -1
  448. package/slash-commands/nfr-assess.md +0 -1
  449. package/slash-commands/tea.md +0 -1
  450. package/slash-commands/test-automate.md +0 -1
  451. package/slash-commands/test-design.md +0 -1
  452. package/slash-commands/test-framework.md +0 -1
  453. package/slash-commands/test-review.md +0 -1
  454. package/slash-commands/test-trace.md +0 -1
  455. package/slash-commands/validate-test-design.md +0 -1
@@ -1,670 +0,0 @@
1
- # Non-Functional Requirements (NFR) Criteria
2
-
3
- ## Principle
4
-
5
- Non-functional requirements (security, performance, reliability, maintainability) are **validated through automated tests**, not checklists. NFR assessment uses objective pass/fail criteria tied to measurable thresholds. Ambiguous requirements default to CONCERNS until clarified.
6
-
7
- ## Rationale
8
-
9
- **The Problem**: Teams ship features that "work" functionally but fail under load, expose security vulnerabilities, or lack error recovery. NFRs are treated as optional "nice-to-haves" instead of release blockers.
10
-
11
- **The Solution**: Define explicit NFR criteria with automated validation. Security tests verify auth/authz and secret handling. Performance tests enforce SLO/SLA thresholds with profiling evidence. Reliability tests validate error handling, retries, and health checks. Maintainability is measured by test coverage, code duplication, and observability.
12
-
13
- **Why This Matters**:
14
-
15
- - Prevents production incidents (security breaches, performance degradation, cascading failures)
16
- - Provides objective release criteria (no subjective "feels fast enough")
17
- - Automates compliance validation (audit trail for regulated environments)
18
- - Forces clarity on ambiguous requirements (default to CONCERNS)
19
-
20
- ## Pattern Examples
21
-
22
- ### Example 1: Security NFR Validation (Auth, Secrets, OWASP)
23
-
24
- **Context**: Automated security tests enforcing authentication, authorization, and secret handling
25
-
26
- **Implementation**:
27
-
28
- ```typescript
29
- // tests/nfr/security.spec.ts
30
- import { test, expect } from '@playwright/test';
31
-
32
- test.describe('Security NFR: Authentication & Authorization', () => {
33
- test('unauthenticated users cannot access protected routes', async ({ page }) => {
34
- // Attempt to access dashboard without auth
35
- await page.goto('/dashboard');
36
-
37
- // Should redirect to login (not expose data)
38
- await expect(page).toHaveURL(/\/login/);
39
- await expect(page.getByText('Please sign in')).toBeVisible();
40
-
41
- // Verify no sensitive data leaked in response
42
- const pageContent = await page.content();
43
- expect(pageContent).not.toContain('user_id');
44
- expect(pageContent).not.toContain('api_key');
45
- });
46
-
47
- test('JWT tokens expire after 15 minutes', async ({ page, request }) => {
48
- // Login and capture token
49
- await page.goto('/login');
50
- await page.getByLabel('Email').fill('test@example.com');
51
- await page.getByLabel('Password').fill('ValidPass123!');
52
- await page.getByRole('button', { name: 'Sign In' }).click();
53
-
54
- const token = await page.evaluate(() => localStorage.getItem('auth_token'));
55
- expect(token).toBeTruthy();
56
-
57
- // Wait 16 minutes (use mock clock in real tests)
58
- await page.clock.fastForward('00:16:00');
59
-
60
- // Token should be expired, API call should fail
61
- const response = await request.get('/api/user/profile', {
62
- headers: { Authorization: `Bearer ${token}` },
63
- });
64
-
65
- expect(response.status()).toBe(401);
66
- const body = await response.json();
67
- expect(body.error).toContain('expired');
68
- });
69
-
70
- test('passwords are never logged or exposed in errors', async ({ page }) => {
71
- // Trigger login error
72
- await page.goto('/login');
73
- await page.getByLabel('Email').fill('test@example.com');
74
- await page.getByLabel('Password').fill('WrongPassword123!');
75
-
76
- // Monitor console for password leaks
77
- const consoleLogs: string[] = [];
78
- page.on('console', (msg) => consoleLogs.push(msg.text()));
79
-
80
- await page.getByRole('button', { name: 'Sign In' }).click();
81
-
82
- // Error shown to user (generic message)
83
- await expect(page.getByText('Invalid credentials')).toBeVisible();
84
-
85
- // Verify password NEVER appears in console, DOM, or network
86
- const pageContent = await page.content();
87
- expect(pageContent).not.toContain('WrongPassword123!');
88
- expect(consoleLogs.join('\n')).not.toContain('WrongPassword123!');
89
- });
90
-
91
- test('RBAC: users can only access resources they own', async ({ page, request }) => {
92
- // Login as User A
93
- const userAToken = await login(request, 'userA@example.com', 'password');
94
-
95
- // Try to access User B's order
96
- const response = await request.get('/api/orders/user-b-order-id', {
97
- headers: { Authorization: `Bearer ${userAToken}` },
98
- });
99
-
100
- expect(response.status()).toBe(403); // Forbidden
101
- const body = await response.json();
102
- expect(body.error).toContain('insufficient permissions');
103
- });
104
-
105
- test('SQL injection attempts are blocked', async ({ page }) => {
106
- await page.goto('/search');
107
-
108
- // Attempt SQL injection
109
- await page.getByPlaceholder('Search products').fill("'; DROP TABLE users; --");
110
- await page.getByRole('button', { name: 'Search' }).click();
111
-
112
- // Should return empty results, NOT crash or expose error
113
- await expect(page.getByText('No results found')).toBeVisible();
114
-
115
- // Verify app still works (table not dropped)
116
- await page.goto('/dashboard');
117
- await expect(page.getByText('Welcome')).toBeVisible();
118
- });
119
-
120
- test('XSS attempts are sanitized', async ({ page }) => {
121
- await page.goto('/profile/edit');
122
-
123
- // Attempt XSS injection
124
- const xssPayload = '<script>alert("XSS")</script>';
125
- await page.getByLabel('Bio').fill(xssPayload);
126
- await page.getByRole('button', { name: 'Save' }).click();
127
-
128
- // Reload and verify XSS is escaped (not executed)
129
- await page.reload();
130
- const bio = await page.getByTestId('user-bio').textContent();
131
-
132
- // Text should be escaped, script should NOT execute
133
- expect(bio).toContain('&lt;script&gt;');
134
- expect(bio).not.toContain('<script>');
135
- });
136
- });
137
-
138
- // Helper
139
- async function login(request: any, email: string, password: string): Promise<string> {
140
- const response = await request.post('/api/auth/login', {
141
- data: { email, password },
142
- });
143
- const body = await response.json();
144
- return body.token;
145
- }
146
- ```
147
-
148
- **Key Points**:
149
-
150
- - Authentication: Unauthenticated access redirected (not exposed)
151
- - Authorization: RBAC enforced (403 for insufficient permissions)
152
- - Token expiry: JWT expires after 15 minutes (automated validation)
153
- - Secret handling: Passwords never logged or exposed in errors
154
- - OWASP Top 10: SQL injection and XSS blocked (input sanitization)
155
-
156
- **Security NFR Criteria**:
157
-
158
- - ✅ PASS: All 6 tests green (auth, authz, token expiry, secret handling, SQL injection, XSS)
159
- - ⚠️ CONCERNS: 1-2 tests failing with mitigation plan and owner assigned
160
- - ❌ FAIL: Critical exposure (unauthenticated access, password leak, SQL injection succeeds)
161
-
162
- ---
163
-
164
- ### Example 2: Performance NFR Validation (k6 Load Testing for SLO/SLA)
165
-
166
- **Context**: Use k6 for load testing, stress testing, and SLO/SLA enforcement (NOT Playwright)
167
-
168
- **Implementation**:
169
-
170
- ```javascript
171
- // tests/nfr/performance.k6.js
172
- import http from 'k6/http';
173
- import { check, sleep } from 'k6';
174
- import { Rate, Trend } from 'k6/metrics';
175
-
176
- // Custom metrics
177
- const errorRate = new Rate('errors');
178
- const apiDuration = new Trend('api_duration');
179
-
180
- // Performance thresholds (SLO/SLA)
181
- export const options = {
182
- stages: [
183
- { duration: '1m', target: 50 }, // Ramp up to 50 users
184
- { duration: '3m', target: 50 }, // Stay at 50 users for 3 minutes
185
- { duration: '1m', target: 100 }, // Spike to 100 users
186
- { duration: '3m', target: 100 }, // Stay at 100 users
187
- { duration: '1m', target: 0 }, // Ramp down
188
- ],
189
- thresholds: {
190
- // SLO: 95% of requests must complete in <500ms
191
- http_req_duration: ['p(95)<500'],
192
- // SLO: Error rate must be <1%
193
- errors: ['rate<0.01'],
194
- // SLA: API endpoints must respond in <1s (99th percentile)
195
- api_duration: ['p(99)<1000'],
196
- },
197
- };
198
-
199
- export default function () {
200
- // Test 1: Homepage load performance
201
- const homepageResponse = http.get(`${__ENV.BASE_URL}/`);
202
- check(homepageResponse, {
203
- 'homepage status is 200': (r) => r.status === 200,
204
- 'homepage loads in <2s': (r) => r.timings.duration < 2000,
205
- });
206
- errorRate.add(homepageResponse.status !== 200);
207
-
208
- // Test 2: API endpoint performance
209
- const apiResponse = http.get(`${__ENV.BASE_URL}/api/products?limit=10`, {
210
- headers: { Authorization: `Bearer ${__ENV.API_TOKEN}` },
211
- });
212
- check(apiResponse, {
213
- 'API status is 200': (r) => r.status === 200,
214
- 'API responds in <500ms': (r) => r.timings.duration < 500,
215
- });
216
- apiDuration.add(apiResponse.timings.duration);
217
- errorRate.add(apiResponse.status !== 200);
218
-
219
- // Test 3: Search endpoint under load
220
- const searchResponse = http.get(`${__ENV.BASE_URL}/api/search?q=laptop&limit=100`);
221
- check(searchResponse, {
222
- 'search status is 200': (r) => r.status === 200,
223
- 'search responds in <1s': (r) => r.timings.duration < 1000,
224
- 'search returns results': (r) => JSON.parse(r.body).results.length > 0,
225
- });
226
- errorRate.add(searchResponse.status !== 200);
227
-
228
- sleep(1); // Realistic user think time
229
- }
230
-
231
- // Threshold validation (run after test)
232
- export function handleSummary(data) {
233
- const p95Duration = data.metrics.http_req_duration.values['p(95)'];
234
- const p99ApiDuration = data.metrics.api_duration.values['p(99)'];
235
- const errorRateValue = data.metrics.errors.values.rate;
236
-
237
- console.log(`P95 request duration: ${p95Duration.toFixed(2)}ms`);
238
- console.log(`P99 API duration: ${p99ApiDuration.toFixed(2)}ms`);
239
- console.log(`Error rate: ${(errorRateValue * 100).toFixed(2)}%`);
240
-
241
- return {
242
- 'summary.json': JSON.stringify(data),
243
- stdout: `
244
- Performance NFR Results:
245
- - P95 request duration: ${p95Duration < 500 ? '✅ PASS' : '❌ FAIL'} (${p95Duration.toFixed(2)}ms / 500ms threshold)
246
- - P99 API duration: ${p99ApiDuration < 1000 ? '✅ PASS' : '❌ FAIL'} (${p99ApiDuration.toFixed(2)}ms / 1000ms threshold)
247
- - Error rate: ${errorRateValue < 0.01 ? '✅ PASS' : '❌ FAIL'} (${(errorRateValue * 100).toFixed(2)}% / 1% threshold)
248
- `,
249
- };
250
- }
251
- ```
252
-
253
- **Run k6 tests:**
254
-
255
- ```bash
256
- # Local smoke test (10 VUs, 30s)
257
- k6 run --vus 10 --duration 30s tests/nfr/performance.k6.js
258
-
259
- # Full load test (stages defined in script)
260
- k6 run tests/nfr/performance.k6.js
261
-
262
- # CI integration with thresholds
263
- k6 run --out json=performance-results.json tests/nfr/performance.k6.js
264
- ```
265
-
266
- **Key Points**:
267
-
268
- - **k6 is the right tool** for load testing (NOT Playwright)
269
- - SLO/SLA thresholds enforced automatically (`p(95)<500`, `rate<0.01`)
270
- - Realistic load simulation (ramp up, sustained load, spike testing)
271
- - Comprehensive metrics (p50, p95, p99, error rate, throughput)
272
- - CI-friendly (JSON output, exit codes based on thresholds)
273
-
274
- **Performance NFR Criteria**:
275
-
276
- - ✅ PASS: All SLO/SLA targets met with k6 profiling evidence (p95 < 500ms, error rate < 1%)
277
- - ⚠️ CONCERNS: Trending toward limits (e.g., p95 = 480ms approaching 500ms) or missing baselines
278
- - ❌ FAIL: SLO/SLA breached (e.g., p95 > 500ms) or error rate > 1%
279
-
280
- **Performance Testing Levels (from Test Architect course):**
281
-
282
- - **Load testing**: System behavior under expected load
283
- - **Stress testing**: System behavior under extreme load (breaking point)
284
- - **Spike testing**: Sudden load increases (traffic spikes)
285
- - **Endurance/Soak testing**: System behavior under sustained load (memory leaks, resource exhaustion)
286
- - **Benchmarking**: Baseline measurements for comparison
287
-
288
- **Note**: Playwright can validate **perceived performance** (Core Web Vitals via Lighthouse), but k6 validates **system performance** (throughput, latency, resource limits under load)
289
-
290
- ---
291
-
292
- ### Example 3: Reliability NFR Validation (Playwright for UI Resilience)
293
-
294
- **Context**: Automated reliability tests validating graceful degradation and recovery paths
295
-
296
- **Implementation**:
297
-
298
- ```typescript
299
- // tests/nfr/reliability.spec.ts
300
- import { test, expect } from '@playwright/test';
301
-
302
- test.describe('Reliability NFR: Error Handling & Recovery', () => {
303
- test('app remains functional when API returns 500 error', async ({ page, context }) => {
304
- // Mock API failure
305
- await context.route('**/api/products', (route) => {
306
- route.fulfill({ status: 500, body: JSON.stringify({ error: 'Internal Server Error' }) });
307
- });
308
-
309
- await page.goto('/products');
310
-
311
- // User sees error message (not blank page or crash)
312
- await expect(page.getByText('Unable to load products. Please try again.')).toBeVisible();
313
- await expect(page.getByRole('button', { name: 'Retry' })).toBeVisible();
314
-
315
- // App navigation still works (graceful degradation)
316
- await page.getByRole('link', { name: 'Home' }).click();
317
- await expect(page).toHaveURL('/');
318
- });
319
-
320
- test('API client retries on transient failures (3 attempts)', async ({ page, context }) => {
321
- let attemptCount = 0;
322
-
323
- await context.route('**/api/checkout', (route) => {
324
- attemptCount++;
325
-
326
- // Fail first 2 attempts, succeed on 3rd
327
- if (attemptCount < 3) {
328
- route.fulfill({ status: 503, body: JSON.stringify({ error: 'Service Unavailable' }) });
329
- } else {
330
- route.fulfill({ status: 200, body: JSON.stringify({ orderId: '12345' }) });
331
- }
332
- });
333
-
334
- await page.goto('/checkout');
335
- await page.getByRole('button', { name: 'Place Order' }).click();
336
-
337
- // Should succeed after 3 attempts
338
- await expect(page.getByText('Order placed successfully')).toBeVisible();
339
- expect(attemptCount).toBe(3);
340
- });
341
-
342
- test('app handles network disconnection gracefully', async ({ page, context }) => {
343
- await page.goto('/dashboard');
344
-
345
- // Simulate offline mode
346
- await context.setOffline(true);
347
-
348
- // Trigger action requiring network
349
- await page.getByRole('button', { name: 'Refresh Data' }).click();
350
-
351
- // User sees offline indicator (not crash)
352
- await expect(page.getByText('You are offline. Changes will sync when reconnected.')).toBeVisible();
353
-
354
- // Reconnect
355
- await context.setOffline(false);
356
- await page.getByRole('button', { name: 'Refresh Data' }).click();
357
-
358
- // Data loads successfully
359
- await expect(page.getByText('Data updated')).toBeVisible();
360
- });
361
-
362
- test('health check endpoint returns service status', async ({ request }) => {
363
- const response = await request.get('/api/health');
364
-
365
- expect(response.status()).toBe(200);
366
-
367
- const health = await response.json();
368
- expect(health).toHaveProperty('status', 'healthy');
369
- expect(health).toHaveProperty('timestamp');
370
- expect(health).toHaveProperty('services');
371
-
372
- // Verify critical services are monitored
373
- expect(health.services).toHaveProperty('database');
374
- expect(health.services).toHaveProperty('cache');
375
- expect(health.services).toHaveProperty('queue');
376
-
377
- // All services should be UP
378
- expect(health.services.database.status).toBe('UP');
379
- expect(health.services.cache.status).toBe('UP');
380
- expect(health.services.queue.status).toBe('UP');
381
- });
382
-
383
- test('circuit breaker opens after 5 consecutive failures', async ({ page, context }) => {
384
- let failureCount = 0;
385
-
386
- await context.route('**/api/recommendations', (route) => {
387
- failureCount++;
388
- route.fulfill({ status: 500, body: JSON.stringify({ error: 'Service Error' }) });
389
- });
390
-
391
- await page.goto('/product/123');
392
-
393
- // Wait for circuit breaker to open (fallback UI appears)
394
- await expect(page.getByText('Recommendations temporarily unavailable')).toBeVisible({ timeout: 10000 });
395
-
396
- // Verify circuit breaker stopped making requests after threshold (should be ≤5)
397
- expect(failureCount).toBeLessThanOrEqual(5);
398
- });
399
-
400
- test('rate limiting gracefully handles 429 responses', async ({ page, context }) => {
401
- let requestCount = 0;
402
-
403
- await context.route('**/api/search', (route) => {
404
- requestCount++;
405
-
406
- if (requestCount > 10) {
407
- // Rate limit exceeded
408
- route.fulfill({
409
- status: 429,
410
- headers: { 'Retry-After': '5' },
411
- body: JSON.stringify({ error: 'Rate limit exceeded' }),
412
- });
413
- } else {
414
- route.fulfill({ status: 200, body: JSON.stringify({ results: [] }) });
415
- }
416
- });
417
-
418
- await page.goto('/search');
419
-
420
- // Make 15 search requests rapidly
421
- for (let i = 0; i < 15; i++) {
422
- await page.getByPlaceholder('Search').fill(`query-${i}`);
423
- await page.getByRole('button', { name: 'Search' }).click();
424
- }
425
-
426
- // User sees rate limit message (not crash)
427
- await expect(page.getByText('Too many requests. Please wait a moment.')).toBeVisible();
428
- });
429
- });
430
- ```
431
-
432
- **Key Points**:
433
-
434
- - Error handling: Graceful degradation (500 error → user-friendly message + retry button)
435
- - Retries: 3 attempts on transient failures (503 → eventual success)
436
- - Offline handling: Network disconnection detected (sync when reconnected)
437
- - Health checks: `/api/health` monitors database, cache, queue
438
- - Circuit breaker: Opens after 5 failures (fallback UI, stop retries)
439
- - Rate limiting: 429 response handled (Retry-After header respected)
440
-
441
- **Reliability NFR Criteria**:
442
-
443
- - ✅ PASS: Error handling, retries, health checks verified (all 6 tests green)
444
- - ⚠️ CONCERNS: Partial coverage (e.g., missing circuit breaker) or no telemetry
445
- - ❌ FAIL: No recovery path (500 error crashes app) or unresolved crash scenarios
446
-
447
- ---
448
-
449
- ### Example 4: Maintainability NFR Validation (CI Tools, Not Playwright)
450
-
451
- **Context**: Use proper CI tools for code quality validation (coverage, duplication, vulnerabilities)
452
-
453
- **Implementation**:
454
-
455
- ```yaml
456
- # .github/workflows/nfr-maintainability.yml
457
- name: NFR - Maintainability
458
-
459
- on: [push, pull_request]
460
-
461
- jobs:
462
- test-coverage:
463
- runs-on: ubuntu-latest
464
- steps:
465
- - uses: actions/checkout@v4
466
- - uses: actions/setup-node@v4
467
-
468
- - name: Install dependencies
469
- run: npm ci
470
-
471
- - name: Run tests with coverage
472
- run: npm run test:coverage
473
-
474
- - name: Check coverage threshold (80% minimum)
475
- run: |
476
- COVERAGE=$(jq '.total.lines.pct' coverage/coverage-summary.json)
477
- echo "Coverage: $COVERAGE%"
478
- if (( $(echo "$COVERAGE < 80" | bc -l) )); then
479
- echo "❌ FAIL: Coverage $COVERAGE% below 80% threshold"
480
- exit 1
481
- else
482
- echo "✅ PASS: Coverage $COVERAGE% meets 80% threshold"
483
- fi
484
-
485
- code-duplication:
486
- runs-on: ubuntu-latest
487
- steps:
488
- - uses: actions/checkout@v4
489
- - uses: actions/setup-node@v4
490
-
491
- - name: Check code duplication (<5% allowed)
492
- run: |
493
- npx jscpd src/ --threshold 5 --format json --output duplication.json
494
- DUPLICATION=$(jq '.statistics.total.percentage' duplication.json)
495
- echo "Duplication: $DUPLICATION%"
496
- if (( $(echo "$DUPLICATION >= 5" | bc -l) )); then
497
- echo "❌ FAIL: Duplication $DUPLICATION% exceeds 5% threshold"
498
- exit 1
499
- else
500
- echo "✅ PASS: Duplication $DUPLICATION% below 5% threshold"
501
- fi
502
-
503
- vulnerability-scan:
504
- runs-on: ubuntu-latest
505
- steps:
506
- - uses: actions/checkout@v4
507
- - uses: actions/setup-node@v4
508
-
509
- - name: Install dependencies
510
- run: npm ci
511
-
512
- - name: Run npm audit (no critical/high vulnerabilities)
513
- run: |
514
- npm audit --json > audit.json || true
515
- CRITICAL=$(jq '.metadata.vulnerabilities.critical' audit.json)
516
- HIGH=$(jq '.metadata.vulnerabilities.high' audit.json)
517
- echo "Critical: $CRITICAL, High: $HIGH"
518
- if [ "$CRITICAL" -gt 0 ] || [ "$HIGH" -gt 0 ]; then
519
- echo "❌ FAIL: Found $CRITICAL critical and $HIGH high vulnerabilities"
520
- npm audit
521
- exit 1
522
- else
523
- echo "✅ PASS: No critical/high vulnerabilities"
524
- fi
525
- ```
526
-
527
- **Playwright Tests for Observability (E2E Validation):**
528
-
529
- ```typescript
530
- // tests/nfr/observability.spec.ts
531
- import { test, expect } from '@playwright/test';
532
-
533
- test.describe('Maintainability NFR: Observability Validation', () => {
534
- test('critical errors are reported to monitoring service', async ({ page, context }) => {
535
- const sentryEvents: any[] = [];
536
-
537
- // Mock Sentry SDK to verify error tracking
538
- await context.addInitScript(() => {
539
- (window as any).Sentry = {
540
- captureException: (error: Error) => {
541
- console.log('SENTRY_CAPTURE:', JSON.stringify({ message: error.message, stack: error.stack }));
542
- },
543
- };
544
- });
545
-
546
- page.on('console', (msg) => {
547
- if (msg.text().includes('SENTRY_CAPTURE:')) {
548
- sentryEvents.push(JSON.parse(msg.text().replace('SENTRY_CAPTURE:', '')));
549
- }
550
- });
551
-
552
- // Trigger error by mocking API failure
553
- await context.route('**/api/products', (route) => {
554
- route.fulfill({ status: 500, body: JSON.stringify({ error: 'Database Error' }) });
555
- });
556
-
557
- await page.goto('/products');
558
-
559
- // Wait for error UI and Sentry capture
560
- await expect(page.getByText('Unable to load products')).toBeVisible();
561
-
562
- // Verify error was captured by monitoring
563
- expect(sentryEvents.length).toBeGreaterThan(0);
564
- expect(sentryEvents[0]).toHaveProperty('message');
565
- expect(sentryEvents[0]).toHaveProperty('stack');
566
- });
567
-
568
- test('API response times are tracked in telemetry', async ({ request }) => {
569
- const response = await request.get('/api/products?limit=10');
570
-
571
- expect(response.ok()).toBeTruthy();
572
-
573
- // Verify Server-Timing header for APM (Application Performance Monitoring)
574
- const serverTiming = response.headers()['server-timing'];
575
-
576
- expect(serverTiming).toBeTruthy();
577
- expect(serverTiming).toContain('db'); // Database query time
578
- expect(serverTiming).toContain('total'); // Total processing time
579
- });
580
-
581
- test('structured logging present in application', async ({ request }) => {
582
- // Make API call that generates logs
583
- const response = await request.post('/api/orders', {
584
- data: { productId: '123', quantity: 2 },
585
- });
586
-
587
- expect(response.ok()).toBeTruthy();
588
-
589
- // Note: In real scenarios, validate logs in monitoring system (Datadog, CloudWatch)
590
- // This test validates the logging contract exists (Server-Timing, trace IDs in headers)
591
- const traceId = response.headers()['x-trace-id'];
592
- expect(traceId).toBeTruthy(); // Confirms structured logging with correlation IDs
593
- });
594
- });
595
- ```
596
-
597
- **Key Points**:
598
-
599
- - **Coverage/duplication**: CI jobs (GitHub Actions), not Playwright tests
600
- - **Vulnerability scanning**: npm audit in CI, not Playwright tests
601
- - **Observability**: Playwright validates error tracking (Sentry) and telemetry headers
602
- - **Structured logging**: Validate logging contract (trace IDs, Server-Timing headers)
603
- - **Separation of concerns**: Build-time checks (coverage, audit) vs runtime checks (error tracking, telemetry)
604
-
605
- **Maintainability NFR Criteria**:
606
-
607
- - ✅ PASS: Clean code (80%+ coverage from CI, <5% duplication from CI), observability validated in E2E, no critical vulnerabilities from npm audit
608
- - ⚠️ CONCERNS: Duplication >5%, coverage 60-79%, or unclear ownership
609
- - ❌ FAIL: Absent tests (<60%), tangled implementations (>10% duplication), or no observability
610
-
611
- ---
612
-
613
- ## NFR Assessment Checklist
614
-
615
- Before release gate:
616
-
617
- - [ ] **Security** (Playwright E2E + Security Tools):
618
- - [ ] Auth/authz tests green (unauthenticated redirect, RBAC enforced)
619
- - [ ] Secrets never logged or exposed in errors
620
- - [ ] OWASP Top 10 validated (SQL injection blocked, XSS sanitized)
621
- - [ ] Security audit completed (vulnerability scan, penetration test if applicable)
622
-
623
- - [ ] **Performance** (k6 Load Testing):
624
- - [ ] SLO/SLA targets met with k6 evidence (p95 <500ms, error rate <1%)
625
- - [ ] Load testing completed (expected load)
626
- - [ ] Stress testing completed (breaking point identified)
627
- - [ ] Spike testing completed (handles traffic spikes)
628
- - [ ] Endurance testing completed (no memory leaks under sustained load)
629
-
630
- - [ ] **Reliability** (Playwright E2E + API Tests):
631
- - [ ] Error handling graceful (500 → user-friendly message + retry)
632
- - [ ] Retries implemented (3 attempts on transient failures)
633
- - [ ] Health checks monitored (/api/health endpoint)
634
- - [ ] Circuit breaker tested (opens after failure threshold)
635
- - [ ] Offline handling validated (network disconnection graceful)
636
-
637
- - [ ] **Maintainability** (CI Tools):
638
- - [ ] Test coverage ≥80% (from CI coverage report)
639
- - [ ] Code duplication <5% (from jscpd CI job)
640
- - [ ] No critical/high vulnerabilities (from npm audit CI job)
641
- - [ ] Structured logging validated (Playwright validates telemetry headers)
642
- - [ ] Error tracking configured (Sentry/monitoring integration validated)
643
-
644
- - [ ] **Ambiguous requirements**: Default to CONCERNS (force team to clarify thresholds and evidence)
645
- - [ ] **NFR criteria documented**: Measurable thresholds defined (not subjective "fast enough")
646
- - [ ] **Automated validation**: NFR tests run in CI pipeline (not manual checklists)
647
- - [ ] **Tool selection**: Right tool for each NFR (k6 for performance, Playwright for security/reliability E2E, CI tools for maintainability)
648
-
649
- ## NFR Gate Decision Matrix
650
-
651
- | Category | PASS Criteria | CONCERNS Criteria | FAIL Criteria |
652
- | ------------------- | -------------------------------------------- | -------------------------------------------- | ---------------------------------------------- |
653
- | **Security** | Auth/authz, secret handling, OWASP verified | Minor gaps with clear owners | Critical exposure or missing controls |
654
- | **Performance** | Metrics meet SLO/SLA with profiling evidence | Trending toward limits or missing baselines | SLO/SLA breached or resource leaks detected |
655
- | **Reliability** | Error handling, retries, health checks OK | Partial coverage or missing telemetry | No recovery path or unresolved crash scenarios |
656
- | **Maintainability** | Clean code, tests, docs shipped together | Duplication, low coverage, unclear ownership | Absent tests, tangled code, no observability |
657
-
658
- **Default**: If targets or evidence are undefined → **CONCERNS** (force team to clarify before sign-off)
659
-
660
- ## Integration Points
661
-
662
- - **Used in workflows**: `*nfr-assess` (automated NFR validation), `*trace` (gate decision Phase 2), `*test-design` (NFR risk assessment via Utility Tree)
663
- - **Related fragments**: `risk-governance.md` (NFR risk scoring), `probability-impact.md` (NFR impact assessment), `test-quality.md` (maintainability standards), `test-levels-framework.md` (system-level testing for NFRs)
664
- - **Tools by NFR Category**:
665
- - **Security**: Playwright (E2E auth/authz), OWASP ZAP, Burp Suite, npm audit, Snyk
666
- - **Performance**: k6 (load/stress/spike/endurance), Lighthouse (Core Web Vitals), Artillery
667
- - **Reliability**: Playwright (E2E error handling), API tests (retries, health checks), Chaos Engineering tools
668
- - **Maintainability**: GitHub Actions (coverage, duplication, audit), jscpd, Playwright (observability validation)
669
-
670
- _Source: Test Architect course (NFR testing approaches, Utility Tree, Quality Scenarios), ISO/IEC 25010 Software Quality Characteristics, OWASP Top 10, k6 documentation, SRE practices_