# to run these tests: # nix-instantiate --eval --strict nixpkgs/lib/tests/misc.nix # if the resulting list is empty, all tests passed with import ../default.nix; let testSanitizeDerivationName = { name, expected }: let drv = derivation { name = strings.sanitizeDerivationName name; builder = "x"; system = "x"; }; in { # Evaluate the derivation so an invalid name would be caught expr = builtins.seq drv.drvPath drv.name; inherit expected; }; in runTests { # TRIVIAL testId = { expr = id 1; expected = 1; }; testConst = { expr = const 2 3; expected = 2; }; testPipe = { expr = pipe 2 [ (x: x + 2) # 2 + 2 = 4 (x: x * 2) # 4 * 2 = 8 ]; expected = 8; }; testPipeEmpty = { expr = pipe 2 []; expected = 2; }; testPipeStrings = { expr = pipe [ 3 4 ] [ (map toString) (map (s: s + "\n")) concatStrings ]; expected = '' 3 4 ''; }; /* testOr = { expr = or true false; expected = true; }; */ testAnd = { expr = and true false; expected = false; }; testFix = { expr = fix (x: {a = if x ? a then "a" else "b";}); expected = {a = "a";}; }; testComposeExtensions = { expr = let obj = makeExtensible (self: { foo = self.bar; }); f = self: super: { bar = false; baz = true; }; g = self: super: { bar = super.baz or false; }; f_o_g = composeExtensions f g; composed = obj.extend f_o_g; in composed.foo; expected = true; }; testComposeManyExtensions0 = { expr = let obj = makeExtensible (self: { foo = true; }); emptyComposition = composeManyExtensions []; composed = obj.extend emptyComposition; in composed.foo; expected = true; }; testComposeManyExtensions = let f = self: super: { bar = false; baz = true; }; g = self: super: { bar = super.baz or false; }; h = self: super: { qux = super.bar or false; }; obj = makeExtensible (self: { foo = self.qux; }); in { expr = let composition = composeManyExtensions [f g h]; composed = obj.extend composition; in composed.foo; expected = (obj.extend (composeExtensions f (composeExtensions g h))).foo; }; testBitAnd = { expr = (bitAnd 3 10); expected = 2; }; testBitOr = { expr = (bitOr 3 10); expected = 11; }; testBitXor = { expr = (bitXor 3 10); expected = 9; }; testToHexString = { expr = toHexString 250; expected = "FA"; }; testToBaseDigits = { expr = toBaseDigits 2 6; expected = [ 1 1 0 ]; }; testFunctionArgsFunctor = { expr = functionArgs { __functor = self: { a, b }: null; }; expected = { a = false; b = false; }; }; testFunctionArgsSetFunctionArgs = { expr = functionArgs (setFunctionArgs (args: args.x) { x = false; }); expected = { x = false; }; }; # STRINGS testConcatMapStrings = { expr = concatMapStrings (x: x + ";") ["a" "b" "c"]; expected = "a;b;c;"; }; testConcatStringsSep = { expr = concatStringsSep "," ["a" "b" "c"]; expected = "a,b,c"; }; testSplitStringsSimple = { expr = strings.splitString "." "a.b.c.d"; expected = [ "a" "b" "c" "d" ]; }; testSplitStringsEmpty = { expr = strings.splitString "." "a..b"; expected = [ "a" "" "b" ]; }; testSplitStringsOne = { expr = strings.splitString ":" "a.b"; expected = [ "a.b" ]; }; testSplitStringsNone = { expr = strings.splitString "." ""; expected = [ "" ]; }; testSplitStringsFirstEmpty = { expr = strings.splitString "/" "/a/b/c"; expected = [ "" "a" "b" "c" ]; }; testSplitStringsLastEmpty = { expr = strings.splitString ":" "2001:db8:0:0042::8a2e:370:"; expected = [ "2001" "db8" "0" "0042" "" "8a2e" "370" "" ]; }; testSplitStringsRegex = { expr = strings.splitString "\\[{}]()^$?*+|." "A\\[{}]()^$?*+|.B"; expected = [ "A" "B" ]; }; testSplitStringsDerivation = { expr = take 3 (strings.splitString "/" (derivation { name = "name"; builder = "builder"; system = "system"; })); expected = ["" "nix" "store"]; }; testSplitVersionSingle = { expr = versions.splitVersion "1"; expected = [ "1" ]; }; testSplitVersionDouble = { expr = versions.splitVersion "1.2"; expected = [ "1" "2" ]; }; testSplitVersionTriple = { expr = versions.splitVersion "1.2.3"; expected = [ "1" "2" "3" ]; }; testIsStorePath = { expr = let goodPath = "${builtins.storeDir}/d945ibfx9x185xf04b890y4f9g3cbb63-python-2.7.11"; in { storePath = isStorePath goodPath; storePathDerivation = isStorePath (import ../.. { system = "x86_64-linux"; }).hello; storePathAppendix = isStorePath "${goodPath}/bin/python"; nonAbsolute = isStorePath (concatStrings (tail (stringToCharacters goodPath))); asPath = isStorePath (/. + goodPath); otherPath = isStorePath "/something/else"; otherVals = { attrset = isStorePath {}; list = isStorePath []; int = isStorePath 42; }; }; expected = { storePath = true; storePathDerivation = true; storePathAppendix = false; nonAbsolute = false; asPath = true; otherPath = false; otherVals = { attrset = false; list = false; int = false; }; }; }; testEscapeXML = { expr = escapeXML ''"test" 'test' < & >''; expected = ""test" 'test' < & >"; }; # LISTS testFilter = { expr = filter (x: x != "a") ["a" "b" "c" "a"]; expected = ["b" "c"]; }; testFold = let f = op: fold: fold op 0 (range 0 100); # fold with associative operator assoc = f builtins.add; # fold with non-associative operator nonAssoc = f builtins.sub; in { expr = { assocRight = assoc foldr; # right fold with assoc operator is same as left fold assocRightIsLeft = assoc foldr == assoc foldl; nonAssocRight = nonAssoc foldr; nonAssocLeft = nonAssoc foldl; # with non-assoc operator the fold results are not the same nonAssocRightIsNotLeft = nonAssoc foldl != nonAssoc foldr; # fold is an alias for foldr foldIsRight = nonAssoc fold == nonAssoc foldr; }; expected = { assocRight = 5050; assocRightIsLeft = true; nonAssocRight = 50; nonAssocLeft = (-5050); nonAssocRightIsNotLeft = true; foldIsRight = true; }; }; testTake = testAllTrue [ ([] == (take 0 [ 1 2 3 ])) ([1] == (take 1 [ 1 2 3 ])) ([ 1 2 ] == (take 2 [ 1 2 3 ])) ([ 1 2 3 ] == (take 3 [ 1 2 3 ])) ([ 1 2 3 ] == (take 4 [ 1 2 3 ])) ]; testFoldAttrs = { expr = foldAttrs (n: a: [n] ++ a) [] [ { a = 2; b = 7; } { a = 3; c = 8; } ]; expected = { a = [ 2 3 ]; b = [7]; c = [8];}; }; testSort = { expr = sort builtins.lessThan [ 40 2 30 42 ]; expected = [2 30 40 42]; }; testToIntShouldConvertStringToInt = { expr = toInt "27"; expected = 27; }; testToIntShouldThrowErrorIfItCouldNotConvertToInt = { expr = builtins.tryEval (toInt "\"foo\""); expected = { success = false; value = false; }; }; testHasAttrByPathTrue = { expr = hasAttrByPath ["a" "b"] { a = { b = "yey"; }; }; expected = true; }; testHasAttrByPathFalse = { expr = hasAttrByPath ["a" "b"] { a = { c = "yey"; }; }; expected = false; }; # ATTRSETS # code from the example testRecursiveUpdateUntil = { expr = recursiveUpdateUntil (path: l: r: path == ["foo"]) { # first attribute set foo.bar = 1; foo.baz = 2; bar = 3; } { #second attribute set foo.bar = 1; foo.quz = 2; baz = 4; }; expected = { foo.bar = 1; # 'foo.*' from the second set foo.quz = 2; # bar = 3; # 'bar' from the first set baz = 4; # 'baz' from the second set }; }; testOverrideExistingEmpty = { expr = overrideExisting {} { a = 1; }; expected = {}; }; testOverrideExistingDisjoint = { expr = overrideExisting { b = 2; } { a = 1; }; expected = { b = 2; }; }; testOverrideExistingOverride = { expr = overrideExisting { a = 3; b = 2; } { a = 1; }; expected = { a = 1; b = 2; }; }; # GENERATORS # these tests assume attributes are converted to lists # in alphabetical order testMkKeyValueDefault = { expr = generators.mkKeyValueDefault {} ":" "f:oo" "bar"; expected = ''f\:oo:bar''; }; testMkValueString = { expr = let vals = { int = 42; string = ''fo"o''; bool = true; bool2 = false; null = null; # float = 42.23; # floats are strange }; in mapAttrs (const (generators.mkValueStringDefault {})) vals; expected = { int = "42"; string = ''fo"o''; bool = "true"; bool2 = "false"; null = "null"; # float = "42.23" true false [ "bar" ] ]''; }; }; testToKeyValue = { expr = generators.toKeyValue {} { key = "value"; "other=key" = "baz"; }; expected = '' key=value other\=key=baz ''; }; testToINIEmpty = { expr = generators.toINI {} {}; expected = ""; }; testToINIEmptySection = { expr = generators.toINI {} { foo = {}; bar = {}; }; expected = '' [bar] [foo] ''; }; testToINIDuplicateKeys = { expr = generators.toINI { listsAsDuplicateKeys = true; } { foo.bar = true; baz.qux = [ 1 false ]; }; expected = '' [baz] qux=1 qux=false [foo] bar=true ''; }; testToINIDefaultEscapes = { expr = generators.toINI {} { "no [ and ] allowed unescaped" = { "and also no = in keys" = 42; }; }; expected = '' [no \[ and \] allowed unescaped] and also no \= in keys=42 ''; }; testToINIDefaultFull = { expr = generators.toINI {} { "section 1" = { attribute1 = 5; x = "Me-se JarJar Binx"; # booleans are converted verbatim by default boolean = false; }; "foo[]" = { "he\\h=he" = "this is okay"; }; }; expected = '' [foo\[\]] he\h\=he=this is okay [section 1] attribute1=5 boolean=false x=Me-se JarJar Binx ''; }; /* right now only invocation check */ testToJSONSimple = let val = { foobar = [ "baz" 1 2 3 ]; }; in { expr = generators.toJSON {} val; # trivial implementation expected = builtins.toJSON val; }; /* right now only invocation check */ testToYAMLSimple = let val = { list = [ { one = 1; } { two = 2; } ]; all = 42; }; in { expr = generators.toYAML {} val; # trivial implementation expected = builtins.toJSON val; }; testToPretty = let deriv = derivation { name = "test"; builder = "/bin/sh"; system = "aarch64-linux"; }; in { expr = mapAttrs (const (generators.toPretty { multiline = false; })) rec { int = 42; float = 0.1337; bool = true; emptystring = ""; string = ''fno"rd''; newlinestring = "\n"; path = /. + "/foo"; null_ = null; function = x: x; functionArgs = { arg ? 4, foo }: arg; list = [ 3 4 function [ false ] ]; emptylist = []; attrs = { foo = null; "foo bar" = "baz"; }; emptyattrs = {}; drv = deriv; }; expected = rec { int = "42"; float = "~0.133700"; bool = "true"; emptystring = ''""''; string = ''"fno\"rd"''; newlinestring = "\"\\n\""; path = "/foo"; null_ = "null"; function = ""; functionArgs = ""; list = "[ 3 4 ${function} [ false ] ]"; emptylist = "[ ]"; attrs = "{ foo = null; \"foo bar\" = \"baz\"; }"; emptyattrs = "{ }"; drv = ""; }; }; testToPrettyLimit = let a.b = 1; a.c = a; in { expr = generators.toPretty { } (generators.withRecursion { throwOnDepthLimit = false; depthLimit = 2; } a); expected = "{\n b = 1;\n c = {\n b = \"\";\n c = {\n b = \"\";\n c = \"\";\n };\n };\n}"; }; testToPrettyLimitThrow = let a.b = 1; a.c = a; in { expr = (builtins.tryEval (generators.toPretty { } (generators.withRecursion { depthLimit = 2; } a))).success; expected = false; }; testToPrettyMultiline = { expr = mapAttrs (const (generators.toPretty { })) rec { list = [ 3 4 [ false ] ]; attrs = { foo = null; bar.foo = "baz"; }; newlinestring = "\n"; multilinestring = '' hello there test ''; multilinestring' = '' hello there test''; }; expected = rec { list = '' [ 3 4 [ false ] ]''; attrs = '' { bar = { foo = "baz"; }; foo = null; }''; newlinestring = "''\n \n''"; multilinestring = '' ''' hello there test '''''; multilinestring' = '' ''' hello there test'''''; }; }; testToPrettyAllowPrettyValues = { expr = generators.toPretty { allowPrettyValues = true; } { __pretty = v: "«" + v + "»"; val = "foo"; }; expected = "«foo»"; }; # CLI testToGNUCommandLine = { expr = cli.toGNUCommandLine {} { data = builtins.toJSON { id = 0; }; X = "PUT"; retry = 3; retry-delay = null; url = [ "https://example.com/foo" "https://example.com/bar" ]; silent = false; verbose = true; }; expected = [ "-X" "PUT" "--data" "{\"id\":0}" "--retry" "3" "--url" "https://example.com/foo" "--url" "https://example.com/bar" "--verbose" ]; }; testToGNUCommandLineShell = { expr = cli.toGNUCommandLineShell {} { data = builtins.toJSON { id = 0; }; X = "PUT"; retry = 3; retry-delay = null; url = [ "https://example.com/foo" "https://example.com/bar" ]; silent = false; verbose = true; }; expected = "'-X' 'PUT' '--data' '{\"id\":0}' '--retry' '3' '--url' 'https://example.com/foo' '--url' 'https://example.com/bar' '--verbose'"; }; testSanitizeDerivationNameLeadingDots = testSanitizeDerivationName { name = "..foo"; expected = "foo"; }; testSanitizeDerivationNameAscii = testSanitizeDerivationName { name = " !\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~"; expected = "-+--.-0123456789-=-?-ABCDEFGHIJKLMNOPQRSTUVWXYZ-_-abcdefghijklmnopqrstuvwxyz-"; }; testSanitizeDerivationNameTooLong = testSanitizeDerivationName { name = "This string is loooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong"; expected = "loooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong"; }; testSanitizeDerivationNameTooLongWithInvalid = testSanitizeDerivationName { name = "Hello there aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa &&&&&&&&"; expected = "there-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-"; }; testSanitizeDerivationNameEmpty = testSanitizeDerivationName { name = ""; expected = "unknown"; }; testFreeformOptions = { expr = let submodule = { lib, ... }: { freeformType = lib.types.attrsOf (lib.types.submodule { options.bar = lib.mkOption {}; }); options.bar = lib.mkOption {}; }; module = { lib, ... }: { options.foo = lib.mkOption { type = lib.types.submodule submodule; }; }; options = (evalModules { modules = [ module ]; }).options; locs = filter (o: ! o.internal) (optionAttrSetToDocList options); in map (o: o.loc) locs; expected = [ [ "foo" ] [ "foo" "" "bar" ] [ "foo" "bar" ] ]; }; testCartesianProductOfEmptySet = { expr = cartesianProductOfSets {}; expected = [ {} ]; }; testCartesianProductOfOneSet = { expr = cartesianProductOfSets { a = [ 1 2 3 ]; }; expected = [ { a = 1; } { a = 2; } { a = 3; } ]; }; testCartesianProductOfTwoSets = { expr = cartesianProductOfSets { a = [ 1 ]; b = [ 10 20 ]; }; expected = [ { a = 1; b = 10; } { a = 1; b = 20; } ]; }; testCartesianProductOfTwoSetsWithOneEmpty = { expr = cartesianProductOfSets { a = [ ]; b = [ 10 20 ]; }; expected = [ ]; }; testCartesianProductOfThreeSets = { expr = cartesianProductOfSets { a = [ 1 2 3 ]; b = [ 10 20 30 ]; c = [ 100 200 300 ]; }; expected = [ { a = 1; b = 10; c = 100; } { a = 1; b = 10; c = 200; } { a = 1; b = 10; c = 300; } { a = 1; b = 20; c = 100; } { a = 1; b = 20; c = 200; } { a = 1; b = 20; c = 300; } { a = 1; b = 30; c = 100; } { a = 1; b = 30; c = 200; } { a = 1; b = 30; c = 300; } { a = 2; b = 10; c = 100; } { a = 2; b = 10; c = 200; } { a = 2; b = 10; c = 300; } { a = 2; b = 20; c = 100; } { a = 2; b = 20; c = 200; } { a = 2; b = 20; c = 300; } { a = 2; b = 30; c = 100; } { a = 2; b = 30; c = 200; } { a = 2; b = 30; c = 300; } { a = 3; b = 10; c = 100; } { a = 3; b = 10; c = 200; } { a = 3; b = 10; c = 300; } { a = 3; b = 20; c = 100; } { a = 3; b = 20; c = 200; } { a = 3; b = 20; c = 300; } { a = 3; b = 30; c = 100; } { a = 3; b = 30; c = 200; } { a = 3; b = 30; c = 300; } ]; }; # The example from the showAttrPath documentation testShowAttrPathExample = { expr = showAttrPath [ "foo" "10" "bar" ]; expected = "foo.\"10\".bar"; }; testShowAttrPathEmpty = { expr = showAttrPath []; expected = ""; }; testShowAttrPathVarious = { expr = showAttrPath [ "." "foo" "2" "a2-b" "_bc'de" ]; expected = ''".".foo."2".a2-b._bc'de''; }; testGroupBy = { expr = groupBy (n: toString (mod n 5)) (range 0 16); expected = { "0" = [ 0 5 10 15 ]; "1" = [ 1 6 11 16 ]; "2" = [ 2 7 12 ]; "3" = [ 3 8 13 ]; "4" = [ 4 9 14 ]; }; }; testGroupBy' = { expr = groupBy' builtins.add 0 (x: boolToString (x > 2)) [ 5 1 2 3 4 ]; expected = { false = 3; true = 12; }; }; # The example from the updateManyAttrsByPath documentation testUpdateManyAttrsByPathExample = { expr = updateManyAttrsByPath [ { path = [ "a" "b" ]; update = old: { d = old.c; }; } { path = [ "a" "b" "c" ]; update = old: old + 1; } { path = [ "x" "y" ]; update = old: "xy"; } ] { a.b.c = 0; }; expected = { a = { b = { d = 1; }; }; x = { y = "xy"; }; }; }; # If there are no updates, the value is passed through testUpdateManyAttrsByPathNone = { expr = updateManyAttrsByPath [] "something"; expected = "something"; }; # A single update to the root path is just like applying the function directly testUpdateManyAttrsByPathSingleIncrement = { expr = updateManyAttrsByPath [ { path = [ ]; update = old: old + 1; } ] 0; expected = 1; }; # Multiple updates can be applied are done in order testUpdateManyAttrsByPathMultipleIncrements = { expr = updateManyAttrsByPath [ { path = [ ]; update = old: old + "a"; } { path = [ ]; update = old: old + "b"; } { path = [ ]; update = old: old + "c"; } ] ""; expected = "abc"; }; # If an update doesn't use the value, all previous updates are not evaluated testUpdateManyAttrsByPathLazy = { expr = updateManyAttrsByPath [ { path = [ ]; update = old: old + throw "nope"; } { path = [ ]; update = old: "untainted"; } ] (throw "start"); expected = "untainted"; }; # Deeply nested attributes can be updated without affecting others testUpdateManyAttrsByPathDeep = { expr = updateManyAttrsByPath [ { path = [ "a" "b" "c" ]; update = old: old + 1; } ] { a.b.c = 0; a.b.z = 0; a.y.z = 0; x.y.z = 0; }; expected = { a.b.c = 1; a.b.z = 0; a.y.z = 0; x.y.z = 0; }; }; # Nested attributes are updated first testUpdateManyAttrsByPathNestedBeforehand = { expr = updateManyAttrsByPath [ { path = [ "a" ]; update = old: old // { x = old.b; }; } { path = [ "a" "b" ]; update = old: old + 1; } ] { a.b = 0; }; expected = { a.b = 1; a.x = 1; }; }; }