commit b3de22483cfd40e52dbe6fe7317b0f4901bd957d · pyrox.dev/nixpkgs

+20

nixos/lib/testing-python.nix

···

       166
        
                 ${lib.optionalString (interactive) "--add-flags --interactive"}

     

       167
        
             '');

     

       168
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       169
        
         # Make a full-blown test

     

       170
        
         makeTest =

     

       171
        
           { machine ? null

···

       166
        
                 ${lib.optionalString (interactive) "--add-flags --interactive"}

     

       167
        
             '');

     

       168
        
       

     

       169
       +
         evalTest = module: lib.evalModules { modules = testModules ++ [ module ]; };

     

       170
       +
         runTest = module: (evalTest module).config.run;

     

       171
       +
       

     

       172
       +
         testModules = [

     

       173
       +
           ./testing/driver.nix

     

       174
       +
           ./testing/interactive.nix

     

       175
       +
           ./testing/legacy.nix

     

       176
       +
           ./testing/meta.nix

     

       177
       +
           ./testing/name.nix

     

       178
       +
           ./testing/network.nix

     

       179
       +
           ./testing/nodes.nix

     

       180
       +
           ./testing/run.nix

     

       181
       +
           ./testing/testScript.nix

     

       182
       +
           {

     

       183
       +
             config = {

     

       184
       +
               hostPkgs = pkgs;

     

       185
       +
             };

     

       186
       +
           }

     

       187
       +
         ];

     

       188
       +
       

     

       189
        
         # Make a full-blown test

     

       190
        
         makeTest =

     

       191
        
           { machine ? null

+16

nixos/lib/testing/call-test.nix

···

       1
       +
       { config, lib, ... }:

     

       2
       +
       let

     

       3
       +
         inherit (lib) mkOption types;

     

       4
       +
       in

     

       5
       +
       {

     

       6
       +
         options = {

     

       7
       +
           callTest = mkOption {

     

       8
       +
             internal = true;

     

       9
       +
             type = types.functionTo types.raw;

     

       10
       +
           };

     

       11
       +
           result = mkOption {

     

       12
       +
             internal = true;

     

       13
       +
             default = config;

     

       14
       +
           };

     

       15
       +
         };

     

       16
       +
       }

+177

nixos/lib/testing/driver.nix

···

       1
       +
       { config, lib, hostPkgs, ... }:

     

       2
       +
       let

     

       3
       +
         inherit (lib) mkOption types;

     

       4
       +
       

     

       5
       +
         # Reifies and correctly wraps the python test driver for

     

       6
       +
         # the respective qemu version and with or without ocr support

     

       7
       +
         testDriver = hostPkgs.callPackage ../test-driver {

     

       8
       +
           inherit (config) enableOCR extraPythonPackages;

     

       9
       +
           qemu_pkg = config.qemu.package;

     

       10
       +
           imagemagick_light = hostPkgs.imagemagick_light.override { inherit (hostPkgs) libtiff; };

     

       11
       +
           tesseract4 = hostPkgs.tesseract4.override { enableLanguages = [ "eng" ]; };

     

       12
       +
         };

     

       13
       +
       

     

       14
       +
       

     

       15
       +
         vlans = map (m: m.virtualisation.vlans) (lib.attrValues config.nodes);

     

       16
       +
         vms = map (m: m.system.build.vm) (lib.attrValues config.nodes);

     

       17
       +
       

     

       18
       +
         nodeHostNames =

     

       19
       +
           let

     

       20
       +
             nodesList = map (c: c.system.name) (lib.attrValues config.nodes);

     

       21
       +
           in

     

       22
       +
           nodesList ++ lib.optional (lib.length nodesList == 1 && !lib.elem "machine" nodesList) "machine";

     

       23
       +
       

     

       24
       +
         # TODO: This is an implementation error and needs fixing

     

       25
       +
         # the testing famework cannot legitimately restrict hostnames further

     

       26
       +
         # beyond RFC1035

     

       27
       +
         invalidNodeNames = lib.filter

     

       28
       +
           (node: builtins.match "^[A-z_]([A-z0-9_]+)?$" node == null)

     

       29
       +
           nodeHostNames;

     

       30
       +
       

     

       31
       +
         uniqueVlans = lib.unique (builtins.concatLists vlans);

     

       32
       +
         vlanNames = map (i: "vlan${toString i}: VLan;") uniqueVlans;

     

       33
       +
         machineNames = map (name: "${name}: Machine;") nodeHostNames;

     

       34
       +
       

     

       35
       +
         withChecks =

     

       36
       +
           if lib.length invalidNodeNames > 0 then

     

       37
       +
             throw ''

     

       38
       +
               Cannot create machines out of (${lib.concatStringsSep ", " invalidNodeNames})!

     

       39
       +
               All machines are referenced as python variables in the testing framework which will break the

     

       40
       +
               script when special characters are used.

     

       41
       +
       

     

       42
       +
               This is an IMPLEMENTATION ERROR and needs to be fixed. Meanwhile,

     

       43
       +
               please stick to alphanumeric chars and underscores as separation.

     

       44
       +
             ''

     

       45
       +
           else

     

       46
       +
             lib.warnIf config.skipLint "Linting is disabled";

     

       47
       +
       

     

       48
       +
         driver =

     

       49
       +
           hostPkgs.runCommand "nixos-test-driver-${config.name}"

     

       50
       +
             {

     

       51
       +
               # inherit testName; TODO (roberth): need this?

     

       52
       +
               nativeBuildInputs = [

     

       53
       +
                 hostPkgs.makeWrapper

     

       54
       +
               ] ++ lib.optionals (!config.skipTypeCheck) [ hostPkgs.mypy ];

     

       55
       +
               testScript = config.testScriptString;

     

       56
       +
               preferLocalBuild = true;

     

       57
       +
               passthru = config.passthru;

     

       58
       +
               meta = config.meta // {

     

       59
       +
                 mainProgram = "nixos-test-driver";

     

       60
       +
               };

     

       61
       +
             }

     

       62
       +
             ''

     

       63
       +
               mkdir -p $out/bin

     

       64
       +
       

     

       65
       +
               vmStartScripts=($(for i in ${toString vms}; do echo $i/bin/run-*-vm; done))

     

       66
       +
       

     

       67
       +
               ${lib.optionalString (!config.skipTypeCheck) ''

     

       68
       +
                 # prepend type hints so the test script can be type checked with mypy

     

       69
       +
                 cat "${../test-script-prepend.py}" >> testScriptWithTypes

     

       70
       +
                 echo "${builtins.toString machineNames}" >> testScriptWithTypes

     

       71
       +
                 echo "${builtins.toString vlanNames}" >> testScriptWithTypes

     

       72
       +
                 echo -n "$testScript" >> testScriptWithTypes

     

       73
       +
       

     

       74
       +
                 cat -n testScriptWithTypes

     

       75
       +
       

     

       76
       +
                 # set pythonpath so mypy knows where to find the imports. this requires the py.typed file.

     

       77
       +
                 export PYTHONPATH='${../test-driver}'

     

       78
       +
                 mypy  --no-implicit-optional \

     

       79
       +
                       --pretty \

     

       80
       +
                       --no-color-output \

     

       81
       +
                       testScriptWithTypes

     

       82
       +
                 unset PYTHONPATH

     

       83
       +
               ''}

     

       84
       +
       

     

       85
       +
               echo -n "$testScript" >> $out/test-script

     

       86
       +
       

     

       87
       +
               ln -s ${testDriver}/bin/nixos-test-driver $out/bin/nixos-test-driver

     

       88
       +
       

     

       89
       +
               ${testDriver}/bin/generate-driver-symbols

     

       90
       +
               ${lib.optionalString (!config.skipLint) ''

     

       91
       +
                 PYFLAKES_BUILTINS="$(

     

       92
       +
                   echo -n ${lib.escapeShellArg (lib.concatStringsSep "," nodeHostNames)},

     

       93
       +
                   < ${lib.escapeShellArg "driver-symbols"}

     

       94
       +
                 )" ${hostPkgs.python3Packages.pyflakes}/bin/pyflakes $out/test-script

     

       95
       +
               ''}

     

       96
       +
       

     

       97
       +
               # set defaults through environment

     

       98
       +
               # see: ./test-driver/test-driver.py argparse implementation

     

       99
       +
               wrapProgram $out/bin/nixos-test-driver \

     

       100
       +
                 --set startScripts "''${vmStartScripts[*]}" \

     

       101
       +
                 --set testScript "$out/test-script" \

     

       102
       +
                 --set vlans '${toString vlans}' \

     

       103
       +
                 ${lib.escapeShellArgs (lib.concatMap (arg: ["--add-flags" arg]) config.extraDriverArgs)}

     

       104
       +
             '';

     

       105
       +
       

     

       106
       +
       in

     

       107
       +
       {

     

       108
       +
         options = {

     

       109
       +
       

     

       110
       +
           driver = mkOption {

     

       111
       +
             description = "Script that runs the test.";

     

       112
       +
             type = types.package;

     

       113
       +
             defaultText = lib.literalDocBook "set by the test framework";

     

       114
       +
           };

     

       115
       +
       

     

       116
       +
           hostPkgs = mkOption {

     

       117
       +
             description = "Nixpkgs attrset used outside the nodes.";

     

       118
       +
             type = types.raw;

     

       119
       +
             example = lib.literalExpression ''

     

       120
       +
               import nixpkgs { inherit system config overlays; }

     

       121
       +
             '';

     

       122
       +
           };

     

       123
       +
       

     

       124
       +
           qemu.package = mkOption {

     

       125
       +
             description = "Which qemu package to use.";

     

       126
       +
             type = types.package;

     

       127
       +
             default = hostPkgs.qemu_test;

     

       128
       +
             defaultText = "hostPkgs.qemu_test";

     

       129
       +
           };

     

       130
       +
       

     

       131
       +
           enableOCR = mkOption {

     

       132
       +
             description = ''

     

       133
       +
               Whether to enable Optical Character Recognition functionality for

     

       134
       +
               testing graphical programs.

     

       135
       +
             '';

     

       136
       +
             type = types.bool;

     

       137
       +
             default = false;

     

       138
       +
           };

     

       139
       +
       

     

       140
       +
           extraPythonPackages = mkOption {

     

       141
       +
             description = ''

     

       142
       +
               Python packages to add to the test driver.

     

       143
       +
       

     

       144
       +
               The argument is a Python package set, similar to `pkgs.pythonPackages`.

     

       145
       +
             '';

     

       146
       +
             type = types.functionTo (types.listOf types.package);

     

       147
       +
             default = ps: [ ];

     

       148
       +
           };

     

       149
       +
       

     

       150
       +
           extraDriverArgs = mkOption {

     

       151
       +
             description = ''

     

       152
       +
               Extra arguments to pass to the test driver.

     

       153
       +
             '';

     

       154
       +
             type = types.listOf types.str;

     

       155
       +
             default = [];

     

       156
       +
           };

     

       157
       +
       

     

       158
       +
           skipLint = mkOption {

     

       159
       +
             type = types.bool;

     

       160
       +
             default = false;

     

       161
       +
           };

     

       162
       +
       

     

       163
       +
           skipTypeCheck = mkOption {

     

       164
       +
             type = types.bool;

     

       165
       +
             default = false;

     

       166
       +
           };

     

       167
       +
         };

     

       168
       +
       

     

       169
       +
         config = {

     

       170
       +
           _module.args.hostPkgs = config.hostPkgs;

     

       171
       +
       

     

       172
       +
           driver = withChecks driver;

     

       173
       +
       

     

       174
       +
           # make available on the test runner

     

       175
       +
           passthru.driver = config.driver;

     

       176
       +
         };

     

       177
       +
       }

+18

nixos/lib/testing/interactive.nix

···

       1
       +
       { config, lib, moduleType, hostPkgs, ... }:

     

       2
       +
       let

     

       3
       +
         inherit (lib) mkOption types;

     

       4
       +
       in

     

       5
       +
       {

     

       6
       +
         options = {

     

       7
       +
           interactive = mkOption {

     

       8
       +
             description = "All the same options, but configured for interactive use.";

     

       9
       +
             type = moduleType;

     

       10
       +
           };

     

       11
       +
         };

     

       12
       +
       

     

       13
       +
         config = {

     

       14
       +
           interactive.qemu.package = hostPkgs.qemu;

     

       15
       +
           interactive.extraDriverArgs = [ "--interactive" ];

     

       16
       +
           passthru.driverInteractive = config.interactive.driver;

     

       17
       +
         };

     

       18
       +
       }

+25

nixos/lib/testing/legacy.nix

···

       1
       +
       { config, options, lib, ... }:

     

       2
       +
       let

     

       3
       +
         inherit (lib) mkIf mkOption types;

     

       4
       +
       in

     

       5
       +
       {

     

       6
       +
         # This needs options.warnings, which we don't have (yet?).

     

       7
       +
         # imports = [

     

       8
       +
         #   (lib.mkRenamedOptionModule [ "machine" ] [ "nodes" "machine" ])

     

       9
       +
         # ];

     

       10
       +
       

     

       11
       +
         options = {

     

       12
       +
           machine = mkOption {

     

       13
       +
             internal = true;

     

       14
       +
             type = types.raw;

     

       15
       +
           };

     

       16
       +
         };

     

       17
       +
       

     

       18
       +
         config = {

     

       19
       +
           nodes = mkIf options.machine.isDefined (

     

       20
       +
             lib.warn

     

       21
       +
               "In test `${config.name}': The `machine' attribute in NixOS tests (pkgs.nixosTest / make-test-python.nix / testing-python.nix / makeTest) is deprecated. Please set the equivalent `nodes.machine'."

     

       22
       +
               { inherit (config) machine; }

     

       23
       +
           );

     

       24
       +
         };

     

       25
       +
       }

+12

nixos/lib/testing/meta.nix

···

       1
       +
       { lib, ... }:

     

       2
       +
       let

     

       3
       +
         inherit (lib) types mkOption;

     

       4
       +
       in

     

       5
       +
       {

     

       6
       +
         options = {

     

       7
       +
           meta.maintainers = lib.mkOption {

     

       8
       +
             type = types.listOf types.raw;

     

       9
       +
             default = [];

     

       10
       +
           };

     

       11
       +
         };

     

       12
       +
       }

nixos/lib/testing/name.nix

···

       1
       +
       { lib, ... }:

     

       2
       +
       {

     

       3
       +
         options.name = lib.mkOption {

     

       4
       +
           description = "The name of the test.";

     

       5
       +
           type = lib.types.str;

     

       6
       +
         };

     

       7
       +
       }

+75

nixos/lib/testing/network.nix

···

       1
       +
       { lib, nodes, ... }:

     

       2
       +
       

     

       3
       +
       with lib;

     

       4
       +
       

     

       5
       +
       

     

       6
       +
       let

     

       7
       +
         machines = attrNames nodes;

     

       8
       +
       

     

       9
       +
         machinesNumbered = zipLists machines (range 1 254);

     

       10
       +
       

     

       11
       +
         nodes_ = forEach machinesNumbered (m: nameValuePair m.fst

     

       12
       +
           [

     

       13
       +
             ({ config, nodes, pkgs, ... }:

     

       14
       +
               let

     

       15
       +
                 interfacesNumbered = zipLists config.virtualisation.vlans (range 1 255);

     

       16
       +
                 interfaces = forEach interfacesNumbered ({ fst, snd }:

     

       17
       +
                   nameValuePair "eth${toString snd}" {

     

       18
       +
                     ipv4.addresses =

     

       19
       +
                       [{

     

       20
       +
                         address = "192.168.${toString fst}.${toString m.snd}";

     

       21
       +
                         prefixLength = 24;

     

       22
       +
                       }];

     

       23
       +
                   });

     

       24
       +
       

     

       25
       +
                 networkConfig =

     

       26
       +
                   {

     

       27
       +
                     networking.hostName = mkDefault m.fst;

     

       28
       +
       

     

       29
       +
                     networking.interfaces = listToAttrs interfaces;

     

       30
       +
       

     

       31
       +
                     networking.primaryIPAddress =

     

       32
       +
                       optionalString (interfaces != [ ]) (head (head interfaces).value.ipv4.addresses).address;

     

       33
       +
       

     

       34
       +
                     # Put the IP addresses of all VMs in this machine's

     

       35
       +
                     # /etc/hosts file.  If a machine has multiple

     

       36
       +
                     # interfaces, use the IP address corresponding to

     

       37
       +
                     # the first interface (i.e. the first network in its

     

       38
       +
                     # virtualisation.vlans option).

     

       39
       +
                     networking.extraHosts = flip concatMapStrings machines

     

       40
       +
                       (m':

     

       41
       +
                         let config = (getAttr m' nodes).config; in

     

       42
       +
                         optionalString (config.networking.primaryIPAddress != "")

     

       43
       +
                           ("${config.networking.primaryIPAddress} " +

     

       44
       +
                             optionalString (config.networking.domain != null)

     

       45
       +
                               "${config.networking.hostName}.${config.networking.domain} " +

     

       46
       +
                             "${config.networking.hostName}\n"));

     

       47
       +
       

     

       48
       +
                     virtualisation.qemu.options =

     

       49
       +
                       let qemu-common = import ../qemu-common.nix { inherit lib pkgs; };

     

       50
       +
                       in

     

       51
       +
                       flip concatMap interfacesNumbered

     

       52
       +
                         ({ fst, snd }: qemu-common.qemuNICFlags snd fst m.snd);

     

       53
       +
                   };

     

       54
       +
       

     

       55
       +
               in

     

       56
       +
               {

     

       57
       +
                 key = "ip-address";

     

       58
       +
                 config = networkConfig // {

     

       59
       +
                   # Expose the networkConfig items for tests like nixops

     

       60
       +
                   # that need to recreate the network config.

     

       61
       +
                   system.build.networkConfig = networkConfig;

     

       62
       +
                 };

     

       63
       +
               }

     

       64
       +
             )

     

       65
       +
           ]);

     

       66
       +
       

     

       67
       +
         extraNodeConfigs = lib.listToAttrs nodes_;

     

       68
       +
       in

     

       69
       +
       {

     

       70
       +
         config = {

     

       71
       +
           defaults = { config, name, ... }: {

     

       72
       +
             imports = extraNodeConfigs.${name};

     

       73
       +
           };

     

       74
       +
         };

     

       75
       +
       }

+91

nixos/lib/testing/nodes.nix

···

       1
       +
       testModuleArgs@{ config, lib, hostPkgs, nodes, ... }:

     

       2
       +
       

     

       3
       +
       let

     

       4
       +
         inherit (lib) mkOption mkForce optional types mapAttrs mkDefault;

     

       5
       +
       

     

       6
       +
         system = hostPkgs.stdenv.hostPlatform.system;

     

       7
       +
       

     

       8
       +
         baseOS =

     

       9
       +
           import ../eval-config.nix {

     

       10
       +
             inherit system;

     

       11
       +
             inherit (config.node) specialArgs;

     

       12
       +
             modules = [ config.defaults ];

     

       13
       +
             baseModules = (import ../../modules/module-list.nix) ++

     

       14
       +
               [

     

       15
       +
                 ../../modules/virtualisation/qemu-vm.nix

     

       16
       +
                 ../../modules/testing/test-instrumentation.nix # !!! should only get added for automated test runs

     

       17
       +
                 { key = "no-manual"; documentation.nixos.enable = false; }

     

       18
       +
                 {

     

       19
       +
                   key = "no-revision";

     

       20
       +
                   # Make the revision metadata constant, in order to avoid needless retesting.

     

       21
       +
                   # The human version (e.g. 21.05-pre) is left as is, because it is useful

     

       22
       +
                   # for external modules that test with e.g. testers.nixosTest and rely on that

     

       23
       +
                   # version number.

     

       24
       +
                   config.system.nixos.revision = mkForce "constant-nixos-revision";

     

       25
       +
                 }

     

       26
       +
                 { key = "nodes"; _module.args.nodes = nodes; }

     

       27
       +
       

     

       28
       +
                 ({ config, ... }:

     

       29
       +
                   {

     

       30
       +
                     virtualisation.qemu.package = testModuleArgs.config.qemu.package;

     

       31
       +
       

     

       32
       +
                     # Ensure we do not use aliases. Ideally this is only set

     

       33
       +
                     # when the test framework is used by Nixpkgs NixOS tests.

     

       34
       +
                     nixpkgs.config.allowAliases = false;

     

       35
       +
                   })

     

       36
       +
               ] ++ optional config.minimal ../../modules/testing/minimal-kernel.nix;

     

       37
       +
           };

     

       38
       +
       

     

       39
       +
       

     

       40
       +
       in

     

       41
       +
       

     

       42
       +
       {

     

       43
       +
       

     

       44
       +
         options = {

     

       45
       +
           node.type = mkOption {

     

       46
       +
             type = types.raw;

     

       47
       +
             default = baseOS.type;

     

       48
       +
             internal = true;

     

       49
       +
           };

     

       50
       +
       

     

       51
       +
           nodes = mkOption {

     

       52
       +
             type = types.lazyAttrsOf config.node.type;

     

       53
       +
           };

     

       54
       +
       

     

       55
       +
           defaults = mkOption {

     

       56
       +
             description = ''

     

       57
       +
               NixOS configuration that is applied to all {option}`nodes`.

     

       58
       +
             '';

     

       59
       +
             type = types.deferredModule;

     

       60
       +
             default = { };

     

       61
       +
           };

     

       62
       +
       

     

       63
       +
           node.specialArgs = mkOption {

     

       64
       +
             type = types.lazyAttrsOf types.raw;

     

       65
       +
             default = { };

     

       66
       +
           };

     

       67
       +
       

     

       68
       +
           minimal = mkOption {

     

       69
       +
             type = types.bool;

     

       70
       +
             default = false;

     

       71
       +
           };

     

       72
       +
       

     

       73
       +
           nodesCompat = mkOption {

     

       74
       +
             internal = true;

     

       75
       +
           };

     

       76
       +
         };

     

       77
       +
       

     

       78
       +
         config = {

     

       79
       +
           _module.args.nodes = config.nodesCompat;

     

       80
       +
           nodesCompat =

     

       81
       +
             mapAttrs

     

       82
       +
               (name: config: config // {

     

       83
       +
                 config = lib.warn

     

       84
       +
                   "Module argument `nodes.${name}.config` is deprecated. Use `nodes.${name}` instead."

     

       85
       +
                   config;

     

       86
       +
               })

     

       87
       +
               config.nodes;

     

       88
       +
       

     

       89
       +
           passthru.nodes = config.nodesCompat;

     

       90
       +
         };

     

       91
       +
       }

+51

nixos/lib/testing/run.nix

···

       1
       +
       { config, hostPkgs, lib, ... }:

     

       2
       +
       let

     

       3
       +
         inherit (lib) types mkOption;

     

       4
       +
       in

     

       5
       +
       {

     

       6
       +
         options = {

     

       7
       +
           passthru = mkOption {

     

       8
       +
             type = types.lazyAttrsOf types.raw;

     

       9
       +
             description = ''

     

       10
       +
               Attributes to add to the returned derivations,

     

       11
       +
               which are not necessarily part of the build.

     

       12
       +
       

     

       13
       +
               This is a bit like doing `drv // { myAttr = true; }` (which would be lost by `overrideAttrs`).

     

       14
       +
               It does not change the actual derivation, but adds the attribute nonetheless, so that

     

       15
       +
               consumers of what would be `drv` have more information.

     

       16
       +
             '';

     

       17
       +
           };

     

       18
       +
       

     

       19
       +
           run = mkOption {

     

       20
       +
             type = types.package;

     

       21
       +
             description = ''

     

       22
       +
               Derivation that runs the test.

     

       23
       +
             '';

     

       24
       +
           };

     

       25
       +
         };

     

       26
       +
       

     

       27
       +
         config = {

     

       28
       +
           run = hostPkgs.stdenv.mkDerivation {

     

       29
       +
             name = "vm-test-run-${config.name}";

     

       30
       +
       

     

       31
       +
             requiredSystemFeatures = [ "kvm" "nixos-test" ];

     

       32
       +
       

     

       33
       +
             buildCommand =

     

       34
       +
               ''

     

       35
       +
                 mkdir -p $out

     

       36
       +
       

     

       37
       +
                 # effectively mute the XMLLogger

     

       38
       +
                 export LOGFILE=/dev/null

     

       39
       +
       

     

       40
       +
                 ${config.driver}/bin/nixos-test-driver -o $out

     

       41
       +
               '';

     

       42
       +
       

     

       43
       +
             passthru = config.passthru;

     

       44
       +
       

     

       45
       +
             meta = config.meta;

     

       46
       +
           };

     

       47
       +
       

     

       48
       +
           # useful for inspection (debugging / exploration)

     

       49
       +
           passthru.config = config;

     

       50
       +
         };

     

       51
       +
       }

+78

nixos/lib/testing/testScript.nix

···

       1
       +
       testModuleArgs@{ config, lib, hostPkgs, nodes, moduleType, ... }:

     

       2
       +
       let

     

       3
       +
         inherit (lib) mkOption types;

     

       4
       +
         inherit (types) either str functionTo;

     

       5
       +
       in

     

       6
       +
       {

     

       7
       +
         options = {

     

       8
       +
           testScript = mkOption {

     

       9
       +
             type = either str (functionTo str);

     

       10
       +
           };

     

       11
       +
           testScriptString = mkOption {

     

       12
       +
             type = str;

     

       13
       +
             readOnly = true;

     

       14
       +
             internal = true;

     

       15
       +
           };

     

       16
       +
       

     

       17
       +
           includeTestScriptReferences = mkOption {

     

       18
       +
             type = types.bool;

     

       19
       +
             default = true;

     

       20
       +
             internal = true;

     

       21
       +
           };

     

       22
       +
           withoutTestScriptReferences = mkOption {

     

       23
       +
             type = moduleType;

     

       24
       +
             description = ''

     

       25
       +
               A parallel universe where the testScript is invalid and has no references.

     

       26
       +
             '';

     

       27
       +
           };

     

       28
       +
         };

     

       29
       +
         config = {

     

       30
       +
           withoutTestScriptReferences.includeTestScriptReferences = false;

     

       31
       +
           withoutTestScriptReferences.testScript = lib.mkForce "testscript omitted";

     

       32
       +
       

     

       33
       +
           testScriptString =

     

       34
       +
             if lib.isFunction config.testScript

     

       35
       +
             then

     

       36
       +
               config.testScript

     

       37
       +
                 {

     

       38
       +
                   nodes =

     

       39
       +
                     lib.mapAttrs

     

       40
       +
                       (k: v:

     

       41
       +
                         if v.virtualisation.useNixStoreImage

     

       42
       +
                         then

     

       43
       +
                         # prevent infinite recursion when testScript would

     

       44
       +
                         # reference v's toplevel

     

       45
       +
                           config.withoutTestScriptReferences.nodesCompat.${k}

     

       46
       +
                         else

     

       47
       +
                         # reuse memoized config

     

       48
       +
                           v

     

       49
       +
                       )

     

       50
       +
                       config.nodesCompat;

     

       51
       +
                 }

     

       52
       +
             else config.testScript;

     

       53
       +
       

     

       54
       +
           defaults = { config, name, ... }: {

     

       55
       +
             # Make sure all derivations referenced by the test

     

       56
       +
             # script are available on the nodes. When the store is

     

       57
       +
             # accessed through 9p, this isn't important, since

     

       58
       +
             # everything in the store is available to the guest,

     

       59
       +
             # but when building a root image it is, as all paths

     

       60
       +
             # that should be available to the guest has to be

     

       61
       +
             # copied to the image.

     

       62
       +
             virtualisation.additionalPaths =

     

       63
       +
               lib.optional

     

       64
       +
                 # A testScript may evaluate nodes, which has caused

     

       65
       +
                 # infinite recursions. The demand cycle involves:

     

       66
       +
                 #   testScript -->

     

       67
       +
                 #   nodes -->

     

       68
       +
                 #   toplevel -->

     

       69
       +
                 #   additionalPaths -->

     

       70
       +
                 #   hasContext testScript' -->

     

       71
       +
                 #   testScript (ad infinitum)

     

       72
       +
                 # If we don't need to build an image, we can break this

     

       73
       +
                 # cycle by short-circuiting when useNixStoreImage is false.

     

       74
       +
                 (config.virtualisation.useNixStoreImage && builtins.hasContext testModuleArgs.config.testScriptString && testModuleArgs.config.includeTestScriptReferences)

     

       75
       +
                 (hostPkgs.writeStringReferencesToFile testModuleArgs.config.testScriptString);

     

       76
       +
           };

     

       77
       +
         };

     

       78
       +
       }