From ce94e2c605c8a2efee81d9cd030f1da582addcc7 Mon Sep 17 00:00:00 2001
From: Benedikt Peetz <benedikt.peetz@b-peetz.de>
Date: Fri, 2 Oct 2026 00:29:54 +0200
Subject: tests/default: Document the `runTest` arguments

Ideally they would be a module :/.
---
 tests/default.nix | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/tests/default.nix b/tests/default.nix
index af9cdd3..b9c3cbd 100644
--- a/tests/default.nix
+++ b/tests/default.nix
@@ -17,11 +17,22 @@
 
   vhack.runTest = {
     name,
+    # Node definition, like in a normal nixos vm test.
     nodes ? {},
+    # Server domains that all clients and the server can resolve via dns.
+    # The format follows the common one, e.g.:
+    # `{nodeName = "domain.example.com";}`
+    # means, that `domain.example.com` resolves to the node with name `nodeName`.
     serverDomains ? [],
-    testScript ? {_, ...}: "",
+    # Services to wait for.
+    # The format follows the common one, e.g.:
+    # `{nodeName = "example.service";}`
+    # means, that the test will not start, until `example.service` on the node with name
+    # `nodeName` has started.
     services ? [],
+    # If `true`, will ignore this test.
     ignore ? null,
+    testScript ? {_, ...}: "",
   }: let
     # Apparently the default's (e.g. `serivces ? []`), are not applied for the `@args`
     # syntax.
-- 
cgit v1.3.1