eeva/home-manager
1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-11-01 08:49:44 +01:00
Code Issues Releases Wiki Activity
home-manager/tests/modules/misc/xdg/file-gen.nix

37 lines
1.2 KiB
Nix
Raw Normal View History

xdg: coerce XDG base directories settings to strings Currently, when a custom path is set for any of the XDG base directories (i.e XDG_DATA_HOME, XDG_CONFIG_HOME, ...), the path will be coerced into a string when consumed by other options such as xdg.configFile et al. This causes the the given path to be copied to the nix store which in the case of xdg.configFile et al, translate to the file being written there as it is a absolute path. Interestingly, the default base directories all work as intended as they are encoded as a string. This commit converts the option to a string regardless of whether it is a primitive path or a string encoded path. This allows downstream consumers to use the base directories in arbitrary way without accidentally copying the content of the directory to the store. It is implemented in a similar manner as how home.homeDirectory undergoes string conversion. The existing file-attr-name test was modified to test also custom xdg base directories, and the home.file generation test was removed as there is a dedicated test for this case in the files module. The test case was renamed to file-gen to better reflect the new scope.
2021-09-13 04:44:58 +02:00
{ config, lib, pkgs, ... }:
with lib;
{
config = {
xdg.configHome = /. + "${config.home.homeDirectory}/.dummy-config";
xdg.dataHome = /. + "${config.home.homeDirectory}/.dummy-data";
xdg.cacheHome = /. + "${config.home.homeDirectory}/.dummy-cache";
xdg: add option 'xdg.stateHome' (#2439) It corresponds to the newly introduced `XDG_STATE_HOME`.
2021-11-04 17:42:44 +01:00
xdg.stateHome = /. + "${config.home.homeDirectory}/.dummy-state";
xdg: coerce XDG base directories settings to strings Currently, when a custom path is set for any of the XDG base directories (i.e XDG_DATA_HOME, XDG_CONFIG_HOME, ...), the path will be coerced into a string when consumed by other options such as xdg.configFile et al. This causes the the given path to be copied to the nix store which in the case of xdg.configFile et al, translate to the file being written there as it is a absolute path. Interestingly, the default base directories all work as intended as they are encoded as a string. This commit converts the option to a string regardless of whether it is a primitive path or a string encoded path. This allows downstream consumers to use the base directories in arbitrary way without accidentally copying the content of the directory to the store. It is implemented in a similar manner as how home.homeDirectory undergoes string conversion. The existing file-attr-name test was modified to test also custom xdg base directories, and the home.file generation test was removed as there is a dedicated test for this case in the files module. The test case was renamed to file-gen to better reflect the new scope.
2021-09-13 04:44:58 +02:00
xdg.configFile.test.text = "config";
xdg.dataFile.test.text = "data";
home.file."${config.xdg.cacheHome}/test".text = "cache";
xdg: add option 'xdg.stateHome' (#2439) It corresponds to the newly introduced `XDG_STATE_HOME`.
2021-11-04 17:42:44 +01:00
home.file."${config.xdg.stateHome}/test".text = "state";
xdg: coerce XDG base directories settings to strings Currently, when a custom path is set for any of the XDG base directories (i.e XDG_DATA_HOME, XDG_CONFIG_HOME, ...), the path will be coerced into a string when consumed by other options such as xdg.configFile et al. This causes the the given path to be copied to the nix store which in the case of xdg.configFile et al, translate to the file being written there as it is a absolute path. Interestingly, the default base directories all work as intended as they are encoded as a string. This commit converts the option to a string regardless of whether it is a primitive path or a string encoded path. This allows downstream consumers to use the base directories in arbitrary way without accidentally copying the content of the directory to the store. It is implemented in a similar manner as how home.homeDirectory undergoes string conversion. The existing file-attr-name test was modified to test also custom xdg base directories, and the home.file generation test was removed as there is a dedicated test for this case in the files module. The test case was renamed to file-gen to better reflect the new scope.
2021-09-13 04:44:58 +02:00
nmt.script = ''
assertFileExists home-files/.dummy-config/test
assertFileExists home-files/.dummy-cache/test
assertFileExists home-files/.dummy-data/test
xdg: add option 'xdg.stateHome' (#2439) It corresponds to the newly introduced `XDG_STATE_HOME`.
2021-11-04 17:42:44 +01:00
assertFileExists home-files/.dummy-state/test
xdg: coerce XDG base directories settings to strings Currently, when a custom path is set for any of the XDG base directories (i.e XDG_DATA_HOME, XDG_CONFIG_HOME, ...), the path will be coerced into a string when consumed by other options such as xdg.configFile et al. This causes the the given path to be copied to the nix store which in the case of xdg.configFile et al, translate to the file being written there as it is a absolute path. Interestingly, the default base directories all work as intended as they are encoded as a string. This commit converts the option to a string regardless of whether it is a primitive path or a string encoded path. This allows downstream consumers to use the base directories in arbitrary way without accidentally copying the content of the directory to the store. It is implemented in a similar manner as how home.homeDirectory undergoes string conversion. The existing file-attr-name test was modified to test also custom xdg base directories, and the home.file generation test was removed as there is a dedicated test for this case in the files module. The test case was renamed to file-gen to better reflect the new scope.
2021-09-13 04:44:58 +02:00
assertFileContent \
home-files/.dummy-config/test \
${builtins.toFile "test" "config"}
assertFileContent \
home-files/.dummy-data/test \
${builtins.toFile "test" "data"}
assertFileContent \
home-files/.dummy-cache/test \
${builtins.toFile "test" "cache"}
xdg: add option 'xdg.stateHome' (#2439) It corresponds to the newly introduced `XDG_STATE_HOME`.
2021-11-04 17:42:44 +01:00
assertFileContent \
home-files/.dummy-state/test \
${builtins.toFile "test" "state"}
xdg: coerce XDG base directories settings to strings Currently, when a custom path is set for any of the XDG base directories (i.e XDG_DATA_HOME, XDG_CONFIG_HOME, ...), the path will be coerced into a string when consumed by other options such as xdg.configFile et al. This causes the the given path to be copied to the nix store which in the case of xdg.configFile et al, translate to the file being written there as it is a absolute path. Interestingly, the default base directories all work as intended as they are encoded as a string. This commit converts the option to a string regardless of whether it is a primitive path or a string encoded path. This allows downstream consumers to use the base directories in arbitrary way without accidentally copying the content of the directory to the store. It is implemented in a similar manner as how home.homeDirectory undergoes string conversion. The existing file-attr-name test was modified to test also custom xdg base directories, and the home.file generation test was removed as there is a dedicated test for this case in the files module. The test case was renamed to file-gen to better reflect the new scope.
2021-09-13 04:44:58 +02:00
'';
};
}
Reference in a new issue Copy permalink