nixos/test-driver: add support for nspawn containers

nixos/lib/test-driver/default.nix

@@ -19,9 +19,12 @@
   qemu_test,
   setuptools,
   socat,
+  systemd,
   tesseract4,
+  util-linux,
   vde2,
 
+  enableNspawn ? false,
   enableOCR ? false,
   extraPythonPackages ? (_: [ ]),
 }:
@@ -51,8 +54,12 @@ buildPythonApplication {
     netpbm
     qemu_pkg
     socat
+    util-linux
     vde2
   ]
+  ++ lib.optionals enableNspawn [
+    systemd
+  ]
   ++ lib.optionals enableOCR [
     imagemagick_light
     tesseract4

nixos/lib/test-driver/src/extract-docstrings.py

@@ -51,7 +51,7 @@ def main() -> None:
 
     class_definitions = (node for node in module.body if isinstance(node, ast.ClassDef))
 
-    machine_class = next(filter(lambda x: x.name == "Machine", class_definitions))
+    machine_class = next(filter(lambda x: x.name == "BaseMachine", class_definitions))
     assert machine_class is not None
 
     function_definitions = [

nixos/lib/test-driver/src/test_driver/__init__.py

@@ -1,6 +1,8 @@
 import argparse
 import os
+import sys
 import time
+import warnings
 from pathlib import Path
 
 import ptpython.ipython
@@ -16,7 +18,7 @@
 
 
 class EnvDefault(argparse.Action):
-    """An argpars Action that takes values from the specified
+    """An argparse Action that takes values from the specified
     environment variable as the flags default value.
     """
 
@@ -55,9 +57,15 @@ def writeable_dir(arg: str) -> Path:
 def main() -> None:
     arg_parser = argparse.ArgumentParser(prog="nixos-test-driver")
     arg_parser.add_argument(
-        "-K",
         "--keep-vm-state",
-        help="re-use a VM state coming from a previous run",
+        help=argparse.SUPPRESS,
+        dest="keep_machine_state",
+        action="store_true",
+    )
+    arg_parser.add_argument(
+        "-K",
+        "--keep-machine-state",
+        help="re-use a machine state coming from a previous run",
         action="store_true",
     )
     arg_parser.add_argument(
@@ -71,13 +79,37 @@ def main() -> None:
         help="Enable interactive debugging breakpoints for sandboxed runs",
     )
     arg_parser.add_argument(
-        "--start-scripts",
-        metavar="START-SCRIPT",
+        "--vm-names",
+        metavar="VM-NAME",
         action=EnvDefault,
-        envvar="startScripts",
+        envvar="vmNames",
+        nargs="*",
+        help="names of participating virtual machines",
+    )
+    arg_parser.add_argument(
+        "--vm-start-scripts",
+        metavar="VM-START-SCRIPT",
+        action=EnvDefault,
+        envvar="vmStartScripts",
         nargs="*",
         help="start scripts for participating virtual machines",
     )
+    arg_parser.add_argument(
+        "--container-names",
+        metavar="CONTAINER-NAME",
+        action=EnvDefault,
+        envvar="containerNames",
+        nargs="*",
+        help="names of participating containers",
+    )
+    arg_parser.add_argument(
+        "--container-start-scripts",
+        metavar="CONTAINER-START-SCRIPT",
+        action=EnvDefault,
+        envvar="containerStartScripts",
+        nargs="*",
+        help="start scripts for participating containers",
+    )
     arg_parser.add_argument(
         "--vlans",
         metavar="VLAN",
@@ -97,8 +129,8 @@ def main() -> None:
     arg_parser.add_argument(
         "-o",
         "--output_directory",
-        help="""The path to the directory where outputs copied from the VM will be placed.
-                By e.g. Machine.copy_from_vm or Machine.screenshot""",
+        help="""The path to the directory where outputs copied from the machine will be placed.
+                By e.g. NspawnMachine.copy_from_machine or QemuMachine.screenshot""",
         default=Path.cwd(),
         type=writeable_dir,
     )
@@ -122,6 +154,12 @@ def main() -> None:
 
     args = arg_parser.parse_args()
 
+    if "--keep-vm-state" in sys.argv:
+        warnings.warn(
+            "The flag '--keep-vm-state' is deprecated. Use '--keep-machine-state' instead.",
+            DeprecationWarning,
+        )
+
     output_directory = args.output_directory.resolve()
     logger = CompositeLogger([TerminalLogger()])
 
@@ -131,21 +169,33 @@ def main() -> None:
     if args.junit_xml:
         logger.add_logger(JunitXMLLogger(output_directory / args.junit_xml))
 
-    if not args.keep_vm_state:
-        logger.info("Machine state will be reset. To keep it, pass --keep-vm-state")
+    if not args.keep_machine_state:
+        logger.info(
+            "Machine state will be reset. To keep it, pass --keep-machine-state"
+        )
 
     debugger: DebugAbstract = DebugNop()
     if args.debug_hook_attach is not None:
         debugger = Debug(logger, args.debug_hook_attach)
 
+    assert len(args.vm_names) == len(args.vm_start_scripts), (
+        f"the number of vm names and vm start scripts must be the same: {args.vm_names} vs. {args.vm_start_scripts}"
+    )
+    assert len(args.container_names) == len(args.container_start_scripts), (
+        f"the number of container names and container start scripts must be the same: {args.container_names} vs. {args.container_start_scripts}"
+    )
+
     with Driver(
-        args.start_scripts,
-        args.vlans,
-        args.testscript.read_text(),
-        output_directory,
-        logger,
-        args.keep_vm_state,
-        args.global_timeout,
+        vm_names=args.vm_names,
+        vm_start_scripts=args.vm_start_scripts,
+        container_names=args.container_names,
+        container_start_scripts=args.container_start_scripts,
+        vlans=args.vlans,
+        tests=args.testscript.read_text(),
+        out_dir=output_directory,
+        logger=logger,
+        keep_machine_state=args.keep_machine_state,
+        global_timeout=args.global_timeout,
         debug=debugger,
     ) as driver:
         if offset := args.dump_vsocks:
@@ -170,7 +220,16 @@ def generate_driver_symbols() -> None:
     in user's test scripts. That list is then used by pyflakes to lint those
     scripts.
     """
-    d = Driver([], [], "", Path(), CompositeLogger([]))
+    d = Driver(
+        vm_names=[],
+        vm_start_scripts=[],
+        container_names=[],
+        container_start_scripts=[],
+        vlans=[],
+        tests="",
+        out_dir=Path(),
+        logger=CompositeLogger([]),
+    )
     test_symbols = d.test_symbols()
     with open("driver-symbols", "w") as fp:
         fp.write(",".join(test_symbols.keys()))