balena-cli/lib/actions/environment-variables.ts

/*
Copyright 2016-2017 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 { CommandDefinition } from 'capitano';

import * as commandOptions from './command-options';
import { normalizeUuidProp } from '../utils/normalization';

export const list: CommandDefinition<
	{},
	{
		application?: string;
		device?: string;
		verbose: boolean;
	}
> = {
	signature: 'envs',
	description: 'list all environment variables',
	help: `\
Use this command to list all environment variables for
a particular application or device.

This command lists all custom environment variables.
If you want to see all environment variables, including private
ones used by balena, use the verbose option.

At the moment the CLI doesn't fully support multi-container applications,
so the following commands will only show service variables,
without showing which service they belong to.

Example:

	$ balena envs --application MyApp
	$ balena envs --application MyApp --verbose
	$ balena envs --device 7cf02a6\
`,
	options: [
		commandOptions.optionalApplication,
		commandOptions.optionalDevice,

		{
			signature: 'verbose',
			description: 'show private environment variables',
			boolean: true,
			alias: 'v',
		},
	],
	permission: 'user',
	async action(_params, options, done) {
		normalizeUuidProp(options, 'device');
		const Bluebird = await import('bluebird');
		const _ = await import('lodash');
		const balena = require('resin-sdk-preconfigured');
		const visuals = await import('resin-cli-visuals');

		const { exitWithExpectedError } = await import('../utils/patterns');

		return Bluebird.try(function() {
			if (options.application != null) {
				return balena.models.environmentVariables.getAllByApplication(
					options.application,
				);
			} else if (options.device != null) {
				return balena.models.environmentVariables.device.getAll(options.device);
			} else {
				exitWithExpectedError('You must specify an application or device');
			}
		})
			.tap(function(environmentVariables) {
				if (_.isEmpty(environmentVariables)) {
					exitWithExpectedError('No environment variables found');
				}
				if (!options.verbose) {
					const { isSystemVariable } = balena.models.environmentVariables;
					environmentVariables = _.reject(
						environmentVariables,
						isSystemVariable,
					);
				}

				console.log(
					visuals.table.horizontal(environmentVariables, [
						'id',
						'name',
						'value',
					]),
				);
			})
			.nodeify(done);
	},
};

export const remove: CommandDefinition<
	{
		id: number;
	},
	{
		yes: boolean;
		device: boolean;
	}
> = {
	signature: 'env rm <id>',
	description: 'remove an environment variable',
	help: `\
Use this command to remove an environment variable from an application.

Don't remove balena specific variables, as things might not work as expected.

Notice this command asks for confirmation interactively.
You can avoid this by passing the \`--yes\` boolean option.

If you want to eliminate a device environment variable, pass the \`--device\` boolean option.

Examples:

	$ balena env rm 215
	$ balena env rm 215 --yes
	$ balena env rm 215 --device\
`,
	options: [commandOptions.yes, commandOptions.booleanDevice],
	permission: 'user',
	async action(params, options, done) {
		const balena = require('resin-sdk-preconfigured');
		const patterns = await import('../utils/patterns');

		return patterns
			.confirm(
				options.yes,
				'Are you sure you want to delete the environment variable?',
			)
			.then(function() {
				if (options.device) {
					return balena.models.environmentVariables.device.remove(params.id);
				} else {
					return balena.models.environmentVariables.remove(params.id);
				}
			})
			.nodeify(done);
	},
};

export const add: CommandDefinition<
	{
		key: string;
		value?: string;
	},
	{
		application?: string;
		device?: string;
	}
> = {
	signature: 'env add <key> [value]',
	description: 'add an environment variable',
	help: `\
Use this command to add an enviroment variable to an application.

At the moment the CLI doesn't fully support multi-container applications,
so the following commands will only set service variables for the first
service in your application.

If value is omitted, the tool will attempt to use the variable's value
as defined in your host machine.

Use the \`--device\` option if you want to assign the environment variable
to a specific device.

If the value is grabbed from the environment, a warning message will be printed.
Use \`--quiet\` to remove it.

Examples:

	$ balena env add EDITOR vim --application MyApp
	$ balena env add TERM --application MyApp
	$ balena env add EDITOR vim --device 7cf02a6\
`,
	options: [commandOptions.optionalApplication, commandOptions.optionalDevice],
	permission: 'user',
	async action(params, options, done) {
		normalizeUuidProp(options, 'device');
		const Bluebird = await import('bluebird');
		const balena = require('resin-sdk-preconfigured');

		const { exitWithExpectedError } = await import('../utils/patterns');

		return Bluebird.try(function() {
			if (params.value == null) {
				params.value = process.env[params.key];

				if (params.value == null) {
					throw new Error(`Environment value not found for key: ${params.key}`);
				} else {
					console.info(
						`Warning: using ${params.key}=${
							params.value
						} from host environment`,
					);
				}
			}

			if (options.application != null) {
				return balena.models.environmentVariables.create(
					options.application,
					params.key,
					params.value,
				);
			} else if (options.device != null) {
				return balena.models.environmentVariables.device.create(
					options.device,
					params.key,
					params.value,
				);
			} else {
				exitWithExpectedError('You must specify an application or device');
			}
		}).nodeify(done);
	},
};

export const rename: CommandDefinition<
	{
		id: number;
		value: string;
	},
	{
		device: boolean;
	}
> = {
	signature: 'env rename <id> <value>',
	description: 'rename an environment variable',
	help: `\
Use this command to rename an enviroment variable from an application.

Pass the \`--device\` boolean option if you want to rename a device environment variable.

Examples:

	$ balena env rename 376 emacs
	$ balena env rename 376 emacs --device\
`,
	permission: 'user',
	options: [commandOptions.booleanDevice],
	async action(params, options, done) {
		const Bluebird = await import('bluebird');
		const balena = require('resin-sdk-preconfigured');

		return Bluebird.try(function() {
			if (options.device) {
				return balena.models.environmentVariables.device.update(
					params.id,
					params.value,
				);
			} else {
				return balena.models.environmentVariables.update(
					params.id,
					params.value,
				);
			}
		}).nodeify(done);
	},
};