ExternalVendorCode/balena-cli
1
0
Fork 0
mirror of https://github.com/balena-io/balena-cli.git synced 2025-01-30 16:13:59 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #1953 from balena-io/convert-os-build-config

Browse Source 
Convert `os build-config` to oclif, typescript
This commit is contained in:
bulldozer-balena[bot] 2020-07-28 16:06:36 +00:00 committed by GitHub
commit 4e37ce14c6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 150 additions and 105 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
automation/capitanodoc/capitanodoc.ts
View File

@ -118,7 +118,7 @@ const capitanoDoc = {
{
title: 'OS',
files: [
'build/actions/os.js',
'build/actions-oclif/os/build-config.js',
'build/actions-oclif/os/configure.js',
'build/actions-oclif/os/versions.js',
'build/actions-oclif/os/download.js',

21
doc/cli.markdown
View File

@ -1585,22 +1585,33 @@ or 'menu' (will show the interactive menu)
## os build-config <image> <device-type>
Use this command to prebuild the OS config once and skip the interactive part of `balena os configure`.
Interactively generate an OS config once, so that the generated config
file can be used in `balena os configure`, skipping the interactive part.
Example:
Examples:
$ balena os build-config ../path/rpi3.img raspberrypi3 --output rpi3-config.json
$ balena os configure ../path/rpi3.img --device 7cf02a6 --config rpi3-config.json
### Arguments
#### IMAGE
os image
#### DEVICE-TYPE
device type
### Options
#### --advanced, -v
#### -v, --advanced
show advanced configuration options
#### --output, -o <output>
#### -o, --output OUTPUT
the path to the output JSON file
path to output JSON file
## os configure IMAGE

130
lib/actions-oclif/os/build-config.ts Normal file
View File

@ -0,0 +1,130 @@
/**
* @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 { flags } from '@oclif/command';
import Command from '../../command';
import * as cf from '../../utils/common-flags';
import { getCliForm, stripIndent } from '../../utils/lazy';
import * as _ from 'lodash';
import type { DeviceType } from 'balena-sdk';
interface FlagsDef {
advanced: boolean;
output: string;
help: void;
}
interface ArgsDef {
image: string;
'device-type': string;
}
export default class OsBuildConfigCmd extends Command {
public static description = stripIndent`
Build an OS config and save it to a JSON file.
Interactively generate an OS config once, so that the generated config
file can be used in \`balena os configure\`, skipping the interactive part.
`;
public static examples = [
'$ balena os build-config ../path/rpi3.img raspberrypi3 --output rpi3-config.json',
'$ balena os configure ../path/rpi3.img --device 7cf02a6 --config rpi3-config.json',
];
public static args = [
{
name: 'image',
description: 'os image',
required: true,
},
{
name: 'device-type',
description: 'device type',
required: true,
},
];
public static usage = 'os build-config <image> <device-type>';
public static flags: flags.Input<FlagsDef> = {
advanced: flags.boolean({
description: 'show advanced configuration options',
char: 'v',
}),
output: flags.string({
description: 'path to output JSON file',
char: 'o',
required: true,
}),
help: cf.help,
};
public static authenticated = true;
public async run() {
const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
OsBuildConfigCmd,
);
const { writeFile } = (await import('fs')).promises;
const config = await this.buildConfig(
params.image,
params['device-type'],
options.advanced,
);
await writeFile(options.output, JSON.stringify(config, null, 4));
console.info(`Config file ${params.image} created successfully.`);
}
async buildConfig(image: string, deviceTypeSlug: string, advanced: boolean) {
advanced = advanced || false;
const { getManifest } = await import('../../utils/helpers');
const deviceTypeManifest = await getManifest(image, deviceTypeSlug);
await this.buildConfigForDeviceType(deviceTypeManifest, advanced);
}
async buildConfigForDeviceType(
deviceTypeManifest: DeviceType,
advanced: boolean,
) {
if (advanced == null) {
advanced = false;
}
let override;
const questions = deviceTypeManifest.options;
if (!advanced) {
const advancedGroup = _.find(questions, {
name: 'advanced',
isGroup: true,
});
if (advancedGroup != null) {
const { getGroupDefaults } = await import('../../utils/helpers');
override = getGroupDefaults(advancedGroup);
}
}
return getCliForm().run(questions, { override });
}
}

3
lib/actions/index.ts
View File

@ -16,11 +16,8 @@ limitations under the License.
export * as config from './config';
export * as help from './help';
export * as os from './os';
export * as push from './push';
export { build } from './build';
export { deploy } from './deploy';
export { preload } from './preload';

91
lib/actions/os.js
View File

@ -1,91 +0,0 @@
/*
Copyright 2016-2020 Balena
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 * as commandOptions from './command-options';
import * as _ from 'lodash';
import { getCliForm } from '../utils/lazy';
const buildConfigForDeviceType = function (deviceType, advanced) {
if (advanced == null) {
advanced = false;
}
const helpers = require('../utils/helpers');
let override;
const questions = deviceType.options;
if (!advanced) {
const advancedGroup = _.find(questions, {
name: 'advanced',
isGroup: true,
});
if (advancedGroup != null) {
override = helpers.getGroupDefaults(advancedGroup);
}
}
return getCliForm().run(questions, { override });
};
const $buildConfig = function (image, deviceTypeSlug, advanced) {
if (advanced == null) {
advanced = false;
}
const Bluebird = require('bluebird');
const helpers = require('../utils/helpers');
return Bluebird.resolve(
helpers.getManifest(image, deviceTypeSlug),
).then((deviceTypeManifest) =>
buildConfigForDeviceType(deviceTypeManifest, advanced),
);
};
export const buildConfig = {
signature: 'os build-config <image> <device-type>',
description: 'build the OS config and save it to the JSON file',
help: `\
Use this command to prebuild the OS config once and skip the interactive part of \`balena os configure\`.
Example:
$ balena os build-config ../path/rpi3.img raspberrypi3 --output rpi3-config.json
$ balena os configure ../path/rpi3.img --device 7cf02a6 --config rpi3-config.json\
`,
permission: 'user',
options: [
commandOptions.advancedConfig,
{
signature: 'output',
description: 'the path to the output JSON file',
alias: 'o',
required: 'the output path is required',
parameter: 'output',
},
],
action(params, options) {
return $buildConfig(
params.image,
params['device-type'],
options.advanced,
).then((answers) =>
require('fs').promises.writeFile(
options.output,
JSON.stringify(answers, null, 4),
),
);
},
};

3
lib/app-capitano.ts
View File

@ -46,9 +46,6 @@ capitano.globalOption({
// ---------- Help Module ----------
capitano.command(actions.help.help);
// ---------- OS Module ----------
capitano.command(actions.os.buildConfig);
// ---------- Config Module ----------
capitano.command(actions.config.read);
capitano.command(actions.config.write);

1
lib/preparser.ts
View File

@ -179,6 +179,7 @@ export const convertedCommands = [
'logout',
'logs',
'note',
'os:build-config',
'os:configure',
'os:versions',
'os:download',

2
lib/utils/helpers.ts
View File

@ -28,7 +28,7 @@ import { promisify } from 'util';
import { isOclifCommand } from '../preparser';
export function getGroupDefaults(group: {
options: Array<{ name: string; default?: string }>;
options: Array<{ name: string; default: string | number }>;
}): { [name: string]: string | number | undefined } {
return _.chain(group)
.get('options')

2
tests/commands/help.spec.ts
View File

@ -79,7 +79,7 @@ Additional commands:
local flash <image> flash an image to a drive
logout logout from balena
note <|note> set a device note
os build-config <image> <device-type> build the OS config and save it to the JSON file
os build-config <image> <device-type> build an OS config and save it to a JSON file
os configure <image> configure a previously downloaded balenaOS image
os download <type> download an unconfigured OS image
os initialize <image> initialize an os image for a device