client: names in compact output when listing resources

[flxzt]

Description

This adds that resources names are printed in the compact output of the labgrid-client resources command.

For example, instead of:

exporter-01/usbhub-p01/NetworkSerialPort
exporter-01/usbhub-p01/NetworkSerialPort

the output becomes

exporter-01/usbhub-p01/NetworkSerialPort[/modbus]
exporter-01/usbhub-p01/NetworkSerialPort[/serial-115200]

which makes it easier to differentiate between resources that have the same class.

The alternative would be to enable verbose printing with labgrid-client -v resources, but that adds a lot of other information and makes is quite hard to pick out the name quickly.

At least in my experience the resource name is the only info that I need 95% of the time, so I think it would be beneficial to add it to the default output.

What do you think?

• PR has been tested

[Bastian-Krause]

Sounds good. Is there a special reason for the square brackets? I would just drop them, so the match can be copy & pasted into labgrid-client add-match <match> directly.

[flxzt]

I went with the brackets because they indicate that the name is optional when adding as a match and for consistency to the verbose output.

I don't have a strong opinion about either, should the verbose output be changed as well?

[flxzt]

I would appreciate feedback here. @Bastian-Krause

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 60.8%. Comparing base (e4f22e7) to head (147a5de).
✅ All tests successful. No failed tests found.

Additional details and impacted files

@@          Coverage Diff           @@
##           master   #1443   +/-   ##
======================================
  Coverage    60.7%   60.8%           
======================================
  Files         184     184           
  Lines       15099   15099           
======================================
+ Hits         9180    9181    +1     
+ Misses       5919    5918    -1     

Flag	Coverage Δ
3.10	60.7% <100.0%> (-0.1%)	⬇️
3.11	60.7% <100.0%> (+<0.1%)	⬆️
3.12	60.7% <100.0%> (-0.1%)	⬇️
3.13	60.7% <100.0%> (-0.1%)	⬇️
3.14	60.7% <100.0%> (-0.1%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

[jluebbe]

In our lab, all exporters use resource configuration without names:

usb-hub-in-rack12:
  USBSerialPort:
    match:
      '@ID_PATH': 'pci-0000:05:00.0-usb-3-1.3'

instead of the named variant

usb-hub-in-rack12:
  console-main:
    cls: 'USBSerialPort'
    match:
      '@ID_PATH': 'pci-0000:05:00.0-usb-3-1.3'

We use the former, because the exporter configuration is relatively static and the "role" of a specific resource only becomes relevant when we add it to a specific place.

With this change, we'd get a lot of redundant information in the output, like this:

rlabQ-srv/q-usb-3-p1/NetworkSerialPort[/USBSerialPort]
rlabQ-srv/q-usb-3-p2/NetworkSerialPort[/USBSerialPort]
rlabQ-srv/q-usb-4-p10/NetworkSerialPort[/USBSerialPort]
rlabQ-srv/q-usb-4-p3/NetworkSerialPort[/USBSerialPort]
rlabQ-srv/q-usb-4-p3-1.1/NetworkSerialPort[/USBSerialPort]
rlabQ-srv/q-usb-4-p3-1.2/NetworkSerialPort[/USBSerialPort]

which could confuse users. I'm not sure how to handle both approaches equally well.

[flxzt]

I'm not sure how to handle both approaches equally well.

Would it make sense to introduce a -n/--names flag instead, only additionally showing the resource names when enabled?