mirror of
https://github.com/Ark0N/Codeman.git
synced 2026-09-30 12:39:42 +02:00
Second review pass on #282, the three items left open after f4dcfbe.
1. `codeman doctor` and the run mode disagreed about pi. The registry entry
accepted a bare `which pi` hit while pi-cli-resolver demanded semver-shaped
`--version` output, so the Dependencies panel could report an installed Pi CLI
on a box where Run Pi stays hidden, which reads as a broken mode rather than a
missing install. Both sides now share one exported PI_VERSION_REGEX, and
PathResolver gains an opt-in `requireVersionMatch` so a binary that fails the
shape check is reported MISSING instead of installed-with-unknown-version.
Only pi sets it; every other tool keeps its current behaviour.
2. The isAltScreenStripMode comment justified excluding pi with "the alt screen
is load-bearing for its fullscreen TUI". That is not what exclusion does: pi
is tmux-backed, so it falls through to isMuxAltScreenOnlyStripMode, which
strips the alt-screen toggles anyway. What exclusion actually preserves is
`\x1b[3J` and the mouse DECSETs, which is the real reason (pi renders into the
main screen and is mouse-aware). Comment and changeset now say that, and state
the consequence: fullscreen pi paints into the main buffer, like vim in a tmux
shell session.
3. skills/codeman still enumerated the five pre-pi modes in nine places, telling
agents a backend does not exist and understating class-wide caveats by one
mode. All updated, plus stale session.ts line references refreshed.
Tests: a new static guard derives the mode set from the Zod schema (not a copy)
and fails when a skill enumeration lists a partial set of external CLIs, verified
by mutation. It also documents the one legitimate exception it found: the "writes
no transcript" lists drop codex, which does write a rollout Codeman reads back.
Plus doctor cases for an unrelated `pi` on PATH and registry/resolver regex parity.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
245 lines
9.1 KiB
TypeScript
245 lines
9.1 KiB
TypeScript
import { describe, it, expect } from 'vitest';
|
|
import { DEPENDENCY_REGISTRY } from '../src/config/dependency-registry.js';
|
|
import {
|
|
detectEnvironment,
|
|
extractVersion,
|
|
compareVersions,
|
|
checkTool,
|
|
checkAll,
|
|
createRealHost,
|
|
} from '../src/utils/dependency-checker.js';
|
|
import type { ProbeHost } from '../src/utils/dependency-checker.js';
|
|
import type { ProbeEnvironment, ToolDependency } from '../src/config/dependency-registry.js';
|
|
import { PI_VERSION_REGEX } from '../src/utils/pi-cli-resolver.js';
|
|
|
|
describe('DEPENDENCY_REGISTRY', () => {
|
|
it('has unique ids', () => {
|
|
const ids = DEPENDENCY_REGISTRY.map((t) => t.id);
|
|
expect(new Set(ids).size).toBe(ids.length);
|
|
});
|
|
|
|
it('hard-requires only node and tmux; agent CLIs and office are optional', () => {
|
|
const required = DEPENDENCY_REGISTRY.filter((t) => t.required)
|
|
.map((t) => t.id)
|
|
.sort();
|
|
expect(required).toEqual(['node', 'tmux']);
|
|
// all agent CLIs are optional (Codeman runs any of them)
|
|
const agentClis = ['claude', 'opencode', 'codex'];
|
|
expect(DEPENDENCY_REGISTRY.filter((t) => agentClis.includes(t.id)).every((t) => t.required === false)).toBe(true);
|
|
const office = DEPENDENCY_REGISTRY.filter((t) => t.category === 'office');
|
|
expect(office.every((t) => t.required === false)).toBe(true);
|
|
});
|
|
|
|
it('resolves pi through the SAME version rule the run mode uses', () => {
|
|
// `pi` is a short generic name, so pi-cli-resolver.ts refuses a binary that does not
|
|
// print semver. If the doctor did not apply the identical rule it would report
|
|
// "Pi CLI ✓" on a box where Run Pi stays hidden, which reads as a broken mode
|
|
// rather than a missing install. One regex, shared, is what keeps them agreeing.
|
|
const pi = DEPENDENCY_REGISTRY.find((t) => t.id === 'pi');
|
|
expect(pi).toBeDefined();
|
|
const spec = pi!.resolvers.find((r) => r.resolver.kind === 'path');
|
|
expect(spec).toBeDefined();
|
|
const resolver = spec!.resolver as { versionRegex?: RegExp; requireVersionMatch?: boolean };
|
|
expect(resolver.requireVersionMatch).toBe(true);
|
|
expect(resolver.versionRegex).toBe(PI_VERSION_REGEX);
|
|
});
|
|
|
|
it('gives msoffice a windows-side resolver scoped to wsl + win32 only', () => {
|
|
const ms = DEPENDENCY_REGISTRY.find((t) => t.id === 'msoffice');
|
|
expect(ms).toBeDefined();
|
|
const spec = ms!.resolvers.find((r) => r.resolver.kind === 'windows-side');
|
|
expect(spec).toBeDefined();
|
|
expect([...spec!.match].sort()).toEqual(['win32', 'wsl']);
|
|
expect(ms!.resolvers.some((r) => r.match.includes('linux'))).toBe(false);
|
|
});
|
|
});
|
|
|
|
describe('detectEnvironment', () => {
|
|
it('returns win32/darwin straight from platform', () => {
|
|
expect(detectEnvironment({ platform: 'win32', procVersion: '', hasWindowsInterop: false })).toBe('win32');
|
|
expect(detectEnvironment({ platform: 'darwin', procVersion: '', hasWindowsInterop: false })).toBe('darwin');
|
|
});
|
|
|
|
it('detects wsl from /proc/version + interop, else linux', () => {
|
|
const wsl = detectEnvironment({
|
|
platform: 'linux',
|
|
procVersion: 'Linux version 6.6 (Microsoft@WSL2)',
|
|
hasWindowsInterop: true,
|
|
});
|
|
expect(wsl).toBe('wsl');
|
|
expect(detectEnvironment({ platform: 'linux', procVersion: 'Microsoft', hasWindowsInterop: false })).toBe('linux');
|
|
expect(detectEnvironment({ platform: 'linux', procVersion: 'generic', hasWindowsInterop: true })).toBe('linux');
|
|
});
|
|
});
|
|
|
|
describe('extractVersion', () => {
|
|
it('pulls a dotted version from typical --version output', () => {
|
|
expect(extractVersion('v22.22.1')).toBe('22.22.1');
|
|
expect(extractVersion('tmux 3.4')).toBe('3.4');
|
|
expect(extractVersion('no digits here')).toBeUndefined();
|
|
});
|
|
it('honors a custom regex', () => {
|
|
expect(extractVersion('ProductVersion 16.0.19929.20172', /(\d+\.\d+\.\d+)/)).toBe('16.0.19929');
|
|
});
|
|
});
|
|
|
|
describe('compareVersions', () => {
|
|
it('orders by numeric components', () => {
|
|
expect(compareVersions('18.0.0', '18.0.0')).toBe(0);
|
|
expect(compareVersions('16.5.0', '18.0.0')).toBe(-1);
|
|
expect(compareVersions('22.22.1', '18.0.0')).toBe(1);
|
|
expect(compareVersions('3.4', '3.4.0')).toBe(0);
|
|
});
|
|
});
|
|
|
|
function fakeHost(env: ProbeEnvironment, over: Partial<ProbeHost> = {}): ProbeHost {
|
|
return {
|
|
environment: env,
|
|
which: () => null,
|
|
fileExists: () => false,
|
|
runVersion: () => null,
|
|
windowsProgramRoots: () => [],
|
|
windowsFileVersion: () => null,
|
|
...over,
|
|
};
|
|
}
|
|
|
|
const tmuxTool: ToolDependency = {
|
|
id: 'tmux',
|
|
label: 'tmux',
|
|
category: 'core',
|
|
required: true,
|
|
resolvers: [{ match: ['linux', 'wsl'], resolver: { kind: 'path', bins: ['tmux'], versionArg: '-V' } }],
|
|
};
|
|
const nodeTool: ToolDependency = {
|
|
id: 'node',
|
|
label: 'Node.js',
|
|
category: 'core',
|
|
required: true,
|
|
minVersion: '18.0.0',
|
|
resolvers: [{ match: ['linux'], resolver: { kind: 'path', bins: ['node'] } }],
|
|
};
|
|
const msTool: ToolDependency = {
|
|
id: 'msoffice',
|
|
label: 'MS Office',
|
|
category: 'office',
|
|
required: false,
|
|
resolvers: [
|
|
{
|
|
match: ['wsl', 'win32'],
|
|
resolver: { kind: 'windows-side', appDirs: ['Microsoft Office/root/Office16'], exes: ['WINWORD.EXE'] },
|
|
},
|
|
],
|
|
};
|
|
|
|
describe('checkTool', () => {
|
|
it('reports ok with path + version when found on PATH', () => {
|
|
const host = fakeHost('linux', {
|
|
which: (b) => (b === 'tmux' ? '/usr/bin/tmux' : null),
|
|
runVersion: () => 'tmux 3.4',
|
|
});
|
|
expect(checkTool(tmuxTool, host)).toMatchObject({
|
|
id: 'tmux',
|
|
status: 'ok',
|
|
version: '3.4',
|
|
path: '/usr/bin/tmux',
|
|
});
|
|
});
|
|
|
|
it('reports missing when no bin resolves', () => {
|
|
expect(checkTool(tmuxTool, fakeHost('linux'))).toMatchObject({ id: 'tmux', status: 'missing' });
|
|
});
|
|
|
|
it('reports outdated when below minVersion', () => {
|
|
const host = fakeHost('linux', { which: () => '/n', runVersion: () => 'v16.5.0' });
|
|
expect(checkTool(nodeTool, host)).toMatchObject({ id: 'node', status: 'outdated', version: '16.5.0' });
|
|
});
|
|
|
|
it('reports error when minVersion set but version unparseable', () => {
|
|
const host = fakeHost('linux', { which: () => '/n', runVersion: () => 'unknown' });
|
|
expect(checkTool(nodeTool, host)).toMatchObject({ id: 'node', status: 'error' });
|
|
});
|
|
|
|
it('reports skipped when no resolver matches the environment', () => {
|
|
expect(checkTool(msTool, fakeHost('linux'))).toMatchObject({ id: 'msoffice', status: 'skipped' });
|
|
});
|
|
|
|
it('finds windows-side apps under WSL', () => {
|
|
const host = fakeHost('wsl', {
|
|
windowsProgramRoots: () => ['/mnt/c/Program Files'],
|
|
fileExists: (p) => p === '/mnt/c/Program Files/Microsoft Office/root/Office16/WINWORD.EXE',
|
|
windowsFileVersion: () => '16.0.19929.20172',
|
|
});
|
|
expect(checkTool(msTool, host)).toMatchObject({
|
|
id: 'msoffice',
|
|
status: 'ok',
|
|
version: '16.0.19929',
|
|
path: '/mnt/c/Program Files/Microsoft Office/root/Office16/WINWORD.EXE',
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('checkTool with requireVersionMatch (generic binary names)', () => {
|
|
const piTool: ToolDependency = {
|
|
id: 'pi',
|
|
label: 'Pi CLI',
|
|
category: 'core',
|
|
required: false,
|
|
resolvers: [
|
|
{
|
|
match: ['linux'],
|
|
resolver: {
|
|
kind: 'path',
|
|
bins: ['pi'],
|
|
versionArg: '--version',
|
|
versionRegex: PI_VERSION_REGEX,
|
|
requireVersionMatch: true,
|
|
},
|
|
},
|
|
],
|
|
};
|
|
|
|
it('accepts a binary that prints a semver version', () => {
|
|
const host = fakeHost('linux', { which: () => '/home/u/.npm-global/bin/pi', runVersion: () => '0.84.1\n' });
|
|
expect(checkTool(piTool, host)).toMatchObject({
|
|
id: 'pi',
|
|
status: 'ok',
|
|
version: '0.84.1',
|
|
path: '/home/u/.npm-global/bin/pi',
|
|
});
|
|
});
|
|
|
|
it('reports MISSING for an unrelated `pi` on PATH instead of an installed tool', () => {
|
|
// The whole point: a Raspberry Pi helper answers `--version` with prose, and calling
|
|
// that "installed" contradicts resolvePiDir(), which rejects it.
|
|
const host = fakeHost('linux', { which: () => '/usr/bin/pi', runVersion: () => 'Raspberry Pi utility\n' });
|
|
expect(checkTool(piTool, host)).toMatchObject({ id: 'pi', status: 'missing' });
|
|
});
|
|
|
|
it('reports MISSING when the binary answers nothing at all', () => {
|
|
const host = fakeHost('linux', { which: () => '/usr/bin/pi', runVersion: () => null });
|
|
expect(checkTool(piTool, host)).toMatchObject({ id: 'pi', status: 'missing' });
|
|
});
|
|
|
|
it('leaves tools without the flag reporting ok on an unparsable version (unchanged)', () => {
|
|
const host = fakeHost('linux', { which: () => '/usr/bin/tmux', runVersion: () => 'no version here' });
|
|
expect(checkTool(tmuxTool, host)).toMatchObject({ id: 'tmux', status: 'ok', version: undefined });
|
|
});
|
|
});
|
|
|
|
describe('checkAll', () => {
|
|
it('maps every tool to a result', () => {
|
|
const results = checkAll([tmuxTool, msTool], fakeHost('linux'));
|
|
expect(results.map((r) => r.id)).toEqual(['tmux', 'msoffice']);
|
|
});
|
|
});
|
|
|
|
describe('createRealHost', () => {
|
|
it('returns a host with a valid detected environment and callable methods', () => {
|
|
const host = createRealHost();
|
|
expect(['linux', 'darwin', 'win32', 'wsl']).toContain(host.environment);
|
|
expect(typeof host.which).toBe('function');
|
|
expect(Array.isArray(host.windowsProgramRoots())).toBe(true);
|
|
});
|
|
});
|