nixpkgs/nixos/doc/manual/development/nixos-tests.chapter.md

# NixOS Tests {#sec-nixos-tests}

When you add some feature to NixOS, you should write a test for it.
NixOS tests are kept in the directory `nixos/tests`, and are executed
(using Nix) by a testing framework that automatically starts one or more
virtual machines containing the NixOS system(s) required for the test.

```{=include=} sections
writing-nixos-tests.section.md
running-nixos-tests.section.md
running-nixos-tests-interactively.section.md
linking-nixos-tests-to-packages.section.md
```
nixos: nixos/doc/manual/devlopment/nixos-tests.xml to CommonMark 2021-09-08 07:41:57 +00:00			`# NixOS Tests {#sec-nixos-tests}`

			`When you add some feature to NixOS, you should write a test for it.`
			NixOS tests are kept in the directory `nixos/tests`, and are executed
			`(using Nix) by a testing framework that automatically starts one or more`
			`virtual machines containing the NixOS system(s) required for the test.`

nixos-render-docs: add structural includes, use for manual this adds support for structural includes to nixos-render-docs. structural includes provide a way to denote the (sub)structure of the nixos manual in the markdown source files, very similar to how we used literal docbook blocks before, and are processed by nixos-render-docs without involvement of xml tooling. this will ultimately allow us to emit the nixos manual in other formats as well, e.g. html, without going through docbook at all. alternatives to this source layout were also considered: a parallel structure using e.g. toml files that describe the document tree and links to each part is possible, but much more complicated to implement than the solution chosen here and makes it harder to follow which files have what substructure. it also makes it much harder to include a substructure in the middle of a file. much the same goes for command-line arguments to the converter, only that command-lined arguments are even harder to specify correctly and cannot be reasonably pulled together from many places without involving another layer of tooling. cli arguments would also mean that the manual structure would be fixed in default.nix, which is also not ideal. 2023-02-11 07:48:06 +00:00			```{=include=} sections
			`writing-nixos-tests.section.md`
			`running-nixos-tests.section.md`
			`running-nixos-tests-interactively.section.md`
			`linking-nixos-tests-to-packages.section.md`
nixos: nixos/doc/manual/devlopment/nixos-tests.xml to CommonMark 2021-09-08 07:41:57 +00:00			```