Get network configuration of a device #733
Conversation
src/cmd/usb.js
Outdated
| const platform = platformForId(usbDevice.platformId); | ||
| if (platform.generation <= 2) { | ||
| output = output.concat(`Device ID: ${chalk.cyan(usbDevice.id)} (${chalk.cyan(platform.displayName)})`); | ||
| output = output.concat('\tCannot get network interfaces for Gen 2 devices'); | ||
| output = output.concat('\n'); | ||
| return; | ||
| } | ||
| return this.getNetworkIface(usbDevice) | ||
| .then((outputData) => { | ||
| output = output.concat(outputData); | ||
| }); |
There was a problem hiding this comment.
Always prefer feature detection over version checks if possible. What does a Gen 2 device or maybe even a Gen 3 device without support for the NetworkIface control request do? If it errors out quickly with a predictable error code (NOT_SUPPORTED or something), then it's best to catch the error and say "Getting network interfaces is not supported for this device". If the error takes a while or it does something else weird, it's ok to fall back to checking the version.
| const ifaceList = await usbDevice.getNetworkInterfaceList(); | ||
| for (const iface of ifaceList) { | ||
| const ifaceInfo = await usbDevice.getNetworkInterface({ index: iface.index, timeout: 10000 }); |
There was a problem hiding this comment.
I suggest separating the code that does the control requests from the code that formats the data. Then write one or a couple of unit tests passing data the data structure that you get from the control request to the formatting function to check that all the output logic works as expected.
keeramis
force-pushed
the
feature/get-network-ifaces
branch
from
2a7ee0e
to
345224a
Compare
|
@monkbroc updated the new output format when there is an error. |
src/cmd/usb.test.js
Outdated
| access_token: '1234' | ||
| }, | ||
| }); | ||
| const res = await usbCommands._formatNetworkIfaceOutput(nwInfo, 'p2', '0123456789abcdef'); |
There was a problem hiding this comment.
Nice test! The test doesn't need to be async and this line doesn't need await since _formatNetworkIfaceOutput is not async.
keeramis
force-pushed
the
feature/get-network-ifaces
branch
from
c585f60
to
b919cf5
Compare
Description
Implements a command which resembles the linux
ifconfigcommand that shows information about the network interfaces and their statesThis is only possible on Gen2 because the USB control requests to request this information are guarded by
HAL_PLATFORM_IFAPIwhich is enabled only for Gen3 and above.How to Test
Check out this branch and from the particle-cli root directory, run
npm start -- usb network-interfacesExpected Outcome
Related Issues / Discussions
particle-iot/particle-usb#102
Completeness