diff options
author | Domen Kožar <domen@dev.si> | 2015-04-21 02:27:40 -0400 |
---|---|---|
committer | Domen Kožar <domen@dev.si> | 2015-04-21 02:28:59 -0400 |
commit | f39b1ead2a5fba63be7cd77dd70c00c09d7f6aba (patch) | |
tree | 3b3e49e8e38e41a7b71024219bdafa06a02a0bd9 /nixos | |
parent | dbaeb7c42867bc4775ea81ec9ff997bbea987843 (diff) | |
download | nixpkgs-f39b1ead2a5fba63be7cd77dd70c00c09d7f6aba.tar nixpkgs-f39b1ead2a5fba63be7cd77dd70c00c09d7f6aba.tar.gz nixpkgs-f39b1ead2a5fba63be7cd77dd70c00c09d7f6aba.tar.bz2 nixpkgs-f39b1ead2a5fba63be7cd77dd70c00c09d7f6aba.tar.lz nixpkgs-f39b1ead2a5fba63be7cd77dd70c00c09d7f6aba.tar.xz nixpkgs-f39b1ead2a5fba63be7cd77dd70c00c09d7f6aba.tar.zst nixpkgs-f39b1ead2a5fba63be7cd77dd70c00c09d7f6aba.zip |
manual: re-add running nixos tests sections
Diffstat (limited to 'nixos')
4 files changed, 47 insertions, 40 deletions
diff --git a/nixos/doc/manual/development/development.xml b/nixos/doc/manual/development/development.xml index 747159c4427..2983c76c770 100644 --- a/nixos/doc/manual/development/development.xml +++ b/nixos/doc/manual/development/development.xml @@ -15,6 +15,7 @@ NixOS.</para> <xi:include href="writing-modules.xml" /> <xi:include href="building-parts.xml" /> <xi:include href="building-nixos.xml" /> +<xi:include href="nixos-tests.xml" /> <xi:include href="testing-installer.xml" /> </part> diff --git a/nixos/doc/manual/development/nixos-tests.xml b/nixos/doc/manual/development/nixos-tests.xml index a98da993330..c09c41ea3bd 100644 --- a/nixos/doc/manual/development/nixos-tests.xml +++ b/nixos/doc/manual/development/nixos-tests.xml @@ -15,5 +15,6 @@ required for the test.</para> <xi:include href="writing-nixos-tests.xml" /> <xi:include href="running-nixos-tests.xml" /> +<xi:include href="running-nixos-tests-interactively.xml" /> -</chapter> \ No newline at end of file +</chapter> diff --git a/nixos/doc/manual/development/running-nixos-tests-interactively.xml b/nixos/doc/manual/development/running-nixos-tests-interactively.xml new file mode 100644 index 00000000000..e4749077781 --- /dev/null +++ b/nixos/doc/manual/development/running-nixos-tests-interactively.xml @@ -0,0 +1,43 @@ +<section xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + version="5.0" + xml:id="sec-running-nixos-tests"> +<title>Running Tests interactively</title> + +<para>The test itself can be run interactively. This is +particularly useful when developing or debugging a test: + +<screen> +$ nix-build nixos/tests/login.nix -A driver +$ ./result/bin/nixos-test-driver +starting VDE switch for network 1 +> +</screen> + +You can then take any Perl statement, e.g. + +<screen> +> startAll +> testScript +> $machine->succeed("touch /tmp/foo") +</screen> + +The function <command>testScript</command> 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> + +<para>To just start and experiment with the VMs, run: + +<screen> +$ nix-build nixos/tests/login.nix -A driver +$ ./result/bin/nixos-run-vms +</screen> + +The script <command>nixos-run-vms</command> starts the virtual +machines defined by test. The root file system of the VMs is created +on the fly and kept across VM restarts in +<filename>./</filename><varname>hostname</varname><filename>.qcow2</filename>.</para> + +</section> diff --git a/nixos/doc/manual/development/running-nixos-tests.xml b/nixos/doc/manual/development/running-nixos-tests.xml index 156dcd205a5..908c0a66a32 100644 --- a/nixos/doc/manual/development/running-nixos-tests.xml +++ b/nixos/doc/manual/development/running-nixos-tests.xml @@ -2,7 +2,7 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" - xml:id="sec-running-nixos-tests"> + xml:id="sec-running-nixos-tests-interactively"> <title>Running Tests</title> @@ -38,42 +38,4 @@ $ firefox result/log.html </screen> </para> - -<title>Running Tests interactively</title> - -<para>The test itself can be run interactively. This is -particularly useful when developing or debugging a test: - -<screen> -$ nix-build nixos/tests/login.nix -A driver -$ ./result/bin/nixos-test-driver -starting VDE switch for network 1 -> -</screen> - -You can then take any Perl statement, e.g. - -<screen> -> startAll -> testScript -> $machine->succeed("touch /tmp/foo") -</screen> - -The function <command>testScript</command> 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> - -<para>To just start and experiment with the VMs, run: - -<screen> -$ nix-build nixos/tests/login.nix -A driver -$ ./result/bin/nixos-run-vms -</screen> - -The script <command>nixos-run-vms</command> starts the virtual -machines defined by test. The root file system of the VMs is created -on the fly and kept across VM restarts in -<filename>./</filename><varname>hostname</varname><filename>.qcow2</filename>.</para> - </section> |