mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
feat: Expose AppRunner.run for easily serving from JS apps
* feat: make methods in CliRunner public * change: rename CliRunner to AppRunner * fix: process being passed incorrectly to runCli * feat: expose AppRunner.run for easily serving from JS apps * change: only make run methods on AppRunner public
This commit is contained in:
parent
f4a09a414d
commit
d1eadd75e7
@ -1,4 +1,4 @@
|
|||||||
#!/usr/bin/env node
|
#!/usr/bin/env node
|
||||||
// eslint-disable-next-line @typescript-eslint/naming-convention
|
// eslint-disable-next-line @typescript-eslint/naming-convention
|
||||||
const { CliRunner } = require('..');
|
const { AppRunner } = require('..');
|
||||||
new CliRunner(process).run();
|
new AppRunner().runCli(process);
|
||||||
|
@ -17,7 +17,7 @@ export * from './authorization/WebAclAuthorizer';
|
|||||||
|
|
||||||
// Init
|
// Init
|
||||||
export * from './init/AclInitializer';
|
export * from './init/AclInitializer';
|
||||||
export * from './init/CliRunner';
|
export * from './init/AppRunner';
|
||||||
export * from './init/ConfigPodInitializer';
|
export * from './init/ConfigPodInitializer';
|
||||||
export * from './init/Initializer';
|
export * from './init/Initializer';
|
||||||
export * from './init/LoggerInitializer';
|
export * from './init/LoggerInitializer';
|
||||||
|
@ -8,16 +8,32 @@ import { getLoggerFor } from '../logging/LogUtil';
|
|||||||
import { absoluteFilePath, ensureTrailingSlash, joinFilePath } from '../util/PathUtil';
|
import { absoluteFilePath, ensureTrailingSlash, joinFilePath } from '../util/PathUtil';
|
||||||
import type { Initializer } from './Initializer';
|
import type { Initializer } from './Initializer';
|
||||||
|
|
||||||
export class CliRunner {
|
export class AppRunner {
|
||||||
private readonly logger = getLoggerFor(this);
|
private readonly logger = getLoggerFor(this);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Generic run function for starting the server from a given config
|
* Generic run function for starting the server from JavaScript for a given config.
|
||||||
|
* @param loaderProperties - Components.js loader properties.
|
||||||
|
* @param configFile - Path to the server config file.
|
||||||
|
* @param variableParams - Variables to pass into the config file.
|
||||||
|
*/
|
||||||
|
public async run(
|
||||||
|
loaderProperties: IComponentsManagerBuilderOptions<Initializer>,
|
||||||
|
configFile: string,
|
||||||
|
variableParams: ConfigVariables,
|
||||||
|
): Promise<void> {
|
||||||
|
const variables = this.createVariables(variableParams);
|
||||||
|
const initializer = await this.createInitializer(loaderProperties, configFile, variables);
|
||||||
|
await initializer.handleSafe();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Generic run function for starting the server on the CLI from a given config
|
||||||
* Made run to be non-async to lower the chance of unhandled promise rejection errors in the future.
|
* Made run to be non-async to lower the chance of unhandled promise rejection errors in the future.
|
||||||
* @param args - Command line arguments.
|
* @param args - Command line arguments.
|
||||||
* @param stderr - Standard error stream.
|
* @param stderr - Standard error stream.
|
||||||
*/
|
*/
|
||||||
public run({
|
public runCli({
|
||||||
argv = process.argv,
|
argv = process.argv,
|
||||||
stderr = process.stderr,
|
stderr = process.stderr,
|
||||||
}: {
|
}: {
|
||||||
@ -103,7 +119,7 @@ export class CliRunner {
|
|||||||
/**
|
/**
|
||||||
* Translates command-line parameters into configuration variables
|
* Translates command-line parameters into configuration variables
|
||||||
*/
|
*/
|
||||||
protected createVariables(params: Record<string, any>): Record<string, any> {
|
protected createVariables(params: ConfigVariables): Record<string, any> {
|
||||||
return {
|
return {
|
||||||
'urn:solid-server:default:variable:baseUrl':
|
'urn:solid-server:default:variable:baseUrl':
|
||||||
params.baseUrl ? ensureTrailingSlash(params.baseUrl) : `http://localhost:${params.port}/`,
|
params.baseUrl ? ensureTrailingSlash(params.baseUrl) : `http://localhost:${params.port}/`,
|
||||||
@ -132,3 +148,12 @@ export class CliRunner {
|
|||||||
return await componentsManager.instantiate(initializer, { variables });
|
return await componentsManager.instantiate(initializer, { variables });
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface ConfigVariables {
|
||||||
|
loggingLevel: string;
|
||||||
|
port: number;
|
||||||
|
baseUrl?: string;
|
||||||
|
rootFilePath?: string;
|
||||||
|
sparqlEndpoint?: string;
|
||||||
|
podConfigJson?: string;
|
||||||
|
}
|
355
test/unit/init/AppRunner.test.ts
Normal file
355
test/unit/init/AppRunner.test.ts
Normal file
@ -0,0 +1,355 @@
|
|||||||
|
import { ComponentsManager } from 'componentsjs';
|
||||||
|
import { AppRunner } from '../../../src/init/AppRunner';
|
||||||
|
import type { Initializer } from '../../../src/init/Initializer';
|
||||||
|
import { joinFilePath } from '../../../src/util/PathUtil';
|
||||||
|
|
||||||
|
const initializer: jest.Mocked<Initializer> = {
|
||||||
|
handleSafe: jest.fn(),
|
||||||
|
} as any;
|
||||||
|
|
||||||
|
const manager: jest.Mocked<ComponentsManager<Initializer>> = {
|
||||||
|
instantiate: jest.fn(async(): Promise<Initializer> => initializer),
|
||||||
|
configRegistry: {
|
||||||
|
register: jest.fn(),
|
||||||
|
},
|
||||||
|
} as any;
|
||||||
|
|
||||||
|
jest.mock('componentsjs', (): any => ({
|
||||||
|
// eslint-disable-next-line @typescript-eslint/naming-convention
|
||||||
|
ComponentsManager: {
|
||||||
|
build: jest.fn(async(): Promise<ComponentsManager<Initializer>> => manager),
|
||||||
|
},
|
||||||
|
}));
|
||||||
|
|
||||||
|
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);
|
||||||
|
|
||||||
|
describe('AppRunner', (): void => {
|
||||||
|
afterEach((): void => {
|
||||||
|
jest.clearAllMocks();
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('run', (): void => {
|
||||||
|
it('starts the server with default settings.', async(): Promise<void> => {
|
||||||
|
await new AppRunner().run(
|
||||||
|
{
|
||||||
|
mainModulePath: joinFilePath(__dirname, '../../../'),
|
||||||
|
dumpErrorState: true,
|
||||||
|
logLevel: 'info',
|
||||||
|
},
|
||||||
|
joinFilePath(__dirname, '../../../config/config-default.json'),
|
||||||
|
{
|
||||||
|
port: 3000,
|
||||||
|
loggingLevel: 'info',
|
||||||
|
rootFilePath: '/var/cwd/',
|
||||||
|
podConfigJson: '/var/cwd/pod-config.json',
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
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/config-default.json'));
|
||||||
|
expect(manager.instantiate).toHaveBeenCalledTimes(1);
|
||||||
|
expect(manager.instantiate).toHaveBeenCalledWith(
|
||||||
|
'urn:solid-server:default:Initializer',
|
||||||
|
{
|
||||||
|
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:podConfigJson': '/var/cwd/pod-config.json',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
);
|
||||||
|
expect(initializer.handleSafe).toHaveBeenCalledTimes(1);
|
||||||
|
expect(initializer.handleSafe).toHaveBeenCalledWith();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('runCli', (): void => {
|
||||||
|
it('starts the server with default settings.', async(): Promise<void> => {
|
||||||
|
new AppRunner().runCli({
|
||||||
|
argv: [ 'node', 'script' ],
|
||||||
|
});
|
||||||
|
|
||||||
|
// Wait until initializer 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: 'info',
|
||||||
|
mainModulePath: joinFilePath(__dirname, '../../../'),
|
||||||
|
});
|
||||||
|
expect(manager.configRegistry.register).toHaveBeenCalledTimes(1);
|
||||||
|
expect(manager.configRegistry.register)
|
||||||
|
.toHaveBeenCalledWith(joinFilePath(__dirname, '/../../../config/config-default.json'));
|
||||||
|
expect(manager.instantiate).toHaveBeenCalledTimes(1);
|
||||||
|
expect(manager.instantiate).toHaveBeenCalledWith(
|
||||||
|
'urn:solid-server:default:Initializer',
|
||||||
|
{
|
||||||
|
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:podConfigJson': '/var/cwd/pod-config.json',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
);
|
||||||
|
expect(initializer.handleSafe).toHaveBeenCalledTimes(1);
|
||||||
|
expect(initializer.handleSafe).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',
|
||||||
|
'--podConfigJson', '/different-path.json',
|
||||||
|
],
|
||||||
|
});
|
||||||
|
|
||||||
|
// Wait until initializer 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:Initializer',
|
||||||
|
{
|
||||||
|
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: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',
|
||||||
|
'--podConfigJson', '/different-path.json',
|
||||||
|
],
|
||||||
|
});
|
||||||
|
|
||||||
|
// Wait until initializer 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:Initializer',
|
||||||
|
{
|
||||||
|
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:podConfigJson': '/different-path.json',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('uses the default process.argv in case none are provided.', async(): Promise<void> => {
|
||||||
|
const { argv } = process;
|
||||||
|
process.argv = [
|
||||||
|
'node', 'script',
|
||||||
|
'-b', 'http://pod.example/',
|
||||||
|
'-c', 'myconfig.json',
|
||||||
|
'-f', '/root',
|
||||||
|
'-l', 'debug',
|
||||||
|
'-m', 'module/path',
|
||||||
|
'-p', '4000',
|
||||||
|
'-s', 'http://localhost:5000/sparql',
|
||||||
|
'--podConfigJson', '/different-path.json',
|
||||||
|
];
|
||||||
|
|
||||||
|
new AppRunner().runCli();
|
||||||
|
|
||||||
|
// Wait until initializer 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:Initializer',
|
||||||
|
{
|
||||||
|
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:podConfigJson': '/different-path.json',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
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' ],
|
||||||
|
});
|
||||||
|
|
||||||
|
// Wait until initializer has been called, because we can't await AppRunner.run.
|
||||||
|
await new Promise((resolve): void => {
|
||||||
|
setImmediate(resolve);
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(write).toHaveBeenCalledTimes(2);
|
||||||
|
expect(write).toHaveBeenNthCalledWith(1,
|
||||||
|
expect.stringMatching(/^Error: could not instantiate server from .*config-default\.json/u));
|
||||||
|
expect(write).toHaveBeenNthCalledWith(2,
|
||||||
|
expect.stringMatching(/^Error: Fatal/u));
|
||||||
|
|
||||||
|
expect(exit).toHaveBeenCalledTimes(1);
|
||||||
|
expect(exit).toHaveBeenCalledWith(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('exits without output to stderr when initialization fails.', async(): Promise<void> => {
|
||||||
|
initializer.handleSafe.mockRejectedValueOnce(new Error('Fatal'));
|
||||||
|
new AppRunner().runCli({
|
||||||
|
argv: [ 'node', 'script' ],
|
||||||
|
});
|
||||||
|
|
||||||
|
// Wait until initializer has been called, because we can't await AppRunner.run.
|
||||||
|
await new Promise((resolve): void => {
|
||||||
|
setImmediate(resolve);
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(write).toHaveBeenCalledTimes(0);
|
||||||
|
|
||||||
|
expect(exit).toHaveBeenCalledWith(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('exits when unknown options are passed to the main executable.', async(): Promise<void> => {
|
||||||
|
new AppRunner().runCli({
|
||||||
|
argv: [
|
||||||
|
'node', 'script', '--foo',
|
||||||
|
],
|
||||||
|
});
|
||||||
|
|
||||||
|
// Wait until initializer has been called, because we can't await AppRunner.run.
|
||||||
|
await new Promise((resolve): void => {
|
||||||
|
setImmediate(resolve);
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(error).toHaveBeenCalledWith('Unknown option: "foo"');
|
||||||
|
expect(exit).toHaveBeenCalledTimes(1);
|
||||||
|
expect(exit).toHaveBeenCalledWith(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('exits when no value is passed to the main executable for an argument.', async(): Promise<void> => {
|
||||||
|
new AppRunner().runCli({
|
||||||
|
argv: [
|
||||||
|
'node', 'script', '-s',
|
||||||
|
],
|
||||||
|
});
|
||||||
|
|
||||||
|
// Wait until initializer has been called, because we can't await AppRunner.run.
|
||||||
|
await new Promise((resolve): void => {
|
||||||
|
setImmediate(resolve);
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(error).toHaveBeenCalledWith('Missing value for argument "s"');
|
||||||
|
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 initializer has been called, because we can't await AppRunner.run.
|
||||||
|
await new Promise((resolve): void => {
|
||||||
|
setImmediate(resolve);
|
||||||
|
});
|
||||||
|
|
||||||
|
// There seems to be an issue with yargs where the first and last `"` are missing.
|
||||||
|
expect(error).toHaveBeenCalledWith('Unsupported 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', '-ll',
|
||||||
|
],
|
||||||
|
});
|
||||||
|
|
||||||
|
// Wait until initializer 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,info]');
|
||||||
|
expect(exit).toHaveBeenCalledTimes(1);
|
||||||
|
expect(exit).toHaveBeenCalledWith(1);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
@ -1,308 +0,0 @@
|
|||||||
import { ComponentsManager } from 'componentsjs';
|
|
||||||
import { CliRunner } from '../../../src/init/CliRunner';
|
|
||||||
import type { Initializer } from '../../../src/init/Initializer';
|
|
||||||
import { joinFilePath } from '../../../src/util/PathUtil';
|
|
||||||
|
|
||||||
const initializer: jest.Mocked<Initializer> = {
|
|
||||||
handleSafe: jest.fn(),
|
|
||||||
} as any;
|
|
||||||
|
|
||||||
const manager: jest.Mocked<ComponentsManager<Initializer>> = {
|
|
||||||
instantiate: jest.fn(async(): Promise<Initializer> => initializer),
|
|
||||||
configRegistry: {
|
|
||||||
register: jest.fn(),
|
|
||||||
},
|
|
||||||
} as any;
|
|
||||||
|
|
||||||
jest.mock('componentsjs', (): any => ({
|
|
||||||
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
||||||
ComponentsManager: {
|
|
||||||
build: jest.fn(async(): Promise<ComponentsManager<Initializer>> => manager),
|
|
||||||
},
|
|
||||||
}));
|
|
||||||
|
|
||||||
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);
|
|
||||||
|
|
||||||
describe('CliRunner', (): void => {
|
|
||||||
afterEach((): void => {
|
|
||||||
jest.clearAllMocks();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('starts the server with default settings.', async(): Promise<void> => {
|
|
||||||
new CliRunner().run({
|
|
||||||
argv: [ 'node', 'script' ],
|
|
||||||
});
|
|
||||||
|
|
||||||
// Wait until initializer has been called, because we can't await CliRunner.run.
|
|
||||||
await new Promise((resolve): void => {
|
|
||||||
setImmediate(resolve);
|
|
||||||
});
|
|
||||||
|
|
||||||
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/config-default.json'));
|
|
||||||
expect(manager.instantiate).toHaveBeenCalledTimes(1);
|
|
||||||
expect(manager.instantiate).toHaveBeenCalledWith(
|
|
||||||
'urn:solid-server:default:Initializer',
|
|
||||||
{
|
|
||||||
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:podConfigJson': '/var/cwd/pod-config.json',
|
|
||||||
},
|
|
||||||
},
|
|
||||||
);
|
|
||||||
expect(initializer.handleSafe).toHaveBeenCalledTimes(1);
|
|
||||||
expect(initializer.handleSafe).toHaveBeenCalledWith();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('accepts abbreviated flags.', async(): Promise<void> => {
|
|
||||||
new CliRunner().run({
|
|
||||||
argv: [
|
|
||||||
'node', 'script',
|
|
||||||
'-b', 'http://pod.example/',
|
|
||||||
'-c', 'myconfig.json',
|
|
||||||
'-f', '/root',
|
|
||||||
'-l', 'debug',
|
|
||||||
'-m', 'module/path',
|
|
||||||
'-p', '4000',
|
|
||||||
'-s', 'http://localhost:5000/sparql',
|
|
||||||
'--podConfigJson', '/different-path.json',
|
|
||||||
],
|
|
||||||
});
|
|
||||||
|
|
||||||
// Wait until initializer has been called, because we can't await CliRunner.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:Initializer',
|
|
||||||
{
|
|
||||||
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:podConfigJson': '/different-path.json',
|
|
||||||
},
|
|
||||||
},
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('accepts full flags.', async(): Promise<void> => {
|
|
||||||
new CliRunner().run({
|
|
||||||
argv: [
|
|
||||||
'node', 'script',
|
|
||||||
'--baseUrl', 'http://pod.example/',
|
|
||||||
'--config', 'myconfig.json',
|
|
||||||
'--loggingLevel', 'debug',
|
|
||||||
'--mainModulePath', 'module/path',
|
|
||||||
'--port', '4000',
|
|
||||||
'--rootFilePath', 'root',
|
|
||||||
'--sparqlEndpoint', 'http://localhost:5000/sparql',
|
|
||||||
'--podConfigJson', '/different-path.json',
|
|
||||||
],
|
|
||||||
});
|
|
||||||
|
|
||||||
// Wait until initializer has been called, because we can't await CliRunner.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:Initializer',
|
|
||||||
{
|
|
||||||
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:podConfigJson': '/different-path.json',
|
|
||||||
},
|
|
||||||
},
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('uses the default process.argv in case none are provided.', async(): Promise<void> => {
|
|
||||||
const { argv } = process;
|
|
||||||
process.argv = [
|
|
||||||
'node', 'script',
|
|
||||||
'-b', 'http://pod.example/',
|
|
||||||
'-c', 'myconfig.json',
|
|
||||||
'-f', '/root',
|
|
||||||
'-l', 'debug',
|
|
||||||
'-m', 'module/path',
|
|
||||||
'-p', '4000',
|
|
||||||
'-s', 'http://localhost:5000/sparql',
|
|
||||||
'--podConfigJson', '/different-path.json',
|
|
||||||
];
|
|
||||||
|
|
||||||
new CliRunner().run();
|
|
||||||
|
|
||||||
// Wait until initializer has been called, because we can't await CliRunner.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:Initializer',
|
|
||||||
{
|
|
||||||
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:podConfigJson': '/different-path.json',
|
|
||||||
},
|
|
||||||
},
|
|
||||||
);
|
|
||||||
|
|
||||||
process.argv = argv;
|
|
||||||
});
|
|
||||||
|
|
||||||
it('exits with output to stderr when instantiation fails.', async(): Promise<void> => {
|
|
||||||
manager.instantiate.mockRejectedValueOnce(new Error('Fatal'));
|
|
||||||
new CliRunner().run({
|
|
||||||
argv: [ 'node', 'script' ],
|
|
||||||
});
|
|
||||||
|
|
||||||
// Wait until initializer has been called, because we can't await CliRunner.run.
|
|
||||||
await new Promise((resolve): void => {
|
|
||||||
setImmediate(resolve);
|
|
||||||
});
|
|
||||||
|
|
||||||
expect(write).toHaveBeenCalledTimes(2);
|
|
||||||
expect(write).toHaveBeenNthCalledWith(1,
|
|
||||||
expect.stringMatching(/^Error: could not instantiate server from .*config-default\.json/u));
|
|
||||||
expect(write).toHaveBeenNthCalledWith(2,
|
|
||||||
expect.stringMatching(/^Error: Fatal/u));
|
|
||||||
|
|
||||||
expect(exit).toHaveBeenCalledTimes(1);
|
|
||||||
expect(exit).toHaveBeenCalledWith(1);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('exits without output to stderr when initialization fails.', async(): Promise<void> => {
|
|
||||||
initializer.handleSafe.mockRejectedValueOnce(new Error('Fatal'));
|
|
||||||
new CliRunner().run({
|
|
||||||
argv: [ 'node', 'script' ],
|
|
||||||
});
|
|
||||||
|
|
||||||
// Wait until initializer has been called, because we can't await CliRunner.run.
|
|
||||||
await new Promise((resolve): void => {
|
|
||||||
setImmediate(resolve);
|
|
||||||
});
|
|
||||||
|
|
||||||
expect(write).toHaveBeenCalledTimes(0);
|
|
||||||
|
|
||||||
expect(exit).toHaveBeenCalledWith(1);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('exits when unknown options are passed to the main executable.', async(): Promise<void> => {
|
|
||||||
new CliRunner().run({
|
|
||||||
argv: [
|
|
||||||
'node', 'script', '--foo',
|
|
||||||
],
|
|
||||||
});
|
|
||||||
|
|
||||||
// Wait until initializer has been called, because we can't await CliRunner.run.
|
|
||||||
await new Promise((resolve): void => {
|
|
||||||
setImmediate(resolve);
|
|
||||||
});
|
|
||||||
|
|
||||||
expect(error).toHaveBeenCalledWith('Unknown option: "foo"');
|
|
||||||
expect(exit).toHaveBeenCalledTimes(1);
|
|
||||||
expect(exit).toHaveBeenCalledWith(1);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('exits when no value is passed to the main executable for an argument.', async(): Promise<void> => {
|
|
||||||
new CliRunner().run({
|
|
||||||
argv: [
|
|
||||||
'node', 'script', '-s',
|
|
||||||
],
|
|
||||||
});
|
|
||||||
|
|
||||||
// Wait until initializer has been called, because we can't await CliRunner.run.
|
|
||||||
await new Promise((resolve): void => {
|
|
||||||
setImmediate(resolve);
|
|
||||||
});
|
|
||||||
|
|
||||||
expect(error).toHaveBeenCalledWith('Missing value for argument "s"');
|
|
||||||
expect(exit).toHaveBeenCalledTimes(1);
|
|
||||||
expect(exit).toHaveBeenCalledWith(1);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('exits when unknown parameters are passed to the main executable.', async(): Promise<void> => {
|
|
||||||
new CliRunner().run({
|
|
||||||
argv: [
|
|
||||||
'node', 'script', 'foo', 'bar', 'foo.txt', 'bar.txt',
|
|
||||||
],
|
|
||||||
});
|
|
||||||
|
|
||||||
// Wait until initializer has been called, because we can't await CliRunner.run.
|
|
||||||
await new Promise((resolve): void => {
|
|
||||||
setImmediate(resolve);
|
|
||||||
});
|
|
||||||
|
|
||||||
// There seems to be an issue with yargs where the first and last `"` are missing.
|
|
||||||
expect(error).toHaveBeenCalledWith('Unsupported 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 CliRunner().run({
|
|
||||||
argv: [
|
|
||||||
'node', 'script', '-ll',
|
|
||||||
],
|
|
||||||
});
|
|
||||||
|
|
||||||
// Wait until initializer has been called, because we can't await CliRunner.run.
|
|
||||||
await new Promise((resolve): void => {
|
|
||||||
setImmediate(resolve);
|
|
||||||
});
|
|
||||||
|
|
||||||
expect(error).toHaveBeenCalledWith('Multiple values were provided for: "l", [info,info]');
|
|
||||||
expect(exit).toHaveBeenCalledTimes(1);
|
|
||||||
expect(exit).toHaveBeenCalledWith(1);
|
|
||||||
});
|
|
||||||
});
|
|
Loading…
x
Reference in New Issue
Block a user