225: lib: only readDir if path exists with safeReadDir r=nrdxp a=Pacman99

After doing this for the second time, I realized it might be good to make a lib function for it and do it across lib.
Create a function called `safeReadDir` that only uses `builtins.readDir` if the path exists. With `optionalAttrs` any function that relies on the output won't fail since they still get an empty attrset.
Then replace all uses of `readDir` with the safe version.

Co-authored-by: Pacman99 <pachum99@gmail.com>
This commit is contained in:
bors[bot] 2021-04-01 20:08:55 +00:00 committed by GitHub
commit 01b0555117
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 16 additions and 7 deletions

View file

@ -40,4 +40,6 @@ rec {
lib.isDerivation v && !meta.broken && builtins.elem system platforms);
in
lib.filterAttrs filter packages;
safeReadDir = path: lib.optionalAttrs (builtins.pathExists path) (builtins.readDir path);
}

View file

@ -17,7 +17,7 @@ lib.makeExtensible (final:
lists = callLibs ./lists.nix;
strings = callLibs ./strings.nix;
inherit (attrs) mapFilterAttrs genAttrs'
inherit (attrs) mapFilterAttrs genAttrs' safeReadDir
pathsToImportedAttrs concatAttrs filterPackages;
inherit (lists) pathsIn;
inherit (strings) rgxToString;

View file

@ -1,4 +1,4 @@
{ lib, ... }:
{ lib, dev, ... }:
let mkProfileAttrs =
/**
@ -16,7 +16,7 @@ let mkProfileAttrs =
let
imports =
let
files = builtins.readDir dir;
files = dev.safeReadDir dir;
p = n: v:
v == "directory"

View file

@ -9,4 +9,4 @@ dev.mapFilterAttrs
let name = lib.removeSuffix ".nix" n; in lib.nameValuePair (name) (_import name)
else
lib.nameValuePair ("") (null))
(builtins.readDir dir)
(dev.safeReadDir dir)

View file

@ -1,9 +1,8 @@
{ lib, ... }:
{ lib, dev, ... }:
{
pathsIn = dir:
let
fullPath = name: "${toString dir}/${name}";
in
map fullPath (lib.attrNames (lib.optionalAttrs
(builtins.pathExists dir) (builtins.readDir dir)));
map fullPath (lib.attrNames (dev.safeReadDir dir));
}

View file

@ -69,6 +69,14 @@ lib.runTests {
(rgxToString "hat" "foohatbar" == "hat")
];
testSafeReadDir = {
expr = safeReadDir "${self}/tests/profiles" // safeReadDir "${self}/nonexistentdir";
expected = {
foo = "directory";
t = "directory";
};
};
testSuites =
let
profiles = os.mkProfileAttrs (toString ./profiles);