···

       
537
       
 
       


     

       
538
       
 
       
Tests are important to ensure quality and make reviews and automatic updates easy.

     

       
539
       
 
       


     

       
540
       
-
       
Nix package tests are a lightweight alternative to [NixOS module tests](https://nixos.org/manual/nixos/stable/#sec-nixos-tests). They can be used to create simple integration tests for packages while the module tests are used to test services or programs with a graphical user interface on a NixOS VM. Unittests that are included in the source code of a package should be executed in the `checkPhase`.

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
541
       
 
       


     

       
542
       
 
       
### Writing package tests {#ssec-package-tests-writing}

     

       
543
       
 
       


     
···

       
602
       
 
       
- [Spacy annotation test](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/python-modules/spacy/annotation-test/default.nix)

     

       
603
       
 
       
- [Libtorch test](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/libraries/science/math/libtorch/test/default.nix)

     

       
604
       
 
       
- [Multiple tests for nanopb](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/libraries/nanopb/default.nix)

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

···

       
537
       
 
       


     

       
538
       
 
       
Tests are important to ensure quality and make reviews and automatic updates easy.

     

       
539
       
 
       


     

       
540
       
+
       
The following types of tests exists:

     

       
541
       
+
       


     

       
542
       
+
       
* [NixOS **module tests**](https://nixos.org/manual/nixos/stable/#sec-nixos-tests), which spawn one or more NixOS VMs. They exercise both NixOS modules and the packaged programs used within them. For example, a NixOS module test can start a web server VM running the `nginx` module, and a client VM running `curl` or a graphical `firefox`, and test that they can talk to each other and display the correct content.

     

       
543
       
+
       
* Nix **package tests** are a lightweight alternative to NixOS module tests. They should be used to create simple integration tests for packages, but cannot test NixOS services, and some programs with graphical user interfaces may also be difficult to test with them.

     

       
544
       
+
       
* The **`checkPhase` of a package**, which should execute the unit tests that are included in the source code of a package.

     

       
545
       
+
       


     

       
546
       
+
       
Here in the nixpkgs manual we describe mostly _package tests_; for _module tests_ head over to the corresponding [section in the NixOS manual](https://nixos.org/manual/nixos/stable/#sec-nixos-tests).

     

       
547
       
 
       


     

       
548
       
 
       
### Writing package tests {#ssec-package-tests-writing}

     

       
549
       
 
       


     
···

       
608
       
 
       
- [Spacy annotation test](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/python-modules/spacy/annotation-test/default.nix)

     

       
609
       
 
       
- [Libtorch test](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/libraries/science/math/libtorch/test/default.nix)

     

       
610
       
 
       
- [Multiple tests for nanopb](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/libraries/nanopb/default.nix)

     

       
611
       
+
       


     

       
612
       
+
       
### Linking NixOS module tests to a package {#ssec-nixos-tests-linking}

     

       
613
       
+
       


     

       
614
       
+
       
Like [package tests](#ssec-package-tests-writing) as shown above, [NixOS module tests](https://nixos.org/manual/nixos/stable/#sec-nixos-tests) can also be linked to a package, so that the tests can be easily run when changing the related package.

     

       
615
       
+
       


     

       
616
       
+
       
For example, assuming we're packaging `nginx`, we can link its module test via `passthru.tests`:

     

       
617
       
+
       


     

       
618
       
+
       
```nix

     

       
619
       
+
       
{ stdenv, lib, nixosTests }:

     

       
620
       
+
       


     

       
621
       
+
       
stdenv.mkDerivation {

     

       
622
       
+
       
  ...

     

       
623
       
+
       


     

       
624
       
+
       
  passthru.tests = {

     

       
625
       
+
       
    nginx = nixosTests.nginx;

     

       
626
       
+
       
  };

     

       
627
       
+
       


     

       
628
       
+
       
  ...

     

       
629
       
+
       
}

     

       
630
       
+
       
```

     

···

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

···

       
1
       
+
       
# Linking NixOS tests to packages {#sec-linking-nixos-tests-to-packages}

     

       
2
       
+
       


     

       
3
       
+
       
You can link NixOS module tests to the packages that they exercised,

     

       
4
       
+
       
so that the tests can be run automatically during code review when the package gets changed.

     

       
5
       
+
       
This is

     

       
6
       
+
       
[described in the nixpkgs manual](https://nixos.org/manual/nixpkgs/stable/#ssec-nixos-tests-linking).

     

···

       
16
       
 
       
 <xi:include href="../from_md/development/writing-nixos-tests.section.xml" />

     

       
17
       
 
       
 <xi:include href="../from_md/development/running-nixos-tests.section.xml" />

     

       
18
       
 
       
 <xi:include href="../from_md/development/running-nixos-tests-interactively.section.xml" />

     

       
0
       
 
       

     

       
19
       
 
       
</chapter>

     

···

       
16
       
 
       
 <xi:include href="../from_md/development/writing-nixos-tests.section.xml" />

     

       
17
       
 
       
 <xi:include href="../from_md/development/running-nixos-tests.section.xml" />

     

       
18
       
 
       
 <xi:include href="../from_md/development/running-nixos-tests-interactively.section.xml" />

     

       
19
       
+
       
 <xi:include href="../from_md/development/linking-nixos-tests-to-packages.section.xml" />

     

       
20
       
 
       
</chapter>

     

···

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

···

       
1
       
+
       
<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-linking-nixos-tests-to-packages">

     

       
2
       
+
       
  <title>Linking NixOS tests to packages</title>

     

       
3
       
+
       
  <para>

     

       
4
       
+
       
    You can link NixOS module tests to the packages that they exercised,

     

       
5
       
+
       
    so that the tests can be run automatically during code review when

     

       
6
       
+
       
    the package gets changed. This is

     

       
7
       
+
       
    <link xlink:href="https://nixos.org/manual/nixpkgs/stable/#ssec-nixos-tests-linking">described

     

       
8
       
+
       
    in the nixpkgs manual</link>.

     

       
9
       
+
       
  </para>

     

       
10
       
+
       
</section>