From 677c54bfff0f3154a6c6138faa4e1df9014b0072 Mon Sep 17 00:00:00 2001 From: busticated Date: Thu, 8 Jul 2021 11:42:40 -0700 Subject: [PATCH] remove deprecated mesh commands --- src/cli/index.js | 2 - src/cli/mesh.js | 106 ---------- src/cmd/mesh.js | 456 ------------------------------------------- test/e2e/help.e2e.js | 10 +- test/e2e/mesh.e2e.js | 124 ------------ test/lib/cli.js | 5 - 6 files changed, 4 insertions(+), 699 deletions(-) delete mode 100644 src/cli/mesh.js delete mode 100644 src/cmd/mesh.js delete mode 100644 test/e2e/mesh.e2e.js diff --git a/src/cli/index.js b/src/cli/index.js index 9611cb4e4..8c1cace5f 100644 --- a/src/cli/index.js +++ b/src/cli/index.js @@ -23,7 +23,6 @@ const variable = require('./variable'); const version = require('./version'); const webhook = require('./webhook'); const whoami = require('./whoami'); -const mesh = require('./mesh'); const usb = require('./usb'); /** @@ -66,7 +65,6 @@ module.exports = function registerAllCommands(context) { version(context); webhook(context); whoami(context); - mesh(context); usb(context); alias(context); }; diff --git a/src/cli/mesh.js b/src/cli/mesh.js deleted file mode 100644 index 7e8a839cf..000000000 --- a/src/cli/mesh.js +++ /dev/null @@ -1,106 +0,0 @@ -const settings = require('../../settings'); - -function meshCommand() { - if (!meshCommand._instance) { - const MeshCommand = require('../cmd/mesh'); - meshCommand._instance = new MeshCommand(settings); - } - return meshCommand._instance; -} - -module.exports = ({ commandProcessor, root }) => { - const mesh = commandProcessor.createCategory(root, 'mesh', 'Manage mesh networks'); - - commandProcessor.createCommand(mesh, 'create', 'Create a new network', { - params: ' ', - options: { - 'password': { - description: 'Network password. The minimum password length is 6 characters', - string: true, - }, - 'channel': { - description: 'Network channel. By default, the device will try to pick the least congested channel in your environment', - number: true - }, - 'yes': { - description: 'Answer yes to all questions', - boolean: true, - alias: 'y' - } - }, - examples: { - '$0 $command my_network my_argon': 'Create a network named "my_network" using a device named "my_argon"' - }, - handler: (args) => { - return meshCommand().create(args); - } - }); - - commandProcessor.createCommand(mesh, 'add', 'Add a device to a network', { - params: ' ', - options: { - 'password': { - description: 'Network password', - string: true, - }, - 'yes': { - description: 'Answer yes to all questions', - boolean: true, - alias: 'y' - } - }, - examples: { - '$0 $command my_xenon my_argon': 'Add a device named "my_xenon" to the current network of a device named "my_argon"' - }, - handler: (args) => { - return meshCommand().add(args); - } - }); - - commandProcessor.createCommand(mesh, 'remove', 'Remove a device from its network', { - params: '', - options: { - 'yes': { - description: 'Answer yes to all questions', - boolean: true, - alias: 'y' - } - }, - examples: { - '$0 $command my_xenon': 'Remove a device named "my_xenon" from its current network' - }, - handler: (args) => { - return meshCommand().remove(args); - } - }); - - commandProcessor.createCommand(mesh, 'list', 'List all networks and their member devices', { - params: '[network]', - options: { - 'networks-only': { - description: 'Do not list member devices', - boolean: true, - alias: 'n' - } - }, - handler: (args) => { - return meshCommand().list(args); - } - }); - - commandProcessor.createCommand(mesh, 'info', 'Get information about the current device\'s network', { - params: '', - handler: (args) => { - return meshCommand().info(args); - } - }); - - commandProcessor.createCommand(mesh, 'scan', 'Scan for networks', { - params: '', - handler: (args) => { - return meshCommand().scan(args); - } - }); - - return mesh; -}; diff --git a/src/cmd/mesh.js b/src/cmd/mesh.js deleted file mode 100644 index a89a3b25a..000000000 --- a/src/cmd/mesh.js +++ /dev/null @@ -1,456 +0,0 @@ -const ParticleApi = require('./api'); -const { asyncMapSeries } = require('../lib/utilities'); -const { getDevice, formatDeviceInfo } = require('./device-util'); -const { openUsbDeviceById } = require('./usb-util'); -const { platformsById } = require('./constants'); -const { prompt, spin } = require('../app/ui'); - - -module.exports = class MeshCommand { - constructor(settings) { - this._auth = settings.access_token; - this._api = new ParticleApi(settings.apiUrl, { accessToken: this._auth }).api; - } - - create(args) { - let device = null; - let usbDevice = null; - let networkPassword = null; - - return this._getDevice(args.params.device) - .then(d => { - device = d; - // Open the device - return this._openUsbDeviceById(device.id, args.params.device); - }) - .then(d => { - usbDevice = d; - - if (!device.network) { - return; - } - - // Remove the device from its current network - let p = Promise.resolve(); - - if (!args.yes) { - const question = { - name: 'remove', - type: 'confirm', - message: 'This device is already a member of another network. Do you want to remove it from that network and proceed?', - default: false - }; - - p = p.then(() => prompt(question)) - .then(r => { - if (!r.remove) { - throw new Error('Cancelled'); - } - }); - } - return p.then(() => this._removeDeviceFromNetwork(usbDevice)); - }) - .then(() => { - if (args.password) { - return args.password; - } - - const questions = [ - { - name: 'password', - type: 'password', - message: 'Enter a password for the new network' - }, - { - name: 'confirm', - type: 'password', - message: 'Confirm the password' - } - ]; - - return prompt(questions) - .then(r => { - if (r.password !== r.confirm) { - throw new Error('The entered passwords do not match'); - } - return r.password; - }); - }) - .then(password => { - networkPassword = password; - - if (usbDevice.isCellularDevice) { - const p = usbDevice.getIccid(); - return spin(p, 'Getting the ICCID...'); - } - }) - .then(iccid => { - const spec = { - name: args.params.network_name, - deviceId: device.id, - auth: this._auth, - iccid - }; - - const p = this._api.createMeshNetwork(spec) - .then(r => r.body.network.id); - - return spin(p, 'Registering the network with the cloud...'); - }) - .then(networkId => { - const spec = { - id: networkId, - name: args.params.network_name, - password: networkPassword, - channel: args.channel - }; - - return spin(usbDevice.createMeshNetwork(spec), 'Creating the network...'); - }) - .then(() => { - return usbDevice.leaveListeningMode(); - }) - .then(() => { - console.log('Done! The device will be registered in the network once it is connected to the cloud.'); - }) - .finally(() => { - if (usbDevice) { - return usbDevice.close(); - } - }); - } - - add(args) { - let joinerDevice = null; - let assistDevice = null; - let joinerUsbDevice = null; - let assistUsbDevice = null; - let networkId = null; - // Get the assisting device - return this._getDevice(args.params.assisting_device) - .then(d => { - assistDevice = d; - - if (!assistDevice.network) { - throw new Error('The assisting device is not a member of any mesh network'); - } - - networkId = assistDevice.network.id; - // Open the assisting device - return this._openUsbDeviceById(assistDevice.id, args.params.assisting_device); - }) - .then(d => { - assistUsbDevice = d; - // Get the joiner device. Do not fail if the device is not claimed - return this._getDevice(args.params.new_device, true); - }) - .then(d => { - joinerDevice = d; // Can be null - // Open the joiner device - let idOrName = args.params.new_device; - - if (joinerDevice) { - idOrName = joinerDevice.id; // Saves an API call - } - - return this._openUsbDeviceById(idOrName, args.params.new_device); - }) - .then(d => { - joinerUsbDevice = d; - // Check if the joiner device is already a member of some network - let p = Promise.resolve(); - - if (joinerDevice && joinerDevice.network) { - if (joinerDevice.network.id === networkId) { - console.log('The device is already a member of the network.'); - return p; // Done - } - - if (!args.yes) { - p = p.then(() => prompt({ - name: 'remove', - type: 'confirm', - message: 'The device is already a member of another network. Do you want to remove it from that network and proceed?', - default: false - })) - .then(r => { - if (!r.remove) { - throw new Error('Cancelled'); - } - }); - } - - p = p.then(() => this._removeDeviceFromNetwork(joinerUsbDevice)); - } - return p.then(() => { - if (args.password) { - return args.password; - } - - const question = { - name: 'password', - type: 'password', - message: 'Enter the network password' - }; - - return prompt(question) - .then(r => r.password); - }) - .then(password => { - // Start the commissioner role - const p = assistUsbDevice.meshAuth(password).then(() => assistUsbDevice.startCommissioner()); - return spin(p, 'Preparing the assisting device...'); - }) - .then(() => { - let p = Promise.resolve(); - - if (!joinerDevice) { - // The cloud will refuse to add an unclaimed device to a network, if the device is - // already a member of some other network - p = p.then(() => this._api.removeMeshNetworkDevice({ deviceId: joinerUsbDevice.id, auth: this._auth })); - } - - // Register the joiner device with the cloud - p = p.then(() => this._api.addMeshNetworkDevice({ networkId, deviceId: joinerUsbDevice.id, auth: this._auth })); - - return spin(p, 'Registering the device with the cloud...'); - }) - .then(() => { - // Add the joiner device to the network - const p = joinerUsbDevice.joinMeshNetwork(assistUsbDevice).then(() => assistUsbDevice.stopCommissioner()); - return spin(p, 'Adding the device to the network...'); - }) - .then(() => { - // Claim the joiner device if necessary - // FIXME: Normally, this should be done via `particle setup`, but it doesn't support mesh devices yet - if (!joinerDevice) { - const p = this._api.getClaimCode({ auth: this._auth }) - .then(r => { - return joinerUsbDevice.setClaimCode(r.body.claim_code); - }) - .then(() => { - // Set the setup done flag - return joinerUsbDevice.setSetupDone(); - }); - - return spin(p, 'Claiming the device to your account...'); - } - }) - .then(() => { - // Leave the listening mode - return joinerUsbDevice.leaveListeningMode(); - }) - .then(() => { - console.log('Done! The device should now connect to the cloud.'); - }); - }) - .finally(() => { - if (joinerUsbDevice) { - return joinerUsbDevice.close(); - } - }) - .finally(() => { - if (assistUsbDevice) { - return assistUsbDevice.close(); - } - }); - } - - remove(args) { - let device = null; - let usbDevice = null; - return this._getDevice(args.params.device) - .then(d => { - device = d; - - let p = Promise.resolve(); - - if (!device.network) { - console.log('This device is not a member of any mesh network.'); - return p; // Done - } - - if (!args.yes) { - const question = { - name: 'remove', - type: 'confirm', - message: 'Are you sure you want to remove this device from the network?', - default: false - }; - - p = p.then(() => prompt(question)) - .then(r => { - if (!r.remove) { - throw new Error('Cancelled'); - } - }); - } - return p.then(() => this._openUsbDeviceById(device.id, args.params.device)) - .then(d => { - usbDevice = d; - return this._removeDeviceFromNetwork(usbDevice); - }) - .then(() => { - console.log('Done.'); - }); - }) - .finally(() => { - if (usbDevice) { - return usbDevice.close(); - } - }); - } - - list(args) { - return Promise.resolve() - .then(() => { - if (args.params.network) { - // Get the network - return this._getNetwork(args.params.network) - .then(network => [network]); - } - - // Get all networks - const p = this._api.listMeshNetworks({ auth: this._auth }) - .then(r => { - return r.body.sort((a, b) => a.name.localeCompare(b.name)); // Sort networks by name - }); - - return spin(p, 'Retrieving networks...'); - }) - .then(networks => { - let p = Promise.resolve(); - - if (networks.length === 0) { - console.log('No networks found.'); - return p; // Done - } - - const listDevices = !args['networks-only']; - - if (listDevices) { - p = p.then(() => asyncMapSeries(networks, (network) => { - const spec = { networkId: network.id, auth: this._auth }; - return this._api.listMeshNetworkDevices(spec) - .then(r => { - network.devices = r.body.sort((a, b) => (a.name || '').localeCompare(b.name || '')); // Sort devices by name - }); - })); - - p = spin(p, 'Retrieving network devices...'); - } - - return p.then(() => { - networks.forEach(network => { - console.log(network.name); - if (listDevices && network.devices.length > 0) { - console.log(' devices:'); - network.devices.forEach(device => { - const type = platformsById[device.platform_id]; - console.log(` ${formatDeviceInfo({ id: device.id, name: device.name, type })}`); - }); - } - }); - }); - }); - } - - info(args) { - let usbDevice = null; - // Open the device - return this._openUsbDeviceById(args.params.device) - .then(d => { - usbDevice = d; - // Get the network info - return usbDevice.getMeshNetworkInfo(); - }) - .then(network => { - if (network) { - console.log(`This device is a member of ${network.name}.`); - } else { - console.log('This device is not a member of any mesh network.'); - } - }) - .finally(() => { - if (usbDevice) { - return usbDevice.close(); - } - }); - } - - scan(args) { - let usbDevice = null; - // Open the device - return this._openUsbDeviceById(args.params.device) - .then(d => { - usbDevice = d; - // Scan for networks - const p = usbDevice.scanMeshNetworks(); - return spin(p, 'Scanning for networks...'); - }) - .then(networks => { - if (networks.length === 0) { - console.log('No networks found.'); - } else { - // Device OS versions prior to 1.2.0 might report the same network multiple times: - // https://github.com/particle-iot/device-os/pull/1760. As a workaround, we're filtering - // out duplicate network entries at the client side as well - networks = networks.filter((n1, i1) => { - const i2 = networks.findIndex(n2 => n1.name === n2.name && n1.panId === n2.panId && n1.extPanId === n2.extPanId); - return i1 === i2; - }); - networks = networks.sort((a, b) => a.name.localeCompare(b.name)); // Sort networks by name - networks.forEach(network => console.log(network.name)); - } - }) - .finally(() => { - if (usbDevice) { - return usbDevice.close(); - } - }); - } - - _removeDeviceFromNetwork(usbDevice) { - const p = this._api.removeMeshNetworkDevice({ deviceId: usbDevice.id, auth: this._auth }); - - return spin(p, 'Removing the device from the network...') - .then(() => { - return spin(usbDevice.leaveMeshNetwork(), 'Clearing the network credentials...'); - }); - } - - _openUsbDeviceById(deviceId, displayName = null) { - return openUsbDeviceById({ id: deviceId, displayName, api: this._api, auth: this._auth }) - .then(usbDevice => { - if (!usbDevice.isMeshDevice) { - return usbDevice.close().then(() => { - throw new Error('The device does not support mesh networking'); - }); - } - return usbDevice; - }); - } - - _getDevice(deviceId, dontThrow = false) { - const msg = 'Getting device information...'; - const operation = getDevice({ id: deviceId, api: this._api, auth: this._auth, dontThrow }); - return spin(operation, msg); - } - - _getNetwork(networkId) { - const p = Promise.resolve() - .then(() => this._api.getMeshNetwork({ networkId, auth: this._auth })) - .then(r => { - return r.body; - }) - .catch(e => { - if (e.statusCode === 404) { - throw new Error(`Network not found: ${networkId}`); - } - throw e; - }); - - return spin(p, 'Getting network information...'); - } -}; - diff --git a/test/e2e/help.e2e.js b/test/e2e/help.e2e.js index 3a5a74d86..2eb67a713 100644 --- a/test/e2e/help.e2e.js +++ b/test/e2e/help.e2e.js @@ -24,7 +24,6 @@ describe('Help & Unknown Command / Argument Handling', () => { ' list Display a list of your devices, as well as their variables and functions', ' login Login to the cloud and store an access token locally', ' logout Log out of your session and clear your saved access token', - ' mesh Manage mesh networks', ' monitor Connect and display messages from a device', ' nyan Make your device shout rainbows', ' preprocess Preprocess a Wiring file (ino) into a C++ file (cpp)', @@ -54,11 +53,10 @@ describe('Help & Unknown Command / Argument Handling', () => { 'keys server', 'keys address', 'keys protocol', 'keys', 'library add', 'library create', 'library copy', 'library list', 'library migrate', 'library search', 'library upload', 'library publish', 'library view', - 'library', 'list', 'login', 'logout', 'mesh create', 'mesh add', - 'mesh remove', 'mesh list', 'mesh info', 'mesh scan', 'mesh', 'monitor', - 'nyan', 'preprocess', 'product device list', 'product device add', - 'product device remove', 'product device', 'product', 'project create', - 'project', 'publish', 'serial list', 'serial monitor', 'serial identify', 'serial wifi', + 'library', 'list', 'login', 'logout', 'monitor', 'nyan', 'preprocess', + 'product device list', 'product device add', 'product device remove', + 'product device', 'product', 'project create', 'project', 'publish', + 'serial list', 'serial monitor', 'serial identify', 'serial wifi', 'serial mac', 'serial inspect', 'serial flash', 'serial claim', 'serial', 'setup', 'subscribe', 'token list', 'token revoke', 'token create', 'token', 'udp send', 'udp listen', 'udp', 'update', diff --git a/test/e2e/mesh.e2e.js b/test/e2e/mesh.e2e.js deleted file mode 100644 index 7bc24e226..000000000 --- a/test/e2e/mesh.e2e.js +++ /dev/null @@ -1,124 +0,0 @@ -const capitalize = require('lodash/capitalize'); -const { expect } = require('../setup'); -const { runForAtLeast, delay } = require('../lib/mocha-utils'); -const cli = require('../lib/cli'); -const { - DEVICE_ID, - DEVICE_NAME, - DEVICE_PLATFORM_NAME -} = require('../lib/env'); - - -describe('Mesh Commands [@device]', () => { - const networkName = 'teste2emesh'; - const help = [ - 'Manage mesh networks', - 'Usage: particle mesh ', - 'Help: particle help mesh ', - '', - 'Commands:', - ' create Create a new network', - ' add Add a device to a network', - ' remove Remove a device from its network', - ' list List all networks and their member devices', - ' info Get information about the current device\'s network', - ' scan Scan for networks', - '', - 'Global Options:', - ' -v, --verbose Increases how much logging to display [count]', - ' -q, --quiet Decreases how much logging to display [count]' - ]; - - before(async () => { - await cli.setTestProfileAndLogin(); - await cli.removeDeviceFromMeshNetwork(); - }); - - after(async () => { - await cli.removeDeviceFromMeshNetwork(); - await cli.logout(); - await cli.setDefaultProfile(); - }); - - it('Shows `help` content', async () => { - const { stdout, stderr, exitCode } = await cli.run(['help', 'mesh']); - - expect(stdout).to.equal(''); - expect(stderr.split('\n')).to.include.members(help); - expect(exitCode).to.equal(0); - }); - - it('Shows `help` content when run without arguments', async () => { - const { stdout, stderr, exitCode } = await cli.run('mesh'); - - expect(stdout).to.equal(''); - expect(stderr.split('\n')).to.include.members(help); - expect(exitCode).to.equal(0); - }); - - it('Shows `help` content when run with `--help` flag', async () => { - const { stdout, stderr, exitCode } = await cli.run(['mesh', '--help']); - - expect(stdout).to.equal(''); - expect(stderr.split('\n')).to.include.members(help); - expect(exitCode).to.equal(0); - }); - - // TODO (mirande): figure out what's up w/ the `--interactive` flag. - it.skip('NYI: Requires forced-interactive mode via unsupported `--interactive` flag', async () => {}); - - it.skip('Creates network', runForAtLeast(30, async () => { - const password = '1234567890'; - const args = ['mesh', 'create', networkName, DEVICE_ID, '--interactive']; - const subprocess = cli.run(args); - - await delay(1000); - subprocess.stdin.write(password); - subprocess.stdin.write('\n'); - await delay(1000); - subprocess.stdin.write(password); - subprocess.stdin.end('\n'); - - const { stdout, stderr, exitCode } = await subprocess; - - expect(stdout).to.include('Done! The device will be registered in the network once it is connected to the cloud.'); - expect(stderr).to.equal(''); - expect(exitCode).to.equal(0); - })).timeout(60 * 1000); - - it.skip('Lists networks', async () => { - const platform = capitalize(DEVICE_PLATFORM_NAME); - const args = ['mesh', 'list']; - const { stdout, stderr, exitCode } = await cli.run(args); - - expect(stdout).to.include(networkName); - expect(stdout).to.include(`${DEVICE_NAME} [${DEVICE_ID}] (${platform})`); - expect(stderr).to.equal(''); - expect(exitCode).to.equal(0); - }); - - it.skip('Get network info', async () => { - const args = ['mesh', 'info', DEVICE_ID]; - const { stdout, stderr, exitCode } = await cli.run(args); - - expect(stdout).to.include(`This device is a member of ${networkName}.`); - expect(stderr).to.equal(''); - expect(exitCode).to.equal(0); - }); - - it.skip('Removes device from network', runForAtLeast(10, async () => { - const args = ['mesh', 'remove', DEVICE_ID, '--interactive']; - const subprocess = cli.run(args); - - await delay(1000); - subprocess.stdin.write('y'); - subprocess.stdin.end('\n'); - - const { stdout, stderr, exitCode } = await subprocess; - - expect(stdout).to.include('Done.'); - expect(stderr).to.equal(''); - expect(exitCode).to.equal(0); - })); -}); - diff --git a/test/lib/cli.js b/test/lib/cli.js index a2e8f6470..87bfa40bd 100644 --- a/test/lib/cli.js +++ b/test/lib/cli.js @@ -168,11 +168,6 @@ module.exports.callStrobyStop = async (deviceID, productID) => { return runWithRetry(args, { reject: true }); }; -module.exports.removeDeviceFromMeshNetwork = () => { - const { run } = module.exports; - return run(['mesh', 'remove', DEVICE_ID, '--yes'], { reject: true }); -}; - module.exports.getNameVariable = async () => { const { run } = module.exports; const { stdout } = await run(['get', DEVICE_NAME, 'name'], { reject: true });