From 9372904a3594893bb21ae36e1de03c7d3bf6776b Mon Sep 17 00:00:00 2001 From: Maximilian Bosch Date: Sun, 20 Jul 2025 15:46:14 +0200 Subject: [PATCH] nixos/doc: clarify scope of debugHook feature in the test driver As discussed with tfc before, it's probably better in most cases to try the interactive test-driver with the SSH backdoor first and resort to this feature for flaky tests. --- .../manual/development/writing-nixos-tests.section.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/nixos/doc/manual/development/writing-nixos-tests.section.md b/nixos/doc/manual/development/writing-nixos-tests.section.md index f69ea279abb5..9751dbd7ff49 100644 --- a/nixos/doc/manual/development/writing-nixos-tests.section.md +++ b/nixos/doc/manual/development/writing-nixos-tests.section.md @@ -343,6 +343,15 @@ source: @NIXOS_TEST_OPTIONS_JSON@ ## Accessing VMs in the sandbox with SSH {#sec-test-sandbox-breakpoint} +::: {.note} +For debugging with SSH access into the machines, it's recommended to try using +[the interactive driver](#sec-running-nixos-tests-interactively) with its +[SSH backdoor](#sec-nixos-test-ssh-access) first. + +This feature is mostly intended to debug flaky test failures that aren't +reproducible elsewhere. +::: + As explained in [](#sec-nixos-test-ssh-access), it's possible to configure an SSH backdoor based on AF_VSOCK. This can be used to SSH into a VM of a running build in a sandbox.