commit c38f9ee11374b922074a74343d187ce13fb206b5 · pyrox.dev/nixpkgs

+46

doc/build-helpers/dev-shell-tools.chapter.md

···

       27
       27
        
       devShellTools.valueToString false

     

       28
       28
        
       => ""

     

       29
       29
        
       ```

     

       30
       30
       +
       

     

       31
       31
       +
       :::

     

       32
       32
       +
       

     

       33
       33
       +
       ## `devShellTools.unstructuredDerivationInputEnv` {#sec-devShellTools-unstructuredDerivationInputEnv}

     

       34
       34
       +
       

     

       35
       35
       +
       Convert a set of derivation attributes (as would be passed to [`derivation`]) to a set of environment variables that can be used in a shell script.

     

       36
       36
       +
       This function does not support `__structuredAttrs`, but does support `passAsFile`.

     

       37
       37
       +
       

     

       38
       38
       +
       :::{.example}

     

       39
       39
       +
       ## `unstructuredDerivationInputEnv` usage example

     

       40
       40
       +
       

     

       41
       41
       +
       ```nix

     

       42
       42
       +
       devShellTools.unstructuredDerivationInputEnv {

     

       43
       43
       +
         drvAttrs = {

     

       44
       44
       +
           name = "foo";

     

       45
       45
       +
           buildInputs = [ hello figlet ];

     

       46
       46
       +
           builder = bash;

     

       47
       47
       +
           args = [ "-c" "${./builder.sh}" ];

     

       48
       48
       +
         };

     

       49
       49
       +
       }

     

       50
       50
       +
       => {

     

       51
       51
       +
         name = "foo";

     

       52
       52
       +
         buildInputs = "/nix/store/...-hello /nix/store/...-figlet";

     

       53
       53
       +
         builder = "/nix/store/...-bash";

     

       54
       54
       +
       }

     

       55
       55
       +
       ```

     

       56
       56
       +
       

     

       57
       57
       +
       Note that `args` is not included, because Nix does not added it to the builder process environment.

     

       58
       58
       +
       

     

       59
       59
       +
       :::

     

       60
       60
       +
       

     

       61
       61
       +
       ## `devShellTools.derivationOutputEnv` {#sec-devShellTools-derivationOutputEnv}

     

       62
       62
       +
       

     

       63
       63
       +
       Takes the relevant parts of a derivation and returns a set of environment variables, that would be present in the derivation.

     

       64
       64
       +
       

     

       65
       65
       +
       :::{.example}

     

       66
       66
       +
       ## `derivationOutputEnv` usage example

     

       67
       67
       +
       

     

       68
       68
       +
       ```nix

     

       69
       69
       +
       let

     

       70
       70
       +
         pkg = hello;

     

       71
       71
       +
       in

     

       72
       72
       +
       devShellTools.derivationOutputEnv { outputList = pkg.outputs; outputMap = pkg; }

     

       73
       73
       +
       ```

     

       74
       74
       +
       

     

       75
       75
       +
       :::

nixos/tests/all-tests.nix

···

       264
       264
        
         docker-rootless = handleTestOn ["aarch64-linux" "x86_64-linux"] ./docker-rootless.nix {};

     

       265
       265
        
         docker-registry = handleTest ./docker-registry.nix {};

     

       266
       266
        
         docker-tools = handleTestOn ["x86_64-linux"] ./docker-tools.nix {};

     

       267
       267
       +
         docker-tools-nix-shell = runTest ./docker-tools-nix-shell.nix;

     

       267
       268
        
         docker-tools-cross = handleTestOn ["x86_64-linux" "aarch64-linux"] ./docker-tools-cross.nix {};

     

       268
       269
        
         docker-tools-overlay = handleTestOn ["x86_64-linux"] ./docker-tools-overlay.nix {};

     

       269
       270
        
         documize = handleTest ./documize.nix {};

+95

nixos/tests/docker-tools-nix-shell.nix

···

       1
       1
       +
       # nix-build -A nixosTests.docker-tools-nix-shell

     

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

     

       3
       3
       +
       let

     

       4
       4
       +
         inherit (config.node.pkgs.dockerTools) examples;

     

       5
       5
       +
       in

     

       6
       6
       +
       {

     

       7
       7
       +
         name = "docker-tools-nix-shell";

     

       8
       8
       +
         meta = with lib.maintainers; {

     

       9
       9
       +
           maintainers = [

     

       10
       10
       +
             infinisil

     

       11
       11
       +
             roberth

     

       12
       12
       +
           ];

     

       13
       13
       +
         };

     

       14
       14
       +
       

     

       15
       15
       +
         nodes = {

     

       16
       16
       +
           docker =

     

       17
       17
       +
             { ... }:

     

       18
       18
       +
             {

     

       19
       19
       +
               virtualisation = {

     

       20
       20
       +
                 diskSize = 3072;

     

       21
       21
       +
                 docker.enable = true;

     

       22
       22
       +
               };

     

       23
       23
       +
             };

     

       24
       24
       +
         };

     

       25
       25
       +
       

     

       26
       26
       +
         testScript = ''

     

       27
       27
       +
           docker.wait_for_unit("sockets.target")

     

       28
       28
       +
       

     

       29
       29
       +
           with subtest("buildImageWithNixDB: Has a nix database"):

     

       30
       30
       +
               docker.succeed(

     

       31
       31
       +
                   "docker load --input='${examples.nix}'",

     

       32
       32
       +
                   "docker run --rm ${examples.nix.imageName} nix-store -q --references /bin/bash"

     

       33
       33
       +
               )

     

       34
       34
       +
       

     

       35
       35
       +
           with subtest("buildNixShellImage: Can build a basic derivation"):

     

       36
       36
       +
               docker.succeed(

     

       37
       37
       +
                   "${examples.nix-shell-basic} | docker load",

     

       38
       38
       +
                   "docker run --rm nix-shell-basic bash -c 'buildDerivation && $out/bin/hello' | grep '^Hello, world!$'"

     

       39
       39
       +
               )

     

       40
       40
       +
       

     

       41
       41
       +
           with subtest("buildNixShellImage: Runs the shell hook"):

     

       42
       42
       +
               docker.succeed(

     

       43
       43
       +
                   "${examples.nix-shell-hook} | docker load",

     

       44
       44
       +
                   "docker run --rm -it nix-shell-hook | grep 'This is the shell hook!'"

     

       45
       45
       +
               )

     

       46
       46
       +
       

     

       47
       47
       +
           with subtest("buildNixShellImage: Sources stdenv, making build inputs available"):

     

       48
       48
       +
               docker.succeed(

     

       49
       49
       +
                   "${examples.nix-shell-inputs} | docker load",

     

       50
       50
       +
                   "docker run --rm -it nix-shell-inputs | grep 'Hello, world!'"

     

       51
       51
       +
               )

     

       52
       52
       +
       

     

       53
       53
       +
           with subtest("buildNixShellImage: passAsFile works"):

     

       54
       54
       +
               docker.succeed(

     

       55
       55
       +
                   "${examples.nix-shell-pass-as-file} | docker load",

     

       56
       56
       +
                   "docker run --rm -it nix-shell-pass-as-file | grep 'this is a string'"

     

       57
       57
       +
               )

     

       58
       58
       +
       

     

       59
       59
       +
           with subtest("buildNixShellImage: run argument works"):

     

       60
       60
       +
               docker.succeed(

     

       61
       61
       +
                   "${examples.nix-shell-run} | docker load",

     

       62
       62
       +
                   "docker run --rm -it nix-shell-run | grep 'This shell is not interactive'"

     

       63
       63
       +
               )

     

       64
       64
       +
       

     

       65
       65
       +
           with subtest("buildNixShellImage: command argument works"):

     

       66
       66
       +
               docker.succeed(

     

       67
       67
       +
                   "${examples.nix-shell-command} | docker load",

     

       68
       68
       +
                   "docker run --rm -it nix-shell-command | grep 'This shell is interactive'"

     

       69
       69
       +
               )

     

       70
       70
       +
       

     

       71
       71
       +
           with subtest("buildNixShellImage: home directory is writable by default"):

     

       72
       72
       +
               docker.succeed(

     

       73
       73
       +
                   "${examples.nix-shell-writable-home} | docker load",

     

       74
       74
       +
                   "docker run --rm -it nix-shell-writable-home"

     

       75
       75
       +
               )

     

       76
       76
       +
       

     

       77
       77
       +
           with subtest("buildNixShellImage: home directory can be made non-existent"):

     

       78
       78
       +
               docker.succeed(

     

       79
       79
       +
                   "${examples.nix-shell-nonexistent-home} | docker load",

     

       80
       80
       +
                   "docker run --rm -it nix-shell-nonexistent-home"

     

       81
       81
       +
               )

     

       82
       82
       +
       

     

       83
       83
       +
           with subtest("buildNixShellImage: can build derivations"):

     

       84
       84
       +
               docker.succeed(

     

       85
       85
       +
                   "${examples.nix-shell-build-derivation} | docker load",

     

       86
       86
       +
                   "docker run --rm -it nix-shell-build-derivation"

     

       87
       87
       +
               )

     

       88
       88
       +
       

     

       89
       89
       +
           with subtest("streamLayeredImage: with nix db"):

     

       90
       90
       +
               docker.succeed(

     

       91
       91
       +
                   "${examples.nix-layered} | docker load",

     

       92
       92
       +
                   "docker run --rm ${examples.nix-layered.imageName} nix-store -q --references /bin/bash"

     

       93
       93
       +
               )

     

       94
       94
       +
         '';

     

       95
       95
       +
       }

+1 -67

nixos/tests/docker-tools.nix

···

       60
       60
        
           };

     

       61
       61
        
       

     

       62
       62
        
         nonRootTestImage =

     

       63
       63
       -
           pkgs.dockerTools.streamLayeredImage rec {

     

       63
       63
       +
           pkgs.dockerTools.streamLayeredImage {

     

       64
       64
        
             name = "non-root-test";

     

       65
       65
        
             tag = "latest";

     

       66
       66
        
             uid = 1000;

     
···

       567
       567
        
               docker.succeed("docker run --rm image-with-certs:latest test -r /etc/pki/tls/certs/ca-bundle.crt")

     

       568
       568
        
               docker.succeed("docker image rm image-with-certs:latest")

     

       569
       569
        
       

     

       570
       570
       -
           with subtest("buildImageWithNixDB: Has a nix database"):

     

       571
       571
       -
               docker.succeed(

     

       572
       572
       -
                   "docker load --input='${examples.nix}'",

     

       573
       573
       -
                   "docker run --rm ${examples.nix.imageName} nix-store -q --references /bin/bash"

     

       574
       574
       -
               )

     

       575
       575
       -
       

     

       576
       576
       -
           with subtest("buildNixShellImage: Can build a basic derivation"):

     

       577
       577
       -
               docker.succeed(

     

       578
       578
       -
                   "${examples.nix-shell-basic} | docker load",

     

       579
       579
       -
                   "docker run --rm nix-shell-basic bash -c 'buildDerivation && $out/bin/hello' | grep '^Hello, world!$'"

     

       580
       580
       -
               )

     

       581
       581
       -
       

     

       582
       582
       -
           with subtest("buildNixShellImage: Runs the shell hook"):

     

       583
       583
       -
               docker.succeed(

     

       584
       584
       -
                   "${examples.nix-shell-hook} | docker load",

     

       585
       585
       -
                   "docker run --rm -it nix-shell-hook | grep 'This is the shell hook!'"

     

       586
       586
       -
               )

     

       587
       587
       -
       

     

       588
       588
       -
           with subtest("buildNixShellImage: Sources stdenv, making build inputs available"):

     

       589
       589
       -
               docker.succeed(

     

       590
       590
       -
                   "${examples.nix-shell-inputs} | docker load",

     

       591
       591
       -
                   "docker run --rm -it nix-shell-inputs | grep 'Hello, world!'"

     

       592
       592
       -
               )

     

       593
       593
       -
       

     

       594
       594
       -
           with subtest("buildNixShellImage: passAsFile works"):

     

       595
       595
       -
               docker.succeed(

     

       596
       596
       -
                   "${examples.nix-shell-pass-as-file} | docker load",

     

       597
       597
       -
                   "docker run --rm -it nix-shell-pass-as-file | grep 'this is a string'"

     

       598
       598
       -
               )

     

       599
       599
       -
       

     

       600
       600
       -
           with subtest("buildNixShellImage: run argument works"):

     

       601
       601
       -
               docker.succeed(

     

       602
       602
       -
                   "${examples.nix-shell-run} | docker load",

     

       603
       603
       -
                   "docker run --rm -it nix-shell-run | grep 'This shell is not interactive'"

     

       604
       604
       -
               )

     

       605
       605
       -
       

     

       606
       606
       -
           with subtest("buildNixShellImage: command argument works"):

     

       607
       607
       -
               docker.succeed(

     

       608
       608
       -
                   "${examples.nix-shell-command} | docker load",

     

       609
       609
       -
                   "docker run --rm -it nix-shell-command | grep 'This shell is interactive'"

     

       610
       610
       -
               )

     

       611
       611
       -
       

     

       612
       612
       -
           with subtest("buildNixShellImage: home directory is writable by default"):

     

       613
       613
       -
               docker.succeed(

     

       614
       614
       -
                   "${examples.nix-shell-writable-home} | docker load",

     

       615
       615
       -
                   "docker run --rm -it nix-shell-writable-home"

     

       616
       616
       -
               )

     

       617
       617
       -
       

     

       618
       618
       -
           with subtest("buildNixShellImage: home directory can be made non-existent"):

     

       619
       619
       -
               docker.succeed(

     

       620
       620
       -
                   "${examples.nix-shell-nonexistent-home} | docker load",

     

       621
       621
       -
                   "docker run --rm -it nix-shell-nonexistent-home"

     

       622
       622
       -
               )

     

       623
       623
       -
       

     

       624
       624
       -
           with subtest("buildNixShellImage: can build derivations"):

     

       625
       625
       -
               docker.succeed(

     

       626
       626
       -
                   "${examples.nix-shell-build-derivation} | docker load",

     

       627
       627
       -
                   "docker run --rm -it nix-shell-build-derivation"

     

       628
       628
       -
               )

     

       629
       629
       -
       

     

       630
       570
        
           with subtest("streamLayeredImage: chown is persistent in fakeRootCommands"):

     

       631
       571
        
               docker.succeed(

     

       632
       572
        
                   "${chownTestImage} | docker load",

     
···

       637
       577
        
               docker.succeed(

     

       638
       578
        
                   "${nonRootTestImage} | docker load",

     

       639
       579
        
                   "docker run --rm ${chownTestImage.imageName} | diff /dev/stdin <(echo 12345:12345)"

     

       640
       640
       -
               )

     

       641
       641
       -
       

     

       642
       642
       -
           with subtest("streamLayeredImage: with nix db"):

     

       643
       643
       -
               docker.succeed(

     

       644
       644
       -
                   "${examples.nix-layered} | docker load",

     

       645
       645
       -
                   "docker run --rm ${examples.nix-layered.imageName} nix-store -q --references /bin/bash"

     

       646
       580
        
               )

     

       647
       581
        
         '';

     

       648
       582
        
       })

+50 -1

pkgs/build-support/dev-shell-tools/default.nix

···

       1
       1
       -
       { lib }:

     

       1
       1
       +
       {

     

       2
       2
       +
         lib,

     

       3
       3
       +
         writeTextFile,

     

       4
       4
       +
       }:

     

       2
       5
        
       let

     

       3
       6
        
         inherit (builtins) typeOf;

     

       4
       7
        
       in

     

       5
       8
        
       rec {

     

       9
       9
       +
         # Docs: doc/build-helpers/dev-shell-tools.chapter.md

     

       10
       10
       +
         # Tests: ./tests/default.nix

     

       6
       11
        
         # This function closely mirrors what this Nix code does:

     

       7
       12
        
         # https://github.com/NixOS/nix/blob/2.8.0/src/libexpr/primops.cc#L1102

     

       8
       13
        
         # https://github.com/NixOS/nix/blob/2.8.0/src/libexpr/eval.cc#L1981-L2036

     
···

       13
       18
        
           if typeOf value == "path" then "${value}"

     

       14
       19
        
           else if typeOf value == "list" then toString (map valueToString value)

     

       15
       20
        
           else toString value;

     

       21
       21
       +
       

     

       22
       22
       +
       

     

       23
       23
       +
         # Docs: doc/build-helpers/dev-shell-tools.chapter.md

     

       24
       24
       +
         # Tests: ./tests/default.nix

     

       25
       25
       +
         # https://github.com/NixOS/nix/blob/2.8.0/src/libstore/build/local-derivation-goal.cc#L992-L1004

     

       26
       26
       +
         unstructuredDerivationInputEnv = { drvAttrs }:

     

       27
       27
       +
           # FIXME: this should be `normalAttrs // passAsFileAttrs`

     

       28
       28
       +
           lib.mapAttrs'

     

       29
       29
       +
             (name: value:

     

       30
       30
       +
               let str = valueToString value;

     

       31
       31
       +
               in if lib.elem name (drvAttrs.passAsFile or [])

     

       32
       32
       +
               then

     

       33
       33
       +
                 let

     

       34
       34
       +
                   nameHash =

     

       35
       35
       +
                     if builtins?convertHash

     

       36
       36
       +
                     then builtins.convertHash {

     

       37
       37
       +
                       hash = "sha256:" + builtins.hashString "sha256" name;

     

       38
       38
       +
                       toHashFormat = "nix32";

     

       39
       39
       +
                     }

     

       40
       40
       +
                     else

     

       41
       41
       +
                       builtins.hashString "sha256" name;

     

       42
       42
       +
                   basename = ".attr-${nameHash}";

     

       43
       43
       +
                 in

     

       44
       44
       +
                   lib.nameValuePair "${name}Path" "${

     

       45
       45
       +
                     writeTextFile {

     

       46
       46
       +
                       name = "shell-passAsFile-${name}";

     

       47
       47
       +
                       text = str;

     

       48
       48
       +
                       destination = "/${basename}";

     

       49
       49
       +
                     }

     

       50
       50
       +
                   }/${basename}"

     

       51
       51
       +
               else lib.nameValuePair name str

     

       52
       52
       +
             )

     

       53
       53
       +
             (removeAttrs drvAttrs [

     

       54
       54
       +
               # TODO: there may be more of these

     

       55
       55
       +
               "args"

     

       56
       56
       +
             ]);

     

       57
       57
       +
       

     

       58
       58
       +
         # Docs: doc/build-helpers/dev-shell-tools.chapter.md

     

       59
       59
       +
         # Tests: ./tests/default.nix

     

       60
       60
       +
         derivationOutputEnv = { outputList, outputMap }:

     

       61
       61
       +
           # A mapping from output name to the nix store path where they should end up

     

       62
       62
       +
           # https://github.com/NixOS/nix/blob/2.8.0/src/libexpr/primops.cc#L1253

     

       63
       63
       +
           lib.genAttrs outputList (output: builtins.unsafeDiscardStringContext outputMap.${output}.outPath);

     

       64
       64
       +
       

     

       16
       65
        
       }

+122 -2

pkgs/build-support/dev-shell-tools/tests/default.nix

···

       4
       4
        
         lib,

     

       5
       5
        
         stdenv,

     

       6
       6
        
         hello,

     

       7
       7
       +
         writeText,

     

       8
       8
       +
         zlib,

     

       9
       9
       +
         nixosTests,

     

       7
       10
        
       }:

     

       8
       11
        
       let

     

       9
       9
       -
         inherit (lib) escapeShellArg;

     

       12
       12
       +
         inherit (lib)

     

       13
       13
       +
           concatLines

     

       14
       14
       +
           escapeShellArg

     

       15
       15
       +
           isString

     

       16
       16
       +
           mapAttrsToList

     

       17
       17
       +
           ;

     

       10
       18
        
       in

     

       11
       11
       -
       {

     

       19
       19
       +
       lib.recurseIntoAttrs {

     

       20
       20
       +
       

     

       21
       21
       +
         # nix-build -A tests.devShellTools.nixos

     

       22
       22
       +
         nixos = nixosTests.docker-tools-nix-shell;

     

       23
       23
       +
       

     

       12
       24
        
         # nix-build -A tests.devShellTools.valueToString

     

       13
       25
        
         valueToString =

     

       14
       26
        
           let inherit (devShellTools) valueToString; in

     
···

       42
       54
        
               ) >log 2>&1 || { cat log; exit 1; }

     

       43
       55
        
             '';

     

       44
       56
        
           };

     

       57
       57
       +
       

     

       58
       58
       +
         # nix-build -A tests.devShellTools.valueToString

     

       59
       59
       +
         unstructuredDerivationInputEnv =

     

       60
       60
       +
           let

     

       61
       61
       +
             inherit (devShellTools) unstructuredDerivationInputEnv;

     

       62
       62
       +
       

     

       63
       63
       +
             drvAttrs = {

     

       64
       64
       +
               one = 1;

     

       65
       65
       +
               boolTrue = true;

     

       66
       66
       +
               boolFalse = false;

     

       67
       67
       +
               foo = "foo";

     

       68
       68
       +
               list = [ 1 2 3 ];

     

       69
       69
       +
               pathDefaultNix = ./default.nix;

     

       70
       70
       +
               stringWithDep = "Exe: ${hello}/bin/hello";

     

       71
       71
       +
               aPackageAttrSet = hello;

     

       72
       72
       +
               anOutPath = hello.outPath;

     

       73
       73
       +
               anAnAlternateOutput = zlib.dev;

     

       74
       74
       +
               args = [ "args must not be added to the environment" "Nix doesn't do it." ];

     

       75
       75
       +
       

     

       76
       76
       +
               passAsFile = [ "bar" ];

     

       77
       77
       +
               bar = ''

     

       78
       78
       +
                 bar

     

       79
       79
       +
                 ${writeText "qux" "yea"}

     

       80
       80
       +
               '';

     

       81
       81
       +
             };

     

       82
       82
       +
             result = unstructuredDerivationInputEnv { inherit drvAttrs; };

     

       83
       83
       +
           in

     

       84
       84
       +
           assert result // { barPath = "<check later>"; } == {

     

       85
       85
       +
             one = "1";

     

       86
       86
       +
             boolTrue = "1";

     

       87
       87
       +
             boolFalse = "";

     

       88
       88
       +
             foo = "foo";

     

       89
       89
       +
             list = "1 2 3";

     

       90
       90
       +
             pathDefaultNix = "${./default.nix}";

     

       91
       91
       +
             stringWithDep = "Exe: ${hello}/bin/hello";

     

       92
       92
       +
             aPackageAttrSet = "${hello}";

     

       93
       93
       +
             anOutPath = "${hello.outPath}";

     

       94
       94
       +
             anAnAlternateOutput = "${zlib.dev}";

     

       95
       95
       +
       

     

       96
       96
       +
             passAsFile = "bar";

     

       97
       97
       +
             barPath = "<check later>";

     

       98
       98
       +
           };

     

       99
       99
       +
       

     

       100
       100
       +
           # Not runCommand, because it alters `passAsFile`

     

       101
       101
       +
           stdenv.mkDerivation ({

     

       102
       102
       +
             name = "devShellTools-unstructuredDerivationInputEnv-built-tests";

     

       103
       103
       +
       

     

       104
       104
       +
             exampleBarPathString =

     

       105
       105
       +
               assert isString result.barPath;

     

       106
       106
       +
               result.barPath;

     

       107
       107
       +
       

     

       108
       108
       +
             dontUnpack = true;

     

       109
       109
       +
             dontBuild = true;

     

       110
       110
       +
             dontFixup = true;

     

       111
       111
       +
             doCheck = true;

     

       112
       112
       +
       

     

       113
       113
       +
             installPhase = "touch $out";

     

       114
       114
       +
       

     

       115
       115
       +
             checkPhase = ''

     

       116
       116
       +
               fail() {

     

       117
       117
       +
                 echo "$@" >&2

     

       118
       118
       +
                 exit 1

     

       119
       119
       +
               }

     

       120
       120
       +
               checkAttr() {

     

       121
       121
       +
                 echo checking attribute $1...

     

       122
       122
       +
                 if [[ "$2" != "$3" ]]; then

     

       123
       123
       +
                   echo "expected: $3"

     

       124
       124
       +
                   echo "actual: $2"

     

       125
       125
       +
                   exit 1

     

       126
       126
       +
                 fi

     

       127
       127
       +
               }

     

       128
       128
       +
               ${

     

       129
       129
       +
                 concatLines

     

       130
       130
       +
                   (mapAttrsToList

     

       131
       131
       +
                     (name: value:

     

       132
       132
       +
                       "checkAttr ${name} \"\$${name}\" ${escapeShellArg value}"

     

       133
       133
       +
                     )

     

       134
       134
       +
                     (removeAttrs

     

       135
       135
       +
                       result

     

       136
       136
       +
                       [

     

       137
       137
       +
                         "args"

     

       138
       138
       +
       

     

       139
       139
       +
                         # Nix puts it in workdir, which is not a concept for

     

       140
       140
       +
                         # unstructuredDerivationInputEnv, so we have to put it in the

     

       141
       141
       +
                         # store instead. This means the full path won't match.

     

       142
       142
       +
                         "barPath"

     

       143
       143
       +
                       ])

     

       144
       144
       +
                   )

     

       145
       145
       +
               }

     

       146
       146
       +
               (

     

       147
       147
       +
                 set -x

     

       148
       148
       +
       

     

       149
       149
       +
                 diff $exampleBarPathString $barPath

     

       150
       150
       +
       

     

       151
       151
       +
                 ${lib.optionalString (builtins?convertHash) ''

     

       152
       152
       +
                   [[ "$(basename $exampleBarPathString)" = "$(basename $barPath)" ]]

     

       153
       153
       +
                 ''}

     

       154
       154
       +
               )

     

       155
       155
       +
       

     

       156
       156
       +
               ''${args:+fail "args should not be set by Nix. We don't expect it to and unstructuredDerivationInputEnv removes it."}

     

       157
       157
       +
               if [[ "''${builder:-x}" == x ]]; then

     

       158
       158
       +
                 fail "builder should be set by Nix. We don't remove it in unstructuredDerivationInputEnv."

     

       159
       159
       +
               fi

     

       160
       160
       +
             '';

     

       161
       161
       +
           } // removeAttrs drvAttrs [

     

       162
       162
       +
             # This would break the derivation. Instead, we have a check in the derivation to make sure Nix doesn't set it.

     

       163
       163
       +
             "args"

     

       164
       164
       +
           ]);

     

       45
       165
        
       }

+16 -29

pkgs/build-support/docker/default.nix

···

       1129
       1129
        
         );

     

       1130
       1130
        
       

     

       1131
       1131
        
         # This function streams a docker image that behaves like a nix-shell for a derivation

     

       1132
       1132
       +
         # Docs: doc/build-helpers/images/dockertools.section.md

     

       1133
       1133
       +
         # Tests: nixos/tests/docker-tools-nix-shell.nix

     

       1132
       1134
        
         streamNixShellImage =

     

       1133
       1133
       -
           { # The derivation whose environment this docker image should be based on

     

       1134
       1134
       -
             drv

     

       1135
       1135
       -
           , # Image Name

     

       1136
       1136
       -
             name ? drv.name + "-env"

     

       1137
       1137
       -
           , # Image tag, the Nix's output hash will be used if null

     

       1138
       1138
       -
             tag ? null

     

       1139
       1139
       -
           , # User id to run the container as. Defaults to 1000, because many

     

       1140
       1140
       -
             # binaries don't like to be run as root

     

       1141
       1141
       -
             uid ? 1000

     

       1142
       1142
       -
           , # Group id to run the container as, see also uid

     

       1143
       1143
       -
             gid ? 1000

     

       1144
       1144
       -
           , # The home directory of the user

     

       1145
       1145
       -
             homeDirectory ? "/build"

     

       1146
       1146
       -
           , # The path to the bash binary to use as the shell. See `NIX_BUILD_SHELL` in `man nix-shell`

     

       1147
       1147
       -
             shell ? bashInteractive + "/bin/bash"

     

       1148
       1148
       -
           , # Run this command in the environment of the derivation, in an interactive shell. See `--command` in `man nix-shell`

     

       1149
       1149
       -
             command ? null

     

       1150
       1150
       -
           , # Same as `command`, but runs the command in a non-interactive shell instead. See `--run` in `man nix-shell`

     

       1151
       1151
       -
             run ? null

     

       1135
       1135
       +
           { drv

     

       1136
       1136
       +
           , name ? drv.name + "-env"

     

       1137
       1137
       +
           , tag ? null

     

       1138
       1138
       +
           , uid ? 1000

     

       1139
       1139
       +
           , gid ? 1000

     

       1140
       1140
       +
           , homeDirectory ? "/build"

     

       1141
       1141
       +
           , shell ? bashInteractive + "/bin/bash"

     

       1142
       1142
       +
           , command ? null

     

       1143
       1143
       +
           , run ? null

     

       1152
       1144
        
           }:

     

       1153
       1145
        
             assert lib.assertMsg (! (drv.drvAttrs.__structuredAttrs or false))

     

       1154
       1146
        
               "streamNixShellImage: Does not work with the derivation ${drv.name} because it uses __structuredAttrs";

     
···

       1190
       1182
        
               # https://github.com/NixOS/nix/blob/2.8.0/src/libstore/globals.hh#L464-L465

     

       1191
       1183
        
               sandboxBuildDir = "/build";

     

       1192
       1184
        
       

     

       1193
       1193
       -
               # https://github.com/NixOS/nix/blob/2.8.0/src/libstore/build/local-derivation-goal.cc#L992-L1004

     

       1194
       1194
       -
               drvEnv = lib.mapAttrs' (name: value:

     

       1195
       1195
       -
                 let str = valueToString value;

     

       1196
       1196
       -
                 in if lib.elem name (drv.drvAttrs.passAsFile or [])

     

       1197
       1197
       -
                 then lib.nameValuePair "${name}Path" (writeText "pass-as-text-${name}" str)

     

       1198
       1198
       -
                 else lib.nameValuePair name str

     

       1199
       1199
       -
               ) drv.drvAttrs //

     

       1200
       1200
       -
                 # A mapping from output name to the nix store path where they should end up

     

       1201
       1201
       -
                 # https://github.com/NixOS/nix/blob/2.8.0/src/libexpr/primops.cc#L1253

     

       1202
       1202
       -
                 lib.genAttrs drv.outputs (output: builtins.unsafeDiscardStringContext drv.${output}.outPath);

     

       1185
       1185
       +
               drvEnv =

     

       1186
       1186
       +
                 devShellTools.unstructuredDerivationInputEnv { inherit (drv) drvAttrs; }

     

       1187
       1187
       +
                 // devShellTools.derivationOutputEnv { outputList = drv.outputs; outputMap = drv; };

     

       1203
       1188
        
       

     

       1204
       1189
        
               # Environment variables set in the image

     

       1205
       1190
        
               envVars = {

     
···

       1291
       1276
        
             };

     

       1292
       1277
        
       

     

       1293
       1278
        
         # Wrapper around streamNixShellImage to build an image from the result

     

       1279
       1279
       +
         # Docs: doc/build-helpers/images/dockertools.section.md

     

       1280
       1280
       +
         # Tests: nixos/tests/docker-tools-nix-shell.nix

     

       1294
       1281
        
         buildNixShellImage = { drv, compressor ? "gz", ... }@args:

     

       1295
       1282
        
           let

     

       1296
       1283
        
             stream = streamNixShellImage (builtins.removeAttrs args ["compressor"]);