Feature: client: Add scp multifile support

[sgross-emlix]

Description

Implement -r and [SOURCES...] [DESTINATION] for scp
Collegues requested this feature since it matches the expectation on how to use the widely known scp command.

Checklist

• Documentation for the feature
• PR has been tested

to Target

labgrid@phoebe:~/client$ lgc scp dummy/bar dummy/foo :/tmp
bar                                                                                                                                                                                100%    3     1.2KB/s 00:00
foo                                                                                                                                                                                100%    5     3.3KB/s   00:00
labgrid@phoebe:~/client$ lgc scp -r dummy :/tmp
foo                                                                                                                                                                                100%    5     2.6KB/s   00:00
bar                                                                                                                                                                                100%    3     1.7KB/s   00:00
labgrid@phoebe:~/client$ lgc ssh


BusyBox v1.34.1 () built-in shell (ash)

# cd /tmp
# ls
WebKitCache          bar                  env.yml              foo                  mesa_shader_cache    weston
avahi-daemon.socket  dummy                fontconfig           hsts-storage.sqlite  update-tool.lock
# cd dummy/
# ls
bar  foo

from Target

labgrid@phoebe:~/client$ mkdir rev
labgrid@phoebe:~/client$ lgc scp :/tmp/dummy/foo :/tmp/dummy/bar rev/
foo                                                                                                                                                                                100%    5     1.0KB/s   00:00
bar                                                                                                                                                                                100%    3     0.8KB/s   00:00
labgrid@phoebe:~/client$ lgc scp -r :/tmp/dummy rev
bar                                                                                                                                                                                100%    3     0.4KB/s   00:00
foo    
labgrid@phoebe:~/client$ find rev
rev
rev/dummy
rev/dummy/foo
rev/dummy/bar
rev/foo
rev/bar

• Man pages have been regenerated

[codecov]

Codecov Report

❌ Patch coverage is 76.47059% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 45.2%. Comparing base (2f0bdf1) to head (1b2997c).
✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
labgrid/remote/client.py	0.0%	3 Missing ⚠️
labgrid/driver/sshdriver.py	92.8%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff            @@
##           master   #1769     +/-   ##
========================================
+ Coverage    45.1%   45.2%   +0.1%     
========================================
  Files         172     172             
  Lines       13618   13626      +8     
========================================
+ Hits         6144    6163     +19     
+ Misses       7474    7463     -11     

Flag	Coverage Δ
3.10	45.2% <76.4%> (+0.1%)	⬆️
3.11	45.2% <76.4%> (+0.1%)	⬆️
3.12	45.2% <76.4%> (+0.1%)	⬆️
3.13	45.2% <76.4%> (+0.1%)	⬆️
3.14	45.2% <76.4%> (+0.1%)	⬆️
3.9	45.2% <76.4%> (+0.1%)	⬆️

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

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

[sgross-emlix]

I would like to update tests, but I have no idea where to start. test_sshdriver looks confusing to me

[jluebbe]

You can pull out bb72bc0 into a separate PR so we can merge that early.

[jluebbe]

You should be able to just use nargs="+" for src and keep the separate dst argument.

[jluebbe]

You can use *src to avoid the insert loop below.

[jluebbe]

We need to consider backwards compatibility here. So, if src is a string, wrap it in a list.

[jluebbe]

You need to check that either all src elements start with ':' or none of them do.

So perhaps first something like

remote_src = [f.startswith(':') for f in src]
if any(remote_src) != all(remote_src):
   raise ValueError("All sources must be consistently local or remote (start with :)")

before the other checks?

[jluebbe]

I would like to update tests, but I have no idea where to start. test_sshdriver looks confusing to me

Use test_local_put() as an example. To run those tests, you first need to have ssh localhost working outside of pytest (via pubkey auth). Then run the tests with --ssh-username=<your username>.

In the test, make two directories via in the tmpdir fixture and transfer beween them.