Add command device local-mode

Change-type: minor
Resolves: #1304
Signed-off-by: Scott Lowe <scott@balena.io>

lib/commands/device/local-mode.ts

@@ -0,0 +1,114 @@
+/**
+ * @license
+ * Copyright 2021 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 * 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 | number;
+}
+
+export default class DeviceLocalModeCmd extends Command {
+	public static description = stripIndent`
+		Get or manage the local mode status for a device.
+
+		Output current local mode status, or enable/disable local mode
+		for specified device.
+	`;
+
+	public static examples = [
+		'$ balena device local-mode 23c73a1',
+		'$ balena device local-mode 23c73a1 --enable',
+		'$ balena device local-mode 23c73a1 --disable',
+		'$ balena device local-mode 23c73a1 --status',
+	];
+
+	public static args: Array<IArg<any>> = [
+		{
+			name: 'uuid',
+			description: 'the uuid of the device to manage',
+			parse: (dev) => tryAsInteger(dev),
+			required: true,
+		},
+	];
+
+	public static usage = 'device local-mode <uuid>';
+
+	public static flags: flags.Input<FlagsDef> = {
+		enable: flags.boolean({
+			description: 'enable local mode',
+			exclusive: ['disable', 'status'],
+		}),
+		disable: flags.boolean({
+			description: 'disable local mode',
+			exclusive: ['enable', 'status'],
+		}),
+		status: flags.boolean({
+			description: 'output boolean indicating local mode status',
+			exclusive: ['enable', 'disable'],
+		}),
+		help: cf.help,
+	};
+
+	public static authenticated = true;
+
+	public async run() {
+		const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
+			DeviceLocalModeCmd,
+		);
+
+		const balena = getBalenaSdk();
+
+		if (options.enable) {
+			await balena.models.device.enableLocalMode(params.uuid);
+			console.log(`Local mode on device ${params.uuid} is now ENABLED.`);
+		} else if (options.disable) {
+			await balena.models.device.disableLocalMode(params.uuid);
+			console.log(`Local mode on device ${params.uuid} is now DISABLED.`);
+		} else if (options.status) {
+			// Output bool indicating local mode status
+			const isEnabled = await balena.models.device.isInLocalMode(params.uuid);
+			console.log(isEnabled);
+		} else {
+			// If no flag provided, output status and tip
+			const isEnabled = await balena.models.device.isInLocalMode(params.uuid);
+			console.log(
+				`Local mode on device ${params.uuid} is ${
+					isEnabled ? 'ENABLED' : 'DISABLED'
+				}.`,
+			);
+			if (isEnabled) {
+				console.log('To disable, use:');
+				console.log(`  balena device local-mode ${params.uuid} --disable`);
+			} else {
+				console.log('To enable, use:');
+				console.log(`  balena device local-mode ${params.uuid} --enable`);
+			}
+		}
+	}
+}

lib/utils/device/deploy.ts

@@ -40,6 +40,7 @@ import { DeviceAPI, DeviceInfo } from './api';
 import * as LocalPushErrors from './errors';
 import LivepushManager from './live';
 import { displayBuildLog } from './logs';
+import { stripIndent } from '../lazy';
 
 const LOCAL_APPNAME = 'localapp';
 const LOCAL_RELEASEHASH = 'localrelease';
@@ -133,16 +134,19 @@ export async function deployToDevice(opts: DeviceDeployOptions): Promise<void> {
 		opts.deviceHost = address;
 	}
 
-	const api = new DeviceAPI(globalLogger, opts.deviceHost);
+	const port = 48484;
+	const api = new DeviceAPI(globalLogger, opts.deviceHost, port);
 
 	// First check that we can access the device with a ping
 	try {
 		globalLogger.logDebug('Checking we can access device');
 		await api.ping();
 	} catch (e) {
-		throw new ExpectedError(
+		throw new ExpectedError(stripIndent`
-			`Could not communicate with local mode device at address ${opts.deviceHost}`,
+			Could not communicate with device supervisor at address ${opts.deviceHost}:${port}.
-		);
+			Device may not have local mode enabled. Check with:
+			  balena device local-mode <device-uuid>
+		`);
 	}
 
 	const versionError = new Error(