2019-08-28 18:51:56 +00:00
|
|
|
/**
|
|
|
|
* @license
|
|
|
|
* Copyright 2019 Balena Ltd.
|
|
|
|
*
|
|
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
* you may not use this file except in compliance with the License.
|
|
|
|
* You may obtain a copy of the License at
|
|
|
|
*
|
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
*
|
|
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
* See the License for the specific language governing permissions and
|
|
|
|
* limitations under the License.
|
|
|
|
*/
|
|
|
|
import { stripIndent } from 'common-tags';
|
|
|
|
|
2020-04-30 08:45:16 +00:00
|
|
|
import { exitWithExpectedError } from './errors';
|
2019-08-28 18:51:56 +00:00
|
|
|
|
|
|
|
export interface AppOptions {
|
2020-01-03 18:37:55 +00:00
|
|
|
// Prevent the default behavior of flushing stdout after running a command
|
2019-08-28 18:51:56 +00:00
|
|
|
noFlush?: boolean;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Simple command-line pre-parsing to choose between oclif or Capitano.
|
|
|
|
* @param argv process.argv
|
|
|
|
*/
|
|
|
|
export async function routeCliFramework(argv: string[], options: AppOptions) {
|
|
|
|
if (process.env.DEBUG) {
|
|
|
|
console.log(
|
2020-01-20 21:21:05 +00:00
|
|
|
`[debug] original argv0="${process.argv0}" argv=[${argv}] length=${argv.length}`,
|
2019-08-28 18:51:56 +00:00
|
|
|
);
|
|
|
|
}
|
|
|
|
const cmdSlice = argv.slice(2);
|
|
|
|
|
|
|
|
// Look for commands that have been removed and if so, exit with a notice
|
|
|
|
checkDeletedCommand(cmdSlice);
|
|
|
|
|
|
|
|
if (cmdSlice.length > 0) {
|
|
|
|
// convert 'balena --version' or 'balena -v' to 'balena version'
|
|
|
|
if (['--version', '-v'].includes(cmdSlice[0])) {
|
|
|
|
cmdSlice[0] = 'version';
|
|
|
|
}
|
|
|
|
// convert 'balena --help' or 'balena -h' to 'balena help'
|
|
|
|
else if (['--help', '-h'].includes(cmdSlice[0])) {
|
|
|
|
cmdSlice[0] = 'help';
|
|
|
|
}
|
|
|
|
// convert e.g. 'balena help env add' to 'balena env add --help'
|
|
|
|
if (cmdSlice.length > 1 && cmdSlice[0] === 'help') {
|
|
|
|
cmdSlice.shift();
|
|
|
|
cmdSlice.push('--help');
|
|
|
|
}
|
2020-04-29 10:58:52 +00:00
|
|
|
|
|
|
|
// support global --debug flag
|
|
|
|
const debugIndex = cmdSlice.indexOf('--debug');
|
|
|
|
if (debugIndex > -1) {
|
|
|
|
process.env.DEBUG = '1';
|
|
|
|
cmdSlice.splice(debugIndex, 1);
|
|
|
|
}
|
2019-08-28 18:51:56 +00:00
|
|
|
}
|
|
|
|
|
2020-05-01 11:18:11 +00:00
|
|
|
const Logger = await import('./utils/logger');
|
|
|
|
Logger.command = cmdSlice[0];
|
|
|
|
|
2019-08-28 18:51:56 +00:00
|
|
|
const [isOclif, isTopic] = isOclifCommand(cmdSlice);
|
|
|
|
|
|
|
|
if (isOclif) {
|
|
|
|
let oclifArgs = cmdSlice;
|
|
|
|
if (isTopic) {
|
|
|
|
// convert space-separated commands to oclif's topic:command syntax
|
|
|
|
oclifArgs = [cmdSlice[0] + ':' + cmdSlice[1], ...cmdSlice.slice(2)];
|
2020-05-01 11:18:11 +00:00
|
|
|
Logger.command = `${cmdSlice[0]} ${cmdSlice[1]}`;
|
2019-08-28 18:51:56 +00:00
|
|
|
}
|
|
|
|
if (process.env.DEBUG) {
|
|
|
|
console.log(
|
|
|
|
`[debug] new argv=[${[
|
|
|
|
argv[0],
|
|
|
|
argv[1],
|
|
|
|
...oclifArgs,
|
|
|
|
]}] length=${oclifArgs.length + 2}`,
|
|
|
|
);
|
|
|
|
}
|
|
|
|
await (await import('./app-oclif')).run(oclifArgs, options);
|
|
|
|
} else {
|
|
|
|
await (await import('./app-capitano')).run(argv);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Check whether the command line refers to a command that has been deprecated
|
|
|
|
* and removed and, if so, exit with an informative error message.
|
|
|
|
* @param argvSlice process.argv.slice(2)
|
|
|
|
*/
|
|
|
|
function checkDeletedCommand(argvSlice: string[]): void {
|
|
|
|
if (argvSlice[0] === 'help') {
|
|
|
|
argvSlice = argvSlice.slice(1);
|
|
|
|
}
|
|
|
|
function replaced(
|
|
|
|
oldCmd: string,
|
|
|
|
alternative: string,
|
|
|
|
version: string,
|
|
|
|
verb = 'replaced',
|
|
|
|
) {
|
|
|
|
exitWithExpectedError(stripIndent`
|
|
|
|
Note: the command "balena ${oldCmd}" was ${verb} in CLI version ${version}.
|
|
|
|
Please use "balena ${alternative}" instead.
|
|
|
|
`);
|
|
|
|
}
|
|
|
|
function removed(oldCmd: string, alternative: string, version: string) {
|
|
|
|
let msg = `Note: the command "balena ${oldCmd}" was removed in CLI version ${version}.`;
|
|
|
|
if (alternative) {
|
|
|
|
msg = [msg, alternative].join('\n');
|
|
|
|
}
|
|
|
|
exitWithExpectedError(msg);
|
|
|
|
}
|
|
|
|
const stopAlternative =
|
|
|
|
'Please use "balena ssh -s" to access the host OS, then use `balena-engine stop`.';
|
|
|
|
const cmds: { [cmd: string]: [(...args: any) => void, ...string[]] } = {
|
|
|
|
sync: [replaced, 'push', 'v11.0.0', 'removed'],
|
|
|
|
'local logs': [replaced, 'logs', 'v11.0.0'],
|
|
|
|
'local push': [replaced, 'push', 'v11.0.0'],
|
|
|
|
'local scan': [replaced, 'scan', 'v11.0.0'],
|
|
|
|
'local ssh': [replaced, 'ssh', 'v11.0.0'],
|
|
|
|
'local stop': [removed, stopAlternative, 'v11.0.0'],
|
|
|
|
};
|
|
|
|
let cmd: string | undefined;
|
|
|
|
if (argvSlice.length > 1) {
|
|
|
|
cmd = [argvSlice[0], argvSlice[1]].join(' ');
|
|
|
|
} else if (argvSlice.length > 0) {
|
|
|
|
cmd = argvSlice[0];
|
|
|
|
}
|
|
|
|
if (cmd && Object.getOwnPropertyNames(cmds).includes(cmd)) {
|
|
|
|
cmds[cmd][0](cmd, ...cmds[cmd].slice(1));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-09-06 13:43:53 +00:00
|
|
|
export const convertedCommands = [
|
2020-04-22 16:08:11 +00:00
|
|
|
'app',
|
|
|
|
'app:create',
|
|
|
|
'app:restart',
|
|
|
|
'app:rm',
|
|
|
|
'apps',
|
2020-04-22 11:47:12 +00:00
|
|
|
'api-key:generate',
|
2019-12-26 22:59:44 +00:00
|
|
|
'devices:supported',
|
2019-09-06 13:43:53 +00:00
|
|
|
'envs',
|
|
|
|
'env:add',
|
|
|
|
'env:rename',
|
|
|
|
'env:rm',
|
2020-04-02 13:26:52 +00:00
|
|
|
'internal:scandevices',
|
|
|
|
'internal:osinit',
|
2020-04-09 14:34:24 +00:00
|
|
|
'join',
|
2020-04-17 13:19:33 +00:00
|
|
|
'keys',
|
|
|
|
'key',
|
|
|
|
'key:add',
|
|
|
|
'key:rm',
|
2020-04-09 14:34:24 +00:00
|
|
|
'leave',
|
2020-03-25 17:07:17 +00:00
|
|
|
'note',
|
2019-10-31 01:46:14 +00:00
|
|
|
'os:configure',
|
2020-03-24 10:44:32 +00:00
|
|
|
'settings',
|
2020-03-25 17:07:17 +00:00
|
|
|
'version',
|
2020-03-13 11:32:29 +00:00
|
|
|
'scan',
|
2019-09-06 13:43:53 +00:00
|
|
|
];
|
2019-08-28 18:51:56 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Determine whether the CLI command has been converted from Capitano to oclif.
|
|
|
|
* Return an array of two boolean values:
|
|
|
|
* r[0] : whether the CLI command is implemented with oclif
|
|
|
|
* r[1] : if r[0] is true, whether the CLI command is implemented with
|
|
|
|
* oclif "topics" (colon-separated subcommands like `env:add`)
|
|
|
|
* @param argvSlice process.argv.slice(2)
|
|
|
|
*/
|
|
|
|
function isOclifCommand(argvSlice: string[]): [boolean, boolean] {
|
|
|
|
// Look for commands that have been transitioned to oclif
|
|
|
|
// const { convertedCommands } = require('oclif/utils/command');
|
|
|
|
const arg0 = argvSlice.length > 0 ? argvSlice[0] : '';
|
|
|
|
const arg1 = argvSlice.length > 1 ? argvSlice[1] : '';
|
|
|
|
|
|
|
|
if (convertedCommands.includes(`${arg0}:${arg1}`)) {
|
|
|
|
return [true, true];
|
|
|
|
}
|
|
|
|
if (convertedCommands.includes(arg0)) {
|
|
|
|
return [true, false];
|
|
|
|
}
|
|
|
|
return [false, false];
|
|
|
|
}
|