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,26 +13,17 @@ specdojo:
|
|
|
13
13
|
|
|
14
14
|
Unit Test Catalog (UTC) Index Documentation Rules
|
|
15
15
|
|
|
16
|
-
|
|
17
|
-
TSPに基づき、単体テストに共通するルールや方針を定義します。
|
|
18
|
-
|
|
19
|
-
個別単体テストカタログ(`utc-<term>`)の記述ルールは [utc-rulebook.md](utc-rulebook.md) を参照してください。
|
|
16
|
+
単体テストカタログの全体概要 `utc-index` に記載する共通方針・判断基準を定めます。対象別カタログ `utc-<term>` は [[specdojo:utc-rulebook|単体テストカタログ 対象別 作成ルール]] に従います。
|
|
20
17
|
|
|
21
18
|
## 1. 全体方針
|
|
22
19
|
|
|
23
|
-
`
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
-
|
|
27
|
-
- 個別の観点・条件・ケースは **`utc-<term>` に集約**し、詳細は **テストコード/CI証跡** に寄せる
|
|
28
|
-
- 記述は **レビュー可能**であることを優先し、長文化を避ける(方針は箇条書き中心)
|
|
29
|
-
- 「例外」や「対象外」を明示し、単体テストの責任境界(何をやらないか)を固定する
|
|
30
|
-
- `tsp-index` の方針を根拠として、単体テストに共通する **分割基準・観点/条件の立て方・依存境界・合格基準・証跡** を定義する
|
|
20
|
+
- **目的と根拠**: `tsp-index` に基づき、対象別カタログの分割基準・観点/条件・依存境界・合格基準・証跡方針を揃える。
|
|
21
|
+
- **責務境界**: `utc-index` は共通方針の正本とし、個別の観点・条件・ケースは `utc-<term>`、実装と実行結果の証跡はテストコード/CIに置く。対象外と例外条件を明示する。
|
|
22
|
+
- **記載レベル**: 判断基準をレビューできる粒度で記述し、個別ケースは列挙しない。
|
|
23
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認に含めない。
|
|
31
24
|
|
|
32
25
|
## 2. 位置づけ(他ドキュメントとの関係)
|
|
33
26
|
|
|
34
|
-
`utc-index` と他ドキュメントの関係を示します。
|
|
35
|
-
|
|
36
27
|
```mermaid
|
|
37
28
|
flowchart BT
|
|
38
29
|
TSP["tsp-index<br>テスト戦略・方針"]
|
|
@@ -55,30 +46,21 @@ flowchart BT
|
|
|
55
46
|
|
|
56
47
|
## 3. ファイル命名・ID規則
|
|
57
48
|
|
|
58
|
-
-
|
|
59
|
-
-
|
|
60
|
-
- `<term>`
|
|
49
|
+
- 対象ドキュメントの `id` は `utc-index`、対象別は `utc-<term>` とする。
|
|
50
|
+
- ファイル名は成果物カタログの宣言に合わせる(例: `utc-index.md`、`utc-010-単体テストカタログ-概要.md`)。
|
|
51
|
+
- `<term>` は用語集の論理名キー(英小文字の kebab-case)を用い、表示名は H1 に日本語で記載してよい。
|
|
61
52
|
|
|
62
53
|
## 4. 推奨 Frontmatter 項目
|
|
63
54
|
|
|
64
55
|
### 4.1. 設定内容
|
|
65
56
|
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
| 項目 | 説明 | 必須 |
|
|
69
|
-
| ---------- | -------------------------------------------------- | ---- |
|
|
70
|
-
| id | `utc-index`(固定) | ○ |
|
|
71
|
-
| type | `test` 固定 | ○ |
|
|
72
|
-
| title | 単体テストカタログ: 概要(`<システム名>`) | ○ |
|
|
73
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
74
|
-
| based_on | 根拠となる仕様ID(ID配列。未指定時は `[]` を許容) | 任意 |
|
|
75
|
-
| supersedes | 置き換え関係(ID配列。未指定時は `[]` を許容) | 任意 |
|
|
57
|
+
許可キー・必須項目・型は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とする。`specdojo.type` は `test`、`specdojo.rulebook` は `specdojo:utc-index-rulebook` とする。タイトルは H1 に「単体テストカタログ: 概要(対象システム名)」と記載する。
|
|
76
58
|
|
|
77
59
|
### 4.2. 推奨ルール
|
|
78
60
|
|
|
79
|
-
- `based_on`
|
|
80
|
-
- BAC/NFR/BR
|
|
81
|
-
-
|
|
61
|
+
- `based_on` には直接の根拠とした `tsp-index` を含める。
|
|
62
|
+
- BAC/NFR/BR 等は、境界・分配・共通合格基準の判断に直接利用した文書だけを列挙する。
|
|
63
|
+
- 成果物カタログに `depends_on` がある場合、参照はその推移閉包内の作成済み文書に限定する。
|
|
82
64
|
|
|
83
65
|
## 5. 本文構成(標準テンプレ)
|
|
84
66
|
|
|
@@ -96,34 +78,24 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
96
78
|
| 8 | ケース表の共通カラム | ○ |
|
|
97
79
|
| 9 | メモ / 将来課題 | 任意 |
|
|
98
80
|
|
|
99
|
-
|
|
100
|
-
生成する `utc-index` 本文の見出しは各章で指定された **番号付き** の形式
|
|
101
|
-
(例: `## 6.`, `### 6.1.` / `#### 6.1.1.` / `#### 6.1.2.`)に置き換えてください。
|
|
81
|
+
本文の見出しは上表の番号と名称を用いる。「記述ガイド」の節番号は rulebook 内の参照用であり、成果物へ転記しない。
|
|
102
82
|
|
|
103
83
|
## 6. 記述ガイド
|
|
104
84
|
|
|
105
|
-
|
|
85
|
+
受入確認では代表的な対象を選び、次を順に照合する。
|
|
106
86
|
|
|
107
|
-
|
|
87
|
+
1. `tsp-index` と対象範囲・除外理由・代替レベルを照合し、責務境界に矛盾がないこと。
|
|
88
|
+
2. 観点/条件を採用基準に当てはめ、主担当の `utc-<term>` を一つ定められ、例外には根拠があること。
|
|
89
|
+
3. 代表ケースを共通カラムで表現し、依存を制御して期待値を判定でき、テストコード/CI証跡へ接続できること。
|
|
108
90
|
|
|
109
|
-
|
|
91
|
+
### 6.1. 本ドキュメントの目的と適用対象
|
|
110
92
|
|
|
111
|
-
-
|
|
112
|
-
-
|
|
113
|
-
-
|
|
114
|
-
- 成果物の位置づけ:
|
|
115
|
-
- `utc-index`:共通方針(SSOT)
|
|
116
|
-
- `utc-<term>`:対象別の観点・条件・ケース表(SSOT)
|
|
117
|
-
- テストコード/CI:実装と実行証跡(SSOT)
|
|
118
|
-
- SSOTの一次情報は `utc-index` / `utc-<term>` とし、テストコード/CIは **実装と実行結果の証跡(Evidence)** として扱う。
|
|
119
|
-
- 本書が扱う粒度:**判断基準・共通ルールまで**(個別ケースの列挙は禁止)
|
|
93
|
+
- 誰がどのテスト作成・レビューの判断に使うかと、対象システム・領域を示す。
|
|
94
|
+
- `utc-<term>` の品質・粒度・責任範囲を揃える目的と、単体テスト(UT)の適用範囲を示す。
|
|
95
|
+
- 内部結合以降(IT/ET/ST/AT)のルールは、それぞれの `*c-index` で扱う。
|
|
120
96
|
|
|
121
97
|
### 6.2. テスト対象の括り方と分割基準
|
|
122
98
|
|
|
123
|
-
生成する `utc-index` 本文の見出しは **## 2. テスト対象の括り方と分割基準**
|
|
124
|
-
|
|
125
|
-
本節では、`utc-<term>` の `<term>` をどう切るか(対象単位の設計)を定義します。
|
|
126
|
-
|
|
127
99
|
- `<term>` は「責務のまとまり」(例:ドメインサービス/ユースケース/主要関数群)とする
|
|
128
100
|
- 分割基準(推奨順):
|
|
129
101
|
1. **責務境界**:何をする単位かが説明できる
|
|
@@ -138,11 +110,6 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
138
110
|
|
|
139
111
|
### 6.3. 対象外・除外理由(共通)
|
|
140
112
|
|
|
141
|
-
生成する `utc-index` 本文の見出しは **## 3. 対象外・除外理由(共通)**
|
|
142
|
-
|
|
143
|
-
本節では、単体テスト(UT)で **やらないこと** と、その **理由**、および **例外条件** を明確にします。
|
|
144
|
-
「UTでやるべきこと」を書くよりも、「UTでやらないこと」を固定する方が、責任境界がぶれにくくなります。
|
|
145
|
-
|
|
146
113
|
#### 6.3.1. 記述ルール
|
|
147
114
|
|
|
148
115
|
- 形式は **「対象外(何をやらないか)」「除外理由(なぜやらないか)」「例外(UTで扱う条件)」** の3点セットを基本とする
|
|
@@ -160,15 +127,17 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
160
127
|
|
|
161
128
|
#### 6.3.3. 典型例(記載候補)
|
|
162
129
|
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
130
|
+
| 対象外(やらないこと) | 除外理由 | 代替レベル/代替手段 | 例外(UTで扱う条件) |
|
|
131
|
+
| -------------------------------------- | ---------------------- | ------------------- | ----------------------------------------------- |
|
|
132
|
+
| UI操作・画面遷移・DOM操作 | ロジック検証を逸脱する | E2E | DOMに依存しない純関数のUIロジックのみ |
|
|
133
|
+
| 実DB接続・実I/O、スキーマ・SQLの妥当性 | 環境依存を伴う | IT | なし。SQL自体が責務でも実接続の検証は IT に委譲 |
|
|
134
|
+
| 外部サービスとの実通信・実認証 | 外部要因で結果が揺れる | IT/ET | 外部SDKのアダプタ層の純粋な入出力変換のみ |
|
|
135
|
+
| 並行性・性能・負荷・耐久(p95等) | 測定条件が別 | 非機能テスト | なし |
|
|
136
|
+
| ブラウザ互換・端末差分 | 実行環境差の確認が必要 | E2E | なし |
|
|
168
137
|
|
|
169
|
-
|
|
138
|
+
例外を適用する `utc-<term>` には、根拠と依存の制御方法を明記する。
|
|
170
139
|
|
|
171
|
-
|
|
140
|
+
### 6.4. 観点の立て方(共通)
|
|
172
141
|
|
|
173
142
|
観点(Perspective)は「何を保証するか」の切り口であり、対象別カタログの章立て(見出し)として用います。
|
|
174
143
|
|
|
@@ -187,8 +156,6 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
187
156
|
|
|
188
157
|
### 6.5. 条件の立て方(共通)
|
|
189
158
|
|
|
190
|
-
生成する `utc-index` 本文の見出しは **## 5. 条件の立て方(共通)**
|
|
191
|
-
|
|
192
159
|
条件(Condition)は、観点を確認するための前提状態・入力状態・環境条件のバリエーションです。
|
|
193
160
|
条件は「入力」「状態」「環境」に分解して作成します。
|
|
194
161
|
|
|
@@ -205,10 +172,6 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
205
172
|
|
|
206
173
|
### 6.6. 観点/条件の採用基準と対象別への分配方針(共通)
|
|
207
174
|
|
|
208
|
-
生成する `utc-index` 本文の見出しは **## 6. 観点/条件の採用基準と対象別への分配方針(共通)**
|
|
209
|
-
|
|
210
|
-
本節では、観点/条件を「採用する判断」と「`utc-<term>` へ割り当てる判断」を共通ルールとして定義します。
|
|
211
|
-
|
|
212
175
|
#### 6.6.1. 採用基準(共通)
|
|
213
176
|
|
|
214
177
|
- 観点は「1観点=1合否命題」で採用する(複数命題の混在を禁止)
|
|
@@ -233,14 +196,11 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
233
196
|
|
|
234
197
|
### 6.7. 単体テスト共通の境界/依存の扱い
|
|
235
198
|
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
単体テストでは、対象の責務を明確にし、依存は原則として制御可能にします。
|
|
239
|
-
依存の扱いは `utc-<term>` 間でぶれないよう、本節で共通方針を定めます。
|
|
199
|
+
依存を制御可能にし、対象別カタログ間で共通方針を揃える。
|
|
240
200
|
|
|
241
201
|
- DB:
|
|
242
202
|
- 原則:実DBに依存しない(In-memory / Fake / Repository mock 等)
|
|
243
|
-
-
|
|
203
|
+
- スキーマ/SQLそのものが責務の場合も、実接続の検証は IT へ寄せる
|
|
244
204
|
- 外部API/外部サービス:
|
|
245
205
|
- 原則:Mock/Stubで制御(成功・失敗・タイムアウトを再現可能に)
|
|
246
206
|
- 時刻:
|
|
@@ -258,8 +218,6 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
258
218
|
|
|
259
219
|
### 6.8. ケース表の共通カラム
|
|
260
220
|
|
|
261
|
-
生成する `utc-index` 本文の見出しは **## 8. ケース表の共通カラム**
|
|
262
|
-
|
|
263
221
|
`utc-<term>` の末端(条件・ケース表)は、検索性・比較性・自動化移行の容易さを確保するため、
|
|
264
222
|
全termで同一カラム順を採用します。
|
|
265
223
|
|
|
@@ -291,16 +249,12 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
291
249
|
|
|
292
250
|
### 6.9. メモ / 将来課題
|
|
293
251
|
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
本節は、現時点で決めきれない事項や将来の改善点を記録します。
|
|
297
|
-
ただし、運用ルールとして必須な内容は本節に置かず、本文(1〜8章)へ反映します。
|
|
298
|
-
|
|
252
|
+
- 未決事項がある場合、論点と影響(当面の扱い・決定後に直す方針や列)を記録する。
|
|
253
|
+
- 確定した必須方針は該当する本文の章へ反映する。
|
|
299
254
|
- 将来検討(例):
|
|
300
255
|
- 組合せ削減の方法(ペアワイズ導入)
|
|
301
256
|
- 証跡リンク形式の統一(CI URL、レポート保存場所)
|
|
302
257
|
- 自動化率の目標と移行基準
|
|
303
|
-
- カタログのlint(case_id重複、必須列欠落など)
|
|
304
258
|
|
|
305
259
|
## 7. 禁止事項
|
|
306
260
|
|
|
@@ -315,74 +269,25 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
315
269
|
|
|
316
270
|
## 8. サンプル(最小)
|
|
317
271
|
|
|
318
|
-
|
|
272
|
+
形式の輪郭を示す抜粋。成果物の全章構成は「本文構成(標準テンプレ)」に従う。
|
|
319
273
|
|
|
320
|
-
```
|
|
274
|
+
```markdown
|
|
321
275
|
---
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
status: draft
|
|
326
|
-
|
|
327
|
-
|
|
276
|
+
specdojo:
|
|
277
|
+
id: utc-index
|
|
278
|
+
type: test
|
|
279
|
+
status: draft
|
|
280
|
+
rulebook: specdojo:utc-index-rulebook
|
|
281
|
+
based_on: [tsp-index]
|
|
328
282
|
---
|
|
329
|
-
```
|
|
330
|
-
|
|
331
|
-
### 8.1. 本ドキュメントの目的と適用対象
|
|
332
|
-
|
|
333
|
-
本ドキュメントは、単体テストカタログ(UTC)の全体概要 `utc-index` を統一形式で記述するためのルールである。
|
|
334
|
-
`utc-index` は単体テストに共通する「対象単位の切り方」「観点/条件の立て方」「依存境界」「合格基準」「証跡方針」を定義し、
|
|
335
|
-
対象別カタログ `utc-<term>` の作成と運用の基盤とする。
|
|
336
|
-
|
|
337
|
-
### 8.2. テスト対象の括り方と分割基準
|
|
338
|
-
|
|
339
|
-
`utc-<term>` の `<term>` は責務のまとまり(例:サービス/ユースケース/主要関数群)とする。
|
|
340
|
-
分割は責務境界・変更影響・依存境界・担当境界を基準とし、過分割と肥大化の双方を避ける。
|
|
341
|
-
観点が過剰、または依存境界が混在する場合は分割候補とする。
|
|
342
|
-
|
|
343
|
-
### 8.3. 対象外・除外理由(共通)
|
|
344
|
-
|
|
345
|
-
単体テスト(UT)では、対象の責務を「小さく・決定的に」検証するため、以下は原則として対象外とする。
|
|
346
|
-
|
|
347
|
-
| 対象外(やらないこと) | 除外理由 | 代替レベル/代替手段 | 例外(UTで扱う条件) |
|
|
348
|
-
| ----------------------------------------------------- | ---------------------------------------------- | ------------------------ | --------------------------------------------------------------- |
|
|
349
|
-
| UIの操作手順や画面遷移の検証(クリック列挙、DOM検証) | UTの責務(ロジック検証)を逸脱し、保守性が低い | E2E(e2eカタログ) | UIロジックが純関数化され、DOMに依存しない場合のみ |
|
|
350
|
-
| 実DB接続・実I/Oによる検証(スキーマ/SQLの正当性) | 環境依存・不安定になりやすい | IT(itcカタログ) | SQLそのものがプロダクト責務で、Fakeでは妥当性が評価できない場合 |
|
|
351
|
-
| 外部サービス疎通(実通信、実認証、ネットワーク障害) | 外部要因で結果が揺れ、再現性が低い | IT/ET(itc/etcカタログ) | 外部SDKのアダプタ層の「入力→出力変換」など純粋な変換責務のみ |
|
|
352
|
-
| 性能・負荷・耐久(p95、スループット、長時間稼働) | UTのスコープ外で測定条件の設計が別物 | NFR(nfrカタログ) | なし |
|
|
353
|
-
| ブラウザ/端末差分(表示崩れ、入力方式差) | 実行環境差が本質でUTでは再現困難 | E2E(e2eカタログ) | なし |
|
|
354
|
-
|
|
355
|
-
例外を適用する場合は、`utc-<term>` 側に「例外の根拠(なぜUTで必要か)」と「依存の制御方法」を明記する。
|
|
356
283
|
|
|
357
|
-
|
|
284
|
+
# 単体テストカタログ: 概要(販売管理)
|
|
358
285
|
|
|
359
|
-
|
|
360
|
-
観点名は「名詞+品質/振る舞い」で統一し、条件を複数持てる程度の粒度にまとめる。
|
|
286
|
+
## 3. 対象外・除外理由(共通)
|
|
361
287
|
|
|
362
|
-
|
|
288
|
+
| 対象外(やらないこと) | 除外理由 | 代替レベル/代替手段 | 例外(UTで扱う条件) |
|
|
289
|
+
| ---------------------- | -------------------------- | ------------------- | ------------------------------------- |
|
|
290
|
+
| UI操作・画面遷移 | UTのロジック検証を逸脱する | E2E | DOMに依存しない純関数のUIロジックのみ |
|
|
363
291
|
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
### 8.6. 観点/条件の採用基準と対象別への分配方針(共通)
|
|
368
|
-
|
|
369
|
-
観点/条件は、業務影響・境界/例外/状態遷移の重要性・上位仕様根拠を基準に採用する。
|
|
370
|
-
分配は責務境界・依存境界・変更影響を基準に主担当 `utc-<term>` を1つ定め、重複は例外として扱う。
|
|
371
|
-
分配結果は `utc-<term>` のケース表とトレース列で追跡可能にする。
|
|
372
|
-
|
|
373
|
-
### 8.7. 単体テスト共通の境界/依存の扱い
|
|
374
|
-
|
|
375
|
-
単体テストでは依存を制御可能にし、テストの決定性を担保する。
|
|
376
|
-
DBは原則Fake/Mock等で実DB依存を避け、外部APIはMock/Stubで成功・失敗・タイムアウトを再現可能にする。
|
|
377
|
-
時刻・乱数・UUIDは注入または固定化し、直参照を禁止する。
|
|
378
|
-
|
|
379
|
-
### 8.8. ケース表の共通カラム
|
|
380
|
-
|
|
381
|
-
対象別カタログ `utc-<term>` の末端表は、全termで共通のカラム順を採用する。
|
|
382
|
-
必須:case_id / 条件 / 手順(最小) / 期待値
|
|
383
|
-
推奨:観測点(アサーション)/ 境界・依存 / トレース / 優先度 / 自動化 / 証跡
|
|
384
|
-
|
|
385
|
-
### 8.9. メモ / 将来課題
|
|
386
|
-
|
|
387
|
-
将来検討事項(例):組合せ削減の手法(ペアワイズ)、証跡リンク形式の統一、カタログlint(case_id重複検出)等を記録する。
|
|
388
|
-
運用ルールとして必須になった時点で本文へ昇格させる。
|
|
292
|
+
例外を適用する対象別カタログには、根拠と依存の制御方法を示す。
|
|
293
|
+
```
|
|
@@ -13,24 +13,18 @@ specdojo:
|
|
|
13
13
|
|
|
14
14
|
Unit Test Catalog (UTC) Documentation Rules
|
|
15
15
|
|
|
16
|
-
|
|
17
|
-
`utc-index` を前提に、SSOTの本体として、対象ごとの **単体テストの責務・境界・依存、観点 x 条件=ケース、トレース、証跡** を明文化します。
|
|
16
|
+
単体テストカタログ(UTC)の対象別 `utc-<term>` に記載する責務・境界・依存、観点×条件=ケース、トレース、証跡の基準を定めます。
|
|
18
17
|
|
|
19
18
|
## 1. 全体方針
|
|
20
19
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
-
|
|
25
|
-
-
|
|
26
|
-
- ケースは「表の1行=1テスト」とし、手順と期待値は **判定可能**な粒度で簡潔に書く
|
|
27
|
-
- 詳細な操作列挙やデータ大量列挙は避け、必要な詳細はテストコード側へ寄せる(証跡で参照可能にする)
|
|
28
|
-
- すべての観点・ケースは、根拠仕様(`based_on` / `トレース`)と、証跡(テストコード/CI)に接続されていること
|
|
20
|
+
- **正本と責務境界**: 対象固有の情報を `utc-<term>` に集約し、共通方針は `utc-index` を参照する。
|
|
21
|
+
- **決定性**: 対象の責務を決定的に検証するため、実DB/実通信/実UIを原則排除する。例外は条件と根拠を示す。
|
|
22
|
+
- **記載レベル**: ケースは表の1行=1テストとし、判定可能な手順・期待値を書く。大量のデータや詳細な操作はテストコードへ寄せる。
|
|
23
|
+
- **追跡性**: すべての観点・ケースを根拠仕様とテストコード/CI証跡へ接続する。
|
|
24
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認に含めない。
|
|
29
25
|
|
|
30
26
|
## 2. 位置づけ(他ドキュメントとの関係)
|
|
31
27
|
|
|
32
|
-
個別 UTC(`utc-<term>`)と他ドキュメントの関係を示します。
|
|
33
|
-
|
|
34
28
|
```mermaid
|
|
35
29
|
flowchart BT
|
|
36
30
|
TSP["tsp-index<br>テスト戦略・方針"]
|
|
@@ -55,35 +49,19 @@ flowchart BT
|
|
|
55
49
|
|
|
56
50
|
- `id` は `utc-<term>`(kebab-case。例: `utc-inventory`)。
|
|
57
51
|
- ファイル名は `utc-010-単体テストカタログ-<term>.md` 等(例: `utc-010-単体テストカタログ-在庫.md`)。
|
|
58
|
-
- `<term>`
|
|
52
|
+
- `<term>` は用語集(GL)の論理名キー(英小文字kebab-case)を用いる。表示名は H1 / ファイル名で日本語を使用してよい。
|
|
59
53
|
|
|
60
54
|
## 4. 推奨 Frontmatter 項目
|
|
61
55
|
|
|
62
56
|
### 4.1. 設定内容
|
|
63
57
|
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
- 参照スキーマ: [docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml](../../../specdojo/schemas/v1/deliverable-frontmatter.schema.yaml)
|
|
67
|
-
- メタ情報標準: [document-metadata-standard.md](../standards/document-metadata-standard.md)
|
|
68
|
-
|
|
69
|
-
| 項目 | 説明 | 必須 |
|
|
70
|
-
| ---------- | -------------------------------------------------------------------------------- | ---- |
|
|
71
|
-
| id | UTC ID(個別: `utc-<term>`) | ○ |
|
|
72
|
-
| type | `test` 固定 | ○ |
|
|
73
|
-
| title | 単体テストカタログ: <対象名> | ○ |
|
|
74
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
75
|
-
| based_on | 根拠仕様(最低限: `tsp-index`, `utc-index`。対象固有の根拠は本文トレースに集約) | ○ |
|
|
76
|
-
| part_of | 集約ドキュメントへの所属(ID配列) | 任意 |
|
|
77
|
-
| supersedes | 置き換え関係 | 任意 |
|
|
58
|
+
許可キー・必須項目・型は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とする。`specdojo.type` は `test`、`specdojo.rulebook` は `specdojo:utc-rulebook` とする。タイトルは H1 に「単体テストカタログ: <対象名>」と記載する。
|
|
78
59
|
|
|
79
60
|
### 4.2. 推奨ルール
|
|
80
61
|
|
|
81
|
-
- `based_on`
|
|
82
|
-
- `
|
|
83
|
-
|
|
84
|
-
機械処理上の都合で `based_on` にも列挙する場合は、本文トレースと矛盾しないこと。
|
|
85
|
-
- 記述内容が多くなる場合は、ドキュメントを分割し、`part_of` で集約ドキュメントに所属させます。
|
|
86
|
-
- `part_of` / `based_on` / `supersedes` は ID 配列(未指定は `[]` 可)。
|
|
62
|
+
- `based_on` は観点の根拠仕様を列挙し、原則 `[tsp-index, utc-index]` を最低限とする。
|
|
63
|
+
- 対象固有の根拠(`br-*` / `bac-*` / `spec-*` / `nfr-*` 等)は本文「トレース」に集約する。機械処理のため `based_on` にも列挙する場合は本文と整合させる。
|
|
64
|
+
- 内容が多く分割する場合は、`part_of` で集約ドキュメントに所属させる。
|
|
87
65
|
|
|
88
66
|
## 5. 本文構成(標準テンプレ)
|
|
89
67
|
|
|
@@ -98,126 +76,81 @@ Frontmatter は共通スキーマに従います(あわせてドキュメン
|
|
|
98
76
|
| 5 | トレース | ○ |
|
|
99
77
|
| 6 | テスト観点とケース | ○ |
|
|
100
78
|
|
|
101
|
-
|
|
102
|
-
生成する `utc-<term>` 本文の見出しは各章で指定された **番号付き** の形式
|
|
103
|
-
(例: `## 6.`, `### 6.1.` / `#### 6.1.1.` / `#### 6.1.2.`)に置き換えてください。
|
|
79
|
+
成果物は上表の番号・名称を `##` 見出しにする。「記述ガイド」の節番号は転記しない。「テスト観点とケース」の配下は `### 6.n. 観点:<観点>`、`#### 6.n.1. 意図`、`#### 6.n.2. 条件・ケース表` の順とする。
|
|
104
80
|
|
|
105
81
|
## 6. 記述ガイド
|
|
106
82
|
|
|
107
|
-
|
|
83
|
+
受入確認では次を順に照合する。
|
|
108
84
|
|
|
109
|
-
|
|
85
|
+
1. `utc-index` と責務・対象外・依存の扱いを照合し、例外に条件と根拠があることを確かめる。
|
|
86
|
+
2. 各責務に対応する観点・代表条件・境界条件・重大例外と、トレース先の仕様が一致することを確かめる。
|
|
87
|
+
3. ケースの条件・手順・期待値・観測点をテストコードと照合し、依存を制御して同じ合否を再現でき、CI証跡へ辿れることを確かめる。
|
|
110
88
|
|
|
111
|
-
|
|
89
|
+
### 6.1. 概要(`<term>`)
|
|
112
90
|
|
|
113
|
-
-
|
|
114
|
-
-
|
|
115
|
-
-
|
|
116
|
-
- 関連コンポーネントや主要API(任意):対象の入口(関数名、クラス名、モジュール名等)を列挙してよい
|
|
117
|
-
- 詳細な仕様の説明や長い背景は書かない(根拠はトレースで示す)
|
|
91
|
+
- 対象を責務のまとまりとして1〜3行で説明し、レビューア・実装者・テスト実装者が前提を把握できるようにする。
|
|
92
|
+
- 粒度は `utc-index` の分割基準に従い、過分割/肥大化を避ける。
|
|
93
|
+
- 主要APIや関連コンポーネントは任意。詳細な仕様や背景はトレース先に置く。
|
|
118
94
|
|
|
119
95
|
### 6.2. 責務
|
|
120
96
|
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
- 箇条書きで 3〜7 個程度を目安に、**動詞で始まる**形で記述する
|
|
126
|
-
- 例:入力を検証する/業務ルールを適用する/状態遷移を行う/エラーコードを返す
|
|
127
|
-
- 責務は「テスト観点」の上位概念であり、観点は責務を分解した切り口である(責務≠観点)
|
|
128
|
-
- 例外・異常系の責務も含める(不正入力時の振る舞い、権限、期限切れ、競合 等)
|
|
129
|
-
- 可能なら観測可能な成果(戻り値、例外、状態更新、依存呼び出し)とセットで書く
|
|
130
|
-
- 責務に含まれないものは「対象外」へ移す(曖昧さを残さない)
|
|
97
|
+
- 保証すべき責務を3〜7個程度、動詞で始まる箇条書きにする(例:入力を検証する/業務ルールを適用する/状態遷移を行う/エラーコードを返す)。
|
|
98
|
+
- 観点は責務を分解した切り口とし、不正入力・権限・期限切れ・競合などの例外も含める。
|
|
99
|
+
- 戻り値・例外・状態更新・依存呼び出しなど観測可能な成果を可能なら併記する。責務に含めないものは「対象外」へ移す。
|
|
131
100
|
|
|
132
101
|
### 6.3. 対象外
|
|
133
102
|
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
`utc-index` の「対象外・除外理由(共通)」と矛盾しないことが前提です。
|
|
138
|
-
|
|
139
|
-
- 対象外は「なぜ除外するか(理由)」とセットで書く
|
|
140
|
-
- 可能なら「代替するレベル」(IT/ET/E2E/NFR 等)も併記する
|
|
141
|
-
- 対象固有の対象外(例:別モジュールの責務、別termの責務)を明確にする
|
|
142
|
-
- 例外としてUTで扱う場合は、条件・根拠・依存の制御方法(Mock等)を明記する
|
|
143
|
-
|
|
144
|
-
推奨フォーマット(簡易):
|
|
145
|
-
|
|
146
|
-
- 対象外:xxx(理由:yyy、代替:zzz)
|
|
103
|
+
- `utc-index` の「対象外・除外理由(共通)」と整合させ、別モジュール・別termの責務など対象固有の除外を示す。
|
|
104
|
+
- 形式は「対象外:xxx(理由:yyy、代替:zzz)」を推奨し、可能なら代替レベル(IT/ET/E2E/NFR等)も併記する。
|
|
105
|
+
- UTで扱う例外には条件・根拠・依存の制御方法(Mock等)を書く。
|
|
147
106
|
|
|
148
107
|
### 6.4. 境界/依存
|
|
149
108
|
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
- 境界:対象の入口/出口(公開API、関数、クラス、モジュール)を明記する
|
|
156
|
-
- 依存はカテゴリごとに列挙し、「扱い(Mock/Stub/Fake/固定化)」を決める
|
|
157
|
-
- DB:Fake/Repository mock 等
|
|
158
|
-
- 外部API:Mock/Stub(成功/失敗/タイムアウトを再現)
|
|
159
|
-
- 時刻:固定クロック(注入)
|
|
109
|
+
- 境界は対象の入口/出口(公開API、関数、クラス、モジュール)を示す。
|
|
110
|
+
- 依存は `utc-index` の方針に従い、カテゴリごとに扱いを決める。
|
|
111
|
+
- DB:Fake/Repository mock
|
|
112
|
+
- 外部API:Mock/Stub(成功・失敗・タイムアウトを再現)
|
|
113
|
+
- 時刻:固定クロック注入
|
|
160
114
|
- 乱数/UUID:固定シード/生成器注入
|
|
161
115
|
- ファイル/ストレージ:Fake(テンポラリ/メモリ)/I/F差替
|
|
162
116
|
- 非同期:同期化/制御可能なスケジューラ
|
|
163
|
-
-
|
|
164
|
-
- 「観測点(アサーション)」で何を検証するか(戻り値/例外/状態/相互作用)もここで整理してよい
|
|
117
|
+
- 例外には理由と再現性・速度・保守性への影響を書く。観測点(戻り値/例外/状態/相互作用)も整理してよい。
|
|
165
118
|
|
|
166
119
|
### 6.5. トレース
|
|
167
120
|
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
本節では、`utc-<term>` の根拠となる上位成果物との対応関係(トレーサビリティ)を示します。
|
|
171
|
-
本カタログにおけるトレースの一次情報(SSOT)は **`## 5. トレース`** とし、観点・ケース表では **trace_key(`TR-xx`)参照**に統一します。
|
|
172
|
-
|
|
173
|
-
#### 6.5.1. 記述ルール(trace_key)
|
|
174
|
-
|
|
175
|
-
- 各トレース項目に **trace_key(`TR-xx`)** を付与する
|
|
176
|
-
- 例:`TR-01`, `TR-02` …(2桁、01始まり推奨)
|
|
177
|
-
|
|
178
|
-
- `trace_key` は **本ドキュメント内で一意**で、原則変更しない
|
|
179
|
-
- 仕様IDの改名・統合・分割が起きた場合でも、可能な限り `trace_key` は維持し、対応先(仕様ID)を更新する
|
|
121
|
+
根拠となる上位仕様との対応は「トレース」の表を正本とし、観点・ケース表は `trace_key`(`TR-xx`)で参照する。
|
|
180
122
|
|
|
181
|
-
|
|
182
|
-
- 例:`TR-02` / `TR-01,TR-03`
|
|
123
|
+
#### 6.5.1. 記述ルール(`trace_key`)
|
|
183
124
|
|
|
184
|
-
-
|
|
185
|
-
|
|
186
|
-
- `TR-
|
|
125
|
+
- `trace_key` は文書内で一意とし、追加順に採番する(`TR-01` 始まりの2桁を推奨)。並べ替えや削除で振り直さず、欠番を詰めない。
|
|
126
|
+
- 仕様IDの改名・統合・分割でもキーを可能な限り維持し、対応先を更新する。
|
|
127
|
+
- 観点・ケース表の `トレース` 列は仕様IDを直書きせず `TR-02` / `TR-01,TR-03` のように記載する。根拠の追加時は先にトレース表へ行を追加する。
|
|
187
128
|
|
|
188
129
|
#### 6.5.2. トレース表(標準フォーマット)
|
|
189
130
|
|
|
190
|
-
|
|
|
191
|
-
|
|
|
192
|
-
|
|
|
193
|
-
|
|
|
194
|
-
|
|
195
|
-
|
|
131
|
+
| 列名 | 内容・判断条件 |
|
|
132
|
+
| ----------- | ------------------------------------------- |
|
|
133
|
+
| `trace_key` | 観点・ケースから参照する一意なキー |
|
|
134
|
+
| 仕様ID | 根拠仕様の文書ID |
|
|
135
|
+
| 要点 | ケース作成の判断に使ったポイントを1行で示す |
|
|
136
|
+
| 備考 | 補足がある場合に記載する |
|
|
196
137
|
|
|
197
138
|
### 6.6. テスト観点とケース
|
|
198
139
|
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
本節は `utc-<term>` の中心です。観点(見出し)→ ケース表(末端表)の順で構成します。
|
|
140
|
+
観点ごとに意図とケース表を記述する。
|
|
202
141
|
|
|
203
142
|
#### 6.6.1. 観点:<観点>
|
|
204
143
|
|
|
205
|
-
生成する `utc-<term>` 本文の見出しは **### 6.1. 観点:<観点>**
|
|
206
|
-
|
|
207
144
|
- 観点は `utc-index` の「観点の立て方(共通)」に従って命名する
|
|
208
145
|
- 観点の粒度は「条件が複数ぶら下がる」程度にまとめる(細かすぎる観点の乱立を避ける)
|
|
209
146
|
- 観点名(見出し)は改善のため変更してよいが、`perspective_key` は原則変更しない(変更が必要なら `supersedes` 等で追跡する)。
|
|
210
147
|
|
|
211
148
|
##### 6.6.1.1. 意図
|
|
212
149
|
|
|
213
|
-
生成する `utc-<term>` 本文の見出しは **#### 6.1.1. 意図**
|
|
214
|
-
|
|
215
150
|
- 観点ごとに「意図(この観点で保証すること)」を 1〜2 行で書く
|
|
216
151
|
|
|
217
152
|
##### 6.6.1.2. 条件・ケース表
|
|
218
153
|
|
|
219
|
-
生成する `utc-<term>` 本文の見出しは **#### 6.1.2. 条件・ケース表**
|
|
220
|
-
|
|
221
154
|
- ケース表の 1 行は「1テスト」を表す(条件×期待値が一意)
|
|
222
155
|
- 必須カラムは `utc-index` の定義に従う
|
|
223
156
|
- `case_id` は以下を推奨し、変更しない
|
|
@@ -245,60 +178,39 @@ Frontmatter は共通スキーマに従います(あわせてドキュメン
|
|
|
245
178
|
|
|
246
179
|
## 8. サンプル(最小)
|
|
247
180
|
|
|
248
|
-
|
|
181
|
+
トレースとケースの接続を示す抜粋。全章構成は「本文構成(標準テンプレ)」に従う。
|
|
249
182
|
|
|
250
|
-
```
|
|
183
|
+
```markdown
|
|
251
184
|
---
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
status: draft
|
|
256
|
-
|
|
257
|
-
based_on: [tsp-index, utc-index]
|
|
258
|
-
supersedes: []
|
|
185
|
+
specdojo:
|
|
186
|
+
id: utc-auth
|
|
187
|
+
type: test
|
|
188
|
+
status: draft
|
|
189
|
+
rulebook: specdojo:utc-rulebook
|
|
190
|
+
based_on: [tsp-index, utc-index]
|
|
259
191
|
---
|
|
260
|
-
```
|
|
261
192
|
|
|
262
|
-
|
|
193
|
+
# 単体テストカタログ: 認証(auth)
|
|
263
194
|
|
|
264
|
-
|
|
195
|
+
## 5. トレース
|
|
265
196
|
|
|
266
|
-
|
|
197
|
+
| `trace_key` | 仕様ID | 要点 | 備考 |
|
|
198
|
+
| ----------- | ----------- | ------------------------ | ---- |
|
|
199
|
+
| TR-01 | br-auth-01 | トークン検証ルール | |
|
|
200
|
+
| TR-02 | bac-auth-02 | 期限切れ時のエラーコード | |
|
|
267
201
|
|
|
268
|
-
|
|
269
|
-
- 権限に応じて許可/拒否を判定する
|
|
270
|
-
- 失敗時に規定のエラーコードを返す
|
|
202
|
+
## 6. テスト観点とケース
|
|
271
203
|
|
|
272
|
-
###
|
|
204
|
+
### 6.1. 観点:入力検証
|
|
273
205
|
|
|
274
|
-
|
|
275
|
-
- 実DB接続による検証(理由:環境依存、代替:IT)
|
|
276
|
-
|
|
277
|
-
### 8.4. 境界/依存
|
|
278
|
-
|
|
279
|
-
- 境界:`verifyToken(token)` / `authorize(user, action)`
|
|
280
|
-
- DB:Fake(インメモリ)
|
|
281
|
-
- 外部IdP:Stub(成功/失敗/タイムアウト)
|
|
282
|
-
- 時刻:固定クロック注入
|
|
283
|
-
|
|
284
|
-
### 8.5. トレース
|
|
285
|
-
|
|
286
|
-
| trace_key | 仕様ID | 要点 | 備考 |
|
|
287
|
-
| --------- | ----------- | ------------------------ | ---- |
|
|
288
|
-
| TR-01 | br-auth-01 | トークン検証ルール | |
|
|
289
|
-
| TR-02 | bac-auth-02 | 期限切れ時のエラーコード | |
|
|
290
|
-
|
|
291
|
-
### 8.6. テスト観点とケース
|
|
292
|
-
|
|
293
|
-
#### 8.6.1. 観点:入力検証
|
|
294
|
-
|
|
295
|
-
##### 8.6.1.1. 意図
|
|
206
|
+
#### 6.1.1. 意図
|
|
296
207
|
|
|
297
208
|
形式不正や期限切れを確実に検出し、規定のエラーコードを返す。
|
|
298
209
|
|
|
299
|
-
|
|
210
|
+
#### 6.1.2. 条件・ケース表
|
|
300
211
|
|
|
301
|
-
| case_id
|
|
302
|
-
| ---------------------------- | ------------------- | ------------------ | -------------- | ---------------------- | --------- |
|
|
303
|
-
| ut-auth-input-validation-010 | 入力: 期限切れtoken | verifyToken(token) | AUTH-001で失敗 | 例外型+code | 時刻=固定 | TR-02
|
|
304
|
-
| ut-auth-input-validation-020 | 入力: 形式不正token | verifyToken(token) | AUTH-002で失敗 | 例外型+code |
|
|
212
|
+
| `case_id` | 条件 | 手順(最小) | 期待値 | 観測点(アサーション) | 境界/依存 | トレース | 優先度 | 自動化 | 証跡 |
|
|
213
|
+
| ---------------------------- | ------------------- | ------------------ | -------------- | ---------------------- | --------- | -------- | ------ | --------- | -------------------------------------- |
|
|
214
|
+
| ut-auth-input-validation-010 | 入力: 期限切れtoken | verifyToken(token) | AUTH-001で失敗 | 例外型+code | 時刻=固定 | TR-02 | P0 | automated | tests/auth/verifyToken.test.ts, CI#123 |
|
|
215
|
+
| ut-auth-input-validation-020 | 入力: 形式不正token | verifyToken(token) | AUTH-002で失敗 | 例外型+code | 時刻=固定 | TR-01 | P1 | automated | tests/auth/verifyToken.test.ts, CI#124 |
|
|
216
|
+
```
|