Merge pull request #1794 from vzlu/minor-helper-updates

Minor helper updates

Author: Emantor

contrib/systemd/labgrid-exporter.service

@@ -11,6 +11,7 @@ EnvironmentFile=-/etc/environment
 ExecStart=/path/to/labgrid/venv/bin/labgrid-exporter /etc/labgrid/exporter.yaml
 Restart=always
 RestartSec=30
+# Replace 'DynamicUser=yes' with 'User=labgrid' and 'Group=labgrid' when using labgrid helpers with sudo.
 DynamicUser=yes
 # Adjust to your distribution (most often "dialout" or "tty")
 SupplementaryGroups=dialout plugdev

doc/getting_started.rst

@@ -379,6 +379,15 @@ Follow these instructions to install the systemd files on your machine(s):
    installation paths of your distribution.
 #. Adapt the ``ExecStart`` paths of the service files to the respective Python
    virtual environments of the coordinator and exporter.
+#. If you use labgrid helpers (see :file:`helpers/`) with sudo on exporter,
+   replace ``DynamicUser`` with ``User`` and ``Group`` in the
+   :file:`labgrid-exporter.service`:
+
+   .. code-block::
+
+      User=labgrid
+      Group=labgrid
+
 #. Adjust the ``SupplementaryGroups`` option in the
    :file:`labgrid-exporter.service` file to your distribution so that the
    exporter gains read and write access on TTY devices (for ``ser2net``); most

helpers/labgrid-bound-connect

@@ -1,4 +1,4 @@
-#!/usr/bin/python3 
+#!/usr/bin/python3
 
 # This is intended to be used via sudo. For example, add via visudo:
 # %developers ALL = NOPASSWD: /usr/local/sbin/labgrid-bound-connect
@@ -15,7 +15,7 @@ def main(ifname, address, port):
         raise ValueError("Empty interface name.")
     if any((c == "/" or c.isspace()) for c in ifname):
         raise ValueError(f"Interface name '{ifname}' contains invalid characters.")
-    if len(ifname) > 16:
+    if len(ifname) > 15:
         raise ValueError(f"Interface name '{ifname}' is too long.")
 
     address = ipaddress.ip_address(address)
@@ -36,7 +36,7 @@ def main(ifname, address, port):
         raise RuntimeError(f"Invalid IP version '{address.version}'")
 
     # Delete the IP lookup cache for the address in case it is stale
-    subprocess.run(["ip", "neigh", "del", str(address), "dev", ifname], 
+    subprocess.run(["ip", "neigh", "del", str(address), "dev", ifname],
         stdout=subprocess.DEVNULL,
         stderr=subprocess.DEVNULL
     )
@@ -78,4 +78,3 @@ if __name__ == "__main__":
             import traceback
             traceback.print_exc()
         print(f"ERROR: {e}", file=sys.stderr)
-

helpers/labgrid-raw-interface

@@ -38,7 +38,7 @@ def main(program, options):
         raise ValueError("Empty interface name.")
     if any((c == "/" or c.isspace()) for c in options.ifname):
         raise ValueError(f"Interface name '{options.ifname}' contains invalid characters.")
-    if len(options.ifname) > 16:
+    if len(options.ifname) > 15:
         raise ValueError(f"Interface name '{options.ifname}' is too long.")
 
     denylist = get_denylist()