public
/
nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

nixos/tests/test-driver: document shell_interact 

(cherry picked from commit 9469433e341f7337308468bb4b9ccfff84b2951b)
This commit is contained in:
Patrick Hilhorst 2021-06-02 14:49:59 +02:00 committed by github-actions[bot]
parent e3e37d20ce
commit 9046996543
2 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
nixos/doc/manual/development/writing-nixos-tests.xml
View File

@ -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>

2
nixos/lib/test-driver/test-driver.py
View File

@ -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