mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
feat: Allow for custom CLI and variable options
* feat: (AppRunner) Mechanism to configure cli args and derive componentsjs vars from them implemented * fix: (AppRunner) tidying * fix: (AppRunner) tidying up * fix: (AppRunner) runCli method made sync * fix; (VarResolver) refactored to multiple files, and other stylistic fixes. * chore: (AppRunner) Uses builder pattern for yargs base arguments setup to enable better typescript inference * fix(AppRunner): refactoring AppRunner and VarResolver * fix(AppRunner): refactoring AppRunner promise handling * fix(AppRunner): verror dependency removal * fix: Simplify CLI error handling * feat: Use same config for both CLI and app instantiation * fix: Update typings and imports * feat: Split VariableResolver behaviour to 2 classes * feat: Move default value behaviour from CLI to ValueComputers * test: Add unit tests for new CLI classes * feat: Integrate new CLI configuration with all default configurations * feat: Add createApp function to AppRunner * docs: Update comments in CLI-related classes * fix: Various fixes and refactors Co-authored-by: damooo <damodara@protonmail.com>
This commit is contained in:
Joachim Van Herwegen
committed by
GitHub
GitHub
parent
d067165b68
commit
c216efd62f
@@ -1,14 +1,38 @@
|
||||
import { ComponentsManager } from 'componentsjs';
|
||||
import type { App } from '../../../src/init/App';
|
||||
import { AppRunner } from '../../../src/init/AppRunner';
|
||||
import type { CliExtractor } from '../../../src/init/cli/CliExtractor';
|
||||
import type { SettingsResolver } from '../../../src/init/variables/SettingsResolver';
|
||||
import { joinFilePath } from '../../../src/util/PathUtil';
|
||||
|
||||
const app: jest.Mocked<App> = {
|
||||
start: jest.fn(),
|
||||
} as any;
|
||||
|
||||
const defaultParameters = {
|
||||
port: 3000,
|
||||
logLevel: 'info',
|
||||
};
|
||||
const cliExtractor: jest.Mocked<CliExtractor> = {
|
||||
handleSafe: jest.fn().mockResolvedValue(defaultParameters),
|
||||
} as any;
|
||||
|
||||
const defaultVariables = {
|
||||
'urn:solid-server:default:variable:port': 3000,
|
||||
'urn:solid-server:default:variable:loggingLevel': 'info',
|
||||
};
|
||||
const settingsResolver: jest.Mocked<SettingsResolver> = {
|
||||
handleSafe: jest.fn().mockResolvedValue(defaultVariables),
|
||||
} as any;
|
||||
|
||||
const manager: jest.Mocked<ComponentsManager<App>> = {
|
||||
instantiate: jest.fn(async(): Promise<App> => app),
|
||||
instantiate: jest.fn(async(iri: string): Promise<any> => {
|
||||
switch (iri) {
|
||||
case 'urn:solid-server-app-setup:default:CliResolver': return { cliExtractor, settingsResolver };
|
||||
case 'urn:solid-server:default:App': return app;
|
||||
default: throw new Error('unknown iri');
|
||||
}
|
||||
}),
|
||||
configRegistry: {
|
||||
register: jest.fn(),
|
||||
},
|
||||
@@ -22,7 +46,6 @@ jest.mock('componentsjs', (): any => ({
|
||||
}));
|
||||
|
||||
jest.spyOn(process, 'cwd').mockReturnValue('/var/cwd');
|
||||
const error = jest.spyOn(console, 'error').mockImplementation(jest.fn());
|
||||
const write = jest.spyOn(process.stderr, 'write').mockImplementation(jest.fn());
|
||||
const exit = jest.spyOn(process, 'exit').mockImplementation(jest.fn() as any);
|
||||
|
||||
@@ -31,8 +54,52 @@ describe('AppRunner', (): void => {
|
||||
jest.clearAllMocks();
|
||||
});
|
||||
|
||||
describe('create', (): void => {
|
||||
it('creates an App with the provided settings.', async(): Promise<void> => {
|
||||
const variables = {
|
||||
'urn:solid-server:default:variable:port': 3000,
|
||||
'urn:solid-server:default:variable:loggingLevel': 'info',
|
||||
'urn:solid-server:default:variable:rootFilePath': '/var/cwd/',
|
||||
'urn:solid-server:default:variable:showStackTrace': false,
|
||||
'urn:solid-server:default:variable:podConfigJson': '/var/cwd/pod-config.json',
|
||||
};
|
||||
const createdApp = await new AppRunner().create(
|
||||
{
|
||||
mainModulePath: joinFilePath(__dirname, '../../../'),
|
||||
dumpErrorState: true,
|
||||
logLevel: 'info',
|
||||
},
|
||||
joinFilePath(__dirname, '../../../config/default.json'),
|
||||
variables,
|
||||
);
|
||||
expect(createdApp).toBe(app);
|
||||
|
||||
expect(ComponentsManager.build).toHaveBeenCalledTimes(1);
|
||||
expect(ComponentsManager.build).toHaveBeenCalledWith({
|
||||
dumpErrorState: true,
|
||||
logLevel: 'info',
|
||||
mainModulePath: joinFilePath(__dirname, '../../../'),
|
||||
});
|
||||
expect(manager.configRegistry.register).toHaveBeenCalledTimes(1);
|
||||
expect(manager.configRegistry.register)
|
||||
.toHaveBeenCalledWith(joinFilePath(__dirname, '/../../../config/default.json'));
|
||||
expect(manager.instantiate).toHaveBeenCalledTimes(1);
|
||||
expect(manager.instantiate).toHaveBeenNthCalledWith(1, 'urn:solid-server:default:App', { variables });
|
||||
expect(cliExtractor.handleSafe).toHaveBeenCalledTimes(0);
|
||||
expect(settingsResolver.handleSafe).toHaveBeenCalledTimes(0);
|
||||
expect(app.start).toHaveBeenCalledTimes(0);
|
||||
});
|
||||
});
|
||||
|
||||
describe('run', (): void => {
|
||||
it('starts the server with default settings.', async(): Promise<void> => {
|
||||
it('starts the server with provided settings.', async(): Promise<void> => {
|
||||
const variables = {
|
||||
'urn:solid-server:default:variable:port': 3000,
|
||||
'urn:solid-server:default:variable:loggingLevel': 'info',
|
||||
'urn:solid-server:default:variable:rootFilePath': '/var/cwd/',
|
||||
'urn:solid-server:default:variable:showStackTrace': false,
|
||||
'urn:solid-server:default:variable:podConfigJson': '/var/cwd/pod-config.json',
|
||||
};
|
||||
await new AppRunner().run(
|
||||
{
|
||||
mainModulePath: joinFilePath(__dirname, '../../../'),
|
||||
@@ -40,13 +107,7 @@ describe('AppRunner', (): void => {
|
||||
logLevel: 'info',
|
||||
},
|
||||
joinFilePath(__dirname, '../../../config/default.json'),
|
||||
{
|
||||
port: 3000,
|
||||
loggingLevel: 'info',
|
||||
rootFilePath: '/var/cwd/',
|
||||
showStackTrace: false,
|
||||
podConfigJson: '/var/cwd/pod-config.json',
|
||||
},
|
||||
variables,
|
||||
);
|
||||
|
||||
expect(ComponentsManager.build).toHaveBeenCalledTimes(1);
|
||||
@@ -59,35 +120,17 @@ describe('AppRunner', (): void => {
|
||||
expect(manager.configRegistry.register)
|
||||
.toHaveBeenCalledWith(joinFilePath(__dirname, '/../../../config/default.json'));
|
||||
expect(manager.instantiate).toHaveBeenCalledTimes(1);
|
||||
expect(manager.instantiate).toHaveBeenCalledWith(
|
||||
'urn:solid-server:default:App',
|
||||
{
|
||||
variables: {
|
||||
'urn:solid-server:default:variable:port': 3000,
|
||||
'urn:solid-server:default:variable:baseUrl': 'http://localhost:3000/',
|
||||
'urn:solid-server:default:variable:rootFilePath': '/var/cwd/',
|
||||
'urn:solid-server:default:variable:sparqlEndpoint': undefined,
|
||||
'urn:solid-server:default:variable:loggingLevel': 'info',
|
||||
'urn:solid-server:default:variable:showStackTrace': false,
|
||||
'urn:solid-server:default:variable:podConfigJson': '/var/cwd/pod-config.json',
|
||||
},
|
||||
},
|
||||
);
|
||||
expect(manager.instantiate).toHaveBeenNthCalledWith(1, 'urn:solid-server:default:App', { variables });
|
||||
expect(cliExtractor.handleSafe).toHaveBeenCalledTimes(0);
|
||||
expect(settingsResolver.handleSafe).toHaveBeenCalledTimes(0);
|
||||
expect(app.start).toHaveBeenCalledTimes(1);
|
||||
expect(app.start).toHaveBeenCalledWith();
|
||||
});
|
||||
});
|
||||
|
||||
describe('runCli', (): void => {
|
||||
it('starts the server with default settings.', async(): Promise<void> => {
|
||||
new AppRunner().runCli({
|
||||
argv: [ 'node', 'script' ],
|
||||
});
|
||||
|
||||
// Wait until app.start has been called, because we can't await AppRunner.run.
|
||||
await new Promise((resolve): void => {
|
||||
setImmediate(resolve);
|
||||
});
|
||||
describe('createCli', (): void => {
|
||||
it('creates the server with default settings.', async(): Promise<void> => {
|
||||
await expect(new AppRunner().createCli([ 'node', 'script' ])).resolves.toBe(app);
|
||||
|
||||
expect(ComponentsManager.build).toHaveBeenCalledTimes(1);
|
||||
expect(ComponentsManager.build).toHaveBeenCalledWith({
|
||||
@@ -98,133 +141,21 @@ describe('AppRunner', (): void => {
|
||||
expect(manager.configRegistry.register).toHaveBeenCalledTimes(1);
|
||||
expect(manager.configRegistry.register)
|
||||
.toHaveBeenCalledWith(joinFilePath(__dirname, '/../../../config/default.json'));
|
||||
expect(manager.instantiate).toHaveBeenCalledTimes(1);
|
||||
expect(manager.instantiate).toHaveBeenCalledWith(
|
||||
expect(manager.instantiate).toHaveBeenCalledTimes(2);
|
||||
expect(manager.instantiate).toHaveBeenNthCalledWith(1, 'urn:solid-server-app-setup:default:CliResolver', {});
|
||||
expect(cliExtractor.handleSafe).toHaveBeenCalledTimes(1);
|
||||
expect(cliExtractor.handleSafe).toHaveBeenCalledWith([ 'node', 'script' ]);
|
||||
expect(settingsResolver.handleSafe).toHaveBeenCalledTimes(1);
|
||||
expect(settingsResolver.handleSafe).toHaveBeenCalledWith(defaultParameters);
|
||||
expect(manager.instantiate).toHaveBeenNthCalledWith(2,
|
||||
'urn:solid-server:default:App',
|
||||
{
|
||||
variables: {
|
||||
'urn:solid-server:default:variable:port': 3000,
|
||||
'urn:solid-server:default:variable:baseUrl': 'http://localhost:3000/',
|
||||
'urn:solid-server:default:variable:rootFilePath': '/var/cwd/',
|
||||
'urn:solid-server:default:variable:sparqlEndpoint': undefined,
|
||||
'urn:solid-server:default:variable:loggingLevel': 'info',
|
||||
'urn:solid-server:default:variable:showStackTrace': false,
|
||||
'urn:solid-server:default:variable:podConfigJson': '/var/cwd/pod-config.json',
|
||||
},
|
||||
},
|
||||
);
|
||||
expect(app.start).toHaveBeenCalledTimes(1);
|
||||
expect(app.start).toHaveBeenCalledWith();
|
||||
});
|
||||
|
||||
it('accepts abbreviated flags.', async(): Promise<void> => {
|
||||
new AppRunner().runCli({
|
||||
argv: [
|
||||
'node', 'script',
|
||||
'-b', 'http://pod.example/',
|
||||
'-c', 'myconfig.json',
|
||||
'-f', '/root',
|
||||
'-l', 'debug',
|
||||
'-m', 'module/path',
|
||||
'-p', '4000',
|
||||
'-s', 'http://localhost:5000/sparql',
|
||||
'-t',
|
||||
'--podConfigJson', '/different-path.json',
|
||||
],
|
||||
});
|
||||
|
||||
// Wait until app.start has been called, because we can't await AppRunner.run.
|
||||
await new Promise((resolve): void => {
|
||||
setImmediate(resolve);
|
||||
});
|
||||
|
||||
expect(ComponentsManager.build).toHaveBeenCalledTimes(1);
|
||||
expect(ComponentsManager.build).toHaveBeenCalledWith({
|
||||
dumpErrorState: true,
|
||||
logLevel: 'debug',
|
||||
mainModulePath: '/var/cwd/module/path',
|
||||
});
|
||||
expect(manager.configRegistry.register).toHaveBeenCalledTimes(1);
|
||||
expect(manager.configRegistry.register).toHaveBeenCalledWith('/var/cwd/myconfig.json');
|
||||
expect(manager.instantiate).toHaveBeenCalledWith(
|
||||
'urn:solid-server:default:App',
|
||||
{
|
||||
variables: {
|
||||
'urn:solid-server:default:variable:baseUrl': 'http://pod.example/',
|
||||
'urn:solid-server:default:variable:loggingLevel': 'debug',
|
||||
'urn:solid-server:default:variable:port': 4000,
|
||||
'urn:solid-server:default:variable:rootFilePath': '/root',
|
||||
'urn:solid-server:default:variable:sparqlEndpoint': 'http://localhost:5000/sparql',
|
||||
'urn:solid-server:default:variable:showStackTrace': true,
|
||||
'urn:solid-server:default:variable:podConfigJson': '/different-path.json',
|
||||
},
|
||||
},
|
||||
);
|
||||
});
|
||||
|
||||
it('accepts full flags.', async(): Promise<void> => {
|
||||
new AppRunner().runCli({
|
||||
argv: [
|
||||
'node', 'script',
|
||||
'--baseUrl', 'http://pod.example/',
|
||||
'--config', 'myconfig.json',
|
||||
'--loggingLevel', 'debug',
|
||||
'--mainModulePath', 'module/path',
|
||||
'--port', '4000',
|
||||
'--rootFilePath', 'root',
|
||||
'--sparqlEndpoint', 'http://localhost:5000/sparql',
|
||||
'--showStackTrace',
|
||||
'--podConfigJson', '/different-path.json',
|
||||
],
|
||||
});
|
||||
|
||||
// Wait until app.start has been called, because we can't await AppRunner.run.
|
||||
await new Promise((resolve): void => {
|
||||
setImmediate(resolve);
|
||||
});
|
||||
|
||||
expect(ComponentsManager.build).toHaveBeenCalledTimes(1);
|
||||
expect(ComponentsManager.build).toHaveBeenCalledWith({
|
||||
dumpErrorState: true,
|
||||
logLevel: 'debug',
|
||||
mainModulePath: '/var/cwd/module/path',
|
||||
});
|
||||
expect(manager.configRegistry.register).toHaveBeenCalledTimes(1);
|
||||
expect(manager.configRegistry.register).toHaveBeenCalledWith('/var/cwd/myconfig.json');
|
||||
expect(manager.instantiate).toHaveBeenCalledWith(
|
||||
'urn:solid-server:default:App',
|
||||
{
|
||||
variables: {
|
||||
'urn:solid-server:default:variable:baseUrl': 'http://pod.example/',
|
||||
'urn:solid-server:default:variable:loggingLevel': 'debug',
|
||||
'urn:solid-server:default:variable:port': 4000,
|
||||
'urn:solid-server:default:variable:rootFilePath': '/var/cwd/root',
|
||||
'urn:solid-server:default:variable:sparqlEndpoint': 'http://localhost:5000/sparql',
|
||||
'urn:solid-server:default:variable:showStackTrace': true,
|
||||
'urn:solid-server:default:variable:podConfigJson': '/different-path.json',
|
||||
},
|
||||
},
|
||||
);
|
||||
});
|
||||
|
||||
it('accepts asset paths for the config flag.', async(): Promise<void> => {
|
||||
new AppRunner().runCli({
|
||||
argv: [
|
||||
'node', 'script',
|
||||
'--config', '@css:config/file.json',
|
||||
],
|
||||
});
|
||||
await new Promise(setImmediate);
|
||||
|
||||
expect(manager.configRegistry.register).toHaveBeenCalledTimes(1);
|
||||
expect(manager.configRegistry.register).toHaveBeenCalledWith(
|
||||
joinFilePath(__dirname, '../../../config/file.json'),
|
||||
);
|
||||
{ variables: defaultVariables });
|
||||
expect(app.start).toHaveBeenCalledTimes(0);
|
||||
});
|
||||
|
||||
it('uses the default process.argv in case none are provided.', async(): Promise<void> => {
|
||||
const { argv } = process;
|
||||
process.argv = [
|
||||
const argvParameters = [
|
||||
'node', 'script',
|
||||
'-b', 'http://pod.example/',
|
||||
'-c', 'myconfig.json',
|
||||
@@ -236,13 +167,9 @@ describe('AppRunner', (): void => {
|
||||
'-t',
|
||||
'--podConfigJson', '/different-path.json',
|
||||
];
|
||||
process.argv = argvParameters;
|
||||
|
||||
new AppRunner().runCli();
|
||||
|
||||
// Wait until app.start has been called, because we can't await AppRunner.run.
|
||||
await new Promise((resolve): void => {
|
||||
setImmediate(resolve);
|
||||
});
|
||||
await expect(new AppRunner().createCli()).resolves.toBe(app);
|
||||
|
||||
expect(ComponentsManager.build).toHaveBeenCalledTimes(1);
|
||||
expect(ComponentsManager.build).toHaveBeenCalledWith({
|
||||
@@ -252,119 +179,181 @@ describe('AppRunner', (): void => {
|
||||
});
|
||||
expect(manager.configRegistry.register).toHaveBeenCalledTimes(1);
|
||||
expect(manager.configRegistry.register).toHaveBeenCalledWith('/var/cwd/myconfig.json');
|
||||
expect(manager.instantiate).toHaveBeenCalledWith(
|
||||
expect(manager.instantiate).toHaveBeenCalledTimes(2);
|
||||
expect(manager.instantiate).toHaveBeenNthCalledWith(1, 'urn:solid-server-app-setup:default:CliResolver', {});
|
||||
expect(cliExtractor.handleSafe).toHaveBeenCalledTimes(1);
|
||||
expect(cliExtractor.handleSafe).toHaveBeenCalledWith(argvParameters);
|
||||
expect(settingsResolver.handleSafe).toHaveBeenCalledTimes(1);
|
||||
expect(settingsResolver.handleSafe).toHaveBeenCalledWith(defaultParameters);
|
||||
expect(manager.instantiate).toHaveBeenNthCalledWith(2,
|
||||
'urn:solid-server:default:App',
|
||||
{
|
||||
variables: {
|
||||
'urn:solid-server:default:variable:baseUrl': 'http://pod.example/',
|
||||
'urn:solid-server:default:variable:loggingLevel': 'debug',
|
||||
'urn:solid-server:default:variable:port': 4000,
|
||||
'urn:solid-server:default:variable:rootFilePath': '/root',
|
||||
'urn:solid-server:default:variable:sparqlEndpoint': 'http://localhost:5000/sparql',
|
||||
'urn:solid-server:default:variable:showStackTrace': true,
|
||||
'urn:solid-server:default:variable:podConfigJson': '/different-path.json',
|
||||
},
|
||||
},
|
||||
);
|
||||
{ variables: defaultVariables });
|
||||
expect(app.start).toHaveBeenCalledTimes(0);
|
||||
|
||||
process.argv = argv;
|
||||
});
|
||||
|
||||
it('exits with output to stderr when instantiation fails.', async(): Promise<void> => {
|
||||
manager.instantiate.mockRejectedValueOnce(new Error('Fatal'));
|
||||
new AppRunner().runCli({
|
||||
argv: [ 'node', 'script' ],
|
||||
});
|
||||
it('throws an error if creating a ComponentsManager fails.', async(): Promise<void> => {
|
||||
(manager.configRegistry.register as jest.Mock).mockRejectedValueOnce(new Error('Fatal'));
|
||||
|
||||
// Wait until app.start has been called, because we can't await AppRunner.run.
|
||||
await new Promise((resolve): void => {
|
||||
setImmediate(resolve);
|
||||
});
|
||||
let caughtError: Error = new Error('should disappear');
|
||||
try {
|
||||
await new AppRunner().createCli([ 'node', 'script' ]);
|
||||
} catch (error: unknown) {
|
||||
caughtError = error as Error;
|
||||
}
|
||||
expect(caughtError.message).toMatch(/^Could not build the config files from .*default\.json/mu);
|
||||
expect(caughtError.message).toMatch(/^Cause: Fatal/mu);
|
||||
|
||||
expect(write).toHaveBeenCalledTimes(2);
|
||||
expect(write).toHaveBeenNthCalledWith(1,
|
||||
expect.stringMatching(/^Error: could not instantiate server from .*default\.json/u));
|
||||
expect(write).toHaveBeenNthCalledWith(2,
|
||||
expect.stringMatching(/^Error: Fatal/u));
|
||||
|
||||
expect(exit).toHaveBeenCalledTimes(1);
|
||||
expect(exit).toHaveBeenCalledWith(1);
|
||||
expect(write).toHaveBeenCalledTimes(0);
|
||||
expect(exit).toHaveBeenCalledTimes(0);
|
||||
});
|
||||
|
||||
it('exits without output to stderr when initialization fails.', async(): Promise<void> => {
|
||||
app.start.mockRejectedValueOnce(new Error('Fatal'));
|
||||
new AppRunner().runCli({
|
||||
argv: [ 'node', 'script' ],
|
||||
});
|
||||
it('throws an error if instantiating the CliResolver fails.', async(): Promise<void> => {
|
||||
manager.instantiate.mockRejectedValueOnce(new Error('Fatal'));
|
||||
|
||||
// Wait until app.start has been called, because we can't await AppRunner.run.
|
||||
await new Promise((resolve): void => {
|
||||
setImmediate(resolve);
|
||||
let caughtError: Error = new Error('should disappear');
|
||||
try {
|
||||
await new AppRunner().createCli([ 'node', 'script' ]);
|
||||
} catch (error: unknown) {
|
||||
caughtError = error as Error;
|
||||
}
|
||||
expect(caughtError.message).toMatch(/^Could not load the config variables/mu);
|
||||
expect(caughtError.message).toMatch(/^Cause: Fatal/mu);
|
||||
|
||||
expect(write).toHaveBeenCalledTimes(0);
|
||||
expect(exit).toHaveBeenCalledTimes(0);
|
||||
});
|
||||
|
||||
it('throws an error if instantiating the server fails.', async(): Promise<void> => {
|
||||
// We want the second call to fail
|
||||
manager.instantiate
|
||||
.mockResolvedValueOnce({ cliExtractor, settingsResolver })
|
||||
.mockRejectedValueOnce(new Error('Fatal'));
|
||||
|
||||
let caughtError: Error = new Error('should disappear');
|
||||
try {
|
||||
await new AppRunner().createCli([ 'node', 'script' ]);
|
||||
} catch (error: unknown) {
|
||||
caughtError = error as Error;
|
||||
}
|
||||
expect(caughtError.message).toMatch(/^Could not create the server/mu);
|
||||
expect(caughtError.message).toMatch(/^Cause: Fatal/mu);
|
||||
|
||||
expect(write).toHaveBeenCalledTimes(0);
|
||||
expect(exit).toHaveBeenCalledTimes(0);
|
||||
});
|
||||
|
||||
it('throws an error if non-error objects get thrown.', async(): Promise<void> => {
|
||||
(manager.configRegistry.register as jest.Mock).mockRejectedValueOnce('NotAnError');
|
||||
|
||||
let caughtError: Error = new Error('should disappear');
|
||||
try {
|
||||
await new AppRunner().createCli([ 'node', 'script' ]);
|
||||
} catch (error: unknown) {
|
||||
caughtError = error as Error;
|
||||
}
|
||||
expect(caughtError.message).toMatch(/^Cause: Unknown error: NotAnError$/mu);
|
||||
|
||||
expect(write).toHaveBeenCalledTimes(0);
|
||||
expect(exit).toHaveBeenCalledTimes(0);
|
||||
});
|
||||
});
|
||||
|
||||
describe('runCli', (): void => {
|
||||
it('runs the server.', async(): Promise<void> => {
|
||||
await expect(new AppRunner().runCli([ 'node', 'script' ])).resolves.toBeUndefined();
|
||||
|
||||
expect(ComponentsManager.build).toHaveBeenCalledTimes(1);
|
||||
expect(ComponentsManager.build).toHaveBeenCalledWith({
|
||||
dumpErrorState: true,
|
||||
logLevel: 'info',
|
||||
mainModulePath: joinFilePath(__dirname, '../../../'),
|
||||
});
|
||||
expect(manager.configRegistry.register).toHaveBeenCalledTimes(1);
|
||||
expect(manager.configRegistry.register)
|
||||
.toHaveBeenCalledWith(joinFilePath(__dirname, '/../../../config/default.json'));
|
||||
expect(manager.instantiate).toHaveBeenCalledTimes(2);
|
||||
expect(manager.instantiate).toHaveBeenNthCalledWith(1, 'urn:solid-server-app-setup:default:CliResolver', {});
|
||||
expect(cliExtractor.handleSafe).toHaveBeenCalledTimes(1);
|
||||
expect(cliExtractor.handleSafe).toHaveBeenCalledWith([ 'node', 'script' ]);
|
||||
expect(settingsResolver.handleSafe).toHaveBeenCalledTimes(1);
|
||||
expect(settingsResolver.handleSafe).toHaveBeenCalledWith(defaultParameters);
|
||||
expect(manager.instantiate).toHaveBeenNthCalledWith(2,
|
||||
'urn:solid-server:default:App',
|
||||
{ variables: defaultVariables });
|
||||
expect(app.start).toHaveBeenCalledTimes(1);
|
||||
expect(app.start).toHaveBeenLastCalledWith();
|
||||
});
|
||||
|
||||
it('throws an error if the server could not start.', async(): Promise<void> => {
|
||||
app.start.mockRejectedValueOnce(new Error('Fatal'));
|
||||
|
||||
let caughtError: Error = new Error('should disappear');
|
||||
try {
|
||||
await new AppRunner().runCli([ 'node', 'script' ]);
|
||||
} catch (error: unknown) {
|
||||
caughtError = error as Error;
|
||||
}
|
||||
expect(caughtError.message).toMatch(/^Could not start the server/mu);
|
||||
expect(caughtError.message).toMatch(/^Cause: Fatal/mu);
|
||||
|
||||
expect(app.start).toHaveBeenCalledTimes(1);
|
||||
|
||||
expect(write).toHaveBeenCalledTimes(0);
|
||||
|
||||
expect(exit).toHaveBeenCalledWith(1);
|
||||
expect(exit).toHaveBeenCalledTimes(0);
|
||||
});
|
||||
});
|
||||
|
||||
it('exits when unknown options are passed to the main executable.', async(): Promise<void> => {
|
||||
new AppRunner().runCli({
|
||||
argv: [ 'node', 'script', '--foo' ],
|
||||
});
|
||||
describe('runCliSync', (): void => {
|
||||
it('starts the server.', async(): Promise<void> => {
|
||||
// eslint-disable-next-line no-sync
|
||||
new AppRunner().runCliSync({ argv: [ 'node', 'script' ]});
|
||||
|
||||
// Wait until app.start has been called, because we can't await AppRunner.run.
|
||||
await new Promise((resolve): void => {
|
||||
setImmediate(resolve);
|
||||
});
|
||||
|
||||
expect(error).toHaveBeenCalledWith('Unknown argument: foo');
|
||||
expect(exit).toHaveBeenCalledTimes(1);
|
||||
expect(exit).toHaveBeenCalledWith(1);
|
||||
expect(ComponentsManager.build).toHaveBeenCalledTimes(1);
|
||||
expect(ComponentsManager.build).toHaveBeenCalledWith({
|
||||
dumpErrorState: true,
|
||||
logLevel: 'info',
|
||||
mainModulePath: joinFilePath(__dirname, '../../../'),
|
||||
});
|
||||
expect(manager.configRegistry.register).toHaveBeenCalledTimes(1);
|
||||
expect(manager.configRegistry.register)
|
||||
.toHaveBeenCalledWith(joinFilePath(__dirname, '/../../../config/default.json'));
|
||||
expect(manager.instantiate).toHaveBeenCalledTimes(2);
|
||||
expect(manager.instantiate).toHaveBeenNthCalledWith(1, 'urn:solid-server-app-setup:default:CliResolver', {});
|
||||
expect(cliExtractor.handleSafe).toHaveBeenCalledTimes(1);
|
||||
expect(cliExtractor.handleSafe).toHaveBeenCalledWith([ 'node', 'script' ]);
|
||||
expect(settingsResolver.handleSafe).toHaveBeenCalledTimes(1);
|
||||
expect(settingsResolver.handleSafe).toHaveBeenCalledWith(defaultParameters);
|
||||
expect(manager.instantiate).toHaveBeenNthCalledWith(2,
|
||||
'urn:solid-server:default:App',
|
||||
{ variables: defaultVariables });
|
||||
expect(app.start).toHaveBeenCalledTimes(1);
|
||||
expect(app.start).toHaveBeenLastCalledWith();
|
||||
});
|
||||
|
||||
it('exits when no value is passed to the main executable for an argument.', async(): Promise<void> => {
|
||||
new AppRunner().runCli({
|
||||
argv: [ 'node', 'script', '-s' ],
|
||||
});
|
||||
it('exits the process and writes to stderr if there was an error.', async(): Promise<void> => {
|
||||
manager.instantiate.mockRejectedValueOnce(new Error('Fatal'));
|
||||
|
||||
// Wait until app.start has been called, because we can't await AppRunner.run.
|
||||
// eslint-disable-next-line no-sync
|
||||
new AppRunner().runCliSync({ argv: [ 'node', 'script' ]});
|
||||
|
||||
// Wait until app.start has been called, because we can't await AppRunner.runCli.
|
||||
await new Promise((resolve): void => {
|
||||
setImmediate(resolve);
|
||||
});
|
||||
|
||||
expect(error).toHaveBeenCalledWith('Not enough arguments following: s');
|
||||
expect(write).toHaveBeenCalledTimes(1);
|
||||
expect(write).toHaveBeenLastCalledWith(expect.stringMatching(/Cause: Fatal/mu));
|
||||
|
||||
expect(exit).toHaveBeenCalledTimes(1);
|
||||
expect(exit).toHaveBeenCalledWith(1);
|
||||
});
|
||||
|
||||
it('exits when unknown parameters are passed to the main executable.', async(): Promise<void> => {
|
||||
new AppRunner().runCli({
|
||||
argv: [ 'node', 'script', 'foo', 'bar', 'foo.txt', 'bar.txt' ],
|
||||
});
|
||||
|
||||
// Wait until app.start has been called, because we can't await AppRunner.run.
|
||||
await new Promise((resolve): void => {
|
||||
setImmediate(resolve);
|
||||
});
|
||||
|
||||
expect(error).toHaveBeenCalledWith('Unsupported positional arguments: "foo", "bar", "foo.txt", "bar.txt"');
|
||||
expect(exit).toHaveBeenCalledTimes(1);
|
||||
expect(exit).toHaveBeenCalledWith(1);
|
||||
});
|
||||
|
||||
it('exits when multiple values for a parameter are passed.', async(): Promise<void> => {
|
||||
new AppRunner().runCli({
|
||||
argv: [ 'node', 'script', '-l', 'info', '-l', 'debug' ],
|
||||
});
|
||||
|
||||
// Wait until app.start has been called, because we can't await AppRunner.run.
|
||||
await new Promise((resolve): void => {
|
||||
setImmediate(resolve);
|
||||
});
|
||||
|
||||
expect(error).toHaveBeenCalledWith('Multiple values were provided for: "l": "info", "debug"');
|
||||
expect(exit).toHaveBeenCalledTimes(1);
|
||||
expect(exit).toHaveBeenCalledWith(1);
|
||||
expect(exit).toHaveBeenLastCalledWith(1);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
13
test/unit/init/CliResolver.test.ts
Normal file
13
test/unit/init/CliResolver.test.ts
Normal file
@@ -0,0 +1,13 @@
|
||||
import type { CliExtractor } from '../../../src/init/cli/CliExtractor';
|
||||
import { CliResolver } from '../../../src/init/CliResolver';
|
||||
import type { SettingsResolver } from '../../../src/init/variables/SettingsResolver';
|
||||
|
||||
describe('A CliResolver', (): void => {
|
||||
it('stores a CliExtractor and SettingsResolver.', async(): Promise<void> => {
|
||||
const cliExtractor: CliExtractor = { canHandle: jest.fn().mockResolvedValue('CLI!') } as any;
|
||||
const settingsResolver: SettingsResolver = { canHandle: jest.fn().mockResolvedValue('Settings!') } as any;
|
||||
const cliResolver = new CliResolver(cliExtractor, settingsResolver);
|
||||
expect(cliResolver.cliExtractor).toBe(cliExtractor);
|
||||
expect(cliResolver.settingsResolver).toBe(settingsResolver);
|
||||
});
|
||||
});
|
||||
83
test/unit/init/cli/YargsCliExtractor.test.ts
Normal file
83
test/unit/init/cli/YargsCliExtractor.test.ts
Normal file
@@ -0,0 +1,83 @@
|
||||
import type { YargsArgOptions } from '../../../../src/init/cli/YargsCliExtractor';
|
||||
import { YargsCliExtractor } from '../../../../src/init/cli/YargsCliExtractor';
|
||||
|
||||
const error = jest.spyOn(console, 'error').mockImplementation(jest.fn());
|
||||
const log = jest.spyOn(console, 'log').mockImplementation(jest.fn());
|
||||
const exit = jest.spyOn(process, 'exit').mockImplementation(jest.fn() as any);
|
||||
describe('A YargsCliExtractor', (): void => {
|
||||
const parameters: YargsArgOptions = {
|
||||
baseUrl: { alias: 'b', requiresArg: true, type: 'string' },
|
||||
port: { alias: 'p', requiresArg: true, type: 'number' },
|
||||
};
|
||||
let extractor: YargsCliExtractor;
|
||||
|
||||
beforeEach(async(): Promise<void> => {
|
||||
extractor = new YargsCliExtractor(parameters);
|
||||
});
|
||||
|
||||
afterEach(async(): Promise<void> => {
|
||||
jest.clearAllMocks();
|
||||
});
|
||||
|
||||
it('returns parsed results.', async(): Promise<void> => {
|
||||
const argv = [ 'node', 'script', '-b', 'http://localhost:3000/', '-p', '3000' ];
|
||||
await expect(extractor.handle(argv)).resolves.toEqual(expect.objectContaining({
|
||||
baseUrl: 'http://localhost:3000/',
|
||||
port: 3000,
|
||||
}));
|
||||
});
|
||||
|
||||
it('accepts full flags.', async(): Promise<void> => {
|
||||
const argv = [ 'node', 'script', '--baseUrl', 'http://localhost:3000/', '--port', '3000' ];
|
||||
await expect(extractor.handle(argv)).resolves.toEqual(expect.objectContaining({
|
||||
baseUrl: 'http://localhost:3000/',
|
||||
port: 3000,
|
||||
}));
|
||||
});
|
||||
|
||||
it('defaults to no parameters if none are provided.', async(): Promise<void> => {
|
||||
extractor = new YargsCliExtractor();
|
||||
const argv = [ 'node', 'script', '-b', 'http://localhost:3000/', '-p', '3000' ];
|
||||
await expect(extractor.handle(argv)).resolves.toEqual(expect.objectContaining({}));
|
||||
});
|
||||
|
||||
it('prints usage if defined.', async(): Promise<void> => {
|
||||
extractor = new YargsCliExtractor(parameters, { usage: 'node ./bin/server.js [args]' });
|
||||
const argv = [ 'node', 'script', '--help' ];
|
||||
await extractor.handle(argv);
|
||||
expect(exit).toHaveBeenCalledTimes(1);
|
||||
expect(log).toHaveBeenCalledTimes(1);
|
||||
expect(log).toHaveBeenLastCalledWith(expect.stringMatching(/^node \.\/bin\/server\.js \[args\]/u));
|
||||
});
|
||||
|
||||
it('can error on undefined parameters.', async(): Promise<void> => {
|
||||
extractor = new YargsCliExtractor(parameters, { strictMode: true });
|
||||
const argv = [ 'node', 'script', '--unsupported' ];
|
||||
await extractor.handle(argv);
|
||||
expect(exit).toHaveBeenCalledTimes(1);
|
||||
expect(error).toHaveBeenCalledWith('Unknown argument: unsupported');
|
||||
});
|
||||
|
||||
it('can parse environment variables.', async(): Promise<void> => {
|
||||
// While the code below does go into the corresponding values,
|
||||
// yargs does not see the new environment variable for some reason.
|
||||
// It does see all the env variables that were already in there
|
||||
// (which can be tested by setting envVarPrefix to '').
|
||||
// This can probably be fixed by changing jest setup to already load the custom env before loading the tests,
|
||||
// but does not seem worth it just for this test.
|
||||
const { env } = process;
|
||||
// eslint-disable-next-line @typescript-eslint/naming-convention
|
||||
process.env = { ...env, TEST_ENV_PORT: '3333' };
|
||||
extractor = new YargsCliExtractor(parameters, { loadFromEnv: true, envVarPrefix: 'TEST_ENV' });
|
||||
const argv = [ 'node', 'script', '-b', 'http://localhost:3333/' ];
|
||||
await expect(extractor.handle(argv)).resolves.toEqual(expect.objectContaining({
|
||||
baseUrl: 'http://localhost:3333/',
|
||||
}));
|
||||
process.env = env;
|
||||
|
||||
// This part is here for the case of envVarPrefix being defined
|
||||
// since it doesn't make much sense to test it if the above doesn't work
|
||||
extractor = new YargsCliExtractor(parameters, { loadFromEnv: true });
|
||||
await extractor.handle(argv);
|
||||
});
|
||||
});
|
||||
38
test/unit/init/variables/CombinedSettingsResolver.test.ts
Normal file
38
test/unit/init/variables/CombinedSettingsResolver.test.ts
Normal file
@@ -0,0 +1,38 @@
|
||||
import { CombinedSettingsResolver } from '../../../../src/init/variables/CombinedSettingsResolver';
|
||||
import type { SettingsExtractor } from '../../../../src/init/variables/extractors/SettingsExtractor';
|
||||
|
||||
describe('A CombinedSettingsResolver', (): void => {
|
||||
const values = { test: 'data' };
|
||||
const varPort = 'urn:solid-server:default:variable:port';
|
||||
const varLog = 'urn:solid-server:default:variable:loggingLevel';
|
||||
let computerPort: jest.Mocked<SettingsExtractor>;
|
||||
let computerLog: jest.Mocked<SettingsExtractor>;
|
||||
let resolver: CombinedSettingsResolver;
|
||||
|
||||
beforeEach(async(): Promise<void> => {
|
||||
computerPort = {
|
||||
handleSafe: jest.fn().mockResolvedValue(3000),
|
||||
} as any;
|
||||
|
||||
computerLog = {
|
||||
handleSafe: jest.fn().mockResolvedValue('info'),
|
||||
} as any;
|
||||
|
||||
resolver = new CombinedSettingsResolver({
|
||||
[varPort]: computerPort,
|
||||
[varLog]: computerLog,
|
||||
});
|
||||
});
|
||||
|
||||
it('assigns variable values based on the Computers output.', async(): Promise<void> => {
|
||||
await expect(resolver.handle(values)).resolves.toEqual({
|
||||
[varPort]: 3000,
|
||||
[varLog]: 'info',
|
||||
});
|
||||
});
|
||||
|
||||
it('rethrows the error if something goes wrong.', async(): Promise<void> => {
|
||||
computerPort.handleSafe.mockRejectedValueOnce(new Error('bad data'));
|
||||
await expect(resolver.handle(values)).rejects.toThrow(`Error in computing value for variable ${varPort}: bad data`);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,28 @@
|
||||
import { AssetPathExtractor } from '../../../../../src/init/variables/extractors/AssetPathExtractor';
|
||||
import { joinFilePath } from '../../../../../src/util/PathUtil';
|
||||
|
||||
describe('An AssetPathExtractor', (): void => {
|
||||
let resolver: AssetPathExtractor;
|
||||
|
||||
beforeEach(async(): Promise<void> => {
|
||||
resolver = new AssetPathExtractor('path');
|
||||
});
|
||||
|
||||
it('resolves the asset path.', async(): Promise<void> => {
|
||||
await expect(resolver.handle({ path: '/var/data' })).resolves.toBe('/var/data');
|
||||
});
|
||||
|
||||
it('errors if the path is not a string.', async(): Promise<void> => {
|
||||
await expect(resolver.handle({ path: 1234 })).rejects.toThrow('Invalid path argument');
|
||||
});
|
||||
|
||||
it('converts paths containing the module path placeholder.', async(): Promise<void> => {
|
||||
await expect(resolver.handle({ path: '@css:config/file.json' }))
|
||||
.resolves.toEqual(joinFilePath(__dirname, '../../../../../config/file.json'));
|
||||
});
|
||||
|
||||
it('defaults to the given path if none is provided.', async(): Promise<void> => {
|
||||
resolver = new AssetPathExtractor('path', '/root');
|
||||
await expect(resolver.handle({ otherPath: '/var/data' })).resolves.toBe('/root');
|
||||
});
|
||||
});
|
||||
22
test/unit/init/variables/extractors/BaseUrlExtractor.test.ts
Normal file
22
test/unit/init/variables/extractors/BaseUrlExtractor.test.ts
Normal file
@@ -0,0 +1,22 @@
|
||||
import { BaseUrlExtractor } from '../../../../../src/init/variables/extractors/BaseUrlExtractor';
|
||||
|
||||
describe('A BaseUrlExtractor', (): void => {
|
||||
let computer: BaseUrlExtractor;
|
||||
|
||||
beforeEach(async(): Promise<void> => {
|
||||
computer = new BaseUrlExtractor();
|
||||
});
|
||||
|
||||
it('extracts the baseUrl parameter.', async(): Promise<void> => {
|
||||
await expect(computer.handle({ baseUrl: 'http://example.com/', port: 3333 }))
|
||||
.resolves.toBe('http://example.com/');
|
||||
});
|
||||
|
||||
it('uses the port parameter if baseUrl is not defined.', async(): Promise<void> => {
|
||||
await expect(computer.handle({ port: 3333 })).resolves.toBe('http://localhost:3333/');
|
||||
});
|
||||
|
||||
it('defaults to port 3000.', async(): Promise<void> => {
|
||||
await expect(computer.handle({})).resolves.toBe('http://localhost:3000/');
|
||||
});
|
||||
});
|
||||
19
test/unit/init/variables/extractors/KeyExtractor.test.ts
Normal file
19
test/unit/init/variables/extractors/KeyExtractor.test.ts
Normal file
@@ -0,0 +1,19 @@
|
||||
import { KeyExtractor } from '../../../../../src/init/variables/extractors/KeyExtractor';
|
||||
|
||||
describe('An KeyExtractor', (): void => {
|
||||
const key = 'test';
|
||||
let extractor: KeyExtractor;
|
||||
|
||||
beforeEach(async(): Promise<void> => {
|
||||
extractor = new KeyExtractor(key);
|
||||
});
|
||||
|
||||
it('extracts the value.', async(): Promise<void> => {
|
||||
await expect(extractor.handle({ test: 'data', notTest: 'notData' })).resolves.toBe('data');
|
||||
});
|
||||
|
||||
it('defaults to a given value if none is defined.', async(): Promise<void> => {
|
||||
extractor = new KeyExtractor(key, 'defaultData');
|
||||
await expect(extractor.handle({ notTest: 'notData' })).resolves.toBe('defaultData');
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user