commit 871526be1fb3d371437a8382901c8a9a25deb197 · pyrox.dev/nixpkgs

+68

lib/asserts.nix

···

       1
        
       { lib }:

     

       2
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       3
        
       rec {

     

       4
        
       

     

       5
        
         /**

     
···

       131
        
             "each element in ${name} must be one of ${lib.generators.toPretty { } xs}, but is: ${

     

       132
        
               lib.generators.toPretty { } vals

     

       133
        
             }";

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       134
        
       }

···

       1
        
       { lib }:

     

       2
        
       

     

       3
       +
       let

     

       4
       +
         inherit (lib.strings)

     

       5
       +
           concatStringsSep

     

       6
       +
           ;

     

       7
       +
         inherit (lib.lists)

     

       8
       +
           filter

     

       9
       +
           ;

     

       10
       +
         inherit (lib.trivial)

     

       11
       +
           showWarnings

     

       12
       +
           ;

     

       13
       +
       in

     

       14
        
       rec {

     

       15
        
       

     

       16
        
         /**

     
···

       142
        
             "each element in ${name} must be one of ${lib.generators.toPretty { } xs}, but is: ${

     

       143
        
               lib.generators.toPretty { } vals

     

       144
        
             }";

     

       145
       +
       

     

       146
       +
         /**

     

       147
       +
           Wrap a value with logic that throws an error when assertions

     

       148
       +
           fail and emits any warnings.

     

       149
       +
       

     

       150
       +
           # Inputs

     

       151
       +
       

     

       152
       +
           `assertions`

     

       153
       +
       

     

       154
       +
           : A list of assertions. If any of their `assertion` attrs is `false`, their `message` attrs will be emitted in a `throw`.

     

       155
       +
       

     

       156
       +
           `warnings`

     

       157
       +
       

     

       158
       +
           : A list of strings to emit as warnings. This function does no filtering on this list.

     

       159
       +
       

     

       160
       +
           `val`

     

       161
       +
       

     

       162
       +
           : A value to return, wrapped in `warn`, if a `throw` is not necessary.

     

       163
       +
       

     

       164
       +
           # Type

     

       165
       +
       

     

       166
       +
           ```

     

       167
       +
           checkAssertWarn :: [ { assertion :: Bool; message :: String } ] -> [ String ] -> Any -> Any

     

       168
       +
           ```

     

       169
       +
       

     

       170
       +
           # Examples

     

       171
       +
           :::{.example}

     

       172
       +
           ## `lib.asserts.checkAssertWarn` usage example

     

       173
       +
           ```nix

     

       174
       +
           checkAssertWarn

     

       175
       +
             [ { assertion = false; message = "Will fail"; } ]

     

       176
       +
             [ ]

     

       177
       +
             null

     

       178
       +
           stderr>        error:

     

       179
       +
           stderr>        Failed assertions:

     

       180
       +
           stderr>        - Will fail

     

       181
       +
       

     

       182
       +
           checkAssertWarn

     

       183
       +
             [ { assertion = true; message = "Will not fail"; } ]

     

       184
       +
             [ "Will warn" ]

     

       185
       +
             null

     

       186
       +
           stderr> evaluation warning: Will warn

     

       187
       +
           null

     

       188
       +
           ```

     

       189
       +
       

     

       190
       +
           :::

     

       191
       +
         */

     

       192
       +
         checkAssertWarn =

     

       193
       +
           assertions: warnings: val:

     

       194
       +
           let

     

       195
       +
             failedAssertions = map (x: x.message) (filter (x: !x.assertion) assertions);

     

       196
       +
           in

     

       197
       +
           if failedAssertions != [ ] then

     

       198
       +
             throw "\nFailed assertions:\n${concatStringsSep "\n" (map (x: "- ${x}") failedAssertions)}"

     

       199
       +
           else

     

       200
       +
             showWarnings warnings val;

     

       201
       +
       

     

       202
        
       }

+77 -55

nixos/modules/image/repart.nix

···

       3
        
       

     

       4
        
       {

     

       5
        
         config,

     

       0
        
       
     

       6
        
         pkgs,

     

       7
        
         lib,

     

       8
        
         utils,

     
···

       258
        
             '';

     

       259
        
           };

     

       260
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       261
        
         };

     

       262
        
       

     

       263
        
         config = {

     

       264
       -
           assertions = lib.mapAttrsToList (

     

       265
       -
             fileName: partitionConfig:

     

       266
       -
             let

     

       267
       -
               inherit (partitionConfig) repartConfig;

     

       268
       -
               labelLength = builtins.stringLength repartConfig.Label;

     

       269
       -
             in

     

       270
       -
             {

     

       271
       -
               assertion = repartConfig ? Label -> GPTMaxLabelLength >= labelLength;

     

       272
       -
               message = ''

     

       273
       -
                 The partition label '${repartConfig.Label}'

     

       274
       -
                 defined for '${fileName}' is ${toString labelLength} characters long,

     

       275
       -
                 but the maximum label length supported by UEFI is ${toString GPTMaxLabelLength}.

     

       276
       -
               '';

     

       277
       -
             }

     

       278
       -
           ) cfg.partitions;

     

       279
       -
       

     

       280
       -
           warnings = lib.filter (v: v != null) (

     

       281
       -
             lib.mapAttrsToList (

     

       282
       -
               fileName: partitionConfig:

     

       283
       -
               let

     

       284
       -
                 inherit (partitionConfig) repartConfig;

     

       285
       -
                 suggestedMaxLabelLength = GPTMaxLabelLength - 2;

     

       286
       -
                 labelLength = builtins.stringLength repartConfig.Label;

     

       287
       -
               in

     

       288
       -
               if (repartConfig ? Label && labelLength >= suggestedMaxLabelLength) then

     

       289
       -
                 ''

     

       290
       -
                   The partition label '${repartConfig.Label}'

     

       291
       -
                   defined for '${fileName}' is ${toString labelLength} characters long.

     

       292
       -
                   The suggested maximum label length is ${toString suggestedMaxLabelLength}.

     

       293
       -
       

     

       294
       -
                   If you use sytemd-sysupdate style A/B updates, this might

     

       295
       -
                   not leave enough space to increment the version number included in

     

       296
       -
                   the label in a future release. For example, if your label is

     

       297
       -
                   ${toString GPTMaxLabelLength} characters long (the maximum enforced by UEFI) and

     

       298
       -
                   you're at version 9, you cannot increment this to 10.

     

       299
       -
                 ''

     

       300
       -
               else

     

       301
       -
                 null

     

       302
       -
             ) cfg.partitions

     

       303
       -
           );

     

       304
       -
       

     

       305
        
           image.baseName =

     

       306
        
             let

     

       307
        
               version = config.image.repart.version;

     
···

       352
        
               };

     

       353
        
       

     

       354
        
               finalPartitions = lib.mapAttrs addClosure cfg.partitions;

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       355
        
             };

     

       356
        
       

     

       357
        
           system.build.image =

     
···

       367
        
               );

     

       368
        
       

     

       369
        
               mkfsEnv = mkfsOptionsToEnv cfg.mkfsOptions;

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       370
        
             in

     

       371
       -
             pkgs.callPackage ./repart-image.nix {

     

       372
       -
               systemd = cfg.package;

     

       373
       -
               imageFileBasename = config.image.baseName;

     

       374
       -
               inherit (cfg)

     

       375
       -
                 name

     

       376
       -
                 version

     

       377
       -
                 compression

     

       378
       -
                 split

     

       379
       -
                 seed

     

       380
       -
                 sectorSize

     

       381
       -
                 finalPartitions

     

       382
       -
                 ;

     

       383
       -
               inherit fileSystems definitionsDirectory mkfsEnv;

     

       384
       -
             };

     

       385
        
         };

     

       386
        
       

     

       387
        
         meta.maintainers = with lib.maintainers; [

···

       3
        
       

     

       4
        
       {

     

       5
        
         config,

     

       6
       +
         options,

     

       7
        
         pkgs,

     

       8
        
         lib,

     

       9
        
         utils,

     
···

       259
        
             '';

     

       260
        
           };

     

       261
        
       

     

       262
       +
           assertions = lib.mkOption {

     

       263
       +
             type = options.assertions.type;

     

       264
       +
             default = [ ];

     

       265
       +
             internal = true;

     

       266
       +
             visible = false;

     

       267
       +
             description = ''

     

       268
       +
               Assertions only evaluated by the repart image, not by the system toplevel.

     

       269
       +
             '';

     

       270
       +
           };

     

       271
       +
       

     

       272
       +
           warnings = lib.mkOption {

     

       273
       +
             type = options.warnings.type;

     

       274
       +
             default = [ ];

     

       275
       +
             internal = true;

     

       276
       +
             visible = false;

     

       277
       +
             description = ''

     

       278
       +
               Warnings only evaluated by the repart image, not by the system toplevel.

     

       279
       +
             '';

     

       280
       +
           };

     

       281
       +
       

     

       282
        
         };

     

       283
        
       

     

       284
        
         config = {

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       285
        
           image.baseName =

     

       286
        
             let

     

       287
        
               version = config.image.repart.version;

     
···

       332
        
               };

     

       333
        
       

     

       334
        
               finalPartitions = lib.mapAttrs addClosure cfg.partitions;

     

       335
       +
       

     

       336
       +
               assertions = lib.mapAttrsToList (

     

       337
       +
                 fileName: partitionConfig:

     

       338
       +
                 let

     

       339
       +
                   inherit (partitionConfig) repartConfig;

     

       340
       +
                   labelLength = builtins.stringLength repartConfig.Label;

     

       341
       +
                 in

     

       342
       +
                 {

     

       343
       +
                   assertion = repartConfig ? Label -> GPTMaxLabelLength >= labelLength;

     

       344
       +
                   message = ''

     

       345
       +
                     The partition label '${repartConfig.Label}'

     

       346
       +
                     defined for '${fileName}' is ${toString labelLength} characters long,

     

       347
       +
                     but the maximum label length supported by UEFI is ${toString GPTMaxLabelLength}.

     

       348
       +
                   '';

     

       349
       +
                 }

     

       350
       +
               ) cfg.partitions;

     

       351
       +
       

     

       352
       +
               warnings = lib.filter (v: v != null) (

     

       353
       +
                 lib.mapAttrsToList (

     

       354
       +
                   fileName: partitionConfig:

     

       355
       +
                   let

     

       356
       +
                     inherit (partitionConfig) repartConfig;

     

       357
       +
                     suggestedMaxLabelLength = GPTMaxLabelLength - 2;

     

       358
       +
                     labelLength = builtins.stringLength repartConfig.Label;

     

       359
       +
                   in

     

       360
       +
                   if (repartConfig ? Label && labelLength >= suggestedMaxLabelLength) then

     

       361
       +
                     ''

     

       362
       +
                       The partition label '${repartConfig.Label}'

     

       363
       +
                       defined for '${fileName}' is ${toString labelLength} characters long.

     

       364
       +
                       The suggested maximum label length is ${toString suggestedMaxLabelLength}.

     

       365
       +
       

     

       366
       +
                       If you use sytemd-sysupdate style A/B updates, this might

     

       367
       +
                       not leave enough space to increment the version number included in

     

       368
       +
                       the label in a future release. For example, if your label is

     

       369
       +
                       ${toString GPTMaxLabelLength} characters long (the maximum enforced by UEFI) and

     

       370
       +
                       you're at version 9, you cannot increment this to 10.

     

       371
       +
                     ''

     

       372
       +
                   else

     

       373
       +
                     null

     

       374
       +
                 ) cfg.partitions

     

       375
       +
               );

     

       376
        
             };

     

       377
        
       

     

       378
        
           system.build.image =

     
···

       388
        
               );

     

       389
        
       

     

       390
        
               mkfsEnv = mkfsOptionsToEnv cfg.mkfsOptions;

     

       391
       +
               val = pkgs.callPackage ./repart-image.nix {

     

       392
       +
                 systemd = cfg.package;

     

       393
       +
                 imageFileBasename = config.image.baseName;

     

       394
       +
                 inherit (cfg)

     

       395
       +
                   name

     

       396
       +
                   version

     

       397
       +
                   compression

     

       398
       +
                   split

     

       399
       +
                   seed

     

       400
       +
                   sectorSize

     

       401
       +
                   finalPartitions

     

       402
       +
                   ;

     

       403
       +
                 inherit fileSystems definitionsDirectory mkfsEnv;

     

       404
       +
               };

     

       405
        
             in

     

       406
       +
             lib.asserts.checkAssertWarn cfg.assertions cfg.warnings val;

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       407
        
         };

     

       408
        
       

     

       409
        
         meta.maintainers = with lib.maintainers; [

+1 -8

nixos/modules/system/activation/top-level.nix

···

       77
        
         );

     

       78
        
       

     

       79
        
         # Handle assertions and warnings

     

       80
       -
       

     

       81
       -
         failedAssertions = map (x: x.message) (filter (x: !x.assertion) config.assertions);

     

       82
       -
       

     

       83
       -
         baseSystemAssertWarn =

     

       84
       -
           if failedAssertions != [ ] then

     

       85
       -
             throw "\nFailed assertions:\n${concatStringsSep "\n" (map (x: "- ${x}") failedAssertions)}"

     

       86
       -
           else

     

       87
       -
             showWarnings config.warnings baseSystem;

     

       88
        
       

     

       89
        
         # Replace runtime dependencies

     

       90
        
         system =

···

       77
        
         );

     

       78
        
       

     

       79
        
         # Handle assertions and warnings

     

       80
       +
         baseSystemAssertWarn = lib.asserts.checkAssertWarn config.assertions config.warnings baseSystem;

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       81
        
       

     

       82
        
         # Replace runtime dependencies

     

       83
        
         system =