commit ea0c94f50d2f1b901ef1434eac2dc31c241ffa9a · pyrox.dev/nixpkgs

+47

doc/builders/trivial-builders.chapter.md

···

       50
       50
        
       ## `symlinkJoin` {#trivial-builder-symlinkJoin}

     

       51
       51
        
       

     

       52
       52
        
       This can be used to put many derivations into the same directory structure. It works by creating a new derivation and adding symlinks to each of the paths listed. It expects two arguments, `name`, and `paths`. `name` is the name used in the Nix store path for the created derivation. `paths` is a list of paths that will be symlinked. These paths can be to Nix store derivations or any other subdirectory contained within.

     

       53
       53
       +
       

     

       54
       54
       +
       ## `writeReferencesToFile` {#trivial-builder-writeReferencesToFile}

     

       55
       55
       +
       

     

       56
       56
       +
       Writes the closure of transitive dependencies to a file.

     

       57
       57
       +
       

     

       58
       58
       +
       This produces the equivalent of `nix-store -q --requisites`.

     

       59
       59
       +
       

     

       60
       60
       +
       For example,

     

       61
       61
       +
       

     

       62
       62
       +
       ```nix

     

       63
       63
       +
       writeReferencesToFile (writeScriptBin "hi" ''${hello}/bin/hello'')

     

       64
       64
       +
       ```

     

       65
       65
       +
       

     

       66
       66
       +
       produces an output path `/nix/store/<hash>-runtime-deps` containing

     

       67
       67
       +
       

     

       68
       68
       +
       ```nix

     

       69
       69
       +
       /nix/store/<hash>-hello-2.10

     

       70
       70
       +
       /nix/store/<hash>-hi

     

       71
       71
       +
       /nix/store/<hash>-libidn2-2.3.0

     

       72
       72
       +
       /nix/store/<hash>-libunistring-0.9.10

     

       73
       73
       +
       /nix/store/<hash>-glibc-2.32-40

     

       74
       74
       +
       ```

     

       75
       75
       +
       

     

       76
       76
       +
       You can see that this includes `hi`, the original input path,

     

       77
       77
       +
       `hello`, which is a direct reference, but also

     

       78
       78
       +
       the other paths that are indirectly required to run `hello`.

     

       79
       79
       +
       

     

       80
       80
       +
       ## `writeDirectReferencesToFile` {#trivial-builder-writeDirectReferencesToFile}

     

       81
       81
       +
       

     

       82
       82
       +
       Writes the set of references to the output file, that is, their immediate dependencies.

     

       83
       83
       +
       

     

       84
       84
       +
       This produces the equivalent of `nix-store -q --references`.

     

       85
       85
       +
       

     

       86
       86
       +
       For example,

     

       87
       87
       +
       

     

       88
       88
       +
       ```nix

     

       89
       89
       +
       writeDirectReferencesToFile (writeScriptBin "hi" ''${hello}/bin/hello'')

     

       90
       90
       +
       ```

     

       91
       91
       +
       

     

       92
       92
       +
       produces an output path `/nix/store/<hash>-runtime-references` containing

     

       93
       93
       +
       

     

       94
       94
       +
       ```nix

     

       95
       95
       +
       /nix/store/<hash>-hello-2.10

     

       96
       96
       +
       ```

     

       97
       97
       +
       

     

       98
       98
       +
       but none of `hello`'s dependencies, because those are not referenced directly

     

       99
       99
       +
       by `hi`'s output.

+29

pkgs/build-support/trivial-builders.nix

···

       438
       438
        
             done < graph

     

       439
       439
        
           '';

     

       440
       440
        
       

     

       441
       441
       +
         /*

     

       442
       442
       +
           Write the set of references to a file, that is, their immediate dependencies.

     

       443
       443
       +
       

     

       444
       444
       +
           This produces the equivalent of `nix-store -q --references`.

     

       445
       445
       +
          */

     

       446
       446
       +
         writeDirectReferencesToFile = path: runCommand "runtime-references"

     

       447
       447
       +
           {

     

       448
       448
       +
             exportReferencesGraph = ["graph" path];

     

       449
       449
       +
             inherit path;

     

       450
       450
       +
           }

     

       451
       451
       +
           ''

     

       452
       452
       +
             touch ./references

     

       453
       453
       +
             while read p; do

     

       454
       454
       +
               read dummy

     

       455
       455
       +
               read nrRefs

     

       456
       456
       +
               if [[ $p == $path ]]; then

     

       457
       457
       +
                 for ((i = 0; i < nrRefs; i++)); do

     

       458
       458
       +
                   read ref;

     

       459
       459
       +
                   echo $ref >>./references

     

       460
       460
       +
                 done

     

       461
       461
       +
               else

     

       462
       462
       +
                 for ((i = 0; i < nrRefs; i++)); do

     

       463
       463
       +
                   read ref;

     

       464
       464
       +
                 done

     

       465
       465
       +
               fi

     

       466
       466
       +
             done < graph

     

       467
       467
       +
             sort ./references >$out

     

       468
       468
       +
           '';

     

       469
       469
       +
       

     

       441
       470
        
       

     

       442
       471
        
         /* Print an error message if the file with the specified name and

     

       443
       472
        
          * hash doesn't exist in the Nix store. This function should only

+20

pkgs/build-support/trivial-builders/test.nix

···

       1
       1
       +
       { lib, nixosTest, path, writeText, hello, figlet, stdenvNoCC }:

     

       2
       2
       +
       

     

       3
       3
       +
       nixosTest {

     

       4
       4
       +
         name = "nixpkgs-trivial-builders";

     

       5
       5
       +
         nodes.machine = { ... }: {

     

       6
       6
       +
           virtualisation.writableStore = true;

     

       7
       7
       +
       

     

       8
       8
       +
           # Test runs without network, so we don't substitute and prepare our deps

     

       9
       9
       +
           nix.binaryCaches = lib.mkForce [];

     

       10
       10
       +
           environment.etc."pre-built-paths".source = writeText "pre-built-paths" (

     

       11
       11
       +
             builtins.toJSON [hello figlet stdenvNoCC]

     

       12
       12
       +
           );

     

       13
       13
       +
         };

     

       14
       14
       +
         testScript = ''

     

       15
       15
       +
           machine.succeed("""

     

       16
       16
       +
             cd ${lib.cleanSource path}

     

       17
       17
       +
             ./pkgs/build-support/trivial-builders/test.sh 2>/dev/console

     

       18
       18
       +
           """)

     

       19
       19
       +
         '';

     

       20
       20
       +
       }

+57

pkgs/build-support/trivial-builders/test.sh

···

       1
       1
       +
       #!/usr/bin/env bash

     

       2
       2
       +
       

     

       3
       3
       +
       # -------------------------------------------------------------------------- #

     

       4
       4
       +
       #

     

       5
       5
       +
       #                         trivial-builders test

     

       6
       6
       +
       #

     

       7
       7
       +
       # -------------------------------------------------------------------------- #

     

       8
       8
       +
       #

     

       9
       9
       +
       #  This file can be run independently (quick):

     

       10
       10
       +
       #

     

       11
       11
       +
       #      $ pkgs/build-support/trivial-builders/test.sh

     

       12
       12
       +
       #

     

       13
       13
       +
       #  or in the build sandbox with a ~20s VM overhead

     

       14
       14
       +
       #

     

       15
       15
       +
       #      $ nix-build -A tests.trivial-builders

     

       16
       16
       +
       #

     

       17
       17
       +
       # -------------------------------------------------------------------------- #

     

       18
       18
       +
       

     

       19
       19
       +
       # strict bash

     

       20
       20
       +
       set -euo pipefail

     

       21
       21
       +
       

     

       22
       22
       +
       # debug

     

       23
       23
       +
       # set -x

     

       24
       24
       +
       # PS4='+(${BASH_SOURCE}:${LINENO}): ${FUNCNAME[0]:+${FUNCNAME[0]}(): }'

     

       25
       25
       +
       

     

       26
       26
       +
       cd "$(dirname ${BASH_SOURCE[0]})"  # nixpkgs root

     

       27
       27
       +
       

     

       28
       28
       +
       testDirectReferences() {

     

       29
       29
       +
         expr="$1"

     

       30
       30
       +
         diff -U3 \

     

       31
       31
       +
           <(sort <$(nix-build --no-out-link --expr "with import ../../.. {}; writeDirectReferencesToFile ($expr)")) \

     

       32
       32
       +
           <(nix-store -q --references $(nix-build --no-out-link --expr "with import ../../.. {}; ($expr)") | sort)

     

       33
       33
       +
       }

     

       34
       34
       +
       

     

       35
       35
       +
       testDirectReferences 'hello'

     

       36
       36
       +
       testDirectReferences 'figlet'

     

       37
       37
       +
       testDirectReferences 'writeText "hi" "hello"'

     

       38
       38
       +
       testDirectReferences 'writeText "hi" "hello ${hello}"'

     

       39
       39
       +
       testDirectReferences 'writeText "hi" "hello ${hello} ${figlet}"'

     

       40
       40
       +
       

     

       41
       41
       +
       

     

       42
       42
       +
       

     

       43
       43
       +
       testClosure() {

     

       44
       44
       +
         expr="$1"

     

       45
       45
       +
         diff -U3 \

     

       46
       46
       +
           <(sort <$(nix-build --no-out-link --expr "with import ../../.. {}; writeReferencesToFile ($expr)")) \

     

       47
       47
       +
           <(nix-store -q --requisites $(nix-build --no-out-link --expr "with import ../../.. {}; ($expr)") | sort)

     

       48
       48
       +
       }

     

       49
       49
       +
       

     

       50
       50
       +
       testClosure 'hello'

     

       51
       51
       +
       testClosure 'figlet'

     

       52
       52
       +
       testClosure 'writeText "hi" "hello"'

     

       53
       53
       +
       testClosure 'writeText "hi" "hello ${hello}"'

     

       54
       54
       +
       testClosure 'writeText "hi" "hello ${hello} ${figlet}"'

     

       55
       55
       +
       

     

       56
       56
       +
       

     

       57
       57
       +
       echo 'OK!'

pkgs/test/default.nix

···

       50
       50
        
       

     

       51
       51
        
         cuda = callPackage ./cuda { };

     

       52
       52
        
       

     

       53
       53
       +
         trivial = callPackage ../build-support/trivial-builders/test.nix {};

     

       54
       54
       +
       

     

       53
       55
        
         writers = callPackage ../build-support/writers/test.nix {};

     

       54
       56
        
       }