···

       
9
       
 
       
  The test itself can be run interactively. This is particularly useful when

     

       
10
       
 
       
  developing or debugging a test:

     

       
11
       
 
       
<screen>

     

       
12
       
-
       
<prompt>$ </prompt>nix-build nixos/tests/login.nix -A driver

     

       
13
       
 
       
<prompt>$ </prompt>./result/bin/nixos-test-driver

     

       
14
       
 
       
starting VDE switch for network 1

     

       
15
       
 
       
<prompt>&gt;</prompt>

     
···

       
30
       
 
       
 <para>

     

       
31
       
 
       
  To just start and experiment with the VMs, run:

     

       
32
       
 
       
<screen>

     

       
33
       
-
       
<prompt>$ </prompt>nix-build nixos/tests/login.nix -A driver

     

       
34
       
 
       
<prompt>$ </prompt>./result/bin/nixos-run-vms

     

       
35
       
 
       
</screen>

     

       
36
       
 
       
  The script <command>nixos-run-vms</command> starts the virtual machines

     

···

       
9
       
 
       
  The test itself can be run interactively. This is particularly useful when

     

       
10
       
 
       
  developing or debugging a test:

     

       
11
       
 
       
<screen>

     

       
12
       
+
       
<prompt>$ </prompt>nix-build nixos/tests/login.nix -A driverInteractive

     

       
13
       
 
       
<prompt>$ </prompt>./result/bin/nixos-test-driver

     

       
14
       
 
       
starting VDE switch for network 1

     

       
15
       
 
       
<prompt>&gt;</prompt>

     
···

       
30
       
 
       
 <para>

     

       
31
       
 
       
  To just start and experiment with the VMs, run:

     

       
32
       
 
       
<screen>

     

       
33
       
+
       
<prompt>$ </prompt>nix-build nixos/tests/login.nix -A driverInteractive

     

       
34
       
 
       
<prompt>$ </prompt>./result/bin/nixos-run-vms

     

       
35
       
 
       
</screen>

     

       
36
       
 
       
  The script <command>nixos-run-vms</command> starts the virtual machines

     

···

       
17
       
 
       
  inherit pkgs;

     

       
18
       
 
       


     

       
19
       
 
       


     

       
20
       
-
       
  testDriver = let

     

       
21
       
 
       
    testDriverScript = ./test-driver/test-driver.py;

     

       
22
       
-
       
  in stdenv.mkDerivation {

     

       
23
       
 
       
    name = "nixos-test-driver";

     

       
24
       
 
       


     

       
25
       
 
       
    nativeBuildInputs = [ makeWrapper ];

     
···

       
47
       
 
       
        # TODO: copy user script part into this file (append)

     

       
48
       
 
       


     

       
49
       
 
       
        wrapProgram $out/bin/nixos-test-driver \

     

       
50
       
-
       
          --prefix PATH : "${lib.makeBinPath [ qemu_test vde2 netpbm coreutils ]}" \

     

       
51
       
 
       
      '';

     

       
52
       
 
       
  };

     

       
53
       
 
       


     

       
0
       
 
       

     

       
0
       
 
       

     

       
54
       
 
       


     

       
55
       
 
       
  # Run an automated test suite in the given virtual network.

     

       
56
       
 
       
  # `driver' is the script that runs the network.

     
···

       
113
       
 
       
      # Generate convenience wrappers for running the test driver

     

       
114
       
 
       
      # interactively with the specified network, and for starting the

     

       
115
       
 
       
      # VMs from the command line.

     

       
116
       
-
       
      driver = let warn = if skipLint then lib.warn "Linting is disabled!" else lib.id; in warn (runCommand testDriverName

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
117
       
 
       
        { buildInputs = [ makeWrapper];

     

       
118
       
 
       
          testScript = testScript';

     

       
119
       
 
       
          preferLocalBuild = true;

     
···

       
148
       
 
       
        meta = (drv.meta or {}) // t.meta;

     

       
149
       
 
       
      };

     

       
150
       
 
       


     

       
151
       
-
       
      test = passMeta (runTests driver);

     

       
152
       
 
       


     

       
153
       
 
       
      nodeNames = builtins.attrNames nodes;

     

       
154
       
 
       
      invalidNodeNames = lib.filter

     
···

       
165
       
 
       
        ''

     

       
166
       
 
       
      else

     

       
167
       
 
       
        test // {

     

       
168
       
-
       
          inherit nodes driver test;

     

       
0
       
 
       

     

       
0
       
 
       

     

       
169
       
 
       
        };

     

       
170
       
 
       


     

       
171
       
 
       
  runInMachine =

     

···

       
17
       
 
       
  inherit pkgs;

     

       
18
       
 
       


     

       
19
       
 
       


     

       
20
       
+
       
  mkTestDriver = let

     

       
21
       
 
       
    testDriverScript = ./test-driver/test-driver.py;

     

       
22
       
+
       
  in qemu_pkg: stdenv.mkDerivation {

     

       
23
       
 
       
    name = "nixos-test-driver";

     

       
24
       
 
       


     

       
25
       
 
       
    nativeBuildInputs = [ makeWrapper ];

     
···

       
47
       
 
       
        # TODO: copy user script part into this file (append)

     

       
48
       
 
       


     

       
49
       
 
       
        wrapProgram $out/bin/nixos-test-driver \

     

       
50
       
+
       
          --prefix PATH : "${lib.makeBinPath [ qemu_pkg vde2 netpbm coreutils ]}" \

     

       
51
       
 
       
      '';

     

       
52
       
 
       
  };

     

       
53
       
 
       


     

       
54
       
+
       
  testDriver = mkTestDriver qemu_test;

     

       
55
       
+
       
  testDriverInteractive = mkTestDriver qemu_kvm;

     

       
56
       
 
       


     

       
57
       
 
       
  # Run an automated test suite in the given virtual network.

     

       
58
       
 
       
  # `driver' is the script that runs the network.

     
···

       
115
       
 
       
      # Generate convenience wrappers for running the test driver

     

       
116
       
 
       
      # interactively with the specified network, and for starting the

     

       
117
       
 
       
      # VMs from the command line.

     

       
118
       
+
       
      driver = testDriver:

     

       
119
       
+
       
        let

     

       
120
       
+
       
          warn = if skipLint then lib.warn "Linting is disabled!" else lib.id;

     

       
121
       
+
       
        in

     

       
122
       
+
       
        warn (runCommand testDriverName

     

       
123
       
 
       
        { buildInputs = [ makeWrapper];

     

       
124
       
 
       
          testScript = testScript';

     

       
125
       
 
       
          preferLocalBuild = true;

     
···

       
154
       
 
       
        meta = (drv.meta or {}) // t.meta;

     

       
155
       
 
       
      };

     

       
156
       
 
       


     

       
157
       
+
       
      test = passMeta (runTests (driver testDriver));

     

       
158
       
 
       


     

       
159
       
 
       
      nodeNames = builtins.attrNames nodes;

     

       
160
       
 
       
      invalidNodeNames = lib.filter

     
···

       
171
       
 
       
        ''

     

       
172
       
 
       
      else

     

       
173
       
 
       
        test // {

     

       
174
       
+
       
          inherit nodes test;

     

       
175
       
+
       
          driver = driver testDriver;

     

       
176
       
+
       
          driverInteractive = driver testDriverInteractive;

     

       
177
       
 
       
        };

     

       
178
       
 
       


     

       
179
       
 
       
  runInMachine =

     

···

       
116
       
 
       
    users.users.root.initialHashedPassword = mkOverride 150 "";

     

       
117
       
 
       


     

       
118
       
 
       
    services.xserver.displayManager.job.logToJournal = true;

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
119
       
 
       
  };

     

       
120
       
 
       


     

       
121
       
 
       
}

     

···

       
116
       
 
       
    users.users.root.initialHashedPassword = mkOverride 150 "";

     

       
117
       
 
       


     

       
118
       
 
       
    services.xserver.displayManager.job.logToJournal = true;

     

       
119
       
+
       


     

       
120
       
+
       
    # Make sure we use the Guest Agent from the QEMU package for testing

     

       
121
       
+
       
    # to reduce the closure size required for the tests.

     

       
122
       
+
       
    services.qemuGuest.package = pkgs.qemu_test.ga;

     

       
123
       
 
       
  };

     

       
124
       
 
       


     

       
125
       
 
       
}

     

···

       
12
       
 
       
        default = false;

     

       
13
       
 
       
        description = "Whether to enable the qemu guest agent.";

     

       
14
       
 
       
      };

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
15
       
 
       
  };

     

       
16
       
 
       


     

       
17
       
 
       
  config = mkIf cfg.enable (

     
···

       
25
       
 
       
      systemd.services.qemu-guest-agent = {

     

       
26
       
 
       
        description = "Run the QEMU Guest Agent";

     

       
27
       
 
       
        serviceConfig = {

     

       
28
       
-
       
          ExecStart = "${pkgs.qemu.ga}/bin/qemu-ga";

     

       
29
       
 
       
          Restart = "always";

     

       
30
       
 
       
          RestartSec = 0;

     

       
31
       
 
       
        };

     

···

       
12
       
 
       
        default = false;

     

       
13
       
 
       
        description = "Whether to enable the qemu guest agent.";

     

       
14
       
 
       
      };

     

       
15
       
+
       
      package = mkOption {

     

       
16
       
+
       
        type = types.package;

     

       
17
       
+
       
        default = pkgs.qemu.ga;

     

       
18
       
+
       
        description = "The QEMU guest agent package.";

     

       
19
       
+
       
      };

     

       
20
       
 
       
  };

     

       
21
       
 
       


     

       
22
       
 
       
  config = mkIf cfg.enable (

     
···

       
30
       
 
       
      systemd.services.qemu-guest-agent = {

     

       
31
       
 
       
        description = "Run the QEMU Guest Agent";

     

       
32
       
 
       
        serviceConfig = {

     

       
33
       
+
       
          ExecStart = "${cfg.package}/bin/qemu-ga";

     

       
34
       
 
       
          Restart = "always";

     

       
35
       
 
       
          RestartSec = 0;

     

       
36
       
 
       
        };

     

···

       
1
       
 
       
{ stdenv, fetchurl, fetchpatch, python, zlib, pkgconfig, glib

     

       
2
       
-
       
, ncurses, perl, pixman, vde2, alsaLib, texinfo, flex

     

       
3
       
 
       
, bison, lzo, snappy, libaio, gnutls, nettle, curl

     

       
4
       
 
       
, makeWrapper

     

       
5
       
 
       
, attr, libcap, libcap_ng

     

       
6
       
 
       
, CoreServices, Cocoa, Hypervisor, rez, setfile

     

       
7
       
 
       
, numaSupport ? stdenv.isLinux && !stdenv.isAarch32, numactl

     

       
8
       
 
       
, seccompSupport ? stdenv.isLinux, libseccomp

     

       
9
       
-
       
, pulseSupport ? !stdenv.isDarwin, libpulseaudio

     

       
10
       
-
       
, sdlSupport ? !stdenv.isDarwin, SDL2

     

       
11
       
-
       
, gtkSupport ? !stdenv.isDarwin && !xenSupport, gtk3, gettext, vte, wrapGAppsHook

     

       
12
       
-
       
, vncSupport ? true, libjpeg, libpng

     

       
13
       
-
       
, smartcardSupport ? true, libcacard

     

       
14
       
-
       
, spiceSupport ? !stdenv.isDarwin, spice, spice-protocol

     

       
0
       
 
       

     

       
0
       
 
       

     

       
15
       
 
       
, usbredirSupport ? spiceSupport, usbredir

     

       
16
       
 
       
, xenSupport ? false, xen

     

       
17
       
 
       
, cephSupport ? false, ceph

     
···

       
29
       
 
       


     

       
30
       
 
       
with stdenv.lib;

     

       
31
       
 
       
let

     

       
32
       
-
       
  audio = optionalString (hasSuffix "linux" stdenv.hostPlatform.system) "alsa,"

     

       
33
       
 
       
    + optionalString pulseSupport "pa,"

     

       
34
       
 
       
    + optionalString sdlSupport "sdl,";

     

       
35
       
 
       


     
···

       
50
       
 
       
  nativeBuildInputs = [ python python.pkgs.sphinx pkgconfig flex bison ]

     

       
51
       
 
       
    ++ optionals gtkSupport [ wrapGAppsHook ];

     

       
52
       
 
       
  buildInputs =

     

       
53
       
-
       
    [ zlib glib ncurses perl pixman

     

       
54
       
 
       
      vde2 texinfo makeWrapper lzo snappy

     

       
55
       
 
       
      gnutls nettle curl

     

       
56
       
 
       
    ]

     

       
0
       
 
       

     

       
57
       
 
       
    ++ optionals stdenv.isDarwin [ CoreServices Cocoa Hypervisor rez setfile ]

     

       
58
       
 
       
    ++ optionals seccompSupport [ libseccomp ]

     

       
59
       
 
       
    ++ optionals numaSupport [ numactl ]

     

···

       
1
       
 
       
{ stdenv, fetchurl, fetchpatch, python, zlib, pkgconfig, glib

     

       
2
       
+
       
, perl, pixman, vde2, alsaLib, texinfo, flex

     

       
3
       
 
       
, bison, lzo, snappy, libaio, gnutls, nettle, curl

     

       
4
       
 
       
, makeWrapper

     

       
5
       
 
       
, attr, libcap, libcap_ng

     

       
6
       
 
       
, CoreServices, Cocoa, Hypervisor, rez, setfile

     

       
7
       
 
       
, numaSupport ? stdenv.isLinux && !stdenv.isAarch32, numactl

     

       
8
       
 
       
, seccompSupport ? stdenv.isLinux, libseccomp

     

       
9
       
+
       
, alsaSupport ? stdenv.lib.hasSuffix "linux" stdenv.hostPlatform.system && !nixosTestRunner

     

       
10
       
+
       
, pulseSupport ? !stdenv.isDarwin && !nixosTestRunner, libpulseaudio

     

       
11
       
+
       
, sdlSupport ? !stdenv.isDarwin && !nixosTestRunner, SDL2

     

       
12
       
+
       
, gtkSupport ? !stdenv.isDarwin && !xenSupport && !nixosTestRunner, gtk3, gettext, vte, wrapGAppsHook

     

       
13
       
+
       
, vncSupport ? !nixosTestRunner, libjpeg, libpng

     

       
14
       
+
       
, smartcardSupport ? !nixosTestRunner, libcacard

     

       
15
       
+
       
, spiceSupport ? !stdenv.isDarwin && !nixosTestRunner, spice, spice-protocol

     

       
16
       
+
       
, ncursesSupport ? !nixosTestRunner, ncurses

     

       
17
       
 
       
, usbredirSupport ? spiceSupport, usbredir

     

       
18
       
 
       
, xenSupport ? false, xen

     

       
19
       
 
       
, cephSupport ? false, ceph

     
···

       
31
       
 
       


     

       
32
       
 
       
with stdenv.lib;

     

       
33
       
 
       
let

     

       
34
       
+
       
  audio = optionalString alsaSupport "alsa,"

     

       
35
       
 
       
    + optionalString pulseSupport "pa,"

     

       
36
       
 
       
    + optionalString sdlSupport "sdl,";

     

       
37
       
 
       


     
···

       
52
       
 
       
  nativeBuildInputs = [ python python.pkgs.sphinx pkgconfig flex bison ]

     

       
53
       
 
       
    ++ optionals gtkSupport [ wrapGAppsHook ];

     

       
54
       
 
       
  buildInputs =

     

       
55
       
+
       
    [ zlib glib perl pixman

     

       
56
       
 
       
      vde2 texinfo makeWrapper lzo snappy

     

       
57
       
 
       
      gnutls nettle curl

     

       
58
       
 
       
    ]

     

       
59
       
+
       
    ++ optionals ncursesSupport [ ncurses ]

     

       
60
       
 
       
    ++ optionals stdenv.isDarwin [ CoreServices Cocoa Hypervisor rez setfile ]

     

       
61
       
 
       
    ++ optionals seccompSupport [ libseccomp ]

     

       
62
       
 
       
    ++ optionals numaSupport [ numactl ]

     

···

       
1
       
 
       
{ stdenv, fetchFromGitHub, autoreconfHook

     

       
2
       
 
       
, asciidoctor, pkgconfig, xmlto, docbook_xsl, docbook_xml_dtd_45, libxslt

     

       
3
       
-
       
, json_c, kmod, which, utillinux, systemd, keyutils

     

       
4
       
 
       
}:

     

       
5
       
 
       


     

       
6
       
 
       
stdenv.mkDerivation rec {

     
···

       
22
       
 
       
    ];

     

       
23
       
 
       


     

       
24
       
 
       
  buildInputs =

     

       
25
       
-
       
    [ json_c kmod utillinux systemd keyutils

     

       
26
       
 
       
    ];

     

       
27
       
 
       


     

       
28
       
 
       
  configureFlags =

     

···

       
1
       
 
       
{ stdenv, fetchFromGitHub, autoreconfHook

     

       
2
       
 
       
, asciidoctor, pkgconfig, xmlto, docbook_xsl, docbook_xml_dtd_45, libxslt

     

       
3
       
+
       
, json_c, kmod, which, utillinux, udev, keyutils

     

       
4
       
 
       
}:

     

       
5
       
 
       


     

       
6
       
 
       
stdenv.mkDerivation rec {

     
···

       
22
       
 
       
    ];

     

       
23
       
 
       


     

       
24
       
 
       
  buildInputs =

     

       
25
       
+
       
    [ json_c kmod utillinux udev keyutils

     

       
26
       
 
       
    ];

     

       
27
       
 
       


     

       
28
       
 
       
  configureFlags =

     

···

       
1
       
-
       
{ stdenv, fetchFromGitHub

     

       
2
       
 
       
, meson, ninja, pkgconfig, gettext, libxslt, docbook_xsl_ns

     

       
3
       
-
       
, libcap, systemd, libidn2

     

       
4
       
 
       
}:

     

       
5
       
 
       


     

       
6
       
 
       
with stdenv.lib;

     
···

       
22
       
 
       
    sha256 = "1jhbcz75a4ij1myyyi110ma1d8d5hpm3scz9pyw7js6qym50xvh4";

     

       
23
       
 
       
  };

     

       
24
       
 
       


     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
25
       
 
       
  mesonFlags = [

     

       
26
       
 
       
    "-DBUILD_RARPD=true"

     

       
27
       
 
       
    "-DBUILD_TRACEROUTE6=true"

     

       
28
       
 
       
    "-DBUILD_TFTPD=true"

     

       
29
       
 
       
    "-DNO_SETCAP_OR_SUID=true"

     

       
30
       
 
       
    "-Dsystemdunitdir=etc/systemd/system"

     

       
0
       
 
       

     

       
31
       
 
       
  ]

     

       
32
       
 
       
    # Disable idn usage w/musl (https://github.com/iputils/iputils/pull/111):

     

       
33
       
 
       
    ++ optional stdenv.hostPlatform.isMusl "-DUSE_IDN=false";

     

       
34
       
 
       


     

       
35
       
 
       
  nativeBuildInputs = [ meson ninja pkgconfig gettext libxslt.bin docbook_xsl_ns ];

     

       
36
       
-
       
  buildInputs = [ libcap systemd ]

     

       
37
       
 
       
    ++ optional (!stdenv.hostPlatform.isMusl) libidn2;

     

       
38
       
 
       


     

       
39
       
 
       
  meta = {

     

···

       
1
       
+
       
{ stdenv, fetchFromGitHub, fetchpatch

     

       
2
       
 
       
, meson, ninja, pkgconfig, gettext, libxslt, docbook_xsl_ns

     

       
3
       
+
       
, libcap, libidn2

     

       
4
       
 
       
}:

     

       
5
       
 
       


     

       
6
       
 
       
with stdenv.lib;

     
···

       
22
       
 
       
    sha256 = "1jhbcz75a4ij1myyyi110ma1d8d5hpm3scz9pyw7js6qym50xvh4";

     

       
23
       
 
       
  };

     

       
24
       
 
       


     

       
25
       
+
       
  patches = [

     

       
26
       
+
       
    # Proposed upstream patch to reduce dependency on systemd: https://github.com/iputils/iputils/pull/297

     

       
27
       
+
       
    (fetchpatch {

     

       
28
       
+
       
      url = "https://github.com/iputils/iputils/commit/13d6aefd57fd471ecad06e19073dcc44608dff5e.patch";

     

       
29
       
+
       
      sha256 = "1n62zxmzp7hgz9qapbbpqv3fxqvc3qyd2a73jhp357x6by84kj49";

     

       
30
       
+
       
    })

     

       
31
       
+
       
  ];

     

       
32
       
+
       


     

       
33
       
 
       
  mesonFlags = [

     

       
34
       
 
       
    "-DBUILD_RARPD=true"

     

       
35
       
 
       
    "-DBUILD_TRACEROUTE6=true"

     

       
36
       
 
       
    "-DBUILD_TFTPD=true"

     

       
37
       
 
       
    "-DNO_SETCAP_OR_SUID=true"

     

       
38
       
 
       
    "-Dsystemdunitdir=etc/systemd/system"

     

       
39
       
+
       
    "-DINSTALL_SYSTEMD_UNITS=true"

     

       
40
       
 
       
  ]

     

       
41
       
 
       
    # Disable idn usage w/musl (https://github.com/iputils/iputils/pull/111):

     

       
42
       
 
       
    ++ optional stdenv.hostPlatform.isMusl "-DUSE_IDN=false";

     

       
43
       
 
       


     

       
44
       
 
       
  nativeBuildInputs = [ meson ninja pkgconfig gettext libxslt.bin docbook_xsl_ns ];

     

       
45
       
+
       
  buildInputs = [ libcap ]

     

       
46
       
 
       
    ++ optional (!stdenv.hostPlatform.isMusl) libidn2;

     

       
47
       
 
       


     

       
48
       
 
       
  meta = {