278 lines
9.1 KiB
TypeScript
278 lines
9.1 KiB
TypeScript
/**
|
|
* Edge cases for BuildContext: unknown cubes, session replay and auth flags.
|
|
*/
|
|
|
|
import { beforeEach, describe, expect, it, vi } from 'vitest';
|
|
import { z } from 'zod';
|
|
import { BuildContext } from '../src/cubes/dependencies.js';
|
|
import { Cube, Manifest } from '../src/cubes/types.js';
|
|
import { Variables } from '../src/nopy.common.js';
|
|
import type { NopyConfig } from '../src/nopy.config.js';
|
|
import type { NopySession } from '../src/nopy.session.js';
|
|
|
|
vi.mock('../src/nopy.prompts.js', async () => {
|
|
const actual = await vi.importActual('../src/nopy.prompts.js');
|
|
return { ...actual, VariableAssignment: vi.fn() };
|
|
});
|
|
|
|
import { VariableAssignment } from '../src/nopy.prompts.js';
|
|
|
|
const testCube = (id: string, schema = z.object({})) =>
|
|
new Cube(Manifest.create({ id, name: `Test ${id}`, schema }), `/test/${id}`, 'deploy.py');
|
|
|
|
const config = { env: {} } as NopyConfig;
|
|
const session = (cubes: NopySession['cubes'] = []) => ({ cubes }) as NopySession;
|
|
|
|
beforeEach(() => {
|
|
vi.clearAllMocks();
|
|
});
|
|
|
|
describe('BuildContext error handling', () => {
|
|
it('throws when the requested cube does not exist', async () => {
|
|
const context = new BuildContext({}, new Variables(), session(), config, { method: 'ssh' });
|
|
|
|
await expect(context.resolveCube('ghost', 'host1')).rejects.toThrow('Cube not found: ghost');
|
|
});
|
|
|
|
it('throws when a dependency does not exist', async () => {
|
|
const cubeB = new Cube(
|
|
Manifest.create({
|
|
id: 'cube-b',
|
|
name: 'B',
|
|
schema: z.object({}),
|
|
dependencies: () => ['ghost'],
|
|
}),
|
|
'/test/cube-b',
|
|
'deploy.py'
|
|
);
|
|
const context = new BuildContext({ 'cube-b': cubeB }, new Variables(), session(), config, {
|
|
method: 'ssh',
|
|
});
|
|
|
|
await expect(context.resolveCube('cube-b', 'host1')).rejects.toThrow('Cube not found: ghost');
|
|
});
|
|
});
|
|
|
|
describe('BuildContext session replay', () => {
|
|
it('takes variables from the session instead of prompting', async () => {
|
|
const cube = testCube('cube-a', z.object({ PORT: z.string().default('3000') }));
|
|
const vars = new Variables();
|
|
const context = new BuildContext(
|
|
{ 'cube-a': cube },
|
|
vars,
|
|
session([{ key: 'cube-a', variables: { PORT: '9090' } }]),
|
|
config,
|
|
{ method: 'ssh' },
|
|
{ isSessionReplay: true }
|
|
);
|
|
|
|
await context.resolveCube('cube-a', 'host1');
|
|
|
|
expect(VariableAssignment).not.toHaveBeenCalled();
|
|
expect(context.deployCalls[0].env.PORT).toBe('9090');
|
|
});
|
|
|
|
it('falls back to schema defaults when the session has no entry for the cube', async () => {
|
|
const cube = testCube('cube-a', z.object({ PORT: z.string().default('3000') }));
|
|
const context = new BuildContext(
|
|
{ 'cube-a': cube },
|
|
new Variables(),
|
|
session([{ key: 'other', variables: { PORT: '9090' } }]),
|
|
config,
|
|
{ method: 'ssh' },
|
|
{ isSessionReplay: true }
|
|
);
|
|
|
|
await context.resolveCube('cube-a', 'host1');
|
|
|
|
expect(VariableAssignment).not.toHaveBeenCalled();
|
|
expect(context.deployCalls[0].env.PORT).toBe('3000');
|
|
});
|
|
|
|
it('prompts when not replaying', async () => {
|
|
const context = new BuildContext(
|
|
{ 'cube-a': testCube('cube-a') },
|
|
new Variables(),
|
|
session(),
|
|
config,
|
|
{ method: 'ssh' }
|
|
);
|
|
|
|
await context.resolveCube('cube-a', 'host1');
|
|
|
|
expect(VariableAssignment).toHaveBeenCalled();
|
|
});
|
|
});
|
|
|
|
describe('BuildContext --use-defaults', () => {
|
|
const withDefaults = (cube: Cube, variables = new Variables(), cfg = config) =>
|
|
new BuildContext(
|
|
{ [cube.id]: cube },
|
|
variables,
|
|
session(),
|
|
cfg,
|
|
{ method: 'ssh' },
|
|
{ useDefaults: true }
|
|
);
|
|
|
|
it('skips the prompts and deploys the schema defaults', async () => {
|
|
const cube = testCube('cube-a', z.object({ PORT: z.string().default('3000') }));
|
|
const context = withDefaults(cube);
|
|
|
|
await context.resolveCube('cube-a', 'host1');
|
|
|
|
expect(VariableAssignment).not.toHaveBeenCalled();
|
|
expect(context.deployCalls[0].env.PORT).toBe('3000');
|
|
});
|
|
|
|
it('lets global env steer the run', async () => {
|
|
const cube = testCube('cube-a', z.object({ PORT: z.string().default('3000') }));
|
|
const context = withDefaults(cube, new Variables({ PORT: '8080' }));
|
|
|
|
await context.resolveCube('cube-a', 'host1');
|
|
|
|
expect(context.deployCalls[0].command.join(' ')).toContain('--data "PORT=8080"');
|
|
});
|
|
|
|
it('refuses to run a cube whose variable nothing can supply', async () => {
|
|
const cube = testCube('cube-a', z.object({ SSID: z.string(), PSK: z.string() }));
|
|
const context = withDefaults(cube);
|
|
|
|
await expect(context.resolveCube('cube-a', 'host1')).rejects.toThrow(
|
|
/Cube "cube-a" cannot run with --use-defaults: SSID, PSK have no default values/
|
|
);
|
|
expect(context.deployCalls).toHaveLength(0);
|
|
});
|
|
|
|
it('names a single missing variable in the singular', async () => {
|
|
const cube = testCube('cube-a', z.object({ SSID: z.string() }));
|
|
|
|
await expect(withDefaults(cube).resolveCube('cube-a', 'host1')).rejects.toThrow(
|
|
'SSID has no default value'
|
|
);
|
|
});
|
|
|
|
it('accepts a required variable supplied by global env', async () => {
|
|
const cube = testCube('cube-a', z.object({ SSID: z.string() }));
|
|
const context = withDefaults(cube, new Variables({ SSID: 'home' }));
|
|
|
|
await context.resolveCube('cube-a', 'host1');
|
|
|
|
expect(context.deployCalls[0].env.SSID).toBe('home');
|
|
});
|
|
|
|
it('accepts a required variable supplied by a dependency', async () => {
|
|
const cube = testCube('cube-a', z.object({ SSID: z.string() }));
|
|
const context = withDefaults(cube);
|
|
|
|
await context.resolveCube('cube-a', 'host1', { SSID: 'from-dep' });
|
|
|
|
expect(context.deployCalls[0].env.SSID).toBe('from-dep');
|
|
});
|
|
|
|
it('still resolves dependencies and hooks', async () => {
|
|
const dep = testCube('dep');
|
|
const main = new Cube(
|
|
Manifest.create({
|
|
id: 'main',
|
|
name: 'Main',
|
|
schema: z.object({ FLAG: z.boolean().default(true) }),
|
|
dependencies: (vars: Record<string, unknown>) => (vars.FLAG ? ['dep'] : []),
|
|
}),
|
|
'/test/main',
|
|
'deploy.py'
|
|
);
|
|
const context = new BuildContext(
|
|
{ dep, main },
|
|
new Variables(),
|
|
session(),
|
|
config,
|
|
{ method: 'ssh' },
|
|
{ useDefaults: true }
|
|
);
|
|
|
|
await context.resolveCube('main', 'host1');
|
|
|
|
expect(context.deployCalls.map((c) => c.cube)).toEqual(['dep', 'main']);
|
|
});
|
|
});
|
|
|
|
describe('BuildContext command construction', () => {
|
|
const build = (auth: { method: string; username?: string; password?: string }) => {
|
|
const context = new BuildContext(
|
|
{ 'cube-a': testCube('cube-a') },
|
|
new Variables(),
|
|
session(),
|
|
config,
|
|
auth
|
|
);
|
|
return context.resolveCube('cube-a', 'host1').then(() => context);
|
|
};
|
|
|
|
it('adds --user/--password for complete password auth', async () => {
|
|
const context = await build({ method: 'password', username: 'deploy', password: 'pw' });
|
|
|
|
expect(context.deployCalls[0].command.join(' ')).toContain('--user deploy --password pw');
|
|
});
|
|
|
|
it('omits credentials for ssh auth', async () => {
|
|
const context = await build({ method: 'ssh' });
|
|
|
|
expect(context.deployCalls[0].command.join(' ')).not.toContain('--user');
|
|
});
|
|
|
|
it('omits credentials when the password is missing', async () => {
|
|
const context = await build({ method: 'password', username: 'deploy' });
|
|
|
|
expect(context.deployCalls[0].command.join(' ')).not.toContain('--user');
|
|
});
|
|
|
|
it('omits credentials when the username is missing', async () => {
|
|
const context = await build({ method: 'password', password: 'pw' });
|
|
|
|
expect(context.deployCalls[0].command.join(' ')).not.toContain('--user');
|
|
});
|
|
|
|
it('passes cube variables as --data flags and points at the deploy script', async () => {
|
|
const cube = testCube('cube-a', z.object({ PORT: z.string().default('3000') }));
|
|
const context = new BuildContext({ 'cube-a': cube }, new Variables(), session(), config, {
|
|
method: 'ssh',
|
|
});
|
|
|
|
await context.resolveCube('cube-a', 'host1');
|
|
const command = context.deployCalls[0].command.join(' ');
|
|
|
|
expect(command).toContain('--data "PORT=3000"');
|
|
expect(command).toContain('--chdir /test/cube-a');
|
|
expect(command).toContain('/test/cube-a/deploy.py');
|
|
expect(context.deployCalls[0].cwd).toBe('/test/cube-a');
|
|
});
|
|
|
|
it('builds a separate call per host but records the cube session once', async () => {
|
|
const context = new BuildContext(
|
|
{ 'cube-a': testCube('cube-a') },
|
|
new Variables(),
|
|
session(),
|
|
config,
|
|
{ method: 'ssh' }
|
|
);
|
|
|
|
await context.resolveCube('cube-a', 'host1');
|
|
await context.resolveCube('cube-a', 'host2');
|
|
|
|
expect(context.deployCalls.map((c) => c.host)).toEqual(['host1', 'host2']);
|
|
expect(context.cubeSessions).toHaveLength(1);
|
|
});
|
|
|
|
it('applies caller overrides as params', async () => {
|
|
const cube = testCube('cube-a', z.object({ PORT: z.string().default('3000') }));
|
|
const context = new BuildContext({ 'cube-a': cube }, new Variables(), session(), config, {
|
|
method: 'ssh',
|
|
});
|
|
|
|
await context.resolveCube('cube-a', 'host1', { PORT: '8080' });
|
|
|
|
expect(context.deployCalls[0].env.PORT).toBe('8080');
|
|
});
|
|
});
|