nixos/tests/test-driver: document shell_interact

This commit is contained in:
Patrick Hilhorst 2021-06-02 14:49:59 +02:00
parent 5a589b5ba8
commit 9469433e34
No known key found for this signature in database
GPG key ID: 3BB083304DADC0FF
2 changed files with 12 additions and 1 deletions

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>

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