From ab03ddc8f441a11644a4ce3d29eb290fa02b11e3 Mon Sep 17 00:00:00 2001 From: Profpatsch Date: Mon, 14 Mar 2022 10:14:18 +0100 Subject: [PATCH 1/2] lib.generators: add toINIWithGlobalSection As discussed in https://github.com/NixOS/nixpkgs/pull/118925#issuecomment-821112723, this is the best way of adding global sections to `toINI` without employing heuristics (i.e. checking whether something is an attrset). --- lib/generators.nix | 45 ++++++++++++++++++++++++++++++++++ lib/tests/misc.nix | 60 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 105 insertions(+) diff --git a/lib/generators.nix b/lib/generators.nix index 79ae9055ce3d..c421573a727b 100644 --- a/lib/generators.nix +++ b/lib/generators.nix @@ -130,6 +130,51 @@ rec { # map input to ini sections mapAttrsToStringsSep "\n" mkSection attrsOfAttrs; + /* Generate an INI-style config file from an attrset + * specifying the global section (no header), and an + * attrset of sections to an attrset of key-value pairs. + * + * generators.toINIWithGlobalSection {} { + * globalSection = { + * someGlobalKey = "hi"; + * }; + * sections = { + * foo = { hi = "${pkgs.hello}"; ciao = "bar"; }; + * baz = { "also, integers" = 42; }; + * } + * + *> someGlobalKey=hi + *> + *> [baz] + *> also, integers=42 + *> + *> [foo] + *> ciao=bar + *> hi=/nix/store/y93qql1p5ggfnaqjjqhxcw0vqw95rlz0-hello-2.10 + * + * The mk* configuration attributes can generically change + * the way sections and key-value strings are generated. + * + * For more examples see the test cases in ./tests.nix. + * + * If you don’t need a global section, you can also use + * `generators.toINI` directly, which only takes + * the part in `sections`. + */ + toINIWithGlobalSection = { + # apply transformations (e.g. escapes) to section names + mkSectionName ? (name: libStr.escape [ "[" "]" ] name), + # format a setting line from key and value + mkKeyValue ? mkKeyValueDefault {} "=", + # allow lists as values for duplicate keys + listsAsDuplicateKeys ? false + }: { globalSection, sections }: + ( if globalSection == {} + then "" + else (toKeyValue { inherit mkKeyValue listsAsDuplicateKeys; } globalSection) + + "\n") + + (toINI { inherit mkSectionName mkKeyValue listsAsDuplicateKeys; } sections); + /* Generate a git-config file from an attrset. * * It has two major differences from the regular INI format: diff --git a/lib/tests/misc.nix b/lib/tests/misc.nix index 5fa95828df69..6687b9bebaee 100644 --- a/lib/tests/misc.nix +++ b/lib/tests/misc.nix @@ -471,6 +471,66 @@ runTests { ''; }; + testToINIWithGlobalSectionEmpty = { + expr = generators.toINIWithGlobalSection {} { + globalSection = { + }; + sections = { + }; + }; + expected = '' + ''; + }; + + testToINIWithGlobalSectionGlobalEmptyIsTheSameAsToINI = + let + sections = { + "section 1" = { + attribute1 = 5; + x = "Me-se JarJar Binx"; + }; + "foo" = { + "he\\h=he" = "this is okay"; + }; + }; + in { + expr = + generators.toINIWithGlobalSection {} { + globalSection = {}; + sections = sections; + }; + expected = generators.toINI {} sections; + }; + + testToINIWithGlobalSectionFull = { + expr = generators.toINIWithGlobalSection {} { + globalSection = { + foo = "bar"; + test = false; + }; + sections = { + "section 1" = { + attribute1 = 5; + x = "Me-se JarJar Binx"; + }; + "foo" = { + "he\\h=he" = "this is okay"; + }; + }; + }; + expected = '' + foo=bar + test=false + + [foo] + he\h\=he=this is okay + + [section 1] + attribute1=5 + x=Me-se JarJar Binx + ''; + }; + /* right now only invocation check */ testToJSONSimple = let val = { From 626ecc7bd72668e8624bfc3eac3635a1a31d1bf3 Mon Sep 17 00:00:00 2001 From: Profpatsch Date: Mon, 14 Mar 2022 10:30:20 +0100 Subject: [PATCH 2/2] lib.generators: fix references to test file --- lib/generators.nix | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/generators.nix b/lib/generators.nix index c421573a727b..3bc0fee332ae 100644 --- a/lib/generators.nix +++ b/lib/generators.nix @@ -10,7 +10,7 @@ * are mostly generators themselves, called with * their respective default values; they can be reused. * - * Tests can be found in ./tests.nix + * Tests can be found in ./tests/misc.nix * Documentation in the manual, #sec-generators */ { lib }: @@ -108,7 +108,7 @@ rec { * The mk* configuration attributes can generically change * the way sections and key-value strings are generated. * - * For more examples see the test cases in ./tests.nix. + * For more examples see the test cases in ./tests/misc.nix. */ toINI = { # apply transformations (e.g. escapes) to section names @@ -155,7 +155,7 @@ rec { * The mk* configuration attributes can generically change * the way sections and key-value strings are generated. * - * For more examples see the test cases in ./tests.nix. + * For more examples see the test cases in ./tests/misc.nix. * * If you don’t need a global section, you can also use * `generators.toINI` directly, which only takes