nixos/doc/manual/from_md/development/running-nixos-tests-interactively.section.xml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

<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
[...]
&gt;&gt;&gt;
</programlisting>
  <para>
    You can then take any Python statement, e.g.
  </para>
  <programlisting language="python">
&gt;&gt;&gt; start_all()
&gt;&gt;&gt; test_script()
&gt;&gt;&gt; machine.succeed(&quot;touch /tmp/foo&quot;)
&gt;&gt;&gt; print(machine.succeed(&quot;pwd&quot;)) # 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="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="opt-interactive"><literal>interactive</literal>
      submodule</link>.
    </para>
    <para>
      To interactively run only the regular configuration, build the
      <literal>&lt;test&gt;.driver</literal> attribute instead, and call
      it with the flag
      <literal>result/bin/nixos-test-driver --interactive</literal>.
    </para>
  </section>
</section>