summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--nixos/doc/manual/development/writing-nixos-tests.xml11
-rw-r--r--nixos/lib/test-driver/test-driver.py2
2 files changed, 12 insertions, 1 deletions
diff --git a/nixos/doc/manual/development/writing-nixos-tests.xml b/nixos/doc/manual/development/writing-nixos-tests.xml
index 5a95436915fa..c29f2b01064c 100644
--- a/nixos/doc/manual/development/writing-nixos-tests.xml
+++ b/nixos/doc/manual/development/writing-nixos-tests.xml
@@ -436,6 +436,17 @@ machine.systemctl("list-jobs --no-pager", "any-user") # spawns a shell for `any-
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>
+ <methodname>shell_interact</methodname>
+ </term>
+ <listitem>
+ <para>
+ Allows you to directly interact with the guest shell.
+ This should only be used during test development, not in production tests.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
</para>
diff --git a/nixos/lib/test-driver/test-driver.py b/nixos/lib/test-driver/test-driver.py
index 90ae2e558ef5..6669c914f76e 100644
--- a/nixos/lib/test-driver/test-driver.py
+++ b/nixos/lib/test-driver/test-driver.py
@@ -459,7 +459,7 @@ class Machine:
def shell_interact(self) -> None:
"""Allows you to interact with the guest shell
- Should only be used during testing, not in the production test."""
+ Should only be used during test development, not in the production test."""
self.connect()
telnet = telnetlib.Telnet()
telnet.sock = self.shell # type: ignore