gador/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

lib.modules: Add hint when using config in imports (#430204)

Browse Source
This commit is contained in:
Robert Hensing
2025-08-04 10:11:49 +02:00
committed by GitHub
parent 37f4290903 5620fc678e
commit d7d16d6bf0
2 changed files with 43 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
lib/modules.nix
View File

@@ -254,11 +254,11 @@ let
inherit
lib
options
config
specialArgs
;
_class = class;
_prefix = prefix;
config = addErrorContext "if you get an infinite recursion here, you probably reference `config` in `imports`. If you are trying to achieve a conditional import behavior dependent on `config`, consider importing unconditionally, and using `mkEnableOption` and `mkIf` to control its effect." config;
}
// specialArgs
);
@@ -651,7 +651,13 @@ let
# evaluation of the option.
context = name: ''while evaluating the module argument `${name}' in "${key}":'';
extraArgs = mapAttrs (
name: _: addErrorContext (context name) (args.${name} or config._module.args.${name})
name: _:
addErrorContext (context name) (
args.${name} or (addErrorContext
"noting that argument `${name}` is not externally provided, so querying `_module.args` instead, requiring `config`"
config._module.args.${name}
)
)
) (functionArgs f);
# Note: we append in the opposite order such that we can add an error

38
lib/tests/modules.sh
View File

@@ -82,6 +82,30 @@ checkConfigOutput() {
fi
}
invertIfUnset() {
gate="$1"
shift
if [[ -n "${!gate:-}" ]]; then
"$@"
else
! "$@"
fi
}
globalErrorLogCheck() {
invertIfUnset "REQUIRE_INFINITE_RECURSION_HINT" \
grep -i 'if you get an infinite recursion here' \
<<<"$err" >/dev/null \
|| {
if [[ -n "${REQUIRE_INFINITE_RECURSION_HINT:-}" ]]; then
echo "Unexpected infinite recursion hint"
else
echo "Expected infinite recursion hint, but none found"
fi
return 1
}
}
checkConfigError() {
local errorContains=$1
local err=""
@@ -94,6 +118,14 @@ checkConfigError() {
logFailure
logEndFailure
else
if ! globalErrorLogCheck "$err"; then
logStartFailure
echo "LOG:"
reportFailure "$@"
echo "GLOBAL ERROR LOG CHECK FAILED"
logFailure
logEndFailure
fi
if echo "$err" | grep -zP --silent "$errorContains" ; then
((++pass))
else
@@ -283,8 +315,8 @@ checkConfigOutput '^true$' "$@" ./define-_module-args-custom.nix
# Check that using _module.args on imports cause infinite recursions, with
# the proper error context.
set -- "$@" ./define-_module-args-custom.nix ./import-custom-arg.nix
checkConfigError 'while evaluating the module argument .*custom.* in .*import-custom-arg.nix.*:' "$@"
checkConfigError 'infinite recursion encountered' "$@"
REQUIRE_INFINITE_RECURSION_HINT=1 checkConfigError 'while evaluating the module argument .*custom.* in .*import-custom-arg.nix.*:' "$@"
REQUIRE_INFINITE_RECURSION_HINT=1 checkConfigError 'infinite recursion encountered' "$@"
# Check _module.check.
set -- config.enable ./declare-enable.nix ./define-enable.nix ./define-attrsOfSub-foo.nix
@@ -488,7 +520,7 @@ checkConfigOutput '^"bar"$' config.nest.bar ./freeform-attrsOf.nix ./freeform-ne
checkConfigOutput '^null$' config.foo ./freeform-attrsOf.nix ./freeform-str-dep-unstr.nix
checkConfigOutput '^"24"$' config.foo ./freeform-attrsOf.nix ./freeform-str-dep-unstr.nix ./define-value-string.nix
# Check whether an freeform-typed value can depend on a declared option, this can only work with lazyAttrsOf
checkConfigError 'infinite recursion encountered' config.foo ./freeform-attrsOf.nix ./freeform-unstr-dep-str.nix
REQUIRE_INFINITE_RECURSION_HINT=1 checkConfigError 'infinite recursion encountered' config.foo ./freeform-attrsOf.nix ./freeform-unstr-dep-str.nix
checkConfigError 'The option .* was accessed but has no value defined. Try setting the option.' config.foo ./freeform-lazyAttrsOf.nix ./freeform-unstr-dep-str.nix
checkConfigOutput '^"24"$' config.foo ./freeform-lazyAttrsOf.nix ./freeform-unstr-dep-str.nix ./define-value-string.nix
# submodules in freeformTypes should have their locations annotated