64 lines
2.4 KiB
XML
64 lines
2.4 KiB
XML
<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-running-nixos-tests-interactively">
|
|
<title>Running Tests interactively</title>
|
|
<para>
|
|
The test itself can be run interactively. This is particularly
|
|
useful when developing or debugging a test:
|
|
</para>
|
|
<programlisting>
|
|
$ nix-build . -A nixosTests.login.driverInteractive
|
|
$ ./result/bin/nixos-test-driver
|
|
[...]
|
|
>>>
|
|
</programlisting>
|
|
<para>
|
|
You can then take any Python statement, e.g.
|
|
</para>
|
|
<programlisting language="python">
|
|
>>> start_all()
|
|
>>> test_script()
|
|
>>> machine.succeed("touch /tmp/foo")
|
|
>>> print(machine.succeed("pwd")) # Show stdout of command
|
|
</programlisting>
|
|
<para>
|
|
The function <literal>test_script</literal> executes the entire test
|
|
script and drops you back into the test driver command line upon its
|
|
completion. This allows you to inspect the state of the VMs after
|
|
the test (e.g. to debug the test script).
|
|
</para>
|
|
<section xml:id="sec-nixos-test-reuse-vm-state">
|
|
<title>Reuse VM state</title>
|
|
<para>
|
|
You can re-use the VM states coming from a previous run by setting
|
|
the <literal>--keep-vm-state</literal> flag.
|
|
</para>
|
|
<programlisting>
|
|
$ ./result/bin/nixos-test-driver --keep-vm-state
|
|
</programlisting>
|
|
<para>
|
|
The machine state is stored in the
|
|
<literal>$TMPDIR/vm-state-machinename</literal> directory.
|
|
</para>
|
|
</section>
|
|
<section xml:id="sec-nixos-test-interactive-configuration">
|
|
<title>Interactive-only test configuration</title>
|
|
<para>
|
|
The <literal>.driverInteractive</literal> attribute combines the
|
|
regular test configuration with definitions from the
|
|
<link linkend="test-opt-interactive"><literal>interactive</literal>
|
|
submodule</link>. This gives you a more usable, graphical, but
|
|
slightly different configuration.
|
|
</para>
|
|
<para>
|
|
You can add your own interactive-only test configuration by adding
|
|
extra configuration to the
|
|
<link linkend="test-opt-interactive"><literal>interactive</literal>
|
|
submodule</link>.
|
|
</para>
|
|
<para>
|
|
To interactively run only the regular configuration, build the
|
|
<literal><test>.driver</literal> attribute instead, and call
|
|
it with the flag
|
|
<literal>result/bin/nixos-test-driver --interactive</literal>.
|
|
</para>
|
|
</section>
|
|
</section>
|