2021-11-25 20:51:13 +00:00
#!/usr/bin/env bash
2015-02-08 20:48:38 +00:00
#
# This script is used to test that the module system is working as expected.
# By default it test the version of nixpkgs which is defined in the NIX_PATH.
2021-11-25 20:53:57 +00:00
set -o errexit -o noclobber -o nounset -o pipefail
shopt -s failglob inherit_errexit
2020-03-14 19:06:04 +00:00
# https://stackoverflow.com/a/246128/6605742
DIR = " $( cd " $( dirname " ${ BASH_SOURCE [0] } " ) " >/dev/null 2>& 1 && pwd ) "
cd " $DIR " /modules
2015-02-08 20:48:38 +00:00
pass = 0
fail = 0
evalConfig( ) {
local attr = $1
2021-11-25 21:41:43 +00:00
shift
2021-11-25 21:01:24 +00:00
local script = " import ./default.nix { modules = [ $* ];} "
2020-01-10 03:11:53 +00:00
nix-instantiate --timeout 1 -E " $script " -A " $attr " --eval-only --show-trace --read-write-mode
2015-02-08 20:48:38 +00:00
}
reportFailure( ) {
local attr = $1
2021-11-25 21:41:43 +00:00
shift
2021-11-25 21:01:24 +00:00
local script = " import ./default.nix { modules = [ $* ];} "
2015-02-08 20:48:38 +00:00
echo 2>& 1 " $ nix-instantiate -E ' $script ' -A ' $attr ' --eval-only "
2021-11-25 20:53:57 +00:00
evalConfig " $attr " " $@ " || true
( ( ++fail) )
2015-02-08 20:48:38 +00:00
}
2020-12-18 15:42:42 +00:00
checkConfigOutput( ) {
2015-02-08 20:48:38 +00:00
local outputContains = $1
2021-11-25 21:41:43 +00:00
shift
2020-12-18 15:42:42 +00:00
if evalConfig " $@ " 2>/dev/null | grep --silent " $outputContains " ; then
2021-11-25 20:53:57 +00:00
( ( ++pass) )
2020-12-18 15:42:42 +00:00
else
echo 2>& 1 " error: Expected result matching ' $outputContains ', while evaluating "
2020-09-02 20:33:29 +00:00
reportFailure " $@ "
fi
2015-02-08 20:48:38 +00:00
}
checkConfigError( ) {
local errorContains = $1
2020-12-18 15:42:42 +00:00
local err = ""
2021-11-25 21:41:43 +00:00
shift
2021-11-25 20:58:35 +00:00
if err = " $( evalConfig " $@ " 2>& 1 >/dev/null) " ; then
2020-12-18 15:42:42 +00:00
echo 2>& 1 "error: Expected error code, got exit code 0, while evaluating"
reportFailure " $@ "
else
if echo " $err " | grep -zP --silent " $errorContains " ; then
2021-11-25 20:53:57 +00:00
( ( ++pass) )
2020-12-18 15:42:42 +00:00
else
echo 2>& 1 " error: Expected error matching ' $errorContains ', while evaluating "
reportFailure " $@ "
fi
fi
2015-02-08 20:48:38 +00:00
}
2022-06-06 14:05:21 +00:00
# Shorthand meta attribute does not duplicate the config
checkConfigOutput '^"one two"$' config.result ./shorthand-meta.nix
2023-06-16 19:43:12 +00:00
checkConfigOutput '^true$' config.result ./test-mergeAttrDefinitionsWithPrio.nix
2023-06-26 10:50:01 +00:00
# types.pathInStore
checkConfigOutput '".*/store/5lz9p8xhf89kb1c1kk6jxrzskaiygnlh-bash-5.2-p15.drv"' config.pathInStore.ok1 ./types.nix
checkConfigOutput '".*/store/xfb3ykw9r5hpayd05sr0cizwadzq1d8q-bash-5.2-p15"' config.pathInStore.ok2 ./types.nix
checkConfigOutput '".*/store/xfb3ykw9r5hpayd05sr0cizwadzq1d8q-bash-5.2-p15/bin/bash"' config.pathInStore.ok3 ./types.nix
checkConfigError 'A definition for option .* is not of type .path in the Nix store.. Definition values:\n\s*- In .*: ""' config.pathInStore.bad1 ./types.nix
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
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
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
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
2015-03-16 21:38:41 +00:00
# Check boolean option.
2021-11-25 22:02:41 +00:00
checkConfigOutput '^false$' config.enable ./declare-enable.nix
2021-11-03 23:19:08 +00:00
checkConfigError 'The option .* does not exist. Definition values:\n\s*- In .*: true' config.enable ./define-enable.nix
2022-12-02 10:49:10 +00:00
checkConfigError 'The option .* does not exist. Definition values:\n\s*- In .*' config.enable ./define-enable-throw.nix
checkConfigError 'while evaluating a definition from `.*/define-enable-abort.nix' config.enable ./define-enable-abort.nix
checkConfigError 'while evaluating the error message for definitions for .enable., which is an option that does not exist' config.enable ./define-enable-abort.nix
2015-03-16 21:38:41 +00:00
2022-01-24 14:58:17 +00:00
checkConfigOutput '^1$' config.bare-submodule.nested ./declare-bare-submodule.nix ./declare-bare-submodule-nested-option.nix
checkConfigOutput '^2$' config.bare-submodule.deep ./declare-bare-submodule.nix ./declare-bare-submodule-deep-option.nix
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
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
2022-02-28 21:57:03 +00:00
checkConfigOutput '^2$' config.bare-submodule.deep ./declare-bare-submodule.nix ./declare-bare-submodule-deep-option.nix ./define-shorthandOnlyDefinesConfig-true.nix
2022-03-07 10:20:30 +00:00
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
2022-01-24 14:58:17 +00:00
2017-10-31 13:23:05 +00:00
# Check integer types.
# unsigned
2021-11-25 22:02:41 +00:00
checkConfigOutput '^42$' config.value ./declare-int-unsigned-value.nix ./define-value-int-positive.nix
2021-11-03 23:19:08 +00:00
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
2017-10-31 16:30:15 +00:00
# positive
2021-11-03 23:19:08 +00:00
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
2017-10-31 13:23:05 +00:00
# between
2021-11-25 22:02:41 +00:00
checkConfigOutput '^42$' config.value ./declare-int-between-value.nix ./define-value-int-positive.nix
2021-11-03 23:19:08 +00:00
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
2017-10-31 13:23:05 +00:00
2019-08-01 13:55:33 +00:00
# Check either types
# types.either
2021-11-25 22:02:41 +00:00
checkConfigOutput '^42$' config.value ./declare-either.nix ./define-value-int-positive.nix
checkConfigOutput '^"24"$' config.value ./declare-either.nix ./define-value-string.nix
2019-08-01 13:55:33 +00:00
# types.oneOf
2021-11-25 22:02:41 +00:00
checkConfigOutput '^42$' config.value ./declare-oneOf.nix ./define-value-int-positive.nix
checkConfigOutput '^\[ \]$' config.value ./declare-oneOf.nix ./define-value-list.nix
checkConfigOutput '^"24"$' config.value ./declare-oneOf.nix ./define-value-string.nix
2019-08-01 13:55:33 +00:00
2015-03-16 21:38:41 +00:00
# Check mkForce without submodules.
2015-02-08 20:48:38 +00:00
set -- config.enable ./declare-enable.nix ./define-enable.nix
2021-11-25 22:02:41 +00:00
checkConfigOutput '^true$' " $@ "
checkConfigOutput '^false$' " $@ " ./define-force-enable.nix
checkConfigOutput '^false$' " $@ " ./define-enable-force.nix
2015-02-08 20:48:38 +00:00
2015-03-16 21:38:41 +00:00
# Check mkForce with option and submodules.
2019-06-13 21:53:03 +00:00
checkConfigError 'attribute .*foo.* .* not found' config.attrsOfSub.foo.enable ./declare-attrsOfSub-any-enable.nix
2021-11-25 22:02:41 +00:00
checkConfigOutput '^false$' config.attrsOfSub.foo.enable ./declare-attrsOfSub-any-enable.nix ./define-attrsOfSub-foo.nix
2019-06-13 21:53:03 +00:00
set -- config.attrsOfSub.foo.enable ./declare-attrsOfSub-any-enable.nix ./define-attrsOfSub-foo-enable.nix
2021-11-25 22:02:41 +00:00
checkConfigOutput '^true$' " $@ "
checkConfigOutput '^false$' " $@ " ./define-force-attrsOfSub-foo-enable.nix
checkConfigOutput '^false$' " $@ " ./define-attrsOfSub-force-foo-enable.nix
checkConfigOutput '^false$' " $@ " ./define-attrsOfSub-foo-force-enable.nix
checkConfigOutput '^false$' " $@ " ./define-attrsOfSub-foo-enable-force.nix
2015-02-08 20:48:38 +00:00
2015-03-16 21:38:41 +00:00
# Check overriding effect of mkForce on submodule definitions.
2019-06-13 21:53:03 +00:00
checkConfigError 'attribute .*bar.* .* not found' config.attrsOfSub.bar.enable ./declare-attrsOfSub-any-enable.nix ./define-attrsOfSub-foo.nix
2021-11-25 22:02:41 +00:00
checkConfigOutput '^false$' config.attrsOfSub.bar.enable ./declare-attrsOfSub-any-enable.nix ./define-attrsOfSub-foo.nix ./define-attrsOfSub-bar.nix
2019-06-13 21:53:03 +00:00
set -- config.attrsOfSub.bar.enable ./declare-attrsOfSub-any-enable.nix ./define-attrsOfSub-foo.nix ./define-attrsOfSub-bar-enable.nix
2021-11-25 22:02:41 +00:00
checkConfigOutput '^true$' " $@ "
2019-06-13 21:53:03 +00:00
checkConfigError 'attribute .*bar.* .* not found' " $@ " ./define-force-attrsOfSub-foo-enable.nix
checkConfigError 'attribute .*bar.* .* not found' " $@ " ./define-attrsOfSub-force-foo-enable.nix
2021-11-25 22:02:41 +00:00
checkConfigOutput '^true$' " $@ " ./define-attrsOfSub-foo-force-enable.nix
checkConfigOutput '^true$' " $@ " ./define-attrsOfSub-foo-enable-force.nix
2015-02-08 20:48:38 +00:00
2015-03-16 21:38:41 +00:00
# Check mkIf with submodules.
2019-06-13 21:53:03 +00:00
checkConfigError 'attribute .*foo.* .* not found' config.attrsOfSub.foo.enable ./declare-enable.nix ./declare-attrsOfSub-any-enable.nix
set -- config.attrsOfSub.foo.enable ./declare-enable.nix ./declare-attrsOfSub-any-enable.nix
checkConfigError 'attribute .*foo.* .* not found' " $@ " ./define-if-attrsOfSub-foo-enable.nix
checkConfigError 'attribute .*foo.* .* not found' " $@ " ./define-attrsOfSub-if-foo-enable.nix
checkConfigError 'attribute .*foo.* .* not found' " $@ " ./define-attrsOfSub-foo-if-enable.nix
2021-11-25 22:02:41 +00:00
checkConfigOutput '^false$' " $@ " ./define-attrsOfSub-foo-enable-if.nix
checkConfigOutput '^true$' " $@ " ./define-enable.nix ./define-if-attrsOfSub-foo-enable.nix
checkConfigOutput '^true$' " $@ " ./define-enable.nix ./define-attrsOfSub-if-foo-enable.nix
checkConfigOutput '^true$' " $@ " ./define-enable.nix ./define-attrsOfSub-foo-if-enable.nix
checkConfigOutput '^true$' " $@ " ./define-enable.nix ./define-attrsOfSub-foo-enable-if.nix
2015-03-16 21:38:41 +00:00
2017-02-14 22:18:44 +00:00
# Check disabledModules with config definitions and option declarations.
set -- config.enable ./define-enable.nix ./declare-enable.nix
2021-11-25 22:02:41 +00:00
checkConfigOutput '^true$' " $@ "
checkConfigOutput '^false$' " $@ " ./disable-define-enable.nix
2022-08-25 12:03:57 +00:00
checkConfigOutput '^false$' " $@ " ./disable-define-enable-string-path.nix
2021-11-03 23:19:08 +00:00
checkConfigError "The option .*enable.* does not exist. Definition values:\n\s*- In .*: true" " $@ " ./disable-declare-enable.nix
2017-02-14 22:18:44 +00:00
checkConfigError "attribute .*enable.* in selection path .*config.enable.* not found" " $@ " ./disable-define-enable.nix ./disable-declare-enable.nix
checkConfigError "attribute .*enable.* in selection path .*config.enable.* not found" " $@ " ./disable-enable-modules.nix
2023-01-20 23:58:47 +00:00
checkConfigOutput '^true$' 'config.positive.enable' ./disable-module-with-key.nix
checkConfigOutput '^false$' 'config.negative.enable' ./disable-module-with-key.nix
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
# 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.
checkConfigOutput '^true$' 'config.positive.enable' ./disable-module-with-toString-key.nix
checkConfigOutput '^false$' 'config.negative.enable' ./disable-module-with-toString-key.nix
2015-03-16 21:38:41 +00:00
# Check _module.args.
2015-05-13 20:44:04 +00:00
set -- config.enable ./declare-enable.nix ./define-enable-with-custom-arg.nix
checkConfigError 'while evaluating the module argument .*custom.* in .*define-enable-with-custom-arg.nix.*:' " $@ "
2021-11-25 22:02:41 +00:00
checkConfigOutput '^true$' " $@ " ./define-_module-args-custom.nix
2015-05-13 20:44:04 +00:00
# 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' " $@ "
2015-03-16 21:38:41 +00:00
# Check _module.check.
2019-06-13 21:53:03 +00:00
set -- config.enable ./declare-enable.nix ./define-enable.nix ./define-attrsOfSub-foo.nix
2021-11-03 23:19:08 +00:00
checkConfigError 'The option .* does not exist. Definition values:\n\s*- In .*' " $@ "
2021-11-25 22:02:41 +00:00
checkConfigOutput '^true$' " $@ " ./define-module-check.nix
2015-03-16 21:38:41 +00:00
2017-02-01 22:52:40 +00:00
# Check coerced value.
2023-02-07 19:39:56 +00:00
set --
2021-11-25 22:02:41 +00:00
checkConfigOutput '^"42"$' config.value ./declare-coerced-value.nix
checkConfigOutput '^"24"$' config.value ./declare-coerced-value.nix ./define-value-string.nix
2021-11-03 23:19:08 +00:00
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
2017-02-01 22:52:40 +00:00
2018-04-04 14:51:46 +00:00
# Check coerced value with unsound coercion
2021-11-25 22:02:41 +00:00
checkConfigOutput '^12$' config.value ./declare-coerced-value-unsound.nix
2021-11-03 23:19:08 +00:00
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
2022-07-10 00:12:31 +00:00
checkConfigError 'toInt: Could not convert .* to int' config.value ./declare-coerced-value-unsound.nix ./define-value-string-arbitrary.nix
2018-04-04 14:51:46 +00:00
2019-01-24 03:58:33 +00:00
# Check mkAliasOptionModule.
2021-11-25 22:02:41 +00:00
checkConfigOutput '^true$' config.enable ./alias-with-priority.nix
checkConfigOutput '^true$' config.enableAlias ./alias-with-priority.nix
checkConfigOutput '^false$' config.enable ./alias-with-priority-can-override.nix
checkConfigOutput '^false$' config.enableAlias ./alias-with-priority-can-override.nix
2019-01-04 07:34:59 +00:00
2023-05-20 16:23:41 +00:00
# Check mkPackageOption
checkConfigOutput '^"hello"$' config.package.pname ./declare-mkPackageOption.nix
checkConfigError 'The option .undefinedPackage. is used but not defined' config.undefinedPackage ./declare-mkPackageOption.nix
checkConfigOutput '^null$' config.nullablePackage ./declare-mkPackageOption.nix
2020-01-01 00:11:45 +00:00
# submoduleWith
## specialArgs should work
2021-11-25 22:02:41 +00:00
checkConfigOutput '^"foo"$' config.submodule.foo ./declare-submoduleWith-special.nix
2020-01-01 00:11:45 +00:00
## shorthandOnlyDefines config behaves as expected
2021-11-25 22:02:41 +00:00
checkConfigOutput '^true$' config.submodule.config ./declare-submoduleWith-shorthand.nix ./define-submoduleWith-shorthand.nix
2020-01-01 00:11:45 +00:00
checkConfigError 'is not of type `boolean' config.submodule.config ./declare-submoduleWith-shorthand.nix ./define-submoduleWith-noshorthand.nix
2023-03-22 10:23:21 +00:00
checkConfigError "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
2021-11-25 22:02:41 +00:00
checkConfigOutput '^true$' config.submodule.config ./declare-submoduleWith-noshorthand.nix ./define-submoduleWith-noshorthand.nix
2020-01-01 00:11:45 +00:00
## submoduleWith should merge all modules in one swoop
2021-11-25 22:02:41 +00:00
checkConfigOutput '^true$' config.submodule.inner ./declare-submoduleWith-modules.nix
checkConfigOutput '^true$' config.submodule.outer ./declare-submoduleWith-modules.nix
2020-09-29 23:49:58 +00:00
# Should also be able to evaluate the type name (which evaluates freeformType,
# which evaluates all the modules defined by the type)
2021-11-25 22:02:41 +00:00
checkConfigOutput '^"submodule"$' options.submodule.type.description ./declare-submoduleWith-modules.nix
2020-01-01 00:11:45 +00:00
2021-10-27 18:42:05 +00:00
## submodules can be declared using (evalModules {...}).type
2021-11-25 22:02:41 +00:00
checkConfigOutput '^true$' config.submodule.inner ./declare-submodule-via-evalModules.nix
checkConfigOutput '^true$' config.submodule.outer ./declare-submodule-via-evalModules.nix
2021-10-27 18:42:05 +00:00
# Should also be able to evaluate the type name (which evaluates freeformType,
# which evaluates all the modules defined by the type)
2021-11-25 22:02:41 +00:00
checkConfigOutput '^"submodule"$' options.submodule.type.description ./declare-submodule-via-evalModules.nix
2021-10-27 18:42:05 +00:00
2020-01-01 00:11:45 +00:00
## Paths should be allowed as values and work as expected
2021-11-25 22:02:41 +00:00
checkConfigOutput '^true$' config.submodule.enable ./declare-submoduleWith-path.nix
2020-01-01 00:11:45 +00:00
2022-05-18 16:42:18 +00:00
## deferredModule
# default module is merged into nodes.foo
2022-03-10 21:45:41 +00:00
checkConfigOutput '"beta"' config.nodes.foo.settingsDict.c ./deferred-module.nix
2022-05-18 16:42:18 +00:00
# errors from the default module are reported with accurate location
2022-05-18 16:46:35 +00:00
checkConfigError 'In `the-file-that-contains-the-bad-config.nix, via option default' \' ': "bogus"' config.nodes.foo.bottom ./deferred-module.nix
2022-06-14 21:12:46 +00:00
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
2022-03-10 21:45:41 +00:00
2020-09-27 15:15:57 +00:00
# Check the file location information is propagated into submodules
checkConfigOutput the-file.nix config.submodule.internalFiles.0 ./submoduleFiles.nix
2020-01-04 01:01:21 +00:00
# Check that disabledModules works recursively and correctly
2021-11-25 22:02:41 +00:00
checkConfigOutput '^true$' config.enable ./disable-recursive/main.nix
checkConfigOutput '^true$' config.enable ./disable-recursive/{ main.nix,disable-foo.nix}
checkConfigOutput '^true$' config.enable ./disable-recursive/{ main.nix,disable-bar.nix}
2021-11-03 23:19:08 +00:00
checkConfigError 'The option .* does not exist. Definition values:\n\s*- In .*: true' config.enable ./disable-recursive/{ main.nix,disable-foo.nix,disable-bar.nix}
2020-01-04 01:01:21 +00:00
2020-01-10 03:11:53 +00:00
# Check that imports can depend on derivations
2021-11-25 22:02:41 +00:00
checkConfigOutput '^true$' config.enable ./import-from-store.nix
2020-01-10 03:11:53 +00:00
2020-03-17 19:21:10 +00:00
# Check that configs can be conditional on option existence
2021-11-25 22:02:41 +00:00
checkConfigOutput '^true$' config.enable ./define-option-dependently.nix ./declare-enable.nix ./declare-int-positive-value.nix
checkConfigOutput '^360$' config.value ./define-option-dependently.nix ./declare-enable.nix ./declare-int-positive-value.nix
checkConfigOutput '^7$' config.value ./define-option-dependently.nix ./declare-int-positive-value.nix
checkConfigOutput '^true$' config.set.enable ./define-option-dependently-nested.nix ./declare-enable-nested.nix ./declare-int-positive-value-nested.nix
checkConfigOutput '^360$' config.set.value ./define-option-dependently-nested.nix ./declare-enable-nested.nix ./declare-int-positive-value-nested.nix
checkConfigOutput '^7$' config.set.value ./define-option-dependently-nested.nix ./declare-int-positive-value-nested.nix
2020-03-17 19:21:10 +00:00
2019-10-12 18:37:21 +00:00
# Check attrsOf and lazyAttrsOf. Only lazyAttrsOf should be lazy, and only
# attrsOf should work with conditional definitions
# In addition, lazyAttrsOf should honor an options emptyValue
checkConfigError "is not lazy" config.isLazy ./declare-attrsOf.nix ./attrsOf-lazy-check.nix
2021-11-25 22:02:41 +00:00
checkConfigOutput '^true$' config.isLazy ./declare-lazyAttrsOf.nix ./attrsOf-lazy-check.nix
checkConfigOutput '^true$' config.conditionalWorks ./declare-attrsOf.nix ./attrsOf-conditional-check.nix
checkConfigOutput '^false$' config.conditionalWorks ./declare-lazyAttrsOf.nix ./attrsOf-conditional-check.nix
checkConfigOutput '^"empty"$' config.value.foo ./declare-lazyAttrsOf.nix ./attrsOf-conditional-check.nix
2019-10-12 18:37:21 +00:00
2020-03-16 20:08:39 +00:00
2020-03-16 20:10:05 +00:00
# Even with multiple assignments, a type error should be thrown if any of them aren't valid
2020-09-17 11:36:38 +00:00
checkConfigError 'A definition for option .* is not of type .*' \
2020-03-16 20:10:05 +00:00
config.value ./declare-int-unsigned-value.nix ./define-value-list.nix ./define-value-int-positive.nix
2020-03-22 19:55:54 +00:00
## Freeform modules
# Assigning without a declared option should work
2021-11-25 22:02:41 +00:00
checkConfigOutput '^"24"$' config.value ./freeform-attrsOf.nix ./define-value-string.nix
2023-04-10 15:26:25 +00:00
# Shorthand modules interpret `meta` and `class` as config items
checkConfigOutput '^true$' options._module.args.value.result ./freeform-attrsOf.nix ./define-freeform-keywords-shorthand.nix
2022-12-17 23:59:29 +00:00
# No freeform assignments shouldn't make it error
2021-11-25 22:02:41 +00:00
checkConfigOutput '^{ }$' config ./freeform-attrsOf.nix
2020-03-22 19:55:54 +00:00
# but only if the type matches
2020-09-17 11:36:38 +00:00
checkConfigError 'A definition for option .* is not of type .*' config.value ./freeform-attrsOf.nix ./define-value-list.nix
2020-03-22 19:55:54 +00:00
# and properties should be applied
2021-11-25 22:02:41 +00:00
checkConfigOutput '^"yes"$' config.value ./freeform-attrsOf.nix ./define-value-string-properties.nix
2020-03-22 19:55:54 +00:00
# Options should still be declarable, and be able to have a type that doesn't match the freeform type
2021-11-25 22:02:41 +00:00
checkConfigOutput '^false$' config.enable ./freeform-attrsOf.nix ./define-value-string.nix ./declare-enable.nix
checkConfigOutput '^"24"$' config.value ./freeform-attrsOf.nix ./define-value-string.nix ./declare-enable.nix
2020-03-22 19:55:54 +00:00
# and this should work too with nested values
2021-11-25 22:02:41 +00:00
checkConfigOutput '^false$' config.nest.foo ./freeform-attrsOf.nix ./freeform-nested.nix
checkConfigOutput '^"bar"$' config.nest.bar ./freeform-attrsOf.nix ./freeform-nested.nix
2020-03-22 19:55:54 +00:00
# Check whether a declared option can depend on an freeform-typed one
2021-11-25 22:02:41 +00:00
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
2020-03-22 19:55:54 +00:00
# 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
checkConfigError 'The option .* is used but not defined' config.foo ./freeform-lazyAttrsOf.nix ./freeform-unstr-dep-str.nix
2021-11-25 22:02:41 +00:00
checkConfigOutput '^"24"$' config.foo ./freeform-lazyAttrsOf.nix ./freeform-unstr-dep-str.nix ./define-value-string.nix
2021-12-08 18:13:14 +00:00
# submodules in freeformTypes should have their locations annotated
checkConfigOutput '/freeform-submodules.nix"$' config.fooDeclarations.0 ./freeform-submodules.nix
# freeformTypes can get merged using `types.type`, including submodules
checkConfigOutput '^10$' config.free.xxx.foo ./freeform-submodules.nix
checkConfigOutput '^10$' config.free.yyy.bar ./freeform-submodules.nix
2020-03-22 19:55:54 +00:00
2020-09-04 13:27:26 +00:00
## types.anything
# Check that attribute sets are merged recursively
2021-11-25 22:02:41 +00:00
checkConfigOutput '^null$' config.value.foo ./types-anything/nested-attrs.nix
checkConfigOutput '^null$' config.value.l1.foo ./types-anything/nested-attrs.nix
checkConfigOutput '^null$' config.value.l1.l2.foo ./types-anything/nested-attrs.nix
checkConfigOutput '^null$' config.value.l1.l2.l3.foo ./types-anything/nested-attrs.nix
2020-09-04 13:27:26 +00:00
# Attribute sets that are coercible to strings shouldn't be recursed into
2021-11-25 22:02:41 +00:00
checkConfigOutput '^"foo"$' config.value.outPath ./types-anything/attrs-coercible.nix
2020-09-04 13:27:26 +00:00
# Multiple lists aren't concatenated together
checkConfigError 'The option .* has conflicting definitions' config.value ./types-anything/lists.nix
# Check that all equalizable atoms can be used as long as all definitions are equal
2021-11-25 22:02:41 +00:00
checkConfigOutput '^0$' config.value.int ./types-anything/equal-atoms.nix
checkConfigOutput '^false$' config.value.bool ./types-anything/equal-atoms.nix
checkConfigOutput '^""$' config.value.string ./types-anything/equal-atoms.nix
checkConfigOutput '^/$' config.value.path ./types-anything/equal-atoms.nix
checkConfigOutput '^null$' config.value.null ./types-anything/equal-atoms.nix
checkConfigOutput '^0.1$' config.value.float ./types-anything/equal-atoms.nix
2020-09-04 13:27:26 +00:00
# Functions can't be merged together
2021-10-02 14:37:22 +00:00
checkConfigError "The option .value.multiple-lambdas.<function body>. has conflicting option types" config.applied.multiple-lambdas ./types-anything/functions.nix
2021-11-25 22:02:41 +00:00
checkConfigOutput '^<LAMBDA>$' config.value.single-lambda ./types-anything/functions.nix
checkConfigOutput '^null$' config.applied.merging-lambdas.x ./types-anything/functions.nix
checkConfigOutput '^null$' config.applied.merging-lambdas.y ./types-anything/functions.nix
2020-09-04 13:27:26 +00:00
# Check that all mk* modifiers are applied
checkConfigError 'attribute .* not found' config.value.mkiffalse ./types-anything/mk-mods.nix
2021-11-25 22:02:41 +00:00
checkConfigOutput '^{ }$' config.value.mkiftrue ./types-anything/mk-mods.nix
checkConfigOutput '^1$' config.value.mkdefault ./types-anything/mk-mods.nix
checkConfigOutput '^{ }$' config.value.mkmerge ./types-anything/mk-mods.nix
checkConfigOutput '^true$' config.value.mkbefore ./types-anything/mk-mods.nix
checkConfigOutput '^1$' config.value.nested.foo ./types-anything/mk-mods.nix
checkConfigOutput '^"baz"$' config.value.nested.bar.baz ./types-anything/mk-mods.nix
2020-09-04 13:27:26 +00:00
2021-01-26 21:30:07 +00:00
## types.functionTo
2021-11-25 22:02:41 +00:00
checkConfigOutput '^"input is input"$' config.result ./functionTo/trivial.nix
checkConfigOutput '^"a b"$' config.result ./functionTo/merging-list.nix
2022-10-07 07:58:55 +00:00
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
2021-11-25 22:02:41 +00:00
checkConfigOutput '^"b a"$' config.result ./functionTo/list-order.nix
checkConfigOutput '^"a c"$' config.result ./functionTo/merging-attrs.nix
2022-05-13 07:09:16 +00:00
checkConfigOutput '^"a bee"$' config.result ./functionTo/submodule-options.nix
2022-10-07 07:58:55 +00:00
checkConfigOutput '^"fun.<function body>.a fun.<function body>.b"$' config.optionsResult ./functionTo/submodule-options.nix
2018-08-07 16:44:58 +00:00
2021-11-22 13:39:10 +00:00
# moduleType
2021-11-25 22:02:41 +00:00
checkConfigOutput '^"a b"$' config.resultFoo ./declare-variants.nix ./define-variant.nix
2022-04-23 22:07:59 +00:00
checkConfigOutput '^"a b y z"$' config.resultFooBar ./declare-variants.nix ./define-variant.nix
2021-11-25 22:02:41 +00:00
checkConfigOutput '^"a b c"$' config.resultFooFoo ./declare-variants.nix ./define-variant.nix
2021-11-22 13:39:10 +00:00
2021-10-15 14:48:38 +00:00
## emptyValue's
checkConfigOutput "[ ]" config.list.a ./emptyValues.nix
checkConfigOutput "{ }" config.attrs.a ./emptyValues.nix
checkConfigOutput "null" config.null.a ./emptyValues.nix
checkConfigOutput "{ }" config.submodule.a ./emptyValues.nix
# These types don't have empty values
checkConfigError 'The option .int.a. is used but not defined' config.int.a ./emptyValues.nix
checkConfigError 'The option .nonEmptyList.a. is used but not defined' config.nonEmptyList.a ./emptyValues.nix
2021-08-02 19:42:45 +00:00
## types.raw
checkConfigOutput "{ foo = <CODE>; }" config.unprocessedNesting ./raw.nix
checkConfigOutput "10" config.processedToplevel ./raw.nix
checkConfigError "The option .multiple. is defined multiple times" config.multiple ./raw.nix
checkConfigOutput "bar" config.priorities ./raw.nix
2022-02-28 21:39:56 +00:00
## Option collision
checkConfigError \
2022-05-02 08:41:47 +00:00
'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.' \
2022-02-28 21:39:56 +00:00
config.set \
./declare-set.nix ./declare-enable-nested.nix
2021-12-08 18:02:29 +00:00
# Test that types.optionType merges types correctly
checkConfigOutput '^10$' config.theOption.int ./optionTypeMerging.nix
checkConfigOutput '^"hello"$' config.theOption.str ./optionTypeMerging.nix
# Test that types.optionType correctly annotates option locations
checkConfigError 'The option .theOption.nested. in .other.nix. is already declared in .optionTypeFile.nix.' config.theOption.nested ./optionTypeFile.nix
2022-03-10 19:25:49 +00:00
# Test that types.optionType leaves types untouched as long as they don't need to be merged
checkConfigOutput 'ok' config.freeformItems.foo.bar ./adhoc-freeformType-survives-type-merge.nix
2022-04-23 22:07:59 +00:00
# Anonymous submodules don't get nixed by import resolution/deduplication
# because of an `extendModules` bug, issue 168767.
checkConfigOutput '^1$' config.sub.specialisation.value ./extendModules-168767-imports.nix
2023-04-17 18:00:07 +00:00
# Class checks, evalModules
2022-10-24 12:30:19 +00:00
checkConfigOutput '^{ }$' config.ok.config ./class-check.nix
2023-04-27 18:03:44 +00:00
checkConfigOutput '"nixos"' config.ok.class ./class-check.nix
2022-10-24 12:30:19 +00:00
checkConfigError 'The module .*/module-class-is-darwin.nix was imported into nixos instead of darwin.' config.fail.config ./class-check.nix
checkConfigError 'The module foo.nix#darwinModules.default was imported into nixos instead of darwin.' config.fail-anon.config ./class-check.nix
2023-04-17 18:00:07 +00:00
# Class checks, submoduleWith
checkConfigOutput '^{ }$' config.sub.nixosOk ./class-check.nix
checkConfigError 'The module .*/module-class-is-darwin.nix was imported into nixos instead of darwin.' config.sub.nixosFail.config ./class-check.nix
# submoduleWith type merge with different class
2023-05-26 16:31:35 +00:00
checkConfigError 'A submoduleWith option is declared multiple times with conflicting class values "darwin" and "nixos".' config.sub.mergeFail.config ./class-check.nix
2023-04-17 18:00:07 +00:00
2023-02-07 19:41:29 +00:00
# _type check
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
checkConfigOutput '^true$' " $@ " config.enable ./declare-enable.nix ./define-enable-with-top-level-mkIf.nix
2023-02-07 20:13:06 +00:00
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
2023-02-07 19:41:29 +00:00
2022-11-03 12:11:04 +00:00
# doRename works when `warnings` does not exist.
checkConfigOutput '^1234$' config.c.d.e ./doRename-basic.nix
# doRename adds a warning.
checkConfigOutput '^"The option `a\.b. defined in `.*/doRename-warnings\.nix. has been renamed to `c\.d\.e.\."$' \
config.result \
./doRename-warnings.nix
2023-01-20 23:58:47 +00:00
# Anonymous modules get deduplicated by key
checkConfigOutput '^"pear"$' config.once.raw ./merge-module-with-key.nix
checkConfigOutput '^"pear\\npear"$' config.twice.raw ./merge-module-with-key.nix
2015-02-08 20:48:38 +00:00
cat <<EOF
= = = = = = module tests = = = = = =
$pass Pass
$fail Fail
EOF
2021-11-25 22:03:40 +00:00
if [ " $fail " -ne 0 ] ; then
2015-02-08 20:48:38 +00:00
exit 1
fi
exit 0