commit 63e2606ddf48204a320a34787b51182c374316c5 · pyrox.dev/nixpkgs

+23

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

···

       275
       275
        
       

     

       276
       276
        
       In that case, `numpy` is chosen from the generic `python3Packages`.

     

       277
       277
        
       

     

       278
       278
       +
       ## Overriding a test {#sec-override-nixos-test}

     

       279
       279
       +
       

     

       280
       280
       +
       The NixOS test framework returns tests with multiple overriding methods.

     

       281
       281
       +
       

     

       282
       282
       +
       `overrideTestDerivation` *function*

     

       283
       283
       +
       :   Like applying `overrideAttrs` on the [test](#test-opt-test) derivation.

     

       284
       284
       +
       

     

       285
       285
       +
           This is a convenience for `extend` with an override on the [`rawTestDerivationArg`](#test-opt-rawTestDerivationArg) option.

     

       286
       286
       +
       

     

       287
       287
       +
           *function*

     

       288
       288
       +
           :   An extension function, e.g. `finalAttrs: prevAttrs: { /* … */ }`, the result of which is passed to [`mkDerivation`](https://nixos.org/manual/nixpkgs/stable/#sec-using-stdenv).

     

       289
       289
       +
               Just as with `overrideAttrs`, an abbreviated form can be used, e.g. `prevAttrs: { /* … */ }` or even `{ /* … */ }`.

     

       290
       290
       +
               See [`lib.extends`](https://nixos.org/manual/nixpkgs/stable/#function-library-lib.fixedPoints.extends).

     

       291
       291
       +
       

     

       292
       292
       +
       `extend { modules = ` *modules* `; specialArgs = ` *specialArgs* `; }`

     

       293
       293
       +
       :   Adds new `nixosTest` modules and/or module arguments to the test, which are evaluated together with the existing modules and [built-in options](#sec-test-options-reference).

     

       294
       294
       +
       

     

       295
       295
       +
           `modules`

     

       296
       296
       +
           :   A list of modules to add to the test. These are added to the existing modules and then [evaluated](https://nixos.org/manual/nixpkgs/stable/index.html#module-system-lib-evalModules) together.

     

       297
       297
       +
       

     

       298
       298
       +
           `specialArgs`

     

       299
       299
       +
           :   An attribute of arguments to pass to the test. These override the existing arguments, as well as any `_module.args.<name>` that the modules may define. See [`evalModules`/`specialArgs`](https://nixos.org/manual/nixpkgs/stable/#module-system-lib-evalModules-param-specialArgs).

     

       300
       300
       +
       

     

       278
       301
        
       ## Test Options Reference {#sec-test-options-reference}

     

       279
       302
        
       

     

       280
       303
        
       The following options can be used when writing tests.

nixos/doc/manual/redirects.json

···

       1
       1
        
       {

     

       2
       2
       +
         "sec-override-nixos-test": [

     

       3
       3
       +
           "index.html#sec-override-nixos-test"

     

       4
       4
       +
         ],

     

       5
       5
       +
         "test-opt-rawTestDerivationArg": [

     

       6
       6
       +
           "index.html#test-opt-rawTestDerivationArg"

     

       7
       7
       +
         ],

     

       2
       8
        
         "book-nixos-manual": [

     

       3
       9
        
           "index.html#book-nixos-manual"

     

       4
       10
        
         ],

+31 -1

nixos/lib/testing/call-test.nix

···

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

     

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         extendModules,

     

       4
       4
       +
         lib,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       2
       7
        
       let

     

       3
       8
        
         inherit (lib) mkOption types;

     

       9
       9
       +
       

     

       10
       10
       +
         unsafeGetAttrPosStringOr =

     

       11
       11
       +
           default: name: value:

     

       12
       12
       +
           let

     

       13
       13
       +
             p = builtins.unsafeGetAttrPos name value;

     

       14
       14
       +
           in

     

       15
       15
       +
           if p == null then default else p.file + ":" + toString p.line + ":" + toString p.column;

     

       16
       16
       +
       

     

       4
       17
        
       in

     

       5
       18
        
       {

     

       6
       19
        
         options = {

     
···

       8
       21
        
             internal = true;

     

       9
       22
        
             default = config;

     

       10
       23
        
           };

     

       24
       24
       +
         };

     

       25
       25
       +
         config = {

     

       26
       26
       +
           # Docs: nixos/doc/manual/development/writing-nixos-tests.section.md

     

       27
       27
       +
           /**

     

       28
       28
       +
             See https://nixos.org/manual/nixos/unstable#sec-override-nixos-test

     

       29
       29
       +
           */

     

       30
       30
       +
           passthru.extend =

     

       31
       31
       +
             args@{

     

       32
       32
       +
               modules,

     

       33
       33
       +
               specialArgs ? { },

     

       34
       34
       +
             }:

     

       35
       35
       +
             (extendModules {

     

       36
       36
       +
               inherit specialArgs;

     

       37
       37
       +
               modules = map (lib.setDefaultModuleLocation (

     

       38
       38
       +
                 unsafeGetAttrPosStringOr "<test.extend module>" "modules" args

     

       39
       39
       +
               )) modules;

     

       40
       40
       +
             }).config.test;

     

       11
       41
        
         };

     

       12
       42
        
       }

+46 -2

nixos/lib/testing/run.nix

···

       2
       2
        
         config,

     

       3
       3
        
         hostPkgs,

     

       4
       4
        
         lib,

     

       5
       5
       +
         options,

     

       5
       6
        
         ...

     

       6
       7
        
       }:

     

       7
       8
        
       let

     

       8
       9
        
         inherit (lib) types mkOption;

     

       10
       10
       +
       

     

       11
       11
       +
         # TODO (lib): Also use lib equivalent in nodes.nix

     

       12
       12
       +
         /**

     

       13
       13
       +
           Create a module system definition that overrides an existing option from a different module evaluation.

     

       14
       14
       +
       

     

       15
       15
       +
           Type: Option a -> (a -> a) -> Definition a

     

       16
       16
       +
         */

     

       17
       17
       +
         mkOneUp =

     

       18
       18
       +
           /**

     

       19
       19
       +
             Option from an existing module evaluation, e.g.

     

       20
       20
       +
             - `(lib.evalModules ...).options.x` when invoking `evalModules` again,

     

       21
       21
       +
             - or `{ options, ... }:` when invoking `extendModules`.

     

       22
       22
       +
           */

     

       23
       23
       +
           opt:

     

       24
       24
       +
           /**

     

       25
       25
       +
             Function from the old value to the new definition, which will be wrapped with `mkOverride`.

     

       26
       26
       +
           */

     

       27
       27
       +
           f:

     

       28
       28
       +
           lib.mkOverride (opt.highestPrio - 1) (f opt.value);

     

       29
       29
       +
       

     

       9
       30
        
       in

     

       10
       31
        
       {

     

       11
       32
        
         options = {

     
···

       30
       51
        
             internal = true;

     

       31
       52
        
           };

     

       32
       53
        
       

     

       54
       54
       +
           rawTestDerivationArg = mkOption {

     

       55
       55
       +
             type = types.functionTo types.raw;

     

       56
       56
       +
             description = ''

     

       57
       57
       +
               Argument passed to `mkDerivation` to create the `rawTestDerivation`.

     

       58
       58
       +
             '';

     

       59
       59
       +
           };

     

       60
       60
       +
       

     

       33
       61
        
           test = mkOption {

     

       34
       62
        
             type = types.package;

     

       35
       63
        
             # TODO: can the interactive driver be configured to access the network?

     
···

       43
       71
        
         };

     

       44
       72
        
       

     

       45
       73
        
         config = {

     

       46
       46
       -
           rawTestDerivation =

     

       74
       74
       +
           rawTestDerivation = hostPkgs.stdenv.mkDerivation config.rawTestDerivationArg;

     

       75
       75
       +
           rawTestDerivationArg =

     

       76
       76
       +
             finalAttrs:

     

       47
       77
        
             assert lib.assertMsg (!config.sshBackdoor.enable)

     

       48
       78
        
               "The SSH backdoor is currently not supported for non-interactive testing! Please make sure to only set `interactive.sshBackdoor.enable = true;`!";

     

       49
       49
       -
             hostPkgs.stdenv.mkDerivation {

     

       79
       79
       +
             {

     

       50
       80
        
               name = "vm-test-run-${config.name}";

     

       51
       81
        
       

     

       52
       82
        
               requiredSystemFeatures =

     
···

       75
       105
        
       

     

       76
       106
        
           # useful for inspection (debugging / exploration)

     

       77
       107
        
           passthru.config = config;

     

       108
       108
       +
       

     

       109
       109
       +
           # Docs: nixos/doc/manual/development/writing-nixos-tests.section.md

     

       110
       110
       +
           /**

     

       111
       111
       +
             See https://nixos.org/manual/nixos/unstable#sec-override-nixos-test

     

       112
       112
       +
           */

     

       113
       113
       +
           passthru.overrideTestDerivation =

     

       114
       114
       +
             f:

     

       115
       115
       +
             config.passthru.extend {

     

       116
       116
       +
               modules = [

     

       117
       117
       +
                 {

     

       118
       118
       +
                   rawTestDerivationArg = mkOneUp options.rawTestDerivationArg (lib.extends (lib.toExtension f));

     

       119
       119
       +
                 }

     

       120
       120
       +
               ];

     

       121
       121
       +
             };

     

       78
       122
        
         };

     

       79
       123
        
       }