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