commit 5b7a21358d674be722cc0c81b9d2c04a2b710916 · pyrox.dev/nixpkgs

lib/tests/modules.sh

···

       575
       575
        
       # nested options work

     

       576
       576
        
       checkConfigOutput '^34$' options.nested.nestedLine34.declarationPositions.0.line ./declaration-positions.nix

     

       577
       577
        
       

     

       578
       578
       +
       # AttrsWith tests

     

       579
       579
       +
       checkConfigOutput '^11$' config.result ./lazy-attrsWith.nix

     

       580
       580
       +
       

     

       578
       581
        
       cat <<EOF

     

       579
       582
        
       ====== module tests ======

     

       580
       583
        
       $pass Pass

+45

lib/tests/modules/lazy-attrsWith.nix

···

       1
       1
       +
       # Check that AttrsWith { lazy = true; } is lazy

     

       2
       2
       +
       { lib, ... }:

     

       3
       3
       +
       let

     

       4
       4
       +
         inherit (lib) types mkOption;

     

       5
       5
       +
       in

     

       6
       6
       +
       {

     

       7
       7
       +
         imports = [

     

       8
       8
       +
           #  Module A

     

       9
       9
       +
           (

     

       10
       10
       +
             { ... }:

     

       11
       11
       +
             {

     

       12
       12
       +
               options.mergedLazy = mkOption {

     

       13
       13
       +
                 # Same as lazyAttrsOf

     

       14
       14
       +
                 type = types.attrsWith {

     

       15
       15
       +
                   lazy = true;

     

       16
       16
       +
                   elemType = types.int;

     

       17
       17
       +
                 };

     

       18
       18
       +
               };

     

       19
       19
       +
             }

     

       20
       20
       +
           )

     

       21
       21
       +
           # Module B

     

       22
       22
       +
           (

     

       23
       23
       +
             { ... }:

     

       24
       24
       +
             {

     

       25
       25
       +
               options.mergedLazy = lib.mkOption {

     

       26
       26
       +
                 # Same as lazyAttrsOf

     

       27
       27
       +
                 type = types.attrsWith {

     

       28
       28
       +
                   lazy = true;

     

       29
       29
       +
                   elemType = types.int;

     

       30
       30
       +
                 };

     

       31
       31
       +
               };

     

       32
       32
       +
             }

     

       33
       33
       +
           )

     

       34
       34
       +
           # Result

     

       35
       35
       +
           (

     

       36
       36
       +
             { config, ... }:

     

       37
       37
       +
             {

     

       38
       38
       +
               # Can only evaluate if lazy

     

       39
       39
       +
               config.mergedLazy.bar = config.mergedLazy.baz + 1;

     

       40
       40
       +
               config.mergedLazy.baz = 10;

     

       41
       41
       +
               options.result = mkOption { default = config.mergedLazy.bar; };

     

       42
       42
       +
             }

     

       43
       43
       +
           )

     

       44
       44
       +
         ];

     

       45
       45
       +
       }

+58 -31

lib/types.nix

···

       582
       582
        
               substSubModules = m: nonEmptyListOf (elemType.substSubModules m);

     

       583
       583
        
             };

     

       584
       584
        
       

     

       585
       585
       -
           attrsOf = elemType: mkOptionType rec {

     

       586
       586
       -
             name = "attrsOf";

     

       587
       587
       -
             description = "attribute set of ${optionDescriptionPhrase (class: class == "noun" || class == "composite") elemType}";

     

       588
       588
       -
             descriptionClass = "composite";

     

       589
       589
       -
             check = isAttrs;

     

       590
       590
       -
             merge = loc: defs:

     

       591
       591
       -
               mapAttrs (n: v: v.value) (filterAttrs (n: v: v ? value) (zipAttrsWith (name: defs:

     

       592
       592
       -
                   (mergeDefinitions (loc ++ [name]) elemType defs).optionalValue

     

       593
       593
       -
                 )

     

       594
       594
       -
                 # Push down position info.

     

       595
       595
       -
                 (map (def: mapAttrs (n: v: { inherit (def) file; value = v; }) def.value) defs)));

     

       596
       596
       -
             emptyValue = { value = {}; };

     

       597
       597
       -
             getSubOptions = prefix: elemType.getSubOptions (prefix ++ ["<name>"]);

     

       598
       598
       -
             getSubModules = elemType.getSubModules;

     

       599
       599
       -
             substSubModules = m: attrsOf (elemType.substSubModules m);

     

       600
       600
       -
             functor = (defaultFunctor name) // { wrapped = elemType; };

     

       601
       601
       -
             nestedTypes.elemType = elemType;

     

       602
       602
       -
           };

     

       585
       585
       +
           attrsOf = elemType: attrsWith { inherit elemType; };

     

       603
       586
        
       

     

       604
       587
        
           # A version of attrsOf that's lazy in its values at the expense of

     

       605
       588
        
           # conditional definitions not working properly. E.g. defining a value with

     

       606
       589
        
           # `foo.attr = mkIf false 10`, then `foo ? attr == true`, whereas with

     

       607
       590
        
           # attrsOf it would correctly be `false`. Accessing `foo.attr` would throw an

     

       608
       591
        
           # error that it's not defined. Use only if conditional definitions don't make sense.

     

       609
       609
       -
           lazyAttrsOf = elemType: mkOptionType rec {

     

       610
       610
       -
             name = "lazyAttrsOf";

     

       611
       611
       -
             description = "lazy attribute set of ${optionDescriptionPhrase (class: class == "noun" || class == "composite") elemType}";

     

       592
       592
       +
           lazyAttrsOf = elemType: attrsWith { inherit elemType; lazy = true; };

     

       593
       593
       +
       

     

       594
       594
       +
           # base type for lazyAttrsOf and attrsOf

     

       595
       595
       +
           attrsWith = {

     

       596
       596
       +
             elemType,

     

       597
       597
       +
             lazy ? false,

     

       598
       598
       +
           }:

     

       599
       599
       +
           let

     

       600
       600
       +
             typeName = if lazy then "lazyAttrsOf" else "attrsOf";

     

       601
       601
       +
             # Push down position info.

     

       602
       602
       +
             pushPositions = map (def: mapAttrs (n: v: { inherit (def) file; value = v; }) def.value);

     

       603
       603
       +
           in

     

       604
       604
       +
           mkOptionType {

     

       605
       605
       +
             name = typeName;

     

       606
       606
       +
             description = (if lazy then "lazy attribute set" else "attribute set") + " of ${optionDescriptionPhrase (class: class == "noun" || class == "composite") elemType}";

     

       612
       607
        
             descriptionClass = "composite";

     

       613
       608
        
             check = isAttrs;

     

       614
       614
       -
             merge = loc: defs:

     

       615
       615
       -
               zipAttrsWith (name: defs:

     

       616
       616
       -
                 let merged = mergeDefinitions (loc ++ [name]) elemType defs;

     

       617
       617
       -
                 # mergedValue will trigger an appropriate error when accessed

     

       618
       618
       -
                 in merged.optionalValue.value or elemType.emptyValue.value or merged.mergedValue

     

       619
       619
       -
               )

     

       620
       620
       -
               # Push down position info.

     

       621
       621
       -
               (map (def: mapAttrs (n: v: { inherit (def) file; value = v; }) def.value) defs);

     

       609
       609
       +
             merge = if lazy then (

     

       610
       610
       +
               # Lazy merge Function

     

       611
       611
       +
               loc: defs:

     

       612
       612
       +
                 zipAttrsWith (name: defs:

     

       613
       613
       +
                   let merged = mergeDefinitions (loc ++ [name]) elemType defs;

     

       614
       614
       +
                   # mergedValue will trigger an appropriate error when accessed

     

       615
       615
       +
                   in merged.optionalValue.value or elemType.emptyValue.value or merged.mergedValue

     

       616
       616
       +
                 )

     

       617
       617
       +
                 # Push down position info.

     

       618
       618
       +
                 (pushPositions defs)

     

       619
       619
       +
             ) else (

     

       620
       620
       +
               # Non-lazy merge Function

     

       621
       621
       +
               loc: defs:

     

       622
       622
       +
                 mapAttrs (n: v: v.value) (filterAttrs (n: v: v ? value) (zipAttrsWith (name: defs:

     

       623
       623
       +
                     (mergeDefinitions (loc ++ [name]) elemType (defs)).optionalValue

     

       624
       624
       +
                   )

     

       625
       625
       +
                 # Push down position info.

     

       626
       626
       +
                 (pushPositions defs)))

     

       627
       627
       +
             );

     

       622
       628
        
             emptyValue = { value = {}; };

     

       623
       629
        
             getSubOptions = prefix: elemType.getSubOptions (prefix ++ ["<name>"]);

     

       624
       630
        
             getSubModules = elemType.getSubModules;

     

       625
       625
       -
             substSubModules = m: lazyAttrsOf (elemType.substSubModules m);

     

       626
       626
       -
             functor = (defaultFunctor name) // { wrapped = elemType; };

     

       631
       631
       +
             substSubModules = m: attrsWith { elemType = elemType.substSubModules m; inherit lazy; };

     

       632
       632
       +
             functor = defaultFunctor "attrsWith" // {

     

       633
       633
       +
               wrapped = elemType;

     

       634
       634
       +
               payload = {

     

       635
       635
       +
                 # Important!: Add new function attributes here in case of future changes

     

       636
       636
       +
                 inherit elemType lazy;

     

       637
       637
       +
               };

     

       638
       638
       +
               binOp = lhs: rhs:

     

       639
       639
       +
                 let

     

       640
       640
       +
                   elemType = lhs.elemType.typeMerge rhs.elemType.functor;

     

       641
       641
       +
                   lazy =

     

       642
       642
       +
                     if lhs.lazy == rhs.lazy then

     

       643
       643
       +
                       lhs.lazy

     

       644
       644
       +
                     else

     

       645
       645
       +
                       null;

     

       646
       646
       +
                 in

     

       647
       647
       +
                 if elemType == null || lazy == null then

     

       648
       648
       +
                   null

     

       649
       649
       +
                 else

     

       650
       650
       +
                   {

     

       651
       651
       +
                     inherit elemType lazy;

     

       652
       652
       +
                   };

     

       653
       653
       +
             };

     

       627
       654
        
             nestedTypes.elemType = elemType;

     

       628
       655
        
           };

     

       629
       656