remote/client: add write-files command

Analogously to write-image, add a write-file command that can be used to
overwrite (or create anew) a single file in a file system located on a
USBStorageDriver. This is useful for faster iteration during bootloader
development when a bootloader is loaded from a file system.

Following usages are supported:

  labgrid-client write-files a b      # writes files a, b into /mnt/
  labgrid-client write-files -t a b c # writes files b, c into /mnt/a/
  labgrid-client write-files -T a b   # writes file  b      to /mnt/a

Where /mnt is some dynamic path on the, possibly remote, host exporting
the USBStorageDriver.

Signed-off-by: Stefan Wiehler <stefan.wiehler@missinglinkelectronics.com>
Co-authored-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
Signed-off-by: Bastian Krause <bst@pengutronix.de>

Author: 2 people

CHANGES.rst

@@ -12,6 +12,8 @@ New Features in 24.0
   to the serial console during testing.
 - The `QEMUDriver` now has an additional ``disk_opts`` property which can be
   used to pass additional options for the disk directly to QEMU
+- labgrid-client now has a ``write-files`` subcommand to copy files onto mass
+  storage devices.
 
 Bug fixes in 24.0
 ~~~~~~~~~~~~~~~~~

contrib/completion/labgrid-client.bash

@@ -769,6 +769,40 @@ _labgrid_client_write_image()
     esac
 }
 
+_labgrid_client_write_files()
+{
+    local cur prev words cword
+    _init_completion || return
+
+    case "$prev" in
+    -w|--wait)
+        ;&
+    -p|--partition)
+        ;&
+    -t|--target-directory)
+        ;&
+    -T)
+        ;&
+    -n|--name)
+        _labgrid_complete match-names "$cur"
+        return
+        ;;
+    esac
+
+    case "$cur" in
+    -*)
+        local options="--wait --partition --target-directory --name $_labgrid_shared_options"
+        COMPREPLY=( $(compgen -W "$options" -- "$cur") )
+        ;;
+    *)
+        local args
+        _labgrid_count_args "@(-w|--wait|-p|--partition|-t|--target-directory|-T|-n|--name)" || return
+
+        _filedir
+        ;;
+    esac
+}
+
 _labgrid_client_reserve()
 {
     _labgrid_client_generic_subcommand "--wait --shell --prio"
@@ -888,6 +922,7 @@ _labgrid_client()
                                audio \
                                tmc \
                                write-image \
+                               write-files \
                                reserve \
                                cancel-reservation \
                                wait \

labgrid/remote/client.py

@@ -5,6 +5,7 @@
 import contextlib
 import enum
 import os
+import pathlib
 import subprocess
 import traceback
 import logging
@@ -1214,6 +1215,32 @@ def tmc_channel(self):
         for k, v in sorted(data.items()):
             print(f"{k:<16s} {str(v):<10s}")
 
+    def write_files(self):
+        place = self.get_acquired_place()
+        target = self._get_target(place)
+        name = self.args.name
+        drv = self._get_driver_or_new(target, "USBStorageDriver", activate=False, name=name)
+        drv.storage.timeout = self.args.wait
+        target.activate(drv)
+
+        try:
+            if self.args.partition == 0:
+                self.args.partition = None
+
+            if self.args.rename:
+                if len(self.args.SOURCE) != 2:
+                    self.args.parser.error("the following arguments are required: SOURCE DEST")
+
+                drv.write_files([self.args.SOURCE[0]], self.args.SOURCE[1],
+                                self.args.partition, target_is_directory=False)
+            else:
+                drv.write_files(self.args.SOURCE, self.args.target_directory,
+                                self.args.partition, target_is_directory=True)
+        except subprocess.CalledProcessError as e:
+            raise UserError(f"could not copy files to network usb storage: {e}")
+        except FileNotFoundError as e:
+            raise UserError(e)
+
     def write_image(self):
         place = self.get_acquired_place()
         target = self._get_target(place)
@@ -1761,6 +1788,27 @@ def main():
     tmc_subparser.add_argument('action', choices=['info', 'values'])
     tmc_subparser.set_defaults(func=ClientSession.tmc_channel)
 
+    subparser = subparsers.add_parser('write-files', help="copy files onto mass storage device",
+                                      usage="%(prog)s [OPTION]... -T SOURCE DEST\n" +
+                                     "       %(prog)s [OPTION]... [-t DIRECTORY] SOURCE...")
+    subparser.add_argument('-w', '--wait', type=float, default=10.0,
+                           help='storage poll timeout in seconds')
+    subparser.add_argument('-p', '--partition', type=int, choices=range(0, 256),
+                           metavar='0-255', default=1,
+                           help='partition number to mount or 0 to mount whole disk (default: %(default)s)')
+    group = subparser.add_mutually_exclusive_group()
+    group.add_argument('-t', '--target-directory', type=pathlib.PurePath, metavar='DIRECTORY',
+                           default=pathlib.PurePath("/"),
+                           help='copy all SOURCE files into DIRECTORY (default: partition root)')
+    group.add_argument('-T', action='store_true', dest='rename',
+                           help='copy SOURCE file and rename to DEST')
+    subparser.add_argument('--name', '-n', help="optional resource name")
+    subparser.add_argument('SOURCE', type=pathlib.PurePath, nargs='+',
+                           help='source file(s) to copy')
+    subparser.add_argument('DEST', type=pathlib.PurePath, nargs='?',
+                           help='destination file name for SOURCE')
+    subparser.set_defaults(func=ClientSession.write_files, parser=subparser)
+
     subparser = subparsers.add_parser('write-image', help="write an image onto mass storage")
     subparser.add_argument('-w', '--wait', type=float, default=10.0)
     subparser.add_argument('-p', '--partition', type=int, help="partition number to write to")

man/labgrid-client.1

@@ -219,6 +219,8 @@ not at all.
 .sp
 \fBtmc\fP command                 Control a USB TMC device
 .sp
+\fBwrite\-files\fP filename(s)     Copy files onto mass storage device
+.sp
 \fBwrite\-image\fP                 Write images onto block devices (USBSDMux, USB Sticks, …)
 .sp
 \fBreserve\fP filter              Create a reservation

man/labgrid-client.rst

@@ -211,6 +211,8 @@ LABGRID-CLIENT COMMANDS
 
 ``tmc`` command                 Control a USB TMC device
 
+``write-files`` filename(s)     Copy files onto mass storage device
+
 ``write-image``                 Write images onto block devices (USBSDMux, USB Sticks, …)
 
 ``reserve`` filter              Create a reservation