Files
gstack/test/docsync-lifecycle-interface.test.ts
T
garrytan b1083a52a6 test: docsync observer accepts harmless read wrappers (W7d docsync observer)
docsCommandAllowed now unwraps, on read-only commands only (pwd, ls, cat,
stat, sha256sum, Git reads): a leading 'cd <fixture repo> &&', '2>/dev/null',
a trailing '|| true', '--no-pager', '-C <fixture repo>' and '-c' with
core.pager=cat / core.quotepath / color.* settings. Lifecycle and script calls
stay literal so their failures cannot be suppressed. Writes, other repos,
--git-dir/--work-tree, config that can execute code, real composition and
redirects stay rejected.

Stored commands (fixtures/docsync-observer-commands.json): 11 known-good read
forms, which the old observer rejected, now pass; all 17 known-bad forms still
fail under the new and old observers. docsync-command-grammar moves its three
harmless rows to an accept test and keeps unsafe variants of them as rejects.
2026-10-03 00:44:12 +00:00

139 lines
8.4 KiB
TypeScript

import { afterAll, beforeAll, describe, expect, test } from 'bun:test';
import * as fs from 'node:fs';
import * as path from 'node:path';
import { fixtureDocs } from './helpers/docsync-fixture';
import { docsCommandAllowed, docsNativeInterface, docsPreambleCommands, docsToolFailures } from './helpers/docsync-observer';
import type { SkillTestResult } from './helpers/session-runner';
let fixture: ReturnType<typeof fixtureDocs>;
beforeAll(() => { fixture = fixtureDocs('updated'); });
afterAll(() => fixture?.clean());
function lifecycleCommands() {
return [...docsNativeInterface(fixture).matchAll(/```bash\n([^`]+)\n```/g)].map(match => match[1]);
}
test('fixture lifecycle guidance exposes owned skill paths and literal commands', () => {
const guidance = docsNativeInterface(fixture);
const skills = fixture.skills.split(path.sep).join('/');
expect(guidance).toContain(`${skills}/document-release/SKILL.md`);
expect(guidance).toContain('instead of copying the generated shell wrappers');
expect(guidance).toContain("satisfy the skill's start/end lifecycle requirements here");
expect(guidance).toContain('applies to parent and every child; include this interface in child prompts');
const [start, end] = lifecycleCommands();
expect(lifecycleCommands()).toHaveLength(2);
expect(start).toBe(`GSTACK_SESSION_KIND=spawned ${skills}/bin/gstack-skill-start --skill document-release --model claude`);
expect(end).toBe(`${skills}/bin/gstack-skill-end --skill document-release --outcome OUTCOME --session-id SESSION_ID_VALUE --tel-start TEL_START_VALUE --used-browse no`);
expect(docsCommandAllowed(start, fixture)).toBe(true);
for (const command of [start, end]) expect(command).not.toMatch(/[\n\r~$\\|<>;]/);
expect(docsCommandAllowed(start.replaceAll('/', '\\'), fixture)).toBe(false);
const source = fs.readFileSync(path.join(import.meta.dir, '../bin/gstack-skill-start'), 'utf8');
expect(source).toContain('PARENT_PID="$PPID"');
expect(start).not.toContain('--parent-pid');
});
test.each(['success', 'error', 'abort', 'unknown'])('same-session literal end accepts outcome %s without wrappers', outcome => {
const guidance = docsNativeInterface(fixture);
expect(guidance).toContain('actual literal values echoed by that same start call');
expect(guidance).toContain('Never execute the placeholders or reuse values from another session');
expect(guidance).toContain('If start fails or SESSION_KIND is not spawned, report the blocker');
expect(guidance).toContain('do not suppress an error or claim completion if it failed');
const end = lifecycleCommands()[1].replace('OUTCOME', outcome).replace('SESSION_ID_VALUE', '123-1790299423-control').replace('TEL_START_VALUE', '1790299423');
expect(docsCommandAllowed(end, fixture)).toBe(true);
const result = { toolCalls: [{ tool: 'Bash', input: { command: end }, output: '' }] } as SkillTestResult;
expect(docsToolFailures(result, fixture)).toEqual([]);
});
test('historical misplaced spawned prefix remains rejected while corrected preamble stays supported', () => {
const [original, spawned] = docsPreambleCommands(fixture);
const misplaced = `GSTACK_SESSION_KIND=spawned ${original}`;
expect(docsCommandAllowed(misplaced, fixture)).toBe(false);
expect(docsCommandAllowed(spawned, fixture)).toBe(true);
expect(docsNativeInterface(fixture)).toContain('prefix belongs directly on the helper invocation, not on a preceding assignment');
});
test.each([
['missing preamble heading', '## Other section\n\n```bash\n"$_SS" --skill "document-release" --model "claude" --parent-pid "$PPID"\n```\n'],
['missing preamble code fence', '## Preamble (run first)\n\nNo executable preamble is present.\n'],
['unrelated fenced code', '## Preamble (run first)\n\n```text\nnot shell\n```\n\n```bash\necho not the preamble\n```\n'],
['malformed Bash block', '## Preamble (run first)\n\n```bash\necho unrelated command\n```\n'],
])('malformed source with %s grants no generated-shell exception', (label, content) => {
const file = path.join(fixture.skills, 'document-release/SKILL.md');
const original = fs.readFileSync(file, 'utf8');
try {
fs.writeFileSync(file, content);
expect(docsPreambleCommands(fixture), label).toEqual([]);
expect(docsCommandAllowed('git status --porcelain', fixture)).toBe(true);
expect(docsCommandAllowed('bun arbitrary.ts', fixture)).toBe(false);
expect(docsCommandAllowed('git status && node attack.js', fixture)).toBe(false);
} finally {
fs.writeFileSync(file, original);
}
});
test('appending shell to the preamble block invalidates the exact generated command', () => {
const file = path.join(fixture.skills, 'document-release/SKILL.md');
const original = fs.readFileSync(file, 'utf8');
const [command] = docsPreambleCommands(fixture);
try {
fs.writeFileSync(file, `## Preamble (run first)\n\n\`\`\`bash\n${command}\necho unauthorized\n\`\`\`\n`);
expect(docsPreambleCommands(fixture)).toEqual([]);
expect(docsCommandAllowed(command, fixture)).toBe(false);
expect(docsCommandAllowed('git status --porcelain', fixture)).toBe(true);
} finally {
fs.writeFileSync(file, original);
}
});
test.each([
'~/.claude/skills/gstack/bin/gstack-skill-end --skill "document-release" --outcome success \\\n --session-id "176-1790299423-4e0464a5" --tel-start "1790299423" --used-browse no \\\n --error-message "" --failed-step "" 2>/dev/null || true',
'~/.claude/skills/gstack/bin/gstack-skill-end --skill "document-release" --outcome success --session-id "933-1790299569-1f0c2bb1" --tel-start "1790299569" --used-browse no --error-message "" --failed-step "" 2>/dev/null || true',
])('historical end wrapper remains rejected: %s', command => {
expect(docsCommandAllowed(command, fixture)).toBe(false);
const result = { toolCalls: [{ tool: 'Bash', input: { command }, output: 'SKILL_END: recorded outcome=success' }] } as SkillTestResult;
expect(docsToolFailures(result, fixture)).toContain('command outside declared docs observation interface');
});
test('lifecycle instructions neither widen command authority nor grant mutation approvals', () => {
const guidance = docsNativeInterface(fixture);
expect(guidance).toContain('The only additional scripts are none');
expect(guidance).toContain('do not grant any additional scripts, write paths or risk approvals');
expect(guidance).toContain('do not rewrite installed skills, config, actor state or scripts');
for (const suffix of [' 2>/dev/null', ' || true', ' && git status', '\ntrue', ' $EXTRA']) {
expect(docsCommandAllowed(lifecycleCommands()[0] + suffix, fixture)).toBe(false);
}
expect(docsCommandAllowed('bun arbitrary.ts', fixture)).toBe(false);
});
test('Git guidance uses the existing working directory without authorizing global options', () => {
const guidance = docsNativeInterface(fixture);
expect(guidance).toContain(`working directory for parent and child Bash calls is already ${fixture.repo}`);
expect(guidance).toContain('literal git subcommand must immediately follow git');
expect(guidance).toContain('does not make git -C an allowed command');
for (const command of ['git status', 'git diff --cached', 'git merge-base main HEAD', 'git rev-parse HEAD']) {
expect(guidance).toContain(command);
expect(docsCommandAllowed(command, fixture)).toBe(true);
}
for (const command of [`git --git-dir ${fixture.repo}/.git status`, `git --work-tree ${fixture.repo} status`]) {
expect(docsCommandAllowed(command, fixture)).toBe(false);
}
});
describe('stored docsync observer commands', () => {
const stored = JSON.parse(fs.readFileSync(path.join(import.meta.dir, 'fixtures/docsync-observer-commands.json'), 'utf8')) as
{ known_good: string[]; known_bad: string[] };
const fill = (command: string) => command.replaceAll('{repo}', fixture.repo).replaceAll('{other}', path.dirname(fixture.repo));
test.each(stored.known_good)('harmless read form is accepted: %s', command => {
expect(docsCommandAllowed(fill(command), fixture)).toBe(true);
});
test.each(stored.known_bad)('known-bad form stays rejected: %s', command => {
expect(docsCommandAllowed(fill(command), fixture)).toBe(false);
});
test('harmless wrappers never extend to lifecycle commands', () => {
for (const command of lifecycleCommands()) {
for (const suffix of [' 2>/dev/null', ' || true']) expect(docsCommandAllowed(command + suffix, fixture)).toBe(false);
expect(docsCommandAllowed(`cd ${fixture.repo} && ${command}`, fixture)).toBe(false);
}
});
});