ktx/packages/cli/src/project-dir.test.ts

147 lines
4.9 KiB
TypeScript
Raw Normal View History

2026-05-10 23:12:26 +02:00
import { afterEach, describe, expect, it, vi } from 'vitest';
2026-05-10 23:51:24 +02:00
import { runKtxCli, type KtxCliDeps } from './index.js';
2026-05-10 23:12:26 +02:00
function makeIo() {
let stdout = '';
let stderr = '';
return {
io: {
stdout: {
write: (chunk: string) => {
stdout += chunk;
},
},
stderr: {
write: (chunk: string) => {
stderr += chunk;
},
},
},
stdout: () => stdout,
stderr: () => stderr,
};
}
describe('project directory defaults', () => {
afterEach(() => {
2026-05-10 23:51:24 +02:00
delete process.env.KTX_PROJECT_DIR;
2026-05-10 23:12:26 +02:00
});
2026-05-10 23:51:24 +02:00
it('uses KTX_PROJECT_DIR when Commander-dispatched commands omit --project-dir', async () => {
process.env.KTX_PROJECT_DIR = '/tmp/ktx-env-project';
2026-05-10 23:12:26 +02:00
const connection = vi.fn(async () => 0);
const doctor = vi.fn(async () => 0);
const ingest = vi.fn(async () => 0);
const scan = vi.fn(async () => 0);
const setup = vi.fn(async () => 0);
const deps: KtxCliDeps = { connection, doctor, ingest, scan, setup };
2026-05-10 23:12:26 +02:00
const cases: Array<{
argv: string[];
spy: ReturnType<typeof vi.fn>;
expected: Record<string, unknown>;
2026-05-12 15:04:01 +02:00
expectedStderr: string;
2026-05-10 23:12:26 +02:00
}> = [
{
argv: ['connection', 'list'],
spy: connection,
2026-05-10 23:51:24 +02:00
expected: { command: 'list', projectDir: '/tmp/ktx-env-project' },
2026-05-12 15:04:01 +02:00
expectedStderr: 'Project: /tmp/ktx-env-project\n',
2026-05-10 23:12:26 +02:00
},
{
2026-05-12 23:51:46 +02:00
argv: ['status', '--no-input'],
2026-05-10 23:12:26 +02:00
spy: doctor,
2026-05-10 23:51:24 +02:00
expected: { command: 'project', projectDir: '/tmp/ktx-env-project' },
2026-05-12 15:04:01 +02:00
expectedStderr: 'Project: /tmp/ktx-env-project\n',
2026-05-10 23:12:26 +02:00
},
{
argv: ['ingest', 'status', 'run-1'],
spy: ingest,
expected: { command: 'status', projectDir: '/tmp/ktx-env-project', runId: 'run-1', outputMode: 'plain' },
2026-05-12 15:04:01 +02:00
expectedStderr: 'Project: /tmp/ktx-env-project\n',
2026-05-10 23:12:26 +02:00
},
{
argv: ['setup', '--no-input'],
2026-05-10 23:12:26 +02:00
spy: setup,
expected: { command: 'run', projectDir: '/tmp/ktx-env-project' },
2026-05-12 15:04:01 +02:00
expectedStderr: 'Project: /tmp/ktx-env-project\n',
2026-05-10 23:12:26 +02:00
},
{
argv: ['scan', 'warehouse'],
2026-05-10 23:12:26 +02:00
spy: scan,
2026-05-10 23:51:24 +02:00
expected: { command: 'run', projectDir: '/tmp/ktx-env-project', connectionId: 'warehouse' },
2026-05-12 15:04:01 +02:00
expectedStderr: 'Project: /tmp/ktx-env-project\n',
2026-05-10 23:12:26 +02:00
},
];
for (const item of cases) {
const testIo = makeIo();
2026-05-10 23:51:24 +02:00
await expect(runKtxCli(item.argv, testIo.io, deps)).resolves.toBe(0);
2026-05-12 23:51:46 +02:00
expect(item.spy).toHaveBeenLastCalledWith(expect.objectContaining(item.expected), testIo.io);
2026-05-12 15:04:01 +02:00
expect(testIo.stderr()).toBe(item.expectedStderr);
2026-05-10 23:12:26 +02:00
}
});
2026-05-10 23:51:24 +02:00
it('lets explicit global --project-dir override KTX_PROJECT_DIR before and after nested commands', async () => {
process.env.KTX_PROJECT_DIR = '/tmp/ktx-env-project';
2026-05-10 23:12:26 +02:00
const scan = vi.fn(async () => 0);
const ingest = vi.fn(async () => 0);
2026-05-10 23:12:26 +02:00
const scanIo = makeIo();
const ingestIo = makeIo();
await expect(
runKtxCli(['--project-dir', '/tmp/ktx-explicit-project', 'scan', 'warehouse'], scanIo.io, { scan }),
2026-05-10 23:12:26 +02:00
).resolves.toBe(0);
await expect(
2026-05-10 23:51:24 +02:00
runKtxCli(['ingest', 'status', 'run-1', '--project-dir=/tmp/ktx-explicit-project'], ingestIo.io, {
ingest,
2026-05-10 23:12:26 +02:00
}),
).resolves.toBe(0);
expect(scan).toHaveBeenCalledWith(
2026-05-10 23:51:24 +02:00
expect.objectContaining({ command: 'run', projectDir: '/tmp/ktx-explicit-project' }),
2026-05-10 23:12:26 +02:00
scanIo.io,
);
expect(ingest).toHaveBeenCalledWith(
2026-05-10 23:51:24 +02:00
expect.objectContaining({ command: 'status', projectDir: '/tmp/ktx-explicit-project' }),
2026-05-10 23:12:26 +02:00
ingestIo.io,
);
2026-05-12 15:04:01 +02:00
expect(scanIo.stderr()).toBe('Project: /tmp/ktx-explicit-project\n');
expect(ingestIo.stderr()).toBe('Project: /tmp/ktx-explicit-project\n');
2026-05-10 23:12:26 +02:00
});
2026-05-10 23:51:24 +02:00
it('uses nearest ancestor containing ktx.yaml when no explicit or environment project-dir exists', async () => {
2026-05-10 23:12:26 +02:00
const { mkdir, realpath, writeFile } = await import('node:fs/promises');
const { mkdtemp, rm } = await import('node:fs/promises');
const { tmpdir } = await import('node:os');
const { join } = await import('node:path');
const originalCwd = process.cwd();
2026-05-10 23:51:24 +02:00
const root = await mkdtemp(join(tmpdir(), 'ktx-cli-nearest-project-'));
2026-05-10 23:12:26 +02:00
const projectDir = join(root, 'warehouse');
const nestedDir = join(projectDir, 'nested', 'deeper');
await mkdir(nestedDir, { recursive: true });
2026-05-10 23:51:24 +02:00
await writeFile(join(projectDir, 'ktx.yaml'), 'project: warehouse\n', 'utf-8');
2026-05-10 23:12:26 +02:00
const expectedProjectDir = await realpath(projectDir);
const scan = vi.fn(async () => 0);
const testIo = makeIo();
try {
process.chdir(nestedDir);
await expect(runKtxCli(['scan', 'warehouse'], testIo.io, { scan })).resolves.toBe(0);
2026-05-10 23:12:26 +02:00
} finally {
process.chdir(originalCwd);
await rm(root, { recursive: true, force: true });
}
expect(scan).toHaveBeenCalledWith(
expect.objectContaining({ command: 'run', projectDir: expectedProjectDir }),
testIo.io,
);
2026-05-12 15:04:01 +02:00
expect(testIo.stderr()).toBe(`Project: ${expectedProjectDir}\n`);
2026-05-10 23:12:26 +02:00
});
});