b12f/nixpkgs
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

nixos/doc/running-nixos-tests-interactively: Describe interactive option

Browse source
This commit is contained in:
Robert Hensing 2022-06-15 18:04:41 +02:00
parent b0c781cc41
commit 6e2f753989
2 changed files with 31 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
nixos/doc/manual/development/running-nixos-tests-interactively.section.md
View file

@ -24,6 +24,8 @@ 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).
## Reuse VM state {#sec-nixos-test-reuse-vm-state}
You can re-use the VM states coming from a previous run by setting the
`--keep-vm-state` flag.
@ -33,3 +35,9 @@ $ ./result/bin/nixos-test-driver --keep-vm-state
The machine state is stored in the `$TMPDIR/vm-state-machinename`
directory.
## Interactive-only test configuration {#sec-nixos-test-interactive-configuration}
You can add configuration that is specific to the interactive test driver, by adding to the `interactive` option.
`interactive` is a copy of the regular test options namespace, and is used by the interactive test driver.
It can be helpful for troubleshooting changes that you don't want to apply to regular test runs.

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

@ -25,15 +25,29 @@ $ ./result/bin/nixos-test-driver
completion. This allows you to inspect the state of the VMs after
the test (e.g. to debug the test script).
</para>
<para>
You can re-use the VM states coming from a previous run by setting
the <literal>--keep-vm-state</literal> flag.
</para>
<programlisting>
<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>
<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>
You can add configuration that is specific to the interactive test
driver, by adding to the <literal>interactive</literal> option.
<literal>interactive</literal> is a copy of the regular test
options namespace, and is used by the interactive test driver. It
can be helpful for troubleshooting changes that you don’t want to
apply to regular test runs.
</para>
</section>
</section>