Files
msd-core/sdk/src/query/config-query.test.ts
Tom Boucher 7032f44633 fix(#2544): exit 1 on missing key in config-get (#2588)
The configGet query handler previously threw GSDError with
ErrorClassification.Validation, which maps to exit code 10. Callers
using `if ! gsd-sdk query config-get key; then fallback; fi` could
not detect missing keys through the exit code alone, because exit 10
is still truthy-failure but the intent (and documented UNIX
convention — cf. `git config --get`) is exit 1 for absent key.

Change the classification for the two 'Key not found' throw sites to
ErrorClassification.Execution so the CLI exits 1 on missing key.
Usage/schema errors (no key argument, malformed JSON, missing
config.json) remain Validation.

Closes #2544
2026-04-22 12:04:03 -04:00

197 lines
7.9 KiB
TypeScript

/**
* Unit tests for config-get and resolve-model query handlers.
*/
import { describe, it, expect, beforeEach, afterEach } from 'vitest';
import { mkdtemp, writeFile, mkdir, rm } from 'node:fs/promises';
import { join } from 'node:path';
import { tmpdir } from 'node:os';
import { GSDError, ErrorClassification, exitCodeFor } from '../errors.js';
// ─── Test setup ─────────────────────────────────────────────────────────────
let tmpDir: string;
beforeEach(async () => {
tmpDir = await mkdtemp(join(tmpdir(), 'gsd-cfg-'));
await mkdir(join(tmpDir, '.planning'), { recursive: true });
});
afterEach(async () => {
await rm(tmpDir, { recursive: true, force: true });
});
// ─── configGet ──────────────────────────────────────────────────────────────
describe('configGet', () => {
it('returns raw config value for top-level key', async () => {
const { configGet } = await import('./config-query.js');
await writeFile(
join(tmpDir, '.planning', 'config.json'),
JSON.stringify({ model_profile: 'quality' }),
);
const result = await configGet(['model_profile'], tmpDir);
expect(result.data).toBe('quality');
});
it('traverses dot-notation for nested keys', async () => {
const { configGet } = await import('./config-query.js');
await writeFile(
join(tmpDir, '.planning', 'config.json'),
JSON.stringify({ workflow: { auto_advance: true } }),
);
const result = await configGet(['workflow.auto_advance'], tmpDir);
expect(result.data).toBe(true);
});
it('throws GSDError when no key provided', async () => {
const { configGet } = await import('./config-query.js');
await expect(configGet([], tmpDir)).rejects.toThrow(GSDError);
});
it('throws GSDError for nonexistent key', async () => {
const { configGet } = await import('./config-query.js');
await writeFile(
join(tmpDir, '.planning', 'config.json'),
JSON.stringify({ model_profile: 'quality' }),
);
await expect(configGet(['nonexistent.key'], tmpDir)).rejects.toThrow(GSDError);
});
it('throws GSDError that maps to exit code 1 for missing key (bug #2544)', async () => {
const { configGet } = await import('./config-query.js');
await writeFile(
join(tmpDir, '.planning', 'config.json'),
JSON.stringify({ model_profile: 'quality' }),
);
try {
await configGet(['nonexistent.key'], tmpDir);
throw new Error('expected configGet to throw for missing key');
} catch (err) {
expect(err).toBeInstanceOf(GSDError);
const gsdErr = err as GSDError;
// UNIX convention: missing config key should exit 1 (like `git config --get`).
// Validation (exit 10) is the previous buggy classification — see issue #2544.
expect(gsdErr.classification).toBe(ErrorClassification.Execution);
expect(exitCodeFor(gsdErr.classification)).toBe(1);
}
});
it('throws GSDError that maps to exit code 1 when traversing into non-object (bug #2544)', async () => {
const { configGet } = await import('./config-query.js');
await writeFile(
join(tmpDir, '.planning', 'config.json'),
JSON.stringify({ model_profile: 'quality' }),
);
try {
await configGet(['model_profile.subkey'], tmpDir);
throw new Error('expected configGet to throw');
} catch (err) {
expect(err).toBeInstanceOf(GSDError);
const gsdErr = err as GSDError;
expect(exitCodeFor(gsdErr.classification)).toBe(1);
}
});
it('reads raw config without merging defaults', async () => {
const { configGet } = await import('./config-query.js');
// Write config with only model_profile -- no workflow section
await writeFile(
join(tmpDir, '.planning', 'config.json'),
JSON.stringify({ model_profile: 'balanced' }),
);
// Accessing workflow should fail (not merged with defaults)
await expect(configGet(['workflow.auto_advance'], tmpDir)).rejects.toThrow(GSDError);
});
});
// ─── resolveModel ───────────────────────────────────────────────────────────
describe('resolveModel', () => {
it('returns model and profile for known agent', async () => {
const { resolveModel } = await import('./config-query.js');
await writeFile(
join(tmpDir, '.planning', 'config.json'),
JSON.stringify({ model_profile: 'balanced' }),
);
const result = await resolveModel(['gsd-planner'], tmpDir);
const data = result.data as Record<string, unknown>;
expect(data).toHaveProperty('model');
expect(data).toHaveProperty('profile', 'balanced');
expect(data).not.toHaveProperty('unknown_agent');
});
it('returns unknown_agent flag for unknown agent', async () => {
const { resolveModel } = await import('./config-query.js');
await writeFile(
join(tmpDir, '.planning', 'config.json'),
JSON.stringify({ model_profile: 'balanced' }),
);
const result = await resolveModel(['unknown-agent'], tmpDir);
const data = result.data as Record<string, unknown>;
expect(data).toHaveProperty('model', 'sonnet');
expect(data).toHaveProperty('unknown_agent', true);
});
it('throws GSDError when no agent type provided', async () => {
const { resolveModel } = await import('./config-query.js');
await expect(resolveModel([], tmpDir)).rejects.toThrow(GSDError);
});
it('respects model_overrides from config', async () => {
const { resolveModel } = await import('./config-query.js');
await writeFile(
join(tmpDir, '.planning', 'config.json'),
JSON.stringify({
model_profile: 'balanced',
model_overrides: { 'gsd-planner': 'openai/gpt-5.4' },
}),
);
const result = await resolveModel(['gsd-planner'], tmpDir);
const data = result.data as Record<string, unknown>;
expect(data).toHaveProperty('model', 'openai/gpt-5.4');
});
it('returns empty model when resolve_model_ids is omit', async () => {
const { resolveModel } = await import('./config-query.js');
await writeFile(
join(tmpDir, '.planning', 'config.json'),
JSON.stringify({
model_profile: 'balanced',
resolve_model_ids: 'omit',
}),
);
const result = await resolveModel(['gsd-planner'], tmpDir);
const data = result.data as Record<string, unknown>;
expect(data).toHaveProperty('model', '');
});
});
// ─── MODEL_PROFILES ─────────────────────────────────────────────────────────
describe('MODEL_PROFILES', () => {
it('contains all 18 agent entries (sync with model-profiles.cjs)', async () => {
const { MODEL_PROFILES } = await import('./config-query.js');
expect(Object.keys(MODEL_PROFILES)).toHaveLength(18);
});
it('has quality/balanced/budget/adaptive for each agent', async () => {
const { MODEL_PROFILES } = await import('./config-query.js');
for (const agent of Object.keys(MODEL_PROFILES)) {
expect(MODEL_PROFILES[agent]).toHaveProperty('quality');
expect(MODEL_PROFILES[agent]).toHaveProperty('balanced');
expect(MODEL_PROFILES[agent]).toHaveProperty('budget');
expect(MODEL_PROFILES[agent]).toHaveProperty('adaptive');
}
});
});
// ─── VALID_PROFILES ─────────────────────────────────────────────────────────
describe('VALID_PROFILES', () => {
it('contains the four profile names', async () => {
const { VALID_PROFILES } = await import('./config-query.js');
expect(VALID_PROFILES).toEqual(['quality', 'balanced', 'budget', 'adaptive']);
});
});