@sdd-method/maintain-cli 0.4.0 → 0.6.0
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/dist/lib/catalogue/build.js +13 -0
- package/dist/lib/catalogue/builders/c4-entity-rollups.js +1 -1
- package/dist/lib/catalogue/builders/capabilities.js +4 -1
- package/dist/lib/catalogue/builders/contracts.js +1 -1
- package/dist/lib/catalogue/builders/event-edges.js +1 -1
- package/dist/lib/catalogue/builders/product-edges.js +3 -1
- package/dist/lib/catalogue/builders/product-platform-dependencies.js +16 -1
- package/dist/lib/catalogue/builders/requirements.js +240 -0
- package/dist/lib/catalogue/canonical-schema.yaml +160 -7
- package/dist/lib/catalogue/rubric-coverage-map.yaml +36 -0
- package/dist/lib/catalogue/schema-compat.js +1 -1
- package/dist/lib/ci-binding/index.js +2 -0
- package/dist/lib/ci-binding/module.js +17 -7
- package/dist/lib/init/ci-workflow.js +2 -0
- package/dist/lib/sync/config.js +8 -1
- package/dist/lib/validate/behaviour-store.js +351 -0
- package/dist/lib/validate/dispatch.js +18 -0
- package/dist/lib/validate/plan.js +2 -0
- package/dist/lib/vocabulary/renames.js +40 -0
- package/dist/lib/vocabulary/vocabulary-renames.yaml +76 -0
- package/dist/maintain-version.json +2 -2
- package/dist/verify-version.json +2 -2
- package/package.json +4 -6
- package/scripts/validate-app-dependencies.sh +30 -22
- package/scripts/validate-integration-docs.sh +1 -1
- package/LICENSE +0 -201
- package/NOTICE +0 -17
|
@@ -94,6 +94,8 @@ function gitlabBlock(profile, runner) {
|
|
|
94
94
|
' DOCKER_TLS_CERTDIR: "/certs"',
|
|
95
95
|
' DOCKER_TLS_VERIFY: "1"',
|
|
96
96
|
' DOCKER_CERT_PATH: "/certs/client"',
|
|
97
|
+
// Full history: the behaviour-store stale check diffs living specs against each change's agreed commit.
|
|
98
|
+
' GIT_DEPTH: "0"',
|
|
97
99
|
" rules:",
|
|
98
100
|
' - if: $CI_PIPELINE_SOURCE == "merge_request_event"',
|
|
99
101
|
" - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH",
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
*/
|
|
13
13
|
import { createHash } from "node:crypto";
|
|
14
14
|
import { getMaintainCliVersion, getVerifyCliVersion } from "../package-version.js";
|
|
15
|
+
import { OPENSPEC_VERSION } from "../validate/behaviour-store.js";
|
|
15
16
|
/** Where the module lives in an SDD (M-ADR 0219 §4.3, ruled 2026-10-16). */
|
|
16
17
|
export const MODULE_DIR = ".dagger/method-validation";
|
|
17
18
|
/**
|
|
@@ -37,8 +38,9 @@ const VERIFY_PIN = "@@VERIFY_CLI_VERSION@@";
|
|
|
37
38
|
// scan would read this text as an import of the CLI's own and refuse a dependency it does not declare.
|
|
38
39
|
const DAGGER_SDK = "@@DAGGER_SDK@@";
|
|
39
40
|
const MAINTAIN_PIN = "@@MAINTAIN_CLI_VERSION@@";
|
|
41
|
+
const OPENSPEC_PIN = "@@OPENSPEC_VERSION@@";
|
|
40
42
|
// The module's own source. String.raw keeps it byte-for-byte, so it holds no backtick; its only
|
|
41
|
-
// substitutions are the
|
|
43
|
+
// substitutions are the four markers above, which renderModuleFiles replaces.
|
|
42
44
|
const INDEX_TS = String.raw `/**
|
|
43
45
|
* Method Validation (M-ADR 0219): the method-managed validation job, as one Dagger module. Every CI
|
|
44
46
|
* host calls it, and none keeps a step list of its own. Written by sdd-cli sync and method-managed:
|
|
@@ -57,6 +59,8 @@ import { dag, Container, Directory, File, object, func, ReturnType } from ${DAGG
|
|
|
57
59
|
// Pinned, so a run is reproducible and every tool the validators shell out to is named here.
|
|
58
60
|
const NODE_IMAGE = "node:20-bookworm"
|
|
59
61
|
const YQ_VERSION = "v4.44.3"
|
|
62
|
+
// The behaviour-store checks run OpenSpec at exactly the version the method depends on (M-ADR 0223 ruling 2), telemetry off.
|
|
63
|
+
const OPENSPEC_VERSION = "${OPENSPEC_PIN}"
|
|
60
64
|
|
|
61
65
|
interface PlanStep {
|
|
62
66
|
id: string
|
|
@@ -69,8 +73,8 @@ interface PlanStep {
|
|
|
69
73
|
@object()
|
|
70
74
|
export class MethodValidation {
|
|
71
75
|
/**
|
|
72
|
-
* The toolchain: Node, git, bash, python3, ripgrep, a pinned yq,
|
|
73
|
-
* maintain CLIs. A tarball, when given, replaces the published package (a release candidate).
|
|
76
|
+
* The toolchain: Node, git, bash, python3, ripgrep, a pinned yq, the pinned OpenSpec CLI, and the
|
|
77
|
+
* exact-pinned verify and maintain CLIs. A tarball, when given, replaces the published package (a release candidate).
|
|
74
78
|
*/
|
|
75
79
|
@func()
|
|
76
80
|
toolchain(
|
|
@@ -99,7 +103,11 @@ export class MethodValidation {
|
|
|
99
103
|
c = c.withFile("/pkgs/maintain-cli.tgz", maintainTarball)
|
|
100
104
|
pkgs.push("/pkgs/maintain-cli.tgz")
|
|
101
105
|
} else pkgs.push("@sdd-method/maintain-cli@" + maintainVersion)
|
|
102
|
-
|
|
106
|
+
pkgs.push("@fission-ai/openspec@" + OPENSPEC_VERSION)
|
|
107
|
+
return c
|
|
108
|
+
.withEnvVariable("OPENSPEC_TELEMETRY", "0")
|
|
109
|
+
.withEnvVariable("DO_NOT_TRACK", "1")
|
|
110
|
+
.withExec(["npm", "install", "-g", "--silent", ...pkgs])
|
|
103
111
|
}
|
|
104
112
|
|
|
105
113
|
/**
|
|
@@ -130,10 +138,12 @@ export class MethodValidation {
|
|
|
130
138
|
for (const step of plan.steps) {
|
|
131
139
|
const ran = base.withExec([step.tool, ...step.args], { expect: ReturnType.Any })
|
|
132
140
|
const code = await ran.exitCode()
|
|
133
|
-
|
|
141
|
+
// A step that ran over an empty population (no behaviour store, say) reports N/A, never PASS.
|
|
142
|
+
const measuredNothing = code === 0 && /^\[(N\/A|SKIP)\] /m.test(await ran.stdout()) && !/^\[PASS\] (?!All validators)/m.test(await ran.stdout())
|
|
143
|
+
const verdict = code === 0 ? (measuredNothing ? "N/A" : "PASS") : step.advisory ? "ADVISORY" : "FAIL"
|
|
134
144
|
if (code !== 0 && !step.advisory) failed++
|
|
135
145
|
lines.push(verdict.padEnd(8) + " exit " + code + " " + step.id + " (" + step.title + ")")
|
|
136
|
-
if (code !== 0) {
|
|
146
|
+
if (code !== 0 || measuredNothing) {
|
|
137
147
|
const out = (await ran.stdout()) + (await ran.stderr())
|
|
138
148
|
lines.push(...out.trim().split("\n").slice(-6).map((l) => " " + l))
|
|
139
149
|
}
|
|
@@ -257,7 +267,7 @@ export function renderModuleFiles(pins = { verify: getVerifyCliVersion(), mainta
|
|
|
257
267
|
["catalogue-rebuild.sh", REBUILD_SH],
|
|
258
268
|
["dagger.json", DAGGER_JSON],
|
|
259
269
|
["package.json", PACKAGE_JSON],
|
|
260
|
-
["src/index.ts", INDEX_TS.split(VERIFY_PIN).join(pins.verify).split(MAINTAIN_PIN).join(pins.maintain).split(DAGGER_SDK).join('"@dagger.io' + '/dagger"')],
|
|
270
|
+
["src/index.ts", INDEX_TS.split(VERIFY_PIN).join(pins.verify).split(MAINTAIN_PIN).join(pins.maintain).split(OPENSPEC_PIN).join(OPENSPEC_VERSION).split(DAGGER_SDK).join('"@dagger.io' + '/dagger"')],
|
|
261
271
|
["tsconfig.json", TSCONFIG_JSON],
|
|
262
272
|
["yarn.lock", YARN_LOCK],
|
|
263
273
|
];
|
|
@@ -93,6 +93,8 @@ function buildMethodManagedBlock(profile, runner) {
|
|
|
93
93
|
// The branch itself when rebuilding, so the rebuild lands on it; otherwise the event's own ref.
|
|
94
94
|
" ref: ${{ steps.catalogue-token.outputs.token != '' && (github.head_ref || github.ref_name) || '' }}",
|
|
95
95
|
" persist-credentials: false",
|
|
96
|
+
// Full history: the behaviour-store stale check diffs living specs against each change's agreed commit.
|
|
97
|
+
" fetch-depth: 0",
|
|
96
98
|
" - name: Install Dagger",
|
|
97
99
|
` run: curl -fsSL https://dl.dagger.io/dagger/install.sh | BIN_DIR="$RUNNER_TEMP/dagger" DAGGER_VERSION=${DAGGER_VERSION} sh && echo "$RUNNER_TEMP/dagger" >> "$GITHUB_PATH"`,
|
|
98
100
|
" - name: Rebuild catalogues",
|
package/dist/lib/sync/config.js
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { existsSync } from "node:fs";
|
|
1
2
|
import { readFile } from "node:fs/promises";
|
|
2
3
|
import { dirname, isAbsolute, resolve } from "node:path";
|
|
3
4
|
import { parse as parseYaml } from "yaml";
|
|
@@ -57,7 +58,7 @@ export async function loadSyncConfig(configPath) {
|
|
|
57
58
|
const rel = `${name}/${name}-${ver}.tar.gz`;
|
|
58
59
|
source = isUrl(resolvedBase)
|
|
59
60
|
? `${resolvedBase.replace(/\/$/, "")}/${rel}`
|
|
60
|
-
: resolve(resolvedBase, name, `${name}-${ver}
|
|
61
|
+
: localBundle(resolve(resolvedBase, name), `${name}-${ver}`);
|
|
61
62
|
}
|
|
62
63
|
else {
|
|
63
64
|
throw new Error(`Sync config ${absPath} bundles[${i}] missing required field: source ` +
|
|
@@ -69,4 +70,10 @@ export async function loadSyncConfig(configPath) {
|
|
|
69
70
|
? { version, bundles }
|
|
70
71
|
: { version, bundleSource, bundles };
|
|
71
72
|
}
|
|
73
|
+
// <dir>/<stem>.tar.gz, or <dir>/<stem>.tgz when only that exists (same bytes, another name).
|
|
74
|
+
function localBundle(dir, stem) {
|
|
75
|
+
const tarGz = resolve(dir, `${stem}.tar.gz`);
|
|
76
|
+
const tgz = resolve(dir, `${stem}.tgz`);
|
|
77
|
+
return !existsSync(tarGz) && existsSync(tgz) ? tgz : tarGz;
|
|
78
|
+
}
|
|
72
79
|
//# sourceMappingURL=config.js.map
|
|
@@ -0,0 +1,351 @@
|
|
|
1
|
+
// Behaviour-store checks (M-ADR 0221, 0222, 0223): the gates OpenSpec itself does not enforce.
|
|
2
|
+
//
|
|
3
|
+
// An SDD's behaviour store is an OpenSpec project; in the inside-SDD shape it is `openspec/` at the
|
|
4
|
+
// SDD root, with one agreement record per change at `docs/agreements/<change>.yaml`
|
|
5
|
+
// (agreement-record-schema.yaml). OpenSpec checks the format of specs and deltas. It does not check
|
|
6
|
+
// that a change was agreed before it was built, that the requirements it modifies stayed as they
|
|
7
|
+
// were agreed, or that an archived change was judged. These are those checks:
|
|
8
|
+
//
|
|
9
|
+
// 1. records: every agreement record has the shape the checks below read.
|
|
10
|
+
// 2. agreement: an open change with any completed task has an agreed record and a Gate 0 that
|
|
11
|
+
// ends CLEAR (the pre-apply check, M-ADR 0223 §4.3).
|
|
12
|
+
// 3. stale: for each open, agreed change that MODIFIES, REMOVES or RENAMES requirements, the
|
|
13
|
+
// targeted living specs are unchanged since the agreed commit (M-ADR 0223 §4.5).
|
|
14
|
+
// With no such targets the check is vacuous, and says so.
|
|
15
|
+
// 4. verdicts: every archived change except a baseline has a verdict.md and a record whose
|
|
16
|
+
// verdict is PASS and names it (M-ADR 0223 §4.6).
|
|
17
|
+
//
|
|
18
|
+
// A sibling-repository store (M-ADR 0221 §4.2) is checked in that repository, not here.
|
|
19
|
+
//
|
|
20
|
+
// OPENSPEC'S OWN VALIDATION is the separate validator `behaviour-store-openspec`, because it needs
|
|
21
|
+
// the OpenSpec CLI at OPENSPEC_VERSION (the Method Validation module installs it). Without a store
|
|
22
|
+
// both report [N/A], an empty population, never a pass.
|
|
23
|
+
import { execFile } from "node:child_process";
|
|
24
|
+
import { access, readdir, readFile } from "node:fs/promises";
|
|
25
|
+
import { basename, join } from "node:path";
|
|
26
|
+
import { promisify } from "node:util";
|
|
27
|
+
import { parseDocument } from "yaml";
|
|
28
|
+
const execFileAsync = promisify(execFile);
|
|
29
|
+
/** The OpenSpec release the method depends on (M-ADR 0223 ruling 2). The module installs exactly this. */
|
|
30
|
+
export const OPENSPEC_VERSION = "1.14.3";
|
|
31
|
+
/** Telemetry off for every OpenSpec run the method makes. */
|
|
32
|
+
export const OPENSPEC_ENV = { OPENSPEC_TELEMETRY: "0", DO_NOT_TRACK: "1" };
|
|
33
|
+
export const STORE_DIR = "openspec";
|
|
34
|
+
export const AGREEMENTS_DIR = "docs/agreements";
|
|
35
|
+
const AGREEMENT_STATUSES = ["proposed", "agreed", "superseded", "withdrawn"];
|
|
36
|
+
const COMMIT_RE = /^[0-9a-f]{7,40}$/;
|
|
37
|
+
// OpenSpec counts a task done when its box holds only `x`, either case, any spacing.
|
|
38
|
+
const TASK_DONE_RE = /^\s*-\s*\[\s*[xX]\s*\]/m;
|
|
39
|
+
const TARGET_HEADING_RE = /^##\s+(MODIFIED|REMOVED|RENAMED)\s+Requirements\b/m;
|
|
40
|
+
async function exists(p) {
|
|
41
|
+
try {
|
|
42
|
+
await access(p);
|
|
43
|
+
return true;
|
|
44
|
+
}
|
|
45
|
+
catch {
|
|
46
|
+
return false;
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
async function dirs(p) {
|
|
50
|
+
try {
|
|
51
|
+
return (await readdir(p, { withFileTypes: true })).filter((d) => d.isDirectory()).map((d) => d.name).sort();
|
|
52
|
+
}
|
|
53
|
+
catch {
|
|
54
|
+
return [];
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
async function readText(p) {
|
|
58
|
+
try {
|
|
59
|
+
return await readFile(p, "utf8");
|
|
60
|
+
}
|
|
61
|
+
catch {
|
|
62
|
+
return null;
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
/** Read and shape-check one agreement record. Returns the record, or the problems found. */
|
|
66
|
+
export function parseAgreementRecord(file, text) {
|
|
67
|
+
const problems = [];
|
|
68
|
+
const doc = parseDocument(text);
|
|
69
|
+
if (doc.errors.length > 0) {
|
|
70
|
+
return { problems: doc.errors.map((e) => `${file}: does not parse: ${e.message.split("\n")[0]}`) };
|
|
71
|
+
}
|
|
72
|
+
const root = doc.toJS();
|
|
73
|
+
const r = root?.agreement_record;
|
|
74
|
+
if (!r || typeof r !== "object")
|
|
75
|
+
return { problems: [`${file}: no top-level agreement_record`] };
|
|
76
|
+
const expected = basename(file).replace(/\.ya?ml$/, "");
|
|
77
|
+
if (r.change !== expected)
|
|
78
|
+
problems.push(`${file}: change is ${JSON.stringify(r.change)}, expected "${expected}" (the file name)`);
|
|
79
|
+
const status = typeof r.status === "string" ? r.status : "";
|
|
80
|
+
if (!AGREEMENT_STATUSES.includes(status)) {
|
|
81
|
+
problems.push(`${file}: status ${JSON.stringify(r.status)} is not one of ${AGREEMENT_STATUSES.join(" | ")}`);
|
|
82
|
+
}
|
|
83
|
+
const sdd = (r.sdd ?? {});
|
|
84
|
+
const gates = Array.isArray(r.gates) ? r.gates : [];
|
|
85
|
+
const gate0 = gates.find((g) => g && g.name === "gate-0");
|
|
86
|
+
if (status === "agreed") {
|
|
87
|
+
if (r.agreed_on === undefined || r.agreed_on === null)
|
|
88
|
+
problems.push(`${file}: agreed, but no agreed_on`);
|
|
89
|
+
if (typeof r.approved_by !== "string" || r.approved_by.trim() === "")
|
|
90
|
+
problems.push(`${file}: agreed, but no approved_by`);
|
|
91
|
+
if (typeof sdd.commit !== "string") {
|
|
92
|
+
problems.push(`${file}: sdd.commit must be a quoted string, found ${sdd.commit === undefined ? "nothing" : `${typeof sdd.commit} ${String(sdd.commit)}`}` +
|
|
93
|
+
(typeof sdd.commit === "number" ? " (unquoted, YAML parsed the SHA as a number)" : ""));
|
|
94
|
+
}
|
|
95
|
+
else if (!COMMIT_RE.test(sdd.commit)) {
|
|
96
|
+
problems.push(`${file}: sdd.commit "${sdd.commit}" is not 7-40 hex characters`);
|
|
97
|
+
}
|
|
98
|
+
if (!gate0)
|
|
99
|
+
problems.push(`${file}: agreed, but no gates entry named gate-0`);
|
|
100
|
+
else if (gate0.result !== "CLEAR")
|
|
101
|
+
problems.push(`${file}: agreed, but gate-0 result is ${JSON.stringify(gate0.result)}, not CLEAR`);
|
|
102
|
+
}
|
|
103
|
+
// Every commit a record pins must survive parsing as a string. YAML 1.2 reads an unquoted
|
|
104
|
+
// all-digit abbreviation as an integer and one shaped like `1234e567` or `123e456` as a float
|
|
105
|
+
// (Infinity), and the pin is then lost; checking the PARSED type is the only test that catches
|
|
106
|
+
// both, since a pattern applied after coercion sees "Infinity" or a number.
|
|
107
|
+
for (const [path, value] of commitFields(r)) {
|
|
108
|
+
if (path === "sdd.commit")
|
|
109
|
+
continue;
|
|
110
|
+
if (typeof value !== "string") {
|
|
111
|
+
problems.push(`${file}: ${path} must be a quoted string, found ${typeof value} ${String(value)} (unquoted, YAML parsed the SHA as a number)`);
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
const verdict = r.verdict && typeof r.verdict === "object" ? r.verdict : undefined;
|
|
115
|
+
if (problems.length > 0)
|
|
116
|
+
return { problems };
|
|
117
|
+
return {
|
|
118
|
+
record: {
|
|
119
|
+
file,
|
|
120
|
+
change: expected,
|
|
121
|
+
status,
|
|
122
|
+
...(typeof sdd.commit === "string" ? { commit: sdd.commit } : {}),
|
|
123
|
+
...(typeof gate0?.result === "string" ? { gate0: gate0.result } : {}),
|
|
124
|
+
...(verdict ? { verdict } : {}),
|
|
125
|
+
},
|
|
126
|
+
problems,
|
|
127
|
+
};
|
|
128
|
+
}
|
|
129
|
+
/** Every pinned commit in a record: any key named `commit` or ending `_commit`, and each value under verdict.merged and current. */
|
|
130
|
+
function commitFields(r) {
|
|
131
|
+
const out = [];
|
|
132
|
+
const walk = (v, path, pinMap) => {
|
|
133
|
+
if (Array.isArray(v))
|
|
134
|
+
v.forEach((x, i) => walk(x, `${path}[${i}]`, false));
|
|
135
|
+
else if (v && typeof v === "object") {
|
|
136
|
+
for (const [k, x] of Object.entries(v)) {
|
|
137
|
+
const p = path === "" ? k : `${path}.${k}`;
|
|
138
|
+
const isPin = pinMap || k === "commit" || k.endsWith("_commit");
|
|
139
|
+
if (isPin && (x === null || typeof x !== "object"))
|
|
140
|
+
out.push([p, x]);
|
|
141
|
+
else
|
|
142
|
+
walk(x, p, p === "verdict.merged" || p === "current");
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
};
|
|
146
|
+
walk(r, "", false);
|
|
147
|
+
return out;
|
|
148
|
+
}
|
|
149
|
+
function lastGateLine(text) {
|
|
150
|
+
const lines = text.split("\n").map((l) => l.trim()).filter((l) => l !== "");
|
|
151
|
+
return lines.at(-1) ?? "";
|
|
152
|
+
}
|
|
153
|
+
async function gitDiffQuiet(repo, commit, path) {
|
|
154
|
+
try {
|
|
155
|
+
await execFileAsync("git", ["-C", repo, "cat-file", "-e", `${commit}^{commit}`]);
|
|
156
|
+
}
|
|
157
|
+
catch {
|
|
158
|
+
return "unresolved";
|
|
159
|
+
}
|
|
160
|
+
try {
|
|
161
|
+
await execFileAsync("git", ["-C", repo, "diff", "--quiet", commit, "HEAD", "--", path]);
|
|
162
|
+
return "same";
|
|
163
|
+
}
|
|
164
|
+
catch (err) {
|
|
165
|
+
return err.code === 1 ? "changed" : "unresolved";
|
|
166
|
+
}
|
|
167
|
+
}
|
|
168
|
+
/** The living specs an open change's deltas modify, remove or rename: openspec/specs/<capability>/spec.md. */
|
|
169
|
+
async function targetedSpecs(repo, changeDir) {
|
|
170
|
+
const out = [];
|
|
171
|
+
const walk = async (rel) => {
|
|
172
|
+
const abs = join(repo, changeDir, "specs", rel);
|
|
173
|
+
let entries;
|
|
174
|
+
try {
|
|
175
|
+
entries = await readdir(abs, { withFileTypes: true });
|
|
176
|
+
}
|
|
177
|
+
catch {
|
|
178
|
+
return;
|
|
179
|
+
}
|
|
180
|
+
for (const e of entries) {
|
|
181
|
+
const childRel = rel === "" ? e.name : `${rel}/${e.name}`;
|
|
182
|
+
if (e.isDirectory())
|
|
183
|
+
await walk(childRel);
|
|
184
|
+
else if (e.name === "spec.md") {
|
|
185
|
+
const text = (await readText(join(abs, e.name))) ?? "";
|
|
186
|
+
if (TARGET_HEADING_RE.test(text))
|
|
187
|
+
out.push(`${STORE_DIR}/specs/${rel}/spec.md`);
|
|
188
|
+
}
|
|
189
|
+
}
|
|
190
|
+
};
|
|
191
|
+
await walk("");
|
|
192
|
+
return out.sort();
|
|
193
|
+
}
|
|
194
|
+
export async function checkBehaviourStore(repo) {
|
|
195
|
+
if (!(await exists(join(repo, STORE_DIR)))) {
|
|
196
|
+
return { exitCode: 0, stdout: `[N/A] no behaviour store (${STORE_DIR}/) in this repository\n` };
|
|
197
|
+
}
|
|
198
|
+
const lines = [];
|
|
199
|
+
const failures = [];
|
|
200
|
+
// 1. records
|
|
201
|
+
const records = new Map();
|
|
202
|
+
let recordFiles = [];
|
|
203
|
+
try {
|
|
204
|
+
recordFiles = (await readdir(join(repo, AGREEMENTS_DIR))).filter((f) => /\.ya?ml$/.test(f)).sort();
|
|
205
|
+
}
|
|
206
|
+
catch {
|
|
207
|
+
recordFiles = [];
|
|
208
|
+
}
|
|
209
|
+
for (const f of recordFiles) {
|
|
210
|
+
const rel = `${AGREEMENTS_DIR}/${f}`;
|
|
211
|
+
const { record, problems } = parseAgreementRecord(rel, (await readText(join(repo, rel))) ?? "");
|
|
212
|
+
failures.push(...problems);
|
|
213
|
+
if (record)
|
|
214
|
+
records.set(record.change, record);
|
|
215
|
+
}
|
|
216
|
+
lines.push(`records: ${recordFiles.length} agreement record(s), ${recordFiles.length - records.size} malformed`);
|
|
217
|
+
// 2 and 3. open changes
|
|
218
|
+
const open = (await dirs(join(repo, STORE_DIR, "changes"))).filter((d) => d !== "archive");
|
|
219
|
+
let started = 0;
|
|
220
|
+
let staleChecked = 0;
|
|
221
|
+
for (const change of open) {
|
|
222
|
+
const dir = `${STORE_DIR}/changes/${change}`;
|
|
223
|
+
const tasks = await readText(join(repo, dir, "tasks.md"));
|
|
224
|
+
const record = records.get(change);
|
|
225
|
+
if (tasks !== null && TASK_DONE_RE.test(tasks)) {
|
|
226
|
+
started++;
|
|
227
|
+
if (!record)
|
|
228
|
+
failures.push(`${dir}: has completed tasks but no agreement record (${AGREEMENTS_DIR}/${change}.yaml)`);
|
|
229
|
+
else if (record.status !== "agreed")
|
|
230
|
+
failures.push(`${dir}: has completed tasks but its agreement record is ${record.status}, not agreed`);
|
|
231
|
+
const gate = await readText(join(repo, dir, "gate-0.md"));
|
|
232
|
+
if (gate === null)
|
|
233
|
+
failures.push(`${dir}: has completed tasks but no gate-0.md`);
|
|
234
|
+
else if (lastGateLine(gate) !== "GATE: CLEAR")
|
|
235
|
+
failures.push(`${dir}: has completed tasks but gate-0.md ends "${lastGateLine(gate)}", not "GATE: CLEAR"`);
|
|
236
|
+
}
|
|
237
|
+
if (record?.status === "agreed" && record.commit) {
|
|
238
|
+
for (const spec of await targetedSpecs(repo, dir)) {
|
|
239
|
+
staleChecked++;
|
|
240
|
+
const r = await gitDiffQuiet(repo, record.commit, spec);
|
|
241
|
+
if (r === "changed")
|
|
242
|
+
failures.push(`${dir}: STALE: ${spec} changed since the agreed commit ${record.commit}`);
|
|
243
|
+
if (r === "unresolved")
|
|
244
|
+
failures.push(`${dir}: stale check unresolved: commit ${record.commit} is not in this clone's history (a shallow clone cannot run it)`);
|
|
245
|
+
}
|
|
246
|
+
}
|
|
247
|
+
}
|
|
248
|
+
lines.push(`agreement: ${open.length} open change(s), ${started} with completed tasks`);
|
|
249
|
+
lines.push(staleChecked === 0 ? "stale: vacuous (no open agreed change modifies, removes or renames a requirement)" : `stale: ${staleChecked} targeted living spec(s) checked against their agreed commits`);
|
|
250
|
+
// 4. archived changes
|
|
251
|
+
const archived = await dirs(join(repo, STORE_DIR, "changes", "archive"));
|
|
252
|
+
let baselines = 0;
|
|
253
|
+
for (const name of archived) {
|
|
254
|
+
const dir = `${STORE_DIR}/changes/archive/${name}`;
|
|
255
|
+
if (await exists(join(repo, dir, "baseline-evidence.md"))) {
|
|
256
|
+
baselines++;
|
|
257
|
+
continue;
|
|
258
|
+
}
|
|
259
|
+
const change = name.replace(/^\d{4}-\d{2}-\d{2}-/, "");
|
|
260
|
+
if (!(await exists(join(repo, dir, "verdict.md"))))
|
|
261
|
+
failures.push(`${dir}: archived without verdict.md`);
|
|
262
|
+
const record = records.get(change);
|
|
263
|
+
if (!record) {
|
|
264
|
+
failures.push(`${dir}: archived without an agreement record (${AGREEMENTS_DIR}/${change}.yaml)`);
|
|
265
|
+
continue;
|
|
266
|
+
}
|
|
267
|
+
if (record.verdict?.result !== "PASS")
|
|
268
|
+
failures.push(`${record.file}: change is archived but verdict.result is ${JSON.stringify(record.verdict?.result)}, not PASS`);
|
|
269
|
+
const vr = record.verdict?.record;
|
|
270
|
+
if (typeof vr !== "string" || !(await exists(join(repo, vr))))
|
|
271
|
+
failures.push(`${record.file}: verdict.record ${JSON.stringify(vr)} does not name an existing file`);
|
|
272
|
+
}
|
|
273
|
+
lines.push(`verdicts: ${archived.length} archived change(s), ${baselines} baseline(s), ${archived.length - baselines} needing a PASS verdict`);
|
|
274
|
+
const population = recordFiles.length + open.length + archived.length;
|
|
275
|
+
const body = lines.map((l) => ` ${l}`).join("\n") + "\n";
|
|
276
|
+
if (failures.length > 0) {
|
|
277
|
+
return { exitCode: 1, stdout: body + failures.map((f) => `[FAIL] ${f}`).join("\n") + "\n" };
|
|
278
|
+
}
|
|
279
|
+
if (population === 0)
|
|
280
|
+
return { exitCode: 0, stdout: body + `[N/A] the behaviour store has no changes and no agreement records yet\n` };
|
|
281
|
+
return { exitCode: 0, stdout: body + "[PASS] behaviour store: records, agreement, stale and verdict checks hold\n" };
|
|
282
|
+
}
|
|
283
|
+
async function runOpenspec(repo, args) {
|
|
284
|
+
try {
|
|
285
|
+
const { stdout } = await execFileAsync("openspec", args, { cwd: repo, env: { ...process.env, ...OPENSPEC_ENV }, maxBuffer: 16 * 1024 * 1024 });
|
|
286
|
+
return { code: 0, json: JSON.parse(stdout), raw: stdout };
|
|
287
|
+
}
|
|
288
|
+
catch (err) {
|
|
289
|
+
const e = err;
|
|
290
|
+
let json;
|
|
291
|
+
try {
|
|
292
|
+
json = JSON.parse(e.stdout ?? "");
|
|
293
|
+
}
|
|
294
|
+
catch {
|
|
295
|
+
json = undefined;
|
|
296
|
+
}
|
|
297
|
+
return { code: typeof e.code === "number" ? e.code : 127, ...(json ? { json } : {}), raw: (e.stdout ?? "") + (e.stderr ?? "") };
|
|
298
|
+
}
|
|
299
|
+
}
|
|
300
|
+
/** OpenSpec's own strict validation of the store: specs and open changes, and archived changes' tasks. */
|
|
301
|
+
export async function checkBehaviourStoreOpenspec(repo) {
|
|
302
|
+
if (!(await exists(join(repo, STORE_DIR)))) {
|
|
303
|
+
return { exitCode: 0, stdout: `[N/A] no behaviour store (${STORE_DIR}/) in this repository\n` };
|
|
304
|
+
}
|
|
305
|
+
let version = "";
|
|
306
|
+
try {
|
|
307
|
+
version = (await execFileAsync("openspec", ["--version"], { env: { ...process.env, ...OPENSPEC_ENV } })).stdout.trim();
|
|
308
|
+
}
|
|
309
|
+
catch {
|
|
310
|
+
return {
|
|
311
|
+
exitCode: 1,
|
|
312
|
+
stdout: `[FAIL] the OpenSpec CLI is not on PATH; this repository has a behaviour store, so its validation cannot run (install @fission-ai/openspec@${OPENSPEC_VERSION}; the Method Validation module does)\n`,
|
|
313
|
+
};
|
|
314
|
+
}
|
|
315
|
+
if (version !== OPENSPEC_VERSION) {
|
|
316
|
+
return { exitCode: 1, stdout: `[FAIL] OpenSpec ${version} is installed; the method depends on exactly ${OPENSPEC_VERSION}\n` };
|
|
317
|
+
}
|
|
318
|
+
const lines = [];
|
|
319
|
+
const failures = [];
|
|
320
|
+
let measured = 0;
|
|
321
|
+
for (const [label, args] of [
|
|
322
|
+
["specs and open changes (--all --strict)", ["validate", "--all", "--strict", "--json", "--no-interactive"]],
|
|
323
|
+
["archived changes' tasks (--archived)", ["validate", "--archived", "--json", "--no-interactive"]],
|
|
324
|
+
]) {
|
|
325
|
+
const r = await runOpenspec(repo, [...args]);
|
|
326
|
+
const t = r.json?.summary?.totals;
|
|
327
|
+
if (!t) {
|
|
328
|
+
failures.push(`${label}: OpenSpec returned no report (exit ${r.code}): ${r.raw.trim().split("\n").slice(-3).join(" | ")}`);
|
|
329
|
+
continue;
|
|
330
|
+
}
|
|
331
|
+
measured += t.items ?? 0;
|
|
332
|
+
lines.push(`${label}: ${t.items ?? 0} item(s), ${t.passed ?? 0} passed, ${t.failed ?? 0} failed`);
|
|
333
|
+
for (const item of r.json?.items ?? []) {
|
|
334
|
+
if (item.valid)
|
|
335
|
+
continue;
|
|
336
|
+
for (const i of item.issues ?? [])
|
|
337
|
+
failures.push(`${label}: ${item.id}${i.path ? ` (${i.path})` : ""}: ${i.level} ${i.message}`);
|
|
338
|
+
if ((item.issues ?? []).length === 0)
|
|
339
|
+
failures.push(`${label}: ${item.id}: invalid`);
|
|
340
|
+
}
|
|
341
|
+
if (r.code !== 0 && (t.failed ?? 0) === 0)
|
|
342
|
+
failures.push(`${label}: OpenSpec exited ${r.code} with no failed item reported`);
|
|
343
|
+
}
|
|
344
|
+
const body = [` OpenSpec ${version}`, ...lines.map((l) => ` ${l}`)].join("\n") + "\n";
|
|
345
|
+
if (failures.length > 0)
|
|
346
|
+
return { exitCode: 1, stdout: body + failures.map((f) => `[FAIL] ${f}`).join("\n") + "\n" };
|
|
347
|
+
if (measured === 0)
|
|
348
|
+
return { exitCode: 0, stdout: body + "[N/A] OpenSpec found no specs and no changes to validate\n" };
|
|
349
|
+
return { exitCode: 0, stdout: body + "[PASS] OpenSpec strict validation holds\n" };
|
|
350
|
+
}
|
|
351
|
+
//# sourceMappingURL=behaviour-store.js.map
|
|
@@ -1,5 +1,20 @@
|
|
|
1
|
+
import { checkBehaviourStore, checkBehaviourStoreOpenspec } from "./behaviour-store.js";
|
|
1
2
|
import { checkBundleCoherence } from "./bundle-coherence.js";
|
|
2
3
|
import { checkYamlParse } from "./yaml-parse.js";
|
|
4
|
+
// The behaviour store (M-ADR 0221-0223) can sit in an SDD of any profile, so every profile carries
|
|
5
|
+
// its two checks; without a store both report [N/A], an empty population, not a pass.
|
|
6
|
+
const BEHAVIOUR_STORE_VALIDATORS = [
|
|
7
|
+
{
|
|
8
|
+
name: "behaviour-store",
|
|
9
|
+
source: { kind: "native", run: async (ctx) => checkBehaviourStore(ctx.targetRepo) },
|
|
10
|
+
build: () => ({ status: "run", args: [] }),
|
|
11
|
+
},
|
|
12
|
+
{
|
|
13
|
+
name: "behaviour-store-openspec",
|
|
14
|
+
source: { kind: "native", run: async (ctx) => checkBehaviourStoreOpenspec(ctx.targetRepo) },
|
|
15
|
+
build: () => ({ status: "run", args: [] }),
|
|
16
|
+
},
|
|
17
|
+
];
|
|
3
18
|
// Validators that accept --app-root / --repo-root flags work fine from the
|
|
4
19
|
// bundled location because they override their internal ROOT_DIR via the
|
|
5
20
|
// flag. Validators without that flag (adr-structure, runway-classification,
|
|
@@ -74,6 +89,7 @@ const APP_VALIDATORS = [
|
|
|
74
89
|
},
|
|
75
90
|
build: () => ({ status: "run", args: [] }),
|
|
76
91
|
},
|
|
92
|
+
...BEHAVIOUR_STORE_VALIDATORS,
|
|
77
93
|
// Note: validate-runway-classification is intentionally NOT in the app set.
|
|
78
94
|
// It requires platform-level files (docs/platform/feature-tree.md,
|
|
79
95
|
// architecture-runway-index.md) that app repos don't own. Per ADR 0089,
|
|
@@ -126,6 +142,7 @@ const INTEGRATION_VALIDATORS = [
|
|
|
126
142
|
},
|
|
127
143
|
build: () => ({ status: "run", args: [] }),
|
|
128
144
|
},
|
|
145
|
+
...BEHAVIOUR_STORE_VALIDATORS,
|
|
129
146
|
];
|
|
130
147
|
const PLATFORM_VALIDATORS = [
|
|
131
148
|
{
|
|
@@ -208,6 +225,7 @@ const PLATFORM_VALIDATORS = [
|
|
|
208
225
|
},
|
|
209
226
|
build: () => ({ status: "run", args: [] }),
|
|
210
227
|
},
|
|
228
|
+
...BEHAVIOUR_STORE_VALIDATORS,
|
|
211
229
|
// Optional: the upstream validate-docs.sh dispatcher covers the 6
|
|
212
230
|
// conditional validators (backward-compatibility, deprecation-runway,
|
|
213
231
|
// migration-completeness, ddd-artifacts, glossary-alignment,
|
|
@@ -22,6 +22,8 @@ const TITLES = {
|
|
|
22
22
|
"yaml-parse": "Validate that tracked YAML parses",
|
|
23
23
|
"gate-readiness": "Validate gate readiness",
|
|
24
24
|
"bundle-coherence": "Report bundle coherence",
|
|
25
|
+
"behaviour-store": "Validate the behaviour store: agreement records, the pre-apply gate, stale requirements, verdicts",
|
|
26
|
+
"behaviour-store-openspec": "Validate the behaviour store with OpenSpec (strict)",
|
|
25
27
|
// CI has no platform checkout, so this step runs the app-only checks; the met gate needs the platform beside it.
|
|
26
28
|
"app-dependencies": "Validate app dependencies (app-only checks; no platform checkout in CI)",
|
|
27
29
|
};
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The method's vocabulary renames (M-ADR 0222 §4.1), loaded from the vendored copy of
|
|
3
|
+
* sdd-method's docs/method/foundations/vocabulary-renames.yaml (one-way, sdd-method ->
|
|
4
|
+
* vendored; scripts/sync-vendored-script.sh, drift-tested in tests/parity).
|
|
5
|
+
*
|
|
6
|
+
* For one major release every reader accepts a former value and reads it as the new one;
|
|
7
|
+
* from `removed_in` the former value is an error. Readers ask this module rather than
|
|
8
|
+
* keeping their own copy, so a rename has one definition here as it has one in the bundles.
|
|
9
|
+
*/
|
|
10
|
+
import { readFileSync } from "node:fs";
|
|
11
|
+
import { dirname, join } from "node:path";
|
|
12
|
+
import { fileURLToPath } from "node:url";
|
|
13
|
+
import { parse } from "yaml";
|
|
14
|
+
const __dirname = dirname(fileURLToPath(import.meta.url));
|
|
15
|
+
export const VENDORED_RENAMES_PATH = join(__dirname, "vocabulary-renames.yaml");
|
|
16
|
+
let cached;
|
|
17
|
+
export function vocabularyRenames() {
|
|
18
|
+
if (cached === undefined) {
|
|
19
|
+
const doc = parse(readFileSync(VENDORED_RENAMES_PATH, "utf8"));
|
|
20
|
+
cached = { introduced_in: String(doc.introduced_in), removed_in: String(doc.removed_in), renames: doc.renames };
|
|
21
|
+
}
|
|
22
|
+
return cached;
|
|
23
|
+
}
|
|
24
|
+
/** The rename with this id; throws on an id the file does not hold, so a reader cannot silently lose its alias. */
|
|
25
|
+
export function rename(id) {
|
|
26
|
+
const r = vocabularyRenames().renames.find((x) => x.id === id);
|
|
27
|
+
if (r === undefined)
|
|
28
|
+
throw new Error(`vocabulary-renames.yaml has no rename "${id}"`);
|
|
29
|
+
return r;
|
|
30
|
+
}
|
|
31
|
+
/** The value as a reader should treat it: the new name for the former one, anything else unchanged. */
|
|
32
|
+
export function canonicalValue(id, value) {
|
|
33
|
+
const r = rename(id);
|
|
34
|
+
return value === r.old ? r.new : value;
|
|
35
|
+
}
|
|
36
|
+
/** Whether a value is the former name under this rename (for the reader's finding). */
|
|
37
|
+
export function isFormerValue(id, value) {
|
|
38
|
+
return value === rename(id).old;
|
|
39
|
+
}
|
|
40
|
+
//# sourceMappingURL=renames.js.map
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# Vocabulary renames (M-ADR 0222 §4.1)
|
|
2
|
+
#
|
|
3
|
+
# The tool-read values the method renamed when "lock" left its vocabulary, as data:
|
|
4
|
+
# every reader that accepts a former value, and the migrate verb, follows this file.
|
|
5
|
+
# For one major release a reader accepts the former value, treats it as the new one
|
|
6
|
+
# and reports it; from removed_in the former value is an error.
|
|
7
|
+
#
|
|
8
|
+
# Each reader that aliases a former value marks the place with a comment line
|
|
9
|
+
# vocabulary-alias: <old> -> <new>
|
|
10
|
+
# and the correspondence registry holds the readers and this file to each other in
|
|
11
|
+
# both directions (orchestration/correspondence-registry.yaml, vocabulary-renames).
|
|
12
|
+
#
|
|
13
|
+
# Consumed by:
|
|
14
|
+
# - validate-spec-lifecycle.sh, validate-traceability.sh, validate-app-dependencies.sh,
|
|
15
|
+
# dispatch-release.sh (the bundled readers)
|
|
16
|
+
# - sdd-cli's catalogue build and repo-config reader
|
|
17
|
+
# - `sdd-cli migrate vocabulary` (rewrites an SDD's own files)
|
|
18
|
+
#
|
|
19
|
+
# Distribution: ships in every method baseline via the seed-file lists.
|
|
20
|
+
|
|
21
|
+
schema_version: "1.0.0"
|
|
22
|
+
introduced_in: "2.0.0" # the sdd-cli major that reads both names
|
|
23
|
+
removed_in: "3.0.0" # the sdd-cli major that rejects the former names
|
|
24
|
+
|
|
25
|
+
renames:
|
|
26
|
+
- id: authoring-status-detailed
|
|
27
|
+
old: detailed-pre-lock
|
|
28
|
+
new: detailed
|
|
29
|
+
positions:
|
|
30
|
+
- "spec `**Status:**` header (M-ADR 0201's authoring ladder)"
|
|
31
|
+
- "work-order status"
|
|
32
|
+
- "capability manifest `capability.status` (a spec-authoring stage on the wrong axis; reported, never translated)"
|
|
33
|
+
|
|
34
|
+
- id: stability-stable
|
|
35
|
+
old: locked
|
|
36
|
+
new: stable
|
|
37
|
+
positions:
|
|
38
|
+
- "`required_stability` (app and integration platform dependencies)"
|
|
39
|
+
- "`traceability.contracts.status` (the contract-set maturity ladder)"
|
|
40
|
+
- "repository config `stability` (a stability class)"
|
|
41
|
+
- "runtime-artefact `stability` and `template-stability`"
|
|
42
|
+
note: "Only where `locked` is a stability CLASS. A pinned version is a different thing (M-ADR 0222 §4.1)."
|
|
43
|
+
|
|
44
|
+
- id: agreement-tag
|
|
45
|
+
old: release-vMAJOR.MINOR-locked
|
|
46
|
+
new: release-vMAJOR.MINOR-agreed
|
|
47
|
+
positions:
|
|
48
|
+
- "the agreement tag on a release branch (M-ADRs 0072-0074)"
|
|
49
|
+
|
|
50
|
+
- id: agreement-tag-key
|
|
51
|
+
old: lock_in_tag
|
|
52
|
+
new: agreement_tag
|
|
53
|
+
positions:
|
|
54
|
+
- "a platform BASELINE.md record key (M-ADR 0073)"
|
|
55
|
+
|
|
56
|
+
- id: gate-registry-next-gate
|
|
57
|
+
old: lock-in
|
|
58
|
+
new: agreement
|
|
59
|
+
positions:
|
|
60
|
+
- "gate registry `next_gate` value (domain-architecture rubric)"
|
|
61
|
+
|
|
62
|
+
- id: gate-registry-remediation-key
|
|
63
|
+
old: remediation_before_lock_in
|
|
64
|
+
new: remediation_before_agreement
|
|
65
|
+
positions:
|
|
66
|
+
- "gate registry key (domain-architecture rubric)"
|
|
67
|
+
|
|
68
|
+
- id: journey-status-accepted
|
|
69
|
+
old: accepted-pre-lock
|
|
70
|
+
new: accepted
|
|
71
|
+
positions:
|
|
72
|
+
- "user-journey status (templates only; no reader)"
|
|
73
|
+
|
|
74
|
+
# An extension an adopter names itself (an `x-<adopter>-stability` contract extension,
|
|
75
|
+
# say) is the adopter's to rename; its values follow the method's (M-ADR 0222 §4.1). The migrate verb
|
|
76
|
+
# reports such extensions and never rewrites them.
|
package/dist/verify-version.json
CHANGED