diff options
-rw-r--r-- | ci-builds.nix | 1 | ||||
-rw-r--r-- | nix/getBins/OWNERS | 3 | ||||
-rw-r--r-- | nix/getBins/default.nix | 48 | ||||
-rw-r--r-- | nix/getBins/tests.nix | 40 | ||||
-rw-r--r-- | third_party/default.nix | 1 |
5 files changed, 93 insertions, 0 deletions
diff --git a/ci-builds.nix b/ci-builds.nix index 1f99afad91fc..0c81ca31d941 100644 --- a/ci-builds.nix +++ b/ci-builds.nix @@ -62,6 +62,7 @@ in lib.fix(self: { nix.yants.tests tools.cheddar tools.nsfv-setup + depot.nix.getBins.tests ]; # User-specific build targets diff --git a/nix/getBins/OWNERS b/nix/getBins/OWNERS new file mode 100644 index 000000000000..a742d0d22bf6 --- /dev/null +++ b/nix/getBins/OWNERS @@ -0,0 +1,3 @@ +inherited: true +owners: + - Profpatsch diff --git a/nix/getBins/default.nix b/nix/getBins/default.nix new file mode 100644 index 000000000000..b0c1135fc87a --- /dev/null +++ b/nix/getBins/default.nix @@ -0,0 +1,48 @@ +{ lib, pkgs, depot, ... }: + +# Takes a derivation and a list of binary names +# and returns an attribute set of `name -> path`. +# The list can also contain renames in the form of +# `{ use, as }`, which goes `as -> usePath`. +# +# It is usually used to construct an attrset `bins` +# containing all the binaries required in a file, +# similar to a simple import system. +# +# Example: +# +# bins = getBins pkgs.hello [ "hello" ] +# // getBins pkgs.coreutils [ "printf" "ln" "echo" ] +# // getBins pkgs.execline +# [ { use = "if"; as = "execlineIf" } ] +# // getBins pkgs.s6-portable-utils +# [ { use = "s6-test"; as = "test" } +# { use = "s6-cat"; as = "cat" } +# ]; +# +# provides +# bins.{hello,printf,ln,echo,execlineIf,test,cat} +# + +let + getBins = drv: xs: + let f = x: + # TODO(Profpatsch): typecheck + let x' = if builtins.isString x then { use = x; as = x; } else x; + in { + name = x'.as; + value = "${lib.getBin drv}/bin/${x'.use}"; + }; + in builtins.listToAttrs (builtins.map f xs); + + + tests = import ./tests.nix { + inherit getBins; + inherit (pkgs) writeScriptBin; + inherit (depot.nix.runTestsuite) assertEq it runTestsuite; + }; + +in { + __functor = _: getBins; + inherit tests; +} diff --git a/nix/getBins/tests.nix b/nix/getBins/tests.nix new file mode 100644 index 000000000000..ff81deb5f1ec --- /dev/null +++ b/nix/getBins/tests.nix @@ -0,0 +1,40 @@ +{ writeScriptBin, assertEq, it, runTestsuite, getBins }: + +let + drv = writeScriptBin "hello" "it’s me"; + drv2 = writeScriptBin "goodbye" "tschau"; + + bins = getBins drv [ + "hello" + { use = "hello"; as = "also-hello"; } + ] + // getBins drv2 [ "goodbye" ] + ; + + simple = it "path is equal to the executable name" [ + (assertEq "path" + bins.hello + "${drv}/bin/hello") + (assertEq "content" + (builtins.readFile bins.hello) + "it’s me") + ]; + + useAs = it "use/as can be used to rename attributes" [ + (assertEq "path" + bins.also-hello + "${drv}/bin/hello") + ]; + + secondDrv = it "by merging attrsets you can build up bins" [ + (assertEq "path" + bins.goodbye + "${drv2}/bin/goodbye") + ]; + +in + runTestsuite "getBins" [ + simple + useAs + secondDrv + ] diff --git a/third_party/default.nix b/third_party/default.nix index c13b8f1b3157..ab45ec002c86 100644 --- a/third_party/default.nix +++ b/third_party/default.nix @@ -132,6 +132,7 @@ let tree which writeScript + writeScriptBin writeShellScript writeShellScriptBin writeText |