mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-07 07:55:13 +02:00
314 lines
12 KiB
TypeScript
314 lines
12 KiB
TypeScript
import { mkdir, mkdtemp, readFile, rm, stat, writeFile } from 'node:fs/promises';
|
|
import { tmpdir } from 'node:os';
|
|
import { join } from 'node:path';
|
|
import { readKtxSetupState } from './context/project/setup-config.js';
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
|
import { gray } from './io/symbols.js';
|
|
import { type KtxSetupProjectPromptAdapter, runKtxSetupProjectStep } from './setup-project.js';
|
|
|
|
function makeIo(options: { stdoutIsTty?: boolean } = {}) {
|
|
let stdout = '';
|
|
let stderr = '';
|
|
return {
|
|
io: {
|
|
stdout: {
|
|
isTTY: options.stdoutIsTty,
|
|
write: (chunk: string) => {
|
|
stdout += chunk;
|
|
},
|
|
},
|
|
stderr: {
|
|
write: (chunk: string) => {
|
|
stderr += chunk;
|
|
},
|
|
},
|
|
},
|
|
stdout: () => stdout,
|
|
stderr: () => stderr,
|
|
};
|
|
}
|
|
|
|
function makePromptAdapter(options: { choice?: string; choices?: string[]; textValue?: string; textValues?: string[] }) {
|
|
const choices = [...(options.choices ?? (options.choice ? [options.choice] : []))];
|
|
const textValues = [...(options.textValues ?? (options.textValue !== undefined ? [options.textValue] : []))];
|
|
return {
|
|
select: vi.fn(async () => choices.shift() ?? 'exit'),
|
|
text: vi.fn(async () => textValues.shift() ?? ''),
|
|
cancel: vi.fn(),
|
|
} satisfies KtxSetupProjectPromptAdapter;
|
|
}
|
|
|
|
function defaultSubfolderLabel(parentDir: string): string {
|
|
const childName = 'ktx-project';
|
|
const childDir = join(parentDir, childName);
|
|
return `New subfolder (${gray(childDir.slice(0, -childName.length))}${childName})`;
|
|
}
|
|
|
|
describe('setup project step', () => {
|
|
let tempDir: string;
|
|
|
|
beforeEach(async () => {
|
|
tempDir = await mkdtemp(join(tmpdir(), 'ktx-setup-project-'));
|
|
});
|
|
|
|
afterEach(async () => {
|
|
await rm(tempDir, { recursive: true, force: true });
|
|
});
|
|
|
|
it('creates a new project in non-interactive auto mode with --yes and marks the project step complete', async () => {
|
|
const projectDir = join(tempDir, 'warehouse');
|
|
const testIo = makeIo();
|
|
|
|
const result = await runKtxSetupProjectStep(
|
|
{ projectDir, mode: 'auto', inputMode: 'disabled', yes: true },
|
|
testIo.io,
|
|
);
|
|
|
|
expect(result.status).toBe('ready');
|
|
expect(result.projectDir).toBe(projectDir);
|
|
expect(await readFile(join(projectDir, 'ktx.yaml'), 'utf-8')).not.toContain('completed_steps:');
|
|
expect(await readKtxSetupState(projectDir)).toEqual({ completed_steps: ['project'] });
|
|
await expect(stat(join(projectDir, '.git'))).resolves.toBeDefined();
|
|
await expect(readFile(join(projectDir, '.ktx/.gitignore'), 'utf-8')).resolves.toContain('secrets/');
|
|
expect(testIo.stdout()).toContain(`Project: ${projectDir}`);
|
|
expect(testIo.stderr()).toBe('');
|
|
});
|
|
|
|
it('creates a missing auto-mode project only when --yes is present in no-input mode', async () => {
|
|
const projectDir = join(tempDir, 'warehouse');
|
|
const rejectedIo = makeIo();
|
|
const acceptedIo = makeIo();
|
|
|
|
await expect(
|
|
runKtxSetupProjectStep({ projectDir, mode: 'auto', inputMode: 'disabled', yes: false }, rejectedIo.io),
|
|
).resolves.toMatchObject({ status: 'missing-input' });
|
|
expect(rejectedIo.stderr()).toContain('Missing setup choice: pass --yes');
|
|
await expect(stat(join(projectDir, 'ktx.yaml'))).rejects.toThrow();
|
|
|
|
await expect(
|
|
runKtxSetupProjectStep({ projectDir, mode: 'auto', inputMode: 'disabled', yes: true }, acceptedIo.io),
|
|
).resolves.toMatchObject({ status: 'ready', projectDir });
|
|
await expect(stat(join(projectDir, 'ktx.yaml'))).resolves.toBeDefined();
|
|
});
|
|
|
|
it('fails clearly in no-input auto mode when ktx.yaml is missing and --yes is absent', async () => {
|
|
const projectDir = join(tempDir, 'warehouse');
|
|
const testIo = makeIo();
|
|
|
|
await expect(
|
|
runKtxSetupProjectStep({ projectDir, mode: 'auto', inputMode: 'disabled', yes: false }, testIo.io),
|
|
).resolves.toMatchObject({ status: 'missing-input' });
|
|
|
|
expect(testIo.stderr()).toContain('Missing setup choice: pass --yes');
|
|
});
|
|
|
|
it('prompts to use the current directory and creates a project in interactive auto mode', async () => {
|
|
const projectDir = join(tempDir, 'warehouse');
|
|
const prompts = makePromptAdapter({ choice: 'current' });
|
|
const testIo = makeIo({ stdoutIsTty: true });
|
|
|
|
const result = await runKtxSetupProjectStep(
|
|
{ projectDir, mode: 'auto', inputMode: 'auto', yes: false },
|
|
testIo.io,
|
|
{ prompts },
|
|
);
|
|
|
|
expect(result.status).toBe('ready');
|
|
expect(result.projectDir).toBe(projectDir);
|
|
expect(prompts.select).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
message: 'Where should KTX create the project?',
|
|
options: [
|
|
expect.objectContaining({ value: 'current', label: `Current directory (${projectDir})` }),
|
|
expect.objectContaining({
|
|
value: 'new-default',
|
|
label: defaultSubfolderLabel(projectDir),
|
|
}),
|
|
expect.objectContaining({ value: 'new-custom', label: 'Custom path' }),
|
|
expect.objectContaining({ value: 'exit', label: 'Exit' }),
|
|
],
|
|
}),
|
|
);
|
|
expect(prompts.text).not.toHaveBeenCalled();
|
|
expect(await readFile(join(projectDir, 'ktx.yaml'), 'utf-8')).not.toContain('completed_steps:');
|
|
expect(await readKtxSetupState(projectDir)).toEqual({ completed_steps: ['project'] });
|
|
});
|
|
|
|
it('offers an absolute default destination for a new project folder', async () => {
|
|
const startDir = join(tempDir, 'start');
|
|
const projectDir = join(startDir, 'ktx-project');
|
|
const prompts = makePromptAdapter({ choices: ['new-default', 'create'] });
|
|
const testIo = makeIo({ stdoutIsTty: true });
|
|
|
|
const result = await runKtxSetupProjectStep(
|
|
{ projectDir: startDir, mode: 'auto', inputMode: 'auto', yes: false },
|
|
testIo.io,
|
|
{ prompts },
|
|
);
|
|
|
|
expect(result.status).toBe('ready');
|
|
expect(result.projectDir).toBe(projectDir);
|
|
expect(prompts.select).toHaveBeenNthCalledWith(
|
|
1,
|
|
expect.objectContaining({
|
|
message: 'Where should KTX create the project?',
|
|
options: expect.arrayContaining([
|
|
expect.objectContaining({
|
|
value: 'new-default',
|
|
label: defaultSubfolderLabel(startDir),
|
|
}),
|
|
]),
|
|
}),
|
|
);
|
|
expect(prompts.select).toHaveBeenNthCalledWith(
|
|
2,
|
|
expect.objectContaining({ message: `Create KTX project at ${projectDir}?` }),
|
|
);
|
|
expect(prompts.text).not.toHaveBeenCalled();
|
|
expect(result.status === 'ready' ? result.project.configPath : '').toBe(join(projectDir, 'ktx.yaml'));
|
|
expect(testIo.stdout()).toContain(`│ KTX will create:\n│ ${projectDir}`);
|
|
await expect(stat(join(projectDir, 'ktx.yaml'))).resolves.toBeDefined();
|
|
});
|
|
|
|
it('prompts for a custom path and resolves it inside the current setup directory', async () => {
|
|
const startDir = join(tempDir, 'start');
|
|
const projectDir = join(startDir, 'analytics-ktx');
|
|
const prompts = makePromptAdapter({ choices: ['new-custom', 'create'], textValue: 'analytics-ktx' });
|
|
|
|
const result = await runKtxSetupProjectStep(
|
|
{ projectDir: startDir, mode: 'auto', inputMode: 'auto', yes: false },
|
|
makeIo({ stdoutIsTty: true }).io,
|
|
{ prompts },
|
|
);
|
|
|
|
expect(result.status).toBe('ready');
|
|
expect(result.projectDir).toBe(projectDir);
|
|
expect(prompts.text).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
message: 'Project folder path\n│ Press Escape to go back.\n│',
|
|
placeholder: './analytics-ktx, ~/analytics-ktx, or /Users/you/projects/analytics-ktx',
|
|
}),
|
|
);
|
|
await expect(stat(join(projectDir, 'ktx.yaml'))).resolves.toBeDefined();
|
|
});
|
|
|
|
it('expands a custom home-directory path before creating a new project', async () => {
|
|
const startDir = join(tempDir, 'start');
|
|
const homeDir = join(tempDir, 'home');
|
|
const projectDir = join(homeDir, 'analytics-ktx');
|
|
const prompts = makePromptAdapter({ choices: ['new-custom', 'create'], textValue: '~/analytics-ktx' });
|
|
|
|
const result = await runKtxSetupProjectStep(
|
|
{ projectDir: startDir, mode: 'auto', inputMode: 'auto', yes: false },
|
|
makeIo({ stdoutIsTty: true }).io,
|
|
{ prompts, homeDir },
|
|
);
|
|
|
|
expect(result.status).toBe('ready');
|
|
expect(result.projectDir).toBe(projectDir);
|
|
await expect(stat(join(projectDir, 'ktx.yaml'))).resolves.toBeDefined();
|
|
});
|
|
|
|
it('confirms a custom new project path and lets Back return to the project choice', async () => {
|
|
const startDir = join(tempDir, 'start');
|
|
const homeDir = join(tempDir, 'home');
|
|
const customProjectDir = join(homeDir, 'analytics-ktx');
|
|
const prompts = makePromptAdapter({
|
|
choices: ['new-custom', 'back', 'exit'],
|
|
textValue: '~/analytics-ktx',
|
|
});
|
|
|
|
const result = await runKtxSetupProjectStep(
|
|
{ projectDir: startDir, mode: 'auto', inputMode: 'auto', yes: false },
|
|
makeIo({ stdoutIsTty: true }).io,
|
|
{ prompts, homeDir },
|
|
);
|
|
|
|
expect(result.status).toBe('cancelled');
|
|
expect(result.projectDir).toBe(startDir);
|
|
expect(prompts.select).toHaveBeenNthCalledWith(
|
|
2,
|
|
expect.objectContaining({
|
|
message: `Create KTX project at ${customProjectDir}?`,
|
|
options: [
|
|
expect.objectContaining({ value: 'create', label: 'Create project' }),
|
|
expect.objectContaining({ value: 'choose-another', label: 'Choose another folder' }),
|
|
expect.objectContaining({ value: 'back', label: 'Back' }),
|
|
],
|
|
}),
|
|
);
|
|
expect(prompts.select).toHaveBeenNthCalledWith(
|
|
3,
|
|
expect.objectContaining({ message: 'Where should KTX create the project?' }),
|
|
);
|
|
await expect(stat(join(customProjectDir, 'ktx.yaml'))).rejects.toThrow();
|
|
});
|
|
|
|
it('rejects an empty new folder path without creating a project in the process cwd', async () => {
|
|
const startDir = join(tempDir, 'start');
|
|
const prompts = makePromptAdapter({ choices: ['new-custom'], textValue: ' ' });
|
|
const initProject = vi.fn(async () => {
|
|
throw new Error('initProject should not run for an empty path');
|
|
});
|
|
const testIo = makeIo({ stdoutIsTty: true });
|
|
|
|
await expect(
|
|
runKtxSetupProjectStep(
|
|
{ projectDir: startDir, mode: 'auto', inputMode: 'auto', yes: false },
|
|
testIo.io,
|
|
{ prompts, initProject },
|
|
),
|
|
).resolves.toMatchObject({ status: 'missing-input', projectDir: startDir });
|
|
|
|
expect(initProject).not.toHaveBeenCalled();
|
|
expect(testIo.stderr()).toContain(
|
|
'Enter a relative path like ./analytics-ktx, a home path like ~/analytics-ktx, or an absolute path.',
|
|
);
|
|
});
|
|
|
|
it('confirms before creating KTX files inside an existing non-empty folder', async () => {
|
|
const startDir = join(tempDir, 'start');
|
|
const projectDir = join(startDir, 'analytics-ktx');
|
|
await mkdir(projectDir, { recursive: true });
|
|
await writeFile(join(projectDir, 'README.md'), 'Existing project notes\n', 'utf-8');
|
|
const prompts = makePromptAdapter({ choices: ['new-custom', 'use-existing'], textValue: 'analytics-ktx' });
|
|
|
|
const result = await runKtxSetupProjectStep(
|
|
{ projectDir: startDir, mode: 'auto', inputMode: 'auto', yes: false },
|
|
makeIo({ stdoutIsTty: true }).io,
|
|
{ prompts },
|
|
);
|
|
|
|
expect(result.status).toBe('ready');
|
|
expect(result.projectDir).toBe(projectDir);
|
|
expect(prompts.select).toHaveBeenNthCalledWith(
|
|
2,
|
|
expect.objectContaining({
|
|
message: `That folder already exists and is not empty: ${projectDir}`,
|
|
options: expect.arrayContaining([
|
|
expect.objectContaining({ value: 'use-existing', label: 'Yes, create KTX files there' }),
|
|
expect.objectContaining({ value: 'choose-another', label: 'Choose another folder' }),
|
|
]),
|
|
}),
|
|
);
|
|
await expect(readFile(join(projectDir, 'README.md'), 'utf-8')).resolves.toBe('Existing project notes\n');
|
|
await expect(stat(join(projectDir, 'ktx.yaml'))).resolves.toBeDefined();
|
|
});
|
|
|
|
it('prompts to exit and returns cancelled in interactive auto mode', async () => {
|
|
const projectDir = join(tempDir, 'warehouse');
|
|
const prompts = makePromptAdapter({ choice: 'exit' });
|
|
|
|
await expect(
|
|
runKtxSetupProjectStep(
|
|
{ projectDir, mode: 'auto', inputMode: 'auto', yes: false },
|
|
makeIo({ stdoutIsTty: true }).io,
|
|
{ prompts },
|
|
),
|
|
).resolves.toMatchObject({ status: 'cancelled', projectDir });
|
|
|
|
expect(prompts.cancel).toHaveBeenCalledWith('Setup cancelled.');
|
|
expect(prompts.text).not.toHaveBeenCalled();
|
|
await expect(stat(join(projectDir, 'ktx.yaml'))).rejects.toThrow();
|
|
});
|
|
});
|