Merge branch 'master' into util/processwrapper

Author: ImHoppy

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/conf.py

@@ -223,7 +223,7 @@ def setup(app):
     # Make version and date stable when generating manpages as they will be tracked in git
     if app.outdir.parts[-1] == "man":
         app.config.version = ""
-        app.config.today_fmt = "%Y"
+        app.config.today = "2025"
     app.connect('builder-inited', run_apidoc)
     app.connect('doctree-read', write_literal_blocks)
 

doc/configuration.rst

@@ -3995,12 +3995,32 @@ something like ``{{ env['FOOBAR'] }}`` to insert the content of environment
 variable ``FOOBAR``.
 In addition to ``env`` the template also has access to the following variables:
 
-isolated
-  ``True`` or ``False``, depending on the :code:`--isolated` command line option.
+drop_ins
+  An alphabetically sorted list of files in a directory named after the
+  currently processed template with ".d" appended. For example if the template
+  is named ``/etc/labgrid/configuration.yaml`` the list will contain files
+  matching ``/etc/labgrid/configuration.yaml.d/*.yaml`` pattern. The paths are
+  relative to the directory containing the template (i.e. ``/etc/labgrid``
+  in our example). These files can be included using the ``include`` directive.
+  A template loading all its drop-ins at would look like this
+
+.. code-block::
+
+   # for f in drop_ins
+   {% include f %}
+   # endfor
+
+.. warning::
+   Use the ``{% include f %}`` form instead of ``# include f``, otherwise
+   Jinja2 would strip newline characters before concatenation, and thus break
+   the YAML formatting.
 
 hostname
   The hostname of the exporter host. Can be used to e.g. construct URLs to the
   current host (``http://{{ hostname }}/``).
 
+isolated
+  ``True`` or ``False``, depending on the :code:`--isolated` command line option.
+
 name
   The name of the exporter.

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

dockerfiles/Dockerfile

@@ -1,32 +1,29 @@
-FROM debian:bookworm-slim AS labgrid-base
-ARG VERSION
+FROM debian:trixie-slim AS labgrid-base
+ARG VERSION=0.0.0
 
 LABEL maintainer="eha@deif.com"
 
 ENV DEBIAN_FRONTEND=noninteractive
 
 COPY ./ /opt/labgrid/
 
-RUN set -e ;\
-    apt update -q=2 ;\
-    apt install -q=2 --yes --no-install-recommends python3 python3-dev python3-pip python3-setuptools git build-essential ;\
-    pip3 install --break-system-packages -U pip;\
-    apt clean ;\
-    rm -rf /var/lib/apt/lists/* ;\
-    cd /opt/labgrid ;\
-    SETUPTOOLS_SCM_PRETEND_VERSION="$VERSION" pip3 install --break-system-packages --no-cache-dir .
+RUN apt update -q=2 && \
+    apt install -q=2 --yes --no-install-recommends python3 python3-dev python3-pip python3-setuptools git build-essential && \
+    rm -rf /var/lib/apt/lists/* && \
+    pip3 config --site set global.break-system-packages true && \
+    pip3 config --site set global.root-user-action ignore && \
+    cd /opt/labgrid && \
+    SETUPTOOLS_SCM_PRETEND_VERSION="$VERSION" pip3 install --no-cache-dir .
 
 #
 # Client
 #
 FROM labgrid-base AS labgrid-client
 ARG VERSION
 
-RUN set -e ;\
-    pip3 install --break-system-packages yq ;\
-    apt update -q=2 ;\
-    apt install -q=2 --yes --no-install-recommends microcom openssh-client rsync jq qemu-system qemu-utils ;\
-    apt clean ;\
+RUN pip3 install yq && \
+    apt update -q=2  && \
+    apt install -q=2 --yes --no-install-recommends microcom openssh-client rsync jq qemu-system qemu-utils && \
     rm -rf /var/lib/apt/lists/*
 
 CMD ["/bin/bash"]
@@ -53,10 +50,8 @@ ARG VERSION
 
 COPY dockerfiles/exporter/entrypoint.sh /entrypoint.sh
 
-RUN set -e ;\
-    apt update -q=2 ;\
-    apt install -q=2 --yes --no-install-recommends ser2net ;\
-    apt clean ;\
+RUN apt update -q=2 && \
+    apt install -q=2 --yes --no-install-recommends ser2net && \
     rm -rf /var/lib/apt/lists/*
 
 VOLUME /opt/conf

dockerfiles/staging/dut/Dockerfile

@@ -1,17 +1,14 @@
-FROM debian:bookworm-slim
+FROM debian:trixie-slim
 
 LABEL org.opencontainers.image.authors="mail@krevsbech.dk"
 
 ENV DEBIAN_FRONTEND=noninteractive
 
-RUN set -e ;\
-    apt update -q=2 ;\
-    apt install -q=2 --yes --no-install-recommends openssh-server;\
-    apt clean ;\
-    rm -rf /var/lib/apt/lists/* ;\
-    mkdir /var/run/sshd ;\
-    echo 'root:PASSWORD' | chpasswd ;\
-    echo 'PermitRootLogin yes' >> /etc/ssh/sshd_config ;\
+RUN apt update -q=2 && \
+    apt install -q=2 --yes --no-install-recommends openssh-server && \
+    rm -rf /var/lib/apt/lists/* && \
+    echo 'root:PASSWORD' | chpasswd && \
+    echo 'PermitRootLogin yes' >> /etc/ssh/sshd_config && \
     sed 's@session\s*required\s*pam_loginuid.so@session optional pam_loginuid.so@g' -i /etc/pam.d/sshd
     # SSH login fix. Otherwise user is kicked off after login
 

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()

labgrid/remote/client.py

@@ -73,7 +73,9 @@ class ServerError(Error):
 
 
 class InteractiveCommandError(Error):
-    pass
+    def __init__(self: Error, msg: str, exitcode: int):
+        super(InteractiveCommandError, self).__init__(msg)
+        self.exitcode = exitcode
 
 
 class ErrorGroup(ExceptionGroup):
@@ -1099,9 +1101,7 @@ async def console(self, place, target):
                 break
             if not self.args.loop:
                 if res:
-                    exc = InteractiveCommandError("microcom error")
-                    exc.exitcode = res
-                    raise exc
+                    raise InteractiveCommandError("microcom error", res)
                 break
             await asyncio.sleep(1.0)
 
@@ -1301,27 +1301,21 @@ def ssh(self):
 
         res = drv.interact(self.args.leftover)
         if res:
-            exc = InteractiveCommandError("ssh error")
-            exc.exitcode = res
-            raise exc
+            raise InteractiveCommandError("ssh error", res)
 
     def scp(self):
         drv = self._get_ssh()
 
         res = drv.scp(src=self.args.src, dst=self.args.dst)
         if res:
-            exc = InteractiveCommandError("scp error")
-            exc.exitcode = res
-            raise exc
+            raise InteractiveCommandError("scp error", res)
 
     def rsync(self):
         drv = self._get_ssh()
 
         res = drv.rsync(src=self.args.src, dst=self.args.dst, extra=self.args.leftover)
         if res:
-            exc = InteractiveCommandError("rsync error")
-            exc.exitcode = res
-            raise exc
+            raise InteractiveCommandError("rsync error", res)
 
     def sshfs(self):
         drv = self._get_ssh()
@@ -1359,9 +1353,7 @@ def telnet(self):
         args = ["telnet", str(ip)]
         res = subprocess.call(args)
         if res:
-            exc = InteractiveCommandError("telnet error")
-            exc.exitcode = res
-            raise exc
+            raise InteractiveCommandError("telnet error", res)
 
     def video(self):
         place = self.get_acquired_place()
@@ -1397,9 +1389,7 @@ def video(self):
         else:
             res = drv.stream(quality, controls=controls)
             if res:
-                exc = InteractiveCommandError("gst-launch-1.0 error")
-                exc.exitcode = res
-                raise exc
+                raise InteractiveCommandError("gst-launch-1.0 error", res)
 
     def audio(self):
         place = self.get_acquired_place()
@@ -1408,9 +1398,7 @@ def audio(self):
         drv = self._get_driver_or_new(target, "USBAudioInputDriver", name=name)
         res = drv.play()
         if res:
-            exc = InteractiveCommandError("gst-launch-1.0 error")
-            exc.exitcode = res
-            raise exc
+            raise InteractiveCommandError("gst-launch-1.0 error", res)
 
     def _get_tmc(self):
         place = self.get_acquired_place()

labgrid/remote/config.py

@@ -1,5 +1,6 @@
 from pprint import pprint
 
+import glob
 import os
 
 import attr
@@ -15,15 +16,21 @@ class ResourceConfig:
     template_env = attr.ib(default=attr.Factory(dict), validator=attr.validators.instance_of(dict))
 
     def __attrs_post_init__(self):
+        _dirname = os.path.dirname(self.filename)
         env = jinja2.Environment(
-            loader=jinja2.FileSystemLoader(os.path.dirname(self.filename)),
+            loader=jinja2.FileSystemLoader(_dirname),
             line_statement_prefix="#",
             line_comment_prefix="##",
         )
         try:
             template = env.get_template(os.path.basename(self.filename))
         except jinja2.TemplateNotFound:
             raise NoConfigFoundError(f"{self.filename} could not be found")
+        drop_ins = [
+            os.path.relpath(p, _dirname) for p in sorted(glob.glob(os.path.join(self.filename + ".d", "*.yaml")))
+        ]
+
+        self.template_env["drop_ins"] = drop_ins
         rendered = template.render(self.template_env)
         pprint(("rendered", rendered))
         self.data = load(rendered)