eeva/home-manager
1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-11-30 06:59:45 +01:00
Code Issues Releases Wiki Activity

borgmatic: preparing upcoming borgmatic change

Browse source 
This commit changes the config format of repositories to the
soon-be-expected `{ "path": "repository-path", }`. The Home Manager
configuration allows a simple string (which will get translated), the
new format by directly using the path attribute, and the one with the
optional label attribute. More information about the background can be
found here https://torsion.org/borgmatic/docs/reference/configuration/
This commit is contained in:
Philipp Kühn 2023-11-01 14:41:58 +01:00 committed by Robert Helgesson
parent fc2a8842ea
commit a421804890
No known key found for this signature in database
GPG key ID: 36BDAA14C2797E89
2 changed files with 62 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
modules/programs/borgmatic.nix
View file

@ -13,6 +13,13 @@ let
default = null;
});
cleanRepositories = repos:
map (repo:
if builtins.isString repo then {
path = repo;
} else
removeNullValues repo) repos;
mkRetentionOption = frequency:
mkNullableOption {
type = types.int;
@ -27,6 +34,26 @@ let
description = "Extra settings.";
};
repositoryOption = types.submodule {
options = {
path = mkOption {
type = types.str;
example = "ssh://myuser@myrepo.myserver.com/./repo";
description = "Path of the repository.";
};
label = mkOption {
type = types.nullOr types.str;
default = null;
example = "remote";
description = ''
Short text describing the repository. Can be used with the
`--repository` flag to select a repository.
'';
};
};
};
consistencyCheckModule = types.submodule {
options = {
name = mkOption {
@ -56,10 +83,23 @@ let
};
repositories = mkOption {
type = types.listOf types.str;
description = "Paths to repositories.";
example =
literalExpression ''["ssh://myuser@myrepo.myserver.com/./repo"]'';
type = types.listOf (types.either types.str repositoryOption);
apply = cleanRepositories;
example = literalExpression ''
[
{
"path" = "ssh://myuser@myrepo.myserver.com/./repo";
"label" = "server";
}
{
"path" = "/var/lib/backups/local.borg";
"label" = "local";
}
]
'';
description = ''
List of local or remote repositories with paths and optional labels.
'';
};
excludeHomeManagerSymlinks = mkOption {

23
tests/modules/programs/borgmatic/basic-configuration.nix
View file

@ -12,7 +12,14 @@ in {
main = {
location = {
sourceDirectories = [ "/my-stuff-to-backup" ];
repositories = [ "/mnt/disk1" "/mnt/disk2" ];
repositories = [
"/mnt/disk1"
{ path = "/mnt/disk2"; }
{
path = "/mnt/disk3";
label = "disk3";
}
];
extraConfig = {
one_file_system = true;
exclude_patterns = [ "*.swp" ];
@ -65,11 +72,17 @@ in {
expectations[source_directories[0]]="${
builtins.elemAt backups.main.location.sourceDirectories 0
}"
expectations[repositories[0]]="${
builtins.elemAt backups.main.location.repositories 0
expectations[repositories[0].path]="${
(builtins.elemAt backups.main.location.repositories 0).path
}"
expectations[repositories[1]]="${
builtins.elemAt backups.main.location.repositories 1
expectations[repositories[1].path]="${
(builtins.elemAt backups.main.location.repositories 1).path
}"
expectations[repositories[2].path]="${
(builtins.elemAt backups.main.location.repositories 2).path
}"
expectations[repositories[2].label]="${
(builtins.elemAt backups.main.location.repositories 2).label
}"
expectations[one_file_system]="${
boolToString backups.main.location.extraConfig.one_file_system