fix tests after adding new command, use firmware/cloud env type since the user has more context with those types

Author: hugomontero

src/cli/usb.js

@@ -168,13 +168,13 @@ module.exports = ({ commandProcessor, root }) => {
 		}
 	});
 
-	commandProcessor.createCommand(usb, 'env', 'Get environment variables from a device', {
+	commandProcessor.createCommand(usb, 'env', 'Gets environment variables from a device', {
 		params: '[devices...]',
 		options: commonOptions,
 		examples: {
-			'$0 $command': 'Get environment variables from the connected device',
-			'$0 $command --all': 'Get environment variables from all devices connected over USB',
-			'$0 $command my_device': 'Get environment variables from the device named "my_device"'
+			'$0 $command': 'Gets environment variables from the connected device',
+			'$0 $command --all': 'Gets environment variables from all devices connected over USB',
+			'$0 $command my_device': 'Gets environment variables from the device named "my_device"'
 		},
 		handler: (args) => {
 			return usbCommand().getEnv(args);

src/cli/usb.test.js

@@ -40,6 +40,7 @@ describe('USB Command-Line Interface', () => {
 					'  configure           Update the system USB configuration',
 					'  cloud-status        Check a device\'s cloud connection state',
 					'  network-interfaces  Gets the network configuration of the device',
+					'  env                 Gets environment variables from a device',
 					''
 				].join('\n'));
 			});

src/cmd/usb.js

@@ -137,55 +137,59 @@ module.exports = class UsbCommand extends CLICommandBase {
 
 	_formatEnvOutput(result, platformName, deviceId) {
 		const output = [];
+		const push = line => output.push(line);
 
-		output.push('');
-		output.push(`${chalk.bold('Device:')} ${chalk.cyan(deviceId)} (${chalk.cyan(platformName)})`);
+		push('');
+		push(`${chalk.bold('Device:')} ${chalk.cyan(deviceId)} (${chalk.cyan(platformName)})`);
 
 		if (result.snapshot) {
-			output.push(`${chalk.bold('Snapshot Hash:')} ${chalk.gray(result.snapshot.hash)}`);
+			push(`${chalk.bold('Snapshot Hash:')} ${chalk.gray(result.snapshot.hash)}`);
 		}
 
-		const envVars = result.env;
-		const envKeys = Object.keys(envVars);
+		const envVars = result.env ?? {};
+		const entries = Object.entries(envVars);
 
-		if (envKeys.length === 0) {
-			output.push(chalk.yellow('  No environment variables set'));
-		} else {
-			output.push(chalk.bold(`${os.EOL}Environment Variables:`));
-			const appVars = [];
-			const systemVars = [];
+		if (entries.length === 0) {
+			push(chalk.yellow('  No environment variables set'));
+			push('');
+			return output;
+		}
 
-			envKeys.forEach(key => {
-				const varInfo = envVars[key];
-				if (varInfo.isApp) {
-					appVars.push({ key, value: varInfo.value });
-				} else {
-					systemVars.push({ key, value: varInfo.value });
-				}
-			});
+		push(chalk.bold(`${os.EOL}Environment Variables:`));
 
-			if (appVars.length > 0) {
-				output.push(chalk.dim('  Application:'));
-				appVars.sort((a, b) => a.key.localeCompare(b.key)).forEach(({ key, value }) => {
-					output.push(`    ${chalk.green(key)}=${chalk.white(value)}`);
-				});
-			}
+		const { appVars, systemVars } = this._groupEnvVars(entries);
 
-			if (systemVars.length > 0) {
-				if (appVars.length > 0) {
-					output.push('');
-				}
-				output.push(chalk.dim('  System:'));
-				systemVars.sort((a, b) => a.key.localeCompare(b.key)).forEach(({ key, value }) => {
-					output.push(`    ${chalk.cyan(key)}=${chalk.white(value)}`);
-				});
-			}
-		}
-		output.push('');
+		this._renderEnvGroup(output, '  Firmware:', appVars, 'green');
+		appVars.length > 0 && systemVars.length > 0 && push('');
+		this._renderEnvGroup(output, '  Cloud:', systemVars, 'cyan');
 
+		push('');
 		return output;
 	}
 
+	_groupEnvVars(entries) {
+		return entries.reduce(
+			(acc, [key, { value, isApp }]) => {
+				const target = isApp ? acc.appVars : acc.systemVars;
+				target.push({ key, value });
+				return acc;
+			},
+			{ appVars: [], systemVars: [] }
+		);
+	}
+
+	_renderEnvGroup(output, title, vars, color) {
+		if (vars.length === 0) {
+			return;
+		}
+		output.push(chalk.dim(title));
+		vars.sort((a, b) => a.key.localeCompare(b.key))
+			.forEach(({ key, value }) => {
+				output.push(`    ${chalk[color](key)}=${chalk.white(value)}`);
+			});
+
+	}
+
 	stopListening(args) {
 		args.api = this._api;
 		args.auth = this._auth;

src/cmd/usb.test.js

@@ -137,8 +137,8 @@ describe('USB Commands', () => {
 			expect(cleanOutput).to.deep.equal([
 				'',
 				'Device: 0123456789abcdef (P2)',
-				'\nEnvironment Variables:',
-				'  Application:',
+				`${os.EOL}Environment Variables:`,
+				'  Firmware:',
 				'    FOO=bar',
 				'    TEST=baz',
 				''
@@ -159,8 +159,8 @@ describe('USB Commands', () => {
 			expect(cleanOutput).to.deep.equal([
 				'',
 				'Device: 0123456789abcdef (P2)',
-				'\nEnvironment Variables:',
-				'  System:',
+				`${os.EOL}Environment Variables:`,
+				'  Cloud:',
 				'    SYS_VAR1=value1',
 				'    SYS_VAR2=value2',
 				''
@@ -182,12 +182,12 @@ describe('USB Commands', () => {
 			expect(cleanOutput).to.deep.equal([
 				'',
 				'Device: abc123def456 (Photon)',
-				'\nEnvironment Variables:',
-				'  Application:',
+				`${os.EOL}Environment Variables:`,
+				'  Firmware:',
 				'    ANOTHER_APP=another_app',
 				'    APP_KEY=app_value',
 				'',
-				'  System:',
+				'  Cloud:',
 				'    SYS_KEY=sys_value',
 				''
 			]);
@@ -226,8 +226,8 @@ describe('USB Commands', () => {
 				'',
 				'Device: 0123456789abcdef (P2)',
 				'Snapshot Hash: abc123def456789',
-				'\nEnvironment Variables:',
-				'  Application:',
+				`${os.EOL}Environment Variables:`,
+				'  Firmware:',
 				'    MY_VAR=my_value',
 				''
 			]);
@@ -251,12 +251,12 @@ describe('USB Commands', () => {
 				'',
 				'Device: device123 (P2)',
 				`${os.EOL}Environment Variables:`,
-				'  Application:',
+				'  Firmware:',
 				'    APPLE=a',
 				'    BANANA=b',
 				'    ZEBRA=z',
 				'',
-				'  System:',
+				'  Cloud:',
 				'    SYS_A=sa',
 				'    SYS_Z=sz',
 				''
@@ -273,7 +273,14 @@ describe('USB Commands', () => {
 			const output = usbCommands._formatEnvOutput(result, 'P2', 'device123');
 			const cleanOutput = output.map(stripAnsi);
 
-			expect(cleanOutput[4]).to.equal('    SPECIAL=value with spaces & symbols!@#$%');
+			expect(cleanOutput).to.deep.equal([
+				'',
+				'Device: device123 (P2)',
+				`${os.EOL}Environment Variables:`,
+				'  Firmware:',
+				'    SPECIAL=value with spaces & symbols!@#$%',
+				''
+			]);
 		});
 	});
 });