mirror of
https://github.com/NixOS/nixpkgs.git
synced 2024-11-17 07:13:23 +01:00
nixos: nixos/doc/manual/development/running-nixos-tests.xml to CommonMark
This commit is contained in:
Bobby Rong
parent
163976c296
commit
8fafcfa3ea
4 changed files with 66 additions and 37 deletions
|
|
@ -14,6 +14,6 @@ xlink:href="https://github.com/NixOS/nixpkgs/tree/master/nixos/tests">nixos/test
|
||||||
test.
|
test.
|
||||||
</para>
|
</para>
|
||||||
<xi:include href="../from_md/development/writing-nixos-tests.section.xml" />
|
<xi:include href="../from_md/development/writing-nixos-tests.section.xml" />
|
||||||
<xi:include href="running-nixos-tests.xml" />
|
<xi:include href="../from_md/development/running-nixos-tests.section.xml" />
|
||||||
<xi:include href="running-nixos-tests-interactively.xml" />
|
<xi:include href="running-nixos-tests-interactively.xml" />
|
||||||
</chapter>
|
</chapter>
|
||||||
|
|
|
||||||
31
nixos/doc/manual/development/running-nixos-tests.section.md
Normal file
31
nixos/doc/manual/development/running-nixos-tests.section.md
Normal file
|
|
@ -0,0 +1,31 @@
|
||||||
|
# Running Tests {#sec-running-nixos-tests}
|
||||||
|
|
||||||
|
You can run tests using `nix-build`. For example, to run the test
|
||||||
|
[`login.nix`](https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/login.nix),
|
||||||
|
you just do:
|
||||||
|
|
||||||
|
```ShellSession
|
||||||
|
$ nix-build '<nixpkgs/nixos/tests/login.nix>'
|
||||||
|
```
|
||||||
|
|
||||||
|
or, if you don't want to rely on `NIX_PATH`:
|
||||||
|
|
||||||
|
```ShellSession
|
||||||
|
$ cd /my/nixpkgs/nixos/tests
|
||||||
|
$ nix-build login.nix
|
||||||
|
…
|
||||||
|
running the VM test script
|
||||||
|
machine: QEMU running (pid 8841)
|
||||||
|
…
|
||||||
|
6 out of 6 tests succeeded
|
||||||
|
```
|
||||||
|
|
||||||
|
After building/downloading all required dependencies, this will perform
|
||||||
|
a build that starts a QEMU/KVM virtual machine containing a NixOS
|
||||||
|
system. The virtual machine mounts the Nix store of the host; this makes
|
||||||
|
VM creation very fast, as no disk image needs to be created. Afterwards,
|
||||||
|
you can view a pretty-printed log of the test:
|
||||||
|
|
||||||
|
```ShellSession
|
||||||
|
$ firefox result/log.html
|
||||||
|
```
|
||||||
|
|
@ -1,36 +0,0 @@
|
||||||
<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</title>
|
|
||||||
|
|
||||||
<para>
|
|
||||||
You can run tests using <command>nix-build</command>. For example, to run the
|
|
||||||
test
|
|
||||||
<filename
|
|
||||||
xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/login.nix">login.nix</filename>,
|
|
||||||
you just do:
|
|
||||||
<screen>
|
|
||||||
<prompt>$ </prompt>nix-build '<nixpkgs/nixos/tests/login.nix>'
|
|
||||||
</screen>
|
|
||||||
or, if you don’t want to rely on <envar>NIX_PATH</envar>:
|
|
||||||
<screen>
|
|
||||||
<prompt>$ </prompt>cd /my/nixpkgs/nixos/tests
|
|
||||||
<prompt>$ </prompt>nix-build login.nix
|
|
||||||
…
|
|
||||||
running the VM test script
|
|
||||||
machine: QEMU running (pid 8841)
|
|
||||||
…
|
|
||||||
6 out of 6 tests succeeded
|
|
||||||
</screen>
|
|
||||||
After building/downloading all required dependencies, this will perform a
|
|
||||||
build that starts a QEMU/KVM virtual machine containing a NixOS system. The
|
|
||||||
virtual machine mounts the Nix store of the host; this makes VM creation very
|
|
||||||
fast, as no disk image needs to be created. Afterwards, you can view a
|
|
||||||
pretty-printed log of the test:
|
|
||||||
<screen>
|
|
||||||
<prompt>$ </prompt>firefox result/log.html
|
|
||||||
</screen>
|
|
||||||
</para>
|
|
||||||
</section>
|
|
||||||
|
|
@ -0,0 +1,34 @@
|
||||||
|
<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-running-nixos-tests">
|
||||||
|
<title>Running Tests</title>
|
||||||
|
<para>
|
||||||
|
You can run tests using <literal>nix-build</literal>. For example,
|
||||||
|
to run the test
|
||||||
|
<link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/login.nix"><literal>login.nix</literal></link>,
|
||||||
|
you just do:
|
||||||
|
</para>
|
||||||
|
<programlisting>
|
||||||
|
$ nix-build '<nixpkgs/nixos/tests/login.nix>'
|
||||||
|
</programlisting>
|
||||||
|
<para>
|
||||||
|
or, if you don’t want to rely on <literal>NIX_PATH</literal>:
|
||||||
|
</para>
|
||||||
|
<programlisting>
|
||||||
|
$ cd /my/nixpkgs/nixos/tests
|
||||||
|
$ nix-build login.nix
|
||||||
|
…
|
||||||
|
running the VM test script
|
||||||
|
machine: QEMU running (pid 8841)
|
||||||
|
…
|
||||||
|
6 out of 6 tests succeeded
|
||||||
|
</programlisting>
|
||||||
|
<para>
|
||||||
|
After building/downloading all required dependencies, this will
|
||||||
|
perform a build that starts a QEMU/KVM virtual machine containing a
|
||||||
|
NixOS system. The virtual machine mounts the Nix store of the host;
|
||||||
|
this makes VM creation very fast, as no disk image needs to be
|
||||||
|
created. Afterwards, you can view a pretty-printed log of the test:
|
||||||
|
</para>
|
||||||
|
<programlisting>
|
||||||
|
$ firefox result/log.html
|
||||||
|
</programlisting>
|
||||||
|
</section>
|
||||||
Loading…
Reference in a new issue