nixos/doc/manual/development/running-nixos-tests.section.md

   1 # Running Tests {#sec-running-nixos-tests}
   2
   3 You can run tests using `nix-build`. For example, to run the test
   4 [`login.nix`](https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/login.nix),
   5 you do:
   6
   7 ```ShellSession
   8 $ cd /my/git/clone/of/nixpkgs
   9 $ nix-build -A nixosTests.login
  10 ```
  11
  12 After building/downloading all required dependencies, this will perform
  13 a build that starts a QEMU/KVM virtual machine containing a NixOS
  14 system. The virtual machine mounts the Nix store of the host; this makes
  15 VM creation very fast, as no disk image needs to be created. Afterwards,
  16 you can view a log of the test:
  17
  18 ```ShellSession
  19 $ nix-store --read-log result
  20 ```
  21
  22 ## System Requirements {#sec-running-nixos-tests-requirements}
  23
  24 NixOS tests require virtualization support.
  25 This means that the machine must have `kvm` in its [system features](https://nixos.org/manual/nix/stable/command-ref/conf-file.html?highlight=system-features#conf-system-features) list, or `apple-virt` in case of macOS.
  26 These features are autodetected locally, but `apple-virt` is only autodetected since Nix 2.19.0.
  27
  28 Features of **remote builders** must additionally be configured manually on the client, e.g. on NixOS with [`nix.buildMachines.*.supportedFeatures`](https://search.nixos.org/options?show=nix.buildMachines.*.supportedFeatures&sort=alpha_asc&query=nix.buildMachines) or through general [Nix configuration](https://nixos.org/manual/nix/stable/advanced-topics/distributed-builds).
  29
  30 If you run the tests on a **macOS** machine, you also need a "remote" builder for Linux; possibly a VM. [nix-darwin](https://daiderd.com/nix-darwin/) users may enable [`nix.linux-builder.enable`](https://daiderd.com/nix-darwin/manual/index.html#opt-nix.linux-builder.enable) to launch such a VM.