mirror of
https://github.com/balena-io/balena-cli.git
synced 2024-12-19 21:57:51 +00:00
64a44e7a5f
- Add fleet(s) commands and -f, --fleet flags as aliases to the app(s) commands and -a, --app, --application flags. - Conditionally rename column/row headers and JSON object properties from 'application' to 'fleet', with some variations. - Print warning messages regarding the renaming, provided that stderr is attached to an interactive terminal. Change-type: minor Resolves: #2302
116 lines
3.1 KiB
TypeScript
116 lines
3.1 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2016-2020 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 type { flags } from '@oclif/command';
|
|
import type { Output as ParserOutput } from '@oclif/parser';
|
|
|
|
import Command from '../../command';
|
|
import * as cf from '../../utils/common-flags';
|
|
import * as ca from '../../utils/common-args';
|
|
import { getBalenaSdk, stripIndent } from '../../utils/lazy';
|
|
import {
|
|
applicationIdInfo,
|
|
appToFleetCmdMsg,
|
|
warnify,
|
|
} from '../../utils/messages';
|
|
|
|
interface FlagsDef {
|
|
help: void;
|
|
}
|
|
|
|
interface ArgsDef {
|
|
fleet: string;
|
|
}
|
|
|
|
export class FleetPurgeCmd extends Command {
|
|
public static description = stripIndent`
|
|
Purge data from a fleet.
|
|
|
|
Purge data from all devices belonging to a fleet.
|
|
This will clear the fleet's '/data' directory.
|
|
|
|
${applicationIdInfo.split('\n').join('\n\t\t')}
|
|
`;
|
|
|
|
public static examples = [
|
|
'$ balena fleet purge MyFleet',
|
|
'$ balena fleet purge myorg/myfleet',
|
|
];
|
|
|
|
public static args = [ca.fleetRequired];
|
|
|
|
public static usage = 'fleet purge <fleet>';
|
|
|
|
public static flags: flags.Input<FlagsDef> = {
|
|
help: cf.help,
|
|
};
|
|
|
|
public static authenticated = true;
|
|
|
|
public async run(parserOutput?: ParserOutput<FlagsDef, ArgsDef>) {
|
|
const { args: params } =
|
|
parserOutput || this.parse<FlagsDef, ArgsDef>(FleetPurgeCmd);
|
|
|
|
const { getApplication } = await import('../../utils/sdk');
|
|
|
|
const balena = getBalenaSdk();
|
|
|
|
// balena.models.application.purge only accepts a numeric id
|
|
// so we must first fetch the app to get it's id,
|
|
const application = await getApplication(balena, params.fleet);
|
|
|
|
try {
|
|
await balena.models.application.purge(application.id);
|
|
} catch (e) {
|
|
if (e.message.toLowerCase().includes('no online device(s) found')) {
|
|
// application.purge throws an error if no devices are online
|
|
// ignore in this case.
|
|
} else {
|
|
throw e;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
export default class AppPurgeCmd extends FleetPurgeCmd {
|
|
public static description = stripIndent`
|
|
DEPRECATED alias for the 'fleet purge' command
|
|
|
|
${appToFleetCmdMsg
|
|
.split('\n')
|
|
.map((l) => `\t\t${l}`)
|
|
.join('\n')}
|
|
|
|
For command usage, see 'balena help fleet purge'
|
|
`;
|
|
public static examples = [];
|
|
public static usage = 'app purge <fleet>';
|
|
public static args = FleetPurgeCmd.args;
|
|
public static flags = FleetPurgeCmd.flags;
|
|
public static authenticated = FleetPurgeCmd.authenticated;
|
|
public static primary = FleetPurgeCmd.primary;
|
|
|
|
public async run() {
|
|
// call this.parse() before deprecation message to parse '-h'
|
|
const parserOutput = this.parse<FlagsDef, ArgsDef>(AppPurgeCmd);
|
|
if (process.stderr.isTTY) {
|
|
console.error(warnify(appToFleetCmdMsg));
|
|
}
|
|
await super.run(parserOutput);
|
|
}
|
|
}
|