Rename actions-oclif/ to commands/

Change-type: patch Signed-off-by: Scott Lowe <scott@balena.io>
2025-06-20 16:50:15 +00:00 · 2020-10-02 13:42:23 +02:00
parent d8acc3f814
commit eddbdfe0dc
68 changed files with 67 additions and 67 deletions
--- a/lib/commands/device/public-url.ts
+++ b/lib/commands/device/public-url.ts
@ -0,0 +1,148 @@
+/**
+ * @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 type { IArg } from '@oclif/parser/lib/args';
+import Command from '../../command';
+import { ExpectedError } from '../../errors';
+import * as cf from '../../utils/common-flags';
+import { getBalenaSdk, stripIndent } from '../../utils/lazy';
+import { tryAsInteger } from '../../utils/validation';
+
+interface FlagsDef {
+	enable: boolean;
+	disable: boolean;
+	status: boolean;
+	help?: void;
+}
+
+interface ArgsDef {
+	uuid: string;
+	// Optional hidden arg to support old command format
+	legacyUuid?: string;
+}
+
+export default class DevicePublicUrlCmd extends Command {
+	public static description = stripIndent`
+		Get or manage the public URL for a device.
+
+		This command will output the current public URL for the
+		specified device.  It can also enable or disable the URL,
+		or output the enabled status, using the respective options.
+
+		The old command style 'balena device public-url enable <uuid>'
+		is deprecated, but still supported.
+	`;
+
+	public static examples = [
+		'$ balena device public-url 23c73a1',
+		'$ balena device public-url 23c73a1 --enable',
+		'$ balena device public-url 23c73a1 --disable',
+		'$ balena device public-url 23c73a1 --status',
+	];
+
+	public static args: Array<IArg<any>> = [
+		{
+			name: 'uuid',
+			description: 'the uuid of the device to manage',
+			parse: (dev) => tryAsInteger(dev),
+			required: true,
+		},
+		{
+			// Optional hidden arg to support old command format
+			name: 'legacyUuid',
+			parse: (dev) => tryAsInteger(dev),
+			hidden: true,
+		},
+	];
+
+	public static usage = 'device public-url <uuid>';
+
+	public static flags: flags.Input<FlagsDef> = {
+		enable: flags.boolean({
+			description: 'enable the public URL',
+			exclusive: ['disable', 'status'],
+		}),
+		disable: flags.boolean({
+			description: 'disable the public URL',
+			exclusive: ['enable', 'status'],
+		}),
+		status: flags.boolean({
+			description: 'determine if public URL is enabled',
+			exclusive: ['enable', 'disable'],
+		}),
+		help: cf.help,
+	};
+
+	public static authenticated = true;
+
+	public async run() {
+		const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
+			DevicePublicUrlCmd,
+		);
+
+		// Legacy command format support.
+		// Previously this command used the following format
+		// (changed due to oclif technicalities):
+		//   `balena device public-url enable|disable|status <uuid>`
+		if (params.legacyUuid) {
+			const action = params.uuid;
+			if (!['enable', 'disable', 'status'].includes(action)) {
+				throw new ExpectedError(
+					`Unexpected arguments: ${params.uuid} ${params.legacyUuid}`,
+				);
+			}
+
+			options.enable = action === 'enable';
+			options.disable = action === 'disable';
+			options.status = action === 'status';
+			params.uuid = params.legacyUuid;
+			delete params.legacyUuid;
+		}
+
+		const balena = getBalenaSdk();
+
+		if (options.enable) {
+			// Enable public URL
+			await balena.models.device.enableDeviceUrl(params.uuid);
+		} else if (options.disable) {
+			// Disable public URL
+			await balena.models.device.disableDeviceUrl(params.uuid);
+		} else if (options.status) {
+			// Output bool indicating if public URL enabled
+			const hasUrl = await balena.models.device.hasDeviceUrl(params.uuid);
+			console.log(hasUrl);
+		} else {
+			// Output public URL
+			try {
+				const url = await balena.models.device.getDeviceUrl(params.uuid);
+				console.log(url);
+			} catch (e) {
+				if (e.message.includes('Device is not web accessible')) {
+					throw new ExpectedError(stripIndent`
+					Public URL is not enabled for this device.
+
+					To enable, use:
+						balena device public-url ${params.uuid} --enable
+					`);
+				} else {
+					throw e;
+				}
+			}
+		}
+	}
+}