specdojo 0.8.0 → 0.9.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.
- package/.github/agents/specdojo-orchestrator.md +4 -1
- package/CHANGELOG.md +77 -0
- package/dist/catalog/catalog.js +16 -14
- package/dist/commands/agent.js +5 -3
- package/dist/commands/build.js +69 -10
- package/dist/commands/git.js +206 -0
- package/dist/commands/init.js +4 -2
- package/dist/commands/orchestrator.js +5 -77
- package/dist/commands/where.js +25 -0
- package/dist/dashboard/dashboard.js +5 -3
- package/dist/dashboard/routines.js +4 -7
- package/dist/dashboard/shared.js +2 -2
- package/dist/dashboard/timeline.js +14 -14
- package/dist/deliverable/trash.js +2 -1
- package/dist/docs/index-command.js +2 -2
- package/dist/docs/yaml-business-tables.js +243 -0
- package/dist/docs/yaml-interface-tables.js +106 -0
- package/dist/docs/yaml-pages-command.js +5 -3
- package/dist/docs/yaml-pages.js +146 -3
- package/dist/docs/yaml-table-shared.js +70 -0
- package/dist/docs/yaml-tables.js +39 -0
- package/dist/exec/agent-config.js +9 -0
- package/dist/exec/agent-protected-config.js +2 -0
- package/dist/exec/commands.js +31 -18
- package/dist/exec/events.js +34 -14
- package/dist/exec/evidence.js +13 -3
- package/dist/exec/opencode-permissions.js +117 -0
- package/dist/exec/parent-validation.js +56 -3
- package/dist/exec/plans-core.js +21 -2
- package/dist/exec/plans-generation.js +6 -7
- package/dist/exec/post-integration.js +162 -0
- package/dist/exec/queue-command.js +166 -0
- package/dist/exec/queue.js +285 -0
- package/dist/exec/register-foreign-wait.js +82 -0
- package/dist/exec/repo-integration-sync.js +17 -5
- package/dist/exec/repo-trace.js +2 -1
- package/dist/exec/reporter.js +2 -2
- package/dist/exec/results.js +24 -4
- package/dist/exec/review-kata.js +4 -1
- package/dist/exec/run/agent-pipeline.js +3 -2
- package/dist/exec/run/agent.js +12 -6
- package/dist/exec/run/change-scope.js +365 -0
- package/dist/exec/run/deferred-cleanup.js +31 -0
- package/dist/exec/run/in-place.js +5 -2
- package/dist/exec/run/job-lock.js +66 -0
- package/dist/exec/run/job-sequence.js +137 -0
- package/dist/exec/run/job.js +56 -19
- package/dist/exec/run/lifecycle-commands.js +1 -1
- package/dist/exec/run/lock.js +22 -1
- package/dist/exec/run/register-command.js +8 -5
- package/dist/exec/run/register-mode.js +68 -8
- package/dist/exec/run/register-resume.js +68 -14
- package/dist/exec/run/register-state.js +13 -8
- package/dist/exec/run/register-worktree.js +140 -125
- package/dist/exec/run/schedule-mode.js +75 -14
- package/dist/exec/run/schedule-prepare.js +3 -0
- package/dist/exec/run/schedule-task.js +88 -38
- package/dist/exec/run/shared.js +5 -0
- package/dist/exec/schedule/schedule.js +116 -4
- package/dist/exec/shared.js +2 -2
- package/dist/exec/smoke.js +190 -0
- package/dist/exec/strategy.js +13 -3
- package/dist/exec/task-repos.js +19 -4
- package/dist/exec/task-view.js +6 -4
- package/dist/exec/trial-commands.js +5 -2
- package/dist/exec/trial-core.js +6 -1
- package/dist/exec/validation-metrics.js +181 -0
- package/dist/exec/worktree-cleanup-lock.js +26 -0
- package/dist/exec/worktree-command.js +12 -2
- package/dist/exec/worktree-ops-commit.js +2 -2
- package/dist/exec/worktree.js +13 -2
- package/dist/grade/command-apply.js +3 -3
- package/dist/grade/command-inspect.js +5 -3
- package/dist/grade/command-plan.js +1 -1
- package/dist/grade/command-run.js +5 -1
- package/dist/grade/run.js +64 -8
- package/dist/job/definition.js +84 -8
- package/dist/job/job.js +79 -23
- package/dist/register/authoring-sources.js +22 -16
- package/dist/register/maintenance-commands.js +2 -2
- package/dist/register/register.js +31 -7
- package/dist/register/renumber.js +1 -3
- package/dist/routine/definition.js +9 -0
- package/dist/routine/routine.js +137 -43
- package/dist/routine/status.js +62 -0
- package/dist/schedule/schedule.js +38 -39
- package/dist/shared/agent-types.js +5 -0
- package/dist/shared/cross-process-lock.js +9 -1
- package/dist/shared/dist-freshness.js +8 -2
- package/dist/shared/git-environment.js +2 -1
- package/dist/shared/git.js +44 -1
- package/dist/shared/lefthook-scaffold.js +3 -0
- package/dist/shared/local-config.js +244 -0
- package/dist/shared/specdojo-config.js +34 -20
- package/dist/shared/specdojo-gitignore.js +1 -0
- package/dist/shared/text.js +17 -1
- package/dist/shared/where-alias.js +13 -0
- package/dist/specdojo.js +4 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +2 -0
- package/docs/ja/specdojo/guides/exec-config-guide.md +23 -4
- package/docs/ja/specdojo/guides/exec-operation-guide.md +44 -1
- package/docs/ja/specdojo/guides/job-sequence-guide.md +77 -0
- package/docs/ja/specdojo/guides/orchestrator-operation-guide.md +1 -1
- package/docs/ja/specdojo/guides/quick-start-guide.md +3 -3
- package/docs/ja/specdojo/guides/register-operation-guide.md +1 -1
- package/docs/ja/specdojo/guides/routine-operation-guide.md +11 -6
- package/docs/ja/specdojo/guides/schedule-design-guide.md +20 -17
- package/docs/ja/specdojo/guides/waza-guide.md +12 -8
- package/docs/ja/specdojo/recipes/bac-recipe.md +66 -49
- package/docs/ja/specdojo/recipes/bes-recipe.md +90 -54
- package/docs/ja/specdojo/recipes/bps-recipe.md +88 -139
- package/docs/ja/specdojo/recipes/br-recipe.md +40 -47
- package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +97 -109
- package/docs/ja/specdojo/recipes/cdfd-recipe.md +85 -146
- package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +91 -110
- package/docs/ja/specdojo/recipes/cnd-recipe.md +79 -69
- package/docs/ja/specdojo/recipes/cpd-recipe.md +78 -64
- package/docs/ja/specdojo/recipes/cxd-recipe.md +92 -75
- package/docs/ja/specdojo/recipes/ifd-recipe.md +79 -68
- package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +78 -105
- package/docs/ja/specdojo/recipes/ifx-index-recipe.md +105 -71
- package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +60 -49
- package/docs/ja/specdojo/recipes/pm-members-recipe.md +50 -51
- package/docs/ja/specdojo/recipes/pm-organization-recipe.md +59 -51
- package/docs/ja/specdojo/recipes/pm-plan-recipe.md +69 -56
- package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +37 -56
- package/docs/ja/specdojo/recipes/pm-raci-recipe.md +39 -53
- package/docs/ja/specdojo/recipes/pm-roles-recipe.md +52 -79
- package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +64 -93
- package/docs/ja/specdojo/recipes/prj-charter-recipe.md +71 -106
- package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +78 -157
- package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +62 -111
- package/docs/ja/specdojo/recipes/prj-scope-recipe.md +67 -123
- package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +60 -96
- package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +61 -105
- package/docs/ja/specdojo/recipes/stsd-recipe.md +79 -109
- package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +78 -55
- package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +82 -73
- package/docs/ja/specdojo/recipes/sysd-index-recipe.md +78 -59
- package/docs/ja/specdojo/recipes/tsd-recipe.md +149 -129
- package/docs/ja/specdojo/references/command-reference.md +258 -118
- package/docs/ja/specdojo/references/deliverables-reference.md +21 -12
- package/docs/ja/specdojo/references/specdojo-config-reference.md +47 -10
- package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +101 -257
- package/docs/ja/specdojo/rulebooks/atc-rulebook.md +102 -228
- package/docs/ja/specdojo/rulebooks/bac-rulebook.md +19 -28
- package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +16 -67
- package/docs/ja/specdojo/rulebooks/bds-rulebook.md +30 -51
- package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +41 -61
- package/docs/ja/specdojo/rulebooks/bes-rulebook.md +22 -50
- package/docs/ja/specdojo/rulebooks/bps-rulebook.md +24 -56
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +13 -38
- package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +41 -76
- package/docs/ja/specdojo/rulebooks/cdfd-d2-rulebook.md +18 -93
- package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +18 -52
- package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +109 -147
- package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +80 -108
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +21 -46
- package/docs/ja/specdojo/rulebooks/cdr-rulebook.md +144 -0
- package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +27 -48
- package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +37 -50
- package/docs/ja/specdojo/rulebooks/clis-rulebook.md +52 -69
- package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +33 -86
- package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +16 -32
- package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +45 -131
- package/docs/ja/specdojo/rulebooks/cop-rulebook.md +69 -275
- package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +20 -112
- package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +23 -56
- package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +12 -145
- package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +39 -47
- package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +37 -56
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +118 -175
- package/docs/ja/specdojo/rulebooks/dec-rulebook.md +5 -14
- package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +22 -66
- package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +36 -94
- package/docs/ja/specdojo/rulebooks/dss-rulebook.md +59 -81
- package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +31 -131
- package/docs/ja/specdojo/rulebooks/etc-rulebook.md +50 -104
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +51 -61
- package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +38 -45
- package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +14 -20
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +26 -38
- package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +26 -107
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +42 -49
- package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +14 -22
- package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +21 -44
- package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +41 -64
- package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +14 -38
- package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +34 -61
- package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +27 -50
- package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +70 -199
- package/docs/ja/specdojo/rulebooks/itc-rulebook.md +65 -153
- package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +74 -150
- package/docs/ja/specdojo/rulebooks/mm-rulebook.md +11 -23
- package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +99 -176
- package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +35 -61
- package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +75 -117
- package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +31 -60
- package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +26 -81
- package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +32 -70
- package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +45 -87
- package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +48 -101
- package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +44 -80
- package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +59 -127
- package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +31 -50
- package/docs/ja/specdojo/rulebooks/opd-rulebook.md +42 -109
- package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +29 -42
- package/docs/ja/specdojo/rulebooks/opr-rulebook.md +29 -87
- package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +62 -84
- package/docs/ja/specdojo/rulebooks/otp-rulebook.md +11 -61
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +91 -106
- package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +25 -34
- package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +30 -53
- package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +23 -35
- package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +27 -45
- package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +37 -45
- package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +45 -46
- package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +37 -48
- package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +25 -29
- package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +28 -35
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +36 -41
- package/docs/ja/specdojo/rulebooks/pr-rulebook.md +5 -18
- package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +16 -37
- package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +23 -97
- package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +39 -57
- package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +43 -116
- package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +16 -51
- package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +47 -92
- package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +25 -84
- package/docs/ja/specdojo/rulebooks/sac-rulebook.md +44 -107
- package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +39 -49
- package/docs/ja/specdojo/rulebooks/sf-rulebook.md +42 -49
- package/docs/ja/specdojo/rulebooks/sld-rulebook.md +64 -89
- package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +90 -189
- package/docs/ja/specdojo/rulebooks/stc-rulebook.md +45 -105
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +6 -12
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +49 -68
- package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +51 -60
- package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +46 -50
- package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +39 -64
- package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +47 -60
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +69 -70
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +65 -72
- package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +35 -46
- package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +49 -66
- package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +64 -139
- package/docs/ja/specdojo/rulebooks/uis-rulebook.md +41 -108
- package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +49 -144
- package/docs/ja/specdojo/rulebooks/utc-rulebook.md +67 -155
- package/docs/ja/specdojo/samples/bds-sample.md +58 -71
- package/docs/ja/specdojo/samples/bes-index-sample.md +20 -37
- package/docs/ja/specdojo/samples/bes-sample.md +43 -53
- package/docs/ja/specdojo/samples/bps-sample.md +42 -54
- package/docs/ja/specdojo/samples/br-sample.md +40 -52
- package/docs/ja/specdojo/samples/ccd-sample.md +0 -1
- package/docs/ja/specdojo/samples/cdr-sample.md +78 -0
- package/docs/ja/specdojo/samples/cdsd-sample.md +47 -63
- package/docs/ja/specdojo/samples/clis-sample.md +70 -77
- package/docs/ja/specdojo/samples/dec-sample.md +2 -3
- package/docs/ja/specdojo/samples/ifx-api-sample.yaml +0 -2
- package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +0 -2
- package/docs/ja/specdojo/samples/job-sequence.yaml +67 -0
- package/docs/ja/specdojo/samples/mip-index-sample.md +98 -20
- package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +26 -19
- package/docs/ja/specdojo/samples/pm-organization-sample.md +39 -50
- package/docs/ja/specdojo/samples/pm-plan-sample.md +61 -67
- package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +31 -45
- package/docs/ja/specdojo/samples/pm-raci-sample.md +31 -37
- package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +32 -48
- package/docs/ja/specdojo/samples/prj-charter-sample.md +42 -59
- package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +55 -61
- package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +30 -33
- package/docs/ja/specdojo/samples/sf-index-sample.md +13 -55
- package/docs/ja/specdojo/samples/sf-sample.md +73 -85
- package/docs/ja/specdojo/samples/sld-sample.md +60 -79
- package/docs/ja/specdojo/samples/uis-sample.md +98 -121
- package/docs/ja/specdojo/standards/job-definition-standard.md +24 -9
- package/docs/ja/specdojo/templates/cdr-template.md +58 -0
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +2 -1
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +42 -5
- package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +35 -0
- package/docs/specdojo/schemas/v1/job-run.schema.yaml +23 -0
- package/docs/specdojo/schemas/v1/job.schema.yaml +63 -2
- package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +2 -2
- package/package.json +9 -6
- package/templates/antigravity/orchestrator.md +4 -1
- package/templates/claude/agents/specdojo-orchestrator.md +4 -1
- package/templates/codex/agents/specdojo-orchestrator.toml +4 -1
- package/templates/codex/orchestrator.md +4 -1
- package/templates/init-exec-defaults.yaml +13 -0
- package/templates/lefthook/tools/specdojo-pre-commit.mjs +8 -0
- package/templates/opencode/agents/specdojo-orchestrator.md +5 -2
|
@@ -13,25 +13,17 @@ specdojo:
|
|
|
13
13
|
|
|
14
14
|
Internal Integration Test Catalog (ITC) Documentation Rules
|
|
15
15
|
|
|
16
|
-
|
|
17
|
-
`itc-index` を前提に、SSOTの本体として、対象ごとの **内部結合テストの責務・境界・依存、観点 x 条件=ケース、トレース、証跡** を明文化します。
|
|
16
|
+
内部結合テストカタログ(ITC)の対象別 `itc-<term>` に、責務・結合境界・依存、観点×条件=ケース、根拠仕様と証跡を記述する基準を定めます。
|
|
18
17
|
|
|
19
18
|
## 1. 全体方針
|
|
20
19
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
- `
|
|
25
|
-
- 内部結合テストの目的は「**複数コンポーネントの結合としての振る舞い**を決定的に検証すること」であり、外部要因(外部サービス実疎通/実ユーザUI)は原則排除する(例外は根拠を明記)
|
|
26
|
-
- ITでは、UTでMockしていた境界の一部(例:Repository実装、SQL/制約、トランザクション)を **実装に近い形で検証**する(ただし再現性が崩れる要因は制御する)
|
|
27
|
-
- ケースは「表の1行=1テスト」とし、手順と期待値は **判定可能**な粒度で簡潔に書く
|
|
28
|
-
- 詳細な操作列挙やデータ大量列挙は避け、必要な詳細はテストコード側へ寄せる(証跡で参照可能にする)
|
|
29
|
-
- すべての観点・ケースは、根拠仕様(`based_on` / `トレース`)と、証跡(テストコード/CI)に接続されていること
|
|
20
|
+
- **正本の分担**: `itc-<term>` は対象固有の観点・ケースの正本とし、共通方針は `itc-index` に従う。詳細な操作・データはテストコードへ寄せる。
|
|
21
|
+
- **検証範囲**: 複数コンポーネントの結合としての振る舞いを決定的に検証する。UTでMockしていた境界の一部(Repository、SQL/制約、トランザクション等)を実装に近づけ、外部サービス実疎通・実ユーザUIは原則除外する。例外には根拠と再現性対策を明記する。
|
|
22
|
+
- **ケースの単位**: 表の1行を1テストとし、判定可能な条件・期待値、根拠仕様、テストコード/CI証跡を対応付ける。
|
|
23
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。文書の整形・lint はリポジトリの検証で扱い、業務の検証に含めない。
|
|
30
24
|
|
|
31
25
|
## 2. 位置づけ(他ドキュメントとの関係)
|
|
32
26
|
|
|
33
|
-
個別 ITC(`itc-<term>`)と他ドキュメントの関係を示します。
|
|
34
|
-
|
|
35
27
|
```mermaid
|
|
36
28
|
flowchart BT
|
|
37
29
|
TSP["tsp-index<br>テスト戦略・方針"]
|
|
@@ -50,42 +42,29 @@ flowchart BT
|
|
|
50
42
|
|
|
51
43
|
classDef target stroke-width:4px
|
|
52
44
|
class TCDetail target
|
|
53
|
-
|
|
54
45
|
```
|
|
55
46
|
|
|
56
47
|
## 3. ファイル命名・ID規則
|
|
57
48
|
|
|
58
|
-
-
|
|
59
|
-
-
|
|
60
|
-
- `<term>`
|
|
49
|
+
- **文書 ID**: [[specdojo:id-and-file-naming-standard|ID・ファイル命名標準]] に従い、プロダクト文書は `itc-<term>`、プロジェクト文書は `<project-id>:itc-<term>` とする。
|
|
50
|
+
- **ファイル名**: `itc-<term>.md` を推奨し、既存文書の配置・名称は成果物カタログの宣言に合わせる。
|
|
51
|
+
- **対象名**: `<term>` は用語集の論理名キー(英小文字kebab-case)とし、日本語の表示名は H1 に記載する。
|
|
61
52
|
|
|
62
53
|
## 4. 推奨 Frontmatter 項目
|
|
63
54
|
|
|
64
55
|
### 4.1. 設定内容
|
|
65
56
|
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
- 参照スキーマ: [docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml](../../../specdojo/schemas/v1/deliverable-frontmatter.schema.yaml)
|
|
69
|
-
- メタ情報標準: [document-metadata-standard.md](../standards/document-metadata-standard.md)
|
|
57
|
+
許可キー・必須項目・型制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` に従う。
|
|
70
58
|
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
| type | `test` 固定 | ○ |
|
|
75
|
-
| title | 内部結合テストカタログ: <対象名> | ○ |
|
|
76
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
77
|
-
| based_on | 根拠仕様(最低限: `tsp-index`, `itc-index`。対象固有の根拠は本文トレースに集約) | ○ |
|
|
78
|
-
| part_of | 集約ドキュメントへの所属(ID配列) | 任意 |
|
|
79
|
-
| supersedes | 置き換え関係 | 任意 |
|
|
59
|
+
- `specdojo.id` は「ファイル命名・ID規則」の区分に従う。
|
|
60
|
+
- `specdojo.type` は `test`、`specdojo.rulebook` は `specdojo:itc-rulebook` とする。
|
|
61
|
+
- 文書名は `# 内部結合テストカタログ: <対象名>` とする。
|
|
80
62
|
|
|
81
63
|
### 4.2. 推奨ルール
|
|
82
64
|
|
|
83
|
-
- `based_on`
|
|
84
|
-
-
|
|
85
|
-
|
|
86
|
-
機械処理上の都合で `based_on` にも列挙する場合は、本文トレースと矛盾しないこと。
|
|
87
|
-
- 記述内容が多くなる場合は、ドキュメントを分割し、`part_of` で集約ドキュメントに所属させます。
|
|
88
|
-
- `part_of` / `based_on` / `supersedes` は ID 配列(未指定は `[]` 可)。
|
|
65
|
+
- `based_on` は原則 `tsp-index` と `itc-index` を最低限とする。対象固有の根拠(`br-*` / `bac-*` / `spec-*` / `nfr-*` 等)は本文「トレース」に集約し、メタ情報にも列挙する場合は対応を揃える。
|
|
66
|
+
- 参照には適用先の正規 ID を用い、カタログの `depends_on` がある場合は、その推移閉包内の作成済み文書に限定する。
|
|
67
|
+
- 分割時は `itc-index` の分割基準に従い、`part_of` で集約先を示す。
|
|
89
68
|
|
|
90
69
|
## 5. 本文構成(標準テンプレ)
|
|
91
70
|
|
|
@@ -100,121 +79,78 @@ Frontmatter は共通スキーマに従います(あわせてドキュメン
|
|
|
100
79
|
| 5 | トレース | ○ |
|
|
101
80
|
| 6 | テスト観点とケース | ○ |
|
|
102
81
|
|
|
103
|
-
|
|
104
|
-
生成する `utc-<term>` 本文の見出しは各章で指定された **番号付き** の形式
|
|
105
|
-
(例: `## 6.`, `### 6.1.` / `#### 6.1.1.` / `#### 6.1.2.`)に置き換えてください。
|
|
82
|
+
生成する `itc-<term>` は上表を番号付き H2 とする。「テスト観点とケース」配下は `### 6.1. 観点:<観点>`、`#### 6.1.1. 意図`、`#### 6.1.2. 条件・ケース表` とし、観点ごとに連番を振る。
|
|
106
83
|
|
|
107
84
|
## 6. 記述ガイド
|
|
108
85
|
|
|
109
86
|
### 6.1. 概要(`<term>`)
|
|
110
87
|
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
- `<term>` の説明(1〜3行):結合のまとまり(ユースケース×主要I/F、サブシステム境界 等)を人が理解できる形で記述する
|
|
116
|
-
- 期待する利用者:レビューア/実装者/テスト実装者が、対象の前提(構成・依存)を把握できる内容にする
|
|
117
|
-
- 対象の粒度:`itc-index` の分割基準に従い、過分割/肥大化を避ける
|
|
118
|
-
- 結合対象(最低限):結合する主要コンポーネント(例:App層、DB層、Queue、Cache 等)を列挙してよい
|
|
119
|
-
- 詳細な仕様の説明や長い背景は書かない(根拠はトレースで示す)
|
|
88
|
+
- 対象の結合単位(ユースケース×主要I/F、サブシステム境界等)を1〜3行で示す。
|
|
89
|
+
- レビューア/実装者/テスト実装者が構成・依存を把握できるよう、主要コンポーネント(App層、DB層、Queue等)を示す。
|
|
90
|
+
- 粒度は `itc-index` の分割基準に従う。仕様の詳細は「トレース」に委ねる。
|
|
120
91
|
|
|
121
92
|
### 6.2. 責務(結合として保証)
|
|
122
93
|
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
- 箇条書きで 3〜7 個程度を目安に、**動詞で始まる**形で記述する
|
|
128
|
-
- 例:API入力を永続化モデルへ正しく変換する/制約違反時に規定エラーへ変換する/同一要求の冪等性を保証する
|
|
129
|
-
|
|
130
|
-
- 責務は「テスト観点」の上位概念であり、観点は責務を分解した切り口である(責務≠観点)
|
|
131
|
-
- 例外・異常系の責務も含める(制約違反、重複、整合性破壊、部分失敗、競合 等)
|
|
132
|
-
- 可能なら観測可能な成果(DB状態、レスポンス、イベント、ログ、トランザクション結果)とセットで書く
|
|
133
|
-
- 責務に含まれないものは「対象外」へ移す(曖昧さを残さない)
|
|
94
|
+
- 結合として保証する振る舞いを、動詞で始まる箇条書きで3〜7個程度示す。例:API入力を永続化モデルへ変換する/同一要求の冪等性を保証する。
|
|
95
|
+
- 制約違反、重複、部分失敗、競合等の異常系を含め、可能ならDB状態・レスポンス・イベント等の観測可能な成果を添える。
|
|
96
|
+
- 責務は観点の上位概念とし、観点はその分解とする。保証しないものは「対象外」へ記す。
|
|
134
97
|
|
|
135
98
|
### 6.3. 対象外
|
|
136
99
|
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
`itc-index` の「対象外・除外理由(共通)」と矛盾しないことが前提です。
|
|
141
|
-
|
|
142
|
-
- 対象外は「なぜ除外するか(理由)」と「代替レベル/代替手段」とセットで書く
|
|
143
|
-
- 対象固有の対象外(例:別サブシステムの責務、別termの責務)を明確にする
|
|
144
|
-
- 例外としてITで扱う場合は、条件・根拠・再現性担保(スタブ、固定設定等)を明記する
|
|
145
|
-
|
|
146
|
-
推奨フォーマット(簡易):
|
|
147
|
-
|
|
148
|
-
- 対象外:xxx(理由:yyy、代替:zzz)
|
|
100
|
+
- `itc-index` の「対象外・除外理由(共通)」に従い、別サブシステム・別termの責務など対象固有の除外を記す。
|
|
101
|
+
- 形式は「対象外:xxx(理由:yyy、代替:zzz)」とし、代替レベル/手段を明記する。
|
|
102
|
+
- 例外としてITで扱う場合は、条件・根拠・再現性対策(スタブ、固定設定等)を示す。
|
|
149
103
|
|
|
150
104
|
### 6.4. 結合境界/依存/環境前提
|
|
151
105
|
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
本節では、内部結合テストにおける「結合境界(どこまでが対象か)」「依存(外部要因)」「環境前提(再現性条件)」を明確にします。
|
|
155
|
-
ITは環境差で揺れやすいため、ここを固定することが重要です。
|
|
106
|
+
- 入口/出口(API、ユースケースI/F等)と結合対象(Service+Repository+DB等)を明記する。
|
|
107
|
+
- 依存ごとに実/スタブ/モック/固定化を選び、`itc-index` の共通方針から対象固有の設定を具体化する。
|
|
156
108
|
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
- メッセージング:テスト用ブローカ or 同等の決定性構成(同期化/待機条件も明記)
|
|
165
|
-
- ファイル/ストレージ:テスト用領域、Fake、I/F差替(再現性条件を明記)
|
|
109
|
+
| 依存 | 扱い・再現性条件 |
|
|
110
|
+
| ------------------- | --------------------------------------------------------- |
|
|
111
|
+
| DB | 原則実DB相当(コンテナ等)。スキーマ/制約を観測可能にする |
|
|
112
|
+
| 外部API | 原則Stub/Mockサーバで成功/失敗/タイムアウトを再現 |
|
|
113
|
+
| 時刻、乱数/UUID | TZを含む固定クロック・再現可能な基準時刻、シード/注入 |
|
|
114
|
+
| メッセージング | テスト用ブローカ等で決定性を担保し、同期化/待機条件を明記 |
|
|
115
|
+
| ファイル/ストレージ | テスト用領域、Fake、I/F差替と再現性条件を明記 |
|
|
166
116
|
|
|
167
|
-
-
|
|
168
|
-
- 「観測点(アサーション)」で何を検証するか(レスポンス/DB状態/イベント/相互作用)もここで整理してよい
|
|
117
|
+
- 環境前提としてDB初期化、seed、並列実行の分離、タイムアウト、ログ取得を推奨する。レスポンス/DB状態/イベント/相互作用の観測点も整理してよい。
|
|
169
118
|
|
|
170
119
|
### 6.5. トレース
|
|
171
120
|
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
本節では、`itc-<term>` の根拠となる上位成果物との対応関係(トレーサビリティ)を示します。
|
|
175
|
-
本カタログにおけるトレースの一次情報(SSOT)は **`## 5. トレース`** とし、観点・ケース表では **trace_key(`TR-xx`)参照**に統一します。
|
|
121
|
+
根拠仕様との対応の正本を本章の表とし、観点・ケース表では `trace_key`(`TR-xx`)を参照する。
|
|
176
122
|
|
|
177
|
-
#### 6.5.1.
|
|
123
|
+
#### 6.5.1. 記述ルール(`trace_key`)
|
|
178
124
|
|
|
179
|
-
-
|
|
180
|
-
-
|
|
181
|
-
-
|
|
182
|
-
- 新しい根拠が必要になった場合は、**先に本節の表へ行追加**し、付与された `trace_key` をケース表で参照する
|
|
183
|
-
- 追加順採番。並び替えても trace_key は維持する。また、削除しても欠番は詰めない
|
|
125
|
+
- `trace_key` は文書内で一意の `TR-xx`(2桁、01始まり推奨)とし、追加順に採番する。並べ替えても維持し、削除時は欠番を詰めない。
|
|
126
|
+
- 新たな根拠は先にトレース表へ追加する。
|
|
127
|
+
- 観点・ケース表の「トレース」列には仕様IDを直書きせず、`TR-xx` を列挙する。
|
|
184
128
|
|
|
185
129
|
#### 6.5.2. トレース表(標準フォーマット)
|
|
186
130
|
|
|
187
|
-
| trace_key | 仕様ID | 要点 | 備考 |
|
|
188
|
-
|
|
|
189
|
-
| TR-01
|
|
190
|
-
| TR-02
|
|
131
|
+
| `trace_key` | 仕様ID | 要点 | 備考 |
|
|
132
|
+
| ----------- | ------- | ------- | ---- |
|
|
133
|
+
| TR-01 | br-... | (1行) | 任意 |
|
|
134
|
+
| TR-02 | bac-... | (1行) | 任意 |
|
|
191
135
|
|
|
192
136
|
- `要点` は「ケース作成の判断に使ったポイント」を **1行**で書く(冗長な仕様説明はしない)
|
|
193
137
|
|
|
194
138
|
### 6.6. テスト観点とケース
|
|
195
139
|
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
本節は `itc-<term>` の中心です。観点(見出し)→ ケース表(末端表)の順で構成します。
|
|
140
|
+
観点(見出し)→意図→ケース表(末端表)の順で構成する。
|
|
199
141
|
|
|
200
142
|
#### 6.6.1. 観点:<観点>
|
|
201
143
|
|
|
202
|
-
生成する `itc-<term>` 本文の見出しは **### 6.1. 観点:<観点>**
|
|
203
|
-
|
|
204
144
|
- 観点は `itc-index` の「観点の立て方(共通)」に従って命名する
|
|
205
145
|
- 観点の粒度は「条件が複数ぶら下がる」程度にまとめる(細かすぎる観点の乱立を避ける)
|
|
206
146
|
- 観点名(見出し)は改善のため変更してよいが、`perspective_key` は原則変更しない(変更が必要なら `supersedes` 等で追跡する)
|
|
207
147
|
|
|
208
148
|
##### 6.6.1.1. 意図
|
|
209
149
|
|
|
210
|
-
生成する `itc-<term>` 本文の見出しは **#### 6.1.1. 意図**
|
|
211
|
-
|
|
212
150
|
- 観点ごとに「意図(この観点で保証すること)」を 1〜2 行で書く
|
|
213
151
|
|
|
214
152
|
##### 6.6.1.2. 条件・ケース表
|
|
215
153
|
|
|
216
|
-
生成する `itc-<term>` 本文の見出しは **#### 6.1.2. 条件・ケース表**
|
|
217
|
-
|
|
218
154
|
- ケース表の 1 行は「1テスト」を表す(条件×期待値が一意)
|
|
219
155
|
- 必須カラムは `itc-index` の定義に従う
|
|
220
156
|
- `case_id` は以下を推奨し、変更しない
|
|
@@ -245,64 +181,40 @@ ITは環境差で揺れやすいため、ここを固定することが重要で
|
|
|
245
181
|
|
|
246
182
|
## 8. サンプル(最小)
|
|
247
183
|
|
|
248
|
-
|
|
184
|
+
トレースとケースの対応を示す部分例です。成果物全体では「本文構成(標準テンプレ)」の必須6章を揃えます。仕様ID・証跡は例示です。
|
|
249
185
|
|
|
250
|
-
```
|
|
186
|
+
```markdown
|
|
251
187
|
---
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
status: draft
|
|
256
|
-
|
|
257
|
-
based_on: [tsp-index, itc-index]
|
|
258
|
-
supersedes: []
|
|
188
|
+
specdojo:
|
|
189
|
+
id: itc-order
|
|
190
|
+
type: test
|
|
191
|
+
status: draft
|
|
192
|
+
rulebook: specdojo:itc-rulebook
|
|
193
|
+
based_on: [tsp-index, itc-index]
|
|
259
194
|
---
|
|
260
|
-
```
|
|
261
|
-
|
|
262
|
-
### 8.1. 概要(order)
|
|
263
195
|
|
|
264
|
-
|
|
196
|
+
# 内部結合テストカタログ: 受注(order)
|
|
265
197
|
|
|
266
|
-
|
|
198
|
+
## 5. トレース
|
|
267
199
|
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
-
|
|
200
|
+
| `trace_key` | 仕様ID | 要点 | 備考 |
|
|
201
|
+
| ----------- | ------------- | -------------------- | ---- |
|
|
202
|
+
| TR-01 | bac-order-01 | 受注登録の入力制約 | |
|
|
203
|
+
| TR-02 | spec-order-05 | 重複時のエラーコード | |
|
|
271
204
|
|
|
272
|
-
|
|
205
|
+
## 6. テスト観点とケース
|
|
273
206
|
|
|
274
|
-
|
|
275
|
-
- ブラウザ操作のE2E(理由:責務外、代替:E2E)
|
|
207
|
+
### 6.1. 観点:永続化の整合性
|
|
276
208
|
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
- 結合境界:`POST /orders`
|
|
280
|
-
- 結合対象:OrderController → OrderService → OrderRepository → DB
|
|
281
|
-
- DB:PostgreSQL(コンテナ)、マイグレーション適用済み
|
|
282
|
-
- 外部在庫API:Stub(成功/失敗/タイムアウト)
|
|
283
|
-
- 時刻:固定クロック注入
|
|
284
|
-
- 初期化:テストごとにDBクリーン(トランザクション or truncate)
|
|
285
|
-
|
|
286
|
-
### 8.5. トレース
|
|
287
|
-
|
|
288
|
-
| trace_key | 仕様ID | 要点 | 備考 |
|
|
289
|
-
| --------- | ------------- | -------------------- | ---- |
|
|
290
|
-
| TR-01 | bac-order-01 | 受注登録の入力制約 | |
|
|
291
|
-
| TR-02 | spec-order-05 | 重複時のエラーコード | |
|
|
292
|
-
| TR-03 | br-order-02 | トランザクション境界 | |
|
|
293
|
-
|
|
294
|
-
### 8.6. テスト観点とケース
|
|
295
|
-
|
|
296
|
-
#### 8.6.1. 観点:永続化の整合性
|
|
297
|
-
|
|
298
|
-
##### 8.6.1.1. 意図
|
|
209
|
+
#### 6.1.1. 意図
|
|
299
210
|
|
|
300
211
|
入力→保存→取得で、データが欠損/改変されず、制約と整合性が担保されることを検証する。
|
|
301
212
|
|
|
302
|
-
|
|
213
|
+
#### 6.1.2. 条件・ケース表
|
|
303
214
|
|
|
304
|
-
| case_id
|
|
215
|
+
| `case_id` | 条件 | 手順(最小) | 期待値 | 観測点(アサーション) | 境界/依存 | トレース | 優先度 | 自動化 | 証跡 |
|
|
305
216
|
| ---------------------------------- | -------------------------------- | ------------ | ------------------------ | -------------------------- | --------------- | -------- | ------ | --------- | --------------------------------------- |
|
|
306
217
|
| it-order-persistence-integrity-010 | 入力: 正常 / 状態: DB空 | POST /orders | 201 + DBに1件作成 | レスポンス/DB行/主要カラム | DB=実(コンテナ) | TR-01 | P0 | automated | tests/it/orders/create.test.ts, CI#123 |
|
|
307
218
|
| it-order-persistence-integrity-020 | 入力: 制約違反 / 状態: DB空 | POST /orders | 400 + DBに作成されない | レスポンス/DB行0 | DB=実(制約観測) | TR-01 | P0 | automated | tests/it/orders/create.test.ts, CI#124 |
|
|
308
219
|
| it-order-persistence-integrity-030 | 入力: 重複 / 状態: 既存orderあり | POST /orders | 409 + DB状態が変化しない | エラーコード/DB差分なし | DB=実 | TR-02 | P1 | automated | tests/it/orders/duplicate.test.ts, CI#9 |
|
|
220
|
+
```
|