Merge pull request #1702 from balena-io/convert-join-leave

Convert commands leave, join to oclif.

automation/capitanodoc/capitanodoc.ts

@@ -116,7 +116,7 @@ const capitanoDoc = {
 		},
 		{
 			title: 'Platform',
-			files: ['build/actions/join.js', 'build/actions/leave.js'],
+			files: ['build/actions-oclif/join.js', 'build/actions-oclif/leave.js'],
 		},
 		{
 			title: 'Utilities',

doc/cli.markdown

@@ -247,8 +247,8 @@ If you come across any problems or would like to get in touch:
 
 - Platform
 
-	- [join [deviceIp]](#join-deviceip)
+	- [join [deviceiporhostname]](#join-deviceiporhostname)
-	- [leave [deviceIp]](#leave-deviceip)
+	- [leave [deviceiporhostname]](#leave-deviceiporhostname)
 
 - Utilities
 
@@ -2146,9 +2146,10 @@ Squash newly built layers into a single new layer
 
 # Platform
 
-## join [deviceIp]
+## join [deviceIpOrHostname]
 
-Use this command to move a local device to an application on another balena server.
+Move a local device to an application on another balena server, causing
+the device to "join" the new server. The device must be running balenaOS.
 
 For example, you could provision a device against an openBalena installation
 where you perform end-to-end tests and then move it to balenaCloud when it's
@@ -2159,7 +2160,8 @@ To move a device between applications on the same server, use the
 
 If you don't specify a device hostname or IP, this command will automatically
 scan the local network for balenaOS devices and prompt you to select one
-from an interactive picker. This usually requires root privileges.
+from an interactive picker. This requires root privileges.  Likewise, if
+the application flag is not provided then a picker will be shown.
 
 Examples:
 
@@ -2169,16 +2171,23 @@ Examples:
 	$ balena join 192.168.1.25
 	$ balena join 192.168.1.25 --application MyApp
 
+### Arguments
+
+#### DEVICEIPORHOSTNAME
+
+the IP or hostname of device
+
 ### Options
 
-#### --application, -a <application>
+#### -a, --application APPLICATION
 
-The name of the application the device should join
+application name
 
-## leave [deviceIp]
+## leave [deviceIpOrHostname]
 
-Use this command to make a local device leave the balena server it is
+Remove a local device from its balena application, causing the device to
-provisioned on. This effectively makes the device "unmanaged".
+"leave" the server it is provisioned on. This effectively makes the device
+"unmanaged". The device must be running balenaOS.
 
 The device entry on the server is preserved after running this command,
 so the device can subsequently re-join the server if needed.
@@ -2193,6 +2202,14 @@ Examples:
 	$ balena leave balena.local
 	$ balena leave 192.168.1.25
 
+### Arguments
+
+#### DEVICEIPORHOSTNAME
+
+the device IP or hostname
+
+### Options
+
 # Utilities
 
 ## util available-drives

lib/actions-oclif/join.ts

@@ -0,0 +1,98 @@
+/**
+ * @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 { stripIndent } from 'common-tags';
+import Command from '../command';
+import * as cf from '../utils/common-flags';
+import { getBalenaSdk } from '../utils/lazy';
+
+interface FlagsDef {
+	application?: string;
+	help?: void;
+}
+
+interface ArgsDef {
+	deviceIpOrHostname?: string;
+}
+
+export default class JoinCmd extends Command {
+	public static description = stripIndent`
+		Move a local device to an application on another balena server.
+
+		Move a local device to an application on another balena server, causing
+		the device to "join" the new server. The device must be running balenaOS.
+
+		For example, you could provision a device against an openBalena installation
+		where you perform end-to-end tests and then move it to balenaCloud when it's
+		ready for production.
+
+		To move a device between applications on the same server, use the
+		\`balena device move\` command instead of \`balena join\`.
+
+		If you don't specify a device hostname or IP, this command will automatically
+		scan the local network for balenaOS devices and prompt you to select one
+		from an interactive picker. This requires root privileges.  Likewise, if
+		the application flag is not provided then a picker will be shown.
+	`;
+
+	public static examples = [
+		'$ balena join',
+		'$ balena join balena.local',
+		'$ balena join balena.local --application MyApp',
+		'$ balena join 192.168.1.25',
+		'$ balena join 192.168.1.25 --application MyApp',
+	];
+
+	public static args = [
+		{
+			name: 'deviceIpOrHostname',
+			description: 'the IP or hostname of device',
+		},
+	];
+
+	// Hardcoded to preserve camelcase
+	public static usage = 'join [deviceIpOrHostname]';
+
+	public static flags: flags.Input<FlagsDef> = {
+		application: {
+			description: 'the name of the application the device should join',
+			...cf.application,
+		},
+		help: cf.help,
+	};
+
+	public static authenticated = true;
+	public static primary = true;
+
+	public async run() {
+		const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
+			JoinCmd,
+		);
+
+		const Logger = await import('../utils/logger');
+		const promote = await import('../utils/promote');
+		const sdk = getBalenaSdk();
+		const logger = Logger.getLogger();
+		return promote.join(
+			logger,
+			sdk,
+			params.deviceIpOrHostname,
+			options.application,
+		);
+	}
+}

lib/actions-oclif/leave.ts

@@ -0,0 +1,80 @@
+/**
+ * @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 { stripIndent } from 'common-tags';
+import Command from '../command';
+import * as cf from '../utils/common-flags';
+import { getBalenaSdk } from '../utils/lazy';
+
+interface FlagsDef {
+	help?: void;
+}
+
+interface ArgsDef {
+	deviceIpOrHostname?: string;
+}
+
+export default class LeaveCmd extends Command {
+	public static description = stripIndent`
+		Remove a local device from its balena application.
+
+		Remove a local device from its balena application, causing the device to
+		"leave" the server it is provisioned on. This effectively makes the device
+		"unmanaged". The device must be running balenaOS.
+
+		The device entry on the server is preserved after running this command,
+		so the device can subsequently re-join the server if needed.
+
+		If you don't specify a device hostname or IP, this command will automatically
+		scan the local network for balenaOS devices and prompt you to select one
+		from an interactive picker. This usually requires root privileges.
+	`;
+
+	public static examples = [
+		'$ balena leave',
+		'$ balena leave balena.local',
+		'$ balena leave 192.168.1.25',
+	];
+
+	public static args = [
+		{
+			name: 'deviceIpOrHostname',
+			description: 'the device IP or hostname',
+		},
+	];
+
+	// Hardcoded to preserve camelcase
+	public static usage = 'leave [deviceIpOrHostname]';
+
+	public static flags: flags.Input<FlagsDef> = {
+		help: cf.help,
+	};
+
+	public static authenticated = true;
+	public static primary = true;
+
+	public async run() {
+		const { args: params } = this.parse<FlagsDef, ArgsDef>(LeaveCmd);
+
+		const Logger = await import('../utils/logger');
+		const promote = await import('../utils/promote');
+		const sdk = getBalenaSdk();
+		const logger = Logger.getLogger();
+		return promote.leave(logger, sdk, params.deviceIpOrHostname);
+	}
+}

lib/actions/index.coffee

@@ -33,6 +33,4 @@ module.exports =
 	util: require('./util')
 	preload: require('./preload')
 	push: require('./push')
-	join: require('./join')
-	leave: require('./leave')
 	tunnel: require('./tunnel')

lib/actions/join.ts

@@ -1,73 +0,0 @@
-/*
-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 { stripIndent } from 'common-tags';
-import { getBalenaSdk } from '../utils/lazy';
-
-interface Args {
-	deviceIp?: string;
-}
-
-interface Options {
-	application?: string;
-}
-
-export const join: CommandDefinition<Args, Options> = {
-	signature: 'join [deviceIp]',
-	description:
-		'Promote a local device running balenaOS to join an application on a balena server',
-	help: stripIndent`
-		Use this command to move a local device to an application on another balena server.
-
-		For example, you could provision a device against an openBalena installation
-		where you perform end-to-end tests and then move it to balenaCloud when it's
-		ready for production.
-
-		To move a device between applications on the same server, use the
-		\`balena device move\` command instead of \`balena join\`.
-
-		If you don't specify a device hostname or IP, this command will automatically
-		scan the local network for balenaOS devices and prompt you to select one
-		from an interactive picker. This usually requires root privileges.
-
-		Examples:
-
-			$ balena join
-			$ balena join balena.local
-			$ balena join balena.local --application MyApp
-			$ balena join 192.168.1.25
-			$ balena join 192.168.1.25 --application MyApp
-	`,
-	options: [
-		{
-			signature: 'application',
-			parameter: 'application',
-			alias: 'a',
-			description: 'The name of the application the device should join',
-		},
-	],
-
-	permission: 'user',
-	primary: true,
-
-	async action(params, options) {
-		const Logger = await import('../utils/logger');
-		const promote = await import('../utils/promote');
-		const sdk = getBalenaSdk();
-		const logger = Logger.getLogger();
-		return promote.join(logger, sdk, params.deviceIp, options.application);
-	},
-};

lib/actions/leave.ts

@@ -1,56 +0,0 @@
-/*
-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 { stripIndent } from 'common-tags';
-import { getBalenaSdk } from '../utils/lazy';
-
-interface Args {
-	deviceIp?: string;
-}
-
-export const leave: CommandDefinition<Args, {}> = {
-	signature: 'leave [deviceIp]',
-	description: 'Detach a local device from its balena application',
-	help: stripIndent`
-		Use this command to make a local device leave the balena server it is
-		provisioned on. This effectively makes the device "unmanaged".
-
-		The device entry on the server is preserved after running this command,
-		so the device can subsequently re-join the server if needed.
-
-		If you don't specify a device hostname or IP, this command will automatically
-		scan the local network for balenaOS devices and prompt you to select one
-		from an interactive picker. This usually requires root privileges.
-
-		Examples:
-
-			$ balena leave
-			$ balena leave balena.local
-			$ balena leave 192.168.1.25
-	`,
-	options: [],
-
-	permission: 'user',
-	primary: true,
-
-	async action(params) {
-		const Logger = await import('../utils/logger');
-		const promote = await import('../utils/promote');
-		const sdk = getBalenaSdk();
-		const logger = Logger.getLogger();
-		return promote.leave(logger, sdk, params.deviceIp);
-	},
-};

lib/app-capitano.coffee

@@ -125,10 +125,6 @@ capitano.command(actions.deploy)
 #------------ Push/remote builds -------
 capitano.command(actions.push.push)
 
-#------------ Join/Leave -------
-capitano.command(actions.join.join)
-capitano.command(actions.leave.leave)
-
 exports.run = (argv) ->
 	cli = capitano.parse(argv.slice(2))
 	runCommand = ->

lib/preparser.ts

@@ -133,6 +133,8 @@ export const convertedCommands = [
 	'env:rm',
 	'internal:scandevices',
 	'internal:osinit',
+	'join',
+	'leave',
 	'note',
 	'os:configure',
 	'settings',

tests/commands/help.spec.ts

@@ -25,8 +25,8 @@ Primary commands:
     preload <image>                         preload an app on a disk image (or Edison zip archive)
     build [source]                          Build a single image or a multicontainer project locally
     deploy <appName> [image]                Deploy a single image or a multicontainer project to a balena application
-    join [deviceIp]                         Promote a local device running balenaOS to join an application on a balena server
+    join [deviceiporhostname]               move a local device to an application on another balena server
-    leave [deviceIp]                        Detach a local device from its balena application
+    leave [deviceiporhostname]              remove a local device from its balena application
     scan                                    Scan for balenaOS devices in your local network
 
 `;