Skip to content

integration-testing-using-virtual-machines.md: nixosTest -> testers.r… #934

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
infinisil merged 1 commit into from
Mar 7, 2024
Merged

integration-testing-using-virtual-machines.md: nixosTest -> testers.r… #934

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions source/tutorials/nixos/integration-testing-using-virtual-machines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ They can be written and launched outside of NixOS, on any Linux machine[^darwin]

Integration tests are reproducible due to the design properties of Nix, making them a valuable part of a continuous integration (CI) pipeline.

## The `nixosTest` function
## The `testers.runNixOSTest` function

NixOS VM tests are defined using the `nixosTest` function.
NixOS VM tests are defined using the `testers.runNixOSTest` function.
The pattern for NixOS VM tests looks like this:

```nix
Expand All @@ -35,7 +35,7 @@ let
pkgs = import nixpkgs { config = {}; overlays = []; };
in

pkgs.nixosTest {
pkgs.testers.runNixOSTest {
name = "test-name";
nodes = {
machine1 = { config, pkgs, ... }: {
Expand All @@ -51,7 +51,7 @@ pkgs.nixosTest {
}
```

The function `nixosTest` takes a [module](https://nixos.org/manual/nixos/stable/#sec-writing-modules) to specify the [test options](https://nixos.org/manual/nixos/stable/index.html#sec-test-options-reference).
The function `testers.runNixOSTest` takes a [module](https://nixos.org/manual/nixos/stable/#sec-writing-modules) to specify the [test options](https://nixos.org/manual/nixos/stable/index.html#sec-test-options-reference).
Because this module only sets configuration values, one can use the abbreviated module notation.

The following configuration values must be set:
Expand Down Expand Up @@ -82,7 +82,7 @@ We will build the example up from scratch.
pkgs = import nixpkgs { config = {}; overlays = []; };
in

pkgs.nixosTest {
pkgs.testers.runNixOSTest {
# ...
}
```
Expand Down Expand Up @@ -136,7 +136,7 @@ let
pkgs = import nixpkgs { config = {}; overlays = []; };
in

pkgs.nixosTest {
pkgs.testers.runNixOSTest {
name = "minimal-test";

nodes.machine = { config, pkgs, ... }: {
Expand Down Expand Up @@ -269,7 +269,7 @@ let
pkgs = import nixpkgs { config = {}; overlays = []; };
in

pkgs.nixosTest {
pkgs.testers.runNixOSTest {
name = "client-server-test";

nodes.server = { pkgs, ... }: {
Expand Down