forked from heavy-duty/stoke
test: enforce scope coverage and parity
This commit is contained in:
parent
112f946802
commit
d84062af54
3 changed files with 155 additions and 1 deletions
1
changelog.d/48.md
Normal file
1
changelog.d/48.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
- Cover every governed repository surface and reject unmapped tracked paths or divergent scope names. (#48).
|
||||||
|
|
@ -2,6 +2,13 @@
|
||||||
|
|
||||||
const fs = require('node:fs');
|
const fs = require('node:fs');
|
||||||
const path = require('node:path');
|
const path = require('node:path');
|
||||||
|
const { execFileSync } = require('node:child_process');
|
||||||
|
|
||||||
|
const UNSCOPED_PATHS = [
|
||||||
|
'.gitignore', // Repository plumbing has no product surface.
|
||||||
|
'assets/logo-mark.svg', // One legacy brand asset does not justify a scope taxonomy.
|
||||||
|
'test/*.test.js', // Tests inherit the scope of the production surface changed beside them.
|
||||||
|
];
|
||||||
|
|
||||||
function parseArgs(argv) {
|
function parseArgs(argv) {
|
||||||
const options = {
|
const options = {
|
||||||
|
|
@ -55,6 +62,65 @@ function parseConfig(contents, filename) {
|
||||||
return { identities, scopes };
|
return { identities, scopes };
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function parseLabeler(contents, filename) {
|
||||||
|
const mappings = new Map();
|
||||||
|
let current;
|
||||||
|
for (const line of contents.split(/\r?\n/)) {
|
||||||
|
const label = line.match(/^"([^"]+)":$/);
|
||||||
|
if (label) {
|
||||||
|
current = label[1];
|
||||||
|
if (mappings.has(current)) throw new Error(`duplicate scope mapping in ${filename}: ${current}`);
|
||||||
|
mappings.set(current, []);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
const matcher = line.match(/^\s+- any-glob-to-any-file:\s*(\[[^\n]+\])$/);
|
||||||
|
if (!matcher) continue;
|
||||||
|
if (!current) throw new Error(`scope matcher has no label in ${filename}`);
|
||||||
|
let globs;
|
||||||
|
try {
|
||||||
|
globs = JSON.parse(matcher[1]);
|
||||||
|
} catch {
|
||||||
|
throw new Error(`malformed scope matcher for ${current} in ${filename}`);
|
||||||
|
}
|
||||||
|
if (!Array.isArray(globs) || globs.length === 0 || globs.some((glob) => typeof glob !== 'string')) {
|
||||||
|
throw new Error(`malformed scope matcher for ${current} in ${filename}`);
|
||||||
|
}
|
||||||
|
mappings.get(current).push(...globs);
|
||||||
|
}
|
||||||
|
for (const [label, globs] of mappings) {
|
||||||
|
if (globs.length === 0) throw new Error(`scope mapping has no globs in ${filename}: ${label}`);
|
||||||
|
}
|
||||||
|
return mappings;
|
||||||
|
}
|
||||||
|
|
||||||
|
function validateScopeNames(scopes, mappings) {
|
||||||
|
const configNames = new Set(scopes.map((scope) => scope.split('|', 1)[0]));
|
||||||
|
const labelerNames = new Set(mappings.keys());
|
||||||
|
const onlyInConfig = [...configNames].filter((name) => !labelerNames.has(name)).sort();
|
||||||
|
const onlyInLabeler = [...labelerNames].filter((name) => !configNames.has(name)).sort();
|
||||||
|
const errors = [];
|
||||||
|
if (onlyInConfig.length > 0) errors.push(`scope names only in labels.conf: ${onlyInConfig.join(', ')}`);
|
||||||
|
if (onlyInLabeler.length > 0) errors.push(`scope names only in labeler.yml: ${onlyInLabeler.join(', ')}`);
|
||||||
|
if (errors.length > 0) throw new Error(errors.join('; '));
|
||||||
|
}
|
||||||
|
|
||||||
|
function validateTrackedPaths(mappings) {
|
||||||
|
let tracked;
|
||||||
|
try {
|
||||||
|
tracked = execFileSync('git', ['ls-files'], { encoding: 'utf8' }).trim().split('\n').filter(Boolean);
|
||||||
|
} catch (error) {
|
||||||
|
throw new Error(`cannot enumerate tracked paths: ${error.message}`);
|
||||||
|
}
|
||||||
|
const globs = [...mappings.values()].flat();
|
||||||
|
const uncovered = tracked.filter((filename) => (
|
||||||
|
!UNSCOPED_PATHS.some((glob) => path.matchesGlob(filename, glob))
|
||||||
|
&& !globs.some((glob) => path.matchesGlob(filename, glob))
|
||||||
|
));
|
||||||
|
if (uncovered.length > 0) {
|
||||||
|
throw new Error(`tracked paths have no scope mapping: ${uncovered.join(', ')}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
async function validateIdentities(apiUrl, identities) {
|
async function validateIdentities(apiUrl, identities) {
|
||||||
for (const login of identities) {
|
for (const login of identities) {
|
||||||
const endpoint = `${apiUrl.replace(/\/$/, '')}/users/${encodeURIComponent(login)}`;
|
const endpoint = `${apiUrl.replace(/\/$/, '')}/users/${encodeURIComponent(login)}`;
|
||||||
|
|
@ -72,6 +138,10 @@ async function main() {
|
||||||
const options = parseArgs(process.argv.slice(2));
|
const options = parseArgs(process.argv.slice(2));
|
||||||
const contents = fs.readFileSync(options.config, 'utf8');
|
const contents = fs.readFileSync(options.config, 'utf8');
|
||||||
const { identities, scopes } = parseConfig(contents, options.config);
|
const { identities, scopes } = parseConfig(contents, options.config);
|
||||||
|
const labeler = path.join(path.dirname(options.config), 'labeler.yml');
|
||||||
|
const mappings = parseLabeler(fs.readFileSync(labeler, 'utf8'), labeler);
|
||||||
|
validateScopeNames(scopes, mappings);
|
||||||
|
validateTrackedPaths(mappings);
|
||||||
await validateIdentities(options.apiUrl, identities);
|
await validateIdentities(options.apiUrl, identities);
|
||||||
console.log(`governance: ${identities.length} identities resolved; ${scopes.length} scope rows valid`);
|
console.log(`governance: ${identities.length} identities resolved; ${scopes.length} scope rows valid`);
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -27,12 +27,30 @@ function writeConfig(contents) {
|
||||||
cleanups.push(dir);
|
cleanups.push(dir);
|
||||||
const config = path.join(dir, 'labels.conf');
|
const config = path.join(dir, 'labels.conf');
|
||||||
fs.writeFileSync(config, contents);
|
fs.writeFileSync(config, contents);
|
||||||
|
fs.copyFileSync(REPOSITORY_LABELER, path.join(dir, 'labeler.yml'));
|
||||||
return config;
|
return config;
|
||||||
}
|
}
|
||||||
|
|
||||||
function runValidator(config, apiUrl) {
|
function writeRepository(configContents, labelerContents, files = {}) {
|
||||||
|
const dir = fs.mkdtempSync(path.join(os.tmpdir(), 'stoke-governance-repository-'));
|
||||||
|
cleanups.push(dir);
|
||||||
|
fs.mkdirSync(path.join(dir, '.github'), { recursive: true });
|
||||||
|
fs.writeFileSync(path.join(dir, '.github', 'labels.conf'), configContents);
|
||||||
|
fs.writeFileSync(path.join(dir, '.github', 'labeler.yml'), labelerContents);
|
||||||
|
for (const [filename, contents] of Object.entries(files)) {
|
||||||
|
const target = path.join(dir, filename);
|
||||||
|
fs.mkdirSync(path.dirname(target), { recursive: true });
|
||||||
|
fs.writeFileSync(target, contents);
|
||||||
|
}
|
||||||
|
execFileSync('git', ['init', '-q'], { cwd: dir });
|
||||||
|
execFileSync('git', ['add', '.'], { cwd: dir });
|
||||||
|
return { dir, config: path.join(dir, '.github', 'labels.conf') };
|
||||||
|
}
|
||||||
|
|
||||||
|
function runValidator(config, apiUrl, cwd = path.join(__dirname, '..')) {
|
||||||
return new Promise((resolve) => {
|
return new Promise((resolve) => {
|
||||||
const child = spawn(process.execPath, [SCRIPT, '--config', config, '--api-url', apiUrl], {
|
const child = spawn(process.execPath, [SCRIPT, '--config', config, '--api-url', apiUrl], {
|
||||||
|
cwd,
|
||||||
encoding: 'utf8',
|
encoding: 'utf8',
|
||||||
});
|
});
|
||||||
let stdout = '';
|
let stdout = '';
|
||||||
|
|
@ -112,6 +130,71 @@ test('governance validator rejects malformed scope rows before identity requests
|
||||||
assert.doesNotMatch(result.stderr, /fetch failed/);
|
assert.doesNotMatch(result.stderr, /fetch failed/);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test('governance validator rejects a tracked path outside every scope and the residue allowlist', async () => {
|
||||||
|
const config = [
|
||||||
|
'panel=codex-bot-andresmgsl',
|
||||||
|
'scope:cli|C5DEF5|src/ — command surface',
|
||||||
|
'scope:ci|C5DEF5|.github/ — governance surface',
|
||||||
|
].join('\n');
|
||||||
|
const labeler = [
|
||||||
|
'"scope:cli":',
|
||||||
|
' - changed-files:',
|
||||||
|
' - any-glob-to-any-file: ["src/**"]',
|
||||||
|
'"scope:ci":',
|
||||||
|
' - changed-files:',
|
||||||
|
' - any-glob-to-any-file: [".github/**"]',
|
||||||
|
].join('\n');
|
||||||
|
const repository = writeRepository(`${config}\n`, `${labeler}\n`, {
|
||||||
|
'src/covered.js': '',
|
||||||
|
'new-surface/uncovered.txt': '',
|
||||||
|
});
|
||||||
|
await withIdentityServer(new Set(['codex-bot-andresmgsl']), async (apiUrl) => {
|
||||||
|
const result = await runValidator(repository.config, apiUrl, repository.dir);
|
||||||
|
assert.notEqual(result.status, 0);
|
||||||
|
assert.match(result.stderr, /tracked paths have no scope mapping: new-surface\/uncovered\.txt/);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test('governance validator rejects scope names declared only in the labeler map', async () => {
|
||||||
|
const config = [
|
||||||
|
'panel=codex-bot-andresmgsl',
|
||||||
|
'scope:cli|C5DEF5|src/ — command surface',
|
||||||
|
].join('\n');
|
||||||
|
const labeler = [
|
||||||
|
'"scope:cli":',
|
||||||
|
' - changed-files:',
|
||||||
|
' - any-glob-to-any-file: ["src/**"]',
|
||||||
|
'"scope:extra":',
|
||||||
|
' - changed-files:',
|
||||||
|
' - any-glob-to-any-file: ["extra/**"]',
|
||||||
|
].join('\n');
|
||||||
|
const repository = writeRepository(`${config}\n`, `${labeler}\n`, { 'src/covered.js': '' });
|
||||||
|
await withIdentityServer(new Set(['codex-bot-andresmgsl']), async (apiUrl) => {
|
||||||
|
const result = await runValidator(repository.config, apiUrl, repository.dir);
|
||||||
|
assert.notEqual(result.status, 0);
|
||||||
|
assert.match(result.stderr, /scope names only in labeler\.yml: scope:extra/);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test('governance validator rejects scope names declared only in labels.conf', async () => {
|
||||||
|
const config = [
|
||||||
|
'panel=codex-bot-andresmgsl',
|
||||||
|
'scope:cli|C5DEF5|src/ — command surface',
|
||||||
|
'scope:renamed|C5DEF5|renamed/ — renamed surface',
|
||||||
|
].join('\n');
|
||||||
|
const labeler = [
|
||||||
|
'"scope:cli":',
|
||||||
|
' - changed-files:',
|
||||||
|
' - any-glob-to-any-file: ["src/**"]',
|
||||||
|
].join('\n');
|
||||||
|
const repository = writeRepository(`${config}\n`, `${labeler}\n`, { 'src/covered.js': '' });
|
||||||
|
await withIdentityServer(new Set(['codex-bot-andresmgsl']), async (apiUrl) => {
|
||||||
|
const result = await runValidator(repository.config, apiUrl, repository.dir);
|
||||||
|
assert.notEqual(result.status, 0);
|
||||||
|
assert.match(result.stderr, /scope names only in labels\.conf: scope:renamed/);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
test('repository governance config resolves the current four-member panel and five scopes', async () => {
|
test('repository governance config resolves the current four-member panel and five scopes', async () => {
|
||||||
const logins = new Set(['codex-bot-andresmgsl', 'glm-bot-andresmgsl', 'claude-bot-andresmgsl', 'kimi-bot-andresmgsl']);
|
const logins = new Set(['codex-bot-andresmgsl', 'glm-bot-andresmgsl', 'claude-bot-andresmgsl', 'kimi-bot-andresmgsl']);
|
||||||
await withIdentityServer(logins, async (apiUrl) => {
|
await withIdentityServer(logins, async (apiUrl) => {
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue