lib/tests/modules.sh

   1 #!/usr/bin/env bash
   2
   3 # This script is used to test that the module system is working as expected.
   4 # Executing it runs tests for `lib.modules`, `lib.options` and `lib.types`.
   5 # By default it test the version of nixpkgs which is defined in the NIX_PATH.
   6 #
   7 # Run:
   8 # [nixpkgs]$ lib/tests/modules.sh
   9 # or:
  10 # [nixpkgs]$ nix-build lib/tests/release.nix
  11
  12 set -o errexit -o noclobber -o nounset -o pipefail
  13 shopt -s failglob inherit_errexit
  14
  15 # https://stackoverflow.com/a/246128/6605742
  16 DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )"
  17
  18 cd "$DIR"/modules
  19
  20 pass=0
  21 fail=0
  22
  23 # loc
  24 #   prints the location of the call of to the function that calls it
  25 # loc n
  26 #   prints the location n levels up the call stack
  27 loc() {
  28     local caller depth
  29     depth=1
  30     if [[ $# -gt 0 ]]; then
  31         depth=$1
  32     fi
  33     # ( lineno fnname file ) of the caller
  34     caller=( $(caller $depth) )
  35     echo "${caller[2]}:${caller[0]}"
  36 }
  37
  38 line() {
  39     echo "----------------------------------------"
  40 }
  41 logStartFailure() {
  42     line
  43 }
  44 logEndFailure() {
  45     line
  46     echo
  47 }
  48
  49 logFailure() {
  50     # bold red
  51     printf '\033[1;31mTEST FAILED\033[0m at %s\n' "$(loc 2)"
  52 }
  53
  54 evalConfig() {
  55     local attr=$1
  56     shift
  57     local script="import ./default.nix { modules = [ $* ];}"
  58     nix-instantiate --timeout 1 -E "$script" -A "$attr" --eval-only --show-trace --read-write-mode --json
  59 }
  60
  61 reportFailure() {
  62     local attr=$1
  63     shift
  64     local script="import ./default.nix { modules = [ $* ];}"
  65     echo "$ nix-instantiate -E '$script' -A '$attr' --eval-only --json"
  66     evalConfig "$attr" "$@" || true
  67     ((++fail))
  68 }
  69
  70 checkConfigOutput() {
  71     local outputContains=$1
  72     shift
  73     if evalConfig "$@" 2>/dev/null | grep -E --silent "$outputContains" ; then
  74         ((++pass))
  75     else
  76         logStartFailure
  77         echo "ACTUAL:"
  78         reportFailure "$@"
  79         echo "EXPECTED: result matching '$outputContains'"
  80         logFailure
  81         logEndFailure
  82     fi
  83 }
  84
  85 checkConfigError() {
  86     local errorContains=$1
  87     local err=""
  88     shift
  89     if err="$(evalConfig "$@" 2>&1 >/dev/null)"; then
  90         logStartFailure
  91         echo "ACTUAL: exit code 0, output:"
  92         reportFailure "$@"
  93         echo "EXPECTED: non-zero exit code"
  94         logFailure
  95         logEndFailure
  96     else
  97         if echo "$err" | grep -zP --silent "$errorContains" ; then
  98             ((++pass))
  99         else
 100             logStartFailure
 101             echo "ACTUAL:"
 102             reportFailure "$@"
 103             echo "EXPECTED: error matching '$errorContains'"
 104             logFailure
 105             logEndFailure
 106         fi
 107     fi
 108 }
 109
 110 # Shorthand meta attribute does not duplicate the config
 111 checkConfigOutput '^"one two"$' config.result ./shorthand-meta.nix
 112
 113 checkConfigOutput '^true$' config.result ./test-mergeAttrDefinitionsWithPrio.nix
 114
 115 # Check that a module argument is passed, also when a default is available
 116 # (but not needed)
 117 #
 118 # When the default is needed, we currently fail to do what the users expect, as
 119 # we pass our own argument anyway, even if it *turns out* not to exist.
 120 #
 121 # The reason for this is that we don't know at invocation time what is in the
 122 # _module.args option. That value is only available *after* all modules have been
 123 # invoked.
 124 #
 125 # Hypothetically, Nix could help support this by giving access to the default
 126 # values, through a new built-in function.
 127 # However the default values are allowed to depend on other arguments, so those
 128 # would have to be passed in somehow, making this not just a getter but
 129 # something more complicated.
 130 #
 131 # At that point we have to wonder whether the extra complexity is worth the cost.
 132 # Another - subjective - reason not to support it is that default values
 133 # contradict the notion that an option has a single value, where _module.args
 134 # is the option.
 135 checkConfigOutput '^true$' config.result ./module-argument-default.nix
 136
 137 # gvariant
 138 checkConfigOutput '^true$' config.assertion ./gvariant.nix
 139
 140 checkConfigOutput '"ok"' config.result ./specialArgs-lib.nix
 141
 142 # https://github.com/NixOS/nixpkgs/pull/131205
 143 # We currently throw this error already in `config`, but throwing in `config.wrong1` would be acceptable.
 144 checkConfigError 'It seems as if you.re trying to declare an option by placing it into .config. rather than .options.' config.wrong1 ./error-mkOption-in-config.nix
 145 # We currently throw this error already in `config`, but throwing in `config.nest.wrong2` would be acceptable.
 146 checkConfigError 'It seems as if you.re trying to declare an option by placing it into .config. rather than .options.' config.nest.wrong2 ./error-mkOption-in-config.nix
 147 checkConfigError 'The option .sub.wrong2. does not exist. Definition values:' config.sub ./error-mkOption-in-submodule-config.nix
 148 checkConfigError '.*This can happen if you e.g. declared your options in .types.submodule.' config.sub ./error-mkOption-in-submodule-config.nix
 149 checkConfigError '.*A definition for option .bad. is not of type .non-empty .list of .submodule...\.' config.bad ./error-nonEmptyListOf-submodule.nix
 150
 151 # types.attrTag
 152 checkConfigOutput '^true$' config.okChecks ./types-attrTag.nix
 153 checkConfigError 'A definition for option .intStrings\.syntaxError. is not of type .attribute-tagged union' config.intStrings.syntaxError ./types-attrTag.nix
 154 checkConfigError 'A definition for option .intStrings\.syntaxError2. is not of type .attribute-tagged union' config.intStrings.syntaxError2 ./types-attrTag.nix
 155 checkConfigError 'A definition for option .intStrings\.syntaxError3. is not of type .attribute-tagged union' config.intStrings.syntaxError3 ./types-attrTag.nix
 156 checkConfigError 'A definition for option .intStrings\.syntaxError4. is not of type .attribute-tagged union' config.intStrings.syntaxError4 ./types-attrTag.nix
 157 checkConfigError 'A definition for option .intStrings\.mergeError. is not of type .attribute-tagged union' config.intStrings.mergeError ./types-attrTag.nix
 158 checkConfigError 'A definition for option .intStrings\.badTagError. is not of type .attribute-tagged union' config.intStrings.badTagError ./types-attrTag.nix
 159 checkConfigError 'A definition for option .intStrings\.badTagTypeError\.left. is not of type .signed integer.' config.intStrings.badTagTypeError.left ./types-attrTag.nix
 160 checkConfigError 'A definition for option .nested\.right\.left. is not of type .signed integer.' config.nested.right.left ./types-attrTag.nix
 161 checkConfigError 'In attrTag, each tag value must be an option, but tag int was a bare type, not wrapped in mkOption.' config.opt.int ./types-attrTag-wrong-decl.nix
 162
 163 # types.pathInStore
 164 checkConfigOutput '".*/store/0lz9p8xhf89kb1c1kk6jxrzskaiygnlh-bash-5.2-p15.drv"' config.pathInStore.ok1 ./types.nix
 165 checkConfigOutput '".*/store/0fb3ykw9r5hpayd05sr0cizwadzq1d8q-bash-5.2-p15"' config.pathInStore.ok2 ./types.nix
 166 checkConfigOutput '".*/store/0fb3ykw9r5hpayd05sr0cizwadzq1d8q-bash-5.2-p15/bin/bash"' config.pathInStore.ok3 ./types.nix
 167 checkConfigError 'A definition for option .* is not of type .path in the Nix store.. Definition values:\n\s*- In .*: ""' config.pathInStore.bad1 ./types.nix
 168 checkConfigError 'A definition for option .* is not of type .path in the Nix store.. Definition values:\n\s*- In .*: ".*/store"' config.pathInStore.bad2 ./types.nix
 169 checkConfigError 'A definition for option .* is not of type .path in the Nix store.. Definition values:\n\s*- In .*: ".*/store/"' config.pathInStore.bad3 ./types.nix
 170 checkConfigError 'A definition for option .* is not of type .path in the Nix store.. Definition values:\n\s*- In .*: ".*/store/.links"' config.pathInStore.bad4 ./types.nix
 171 checkConfigError 'A definition for option .* is not of type .path in the Nix store.. Definition values:\n\s*- In .*: "/foo/bar"' config.pathInStore.bad5 ./types.nix
 172
 173 # Check boolean option.
 174 checkConfigOutput '^false$' config.enable ./declare-enable.nix
 175 checkConfigError 'The option .* does not exist. Definition values:\n\s*- In .*: true' config.enable ./define-enable.nix
 176 checkConfigError 'The option .* does not exist. Definition values:\n\s*- In .*' config.enable ./define-enable-throw.nix
 177 checkConfigError 'while evaluating a definition from `.*/define-enable-abort.nix' config.enable ./define-enable-abort.nix
 178 checkConfigError 'while evaluating the error message for definitions for .enable., which is an option that does not exist' config.enable ./define-enable-abort.nix
 179
 180 # Check boolByOr type.
 181 checkConfigOutput '^false$' config.value.falseFalse ./boolByOr.nix
 182 checkConfigOutput '^true$' config.value.trueFalse ./boolByOr.nix
 183 checkConfigOutput '^true$' config.value.falseTrue ./boolByOr.nix
 184 checkConfigOutput '^true$' config.value.trueTrue ./boolByOr.nix
 185
 186 checkConfigOutput '^1$' config.bare-submodule.nested ./declare-bare-submodule.nix ./declare-bare-submodule-nested-option.nix
 187 checkConfigOutput '^2$' config.bare-submodule.deep ./declare-bare-submodule.nix ./declare-bare-submodule-deep-option.nix
 188 checkConfigOutput '^42$' config.bare-submodule.nested ./declare-bare-submodule.nix ./declare-bare-submodule-nested-option.nix ./declare-bare-submodule-deep-option.nix ./define-bare-submodule-values.nix
 189 checkConfigOutput '^420$' config.bare-submodule.deep ./declare-bare-submodule.nix ./declare-bare-submodule-nested-option.nix ./declare-bare-submodule-deep-option.nix ./define-bare-submodule-values.nix
 190 checkConfigOutput '^2$' config.bare-submodule.deep ./declare-bare-submodule.nix ./declare-bare-submodule-deep-option.nix ./define-shorthandOnlyDefinesConfig-true.nix
 191 checkConfigError 'The option .bare-submodule.deep. in .*/declare-bare-submodule-deep-option.nix. is already declared in .*/declare-bare-submodule-deep-option-duplicate.nix' config.bare-submodule.deep ./declare-bare-submodule.nix ./declare-bare-submodule-deep-option.nix  ./declare-bare-submodule-deep-option-duplicate.nix
 192
 193 # Check integer types.
 194 # unsigned
 195 checkConfigOutput '^42$' config.value ./declare-int-unsigned-value.nix ./define-value-int-positive.nix
 196 checkConfigError 'A definition for option .* is not of type.*unsigned integer.*. Definition values:\n\s*- In .*: -23' config.value ./declare-int-unsigned-value.nix ./define-value-int-negative.nix
 197 # positive
 198 checkConfigError 'A definition for option .* is not of type.*positive integer.*. Definition values:\n\s*- In .*: 0' config.value ./declare-int-positive-value.nix ./define-value-int-zero.nix
 199 # between
 200 checkConfigOutput '^42$' config.value ./declare-int-between-value.nix ./define-value-int-positive.nix
 201 checkConfigError 'A definition for option .* is not of type.*between.*-21 and 43.*inclusive.*. Definition values:\n\s*- In .*: -23' config.value ./declare-int-between-value.nix ./define-value-int-negative.nix
 202
 203 # Check either types
 204 # types.either
 205 checkConfigOutput '^42$' config.value ./declare-either.nix ./define-value-int-positive.nix
 206 checkConfigOutput '^"24"$' config.value ./declare-either.nix ./define-value-string.nix
 207 # types.oneOf
 208 checkConfigOutput '^42$' config.value ./declare-oneOf.nix ./define-value-int-positive.nix
 209 checkConfigOutput '^\[\]$' config.value ./declare-oneOf.nix ./define-value-list.nix
 210 checkConfigOutput '^"24"$' config.value ./declare-oneOf.nix ./define-value-string.nix
 211
 212 # Check mkForce without submodules.
 213 set -- config.enable ./declare-enable.nix ./define-enable.nix
 214 checkConfigOutput '^true$' "$@"
 215 checkConfigOutput '^false$' "$@" ./define-force-enable.nix
 216 checkConfigOutput '^false$' "$@" ./define-enable-force.nix
 217
 218 # Check mkForce with option and submodules.
 219 checkConfigError 'attribute .*foo.* .* not found' config.attrsOfSub.foo.enable ./declare-attrsOfSub-any-enable.nix
 220 checkConfigOutput '^false$' config.attrsOfSub.foo.enable ./declare-attrsOfSub-any-enable.nix ./define-attrsOfSub-foo.nix
 221 set -- config.attrsOfSub.foo.enable ./declare-attrsOfSub-any-enable.nix ./define-attrsOfSub-foo-enable.nix
 222 checkConfigOutput '^true$' "$@"
 223 checkConfigOutput '^false$' "$@" ./define-force-attrsOfSub-foo-enable.nix
 224 checkConfigOutput '^false$' "$@" ./define-attrsOfSub-force-foo-enable.nix
 225 checkConfigOutput '^false$' "$@" ./define-attrsOfSub-foo-force-enable.nix
 226 checkConfigOutput '^false$' "$@" ./define-attrsOfSub-foo-enable-force.nix
 227
 228 # Check overriding effect of mkForce on submodule definitions.
 229 checkConfigError 'attribute .*bar.* .* not found' config.attrsOfSub.bar.enable ./declare-attrsOfSub-any-enable.nix ./define-attrsOfSub-foo.nix
 230 checkConfigOutput '^false$' config.attrsOfSub.bar.enable ./declare-attrsOfSub-any-enable.nix ./define-attrsOfSub-foo.nix ./define-attrsOfSub-bar.nix
 231 set -- config.attrsOfSub.bar.enable ./declare-attrsOfSub-any-enable.nix ./define-attrsOfSub-foo.nix ./define-attrsOfSub-bar-enable.nix
 232 checkConfigOutput '^true$' "$@"
 233 checkConfigError 'attribute .*bar.* .* not found' "$@" ./define-force-attrsOfSub-foo-enable.nix
 234 checkConfigError 'attribute .*bar.* .* not found' "$@" ./define-attrsOfSub-force-foo-enable.nix
 235 checkConfigOutput '^true$' "$@" ./define-attrsOfSub-foo-force-enable.nix
 236 checkConfigOutput '^true$' "$@" ./define-attrsOfSub-foo-enable-force.nix
 237
 238 # Check mkIf with submodules.
 239 checkConfigError 'attribute .*foo.* .* not found' config.attrsOfSub.foo.enable ./declare-enable.nix ./declare-attrsOfSub-any-enable.nix
 240 set -- config.attrsOfSub.foo.enable ./declare-enable.nix ./declare-attrsOfSub-any-enable.nix
 241 checkConfigError 'attribute .*foo.* .* not found' "$@" ./define-if-attrsOfSub-foo-enable.nix
 242 checkConfigError 'attribute .*foo.* .* not found' "$@" ./define-attrsOfSub-if-foo-enable.nix
 243 checkConfigError 'attribute .*foo.* .* not found' "$@" ./define-attrsOfSub-foo-if-enable.nix
 244 checkConfigOutput '^false$' "$@" ./define-attrsOfSub-foo-enable-if.nix
 245 checkConfigOutput '^true$' "$@" ./define-enable.nix ./define-if-attrsOfSub-foo-enable.nix
 246 checkConfigOutput '^true$' "$@" ./define-enable.nix ./define-attrsOfSub-if-foo-enable.nix
 247 checkConfigOutput '^true$' "$@" ./define-enable.nix ./define-attrsOfSub-foo-if-enable.nix
 248 checkConfigOutput '^true$' "$@" ./define-enable.nix ./define-attrsOfSub-foo-enable-if.nix
 249
 250 # Check importApply
 251 checkConfigOutput '"abc"' config.value ./importApply.nix
 252 # importApply does not set a key.
 253 # Disabling the function file is not sufficient, because importApply can't reasonably assume that the key is unique.
 254 # e.g. user may call it multiple times with different arguments and expect each of the module to apply.
 255 # While this is excusable for the disabledModules aspect, it is not for the deduplication of modules.
 256 checkConfigOutput '"abc"' config.value ./importApply-disabling.nix
 257
 258 # Check disabledModules with config definitions and option declarations.
 259 set -- config.enable ./define-enable.nix ./declare-enable.nix
 260 checkConfigOutput '^true$' "$@"
 261 checkConfigOutput '^false$' "$@" ./disable-define-enable.nix
 262 checkConfigOutput '^false$' "$@" ./disable-define-enable-string-path.nix
 263 checkConfigError "The option .*enable.* does not exist. Definition values:\n\s*- In .*: true" "$@" ./disable-declare-enable.nix
 264 checkConfigError "attribute .*enable.* in selection path .*config.enable.* not found" "$@" ./disable-define-enable.nix ./disable-declare-enable.nix
 265 checkConfigError "attribute .*enable.* in selection path .*config.enable.* not found" "$@" ./disable-enable-modules.nix
 266
 267 checkConfigOutput '^true$' 'config.positive.enable' ./disable-module-with-key.nix
 268 checkConfigOutput '^false$' 'config.negative.enable' ./disable-module-with-key.nix
 269 checkConfigError 'Module ..*disable-module-bad-key.nix. contains a disabledModules item that is an attribute set, presumably a module, that does not have a .key. attribute. .*' 'config.enable' ./disable-module-bad-key.nix
 270
 271 # Not sure if we want to keep supporting module keys that aren't strings, paths or v?key, but we shouldn't remove support accidentally.
 272 checkConfigOutput '^true$' 'config.positive.enable' ./disable-module-with-toString-key.nix
 273 checkConfigOutput '^false$' 'config.negative.enable' ./disable-module-with-toString-key.nix
 274
 275 # Check _module.args.
 276 set -- config.enable ./declare-enable.nix ./define-enable-with-custom-arg.nix
 277 checkConfigError 'while evaluating the module argument .*custom.* in .*define-enable-with-custom-arg.nix.*:' "$@"
 278 checkConfigOutput '^true$' "$@" ./define-_module-args-custom.nix
 279
 280 # Check that using _module.args on imports cause infinite recursions, with
 281 # the proper error context.
 282 set -- "$@" ./define-_module-args-custom.nix ./import-custom-arg.nix
 283 checkConfigError 'while evaluating the module argument .*custom.* in .*import-custom-arg.nix.*:' "$@"
 284 checkConfigError 'infinite recursion encountered' "$@"
 285
 286 # Check _module.check.
 287 set -- config.enable ./declare-enable.nix ./define-enable.nix ./define-attrsOfSub-foo.nix
 288 checkConfigError 'The option .* does not exist. Definition values:\n\s*- In .*' "$@"
 289 checkConfigOutput '^true$' "$@" ./define-module-check.nix
 290
 291 # Check coerced value.
 292 set --
 293 checkConfigOutput '^"42"$' config.value ./declare-coerced-value.nix
 294 checkConfigOutput '^"24"$' config.value ./declare-coerced-value.nix ./define-value-string.nix
 295 checkConfigError 'A definition for option .* is not.*string or signed integer convertible to it.*. Definition values:\n\s*- In .*: \[ \]' config.value ./declare-coerced-value.nix ./define-value-list.nix
 296
 297 # Check coerced option merging.
 298 checkConfigError 'The option .value. in .*/declare-coerced-value.nix. is already declared in .*/declare-coerced-value-no-default.nix.' config.value ./declare-coerced-value.nix ./declare-coerced-value-no-default.nix
 299
 300 # Check coerced value with unsound coercion
 301 checkConfigOutput '^12$' config.value ./declare-coerced-value-unsound.nix
 302 checkConfigError 'A definition for option .* is not of type .*. Definition values:\n\s*- In .*: "1000"' config.value ./declare-coerced-value-unsound.nix ./define-value-string-bigint.nix
 303 checkConfigError 'toInt: Could not convert .* to int' config.value ./declare-coerced-value-unsound.nix ./define-value-string-arbitrary.nix
 304
 305 # Check mkAliasOptionModule.
 306 checkConfigOutput '^true$' config.enable ./alias-with-priority.nix
 307 checkConfigOutput '^true$' config.enableAlias ./alias-with-priority.nix
 308 checkConfigOutput '^false$' config.enable ./alias-with-priority-can-override.nix
 309 checkConfigOutput '^false$' config.enableAlias ./alias-with-priority-can-override.nix
 310
 311 # Check mkPackageOption
 312 checkConfigOutput '^"hello"$' config.package.pname ./declare-mkPackageOption.nix
 313 checkConfigOutput '^"hello"$' config.namedPackage.pname ./declare-mkPackageOption.nix
 314 checkConfigOutput '^".*Hello.*"$' options.namedPackage.description ./declare-mkPackageOption.nix
 315 checkConfigOutput '^"hello"$' config.pathPackage.pname ./declare-mkPackageOption.nix
 316 checkConfigOutput '^"pkgs\.hello\.override \{ stdenv = pkgs\.clangStdenv; \}"$' options.packageWithExample.example.text ./declare-mkPackageOption.nix
 317 checkConfigOutput '^".*Example extra description\..*"$' options.packageWithExtraDescription.description ./declare-mkPackageOption.nix
 318 checkConfigError 'The option .undefinedPackage. was accessed but has no value defined. Try setting the option.' config.undefinedPackage ./declare-mkPackageOption.nix
 319 checkConfigOutput '^null$' config.nullablePackage ./declare-mkPackageOption.nix
 320 checkConfigOutput '^"null or package"$' options.nullablePackageWithDefault.type.description ./declare-mkPackageOption.nix
 321 checkConfigOutput '^"myPkgs\.hello"$' options.packageWithPkgsText.defaultText.text ./declare-mkPackageOption.nix
 322 checkConfigOutput '^"hello-other"$' options.packageFromOtherSet.default.pname ./declare-mkPackageOption.nix
 323
 324 # submoduleWith
 325
 326 ## specialArgs should work
 327 checkConfigOutput '^"foo"$' config.submodule.foo ./declare-submoduleWith-special.nix
 328
 329 ## shorthandOnlyDefines config behaves as expected
 330 checkConfigOutput '^true$' config.submodule.config ./declare-submoduleWith-shorthand.nix ./define-submoduleWith-shorthand.nix
 331 checkConfigError 'is not of type `boolean' config.submodule.config ./declare-submoduleWith-shorthand.nix ./define-submoduleWith-noshorthand.nix
 332 checkConfigError "In module ..*define-submoduleWith-shorthand.nix., you're trying to define a value of type \`bool'\n\s*rather than an attribute set for the option" config.submodule.config ./declare-submoduleWith-noshorthand.nix ./define-submoduleWith-shorthand.nix
 333 checkConfigOutput '^true$' config.submodule.config ./declare-submoduleWith-noshorthand.nix ./define-submoduleWith-noshorthand.nix
 334
 335 ## submoduleWith should merge all modules in one swoop
 336 checkConfigOutput '^true$' config.submodule.inner ./declare-submoduleWith-modules.nix
 337 checkConfigOutput '^true$' config.submodule.outer ./declare-submoduleWith-modules.nix
 338 # Should also be able to evaluate the type name (which evaluates freeformType,
 339 # which evaluates all the modules defined by the type)
 340 checkConfigOutput '^"submodule"$' options.submodule.type.description ./declare-submoduleWith-modules.nix
 341
 342 ## submodules can be declared using (evalModules {...}).type
 343 checkConfigOutput '^true$' config.submodule.inner ./declare-submodule-via-evalModules.nix
 344 checkConfigOutput '^true$' config.submodule.outer ./declare-submodule-via-evalModules.nix
 345 # Should also be able to evaluate the type name (which evaluates freeformType,
 346 # which evaluates all the modules defined by the type)
 347 checkConfigOutput '^"submodule"$' options.submodule.type.description ./declare-submodule-via-evalModules.nix
 348
 349 ## Paths should be allowed as values and work as expected
 350 checkConfigOutput '^true$' config.submodule.enable ./declare-submoduleWith-path.nix
 351
 352 ## deferredModule
 353 # default module is merged into nodes.foo
 354 checkConfigOutput '"beta"' config.nodes.foo.settingsDict.c ./deferred-module.nix
 355 # errors from the default module are reported with accurate location
 356 checkConfigError 'In `the-file-that-contains-the-bad-config.nix, via option default'\'': "bogus"' config.nodes.foo.bottom ./deferred-module.nix
 357 checkConfigError '.*lib/tests/modules/deferred-module-error.nix, via option deferred [(]:anon-1:anon-1:anon-1[)] does not look like a module.' config.result ./deferred-module-error.nix
 358
 359 # Check the file location information is propagated into submodules
 360 checkConfigOutput the-file.nix config.submodule.internalFiles.0 ./submoduleFiles.nix
 361
 362
 363 # Check that disabledModules works recursively and correctly
 364 checkConfigOutput '^true$' config.enable ./disable-recursive/main.nix
 365 checkConfigOutput '^true$' config.enable ./disable-recursive/{main.nix,disable-foo.nix}
 366 checkConfigOutput '^true$' config.enable ./disable-recursive/{main.nix,disable-bar.nix}
 367 checkConfigError 'The option .* does not exist. Definition values:\n\s*- In .*: true' config.enable ./disable-recursive/{main.nix,disable-foo.nix,disable-bar.nix}
 368
 369 # Check that imports can depend on derivations
 370 checkConfigOutput '^true$' config.enable ./import-from-store.nix
 371
 372 # Check that configs can be conditional on option existence
 373 checkConfigOutput '^true$' config.enable ./define-option-dependently.nix ./declare-enable.nix ./declare-int-positive-value.nix
 374 checkConfigOutput '^360$' config.value ./define-option-dependently.nix ./declare-enable.nix ./declare-int-positive-value.nix
 375 checkConfigOutput '^7$' config.value ./define-option-dependently.nix ./declare-int-positive-value.nix
 376 checkConfigOutput '^true$' config.set.enable ./define-option-dependently-nested.nix ./declare-enable-nested.nix ./declare-int-positive-value-nested.nix
 377 checkConfigOutput '^360$' config.set.value ./define-option-dependently-nested.nix ./declare-enable-nested.nix ./declare-int-positive-value-nested.nix
 378 checkConfigOutput '^7$' config.set.value ./define-option-dependently-nested.nix ./declare-int-positive-value-nested.nix
 379
 380 # Check attrsOf and lazyAttrsOf. Only lazyAttrsOf should be lazy, and only
 381 # attrsOf should work with conditional definitions
 382 # In addition, lazyAttrsOf should honor an options emptyValue
 383 checkConfigError "is not lazy" config.isLazy ./declare-attrsOf.nix ./attrsOf-lazy-check.nix
 384 checkConfigOutput '^true$' config.isLazy ./declare-lazyAttrsOf.nix ./attrsOf-lazy-check.nix
 385 checkConfigOutput '^true$' config.conditionalWorks ./declare-attrsOf.nix ./attrsOf-conditional-check.nix
 386 checkConfigOutput '^false$' config.conditionalWorks ./declare-lazyAttrsOf.nix ./attrsOf-conditional-check.nix
 387 checkConfigOutput '^"empty"$' config.value.foo ./declare-lazyAttrsOf.nix ./attrsOf-conditional-check.nix
 388
 389
 390 # Even with multiple assignments, a type error should be thrown if any of them aren't valid
 391 checkConfigError 'A definition for option .* is not of type .*' \
 392   config.value ./declare-int-unsigned-value.nix ./define-value-list.nix ./define-value-int-positive.nix
 393
 394 ## Freeform modules
 395 # Assigning without a declared option should work
 396 checkConfigOutput '^"24"$' config.value ./freeform-attrsOf.nix ./define-value-string.nix
 397 # Shorthand modules interpret `meta` and `class` as config items
 398 checkConfigOutput '^true$' options._module.args.value.result ./freeform-attrsOf.nix ./define-freeform-keywords-shorthand.nix
 399 # No freeform assignments shouldn't make it error
 400 checkConfigOutput '^{}$' config ./freeform-attrsOf.nix
 401 # but only if the type matches
 402 checkConfigError 'A definition for option .* is not of type .*' config.value ./freeform-attrsOf.nix ./define-value-list.nix
 403 # and properties should be applied
 404 checkConfigOutput '^"yes"$' config.value ./freeform-attrsOf.nix ./define-value-string-properties.nix
 405 # Options should still be declarable, and be able to have a type that doesn't match the freeform type
 406 checkConfigOutput '^false$' config.enable ./freeform-attrsOf.nix ./define-value-string.nix ./declare-enable.nix
 407 checkConfigOutput '^"24"$' config.value ./freeform-attrsOf.nix ./define-value-string.nix ./declare-enable.nix
 408 # and this should work too with nested values
 409 checkConfigOutput '^false$' config.nest.foo ./freeform-attrsOf.nix ./freeform-nested.nix
 410 checkConfigOutput '^"bar"$' config.nest.bar ./freeform-attrsOf.nix ./freeform-nested.nix
 411 # Check whether a declared option can depend on an freeform-typed one
 412 checkConfigOutput '^null$' config.foo ./freeform-attrsOf.nix ./freeform-str-dep-unstr.nix
 413 checkConfigOutput '^"24"$' config.foo ./freeform-attrsOf.nix ./freeform-str-dep-unstr.nix ./define-value-string.nix
 414 # Check whether an freeform-typed value can depend on a declared option, this can only work with lazyAttrsOf
 415 checkConfigError 'infinite recursion encountered' config.foo ./freeform-attrsOf.nix ./freeform-unstr-dep-str.nix
 416 checkConfigError 'The option .* was accessed but has no value defined. Try setting the option.' config.foo ./freeform-lazyAttrsOf.nix ./freeform-unstr-dep-str.nix
 417 checkConfigOutput '^"24"$' config.foo ./freeform-lazyAttrsOf.nix ./freeform-unstr-dep-str.nix ./define-value-string.nix
 418 # submodules in freeformTypes should have their locations annotated
 419 checkConfigOutput '/freeform-submodules.nix"$' config.fooDeclarations.0 ./freeform-submodules.nix
 420 # freeformTypes can get merged using `types.type`, including submodules
 421 checkConfigOutput '^10$' config.free.xxx.foo ./freeform-submodules.nix
 422 checkConfigOutput '^10$' config.free.yyy.bar ./freeform-submodules.nix
 423
 424 ## types.anything
 425 # Check that attribute sets are merged recursively
 426 checkConfigOutput '^null$' config.value.foo ./types-anything/nested-attrs.nix
 427 checkConfigOutput '^null$' config.value.l1.foo ./types-anything/nested-attrs.nix
 428 checkConfigOutput '^null$' config.value.l1.l2.foo ./types-anything/nested-attrs.nix
 429 checkConfigOutput '^null$' config.value.l1.l2.l3.foo ./types-anything/nested-attrs.nix
 430 # Attribute sets that are coercible to strings shouldn't be recursed into
 431 checkConfigOutput '^"foo"$' config.value.outPath ./types-anything/attrs-coercible.nix
 432 # Multiple lists aren't concatenated together if their definitions are not equal
 433 checkConfigError 'The option .* has conflicting definition values' config.value ./types-anything/lists.nix
 434 # Check that all equalizable atoms can be used as long as all definitions are equal
 435 checkConfigOutput '^0$' config.value.int ./types-anything/equal-atoms.nix
 436 checkConfigOutput '^false$' config.value.bool ./types-anything/equal-atoms.nix
 437 checkConfigOutput '^""$' config.value.string ./types-anything/equal-atoms.nix
 438 checkConfigOutput '^"/[^"]+"$' config.value.path ./types-anything/equal-atoms.nix
 439 checkConfigOutput '^null$' config.value.null ./types-anything/equal-atoms.nix
 440 checkConfigOutput '^0.1$' config.value.float ./types-anything/equal-atoms.nix
 441 checkConfigOutput '^\[1,"a",{"x":null}\]$' config.value.list ./types-anything/equal-atoms.nix
 442 # Functions can't be merged together
 443 checkConfigError "The option .value.multiple-lambdas.<function body>. has conflicting option types" config.applied.multiple-lambdas ./types-anything/functions.nix
 444 checkConfigOutput '^true$' config.valueIsFunction.single-lambda ./types-anything/functions.nix
 445 checkConfigOutput '^null$' config.applied.merging-lambdas.x ./types-anything/functions.nix
 446 checkConfigOutput '^null$' config.applied.merging-lambdas.y ./types-anything/functions.nix
 447 # Check that all mk* modifiers are applied
 448 checkConfigError 'attribute .* not found' config.value.mkiffalse ./types-anything/mk-mods.nix
 449 checkConfigOutput '^{}$' config.value.mkiftrue ./types-anything/mk-mods.nix
 450 checkConfigOutput '^1$' config.value.mkdefault ./types-anything/mk-mods.nix
 451 checkConfigOutput '^{}$' config.value.mkmerge ./types-anything/mk-mods.nix
 452 checkConfigOutput '^true$' config.value.mkbefore ./types-anything/mk-mods.nix
 453 checkConfigOutput '^1$' config.value.nested.foo ./types-anything/mk-mods.nix
 454 checkConfigOutput '^"baz"$' config.value.nested.bar.baz ./types-anything/mk-mods.nix
 455
 456 ## types.functionTo
 457 checkConfigOutput '^"input is input"$' config.result ./functionTo/trivial.nix
 458 checkConfigOutput '^"a b"$' config.result ./functionTo/merging-list.nix
 459 checkConfigError 'A definition for option .fun.<function body>. is not of type .string.. Definition values:\n\s*- In .*wrong-type.nix' config.result ./functionTo/wrong-type.nix
 460 checkConfigOutput '^"b a"$' config.result ./functionTo/list-order.nix
 461 checkConfigOutput '^"a c"$' config.result ./functionTo/merging-attrs.nix
 462 checkConfigOutput '^"a bee"$' config.result ./functionTo/submodule-options.nix
 463 checkConfigOutput '^"fun.<function body>.a fun.<function body>.b"$' config.optionsResult ./functionTo/submodule-options.nix
 464
 465 # moduleType
 466 checkConfigOutput '^"a b"$' config.resultFoo ./declare-variants.nix ./define-variant.nix
 467 checkConfigOutput '^"a b y z"$' config.resultFooBar ./declare-variants.nix ./define-variant.nix
 468 checkConfigOutput '^"a b c"$' config.resultFooFoo ./declare-variants.nix ./define-variant.nix
 469
 470 ## emptyValue's
 471 checkConfigOutput "\[\]" config.list.a ./emptyValues.nix
 472 checkConfigOutput "{}" config.attrs.a ./emptyValues.nix
 473 checkConfigOutput "null" config.null.a ./emptyValues.nix
 474 checkConfigOutput "{}" config.submodule.a ./emptyValues.nix
 475 # These types don't have empty values
 476 checkConfigError 'The option .int.a. was accessed but has no value defined. Try setting the option.' config.int.a ./emptyValues.nix
 477 checkConfigError 'The option .nonEmptyList.a. was accessed but has no value defined. Try setting the option.' config.nonEmptyList.a ./emptyValues.nix
 478
 479 # types.unique
 480 #   requires a single definition
 481 checkConfigError 'The option .examples\.merged. is defined multiple times while it.s expected to be unique' config.examples.merged.a ./types-unique.nix
 482 #   user message is printed
 483 checkConfigError 'We require a single definition, because seeing the whole value at once helps us maintain critical invariants of our system.' config.examples.merged.a ./types-unique.nix
 484 #   let the inner merge function check the values (on demand)
 485 checkConfigError 'A definition for option .examples\.badLazyType\.a. is not of type .string.' config.examples.badLazyType.a ./types-unique.nix
 486 #   overriding still works (unlike option uniqueness)
 487 checkConfigOutput '^"bee"$' config.examples.override.b ./types-unique.nix
 488
 489 ## types.raw
 490 checkConfigOutput '^true$' config.unprocessedNestingEvaluates.success ./raw.nix
 491 checkConfigOutput "10" config.processedToplevel ./raw.nix
 492 checkConfigError "The option .multiple. is defined multiple times" config.multiple ./raw.nix
 493 checkConfigOutput "bar" config.priorities ./raw.nix
 494
 495 ## Option collision
 496 checkConfigError \
 497   'The option .set. in module .*/declare-set.nix. would be a parent of the following options, but its type .attribute set of signed integer. does not support nested options.\n\s*- option[(]s[)] with prefix .set.enable. in module .*/declare-enable-nested.nix.' \
 498   config.set \
 499   ./declare-set.nix ./declare-enable-nested.nix
 500
 501 # Options: accidental use of an option-type instead of option (or other tagged type; unlikely)
 502 checkConfigError 'In module .*/options-type-error-typical.nix: expected an option declaration at option path .result. but got an attribute set with type option-type' config.result ./options-type-error-typical.nix
 503 checkConfigError 'In module .*/options-type-error-typical-nested.nix: expected an option declaration at option path .result.here. but got an attribute set with type option-type' config.result.here ./options-type-error-typical-nested.nix
 504 checkConfigError 'In module .*/options-type-error-configuration.nix: expected an option declaration at option path .result. but got an attribute set with type configuration' config.result ./options-type-error-configuration.nix
 505
 506 # Check that that merging of option collisions doesn't depend on type being set
 507 checkConfigError 'The option .group..*would be a parent of the following options, but its type .<no description>. does not support nested options.\n\s*- option.s. with prefix .group.enable..*' config.group.enable ./merge-typeless-option.nix
 508
 509 # Test that types.optionType merges types correctly
 510 checkConfigOutput '^10$' config.theOption.int ./optionTypeMerging.nix
 511 checkConfigOutput '^"hello"$' config.theOption.str ./optionTypeMerging.nix
 512
 513 # Test that types.optionType correctly annotates option locations
 514 checkConfigError 'The option .theOption.nested. in .other.nix. is already declared in .optionTypeFile.nix.' config.theOption.nested ./optionTypeFile.nix
 515
 516 # Test that types.optionType leaves types untouched as long as they don't need to be merged
 517 checkConfigOutput 'ok' config.freeformItems.foo.bar ./adhoc-freeformType-survives-type-merge.nix
 518
 519 # Anonymous submodules don't get nixed by import resolution/deduplication
 520 # because of an `extendModules` bug, issue 168767.
 521 checkConfigOutput '^1$' config.sub.specialisation.value ./extendModules-168767-imports.nix
 522
 523 # Class checks, evalModules
 524 checkConfigOutput '^{}$' config.ok.config ./class-check.nix
 525 checkConfigOutput '"nixos"' config.ok.class ./class-check.nix
 526 checkConfigError 'The module .*/module-class-is-darwin.nix was imported into nixos instead of darwin.' config.fail.config ./class-check.nix
 527 checkConfigError 'The module foo.nix#darwinModules.default was imported into nixos instead of darwin.' config.fail-anon.config ./class-check.nix
 528
 529 # Class checks, submoduleWith
 530 checkConfigOutput '^{}$' config.sub.nixosOk ./class-check.nix
 531 checkConfigError 'The module .*/module-class-is-darwin.nix was imported into nixos instead of darwin.' config.sub.nixosFail.config ./class-check.nix
 532
 533 # submoduleWith type merge with different class
 534 checkConfigError 'A submoduleWith option is declared multiple times with conflicting class values "darwin" and "nixos".' config.sub.mergeFail.config ./class-check.nix
 535
 536 # _type check
 537 checkConfigError 'Expected a module, but found a value of type .*"flake".*, while trying to load a module into .*/module-imports-_type-check.nix' config.ok.config ./module-imports-_type-check.nix
 538 checkConfigOutput '^true$' config.enable ./declare-enable.nix ./define-enable-with-top-level-mkIf.nix
 539 checkConfigError 'Expected a module, but found a value of type .*"configuration".*, while trying to load a module into .*/import-configuration.nix.' config ./import-configuration.nix
 540 checkConfigError 'please only import the modules that make up the configuration' config ./import-configuration.nix
 541
 542 # doRename works when `warnings` does not exist.
 543 checkConfigOutput '^1234$' config.c.d.e ./doRename-basic.nix
 544 # doRename adds a warning.
 545 checkConfigOutput '^"The option `a\.b. defined in `.*/doRename-warnings\.nix. has been renamed to `c\.d\.e.\."$' \
 546   config.result \
 547   ./doRename-warnings.nix
 548 checkConfigOutput "^true$" config.result ./doRename-condition.nix ./doRename-condition-enable.nix
 549 checkConfigOutput "^true$" config.result ./doRename-condition.nix ./doRename-condition-no-enable.nix
 550 checkConfigOutput "^true$" config.result ./doRename-condition.nix ./doRename-condition-migrated.nix
 551
 552 # Anonymous modules get deduplicated by key
 553 checkConfigOutput '^"pear"$' config.once.raw ./merge-module-with-key.nix
 554 checkConfigOutput '^"pear\\npear"$' config.twice.raw ./merge-module-with-key.nix
 555
 556 # Declaration positions
 557 # Line should be present for direct options
 558 checkConfigOutput '^14$' options.imported.line14.declarationPositions.0.line ./declaration-positions.nix
 559 checkConfigOutput '/declaration-positions.nix"$' options.imported.line14.declarationPositions.0.file ./declaration-positions.nix
 560 # Generated options may not have line numbers but they will at least get the
 561 # right file
 562 checkConfigOutput '/declaration-positions.nix"$' options.generated.line22.declarationPositions.0.file ./declaration-positions.nix
 563 checkConfigOutput '^null$' options.generated.line22.declarationPositions.0.line ./declaration-positions.nix
 564 # Submodules don't break it
 565 checkConfigOutput '^45$' config.submoduleLine38.submodDeclLine45.0.line ./declaration-positions.nix
 566 checkConfigOutput '/declaration-positions.nix"$' config.submoduleLine38.submodDeclLine45.0.file ./declaration-positions.nix
 567 # New options under freeform submodules get collected into the parent submodule
 568 # (consistent with .declarations behaviour, but weird; notably appears in system.build)
 569 checkConfigOutput '^38|27$' options.submoduleLine38.declarationPositions.0.line ./declaration-positions.nix
 570 checkConfigOutput '^38|27$' options.submoduleLine38.declarationPositions.1.line ./declaration-positions.nix
 571 # nested options work
 572 checkConfigOutput '^34$' options.nested.nestedLine34.declarationPositions.0.line ./declaration-positions.nix
 573
 574 cat <<EOF
 575 ====== module tests ======
 576 $pass Pass
 577 $fail Fail
 578 EOF
 579
 580 if [ "$fail" -ne 0 ]; then
 581     exit 1
 582 fi
 583 exit 0