mirror of
https://gitlab.com/openstapps/openstapps.git
synced 2026-01-19 16:13:06 +00:00
feat: modernize core-tools
This commit is contained in:
Wieland Schöbl
347
src/cli.ts
347
src/cli.ts
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (C) 2018-2019 StApps
|
||||
* Copyright (C) 2018-2021 StApps
|
||||
* This program is free software: you can redistribute it and/or modify it
|
||||
* under the terms of the GNU General Public License as published by the Free
|
||||
* Software Foundation, version 3.
|
||||
@@ -16,27 +16,16 @@ import {Logger} from '@openstapps/logger';
|
||||
import {Command} from 'commander';
|
||||
import {existsSync, readFileSync, writeFileSync} from 'fs';
|
||||
import {copy} from 'fs-extra';
|
||||
import got from 'got';
|
||||
import {join, relative, resolve} from 'path';
|
||||
import {exit} from 'process';
|
||||
import {
|
||||
capitalize,
|
||||
getProjectReflection,
|
||||
mkdirPromisified,
|
||||
readFilePromisified,
|
||||
toArray,
|
||||
} from './common';
|
||||
import {generateTemplate} from './mapping';
|
||||
import path from 'path';
|
||||
import {mkdirPromisified, readFilePromisified} from './common';
|
||||
import {lightweightDefinitionsFromPath, lightweightProjectFromPath} from './easy-ast/easy-ast';
|
||||
import {pack} from './pack';
|
||||
import {openapi3Template} from './resources/openapi-303-template';
|
||||
import {
|
||||
gatherRouteInformation,
|
||||
generateOpenAPIForRoute,
|
||||
} from './routes';
|
||||
import {Converter, getValidatableTypesFromReflection} from './schema';
|
||||
import {gatherRouteInformation, generateOpenAPIForRoute} from './routes';
|
||||
import {Converter, getValidatableTypesInPath} from './schema';
|
||||
import {createDiagram, createDiagramFromString} from './uml/create-diagram';
|
||||
import {readDefinitions} from './uml/read-definitions';
|
||||
import {UMLConfig} from './uml/uml-config';
|
||||
import {capitalize} from './util/string';
|
||||
import {validateFiles, writeReport} from './validate';
|
||||
|
||||
// handle unhandled promise rejections
|
||||
@@ -50,35 +39,41 @@ process.on('unhandledRejection', async (reason: unknown) => {
|
||||
|
||||
const commander = new Command('openstapps-core-tools');
|
||||
|
||||
commander
|
||||
.version(JSON.parse(
|
||||
readFileSync(resolve(__dirname, '..', 'package.json'))
|
||||
.toString(),
|
||||
).version);
|
||||
// eslint-disable-next-line unicorn/prefer-module
|
||||
commander.version(JSON.parse(readFileSync(path.resolve(__dirname, '..', 'package.json')).toString()).version);
|
||||
|
||||
commander.command('prototype <srcBundle> <out>').action(async (sourcePath, out) => {
|
||||
const files = lightweightProjectFromPath(sourcePath);
|
||||
writeFileSync(path.resolve(out), JSON.stringify(files, undefined, 2));
|
||||
});
|
||||
|
||||
commander
|
||||
.command('openapi <srcPath> <outDirPath>')
|
||||
.action(async (relativeSrcPath, relativeOutDirPath) => {
|
||||
.action(async (relativeSourceBundlePath, relativeOutDirectoryPath) => {
|
||||
// get absolute paths
|
||||
const srcPath = resolve(relativeSrcPath);
|
||||
const outDirPath = resolve(relativeOutDirPath);
|
||||
const outDirSchemasPath = join(outDirPath, 'schemas');
|
||||
|
||||
// get project reflection
|
||||
const projectReflection = getProjectReflection(srcPath);
|
||||
const sourcePath = path.resolve(relativeSourceBundlePath);
|
||||
const outDirectoryPath = path.resolve(relativeOutDirectoryPath);
|
||||
const outDirectorySchemasPath = path.join(outDirectoryPath, 'schemas');
|
||||
|
||||
// get information about routes
|
||||
const routes = await gatherRouteInformation(projectReflection);
|
||||
const routes = await gatherRouteInformation(sourcePath);
|
||||
routes.sort((a, b) => a.route.urlFragment.localeCompare(b.route.urlFragment));
|
||||
|
||||
// change url path parameters to openapi notation
|
||||
routes.forEach((routeWithMetaInformation) => {
|
||||
routeWithMetaInformation.route.urlFragment = routeWithMetaInformation.route.urlFragment.replace(/:\w+/g, (match) => `{${match.replace(':','')}}`);
|
||||
});
|
||||
for (const routeWithMetaInformation of routes) {
|
||||
routeWithMetaInformation.route.urlFragment = routeWithMetaInformation.route.urlFragment.replace(
|
||||
/:\w+/g,
|
||||
(match: string) => `{${match.replace(':', '')}}`,
|
||||
);
|
||||
}
|
||||
|
||||
// keep openapi tags for routes that actually share url fragments
|
||||
let tagsToKeep = routes.map((routeWithMetaInformation) => capitalize(routeWithMetaInformation.route.urlFragment.split('/')[1]));
|
||||
tagsToKeep = tagsToKeep.filter((element, i, array) => array.indexOf(element) === i && array.lastIndexOf(element) !== i);
|
||||
let tagsToKeep = routes.map(routeWithMetaInformation =>
|
||||
capitalize(routeWithMetaInformation.route.urlFragment.split('/')[1]),
|
||||
);
|
||||
tagsToKeep = tagsToKeep.filter(
|
||||
(element, i, array) => array.indexOf(element) === i && array.lastIndexOf(element) !== i,
|
||||
);
|
||||
|
||||
// initialize json output
|
||||
const output = openapi3Template;
|
||||
@@ -87,194 +82,99 @@ commander
|
||||
const schemasToCopy: string[] = [];
|
||||
|
||||
// generate documentation for all routes
|
||||
routes.forEach((routeWithMetaInformation) => {
|
||||
for (const routeWithMetaInformation of routes) {
|
||||
routeWithMetaInformation.tags = [capitalize(routeWithMetaInformation.route.urlFragment.split('/')[1])];
|
||||
|
||||
output.paths[routeWithMetaInformation.route.urlFragment] = generateOpenAPIForRoute(
|
||||
routeWithMetaInformation,
|
||||
relative(relativeOutDirPath,outDirSchemasPath),
|
||||
path.relative(relativeOutDirectoryPath, outDirectorySchemasPath),
|
||||
schemasToCopy,
|
||||
tagsToKeep,
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
// copy schema json schema files
|
||||
try {
|
||||
if (!existsSync(outDirSchemasPath)){
|
||||
await mkdirPromisified(outDirSchemasPath, {
|
||||
if (!existsSync(outDirectorySchemasPath)) {
|
||||
await mkdirPromisified(outDirectorySchemasPath, {
|
||||
recursive: true,
|
||||
});
|
||||
}
|
||||
for (const fileName of schemasToCopy) {
|
||||
await copy(join(srcPath, 'schema', `${fileName}.json`), join(outDirSchemasPath, `${fileName}.json`));
|
||||
await copy(
|
||||
path.join(sourcePath, 'schema', `${fileName}.json`),
|
||||
path.join(outDirectorySchemasPath, `${fileName}.json`),
|
||||
);
|
||||
}
|
||||
} catch (error) {
|
||||
await Logger.error(error);
|
||||
// tslint:disable-next-line: no-magic-numbers
|
||||
process.exit(-2);
|
||||
}
|
||||
|
||||
// write openapi object to file (prettified)
|
||||
// tslint:disable-next-line: no-magic-numbers
|
||||
writeFileSync(join(outDirPath, 'openapi.json'), JSON.stringify(output, null, 2));
|
||||
writeFileSync(path.join(outDirectoryPath, 'openapi.json'), JSON.stringify(output, undefined, 2));
|
||||
|
||||
Logger.ok(`OpenAPI representation resources written to ${outDirPath} .`);
|
||||
Logger.ok(`OpenAPI representation resources written to ${outDirectoryPath} .`);
|
||||
});
|
||||
|
||||
commander
|
||||
.command('mapping <relativeSrcPath>')
|
||||
.option('-m, --mappingPath <relativeMappingPath>', 'Mapping Path')
|
||||
.option('-i, --ignoredTags <ignoredTags>', 'Ignored Tags (comma-separated)')
|
||||
.option('-a, --aggPath <relativeAggregationPath>', 'Aggregations Path')
|
||||
.option('-e, --errorPath <relativeErrorPath>', 'Error Path')
|
||||
.action(async (relativeSrcPath, options) => {
|
||||
// get absolute paths
|
||||
const srcPath = resolve(relativeSrcPath);
|
||||
commander.command('schema <srcPath> <schemaPath>').action(async (relativeSourcePath, relativeSchemaPath) => {
|
||||
// get absolute paths
|
||||
const absoluteSourcePath = path.resolve(relativeSourcePath);
|
||||
const schemaPath = path.resolve(relativeSchemaPath);
|
||||
|
||||
let ignoredTagsList: string[] = [];
|
||||
if (typeof options.ignoredTags === 'string') {
|
||||
ignoredTagsList = options.ignoredTags.split(',');
|
||||
}
|
||||
// initialize new core converter
|
||||
const coreConverter = new Converter(absoluteSourcePath);
|
||||
|
||||
// get project reflection
|
||||
const projectReflection = getProjectReflection(srcPath);
|
||||
// get validatable types
|
||||
const validatableTypes = getValidatableTypesInPath(absoluteSourcePath);
|
||||
|
||||
const result = generateTemplate(projectReflection, ignoredTagsList, true);
|
||||
if (result.errors.length !== 0) {
|
||||
await Logger.error('Mapping generated with errors!');
|
||||
} else {
|
||||
Logger.ok('Mapping generated without errors!');
|
||||
}
|
||||
Logger.info(`Found ${validatableTypes.length} type(s) to generate schemas for.`);
|
||||
|
||||
// write documentation to file
|
||||
if (typeof options.aggPath !== 'undefined') {
|
||||
const aggPath = resolve(options.aggPath);
|
||||
// tslint:disable-next-line:no-magic-numbers
|
||||
writeFileSync(aggPath, JSON.stringify(result.aggregations, null, 2));
|
||||
Logger.ok(`Elasticsearch aggregations written to ${aggPath}.`);
|
||||
}
|
||||
if (typeof options.mappingPath !== 'undefined') {
|
||||
const mappingPath = resolve(options.mappingPath);
|
||||
// tslint:disable-next-line:no-magic-numbers
|
||||
writeFileSync(mappingPath, JSON.stringify(result.mappings, null, 2));
|
||||
Logger.ok(`Elasticsearch mappings written to ${mappingPath}.`);
|
||||
}
|
||||
if (typeof options.errorPath !== 'undefined') {
|
||||
const errPath = resolve(options.errorPath);
|
||||
// tslint:disable-next-line:no-magic-numbers
|
||||
writeFileSync(errPath, JSON.stringify(result.errors, null, 2));
|
||||
Logger.ok(`Mapping errors written to ${errPath}.`);
|
||||
}
|
||||
await mkdirPromisified(schemaPath, {
|
||||
recursive: true,
|
||||
});
|
||||
|
||||
commander
|
||||
.command('put-es-templates <srcPath> <esAddress> [ignoredTags]')
|
||||
.action(async (relativeSrcPath, esAddress, ignoredTags) => {
|
||||
// get absolute paths
|
||||
const srcPath = resolve(relativeSrcPath);
|
||||
Logger.info(`Trying to find a package.json for ${absoluteSourcePath}.`);
|
||||
|
||||
let ignoredTagsList: string[] = [];
|
||||
if (typeof ignoredTags === 'string') {
|
||||
ignoredTagsList = ignoredTags.split(',');
|
||||
}
|
||||
let packagePath = absoluteSourcePath;
|
||||
// TODO: this check should be less ugly! --- What is this doing anyway?
|
||||
while (!existsSync(path.join(packagePath, 'package.json')) && packagePath.length > 5) {
|
||||
packagePath = path.resolve(packagePath, '..');
|
||||
}
|
||||
|
||||
// get project reflection
|
||||
const projectReflection = getProjectReflection(srcPath);
|
||||
const corePackageJsonPath = path.join(packagePath, 'package.json');
|
||||
|
||||
const result = generateTemplate(projectReflection, ignoredTagsList, true);
|
||||
if (result.errors.length !== 0) {
|
||||
await Logger.error(`Mapping generated with errors:\n${JSON.stringify(result.errors)}`);
|
||||
exit(-1);
|
||||
} else {
|
||||
Logger.ok('Mapping generated without errors!');
|
||||
}
|
||||
Logger.info(`Using ${corePackageJsonPath} to determine version for schemas.`);
|
||||
|
||||
for (const template in result.mappings) {
|
||||
if (!result.mappings.hasOwnProperty(template)) {
|
||||
continue;
|
||||
}
|
||||
const buffer = await readFilePromisified(corePackageJsonPath);
|
||||
const corePackageJson = JSON.parse(buffer.toString());
|
||||
const coreVersion = corePackageJson.version;
|
||||
|
||||
const response = await got.put(`${esAddress}_template/${template}`, {
|
||||
json: result.mappings[template],
|
||||
});
|
||||
Logger.log(`Using ${coreVersion} as version for schemas.`);
|
||||
|
||||
const HTTP_STATUS_OK = 200;
|
||||
if (response.statusCode !== HTTP_STATUS_OK) {
|
||||
await Logger.error(`Template for "${template}" failed in Elasticsearch:\n${JSON.stringify(response.body)}`);
|
||||
exit(-1);
|
||||
}
|
||||
}
|
||||
// generate and write JSONSchema files for validatable types
|
||||
for (const type of validatableTypes) {
|
||||
const schema = coreConverter.getSchema(type, coreVersion);
|
||||
|
||||
Logger.ok(`Templates accepted by Elasticsearch.`);
|
||||
});
|
||||
const stringifiedSchema = JSON.stringify(schema, undefined, 2);
|
||||
|
||||
commander
|
||||
.command('schema <srcPath> <schemaPath>')
|
||||
.action(async (relativeSrcPath, relativeSchemaPath) => {
|
||||
// get absolute paths
|
||||
const srcPath = resolve(relativeSrcPath);
|
||||
const schemaPath = resolve(relativeSchemaPath);
|
||||
const file = path.join(schemaPath, `${type}.json`);
|
||||
|
||||
// initialize new core converter
|
||||
const coreConverter = new Converter(srcPath);
|
||||
// write schema to file
|
||||
writeFileSync(file, stringifiedSchema);
|
||||
|
||||
// get project reflection
|
||||
const projectReflection = getProjectReflection(srcPath);
|
||||
Logger.info(`Generated schema for ${type} and saved to ${file}.`);
|
||||
}
|
||||
|
||||
// get validatable types
|
||||
const validatableTypes = getValidatableTypesFromReflection(
|
||||
projectReflection,
|
||||
);
|
||||
|
||||
Logger.info(`Found ${validatableTypes.length} type(s) to generate schemas for.`);
|
||||
|
||||
await mkdirPromisified(schemaPath, {
|
||||
recursive: true,
|
||||
});
|
||||
|
||||
Logger.info(`Trying to find a package.json for ${srcPath}.`);
|
||||
|
||||
let path = srcPath;
|
||||
// TODO: this check should be less ugly! --- What is this doing anyway?
|
||||
// tslint:disable-next-line:no-magic-numbers
|
||||
while (!existsSync(join(path, 'package.json')) && path.length > 5) {
|
||||
path = resolve(path, '..');
|
||||
}
|
||||
|
||||
const corePackageJsonPath = join(path, 'package.json');
|
||||
|
||||
Logger.info(`Using ${corePackageJsonPath} to determine version for schemas.`);
|
||||
|
||||
const buffer = await readFilePromisified(corePackageJsonPath);
|
||||
const corePackageJson = JSON.parse(buffer.toString());
|
||||
const coreVersion = corePackageJson.version;
|
||||
|
||||
Logger.log(`Using ${coreVersion} as version for schemas.`);
|
||||
|
||||
// generate and write JSONSchema files for validatable types
|
||||
validatableTypes.forEach((type) => {
|
||||
const schema = coreConverter.getSchema(type, coreVersion);
|
||||
|
||||
// tslint:disable-next-line:no-magic-numbers
|
||||
const stringifiedSchema = JSON.stringify(schema, null, 2);
|
||||
|
||||
const file = join(schemaPath, `${type}.json`);
|
||||
|
||||
// write schema to file
|
||||
writeFileSync(file, stringifiedSchema);
|
||||
|
||||
Logger.info(`Generated schema for ${type} and saved to ${file}.`);
|
||||
});
|
||||
|
||||
Logger.ok(`Generated schemas for ${validatableTypes.length} type(s).`);
|
||||
});
|
||||
Logger.ok(`Generated schemas for ${validatableTypes.length} type(s).`);
|
||||
});
|
||||
|
||||
commander
|
||||
.command('validate <schemaPath> <testPath> [reportPath]')
|
||||
.action(async (relativeSchemaPath, relativeTestPath, relativeReportPath) => {
|
||||
// get absolute paths
|
||||
const schemaPath = resolve(relativeSchemaPath);
|
||||
const testPath = resolve(relativeTestPath);
|
||||
const schemaPath = path.resolve(relativeSchemaPath);
|
||||
const testPath = path.resolve(relativeTestPath);
|
||||
|
||||
const errorsPerFile = await validateFiles(schemaPath, testPath);
|
||||
|
||||
@@ -284,11 +184,11 @@ commander
|
||||
continue;
|
||||
}
|
||||
|
||||
unexpected = unexpected || errorsPerFile[file].some((error) => !error.expected);
|
||||
unexpected = unexpected || errorsPerFile[file].some(error => !error.expected);
|
||||
}
|
||||
|
||||
if (typeof relativeReportPath !== 'undefined') {
|
||||
const reportPath = resolve(relativeReportPath);
|
||||
const reportPath = path.resolve(relativeReportPath);
|
||||
await writeReport(reportPath, errorsPerFile);
|
||||
}
|
||||
|
||||
@@ -300,70 +200,34 @@ commander
|
||||
}
|
||||
});
|
||||
|
||||
commander
|
||||
.command('pack')
|
||||
.action(async () => {
|
||||
await pack();
|
||||
});
|
||||
commander.command('pack').action(async () => {
|
||||
await pack();
|
||||
});
|
||||
|
||||
commander
|
||||
.command('plantuml <srcPath> <plantumlserver>')
|
||||
.option(
|
||||
'--definitions <definitions>',
|
||||
'Shows these specific definitions (class, interface or enum)',
|
||||
toArray,
|
||||
.option('--definitions <definitions>', 'Shows these specific definitions (class, interface or enum)', it =>
|
||||
it.split(','),
|
||||
)
|
||||
.option('--showAssociations', 'Shows associations of definitions')
|
||||
.option(
|
||||
'--showInheritance',
|
||||
'Shows extensions and implementations of definitions',
|
||||
)
|
||||
.option('--showInheritance', 'Shows extensions and implementations of definitions')
|
||||
.option('--showEnumValues', 'Show enum values')
|
||||
.option('--showProperties', 'Show attributes')
|
||||
.option(
|
||||
'--showInheritedProperties',
|
||||
'Shows inherited attributes, needs --showProperties',
|
||||
)
|
||||
.option(
|
||||
'--showOptionalProperties',
|
||||
'Shows optional attributes and relations, needs --showProperties',
|
||||
)
|
||||
.option(
|
||||
'--excludeExternals',
|
||||
'Exclude external definitions',
|
||||
)
|
||||
.option(
|
||||
'--outputFileName <fileName>',
|
||||
'Defines the filename of the output',
|
||||
)
|
||||
.action(async (relativeSrcPath, plantumlserver, options) => {
|
||||
.option('--showInheritedProperties', 'Shows inherited attributes, needs --showProperties')
|
||||
.option('--showOptionalProperties', 'Shows optional attributes and relations, needs --showProperties')
|
||||
.option('--excludeExternals', 'Exclude external definitions')
|
||||
.option('--outputFileName <fileName>', 'Defines the filename of the output')
|
||||
.action(async (relativeSourcePath, plantumlServer, options) => {
|
||||
const plantUmlConfig: UMLConfig = {
|
||||
definitions:
|
||||
typeof options.definitions !== 'undefined' ? options.definitions : [],
|
||||
showAssociations:
|
||||
typeof options.showAssociations !== 'undefined'
|
||||
? options.showAssociations
|
||||
: false,
|
||||
showEnumValues:
|
||||
typeof options.showEnumValues !== 'undefined'
|
||||
? options.showEnumValues
|
||||
: false,
|
||||
showInheritance:
|
||||
typeof options.showInheritance !== 'undefined'
|
||||
? options.showInheritance
|
||||
: false,
|
||||
definitions: typeof options.definitions !== 'undefined' ? options.definitions : [],
|
||||
showAssociations: typeof options.showAssociations !== 'undefined' ? options.showAssociations : false,
|
||||
showEnumValues: typeof options.showEnumValues !== 'undefined' ? options.showEnumValues : false,
|
||||
showInheritance: typeof options.showInheritance !== 'undefined' ? options.showInheritance : false,
|
||||
showInheritedProperties:
|
||||
typeof options.showInheritedProperties !== 'undefined'
|
||||
? options.showInheritedProperties
|
||||
: false,
|
||||
typeof options.showInheritedProperties !== 'undefined' ? options.showInheritedProperties : false,
|
||||
showOptionalProperties:
|
||||
typeof options.showOptionalProperties !== 'undefined'
|
||||
? options.showOptionalProperties
|
||||
: false,
|
||||
showProperties:
|
||||
typeof options.showProperties !== 'undefined'
|
||||
? options.showProperties
|
||||
: false,
|
||||
typeof options.showOptionalProperties !== 'undefined' ? options.showOptionalProperties : false,
|
||||
showProperties: typeof options.showProperties !== 'undefined' ? options.showProperties : false,
|
||||
};
|
||||
if (typeof options.outputFileName !== 'undefined') {
|
||||
plantUmlConfig.outputFileName = options.outputFileName;
|
||||
@@ -371,21 +235,14 @@ commander
|
||||
|
||||
Logger.log(`PlantUML options: ${JSON.stringify(plantUmlConfig)}`);
|
||||
|
||||
const srcPath = resolve(relativeSrcPath);
|
||||
|
||||
const projectReflection = getProjectReflection(srcPath, !options.excludeExternals ? false : true);
|
||||
|
||||
const definitions = readDefinitions(projectReflection);
|
||||
|
||||
await createDiagram(definitions, plantUmlConfig, plantumlserver);
|
||||
await createDiagram(lightweightDefinitionsFromPath(relativeSourcePath), plantUmlConfig, plantumlServer);
|
||||
});
|
||||
|
||||
commander
|
||||
.command('plantuml-file <inputFile> <plantumlserver> [outputFile]')
|
||||
.action(async (file: string, plantumlserver: string, outputFile: string) => {
|
||||
const fileContent = readFileSync(resolve(file))
|
||||
.toString();
|
||||
await createDiagramFromString(fileContent, plantumlserver, outputFile);
|
||||
.action(async (file: string, plantumlServer: string, outputFile: string) => {
|
||||
const fileContent = readFileSync(path.resolve(file)).toString();
|
||||
await createDiagramFromString(fileContent, plantumlServer, outputFile);
|
||||
});
|
||||
|
||||
commander.parse(process.argv);
|
||||
|
||||
Reference in New Issue
Block a user